• Made verbosity comparisons more explicit. • Made Reporter->report() an abstract method; subclasses must now implement output themselves. • Switched to explicitly writing to output streams for each subclass rather than just using print or echo. This is because CLI and HTML use different output streams anyway (STDOUT and php://output, respectively).

nigel.stanger / sqlmarker

Browse code • Made verbosity comparisons more explicit. • Made Reporter->report() an abstract method; subclasses must now implement output themselves. • Switched to explicitly writing to output streams for each subclass rather than just using print or echo. This is because CLI and HTML use different output streams anyway (STDOUT and php://output, respectively). master
1 parent 5de06e2 commit c57571dc2d79a8fe2d80066c6e93ffe7da5f94de Nigel Stanger authored on 12 Mar 2014

Browse code

• Made verbosity comparisons more explicit.

• Made Reporter->report() an abstract method; subclasses must now implement output themselves.
• Switched to explicitly writing to output streams for each subclass rather than just using print or echo. This is because CLI and HTML use different output streams anyway (STDOUT and php://output, respectively).

master

1 parent 5de06e2 commit c57571dc2d79a8fe2d80066c6e93ffe7da5f94de

Nigel Stanger authored on 12 Mar 2014

Patch

Showing 4 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; } /** * $statusText 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 / abstract public function report( $statusText, $reportText, $printfArguments = null ); 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 ( abs( $count ) !== 1 ) ? $manyText : $oneText; } public function setVerbosity( $newVerbosity ) { $this->verbosity = $newVerbosity; } public function getVerbosity() { return $this->verbosity; } /* * $statusText 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 = null ) { if ( $this->verbosity ) vprintf( $statusText . $reportText . "\n", $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;
	}
	
	/**
	 *	$statusText 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
	 */
	abstract public function report( $statusText, $reportText, $printfArguments = null );
	
	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 ( abs( $count ) !== 1 ) ? $manyText : $oneText;
	}
	
	public function setVerbosity( $newVerbosity )
	{
		$this->verbosity = $newVerbosity;
	}
	
	public function getVerbosity()
	{
		return $this->verbosity;
	}
	
	/**
	 *	$statusText 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 = null )
	{
		if ( $this->verbosity ) vprintf( $statusText . $reportText . "\n", $printfArguments );
	}
	
	abstract public function hr();
}

Ignore Space Show notes View Unit_testing/Reporter/ANSIReporter.php
<?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 = null ) { if ( $this->getVerbosity() > 0 ) { $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; } fwrite( STDOUT, $this->ANSI->setColor( $fg, $bg ) ); parent::report( $status, $reportText . $this->ANSI->resetANSI(), $printfArguments ); } } } ?> <?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 = null ) { 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

<?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 = null )
	{
		if ( $this->getVerbosity() > 0 )
		{
			$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;
			}
			
			fwrite( STDOUT, $this->ANSI->setColor( $fg, $bg ) );
			
			parent::report( $status, $reportText . $this->ANSI->resetANSI(), $printfArguments );
		}
	}
}

<?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 = null )
	{
		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/HTMLReporter.php
<?php require_once 'Reporter.php'; class HTMLReporter extends Reporter { private $output_stream; function __construct( $verbosity ) { $this->output_stream = fopen( 'php://output', 'w' ); parent::__construct( $verbosity ); } public function report( $status, $reportText, $printfArguments = null ) { if ( $this->getVerbosity() > 0 ) { $statusText = '<p class="blackboard'; switch ( $status ) { case Reporter::STATUS_PASS: $statusText .= ' greenbg result"><span style="font-size: large">✔</span> '; break; case Reporter::STATUS_SKIPPED: $statusText .= '" style="padding-left: 2em;"><strong style="font-size: large">#</strong> '; break; case Reporter::STATUS_INCOMPLETE: $statusText .= ' yellow-ou result"><strong style="font-size: large">%</strong> '; break; case Reporter::STATUS_FAILURE: $statusText .= ' red-ou result""><span style="font-size: large">✘</span> '; break; case Reporter::STATUS_ERROR: $statusText .= ' red-ou result"><span style="font-size: large">☠</span> '; break; case Reporter::STATUS_WARNING: $statusText .= ' yellow-ou result"><span style="font-size: large">⚠</span> '; break; case Reporter::STATUS_NOTE: $statusText .= ' grey-light result">'; break; default: case Reporter::STATUS_TEST: $statusText .= ' style="font-weight: bold;">'; break; default: $statusText .= ' yellow-ou result"><strong style="font-size: large">?</strong> '; break; } if ( $this->getVerbosity() > 1 ) $statusText .= "<strong>" . ucfirst( strtolower( $status ) ) . ':</strong> '; $message = vsprintf( $statusText . $reportText . "</span></p>\n", $printfArguments ); fwrite( $this->output_stream, $message ); } } public function hr() { echo "<hr />\n"; } } ?> <?php require_once 'Reporter.php'; class HTMLReporter extends Reporter { public function report( $status, $reportText, $printfArguments = null ) { if ( $this->getVerbosity() ) { $statusText = '<p class="blackboard'; switch ( $status ) { case Reporter::STATUS_PASS: $statusText .= ' greenbg result"><span style="font-size: large">✔</span> '; break; case Reporter::STATUS_SKIPPED: $statusText .= '" style="padding-left: 2em;"><strong style="font-size: large">#</strong> '; break; case Reporter::STATUS_INCOMPLETE: $statusText .= ' yellow-ou result"><strong style="font-size: large">%</strong> '; break; case Reporter::STATUS_FAILURE: $statusText .= ' red-ou result""><span style="font-size: large">✘</span> '; break; case Reporter::STATUS_ERROR: $statusText .= ' red-ou result"><span style="font-size: large">☠</span> '; break; case Reporter::STATUS_WARNING: $statusText .= ' yellow-ou result"><span style="font-size: large">⚠</span> '; break; case Reporter::STATUS_NOTE: $statusText .= ' grey-light result">'; break; default: case Reporter::STATUS_TEST: $statusText .= ' style="font-weight: bold;">'; break; default: $statusText .= ' yellow-ou result"><strong style="font-size: large">?</strong> '; break; } if ( $this->getVerbosity() > 1 ) $statusText .= "<strong>" . ucfirst( strtolower( $status ) ) . ':</strong> '; parent::report( $statusText, $reportText . "</span></p>\n", $printfArguments ); } } public function hr() { echo "<hr />\n"; } } ?>

Ignore Space Show notes View

Unit_testing/Reporter/HTMLReporter.php

<?php
require_once 'Reporter.php';

class HTMLReporter extends Reporter
{
    private $output_stream;

<?php
require_once 'Reporter.php';

class HTMLReporter extends Reporter
{
	public function report( $status, $reportText, $printfArguments = null )
	{
		if ( $this->getVerbosity() )
		{
			$statusText = '✔ ';
					break;
				case Reporter::STATUS_SKIPPED:
					$statusText .= '" style="padding-left: 2em;"># ';
					break;
				case Reporter::STATUS_INCOMPLETE:
					$statusText .= ' yellow-ou result">% ';
					break;
				case Reporter::STATUS_FAILURE:
					$statusText .= ' red-ou result"">✘ ';
					break;
				case Reporter::STATUS_ERROR:
					$statusText .= ' red-ou result">☠ ';
					break;
				case Reporter::STATUS_WARNING:
					$statusText .= ' yellow-ou result">⚠ ';
					break;
				case Reporter::STATUS_NOTE:
					$statusText .= ' grey-light result">';
					break;
				default:
				case Reporter::STATUS_TEST:
					$statusText .= ' style="font-weight: bold;">';
					break;
				default:
					$statusText .= ' yellow-ou result">? ';
					break;
			}
			if ( $this->getVerbosity() > 1 ) $statusText .= "" . ucfirst( strtolower( $status ) ) . ': ';
			
			parent::report( $statusText, $reportText . "\n", $printfArguments );
		}
	}
	
	public function hr()
	{
		echo "<hr />\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 = null ) { if ( $this->getVerbosity() > 0 ) { $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 . ': '; $output = vsprintf( $statusText . $reportText . "\n", $printfArguments ); fwrite( STDOUT, $output ); } } public function hr() { echo "------------------------------------------------------------\n"; } } ?> <?php require_once 'Reporter.php'; class TextReporter extends Reporter { public function report ( $status, $reportText, $printfArguments = null ) { 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"; } } ?>

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 = null )
	{
		if ( $this->getVerbosity() > 0 )
		{
			$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 . ': ';
			
		    $output = vsprintf( $statusText . $reportText . "\n", $printfArguments );
		    fwrite( STDOUT, $output );
		}
	}
	
	public function hr()
	{
		echo "------------------------------------------------------------\n";
	}
}

<?php
require_once 'Reporter.php';

class TextReporter extends Reporter
{
	public function report ( $status, $reportText, $printfArguments = null )
	{
		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";
	}
}

Show line notes below