hgbook
view es/hook.tex @ 461:67d34d8b6ba0
translated up to the "writing an in-process hook" section
| author | Javier Rojas <jerojasro@devnull.li> |
|---|---|
| date | Tue Dec 23 12:57:21 2008 -0500 (2008-12-23) |
| parents | 5a0401ba9faa |
| children | 5389bef3a95b |
line source
1 \chapter{Manejo de eventos en repositorios mediante ganchos}
2 \label{chap:hook}
4 Mercurial ofrece un poderoso mecanismo para permitirle a usted
5 automatizar la ejecución de acciones en respuesta a eventos que
6 ocurran en un repositorio. En algunos casos, usted puede controlar
7 incluso la respuesta de Mercurial a dichos eventos.
9 Mercurial usa el término \emph{gancho} para identificar estas
10 acciones. Los ganchos son conocidos como ``disparadores'' en algunos
11 sistemas de control de revisiones, pero los dos nombres se refieren al
12 mismo concepto.
14 \section{Vistazo general de ganchos en Mercurial}
16 A continuación se encuentra una breve lista de los ganchos que
17 Mercurial soporta. Volveremos a cada uno de estos ganchos con más
18 detalle después, en la sección~\ref{sec:hook:ref}.
20 \begin{itemize}
21 \item[\small\hook{changegroup}] Es ejecutado luego de que un grupo de
22 conjuntos de cambios ha sido traído al repositorio desde algún
23 otro sitio.
24 \item[\small\hook{commit}] Es ejecutado después de la creación de
25 un conjunto de cambios en el repositorio local.
26 \item[\small\hook{incoming}] Es ejecutado una vez por cada conjunto de
27 cambios traído al repositorio desde otra ubicación. Note la
28 diferencia respecto al gancho \hook{changegroup}, que es ejecutado
29 una vez por cada \emph{grupo} de conjuntos de cambios que se
30 traiga.
31 \item[\small\hook{outgoing}] Es ejecutado luego de que un grupo de
32 conjuntos de cambios ha sido transmitido desde el repositorio.
33 \item[\small\hook{prechangegroup}] Es ejecutado antes de iniciar la
34 recepción de un grupo de conjuntos de cambios en el repositorio.
35 \item[\small\hook{precommit}] De control. Es ejecutado antes de
36 iniciar una consignación.
37 \item[\small\hook{preoutgoing}] De control. Es ejecutado antes de
38 iniciar la transmisión de un grupo de conjuntos de cambios desde
39 el repositorio.
40 \item[\small\hook{pretag}] De control. Es ejecutado antes de crear una
41 etiqueta.
42 \item[\small\hook{pretxnchangegroup}] De control. Es ejecutado después
43 de haber recibido un grupo de conjuntos de cambios en el
44 repositorio local, pero antes de que la transacción se complete y
45 los cambios sean permanentes dentro del repositorio.
46 \item[\small\hook{pretxncommit}] De control. Es ejecutado luego de la
47 creación de un conjunto de cambios en el repositorio local, pero
48 antes de que la transacción que hace permanente el cambio sea
49 completada.
50 \item[\small\hook{preupdate}] De control. Es ejecutado antes de
51 iniciar una actualización o fusión en el directorio de trabajo.
52 \item[\small\hook{tag}] Es ejecutado después de la creación de una
53 etiqueta.
54 \item[\small\hook{update}] Es ejecutado después de que termina una
55 actualización o una fusión.
56 \end{itemize}
57 Cada uno de los ganchos cuya descripción empieza con la frase
58 ``de control'' tiene la facultad de determinar si una actividad puede
59 continuar. Si el gancho se ejecuta con éxito, la actividad puede
60 continuar; si falla, o bien la actividad no es permitida, o se
61 deshacen los cambios que se puedan haber llevado a cabo, dependiendo
62 del gancho involucrado.
64 \section{Ganchos y seguridad}
66 \subsection{Los ganchos se ejecutan con sus privilegios de usuario}
68 Cuando usted ejecuta un comando de Mercurial en un repositorio, y el
69 comando causa la ejecución de un gancho, dicho gancho se ejecuta en
70 \emph{su} sistema, en \emph{su} cuenta de usuario, con \emph{sus}
71 privilegios. Ya que los ganchos son elementos arbitrarios de código
72 ejecutable, usted debería tratarlos con un nivel adecuado de
73 desconfianza. No instale un gancho a menos en que confíe en quien lo
74 creó y en lo que el gancho hace.
76 En algunos casos, usted puede estar expuesto a ganchos que usted no
77 %TODO acá introduzco algo de texto por mi cuenta, por claridad
78 instaló. Si usted usa Mercurial en un sistema extraño, tenga en cuenta
79 que Mercurial ejecutará los ganchos definidos en el fichero \hgrc.
81 Si está trabajando con un repositorio propiedad de otro usuario,
82 Mercurial podrá ejecutar los ganchos definidos en el repositorio de
83 dicho usuario, pero los ejecutará como ``usted''. Por ejemplo, si
84 usted jala (\hgcmd{pull}) desde ese repositorio, y el
85 \sfilename{.hg/hgrc} define un gancho saliente (\hook{outgoing}),
86 dicho gancho se ejecuta bajo su cuenta de usuario, aun cuando usted no
87 es el propietario del repositorio.
89 \begin{note}
90 Esto sólo aplica si usted está jalando desde un repositorio en un
91 sistema de ficheros local o de red. Si está jalando a través de http
92 o ssh, cualquier gancho saliente (\hook{outgoing}) se ejecutará bajo
93 la cuenta que está ejecutando el proceso servidor, en el servidor.
94 \end{note}
96 XXX Para ver qué ganchos han sido definidos en un repositorio, use el
97 comando \hgcmdargs{config}{hooks}. Si usted está trabajando en un
98 repositorio, pero comunicándose con otro que no le pertenece
99 (por ejemplo, usando \hgcmd{pull} o \hgcmd{incoming}), recuerde que
100 los ganchos que debe considerar son los del otro repositorio, no los
101 del suyo.
103 \subsection{Los ganchos no se propagan}
105 En Mercurial, no se hace control de revisiones de los ganchos, y no se
106 propagan cuando usted clona, o jala de, un repositorio. El motivo para
107 esto es simple: un gancho es código ejecutable arbitrario. Se ejecuta
108 bajo su identidad, con su nivel de privilegios, en su máquina.
110 Sería extremadamente descuidado de parte de cualquier sistema
111 distribuido de control de revisiones el implementar control de
112 revisiones para ganchos, ya que esto ofrecería maneras fácilmente
113 %TODO subvertir
114 aprovechables de subvertir las cuentas de los usuarios del sistema de
115 control de revisiones.
117 Ya que Mercurial no propaga los ganchos, si usted está colaborando con
118 otras personas en un proyecto común, no debería asumir que ellos están
119 usando los mismos ganchos para Mercurial que usted usa, o que los de
120 ellos están configurado correctamente. Usted debería documentar los
121 ganchos que usted espera que la gente use.
123 En una intranet corporativa, esto es algo más fácil de manejar, ya que
124 usted puede, por ejemplo, proveer una instalación ``estándar'' de
125 Mercurial en un sistema de ficheros NFS, y usar un fichero \hgrc\
126 global para definir los ganchos que verán todos los usuarios. Sin
127 embargo, este enfoque tiene sus límites; vea más abajo.
129 \subsection{Es posible hacer caso omiso de los ganchos}
131 Mercurial le permite hacer caso omiso de la deficinión de un gancho,
132 a través de la redefinición del mismo. Usted puede deshabilitar el
133 gancho fijando su valor como una cadena vacía, o cambiar su
134 comportamiento como desee.
136 Si usted instala un fichero \hgrc\ a nivel de sistema o sitio completo
137 que define algunos ganchos, debe entender que sus usuarios pueden
138 deshabilitar o hacer caso omiso de los mismos.
140 \subsection{Asegurarse de que ganchos críticos sean ejecutados}
142 Algunas veces usted puede querer hacer respetar una política, y no
143 permitir que los demás sean capaces de evitarla. Por ejemplo, usted
144 puede tener como requerimiento que cada conjunto de cambios debe pasar
145 un riguroso conjunto de pruebas. Definir este requerimientos a través
146 de un gancho en un fichero \hgrc\ global no servirá con usuarios
147 remotos en computadoras portátiles, y por supuesto que los usuarios
148 locales pueden evitar esto a voluntad haciendo caso omiso del gancho.
150 En vez de eso, usted puede definir las políticas para usar Mercurial
151 de tal forma que se espere que los usuarios propaguen los cambios a
152 través de un servidor ``canónico'' bien conocido que usted ha
153 asegurado y configurado apropiadamente.
155 Una manera de hacer esto es a través de una combinación de ingeniería
156 socual y tecnología. Cree una cuenta de acceso restringido; los
157 usuarios pueden empujar cambios a través de la red a los repositorios
158 administrados por esta cuenta, pero no podrán ingresar a dicha cuenta
159 para ejecutar órdenes en el intérprete de comandos. En este escenario,
160 un usuario puede enviar un conjunto de cambios que contenga la
161 porquería que él desee.
163 Cuando alguien empuja un conjunto de cambios al servidor del que todos
164 jalan, el servidor probará el conjunto de cambios antes de aceptarlo
165 como permanente, y lo rechazará si no logra pasar el conjunto de
166 pruebas. Si la gente sólo jala cambios desde este servidor de filtro,
167 servirá para asegurarse de que todos los cambios que la gente jala han
168 sido examinados automáticamente
170 \section{Precauciones con ganchos \texttt{pretxn} en un repositorio de
171 acceso compartido}
173 Si usted desea usar ganchos para llevar a cabo automáticamente algún
174 trabajo en un repositorio al que varias personas tienen acceso
175 compartido, debe tener cuidado con la forma de hacerlo.
177 Mercurial sólo bloquea un repositorio cuando está escribiendo al
178 mismo, y sólo las partes de Mercurial que escriben al repositorio le
179 prestan atención a los bloqueos. Los bloqueos de escritura son
180 necesarios para evitar que múltiples escritores simultáneos
181 interfieran entre sí, corrompiendo el repositorio.
183 Ya que Mercurial tiene cuidado con el orden en que lee y escribe
184 datos, no necesita adquirir un bloqueo cuando desea leer datos del
185 repositorio. Las partes de Mercurial que leen del repositorio nunca le
186 prestan atención a los bloqueos. Este esquema de lectura libre de
187 bloqueos incremententa en gran medida el desempeño y la concurrencia.
189 Sin embargo, para tener un gran desempeño es necesario hacer
190 sacrificios, uno de los cuales tiene el potencial de causarle
191 problemas a menos de que usted esté consciente de él. Describirlo
192 requiere algo de detalle respecto a cómo Mercurial añade conjuntos de
193 cambios al repositorio y cómo lee esos cambios de vuelta.
195 Cuando Mercurial \emph{escribe} metadatos, los escribe directamente en
196 el fichero de destino. Primero escribe los datos del fichero, luego
197 los datos del manifiesto (que contienen punteros a los nuevos datos
198 del fichero), luego datos de la bitácora de cambios (que contienen
199 punteros a los nuevos datos del manifiesto). Antes de la primera
200 escritura a cada fichero, se guarda un registro de dónde estaba el
201 final de fichero en su registro de transacciones. Si la transacción
202 debe ser deshecha, Mercurial simplemente trunca cada fichero de vuelta
203 al tamaño que tenía antes de que empezara la transacción.
205 Cuando Mercurial \emph{lee} metadatos, lee la bitácora de cambios
206 primero, y luego todo lo demás. Como un lector sólo accederá a las
207 partes del manifiesto o de los metadatos de fichero que él puede ver
208 en la bitácora de cambios, nunca puede ver datos parcialmente
209 escritos.
211 Algunos ganchos de control (\hook{pretxncommit} y
212 \hook{pretxnchangegroup}) se ejecutan cuando una transacción está casi
213 completa. Todos los metadatos han sido escritos, pero Mercurial aún
214 puede deshacer la transacción y hacer que los datos recién escritos
215 desaparezcan.
217 Si alguno de estos ganchos permanece en ejecución por mucho tiempo,
218 abre una ventana de tiempo en la que un lector puede ver los metadatos
219 de conjuntos de cambios que aún no son permanentes y que no debería
220 considerarse que estén ``realmante ahí''. Entre más tiempo tome la
221 ejecución del gancho, más tiempo estará abierta esta ventana.
223 \subsection{Ilustración del problema}
225 En principio, un buen uso del gancho \hook{pretxnchangegroup} sería
226 ensamblar y probar automáticamente todos los cambios entrantes antes
227 de que sean aceptados en un repositorio central. Esto le permitiría a
228 usted garantizar que nadie pueda empujar cambios que ``rompan el
229 ensamblaje''. Pero si un cliente puede jalar cambios mientras están
230 siendo probados, la utilidad de esta prueba es nula; alguien confiado
231 puede jalar cambios sin probar, lo que potencialmente podría romper su
232 proceso de ensamblaje.
234 La respuesta técnica más segura frente a este retos es montar dicho
235 repositorio ``guardián'' como \emph{unidireccional}. Permita que
236 reciba cambios desde el exterior, pero no permita que nadie jale
237 cambios de él (use el gancho \hook{preoutgoing} para bloquear esto).
238 Configure un gancho \hook{changegroup} para que si el ensamblaje o
239 prueba tiene éxito, el gancho empuje los nuevos cambios a otro
240 repositorio del que la gente \emph{pueda} jalar.
242 En la práctica, montar un cuello de botella centralizado como éste a
243 menudo no es una buena idea, y la visibilidad de las transacciones no
244 tiene nada que ver con el problema. A medida que el tamaño de un
245 proyecto---y el tiempo que toma ensamblarlo y probarlo---crece, usted
246 se acerca rápidamente a un límite con este enfoque ``pruebe antes de
247 comprar'', en el que tiene más conjuntos de cambios a probar que
248 tiempo para ocuparse de ellos. El resultado inevitable es frustración
249 para todos los que estén involucrados.
251 Una aproximación que permite manejar mejor el crecimiento es hacer que
252 la gente ensamble y pruebe antes de empujar, y ejecutar el ensamble y
253 pruebas automáticas centralmente \emph{después} de empujar, para
254 asegurarse de que todo esté bien. La ventaja de este enfoque es que no
255 impone un límite a la rata en la que un repositorio puede aceptar
256 cambios.
258 \section{Tutorial corto de uso de ganchos}
259 \label{sec:hook:simple}
261 Escribir un gancho para Mercurial es fácil. Empecemos con un gancho
262 que se ejecute cuando usted termine un \hgcmd{commit}, y simplemente
263 muestre el hash del conjunto de cambios que usted acaba de crear. El
264 gancho se llamará \hook{commit}.
266 \begin{figure}[ht]
267 \interaction{hook.simple.init}
268 \caption{Un gancho simple que se ejecuta al hacer la consignación de
269 un conjunto de cambios}
270 \label{ex:hook:init}
271 \end{figure}
273 Todos los ganchos siguen el patrón del ejemplo~\ref{ex:hook:init}.
274 Usted puede añadir una entrada a la sección \rcsection{hooks} de su
275 fichero \hgrc. A la izquierda está el nombre del evento respecto al
276 cual dispararse; a la derecha está la acción a llevar a cabo. Como
277 puede ver, es posible ejecutar cualquier orden de la línea de comandos
278 en un gancho. Mercurial le pasa información extra al gancho usando
279 variables de entorno (busque \envar{HG\_NODE} en el ejemplo).
281 \subsection{Llevar a cabo varias acciones por evento}
283 A menudo, usted querrá definir más de un gancho para un tipo de evento
284 particular, como se muestra en el ejemplo~\ref{ex:hook:ext}.
285 Mercurial le permite hacer esto añadiendo una \emph{extensión} al
286 final del nombre de un gancho. Usted extiende el nombre del gancho
287 %TODO Yuk, no me gusta ese "parada completa"
288 poniendo el nombre del gancho, seguido por una parada completa (el
289 caracter ``\texttt{.}''), seguido de algo más de texto de su elección.
290 Por ejemplo, Mercurial ejecutará tanto \texttt{commit.foo} como
291 \texttt{commit.bar} cuando ocurra el evento \texttt{commit}.
293 \begin{figure}[ht]
294 \interaction{hook.simple.ext}
295 \caption{Definición de un segundo gancho \hook{commit}}
296 \label{ex:hook:ext}
297 \end{figure}
299 Para dar un orden bien definido de ejecución cuando hay múltiples
300 ganchos definidos para un evento, Mercurial ordena los ganchos de
301 acuerdo a su extensión, y los ejecuta en dicho orden. En el ejemplo de
302 arribam \texttt{commit.bar} se ejecutará antes que
303 \texttt{commit.foo}, y \texttt{commit} se ejecutará antes de ambos.
305 Es una buena idea usar una extensión descriptiva cuando usted define
306 un gancho. Esto le ayudará a recordar para qué se usa el gancho. Si el
307 gancho falla, usted recibirá un mensaje de error que contiene el
308 nombre y la extensión del gancho, así que usar una extensión
309 descriptiva le dará una pista inmediata de porqué el gancho falló (vea
310 un ejemplo en la sección~\ref{sec:hook:perm}).
312 \subsection{Controlar cuándo puede llevarse a cabo una actividad}
313 \label{sec:hook:perm}
315 En los ejemplos anteriores, usamos el gancho \hook{commit}, que es
316 ejecutado después de que se ha completado una consignación. Este es
317 uno de los varios ganchos que Mercurial ejecuta luego de que una
318 actividad termina. Tales ganchos no tienen forma de influenciar la
319 actividad como tal.
321 Mercurial define un número de eventos que ocurren antes de que una
322 actividad empiece; o luego de que empiece, pero antes de que termine.
323 Los ganchos que se disparan con estos eventos tienen la capacidad
324 adicional de elegir si la actividad puede continuar, o si su ejecución
325 es abortada.
327 El gancho \hook{pretxncommit} se ejecuta justo antes de que una
328 consignación se ejecute. En otras palabras, los metadatos que
329 representan el conjunto de cambios han sido escritos al disco, pero no
330 se ha terminado la transacción. El gancho \hook{pretxncommit} tiene la
331 capacidad de decidir si una transacción se completa, o debe
332 deshacerse.
334 Si el gancho \hook{pretxncommit} termina con un código de salida de
335 cero, se permite que la transacción se complete; la consignación
336 termina; y el gancho \hook{commit} es ejecutado. Si el gancho
337 \hook{pretxncommit} termina con un código de salida diferente de cero,
338 la transacción es revertida; los metadatos representando el conjunto
339 de cambios son borrados; y el gancho \hook{commit} no es ejecutado.
341 \begin{figure}[ht]
342 \interaction{hook.simple.pretxncommit}
343 \caption{Uso del gancho \hook{pretxncommit} hook to control commits}
344 \label{ex:hook:pretxncommit}
345 \end{figure}
347 El gancho en el ejemplo~\ref{ex:hook:pretxncommit} revisa si el
348 mensaje de consignación contiene el ID de algún fallo. Si lo contiene,
349 la consignación puede continuar. Si no, la consignación es cancelada.
351 \section{Escribir sus propios ganchos}
353 Cuando usted escriba un gancho, puede encontrar útil el ejecutar
354 Mercurial o bien pasándole la opción \hggopt{-v}, o con el valor de
355 configuración \rcitem{ui}{verbose} fijado en ``true'' (verdadero).
356 Cuando lo haga, Mercurial imprimirá un mensaje antes de llamar cada
357 gancho.
359 \subsection{Escoger cómo debe ejecutarse su gancho}
360 \label{sec:hook:lang}
362 Usted puede escribir un gancho que funcione como un programa normal
363 ---típicamente un guión de línea de comandos---o como una función de
364 Python que se ejecuta dentro del proceso Mercurial.
366 Escribir un gancho como un programa externo tiene la ventaja de que no
367 requiere ningún conocimiento del funcionamiento interno de Mercurial.
368 Usted puede ejecutar comandos Mercurial normales para obtener la
369 informción extra que pueda necesitar. La contraparte de esto es que
370 los ganchos externos son más lentos que los ganchos internos
371 ejecutados dentro del proceso.
373 Un gancho Python interno tiene acceso completo a la API de Mercurial,
374 y no se ``externaliza'' a otro proceso, así que es inherentemente más
375 rápido que un gancho externo. Adicionalmente es más fácil obtener la
376 mayoría de la información que un gancho requiere a través de llamadas
377 directas a la API de Mercurial que hacerlo ejecutando comandos
378 Mercurial.
380 Si se siente a gusto con Python, o requiere un alto desempeño,
381 escribir sus ganchos en Python puede ser una buena elección. Sin
382 embargo, cuando usted tiene un gancho bastante directo por escribir y
383 no le importa el desempeño (el caso de la mayoría de los ganchos), es
384 perfectamente admisible un guión de línea de comandos.
386 \subsection{Parámetros para ganchos}
387 \label{sec:hook:param}
389 Mercurial llama cada gancho con un conjunto de paŕametros bien
390 definidos. En Python, un parámetro se pasa como argumento de palabra
391 clave a su función de gancho. Para un programa externo, los parámetros
392 son pasados como variables de entornos.
394 Sin importar si su gancho está escrito en Python o como guión de línea
395 de comandos, los nombres y valores de los parámetros específicos de
396 los ganchos serán los mismos. Un parámetro booleano será representado
397 como un valor booleano en Python, pero como el número 1 (para
398 ``verdadero'') o 0 (para falso) en una variable de entorno para un
399 gancho externo. Si un parámetro se llama \texttt{foo}, el argumento de
400 palabra clave para un gancho en Python también se llamará
401 \texttt{foo}, mientras que la variable de entorno para un gancho
402 externo se llamará \texttt{HG\_FOO}.
404 \subsection{Valores de retorno de ganchos y control de actividades}
406 Un gancho que se ejecuta exitosamente debe terminar con un código de
407 salida de cero, si es externo, o retornar el valor booleano
408 ``falso'', si es interno. Un fallo se indica con un código de salida
409 diferente de cero desde un gancho externo, o un valor de retorno
410 booleano ``verdadero''. Si un gancho interno genera una excepción, se
411 considera que el gancho ha fallado.
413 Para los ganchos que controlan si una actividad puede continuar o no,
414 cero/falso quiere decir ``permitir'', mientras que
415 % TODO me suena mejor "no permitir" que "denegar"
416 no-cero/verdadero/excepción quiere decir ``no permitir''.
418 \subsection{Escribir un gancho externo}
420 Cuando usted define un gancho externo en su fichero \hgrc\ y el mismo
421 es ejecutado, dicha definición pasa a su intérprete de comandos, que
422 hace la interpretación correspondiente. Esto significa que usted puede
423 usar elementos normales del intérprete en el cuerpo del gancho.
425 Un gancho ejecutable siempre es ejecutado con su directorio actual
426 fijado al directorio raíz del repositorio.
428 Cada parámetro para el gancho es pasado como una variable de entorno;
429 el nombre está en mayúsculas, y tiene como prefijo la cadena
430 ``\texttt{HG\_}''.
432 Con la excepción de los parámetros para los ganchos, Mercurial no
433 define o modifica ninguna variable de entorno al ejecutar un gancho.
434 Es útil recordar esto al escribir un gancho global que podría ser
435 ejecutado por varios usuarios con distintas variables de entorno
436 fijadas. En situaciones con múltiples usuarios, usted no debería
437 asumir la existencia de ninguna variable de entorno, ni que sus
438 valores sean los mismos que tenían cuando usted probó el gancho en su
439 ambiente de trabajo.
441 \subsection{Indicar a Mercurial que use un gancho interno}
443 La sintaxis para definir un gancho interno en el fichero \hgrc\ es
444 ligeramente diferente de la usada para un gancho externo. El valor del
445 gancho debe comenzar con el texto ``\texttt{python:}'', y continuar
446 con el nombre completamente cualificado de un objeto invocable que se
447 usará como el valor del gancho.
449 El módulo en que vive un gancho es importado automáticamente cuando se
450 ejecuta un gancho. Siempre que usted tenga el nombre del módulo y la
451 variable de entorno \envar{PYTHONPATH} ajustada adecuadamente, todo
452 debería funcionar sin problemas.
454 El siguiente fragmento de ejemplo de un fichero \hgrc\ ilustra la
455 sintaxis y significado de los conceptos que acabamos de describir.
456 \begin{codesample2}
457 [hooks]
458 commit.example = python:mymodule.submodule.myhook
459 \end{codesample2}
460 Cuando Mercurial ejecuta el gancho \texttt{commit.example}, importa
461 \texttt{mymodule.submodule}, busca el objeto invocable llamado
462 \texttt{myhook}, y lo invoca (llama).
464 \subsection{Escribir un gancho interno}
466 El gancho interno más sencillo no hace nada, pero ilustra la
467 estructura básica de la API\footnote{\emph{Application Progamming
468 Interface}, Interfaz para Programación de Aplicaciones} para ganchos:
469 \begin{codesample2}
470 def myhook(ui, repo, **kwargs):
471 pass
472 \end{codesample2}
473 The first argument to a Python hook is always a
474 \pymodclass{mercurial.ui}{ui} object. The second is a repository object;
475 at the moment, it is always an instance of
476 \pymodclass{mercurial.localrepo}{localrepository}. Following these two
477 arguments are other keyword arguments. Which ones are passed in
478 depends on the hook being called, but a hook can ignore arguments it
479 doesn't care about by dropping them into a keyword argument dict, as
480 with \texttt{**kwargs} above.
482 \section{Some hook examples}
484 \subsection{Writing meaningful commit messages}
486 It's hard to imagine a useful commit message being very short. The
487 simple \hook{pretxncommit} hook of figure~\ref{ex:hook:msglen.go}
488 will prevent you from committing a changeset with a message that is
489 less than ten bytes long.
491 \begin{figure}[ht]
492 \interaction{hook.msglen.go}
493 \caption{A hook that forbids overly short commit messages}
494 \label{ex:hook:msglen.go}
495 \end{figure}
497 \subsection{Checking for trailing whitespace}
499 An interesting use of a commit-related hook is to help you to write
500 cleaner code. A simple example of ``cleaner code'' is the dictum that
501 a change should not add any new lines of text that contain ``trailing
502 whitespace''. Trailing whitespace is a series of space and tab
503 characters at the end of a line of text. In most cases, trailing
504 whitespace is unnecessary, invisible noise, but it is occasionally
505 problematic, and people often prefer to get rid of it.
507 You can use either the \hook{precommit} or \hook{pretxncommit} hook to
508 tell whether you have a trailing whitespace problem. If you use the
509 \hook{precommit} hook, the hook will not know which files you are
510 committing, so it will have to check every modified file in the
511 repository for trailing white space. If you want to commit a change
512 to just the file \filename{foo}, but the file \filename{bar} contains
513 trailing whitespace, doing a check in the \hook{precommit} hook will
514 prevent you from committing \filename{foo} due to the problem with
515 \filename{bar}. This doesn't seem right.
517 Should you choose the \hook{pretxncommit} hook, the check won't occur
518 until just before the transaction for the commit completes. This will
519 allow you to check for problems only the exact files that are being
520 committed. However, if you entered the commit message interactively
521 and the hook fails, the transaction will roll back; you'll have to
522 re-enter the commit message after you fix the trailing whitespace and
523 run \hgcmd{commit} again.
525 \begin{figure}[ht]
526 \interaction{hook.ws.simple}
527 \caption{A simple hook that checks for trailing whitespace}
528 \label{ex:hook:ws.simple}
529 \end{figure}
531 Figure~\ref{ex:hook:ws.simple} introduces a simple \hook{pretxncommit}
532 hook that checks for trailing whitespace. This hook is short, but not
533 very helpful. It exits with an error status if a change adds a line
534 with trailing whitespace to any file, but does not print any
535 information that might help us to identify the offending file or
536 line. It also has the nice property of not paying attention to
537 unmodified lines; only lines that introduce new trailing whitespace
538 cause problems.
540 \begin{figure}[ht]
541 \interaction{hook.ws.better}
542 \caption{A better trailing whitespace hook}
543 \label{ex:hook:ws.better}
544 \end{figure}
546 The example of figure~\ref{ex:hook:ws.better} is much more complex,
547 but also more useful. It parses a unified diff to see if any lines
548 add trailing whitespace, and prints the name of the file and the line
549 number of each such occurrence. Even better, if the change adds
550 trailing whitespace, this hook saves the commit comment and prints the
551 name of the save file before exiting and telling Mercurial to roll the
552 transaction back, so you can use
553 \hgcmdargs{commit}{\hgopt{commit}{-l}~\emph{filename}} to reuse the
554 saved commit message once you've corrected the problem.
556 As a final aside, note in figure~\ref{ex:hook:ws.better} the use of
557 \command{perl}'s in-place editing feature to get rid of trailing
558 whitespace from a file. This is concise and useful enough that I will
559 reproduce it here.
560 \begin{codesample2}
561 perl -pi -e 's,\\s+\$,,' filename
562 \end{codesample2}
564 \section{Bundled hooks}
566 Mercurial ships with several bundled hooks. You can find them in the
567 \dirname{hgext} directory of a Mercurial source tree. If you are
568 using a Mercurial binary package, the hooks will be located in the
569 \dirname{hgext} directory of wherever your package installer put
570 Mercurial.
572 \subsection{\hgext{acl}---access control for parts of a repository}
574 The \hgext{acl} extension lets you control which remote users are
575 allowed to push changesets to a networked server. You can protect any
576 portion of a repository (including the entire repo), so that a
577 specific remote user can push changes that do not affect the protected
578 portion.
580 This extension implements access control based on the identity of the
581 user performing a push, \emph{not} on who committed the changesets
582 they're pushing. It makes sense to use this hook only if you have a
583 locked-down server environment that authenticates remote users, and
584 you want to be sure that only specific users are allowed to push
585 changes to that server.
587 \subsubsection{Configuring the \hook{acl} hook}
589 In order to manage incoming changesets, the \hgext{acl} hook must be
590 used as a \hook{pretxnchangegroup} hook. This lets it see which files
591 are modified by each incoming changeset, and roll back a group of
592 changesets if they modify ``forbidden'' files. Example:
593 \begin{codesample2}
594 [hooks]
595 pretxnchangegroup.acl = python:hgext.acl.hook
596 \end{codesample2}
598 The \hgext{acl} extension is configured using three sections.
600 The \rcsection{acl} section has only one entry, \rcitem{acl}{sources},
601 which lists the sources of incoming changesets that the hook should
602 pay attention to. You don't normally need to configure this section.
603 \begin{itemize}
604 \item[\rcitem{acl}{serve}] Control incoming changesets that are arriving
605 from a remote repository over http or ssh. This is the default
606 value of \rcitem{acl}{sources}, and usually the only setting you'll
607 need for this configuration item.
608 \item[\rcitem{acl}{pull}] Control incoming changesets that are
609 arriving via a pull from a local repository.
610 \item[\rcitem{acl}{push}] Control incoming changesets that are
611 arriving via a push from a local repository.
612 \item[\rcitem{acl}{bundle}] Control incoming changesets that are
613 arriving from another repository via a bundle.
614 \end{itemize}
616 The \rcsection{acl.allow} section controls the users that are allowed to
617 add changesets to the repository. If this section is not present, all
618 users that are not explicitly denied are allowed. If this section is
619 present, all users that are not explicitly allowed are denied (so an
620 empty section means that all users are denied).
622 The \rcsection{acl.deny} section determines which users are denied
623 from adding changesets to the repository. If this section is not
624 present or is empty, no users are denied.
626 The syntaxes for the \rcsection{acl.allow} and \rcsection{acl.deny}
627 sections are identical. On the left of each entry is a glob pattern
628 that matches files or directories, relative to the root of the
629 repository; on the right, a user name.
631 In the following example, the user \texttt{docwriter} can only push
632 changes to the \dirname{docs} subtree of the repository, while
633 \texttt{intern} can push changes to any file or directory except
634 \dirname{source/sensitive}.
635 \begin{codesample2}
636 [acl.allow]
637 docs/** = docwriter
639 [acl.deny]
640 source/sensitive/** = intern
641 \end{codesample2}
643 \subsubsection{Testing and troubleshooting}
645 If you want to test the \hgext{acl} hook, run it with Mercurial's
646 debugging output enabled. Since you'll probably be running it on a
647 server where it's not convenient (or sometimes possible) to pass in
648 the \hggopt{--debug} option, don't forget that you can enable
649 debugging output in your \hgrc:
650 \begin{codesample2}
651 [ui]
652 debug = true
653 \end{codesample2}
654 With this enabled, the \hgext{acl} hook will print enough information
655 to let you figure out why it is allowing or forbidding pushes from
656 specific users.
658 \subsection{\hgext{bugzilla}---integration with Bugzilla}
660 The \hgext{bugzilla} extension adds a comment to a Bugzilla bug
661 whenever it finds a reference to that bug ID in a commit comment. You
662 can install this hook on a shared server, so that any time a remote
663 user pushes changes to this server, the hook gets run.
665 It adds a comment to the bug that looks like this (you can configure
666 the contents of the comment---see below):
667 \begin{codesample2}
668 Changeset aad8b264143a, made by Joe User <joe.user@domain.com> in
669 the frobnitz repository, refers to this bug.
671 For complete details, see
672 http://hg.domain.com/frobnitz?cmd=changeset;node=aad8b264143a
674 Changeset description:
675 Fix bug 10483 by guarding against some NULL pointers
676 \end{codesample2}
677 The value of this hook is that it automates the process of updating a
678 bug any time a changeset refers to it. If you configure the hook
679 properly, it makes it easy for people to browse straight from a
680 Bugzilla bug to a changeset that refers to that bug.
682 You can use the code in this hook as a starting point for some more
683 exotic Bugzilla integration recipes. Here are a few possibilities:
684 \begin{itemize}
685 \item Require that every changeset pushed to the server have a valid
686 bug~ID in its commit comment. In this case, you'd want to configure
687 the hook as a \hook{pretxncommit} hook. This would allow the hook
688 to reject changes that didn't contain bug IDs.
689 \item Allow incoming changesets to automatically modify the
690 \emph{state} of a bug, as well as simply adding a comment. For
691 example, the hook could recognise the string ``fixed bug 31337'' as
692 indicating that it should update the state of bug 31337 to
693 ``requires testing''.
694 \end{itemize}
696 \subsubsection{Configuring the \hook{bugzilla} hook}
697 \label{sec:hook:bugzilla:config}
699 You should configure this hook in your server's \hgrc\ as an
700 \hook{incoming} hook, for example as follows:
701 \begin{codesample2}
702 [hooks]
703 incoming.bugzilla = python:hgext.bugzilla.hook
704 \end{codesample2}
706 Because of the specialised nature of this hook, and because Bugzilla
707 was not written with this kind of integration in mind, configuring
708 this hook is a somewhat involved process.
710 Before you begin, you must install the MySQL bindings for Python on
711 the host(s) where you'll be running the hook. If this is not
712 available as a binary package for your system, you can download it
713 from~\cite{web:mysql-python}.
715 Configuration information for this hook lives in the
716 \rcsection{bugzilla} section of your \hgrc.
717 \begin{itemize}
718 \item[\rcitem{bugzilla}{version}] The version of Bugzilla installed on
719 the server. The database schema that Bugzilla uses changes
720 occasionally, so this hook has to know exactly which schema to use.
721 At the moment, the only version supported is \texttt{2.16}.
722 \item[\rcitem{bugzilla}{host}] The hostname of the MySQL server that
723 stores your Bugzilla data. The database must be configured to allow
724 connections from whatever host you are running the \hook{bugzilla}
725 hook on.
726 \item[\rcitem{bugzilla}{user}] The username with which to connect to
727 the MySQL server. The database must be configured to allow this
728 user to connect from whatever host you are running the
729 \hook{bugzilla} hook on. This user must be able to access and
730 modify Bugzilla tables. The default value of this item is
731 \texttt{bugs}, which is the standard name of the Bugzilla user in a
732 MySQL database.
733 \item[\rcitem{bugzilla}{password}] The MySQL password for the user you
734 configured above. This is stored as plain text, so you should make
735 sure that unauthorised users cannot read the \hgrc\ file where you
736 store this information.
737 \item[\rcitem{bugzilla}{db}] The name of the Bugzilla database on the
738 MySQL server. The default value of this item is \texttt{bugs},
739 which is the standard name of the MySQL database where Bugzilla
740 stores its data.
741 \item[\rcitem{bugzilla}{notify}] If you want Bugzilla to send out a
742 notification email to subscribers after this hook has added a
743 comment to a bug, you will need this hook to run a command whenever
744 it updates the database. The command to run depends on where you
745 have installed Bugzilla, but it will typically look something like
746 this, if you have Bugzilla installed in
747 \dirname{/var/www/html/bugzilla}:
748 \begin{codesample4}
749 cd /var/www/html/bugzilla && ./processmail %s nobody@nowhere.com
750 \end{codesample4}
751 The Bugzilla \texttt{processmail} program expects to be given a
752 bug~ID (the hook replaces ``\texttt{\%s}'' with the bug~ID) and an
753 email address. It also expects to be able to write to some files in
754 the directory that it runs in. If Bugzilla and this hook are not
755 installed on the same machine, you will need to find a way to run
756 \texttt{processmail} on the server where Bugzilla is installed.
757 \end{itemize}
759 \subsubsection{Mapping committer names to Bugzilla user names}
761 By default, the \hgext{bugzilla} hook tries to use the email address
762 of a changeset's committer as the Bugzilla user name with which to
763 update a bug. If this does not suit your needs, you can map committer
764 email addresses to Bugzilla user names using a \rcsection{usermap}
765 section.
767 Each item in the \rcsection{usermap} section contains an email address
768 on the left, and a Bugzilla user name on the right.
769 \begin{codesample2}
770 [usermap]
771 jane.user@example.com = jane
772 \end{codesample2}
773 You can either keep the \rcsection{usermap} data in a normal \hgrc, or
774 tell the \hgext{bugzilla} hook to read the information from an
775 external \filename{usermap} file. In the latter case, you can store
776 \filename{usermap} data by itself in (for example) a user-modifiable
777 repository. This makes it possible to let your users maintain their
778 own \rcitem{bugzilla}{usermap} entries. The main \hgrc\ file might
779 look like this:
780 \begin{codesample2}
781 # regular hgrc file refers to external usermap file
782 [bugzilla]
783 usermap = /home/hg/repos/userdata/bugzilla-usermap.conf
784 \end{codesample2}
785 While the \filename{usermap} file that it refers to might look like
786 this:
787 \begin{codesample2}
788 # bugzilla-usermap.conf - inside a hg repository
789 [usermap]
790 stephanie@example.com = steph
791 \end{codesample2}
793 \subsubsection{Configuring the text that gets added to a bug}
795 You can configure the text that this hook adds as a comment; you
796 specify it in the form of a Mercurial template. Several \hgrc\
797 entries (still in the \rcsection{bugzilla} section) control this
798 behaviour.
799 \begin{itemize}
800 \item[\texttt{strip}] The number of leading path elements to strip
801 from a repository's path name to construct a partial path for a URL.
802 For example, if the repositories on your server live under
803 \dirname{/home/hg/repos}, and you have a repository whose path is
804 \dirname{/home/hg/repos/app/tests}, then setting \texttt{strip} to
805 \texttt{4} will give a partial path of \dirname{app/tests}. The
806 hook will make this partial path available when expanding a
807 template, as \texttt{webroot}.
808 \item[\texttt{template}] The text of the template to use. In addition
809 to the usual changeset-related variables, this template can use
810 \texttt{hgweb} (the value of the \texttt{hgweb} configuration item
811 above) and \texttt{webroot} (the path constructed using
812 \texttt{strip} above).
813 \end{itemize}
815 In addition, you can add a \rcitem{web}{baseurl} item to the
816 \rcsection{web} section of your \hgrc. The \hgext{bugzilla} hook will
817 make this available when expanding a template, as the base string to
818 use when constructing a URL that will let users browse from a Bugzilla
819 comment to view a changeset. Example:
820 \begin{codesample2}
821 [web]
822 baseurl = http://hg.domain.com/
823 \end{codesample2}
825 Here is an example set of \hgext{bugzilla} hook config information.
826 \begin{codesample2}
827 [bugzilla]
828 host = bugzilla.example.com
829 password = mypassword
830 version = 2.16
831 # server-side repos live in /home/hg/repos, so strip 4 leading
832 # separators
833 strip = 4
834 hgweb = http://hg.example.com/
835 usermap = /home/hg/repos/notify/bugzilla.conf
836 template = Changeset \{node|short\}, made by \{author\} in the \{webroot\}
837 repo, refers to this bug.\\nFor complete details, see
838 \{hgweb\}\{webroot\}?cmd=changeset;node=\{node|short\}\\nChangeset
839 description:\\n\\t\{desc|tabindent\}
840 \end{codesample2}
842 \subsubsection{Testing and troubleshooting}
844 The most common problems with configuring the \hgext{bugzilla} hook
845 relate to running Bugzilla's \filename{processmail} script and mapping
846 committer names to user names.
848 Recall from section~\ref{sec:hook:bugzilla:config} above that the user
849 that runs the Mercurial process on the server is also the one that
850 will run the \filename{processmail} script. The
851 \filename{processmail} script sometimes causes Bugzilla to write to
852 files in its configuration directory, and Bugzilla's configuration
853 files are usually owned by the user that your web server runs under.
855 You can cause \filename{processmail} to be run with the suitable
856 user's identity using the \command{sudo} command. Here is an example
857 entry for a \filename{sudoers} file.
858 \begin{codesample2}
859 hg_user = (httpd_user) NOPASSWD: /var/www/html/bugzilla/processmail-wrapper %s
860 \end{codesample2}
861 This allows the \texttt{hg\_user} user to run a
862 \filename{processmail-wrapper} program under the identity of
863 \texttt{httpd\_user}.
865 This indirection through a wrapper script is necessary, because
866 \filename{processmail} expects to be run with its current directory
867 set to wherever you installed Bugzilla; you can't specify that kind of
868 constraint in a \filename{sudoers} file. The contents of the wrapper
869 script are simple:
870 \begin{codesample2}
871 #!/bin/sh
872 cd `dirname $0` && ./processmail "$1" nobody@example.com
873 \end{codesample2}
874 It doesn't seem to matter what email address you pass to
875 \filename{processmail}.
877 If your \rcsection{usermap} is not set up correctly, users will see an
878 error message from the \hgext{bugzilla} hook when they push changes
879 to the server. The error message will look like this:
880 \begin{codesample2}
881 cannot find bugzilla user id for john.q.public@example.com
882 \end{codesample2}
883 What this means is that the committer's address,
884 \texttt{john.q.public@example.com}, is not a valid Bugzilla user name,
885 nor does it have an entry in your \rcsection{usermap} that maps it to
886 a valid Bugzilla user name.
888 \subsection{\hgext{notify}---send email notifications}
890 Although Mercurial's built-in web server provides RSS feeds of changes
891 in every repository, many people prefer to receive change
892 notifications via email. The \hgext{notify} hook lets you send out
893 notifications to a set of email addresses whenever changesets arrive
894 that those subscribers are interested in.
896 As with the \hgext{bugzilla} hook, the \hgext{notify} hook is
897 template-driven, so you can customise the contents of the notification
898 messages that it sends.
900 By default, the \hgext{notify} hook includes a diff of every changeset
901 that it sends out; you can limit the size of the diff, or turn this
902 feature off entirely. It is useful for letting subscribers review
903 changes immediately, rather than clicking to follow a URL.
905 \subsubsection{Configuring the \hgext{notify} hook}
907 You can set up the \hgext{notify} hook to send one email message per
908 incoming changeset, or one per incoming group of changesets (all those
909 that arrived in a single pull or push).
910 \begin{codesample2}
911 [hooks]
912 # send one email per group of changes
913 changegroup.notify = python:hgext.notify.hook
914 # send one email per change
915 incoming.notify = python:hgext.notify.hook
916 \end{codesample2}
918 Configuration information for this hook lives in the
919 \rcsection{notify} section of a \hgrc\ file.
920 \begin{itemize}
921 \item[\rcitem{notify}{test}] By default, this hook does not send out
922 email at all; instead, it prints the message that it \emph{would}
923 send. Set this item to \texttt{false} to allow email to be sent.
924 The reason that sending of email is turned off by default is that it
925 takes several tries to configure this extension exactly as you would
926 like, and it would be bad form to spam subscribers with a number of
927 ``broken'' notifications while you debug your configuration.
928 \item[\rcitem{notify}{config}] The path to a configuration file that
929 contains subscription information. This is kept separate from the
930 main \hgrc\ so that you can maintain it in a repository of its own.
931 People can then clone that repository, update their subscriptions,
932 and push the changes back to your server.
933 \item[\rcitem{notify}{strip}] The number of leading path separator
934 characters to strip from a repository's path, when deciding whether
935 a repository has subscribers. For example, if the repositories on
936 your server live in \dirname{/home/hg/repos}, and \hgext{notify} is
937 considering a repository named \dirname{/home/hg/repos/shared/test},
938 setting \rcitem{notify}{strip} to \texttt{4} will cause
939 \hgext{notify} to trim the path it considers down to
940 \dirname{shared/test}, and it will match subscribers against that.
941 \item[\rcitem{notify}{template}] The template text to use when sending
942 messages. This specifies both the contents of the message header
943 and its body.
944 \item[\rcitem{notify}{maxdiff}] The maximum number of lines of diff
945 data to append to the end of a message. If a diff is longer than
946 this, it is truncated. By default, this is set to 300. Set this to
947 \texttt{0} to omit diffs from notification emails.
948 \item[\rcitem{notify}{sources}] A list of sources of changesets to
949 consider. This lets you limit \hgext{notify} to only sending out
950 email about changes that remote users pushed into this repository
951 via a server, for example. See section~\ref{sec:hook:sources} for
952 the sources you can specify here.
953 \end{itemize}
955 If you set the \rcitem{web}{baseurl} item in the \rcsection{web}
956 section, you can use it in a template; it will be available as
957 \texttt{webroot}.
959 Here is an example set of \hgext{notify} configuration information.
960 \begin{codesample2}
961 [notify]
962 # really send email
963 test = false
964 # subscriber data lives in the notify repo
965 config = /home/hg/repos/notify/notify.conf
966 # repos live in /home/hg/repos on server, so strip 4 "/" chars
967 strip = 4
968 template = X-Hg-Repo: \{webroot\}
969 Subject: \{webroot\}: \{desc|firstline|strip\}
970 From: \{author\}
972 changeset \{node|short\} in \{root\}
973 details: \{baseurl\}\{webroot\}?cmd=changeset;node=\{node|short\}
974 description:
975 \{desc|tabindent|strip\}
977 [web]
978 baseurl = http://hg.example.com/
979 \end{codesample2}
981 This will produce a message that looks like the following:
982 \begin{codesample2}
983 X-Hg-Repo: tests/slave
984 Subject: tests/slave: Handle error case when slave has no buffers
985 Date: Wed, 2 Aug 2006 15:25:46 -0700 (PDT)
987 changeset 3cba9bfe74b5 in /home/hg/repos/tests/slave
988 details: http://hg.example.com/tests/slave?cmd=changeset;node=3cba9bfe74b5
989 description:
990 Handle error case when slave has no buffers
991 diffs (54 lines):
993 diff -r 9d95df7cf2ad -r 3cba9bfe74b5 include/tests.h
994 --- a/include/tests.h Wed Aug 02 15:19:52 2006 -0700
995 +++ b/include/tests.h Wed Aug 02 15:25:26 2006 -0700
996 @@ -212,6 +212,15 @@ static __inline__ void test_headers(void *h)
997 [...snip...]
998 \end{codesample2}
1000 \subsubsection{Testing and troubleshooting}
1002 Do not forget that by default, the \hgext{notify} extension \emph{will
1003 not send any mail} until you explicitly configure it to do so, by
1004 setting \rcitem{notify}{test} to \texttt{false}. Until you do that,
1005 it simply prints the message it \emph{would} send.
1007 \section{Information for writers of hooks}
1008 \label{sec:hook:ref}
1010 \subsection{In-process hook execution}
1012 An in-process hook is called with arguments of the following form:
1013 \begin{codesample2}
1014 def myhook(ui, repo, **kwargs):
1015 pass
1016 \end{codesample2}
1017 The \texttt{ui} parameter is a \pymodclass{mercurial.ui}{ui} object.
1018 The \texttt{repo} parameter is a
1019 \pymodclass{mercurial.localrepo}{localrepository} object. The
1020 names and values of the \texttt{**kwargs} parameters depend on the
1021 hook being invoked, with the following common features:
1022 \begin{itemize}
1023 \item If a parameter is named \texttt{node} or
1024 \texttt{parent\emph{N}}, it will contain a hexadecimal changeset ID.
1025 The empty string is used to represent ``null changeset ID'' instead
1026 of a string of zeroes.
1027 \item If a parameter is named \texttt{url}, it will contain the URL of
1028 a remote repository, if that can be determined.
1029 \item Boolean-valued parameters are represented as Python
1030 \texttt{bool} objects.
1031 \end{itemize}
1033 An in-process hook is called without a change to the process's working
1034 directory (unlike external hooks, which are run in the root of the
1035 repository). It must not change the process's working directory, or
1036 it will cause any calls it makes into the Mercurial API to fail.
1038 If a hook returns a boolean ``false'' value, it is considered to have
1039 succeeded. If it returns a boolean ``true'' value or raises an
1040 exception, it is considered to have failed. A useful way to think of
1041 the calling convention is ``tell me if you fail''.
1043 Note that changeset IDs are passed into Python hooks as hexadecimal
1044 strings, not the binary hashes that Mercurial's APIs normally use. To
1045 convert a hash from hex to binary, use the
1046 \pymodfunc{mercurial.node}{bin} function.
1048 \subsection{External hook execution}
1050 An external hook is passed to the shell of the user running Mercurial.
1051 Features of that shell, such as variable substitution and command
1052 redirection, are available. The hook is run in the root directory of
1053 the repository (unlike in-process hooks, which are run in the same
1054 directory that Mercurial was run in).
1056 Hook parameters are passed to the hook as environment variables. Each
1057 environment variable's name is converted in upper case and prefixed
1058 with the string ``\texttt{HG\_}''. For example, if the name of a
1059 parameter is ``\texttt{node}'', the name of the environment variable
1060 representing that parameter will be ``\texttt{HG\_NODE}''.
1062 A boolean parameter is represented as the string ``\texttt{1}'' for
1063 ``true'', ``\texttt{0}'' for ``false''. If an environment variable is
1064 named \envar{HG\_NODE}, \envar{HG\_PARENT1} or \envar{HG\_PARENT2}, it
1065 contains a changeset ID represented as a hexadecimal string. The
1066 empty string is used to represent ``null changeset ID'' instead of a
1067 string of zeroes. If an environment variable is named
1068 \envar{HG\_URL}, it will contain the URL of a remote repository, if
1069 that can be determined.
1071 If a hook exits with a status of zero, it is considered to have
1072 succeeded. If it exits with a non-zero status, it is considered to
1073 have failed.
1075 \subsection{Finding out where changesets come from}
1077 A hook that involves the transfer of changesets between a local
1078 repository and another may be able to find out information about the
1079 ``far side''. Mercurial knows \emph{how} changes are being
1080 transferred, and in many cases \emph{where} they are being transferred
1081 to or from.
1083 \subsubsection{Sources of changesets}
1084 \label{sec:hook:sources}
1086 Mercurial will tell a hook what means are, or were, used to transfer
1087 changesets between repositories. This is provided by Mercurial in a
1088 Python parameter named \texttt{source}, or an environment variable named
1089 \envar{HG\_SOURCE}.
1091 \begin{itemize}
1092 \item[\texttt{serve}] Changesets are transferred to or from a remote
1093 repository over http or ssh.
1094 \item[\texttt{pull}] Changesets are being transferred via a pull from
1095 one repository into another.
1096 \item[\texttt{push}] Changesets are being transferred via a push from
1097 one repository into another.
1098 \item[\texttt{bundle}] Changesets are being transferred to or from a
1099 bundle.
1100 \end{itemize}
1102 \subsubsection{Where changes are going---remote repository URLs}
1103 \label{sec:hook:url}
1105 When possible, Mercurial will tell a hook the location of the ``far
1106 side'' of an activity that transfers changeset data between
1107 repositories. This is provided by Mercurial in a Python parameter
1108 named \texttt{url}, or an environment variable named \envar{HG\_URL}.
1110 This information is not always known. If a hook is invoked in a
1111 repository that is being served via http or ssh, Mercurial cannot tell
1112 where the remote repository is, but it may know where the client is
1113 connecting from. In such cases, the URL will take one of the
1114 following forms:
1115 \begin{itemize}
1116 \item \texttt{remote:ssh:\emph{ip-address}}---remote ssh client, at
1117 the given IP address.
1118 \item \texttt{remote:http:\emph{ip-address}}---remote http client, at
1119 the given IP address. If the client is using SSL, this will be of
1120 the form \texttt{remote:https:\emph{ip-address}}.
1121 \item Empty---no information could be discovered about the remote
1122 client.
1123 \end{itemize}
1125 \section{Hook reference}
1127 \subsection{\hook{changegroup}---after remote changesets added}
1128 \label{sec:hook:changegroup}
1130 This hook is run after a group of pre-existing changesets has been
1131 added to the repository, for example via a \hgcmd{pull} or
1132 \hgcmd{unbundle}. This hook is run once per operation that added one
1133 or more changesets. This is in contrast to the \hook{incoming} hook,
1134 which is run once per changeset, regardless of whether the changesets
1135 arrive in a group.
1137 Some possible uses for this hook include kicking off an automated
1138 build or test of the added changesets, updating a bug database, or
1139 notifying subscribers that a repository contains new changes.
1141 Parameters to this hook:
1142 \begin{itemize}
1143 \item[\texttt{node}] A changeset ID. The changeset ID of the first
1144 changeset in the group that was added. All changesets between this
1145 and \index{tags!\texttt{tip}}\texttt{tip}, inclusive, were added by
1146 a single \hgcmd{pull}, \hgcmd{push} or \hgcmd{unbundle}.
1147 \item[\texttt{source}] A string. The source of these changes. See
1148 section~\ref{sec:hook:sources} for details.
1149 \item[\texttt{url}] A URL. The location of the remote repository, if
1150 known. See section~\ref{sec:hook:url} for more information.
1151 \end{itemize}
1153 See also: \hook{incoming} (section~\ref{sec:hook:incoming}),
1154 \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}),
1155 \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup})
1157 \subsection{\hook{commit}---after a new changeset is created}
1158 \label{sec:hook:commit}
1160 This hook is run after a new changeset has been created.
1162 Parameters to this hook:
1163 \begin{itemize}
1164 \item[\texttt{node}] A changeset ID. The changeset ID of the newly
1165 committed changeset.
1166 \item[\texttt{parent1}] A changeset ID. The changeset ID of the first
1167 parent of the newly committed changeset.
1168 \item[\texttt{parent2}] A changeset ID. The changeset ID of the second
1169 parent of the newly committed changeset.
1170 \end{itemize}
1172 See also: \hook{precommit} (section~\ref{sec:hook:precommit}),
1173 \hook{pretxncommit} (section~\ref{sec:hook:pretxncommit})
1175 \subsection{\hook{incoming}---after one remote changeset is added}
1176 \label{sec:hook:incoming}
1178 This hook is run after a pre-existing changeset has been added to the
1179 repository, for example via a \hgcmd{push}. If a group of changesets
1180 was added in a single operation, this hook is called once for each
1181 added changeset.
1183 You can use this hook for the same purposes as the \hook{changegroup}
1184 hook (section~\ref{sec:hook:changegroup}); it's simply more convenient
1185 sometimes to run a hook once per group of changesets, while other
1186 times it's handier once per changeset.
1188 Parameters to this hook:
1189 \begin{itemize}
1190 \item[\texttt{node}] A changeset ID. The ID of the newly added
1191 changeset.
1192 \item[\texttt{source}] A string. The source of these changes. See
1193 section~\ref{sec:hook:sources} for details.
1194 \item[\texttt{url}] A URL. The location of the remote repository, if
1195 known. See section~\ref{sec:hook:url} for more information.
1196 \end{itemize}
1198 See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}) \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}), \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup})
1200 \subsection{\hook{outgoing}---after changesets are propagated}
1201 \label{sec:hook:outgoing}
1203 This hook is run after a group of changesets has been propagated out
1204 of this repository, for example by a \hgcmd{push} or \hgcmd{bundle}
1205 command.
1207 One possible use for this hook is to notify administrators that
1208 changes have been pulled.
1210 Parameters to this hook:
1211 \begin{itemize}
1212 \item[\texttt{node}] A changeset ID. The changeset ID of the first
1213 changeset of the group that was sent.
1214 \item[\texttt{source}] A string. The source of the of the operation
1215 (see section~\ref{sec:hook:sources}). If a remote client pulled
1216 changes from this repository, \texttt{source} will be
1217 \texttt{serve}. If the client that obtained changes from this
1218 repository was local, \texttt{source} will be \texttt{bundle},
1219 \texttt{pull}, or \texttt{push}, depending on the operation the
1220 client performed.
1221 \item[\texttt{url}] A URL. The location of the remote repository, if
1222 known. See section~\ref{sec:hook:url} for more information.
1223 \end{itemize}
1225 See also: \hook{preoutgoing} (section~\ref{sec:hook:preoutgoing})
1227 \subsection{\hook{prechangegroup}---before starting to add remote changesets}
1228 \label{sec:hook:prechangegroup}
1230 This controlling hook is run before Mercurial begins to add a group of
1231 changesets from another repository.
1233 This hook does not have any information about the changesets to be
1234 added, because it is run before transmission of those changesets is
1235 allowed to begin. If this hook fails, the changesets will not be
1236 transmitted.
1238 One use for this hook is to prevent external changes from being added
1239 to a repository. For example, you could use this to ``freeze'' a
1240 server-hosted branch temporarily or permanently so that users cannot
1241 push to it, while still allowing a local administrator to modify the
1242 repository.
1244 Parameters to this hook:
1245 \begin{itemize}
1246 \item[\texttt{source}] A string. The source of these changes. See
1247 section~\ref{sec:hook:sources} for details.
1248 \item[\texttt{url}] A URL. The location of the remote repository, if
1249 known. See section~\ref{sec:hook:url} for more information.
1250 \end{itemize}
1252 See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}),
1253 \hook{incoming} (section~\ref{sec:hook:incoming}), ,
1254 \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup})
1256 \subsection{\hook{precommit}---before starting to commit a changeset}
1257 \label{sec:hook:precommit}
1259 This hook is run before Mercurial begins to commit a new changeset.
1260 It is run before Mercurial has any of the metadata for the commit,
1261 such as the files to be committed, the commit message, or the commit
1262 date.
1264 One use for this hook is to disable the ability to commit new
1265 changesets, while still allowing incoming changesets. Another is to
1266 run a build or test, and only allow the commit to begin if the build
1267 or test succeeds.
1269 Parameters to this hook:
1270 \begin{itemize}
1271 \item[\texttt{parent1}] A changeset ID. The changeset ID of the first
1272 parent of the working directory.
1273 \item[\texttt{parent2}] A changeset ID. The changeset ID of the second
1274 parent of the working directory.
1275 \end{itemize}
1276 If the commit proceeds, the parents of the working directory will
1277 become the parents of the new changeset.
1279 See also: \hook{commit} (section~\ref{sec:hook:commit}),
1280 \hook{pretxncommit} (section~\ref{sec:hook:pretxncommit})
1282 \subsection{\hook{preoutgoing}---before starting to propagate changesets}
1283 \label{sec:hook:preoutgoing}
1285 This hook is invoked before Mercurial knows the identities of the
1286 changesets to be transmitted.
1288 One use for this hook is to prevent changes from being transmitted to
1289 another repository.
1291 Parameters to this hook:
1292 \begin{itemize}
1293 \item[\texttt{source}] A string. The source of the operation that is
1294 attempting to obtain changes from this repository (see
1295 section~\ref{sec:hook:sources}). See the documentation for the
1296 \texttt{source} parameter to the \hook{outgoing} hook, in
1297 section~\ref{sec:hook:outgoing}, for possible values of this
1298 parameter.
1299 \item[\texttt{url}] A URL. The location of the remote repository, if
1300 known. See section~\ref{sec:hook:url} for more information.
1301 \end{itemize}
1303 See also: \hook{outgoing} (section~\ref{sec:hook:outgoing})
1305 \subsection{\hook{pretag}---before tagging a changeset}
1306 \label{sec:hook:pretag}
1308 This controlling hook is run before a tag is created. If the hook
1309 succeeds, creation of the tag proceeds. If the hook fails, the tag is
1310 not created.
1312 Parameters to this hook:
1313 \begin{itemize}
1314 \item[\texttt{local}] A boolean. Whether the tag is local to this
1315 repository instance (i.e.~stored in \sfilename{.hg/localtags}) or
1316 managed by Mercurial (stored in \sfilename{.hgtags}).
1317 \item[\texttt{node}] A changeset ID. The ID of the changeset to be tagged.
1318 \item[\texttt{tag}] A string. The name of the tag to be created.
1319 \end{itemize}
1321 If the tag to be created is revision-controlled, the \hook{precommit}
1322 and \hook{pretxncommit} hooks (sections~\ref{sec:hook:commit}
1323 and~\ref{sec:hook:pretxncommit}) will also be run.
1325 See also: \hook{tag} (section~\ref{sec:hook:tag})
1327 \subsection{\hook{pretxnchangegroup}---before completing addition of
1328 remote changesets}
1329 \label{sec:hook:pretxnchangegroup}
1331 This controlling hook is run before a transaction---that manages the
1332 addition of a group of new changesets from outside the
1333 repository---completes. If the hook succeeds, the transaction
1334 completes, and all of the changesets become permanent within this
1335 repository. If the hook fails, the transaction is rolled back, and
1336 the data for the changesets is erased.
1338 This hook can access the metadata associated with the almost-added
1339 changesets, but it should not do anything permanent with this data.
1340 It must also not modify the working directory.
1342 While this hook is running, if other Mercurial processes access this
1343 repository, they will be able to see the almost-added changesets as if
1344 they are permanent. This may lead to race conditions if you do not
1345 take steps to avoid them.
1347 This hook can be used to automatically vet a group of changesets. If
1348 the hook fails, all of the changesets are ``rejected'' when the
1349 transaction rolls back.
1351 Parameters to this hook:
1352 \begin{itemize}
1353 \item[\texttt{node}] A changeset ID. The changeset ID of the first
1354 changeset in the group that was added. All changesets between this
1355 and \index{tags!\texttt{tip}}\texttt{tip}, inclusive, were added by
1356 a single \hgcmd{pull}, \hgcmd{push} or \hgcmd{unbundle}.
1357 \item[\texttt{source}] A string. The source of these changes. See
1358 section~\ref{sec:hook:sources} for details.
1359 \item[\texttt{url}] A URL. The location of the remote repository, if
1360 known. See section~\ref{sec:hook:url} for more information.
1361 \end{itemize}
1363 See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}),
1364 \hook{incoming} (section~\ref{sec:hook:incoming}),
1365 \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup})
1367 \subsection{\hook{pretxncommit}---before completing commit of new changeset}
1368 \label{sec:hook:pretxncommit}
1370 This controlling hook is run before a transaction---that manages a new
1371 commit---completes. If the hook succeeds, the transaction completes
1372 and the changeset becomes permanent within this repository. If the
1373 hook fails, the transaction is rolled back, and the commit data is
1374 erased.
1376 This hook can access the metadata associated with the almost-new
1377 changeset, but it should not do anything permanent with this data. It
1378 must also not modify the working directory.
1380 While this hook is running, if other Mercurial processes access this
1381 repository, they will be able to see the almost-new changeset as if it
1382 is permanent. This may lead to race conditions if you do not take
1383 steps to avoid them.
1385 Parameters to this hook:
1386 \begin{itemize}
1387 \item[\texttt{node}] A changeset ID. The changeset ID of the newly
1388 committed changeset.
1389 \item[\texttt{parent1}] A changeset ID. The changeset ID of the first
1390 parent of the newly committed changeset.
1391 \item[\texttt{parent2}] A changeset ID. The changeset ID of the second
1392 parent of the newly committed changeset.
1393 \end{itemize}
1395 See also: \hook{precommit} (section~\ref{sec:hook:precommit})
1397 \subsection{\hook{preupdate}---before updating or merging working directory}
1398 \label{sec:hook:preupdate}
1400 This controlling hook is run before an update or merge of the working
1401 directory begins. It is run only if Mercurial's normal pre-update
1402 checks determine that the update or merge can proceed. If the hook
1403 succeeds, the update or merge may proceed; if it fails, the update or
1404 merge does not start.
1406 Parameters to this hook:
1407 \begin{itemize}
1408 \item[\texttt{parent1}] A changeset ID. The ID of the parent that the
1409 working directory is to be updated to. If the working directory is
1410 being merged, it will not change this parent.
1411 \item[\texttt{parent2}] A changeset ID. Only set if the working
1412 directory is being merged. The ID of the revision that the working
1413 directory is being merged with.
1414 \end{itemize}
1416 See also: \hook{update} (section~\ref{sec:hook:update})
1418 \subsection{\hook{tag}---after tagging a changeset}
1419 \label{sec:hook:tag}
1421 This hook is run after a tag has been created.
1423 Parameters to this hook:
1424 \begin{itemize}
1425 \item[\texttt{local}] A boolean. Whether the new tag is local to this
1426 repository instance (i.e.~stored in \sfilename{.hg/localtags}) or
1427 managed by Mercurial (stored in \sfilename{.hgtags}).
1428 \item[\texttt{node}] A changeset ID. The ID of the changeset that was
1429 tagged.
1430 \item[\texttt{tag}] A string. The name of the tag that was created.
1431 \end{itemize}
1433 If the created tag is revision-controlled, the \hook{commit} hook
1434 (section~\ref{sec:hook:commit}) is run before this hook.
1436 See also: \hook{pretag} (section~\ref{sec:hook:pretag})
1438 \subsection{\hook{update}---after updating or merging working directory}
1439 \label{sec:hook:update}
1441 This hook is run after an update or merge of the working directory
1442 completes. Since a merge can fail (if the external \command{hgmerge}
1443 command fails to resolve conflicts in a file), this hook communicates
1444 whether the update or merge completed cleanly.
1446 \begin{itemize}
1447 \item[\texttt{error}] A boolean. Indicates whether the update or
1448 merge completed successfully.
1449 \item[\texttt{parent1}] A changeset ID. The ID of the parent that the
1450 working directory was updated to. If the working directory was
1451 merged, it will not have changed this parent.
1452 \item[\texttt{parent2}] A changeset ID. Only set if the working
1453 directory was merged. The ID of the revision that the working
1454 directory was merged with.
1455 \end{itemize}
1457 See also: \hook{preupdate} (section~\ref{sec:hook:preupdate})
1459 %%% Local Variables:
1460 %%% mode: latex
1461 %%% TeX-master: "00book"
1462 %%% End: