Pruebas unitarias en Joomla con PHPUnit y soporte para debugging

Es necesario un dominio básico de pruebas unitarias, si las has realizado utilizando otro framework como JUnit esto servirá.
Bueno, mi primera impresión con PHPUnit ha sido positiva, sin haber profundizado aún he podido observar características que no había visto en Junit aunque derepente existan, como dependencia entre métodos de pruebas unitarias para evitar repetir el código que normalmente escribimos para establecer el entorno en el que se realizará una prueba (mock objects por ejemplo) y los proveedores de datos (data providers).

Recomiendo la siguiente guía bastante completa y didáctica. Aunque para el fin de seguirme en el presente tutorial no será necesario, ya lo podrán hacer después para profundizar si desean.

http://www.phpunit.de/manual/current/en/automating-tests.html

Comenzaremos por la instalación de PHPUnit usando los repositorios PEAR.

Ejecutaremos los siguientes comandos si tenemos a pear dentro de la variable de entorno PATH.

pear channel-discover pear.phpunit.de
pear channel-discover pear.symfony-project.com
pear install phpunit/PHPUnit

Es necesario mencionar que se requiere cierta versión de PEAR y algunas dependencias por lo cual podría ser necesario realizar la instalación de la siguiente manera:

pear upgrade-all
pear channel-discover pear.phpunit.de
pear channel-discover pear.symfony-project.com
pear install --alldeps phpunit/PHPUnit

Si se encuentran detrás de un proxy:

pear config-set http_proxy http://ip:puerto

Ahora necesitamos agregar el repositorio local de librerías PEAR al include_path si no lo habíamos hecho antes. Aquí pueden ver las instrucciones:

http://support.modwest.com/content/5/98/en/how-do-i-set-php-include_path.html

Ahora podemos pasar a la configuración del IDE y joomla.
Utilizaremos el eclipse PDT que es el que he encontrado con mejor soporte para funcionalidades avanzadas como debugging (También pueden usar aptana con el PHp debugger como extensión).

Después de instalarlo en alguna ubicación y abrirlo en un workspace nos dirigiremos a window > preferences > PHP > PHP Libraries y creamos una librería a la que llamaremos PEAR y luego haciendo clic en Add External folder agregaremos la carpeta raíz del repositorio PEAR, esto nos otorgará la capacidad de autocompletado de las referencias hacia la librería pear y además el debugging de pruebas unitarias.

Bueno, con el IDE y PEAR correctamente configurado podemos comenzar a hacer pruebas unitarias en joomla. Para el soporte de debugging de pruebas unitarias asumiré que tienen soporte para usar Zend Debugger aunque supongo que también debería funcionar con XDebug.  (digo: supongo) Un servidor web con php con soporte para Zend Debugger por defecto es el http://www.zend.com/en/products/server-ce/

Pasos a seguir:

1. Crear instalación de joomla 1.5.x nueva.

Esta importante que joomla sea de la serie 1.5.x porque no he probado con ninguna otra, aunque seguramente no requeriría mucha esfuerzo modificar los scripts para que funcione en las versiones 1.x por citar un ejemplo.

2. Importar esta nueva instalación al PDT como un nuevo proyecto, en mi caso joomla ha sido instalado en la carpeta newsite.

New PHP Project > Create project from existing source

3. Creamos un nuevo proyecto para las pruebas unitarias correspondientes a la instalación de joomla mencionada arriba, lo llamaré newsitetests, recomiendo ubicarlo en la misma carpeta en la que se encuentra newsite (nótese que cree una carpeta vacía con el nombre newsitetests para poder crear el proyecto a partir de fuentes existentes).

4. Ahora dentro del proyecto de las pruebas unitarias crearemos una estructura como la siguiente, nótese lo que he hecho:

– Agregué la instalación de joomla (newsite) y la librería PEAR al PHP Include Path.

Ahora, una pequeña explicación del significado de cada uno de los archivos:

JRequest-0000-getmethod-Test.php Nuestra prueba unitaria de ejemplo.
JoomlaTestCase.php Este archivo contiene una clase que extiende a PHPUnit_Framework_TestCase para agregar soporte para joomla, Joomla_PHPUnit_Framework_TestCase
JoomlaTestCase.xml xml de configuración que Joomla_PHPUnit_Framework_TestCase espera a través de su constructor
NewsiteBaseTestContext.php Contiene una clase que extiende a Joomla_PHPUnit_Framework_TestCase con la configuración específica para nuestro proyecto de pruebas.
xml2array.php Librería externa que se puede encontrar en http://blog.unijimpe.net/xml2array-php-xml-parser/
phpunit.php script de lanzamiento de phpunit que se obtiene con la instalación PEAR que se realizó al comienzo.

Pueden bajarse el proyecto de pruebas newsitetests desde aquí:

http://www.megaupload.com/?d=3LDIQUSN

Aquí solo publicaré el código fuente de JoomlaTestCase.php, el cual contiene la clase que deben extender las clases de pruebas unitarias para obtener el soporte especial para joomla.

<?php

require_once 'PHPUnit/Framework.php';
require_once 'xml2array.php';

/**
 * It extends PHPUnit_Framework_TestCase to preload all required
 * joomla stuff
 *
 * @author JHABLUTZEL
 *
 */
class Joomla_PHPUnit_Framework_TestCase extends PHPUnit_Framework_TestCase
{

 // properties, need to set in constructor
 protected $configurationPath = null;

 // properties cominf from $configurationPath
 protected $joomlaDir = null;
 protected $joomlaSite = null;
 protected $joomlaAdminUser = null;
 protected $joomlaAdminPassword = null;

 /**
 * Path to configuration xml
 */
 public function setConfigurationXML($configurationXML){
 $this->configurationPath = $configurationXML;
 }

 private function loadConfiguration() {
 $contents = file_get_contents($this->configurationPath);
 $result = xml2array($contents);
 $this->joomlaDir =         $result['configuration']['joomlaDir']['value'];

 }

 public function __construct($name = NULL, array $data = array(), $dataName = '', $configurationXML)
 {

 parent::__construct($name, $data, $dataName);
 $this->configurationPath = $configurationXML;

 if (!isset($configurationXML) || $configurationXML == null) {
 throw new Exception("JoomlaTestCase needs a configurationXML");
 }

 $this->loadConfiguration();

 ini_set('include_path',ini_get('include_path').';' . $this->joomlaDir ); // only works in windows, change to : as include_pat separator for unix

 define( '_JEXEC', 1 );
 define('JPATH_BASE', $this->joomlaDir );
 define( 'DS', DIRECTORY_SEPARATOR );
 require_once ( JPATH_BASE .DS.'includes'.DS.'defines.php' );
 require_once ( JPATH_BASE .DS.'includes'.DS.'framework.php' );
 }

}

Creé esta clase basandome en la manera en la que AbstractJUnit4SpringContextTests de Spring, lo hace en el mundo Java, esta clase debe ser extendida por una clase propia del proyecto, en nuestro caso, la clase que se encuentra en NewsiteBaseTestContext.php.

5. Ahora debemos agregar soporte para correr las pruebas unitarias desde el eclipse PDT. Precisamente para esto copie phpunit.php, el cual no es nada más que el script de inicio agregado por PEAR cuando se instaló PHPUnit, éste método podría ser cuestionado, la otra manera de hacerlo es usando External Tools de PDT, pero de ésta manera no he conseguido soporte para debugging. Ese método lo podrían encontrar aquí:

http://www.phpunit.de/wiki/Eclipse

Usando mi método creamos una configuración de debugging del tipo PHP Script.

Y creo que ésto es todo ya pueden seleccionar una prueba unitaria como la que se subió con el ejemplo JRequest-0000-getmethod-Test.php e iniciar el debugging.

Y al final, el resultado:

Ésta última sección podría resultar algo confusa para alguien que no sea familiar con Eclipse PDT, pero les recomiendo enérgicamente familiarizarse con esta herramienta, que es muy buena.

Vínculos de referencia:

http://docs.joomla.org/Unit_Testing

Nota:

He subido el archivo de ejemplo en un repositorio libre como es megaupload, sin embargo podría suceder que ellos lo borren por estar utilizando el servicio gratuito, si alguno de ustedes conoce un mejor servicio de repositorio de archivos le agradeceré que me lo diga 😉

5 thoughts on “Pruebas unitarias en Joomla con PHPUnit y soporte para debugging”

  1. Hola Juan, acabo de actualizar el vínculo de descarga, sin embargo, no es el proyecto exactamente como estaba en el momento en el que escribí el post, si ves algunos archivos nuevos o algunos modificados no te sorprendas.

Leave a Reply

Your email address will not be published. Required fields are marked *