330 lines
10 KiB
PHP
330 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* base include file for SimpleTest
|
|
* @package SimpleTest
|
|
* @subpackage UnitTester
|
|
* @version $Id: shell_tester.php 2011 2011-04-29 08:22:48Z pp11 $
|
|
*/
|
|
|
|
/**#@+
|
|
* include other SimpleTest class files
|
|
*/
|
|
require_once(dirname(__FILE__) . '/test_case.php');
|
|
/**#@-*/
|
|
|
|
/**
|
|
* Wrapper for exec() functionality.
|
|
* @package SimpleTest
|
|
* @subpackage UnitTester
|
|
*/
|
|
class SimpleShell {
|
|
private $output;
|
|
|
|
/**
|
|
* Executes the shell comand and stashes the output.
|
|
* @access public
|
|
*/
|
|
function __construct() {
|
|
$this->output = false;
|
|
}
|
|
|
|
/**
|
|
* Actually runs the command. Does not trap the
|
|
* error stream output as this need PHP 4.3+.
|
|
* @param string $command The actual command line
|
|
* to run.
|
|
* @return integer Exit code.
|
|
* @access public
|
|
*/
|
|
function execute($command) {
|
|
$this->output = false;
|
|
exec($command, $this->output, $ret);
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Accessor for the last output.
|
|
* @return string Output as text.
|
|
* @access public
|
|
*/
|
|
function getOutput() {
|
|
return implode("\n", $this->output);
|
|
}
|
|
|
|
/**
|
|
* Accessor for the last output.
|
|
* @return array Output as array of lines.
|
|
* @access public
|
|
*/
|
|
function getOutputAsList() {
|
|
return $this->output;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Test case for testing of command line scripts and
|
|
* utilities. Usually scripts that are external to the
|
|
* PHP code, but support it in some way.
|
|
* @package SimpleTest
|
|
* @subpackage UnitTester
|
|
*/
|
|
class ShellTestCase extends SimpleTestCase {
|
|
private $current_shell;
|
|
private $last_status;
|
|
private $last_command;
|
|
|
|
/**
|
|
* Creates an empty test case. Should be subclassed
|
|
* with test methods for a functional test case.
|
|
* @param string $label Name of test case. Will use
|
|
* the class name if none specified.
|
|
* @access public
|
|
*/
|
|
function __construct($label = false) {
|
|
parent::__construct($label);
|
|
$this->current_shell = $this->createShell();
|
|
$this->last_status = false;
|
|
$this->last_command = '';
|
|
}
|
|
|
|
/**
|
|
* Executes a command and buffers the results.
|
|
* @param string $command Command to run.
|
|
* @return boolean True if zero exit code.
|
|
* @access public
|
|
*/
|
|
function execute($command) {
|
|
$shell = $this->getShell();
|
|
$this->last_status = $shell->execute($command);
|
|
$this->last_command = $command;
|
|
return ($this->last_status === 0);
|
|
}
|
|
|
|
/**
|
|
* Dumps the output of the last command.
|
|
* @access public
|
|
*/
|
|
function dumpOutput() {
|
|
$this->dump($this->getOutput());
|
|
}
|
|
|
|
/**
|
|
* Accessor for the last output.
|
|
* @return string Output as text.
|
|
* @access public
|
|
*/
|
|
function getOutput() {
|
|
$shell = $this->getShell();
|
|
return $shell->getOutput();
|
|
}
|
|
|
|
/**
|
|
* Accessor for the last output.
|
|
* @return array Output as array of lines.
|
|
* @access public
|
|
*/
|
|
function getOutputAsList() {
|
|
$shell = $this->getShell();
|
|
return $shell->getOutputAsList();
|
|
}
|
|
|
|
/**
|
|
* Called from within the test methods to register
|
|
* passes and failures.
|
|
* @param boolean $result Pass on true.
|
|
* @param string $message Message to display describing
|
|
* the test state.
|
|
* @return boolean True on pass
|
|
* @access public
|
|
*/
|
|
function assertTrue($result, $message = false) {
|
|
return $this->assert(new TrueExpectation(), $result, $message);
|
|
}
|
|
|
|
/**
|
|
* Will be true on false and vice versa. False
|
|
* is the PHP definition of false, so that null,
|
|
* empty strings, zero and an empty array all count
|
|
* as false.
|
|
* @param boolean $result Pass on false.
|
|
* @param string $message Message to display.
|
|
* @return boolean True on pass
|
|
* @access public
|
|
*/
|
|
function assertFalse($result, $message = '%s') {
|
|
return $this->assert(new FalseExpectation(), $result, $message);
|
|
}
|
|
|
|
/**
|
|
* Will trigger a pass if the two parameters have
|
|
* the same value only. Otherwise a fail. This
|
|
* is for testing hand extracted text, etc.
|
|
* @param mixed $first Value to compare.
|
|
* @param mixed $second Value to compare.
|
|
* @param string $message Message to display.
|
|
* @return boolean True on pass
|
|
* @access public
|
|
*/
|
|
function assertEqual($first, $second, $message = "%s") {
|
|
return $this->assert(
|
|
new EqualExpectation($first),
|
|
$second,
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* Will trigger a pass if the two parameters have
|
|
* a different value. Otherwise a fail. This
|
|
* is for testing hand extracted text, etc.
|
|
* @param mixed $first Value to compare.
|
|
* @param mixed $second Value to compare.
|
|
* @param string $message Message to display.
|
|
* @return boolean True on pass
|
|
* @access public
|
|
*/
|
|
function assertNotEqual($first, $second, $message = "%s") {
|
|
return $this->assert(
|
|
new NotEqualExpectation($first),
|
|
$second,
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* Tests the last status code from the shell.
|
|
* @param integer $status Expected status of last
|
|
* command.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertExitCode($status, $message = "%s") {
|
|
$message = sprintf($message, "Expected status code of [$status] from [" .
|
|
$this->last_command . "], but got [" .
|
|
$this->last_status . "]");
|
|
return $this->assertTrue($status === $this->last_status, $message);
|
|
}
|
|
|
|
/**
|
|
* Attempt to exactly match the combined STDERR and
|
|
* STDOUT output.
|
|
* @param string $expected Expected output.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertOutput($expected, $message = "%s") {
|
|
$shell = $this->getShell();
|
|
return $this->assert(
|
|
new EqualExpectation($expected),
|
|
$shell->getOutput(),
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* Scans the output for a Perl regex. If found
|
|
* anywhere it passes, else it fails.
|
|
* @param string $pattern Regex to search for.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertOutputPattern($pattern, $message = "%s") {
|
|
$shell = $this->getShell();
|
|
return $this->assert(
|
|
new PatternExpectation($pattern),
|
|
$shell->getOutput(),
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* If a Perl regex is found anywhere in the current
|
|
* output then a failure is generated, else a pass.
|
|
* @param string $pattern Regex to search for.
|
|
* @param $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertNoOutputPattern($pattern, $message = "%s") {
|
|
$shell = $this->getShell();
|
|
return $this->assert(
|
|
new NoPatternExpectation($pattern),
|
|
$shell->getOutput(),
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* File existence check.
|
|
* @param string $path Full filename and path.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertFileExists($path, $message = "%s") {
|
|
$message = sprintf($message, "File [$path] should exist");
|
|
return $this->assertTrue(file_exists($path), $message);
|
|
}
|
|
|
|
/**
|
|
* File non-existence check.
|
|
* @param string $path Full filename and path.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertFileNotExists($path, $message = "%s") {
|
|
$message = sprintf($message, "File [$path] should not exist");
|
|
return $this->assertFalse(file_exists($path), $message);
|
|
}
|
|
|
|
/**
|
|
* Scans a file for a Perl regex. If found
|
|
* anywhere it passes, else it fails.
|
|
* @param string $pattern Regex to search for.
|
|
* @param string $path Full filename and path.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertFilePattern($pattern, $path, $message = "%s") {
|
|
return $this->assert(
|
|
new PatternExpectation($pattern),
|
|
implode('', file($path)),
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* If a Perl regex is found anywhere in the named
|
|
* file then a failure is generated, else a pass.
|
|
* @param string $pattern Regex to search for.
|
|
* @param string $path Full filename and path.
|
|
* @param string $message Message to display.
|
|
* @return boolean True if pass.
|
|
* @access public
|
|
*/
|
|
function assertNoFilePattern($pattern, $path, $message = "%s") {
|
|
return $this->assert(
|
|
new NoPatternExpectation($pattern),
|
|
implode('', file($path)),
|
|
$message);
|
|
}
|
|
|
|
/**
|
|
* Accessor for current shell. Used for testing the
|
|
* the tester itself.
|
|
* @return Shell Current shell.
|
|
* @access protected
|
|
*/
|
|
protected function getShell() {
|
|
return $this->current_shell;
|
|
}
|
|
|
|
/**
|
|
* Factory for the shell to run the command on.
|
|
* @return Shell New shell object.
|
|
* @access protected
|
|
*/
|
|
protected function createShell() {
|
|
return new SimpleShell();
|
|
}
|
|
}
|
|
?>
|