Softwarequalität in PHP-Projekten

Transkript

1 Sebastian Bergmann Stefan Priebsch Softwarequalität in PHP-Projekten HANSER

2 Inhaltsverzeichnis I Grundlagen 1 1 Software-Qualität Was ist Software-Qualität? Externe Qualität Interne Qualität Technical Debt Konstruktive Qualitätssicherung Sauberer Code ' Explizite und minimale Abhängigkeiten ' Klare Verantwortlichkeiten Keine Duplikation Kurze Methoden mit wenigen Ausführungszweigen Software-Metriken Zyklomatische Komplexität und NPath-Komplexität Change Risk Anti-Patterns (CRAP) Index Non-Mockable Total Recursive Cyclomatic Complexity Global Mutable State Kohäsion und Kopplung Werkzeuge Fazit 16 2 Testen von Software Black-Box-und White-Box-Tests Wie viele Tests braucht man? Systemtests Testen im Browser 20

3 VI Inhaltsverzeichnis Automatisierte Tests Testisolation Akzeptanztests Grenzen von Systemtests Unit-Tests Rückgabewerte Abhängigkeiten Seiteneffekte Praxisbeispiel Den zu testenden Code analysieren Eine Testumgebung aufbauen Globale Abhängigkeiten vermeiden Unabhängig von Datenquellen testen Asynchrone Vorgänge testen Änderungen in der Datenbank speichern Nicht vorhersagbare Ergebnisse Eingabedaten kapseln Weiterführende Überlegungen Fazit 62 II Best Practices 63 3 TYPO3: die agile Zukunft eines schwergewichtigen Projekts Einführung Die Geschichte von TYPO3-13 Jahre in 13 Absätzen Den Neuanfang wagen! Unsere Erfahrungen mit dem Testen Grundsätze und Techniken Bittersüße Elefantenstückchen Testgetriebene Entwicklung Tests als Dokumentation ' Kontinuierliche Integration Sauberer Code Refaktorierung Programmierrichtlinien 77

4 Inhaltsverzeichnis _, VII Domänengetriebenes Design Vorgehen bei der Entwicklung...' Neuen Code entwickeln Code erweitern und ändern Code optimieren Fehler finden und beheben ' Alten Code fachgerecht entsorgen Testrezepte Ungewollt funktionale Unit-Tests Zugriffe auf das Dateisystem Konstruktoren in Interfaces Abstrakte Klassen testen Testen von geschützten Methoden Verwendung von Callbacks Auf in die Zukunft 92 4 Bad Practices in Unit-Tests Einführung Warum guter Testcode wichtig ist Bad Practices und Test-Smells Duplizierter Testcode Zusicherungsroulette und begierige Tests Fragile Tests Obskure Tests Lügende Tests Langsame Tests Konditionale Logik in Tests Selbstvalidierende Tests Websurfende Tests Mock-Overkill Skip-Epidemie Fazit Qualitätssicherung bei Digg 123 ' 5.1 Die Ausgangssituation Unsere Probleme 123

5 VIII Inhaltsverzeichnis Code-Altlasten Wie lösen wir unsere Probleme? Ein Test-Framework, wählen Mit einem Experten arbeiten Das Team trainieren Testbaren Code schreiben Statische Methoden vermeiden Dependency Injection Mock-Objekte Überblick Datenbank Lose gekoppelte Abhängigkeiten Beobachter für klasseninternes Verhalten Memcache Mocken einer serviceorientierten Architektur Der Qualitätssicherungsprozess bei Digg Testen Vorteile Herausforderungen Fazit 152 III Server und Services Testen von serviceorientierten APIs Die Probleme API-Zugangskennungen API-Beschränkungen Service-Protokolle offline testen Konkrete Services offline testen Fazit Wie man einen WebDAV-Server testet Über die ez WebDAV-Komponente WebDAV Architektur 180

6 Inhaltsverzeichnis IX 7.2 Herausforderungen bei der Entwicklung Anforderungsanalyse TDD nach RFC Den Server testen Automatisierte Akzeptanztests mit PHPUnit Test-Trails aufzeichnen Das Testrezept ' Integration mit PHPUnit Fazit 201 IV Architektur Testen von Symfony und Symfony-Projekten Einführung Ein Framework testen Der Release-Management-Prozess von Symfony Verhältnis von Testcode und getestetem Code Die Ausführung der Testsuite muss schnell sein Gesammelte Erfahrungen Testen von Webanwendungen Die Hemmschwelle für das Testen abbauen Unit-Tests Funktionale Tests Fazit Testen von Grafikausgaben Einführung Entwicklungsphilosophie Die ezcgraph-komponente Architektur Anforderungen an die Tests Ausgabetreiber durch Mock-Objekt ersetzen Mehrfache Erwartungen Structs Generierung der Erwartungen 238

7 X Inhaltsverzeichnis Zusammenfassung Binäre Ausgaben testen Die Ausgabetreiber Generierung der Erwartungen SVG Bitmap-Erzeugung Flash Fazit Testen von Datenbank-Interaktionen Einführung Pro und Kontra Was gegen Datenbanktests spricht Warum wir Datenbanktests schreiben sollten Was wir testen sollten Datenbanktests schreiben Die Datenbankverbindung mocken Die Datenbankerweiterung von PHPUnit Die Klasse für Datenbanktestfälle Die Verbindung zur Testdatenbank aufbauen Datenbestände erzeugen Operationen auf den Daten Tests schreiben Den Datenbanktester benutzen Testgetriebene Entwicklung und Datenbanktests Datenbanktests als Regressionstests Probleme mit den Daten testen Probleme testen, die durch Daten sichtbar werden Zusammenfassung 298 V QA im Großen Qualitätssicherung bei studivz Einführung Akzeptanztests 303

8 Inhaltsverzeichnis XI Selenium Die Selenium-Erweiterung von PHPUnit Technisches Setup von studivz Codeumgebung Testumgebung Best Practices Jugendsünden Strategiewechsel Eine DSL muss her Interne DSL Testing-SeleniumDSL Testing_SeleniumDSL ein Entwurf Fazit Kontinuierliche Integration Einführung Kontinuierliche Integration Statische Analyse Installation und Inbetriebnahme Konfiguration Statische Tests Dynamische Tests Reporting Deliverables erzeugen Betrieb " Weiterführende Themen Continuous Deployment Einen Reverse Proxy nutzen Kontinuierliche Integration und agile Paradigmen Fazit swoodoo - eine wahrhaft agile Geschichte Einführung Evolution: Nur die Starken überleben Wie wir die "extreme Seite" erreichten Kontinuierliche Integration 380

9 XII Inhaltsverzeichnis Testgetriebene Entwicklung Tägliche Standup-Meetings Und wo wir schon einmal dabei sind User Storys und Story Points Velocity Iterationsplanung Programmieren in Paaren Kollektives Eigentum Offenheit für Änderungen Überstunden Die Kunst der Evolution KISS und YAGNI - zwei Seiten einer Medaille Evolutionstheorie und Fazit 398 VI Nichtfunktionale Aspekte Gebrauchstauglichkeit Einführung Anything goes - aber zu welchem Preis? Designaspekte Barrierefreiheit Lesbarkeit Label für Formularelemente Tastaturbedienbare Webseite " Gute Farbkontraste Logo zur Startseite verlinken Alternativtexte für Bilder Hintergrundbild mit Hintergrundfarbe Druckversion nicht vergessen Erkennbare Links Gute Bookmarks Keine Frames Skalierbare Schrift 412 ' 14.4 Technische Aspekte Performanz 412

10 Inhaltsverzeichnis XIII JavaScript Benutzerführung Der Mythos des Falzes Feedback bei Interaktionen Navigation Popups und andere Störenfriede Gewohnheiten bedienen, Erwartungen nicht enttäuschen Fehlertoleranz und Feedback Testen der Usability Fazit Performanz Einführung Werkzeuge Umgebungsbezogene Gesichtspunkte Lasttests Apache Bench Pylot Weitere Werkzeuge für Lasttests Profiling Callgrind APD Xdebug XHProf OProfile V Systemmetriken strace Sysstat Lösungen im Eigenbau Übliche Fallstricke Entwicklungsumgebung gegen Produktivumgebung CPU-Zeit Mikro-Optimierungen PHP als Glue Language Priorisierung von Optimierungen Fazit 452

11 XIV Inhaltsverzeichnis 16 Sicherheit Was ist eigentlich Sicherheit? Secure by Design Der Betrieb Physikalischer Zugang Software-Entwicklung Was kostet Sicherheit? Die häufigsten Probleme A10 - Transportschicht A9 - Kryptografie A8 - Weiterleitungen A7 - Zugriffsschutz A6 - Konfiguration A5 - Cross Site Request Forgery (CSRF/XSRF) A4 - Direkte Zugriffe A3 - Authentifizierung und Session-Management A2 - Cross Site Scripting (XSS) Al - Injections Fazit 473 VII Schlussbetrachtungen 475 Stichwortverzeichnis 489