icingaweb2-module-director/application/clicommands/TestCommand.php

<?php

namespace Icinga\Module\Director\Clicommands;

use Icinga\Application\Logger;
use Icinga\Cli\Command;
use Icinga\Module\Director\Test\TestSuiteLint;
use Icinga\Module\Director\Test\TestSuiteStyle;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;

class TestCommand extends Command
{
    /**
     * Default arguments and options for PHP_CodeSniffer
     *
     * @var array
     */
    protected $phpcsDefaultParams = array(
        '-p',
        '--standard=PSR2',
        '--extensions=php',
        '--encoding=utf-8'
    );

    public function lintAction()
    {
        $test = new TestSuiteLint();
        $test->run();
        if ($test->hasFailures()) {
            Logger::error('Lint check failed');
            exit(1);
        } else {
            Logger::info('Lint check succeeded');
            exit(0);
        }
    }

    /**
     * Run all unit-test suites
     *
     * This command runs the unit- and regression-tests of icingaweb and installed modules.
     *
     * USAGE
     *
     * icingacli test php unit [options]
     *
     * OPTIONS
     *
     *   --verbose  Be more verbose.
     *   --build    Enable reporting.
     *   --include  Pattern to use for including files/test cases.
     *
     * EXAMPLES
     *
     *   icingacli test php unit --verbose
     *   icingacli test php unit --build
     *   icingacli test php unit --include=*SpecialTest
     */
    public function phpAction()
    {
        $basedir = $this->getBaseDir();
        $build = $this->params->shift('build');
        $include = $this->params->shift('include');

        $phpUnit = exec('which phpunit');
        if (!file_exists($phpUnit)) {
            $this->fail('PHPUnit not found. Please install PHPUnit to be able to run the unit-test suites.');
        }

        $options = array(
            '--bootstrap' => $basedir . '/test/bootstrap.php'
        );
        if ($this->isVerbose) {
            $options[] = '--verbose --testdox';
        }
        if ($build) {
            $reportPath = $this->setupAndReturnReportDirectory();
            $options[] = '--verbose';
            $options[] = '--log-junit';
            $options[] = $reportPath . '/phpunit_results.xml';
            $options[] = '--coverage-html';
            $options[] = $reportPath . '/php_html_coverage';
        }
        if ($include !== null) {
            $options[] = '--filter';
            $options[] = $include;
        }

        chdir(realpath(__DIR__ . '/../..'));
        $command = $phpUnit . ' ' . join(' ', array_merge($options, $this->params->getAllStandalone()));
        if ($this->isVerbose) {
            $res = `$command`;
            foreach (preg_split('/\n/', $res) as $line) {
                if (preg_match('~\s+\[([x\s])\]\s~', $line, $m)) {
                    if ($m[1] === 'x') {
                        echo $this->screen->colorize($line, 'green') . "\n";
                    } else {
                        echo $this->screen->colorize($line, 'red') . "\n";
                    }
                } else {
                    echo $line . "\n";
                }
            }
        } else {
            passthru($command);
        }
    }

    /**
     * Run code-style checks
     *
     * This command checks whether icingaweb and installed modules match the PSR-2 coding standard.
     *
     * USAGE
     *
     * icingacli test php style [options]
     *
     * OPTIONS
     *
     *   --verbose  Be more verbose.
     *   --build    Enable reporting.
     *   --include  Include only specific files. (Can be supplied multiple times.)
     *   --exclude  Pattern to use for excluding files. (Can be supplied multiple times.)
     *
     * EXAMPLES
     *
     *   icingacli test php style --verbose
     *   icingacli test php style --build
     *   icingacli test php style --include=path/to/your/file
     *   icingacli test php style --exclude=*someFile* --exclude=someOtherFile*
     */
    public function styleAction()
    {
        // passthru(
        // 'phpcs -p --standard=PSR2 --extensions=php --encoding=utf-8 -w -s
        // --report-checkstyle=/tmp/style/bla library/Director/ application/
        //  run.php configuration.php'
        // );


        $test = new TestSuiteStyle();
        $test->run();

        return;
        // TODO: obsolete:

        if ($test->hasFailures()) {
            $this->fail('Lint check failed');
        } else {
            Logger::info('Lint check succeeded');
        }

        $out = TestRunner::newTempFile();
        $check = array(
            'library/Director/',
            'application/',
            'configuration.php',
            'run.php',
        );

        $cmd = sprintf(
            "phpcs -p --standard=PSR2 --extensions=php --encoding=utf-8 -w -s --report-checkstyle=%s '%s'",
            $out,
            implode("' '", $check)
        );

        // TODO: Debug only:
        `$cmd`;
        echo $cmd . "\n";
        echo $out ."\n";
        echo file_get_contents($out);
        unlink($out);
        exit;

        $build = $this->params->shift('build');
        $include = (array) $this->params->shift('include', array());
        $exclude = (array) $this->params->shift('exclude', array());

        $phpcs = exec('which phpcs');
        if (!file_exists($phpcs)) {
            $this->fail(
                'PHP_CodeSniffer not found. Please install PHP_CodeSniffer to be able to run code style tests.'
            );
        }

        $options = array();
        if ($this->isVerbose) {
            $options[] = '-v';
        }
        if ($build) {
            $options[] = '--report-checkstyle=' . $this->setupAndReturnReportDirectory();
        }
        if (!empty($exclude)) {
            $options[] = '--ignore=' . join(',', $exclude);
        }
        $arguments = array_filter(
            array_map(
                function ($p) {
                    return realpath($p);
                },
                $include
            )
        );
        if (empty($arguments)) {
            $arguments = array(
                realpath(__DIR__ . '/../../../../application'),
                realpath(__DIR__ . '/../../../../library/Icinga')
            );
        }

        chdir(realpath(__DIR__ . '/../..'));
        passthru(
            $phpcs . ' ' . join(
                ' ',
                array_merge(
                    $options,
                    $this->phpcsDefaultParams,
                    $arguments,
                    $this->params->getAllStandalone()
                )
            )
        );
    }

    protected function getBaseDir()
    {
        return dirname(dirname(__DIR__));
    }

    /**
     * Setup the directory where to put report files and return its path
     *
     * @return  string
     */
    protected function setupAndReturnReportDirectory()
    {
        $path = '/tmp/test-devel';

        if (!is_dir($path) && !@mkdir($path, 0755, true)) {
            $this->fail("Could not create directory: $path");
        }

        return $path;
    }
}