TDLCR Test Driven Legacy Code Refactoring

Transkript

1 TDLCR Test Driven Legacy Code Refactoring Orientation in Objects GmbH Weinheimer Str Mannheim Java Forum Nord Hannover, Version:

2 Abstract Bestandsanwendungen müssen gewartet und ggf. weiterentwickelt werden, bergen aber meist viele Defekte. Als Entwickler fürchten wir uns zudem, mehr Schaden anzurichten, weil das Verständnis für den Legacy Code fehlt. Refactoring kann zum Verstehen beitragen, endet aber aufgrund der typischerweise fehlenden automatisierten Tests in einem Blindflug. Mit testgetriebener Entwicklung scheint es eine Allzweckwaffe für gutes Design und eine geringe Fehlerrate zu geben. Aber TDD und Legacy Code scheinen sich eigentlich auszuschließen. Anhand von Live Coding schauen wir, wie die testgetriebene Entwicklung trotzdem helfen kann, den Code ohne allzu große Bauchschmerzen anzupassen. Schöner Nebeneffekt wird das Entstehen eines automatisierten Testbetts sein, welches zukünftige Refactorings leichter machen wird. Orientation in Objects GmbH Test Driven Legacy Code Refactoring 2

3 Über mich Falk Sippach Trainer, Berater, Entwickler Co-Organisator Schwerpunkte Architektur Agile Softwareentwicklung Codequalität Orientation in Objects GmbH Test Driven Legacy Code Refactoring 3

4 Java, XML und Open Source seit 1998 ) Software Factory ) ) Object Rangers ) ) Competence Center) Schlüsselfertige Realisierung von Java Software Individualsoftware Pilot- und Migrationsprojekte Sanierung von Software Software Wartung Unterstützung laufender Java Projekte Perfect Match Rent-a-team Coaching on the project Inhouse Outsourcing Schulungen, Coaching, Weiterbildungsberatung, Train & Solve-Programme Methoden, Standards und Tools für die Entwicklung von offenen, unternehmensweiten Systemen Orientation in Objects GmbH Test Driven Legacy Code Refactoring 4

5 TDLCR Legacy Code Orientation in Objects GmbH Test Driven Legacy Code Refactoring 5

6 Vermächtnis Erbe Altlast Hinterlassenschaft Foto von smpcas, CC0 Public Domain Lizenz, Orientation in Objects GmbH Test Driven Legacy Code Refactoring 6

7 Greenfield, Agile, TDD, // TODO: refactor this Orientation in Objects GmbH Test Driven Legacy Code Refactoring 7

8 Was ist Legacy Code? Alter Code, geerbter Code, Code den niemand mehr versteht "Some crap made by someone else" Code entstanden unter Zeitdruck und ohne automatisierte Tests Was ist mit unserem eigenen Code? Technische Schulden Orientation in Objects GmbH Test Driven Legacy Code Refactoring 8

9 Warum Legacy Code anfassen? Verstehen Erweitern Bugfixing Optimierung Orientation in Objects GmbH Test Driven Legacy Code Refactoring 9

10 J. B. Rainsberger Legacy code is valuable code that we feel afraid to change. Foto von PublicDomainPictures, CC0 Public Domain Lizenz, Orientation in Objects GmbH Test Driven Legacy Code Refactoring 10

11 Legacy Code Dilemma Code without tests is bad code. Michael Feathers Orientation in Objects GmbH Test Driven Legacy Code Refactoring 11

12 refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu Henne-Eiverstehen könnte man Code refactoren, um Code zu refactoren bräuchte Problem man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu Orientation in Objects GmbH Test Driven Legacy Code Refactoring 12

13 um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten Die Katze müßtebeißt man refactoren, sich um zu refactoren könnte man Tests schreiben, in um den Tests Schwanz! zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refact Orientation in Objects GmbH Test Driven Legacy Code Refactoring 13

14 TDLCR Test Driven Refactoring Orientation in Objects GmbH Test Driven Legacy Code Refactoring 14

15 TDD hilft beim Verbessern des Codes Orientation in Objects GmbH Test Driven Legacy Code Refactoring 15

16 Test Driven Development RED REFACTOR GREEN Orientation in Objects GmbH Test Driven Legacy Code Refactoring 16

17 "Gesetze" von TDD Schreibe einen fehlschlagenden Test, bevor du Code für das Produktivsystem verfasst. Schreibe nur so viel Code für den Test, damit er kompiliert (Rot) Schreibe nur so viel Code, um den Test zu bestehen (Grün) Refactor: Duplikation entfernen Orientation in Objects GmbH Test Driven Legacy Code Refactoring 17

18 Wo kann TDD bei Legacy Code helfen? Verstehen Erweitern Bugfixing Optimierung Orientation in Objects GmbH Test Driven Legacy Code Refactoring 18

19 TDD vs. Legacy Code Test vor dem Code vs. Code schon da Orientation in Objects GmbH Test Driven Legacy Code Refactoring 19

20 TDLCR Test Driven Legacy Code Refactoring Orientation in Objects GmbH Test Driven Legacy Code Refactoring 20

21 Erweitern Strategie 1: Edit and Pray! Foto von Myriams-Fotos: (CC0 Public Domain Lizenz) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 21

22 Erweitern Strategie 2: Canary in the coal mine Orientation in Objects GmbH Foto von janjf93: Test Driven Legacy Code Refactoring (CC0 Public Domain 22Lizenz)

23 1 2 3 Sicherheitsnetz Neue Funktionalität mit TDD Testen des Bestands-Codes Orientation in Objects GmbH Test Driven Legacy Code Refactoring 23

24 1 Sicherheitsnetz Foto von bella67: (CC0 Public Domain Lizenz) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 24

25 Golden Master gegenwärtiges Verhalten dokumentieren und erhalten Foto von istara: (CC0 Public Domain Lizenz) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 25

26 Orientation in Objects GmbH Test Driven Legacy Code Refactoring 26

27 Konsolenausgaben abprüfen Orientation in Objects GmbH Test Driven Legacy Code Refactoring 27

28 Was mache ich bei GUI-Anwendungen? 2 3 public static void main(string... args) throws Exception { WebDriver driver = new FirefoxDriver(); driver.get(" while (true) { List<WebElement> links = driver.findelements(by.tagname("a")); links.get(random.nextint(links.size())).click(); Thread.sleep(500); List<WebElement> fields = driver.findelements(by.xpath("//input[@type='text']")); WebElement field = fields.get(random.nextint(fields.size())); field.sendkeys(randomstring()); Thread.sleep(500); } } Orientation in Objects GmbH Test Driven Legacy Code Refactoring 28

29 2 Neue Features ausliefern Foto von PublicDomainPictures: (CC0 Public Domain Lizenz) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 29

30 Aufhören Legacy Code zu schreiben! sonst wird die Codebasis nur schlimmer und man entfernt sich immer mehr davon, jemals Tests hinzuzufügen Keine neuen Features mehr ohne Unit-Testing! Sprout Method + Wrap Method als Hilfen Orientation in Objects GmbH Test Driven Legacy Code Refactoring 30

31 Sprout Method public int berechne(int a, int b) { } int c = a + b; // weitere wichtige Aufgaben // neues Verhalten return verdoppeleresult(c); testgetrieben entwickeln protected int verdoppeleresult(int result) {...} neues Feature in eigene Methode Orientation in Objects GmbH Test Driven Legacy Code Refactoring 31

32 Sprout Method und TDD (1) // nicht kompilierenden Test public void testverdoppeleresult() { assertequals(2, rechner.verdoppeleresult(1); } // Kompilerfehler protected int verdoppeleresult(int result) { return 0; } // Test ist rot Orientation in Objects GmbH Test Driven Legacy Code Refactoring 32

33 Sprout Method und TDD (2) // einfachste Lösung, damit Test grün wird protected int verdoppeleresult(int result) { return 2; } // nichts zu refactoren // von vorn beginnen, weiteren Test schreiben public void testverdoppeleresult() { assertequals(2, rechner.verdoppeleresult(1); assertequals(4, rechner.verdoppeleresult(2); } Orientation in Objects GmbH Test Driven Legacy Code Refactoring 33

34 Tipps TDD kleine Schritte Workflow (Red Green - Refactor) einhalten Ideen für weitere Testfälle in eine Liste schreiben und nach und nach abarbeiten (kleine Schritte!) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 34

35 Wrap Method ähnlich zu Sprout Method, neues Verhalten aber vor oder am Ende der zu ändernden Methode public int berechne(int a, int b) { logresult(c); return berechneprivate(a, b); } private int berechneprivate(int a, int b) { int c = a + b; // weitere wichtige Aufgaben return c; } protected void logresult(int result) {...} Orientation in Objects GmbH Test Driven Legacy Code Refactoring 35

36 Live-Coding Foto von StockSnap: (CC0 Public Domain Lizenz) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 36

37 3 Bestandscode testen, aber: kein TDD möglich teuer und langwierig Code meist kaum/nicht testbar Orientation in Objects GmbH Foto von geralt: Test Driven Legacy Code Refactoring (CC0 Public Domain Lizenz) 37

38 1. Identify what to change 2. Identify what to test 3. Break dependencies 4. Write the tests 5. Modify and refactoring Orientation in Objects GmbH Foto von olafpictures: Test Driven Legacy Code Refactoring (CC0 Public Domain Lizenz) 38

39 Seam (Nahtstelle) Ein Seam ist eine Stelle, an der man das Verhalten editieren kann, ohne direkt an dieser Stelle zu ändern. Aufbrechen stark gekoppelter Abhängigkeiten aka Subclass and Extract aka Extract and Override Call aka (weitere verschiedene Varianten) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 39

40 Subclass and Override es gibt protected Methoden für die externen Dependencies in einer Subklasse mit leerem oder speziellem Inhalt überschreiben Verwenden der Subklasse in den Tests public void saveorder(int orderid) { Order order = orderrepository.getorderbyid(orderid); getorderchanges(); saveordertofile(order); } protected void saveordertofile(order order) { } // File IO Orientation in Objects GmbH Test Driven Legacy Code Refactoring 40

41 Subclass and Override (2) public class OrderServiceForTests extends OrderService protected void saveordertofile(order order) { // nichts tun (keine IO, keine externen Dependenies) } } // oder order-parameter extern überprüfbar machen Orientation in Objects GmbH Test Driven Legacy Code Refactoring 41

42 Extract and Override Call zu überschreibenden Code zunächst herauslösen (Extract Method) dann wie Subclass and Override public void sendorderconfirmation(int orderid) { Order order = orderrepository.getorderbyid(orderid); Mail = new MailMessage(defaultSender, subject,...)); } smtpclient.send( ); Orientation in Objects GmbH Test Driven Legacy Code Refactoring 42

43 Extract and Override Call zu überschreibenden Code zunächst herauslösen (Extract Method) dann wie Subclass and Override public void sendorderconfirmation(int orderid) { Order order = orderrepository.getorderbyid(orderid); Mail = new MailMessage(defaultSender, subject,...)); } smtpclient.send( ); Orientation in Objects GmbH Test Driven Legacy Code Refactoring 43

44 Extract Pure Method/Function Codestellen isolieren Ziel: separat testen, Duplikation reduzieren Vorteil von reinen Methoden: seiteneffektfrei, keine Statusänderung Vorsicht: wir müssen Code ändern bevor Tests da sind immer kleine Schritte, Tools/IDEs für das Refactoring verwenden Extract Method ist typischerweise sicher Orientation in Objects GmbH Test Driven Legacy Code Refactoring 44

45 Extract Interface Klasse extrahieren (Methode verschieben) Interface herausziehen Aufrufer ändern und das Interface verwenden leichter austauschbar gegen Dummy, Stub, Mock Orientation in Objects GmbH Test Driven Legacy Code Refactoring 45

46 Viele weitere Refactorings für Legacy Code Orientation in Objects GmbH Test Driven Legacy Code Refactoring 46

47 Weitere Tools/Hilfsmittel private Methoden testen nicht schön, aber praktisch per Reflection oder mit Frameworks z. B. private Pure- und Sprout-Methoden testen Mocking Exctract and Override und noch mächtiger Interaktion mit Umgebung testen erwartete Parameter und Aufrufreihenfolge sicherstellen Orientation in Objects GmbH Test Driven Legacy Code Refactoring 47

48 Tools Code Coverage Approval Tests Infinitest Eclipse Metrics Orientation in Objects GmbH Test Driven Legacy Code Refactoring 48

49 Legacy Code Retreat Foto von Jmabel: (CC BY-SA 3.0 Lizenz) Orientation in Objects GmbH Test Driven Legacy Code Refactoring 49

50 Links Code-Beispiel der Live-Demo Refactoring anderes Code-Beispiel für Legacy Code Blog: Techniken zu Legacy Code-Retreat Orientation in Objects GmbH Test Driven Legacy Code Refactoring 50

51 Literaturhinweise Refactoring Sprache: Englisch Gebunden Seiten - Addison Wesely Erscheinungsdatum: 1. Juni 1999 ISBN: Working Effectively with Legacy Code Sprache: Englisch Gebunden Orientation in Objects GmbH Test Driven Legacy Code Refactoring 51

52 ??? Fragen?? Orientation in Objects GmbH? Weinheimer Str Mannheim

53 Vielen Dank für Ihre Aufmerksamkeit! Orientation in Objects GmbH Weinheimer Str Mannheim