Added support for ANSI coloured output.

nigel.stanger / sqlmarker

Browse code Added support for ANSI coloured output. master
1 parent 068bafe commit 9cc6f02aec2c86c9cefd79022a01415df9874619 Nigel Stanger authored on 29 Aug 2013

Patch

Showing 7 changed files

Ignore Space Show notes View Unit_testing/Reporter.php
<?php abstract class Reporter { // 0 == no output // 1 == brief output (students?) // 2 == verbose output (marking) private $verbosity = 0; const STATUS_PASS = 'PASSED'; const STATUS_SKIPPED = 'SKIPPED'; const STATUS_INCOMPLETE = 'INCOMPLETE'; const STATUS_FAILURE = 'FAILED'; const STATUS_ERROR = 'ERROR'; const STATUS_WARNING = 'WARNING'; const STATUS_NOTE = 'NOTE'; const STATUS_TEST = 'TEST'; function __construct( $verbosity ) { $this->verbosity = $verbosity; } public static function pluralise( $count, $oneText, $manyText ) { return ( abs( $count ) !== 1 ) ? $manyText : $oneText; } public function setVerbosity( $newVerbosity ) { $this->verbosity = $newVerbosity; } public function getVerbosity() { return $this->verbosity; } /** * $reportText is one of: PASSED, FAILED, ERROR, INCOMPLETE, SKIPPED, WARNING, NOTE, MISC, ...? * $reportText is a printf-style string (although we actually use vprintf because of the array) * $printfArguments is an array of arguments to $reportText / public function report( $statusText, $reportText, $printfArguments ) { if ( $this->verbosity ) vprintf( $statusText . $reportText . "\n", $printfArguments ); } abstract public function hr(); } ?> <?php abstract class Reporter { // 0 == no output // 1 == brief output (students?) // 2 == verbose output (marking) private $verbosity = 0; const STATUS_PASS = 'PASSED'; const STATUS_SKIPPED = 'SKIPPED'; const STATUS_INCOMPLETE = 'INCOMPLETE'; const STATUS_FAILURE = 'FAILED'; const STATUS_ERROR = 'ERROR'; const STATUS_WARNING = 'WARNING'; const STATUS_NOTE = 'NOTE'; const STATUS_TEST = 'TEST'; function __construct( $verbosity ) { $this->verbosity = $verbosity; } public static function pluralise( $count, $oneText, $manyText ) { return ( $count > 1 ) ? $manyText : $oneText; } public function setVerbosity( $newVerbosity ) { $this->verbosity = $newVerbosity; } public function getVerbosity() { return $this->verbosity; } /* * $reportText is one of: PASSED, FAILED, ERROR, INCOMPLETE, SKIPPED, WARNING, NOTE, MISC, ...? * $reportText is a printf-style string (although we actually use vprintf because of the array) * $printfArguments is an array of arguments to $reportText */ public function report( $statusText, $reportText, $printfArguments ) { if ( $this->verbosity ) vprintf( $statusText . $reportText, $printfArguments ); } abstract public function hr(); } ?>

Ignore Space Show notes View

Unit_testing/Reporter.php

<?php

abstract class Reporter
{
	// 0 == no output
	// 1 == brief output (students?)
	// 2 == verbose output (marking)
	private $verbosity = 0;
	
	const STATUS_PASS		= 'PASSED';
	const STATUS_SKIPPED	= 'SKIPPED';
	const STATUS_INCOMPLETE	= 'INCOMPLETE';
	const STATUS_FAILURE	= 'FAILED';
	const STATUS_ERROR		= 'ERROR';
	const STATUS_WARNING	= 'WARNING';
	const STATUS_NOTE		= 'NOTE';
	const STATUS_TEST		= 'TEST';
	
	function __construct( $verbosity )
	{
		$this->verbosity = $verbosity;
	}
	
	public static function pluralise( $count, $oneText, $manyText )
	{
		return ( abs( $count ) !== 1 ) ? $manyText : $oneText;
	}
	
	public function setVerbosity( $newVerbosity )
	{
		$this->verbosity = $newVerbosity;
	}
	
	public function getVerbosity()
	{
		return $this->verbosity;
	}
	
	/**
	 *	$reportText is one of: PASSED, FAILED, ERROR, INCOMPLETE, SKIPPED, WARNING, NOTE, MISC, ...?
	 *	$reportText is a printf-style string (although we actually use vprintf because of the array)
	 *	$printfArguments is an array of arguments to $reportText
	 */
	public function report( $statusText, $reportText, $printfArguments )
	{
		if ( $this->verbosity ) vprintf( $statusText . $reportText . "\n", $printfArguments );
	}
	
	abstract public function hr();
}

<?php

abstract class Reporter
{
	// 0 == no output
	// 1 == brief output (students?)
	// 2 == verbose output (marking)
	private $verbosity = 0;
	
	const STATUS_PASS		= 'PASSED';
	const STATUS_SKIPPED	= 'SKIPPED';
	const STATUS_INCOMPLETE	= 'INCOMPLETE';
	const STATUS_FAILURE	= 'FAILED';
	const STATUS_ERROR		= 'ERROR';
	const STATUS_WARNING	= 'WARNING';
	const STATUS_NOTE		= 'NOTE';
	const STATUS_TEST		= 'TEST';
	
	function __construct( $verbosity )
	{
		$this->verbosity = $verbosity;
	}
	
	public static function pluralise( $count, $oneText, $manyText )
	{
		return ( $count > 1 ) ? $manyText : $oneText;
	}
	
	public function setVerbosity( $newVerbosity )
	{
		$this->verbosity = $newVerbosity;
	}
	
	public function getVerbosity()
	{
		return $this->verbosity;
	}
	
	/**
	 *	$reportText is one of: PASSED, FAILED, ERROR, INCOMPLETE, SKIPPED, WARNING, NOTE, MISC, ...?
	 *	$reportText is a printf-style string (although we actually use vprintf because of the array)
	 *	$printfArguments is an array of arguments to $reportText
	 */
	public function report( $statusText, $reportText, $printfArguments )
	{
		if ( $this->verbosity ) vprintf( $statusText . $reportText, $printfArguments );
	}
	
	abstract public function hr();
}

Ignore Space Show notes View Unit_testing/Reporter/ANSIReporter.php 0 → 100644
<?php require_once 'TextReporter.php'; require_once 'Util/ANSIColors.php'; class ANSIReporter extends TextReporter { private $ANSI; public function __construct( $verbosity ) { $this->ANSI = new ANSIColors(); parent::__construct( $verbosity ); } public function report ( $status, $reportText, $printfArguments ) { if ( $this->getVerbosity() ) { $fg = null; $bg = null; switch ( $status ) { case Reporter::STATUS_PASS: $bg = 'green'; break; case Reporter::STATUS_INCOMPLETE: $bg = 'yellow'; break; case Reporter::STATUS_FAILURE: case Reporter::STATUS_ERROR: $fg = 'white'; $bg = 'red'; break; case Reporter::STATUS_WARNING: $bg = 'yellow'; break; case Reporter::STATUS_NOTE: $bg = 'light_gray'; break; default: break; } echo $this->ANSI->setColor( $fg, $bg ); parent::report( $status, $reportText . $this->ANSI->resetANSI(), $printfArguments ); } } } ?>

Ignore Space Show notes View

Unit_testing/Reporter/ANSIReporter.php 0 → 100644

<?php
require_once 'TextReporter.php';
require_once 'Util/ANSIColors.php';

class ANSIReporter extends TextReporter
{
    private $ANSI;
    
    public function __construct( $verbosity )
    {
        $this->ANSI = new ANSIColors();
        parent::__construct( $verbosity );
    }
    
	public function report ( $status, $reportText, $printfArguments )
	{
		if ( $this->getVerbosity() )
		{
			$fg = null;
			$bg = null;
			switch ( $status )
			{
				case Reporter::STATUS_PASS:
					$bg = 'green';
					break;
				case Reporter::STATUS_INCOMPLETE:
					$bg = 'yellow';
					break;
				case Reporter::STATUS_FAILURE:
				case Reporter::STATUS_ERROR:
				    $fg = 'white';
					$bg = 'red';
					break;
				case Reporter::STATUS_WARNING:
					$bg = 'yellow';
					break;
				case Reporter::STATUS_NOTE:
					$bg = 'light_gray';
					break;
				default:
					break;
			}
			
			echo $this->ANSI->setColor( $fg, $bg );
			
			parent::report( $status, $reportText . $this->ANSI->resetANSI(), $printfArguments );
		}
	}
}

Ignore Space Show notes View Unit_testing/Reporter/TextReporter.php
<?php require_once 'Reporter.php'; class TextReporter extends Reporter { public function report ( $status, $reportText, $printfArguments ) { if ( $this->getVerbosity() ) { $statusText = ''; switch ( $status ) { case Reporter::STATUS_PASS: $statusText .= '+++ '; break; case Reporter::STATUS_SKIPPED: $statusText .= '### '; break; case Reporter::STATUS_INCOMPLETE: $statusText .= '%%% '; break; case Reporter::STATUS_FAILURE: $statusText .= '--- '; break; case Reporter::STATUS_ERROR: $statusText .= 'XXX '; break; case Reporter::STATUS_WARNING: $statusText .= '!!! '; break; case Reporter::STATUS_NOTE: case Reporter::STATUS_TEST: break; default: $statusText .= '??? '; break; } if ( $this->getVerbosity() > 1 ) $statusText .= $status . ': '; parent::report( $statusText, $reportText, $printfArguments ); } } public function hr() { echo "------------------------------------------------------------\n"; } } ?> <?php require_once 'Reporter.php'; class TextReporter extends Reporter { public function report ( $status, $reportText, $printfArguments ) { if ( $this->getVerbosity() ) { $statusText = ''; switch ( $status ) { case Reporter::STATUS_PASS: $statusText .= '+++ '; break; case Reporter::STATUS_SKIPPED: $statusText .= '### '; break; case Reporter::STATUS_INCOMPLETE: $statusText .= '%%% '; break; case Reporter::STATUS_FAILURE: $statusText .= '--- '; break; case Reporter::STATUS_ERROR: $statusText .= 'XXX '; break; case Reporter::STATUS_WARNING: $statusText .= '!!! '; break; case Reporter::STATUS_NOTE: break; case Reporter::STATUS_TEST: break; default: $statusText .= '??? '; break; } if ( $this->getVerbosity() > 1 ) $statusText .= $status . ': '; parent::report( $statusText, $reportText . "\n", $printfArguments ); } } public function hr() { echo "------------------------------------------------------------\n"; } } ?>

Ignore Space Show notes View

Unit_testing/Reporter/TextReporter.php

<?php
require_once 'Reporter.php';

class TextReporter extends Reporter
{
	public function report ( $status, $reportText, $printfArguments )
	{
		if ( $this->getVerbosity() )
		{
			$statusText = '';
			switch ( $status )
			{
				case Reporter::STATUS_PASS:
					$statusText .= '+++ ';
					break;
				case Reporter::STATUS_SKIPPED:
					$statusText .= '### ';
					break;
				case Reporter::STATUS_INCOMPLETE:
					$statusText .= '%%% ';
					break;
				case Reporter::STATUS_FAILURE:
					$statusText .= '--- ';
					break;
				case Reporter::STATUS_ERROR:
					$statusText .= 'XXX ';
					break;
				case Reporter::STATUS_WARNING:
					$statusText .= '!!! ';
					break;
				case Reporter::STATUS_NOTE:
				case Reporter::STATUS_TEST:
					break;
				default:
					$statusText .= '??? ';
					break;
			}
			if ( $this->getVerbosity() > 1 ) $statusText .= $status . ': ';
			
			parent::report( $statusText, $reportText, $printfArguments );
		}
	}
	
	public function hr()
	{
		echo "------------------------------------------------------------\n";
	}
}

<?php
require_once 'Reporter.php';

class TextReporter extends Reporter
{
	public function report ( $status, $reportText, $printfArguments )
	{
		if ( $this->getVerbosity() )
		{
			$statusText = '';
			switch ( $status )
			{
				case Reporter::STATUS_PASS:
					$statusText .= '+++ ';
					break;
				case Reporter::STATUS_SKIPPED:
					$statusText .= '### ';
					break;
				case Reporter::STATUS_INCOMPLETE:
					$statusText .= '%%% ';
					break;
				case Reporter::STATUS_FAILURE:
					$statusText .= '--- ';
					break;
				case Reporter::STATUS_ERROR:
					$statusText .= 'XXX ';
					break;
				case Reporter::STATUS_WARNING:
					$statusText .= '!!! ';
					break;
				case Reporter::STATUS_NOTE:
					break;
				case Reporter::STATUS_TEST:
					break;
				default:
					$statusText .= '??? ';
					break;
			}
			if ( $this->getVerbosity() > 1 ) $statusText .= $status . ': ';
			
			parent::report( $statusText, $reportText . "\n", $printfArguments );
		}
	}
	
	public function hr()
	{
		echo "------------------------------------------------------------\n";
	}
}

Ignore Space Show notes View Unit_testing/TestListener/ANSITestListener.php 0 → 100644
<?php require_once 'TextTestListener.php'; class ANSITestListener extends TextTestListener { private $ANSI; public function __construct() { $this->ANSI = new ANSIColors(); } public function printPass() { echo $this->ANSI->setForegroundColor( 'green' ); parent::printPass(); echo $this->ANSI->resetANSI(); } public function printFailure( Exception $e ) { echo $this->ANSI->setForegroundColor( 'red' ); parent::printFailure( $e ); echo $this->ANSI->resetANSI(); } public function printError( Exception $e ) { echo $this->ANSI->setForegroundColor( 'red' ); parent::printError( $e ); echo $this->ANSI->resetANSI(); } public function printIncomplete( Exception $e ) { echo $this->ANSI->setForegroundColor( 'yellow' ); parent::printIncomplete( $e ); echo $this->ANSI->resetANSI(); } } ?>

Ignore Space Show notes View

Unit_testing/TestListener/ANSITestListener.php 0 → 100644

Ignore Space Show notes View Unit_testing/Util/ANSIColors.php 0 → 100644
<?php class ANSIColors { private $foreground_colors = array(); private $background_colors = array(); public function __construct() { // Set up shell colors $this->foreground_colors['black'] = '0;30'; $this->foreground_colors['dark_gray'] = '1;30'; $this->foreground_colors['blue'] = '0;34'; $this->foreground_colors['light_blue'] = '1;34'; $this->foreground_colors['green'] = '0;32'; $this->foreground_colors['light_green'] = '1;32'; $this->foreground_colors['cyan'] = '0;36'; $this->foreground_colors['light_cyan'] = '1;36'; $this->foreground_colors['red'] = '0;31'; $this->foreground_colors['light_red'] = '1;31'; $this->foreground_colors['purple'] = '0;35'; $this->foreground_colors['light_purple'] = '1;35'; $this->foreground_colors['brown'] = '0;33'; $this->foreground_colors['yellow'] = '1;33'; $this->foreground_colors['light_gray'] = '0;37'; $this->foreground_colors['white'] = '1;37'; $this->background_colors['black'] = '40'; $this->background_colors['red'] = '41'; $this->background_colors['green'] = '42'; $this->background_colors['yellow'] = '43'; $this->background_colors['blue'] = '44'; $this->background_colors['magenta'] = '45'; $this->background_colors['cyan'] = '46'; $this->background_colors['light_gray'] = '47'; } // Generate ANSI escape sequence. public function ansiEscape( $arg ) { return sprintf( "\033[%sm", $arg ); } // Return colorized string. public function colorizeString( $string, $foreground_color = null, $background_color = null ) { return sprintf( "%s%s%s%s", $this->setForegroundColor( $foreground_color ), $this->setBackgroundColor( $background_color ), $string, $this->resetANSI() ); } // Set foreground color (if it exists). public function setForegroundColor( $foreground_color = null ) { return ( isset( $this->foreground_colors[ $foreground_color ] ) ) ? $this->ansiEscape( $this->foreground_colors[ $foreground_color ] ) : ''; } // Set background color (if it exists). public function setBackgroundColor( $background_color = null ) { return ( isset( $this->background_colors[ $background_color ] ) ) ? $this->ansiEscape( $this->background_colors[ $background_color ] ) : ''; } // Set the color. public function setColor( $foreground_color = null, $background_color = null ) { return $this->setForegroundColor( $foreground_color ) . $this->setBackgroundColor( $background_color ); } // Reset all ANSI formatting. public function resetANSI() { return $this->ansiEscape( '0' ); } // Returns specified foreground color. public function getForegroundColor( $name ) { return ( isset( $this->foreground_colors[$name] ) ) ? $this->foreground_colors[$name] : ''; } // Returns specified background color. public function getBackgroundColor( $name ) { return ( isset( $this->background_colors[$name] ) ) ? $this->background_colors[$name] : ''; } // Returns all foreground color names. public function getForegroundColors() { return array_keys($this->foreground_colors); } // Returns all background color names. public function getBackgroundColors() { return array_keys($this->background_colors); } } ?>

Ignore Space Show notes View

Unit_testing/Util/ANSIColors.php 0 → 100644

<?php

class ANSIColors
{
    private $foreground_colors = array();
    private $background_colors = array();

public function __construct()
    {
        // Set up shell colors
        $this->foreground_colors['black'] = '0;30';
        $this->foreground_colors['dark_gray'] = '1;30';
        $this->foreground_colors['blue'] = '0;34';
        $this->foreground_colors['light_blue'] = '1;34';
        $this->foreground_colors['green'] = '0;32';
        $this->foreground_colors['light_green'] = '1;32';
        $this->foreground_colors['cyan'] = '0;36';
        $this->foreground_colors['light_cyan'] = '1;36';
        $this->foreground_colors['red'] = '0;31';
        $this->foreground_colors['light_red'] = '1;31';
        $this->foreground_colors['purple'] = '0;35';
        $this->foreground_colors['light_purple'] = '1;35';
        $this->foreground_colors['brown'] = '0;33';
        $this->foreground_colors['yellow'] = '1;33';
        $this->foreground_colors['light_gray'] = '0;37';
        $this->foreground_colors['white'] = '1;37';

$this->background_colors['black'] = '40';
        $this->background_colors['red'] = '41';
        $this->background_colors['green'] = '42';
        $this->background_colors['yellow'] = '43';
        $this->background_colors['blue'] = '44';
        $this->background_colors['magenta'] = '45';
        $this->background_colors['cyan'] = '46';
        $this->background_colors['light_gray'] = '47';
    }
    
    // Generate ANSI escape sequence.
    public function ansiEscape( $arg )
    {
        return sprintf( "\033[%sm", $arg );
    }

// Return colorized string.
    public function colorizeString( $string, $foreground_color = null, $background_color = null )
    {
        return sprintf( "%s%s%s%s",
                        $this->setForegroundColor( $foreground_color ),
                        $this->setBackgroundColor( $background_color ),
                        $string,
                        $this->resetANSI()  );
    }

// Set foreground color (if it exists).
    public function setForegroundColor( $foreground_color = null )
    {
        return ( isset( $this->foreground_colors[ $foreground_color ] ) )
                ? $this->ansiEscape( $this->foreground_colors[ $foreground_color ] ) : '';
    }

// Set background color (if it exists).
    public function setBackgroundColor( $background_color = null )
    {
        return ( isset( $this->background_colors[ $background_color ] ) )
                ? $this->ansiEscape( $this->background_colors[ $background_color ] ) : '';
    }
    
    // Set the color.
    public function setColor( $foreground_color = null, $background_color = null )
    {
        return $this->setForegroundColor( $foreground_color ) . $this->setBackgroundColor( $background_color );
    }
    
    // Reset all ANSI formatting.
    public function resetANSI()
    {
        return $this->ansiEscape( '0' );
    }

// Returns specified foreground color.
    public function getForegroundColor( $name )
    {
        return ( isset( $this->foreground_colors[$name] ) ) ? $this->foreground_colors[$name] : '';
    }

// Returns specified background color.
    public function getBackgroundColor( $name )
    {
        return ( isset( $this->background_colors[$name] ) ) ? $this->background_colors[$name] : '';
    }

// Returns all foreground color names.
    public function getForegroundColors()
    {
        return array_keys($this->foreground_colors);
    }

// Returns all background color names.
    public function getBackgroundColors()
    {
        return array_keys($this->background_colors);
    }
}

Ignore Space Show notes View Unit_testing/mark_schema.php
<?php // Define things that need to be globally accessible as constants. define( 'ORACLE_USERNAME', 'stani797' ); define( 'ORACLE_PASSWORD', 'b1ggles' ); $outputMode = 'ANSI'; define( 'OUTPUT_VERBOSITY', 2 ); define( 'RUN_MODE', 'staff' ); require_once 'test_config.php'; require_once 'test.php'; ?> <?php // Define things that need to be globally accessible as constants. define( 'ORACLE_USERNAME', 'stani797' ); define( 'ORACLE_PASSWORD', 'b1ggles' ); $outputMode = 'TEXT'; define( 'OUTPUT_VERBOSITY', 2 ); define( 'RUN_MODE', 'staff' ); require_once 'test_config.php'; require_once 'test.php'; ?>

Ignore Space Show notes View

Unit_testing/mark_schema.php

Ignore Space Show notes View Unit_testing/test.php
<?php require_once 'test_config.php'; require_once "PHPUnit/Autoload.php"; require_once 'TestListener/HTMLTestListener.php'; require_once 'TestListener/TextTestListener.php'; require_once 'TestListener/ANSITestListener.php'; require_once 'Reporter/TextReporter.php'; require_once 'Reporter/ANSIReporter.php'; require_once 'Reporter/HTMLReporter.php'; require_once 'Searchable_TestSuite.php'; require_once "Schema.php"; // I don't know that these two settings make any difference, but I'll leave them in for now. PHPUnit_Framework_Error_Warning::$enabled = FALSE; PHPUnit_Framework_Error_Notice::$enabled = FALSE; switch ( $outputMode ) { case 'HTML': $reporter = new HTMLReporter( OUTPUT_VERBOSITY ); $listener = new HTMLTestListener; break; case 'TEXT': $reporter = new TextReporter( OUTPUT_VERBOSITY ); $listener = new TextTestListener; break; case 'ANSI': $reporter = new ANSIReporter( OUTPUT_VERBOSITY ); $listener = new ANSITestListener; break; } $result = new PHPUnit_Framework_TestResult; $result->addListener( $listener ); // List of tables to be tested. This is used to build the corresponding test class names. require_once "${scenario}_table_list.php"; /* Hack! There's no easy way to create a global object constant, so the global report object is stored as a private static member in PHPUnit_Extensions_Database_TestCase_CreateTable, with corresponding public get/set static methods. Set it once at the start, and it'll stay set for the entire test run. Yay! / PHPUnit_Extensions_Database_TestCase_CreateTable::setReporter( $reporter ); foreach ( $testTables as $table ) { $structureTest = "${scenario}_Test_${table}_structure"; $dataTest = "${scenario}_Test_${table}_data"; require_once "${table}/${structureTest}.php"; require_once "${table}/${dataTest}.php"; $listener->reset(); $reporter->hr(); $reporter->report( Reporter::STATUS_NOTE, 'Checking structure of table %s.', array( $table ) ); $suite = new Searchable_TestSuite( $structureTest ); // Critical to data testing. // TODO: is $testResult needed anymore? if ( $suite->testExists( 'testTableExists' ) ) { $testResult = $suite->run( $result, '/testTableExists/' ); $structurePassed = $listener->wasSuccessful( 'testTableExists' ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'Table %s exists.', array( $table ) ); // Critical to data testing. if ( $suite->testExists( "${structureTest}::testColumnExists" ) ) { $testResult = $suite->run( $result, '/testColumnExists/' ); $structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnExists" ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'Table %s contains all the expected columns.', array( $table ) ); if ( $suite->testExists( "${structureTest}::testColumnDataType" ) ) { $testResult = $suite->run( $result, '/testColumnDataType/' ); $structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnDataType" ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have data types compatible with the specification.', array( $table ) ); if ( $suite->testExists( "${structureTest}::testColumnLength" ) ) { $testResult = $suite->run( $result, '/testColumnLength/' ); $structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnLength" ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have lengths compatible with the specification.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected column length.', array( $listener->countNonPasses( "${structureTest}::testColumnLength" ), $listener->countPasses( "${structureTest}::testColumnLength" ), $table, Reporter::pluralise( "${structureTest}::testColumnLength", 'has', 'have' ) ) ) ; } } } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected data type.', array( $listener->countNonPasses( "${structureTest}::testColumnDataType" ), $listener->countPasses( "${structureTest}::testColumnDataType" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnDataType" ), "has", "have" ) ) ) ; $reporter->report( Reporter::STATUS_SKIPPED, 'column length tests, as the data types do not match what was expected.', null ); } } if ( RUN_MODE !== 'student' ) { if ( $suite->testExists( "${structureTest}::testColumnNullability" ) ) { $testResult = $suite->run( $result, '/testColumnNullability/' ); if ( $listener->wasSuccessful( "${structureTest}::testColumnNullability" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have the expected nullability.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected nullability.', array( $listener->countNonPasses( "${structureTest}::testColumnNullability" ), $listener->countPasses( "${structureTest}::testColumnNullability" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnNullability" ), "has", "have" ) ) ) ; } } } } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected columns of table %s %s either missing or misnamed.', array( $listener->countNonPasses( "${structureTest}::testColumnExists" ), $listener->countPasses( "${structureTest}::testColumnExists" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnExists" ), 'is', 'are' ) ) ) ; $reporter->report( Reporter::STATUS_SKIPPED, 'data type, length and nullability tests as they will include spurious errors.', null ); } } if ( RUN_MODE !== 'student' ) { // Not critical to data testing. Need to run both PK tests in one pass as the columns test depends on the existence test. if ( $suite->testExists( 'testPKExists' ) ) { $testResult = $suite->run( $result, '/testPK./' ); if ( $listener->wasSuccessful( 'testPKExists' ) ) { $reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s exists.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s missing.', array( $table ) ); } } if ( $suite->testExists( 'testPKColumns' ) ) { if ( $listener->wasSuccessful( 'testPKColumns' ) ) { $reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s includes (only) the expected columns.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s does not include (only) the expected columns.', array( $table ) ); } } // Not critical to data testing. if ( $suite->testExists( "${structureTest}::testFKsExist" ) ) { $testResult = $suite->run( $result, '/testFKsExist/' ); if ( $listener->wasSuccessful( "${structureTest}::testFKsExist" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All expected foreign keys for table %s exist.', array( $table ) ); if ( $suite->testExists( "${structureTest}::testFKColumns" ) ) { $testResult = $suite->run( $result, '/testFKColumns/' ); if ( $listener->wasSuccessful( "${structureTest}::testFKColumns" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All foreign keys for table %s include (only) the expected columns.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d foreign keys for table %s %s not include (only) the expected columns.', array( $listener->countNonPasses( "${structureTest}::testFKColumns" ), $listener->countPasses( "${structureTest}::testFKColumns" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKColumns" ), 'does', 'do' ) ) ); } } } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected foreign keys for table %s %s missing.', array( $listener->countNonPasses( "${structureTest}::testFKsExist" ), $listener->countPasses( "${structureTest}::testFKsExist" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKsExist" ), 'is', 'are' ) ) ); $reporter->report( Reporter::STATUS_SKIPPED, 'testing expected columns of FKs to avoid spurious errors' ); } } // Not critical to data testing. if ( $suite->testExists( "${structureTest}::testConstraintsNamed" ) ) { $testResult = $suite->run( $result, '/testConstraintsNamed/' ); if ( $listener->wasSuccessful( "${structureTest}::testConstraintsNamed" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All constraints of table %s that should be are explicitly named.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, 'Some constraints of table %s are not explicitly named that should be.', array( $table ) ); } } } } } if ( RUN_MODE !== 'student' ) { $reporter->report( Reporter::STATUS_NOTE, 'Testing constraints of table %s.', array( $table ) ); /* If the table or required columns are missing or misnamed, we need to skip the data testing entirely, as the INSERTs will just error out. We can't incorporate this into the if above, because we're using a completely different test suite. / if ( $structurePassed ) { $suite = new Searchable_TestSuite( $dataTest ); if ( $suite->testExists( "${dataTest}::testColumnLegalValue" ) ) { $testResult = $suite->run( $result, '/testColumnLegalValue/' ); if ( $listener->wasSuccessful( "${dataTest}::testColumnLegalValue" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All %d legal values tested were accepted.', array( $listener->countTests( "${dataTest}::testColumnLegalValue" ) ) ); } } if ( $suite->testExists( "${dataTest}::testColumnIllegalValueExplicit" ) ) { $testResult = $suite->run( $result, '/testColumnIllegalValueExplicit/' ); if ( $listener->wasSuccessful( "${dataTest}::testColumnIllegalValueExplicit" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All %d illegal values tested were rejected by a CHECK constraint.', array( $listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ) ) ); } else { $checkFails = $listener->countFails( "${dataTest}::testColumnIllegalValueExplicit" ); $reporter->report( Reporter::STATUS_WARNING, '%d of %d illegal values tested %s not rejected by a CHECK constraint.', array( $checkFails, $listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ), Reporter::pluralise( $checkFails, 'was', 'were' ) ) ) ; $reporter->report( Reporter::STATUS_WARNING, 'Checking values against column length...', null ); if ( $suite->testExists( "${dataTest}::testColumnIllegalValueImplicit" ) ) { / 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( "${dataTest}::testColumnIllegalValueImplicit" ); $reporter->report( Reporter::STATUS_PASS, '%d of %d illegal values tested %s rejected by exceeding the column length.', array( $implicitPasses, $listener->countTests( "${dataTest}::testColumnIllegalValueImplicit" ), Reporter::pluralise( $implicitPasses, 'was', 'were' ) ) ) ; // 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. / $reporter->report( Reporter::STATUS_FAILURE, '%d illegal %s rejected in both tests—check for something unusual.', array( $checkFails - $implicitPasses, Reporter::pluralise( $checkFails - $implicitPasses, 'value was', 'values were' ) ) ) ; } else { $reporter->report( Reporter::STATUS_NOTE, 'This is OK, but not necessarily safe, as the column length may change in future.', null ); } } else { $reporter->report( Reporter::STATUS_SKIPPED, 'testColumnIllegalValueImplicit() because it is missing.', null ); } } } } else { $reporter->report( Reporter::STATUS_SKIPPED, 'data tests, as failures in the structure testing mean that they may not work.', null ); } } } $reporter->hr(); ?> <?php require_once 'test_config.php'; require_once "PHPUnit/Autoload.php"; require_once 'TestListener/HTMLTestListener.php'; require_once 'TestListener/TextTestListener.php'; require_once 'Reporter/TextReporter.php'; require_once 'Reporter/HTMLReporter.php'; require_once 'Searchable_TestSuite.php'; require_once "Schema.php"; // I don't know that these two settings make any difference, but I'll leave them in for now. PHPUnit_Framework_Error_Warning::$enabled = FALSE; PHPUnit_Framework_Error_Notice::$enabled = FALSE; switch ( $outputMode ) { case 'HTML': $reporter = new HTMLReporter( OUTPUT_VERBOSITY ); $listener = new HTMLTestListener; break; case 'TEXT': $reporter = new TextReporter( OUTPUT_VERBOSITY ); $listener = new TextTestListener; break; } $result = new PHPUnit_Framework_TestResult; $result->addListener( $listener ); // List of tables to be tested. This is used to build the corresponding test class names. require_once "${scenario}_table_list.php"; / Hack! There's no easy way to create a global object constant, so the global report object is stored as a private static member in PHPUnit_Extensions_Database_TestCase_CreateTable, with corresponding public get/set static methods. Set it once at the start, and it'll stay set for the entire test run. Yay! / PHPUnit_Extensions_Database_TestCase_CreateTable::setReporter( $reporter ); foreach ( $testTables as $table ) { $structureTest = "${scenario}_Test_${table}_structure"; $dataTest = "${scenario}_Test_${table}_data"; require_once "${table}/${structureTest}.php"; require_once "${table}/${dataTest}.php"; $listener->reset(); $reporter->hr(); $reporter->report( Reporter::STATUS_NOTE, 'Checking structure of table %s.', array( $table ) ); $suite = new Searchable_TestSuite( $structureTest ); // Critical to data testing. // TODO: is $testResult needed anymore? if ( $suite->testExists( 'testTableExists' ) ) { $testResult = $suite->run( $result, '/testTableExists/' ); $structurePassed = $listener->wasSuccessful( 'testTableExists' ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'Table %s exists.', array( $table ) ); // Critical to data testing. if ( $suite->testExists( "${structureTest}::testColumnExists" ) ) { $testResult = $suite->run( $result, '/testColumnExists/' ); $structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnExists" ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'Table %s contains all the expected columns.', array( $table ) ); if ( $suite->testExists( "${structureTest}::testColumnDataType" ) ) { $testResult = $suite->run( $result, '/testColumnDataType/' ); $structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnDataType" ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have data types compatible with the specification.', array( $table ) ); if ( $suite->testExists( "${structureTest}::testColumnLength" ) ) { $testResult = $suite->run( $result, '/testColumnLength/' ); $structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnLength" ); if ( $structurePassed ) { $reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have lengths compatible with the specification.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected column length.', array( $listener->countNonPasses( "${structureTest}::testColumnLength" ), $listener->countPasses( "${structureTest}::testColumnLength" ), $table, Reporter::pluralise( "${structureTest}::testColumnLength", 'has', 'have' ) ) ) ; } } } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected data type.', array( $listener->countNonPasses( "${structureTest}::testColumnDataType" ), $listener->countPasses( "${structureTest}::testColumnDataType" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnDataType" ), "has", "have" ) ) ) ; $reporter->report( Reporter::STATUS_SKIPPED, 'column length tests, as the data types do not match what was expected.', null ); } } if ( RUN_MODE !== 'student' ) { if ( $suite->testExists( "${structureTest}::testColumnNullability" ) ) { $testResult = $suite->run( $result, '/testColumnNullability/' ); if ( $listener->wasSuccessful( "${structureTest}::testColumnNullability" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have the expected nullability.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected nullability.', array( $listener->countNonPasses( "${structureTest}::testColumnNullability" ), $listener->countPasses( "${structureTest}::testColumnNullability" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnNullability" ), "has", "have" ) ) ) ; } } } } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected columns of table %s %s either missing or misnamed.', array( $listener->countNonPasses( "${structureTest}::testColumnExists" ), $listener->countPasses( "${structureTest}::testColumnExists" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnExists" ), 'is', 'are' ) ) ) ; $reporter->report( Reporter::STATUS_SKIPPED, 'data type, length and nullability tests as they will include spurious errors.', null ); } } if ( RUN_MODE !== 'student' ) { // Not critical to data testing. Need to run both PK tests in one pass as the columns test depends on the existence test. if ( $suite->testExists( 'testPKExists' ) ) { $testResult = $suite->run( $result, '/testPK./' ); if ( $listener->wasSuccessful( 'testPKExists' ) ) { $reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s exists.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s missing.', array( $table ) ); } } if ( $suite->testExists( 'testPKColumns' ) ) { if ( $listener->wasSuccessful( 'testPKColumns' ) ) { $reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s includes (only) the expected columns.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s does not include (only) the expected columns.', array( $table ) ); } } // Not critical to data testing. if ( $suite->testExists( "${structureTest}::testFKsExist" ) ) { $testResult = $suite->run( $result, '/testFKsExist/' ); if ( $listener->wasSuccessful( "${structureTest}::testFKsExist" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All expected foreign keys for table %s exist.', array( $table ) ); if ( $suite->testExists( "${structureTest}::testFKColumns" ) ) { $testResult = $suite->run( $result, '/testFKColumns/' ); if ( $listener->wasSuccessful( "${structureTest}::testFKColumns" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All foreign keys for table %s include (only) the expected columns.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d foreign keys for table %s %s not include (only) the expected columns.', array( $listener->countNonPasses( "${structureTest}::testFKColumns" ), $listener->countPasses( "${structureTest}::testFKColumns" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKColumns" ), 'does', 'do' ) ) ); } } } else { $reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected foreign keys for table %s %s missing.', array( $listener->countNonPasses( "${structureTest}::testFKsExist" ), $listener->countPasses( "${structureTest}::testFKsExist" ), $table, Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKsExist" ), 'is', 'are' ) ) ); $reporter->report( Reporter::STATUS_SKIPPED, 'testing expected columns of FKs to avoid spurious errors' ); } } // Not critical to data testing. if ( $suite->testExists( "${structureTest}::testConstraintsNamed" ) ) { $testResult = $suite->run( $result, '/testConstraintsNamed/' ); if ( $listener->wasSuccessful( "${structureTest}::testConstraintsNamed" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All constraints of table %s that should be are explicitly named.', array( $table ) ); } else { $reporter->report( Reporter::STATUS_FAILURE, 'Some constraints of table %s are not explicitly named that should be.', array( $table ) ); } } } } } if ( RUN_MODE !== 'student' ) { $reporter->report( Reporter::STATUS_NOTE, 'Testing constraints of table %s.', array( $table ) ); /* If the table or required columns are missing or misnamed, we need to skip the data testing entirely, as the INSERTs will just error out. We can't incorporate this into the if above, because we're using a completely different test suite. / if ( $structurePassed ) { $suite = new Searchable_TestSuite( $dataTest ); if ( $suite->testExists( "${dataTest}::testColumnLegalValue" ) ) { $testResult = $suite->run( $result, '/testColumnLegalValue/' ); if ( $listener->wasSuccessful( "${dataTest}::testColumnLegalValue" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All %d legal values tested were accepted.', array( $listener->countTests( "${dataTest}::testColumnLegalValue" ) ) ); } } if ( $suite->testExists( "${dataTest}::testColumnIllegalValueExplicit" ) ) { $testResult = $suite->run( $result, '/testColumnIllegalValueExplicit/' ); if ( $listener->wasSuccessful( "${dataTest}::testColumnIllegalValueExplicit" ) ) { $reporter->report( Reporter::STATUS_PASS, 'All %d illegal values tested were rejected by a CHECK constraint.', array( $listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ) ) ); } else { $checkFails = $listener->countFails( "${dataTest}::testColumnIllegalValueExplicit" ); $reporter->report( Reporter::STATUS_WARNING, '%d of %d illegal values tested %s not rejected by a CHECK constraint.', array( $checkFails, $listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ), Reporter::pluralise( $checkFails, 'was', 'were' ) ) ) ; $reporter->report( Reporter::STATUS_WARNING, 'Checking values against column length...', null ); if ( $suite->testExists( "${dataTest}::testColumnIllegalValueImplicit" ) ) { / 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( "${dataTest}::testColumnIllegalValueImplicit" ); $reporter->report( Reporter::STATUS_PASS, '%d of %d illegal values tested %s rejected by exceeding the column length.', array( $implicitPasses, $listener->countTests( "${dataTest}::testColumnIllegalValueImplicit" ), Reporter::pluralise( $implicitPasses, 'was', 'were' ) ) ) ; // 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. */ $reporter->report( Reporter::STATUS_FAILURE, '%d illegal values %s rejected in both tests—check for something unusual.', array( $checkFails - $implicitPasses, Reporter::pluralise( $checkFails - $implicitPasses, 'was', 'were' ) ) ) ; } else { $reporter->report( Reporter::STATUS_NOTE, 'This is OK, but not necessarily safe, as the column length may change in future.', null ); } } else { $reporter->report( Reporter::STATUS_SKIPPED, 'testColumnIllegalValueImplicit() because it is missing.', null ); } } } } else { $reporter->report( Reporter::STATUS_SKIPPED, 'data tests, as failures in the structure testing mean that they may not work.', null ); } } } $reporter->hr(); ?>

Ignore Space Show notes View

Unit_testing/test.php

<?php

require_once 'test_config.php';

require_once "PHPUnit/Autoload.php";
require_once 'TestListener/HTMLTestListener.php';
require_once 'TestListener/TextTestListener.php';
require_once 'TestListener/ANSITestListener.php';
require_once 'Reporter/TextReporter.php';
require_once 'Reporter/ANSIReporter.php';
require_once 'Reporter/HTMLReporter.php';
require_once 'Searchable_TestSuite.php';
require_once "Schema.php";

// I don't know that these two settings make any difference, but I'll leave them in for now.
PHPUnit_Framework_Error_Warning::$enabled = FALSE;
PHPUnit_Framework_Error_Notice::$enabled = FALSE;

switch ( $outputMode )
{
	case 'HTML':
		$reporter = new HTMLReporter( OUTPUT_VERBOSITY );
		$listener = new HTMLTestListener;
		break;
	case 'TEXT':
		$reporter = new TextReporter( OUTPUT_VERBOSITY );
		$listener = new TextTestListener;
		break;
	case 'ANSI':
		$reporter = new ANSIReporter( OUTPUT_VERBOSITY );
		$listener = new ANSITestListener;
		break;
}

$result = new PHPUnit_Framework_TestResult;
$result->addListener( $listener );

// List of tables to be tested. This is used to build the corresponding test class names.
require_once "${scenario}_table_list.php";

/*
	Hack! There's no easy way to create a global object constant, so the global report object is stored as a private static member in PHPUnit_Extensions_Database_TestCase_CreateTable, with corresponding public get/set static methods. Set it once at the start, and it'll stay set for the entire test run. Yay!
*/
PHPUnit_Extensions_Database_TestCase_CreateTable::setReporter( $reporter );

foreach ( $testTables as $table )
{
	$structureTest	= "${scenario}_Test_${table}_structure";
	$dataTest		= "${scenario}_Test_${table}_data";
	
	require_once "${table}/${structureTest}.php";
	require_once "${table}/${dataTest}.php";
	
	$listener->reset();
	$reporter->hr();
	
	$reporter->report( Reporter::STATUS_NOTE, 'Checking structure of table %s.', array( $table ) );
	
	$suite = new Searchable_TestSuite( $structureTest );
	
	// Critical to data testing.
	// TODO: is $testResult needed anymore?
	if ( $suite->testExists( 'testTableExists' ) )
	{
		$testResult = $suite->run( $result, '/testTableExists/' );
		$structurePassed = $listener->wasSuccessful( 'testTableExists' );
		if ( $structurePassed )
		{
			$reporter->report( Reporter::STATUS_PASS, 'Table %s exists.', array( $table ) );
			
			// Critical to data testing.
			if ( $suite->testExists( "${structureTest}::testColumnExists" ) )
			{
				$testResult = $suite->run( $result, '/testColumnExists/' );
				$structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnExists" );
				if ( $structurePassed )
				{
					$reporter->report( Reporter::STATUS_PASS, 'Table %s contains all the expected columns.', array( $table ) );
				
					if ( $suite->testExists( "${structureTest}::testColumnDataType" ) )
					{
						$testResult = $suite->run( $result, '/testColumnDataType/' );
						$structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnDataType" );
						if ( $structurePassed )
						{
							$reporter->report(	Reporter::STATUS_PASS,
												'All columns of table %s have data types compatible with the specification.',
												array( $table )	);
						
							if ( $suite->testExists( "${structureTest}::testColumnLength" ) )
							{
								$testResult = $suite->run( $result, '/testColumnLength/' );
								$structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnLength" );
								if ( $structurePassed )
								{
									$reporter->report(	Reporter::STATUS_PASS,
														'All columns of table %s have lengths compatible with the specification.',
														array( $table )	);
								}
								else
								{
									$reporter->report(	Reporter::STATUS_FAILURE,
														'%d of the %d columns of table %s %s an unexpected column length.',
														array(	$listener->countNonPasses( "${structureTest}::testColumnLength" ),
																$listener->countPasses( "${structureTest}::testColumnLength" ),
																$table,
																Reporter::pluralise( "${structureTest}::testColumnLength", 'has', 'have' ) ) ) ;
								}
							}
						}
						else
						{
							$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected data type.',
								array(
									$listener->countNonPasses( "${structureTest}::testColumnDataType" ),
									$listener->countPasses( "${structureTest}::testColumnDataType" ),
									$table,
									Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnDataType" ), "has", "have" )
								) ) ;
							$reporter->report( Reporter::STATUS_SKIPPED, 'column length tests, as the data types do not match what was expected.', null );
						}
					}
					
					if ( RUN_MODE !== 'student' )
					{
						if ( $suite->testExists( "${structureTest}::testColumnNullability" ) )
						{
							$testResult = $suite->run( $result, '/testColumnNullability/' );
							if ( $listener->wasSuccessful( "${structureTest}::testColumnNullability" ) )
							{
								$reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have the expected nullability.', array( $table ) );
							}
							else
							{
								$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected nullability.',
									array(
										$listener->countNonPasses( "${structureTest}::testColumnNullability" ),
										$listener->countPasses( "${structureTest}::testColumnNullability" ),
										$table,
										Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnNullability" ), "has", "have" )
									) ) ;
							}
						}
					}
				}
				else
				{
					$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected columns of table %s %s either missing or misnamed.',
						array(
							$listener->countNonPasses( "${structureTest}::testColumnExists" ),
							$listener->countPasses( "${structureTest}::testColumnExists" ),
							$table,
							Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnExists" ), 'is', 'are' )
						) ) ;
					$reporter->report( Reporter::STATUS_SKIPPED, 'data type, length and nullability tests as they will include spurious errors.', null );
				}
			}
			
			if ( RUN_MODE !== 'student' )
			{
				// Not critical to data testing. Need to run both PK tests in one pass as the columns test depends on the existence test.
				if ( $suite->testExists( 'testPKExists' ) )
				{
					$testResult = $suite->run( $result, '/testPK.*/' );
					if ( $listener->wasSuccessful( 'testPKExists' ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s exists.', array( $table ) );
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s missing.', array( $table ) );
					}
				}
				if ( $suite->testExists( 'testPKColumns' ) )
				{
					if ( $listener->wasSuccessful( 'testPKColumns' ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s includes (only) the expected columns.', array( $table ) );
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s does not include (only) the expected columns.', array( $table ) );
					}
				}
				
				// Not critical to data testing.
				if ( $suite->testExists( "${structureTest}::testFKsExist" ) )
				{
					$testResult = $suite->run( $result, '/testFKsExist/' );
					if ( $listener->wasSuccessful( "${structureTest}::testFKsExist" ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'All expected foreign keys for table %s exist.', array( $table ) );
						
						if ( $suite->testExists( "${structureTest}::testFKColumns" ) )
						{
							$testResult = $suite->run( $result, '/testFKColumns/' );
							if ( $listener->wasSuccessful( "${structureTest}::testFKColumns" ) )
							{
								$reporter->report( Reporter::STATUS_PASS, 'All foreign keys for table %s include (only) the expected columns.', array( $table ) );
							}
							else
							{
								$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d foreign keys for table %s %s not include (only) the expected columns.', 
									array(
										$listener->countNonPasses( "${structureTest}::testFKColumns" ),
										$listener->countPasses( "${structureTest}::testFKColumns" ),
										$table,
										Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKColumns" ), 'does', 'do' )
									) );
							}
						}
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected foreign keys for table %s %s missing.', 
							array(
								$listener->countNonPasses( "${structureTest}::testFKsExist" ),
								$listener->countPasses( "${structureTest}::testFKsExist" ),
								$table,
								Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKsExist" ), 'is', 'are' )
							) );
						
						$reporter->report( Reporter::STATUS_SKIPPED, 'testing expected columns of FKs to avoid spurious errors' );
					}
				}
				
				// Not critical to data testing.
				if ( $suite->testExists( "${structureTest}::testConstraintsNamed" ) )
				{
					$testResult = $suite->run( $result, '/testConstraintsNamed/' );
					if ( $listener->wasSuccessful( "${structureTest}::testConstraintsNamed" ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'All constraints of table %s that should be are explicitly named.', array( $table ) );
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, 'Some constraints of table %s are not explicitly named that should be.', array( $table ) );
					}
				}
			}
		}
	}
	
	if ( RUN_MODE !== 'student' )
	{
		$reporter->report( Reporter::STATUS_NOTE, 'Testing constraints of table %s.', array( $table ) );
		
		/*
			If the table or required columns are missing or misnamed, we need to skip the data testing entirely, as the INSERTs will just error out. We can't incorporate this into the if above, because we're using a completely different test suite.
		*/
		if ( $structurePassed )
		{
			$suite = new Searchable_TestSuite( $dataTest );
			
			if ( $suite->testExists( "${dataTest}::testColumnLegalValue" ) )
			{
				$testResult = $suite->run( $result, '/testColumnLegalValue/' );
				if ( $listener->wasSuccessful( "${dataTest}::testColumnLegalValue" ) )
				{
					$reporter->report( Reporter::STATUS_PASS, 'All %d legal values tested were accepted.', 
						array( $listener->countTests( "${dataTest}::testColumnLegalValue" ) ) );
				}
			}
		
			if ( $suite->testExists( "${dataTest}::testColumnIllegalValueExplicit" ) )
			{
				$testResult = $suite->run( $result, '/testColumnIllegalValueExplicit/' );
				if ( $listener->wasSuccessful( "${dataTest}::testColumnIllegalValueExplicit" ) )
				{
					$reporter->report( Reporter::STATUS_PASS, 'All %d illegal values tested were rejected by a CHECK constraint.', 
						array( $listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ) ) );
				}
				else
				{
					$checkFails = $listener->countFails( "${dataTest}::testColumnIllegalValueExplicit" );
					$reporter->report( Reporter::STATUS_WARNING, '%d of %d illegal values tested %s not rejected by a CHECK constraint.',
						array(
							$checkFails,
							$listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ),
							Reporter::pluralise( $checkFails, 'was', 'were' )
						) ) ;
					$reporter->report( Reporter::STATUS_WARNING, 'Checking values against column length...', null );
					
					if ( $suite->testExists( "${dataTest}::testColumnIllegalValueImplicit" ) )
					{
						/*
							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( "${dataTest}::testColumnIllegalValueImplicit" );
						$reporter->report( Reporter::STATUS_PASS, '%d of %d illegal values tested %s rejected by exceeding the column length.',
							array(
								$implicitPasses,
								$listener->countTests( "${dataTest}::testColumnIllegalValueImplicit" ),
								Reporter::pluralise( $implicitPasses, 'was', 'were' )
							) ) ;
						
						// 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.
							*/
							$reporter->report( Reporter::STATUS_FAILURE, '%d illegal %s rejected in both tests—check for something unusual.',
								array(
									$checkFails - $implicitPasses,
									Reporter::pluralise( $checkFails - $implicitPasses, 'value was', 'values were' )
								) ) ;
						}
						else
						{
							$reporter->report( Reporter::STATUS_NOTE, 'This is OK, but not necessarily safe, as the column length may change in future.', null );
						}
					}
					else
					{
						$reporter->report( Reporter::STATUS_SKIPPED, 'testColumnIllegalValueImplicit() because it is missing.', null );
					}
				}
			}
		}
		else
		{
			$reporter->report( Reporter::STATUS_SKIPPED, 'data tests, as failures in the structure testing mean that they may not work.', null );
		}
	}
}

$reporter->hr();
?>

<?php

require_once 'test_config.php';

require_once "PHPUnit/Autoload.php";
require_once 'TestListener/HTMLTestListener.php';
require_once 'TestListener/TextTestListener.php';
require_once 'Reporter/TextReporter.php';
require_once 'Reporter/HTMLReporter.php';
require_once 'Searchable_TestSuite.php';
require_once "Schema.php";

// I don't know that these two settings make any difference, but I'll leave them in for now.
PHPUnit_Framework_Error_Warning::$enabled = FALSE;
PHPUnit_Framework_Error_Notice::$enabled = FALSE;

$result = new PHPUnit_Framework_TestResult;
$result->addListener( $listener );

// List of tables to be tested. This is used to build the corresponding test class names.
require_once "${scenario}_table_list.php";

foreach ( $testTables as $table )
{
	$structureTest	= "${scenario}_Test_${table}_structure";
	$dataTest		= "${scenario}_Test_${table}_data";
	
	require_once "${table}/${structureTest}.php";
	require_once "${table}/${dataTest}.php";
	
	$listener->reset();
	$reporter->hr();
	
	$reporter->report( Reporter::STATUS_NOTE, 'Checking structure of table %s.', array( $table ) );
	
	$suite = new Searchable_TestSuite( $structureTest );
	
	// Critical to data testing.
	// TODO: is $testResult needed anymore?
	if ( $suite->testExists( 'testTableExists' ) )
	{
		$testResult = $suite->run( $result, '/testTableExists/' );
		$structurePassed = $listener->wasSuccessful( 'testTableExists' );
		if ( $structurePassed )
		{
			$reporter->report( Reporter::STATUS_PASS, 'Table %s exists.', array( $table ) );
			
			// Critical to data testing.
			if ( $suite->testExists( "${structureTest}::testColumnExists" ) )
			{
				$testResult = $suite->run( $result, '/testColumnExists/' );
				$structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnExists" );
				if ( $structurePassed )
				{
					$reporter->report( Reporter::STATUS_PASS, 'Table %s contains all the expected columns.', array( $table ) );
				
					if ( $suite->testExists( "${structureTest}::testColumnDataType" ) )
					{
						$testResult = $suite->run( $result, '/testColumnDataType/' );
						$structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnDataType" );
						if ( $structurePassed )
						{
							$reporter->report(	Reporter::STATUS_PASS,
												'All columns of table %s have data types compatible with the specification.',
												array( $table )	);
						
							if ( $suite->testExists( "${structureTest}::testColumnLength" ) )
							{
								$testResult = $suite->run( $result, '/testColumnLength/' );
								$structurePassed = $listener->wasSuccessful( "${structureTest}::testColumnLength" );
								if ( $structurePassed )
								{
									$reporter->report(	Reporter::STATUS_PASS,
														'All columns of table %s have lengths compatible with the specification.',
														array( $table )	);
								}
								else
								{
									$reporter->report(	Reporter::STATUS_FAILURE,
														'%d of the %d columns of table %s %s an unexpected column length.',
														array(	$listener->countNonPasses( "${structureTest}::testColumnLength" ),
																$listener->countPasses( "${structureTest}::testColumnLength" ),
																$table,
																Reporter::pluralise( "${structureTest}::testColumnLength", 'has', 'have' ) ) ) ;
								}
							}
						}
						else
						{
							$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected data type.',
								array(
									$listener->countNonPasses( "${structureTest}::testColumnDataType" ),
									$listener->countPasses( "${structureTest}::testColumnDataType" ),
									$table,
									Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnDataType" ), "has", "have" )
								) ) ;
							$reporter->report( Reporter::STATUS_SKIPPED, 'column length tests, as the data types do not match what was expected.', null );
						}
					}
					
					if ( RUN_MODE !== 'student' )
					{
						if ( $suite->testExists( "${structureTest}::testColumnNullability" ) )
						{
							$testResult = $suite->run( $result, '/testColumnNullability/' );
							if ( $listener->wasSuccessful( "${structureTest}::testColumnNullability" ) )
							{
								$reporter->report( Reporter::STATUS_PASS, 'All columns of table %s have the expected nullability.', array( $table ) );
							}
							else
							{
								$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d columns of table %s %s an unexpected nullability.',
									array(
										$listener->countNonPasses( "${structureTest}::testColumnNullability" ),
										$listener->countPasses( "${structureTest}::testColumnNullability" ),
										$table,
										Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnNullability" ), "has", "have" )
									) ) ;
							}
						}
					}
				}
				else
				{
					$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected columns of table %s %s either missing or misnamed.',
						array(
							$listener->countNonPasses( "${structureTest}::testColumnExists" ),
							$listener->countPasses( "${structureTest}::testColumnExists" ),
							$table,
							Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testColumnExists" ), 'is', 'are' )
						) ) ;
					$reporter->report( Reporter::STATUS_SKIPPED, 'data type, length and nullability tests as they will include spurious errors.', null );
				}
			}
			
			if ( RUN_MODE !== 'student' )
			{
				// Not critical to data testing. Need to run both PK tests in one pass as the columns test depends on the existence test.
				if ( $suite->testExists( 'testPKExists' ) )
				{
					$testResult = $suite->run( $result, '/testPK.*/' );
					if ( $listener->wasSuccessful( 'testPKExists' ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s exists.', array( $table ) );
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s missing.', array( $table ) );
					}
				}
				if ( $suite->testExists( 'testPKColumns' ) )
				{
					if ( $listener->wasSuccessful( 'testPKColumns' ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'Primary key of table %s includes (only) the expected columns.', array( $table ) );
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, 'Primary key of table %s does not include (only) the expected columns.', array( $table ) );
					}
				}
				
				// Not critical to data testing.
				if ( $suite->testExists( "${structureTest}::testFKsExist" ) )
				{
					$testResult = $suite->run( $result, '/testFKsExist/' );
					if ( $listener->wasSuccessful( "${structureTest}::testFKsExist" ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'All expected foreign keys for table %s exist.', array( $table ) );
						
						if ( $suite->testExists( "${structureTest}::testFKColumns" ) )
						{
							$testResult = $suite->run( $result, '/testFKColumns/' );
							if ( $listener->wasSuccessful( "${structureTest}::testFKColumns" ) )
							{
								$reporter->report( Reporter::STATUS_PASS, 'All foreign keys for table %s include (only) the expected columns.', array( $table ) );
							}
							else
							{
								$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d foreign keys for table %s %s not include (only) the expected columns.', 
									array(
										$listener->countNonPasses( "${structureTest}::testFKColumns" ),
										$listener->countPasses( "${structureTest}::testFKColumns" ),
										$table,
										Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKColumns" ), 'does', 'do' )
									) );
							}
						}
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, '%d of the %d expected foreign keys for table %s %s missing.', 
							array(
								$listener->countNonPasses( "${structureTest}::testFKsExist" ),
								$listener->countPasses( "${structureTest}::testFKsExist" ),
								$table,
								Reporter::pluralise( $listener->countNonPasses( "${structureTest}::testFKsExist" ), 'is', 'are' )
							) );
						
						$reporter->report( Reporter::STATUS_SKIPPED, 'testing expected columns of FKs to avoid spurious errors' );
					}
				}
				
				// Not critical to data testing.
				if ( $suite->testExists( "${structureTest}::testConstraintsNamed" ) )
				{
					$testResult = $suite->run( $result, '/testConstraintsNamed/' );
					if ( $listener->wasSuccessful( "${structureTest}::testConstraintsNamed" ) )
					{
						$reporter->report( Reporter::STATUS_PASS, 'All constraints of table %s that should be are explicitly named.', array( $table ) );
					}
					else
					{
						$reporter->report( Reporter::STATUS_FAILURE, 'Some constraints of table %s are not explicitly named that should be.', array( $table ) );
					}
				}
			}
		}
	}
	
	if ( RUN_MODE !== 'student' )
	{
		$reporter->report( Reporter::STATUS_NOTE, 'Testing constraints of table %s.', array( $table ) );
		
		/*
			If the table or required columns are missing or misnamed, we need to skip the data testing entirely, as the INSERTs will just error out. We can't incorporate this into the if above, because we're using a completely different test suite.
		*/
		if ( $structurePassed )
		{
			$suite = new Searchable_TestSuite( $dataTest );
			
			if ( $suite->testExists( "${dataTest}::testColumnLegalValue" ) )
			{
				$testResult = $suite->run( $result, '/testColumnLegalValue/' );
				if ( $listener->wasSuccessful( "${dataTest}::testColumnLegalValue" ) )
				{
					$reporter->report( Reporter::STATUS_PASS, 'All %d legal values tested were accepted.', 
						array( $listener->countTests( "${dataTest}::testColumnLegalValue" ) ) );
				}
			}
		
			if ( $suite->testExists( "${dataTest}::testColumnIllegalValueExplicit" ) )
			{
				$testResult = $suite->run( $result, '/testColumnIllegalValueExplicit/' );
				if ( $listener->wasSuccessful( "${dataTest}::testColumnIllegalValueExplicit" ) )
				{
					$reporter->report( Reporter::STATUS_PASS, 'All %d illegal values tested were rejected by a CHECK constraint.', 
						array( $listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ) ) );
				}
				else
				{
					$checkFails = $listener->countFails( "${dataTest}::testColumnIllegalValueExplicit" );
					$reporter->report( Reporter::STATUS_WARNING, '%d of %d illegal values tested %s not rejected by a CHECK constraint.',
						array(
							$checkFails,
							$listener->countTests( "${dataTest}::testColumnIllegalValueExplicit" ),
							Reporter::pluralise( $checkFails, 'was', 'were' )
						) ) ;
					$reporter->report( Reporter::STATUS_WARNING, 'Checking values against column length...', null );
					
					if ( $suite->testExists( "${dataTest}::testColumnIllegalValueImplicit" ) )
					{
						/*
							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( "${dataTest}::testColumnIllegalValueImplicit" );
						$reporter->report( Reporter::STATUS_PASS, '%d of %d illegal values tested %s rejected by exceeding the column length.',
							array(
								$implicitPasses,
								$listener->countTests( "${dataTest}::testColumnIllegalValueImplicit" ),
								Reporter::pluralise( $implicitPasses, 'was', 'were' )
							) ) ;
						
						// 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.
							*/
							$reporter->report( Reporter::STATUS_FAILURE, '%d illegal values %s rejected in both tests—check for something unusual.',
								array(
									$checkFails - $implicitPasses,
									Reporter::pluralise( $checkFails - $implicitPasses, 'was', 'were' )
								) ) ;
						}
						else
						{
							$reporter->report( Reporter::STATUS_NOTE, 'This is OK, but not necessarily safe, as the column length may change in future.', null );
						}
					}
					else
					{
						$reporter->report( Reporter::STATUS_SKIPPED, 'testColumnIllegalValueImplicit() because it is missing.', null );
					}
				}
			}
		}
		else
		{
			$reporter->report( Reporter::STATUS_SKIPPED, 'data tests, as failures in the structure testing mean that they may not work.', null );
		}
	}
}

$reporter->hr();
?>

Show line notes below