#yahoor3

So after far too much research, we came up with Yahoo r3, but we still had an itch to scratch: how can we integrate this into our continuous integration workflow? We are using Phing (and Java Ant) for building our sites, so it was nice to have some Phing tasks to work with r3. So I wrote these two tasks:

r3GenerateTask.php

require_once 'phing/Task.php'; /**  * r3 Generate Task  *  * PHP version 5  *  * @category  Phing Task  * @package   phing  * @author    Alfonso Jimenez  * license   http://www.gnu.org/licenses/gpl.html GPL  *  */ class r3GenerateTask extends Task {     /**      * path to r3 workspace      *      * var  string      */     protected $r3Workspace;     /**      * init method      *      * @return boolean      */     public function init()     {         return true;     }     /**      * main method      *      * @return void      */     public function main()     {         $command = 'r3 -c '. $this->Workspace .' generate -av';         $output  = array();         $return  = null;         try {             exec($command, $output, $return);             foreach ($output as $line) {                 $this->log($line, Project::MSG_VERBOSE);             }             if ($return !== 0) {                 throw new BuildException('Task exited with code'. $return);             }         } catch (BuildException $e) {             $op = Project::MSG_WARN;             if ($this->quiet === true) {                 $op = Project::MSG_VERBOSE;             }             $this->log($e->getMessage(), $op);         }     } }

r3SetVarTask.php

require_once 'phing/Task.php'; /**  * r3 setVar Task  *  * PHP version 5  *  * category Phing Task  * package phing  * author Alfonso Jimenez <[email protected]>  * license http://www.gnu.org/licenses/gpl.html GPL  *  */ class r3SetVarTask extends Task {     /**      * path to r3 workspace      *      * var string      */     protected $r3Workspace;     /**                                                   * dimension                                           *                                                    * @var string                                         */                                                  protected $dimension;                                /**                                                   * variable key                                       *                                                     * @var string                                         */                                                  protected $key;                                      /**                                                   * variable value                                     *                                                     * @var string                                         */                                                  protected $value;                                    /**                                                   * sets the r3 workspace path                         *                                                     * param string $r3Workspace                         *                                                     * return void                                       */                                                  public function setr3Workspace($r3Workspace)          {                                                        $this->r3Workspace = $r3Workspace;                }                                                    /**                                                   * sets dimension                                     *                                                     * param string $dimension                           *                                                     * return void                                       */                                                  public function setDimension($dimension)              {                                                        $this->dimension = $dimension;                    }                                                    /**                                                   * sets the variable key                               *                                                     * param string $key                                 *                                                     * return void                                       */                                                  public function setKey($key)                          {                                                        $this->key = $key;                                }                                                    /**                                                   * sets the variable value                             *                                                     * param string $value                               *                                                     * return void                                       */                                                  public function setValue($value)                      {                                                        $this->value = $value;                            }                                                    /**      * init method      *                 * @return boolean      */                  public function init()     {                            return true;          }                        /**                       * main method             *                         * @return void           */                      public function main()     {                            $command = ‘r3 -c ‘. $this‐>r3Workspace .’ var set ‘. $this‐>dimension                    .’ ‘. $this‐>key .’ ‘. $this‐>value;                              $output  = array();                                                          $return  = null;                                                              try {                                                                            exec($command, $output, $return);                                            foreach ($output as $line) {                                                      $this->log($line, Project::MSG_VERBOSE);             }             if ($return !== 0) {                 throw new BuildException(‘Task exited with code’. $return);             }         } catch (BuildException $e) {             $op = Project::MSG_WARN;             if ($this->quiet === true) {                 $op = Project::MSG_VERBOSE;             }             $this->log($e->getMessage(), $op);         }     } }

If you want to use these tasks in your Phing file, you have to place them in /usr/share/php/phing/extended/tasks/ first. Then you can call them by writing the following tag-commands:

<taskdef name=”r3-generate” classname=”extended.tasks.r3GenerateTask” /> <taskdef name=”r3-setVar” classname=”extended.tasks.r3SetVarTask” />

<r3-generate r3Workspace=”${workspace.dir}”></r3> <r3-setVar r3Workspace=”${workspace.dir}” dimension=”${dimension}” key=”var_key” value=”${var_value}”></r3>

Let’s see an example of a real Phing file. Imagine that we have to write a task which needs to do the following steps:

Get a Yahoo r3 workspace from a SVN repository (http://svn.test.com/trunk/r3)

Build the Yahoo r3 workspace

Move the generated templates into a certain directory

Clean up the temporary files

So we can straightforward write a Phing task in order to follow this sequence of steps: