phpci/PHPCI/Plugin/Codeception.php

<?php
/**
 * PHPCI - Continuous Integration for PHP
 *
 * @copyright    Copyright 2014, Block 8 Limited.
 * @license      https://github.com/Block8/PHPCI/blob/master/LICENSE.md
 * @link         https://www.phptesting.org/
 */

namespace PHPCI\Plugin;

use PHPCI\Builder;
use PHPCI\Helper\Lang;
use PHPCI\Model\Build;
use PHPCI\Plugin\Util\TestResultParsers\Codeception as Parser;
use Psr\Log\LogLevel;

/**
 * Codeception Plugin - Enables full acceptance, unit, and functional testing.
 * @author       Don Gilbert <don@dongilbert.net>
 * @author       Igor Timoshenko <contact@igortimoshenko.com>
 * @author       Adam Cooper <adam@networkpie.co.uk>
 * @package      PHPCI
 * @subpackage   Plugins
 */
class Codeception implements \PHPCI\Plugin, \PHPCI\ZeroConfigPlugin
{
    /** @var string */
    protected $args = '';

    /** @var Builder */
    protected $phpci;

    /** @var Build */
    protected $build;

    /**
     * @var string $ymlConfigFile The path of a yml config for Codeception
     */
    protected $ymlConfigFile;

    /**
     * @var string $path The path to the codeception tests folder.
     */
    protected $path;

    /**
     * @param $stage
     * @param Builder $builder
     * @param Build $build
     * @return bool
     */
    public static function canExecute($stage, Builder $builder, Build $build)
    {
        return $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;
    }

    /**
     * Set up the plugin, configure options, etc.
     * @param Builder $phpci
     * @param Build $build
     * @param array $options
     */
    public function __construct(Builder $phpci, Build $build, array $options = array())
    {
        $this->phpci = $phpci;
        $this->build = $build;
        $this->path = 'tests/';

        if (empty($options['config'])) {
            $this->ymlConfigFile = self::findConfigFile($this->phpci->buildPath);
        } else {
            $this->ymlConfigFile = $options['config'];
        }
        if (isset($options['args'])) {
            $this->args = (string) $options['args'];
        }
        if (isset($options['path'])) {
            $this->path = $options['path'];
        }
    }

    /**
     * Runs Codeception tests, optionally using specified config file(s).
     */
    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)
    {
        $this->phpci->logExecOutput(false);

        $codecept = $this->phpci->findBinary('codecept');

        if (!$codecept) {
            $this->phpci->logFailure(Lang::get('could_not_find', 'codecept'));

            return false;
        }

        $cmd = 'cd "%s" && ' . $codecept . ' run -c "%s" --xml ' . $this->args;
        if (IS_WIN) {
            $cmd = 'cd /d "%s" && ' . $codecept . ' run -c "%s" --xml ' . $this->args;
        }

        $configPath = $this->phpci->buildPath . $configPath;
        $success = $this->phpci->executeCommand($cmd, $this->phpci->buildPath, $configPath);

        $reportPath = $this->phpci->buildPath . $this->path . '_output/report.xml';
        if (!file_exists($reportPath)) {
            throw new \Exception("Cannot find Codeception XML report: $reportPath");
        }
        $xml = file_get_contents($reportPath, false);

        $parser = new Parser($this->phpci, $xml);
        $output = $parser->parse();

        $meta = array(
            '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());

        $this->phpci->logExecOutput(true);

        return $success;
    }
}