© Matej Kotula/Shutterstock.com
Angular mit GitLab CI und Docker verwenden

Build, Test, Deploy mit Angular und CI


Der Einsatz eines Continuous-Integration-(CI-)Servers ist im Backend-Bereich schon lange eine etablierte Best Practice. Mit der Zunahme von Komplexität und Umfang moderner Web-Frontends nimmt der Bedarf an Techniken professioneller Entwicklung auch hier zu. Dazu gehört die Arbeit mit Test-driven Development, CI-Servern und automatisierten Abläufen. In diesem Artikel beschäftigen wir uns am Beispiel von Angular und GitLab CI damit, wie die Build-Automatisierung umgesetzt werden kann.

Wer noch keinen CI-Server einsetzt, sollte sich die Vorteile vor Augen führen:

  • Schnelles, automatisches Feedback für alle Codeänderungen
  • Reproduzierbare Build-Ergebnisse durch eine neutrale Umgebung
  • Alle Änderungen können automatisch für den Test durch Kunden oder Fachabteilung in einer Testumgebung bereitgestellt werden

GitLab entstand ursprünglich als reines Git Repository und wurde später um einen CI-Server erweitert. Der Vorteil bei dieser integrierten Lösung liegt auf der Hand: GitLab weiß, wann sich Änderungen am Code ergeben und kann dann direkt einen Build starten. Eine aufwendige Integration von Versionsverwaltung und Build-Server entfällt somit. GitLab CI folgt dem Trend, die Build-Konfiguration zusammen mit dem zu bauenden Artefakt zu versionieren. Das Vorgehen, wie in diesem Beitrag vorgestellt, lässt sich entsprechend einfach auch auf andere Build-Server übertragen, da die Mechanismen ähnlich sind. In der Umsetzung erwartet GitLab CI eine .gitlab-ci.yml-Datei, in der im YAML-Format die einzelnen Build-Schritte beschrieben sind. Das hat den Vorteil, dass bei jedem Branch eine andere Build-Konfiguration verwendet werden kann. Die recht schlichte Syntax verleitet nicht dazu, besonders komplexe und außerhalb des Build-Servers kaum nachstellbare Builds zu konzipieren. In der Regel sind die einzelnen Build-Schritte einfache Aufrufe von Shellskripten.

Zur Ausführung der Builds unterstützt GitLab CI Docker Images. Damit ist auch die Frage danach beantwortet, wie der Build-Server an benötigte Werkzeuge, wie npm oder Maven, und Ablaufumgebungen, beispielsweise Node.js oder eine Java-Umgebung, gelangt. GitLab CI kann neben dem zum Build verwendeten Docker-Container auch weitere Service-Container starten, um damit für Tests benötigte Umsysteme wie eine Datenbank oder Backend-Systeme bereitzustellen. Die eigentliche Ausführung übernehmen sogenannte Runner: Diese Build-Agenten können auf separaten Maschinen oder in der Cloud gestartet werden und kommunizieren mit dem GitLab-CI-Server über ein API. Damit lässt sich die Build-Infrastruktur gut skalieren und dem jeweiligen Bedarf an Ressourcen anpassen.

GitLab CI Pipeline

GitLab CI bezeichnet eine Build-Konfiguration als Pipeline. Das Konfigurationsformat ist YAML und gliedert sich in sogenannte Stages. Per Default werden die Stages build, test und deploy definiert. Eigene Stages sind jedoch ebenfalls möglich. Innerhalb einer Stage werden Jobs definiert. Alle Jobs einer Stage können parallel ausgeführt werden, um die Performance zu verbessern. Jeder Job kann eine script-Anweisung definieren, die innerhalb des Jobs ausgeführt wird, siehe zum Beispiel Listing 1. Sollen mehrere Anweisungen ausgeführt werden, so müssen diese als Array unterhalb von script definiert werden. Die einzelnen Schritte werden sukzessive sequentiell ausgeführt. Die Arraysyntax wird in den folgenden Listings auch an mehreren Stellen verwendet.

job1:
script: "execute-script-for-job1"

job2:
script: "execute-script-for-job2"

Listing 1: Struktureller Aufbau einer GitLab CI Pipeline mit zwei Jobs

Wird ein Job keiner Stage zugeordnet, wird standardmäßig die test-Stage verwendet. Es ist auch möglich, Jobs nur auszuführen, wenn der Build für einen Branch oder Tag erfolgt. Damit lassen sich beispielsweise gezielt Release- oder Deploymentjobs definieren. Durch einen regulären Ausdruck lässt sich sogar konfigurieren, dass Jobs nur für Tags oder Branches ausgeführt werden, die einem gewissen Namensschema entsprechen. Vor dem eigentlichen Skript auszuführende Kommandos können pro Job oder global als before_script definiert werden. Das kann zum Beispiel ein Aufruf des Dependency Managers sein, um benötigte Libraries herunterzuladen. Wird zur Ausführung ein spezieller Runner benötigt, kann dieser über am Job deklarierte Tags selektiert werden.

Das wichtigste Ergebnis eines Jobs sind Artefakte. So deklarierte Dateien oder Verzeichnisse werden von GitLab CI in nachfolgenden Stages bereitgestellt oder können als Dateien für einen konkreten Build heruntergeladen werden. Nicht als Artefakt deklarierte Dateien und Ordner stehen in anderen Jobs nicht zur Verfügung. Ein weiteres wichtiges Element von Builds sind Variablen. Mit Variablen lassen sich Builds parametrisieren und beispielsweise Passwörter extern verwalten.

Angular Build mit einer GitLab CI Pipeline

Angular-Projekte können mit npm als Dependency Manager und Angular CLI als Build-Abstraktion über webpack gebaut werden. Dieses Setup wird auch den Rahmen unseres Beispiels bilden. Nachdem mit Angular CLI ein Angular-Projekt erstellt wurde, wird es normalerweise mit ng build gebaut. In einer CI-Umgebung müssen noch Abhängigkeiten durch npm installiert werden, in neueren npm-Versionen wird statt npm install besser npm ci verwendet, damit eine exakt reproduzierbare Versionsauflösung stattfindet. Für den Build werden eine Node.js-Umgebung und das Angular-CLI-Werkzeug benötigt. Der einfachste Weg, diese Umgebung für einen Build-Server bereitzustellen, ist durch geeignete Docker-Container. Für Angular verwenden wir das trion/ng-cli Image, das Node.js, npm und das Angular CLI bereitstellt. Für Tests existieren ebenfalls passende Images, dazu später mehr.

In GitLab CI kann für einen Job ein Docker-Container als Ablaufumgebung spezifiziert werden. Dazu werden lediglich der Parameter image und ein geeignetes Docker Image angegeben. Falls zur Auswahl eines Docker-fähigen Runners noch Tags benötigt werden, so müssen diese ebenfalls im Job angegeben werden. Ein Beispiel für einen Angular-Job ist in Listing 2 zu sehen. Neben dem eigentlichen...

headline from sands settings