NativePhpunitTask.php 7.04 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
<?php
/**
 * Native PHPUnit Task
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to kontakt@beberlei.de so I can send you a copy immediately.
 */

require_once 'PHPUnit/Framework.php';

/**
 * A more flexible and powerful PHPUnit Task than the native Phing one.
 *
 * Plus forward compability for PHPUnit 3.5 and later is ensured by using the PHPUnit Test Runner instead of implementing one.
 *
 * @author Benjamin Eberlei <kontakt@beberlei.de>
 */
class NativePhpunitTask extends Task
{
    private $test;
    private $testfile;
    private $testdirectory;
    private $configuration = null;
    private $coverageClover = null;
    private $junitlogfile = null;
    private $haltonfailure = true;
    private $haltonerror = true;

    public function setTestdirectory($directory) {
        $this->testdirectory = $directory;
    }

    public function setTest($test) {
        $this->test = $test;
    }

    public function setTestfile($testfile) {
        $this->testfile = $testfile;
    }

    public function setJunitlogfile($junitlogfile) {
47 48 49 50
        if (strlen($junitlogfile) == 0) {
            $junitlogfile = NULL;
        }

51 52 53 54
        $this->junitlogfile = $junitlogfile;
    }

    public function setConfiguration($configuration) {
55 56 57 58
        if (strlen($configuration) == 0) {
            $configuration = NULL;
        }

59 60 61 62
        $this->configuration = $configuration;
    }

    public function setCoverageClover($coverageClover) {
63 64 65 66
        if (strlen($coverageClover) == 0) {
            $coverageClover = NULL;
        }

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
        $this->coverageClover = $coverageClover;
    }

    public function setHaltonfailure($haltonfailures) {
        $this->haltonfailure = $haltonfailures;
    }

    public function setHaltonerror($haltonerrors) {
        $this->haltonerror = $haltonerrors;
    }

    public function init()
    {
        require_once "PHPUnit/Runner/Version.php";
        $version = PHPUnit_Runner_Version::id();

        if (version_compare($version, '3.4.0') < 0)
        {
            throw new BuildException("NativePHPUnitTask requires PHPUnit version >= 3.2.0", $this->getLocation());
        }

        require_once 'PHPUnit/Util/Filter.php';

        // point PHPUnit_MAIN_METHOD define to non-existing method
        if (!defined('PHPUnit_MAIN_METHOD'))
        {
            define('PHPUnit_MAIN_METHOD', 'PHPUnitTask::undefined');
        }
    }

    public function main()
    {
        if (!is_dir(realpath($this->testdirectory))) {
            throw new BuildException("NativePHPUnitTask requires a Test Directory path given, '".$this->testdirectory."' given.");
        }
        set_include_path(realpath($this->testdirectory) . PATH_SEPARATOR . get_include_path());

        $printer = new NativePhpunitPrinter();

        $arguments = array(
107
            'configuration' => $this->configuration,
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
            'coverageClover' => $this->coverageClover,
            'junitLogfile' => $this->junitlogfile,
            'printer' => $printer,
        );

        require_once "PHPUnit/TextUI/TestRunner.php";
        $runner = new PHPUnit_TextUI_TestRunner();
        $suite = $runner->getTest($this->test, $this->testfile, true);

        try {
            $result = $runner->doRun($suite, $arguments);
            /* @var $result PHPUnit_Framework_TestResult */

            if ( ($this->haltonfailure && $result->failureCount() > 0) || ($this->haltonerror && $result->errorCount() > 0) ) {
                throw new BuildException("PHPUnit: ".$result->failureCount()." Failures and ".$result->errorCount()." Errors, ".
                    "last failure message: ".$printer->getMessages());
            }

            $this->log("PHPUnit Success: ".count($result->passed())." tests passed, no ".
                "failures (".$result->skippedCount()." skipped, ".$result->notImplementedCount()." not implemented)");

129
            // Hudson for example doesn't like the backslash in class names
130
            if (file_exists($this->coverageClover)) {
131
                $this->log("Generated Clover Coverage XML to: ".$this->coverageClover);
132 133 134 135 136 137
                $content = file_get_contents($this->coverageClover);
                $content = str_replace("\\", ".", $content);
                file_put_contents($this->coverageClover, $content);
                unset($content);
            }

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
        } catch(\Exception $e) {
            throw new BuildException("NativePhpunitTask failed: ".$e->getMessage());
        }
    }
}

class NativePhpunitPrinter extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener
{
    private $_messages = array();

    public function write($buffer)
    {
        // do nothing
    }

    public function getMessages()
    {
        return $this->_messages;
    }

    /**
     * An error occurred.
     *
     * @param  PHPUnit_Framework_Test $test
     * @param  Exception              $e
     * @param  float                  $time
     */
    public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
    {
        $this->_messages[] = "Test ERROR: ".$test->getName().": ".$e->getMessage();
    }

    /**
     * A failure occurred.
     *
     * @param  PHPUnit_Framework_Test                 $test
     * @param  PHPUnit_Framework_AssertionFailedError $e
     * @param  float                                  $time
     */
    public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)
    {
        $this->_messages[] = "Test FAILED: ".$test->getName().": ".$e->getMessage();
    }

    /**
     * Incomplete test.
     *
     * @param  PHPUnit_Framework_Test $test
     * @param  Exception              $e
     * @param  float                  $time
     */
    public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
    {

    }

    /**
     * Skipped test.
     *
     * @param  PHPUnit_Framework_Test $test
     * @param  Exception              $e
     * @param  float                  $time
     * @since  Method available since Release 3.0.0
     */
    public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)
    {

    }

    /**
     * A test suite started.
     *
     * @param  PHPUnit_Framework_TestSuite $suite
     * @since  Method available since Release 2.2.0
     */
    public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
    {

    }

    /**
     * A test suite ended.
     *
     * @param  PHPUnit_Framework_TestSuite $suite
     * @since  Method available since Release 2.2.0
     */
    public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
    {

    }

    /**
     * A test started.
     *
     * @param  PHPUnit_Framework_Test $test
     */
    public function startTest(PHPUnit_Framework_Test $test)
    {

    }

    /**
     * A test ended.
     *
     * @param  PHPUnit_Framework_Test $test
     * @param  float                  $time
     */
    public function endTest(PHPUnit_Framework_Test $test, $time)
    {
        
    }
}