© Excellent backgrounds/Shutterstock.com
Continuous Integration mit Liferay 6.1

Lean back and deploy!


Liferay ist ein vielseitiges Content-Management-System und einfach mit dynamischem Content erweiterbar. Daher wird es oft für Intranet und andere interne Anwendungen genutzt, die mehr als ein Wiki bieten sollen. Mit der Zeit wurden die dynamischen Inhalte stetig erweitert, sodass die Notwendigkeit von häufigen Deployments von Portlets besteht. Da aber in vielen Unternehmen beim Deployment die Arbeit oft manuell durchgeführt wird, entstehen lange Betriebsanleitungen, die beschreiben, welche Pages erstellt werden, welche Rollen diesen Pages zugewiesen werden, welche Präferenzen für die Anzeige und welche Portlets auf welche Pages platziert werden sollen. Mit dem Liferay-API lassen sich diese Prozesse automatisieren. Dabei können die gleichen Methoden praktisch auf jedem Web Application Server benutzt werden, der mindestens JSR 53 implementiert.

Im Folgenden sollen drei Bereiche thematisiert werden:

  • Continuous-Integration-Tools und ihre Voraussetzungen

  • Continuous Integration auf einem Web Application Server für Liferay

  • Continuous Integration mit Liferay

Continuous Integration mit Liferay werden wir als unabhängig vom Web Application Server betrachten, weil Continuous Integration Recipes, die hier für Liferay dargestellt werden, problemlos genauso unter Apache Tomcat, WebLogic, JBoss oder WebSphere angewendet werden können.

Liferay hat eine relativ spezifische Lösung für Deployment-Prozesse, indem es die .war-Dateien in einem deploy-Verzeichnis verwaltet. Das erklärt sich dadurch, dass Liferay diese .war-Datei bearbeitet, eventuell mit eigenen tld-Dateien anreichert und web.xml abändert. Die Standard-.war-Applikationen werden im Gegensatz dazu einfach so übernommen, wie sie verpackt sind. Sie werden nur ausgepackt und ausgeführt. Standardapplikationen werden auch nicht in spezifischen deploy-Verzeichnissen von Liferay abgelegt, sondern im Web-Application-Verzeichnis. Das ist zum Beispiel entweder das webapp in Tomcat oder das Domain-Verzeichnis unter WebLogic.

Dieser Artikel geht nicht auf das Thema Unit und Integration Testing ein. Natürlich ist ein ausreichendes automatisches Testing eine Grundvoraussetzung für CI und wird daher als selbstverständlich vorausgesetzt.

Continuous-Integration-Tools und ihre Voraussetzungen

Um Continuous Integration (CI) und Continuous Deployment (CD) zu ermöglichen, brauchen wir zuerst ein CI-/CD-Tool. Davon gibt es viele auf dem Markt: TeamCity, Hudson, Jenkins, Atlassian Bamboo und zahlreiche andere. Diese Tools bieten oftmals ähnliche Funktionalitäten und ermöglichen die Gestaltung von Deployment-Prozessen in mehreren Stufen. Als Ausführungswerkzeug, die Deployment-Stufen zu gestalten, gibt es Maven-, Ant-, oder sogar Bash-Skripte. Da wir uns im Java-Umfeld befinden und mit Apache Maven gesegnet sind, entscheiden wir uns dafür, Maven einzusetzen. Warum nicht Apache Ant? Die „Ameise“ ist zwar fleißig, Maven benötigt aber im Vergleich zu Apache Ant viel weniger Code, um Standardprozesse zu implementieren.

Wir erstellen mit unseren Portlets ein erstes Maven-­.war-Modul, das auch andere jar-Bibliotheken als Dependencies enthält. Wenn unsere Portlets in einem Maven-Modul verpackt sind, dann können wir in unserem CI-Tool Maven als Build-Prozess auswählen und als Erstes bei jedem Git- bzw. SVN-Commit-Trigger Maven-Tasks ausführen: mvn clean compile. So haben wir die erste einfachste Stufe erreicht: Zumindest unser Code wird dahingehend überprüft, ob er kompiliert. Danach wollen wir, dass unsere Klassen automatisch getestet und .jsp, .css, .js, xml und andere Dateien in eine .war-Datei gepackt werden. Dafür ändern wir unser Ziel im CI-Tool zu mvn clean package.

.war-Datei automatisch auf den Webserver ­deployen?

Öfters steht eine Web-Application-Server-Instanz für die QA-Abteilung zum Testen bereit, und alle wünschen sich, dass der Server automatisch mit dem letzten Code regelmäßig aktualisiert wird. Viele Server bieten ein automatisches Deployment von .war, .ear und anderen Artefakten über Maven-Plug-ins an.

In unserem Projekt hatten wir es mit WebLogic zu tun, und WebLogic verfügt schon seit mehreren Versionen über ein Maven-Plug-in, das ein automatisches Redeploy von Artefakten auf dem laufenden Webserver ermöglicht [1], [2]. Dabei wird das Artefakt oftmals über den Admin-Server deployt, sodass Benutzername, Passwort, Hostname und Port in der pom.xml definiert werden sollten. Sie werden vom Maven-Plug-in beim Redeployment benutzt.

WebSphere bietet seinen Benutzern auch die Möglichkeit, über ein Maven-Plug-in die Artefakte automatisch zu erstellen und zu deployen [3].

Continuous Integration auf einem Web Application Server für Liferay

Liferay ist so strukturiert, dass man normalerweise die .war-Datei in einem deploy-Verzeichnis von Liferay ablegt. Auf dem deploy-Verzeichnis läuft immer eine Überprüfung auf die neuen Dateien. Die neue .war-Datei wird von Liferay „verschluckt“, aus dem deploy-Verzeichnis gelöscht und von BaseDeployer.java bearbeitet. Dadurch entsteht ein vollständiges, für Liferay passend ausgepacktes Verzeichnis. Da wir von Liferay in dieser Hinsicht nicht abhängig sein wollen und unsere web.xml-Datei nicht ändern lassen wollen, müssen wir dann die Arbeit von BaseDeployer.java selbst übernehmen. Wir müssen nicht alles genauso abändern. Zum Beispiel brauchen wir nicht unbedingt die taglibs in unserer web.xml zu deklarieren; diese werden automatisch von vielen Web Application Servern im jar im lib-Verzeichnis gefunden und unter dem deklarierten Namespace registriert, sodass die jsp-Dateien durch die Namespace-Deklaration den taglib zugeordnet werden können. Aber auf jeden Fall sollten wir Liferay Listener, Liferay Portlets und Liferay Filter hinzufügen. Wie sieht die Liferay-Portlet-Deklaration in web.xml aus? Portlets basieren auf Servlets. Wir ergänzen unsere web.xml mit der entsprechenden Servlet-Konfiguration – jeweils ein Servlet zu jedem in der portlet.xml deklarierten Portlet. Da wir Spring für unsere Portlets nutzen, wird jedes Portlet durch org.springframework.web.portlet.Dis­patch­er­Port­let gesteuert (Listing 1).

Listing 1

<servlet>
  <servlet-name>FilterPortlet Servlet</servlet-name>
  <servlet-class>com.liferay.portal.kernel.servlet.PortletServlet</servlet-class>
  <init-param>
    <param-name>portlet-class</param-name>
    <param-value>org.springframework.web.portlet.DispatcherPortlet</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>  
<servlet-mapping>
  <servlet-name>FilterPortlet Servlet</servlet-name>
  <url-pattern>/FilterPortlet/*</url-pattern>
</servlet-mapping>

Dadurch können wir eventuelle Bugs in BaseDeployer.java von Liferay umgehen und haben volle Kontrolle über unseren Deployment-Prozess. In Liferay 6.1 gab es zum Beispiel...

headline from sands settings