20 maja 2010
Spis treści 1 Programowanie kontraktowe Geneza Założenia Kontrakty w języku Eiffel 2 Definiowanie specyfikacji Weryfikacja poprawności aplikacji 3 Wykorzystanie założeń kontraktów 4 Asercje Narzędzia wspierające programowanie kontraktowe w Javie 5 6
Cele prezentacji 1 Przedstawienie koncepcji programowania kontraktowego 2 Poznanie narzędzi do CDD w javie 3 Przykład wykorzystania kontraktów
Kontrakt Programowanie kontraktowe Geneza Założenia Kontrakty w języku Eiffel Kontrakt Umowa między dwiema stronami: kupującym i sprzedającym dotycząca dostarczenia przez sprzedającego określonego dobra kupującemu w zamian za zatwierdzoną rekompensatę. Zawartość kontraktu Opis sprawy Warunki akceptacji Zasady zachowania kontraktu Warunki zerwania kontraktu
Wzmianki Programowanie kontraktowe Geneza Założenia Kontrakty w języku Eiffel Pierwsze wzmianki o programowaniu kontraktowym już w 1986 roku Bertrand Meyer - twórca języka Eiffel i propagator Design by Contract Contract Driven Development, Design by Contract, Contract Programming
Kontrakt w programowaniu Geneza Założenia Kontrakty w języku Eiffel Przedstawienie warunków specyfikacji oprogramowania w postaci formalnie zdefiniowanych założeń działania aplikacji. Określanie już na wstępie warunków w jakich dana część kodu może być używana a w jakich nie. Zapewnienie spełniania podanych warunków przez metody w całym okresie tworzenia aplikacji.
Kontrakty w kodzie Geneza Założenia Kontrakty w języku Eiffel Co oznacza uzycie kontraktów przy pisaniu programu? Definiowanie formalnych znanych z OCLa warunków wejściowych, wyjściowych i inwariantów (niezmienników) dla metod programowych i klas je zawierających. Preconditions Postconditions Invariants
Kontrakty w języku Eiffel Geneza Założenia Kontrakty w języku Eiffel Eiffel językiem z natywnie zdefiniowanymi kontraktami Położenie dużego nacisku na definiowanie kontraktów jako nieodłącznych części kodu Instrukcje check, require, ensure jako odpowiednio inwarianty, pre i postconditions Inwarianty także dla warunków pętli (loop invariants)
Definiowanie specyfikacji Definiowanie specyfikacji Weryfikacja poprawności aplikacji Formalne zdefiniowanie założeń działania aplikacji Specyfikacja programowa ubrana w kontrakty What does it expect? What does it guarantee? What does it maintain? Problem? Wymaga wiedzy programisty o kontekście działania klasy
Definiowanie specyfikacji - Zasady Definiowanie specyfikacji Weryfikacja poprawności aplikacji Wazną zasadą łaczacą kontrakty z programowaniem obiektowym jest zasada dziedziczenia kontraktów. Klasa dziedzicząca kontrakt może: 1 Zachować lub zacieśnić warunki wejściowe metody 2 Zachować lub poszerzyć warunki wyjściowe metody 3 Zachować lub zacieśnić niezmienniki klasy require no more, promise no less
Weryfikacja poprawności aplikacji Definiowanie specyfikacji Weryfikacja poprawności aplikacji Jeden kontrakt opisuje wszystkie możliwe przypadki wykorzystania danej klasy. Może to być uznawane za pewną słabość praktyki, gdyż w przeciwieństwie do TDD nie pozwala na zagłębianie się w konkretne przypadki implementacji. Kontrakt jest jasno zdefiniowany i widoczny zarówno dla klienta jak i twórcy Aplikacje weryfikuje się tylko pod względem załozeń kontraktu
Zadania i benefity kienta i dostawcy Definiowanie specyfikacji Weryfikacja poprawności aplikacji Klient Nie musi sprawdzać wyjścia Kontrakt gwarantuje poprawność rezultatu Dba o zapewnienie poprawności danych wejściowych Dostawca Nie musi sprawdzać danych wejsciowych Kontrakt gwarantuje ich poprawność Zapewnia poprawny rezultat operacji
Kontrakt a test jednostkowy Wykorzystanie założeń kontraktów Kontrakt opisuje generalny przypadek testowy dla obejmowanej klasy Definiuje wartości wejściowe parametrów metod Służy jako wyrocznia opisująca warunki poprawności rezultatów metod
Wykorzystanie założeń kontraktów Wspomaganie praktyki testów jednostkowych Kontrakty jako pomocniczy element testowania jednostkowego Pomaga zdefiniować sensowne wartości wejściowe Określa kontekst wykorzystania klasy Ogranicza odpowiedzialność programisty - nie wychodzimy poza kontrakt Mozna na jego podstawie wyspecyfikować szczegółowe przypadki testowe
Asercje jako pseudokontrakty Asercje Narzędzia wspierające programowanie kontraktowe w Javie Jak działają Pozwalają testować założenia programu w samym kodzie Składają się z keywordu assert i wyrażenia logicznego definiującego warunek działania programu Mogą wywoływać metody Niespełnienie warunku wyrzuca AssertionError Wstępnie mogą być wykorzystane do imitacji pre- postconditions i inwariantów
Asercje - Przykład Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie Asercje bezpośrednio w kodzie // assert that the absolute value is >= 0 assert ( number >= 0 && number <= 10 ) : "bad number: " + number; Asercje w testach jednostkowych Assert.assertEquals(5, new Calc().add(2, 3));
Asercje - Problemy Asercje Narzędzia wspierające programowanie kontraktowe w Javie Wymagają pisania asercji w każdej metodzie Ograniczona możliwość kontroli Mogą zostać wyłączone (domyślnie wyłączone) Mimo wszystko stanowią dobry punkt wyjścia do implementacji kontraktów w Javie.
Narzędzia CDD w Javie Asercje Narzędzia wspierające programowanie kontraktowe w Javie Ułatwiają wprowadzenie w życie programowania kontraktowego w języku Java. Przykładowe narzędzia C4J contract4j icontract Każde z nich reprezentuje inne rozwiązanie definiowania kontraktów w kodzie programów języka Java.
C4J Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie Kontrakty jako klasy generyczne parametryzowane typem zakontraktowanej klasy Warunki pre, post i inwarianty jako metody z asercjami Enkapsulacja warunków kontraktu w tych metodach Dzięki parametryzacji klasy można odwoływać się do metod i pól zakontraktowanej klasy Wszystko pisane w standardowym kodzie Javy
C4J - Przykład Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie @ContractReference(contractClassName = "DummyContract") public class Dummy { protected List m_stuff = new LinkedList(); } public int additem(object item) { m_stuff.add(item); return m_stuff.size(); }
C4J - Przykład Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie public class DummyContract extends ContractBase<Dummy> { public DummyContract(Dummy target){ super(target); } public void classinvariant(){ assert m_target.m_stuff!= null; } public void pre_additem(object item) { super.setpreconditionvalue("list-size", m_target.m_stuff.size()); } public void post_additem(object item) { assert m_target.m_stuff.contains(item); int presize = super.getpreconditionvalue("list-size"); assert presize == m_target.m_stuff.size() - 1; assert m_target.m_stuff.size() == super.getreturnvalue(); } }
C4J Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie C4J - Wady i zalety: Odseparowanie kodu klasy od kontraktów Kontrakty pisane w kodzie Javy łatwa możliwość zmiany i odnajdywania błędów Możliwość wykorzystania mechanizmów Javy (np. dziedziczenia) na klasach kontraktów Dostępny plugin do eclipse Konieczność pisania dodatkowych linijek kodu
contract4j Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie Rozwiazanie odmienne od poprzedniego Biblioteka zawierająca warunki Pre, Post i Invarianty jako adnotacje klas i metod W adnotacji w Stringu pisze się warunki logiczne uzywając składni javy i paru słow kluczowych ($old, $result etc.) Wykorzystuje zdobycze programowania aspectowego (AspectJ) Aspekty przy akzdym wywołaniu metody lub odwolaniu się do pola sprawdzają warunki je opisujące
contract4j - Przykład Asercje Narzędzia wspierające programowanie kontraktowe w Javie @Contract interface BankAccount { @Post("$return >= 0"); float getbalance(); @Pre("amount >= 0") @Post("$this.balance == $old($this.balance)+amount && $return == $this.balance") float deposit(float amount); @Pre("amount >= 0 && $this.balance { amount >= 0") @Post("$this.balance == $old($this.balance)-amount && $return == $this.balance") float withdraw(float amount);... }
contract4j Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie contract4j - wady i zalety Proste i intuicyjne użycie Nie wymaga dużego nakładu pracy programisty Brak potrzeby uczenia się nowych technik pisania kodu Programista nie ma większej kontroli nad procesem sprawdzania kontraktów Konieczność podpinania pod projekt biblioteki aspektów W suchym Stringu ciężej można doszukać się błędów w opisie warunków
icontract Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie Podobne do contract4j Warunki zapisywane w dokumentacji klas i metod
icontract - Przykład Asercje Narzędzia wspierające programowanie kontraktowe w Javie /** * @inv!isempty() implies top()!= null // no null objects */ public interface Stack { /** * @pre o!= null * @post!isempty() * @post top() == o */ void push(object o); /** * @pre!isempty() * @post @return == top()@pre */ Object pop();... }
icontract Programowanie kontraktowe Asercje Narzędzia wspierające programowanie kontraktowe w Javie icontract - wady i zalety Proste w użyciu Pomaga w stworzeniu i utrzymaniu pełnej dokumentacji metod Wsparcie dla kwantyfikatorów logicznych Możliwość zdefiniowania licznych odseparowanych warunków dla tej samej metody lub pola Ciężko doszukać się w komentarzu błędów
Programowanie kontraktowe nie jest nowym podejsciem do tworzenia oprogramowania Pomaga w zapewnieniu spójności działania apliakcji z oczekiwaniami Ułatwia pracę i zmniejsza odpowiedzialność programisty Nie zastępuje testów jednostkowych ale je dopełnia
Źródła Programowanie kontraktowe Power of Design By Contract, http://www.eiffel.com/developers/design b y c ontract.htmlretokrame icontract: design by contract in java, http://www.javaworld.com/javaworld/jw-02-2001/jw-0216- cooltools.html C4J - CDD Java tool, http://c4j.sourceforge.net/ contract4j: Design by cotnract for Java, http://www.contract4j.org/contract4j
Przedstawienie uzycia bilbioteki contract4j jako narzedzia wspomagajacego wprowadzanie CDD w projekcie. Potrzebujemy: Eclipse IDE Aspect Development Tool for Eclipse www.eclipse.org/aspectj/ contract4j.jar www.contract4j.org/contract4j