* @author Igor Timoshenko * @author Adam Cooper */ class Codeception extends Plugin implements ZeroConfigPluginInterface { /** @var string */ protected $args = ''; /** * @var string $ymlConfigFile The path of a yml config for Codeception */ protected $ymlConfigFile; /** * @var array $path The path to the codeception tests folder. */ protected $path = [ 'tests/_output', 'tests/_log', ]; /** * @return string */ public static function pluginName() { return 'codeception'; } /** * {@inheritdoc} */ public function __construct(Builder $builder, Build $build, array $options = []) { parent::__construct($builder, $build, $options); if (empty($options['config'])) { $this->ymlConfigFile = self::findConfigFile($this->builder->buildPath); } else { $this->ymlConfigFile = $options['config']; } if (isset($options['args'])) { $this->args = (string) $options['args']; } if (isset($options['path'])) { array_unshift($this->path, $options['path']); } } /** * @param $stage * @param Builder $builder * @param Build $build * @return bool */ public static function canExecute($stage, Builder $builder, Build $build) { return $stage == Build::STAGE_TEST && !is_null(self::findConfigFile($builder->buildPath)); } /** * Try and find the codeception YML config file. * @param $buildPath * @return null|string */ public static function findConfigFile($buildPath) { if (file_exists($buildPath . 'codeception.yml')) { return 'codeception.yml'; } if (file_exists($buildPath . 'codeception.dist.yml')) { return 'codeception.dist.yml'; } return null; } /** * Runs Codeception tests */ public function execute() { if (empty($this->ymlConfigFile)) { throw new \Exception("No configuration file found"); } // Run any config files first. This can be either a single value or an array. return $this->runConfigFile($this->ymlConfigFile); } /** * Run tests from a Codeception config file. * @param $configPath * @return bool|mixed * @throws \Exception */ protected function runConfigFile($configPath) { $codeception = $this->findBinary('codecept'); if (!$codeception) { $this->builder->logFailure(sprintf('Could not find %s', 'codecept')); return false; } $cmd = 'cd "%s" && ' . $codeception . ' run -c "%s" --xml ' . $this->args; $configPath = $this->builder->buildPath . $configPath; $success = $this->builder->executeCommand($cmd, $this->builder->buildPath, $configPath); $parser = new YamlParser(); $yaml = file_get_contents($configPath); $config = (array)$parser->parse($yaml); $outputPath = null; if ($config && isset($config['paths']['log'])) { $outputPath = $this->builder->buildPath . $config['paths']['log'] . '/'; } if (!file_exists($outputPath . 'report.xml')) { foreach ($this->path as $path) { $outputPath = $this->builder->buildPath . rtrim($path, '/\\') . '/'; if (file_exists($outputPath . 'report.xml')) { break; } } } $parser = new Parser($this->builder, ($outputPath . 'report.xml')); $output = $parser->parse(); $meta = [ 'tests' => $parser->getTotalTests(), 'timetaken' => $parser->getTotalTimeTaken(), 'failures' => $parser->getTotalFailures() ]; $this->build->storeMeta('codeception-meta', $meta); $this->build->storeMeta('codeception-data', $output); $this->build->storeMeta('codeception-errors', $parser->getTotalFailures()); return $success; } }