1. sfTestCoverageTask.class.php
  2. /**
 * Outputs test code coverage.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfTestCoverageTask.class.php 25036 2009-12-07 19:41:58Z Kris.Wallsmith $
 */
  3. class sfTestCoverageTask extends sfBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('test_name', sfCommandArgument::REQUIRED, 'A test file name or a test directory'),
  12.       new sfCommandArgument('lib_name', sfCommandArgument::REQUIRED, 'A lib file name or a lib directory for wich you want to know the coverage'),
  13.     ));
  15.     $this->addOptions(array(
  16.       new sfCommandOption('detailed', null, sfCommandOption::PARAMETER_NONE, 'Output detailed information'),
  17.     ));
  19.     $this->namespace = 'test';
  20.     $this->name = 'coverage';
  21.     $this->briefDescription = 'Outputs test code coverage';
  23.     $this->detailedDescription = <<<EOF
  24. The [test:coverage|INFO] task outputs the code coverage
  25. given a test file or test directory
  26. and a lib file or lib directory for which you want code
  27. coverage:
  29.   [./symfony test:coverage test/unit/model lib/model|INFO]
  31. To output the lines not covered, pass the [--detailed|INFO] option:
  33.   [./symfony test:coverage --detailed test/unit/model lib/model|INFO]
  34. EOF;
  35.   }
  37.   /**
  38.    * @see sfTask
  39.    */
  40.   protected function execute($arguments = array(), $options = array())
  41.   {
  42.     require_once sfConfig::get('sf_symfony_lib_dir').'/vendor/lime/lime.php';
  44.     $coverage = $this->getCoverage($this->getTestHarness(array('force_colors' => isset($options['color']) && $options['color'])), $options['detailed']);
  46.     $testFiles = $this->getFiles(sfConfig::get('sf_root_dir').'/'.$arguments['test_name']);
  47.     $max = count($testFiles);
  48.     foreach ($testFiles as $i => $file)
  49.     {
  50.       $this->logSection('coverage', sprintf('running %s (%d/%d)', $file, $i + 1, $max));
  51.       $coverage->process($file);
  52.     }
  54.     $coveredFiles = $this->getFiles(sfConfig::get('sf_root_dir').'/'.$arguments['lib_name']);
  55.     $coverage->output($coveredFiles);
  56.   }
  58.   protected function getTestHarness($harnessOptions = array())
  59.   {
  60.     require_once dirname(__FILE__).'/sfLimeHarness.class.php';
  62.     $harness = new sfLimeHarness($harnessOptions);
  63.     $harness->addPlugins(array_map(array($this->configuration, 'getPluginConfiguration'), $this->configuration->getPlugins()));
  64.     $harness->base_dir = sfConfig::get('sf_root_dir');
  66.     return $harness;
  67.   }
  69.   protected function getCoverage(lime_harness $harness, $detailed = false)
  70.   {
  71.     $coverage = new lime_coverage($harness);
  72.     $coverage->verbose = $detailed;
  73.     $coverage->base_dir = sfConfig::get('sf_root_dir');
  75.     return $coverage;
  76.   }
  78.   protected function getFiles($directory)
  79.   {
  80.     if (is_dir($directory))
  81.     {
  82.       return sfFinder::type('file')->name('*.php')->in($directory);
  83.     }
  84.     else if (file_exists($directory))
  85.     {
  86.       return array($directory);
  87.     }
  88.     else
  89.     {
  90.       throw new sfCommandException(sprintf('File or directory "%s" does not exist.', $directory));
  91.     }
  92.   }
  93. }
Debug toolbar