Nette\Test: added new simple unit test framework

Tester/NetteTestCase.php

@@ -0,0 +1,307 @@
+<?php
+
+/**
+ * Nette Framework
+ *
+ * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
+ *
+ * This source file is subject to the "Nette license" that is bundled
+ * with this package in the file license.txt.
+ *
+ * For more information please see http://nettephp.com
+ *
+ * @copyright  Copyright (c) 2004, 2009 David Grudl
+ * @license    http://nettephp.com/license  Nette license
+ * @link       http://nettephp.com
+ * @category   Nette
+ * @package    Nette\Test
+ */
+
+
+
+/**
+ * Single test case.
+ *
+ * @author     David Grudl
+ * @package    Nette\Test
+ */
+class NetteTestCase
+{
+	/** @var string  test file */
+	private $file;
+
+	/** @var string  PHP-CGI command line */
+	private $cmdLine;
+
+	/** @var array   test file multiparts */
+	private $sections;
+
+	/** @var string  test output */
+	private $output;
+
+	/** @var string  output headers in raw format */
+	private $headers;
+
+
+
+	/**
+	 * @param  string  test file name
+	 * @param  string  PHP-CGI command line
+	 * @return void
+	 */
+	public function __construct($testFile, $cmdLine)
+	{
+		$this->file = (string) $testFile;
+		$this->cmdLine = (string) $cmdLine;
+		$this->sections = self::parseSections($this->file);
+	}
+
+
+
+	/**
+	 * Runs single test.
+	 * @return void
+	 */
+	public function run()
+	{
+		$this->execute();
+		$tests = 0;
+
+		// compare output
+		$expectedOutput = $this->getExpectedOutput();
+		if ($expectedOutput !== NULL) {
+			$tests++;
+			if (!$this->compare($this->output, $expectedOutput)) {
+				throw new NetteTestCaseException("Output doesn't match.");
+			}
+		}
+
+		// compare headers
+		$expectedHeaders = $this->getExpectedHeaders();
+		if ($expectedHeaders !== NULL) {
+			$tests++;
+			$headers = array_change_key_case(self::parseLines($this->headers, ':'), CASE_LOWER);
+			$expectedHeaders = array_change_key_case(self::parseLines($expectedHeaders, ':'), CASE_LOWER);
+			foreach ($expectedHeaders as $name => $header) {
+				if (!isset($headers[$name])) {
+					throw new NetteTestCaseException("Missing header '$name'.");
+
+				} elseif (!$this->compare($headers[$name], $header)) {
+					throw new NetteTestCaseException("Header '$name' doesn't match.");
+				}
+			}
+		}
+
+		if (!$tests) {
+			throw new NetteTestCaseException("Missing EXPECT and/or EXPECTHEADERS section.");
+		}
+	}
+
+
+
+	/**
+	 * Execute test.
+	 * @return array
+	 */
+	private function execute()
+	{
+		$this->headers = $this->output = NULL;
+
+		$tempFile = tempnam('', 'tmp');
+		if (!$tempFile) {
+			throw new Exception("Unable to create temporary file.");
+		}
+
+		chdir(dirname($this->file));
+		$command = str_replace('%input', escapeshellarg($this->file), $this->cmdLine);
+		$command = str_replace('%output', escapeshellarg($tempFile), $command);
+		exec($command, $foo, $res);
+		if ($res !== 0 && $res !== 255) {
+			throw new Exception("Unable to execute '$command'.");
+		}
+
+		$this->output = file_get_contents($tempFile);
+		unlink($tempFile);
+
+		list($this->headers, $this->output) = explode("\r\n\r\n", $this->output, 2); // CGI
+		$this->output = str_replace("\n", PHP_EOL, str_replace("\r\n", "\n", $this->output));  // normalize EOL
+	}
+
+
+
+	/**
+	 * Returns test file section.
+	 * @return string
+	 */
+	public function getSection($name)
+	{
+		return isset($this->sections[$name]) ? $this->sections[$name] : NULL;
+	}
+
+
+
+	/**
+	 * Returns test name.
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->sections['options']['name'];
+	}
+
+
+
+	/**
+	 * Returns test output.
+	 * @return string
+	 */
+	public function getOutput()
+	{
+		return $this->output;
+	}
+
+
+
+	/**
+	 * Returns output headers.
+	 * @return string
+	 */
+	public function getHeaders()
+	{
+		return $this->headers;
+	}
+
+
+
+	/**
+	 * Returns expected output.
+	 * @return string
+	 */
+	public function getExpectedOutput()
+	{
+		if (isset($this->sections['expect'])) {
+			return $this->sections['expect'];
+
+		} elseif (is_file($expFile = str_replace('.phpt', '', $this->file) . '.expect')) {
+			return file_get_contents($expFile);
+
+		} else {
+			return NULL;
+		}
+	}
+
+
+
+	/**
+	 * Returns expected headers.
+	 * @return string
+	 */
+	public function getExpectedHeaders()
+	{
+		return $this->getSection('expectheaders');
+	}
+
+
+
+	/********************* helpers ****************d*g**/
+
+
+
+	/**
+	 * Splits file into sections.
+	 * @param  string  file
+	 * @return array
+	 */
+	public static function parseSections($testFile)
+	{
+		$content = file_get_contents($testFile);
+		$sections = array(
+			'options' => array(),
+		);
+
+		// phpDoc
+		$phpDoc = preg_match('#^/\*\*(.*?)\*/#ms', $content, $matches) ? trim($matches[1]) : '';
+		preg_match_all('#^\s*\*\s*@(\S+)(.*)#mi', $phpDoc, $matches, PREG_SET_ORDER);
+		foreach ($matches as $match) {
+			$sections['options'][$match[1]] = isset($match[2]) ? trim($match[2]) : TRUE;
+		}
+		$sections['options']['name'] = preg_match('#^\s*\*\s*TEST:(.*)#mi', $phpDoc, $matches) ? trim($matches[1]) : $testFile;
+
+		// file parts
+		$tmp = preg_split('#^-{3,}([^ -]+)-{1,}(?:\r?\n|$)#m', $content, -1, PREG_SPLIT_DELIM_CAPTURE);
+		$i = 1;
+		while (isset($tmp[$i])) {
+			$sections[strtolower($tmp[$i])] = preg_replace('~#EOF\s*$~', '', $tmp[$i+1]); // supports #EOF;
+			$i += 2;
+		}
+		return $sections;
+	}
+
+
+
+	/**
+	 * Splits HTTP headers into array.
+	 * @param  string
+	 * @param  string
+	 * @return array
+	 */
+	public static function parseLines($raw, $separator)
+	{
+		$headers = array();
+		foreach (explode("\r\n", $raw) as $header) {
+			$a = strpos($header, $separator);
+			if ($a !== FALSE) {
+				$headers[trim(substr($header, 0, $a))] = (string) trim(substr($header, $a + 2));
+			}
+		}
+		return $headers;
+	}
+
+
+
+	/**
+	 * Compares results.
+	 * @param  string
+	 * @param  string
+	 * @return bool
+	 */
+	public static function compare($left, $right)
+	{
+		$right = strtr($right, array(
+			'%a%' => '[^\r\n]+',    // one or more of anything except the end of line characters
+			'%a?%'=> '[^\r\n]*',    // zero or more of anything except the end of line characters
+			'%A%' => '.+',          // one or more of anything including the end of line characters
+			'%A?%'=> '.*',          // zero or more of anything including the end of line characters
+			'%s%' => '[\t ]+',      // one or more white space characters except the end of line characters
+			'%s?%'=> '[\t ]*',      // zero or more white space characters except the end of line characters
+			'%S%' => '\S+',         // one or more of characters except the white space
+			'%S?%'=> '\S*',         // zero or more of characters except the white space
+			'%c%' => '[^\r\n]',     // a single character of any sort (except the end of line)
+			'%d%' => '[0-9]+',      // one or more digits
+			'%d?%'=> '[0-9]*',      // zero or more digits
+			'%i%' => '[+-]?[0-9]+', // signed integer value
+			'%f%' => '[+-]?\.?\d+\.?\d*(?:[Ee][+-]?\d+)?', // floating point number
+			'%[^' => '[^',          // reg-exp
+			'%['  => '[',           // reg-exp
+			']%'  => ']+',          // reg-exp
+
+			'.' => '\.', '\\' => '\\\\', '+' => '\+', '*' => '\*', '?' => '\?', '[' => '\[', '^' => '\^', ']' => '\]', '$' => '\$', '(' => '\(', ')' => '\)', // preg quote
+			'{' => '\{', '}' => '\}', '=' => '\=', '!' => '\!', '>' => '\>', '<' => '\<', '|' => '\|', ':' => '\:', '-' => '\-', "\x00" => '\000', '#' => '\#', // preg quote
+		));
+
+		return (bool) preg_match("#^$right$#s", $left);
+	}
+
+}
+
+
+
+/**
+ * Single test exception.
+ *
+ * @author     David Grudl
+ * @package    Nette\Test
+ */
+class NetteTestCaseException extends Exception
+{
+}