Merge pull request #997 from dshafik/skip-test-in-data-provider

Allow markTestSkipped/Incomplete() in dataProvider

src/Framework/IncompleteTestCase.php

@@ -0,0 +1,125 @@
+<?php
+/**
+ * PHPUnit
+ *
+ * Copyright (c) 2001-2014, Sebastian Bergmann <[email protected]>.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *   * Neither the name of Sebastian Bergmann nor the names of his
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * 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.
+ *
+ * @package    PHPUnit
+ * @subpackage Framework
+ * @author     Sebastian Bergmann <[email protected]>
+ * @copyright  2001-2014 Sebastian Bergmann <[email protected]>
+ * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
+ * @link       http://www.phpunit.de/
+ * @since      File available since Release 2.0.0
+ */
+
+/**
+ * An incomplete test case
+ *
+ * @package    PHPUnit
+ * @subpackage Framework
+ * @author     Davey Shafik <[email protected]>
+ * @copyright  2001-2014 Sebastian Bergmann <[email protected]>
+ * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
+ * @link       http://www.phpunit.de/
+ * @since      Class available since Release 4.3
+ */
+class PHPUnit_Framework_IncompleteTestCase extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @var string
+     */
+    protected $message = '';
+
+    /**
+     * @var boolean
+     */
+    protected $backupGlobals = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $backupStaticAttributes = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $runTestInSeparateProcess = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $useErrorHandler = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $useOutputBuffering = FALSE;
+
+    /**
+     * @param string $message
+     */
+    public function __construct($className, $methodName, $message = '')
+    {
+        $this->message = $message;
+        parent::__construct($className . '::' . $methodName);
+    }
+
+    /**
+     * @throws PHPUnit_Framework_Exception
+     */
+    protected function runTest()
+    {
+        $this->markTestIncomplete($this->message);
+    }
+
+    /**
+     * @return string
+     * @since  Method available since Release 3.0.0
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+
+    /**
+     * Returns a string representation of the test case.
+     *
+     * @return string
+     * @since  Method available since Release 3.4.0
+     */
+    public function toString()
+    {
+        return $this->getName();
+    }
+}

src/Framework/SkippedTestCase.php

@@ -0,0 +1,125 @@
+<?php
+/**
+ * PHPUnit
+ *
+ * Copyright (c) 2001-2014, Sebastian Bergmann <[email protected]>.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *   * Neither the name of Sebastian Bergmann nor the names of his
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * 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.
+ *
+ * @package    PHPUnit
+ * @subpackage Framework
+ * @author     Sebastian Bergmann <[email protected]>
+ * @copyright  2001-2014 Sebastian Bergmann <[email protected]>
+ * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
+ * @link       http://www.phpunit.de/
+ * @since      File available since Release 2.0.0
+ */
+
+/**
+ * A skipped test case
+ *
+ * @package    PHPUnit
+ * @subpackage Framework
+ * @author     Davey Shafik <[email protected]>
+ * @copyright  2001-2014 Sebastian Bergmann <[email protected]>
+ * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
+ * @link       http://www.phpunit.de/
+ * @since      Class available since Release 4.3
+ */
+class PHPUnit_Framework_SkippedTestCase extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @var string
+     */
+    protected $message = '';
+
+    /**
+     * @var boolean
+     */
+    protected $backupGlobals = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $backupStaticAttributes = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $runTestInSeparateProcess = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $useErrorHandler = FALSE;
+
+    /**
+     * @var boolean
+     */
+    protected $useOutputBuffering = FALSE;
+
+    /**
+     * @param string $message
+     */
+    public function __construct($className, $methodName, $message = '')
+    {
+        $this->message = $message;
+        parent::__construct($className . '::' . $methodName);
+    }
+
+    /**
+     * @throws PHPUnit_Framework_Exception
+     */
+    protected function runTest()
+    {
+        $this->markTestSkipped($this->message);
+    }
+
+    /**
+     * @return string
+     * @since  Method available since Release 3.0.0
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+
+    /**
+     * Returns a string representation of the test case.
+     *
+     * @return string
+     * @since  Method available since Release 3.4.0
+     */
+    public function toString()
+    {
+        return $this->getName();
+    }
+}

src/Framework/TestSuite.php

@@ -471,19 +471,51 @@ public static function createTest(ReflectionClass $theClass, $name)
                       $className, $name
                     );
                 } catch (Exception $e) {
-                    $message = sprintf(
-                      'The data provider specified for %s::%s is invalid.',
-                      $className,
-                      $name
-                    );
+                    if (!($e instanceof PHPUnit_Framework_SkippedTestError || $e instanceof PHPUnit_Framework_IncompleteTestError)) {
+                        $message = sprintf(
+                          'The data provider specified for %s::%s is invalid.',
+                          $className,
+                          $name
+                        );
 
-                    $_message = $e->getMessage();
+                        $_message = $e->getMessage();
+
+                        if (!empty($_message)) {
+                            $message .= "\n" . $_message;
+                        }
 
-                    if (!empty($_message)) {
-                        $message .= "\n" . $_message;
+                        $data = self::warning($message);
                     }
+                    else if ($e instanceof PHPUnit_Framework_SkippedTestError) {
+                        $message = sprintf(
+                            'Test for %s::%s skipped by data provider',
+                            $className,
+                            $name
+                        );
+
+                        $_message = $e->getMessage();
 
-                    $data = self::warning($message);
+                        if (!empty($_message)) {
+                            $message .= "\n" . $_message;
+                        }
+
+                        $data = self::skipTest($className, $name, $message);
+                    }
+                    else if ($e instanceof PHPUnit_Framework_IncompleteTestError) {
+                        $message = sprintf(
+                            'Test for %s::%s marked incomplete by data provider',
+                            $className,
+                            $name
+                        );
+
+                        $_message = $e->getMessage();
+
+                        if (!empty($_message)) {
+                            $message .= "\n" . $_message;
+                        }
+
+                        $data = self::incompleteTest($className, $name, $message);
+                    }
                 }
 
                 // Test method with @dataProvider.
@@ -503,7 +535,9 @@ public static function createTest(ReflectionClass $theClass, $name)
 
                     $groups = PHPUnit_Util_Test::getGroups($className, $name);
 
-                    if ($data instanceof PHPUnit_Framework_Warning) {
+                    if ($data instanceof PHPUnit_Framework_Warning
+                        || $data instanceof PHPUnit_Framework_SkippedTestCase
+                        || $data instanceof PHPUnit_Framework_IncompleteTestCase) {
                         $test->addTest($data, $groups);
                     } else {
                         foreach ($data as $_dataName => $_data) {
@@ -845,6 +879,28 @@ protected static function warning($message)
         return new PHPUnit_Framework_Warning($message);
     }
 
+    /**
+     * @param string $class
+     * @param string $methodName
+     * @param string $message
+     * @return PHPUnit_Framework_SkippedTestCase
+     */
+    protected static function skipTest($class, $methodName, $message)
+    {
+        return new PHPUnit_Framework_SkippedTestCase($class, $methodName, $message);
+    }
+
+    /**
+     * @param string $class
+     * @param string $methodName
+     * @param string $message
+     * @return PHPUnit_Framework_IncompleteTestCase
+     */
+    protected static function incompleteTest($class, $methodName, $message)
+    {
+        return new PHPUnit_Framework_IncompleteTestCase($class, $methodName, $message);
+    }
+
     /**
      * @param boolean $backupGlobals
      * @since  Method available since Release 3.3.0

tests/Framework/SuiteTest.php

@@ -44,6 +44,8 @@
 
 require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'BeforeAndAfterTest.php';
 require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'BeforeClassAndAfterClassTest.php';
+require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'DataProviderSkippedTest.php';
+require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'DataProviderIncompleteTest.php';
 require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'InheritedTestCase.php';
 require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'NoTestCaseClass.php';
 require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'NoTestCases.php';
@@ -86,6 +88,8 @@ public static function suite()
         $suite->addTest(new Framework_SuiteTest('testShadowedTests'));
         $suite->addTest(new Framework_SuiteTest('testBeforeClassAndAfterClassAnnotations'));
         $suite->addTest(new Framework_SuiteTest('testBeforeAnnotation'));
+        $suite->addTest(new Framework_SuiteTest('testSkippedTestDataProvider'));
+        $suite->addTest(new Framework_SuiteTest('testIncompleteTestDataProvider'));
         $suite->addTest(new Framework_SuiteTest('testRequirementsBeforeClassHook'));
 
         return $suite;
@@ -215,6 +219,26 @@ public function testBeforeAnnotation()
         $this->assertEquals(2, BeforeAndAfterTest::$afterWasRun);
     }
 
+    public function testSkippedTestDataProvider()
+    {
+        $suite = new PHPUnit_Framework_TestSuite('DataProviderSkippedTest');
+
+        $suite->run($this->result);
+
+        $this->assertEquals(3, $this->result->count());
+        $this->assertEquals(1, $this->result->skippedCount());
+    }
+
+    public function testIncompleteTestDataProvider()
+    {
+        $suite = new PHPUnit_Framework_TestSuite('DataProviderIncompleteTest');
+
+        $suite->run($this->result);
+
+        $this->assertEquals(3, $this->result->count());
+        $this->assertEquals(1, $this->result->notImplementedCount());
+    }
+
     public function testRequirementsBeforeClassHook()
     {
         $suite = new PHPUnit_Framework_TestSuite(