- Split SimpleTestListener off into a separate file. - Major work on responding conditionally to test results (now works nicely for the Staff table).

nigel.stanger / sqlmarker

Browse code - Split SimpleTestListener off into a separate file. - Major work on responding conditionally to test results (now works nicely for the Staff table). master
1 parent 0713f2b commit 0eccaa4387baade8ebfc0f59aa266e873eb2aaf4 Nigel Stanger authored on 27 Jun 2013

Patch

Showing 2 changed files

Ignore Space Show notes View Unit_testing/SimpleTestListener.php 0 → 100644
<?php class SimpleTestListener implements PHPUnit_Framework_TestListener { /** * When you're running test suites, the various count methods in TestResult return only the total number of tests, fails, etc., for the entire Test, even if you filter the tests to be run within a given suite. We therefore need to keep track of these within the test listener for each suite. The results are indexed by suite name, which will be something like "BDL_Test_Staff_structure::testFoo". / private $passes = array(); private $fails = array(); private $errors = array(); private $incompletes = array(); private $skips = array(); private $tests = array(); /* * These keep track of the counts within a given suite execution, and are reset at the start of every new suite. I'm not sure whether nested suites are stored as actual TestSuite objects. If not, this could mean that the counts for the enclosing suites may be wrong? */ private $passCount = 0; private $failCount = 0; private $errorCount = 0; private $incompleteCount = 0; private $skipCount = 0; private $testCount = 0; public function countPasses( $suiteName ) { return $this->passes[ $suiteName ]; } public function countFails( $suiteName ) { return $this->fails[ $suiteName ]; } public function countErrors( $suiteName ) { return $this->errors[ $suiteName ]; } public function countIncompletes( $suiteName ) { return $this->incompletes[ $suiteName ]; } public function countSkips( $suiteName ) { return $this->skips[ $suiteName ]; } public function countTests( $suiteName ) { return $this->tests[ $suiteName ]; } public function addError(PHPUnit_Framework_Test $test, Exception $e, $time) { echo "ERROR! " . $e->getMessage() . "\n"; $this->errorCount++; } public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time) { echo "FAILED! " . $e->getMessage() . "\n"; $this->failCount++; } public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) { echo "INCOMPLETE: " . $e->getMessage() . "\n"; $this->incompleteCount++; } public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) { echo "SKIPPED: " . $e->getMessage() . "\n"; $this->skipCount++; } public function startTest(PHPUnit_Framework_Test $test) { // printf("Test '%s' started.\n", $test->getName()); $this->testCount++; } public function endTest(PHPUnit_Framework_Test $test, $time) { // printf("Test '%s' ended.\n", $test->getName()); if ( $test->getStatus() === PHPUnit_Runner_BaseTestRunner::STATUS_PASSED ) { echo "OK\n"; $this->passCount++; } } public function startTestSuite(PHPUnit_Framework_TestSuite $suite) { // printf("TestSuite '%s' started.\n", $suite->getName()); $this->passCount = $this->failCount = $this->errorCount = $this->incompleteCount = $this->skipCount = $this->testCount = 0; } public function endTestSuite(PHPUnit_Framework_TestSuite $suite) { // printf("TestSuite '%s' ended.\n", $suite->getName()); $this->passes[ $suite->getName() ] = $this->passCount; $this->fails[ $suite->getName() ] = $this->failCount; $this->errors[ $suite->getName() ] = $this->errorCount; $this->incompletes[ $suite->getName() ] = $this->incompleteCount; $this->skips[ $suite->getName() ] = $this->skipCount; $this->tests[ $suite->getName() ] = $this->testCount; } } ?>

Ignore Space Show notes View

Unit_testing/SimpleTestListener.php 0 → 100644

<?php
	class SimpleTestListener implements PHPUnit_Framework_TestListener
	{
		/**
		 *	When you're running test suites, the various count methods in TestResult return only the total number of tests, fails, etc., for the entire Test, even if you filter the tests to be run within a given suite. We therefore need to keep track of these within the test listener for each suite. The results are indexed by suite name, which will be something like "BDL_Test_Staff_structure::testFoo".
		 */
		private $passes = array();
		private $fails = array();
		private $errors = array();
		private $incompletes = array();
		private $skips = array();
		private $tests = array();
		
		/**
		 *	These keep track of the counts within a given suite execution, and are reset at the start of every new suite. I'm not sure whether nested suites are stored as actual TestSuite objects. If not, this could mean that the counts for the enclosing suites may be wrong?
		 */
		private $passCount = 0;
		private $failCount = 0;
		private $errorCount = 0;
		private $incompleteCount = 0;
		private $skipCount = 0;
		private $testCount = 0;
		
		public function countPasses( $suiteName )
		{
			return $this->passes[ $suiteName ];
		}
		
		public function countFails( $suiteName )
		{
			return $this->fails[ $suiteName ];
		}
		
		public function countErrors( $suiteName )
		{
			return $this->errors[ $suiteName ];
		}
		
		public function countIncompletes( $suiteName )
		{
			return $this->incompletes[ $suiteName ];
		}
		
		public function countSkips( $suiteName )
		{
			return $this->skips[ $suiteName ];
		}
		
		public function countTests( $suiteName )
		{
			return $this->tests[ $suiteName ];
		}
		
		public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
		{
			echo "ERROR! " . $e->getMessage() . "\n";
			$this->errorCount++;
		}
	 
		public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)
		{
			echo "FAILED! " . $e->getMessage() . "\n";
			$this->failCount++;
		}
	 
		public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
		{
			echo "INCOMPLETE: " . $e->getMessage() . "\n";
			$this->incompleteCount++;
		}
	 
		public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)
		{
			echo "SKIPPED: " . $e->getMessage() . "\n";
			$this->skipCount++;
		}
	 
		public function startTest(PHPUnit_Framework_Test $test)
		{
// 			printf("Test '%s' started.\n", $test->getName());
			$this->testCount++;
		}
	 
		public function endTest(PHPUnit_Framework_Test $test, $time)
		{
// 			printf("Test '%s' ended.\n", $test->getName());
			if ( $test->getStatus() === PHPUnit_Runner_BaseTestRunner::STATUS_PASSED )
			{
				echo "OK\n";
				$this->passCount++;
			}
		}
	 
		public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
		{
// 			printf("TestSuite '%s' started.\n", $suite->getName());
			$this->passCount = $this->failCount = $this->errorCount = $this->incompleteCount = $this->skipCount = $this->testCount = 0;
		}
	 
		public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
		{
// 			printf("TestSuite '%s' ended.\n", $suite->getName());
			$this->passes[ $suite->getName() ] = $this->passCount;
			$this->fails[ $suite->getName() ] = $this->failCount;
			$this->errors[ $suite->getName() ] = $this->errorCount;
			$this->incompletes[ $suite->getName() ] = $this->incompleteCount;
			$this->skips[ $suite->getName() ] = $this->skipCount;
			$this->tests[ $suite->getName() ] = $this->testCount;
		}
	}
?>

Ignore Space Show notes View Unit_testing/test.php
<?php require_once "PHPUnit/Autoload.php"; require_once 'SimpleTestListener.php'; require_once "BDL_Test_Staff_structure.php"; require_once "BDL_Test_Staff_data.php"; $result = new PHPUnit_Framework_TestResult; $listener = new SimpleTestListener; $result->addListener( $listener ); $suite = new PHPUnit_Framework_TestSuite( 'BDL_Test_Staff_structure' ); $testresult = $suite->run( $result, '/testTableExists/' ); if ( $testresult->wasSuccessful() ) { echo ">>> Table exists.\n"; $testresult = $suite->run( $result, '/testColumnExists/' ); if ( $testresult->wasSuccessful() ) { echo ">>> Table contains all the expected columns.\n"; $testresult = $suite->run( $result, '/testColumnDataType/' ); if ( $testresult->wasSuccessful() ) echo ">>> All columns have the expected data types.\n"; $testresult = $suite->run( $result, '/testColumnLength/' ); if ( $testresult->wasSuccessful() ) echo ">>> All columns have the expected lengths.\n"; $testresult = $suite->run( $result, '/testColumnNullability/' ); if ( $testresult->wasSuccessful() ) echo ">>> All columns have the expected nullability.\n"; } $testresult = $suite->run( $result, '/testPK./' ); if ( $testresult->wasSuccessful() ) { echo ">>> Primary key exists and includes only the expected columns.\n"; } $testresult = $suite->run( $result, '/testConstraintsNamed/' ); if ( $testresult->wasSuccessful() ) echo ">>> All constraints that should be are explicitly named.\n"; } $suite = new PHPUnit_Framework_TestSuite( 'BDL_Test_Staff_data' ); $testresult = $suite->run( $result, '/testColumnLegalValue/' ); if ( $testresult->wasSuccessful() ) { printf( ">>> All %d legal values tested were accepted.\n", $listener->countTests( 'BDL_Test_Staff_data::testColumnLegalValue' ) ); } $testresult = $suite->run( $result, '/testColumnIllegalValueExplicit/' ); if ( $testresult->wasSuccessful() ) { printf( ">>> All %d illegal values tested were rejected by a CHECK constraint.\n", $listener->countTests( 'BDL_Test_Staff_data::testColumnIllegalValueExplicit' ) ); } else { $checkFails = $listener->countFails( 'BDL_Test_Staff_data::testColumnIllegalValueExplicit' ); printf( ">>> %d of %d illegal values tested %s not rejected by a CHECK constraint.\n", $checkFails, $listener->countTests( 'BDL_Test_Staff_data::testColumnIllegalValueExplicit' ), ( $checkFails > 1 ) ? "were" : "was" ); echo ">>> Checking values against column length...\n"; / Unfortunately, we can't test just the columns that failed the CHECK test. The failed TestCases are in $testresult->failures(), but we need the column name, which is hidden away in the private $data member of TestCase. We therefore have to test all the illegal values again to see if they're larger than the column. We then make the big assumption that if all the values that failed the CHECK test did so because they exceeded the column length. If this is correct, then the number of CHECK fails will equal the number of column length passes. If not, then something more serious has probably gone wrong! / $testresult = $suite->run( $result, '/testColumnIllegalValueImplicit/' ); $implicitPasses = $listener->countPasses( 'BDL_Test_Staff_data::testColumnIllegalValueImplicit' ); printf( ">>> %d of %d illegal values tested %s rejected by exceeding the column length.\n", $implicitPasses, $listener->countTests( 'BDL_Test_Staff_data::testColumnIllegalValueImplicit' ), ( $implicitPasses > 1 ) ? "were" : "was" ); // Any leftovers? if ( $implicitPasses != $checkFails ) { / $checkFails must by definition be >= $implicitPasses, as a "length exceeded" will /always/ fail the CHECK test, and a "check constraint" will /always/ fail the column length test. The two values will only differ when there are other exceptions in the mix, which will fail both tests. For example, suppose that two values fail the CHECK test with "length exceeded", one fails with "foo exception" and the remaining two pass. The first two will pass the column length test, and the remaining three will fail. */ printf( ">>> %d illegal values %s were rejected in both tests—check for something unusual.\n", $checkFails - $implicitPasses, ( ( $checkFails - $implicitPasses ) > 1 ) ? "were" : "was" ); } else { echo ">>> This is OK, but not necessarily safe, as the column length may change in future.\n"; } // $lengthPasses = } ?> <?php require_once "PHPUnit/Autoload.php"; require_once "BDL_Test_Staff_structure.php"; class SimpleTestListener implements PHPUnit_Framework_TestListener { private $totalMark = 0; public function getTotalMark() { return $this->totalMark; } public function addError(PHPUnit_Framework_Test $test, Exception $e, $time) { printf("Error while running test '%s'.\n", $test->getName()); } public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time) { printf("Test '%s' failed.\n", $test->getName()); } public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) { printf("Test '%s' is incomplete.\n", $test->getName()); } public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) { printf("Test '%s' has been skipped.\n", $test->getName()); } public function startTest(PHPUnit_Framework_Test $test) { printf("Test '%s' started.\n", $test->getName()); } public function endTest(PHPUnit_Framework_Test $test, $time) { printf("Test '%s' ended.\n", $test->getName()); } public function startTestSuite(PHPUnit_Framework_TestSuite $suite) { printf("TestSuite '%s' started.\n", $suite->getName()); } public function endTestSuite(PHPUnit_Framework_TestSuite $suite) { printf("TestSuite '%s' ended.\n", $suite->getName()); } } $suite = new PHPUnit_Framework_TestSuite('BDL_Test_Staff_structure'); $result = new PHPUnit_Framework_TestResult; $listener = new SimpleTestListener; $result->addListener($listener); $testresult = $suite->run( $result, '/testTableExists/' ); if ( count( $testresult->passed() ) == 1 ) echo "Table exists.\n"; $testresult = $suite->run( $result, '/testColumnExists/' ); if ( count( $testresult->passed() ) == 9 ) echo "Table has all the expected columns.\n"; ?>

Ignore Space Show notes View

Unit_testing/test.php

<?php
	require_once "PHPUnit/Autoload.php";
	require_once 'SimpleTestListener.php';
	require_once "BDL_Test_Staff_structure.php";
	require_once "BDL_Test_Staff_data.php";
	
	$result = new PHPUnit_Framework_TestResult;
	$listener = new SimpleTestListener;
	$result->addListener( $listener );
	
	$suite = new PHPUnit_Framework_TestSuite( 'BDL_Test_Staff_structure' );
	
	$testresult = $suite->run( $result, '/testTableExists/' );
	if ( $testresult->wasSuccessful() )
	{
		echo ">>> Table exists.\n";
		
		$testresult = $suite->run( $result, '/testColumnExists/' );
		if ( $testresult->wasSuccessful() )
		{
			echo ">>> Table contains all the expected columns.\n";
		
			$testresult = $suite->run( $result, '/testColumnDataType/' );
			if ( $testresult->wasSuccessful() ) echo ">>> All columns have the expected data types.\n";
			
			$testresult = $suite->run( $result, '/testColumnLength/' );
			if ( $testresult->wasSuccessful() ) echo ">>> All columns have the expected lengths.\n";
			
			$testresult = $suite->run( $result, '/testColumnNullability/' );
			if ( $testresult->wasSuccessful() ) echo ">>> All columns have the expected nullability.\n";
		}
		
		$testresult = $suite->run( $result, '/testPK.*/' );
		if ( $testresult->wasSuccessful() )
		{
			echo ">>> Primary key exists and includes only the expected columns.\n";
		}
		
		$testresult = $suite->run( $result, '/testConstraintsNamed/' );
		if ( $testresult->wasSuccessful() ) echo ">>> All constraints that should be are explicitly named.\n";
	}
	
	$suite = new PHPUnit_Framework_TestSuite( 'BDL_Test_Staff_data' );
	
	$testresult = $suite->run( $result, '/testColumnLegalValue/' );
	if ( $testresult->wasSuccessful() )
	{
		printf( ">>> All %d legal values tested were accepted.\n",
			$listener->countTests( 'BDL_Test_Staff_data::testColumnLegalValue' )
		);
	}

$testresult = $suite->run( $result, '/testColumnIllegalValueExplicit/' );
	if ( $testresult->wasSuccessful() )
	{
		printf( ">>> All %d illegal values tested were rejected by a CHECK constraint.\n",
			$listener->countTests( 'BDL_Test_Staff_data::testColumnIllegalValueExplicit' )
		);
	}
	else
	{
		$checkFails = $listener->countFails( 'BDL_Test_Staff_data::testColumnIllegalValueExplicit' );
		printf( ">>> %d of %d illegal values tested %s not rejected by a CHECK constraint.\n",
			$checkFails,
			$listener->countTests( 'BDL_Test_Staff_data::testColumnIllegalValueExplicit' ),
			( $checkFails > 1 ) ? "were" : "was"
		);
		echo ">>> Checking values against column length...\n";
		
		/*
			Unfortunately, we can't test just the columns that failed the CHECK test. The failed TestCases are in $testresult->failures(), but we need the column name, which is hidden away in the private $data member of TestCase. We therefore have to test all the illegal values again to see if they're larger than the column. We then make the big assumption that if all the values that failed the CHECK test did so because they exceeded the column length. If this is correct, then the number of CHECK fails will equal the number of column length passes. If not, then something more serious has probably gone wrong!
		*/
		$testresult = $suite->run( $result, '/testColumnIllegalValueImplicit/' );
		$implicitPasses = $listener->countPasses( 'BDL_Test_Staff_data::testColumnIllegalValueImplicit' );
		printf( ">>> %d of %d illegal values tested %s rejected by exceeding the column length.\n",
			$implicitPasses,
			$listener->countTests( 'BDL_Test_Staff_data::testColumnIllegalValueImplicit' ),
			( $implicitPasses > 1 ) ? "were" : "was"
		);
		
		// Any leftovers?
		if ( $implicitPasses != $checkFails )
		{
			/*
				$checkFails must by definition be >= $implicitPasses, as a "length exceeded" will /always/ fail the CHECK test, and a "check constraint" will /always/ fail the column length test. The two values will only differ when there are other exceptions in the mix, which will fail both tests.
				
				For example, suppose that two values fail the CHECK test with "length exceeded", one fails with "foo exception" and the remaining two pass. The first two will pass the column length test, and the remaining three will fail.
			*/
			printf( ">>> %d illegal values %s were rejected in both tests—check for something unusual.\n",
				$checkFails - $implicitPasses,
				( ( $checkFails - $implicitPasses ) > 1 ) ? "were" : "was"
			);
		}
		else
		{
			echo ">>> This is OK, but not necessarily safe, as the column length may change in future.\n";
		}
// 		$lengthPasses = 
	}
	
?>

<?php
	require_once "PHPUnit/Autoload.php";
	require_once "BDL_Test_Staff_structure.php";
	
	class SimpleTestListener implements PHPUnit_Framework_TestListener
	{
		private $totalMark = 0;
		
		public function getTotalMark()
		{
			return $this->totalMark;
		}
		
		public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
		{
			printf("Error while running test '%s'.\n", $test->getName());
		}
	 
		public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)
		{
			printf("Test '%s' failed.\n", $test->getName());
		}
	 
		public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
		{
			printf("Test '%s' is incomplete.\n", $test->getName());
		}
	 
		public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)
		{
			printf("Test '%s' has been skipped.\n", $test->getName());
		}
	 
		public function startTest(PHPUnit_Framework_Test $test)
		{
			printf("Test '%s' started.\n", $test->getName());
		}
	 
		public function endTest(PHPUnit_Framework_Test $test, $time)
		{
			printf("Test '%s' ended.\n", $test->getName());
		}
	 
		public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
		{
			printf("TestSuite '%s' started.\n", $suite->getName());
		}
	 
		public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
		{
			printf("TestSuite '%s' ended.\n", $suite->getName());
		}
	}
	
	$suite = new PHPUnit_Framework_TestSuite('BDL_Test_Staff_structure');
	
	$result = new PHPUnit_Framework_TestResult;
	$listener = new SimpleTestListener;
	$result->addListener($listener);
	
	$testresult = $suite->run( $result, '/testTableExists/' );
	
	if ( count( $testresult->passed() ) == 1 ) echo "Table exists.\n";
	
	$testresult = $suite->run( $result, '/testColumnExists/' );
	
	if ( count( $testresult->passed() ) == 9 ) echo "Table has all the expected columns.\n";
?>

Show line notes below