URT Eclipse All in one

Transkript

1 URT Eclipse All in one Das Paket Eclipse All in one enthält Programme und Einstellungen, die zum Programmieren mit Eclipse in Zusammenarbeit mit Subversion und ANT benötigt werden. Dieses Paket dient als Grundlage für den Workflow, der im Anhang aufgezeigt ist. Im Einzelnen enthält das Paket: Java JDK Eclipse Installierte Eclipse-Plugins PHPEclipse Tools Core Polarion Subversive SVN Team Provider (etc.) FTP-Bibliotheken für ANT Download Das Paket kann im Typo3-Portal der Universität im Bereich Downloads / Eclipse herunter geladen werden. ( Installation Java Sofern nicht schon eine Java-VM ab Version 1.6 installiert ist, sollten Sie die bereitgestellte Java-VM installieren. Eclipse Die Eclipse Installation ist durch das Entpacken des selbst extrahierenden Archivs bereits erledigt. Plugins von Eclipse sind ohne Konfiguration benutzbar. Die Integration der Bibliotheken für ANT wird später erklärt.

2 Zum Konzept der Extensionentwicklung Neben dem unten angeführten Workflow hier noch einige Anmerkungen zum Workflow der Extensionentwicklung. Jede Extension wird als eigenständiges Projekt in Eclipse verwaltet. So erklärt sich auch die vorgegebene Basisstruktur des Verzeichnisses: build entwicklung produktiv Der build-ordner beinhaltet das build.xml, mit dem ANT angesteuert wird. Der Entwicklung-Ordner ist der zentrale Ordner, in dem Ihre Klassen und Dateien gespeichert werden. Der Produktiv-Ordner ist der Entwicklungsstand der Dateien, die im Moment im produktiven System verwendet werden. So können Unterschiede und/oder Fehler im laufenden Betrieb schneller gefunden werden, obwohl sich schon eine weitere Version in der Entwicklung befinden. Wenn eine neue Extension erstellt wird, besprechen Sie zunächst den Extentionkey mit den Typo3-Admins um einen eindeutigen Key zu finden. Die Typo3-Admins werden dann den entsprechenden Key als Verzeichnis in Subversion anlegen mit den Rechten ausstatten, die nötig sind um darauf zuzugreifen. Zweiter Schritt der Entwicklung wird daher das Einrichten eines neuen php-projekts in Eclipse sein, das später erklärt wird. Der Zugang zu Subversion wird durch die URT-Kennung validiert. Ebenso zum Wiki der Externen Entwickler. Der ftp-zugang auf den jeweiligen Test-Server wird als Gruppenzugang eine separate Kennung und Passwort sein.

3 Erstellen eines Projekts Nachdem Sie Eclipse das erste mal gestartet haben, wird es Sie nach einem Ort für den Workspace fragen. Dieser Workspace ist der lokale Speicherort der php-dateien. Geben Sie einen Workspaceort an oder wählen Sie den default-pfad. Wie oben erwähnt wird jede Extension in einem eigenen Projekt entwickelt. 1. Erstellen Sie ein PHP Projekt (File New PHP Project) 2. Geben Sie dem Projekt einen Namen (Ext-Key) und klicken dann auf "Finish". 3. Öffnen Sie das Kontextmenü des neuen, leeren Projektordners und wählen dort "Team Share Project" 4. Im Dialog wählen Sie den "SVN" Adapter und klicken auf "Next" 5. Geben Sie URL, Username und Password an URL: Benutzername und Passwort sind URT-Kennung und -Passwort 6. ganz WICHTIG: klicken Sie dann auf "NEXT"! (und nicht auf finish) 7. Wählen Sie folgende Optionen: (x) "Name on Repository: Use empty name" (x) "Project Repository Layout: Use single project layout" Häkchen entfernen: "Use Subversion recommended layout" Klicken Sie jetzt auf "Finish" 8. Falls schon Daten im Repository vorhanden sind, schlägt Eclipse vor diese herunterzuladen. Bestätigen Sie dies mit "yes". Eclipse lädt nun die vorhandenen Dateien in den lokalen Workspace. Dabei handelt es sich initial um die Verzeichnisstruktur und evtl. das default-build-file. Als nächstes sollten Sie die für Ihre Entwicklung relevanten Dateien aus dem Typo3 per copy und paste in die entsprechenden Folder des Workspace kopieren (File new php file). Meist sind dies die Dateien class.tx_<ext-key>_pi1.php im Ordner pi1 und index.php im Ordner mod1. Sinnvoll ist auch das mitführen und füllen des Changelog. Soweit zum Erstellen des Projekts im lokalen Workspace. Die weitere Nutzung von Subversion und Eclipse wird in der pdf Synchro_Eclipse_Svn.pdf erklärt.

4 Nutzung von ANT ANT ist ein Entwicklerwerkzeug von Eclipse, das hilft immer wiederkehrende Arbeitsschritte zu automatisieren. Hier verwenden wir ANT dazu Dateien aus dem Workspace per FTP auf den Webserver zu kopieren. ANT arbeitet dabei nur als Uploadclient. Gesteuert wird der Upload durch eine XML-Datei. Diese wird als build.xml im build-ordner bereitgestellt. Vom default-build-file sollte ersichtlich sein, welche Änderungen nötig sind um die eigenen Dateien an die eigene Installation zu schicken. Ändern Sie also nur die Zugangsdaten, den Server/-pfad und das Fileset. Da ANT nicht von Haus aus die Bibliotheken für den FTP-Upload beinhaltet, müssen zunächst einem ersten ANT-Build die nötigen Dateien hinzufügt werden. Diesen Schritt kann man später überspringen, in dem man den Build dupliziert und so diese Einstellung übernimmt. (Duplizieren: Rechtsklick auf einen vorhandenen Build Dublicate) Erstellen eines Builds 1. In Eclipse auf: Run External Tools Open External Tools Dialog klicken 2. In der Baumstruktur links wählen Sie Ant Build aus und im Context-Menü New 5. Geben Sie dieser Konfiguration (im weiteren auch Build genannt) einen sinnvollen Namen. 6. Beim ersten Build muss noch folgender Schritt gemacht werden. Wechseln Sie dann in den Tab Classpath und klicken Sie auf add external jars um die Dateien hinzuzufügen: /path/to/eclipse/plugins/org.apache.ant_1.6.5/lib/jsch jar, /path/to/eclipse/plugins/org.apache.ant_1.6.5/lib/jakarta-oro jar, /path/to/eclipse/plugins/org.apache.ant_1.6.5/lib/commons-net jar (Der Button wird aktiv, sobald Sie einen vorhandenen Wert markiert haben) 7. Im Tab Main geben Sie die build-datei an, die Sie verwenden wollen (Browse Workspace). Hier wählen Sie die XML-Datei im Build-Ordner aus. 8. Nun werden im Tab Targets die einzelnen Targets der XML-Datei aufgeführt und Sie wählen das Target aus, das Ihr Fileset hochläd. 9. Speichern Sie die Einstellungen des Builds mit Apply und lassen Sie es ein erstes mal ausführen ( Run ). In der Konsole von Eclipse wird ein Output des ANT-Builds erscheinen. Hier werden Sie auch über die erfolgreiche oder fehlerhafte Ausführung benachrichtigt. Häufige Fehler sind falsche Pfade in der XML-Datei. Die Fehlermeldung der Console gibt mit der Zeilennummer einen guten Hinweis auf die Fehlerquelle.

5 Hinweis: Sollte der FTP-Upload nicht funktionieren, kann es daran liegen, dass die ANT- Bibliotheken für FTP nicht in der ANT-Konfiguration verlinkt wurden oder gar nicht im Workspace existieren. Prüfen Sie daher, ob im Classpath des Builds folgende Dateien aufgeführt sind: jsch jar, jakarta-oro jar, commons-net jar Sollte das nicht der Fall sein, können Sie diese mit dem Befehl Add External JARs... im Tab Classpath hinzufügen.

6 Extensionkey festlegen Plugin schreiben Vorversion php-code ändern Review beauftragen U R T QA Review Installation im Produktivsystem Workflow Bild 1

7 SVN-Repository Synchronize vom SVN Commit ins SVN php-code schreiben Eclipse Upload per ANT (ftp) Typo3 Test - Webserver Workflow Bild 2