CVSTrac

2008-02-24T00:38:43Z

RoltrTrocd: c4ttasitviro

lialchicac
__TOC__

[[Imagen:Cvstrac-mainscn.jpg|thumb|right|CVSTrac es un gestor de repositorios CVS.]]

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.
* 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/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>
$ mv cvstrac-200-suse92-bin cvstrac
$ chmod +x cvstrac
</pre>

Ahora copia el ejecutable a un lugar donde lo puedas encontrar cuando lo quieras ejecutar:

<pre>
$ sudo cp cvstrac /usr/bin
</pre>

== 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'':

<pre>
$ cvstrac init /home/cvs demo
</pre>

O hacerlo asÃ:

<pre>
$ su -c "cvstrac init /home/cvs demo" usuario
</pre>

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.

{{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 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'':

<pre>
80 stream tcp nowait.1000 cvs /usr/bin/cvstrac cvstrac http /home/cvs
</pre>

=== Usando xinetd ===
Crea el fichero '''/etc/xinetd.d/cvstrac''' con el siguiente contenido:

<pre>
service cvstrac {
socket_type = stream
wait = no
user = cvs
server = /usr/bin/cvstrac
server_args = http /home/cvs
}
</pre>

=== Como un CGI ===
Para ejecutarlo como un CGI tiene que crear un script como Ã©ste que encapsule la llamada:

<pre>
#!/bin/sh

/usr/bin/cvstrac cgi /home/cvs
</pre>

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>
#!/bin/sh

LANG=es_ES.UTF-8 /usr/bin/cvstrac cgi /home/cvs
</pre>

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:

<pre>
$ cvstrac server 8008 /home/cvs
</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 Ã©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>
<h1>Ticket <a href="http://cvstrac/tktview?tn=$gszTicketNumber">#$gszTicketNumber</a> was updated by $gszChanged.</h1>
<table border=0 cellpadding=2 cellspacing=1 bgcolor="black" width="100%">
<tr><th>Title:</th><td width="100%">$gszTitle</td></tr>
<tr><th>Type:</th><td>$gszType</td></tr>
<tr>
<th>Assigned to:</th>
<td>
<a href="mailto:$gszAssignedMail">$gszAssignedName</a>
</td>
</tr>
<tr><th>Status:</th><td>$gszStatus</td></tr>
<tr><th colspan=2>Description:</th></tr>
<tr><td colspan=2><pre>$gszDescription</pre></td></tr>
<tr><th colspan=2>Remarks:</th></tr>
<tr><td colspan=2><pre>$gszRemarks</pre></td></tr>
</table>
Generated by notify.pl at $gszTime<br>
<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.

== Ver tambiÃ©n ==
* [[CVS]]

== Enlaces externos ==
* http://www.cvstrac.org/
* [http://www.developingprogrammers.com/index.php/2005/12/15/cvstrac-and-trac-combined-tutorial/ CVSTrac and Trac Combined Tutorial]

[[CategorÃa:ProgramaciÃ³n]]

Guía Ubuntu - Contribuciones del usuario [es]

CVSTrac