Home > Chamilo, desarrollo, OSS Solutions, Spanish, técnico, Tech Crunch > Instalar Phing y Xinc en Ubuntu

Instalar Phing y Xinc en Ubuntu

Este proceso de instalación es específico a Ubuntu 9.10. Puede que funcione con otros sistemas operativos o otras versiones, pero solo estamos seguros para esta configuración.

Instalar SimpleTest

Phing necesitará SimpleTest. En el paquete de Chamilo, SimpleTest está disponible como una carpeta con una de las últimas versiones de SimpleTest. Para evitar problemas luego con la versión instalada por el sistema es mejor de instalar la versión que está en Chamilo a nivel del sistema. Hay varias soluciones para hacerlo, de las cuales posiblemente la más limpia es de agregar la carpeta tests/simpletest de Chamilo en el include_path de la config de PHP. Si no quiere tomar el tiempo de hacerlo, en una Ubuntu, puede hacer un sudo apt-get install php-simpletest y después sobreescribir los ficheros en /usr/share/php/simpletest/ con los de Chamilo (es malo, lo sé, pero asumo que la máquina en la cual se hace la instalación es una máquina de desarrollo por ahora).

Instalar Phing

$ sudo pear channel-discover pear.phing.info
$ sudo pear install phing/phing

A este punto, prueba de ejecutar “phing” en la línea de comando. Si el sistema no encuentra el comando, prueba ejecutar el script de configuración de Phing

$ sudo pear run-scripts phing/phing

Esto debería crear un /var/www/phing dentro del cual se puede editar el build.xml para customisarlo. Un ejemplo de build.xml

<?xml version="1.0"?>
<project name="chamilo187" default="clean" basedir=".">
 <target name="empty">
  <echo msg="Cleaning working space..." />
  <delete file="chamilo*.tgz" />
 </target>
 <target name="prepare" depends="empty">
  <echo msg="Preparing build..." />
  <mkdir dir="./chamilo-1.8.7" />
 </target>
 <target name="copy" depends="prepare">
  <echo>Copying...</echo>
  <copy todir="./chamilo-1.8.7/">
   <fileset dir="/var/www/chamilohg">
    <exclude name="**/.svn" />
   </fileset>
  </copy>
  <delete file="**/.svn" />
 </target>
 <target name="syntax-check" depends="copy">
  <phplint>
   <fileset dir="./chamilo-1.8.7">
    <include name="**/*.php"/>
   </fileset>
  </phplint>
  <simpletest printsummary="true">
  <formatter todir="reports" type="plain" />
   <fileset dir="./chamilo-1.8.7/tests">
    <include name="dummy.test.php" />
   </fileset>
  </simpletest>
 </target>
 <target name="documentation" depends="syntax-check">
  <phpdoc title="Chamilo API" destdir="doc" output="HTML:Smarty:PHP">
   <fileset dir="./chamilo-1.8.7">
    <include name="**/*.php" />
   </fileset>
  </phpdoc>
 </target>
 <target name="dist" depends="documentation">
  <echo message="Creating archive..." />
  <tar destfile="chamilo-1.8.7.tgz" compression="gzip">
   <fileset dir="./chamilo-1.8.7">
    <exclude name="**/*.bak" />
   </fileset>
  </tar>
 </target>
 <target name="clean" depends="dist">
  <echo msg="Cleaning up..." />
  <delete dir="./chamilo-1.8.7" includeemptydirs="true" verbose="true" failonerror="true" />
 </target>
</project>

Una vez el proyecto Phing listo (dentro del build.xml), basta lanzar, en línea de comando, un “phing” para iniciar el proceso.

Phing executing in a terminal

Phing executing in a terminal

La documentación (en Inglés) de Phing esta disponible acá: http://phing.info/docs/guide/2.2.0/

Instalar Xinc

Xinc's first screen

Xinc's first screen

$ sudo pear channel-discover pear.xinc.eu
$ sudo pear install xinc/Xinc

El último comando ejecuta montones de cosas.

Según los resultados, es posible que sea necesario ejecutar una serie de comandos adicionales como:

$ sudo pear install channel://pear.xinc.eu/Xinc-2.0.0b196
$ sudo pear install channel://pear.php.net/VersionControl_SVN-0.3.3
$ sudo pear channel-discover components.ez.no
$ sudo pear install channel://components.ez.no/Base
$ sudo pear install channel://components.ez.no/Graph
$ sudo apt-get install php5-xsl

Posiblemente, este paso falla, pero en el mensaje de error aparece el URL que debería cargar en sitio de “xinc/Xinc” en el último comando.

Después de instalar, es necesario ejecutar el comando

$ sudo pear run-scripts xinc/Xinc

Lamentablemente, si ha tenido que usar el URL en lugar de xinc/Xinc, podría ser necesario cambiar este último comando también (algo como pear.xinc.eu/Xinc). Este comando debería retornar algo parecido a esto:

Including external post-installation script "/usr/share/php/Xinc/Postinstall/Nix.php" - any errors are in this script
Inclusion succeeded
running post-install script "Xinc_Postinstall_Nix_postinstall->init()"
init succeeded
 1. Directory to keep the Xinc config files                    : /etc/xinc
 2. Directory to keep the Xinc Projects and Status information : /var/xinc
 3. Directory to keep the Xinc log files                       : /var/log
 4. Directory to install the Xinc start/stop daemon            : /etc/init.d
 5. Directory for xinc`s temporary files                       : /tmp/xinc
 6. Do you want to install the SimpleProject example           : yes
 7. Directory to install the Xinc web-application              : /var/www/xinc
 8. IP of Xinc web-application                                 : 127.0.0.1
 9. Port of Xinc web-application                               : 8080

1-9, 'all', 'abort', or Enter to continue:
Successfully copied /usr/share/php/data/Xinc/xinc.ini.tpl  to: /usr/share/php/data/Xinc/xinc.ini
Successfully copied /usr/share/php/data/Xinc/etc/xinc/*  to: /etc/xinc
Successfully copied /usr/share/php/data/Xinc/examples/SimpleProject  to: /var/xinc/projects
Successfully copied /usr/share/php/data/Xinc/web/.htaccess  to: /var/www/xinc
Successfully copied /usr/share/php/data/Xinc/web/*  to: /var/www/xinc
Successfully copied /usr/share/php/data/Xinc/scripts/xinc-uninstall  to: /usr/bin/xinc-uninstall
Successfully copied /usr/share/php/data/Xinc/scripts/xinc-uninstall.php  to: /usr/bin/xinc-uninstall.php
Xinc installation complete.
- Please include /etc/xinc/www.conf in your apache virtual hosts.
- Please enable mod-rewrite.
- To add projects to Xinc, copy the project xml to /etc/xinc/conf.d
- To start xinc execute: sudo /etc/init.d/xinc start
UNINSTALL instructions:
- pear uninstall xinc/Xinc
- run: /usr/bin/xinc-uninstall to cleanup installed files
[OK] Saved ini settings
Install scripts complete

En este momento, es importante entender que Xinc debe ser el que maneja la actualización desde el repositorio de gestión de versiones. La razón es que xinc se va a encargar de la parte “integración contínua”. Si Xinc no puede manejar el mismo la actualización de mi código, como se va a dar cuenta si hubó un cambio? No puede! Entonces tiene el mismo que poder encontrar los cambios de versiones y darse cuenta si hubó un cambio. Esto implica sacar la parte de actualización automática del Phing, y dejarlo a Xinc.

Al fin de la instalación, es necesario reconfigurar y pasar el virtual host ubicado en /etc/xinc/www.conf dentro de /etc/apache2/sites-available/ y activarlo con

$ sudo cp /etc/xinc/www.conf /etc/apache2/sites-available/xinc.host.ext
$ sudo a2ensite xinc.host.ext
$ sudo /etc/init.d/apache2 reload

Para tener un resultado interesante en Xinc, es necesario tener unos scripts de prueba en SimpleTest o PHPUnit, y Phing instalado (más sobre las pruebas más tarde).

Antes de iniciar Xinc, es necesario configurar un proyecto. En nuestro caso, estaremos montando un proyecto llamado “chamilo” con un repositorio Mercurial en https://sources.beeznest.net/public/chamilo/

$ sudo mkdir -p /var/xinc/projects/chamilo
$ cd /var/xinc/projects/chamilo/
$ sudo hg clone https://sources.beeznest.net/public/chamilo/

Esto descargará la última versión de desarrollo de Chamilo.

Ahora el nuevo problema es que Xinc no soporta Mercurial… Una solución podría ser de ejecutar las cosas relativas a Mercurial en línea de comando desde la tarea Phing, pero lamentablemente Xinc necesita una visibilidad sobre las revisiones de Mercurial para poder devolver resultados interesantes. Por esto hemos desarrollado una versión básica del módulo de Hg para Xinc, que puede pedirnos por correo (no lo ponemos en línea todavía porque no está estable y no queremos que se moleste si le rompe su proyecto).

Configurar el proyecto Xinc

La configuración de Xinc en sí se hace dentro de /etc/xinc/conf.d, donde se encuentra un fichero simpleproject.xml que se puede modificar. Sino quiere tener un proyecto “simpleproject” fantasma, entonces mejor mover este fichero de otro lado y hacer una copia ahí, renombrar el archivo y editar sus detalles *antes* de iniciar Xinc por primera vez (después es bastante complicado de quitar este proyecto fantasma).

Por ejemplo, renombramos el archivo simpleproject.xml en chamilo.xml y le damos el contenido siguiente.

<?xml version="1.0"?>
<xinc engine="Sunrise">
 <project name="chamilo">
 <configuration>
 <setting name="loglevel" value="1"/>
 <setting name="timezone" value="America/Lima"/>
 </configuration>
 <property name="dir" value="${projectdir}/${project.name}"/>
 <schedule interval="3600" />
 <!--cron timer="* */2 * * *"/-->
 <modificationset>
 <hg directory="${dir}/chamilo/" update="true" />
 <!--buildalways/-->
 </modificationset>
 <builders>
 <phingBuilder buildfile="${dir}/build.xml" target="build"/>
 </builders>
 <publishers>
 <simpleTestTestResults file="${dir}/reports/testresults.txt"/>
 <onfailure>
 <email to="ywarnier@beeznest.org"
 subject="${project.name} build ${build.number} failed"
 message="The build failed."/>
 </onfailure>
 <onsuccess>
 </onsuccess>
 <onrecovery>
 <email to="ywarnier@beeznest.org"
 subject="${project.name} build ${build.number} was recovered"
 message="The build passed after having failed before."/>
 </onrecovery>
 </publishers>
 </project>
</xinc>

Analizemos un poco:

<project name="chamilo">

-> el proyecto se llama “chamilo”. Esto también define la variable ${project.name}

<schedule interval="3600" />

-> la actualización corre cada 3600 segundos

<hg directory="${dir}/chamilo/" update="true" />

-> definimos que la fuente del proyecto (hg=mercurial) se encuentra en ${dir} (definido antes), subcarpeta /chamilo/. Desde ahí, y con las tareas Xinc definidas,

<phingBuilder buildfile="${dir}/build.xml" target="build"/>

-> define donde encontrar el archivo de construcción del proyecto (construcción que se hace con Phing)

 <simpleTestTestResults file="${dir}/reports/testresults.txt"/>

-> define donde encontrar el archivo de reporte de las pruebas. Una vez más, faltaba integración para SimpleTest aquí, así que desarrollamos los scripts a partir de los de PHPUnit. Ver http://code.google.com/p/xinc/issues/detail?id=206

Lo demás define como generar reportes en caso de éxito, de falla o de recuperación. En caso de éxito, se podría definir que se ejecuta otro proyecto Phing, que sirve para la construcción del paquete (como por ejemplo hacer un archivo Zip, en la forma de un fichero de configuración Phing package.xml por ejemplo).

Por el hecho de tener el control de versiones hecho a nivel de xinc, podemos tener un build.xml de Phing muy reducido:

<?xml version="1.0"?>
<project name="chamilo" default="build" basedir=".">
 <property name="builddir" value="chamilo/" override="true" />

 <target name="order">
   <echo msg="Copying cli_install..." />
   <copy file="cli_install.php" tofile="./${builddir}main/install/cli_install.php" overwrite="true"/>
   <echo msg="Moving local simpletest copy to avoid using it (use system's library)..." />
   <move file="${builddir}tests/simpletest" todir="${builddir}tests/simpletestbak" includeemptydirs="true" />
 </target>

 <target name="install" depends="order">
   <echo msg="Installing Chamilo..." />
   <exec command="chmod -R 0777 *" dir="${builddir}" />
   <echo msg="Assigned development permissions..." />      
   <exec command="php5 cli_install.php -l admin -p admin -U chamilo -P chamilo -u 'http://phing.chamilo.net' -X 'chamilophing_'" dir="./${builddir}main/install/" />
   <echo msg="Hopefully installed..." />      
 </target>

 <target name="simple-tests" depends="install">
   <echo msg="Starting tests..." />
   <simpletest>
     <formatter todir="reports" type="plain"/>
     <fileset dir="${builddir}tests">
       <include name="all.test3.php" />
     </fileset>
   </simpletest>
 </target>

 <target name="build" depends="simple-tests">
   <echo msg="Cleaning up the database..." />
   <exec command="php5 cleandb.php" dir="." />
   <echo msg="Moving back local simpletest copy..." />
   <move file="${builddir}tests/simpletestbak" todir="${builddir}tests/simpletest" includeemptydirs="true" />
   <echo msg="All clean!" />
 </target>
</project>

Esta combinación de los proyectos Phing y Xinc implica que tenemos que tener una carpeta /var/xinc/projects/chamilo que contenga

  • un repositorio Mercurial de nuestro Chamilo (checkeado con el usuario root para poder hacer la actualización después via Xinc)
  • un script cli_install.php que instale un Chamilo en línea de comando
  • un script cleandb.php que limpie la base de datos después de las pruebas

Si ocurre un error en la construcción, probar de ver los logs de xinc así

$ sudo tail -f /var/log/xinc.log

Si ocurre un error en la construcción del paquete, es posible que tenga más detalles un archivo de log en /var/xinc/projects/chamilo/

Para iniciar Xinc

$ sudo /etc/init.d/xinc start

La documentación (en Inglés) de Xinc esta disponible acá: http://www.xinc.eu/api/documentation/get/file/xinc/latest-successful/Enduser/index.html

Cuando empieza a correr el Xinc, en general (si ha instalado como indicado arriba) en la version 2.0.0 tiene un problema para jalar la buena libreria para generar los graficos. Esto se puede arreglar editando un archivo de Xinc (como indicado en http://code.google.com/p/xinc/issues/detail?id=167):

sudo vim /usr/share/php/Xinc/Plugin/Repos/Gui/Statistics/Graph.php

y ahí, editar la línea 33 (después de un comentario vacío) para agregar

require 'ezc/Base/ezc_bootstrap.php';

y después reiniciar a Xinc con

/etc/init.d/xinc restart

Para parar Xinc

$ sudo /etc/init.d/xinc stop
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: