Erinnerung: XML (1/2) 9. Build-Management

Transkript

1 9. Build-Management Wiederholung: Grundideen XML Aufgaben des Build- und Releasemanagements Konzepte von Build-Werkzeugen Aufbau von Ant-Skripten Typische Ant-Tasks Erweiterung mit neuen Ant-Tasks Literatur [Cha03] M. Chapman, Apache Ant 101: Make Java builds a snap, ibm.com/developerworks, 2003 Erinnerung: XML (1/2) extensible Markup Language strukturierte maschinen- und ansatzweise menschenlesbare Informationsbeschreibung Processing Instruction am Anfang (evtl. mit encoding-info) <?xml version="1.0"?> Aufbau eines Elements mit Start- und End-Tags als Klammer <Elementname> Inhalt </Elementname> Inhalt kann wieder aus Elementen bestehen, es ergibt sich Baumstruktur Elemente können Attribute enthalten <Elementname att1="bla" att2="blubb" > Inhalt </Elementname> Erinnerung: XML (2/2) Elemente, die maximal Attribute, aber keinen Inhalt haben, können verkürzt geschrieben werden <Elementname att1="bla" att2="blubb" /> Kommentar <!-- Isch bin ähn Gommenta --> weitere Möglichkeiten, wie Querverweise Neben reiner Syntax kann auch die erlaubte inhaltliche Struktur spezifiziert werden (DTD: Document Type Definition), XML-Schema Viele spannende Werkzeuge zur XML-Verarbeitung Herstellung der Entwicklungsumgebung In großen Projekten arbeiten Entwickler häufig nicht auf einer Quelldatei; Dateien werden lokal kopiert und dort bearbeitet Vorteil: ordentliche Verfolgung von Änderungen, laufende Programmversionen können nicht verloren gehen Nachteil: Entwickler muss Kopien für seinen Arbeitsbereich erstellen Lösung: Automatisierung des Kopier- und Übersetzungsprozesses (+ weiterer Standardaufgaben) Einsatz von Skripten sh, *.bat besser: Einsatz von Werkzeugen, wie make und ant (auch Build-Tools genannt) In Großprojekten muss der Entwickler die dahinter liegenden automatisierten Prozesse nicht kennen, er muss nur wissen, wo seine mit welchen Randbedingungen läuft Software durchläuft bei der Installation häufig eine Installationsroutine, bei der u. a. Pfade gelesen und bearbeitet werden

2 Ant Apache Ant (another neat tool, James Duncan Davidson) ist Alternative zu make-files Ant-Files können betriebssystemunabhängig formuliert werden alle Befehle im XML-Format viele Werkzeuge bieten XML-Tasks an, mit denen verschiedene Befehle des Werkzeugs aus Ant heraus ausgeführt werden können (z. B. Kompilieren) Ant kann leicht erweitert werden, da in Java geschrieben, als Framework konzipiert Ant benötigt XML-Parser, Apache Xerces mitgeliefert erste Schritte auf Veranstaltungswebseite 234 Konzept von Ant (und make) Es gibt zentrales Ziel (project), was erreicht werden soll (z. B. vollständige Kompilation) Jedes Ziel besteht aus Teilzielen (target), die vorher erreicht werden müssen (z. B. Übersetzung eines Teilpakets) Werkzeug stellt Regeln auf, was in welcher Reihenfolge gemacht werden muss, um zentrales Ziel zu erreichen Werkzeug bietet dabei u. a. Reaktionsmöglichkeiten bei Fehlern Varianten bei der Ausführung Möglichkeit, Ordner zu löschen und anzulegen, Dateien zu kopieren, verschieben und löschen 235 Erinnerung an make all : file1.o file2.o file3.o gcc -o prog file1.o file2.o file3.o file1.o : file1.c gcc -Wall -c file1.c file2.o : file2.c gcc -Wall -c file2.c file3.o : file3.c gcc -Wall -c file3.c 236 Beispiel für Abhängigkeiten <target name="init"/> <target name="preprocess" depends="init"/> <target name="compile" depends="init,preprocess"/> <target name="package" depends="compile"/> Die Reihenfolge der Ziele (target) in der Datei hat keine Bedeutung, nur depends dabei wichtig Neben einem default-ziel kann man beim Start ein Ziel auswählen, z. B. compile alle depends betrachtet und schrittweise vom Werkzeug in mögliche Reihenfolge gebracht, hier: init hat keine Abhängigkeiten, wird zuerst ausgeführt (was, hier nicht sichtbar) preprocess benötigt init, da schon ausgeführt, wird nur preprocess ausgeführt 237

3 Ant-Basisskript (erzeugt von Eclipse) <?xml version="1.0"?> <!-- ============================================= Projekt, Datum, Aufgabe Autor, ============================================= --> <project name="project" default="default"> <description> description </description> <!-- ================================= target: default ================================= --> <target name="default" depends="depends" description="--> description"> <! target: depends > <target name="depends"> </project> Skript-Konstanten (Eigenschaften, Properties) <property name="eigen" value = "Wert" /> Nutzung von Property-Werten mit ${eigen} <property name= "db" value = "${eigen}.db"/> Bei Pfaden wird statt value dann location genutzt, dabei werden / und \ automatisch angepasst <property name="ziel" location="${p}/bla/fas"/> <property name="ziel" location="${p}\bla\fas"/> Laufwerksbuchstaben, wie C: sind verboten (möglichst mit relativen Pfaden arbeiten) Es gibt vordefinierte Properties, z. B. ${user.home} Beispiel-Task: Kompilieren <!-- classpath in der Form besser weglassen! --> <target name="compile" depends="start" description="kompiliere"> <javac srcdir="src" destdir="build" classpath="." debug="on"> </javac> <echo message="in compile"/> weitere Parameter können der Ant-Dokumentation entnommen werden (...\ant\docs\manual\index.html) classpath nur nutzen, wenn weitere Pakete genutzt werden echo hier als Spielerei Übersetzung aller Klassen in Verzeichnis src und Unterverzeichnissen 240 Beispiel-Task: Packen <!-- existierendes Manifest mit Attribut file="" --> <target name="pack" depends="compile" description="packe"> <jar destfile="dist/gepackt.jar" basedir="build"> <manifest> <attribute name="main-class" value="de.kleuker.xstarter"> </attribute> </manifest> </jar> <echo message="in pack"/> hier wird Manifest-Datei direkt erzeugt, zu nutzende Datei kann auch angegeben werden 241

4 Hilfsmittel: Zeitstempel Einfachste Form: Task <tstamp/>, dann nutzbare Variablen: DSTAMP: aktuelles Datum, Default-Format yyyymmdd TSTAMP: aktuelle Uhrzeit, Default-Format hhmm TODAY: aktuelles Datum als String konfigurierbar über format-property <target name="zeigezeit"> <tstamp> <format property="today" pattern="dd.mmmm.yyyy" locale="de,de"/> </tstamp> <echo message="dstamp = ${DSTAMP}"/> <echo message="tstamp = ${TSTAMP}"/> <echo message="today = ${TODAY}"/> [echo] DSTAMP = [echo] TSTAMP = 1234 [echo] TODAY = 09.Februar Umgang mit Files und Dateien <mkdir dir="${builddir}"/> legt auch fehlende Unterverzeichnisse z. B. bei /dist/nase/simpel/billig an übersprungen, falls Verzeichnis existiert <delete dir="${builddir}"/> <copy file="src/hai.java" tofile="back/hai.java"/> <move file="src/hai.java" tofile="back/hai.java"/> Pattern / Wildcards / reguläre Ausdrücke * für beliebig viele Zeichen? für genau ein Zeichen ** alle Unterverzeichnisse, z. B. **/*.java häufig Property fileset zum Ein- und Ausschließen nutzbar <copy todir="archive"> <fileset dir="src"> <include name="*.java"/> </fileset> </copy> 243 Detailliertes Beispiel (1/5) 2 1 Ausgangssituation Menü bei Rechtsklick auf build.xml 244 Detailliertes Beispiel (2/5) <?xml version="1.0"?> <project name="antspiel" default="default"> <description> Etwas Spielerei mit Ant </description> <property name="srcdir" location="src"/> <property name="builddir" location="build"/> <property name="destdir" location="dest"/> <!-- clean üblicherweise nicht immer --> <target name="default" depends="clean,compile,pack,execute" description="mach alles"> <echo message="in default"/> <target name="clean" description="aufräumen"> <delete dir="${builddir}"/> <delete dir="${destdir}"/> <echo message="in clean"/> 245

5 Detailliertes Beispiel (3/5) <target name="start" description="initialisieren"> <tstamp/> <mkdir dir="${builddir}"/> <mkdir dir="${destdir}"/> <echo message="in start"/> <!-- classpath in der Form besser weglassen! --> <target name="compile" depends="start" description="kompilere"> <javac srcdir="${srcdir}" destdir="${builddir}" classpath="." debug="on"> </javac> <echo message="in compile"/> 246 Detailliertes Beispiel (4/5) <!-- existierendes manifest attribut file="" --> <target name="pack" depends="compile" description="packe"> <jar destfile="${destdir}/gepackt${dstamp}.jar" basedir="${builddir}"> <manifest> <attribute name="main-class" value="de.kleuker.xstarter"/> </manifest> </jar> <echo message="in pack"/> <!-- sehr ungewöhnlich, aber zum Zeigen --> <target name="execute" depends="pack" description="ausführen"> <exec dir="${destdir}" executable="cmd.exe" os="windows XP"> <arg line="/c java -jar gepackt${dstamp}.jar"/> </exec> <echo message="in execute"/> </project> 247 Detailliertes Beispiel (5/5) Buildfile: G:\antspiel\build.xml clean: [echo] in clean start: [mkdir] Created dir: G:\antspiel\build [mkdir] Created dir: G:\antspiel\dest [echo] in start compile: [javac] Compiling 5 source files to G:\antspiel\build [echo] in compile pack: [jar] Building jar: G:\antspiel\dest\gepackt jar [echo] in pack execute: [echo] in execute default: [echo] in default BUILD SUCCESSFUL Total time: 7 minutes 13 seconds Ant wartet bis Nutzer Programm beendet (besser spawn nutzen) 248 Bedingte Ausführung <target name="mytarget" depends="mytarget.check" if="mytarget.run"> <echo> Files foo.txt and bar.txt are present. </echo> <target name="mytarget.check"> <condition property="mytarget.run"> <and> <available file="foo.txt"/> <available file="bar.txt"/> </and> </condition> if prüft nur, ob eine Eigenschaft gesetzt wurde, der eigentliche Wert spielt keine Rolle (unless für nicht if) 249

6 Neue Ant-Tasks Generell kann man in Ant beliebige Programme aufrufen, dazu kann die <exec>-task genutzt werden exec leider stark betriebssystemabhängig Ansatz: Kapsle Aufruf als neue Ant-Task (als Java-Programm) Klasse MeineTask erbt von org.apache.tools.ant.task hat Methode: public void execute() throws BuildException für jedes Attribut eine public void set-methode public void setdatei(file f) Definieren der Task <taskdef name="meinetask" classname="meinetask" classpath="."/> Nutzen der Task <meinetask datei="input.txt"/> 250 Überblick: Core-Tasks Ant AntCall AntStructure Apply/ExecOn Apt Available Basename BuildNumber BUnzip2 BZip2 Checksum Chmod Concat Condition Copy Copydir Copyfile Cvs CvsChangeLog CvsChangeLog CvsVersion CVSPass CvsTagDiff Defaultexcludes Delete Deltree Dependset Diagnostics Dirname Ear Echo EchoXML Exec Fail Filter FixCRLF GenKey Get GUnzip GZip Import Input Jar Java Javac Javadoc/Javadoc2 Length LoadFile LoadProperties LoadResource MakeURL Mail MacroDef Manifest ManifestClassPath Mkdir Move Nice Parallel Patch PathConvert PreSetDef Property Record Rename Replace ResourceCount Rmic Sequential SignJar Sleep Sql Subant Sync Tar Taskdef Tempfile Touch TStamp Typedef Unjar Untar Unwar Unzip Uptodate Waitfor WhichResource War XmlProperty XSLT/Style Zip 251 Beispiel aus svnant-dokumentation (1/2): ignore (generell: Installation: jar-files nach ant/lib kopieren) Add a given file or a pattern to the ignored files list (modifies svn:ignore property) Attribute file dir pattern recurse Description file to ignore directory on which we will update svn:ignore property pattern to add to svn:ignore on the directory Only when dir is set Set to "true" to add the pattern recursively to directories. Default is "false" Only when dir is set Example : <ignore dir="workingcopy/ignoretest/dir1" pattern="*.ignore" recurse="true"/> Required One of the two Yes 252 No Beispiel aus svnant-dokumentation (2/2): checkout Check out a working copy from a repository. Attribute Description url url to checkout from Set to "false" to operate on single directory recurse only. Default is "true" destpath destination directory revision to checkout. Possible values are : - a date with the following format : revision MM/DD/YYYY HH:MM AM_PM - a revision number:head, BASE, COMMITED or PREV. Default is "HEAD" Required Yes Yes Parameters specified as nested elements : fileset. Filesets are used to select sets of files to add to the repository. Note that directories needed to add selected files will be added to the repository even if they are not selected by the fileset. <svn javahl="${javahl}"> <checkout url="${urlrepos}" destpath="arbeit"/> </svn> 253 No No

7 Übung Informieren Sie sich über die Nutzungsmöglichkeiten von JavaDoc und JUnit von Ant aus. Entwerfen Sie mit Ihrem Wissen über Subversion und Ant eine sinnvolle Dateistruktur für das Repository Ihres Projekts. Überlegen Sie, wozu Sie Ant einsetzen und wie Sie mit generierten Dateien umgehen wollen. Beachten Sie, dass das Repository leicht um weitere Verzeichnisse an sinnvollen Stellen erweiterbar sein soll. 254