script/extras/ci_tests.php

   1 <?php
   2 defined('DS')          ? null : define('DS',DIRECTORY_SEPARATOR);
   3 defined('AK_BASE_DIR') ? null : define('AK_BASE_DIR',preg_replace('@\\'.DS.'(test|script)($|\\'.DS.'.*)@','',getcwd()));
   4 define('AK_CI_CONFIG_FILE',AK_BASE_DIR.DS.'config'.DS.'ci-config.yaml');
   5
   6 class CI_Tests
   7 {
   8     var $options = array(
   9         'break_on_errors'=>false,
  10         'test_mode'      =>false
  11     );
  12
  13     var $settings;
  14
  15     var $target_files;
  16     var $target_executables;
  17     var $target_environments;
  18
  19     static function main($args=array())
  20     {
  21         if (empty($args)){
  22             global $argv;
  23             $args = $argv;
  24         }
  25
  26         $self = new CI_Tests($args);
  27         $self->run();
  28         $self->hadError() ? exit(1) : exit(0);
  29     }
  30
  31     function __construct($args)
  32     {
  33         if (!is_file($this->config_file())) die('Not sure where I am and where config/config.php is. Run from inside the test/* folders.');
  34
  35         $this->loadSettings();
  36         $this->parseArgs($args);
  37     }
  38
  39     function loadSettings($filename=AK_CI_CONFIG_FILE)
  40     {
  41         require AK_BASE_DIR.DS.'vendor'.DS.'TextParsers'.DS.'spyc.php';
  42
  43         if (!is_file($filename)){
  44             die ('Could not find ci configuration file in '.AK_CI_CONFIG_FILE.'.');
  45         }
  46         $yaml = file_get_contents($filename);
  47         $this->settings = Spyc::YAMLLoad($yaml);
  48     }
  49
  50     function parseArgs($args)
  51     {
  52         array_shift($args);
  53         while (count($args) > 0){
  54             $arg = array_shift($args);
  55             if (array_key_exists(strtolower($arg),$this->settings['executables'])){
  56                 $this->target_executables[] = $arg;
  57             }elseif (array_key_exists(strtolower($arg),$this->settings['environments'])){
  58                 $this->target_environments[] = $arg;
  59             }elseif ($filename = $this->constructTestFilename($arg)){
  60                 $this->target_files[] = $filename;
  61             }else{
  62                 switch ($arg){
  63                     case '-b':
  64                         $this->options['break_on_errors'] = true;
  65                         break;
  66                     case '-t':
  67                         $this->options['test_mode'] = true;
  68                         break;
  69                     case '-?':
  70                     case '?':
  71                         $this->drawHelp();
  72                         break;
  73                 }
  74             }
  75         }
  76
  77         $this->setDefaults();
  78     }
  79
  80     function setDefaults()
  81     {
  82         if (!$this->target_executables)  $this->target_executables  = $this->settings['default_executables'];
  83         if (!$this->target_files)        $this->target_files[]      = AK_BASE_DIR.DS.'test'.DS.'unit.php';
  84         if (!$this->target_environments) $this->target_environments = array_keys($this->settings['environments']);
  85     }
  86
  87     function constructTestFilename($filename)
  88     {
  89         if (is_file($filename)) return $filename;
  90
  91         $target_file = getcwd().DIRECTORY_SEPARATOR.$filename;
  92         if (is_file($target_file)) return $target_file;
  93
  94         return false;
  95     }
  96
  97
  98     function config_file()
  99     {
 100         return AK_BASE_DIR.DS.'config'.DS.'config.php';
 101     }
 102
 103     function config_backup_file()
 104     {
 105         return AK_BASE_DIR.DS.'config'.DS.'config-backup.php';
 106     }
 107
 108     function config_file_for($environment)
 109     {
 110         return AK_BASE_DIR.DS.config.DS.$this->settings['environments'][$environment].'.php';
 111     }
 112
 113     function run()
 114     {
 115         $this->drawHeader();
 116
 117         $this->beforeRun();
 118         foreach ($this->filesToRun() as $file){
 119             foreach ($this->executablesToRun() as $php_version){
 120                 foreach ($this->environmentsToRun() as $environment){
 121                     if ($this->isValidCombination($environment,$php_version)){
 122                         $return_value = $this->runCommand($php_version,$file,$environment);
 123                         if ($return_value !== 0) {
 124                             $this->markError();
 125                             if ($this->options['break_on_errors']) break 3;
 126                         }
 127                     }
 128                 }
 129             }
 130         }
 131         $this->afterRun();
 132
 133         $this->drawFooter();
 134     }
 135
 136     function markError()
 137     {
 138         $this->errors = true;
 139     }
 140
 141     function hadError()
 142     {
 143         return isset($this->errors);
 144     }
 145
 146     function filesToRun()
 147     {
 148         return $this->target_files;
 149     }
 150
 151     function executablesToRun()
 152     {
 153         return $this->target_executables;
 154     }
 155
 156     function environmentsToRun()
 157     {
 158         return $this->target_environments;
 159     }
 160
 161     function isValidCombination($environment,$php_version)
 162     {
 163         return in_array($environment,$this->settings['valid_combinations'][$php_version]);
 164     }
 165
 166     function beforeRun()
 167     {
 168         return copy($this->config_file(),$this->config_backup_file());
 169     }
 170
 171     function afterRun()
 172     {
 173         if (copy($this->config_backup_file(),$this->config_file())){
 174             return unlink($this->config_backup_file());
 175         }
 176         return false;
 177     }
 178
 179     function prepareEnvironment($environment)
 180     {
 181         if (!is_file($this->config_file_for($environment))){
 182             echo "Can't find environment settings for $environment. Skipping...\n\r";
 183             return false;
 184         }
 185         return copy($this->config_file_for($environment),$this->config_file());
 186     }
 187
 188     function runCommand($php,$filename,$environment)
 189     {
 190         $this->drawBox(array($filename,strtoupper($environment),$php));
 191
 192         if ($this->prepareEnvironment($environment)){
 193             $command = $this->settings['executables'][$php].' '.$filename;
 194             if ($this->options['test_mode']){
 195                 echo "Executing: ".$command."\n\r";
 196                 $return_value = 0;
 197             }else{
 198                 passthru($command,$return_value);
 199             }
 200             return $return_value;
 201         }
 202     }
 203
 204     function drawBox($message)
 205     {
 206         $this->drawNewline();
 207         $this->drawLine();
 208         echo " TARGET: ".join(', ',$message)."\n\r";
 209         $this->drawLine();
 210         $this->drawNewline();
 211     }
 212
 213     function drawHeader()
 214     {
 215         #$this->drawLine('+');
 216     }
 217
 218     function drawFooter()
 219     {
 220         $this->drawNewline();
 221         $this->drawLine('+');
 222         echo "FINISHED. ";
 223         if (!$this->hadError()) echo " All fine.";
 224     }
 225
 226     function drawLine($char='-',$num=80)
 227     {
 228         echo str_pad('',$num,$char);
 229     }
 230
 231     function drawNewline()
 232     {
 233         echo "\n\r";
 234     }
 235
 236     function drawHelp()
 237     {
 238         echo <<<BANNER
 239 Usage:
 240
 241 ci_tests [php4|php5] [mysql|postgres|sqlite] [-b] [test-files]
 242    -b   break on first error
 243    -t   test-mode, don't run the commands actually
 244    -?   this help
 245
 246 Examples:
 247 > ci_tests
 248 run all unit tests in any combination.
 249
 250 > ci_tests php5 postgres mysql AkHasMany AkBelongsTo
 251 run AkHasMany and AkBelongsTo on PHP5 using the postgres and mysql-db.
 252
 253 Setup:
 254 1.  Copy DEFAULT-ci-config.yaml to config/ci-config.yaml and set it up
 255
 256 2.  Copy config/config.php to config/mysql-testing.php, config/postgres-testing.php [...] and modify the database settings at least for the testing environment. You can configure the filename for these config-files in the script directly if you must.
 257
 258 3.  Expects to be run from inside the test folder structure. So to speak your current directory must be */test or a subdir. The script itself can be placed whereever you want. You can define a (shell-)macro and quickly swap between different installations and test again. ;-)
 259
 260 This script backups config/config.php to config-backup.php (and restores it after run).
 261
 262 BANNER;
 263         exit;
 264     }
 265 }
 266 $test_args = array(
 267     'Myself_will_be_thrown_away',
 268     "all",
 269     #"-b",
 270     #"-?",
 271     "-t",
 272     #'AkHasMany.php',
 273     #'postgres'
 274 );
 275 #CI_Tests::main($test_args);
 276 CI_Tests::main();
 277
 278 ?>