From 8ff245104b61af10ad35947aac283cb119b63d44 Mon Sep 17 00:00:00 2001
From: Robert Sesek <rsesek@bluestatic.org>
Date: Sat, 28 Jul 2007 17:37:32 +0000
Subject: [PATCH] Starting to migrate from SimpleTest to PHPUnit.

* docs/UnitTestReport.php: Renamed to SimpleTestReporter
* docs/UnitTest/AllTests.php: Changing the path to the test reporter, see above.
* docs/PHPUnitTestReporter.php: Added
---
 docs/PHPUnitTestReporter.php                  | 546 ++++++++++++++++++
 ...tTestReport.php => SimpleTestReporter.php} |   0
 docs/UnitTest/AllTests.php                    |   2 +-
 3 files changed, 547 insertions(+), 1 deletion(-)
 create mode 100644 docs/PHPUnitTestReporter.php
 rename docs/{UnitTestReport.php => SimpleTestReporter.php} (100%)

diff --git a/docs/PHPUnitTestReporter.php b/docs/PHPUnitTestReporter.php
new file mode 100644
index 0000000..b713fd5
--- /dev/null
+++ b/docs/PHPUnitTestReporter.php
@@ -0,0 +1,546 @@
+<?php
+/*=====================================================================*\
+|| ###################################################################
+|| # PHPUnit2 Web Report [#]version[#]
+|| # Copyright ©2002-[#]year[#] Iris Studios, Inc.
+|| #
+|| # This program is free software; you can redistribute it and/or modify
+|| # it under the terms of the GNU General Public License as published by
+|| # the Free Software Foundation; version [#]gpl[#] of the License.
+|| #
+|| # This program is distributed in the hope that it will be useful, but
+|| # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+|| # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+|| # more details.
+|| #
+|| # You should have received a copy of the GNU General Public License along
+|| # with this program; if not, write to the Free Software Foundation, Inc.,
+|| # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+|| ###################################################################
+\*=====================================================================*/
+
+require_once('PHPUnit2/Framework/TestListener.php');
+
+/**
+* PHPUnit2 HTML Output Generator Listener
+*
+* This class is used to to run PHPUnit2 tests normally and generate an
+* HTML report at the end, which details all the tests. To use this,
+* you need to attach this listener:
+*
+* <code>$result = new PHPUnit2_Framework_TestResult;
+* $result->addListener(new ISI_PHPUnit2_Output_HTML_Listener);
+* $suite->run($result);</code>
+*
+* @author		Iris Studios, Inc.
+* @copyright	Copyright ©2002 - [#]year[#], Iris Studios, Inc.
+* @version		$Revision$
+* 
+*/
+class ISI_PHPUnit2_Output_HTML_Listener implements PHPUnit2_Framework_TestListener
+{
+	/**
+	* A successful test
+	* @var	integer
+	*/
+	const TEST_SUCCESS = 1;
+	
+	/**
+	* An incomplete test
+	* @var	integer
+	*/
+	const TEST_INCOMPLETE = 2;
+	
+	/**
+	* A failed test
+	* @var	integer
+	*/
+	const TEST_FAIL = 3;
+	
+	/**
+	* An array of all the tests run in a given suite
+	* @var	array
+	*/
+	protected $tests = array();
+	
+	/**
+	* An array of arrays of all the errors in a given failed test in a suite
+	* @var	array
+	*/
+	protected $errors = array();
+	
+	/**
+	* An array of all the incomplete test messages for a test in a suite
+	* @var	array
+	*/
+	protected $incompletes = array();
+	
+	/**
+	* Statistics for a given test suite
+	* @var	array
+	*/
+	protected $stats = array();
+	
+	/**
+	* The name of the currently-running test suite
+	* @var	string
+	*/
+	private $currentSuite;
+	
+	/**
+	* The name of the currently-running individual test
+	* @var	string
+	*/
+	private $currentTest;
+	
+	// ###################################################################
+	/**
+	* A test errored out
+	*
+	* @param	object	PHPUnit2_Framework_Test
+	* @param	except	Thrown execption
+	*/
+	public function addError(PHPUnit2_Framework_Test $test, Exception $e)
+	{
+		$this->errors[ $this->currentSuite ][ $this->currentTest ][] = new ISI_Private_Exception($e);
+	}
+	
+	// ###################################################################
+	/**
+	* A test failed
+	*
+	* @param	object	PHPUnit2_Framework_Test
+	* @param	object	PHPUnit2_Framework_AssertionFailedError
+	*/
+	public function addFailure(PHPUnit2_Framework_Test $test, PHPUnit2_Framework_AssertionFailedError $e)
+	{
+		$this->errors[ $this->currentSuite ][ $this->currentTest ][] = new ISI_Private_Exception($e);
+		$this->tests[ $this->currentSuite ][ $this->currentTest ] = self::TEST_FAIL;
+		$this->stats[ $this->currentSuite ]['fail']++;
+	}
+	
+	// ###################################################################
+	/**
+	* A test reported being an incomplete implementation
+	*
+	* @param	object	PHPUnit2_Framework_Test
+	* @param	except	The thrown exception notice
+	*/
+	public function addIncompleteTest(PHPUnit2_Framework_Test $test, Exception $e)
+	{
+		$this->incompletes[ $this->currentSuite ][ $this->currentTest ] = new ISI_Private_Exception($e);
+		$this->tests[ $this->currentSuite ][ $this->currentTest ] = self::TEST_INCOMPLETE;
+		$this->stats[ $this->currentSuite ]['incomplete']++;
+	}
+	
+	// ###################################################################
+	/**
+	* Start test suite
+	*
+	* @param	object	A PHPUnit2_Framework_TestSuite
+	*/
+	public function startTestSuite(PHPUnit2_Framework_TestSuite $suite)
+	{
+		$this->currentSuite = $suite->getName();
+		if ($this->currentSuite == '')
+		{
+			return;
+		}
+		
+		$this->tests[ $this->currentSuite ] = array();
+		$this->stats[ $this->currentSuite ] = array('total' => 0, 'fail' => 0, 'incomplete' => 0);
+	}
+	
+	// ###################################################################
+	/**
+	* Test suite ended
+	*
+	* @param	object	PHPUnit2_Framework_TestSuite
+	*/
+	public function endTestSuite(PHPUnit2_Framework_TestSuite $suite)
+	{
+		$this->currentSuite = null;
+	}
+	
+	// ###################################################################
+	/**
+	* An individual test started
+	*
+	* @param	object	The PHPUnit2_Framework_Test
+	*/
+	public function startTest(PHPUnit2_Framework_Test $test)
+	{
+		$this->currentTest = $test->getName();
+		if ($this->currentTest == '')
+		{
+			return;
+		}
+		
+		$this->tests[ $this->currentSuite ][ $this->currentTest ] = self::TEST_SUCCESS;
+		$this->stats[ $this->currentSuite ]['total']++;
+	}
+	
+	// ###################################################################
+	/**
+	* An individual test ended
+	*
+	* @param	object	The PHPUnit2_Framework_Test
+	*/
+	public function endTest(PHPUnit2_Framework_Test $test)
+	{
+		$this->currentTest = null;
+	}
+	
+	// ###################################################################
+	/**
+	* Destructor: create the HTML output
+	*/
+	public function __destruct()
+	{
+		$stats = array('total' => 0, 'incomplete' => 0, 'fail' => 0, 'success' => 0);
+		foreach ($this->stats AS $statGroup)
+		{
+			foreach ($statGroup AS $statType => $count)
+			{
+				$stats["$statType"] += $count;
+			}
+		}
+		$stats['success'] = $stats['total'] - ($stats['incomplete'] + $stats['fail']);
+		
+		$output = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+	<title>Unit Test Results</title>
+	
+	<style type="text/css">
+	<!--
+		
+		body
+		{
+			font-size: 12px;
+			font-family: "Trebuchet MS", Verdana, Helvetica, sans-serif;
+		}
+	
+		.suite
+		{
+			background-color: rgb(255, 255, 255);
+			
+			border-color: rgb(222, 222, 222);
+			border-style: solid;
+			border-width: 1px;
+		}
+		
+		.suiteHead
+		{
+			background-color: rgb(222, 222, 222);
+			
+			font-weight: bold;
+			
+			margin: 2px;
+			padding: 3px;
+		}
+		
+		.testGroup
+		{
+			padding: 4px;
+		}
+		
+		.testIncomplete
+		{
+			border-color: rgb(222, 230, 255);
+			border-style: dashed;
+			border-width: 1px;
+			
+			margin-bottom: 5px;
+		}
+		
+		.testIncompleteHead
+		{
+			background-color: rgb(222, 230, 255);
+			
+			margin: 1px;
+			padding: 2px;
+		}
+		
+		.blueText
+		{
+			color: rgb(111, 133, 255);
+		}
+		
+		.testSuccess
+		{
+			border-color: rgb(216, 255, 216);
+			border-style: dashed;
+			border-width: 1px;
+			
+			margin-bottom: 5px;
+		}
+		
+		.testSuccessHead
+		{
+			background-color: rgb(216, 255, 216);
+			
+			margin: 1px;
+			padding: 2px;
+		}
+		
+		.greenText
+		{
+			color: rgb(76, 168, 78);
+		}
+		
+		.testFail
+		{
+			border-color: rgb(255, 226, 229);
+			border-style: dashed;
+			border-width: 1px;
+			
+			margin-bottom: 5px;
+		}
+		
+		.testFailHead
+		{
+			background-color: rgb(255, 226, 229);
+			
+			margin: 1px;
+			padding: 2px;
+		}
+		
+		.redText
+		{
+			color: rgb(168, 65, 63);
+		}
+		
+		.textPadding
+		{
+			padding: 3px;
+		}
+		
+		.message
+		{
+			margin-bottom: 4px;
+		}
+		
+		.messageLast
+		{
+			margin-bottom: 0px;
+		}
+		
+		.location
+		{
+			margin-left: 20px;
+			
+			font-style: italic;
+		}
+			
+	//-->
+	</style>
+</head>
+<body>
+
+<h1>Unit Test Results</h1>
+
+<div>
+	<div>The following is a report of how each unit test performed. If any errors or exceptions were thrown, they have been recorded below. Tests have been broken down into their test suite groups. Your overall statistics are here:</div>
+	
+	<br />
+	
+	<div>Total Tests: <strong>' . $stats['total'] . '</strong></div>
+	<div>Number Success: <strong class="greenText">' . $stats['success'] . '</strong></div>
+	<div>Number Fail: <strong class="redText">' . $stats['fail'] . '</strong></div>
+	<div>Number Incomplete: <strong class="blueText">' . $stats['incomplete'] . '</strong></div>
+	
+	<br />
+	
+	<div><em>Total Success Rate: <strong class="' . ($stats['success'] == $stats['total'] ? 'green' : 'red') . 'Text">' . round(100 * ($stats['success'] / $stats['total']), 1) . '%</strong></em></div>
+</div>
+
+<br />
+
+';
+		
+		foreach ($this->tests AS $suite => $tests)
+		{
+			$successPercent = round(100 * (($this->stats["$suite"]['total'] - ($this->stats["$suite"]['fail'] + $this->stats["$suite"]['incomplete'])) / $this->stats["$suite"]['total']), 1);
+			
+			$output .= '<div class="suite">';
+			$output .= "\n\t" . '<div class="suiteHead">';
+			$output .= "\n\t\t" . '<span style="float: right">' . $this->stats["$suite"]['total'] . ' Tests, ' . $successPercent . '% Success' . '</span>';
+			$output .= "\n\t\t" . $suite;
+			$output .= "\n\t" . '</div>';
+			$output .= "\n\t" . '<div class="testGroup">';
+			foreach ($tests AS $name => $statusCode)
+			{				
+				switch ($statusCode)
+				{
+					case self::TEST_SUCCESS:
+						$cssName = 'Success';
+						$cssColor = 'green';
+						
+						$info = '';
+					break;
+						
+					case self::TEST_INCOMPLETE:
+						$cssName = 'Incomplete';
+						$cssColor = 'blue';
+						
+						$info = $this->formatInfo($this->incompletes["$suite"]["$name"]);
+					break;
+						
+					case self::TEST_FAIL:
+						$cssName = 'Fail';
+						$cssColor = 'red';
+						
+						$info = $this->formatInfo($this->errors["$suite"]["$name"]);
+					break;
+				}
+				
+				$output .= "\n\t\t" . '<div class="test' . $cssName . ' ' . $cssColor . 'Text' . ($info ? ' negateMargin' : '') . '">';
+				$output .= "\n\t\t\t" . '<div class="test' . $cssName . 'Head">' . $name . '</div>';
+				
+				if ($info)
+				{
+					$output .= "\n\t\t\t" . '<div class="textPadding">';
+					$output .= $info;
+					$output .= "\n\t\t\t" . '</div class="textPadding">';
+				}
+				
+				$output .= "\n\t\t" . '</div>';
+			}
+			$output .= "\n\t" . '</div>';
+			$output .= "\n" . '</div>';
+			$output .= "\n\n" . '<br />' . "\n\n";
+		}
+		
+		$output .= '
+</body>
+</html>';
+		
+		file_put_contents('./UnitTestReport.html', $output);
+	}
+	
+	// ###################################################################
+	/**
+	* Formats an error array into a bulleted list
+	*
+	* @param	mixed	Error/information list
+	*
+	* @return	string	Formatted HTML
+	*/
+	private function formatInfo($list)
+	{
+		if (!is_array($list))
+		{
+			$list = array($list);	
+		}
+		
+		$count = sizeof($list);
+		foreach ($list AS $exc)
+		{
+			$i++;
+			
+			if ($exc->getMessage() != '')
+			{
+				$output = "\n\t\t\t\t" . '<div class="message' . ($count == $i ? ' messageLast' : '') . '">';
+				$output .= "\n\t\t\t\t\t" . '<div>&bull; ' . htmlspecialchars($exc->getMessage()) . '</div>';
+			}
+			
+			$output .= "\n\t\t\t\t\t" . '<div class="location">in ' . $exc->getPath() . ' at line ' . $exc->getLine() . '</div>';
+			
+			if ($exc->getMessage() != '')
+			{
+				$output .= "\n\t\t\t\t" . '</div>';
+			}
+		}
+		
+		return $output;
+	}
+}
+
+/**
+* Iris Studios Private Exception Handler
+*
+* This class is just a form of an exception that ignores the stack trace
+* because it's too long.
+*
+* @author		Iris Studios, Inc.
+* @copyright	Copyright ©2002 - [#]year[#], Iris Studios, Inc.
+* @version		$Revision$
+* 
+*/
+class ISI_Private_Exception
+{
+	/**
+	* Exception context message
+	* @var	string
+	*/
+	private $message = '';
+	
+	/**
+	* File path
+	* @var	string
+	*/
+	private $path = '';
+	
+	/**
+	* Line number of the exception
+	* @var	integer
+	*/
+	private $line = 0;
+	
+	// ###################################################################
+	/**
+	* Constructor: accept exception
+	*
+	* @param	except	A given exception
+	*/
+	public function __construct(Exception $e)
+	{
+		$this->message = $e->getMessage();
+		$this->path = $e->getFile();
+		$this->line = $e->getLine();
+	}
+	
+	// ###################################################################
+	/**
+	* Returns the context message
+	*
+	* @return	string	Context message
+	*/
+	public function getMessage()
+	{
+		return $this->message;
+	}
+	
+	// ###################################################################
+	/**
+	* Returns the file path
+	*
+	* @return	string	File path
+	*/
+	public function getPath()
+	{
+		return $this->path;
+	}
+	
+	// ###################################################################
+	/**
+	* Returns the line number
+	*
+	* @return	integer	Line number
+	*/
+	public function getLine()
+	{
+		return $this->line;
+	}
+}
+
+/*=====================================================================*\
+|| ###################################################################
+|| # $HeadURL$
+|| # $Id$
+|| ###################################################################
+\*=====================================================================*/
+?>
\ No newline at end of file
diff --git a/docs/UnitTestReport.php b/docs/SimpleTestReporter.php
similarity index 100%
rename from docs/UnitTestReport.php
rename to docs/SimpleTestReporter.php
diff --git a/docs/UnitTest/AllTests.php b/docs/UnitTest/AllTests.php
index 66d7a82..22e5764 100644
--- a/docs/UnitTest/AllTests.php
+++ b/docs/UnitTest/AllTests.php
@@ -4,7 +4,7 @@ set_include_path(get_include_path() . ':/Server/htdocs');
 
 // load the toolkit
 require_once('simpletest/unit_tester.php');
-require_once('../UnitTestReport.php');
+require_once('../SimpleTestReporter.php');
 
 $test = new GroupTest('All Tests');
 
-- 
2.22.5