Diferencia entre revisiones de «CVSTrac»
m (Revertida a la última edición por Monkiki) |
|||
Línea 1: | Línea 1: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
__TOC__ | __TOC__ | ||
[[Imagen:Cvstrac-mainscn.jpg|thumb|right|CVSTrac es un gestor de repositorios CVS.]] | [[Imagen:Cvstrac-mainscn.jpg|thumb|right|CVSTrac es un gestor de repositorios CVS.]] | ||
− | CVSTrac es un sistema de | + | CVSTrac es un sistema de gestión de incidencias basado en web para [[:w:es:CVS|CVS]]. Más información sobre cómo montar un repositorio CVS en [[CVS|esta misma guía]]. Se trata de una aplicación sencilla y potente con las siguientes características: |
* El interfaz web es simple y funcional. | * El interfaz web es simple y funcional. | ||
* Tiene un visualizador de repositorios CVS y un wiki integrados con el sistema de incidencias. | * Tiene un visualizador de repositorios CVS y un wiki integrados con el sistema de incidencias. | ||
− | * Ejecutable, puede funcionar en modo CGI o incluso de forma | + | * Ejecutable, puede funcionar en modo CGI o incluso de forma autónoma ya que incluye un servidor web. |
* Usa la base de datos SQLite, lo que permite escribir consultas complejas en SQL. | * Usa la base de datos SQLite, lo que permite escribir consultas complejas en SQL. | ||
* Puede gestionar los usuarios y permisos del repositorio CVS. | * Puede gestionar los usuarios y permisos del repositorio CVS. | ||
== Obtener el ejecutable == | == Obtener el ejecutable == | ||
− | En la | + | En la página del proyecto [http://www.cvstrac.org/cvstrac/wiki?p=DownloadCvstrac http://www.cvstrac.org/] puedes bajar la última versión. A día de hoy es la 2.0, la cual trae muchas mejoras sobre la 1.2.1 que es la que ha estado vigente durante bastante tiempo. Tienes la posibilidad de bajar las fuentes y compilarlas o bajar un binario compilado para SuSE que funcionará perfectamente en Dapper. Después de bajártelo, lo renombras y le das permisos de ejecución: |
<pre> | <pre> | ||
Línea 65: | Línea 26: | ||
== Inicializando la base de datos == | == Inicializando la base de datos == | ||
− | CVSTrac contiene su propio motor de base de datos SQL embebido, | + | CVSTrac contiene su propio motor de base de datos SQL embebido, así que no necesita ningún sistema de RDBMS externo. La base de datos de un proyecto se almacena en un sólo fichero. El primer paso para usar CVSTrac es inicializar esta base de datos. Para ello ejecuta el siguiente comando, pero tiene que ser como un usuario que no sea ''root'': |
<pre> | <pre> | ||
Línea 71: | Línea 32: | ||
</pre> | </pre> | ||
− | O hacerlo | + | O hacerlo así: |
<pre> | <pre> | ||
Línea 77: | Línea 38: | ||
</pre> | </pre> | ||
− | Cambia el argumento ''/home/cvs'' por el directorio donde quieras que | + | Cambia el argumento ''/home/cvs'' por el directorio donde quieras que esté la base de datos. Cambia el argumento ''demo'' por el nombre del proyecto CVS que gestionará CVSTrac. Con los parámetros actuales se crearía la base de datos llamada ''/home/cvs/demo.db''. |
− | Si vamos a ejecutar la | + | Si vamos a ejecutar la aplicación web en modo CGI tendrás que darle los permisos correspondientes a esta base de datos para que el CGI pueda leerla y modificarla: |
$ chown apache:apache /home/cvs/demo.db | $ chown apache:apache /home/cvs/demo.db | ||
− | Esta base de datos contiene toda la | + | Esta base de datos contiene toda la información del proyecto, por lo que es posible que la queramos consultar para hacer algún tipo de informe. El motor que usa es SQLite, por lo que todo el contenido está en ese fichero que hemos inicializado previamente. Si has instalado la última versión de CVSTrac (actualmente la 2.0.0), verás que usa como mínimo la versión 3.3.2 de SQLite3. En Dapper la versión de SQLite3 es la 3.2.8, de modo que no podrás hacer consultas sobre este fichero. Lo más sencillo es bajarse una versión compilada de http://www.sqlite.org/ y usar ésta. |
− | {{Nota|Si has bajado la | + | {{Nota|Si has bajado la versión compilada de CVSTrac te funcionará perfectamente porque viene compilado estáticamente con la versión correcta de SQLite3. Lo de bajarte el binario de SQLite3 actualizado es sólo para poder hacer consultas desde fuera del CVSTrac.}} |
− | == Varias formas de | + | == Varias formas de instalación == |
− | Como hemos visto, tiene varias formas de funcionar. En todas las configuraciones vamos a suponer que el directorio del repositorio CVS se encuentra en ''/home/cvs'' y el programa | + | Como hemos visto, tiene varias formas de funcionar. En todas las configuraciones vamos a suponer que el directorio del repositorio CVS se encuentra en ''/home/cvs'' y el programa estará accesible en el puerto 80 del servidor. |
=== Usando inetd === | === Usando inetd === | ||
− | + | Añade la siguiente línea al fichero ''/etc/inetd.conf'': | |
<pre> | <pre> | ||
Línea 111: | Línea 72: | ||
=== Como un CGI === | === Como un CGI === | ||
− | Para ejecutarlo como un CGI tiene que crear un script como | + | Para ejecutarlo como un CGI tiene que crear un script como éste que encapsule la llamada: |
<pre> | <pre> | ||
Línea 119: | Línea 80: | ||
</pre> | </pre> | ||
− | Este script con | + | Este script con extensión '''.cgi''' lo debes poner en el directorio '''/var/www/cgi-bin'''. Para temas de localización es mejor que el script sea así: |
<pre> | <pre> | ||
Línea 129: | Línea 90: | ||
O sea, que le antepones el establecimiento de la variable de entorno LANG para que el programa se ejecute usando los locales adecuados. | O sea, que le antepones el establecimiento de la variable de entorno LANG para que el programa se ejecute usando los locales adecuados. | ||
− | === Como un servidor web | + | === Como un servidor web autónomo === |
− | Si quieres que use su propio servidor web, ejecuta la | + | Si quieres que use su propio servidor web, ejecuta la línea de comando siguiente: |
<pre> | <pre> | ||
Línea 136: | Línea 97: | ||
</pre> | </pre> | ||
− | + | Estará a la escucha en el puerto TCP 8008. Ten en cuenta que tienes que ejecutar ''cvstrac'' en el '''CVSROOT''' del proyecto CVS, por ejemplo ''/home/cvs/CVSROOT''. Debe existir un directorio con el mismo nombre del proyecto en el mismo nivel. | |
− | == | + | == Configuración == |
− | Una vez instalado el programa para poder acceder a | + | Una vez instalado el programa para poder acceder a él vía web, entramos al sistema con el usuario y password ''setup''. Tendrás que cambiar el password del usuario ''setup'' por cuestiones de seguridad. |
− | Hay varias cosas a configurar para que se adapte a nuestro sistema de desarrollo. Muchas de ellas son opcionales y permiten hilar fino a la hora de poner todo a nuestro gusto. Sin embargo hay una que es obligatoria y es lo primero que tenemos que hacer: decirle donde se encuentra el repositorio que va a gestionar. Para hacer | + | Hay varias cosas a configurar para que se adapte a nuestro sistema de desarrollo. Muchas de ellas son opcionales y permiten hilar fino a la hora de poner todo a nuestro gusto. Sin embargo hay una que es obligatoria y es lo primero que tenemos que hacer: decirle donde se encuentra el repositorio que va a gestionar. Para hacer ésto vamos a '''Setup -> CVS Repository''' y ahí especificamos el directorio donde se encuentra el repositorio. En el caso de nuestro ejemplo sería ''/home/cvs''. La casilla que pone ''Module prefix:'' es por si tenemos muchos módulos y sólo queremos mostrar algunos. |
− | Si al ir la | + | Si al ir la opción '''Browse''' no ves ningún fichero ni directorio es que has metido los ficheros en el repositorio con un '''cvs import'''. CVSTrac sólo muestras los ficheros que se han incluido con un ''commit''. Vaya, ¿y ahora qué? Tampoco es tan grave. Puedes forzar un commit de todos los ficheros de un proyecto situándote en el directorio de nivel superior y haciendo ésto: |
$ cvs commit -f -R -m "imported into cvstrac" | $ cvs commit -f -R -m "imported into cvstrac" | ||
− | == | + | == Gestión de usuarios == |
− | Un usuario con permisos de administrador puede | + | Un usuario con permisos de administrador puede añadir y eliminar usuarios. Estos usuarios de CVSTrac también serán los usuarios de acceso al repositorio [[CVS]], de modo que podremos restringir de esta forma el acceso y acciones de los usuarios que acceden al repositorio. Hay muchos permisos que les podemos asignar a cada usuario, pero para un usuario normal que trabaje con el código del repositorio pondremos los siguientes '''ijknopqrw''', los cuales se detallan a continuación: |
− | * '''i (Check-in)''': | + | * '''i (Check-in)''': Añadir nuevo código al repositorio CVS. |
− | * '''j (Read-Wiki)''': Ver las | + | * '''j (Read-Wiki)''': Ver las páginas del wiki. |
− | * '''k (Wiki)''': Crear o modificar las | + | * '''k (Wiki)''': Crear o modificar las páginas del wiki. |
* '''n (New)''': Crear nuevos tickets de incidencias. | * '''n (New)''': Crear nuevos tickets de incidencias. | ||
− | * '''o (Check-out)''': Leer el | + | * '''o (Check-out)''': Leer el código del repositorio CVS. |
* '''p (Password)''': Cambiar el password (el suyo, se entiende). | * '''p (Password)''': Cambiar el password (el suyo, se entiende). | ||
* '''q (Query)''': Crear o editar informes. | * '''q (Query)''': Crear o editar informes. | ||
− | * '''r (Read)''': Ver tickets y cambiar | + | * '''r (Read)''': Ver tickets y cambiar histórico. |
* '''w (Write)''': Editar tickets. | * '''w (Write)''': Editar tickets. | ||
== Notificaciones en los cambios en los tickets == | == Notificaciones en los cambios en los tickets == | ||
− | CVSTrac admite gran cantidad de personalizaciones, como definir un programa externo que se ejecute cada vez que se crea o modifica un ticket. La | + | CVSTrac admite gran cantidad de personalizaciones, como definir un programa externo que se ejecute cada vez que se crea o modifica un ticket. La opción está accesible en ''Setup'' -> ''Change Notification''. El script que nos va a realizar esta tarea es uno tan simple como: |
echo '%d %r'|mail -s '[cvstrac] %p/%s/%t' '%A' | echo '%d %r'|mail -s '[cvstrac] %p/%s/%t' '%A' | ||
− | Buscando por | + | Buscando por ahí me he encontrado este otro más currado, pero no lo he probado: |
<perl> | <perl> | ||
Línea 235: | Línea 196: | ||
</perl> | </perl> | ||
− | En este caso la | + | En este caso la invocación del script sería: |
/usr/local/bin/notify.pl -n '%a' -a '%A' -c '%c' -d '%d' -i '%n' -p '%p' -r '%r' \ | /usr/local/bin/notify.pl -n '%a' -a '%A' -c '%c' -d '%d' -i '%n' -p '%p' -r '%r' \ | ||
-s '%s' -t '%t' -u '%u' -y '%y' -o '%w' | -s '%s' -t '%t' -u '%u' -y '%y' -o '%w' | ||
− | La barra invertida ('''\''') es para poder ponerlo en dos | + | La barra invertida ('''\''') es para poder ponerlo en dos líneas y mejorar la legibilidad. Cuando lo vaya a usar ponlo todo en una sola línea. |
− | == Ver | + | == Ver también == |
* [[CVS]] | * [[CVS]] | ||
Línea 249: | Línea 210: | ||
* [http://www.developingprogrammers.com/index.php/2005/12/15/cvstrac-and-trac-combined-tutorial/ CVSTrac and Trac Combined Tutorial] | * [http://www.developingprogrammers.com/index.php/2005/12/15/cvstrac-and-trac-combined-tutorial/ CVSTrac and Trac Combined Tutorial] | ||
− | [[ | + | [[Categoría:Programación]] |
Revisión de 23:38 26 mayo 2009
Contenido
CVSTrac es un sistema de gestión de incidencias basado en web para CVS. Más información sobre cómo montar un repositorio CVS en esta misma guía. Se trata de una aplicación sencilla y potente con las siguientes características:
- El interfaz web es simple y funcional.
- Tiene un visualizador de repositorios CVS y un wiki integrados con el sistema de incidencias.
- Ejecutable, puede funcionar en modo CGI o incluso de forma autónoma ya que incluye un servidor web.
- Usa la base de datos SQLite, lo que permite escribir consultas complejas en SQL.
- Puede gestionar los usuarios y permisos del repositorio CVS.
Obtener el ejecutable
En la página del proyecto http://www.cvstrac.org/ puedes bajar la última versión. A día de hoy es la 2.0, la cual trae muchas mejoras sobre la 1.2.1 que es la que ha estado vigente durante bastante tiempo. Tienes la posibilidad de bajar las fuentes y compilarlas o bajar un binario compilado para SuSE que funcionará perfectamente en Dapper. Después de bajártelo, lo renombras y le das permisos de ejecución:
$ mv cvstrac-200-suse92-bin cvstrac $ chmod +x cvstrac
Ahora copia el ejecutable a un lugar donde lo puedas encontrar cuando lo quieras ejecutar:
$ sudo cp cvstrac /usr/bin
Inicializando la base de datos
CVSTrac contiene su propio motor de base de datos SQL embebido, así que no necesita ningún sistema de RDBMS externo. La base de datos de un proyecto se almacena en un sólo fichero. El primer paso para usar CVSTrac es inicializar esta base de datos. Para ello ejecuta el siguiente comando, pero tiene que ser como un usuario que no sea root:
$ cvstrac init /home/cvs demo
O hacerlo así:
$ su -c "cvstrac init /home/cvs demo" usuario
Cambia el argumento /home/cvs por el directorio donde quieras que esté la base de datos. Cambia el argumento demo por el nombre del proyecto CVS que gestionará CVSTrac. Con los parámetros actuales se crearía la base de datos llamada /home/cvs/demo.db.
Si vamos a ejecutar la aplicación web en modo CGI tendrás que darle los permisos correspondientes a esta base de datos para que el CGI pueda leerla y modificarla:
$ chown apache:apache /home/cvs/demo.db
Esta base de datos contiene toda la información del proyecto, por lo que es posible que la queramos consultar para hacer algún tipo de informe. El motor que usa es SQLite, por lo que todo el contenido está en ese fichero que hemos inicializado previamente. Si has instalado la última versión de CVSTrac (actualmente la 2.0.0), verás que usa como mínimo la versión 3.3.2 de SQLite3. En Dapper la versión de SQLite3 es la 3.2.8, de modo que no podrás hacer consultas sobre este fichero. Lo más sencillo es bajarse una versión compilada de http://www.sqlite.org/ y usar ésta.
Varias formas de instalación
Como hemos visto, tiene varias formas de funcionar. En todas las configuraciones vamos a suponer que el directorio del repositorio CVS se encuentra en /home/cvs y el programa estará accesible en el puerto 80 del servidor.
Usando inetd
Añade la siguiente línea al fichero /etc/inetd.conf:
80 stream tcp nowait.1000 cvs /usr/bin/cvstrac cvstrac http /home/cvs
Usando xinetd
Crea el fichero /etc/xinetd.d/cvstrac con el siguiente contenido:
service cvstrac { socket_type = stream wait = no user = cvs server = /usr/bin/cvstrac server_args = http /home/cvs }
Como un CGI
Para ejecutarlo como un CGI tiene que crear un script como éste que encapsule la llamada:
#!/bin/sh /usr/bin/cvstrac cgi /home/cvs
Este script con extensión .cgi lo debes poner en el directorio /var/www/cgi-bin. Para temas de localización es mejor que el script sea así:
#!/bin/sh LANG=es_ES.UTF-8 /usr/bin/cvstrac cgi /home/cvs
O sea, que le antepones el establecimiento de la variable de entorno LANG para que el programa se ejecute usando los locales adecuados.
Como un servidor web autónomo
Si quieres que use su propio servidor web, ejecuta la línea de comando siguiente:
$ cvstrac server 8008 /home/cvs
Estará a la escucha en el puerto TCP 8008. Ten en cuenta que tienes que ejecutar cvstrac en el CVSROOT del proyecto CVS, por ejemplo /home/cvs/CVSROOT. Debe existir un directorio con el mismo nombre del proyecto en el mismo nivel.
Configuración
Una vez instalado el programa para poder acceder a él vía web, entramos al sistema con el usuario y password setup. Tendrás que cambiar el password del usuario setup por cuestiones de seguridad.
Hay varias cosas a configurar para que se adapte a nuestro sistema de desarrollo. Muchas de ellas son opcionales y permiten hilar fino a la hora de poner todo a nuestro gusto. Sin embargo hay una que es obligatoria y es lo primero que tenemos que hacer: decirle donde se encuentra el repositorio que va a gestionar. Para hacer ésto vamos a Setup -> CVS Repository y ahí especificamos el directorio donde se encuentra el repositorio. En el caso de nuestro ejemplo sería /home/cvs. La casilla que pone Module prefix: es por si tenemos muchos módulos y sólo queremos mostrar algunos.
Si al ir la opción Browse no ves ningún fichero ni directorio es que has metido los ficheros en el repositorio con un cvs import. CVSTrac sólo muestras los ficheros que se han incluido con un commit. Vaya, ¿y ahora qué? Tampoco es tan grave. Puedes forzar un commit de todos los ficheros de un proyecto situándote en el directorio de nivel superior y haciendo ésto:
$ cvs commit -f -R -m "imported into cvstrac"
Gestión de usuarios
Un usuario con permisos de administrador puede añadir y eliminar usuarios. Estos usuarios de CVSTrac también serán los usuarios de acceso al repositorio CVS, de modo que podremos restringir de esta forma el acceso y acciones de los usuarios que acceden al repositorio. Hay muchos permisos que les podemos asignar a cada usuario, pero para un usuario normal que trabaje con el código del repositorio pondremos los siguientes ijknopqrw, los cuales se detallan a continuación:
- i (Check-in): Añadir nuevo código al repositorio CVS.
- j (Read-Wiki): Ver las páginas del wiki.
- k (Wiki): Crear o modificar las páginas del wiki.
- n (New): Crear nuevos tickets de incidencias.
- o (Check-out): Leer el código del repositorio CVS.
- p (Password): Cambiar el password (el suyo, se entiende).
- q (Query): Crear o editar informes.
- r (Read): Ver tickets y cambiar histórico.
- w (Write): Editar tickets.
Notificaciones en los cambios en los tickets
CVSTrac admite gran cantidad de personalizaciones, como definir un programa externo que se ejecute cada vez que se crea o modifica un ticket. La opción está accesible en Setup -> Change Notification. El script que nos va a realizar esta tarea es uno tan simple como:
echo '%d %r'|mail -s '[cvstrac] %p/%s/%t' '%A'
Buscando por ahí me he encontrado este otro más currado, pero no lo he probado:
<perl>
- !/usr/bin/perl
use MIME::Lite; use POSIX; use Getopt::Long;
Getopt::Long::Configure('bundling');
if( @ARGV > 0 ) {
GetOptions( 'a|assigned=s' => \$gszAssignedMail, 'n|name=s' => \$gszAssignedName, 'c|contact=s' => \$gszContact, 'd|description=s' => \$gszDescription, 'i|ticket=s' => \$gszTicketNumber, 'p|project=s' => \$gszProject, 'r|remarks=s' => \$gszRemarks, 's|status=s' => \$gszStatus, 't|title=s' => \$gszTitle, 'u|changed=s' => \$gszChanged, 'o|originator=s' => \$gszOriginator, 'y|type=s' => \$gszType );
$gszTime = POSIX::strftime("%a, %m %d %H:%M", localtime);
$szBuffer = <<EOT;
<html> <style> BODY, P, TD, TH { background-color: white; font-size: 10px;
font-family: Arial, Helvetica, Sans-Serif; }
TH { text-align: left; font-size: 11px; background-color: #e0e0e0; } PRE { font-family: Lucida Console, Monaco, Courier New, fixed; font-size: 10px; } H1 { font-size: 18px; } </style> <body>
Ticket <a href="http://cvstrac/tktview?tn=$gszTicketNumber">#$gszTicketNumber</a> was updated by $gszChanged.
Title: | $gszTitle |
---|---|
Type: | $gszType |
Assigned to: |
<a href="mailto:$gszAssignedMail">$gszAssignedName</a> |
Status: | $gszStatus |
Description: | |
$gszDescription | |
Remarks: | |
$gszRemarks |
Generated by notify.pl at $gszTime
<a href="http://cvstrac/tktview?tn=$gszTicketNumber">View Ticket</a>
</body>
</html>
EOT
$msg = new MIME::Lite
From => 'issue-tracker@my.domain.com.com', To => $gszContact, Cc => $gszAssignedMail, Subject => "[$gszProject tracker] Ticket $gszTicketNumber updated by $gszChanged", Type => "text/html", Data => $szBuffer;
$msg->attr( 'content-type.charset' => "ISO-8859-1" );
$msg->send( 'smtp', 'smart.host.my.domain.com'); } </perl>
En este caso la invocación del script sería:
/usr/local/bin/notify.pl -n '%a' -a '%A' -c '%c' -d '%d' -i '%n' -p '%p' -r '%r' \ -s '%s' -t '%t' -u '%u' -y '%y' -o '%w'
La barra invertida (\) es para poder ponerlo en dos líneas y mejorar la legibilidad. Cuando lo vaya a usar ponlo todo en una sola línea.