Shopware Wiki

Angeschaut

SVN Pre-Commit-Hooks mit PHP

Shopware Labs

Der Bereich Shopware Labs ist die Plattform für alle Entwickler. Hier findet man technische Dokumentationen und zahlreiche Tipps und Tricks rund um das Thema Programmieren. In dieser Rubrik stellen außerdem die Entwickler der shopware AG neue und experimentelle Lösungsansätze vor. Neue Funktionen, die in dieser Rubrik bereitgestellt werden, sind teilweise auch für zukünftige Releases geplant. Die Funktionen können dann ohne Programmierkenntnisse zukünftig direkt im Shopware Backend konfiguriert werden oder werden über Plugins bereitgestellt. Informationen über neue, geplante Funktionen finden Sie in unserer Roadmap.

Bitte beachten Sie, dass die hier bereitgestellten Lösungsansätze nicht offiziell supportet werden und nur eingebaut werden sollten, sofern Sie über das entsprechende, technische Wissen verfügen.

SVN Pre-Commit-Hooks mit PHP

0 Kommentare

Allgemein

Ein SVN-Pre-Commit-Hook wird automatisch bei jedem Checkin in das Versionsverwaltungssystem ausgeführt. Somit kann man geänderten oder neu hinzugefügten Code aktiv auf Fehler und die Einhaltung von Konventionen überprüfen.

Das nachfolgende Beispiel liefert Ihnen ein Basis-Modul, welches Sie nach Ihren Anforderungen hin anpassen können.

Folgende Tests werden im Beispiel-Script durchgeführt:

Syntax-Check der eingelieferten PHP-Dateien (PHP-Lint)
Überprüfung des Commit-Kommentars. Mindestlänge 10 Zeichen. Verweis auf Ticket-ID erforderlich!
Falls Objekte eingecheckt werden, so wird die Objekt-Struktur überprüft. Insbesondere müssen Objekt- und Methoden-Kommentare vorhanden sein
(Die Objekt-Kommentar-Funktion kann man z.B. auch mit PHP-Code-Sniffer realisieren!)

Vorbereitung

Wechseln Sie in das Verzeichnis "hooks" Ihres Repositories
Benennen Sie die Datei pre-commit.tmp in pre-commit um (mv pre-commit.tmp pre-commit)
Erstellen Sie den Unterordner /php im Verzeichnis hooks
Legen Sie eine neue Datei php/pre.php an
Erstellen Sie das Verzeichnis /php/tmp und geben Sie dem Verzeichnis Schreibrechte
Stellen Sie sicher, dass die Verzeichnisse und Dateien durch den SVN Benutzer gelesen werden können

Aktivieren des Pre-Commit-Hooks

Ersetzen Sie den Inhalt der Datei "pre-commit" mit folgendem Code:

 
#!/bin/bash
REPOS="$1"
TXN="$2"
# Achtung! Pfad zur PHP-Datei anpassen!
/var/svn/shopware/hooks/php/pre.php "$REPOS" -t "$TXN" >&2 || exit 1

PHP-Datei für Hook

Fügen Sie in der Datei pre.php folgenden Code ein:

 
#!/usr/bin/php
<?php
/**
 * Shopware AG SVN Pre-Hook Script
 * @link http://www.shopware.de
 * @package tools
 * @subpackage svn-hooks
 * @copyright (C) Shopware AG 2010-2011
 * @version Shopware 3.5.0
 */
 
define('AWK', '/usr/bin/awk');
define('GREP', '/bin/grep');
define('PHP', '/usr/bin/php');
define('SVNLOOK', '/usr/bin/svnlook');
define('DIVIDER','*****************************************');
 
$arguments = $_SERVER["argv"];
$transaction = $arguments[3];
$repository = $arguments[1];
 
$Shopware_SVN = new Shopware_SVN_Actions();
 
$successfully = false;
 
// PHP-Lint
file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Running PHP-Lint-Check" . PHP_EOL);
$successfully = $Shopware_SVN->runPhpLint($transaction,$repository);
 
// Comment-Style
file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Running Comment-Check" . PHP_EOL);
$successfully = $Shopware_SVN->runCommentCheck($transaction,$repository);
 
// Basic Code-Style
file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Running Code-Style Check" . PHP_EOL);
$successfully = $Shopware_SVN->runBasicStyleCheck($transaction,$repository);
 
if ($successfully == false){
	exit(1);
}
 
exit(0);
 
/**
 * Shopware AG SVN Pre-Hook Script / Tools class
 * @link http://www.shopware.de
 * @package tools
 * @subpackage svn-hooks
 * @copyright (C) Shopware AG 2010-2011
 * @version Shopware 3.5.0
 */
class Shopware_SVN_Actions{
 
	/**
	 * Check if sourcecode is commented
	 * @param string $transaction svn transaction no
	 * @param string $repository path to svn repository
	 * @access public
	 * @return boolean true/false
	 */
	public function runBasicStyleCheck($transaction,$repository){
		$success = true;
		$changedOutput = array();
		// Get a list with changed php-files
		$changedCommand = SVNLOOK . ' changed -t "'
	        . $transaction . '" "'
	        . $repository . '" '
	        . '| ' . GREP . ' "^[UA]" '
	        . '| ' . GREP . ' "\\.php$" '
	        . '| ' . AWK . ' \'{print $2}\'';
	    exec($changedCommand, $changedOutput);
 
	    // Loop through this files
	    foreach ($changedOutput as $file) {
 
	        $temporaryFile = dirname(__FILE__)."/tmp/".md5($file);
 
	        $lintCommand = SVNLOOK . ' cat -t "'
	            . $transaction . '" "'
	            . $repository . '" "' . $file . '" > '.escapeshellarg($temporaryFile);
 
	        exec($lintCommand);
 
	        $temporaryCode = file_get_contents($temporaryFile);
 
	        // Remove extends & implements
	        $temporaryCode = preg_replace("/((extends|implements) (.*)( |{|\n))/","\\4",$temporaryCode);
	        file_put_contents($temporaryFile,$temporaryCode);
 
	        // Build temporary code
	        $class = "";
	        $classCount = 0;
	        $lint = explode("\n",$temporaryCode);
 
	        // Loop trough code and find class-name
	        foreach ($lint as $line){
	        	if (strpos($line,"class ")!==false){
	        		$tempClass = array();
	        		//preg_match("/class (.*)/",$line,$tempClass);
	        		 $matches=array();
                     if (preg_match('#^(\s*)((?:(?:abstract|final|static)\s+)*)class\s+([-a-zA-Z0-9_]+)(?:\s+extends\s+([-a-zA-Z0-9_]+))?(?:\s+implements\s+([-a-zA-Z0-9_,\s]+))?#',$line,$matches)) 
                     {
                        $class = $matches[3];
                        $classCount += 1;
                     }
	        	}
	        }
 
	        // One class per file
	        if ($classCount == 1){
	        	file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Analyse comments in $file - Class: $class" . PHP_EOL);
	        	//eval($temporaryCode);
	        	include_once($temporaryFile);
	        	// Check Class-Comment
	        	$reflector = new ReflectionClass($class);
	        	if (!$reflector->getDocComment()){
	        		file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ No class comment for $class found!" . PHP_EOL);
	        		$success = false;
	        	}
	        	// Check Method-Comments
	        	$methods = $reflector->getMethods();
	        	foreach ($methods as $method){
					if (!$method->getDocComment()){
						$name = $method->getName();
						file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ No comment for method $name in class $class! Aborting!" . PHP_EOL);
						$success = false;
					}
				}	        	
	        }elseif($classCount > 1){
	        	// More then one class?
	        	file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Code-Analyse for $file failed! More then one class per file is forbidden! $classCount classes found!" . PHP_EOL);
	        	$success = false;
	        }else {
	        	// File seems to not consider any classes
	        	$success = true;
	        }
	    }	
		return $success;
	}
 
	/**
	 * Check if svn comment matches requirements
	 * @param string $transaction svn transaction no
	 * @param string $repository path to svn repository
	 * @access public
	 * @return boolean true/false
	 */
	public function runCommentCheck($transaction,$repository){
		$command = SVNLOOK." log -t '". $transaction ."' '". $repository."'";
		$log = exec($command);
 
		$message = PHP_EOL . DIVIDER . PHP_EOL . PHP_EOL;
		$message .= "Comment `$log` did not match requirements (".$command.")";
		$successfully = true;
 
		if (strlen($log) <= 10){
			$successfully = false;
			$message .= PHP_EOL."|_Comment is too short, mininum 10 chars required!";
		}
		if (!preg_match("/\#[0-9][0-9][0-9][0-9]/",$log) && strpos($log,"#NTR")===false){
			$successfully = false;
			$message .= PHP_EOL."|_Comment must contain at least a corresponding ticket-id (Format: #0000) or the NO_TICKET_REQUIRED (#NTR) flag!";
		}
		if ($successfully != true){
			file_put_contents('php://stderr', $message . PHP_EOL);
		}
		return $successfully;
	}
 
	/**
	 * Run php lint against sourcefiles
	 * @param string $transaction svn transaction no
	 * @param string $repository path to svn repository
	 * @access public
	 * @return boolean true/false
	 */
	public function runPhpLint($transaction, $repository) {
	    $success = true;
	    $changedCommand = SVNLOOK . ' changed -t "'
	        . $transaction . '" "'
	        . $repository . '" '
	        . '| ' . GREP . ' "^[UA]" '
	        . '| ' . GREP . ' "\\.php$" '
	        . '| ' . AWK . ' \'{print $2}\'';
	    exec($changedCommand, $changedOutput);
 
	    foreach ($changedOutput as $file) {
	        $lint = array();
	        $lintCommand = SVNLOOK . ' cat -t "'
	            . $transaction . '" "'
	            . $repository . '" "' . $file . '" '
	            . '| ' . PHP . ' -l';
	        exec($lintCommand, $lint);
	        if ('No syntax errors detected in -' == $lint[0]) {
	            // Lint returns text on good files,
	            // don't write that to standard
	            // error or consider it an error.
	            continue;
	        }
	        $message = PHP_EOL . DIVIDER . PHP_EOL . PHP_EOL
	            . $file . ' contains PHP error(s):' . PHP_EOL;
	        foreach ($lint as $line) {
	            // PHP lint includes some blank lines in its output.
	            if ('' == $line) {
	                continue;
	            }
	            // PHP lint tells us where the error is,
	            // which because we pass it in by piping it
	            // to standard in, doesn't tell us anything.
	            if ('Errors parsing -' == $line) {
	                continue;
	            }
	            $message .= "\t" . $line . PHP_EOL;
	        }
	        file_put_contents('php://stderr', $message . PHP_EOL);
	        $success = false;
	    }
	    return $success;
	}
}
 
?>

Update vom 15.02.2011

Das Auslesen / Prüfen der Kommentare mit der PHP Reflection API hat sich als nicht sonderlich stabil erwiesen. Das Problem ist, dass der zu überprüfende Code zur Laufzeit eingebunden werden muss und somit interpretiert wird. Mögliche Abhängigkeiten können so nicht aufgelöst werden.

Ich habe deshalb nun den PHP-Token Analyser aus der Software "phpSimpleDoc" angepasst und implementiert. Die Code-Qualität der Komponente ist nicht sonderlich hoch - aber es funktioniert ;)

Die Komponente stelle ich hier zum Download zur Verfügung. Einfach in das Verzeichnis php/comment im SVN-Hooks Verzeichnis ablegen.

Das Pre-Commit Script muss dann wie folgt aussehen:

 
#!/usr/bin/php
<?php
/**
 * Shopware AG SVN Pre-Hook Script
 * @link http://www.shopware.de
 * @package tools
 * @subpackage svn-hooks
 * @copyright (C) Shopware AG 2010-2011
 * @version Shopware 3.5.0
 */
 
define('AWK', '/usr/bin/awk');
define('GREP', '/bin/grep');
define('PHP', '/usr/bin/php');
define('SVNLOOK', '/usr/bin/svnlook');
define('DIVIDER','*****************************************');
 
include("comment/Comment.php");
include("comment/CommonComment.php");
include("comment/FunctionComment.php");
include("comment/PHPTokenizer.php");
include("comment/loader.php");
 
$arguments = $_SERVER["argv"];
$transaction = $arguments[3];
$repository = $arguments[1];
 
$Shopware_SVN = new Shopware_SVN_Actions();
 
$successfully = false;
 
// PHP-Lint
file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Running PHP-Lint-Check" . PHP_EOL);
$successfully = $Shopware_SVN->runPhpLint($transaction,$repository);
 
// Comment-Style
file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Running Comment-Check" . PHP_EOL);
$successfully = $Shopware_SVN->runCommentCheck($transaction,$repository);
 
// Basic Code-Style
file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Running Code-Style Check" . PHP_EOL);
$successfully = $Shopware_SVN->runBasicStyleCheck($transaction,$repository);
 
if ($successfully == false){
	exit(1);
}
 
exit(0);
 
/**
 * Shopware AG SVN Pre-Hook Script / Tools class
 * @link http://www.shopware.de
 * @package tools
 * @subpackage svn-hooks
 * @copyright (C) Shopware AG 2010-2011
 * @version Shopware 3.5.0
 */
class Shopware_SVN_Actions{
 
	/**
	 * Check if sourcecode is commented
	 * @param string $transaction svn transaction no
	 * @param string $repository path to svn repository
	 * @access public
	 * @return boolean true/false
	 */
	public function runBasicStyleCheck($transaction,$repository){
		$success = true;
		$changedOutput = array();
		// Get a list with changed php-files
		$changedCommand = SVNLOOK . ' changed -t "'
	        . $transaction . '" "'
	        . $repository . '" '
	        . '| ' . GREP . ' "^[UA]" '
	        . '| ' . GREP . ' "\\.php$" '
	        . '| ' . AWK . ' \'{print $2}\'';
	    exec($changedCommand, $changedOutput);
 
	    // Loop through this files
	    foreach ($changedOutput as $file) {
 
	        $temporaryFile = dirname(__FILE__)."/tmp/".md5($file);
 
	        $lintCommand = SVNLOOK . ' cat -t "'
	            . $transaction . '" "'
	            . $repository . '" "' . $file . '" > '.escapeshellarg($temporaryFile);
 
	        exec($lintCommand);
 
	        $temporaryCode = file_get_contents($temporaryFile);
 
	        // Remove Dependencies
	       /* $temporaryCode = preg_replace("/((extends|implements) (.*)( |{|\n))/","\\4",$temporaryCode);
			$temporaryCode = str_replace(array("include ","include_once ","require ","require_once "),array("#include ","#include_once ","#require ","#require_once "),$temporaryCode);
			$temporaryCode = str_replace("parent::","//parent::",$temporaryCode);
 
 
	        file_put_contents($temporaryFile,$temporaryCode);
	        */
	        // Build temporary code
	        $class = "";
	        $classCount = 0;
	        $lint = explode("\n",$temporaryCode);
 
	        // Loop trough code and find class-name
	        foreach ($lint as $line){
	        	if (strpos($line,"class ")!==false){
	        		$tempClass = array();
	        		//preg_match("/class (.*)/",$line,$tempClass);
	        		 $matches=array();
                     if (preg_match('#^(\s*)((?:(?:abstract|final|static)\s+)*)class\s+([-a-zA-Z0-9_]+)(?:\s+extends\s+([-a-zA-Z0-9_]+))?(?:\s+implements\s+([-a-zA-Z0-9_,\s]+))?#',$line,$matches)) 
                     {
                        $class = $matches[3];
                        $classCount += 1;
                     }
	        	}
	        }
 
	        // One class per file
	        if ($classCount == 1){
	        	file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Analyse comments in $file - Class: $class" . PHP_EOL);
 
	        	$ldeMainLoader = new ldeMainLoader();
				$ldeMainLoader->loadData(file_get_contents($temporaryFile));
				$documentation = $ldeMainLoader->docu;
 
				if (empty($documentation->data["classes"][0]["commentObject"]->description)){
					file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ No class comment for $class found!" . PHP_EOL);
	        		$success = false;
				}
	        	// Check Method-Comments
	        	$methods = $documentation->data["classMethods"];
 
	        	foreach ($methods as $method){
					if (!$method["commentObject"]->description){
						$name = $method["name"];
						file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ No comment for method $name in class $class! Aborting!" . PHP_EOL);
						$success = false;
					}else {
						$description = $method["commentObject"]->description;
						if (strlen($description) <= 15 || strpos($description,"Enter Description here")!==false){
							$name = $method["name"];
							file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Comment for method $name in class $class is not long enough!" . PHP_EOL);
							$success = false;
						}
					}
				}	        	
	        }elseif($classCount > 1){
	        	// More then one class?
	        	file_put_contents('php://stderr', PHP_EOL.DIVIDER.PHP_EOL . "|_ Code-Analyse for $file failed! More then one class per file is forbidden! $classCount classes found!" . PHP_EOL);
	        	$success = false;
	        }else {
	        	// File seems to not consider any classes
	        	$success = true;
	        }
	    }	
		return $success;
	}
 
	/**
	 * Check if svn comment matches requirements
	 * @param string $transaction svn transaction no
	 * @param string $repository path to svn repository
	 * @access public
	 * @return boolean true/false
	 */
	public function runCommentCheck($transaction,$repository){
		$command = SVNLOOK." log -t '". $transaction ."' '". $repository."'";
		$log = exec($command);
 
		$message = PHP_EOL . DIVIDER . PHP_EOL . PHP_EOL;
		$message .= "Comment `$log` did not match requirements (".$command.")";
		$successfully = true;
 
		if (strlen($log) <= 10){
			$successfully = false;
			$message .= PHP_EOL."|_Comment is too short, mininum 10 chars required!";
		}
		if (!preg_match("/\#[0-9][0-9][0-9][0-9]/",$log) && strpos($log,"#NTR")===false){
			$successfully = false;
			$message .= PHP_EOL."|_Comment must contain at least a corresponding ticket-id (Format: #0000) or the NO_TICKET_REQUIRED (#NTR) flag!";
		}
		if ($successfully != true){
			file_put_contents('php://stderr', $message . PHP_EOL);
		}
		return $successfully;
	}
 
	/**
	 * Run php lint against sourcefiles
	 * @param string $transaction svn transaction no
	 * @param string $repository path to svn repository
	 * @access public
	 * @return boolean true/false
	 */
	public function runPhpLint($transaction, $repository) {
	    $success = true;
	    $changedCommand = SVNLOOK . ' changed -t "'
	        . $transaction . '" "'
	        . $repository . '" '
	        . '| ' . GREP . ' "^[UA]" '
	        . '| ' . GREP . ' "\\.php$" '
	        . '| ' . AWK . ' \'{print $2}\'';
	    exec($changedCommand, $changedOutput);
 
	    foreach ($changedOutput as $file) {
	        $lint = array();
	        $lintCommand = SVNLOOK . ' cat -t "'
	            . $transaction . '" "'
	            . $repository . '" "' . $file . '" '
	            . '| ' . PHP . ' -l';
	        exec($lintCommand, $lint);
	        if ('No syntax errors detected in -' == $lint[0]) {
	            // Lint returns text on good files,
	            // don't write that to standard
	            // error or consider it an error.
	            continue;
	        }
	        $message = PHP_EOL . DIVIDER . PHP_EOL . PHP_EOL
	            . $file . ' contains PHP error(s):' . PHP_EOL;
	        foreach ($lint as $line) {
	            // PHP lint includes some blank lines in its output.
	            if ('' == $line) {
	                continue;
	            }
	            // PHP lint tells us where the error is,
	            // which because we pass it in by piping it
	            // to standard in, doesn't tell us anything.
	            if ('Errors parsing -' == $line) {
	                continue;
	            }
	            $message .= "\t" . $line . PHP_EOL;
	        }
	        file_put_contents('php://stderr', $message . PHP_EOL);
	        $success = false;
	    }
	    return $success;
	}
}
 
?>

Artikel-PDF erstellen

Verfügbare Downloads:

Download Download angepasster phpSimpleDoc Token-Parser

Artikel bewerten

Kommentare:

Artikel kommentieren

Weitere interessante Artikel:

Bezeichnung:

Rating:

Klicks:

Datum:

Bestell-Nr.: SW1532

Lieferzeit ca. 5 Tage

€ 1,00

Preise inkl. gesetzlicher
MwSt. zzgl. Versandkosten*

€ 1,00

Preise inkl. gesetzlicher
MwSt. + Versandkosten*

« Zurück

11 von 39 (Übersicht)

Weiter »

Kategorien:

Shopware Knowledgebase

SVN Pre-Commit-Hooks mit PHP

Inhaltsverzeichnis

Allgemein

Vorbereitung

Aktivieren des Pre-Commit-Hooks

PHP-Datei für Hook

Update vom 15.02.2011

Artikel-PDF erstellen

Verfügbare Downloads:

Artikel bewerten

Kommentare:

Artikel kommentieren

Shopware Public Roadmap Help-Guide

Hinter den Kulissen - shopware als Wiki

Installation 3.5

Allgemein |

Labs

Der Shopware Newsletter

Der Shopware Facebook Treff

Twitter - Immer mehr gezwitscher

Hilfe

Roadmap

Communitystore

Labs

RSS