Codequalitätskontrolle mit SonarQube

Transkript

1 Codequalitätskontrolle mit SonarQube

2 Wer ist das? Josha von Gizycki Goslarer Seit 2008 bei der Java, Oracle, Webentwicklung, Hacker, Zocker, Rocker Codequalitätskontrolle mit SonarQube - 2

3 Warum der? Codequalitätskontrolle mit SonarQube - 3

4 Typische Fehler im Alltag Keine Tests Zeitdruck Legacy Code Basteln Codequalitätskontrolle mit SonarQube - 4

5 Was ist das Ergebnis? Big Ball of Mud? Gasfabrik? Spaghetticode mit Copy Pasta? Innere Plattform? Sumo-Hochzeit? Codequalitätskontrolle mit SonarQube - 5

6 Was macht statische Codeanalyse? Bytecode oder Quelltext Nutzt Metriken Generiert Statistiken Codequalitätskontrolle mit SonarQube - 6

7 Was ist statische Codeanalyse? Bytecode Quelltext Quelltext Bugs Ineffizienz Codestil Harte Fehler Handwerk Konventionen Codequalitätskontrolle mit SonarQube - 7

8 Metriken? Lat. ars metrica : Lehre von den Maßen Codequalitätskontrolle mit SonarQube - 8

9 Softwaremetriken Mathematische Funktion Code Vergleichbarkeit Eine Softwarequalitätsmetrik ist eine Funktion, die eine Software-Einheit in einen Zahlenwert abbildet, welcher als Erfüllungsgrad einer Qualitätseigenschaft der Software-Einheit interpretierbar ist. IEEE Standard 1061, 1998 Codequalitätskontrolle mit SonarQube - 9

10 McCabe Zyklomatische Komplexität Anzahl unterschiedlicher Möglichkeiten, durch ein Stück Code zu laufen 1 + Anzahl Kontrollstrukturen + Boolesche Operatoren if, while, do, for,?:, catch, case &&, Grenzwerte 10 für Methoden 200 für Klassen Codequalitätskontrolle mit SonarQube - 10

11 McCabe Zyklomatische Komplexität String wochentagsname(int nummer) { switch(nummer) { case 1: return "Montag"; case 2: return "Dienstag"; case 3: return "Mittwoch"; case 4: return "Donnerstag"; case 5: return "Freitag"; case 6: return "Samstag"; case 7: return "Sonntag"; } return ""; } String wochentagsname(int nummer) { String[] tage = new String[] { "Montag", "Dienstag", "Mittwoch", "Donnerstag", "Freitag", "Samstag", "Sonntag"}; int len = tage.length; if (nummer >= 1 && nummer <= len) { return tage[nummer - 1]; } return ""; } Codequalitätskontrolle mit SonarQube - 11

12 Mehrwert Quantitative / Qualitative Einschätzung der Codebasis Argumentationsgrundlage gegenüber Entscheidern Risikoabschätzung Teamorganisation Codequalitätskontrolle mit SonarQube - 12

13 SonarQube Scanner Datenbank Web-Komponente Codequalitätskontrolle mit SonarQube - 13

14 SonarQube OpenSource unter LGPL v3 Integriert unter anderem PMD, Checkstyle, Findbugs Plugins Sprachen (Java, Javascript, PHP, ) SCM (Git, Subversion, Mercurial, ) GitHub (Authentifikation, Pull Requests) Codequalitätskontrolle mit SonarQube - 14

15 Code Smell Cyclomatic Complexity Deprecated code should be removed eventually Silly math should not be performed Codequalitätskontrolle mit SonarQube - 15

16 Vulnerability public static fields should be constant Credentials should not be hard-coded Values passed to SQL commands should be sanitized Codequalitätskontrolle mit SonarQube - 16

17 Bugs Classes should not be compared by name Loops should not be infinite Null pointers should not be dereferenced Codequalitätskontrolle mit SonarQube - 17

18 Auswertung Codequalitätskontrolle mit SonarQube - 18

19 Auswertung Codequalitätskontrolle mit SonarQube - 19

20 Auswertung Codequalitätskontrolle mit SonarQube - 20

21 Auswertung Codequalitätskontrolle mit SonarQube - 21

22 Auswertung Codequalitätskontrolle mit SonarQube - 22

23 Auswertung Codequalitätskontrolle mit SonarQube - 23

24 Auswertung Codequalitätskontrolle mit SonarQube - 24

25 Auswertung Codequalitätskontrolle mit SonarQube - 25

26 Auswertung Codequalitätskontrolle mit SonarQube - 26

27 Quality Gates Codequalitätskontrolle mit SonarQube - 27

28 Quality Gates - GitFlow Codequalitätskontrolle mit SonarQube - 28

29 Interpretation Relative Werte > Absolute Werte Änderungen > Status Quo Metriken verstehen Metriken in Relation zueinander stellen Codequalitätskontrolle mit SonarQube - 29

30 Lines of Code Lines of Code - LOC Source Lines of Code SLOC Comment Lines of Code CLOC Non-Comment Lines of Code NCLOC Logical Lines of Code - LLOC Codequalitätskontrolle mit SonarQube - 30

31 Metriken in Relation setzen DTO search(list<list<dto>> rawdata, int id) { if(rawdata!= null) { for(list<dto> sublist : rawdata) { for(dto dto : sublist) { if(dto.getid() == id) { return dto; } } } } return null; } Codequalitätskontrolle mit SonarQube - 31

32 Metriken in Relation setzen DTO search(list<list<dto>> rawdata, int id) { if(rawdata == null) { return; } } for(list<dto> sublist : rawdata) { for(dto dto : sublist) { if(dto.getid() == id) { return dto; } } } return null; Codequalitätskontrolle mit SonarQube - 32

33 Metriken in Relation setzen void printnumbers() { for(int i = 0; i < 10; ++i) { if(i % 2 == 0) { continue; } if(i % 3 == 0) { continue; } System.out.println(i); } } Codequalitätskontrolle mit SonarQube - 33

34 Metriken in Relation setzen void printnumbers() { for(int i = 0; i < 10; ++i) { if(i % 2 == 0 i % 3 == 0) { continue; } System.out.println(i); } } Codequalitätskontrolle mit SonarQube - 34

35 SQALE - ISO 9126 Codequalitätskontrolle mit SonarQube - 35

36 Maintainability Rating A: 0 0,1 B: 0,11 0,2 C: 0,21 0,5 D: 0,5 1 E: > 1 Technical Debt / Development Cost Projektgröße: LOC Technische Schuld: 50 Tage 50 / (0.06 * 2.500) = 0,33 Codequalitätskontrolle mit SonarQube - 36

37 Erfahrungswerte Mit ausreichend großer Codebasis erreichen viele Legacy-Projekte ein A-Rating Codequalitätskontrolle mit SonarQube - 37

38 Erfahrungswerte Codequalitätskontrolle mit SonarQube - 38

39 Erfahrungswerte For every 30 rule violations, you can expect on average three minor bugs and one major bug Embedded Programmer Codequalitätskontrolle mit SonarQube - 39

40 Erfahrungswerte Live mit SonarQube zu arbeiten, kann zu Gasfabriken führen Codequalitätskontrolle mit SonarQube - 40

41 Das heißt? Statistiken sind interessant Qualitätserhöhung Teammotivation Messbare Qualität für Kunden Codequalitätskontrolle mit SonarQube - 41

42 Codequalitätskontrolle mit SonarQube - 42

43 Buffet ist eröffnet! Codequalitätskontrolle mit SonarQube - 43

44 Ich hab da mal was vorbereitet Codequalitätskontrolle mit SonarQube - 44

45 Josha von Gizycki Logindaten: jug / Codequalitätskontrolle mit SonarQube - 45