Vom lokalen Build zum Deployment

Transkript

1 Vom lokalen Build zum Deployment International PHP Conference Manuel Pichler Vom lokalen Build zum Deployment 1 / 36

2 Über mich Diplominformatiker Mehr als 10 Jahre Erfahrung im PHP-Umfeld Autor hinter einer Reihe von QA-Tools Qafoo passion for software quality Vom lokalen Build zum Deployment 2 / 36

5 Über mich Mitgründer von Diplominformatiker Mehr als 10 Jahre Erfahrung im PHP-Umfeld Autor hinter einer Reihe von QA-Tools Qafoo passion for software quality Vom lokalen Build zum Deployment 2 / 36

6 Über mich Mitgründer von Diplominformatiker Mehr als 10 Jahre Erfahrung im PHP-Umfeld Autor hinter einer Reihe von QA-Tools Qafoo passion for software quality We help people to create high quality PHP applications. Vom lokalen Build zum Deployment 2 / 36

7 Über mich Mitgründer von Diplominformatiker Mehr als 10 Jahre Erfahrung im PHP-Umfeld Autor hinter einer Reihe von QA-Tools Qafoo passion for software quality We help people to create high quality PHP applications. Vom lokalen Build zum Deployment 2 / 36

8 Outline Motivation Die Idee Anforderungen Features Roadmap Fazit Vom lokalen Build zum Deployment 3 / 36

9 Dezember 2009 Ausgangssituation Diverse Open-Source-Projekte PHP Depend PHPMD phpundercontrol staticreflection... Und viel zu wenig Zeit :-[ Vom lokalen Build zum Deployment 4 / 36

18 Warum? Einheitliche Strukturen? Vom lokalen Build zum Deployment 5 / 36

19 Warum? Einheitliche Strukturen? Naja Vom lokalen Build zum Deployment 5 / 36

20 Warum? Einheitliche Strukturen? Naja, Vielleicht Vom lokalen Build zum Deployment 5 / 36

21 Warum? Einheitliche Strukturen? Naja, Vielleicht doch nicht ;-] Vom lokalen Build zum Deployment 5 / 36

22 Build-Infrastruktur Jedes Projekt hatte ein individuelles Set an Skripten Aktualisiere die PEAR package.xml Datei Erzeuge ein PEAR- oder Phar-Archiv Generiere weitere Projekt-Artefakte Zusätzlich ein eigenes Ant build.xml Skript Führe die Tests aus Prüfe den Coding-Standard Sammle Softwaremetriken Erstelle einen Release... Vom lokalen Build zum Deployment 6 / 36

32 Probleme Unterschiedliche Kommandos Unterschiedliche Workflows Zeitaufwand beim Projektwechsel Wartungsaufwand der Buildumgebung DRY!? Don t Repeat Yourself Vom lokalen Build zum Deployment 7 / 36

39 Software Lifecycle Eigentlich besteht Lebenszyklus jeder Software immer aus den gleichen Bestandteilen Build Testing Dokumentation Qualitätssicherung Deployment Dependency-Management Vom lokalen Build zum Deployment 9 / 36

46 Convention over Configuration Andere machen es vor PEAR Zend-Framework PSR-0 Warum sollte dies nicht auch für eine Buildumgebung gelten Buildprozess Verzeichnisstruktur Versionierung Namensgebung Verteilung / Distribution Vom lokalen Build zum Deployment 10 / 36

56 Evaluiere existierende Lösungen Viel Recherche......brachte fast immer das gleiche Ergebnis Apache Maven Genauer die Konzepte und Konventionen Vom lokalen Build zum Deployment 11 / 36

61 Apache Maven Formalisiert den Buildprozess vollständig Setzt sehr stark auf Konventionen Definiert durchdachte Strukturen Modulare und Erweiterbare Architektur War sehr Java fokussiert War??? Heute gibt es das PHP for Maven Plugin Scheint mittlerweile aber leider unmaintained Vom lokalen Build zum Deployment 12 / 36

70 Buildwerkzeug Apache Ant als Basis Warum Ant und nicht Phing, Pake,...? Es gibt keinen wirklichen Grund Vom lokalen Build zum Deployment 14 / 36

73 Minimale Konfiguration Vom lokalen Build zum Deployment 15 / 36

76 Minimale Konfiguration build.xml 1 <?xml v e r s i o n= 1. 0 e n c o d i n g= UTF 8?> 2 <p r o j e c t name= PHP Depend b a s e d i r=. > 3 <property f i l e = b u i l d. p r o p e r t i e s /> 4 5 <import f i l e = s e t u p / s r c / main / xml / base. xml /> 6 </ p r o j e c t> build.properties 1 p r o j e c t. u r i = pdepend. org 2 p r o j e c t. name = pdepend 3 p r o j e c t. v e r s i o n = p r o j e c t. s t a b i l i t y = s t a b l e Vom lokalen Build zum Deployment 16 / 36

80 Fest definierte Buildschritte initialize compile test package integration-test verify install deploy Vom lokalen Build zum Deployment 17 / 36

88 Modulare Architektur Buildschritte und Abfolge geben die Grundstruktur vor Jeder Buildschritt soll non-invasiv erweiterbar sein Codegeneratoren Testwerkzeuge Distributionswerkzeuge QA-Tools Datenbank... Vom lokalen Build zum Deployment 18 / 36

97 Standardisierte Verzeichnisstruktur build/ dist/ logs/ src/ bin/ conf/ main/ js/ php/ resources/ test/ js/ php/ resources/ Vom lokalen Build zum Deployment 20 / 36

102 Environments I Es existiert immer ein Standard-Environment db. hostname = l o c a l h o s t 3 db. u s e r i d = r o o t 4 db. password = 5 db. name = dev db Für das Standard-Environment ist lediglich der Buildschritt anzugeben 1 $ ant d e p l o y Vom lokalen Build zum Deployment 21 / 36

103 Environments I Es existiert immer ein Standard-Environment db. hostname = l o c a l h o s t 3 db. u s e r i d = r o o t 4 db. password = 5 db. name = dev db Für das Standard-Environment ist lediglich der Buildschritt anzugeben 1 $ ant d e p l o y Vom lokalen Build zum Deployment 21 / 36

104 Environments II Es können frei weitere Environments hinzugefügt werden Jede Variable kann für das Environment redefiniert werden db. t e s t i n g. hostname = db01. t e s t. i n t e r n. example. com 3 db. t e s t i n g. u s e r i d = u s e r 4 db. t e s t i n g. password = password 5 db. t e s t i n g. name = t e s t i n g d b Über die Option commons.env lässt sich zusätzlich das Environment wählen 1 $ ant Dcommons. env=t e s t i n g d e p l o y Vom lokalen Build zum Deployment 22 / 36

107 Unabhängige Buildumgebung Ein Build der Software sollte möglich sein, ohne zuvor $X Abhängigkeiten installieren zu müssen PEAR ist fester Bestandteil der Buildumgebung Alle weiteren Pakete werden erst bei Bedarf installiert Dies erlaubt fest definierte Tool-Versionen je Projekt phpunit.package.name = phpunit codesniffer.package.name = php codesniffer Vom lokalen Build zum Deployment 23 / 36

110 Unabhängige Buildumgebung Ein Build der Software sollte möglich sein, ohne zuvor $X Abhängigkeiten installieren zu müssen PEAR ist fester Bestandteil der Buildumgebung Alle weiteren Pakete werden erst bei Bedarf installiert Kein händisches installieren von Paketen $ pear channel-discover pear.pdepend.org $ pear install --alldeps pdepend/php depend Dies erlaubt fest definierte Tool-Versionen je Projekt phpunit.package.name = phpunit codesniffer.package.name = php codesniffer Vom lokalen Build zum Deployment 23 / 36

115 Buildschritte I initialize Build Verzeichnisse erstellen Update aus der Versionskontrolle compile php -l auf Quelltext und Tests Nur geänderte Dateien werden geprüft test Ausführen der unittest Annotation package Zip-Archiv Optional PEAR-Archiv Optional Phar-Archiv Vom lokalen Build zum Deployment 24 / 36

127 Buildschritt: integrationtest Annotation Ausführen der Integrationstests In der Dev-Umgebung Gegen die Quellen im Zip-Archiv Optional gegen das Phar-Archiv Optional gegen das PEAR-Archiv Exkurs lokales PEAR $ pear config-create /foo /foo/pear.conf $ pear -c /foo/pear.conf config-set auto discover 1 $ pear -c /foo/pear.conf install --alldeps project.tgz Vom lokalen Build zum Deployment 25 / 36

137 Buildschritt: verify Erzeugung zeitaufwändiger Qualitätsreports Dynamische Analyse Code-Coverage Optional Profiling/Performance Analyse Statische Analyse Copy&Paste (PHPCPD) Coding Standard (CodeSniffer) Metriken (PHP Depend) Code Smells, Unused Code usw. (PHPMD) Vom lokalen Build zum Deployment 26 / 36

146 Buildschritt: install Lokale Installation Applikation Konfiguriertes Verzeichnis PEAR-Archiv Lokale PEAR-Installation Spezifiziertes Environment (Default Snapshot) Phar-Archiv TODO: Apache-Ivy Repository Vom lokalen Build zum Deployment 27 / 36

154 Buildschritt: deploy Remote Installation Applikation Konfigurierter Server + Verzeichnis Spezifiziertes Environment (Testing, Staging usw.) Optional Datenbank-Migration mit DbDeploy PEAR-Archiv Remote Pirum-Server Spezifiziertes Environment (Default Snapshot) Phar-Archiv TODO: Apache-Ivy Remote Repository Vom lokalen Build zum Deployment 28 / 36

164 Erweiterbarkeit I Die Abfolge der Buildschritte ist fest vorgegeben Jeder Buildschritt wird aber erst durch Erweiterungen mit Leben befüllt Je Buildschritt existiert ein Pre-Hook Und ein passender Post-Hook Hierdurch können projektspezifische Tasks in den Build integriert werden. Eine Reihe von Tasks sind von Haus aus bereits integriert PHPUnit PHPMD, PHPCPD, CodeSniffer,... PEAR- & Phar-Packaging Pirum Vom lokalen Build zum Deployment 29 / 36

174 Erweiterbarkeit II Seit Version 1.8 gibt es in Apache-Ant die so genannten Extension-Points. Ein praktischer Mechanismus für modulare Buildskripte 1 <p r o j e c t name= Build Commons Deploy > 2 <t a r g e t name= d e p l o y 3 depends= d e p l o y : b e f o r e hook, 4 d e p l o y : d e p l o y, 5 d e p l o y : a f t e r hook /> 6 7 <extension p o i n t name= d e p l o y : b e f o r e hook /> <extension p o i n t name= d e p l o y : a f t e r hook /> 11 <t a r g e t name= d e p l o y : d e p l o y >... </ t a r g e t> 12 </ p r o j e c t> Vom lokalen Build zum Deployment 30 / 36