Das post-commit-Skript wird direkt nach einem Commit ausgeführt und bietet sich hervorragend an, um direkt nach einer Projekt-Änderung den aktuellen Stand für den Webserver zur Verfügung zu stellen. Dazu muss man im Skript nur festlegen, dass ein checkout in das gewünschte Web-Verzeichnis ausgeführt werden soll. Wie das geht, zeige ich im folgenden Artikel.

Vorab:

Mein Beispiel geht davon aus, dass sich alle SVN-Benutzer mit einem privaten Schlüssel über svn+ssh am Server anmelden um ihre Aktionen auszuführen. Das führt dazu, dass der post-commit hook immer mit dem Benutzerkonto ausgeführt wird, der gerade einen Commit begangen hat. Wenn post-commit nun die Aufgabe hat, einen automatischen Checkout auf dem Webserver zu machen, kommt es standardmäßig dazu, dass die Dateien beim Checkout alle dem Benutzer gehören, der den Commit gemacht hat. Wenn man mit mehreren SVN-Benutzern arbeitet kommt es zu einem Problem. Den anderen Benutzern fehlen die nötigen Rechte, um die Checkout-Dateien für das Webverzeichnis zu ändern. Zudem gibt es noch ein weiteres Problem. Damit das Webprojekt erfolgreich im Internet bedient werden kann, sollte das Webverzeichnis, in das ausgecheckt wird, dem Apache-Webserver gehören. Man kann zwar für den svn checkout Befehl einen Benutzer und ein Passwort festlegen, damit der Checkout immer über dasselbe Benutzerkonto ausgeführt wird, allerdings authentifizieren sich die SVN-Benutzer (wie bereits erwähnt) nicht über ein Passwort, sondern über einen Schlüssel. Trotzdem gibt es eine Lösung dafür.

Struktur:

Der Apache-Webserver läuft unter dem Benutzerkonto: www-data
Das SVN-Repository liegt in: /srv/svn/st38
Das Web-Verzeichnis ist: /srv/www/st38
Die ausführbare SVN-Datei ist: /usr/bin/svn
Alle SVN-Benutzer sind in der Gruppe: svn

Quellcode:

Meine Lösung benötigt zwei Dateien. Das Skript für den post-commit hook sowie ein Programm für das automatische svn update. Damit es während der Einrichtung keine Probleme gibt, hier schon mal die Quelltexte.

post-commit

1
2
3
4
5
6
7
8
9
10
11
12
13

#!/bin/sh
# REPO	- Path to the repository
# REV	- Current revision number of the repository
# USER	- Name of the user who did the commit
# DATE	- Time of the commit
 
REPO="$1"
REV="$2"
USER=`whoami 2>&1`
DATE=`date +"%d.%m.%Y, %H:%Mh"`
 
/srv/svn/repos/st38/hooks/bin/svn-update /usr/bin/svn /srv/www/st38
echo "$DATE - User \"$USER\" committed Revision \"$REV\"." >> /srv/www/st38/post-commit.log

Der post-commit hook ruft das Programm svn-update auf. Dabei wird als erster Parameter der Pfad zur ausführbaren svn-Datei angegeben. Als zweiter Parameter folgt der Pfad zum Webverzeichnis, in das ausgecheckt werden soll. Nach Ausführung dieses Programms erstellt der hook noch eine Logdatei, um zu sehen wer eine Revision eingecheckt hat und wann diese Revision erstellt wurde.

svn-update.c

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

#include <stddef.h>
#include <stdlib.h>
#include <unistd.h>
 
/*
 argv[1] - Path to the svn executable
 argv[2] - Path to the web-directory
*/
int main(int argc, char* argv[])
{	
	if (argc == 3)
	{
		char *newenv = { NULL };
		execle(argv[1], "svn", "update", argv[2],
				"--non-interactive", "--accept", "theirs-full",
				NULL, newenv);
	}
	else
		return(EXIT_FAILURE);
	return(EXIT_SUCCESS);
}

Die Datei svn-update.c ist ein C-Programm und muss erst noch kompiliert werden (siehe GCC installieren und C kompilieren). Das Programm sorgt dafür, dass svn update immer vom selben Benutzer ausgeführt wird.

Einrichtung

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

sudo usermod -a -G svn www-data
cd /srv/svn/repos/st38/hooks
scp post-commit.tmpl post-commit
vim post-commit
sudo chmod 0770 post-commit
sudo chown svn:svn post-commit
mkdir ./bin
sudo chmod -R 0770 ./bin
sudo chown svn:svn ./bin
touch ./bin/svn-update.c
gcc -o ./bin/svn-update ./bin/svn-update.c
sudo chmod -R 6750 ./bin/svn-update
sudo chown www-data:svn ./bin/svn-update
mkdir -p /srv/www/st38
cd /srv/www
svn co file:///srv/svn/repos/st38
sudo chmod -R 0775 /srv/www/st38
sudo chown www-data:svn /srv/www/st38

1. Apache-Benutzer der Gruppe “svn” hinzufügen
   Tipp: Mit dem Kommando sudo id www-data kann überprüft werden, in welchen Gruppen der Benutzer ist
2. In das “hooks”-Verzeichnis des Repository wechseln
3. “post-commit”-Hook aus Template kopieren
4. post-commit bearbeiten (Quelltext einfügen!)
5. Verzeichnisrechte für “post-commit” setzen
6. Neuen Besitzer für “post-commit” setzen
7. Ordner “bin” erstellen
8. Verzeichisrechte für Ordner “bin” setzen
9. Neuen Besitzer für Ordner “bin” setzen
10. Datei “svn-update.c” erstellen (Quellcode einfügen nicht vergessen!)
11. “svn-update.c” zu “svn-update” kompilieren (siehe GCC installieren und C kompilieren)
12. CHMOD für “svn-update” setzen (Achtung! 6750!)
13. Besitzer für “svn-update” ändern (es muss der Apache-User sein!)
14. Web-Verzeichnis für das Repository anlegen
15. “Vor” das eigentliche Webverzeichnis wechseln
16. Initialen Checkout machen
17. CHMOD setzen
18. Besitzer ändern

Ergebnis

Sobald ein SVN-Benutzer nun über seinen SVN-Client einen Commit macht, wird das Repository (/srv/svn/repos/st38) aktualisiert und der neue Stand im Webverzeichnis (/srv/www/st38) eingefügt. Die Dateien im Webverzeichnis gehören alle dem Webserver (www-data) und können so bequem über das Internet abgerufen werden (sofern ein gültiger Directory-Eintrag besteht). Außerdem wird eine Logdatei im Webordner angelegt.

Vielen Dank an gpinzone aus der Subversion Community by WANdisco.

1
2
3

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install gcc

Sobald die GCC installiert ist, kann man C-Programme kompilieren. Zum Testen eignet sich dieses kleine “Hello World”-Programm:

quellcode.c

1
2
3
4
5
6
7

#include <stdio.h>
 
int main() 
{
	printf("Hello, World!\n");
	return 0;
}

Mit den folgenden Befehlen kann man die Datei “quellcode.c” nun in eine ausführbare Datei namens “hello” übersetzen und ausführen:

1
2

gcc -o hello quellcode.c
./hello

Wenn dieser Fehler bei der Verwendung von printf auftritt, dann kann es daran liegen, dass die Standard Ein -und Ausgabe noch nicht eingebunden wurde. Ein einfaches #include <stdio.h> im Quellcode des Programms hilft hier.