improved collecting deprecation notices during tests by using PHPUnit…

…Bridge's new `@expectedDeprecation` annotation
craue · Nov 30, 2016 · f33cc30 · f33cc30
1 parent 52fd639
commit f33cc30
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 78 deletions.
diff --git a/Tests/Form/FormFlowBcMethodsTest.php b/Tests/Form/FormFlowBcMethodsTest.php
@@ -2,22 +2,21 @@
 
 namespace Craue\FormFlowBundle\Tests\Form;
 
-use Craue\FormFlowBundle\Tests\UnitTestCase;
-
 /**
  * Tests for BC.
  *
- * @collectDeprecationNotices
+ * @group legacy
  * @group unit
  *
  * @author Christian Raue <christian.raue@gmail.com>
  * @copyright 2011-2016 Christian Raue
  * @license http://opensource.org/licenses/mit-license.php MIT License
  */
-class FormFlowBcMethodsTest extends UnitTestCase {
-
-	private $deprecatedMessage = 'Method Craue\FormFlowBundle\Form\FormFlow::%s is deprecated since version 2.0. Use method %s instead.';
+class FormFlowBcMethodsTest extends \PHPUnit_Framework_TestCase {
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::getCurrentStep is deprecated since version 2.0. Use method getCurrentStepNumber instead.
+	 */
 	public function testBcMethodDelegation_getCurrentStep() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'getCurrentStepNumber'))->getMock();
 
@@ -27,9 +26,11 @@ public function testBcMethodDelegation_getCurrentStep() {
 		;
 
 		$flowStub->getCurrentStep();
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'getCurrentStep', 'getCurrentStepNumber')), $this->getDeprecationNotices());
 	}
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::getCurrentStepDescription is deprecated since version 2.0. Use method getCurrentStepLabel instead.
+	 */
 	public function testBcMethodDelegation_getCurrentStepDescription() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'getCurrentStepLabel'))->getMock();
 
@@ -39,9 +40,11 @@ public function testBcMethodDelegation_getCurrentStepDescription() {
 		;
 
 		$flowStub->getCurrentStepDescription();
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'getCurrentStepDescription', 'getCurrentStepLabel')), $this->getDeprecationNotices());
 	}
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::getMaxSteps is deprecated since version 2.0. Use method getStepCount instead.
+	 */
 	public function testBcMethodDelegation_getMaxSteps() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'getStepCount'))->getMock();
 
@@ -51,9 +54,11 @@ public function testBcMethodDelegation_getMaxSteps() {
 		;
 
 		$flowStub->getMaxSteps();
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'getMaxSteps', 'getStepCount')), $this->getDeprecationNotices());
 	}
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::getStepDescriptions is deprecated since version 2.0. Use method getStepLabels instead.
+	 */
 	public function testBcMethodDelegation_getStepDescriptions() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'getStepLabels'))->getMock();
 
@@ -63,9 +68,11 @@ public function testBcMethodDelegation_getStepDescriptions() {
 		;
 
 		$flowStub->getStepDescriptions();
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'getStepDescriptions', 'getStepLabels')), $this->getDeprecationNotices());
 	}
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::getFirstStep is deprecated since version 2.0. Use method getFirstStepNumber instead.
+	 */
 	public function testBcMethodDelegation_getFirstStep() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'getFirstStepNumber'))->getMock();
 
@@ -75,9 +82,11 @@ public function testBcMethodDelegation_getFirstStep() {
 		;
 
 		$flowStub->getFirstStep();
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'getFirstStep', 'getFirstStepNumber')), $this->getDeprecationNotices());
 	}
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::getLastStep is deprecated since version 2.0. Use method getLastStepNumber instead.
+	 */
 	public function testBcMethodDelegation_getLastStep() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'getLastStepNumber'))->getMock();
 
@@ -87,9 +96,11 @@ public function testBcMethodDelegation_getLastStep() {
 		;
 
 		$flowStub->getLastStep();
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'getLastStep', 'getLastStepNumber')), $this->getDeprecationNotices());
 	}
 
+	/**
+	 * @expectedDeprecation Method Craue\FormFlowBundle\Form\FormFlow::hasSkipStep is deprecated since version 2.0. Use method isStepSkipped instead.
+	 */
 	public function testBcMethodDelegation_hasSkipStep() {
 		$flowStub = $this->getMockBuilder('\Craue\FormFlowBundle\Form\FormFlow')->setMethods(array('getName', 'isStepSkipped'))->getMock();
 
@@ -102,7 +113,6 @@ public function testBcMethodDelegation_hasSkipStep() {
 		;
 
 		$flowStub->hasSkipStep($stepNumber);
-		$this->assertEquals(array(sprintf($this->deprecatedMessage, 'hasSkipStep', 'isStepSkipped')), $this->getDeprecationNotices());
 	}
 
 }
diff --git a/Tests/UnitTestCase.php b/Tests/UnitTestCase.php
diff --git a/composer.json b/composer.json
@@ -24,7 +24,7 @@
 		"doctrine/common": "~2.3",
 		"phpunit/phpunit": "~4.1|~5.0",
 		"sensio/framework-extra-bundle": "~2.1|~3.0",
-		"symfony/phpunit-bridge": "^2.8.1",
+		"symfony/phpunit-bridge": "~3.2",
 		"symfony/symfony": "^2.1.3"
 	},
 	"minimum-stability": "stable",

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -25,4 +25,7 @@
 		<env name="LOG_DIR" value="/path/to/your/log/" />
 	</php>
 	-->
+	<listeners>
+		<listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
+	</listeners>
 </phpunit>