1 Testowanie i logowanie 1. Testowanie aplikacji JUnit. 2. Tworzenie logów: pakiet java.util.logging.
2 JUnit JUnit jest platformą umożliwiającą tworzenie testów i testowanie programów napisanych w Javie. JUnit jest projektem Open Source, rozpowszechnianym na licencji Common Public License Version 1.0. Strona domowa projektu to http://www.junit.org. JUnit jest rozprowadzany w postaci archiwum zawierającego odpowiednią bibliotekę, przykłady wykorzystania pakietu oraz kod źródłowy. JUnit jest także dołączony do środowiska deweloperskiego Eclipse.
3 Przykładowa testowana klasa class Money { private int famount; private String fcurrency; public Money(int amount, String currency) { famount = amount; fcurrency = currency; public int getamount() { return famount; public String getcurrency() { return fcurrency;
4 Piszemy metody testujące public class MoneyTest extends TestCase { private Money f12chf; private Money f14chf; // inicjacja pakietu testów protected void setup() { f12chf= new Money(12, "CHF"); f14chf= new Money(14, "CHF"); // pierwsza z metod testujących public void testgetters() { Assert.assertEquals(this.f12CHF.getAmount(), 12); Assert.assertEquals(this.f12CHF.getCurrency(), "CHF");
Metody publiczne z klasy Assert public static void asserttrue(string message, boolean condition) Sprawdza czy condition jest równe true. Jeśli nie zgłaszany jest wyjątek AssertionFailedError zawierający message. public static void asserttrue(boolean condition) public static void assertfalse(...) public static void fail(...) public static void assertequals(...) public static void assertnotnull(...) public static void assertnull(...) public static void assertsame(...) Sprawdza czy podane referencje to te same obiekty public static void assertnotsame(...) 5
6 Piszemy metody testujące cd. Chcemy żeby była możliwość dodawania dwóch obiektów typu Money. Zanim napiszemy metodę add() w klasie Money określimy jej własności dopisując do zestawu MoneyTest odpowiedni test. public void testadd() { Money expected = new Money(26, "CHF"); Money result = this.f12chf.add(f14chf); Assert.assertTrue(expected.equals(result)); Ale jak powinna działać metoda equals() wywołana na rzecz instancji klasy Money?
7 Piszemy metody testujące cd. Metoda equals() powinna działać tak, aby między innymi spełnić poniższy test. public void testequals() { Money m12chf= new Money(12, "CHF"); Money m14chf= new Money(14, "CHF"); Assert.assertTrue(!m12CHF.equals(null)); Assert.assertEquals(m12CHF, m12chf); Assert.assertEquals(m12CHF, new Money(12, "CHF")); Assert.assertTrue(!m12CHF.equals(m14CHF)); Dwie instancje Money są uważane za równe gdy równa jest waluta i kwota.
8 Dopisujemy kod do testowanej klasy W klasie Money dodajemy następujące metody: // dodawanie dwóch instancji klasy Money public Money add(money m) { return new Money(getAmount()+m.getAmount(), getcurrency()); // porównanie dwóch instancji klasy Money public boolean equals(object anobject) { if (anobject instanceof Money) { Money amoney = (Money)anObject; return amoney.getcurrency().equals(getcurrency()) && (getamount() == amoney.getamount()); return false;
Aby uruchomić zestaw testów należy: określić sposób uruchomienia testu, Zanim uruchomimy test określić sposób uruchomienia zestawu testów. JUnit umożliwia uruchamianie poszczególnych testów na dwa sposoby: statyczny i dynamiczny. Statyczne wywołanie testu następuje poprzez nadpisanie metody runtest dziedziczonej po klasie TestCase i uruchomienie w niej określonego testu. Przykład: TestCase test = new MoneyTest("test dodawania"){ public void runtest() { testadd(); ; Każdy test musi posiadać nazwę! 9
10 Zanim uruchomimy test Dynamiczne wywołanie testu polega na skorzystaniu z mechanizmu Java Reflection w celu uruchomienia danego testu. Nazwa testu jest tożsama z nazwą metody realizującej test. Aby wywołać metodę testadd() konstruujemy test następująco: TestCase test = new MoneyTest("testAdd"); Wywołanie dynamiczne jest prostsze, jednak mniej bezpieczne jeśli chodzi o kontrole typów. W przypadku braku podanej metody zwracany jest wyjątek NoSuchMethodException.
Zestawy testów Aby zdefiniować zbiór testów należy zdefiniować publiczną statyczną metodę suite(): public static Test suite() { TestSuite suite= new TestSuite(); suite.addtest(new MoneyTest("testEquals")); suite.addtest(new MoneyTest("testAdd")); return suite; Wewnątrz tej metody tworzymy obiekt TestSuite zawierający metody obsługujące przeprowadzenie testu. TestSuite i TestCase implementują interfejs Test zawierający metody obsługujące przeprowadzenie testu. Istnieje także (od wersji 2.0) możliwość dynamicznego stworzenia zestawu w oparciu o klasę zawierającą testy: public static Test suite() { return new TestSuite(MoneyTest.class); 11
Zestawy testów Statyczna wersja kodu tworząca zestaw: public static Test suite() { TestSuite suite = new TestSuite(); suite.addtest( new MoneyTest("money equals") { protected void runtest() { testequals(); ); suite.addtest( new MoneyTest("simple add") { protected void runtest(){ testadd(); ); return suite; 12
13 Uruchomienie testów Aby uruchomić testy wpisujemy komende: java -cp junit.jar:money.jar junit.swingui.testrunner MoneyTest
JUnit i Eclipse 14
JUnit i Eclipse 15
Java Logging API Logowanie przede wszystkim stosuje się aby umożliwić zdiagnozowanie problemu przez: użytkownika końcowego lub lokalnego administratora, pomoc techniczną, producenta oprogramowania, programistów w trakcie tworzenia i rozwoju oprogramowania. Kolejne grupy użytkowników zwykle potrzebują coraz więcej informacji. Nie należy zastępować zwykłego debugowania przez logowanie ponieważ prowadzi to do znacznego rozrostu kodu programu. Ma to szczególnie istotne znaczenie w przypadku oprogramowania rozprowadzanego przez sieć. Klasy obsługujące logowanie są zgrupowane w pakiecie java.util.logging. http://java.sun.com/j2se/1.4.2/docs/guide/util/logging/overview.html. Inne popularne rozwiązanie log4j: http://logging.apache.org/log4j/docs/. 16
Java Logging API Najważniejsze z klas obsługujących logowanie to: Logger klasa używana przez aplikacje do wywoływania żądań logowania. LogRecord zawiera dane określające pojedynczy wpis w logu. Dane zapisywane w obiekcie LogRecord dostępne przez metody publiczne: poziom Level getlevel() (np. Level.SEVERE), nazwa użytego obiektu typu Logger String getloggername(), wiadomość do zalogowania (przed ew. formatowaniem i lokalizacją) String getmessage(), czas: liczba milisekund od 01.01.1970 long getmillis(), dodatkowe parametry Object[] getparameters(), numer kolejny long getsequencenumber(), nazwa klasy, w której wywołano logger'a String getsourceclassname(), 17
18 Java Logging API nazwa metody, w której wywołano logger'a String getsourcemethodname(), identyfikator wątku, w którym wywołano logger'a int getthreadid(), wyjątek związany z logowaną wiadomością Throwable getthrown(). Handler eksportuje obiekty LogRecord do różnych miejsc docelowych np: pamięci, strumieni wyjścia, konsoli, plików, gniazd sieciowych. Standardowo dostępne są następujące typy handler'ow:
Java Logging API Level - określa zbiór standardowych poziomów logowania. Program może mieć przypisane różne poziomy dla różnych urządzeń odbierających komunikaty. Poziomy zdefiniowane w klasie Level: SEVERE - 1000 WARNING- 900 INFO - 800 CONFIG - 700 FINE - 500 FINER - 400 FINEST - 300 Dodatkowo zostały zdefiniowane dwa poziomy: OFF (Integer.MAX_VALUE) i ALL (Integer.MIN_VALUE), który pozwalają wyłączyć logowanie lub logować wszystkie komunikaty. Można tworzyć własne poziomy pisząc podklasy java.util.logging.levels. 19
20 Java Logging API Filter umożliwia dodatkową, precyzyjniejszą kontrolę logowanych wiadomości niż ta zapewniona przez klase Level. Formatter wspiera formatowanie informacji zapisanych w obiekcie LogRecord. Standardowodostępne są dwie klasy formatujące: SimpleFormatter - zapisuje informacje w typowej formie tekstowej XMLFormatter umożliwia tworzenie logów w formacie XML.
Prosty przykład public class LoggingSample{ private static Logger logger = Logger.getLogger("LoggingSample"); public static void inner(){ logger.info("jestem w srodku"); public static void main(string argv[]){ logger.info("zaczynam"); logger.fine("jestem gadatliwy"); try { Thread.sleep(1000); inner(); Thread.sleep(1000); catch (InterruptedException e) { logger.log(level.warning, "sleep", e); logger.warning("programista sie pomylil"); logger.finer("jestem bardziej gadatliwy"); logger.info("zrobione"); 21
22 Prosty przykład Efekt działania tekst w konsoli: 2006-02-28 16:27:47 LoggingSample main INFO: zaczynam 2006-02-28 16:27:48 LoggingSample inner INFO: jestem w srodku 2006-02-28 16:27:49 LoggingSample main WARNING: programista sie pomylil 2006-02-28 16:27:49 LoggingSample main INFO: zrobione Brak logowania wiadomości na poziomie FINE! Sposób działania logowania jest określony w pliku logging.properties, znajdującym się w podkatalogu lib środowiska JRE.
logging.properties # Global properties handlers= java.util.logging.consolehandler.level= INFO # Handler specific properties. java.util.logging.filehandler.pattern = %h/java%u.log java.util.logging.filehandler.limit = 50000 java.util.logging.filehandler.count = 1 java.util.logging.filehandler.formatter = java.util.logging.xmlformatter java.util.logging.consolehandler.level = INFO java.util.logging.consolehandler.formatter = java.util.logging.simpleformatter # Facility specific properties. # Provides extra control for each logger. com.xyz.foo.level = SEVERE Podmiana pliku jest możliwa poprzez podanie odpowiedniego argumentu dla polecenia java: -Djava.util.logging.config.file=myfile 23
24 Konfiguracja dynamiczna public class LoggingHandlerSample extends LoggingSample{ public static void main(string[] args){ try { Handler fh1 = new FileHandler("log.txt"); fh1.setlevel(level.warning); Handler fh2 = new FileHandler("logSimple.txt"); fh2.setformatter(new SimpleFormatter()); fh2.setlevel(level.all); Handler fh3 = new FileHandler("logXML.txt"); fh3.setlevel(level.info); fh3.setformatter(new XMLFormatter()); logger.addhandler(fh1); logger.addhandler(fh2); logger.addhandler(fh3); logger.setlevel(level.finest);
Konfiguracja dynamiczna catch (SecurityException e) { logger.log(level.warning, "problem", e); catch (IOException e) { logger.log(level.warning, "problem", e); LoggingSample.main(args); W konsoli wynik ten sam. W pliku logsimple.txt: 2006-02-28 16:33:37 LoggingSample main INFO: zaczynam 2006-02-28 16:33:37 LoggingSample main FINE: jestem gadatliwy 2006-02-28 16:33:38 LoggingSample inner INFO: jestem w srodku 2006-02-28 16:33:39 LoggingSample main WARNING: programista sie pomylil 2006-02-28 16:33:39 LoggingSample main FINER: jestem bardziej gadatliwy 2006-02-28 16:33:39 LoggingSample main INFO: zrobione 25
Fragment log.txt: Konfiguracja dynamiczna <?xml version="1.0" encoding="windows-1250" standalone="no"?> <!DOCTYPE log SYSTEM "logger.dtd"> <?xml version="1.0" encoding="windows-1250" standalone="no"?> <!DOCTYPE log SYSTEM "logger.dtd"> <log> <record> <date>2006-02-28t16:33:39</date> <millis>1141140819377</millis> <sequence>3</sequence> <logger>loggingsample</logger> <level>warning</level> <class>loggingsample</class> <method>main</method> <thread>10</thread> <message>programista sie pomylil</message> </record> </log> W pliku logxml.txt: jest więcej wpisów związanych z niższym poziomem logowania. 26
27 Podsumowanie Korzystanie z narzędzi służących testowaniu oprogramowania pozwala znacznie skrócić czas potrzebny na przygotowanie rozbudowanych aplikacji. Logowanie umożliwia śledzenie pracy programu i łatwiejszą lokalizacje przyczyn ewentualnych błędów.