[solucionado] Crear un sencillo hook para verificar la sintaxis de los archivos
Publicado por kip (6 intervenciones) el 12/09/2017 04:27:35
Hola, Git proporciona de varios hooks(https://es.wikipedia.org/wiki/Hooking) para poder alterar el comportamiento de ciertos eventos a nuestro beneficio, en este caso mostrare como usar uno de estos para realizar un checkeo simple de la sintaxis del código y de esa forma poder cancelar el commit si es que algunos de los scripts en en el staging area no pasan esta prueba.
Tenemos dos archivos PHP simples:
En cada uno de ellos tengo lo siguiente:
Podemos ver el log del repositorio:
Ahora intentemos hacer un cambio con mala sintaxis en uno de los archivos PHP, por ejemplo no coloquemos el ;
Vemos que nos marca el archivo que ha sido modificado:
Ahora intentemos aplicar el cambio junto con un mensaje de commit:
Me ha mostrado un mensaje y me ha cancelado el commit !
Git, como dije al inicio, te da la oportunidad de ejecutar código en ciertos eventos, los posibles eventos en los que podemos correr algún código son:
En este caso ejecutamos el código de checkeo de sintaxis en el evento pre-commit, que como su nombre lo indice se ejecuta antes de realizar un commit, dandote la oportunidad de poderlo cancelar.
Pero donde estan localizados o donde colocaremos el codigo para que Git lo ejecute en algun evento ?
Para que Git corra el codigo que desees debes acceder a la carpeta hooks dentro de la carpeta base de git en tu repositorio que es .git/
Y dentro de hooks podemos ver ejemplos de codigo de cada evento que te ofrece Git como guia:
Si nos damos cuenta tiene el .sample, debemos saber que Git solo reconocera el archivo a ejecutar si este se llama tal como el evento sin el sample, por ejemplo para que Git ejecute algun codigo en el evento pre-commit deberemos crear un archivo con ese nombre y dentro de el colocar el codigo que quieras.
Debemos saber que dentro de este archivo, o estos archivos, podemos colocar código en cualquier lenguaje !! Solo debemos tener en cuenta de que el sistema pueda ejecutar este(puedes usar COBOL si quieres), en nuestro ejemplo usare bash y python, veamos como seria en bash un checkeo de sintaxis simple:
Tenemos dos archivos PHP simples:
1
2
3
4
./main.php
./carpeta:
'main 2.php'En cada uno de ellos tengo lo siguiente:
1
2
3
4
5
$ cat main.php<?php
$var = 1;echo $var;
1
2
3
4
5
$ cat carpeta/main\ 2.php
<?php
$var = 1;echo $var;
Podemos ver el log del repositorio:
1
2
3
4
5
6
$ git log
commit ****bc1a033d4e6f67f7a9a1d6a9dfa0d29e104c
Author: KIP <---->Date: Mon Sep 11 23:05:38 2017 -0300
Primer commit
Ahora intentemos hacer un cambio con mala sintaxis en uno de los archivos PHP, por ejemplo no coloquemos el ;
1
2
3
4
5
<?php
$var = 1;echo $var;
echo 'Final !'Vemos que nos marca el archivo que ha sido modificado:
1
2
3
4
5
6
7
8
9
$ git status
On branch master
Changes not staged for commit:(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
modified: main.php
no changes added to commit (use "git add" and/or "git commit -a")
Ahora intentemos aplicar el cambio junto con un mensaje de commit:
Me ha mostrado un mensaje y me ha cancelado el commit !
Git, como dije al inicio, te da la oportunidad de ejecutar código en ciertos eventos, los posibles eventos en los que podemos correr algún código son:
1
2
3
4
5
6
7
8
9
applypatch-msgpre-pushcommit-msgpre-rebasepost-updateprepare-commit-msg
pre-applypatchupdate
pre-commitEn este caso ejecutamos el código de checkeo de sintaxis en el evento pre-commit, que como su nombre lo indice se ejecuta antes de realizar un commit, dandote la oportunidad de poderlo cancelar.
Pero donde estan localizados o donde colocaremos el codigo para que Git lo ejecute en algun evento ?
Para que Git corra el codigo que desees debes acceder a la carpeta hooks dentro de la carpeta base de git en tu repositorio que es .git/
1
2
3
4
5
6
7
8
9
10
11
$ ls -1 .git/
COMMIT_EDITMSG
config
description
HEAD
hooks/ <--- AQUI !
index
info/
logs/
objects/
refs/
Y dentro de hooks podemos ver ejemplos de codigo de cada evento que te ofrece Git como guia:
1
2
3
4
5
6
7
8
9
10
11
$ ls -1 .git/hooks/
applypatch-msg.sample
commit-msg.sample
post-update.sample
pre-applypatch.sample
pre-commit.sample
prepare-commit-msg.sample
pre-push.sample
pre-rebase.sample
pre-receive.sample
update.sampleSi nos damos cuenta tiene el .sample, debemos saber que Git solo reconocera el archivo a ejecutar si este se llama tal como el evento sin el sample, por ejemplo para que Git ejecute algun codigo en el evento pre-commit deberemos crear un archivo con ese nombre y dentro de el colocar el codigo que quieras.
Debemos saber que dentro de este archivo, o estos archivos, podemos colocar código en cualquier lenguaje !! Solo debemos tener en cuenta de que el sistema pueda ejecutar este(puedes usar COBOL si quieres), en nuestro ejemplo usare bash y python, veamos como seria en bash un checkeo de sintaxis simple:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#!/bin/bash
oIFS="$IFS"
IFS=$'\n'
RED='\033[1;31m'
GREEN='\033[1;32m'
NC='\033[0m'
files=($(git diff --cached --name-only))
errors=()
for f in ${files[@]}
do
errors+=($(php -l "$f" | grep -v "No syntax errors detected"))
done
IFS="$oIFS"
if [ ${#errors[@]} -eq 0 ]
then
printf "${GREEN}Sintaxis correcta !${NC}"exit 0;
else
printf "${RED}No es posible realizar el commit por error de sintaxis !${NC}\n\n"printf "%s\n" "${errors[@]}"
exit 1;
fi
Valora esta pregunta
1
