Subversion-Projekte lars-tiefland.php_share

Revision

Blame | Letzte Änderung | Log anzeigen | RSS feed

<?php
/**
 * $Id: PHPUnitTask.php 427 2008-10-28 19:34:15Z mrook $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

require_once 'phing/Task.php';
require_once 'phing/system/io/PhingFile.php';
require_once 'phing/system/io/Writer.php';
require_once 'phing/util/LogWriter.php';

/**
 * Runs PHPUnit2/3 tests.
 *
 * @author Michiel Rook <michiel.rook@gmail.com>
 * @version $Id: PHPUnitTask.php 427 2008-10-28 19:34:15Z mrook $
 * @package phing.tasks.ext.phpunit
 * @see BatchTest
 * @since 2.1.0
 */
class PHPUnitTask extends Task
{
        private $batchtests = array();
        private $formatters = array();
        private $haltonerror = false;
        private $haltonfailure = false;
        private $haltonincomplete = false;
        private $haltonskipped = false;
        private $errorproperty;
        private $failureproperty;
        private $incompleteproperty;
        private $skippedproperty;
        private $printsummary = false;
        private $testfailed = false;
        private $codecoverage = false;
        private $groups = array();
        private $excludeGroups = array();

        /**
         * Initialize Task.
         * This method includes any necessary PHPUnit2 libraries and triggers
         * appropriate error if they cannot be found.  This is not done in header
         * because we may want this class to be loaded w/o triggering an error.
         */
        function init() {
                if (version_compare(PHP_VERSION, '5.0.3') < 0) {
                    throw new BuildException("PHPUnit2Task requires PHP version >= 5.0.3.", $this->getLocation());
                }
                
                /**
                 * Determine PHPUnit version number
                 */
                @include_once 'PHPUnit/Runner/Version.php';
                @include_once 'PHPUnit2/Runner/Version.php';

                if (class_exists('PHPUnit_Runner_Version'))
                {
                        $version = PHPUnit_Runner_Version::id();
                }
                elseif (class_exists('PHPUnit2_Runner_Version'))
                {
                        $version = PHPUnit2_Runner_Version::id();
                }
                else
                {
                        throw new BuildException("PHPUnit task depends on PHPUnit 2 or 3 package being installed.", $this->getLocation());
                }
                
                if (version_compare($version, "3.0.0") >= 0)
                {
                        PHPUnitUtil::$installedVersion = 3;
                        if (version_compare($version, "3.2.0") >= 0)
                        {
                                PHPUnitUtil::$installedMinorVersion = 2;
                        }
                }
                else
                {
                        PHPUnitUtil::$installedVersion = 2;
                }
                
                /**
                 * Other dependencies that should only be loaded when class is actually used.
                 */
                require_once 'phing/tasks/ext/phpunit/PHPUnitTestRunner.php';
                require_once 'phing/tasks/ext/phpunit/BatchTest.php';
                require_once 'phing/tasks/ext/phpunit/FormatterElement.php';

                /**
                 * Add some defaults to the PHPUnit filter
                 */
                $pwd = dirname(__FILE__);

                if (PHPUnitUtil::$installedVersion == 3)
                {
                        require_once 'PHPUnit/Framework.php';
                        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');
                        }
                        
                        PHPUnit_Util_Filter::addFileToFilter($pwd . '/PHPUnitTask.php', 'PHING');
                        PHPUnit_Util_Filter::addFileToFilter($pwd . '/PHPUnitTestRunner.php', 'PHING');
                        PHPUnit_Util_Filter::addFileToFilter($pwd . '/../../../Task.php', 'PHING');
                        PHPUnit_Util_Filter::addFileToFilter($pwd . '/../../../Target.php', 'PHING');
                        PHPUnit_Util_Filter::addFileToFilter($pwd . '/../../../Project.php', 'PHING');
                        PHPUnit_Util_Filter::addFileToFilter($pwd . '/../../../Phing.php', 'PHING');
                }
                else
                {
                        require_once 'PHPUnit2/Framework.php';
                        require_once 'PHPUnit2/Util/Filter.php';
                        
                        PHPUnit2_Util_Filter::addFileToFilter($pwd . '/PHPUnitTask.php');
                        PHPUnit2_Util_Filter::addFileToFilter($pwd . '/PHPUnitTestRunner.php');
                        PHPUnit2_Util_Filter::addFileToFilter($pwd . '/../../../Task.php');
                        PHPUnit2_Util_Filter::addFileToFilter($pwd . '/../../../Target.php');
                        PHPUnit2_Util_Filter::addFileToFilter($pwd . '/../../../Project.php');
                        PHPUnit2_Util_Filter::addFileToFilter($pwd . '/../../../Phing.php');
                }
        }
        
        function setErrorproperty($value)
        {
                $this->errorproperty = $value;
        }
        
        function setFailureproperty($value)
        {
                $this->failureproperty = $value;
        }
        
        function setIncompleteproperty($value)
        {
                $this->incompleteproperty = $value;
        }
        
        function setSkippedproperty($value)
        {
                $this->skippedproperty = $value;
        }
        
        function setHaltonerror($value)
        {
                $this->haltonerror = $value;
        }

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

        function setHaltonincomplete($value)
        {
                $this->haltonincomplete = $value;
        }

        function setHaltonskipped($value)
        {
                $this->haltonskipped = $value;
        }

        function setPrintsummary($printsummary)
        {
                $this->printsummary = $printsummary;
        }
        
        function setCodecoverage($codecoverage)
        {
                $this->codecoverage = $codecoverage;
        }

        function setGroups($groups)
        {
                if (PHPUnitUtil::$installedVersion < 3 || (PHPUnitUtil::$installedVersion == 3 && PHPUnitUtil::$installedMinorVersion < 2))
                {
                        $this->log("The 'groups' attribute is only available with PHPUnit 3.2.0 or newer", Project::MSG_WARN);
                }
                $token = ' ,;';
                $this->groups = array();
                $tok = strtok($groups, $token);
                while ($tok !== false) {
                        $this->groups[] = $tok;
                        $tok = strtok($token);
                }
        }

        function setExcludeGroups($excludeGroups)
        {
                if (PHPUnitUtil::$installedVersion < 3 || (PHPUnitUtil::$installedVersion == 3 && PHPUnitUtil::$installedMinorVersion < 2))
                {
                        $this->log("The 'excludeGroups' attribute is only available with PHPUnit 3.2.0 or newer", Project::MSG_WARN);
                }
                $token = ' ,;';
                $this->excludeGroups = array();
                $tok = strtok($groups, $token);
                while ($tok !== false) {
                        $this->excludeGroups[] = $tok;
                        $tok = strtok($token);
                }
        }

        /**
         * Add a new formatter to all tests of this task.
         *
         * @param FormatterElement formatter element
         */
        function addFormatter(FormatterElement $fe)
        {
                $this->formatters[] = $fe;
        }

        /**
         * The main entry point
         *
         * @throws BuildException
         */
        function main()
        {
                $tests = array();
                
                if ($this->printsummary)
                {
                        $fe = new FormatterElement();
                        $fe->setType("summary");
                        $fe->setUseFile(false);
                        $this->formatters[] = $fe;
                }
                
                foreach ($this->batchtests as $batchtest)
                {
                        $tests = array_merge($tests, $batchtest->elements());
                }                       
                
                foreach ($this->formatters as $fe)
                {
                        $formatter = $fe->getFormatter();                       
                        $formatter->setProject($this->getProject());

                        if ($fe->getUseFile())
                        {
                                $destFile = new PhingFile($fe->getToDir(), $fe->getOutfile());
                                
                                $writer = new FileWriter($destFile->getAbsolutePath());

                                $formatter->setOutput($writer);
                        }
                        else
                        {
                                $formatter->setOutput($this->getDefaultOutput());
                        }

                        $formatter->startTestRun();
                }
                
                foreach ($tests as $test)
                {
                        $suite = NULL;
                        
                        if ((PHPUnitUtil::$installedVersion == 3 && is_subclass_of($test, 'PHPUnit_Framework_TestSuite')) || (PHPUnitUtil::$installedVersion == 2 && is_subclass_of($test, 'PHPUnit2_Framework_TestSuite')))
                        {
                                if (is_object($test))
                                {
                                        $suite = $test;
                                }
                                else
                                {
                                        $suite = new $test();
                                }
                        }
                        else
                        {
                                if (PHPUnitUtil::$installedVersion == 3)
                                {
                                        require_once 'PHPUnit/Framework/TestSuite.php';
                                        $suite = new PHPUnit_Framework_TestSuite(new ReflectionClass($test));
                                }
                                else
                                {
                                        require_once 'PHPUnit2/Framework/TestSuite.php';
                                        $suite = new PHPUnit2_Framework_TestSuite(new ReflectionClass($test));
                                }
                        }
                        
                        $this->execute($suite);
                }

                foreach ($this->formatters as $fe)
                {
                        $formatter = $fe->getFormatter();
                        $formatter->endTestRun();
                }
                
                if ($this->testfailed)
                {
                        throw new BuildException("One or more tests failed");
                }
        }

        /**
         * @throws BuildException
         */
        private function execute($suite)
        {
                $runner = new PHPUnitTestRunner($suite, $this->project, $this->groups, $this->excludeGroups);
                
                $runner->setCodecoverage($this->codecoverage);

                foreach ($this->formatters as $fe)
                {
                        $formatter = $fe->getFormatter();

                        $runner->addFormatter($formatter);
                }

                $runner->run();

                $retcode = $runner->getRetCode();
                
                if ($retcode == PHPUnitTestRunner::ERRORS) {
                    if ($this->errorproperty) {
                                $this->project->setNewProperty($this->errorproperty, true);
                        }
                        if ($this->haltonerror) {
                            $this->testfailed = true;
                        }
                } elseif ($retcode == PHPUnitTestRunner::FAILURES) {
                        if ($this->failureproperty) {
                                $this->project->setNewProperty($this->failureproperty, true);
                        }
                        
                        if ($this->haltonfailure) {
                                $this->testfailed = true;
                        }
                } elseif ($retcode == PHPUnitTestRunner::INCOMPLETES) {
                        if ($this->incompleteproperty) {
                                $this->project->setNewProperty($this->incompleteproperty, true);
                        }
                        
                        if ($this->haltonincomplete) {
                                $this->testfailed = true;
                        }
                } elseif ($retcode == PHPUnitTestRunner::SKIPPED) {
                        if ($this->skippedproperty) {
                                $this->project->setNewProperty($this->skippedproperty, true);
                        }
                        
                        if ($this->haltonskipped) {
                                $this->testfailed = true;
                        }
                }
        }

        private function getDefaultOutput()
        {
                return new LogWriter($this);
        }

        /**
         * Adds a set of tests based on pattern matching.
         *
         * @return BatchTest a new instance of a batch test.
         */
        function createBatchTest()
        {
                $batchtest = new BatchTest($this->getProject());

                $this->batchtests[] = $batchtest;

                return $batchtest;
        }
}