Ant - prezentacja narzędzia

Transkrypt

1 Dawid Dorosz Michał Ostrowiecki Andrzej Perużyński Technologie Biznesu Elektronicznego 21 marca 2006

2 Plan prezentacji 1 Wprowadzenie Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml 2 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit 3 Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta 4

3 Czym jest Ant? Wprowadzenie Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml 1 Narzędzie, służące do zautomatyzowania procesu budowy oprogramowania. 2 Napisany w Javie do wykorzystania z programami napisanymi w tym języku. 3 Co najważniejsze, jest to open-source na licencji Apache Software Fundation. 4 W swej funkcjonalności niczym szwajcarski scyzoryk.

4 Historia Ant a Wprowadzenie Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml Wymyślony przez Jamesa Duncana Davidsona w Apache Software Fundation w 1998 r. 1 Najnowsza wersja Ant z 2 czerwca Używana w projekcie TBE: Ant 1.6.5

5 Co różni Ant a od Make? Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml 1 W pliku Makefile czynności określone jako komendy powłoki zależne od platformy 2 Ant rozwiązuje ten problem 3 Użycie i XML a i pliku build.xml

6 Schemat pliku build.xml Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml <project name="project_name" basedir="." default="default"> <property name="src" value="./src" /> <target name="default"> <task1 param1="value" /> <task2> <type param="value" /> </task2> </target> </project>

7 Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml Czym jest <target>? Czym jest <task>?

8 Wprowadzenie do Ant Ant vs Make Budowa pliku build.xml Przykład problemu przenośności Make 1 rm -rf classes/ - zapisane w pliku Makefile jako komenda Unixowa 2 <delete dir= classes /> - zapisanie w pliku build.xml 3 pliki build konwertują ścieżkę z Uniksowej do formatu określonej platformy

9 Ant Wprowadzenie Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit wymagania - JDK 1.2 lub nowsza download - najnowsza wersja - Ant używana wersja - Ant 1.6.5

10 Ant przykładowa instalacja Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit 1 rozpakować apache-ant bin.zip do c:\ant 2 set ANT HOME=c:\ant 3 set JAVA HOME=C:\Sun\AppServer\jdk 4 set PATH=%PATH%;%ANT HOME%\bin

11 Ant uruchomienie Wprowadzenie Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit z linii poleceń 1 wejście do katalogu, w którym jest plik build.xml i wpisanie komendy ant 2 wykonanie polecenia: ant -buildfile ścieżka do pliku build.xml z Eclipse 1 kliknięcie prawym przyciskiem myszy na plik build.xml i wybranie Run as Ant Build

12 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Tworzenie katalogów i kopiowanie plików Najważniejsze elementy pliku build.xml <deltree dir="${build}"/> <mkdir dir="${build}/${src}" /> <copy todir="${build}/${src}"> <fileset dir="${src}"> <include name="*.xml"/> <exclude name="index.xml"/> </fileset> </copy>

13 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Kompilacja oraz uruchomienie programu Najważniejsze elementy pliku build.xml <javac srcdir="${src}" destdir="${build}" includes="start.java"/> <jar destfile="uruchom.jar" basedir="${build}"/> <java classname="src.start" classpath="uruchom.jar" />

14 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Uruchamianie programu z argumentami pobranymi z pliku build.xml (1) Java umożliwia pobieranie argumentów z pliku build.xml W tym celu należy: import org.apache.tools.ant.task; extends Task posiadać metodę np. public void setmessage(string msg) posiadać metodę public void execute()

15 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Uruchamianie programu z argumentami pobranymi z pliku build.xml (2) Aby uruchomić napisany przez nas program należy: zdefiniować własny task <taskdef name="start" classname="src.start" classpath="uruchom.jar"/> wywołać wcześniej utwożony task z atrybutem, który chcemy przesłać <start message="wiadomosc przeslana jako argument"/>

16 Wykonywanie komendy systemowej Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Ant umożliwia wykonywanie komend systemowych. Można to wykorzystać np. do odtwarzania plików mp3. Oto przykład: <exec executable="${src}wmplayer.exe" spawn="true"> <arg value="${muzyka}\disco polo - Majteczki W Kropeczki.mp3"/> </exec>

17 Co jest potrzebne? Wprowadzenie Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit junit.jar ze strony dodanie powyższego pliku do: katalogu c:\ant\lib lub w Eclipse Window Preferences Ant Runtime Classpath Add JARs

18 Co wykorzystujemy? (1) Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Używamy następujących tasków: <junit>, dla którego będziemy wykorzystywać poniższe atrybuty i znaczniki: 1 fork= true powoduje uruchomienie testu na osobnej VM 2 haltonerror= no powoduje nie kończenie testowania w razie wystąpienia błędu 3 <classpath> informuje gdzie znajduje się szukana klasa testowana 4 <formatter> ustawia jak wyniki testu mają zostać zapisane np. w postaci XML 5 <test> definiuje pojedynczy test 6 <batchtest> definiuje zestaw testów

19 Co wykorzystujemy? (2) Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit <junitreport> generuje raport na podstawie plików XML wcześniej utworzonych przez JUnit. Wykorzystujemy przy tym poniższe atrybuty i znaczniki: 1 todir= katalog wynikowy określa gdzie raport ma się znaleźć 2 <fileset> określa gdzie znajdują się pliki XML utworzone przez JUnit 3 <report> odpowiada za wygenerowanie raportu, posiada on atrybuty: 1 format= frames jest to format w jakim zostanie wygenerowany raport, może być frames lub noframes 2 todir= katalog raporty określa katalog, w którym ma być umieszczony raport

20 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Przykład wykorzystujący pojedynczo uruchamiane testy <junit fork="yes" haltonfailure="no"> <classpath refid="classpath.test"/> <formatter type="xml"/> <test fork="yes" name="matematykatest" todir="${build}/${junit.out.dir.xml}"/> <test fork="yes" name="napisytest" todir="${build}/${junit.out.dir.xml}"/> <junit>

21 Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit Przykład wykorzystujący zbiorowo uruchamiane testy <junit fork="yes" haltonfailure="no"> <classpath refid="classpath.test"/> <formatter type="xml"/> <batchtest fork="yes" todir="${build}/${junit.out.dir.xml}"> <fileset dir="src" includes="**/*test.java"/> </batchtest> </junit>

22 Generowanie raportu Instalacja Ant Przykłady podstawowe Humor Ant i testy JUnit <junitreport todir="${build}/${junit.out.dir.html}"> <fileset dir="${build}/${junit.out.dir.xml}"> <include name="*.xml"/> </fileset> <report format="frames" todir="${build}/${junit.out.dir.html}"/> </junitreport>

23 Struktury kontrolne if..then..else (1) Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta Taką strukturę chcemy uzyskać w pliku build.xml if( condition ) { if( inner-condition ) { A } else { B } } else { C }

24 Struktury kontrolne if..then..else (2) Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta Najważniejsze elementy pliku build.xml <target name="nested-if"> <condition property="condition"> <available file="fileone"/> </condition> <antcall target="then"/> <antcall target="else"/> </target> <target name="then" if="condition"> <target name="else" unless="condition">

25 Co trzeba zrobić? (1) Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta 1 ściągnąć Subversion ze strony 2 rozpakować katalog do dowolnego miejsca na dysku np. c:\svn 3 dodać do zmiennej środowiskowej PATH ścieżkę do katalogu, w którym jest plik svn.exe (C:\svn\bin) 4 ściagnąć svnant ze strony rc1.zip

26 Co trzeba zrobić? (2) Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta 5 do katalogu lib naszego projektu skopiować zawartość katalogu lib z svnant czyli: commons-lang-2.0.jar jakarta-regexp-1.3.jar svnclientadapter.jar svnant.jar svnjavahl.jar 6 użyć odpowiednich znaczników w pliku build.xml

27 Najważniejsze znaczniki Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta <svn> umożliwia wywoływanie zadań związanych z korzystaniem z repozytorium. Atrybuty: username password

28 Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta Komendy svn jako zagnieżdżone elementy (1) <checkout> umożliwia ściągnięcie kopii z repozytorium. Atrybuty: url np.: destpath - katalog, do którego kopiujemy zawartość <mkdir> umożliwia stworzenie katalogu na repozytorium. Atrybuty: url np.: message - wiadomość

29 Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta Komendy svn jako zagnieżdżone elementy (2) <cat> umożliwia skopiowanie zawartości pliku z repozytorium. Atrybuty: url np.: destfile - plik, do którego kopiujemy zawartość <delete> umożliwia skasowanie katalogu na repozytorium. Atrybuty: url np.: message - wiadomość

30 Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta Komendy svn jako zagnieżdżone elementy (3) <add> umożliwia dodanie pliku lub katalogu do repozytorium. Pliki na repozytorium zobaczymy po wywołaniu commit Atrybuty: file dir <commit> umożliwia przesłanie zmian kopii roboczej na repozytorium Atrybuty: file dir

31 Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta Ściągnięcie najnowszego kodu z repozytorium WordPress Plik build.xml: <project name="wordpress" default="update" basedir="."> <path id="project.classpath"> <fileset dir="lib"> <include name="**/*.jar"/> </fileset> </path> <taskdef resource="svntask.properties" classpathref="project.classpath"/> <target name="update" description="update from Repository" > <svn> <checkout url=" destpath="src" /> </svn> </target> </project>

32 Uruchomienie i zakończenie Jetty Wywołania warunkowe w Ant Korzystanie z repozytorium za pomocą Ant Korzystanie z Jetty przy pomocy Anta 1 Uruchomienie Jetty: <java jar= ${lib.dir}start.jar classpathref= libs.classpath fork= true dir= ${build.dir} > Atrybuty: ${lib.dir}start.jar - ścieżka do pliku start.jar classpathref - informuje, gdzie znajdują się klasy potrzebne do uruchomienia fork= true - wykonanie klasy jest w osobnej VM dir= ${build.dir} - katalog, w którym zostanie wywołana VM 2 Zakończenie Jetty: <java jar= ${lib.dir}stop.jar fork= true failonerror= false /> Atrybuty: ${lib.dir}stop.jar - ścieżka do pliku stop.jar failonerror= false - w przypadku błędu kontynuuje

33 Jesse Tilly, Eric Burke Ant: The Definitive Guide O Reilly Apache Ant Manual The Apache Software Foundation AntTutorialWritingTasks The Apache Software Foundation Svn Task CollabNet