git hook sintaxis check

Question

Intentando hacer una sintaxis de php check hook para un repositorio de git. Me alegré cuando encontré un fragmento de código que hace exactamente esto.

Pero parece que el script de fragmento tiene un defecto. Ejecuta

git diff-index --cached --name-only HEAD 

para obtener una lista de archivos en el índice. Ahora ejecuta php -l para cada archivo en esa lista. La falla es que un archivo puede diferir entre la copia de trabajo y el área de ensayo. Si el área de ensayo php tiene un error de sintaxis, pero la versión de copia de trabajo no lo hace, no se encuentra ningún error de sintaxis y la confirmación tiene éxito, que era lo que había que evitar.

¿Es este un problema no trivial para resolver, o hay alguna forma de ejecutar php -l en la versión provisional de cada archivo?

Answer 1

Estoy muy feliz de usar este php syntax validation hook. Espero que se ajuste a tus necesidades también.

Utiliza git diff-index --cached --full-index.

Answer 2

No estoy seguro si hay un problema aquí.

El fragmento que menciona probablemente proviene de la entrada del blog Don’t Commit That Error.
E incluye:

A continuación, se llaman git diff-index con unos pocos parámetros.
Primero, agregamos --cached para decirle a Git que solo queremos archivos que vayan a cometerse.
Luego, agregamos --name-only para decirle a Git que solo muestre el nombre de los archivos que se están confirmando.

Parece que los archivos que se van a comprometer son precisamente los que un anzuelo de precompromiso desearía inspeccionar.
Incluso si difieren de los archivos en el directorio de trabajo, es su versión (en el índice) la que se va a confirmar. Y es la misma versión que se enviará al proceso php -l.

---

En realidad, el problema no está en la git diff-index sí mismo (con o sin --full-index) está en la forma en que va a leer el contenido del archivo en el índice

• El "PHP Advent 2008" hook simplemente se trate de acceder al archivo desde su nombre (con el riesgo de acceder a la copia de trabajo)

 
exec("php -l " . escapeshellarg($file), $lint_output, $return); 

• El "phpbb3" hook (mencionado por takeshkin en his answer) pedirá a Git para el contenido real:

 
result=$(git cat-file -p $sha | /usr/bin/env $PHP_BIN -l 2>/dev/null) 

Usando git cat-file es la clave aquí, para acceder a un objeto en el repositorio Git (es decir, no en el "directorio de trabajo")

Answer 3

Causa pre-commit gancho no es bueno para trabajar en un equipo que debe utilizar pre-recepción instalado en el lado del servidor de rechazar todas las confirmaciones con la sintaxis de PHP no válida y el estándar de codificación incorrecta gancho.

He creado pre-reciben script en Python para que pupose:

# A server-side git hook script for checking PHP syntax and validating coding standard 
# Depends on: PHP_CodeSniffer (http://pear.php.net/package/PHP_CodeSniffer/) 
# Install: copy this script to <server side repo location>/hooks/pre-receive 
#!/usr/bin/python 

import os 
import sys 
oldrev, newrev, ref = sys.stdin.read().strip().split(' ') 
test_file = os.popen('mktemp').read().strip() 
coding_standards = 'PSR2' 
for line in os.popen('git diff --name-only %s %s' % (oldrev, newrev)).readlines(): 
    extension = line.split('.')[-1].strip() 
    file_name = line.strip() 

    if(extension == 'php'): 
     os.system("git cat-file -p %s:%s > %s" % (newrev, file_name, test_file)) 
     if 0 != os.system('php -l ' + test_file + ' > /dev/null'): 
      print "PHP Syntax error in file %s" % (file_name) 
      sys.exit(1) 

     if 0 != os.system("phpcs -n --standard=%s %s" % (coding_standards, test_file)): 
      print "Coding standards fail in file %s" % (file_name) 
      sys.exit(2)