Merge branch 'master' into routing

Conflicts:
	lib/search/provider/file.php
	settings/ajax/changepassword.php
	settings/settings.php
This commit is contained in:
Bart Visscher 2012-10-17 16:38:11 +02:00
commit 6081bfa2bc
1500 changed files with 23864 additions and 176365 deletions

View File

@ -35,7 +35,7 @@
* @author Vincent Blavet <vincent@phpconcept.net>
* @copyright 1997-2010 The Authors
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version CVS: $Id: Tar.php 323476 2012-02-24 15:27:26Z mrook $
* @version CVS: $Id: Tar.php 324840 2012-04-05 08:44:41Z mrook $
* @link http://pear.php.net/package/Archive_Tar
*/
@ -50,7 +50,7 @@ define('ARCHIVE_TAR_END_BLOCK', pack("a512", ''));
* @package Archive_Tar
* @author Vincent Blavet <vincent@phpconcept.net>
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Revision: 323476 $
* @version $Revision: 324840 $
*/
class Archive_Tar extends PEAR
{
@ -577,7 +577,7 @@ class Archive_Tar extends PEAR
}
// ----- Get the arguments
$v_att_list = func_get_args();
$v_att_list = &func_get_args();
// ----- Read the attributes
$i=0;
@ -649,14 +649,14 @@ class Archive_Tar extends PEAR
// {{{ _error()
function _error($p_message)
{
$this->error_object = $this->raiseError($p_message);
$this->error_object = &$this->raiseError($p_message);
}
// }}}
// {{{ _warning()
function _warning($p_message)
{
$this->error_object = $this->raiseError($p_message);
$this->error_object = &$this->raiseError($p_message);
}
// }}}
@ -981,7 +981,7 @@ class Archive_Tar extends PEAR
// }}}
// {{{ _addFile()
function _addFile($p_filename, &$p_header, $p_add_dir, $p_remove_dir,$v_stored_filename=null)
function _addFile($p_filename, &$p_header, $p_add_dir, $p_remove_dir, $v_stored_filename=null)
{
if (!$this->_file) {
$this->_error('Invalid file descriptor');
@ -992,31 +992,32 @@ class Archive_Tar extends PEAR
$this->_error('Invalid file name');
return false;
}
if(is_null($v_stored_filename)){
// ----- Calculate the stored filename
$p_filename = $this->_translateWinPath($p_filename, false);
$v_stored_filename = $p_filename;
if (strcmp($p_filename, $p_remove_dir) == 0) {
return true;
}
if ($p_remove_dir != '') {
if (substr($p_remove_dir, -1) != '/')
$p_remove_dir .= '/';
// ownCloud change to make it possible to specify the filename to use
if(is_null($v_stored_filename)) {
// ----- Calculate the stored filename
$p_filename = $this->_translateWinPath($p_filename, false);
$v_stored_filename = $p_filename;
if (strcmp($p_filename, $p_remove_dir) == 0) {
return true;
}
if ($p_remove_dir != '') {
if (substr($p_remove_dir, -1) != '/')
$p_remove_dir .= '/';
if (substr($p_filename, 0, strlen($p_remove_dir)) == $p_remove_dir)
$v_stored_filename = substr($p_filename, strlen($p_remove_dir));
}
$v_stored_filename = $this->_translateWinPath($v_stored_filename);
if ($p_add_dir != '') {
if (substr($p_add_dir, -1) == '/')
$v_stored_filename = $p_add_dir.$v_stored_filename;
else
$v_stored_filename = $p_add_dir.'/'.$v_stored_filename;
}
if (substr($p_filename, 0, strlen($p_remove_dir)) == $p_remove_dir)
$v_stored_filename = substr($p_filename, strlen($p_remove_dir));
}
$v_stored_filename = $this->_translateWinPath($v_stored_filename);
if ($p_add_dir != '') {
if (substr($p_add_dir, -1) == '/')
$v_stored_filename = $p_add_dir.$v_stored_filename;
else
$v_stored_filename = $p_add_dir.'/'.$v_stored_filename;
}
$v_stored_filename = $this->_pathReduction($v_stored_filename);
}
$v_stored_filename = $this->_pathReduction($v_stored_filename);
}
if ($this->_isArchive($p_filename)) {
if (($v_file = @fopen($p_filename, "rb")) == 0) {
@ -1775,12 +1776,20 @@ class Archive_Tar extends PEAR
}
if ($this->_compress_type == 'gz') {
$end_blocks = 0;
while (!@gzeof($v_temp_tar)) {
$v_buffer = @gzread($v_temp_tar, 512);
if ($v_buffer == ARCHIVE_TAR_END_BLOCK || strlen($v_buffer) == 0) {
$end_blocks++;
// do not copy end blocks, we will re-make them
// after appending
continue;
} elseif ($end_blocks > 0) {
for ($i = 0; $i < $end_blocks; $i++) {
$this->_writeBlock(ARCHIVE_TAR_END_BLOCK);
}
$end_blocks = 0;
}
$v_binary_data = pack("a512", $v_buffer);
$this->_writeBlock($v_binary_data);
@ -1789,9 +1798,19 @@ class Archive_Tar extends PEAR
@gzclose($v_temp_tar);
}
elseif ($this->_compress_type == 'bz2') {
$end_blocks = 0;
while (strlen($v_buffer = @bzread($v_temp_tar, 512)) > 0) {
if ($v_buffer == ARCHIVE_TAR_END_BLOCK) {
if ($v_buffer == ARCHIVE_TAR_END_BLOCK || strlen($v_buffer) == 0) {
$end_blocks++;
// do not copy end blocks, we will re-make them
// after appending
continue;
} elseif ($end_blocks > 0) {
for ($i = 0; $i < $end_blocks; $i++) {
$this->_writeBlock(ARCHIVE_TAR_END_BLOCK);
}
$end_blocks = 0;
}
$v_binary_data = pack("a512", $v_buffer);
$this->_writeBlock($v_binary_data);

View File

@ -2,7 +2,7 @@
/*~ class.phpmailer.php
.---------------------------------------------------------------------------.
| Software: PHPMailer - PHP email class |
| Version: 5.2 |
| Version: 5.2.1 |
| Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ |
| ------------------------------------------------------------------------- |
| Admin: Jim Jagielski (project admininistrator) |
@ -10,7 +10,7 @@
| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
| : Jim Jagielski (jimjag) jimjag@gmail.com |
| Founder: Brent R. Matzelle (original founder) |
| Copyright (c) 2010-2011, Jim Jagielski. All Rights Reserved. |
| Copyright (c) 2010-2012, Jim Jagielski. All Rights Reserved. |
| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
| Copyright (c) 2001-2003, Brent R. Matzelle |
| ------------------------------------------------------------------------- |
@ -29,7 +29,7 @@
* @author Andy Prevost
* @author Marcus Bointon
* @author Jim Jagielski
* @copyright 2010 - 2011 Jim Jagielski
* @copyright 2010 - 2012 Jim Jagielski
* @copyright 2004 - 2009 Andy Prevost
* @version $Id: class.phpmailer.php 450 2010-06-23 16:46:33Z coolbru $
* @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
@ -129,6 +129,13 @@ class PHPMailer {
*/
protected $MIMEHeader = '';
/**
* Stores the complete sent MIME message (Body and Headers)
* @var string
* @access protected
*/
protected $SentMIMEMessage = '';
/**
* Sets word wrapping on the body of the message to a given number of
* characters.
@ -317,7 +324,7 @@ class PHPMailer {
* Sets the PHPMailer Version number
* @var string
*/
public $Version = '5.2';
public $Version = '5.2.1';
/**
* What to use in the X-Mailer header
@ -460,7 +467,7 @@ class PHPMailer {
* @return boolean
*/
public function AddReplyTo($address, $name = '') {
return $this->AddAnAddress('ReplyTo', $address, $name);
return $this->AddAnAddress('Reply-To', $address, $name);
}
/**
@ -473,12 +480,14 @@ class PHPMailer {
* @access protected
*/
protected function AddAnAddress($kind, $address, $name = '') {
if (!preg_match('/^(to|cc|bcc|ReplyTo)$/', $kind)) {
if (!preg_match('/^(to|cc|bcc|Reply-To)$/', $kind)) {
$this->SetError($this->Lang('Invalid recipient array').': '.$kind);
if ($this->exceptions) {
throw new phpmailerException('Invalid recipient array: ' . $kind);
}
echo $this->Lang('Invalid recipient array').': '.$kind;
if ($this->SMTPDebug) {
echo $this->Lang('Invalid recipient array').': '.$kind;
}
return false;
}
$address = trim($address);
@ -488,10 +497,12 @@ class PHPMailer {
if ($this->exceptions) {
throw new phpmailerException($this->Lang('invalid_address').': '.$address);
}
echo $this->Lang('invalid_address').': '.$address;
if ($this->SMTPDebug) {
echo $this->Lang('invalid_address').': '.$address;
}
return false;
}
if ($kind != 'ReplyTo') {
if ($kind != 'Reply-To') {
if (!isset($this->all_recipients[strtolower($address)])) {
array_push($this->$kind, array($address, $name));
$this->all_recipients[strtolower($address)] = true;
@ -520,14 +531,16 @@ class PHPMailer {
if ($this->exceptions) {
throw new phpmailerException($this->Lang('invalid_address').': '.$address);
}
echo $this->Lang('invalid_address').': '.$address;
if ($this->SMTPDebug) {
echo $this->Lang('invalid_address').': '.$address;
}
return false;
}
$this->From = $address;
$this->FromName = $name;
if ($auto) {
if (empty($this->ReplyTo)) {
$this->AddAnAddress('ReplyTo', $address, $name);
$this->AddAnAddress('Reply-To', $address, $name);
}
if (empty($this->Sender)) {
$this->Sender = $address;
@ -574,6 +587,7 @@ class PHPMailer {
if(!$this->PreSend()) return false;
return $this->PostSend();
} catch (phpmailerException $e) {
$this->SentMIMEMessage = '';
$this->SetError($e->getMessage());
if ($this->exceptions) {
throw $e;
@ -584,6 +598,7 @@ class PHPMailer {
protected function PreSend() {
try {
$mailHeader = "";
if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
throw new phpmailerException($this->Lang('provide_address'), self::STOP_CRITICAL);
}
@ -603,6 +618,19 @@ class PHPMailer {
$this->MIMEHeader = $this->CreateHeader();
$this->MIMEBody = $this->CreateBody();
// To capture the complete message when using mail(), create
// an extra header list which CreateHeader() doesn't fold in
if ($this->Mailer == 'mail') {
if (count($this->to) > 0) {
$mailHeader .= $this->AddrAppend("To", $this->to);
} else {
$mailHeader .= $this->HeaderLine("To", "undisclosed-recipients:;");
}
$mailHeader .= $this->HeaderLine('Subject', $this->EncodeHeader($this->SecureHeader(trim($this->Subject))));
// if(count($this->cc) > 0) {
// $mailHeader .= $this->AddrAppend("Cc", $this->cc);
// }
}
// digitally sign with DKIM if enabled
if ($this->DKIM_domain && $this->DKIM_private) {
@ -610,7 +638,9 @@ class PHPMailer {
$this->MIMEHeader = str_replace("\r\n", "\n", $header_dkim) . $this->MIMEHeader;
}
$this->SentMIMEMessage = sprintf("%s%s\r\n\r\n%s",$this->MIMEHeader,$mailHeader,$this->MIMEBody);
return true;
} catch (phpmailerException $e) {
$this->SetError($e->getMessage());
if ($this->exceptions) {
@ -628,6 +658,8 @@ class PHPMailer {
return $this->SendmailSend($this->MIMEHeader, $this->MIMEBody);
case 'smtp':
return $this->SmtpSend($this->MIMEHeader, $this->MIMEBody);
case 'mail':
return $this->MailSend($this->MIMEHeader, $this->MIMEBody);
default:
return $this->MailSend($this->MIMEHeader, $this->MIMEBody);
}
@ -637,7 +669,9 @@ class PHPMailer {
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage()."\n";
if ($this->SMTPDebug) {
echo $e->getMessage()."\n";
}
return false;
}
}
@ -703,7 +737,7 @@ class PHPMailer {
$to = implode(', ', $toArr);
if (empty($this->Sender)) {
$params = "-oi -f %s";
$params = "-oi ";
} else {
$params = sprintf("-oi -f %s", $this->Sender);
}
@ -732,7 +766,7 @@ class PHPMailer {
$this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body);
}
} else {
$rt = @mail($to, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header);
$rt = @mail($to, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params);
// implement call back function if it exists
$isSent = ($rt == 1) ? 1 : 0;
$this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body);
@ -880,7 +914,9 @@ class PHPMailer {
}
} catch (phpmailerException $e) {
$this->smtp->Reset();
throw $e;
if ($this->exceptions) {
throw $e;
}
}
return true;
}
@ -1159,7 +1195,7 @@ class PHPMailer {
$result .= $this->HeaderLine('To', 'undisclosed-recipients:;');
}
}
}
}
$from = array();
$from[0][0] = trim($this->From);
@ -1177,7 +1213,7 @@ class PHPMailer {
}
if(count($this->ReplyTo) > 0) {
$result .= $this->AddrAppend('Reply-to', $this->ReplyTo);
$result .= $this->AddrAppend('Reply-To', $this->ReplyTo);
}
// mail() sets the subject itself
@ -1250,6 +1286,16 @@ class PHPMailer {
return $result;
}
/**
* Returns the MIME message (headers and body). Only really valid post PreSend().
* @access public
* @return string
*/
public function GetSentMIMEMessage() {
return $this->SentMIMEMessage;
}
/**
* Assembles the message body. Returns an empty string on failure.
* @access public
@ -1363,8 +1409,8 @@ class PHPMailer {
$signed = tempnam("", "signed");
if (@openssl_pkcs7_sign($file, $signed, "file://".$this->sign_cert_file, array("file://".$this->sign_key_file, $this->sign_key_pass), NULL)) {
@unlink($file);
@unlink($signed);
$body = file_get_contents($signed);
@unlink($signed);
} else {
@unlink($file);
@unlink($signed);
@ -1487,7 +1533,9 @@ class PHPMailer {
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage()."\n";
if ($this->SMTPDebug) {
echo $e->getMessage()."\n";
}
if ( $e->getCode() == self::STOP_CRITICAL ) {
return false;
}
@ -1590,15 +1638,23 @@ class PHPMailer {
return false;
}
}
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
$magic_quotes = get_magic_quotes_runtime();
set_magic_quotes_runtime(0);
}
$magic_quotes = get_magic_quotes_runtime();
if ($magic_quotes) {
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime(0);
} else {
ini_set('magic_quotes_runtime', 0);
}
}
$file_buffer = file_get_contents($path);
$file_buffer = $this->EncodeString($file_buffer, $encoding);
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime($magic_quotes);
}
if ($magic_quotes) {
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime($magic_quotes);
} else {
ini_set('magic_quotes_runtime', $magic_quotes);
}
}
return $file_buffer;
} catch (Exception $e) {
$this->SetError($e->getMessage());
@ -2154,7 +2210,7 @@ class PHPMailer {
* @return $message
*/
public function MsgHTML($message, $basedir = '') {
preg_match_all("/(src|background)=\"(.*)\"/Ui", $message, $images);
preg_match_all("/(src|background)=[\"'](.*)[\"']/Ui", $message, $images);
if(isset($images[2])) {
foreach($images[2] as $i => $url) {
// do not change urls for absolute images (thanks to corvuscorax)
@ -2168,20 +2224,23 @@ class PHPMailer {
if ( strlen($basedir) > 1 && substr($basedir, -1) != '/') { $basedir .= '/'; }
if ( strlen($directory) > 1 && substr($directory, -1) != '/') { $directory .= '/'; }
if ( $this->AddEmbeddedImage($basedir.$directory.$filename, md5($filename), $filename, 'base64', $mimeType) ) {
$message = preg_replace("/".$images[1][$i]."=\"".preg_quote($url, '/')."\"/Ui", $images[1][$i]."=\"".$cid."\"", $message);
$message = preg_replace("/".$images[1][$i]."=[\"']".preg_quote($url, '/')."[\"']/Ui", $images[1][$i]."=\"".$cid."\"", $message);
}
}
}
}
$this->IsHTML(true);
$this->Body = $message;
$textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s', '', $message)));
if (!empty($textMsg) && empty($this->AltBody)) {
$this->AltBody = html_entity_decode($textMsg);
}
if (empty($this->AltBody)) {
$textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s', '', $message)));
if (!empty($textMsg)) {
$this->AltBody = html_entity_decode($textMsg, ENT_QUOTES, $this->CharSet);
}
}
if (empty($this->AltBody)) {
$this->AltBody = 'To view this email message, open it in a program that understands HTML!' . "\n\n";
}
return $message;
}
/**

View File

@ -2,7 +2,7 @@
/*~ class.smtp.php
.---------------------------------------------------------------------------.
| Software: PHPMailer - PHP email class |
| Version: 5.2 |
| Version: 5.2.1 |
| Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ |
| ------------------------------------------------------------------------- |
| Admin: Jim Jagielski (project admininistrator) |
@ -10,7 +10,7 @@
| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
| : Jim Jagielski (jimjag) jimjag@gmail.com |
| Founder: Brent R. Matzelle (original founder) |
| Copyright (c) 2010-2011, Jim Jagielski. All Rights Reserved. |
| Copyright (c) 2010-2012, Jim Jagielski. All Rights Reserved. |
| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
| Copyright (c) 2001-2003, Brent R. Matzelle |
| ------------------------------------------------------------------------- |
@ -30,7 +30,7 @@
* @author Marcus Bointon
* @copyright 2004 - 2008 Andy Prevost
* @author Jim Jagielski
* @copyright 2010 - 2011 Jim Jagielski
* @copyright 2010 - 2012 Jim Jagielski
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
* @version $Id: class.smtp.php 450 2010-06-23 16:46:33Z coolbru $
*/
@ -72,7 +72,7 @@ class SMTP {
* Sets the SMTP PHPMailer Version number
* @var string
*/
public $Version = '5.2';
public $Version = '5.2.1';
/////////////////////////////////////////////////
// PROPERTIES, PRIVATE AND PROTECTED
@ -797,7 +797,8 @@ class SMTP {
*/
private function get_lines() {
$data = "";
while($str = @fgets($this->smtp_conn,515)) {
while(!feof($this->smtp_conn)) {
$str = @fgets($this->smtp_conn,515);
if($this->do_debug >= 4) {
echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';

BIN
3rdparty/css/chosen-sprite.png vendored Normal file → Executable file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 742 B

After

Width:  |  Height:  |  Size: 559 B

261
3rdparty/css/chosen.css vendored Normal file → Executable file
View File

@ -1,16 +1,10 @@
/* @group Base */
select.chzn-select {
visibility: hidden;
height: 28px !important;
min-height: 28px !important;
}
.chzn-container {
font-size: 13px;
position: relative;
display: inline-block;
zoom: 1;
*display: inline;
vertical-align: bottom;
}
.chzn-container .chzn-drop {
background: #fff;
@ -29,31 +23,37 @@ select.chzn-select {
/* @group Single Chosen */
.chzn-container-single .chzn-single {
background-color: #fff;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, #eeeeee), color-stop(0.5, white));
background-image: -webkit-linear-gradient(center bottom, #eeeeee 0%, white 50%);
background-image: -moz-linear-gradient(center bottom, #eeeeee 0%, white 50%);
background-image: -o-linear-gradient(top, #eeeeee 0%,#ffffff 50%);
background-image: -ms-linear-gradient(top, #eeeeee 0%,#ffffff 50%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#eeeeee', endColorstr='#ffffff',GradientType=0 );
background-image: linear-gradient(top, #eeeeee 0%,#ffffff 50%);
-webkit-border-radius: 4px;
-moz-border-radius : 4px;
border-radius : 4px;
background-color: #ffffff;
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #ffffff), color-stop(50%, #f6f6f6), color-stop(52%, #eeeeee), color-stop(100%, #f4f4f4));
background-image: -webkit-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: -moz-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: -o-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: -ms-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
-webkit-border-radius: 5px;
-moz-border-radius : 5px;
border-radius : 5px;
-moz-background-clip : padding;
-webkit-background-clip: padding-box;
background-clip : padding-box;
border: 1px solid #aaa;
border: 1px solid #aaaaaa;
-webkit-box-shadow: 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1);
-moz-box-shadow : 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1);
box-shadow : 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1);
display: block;
overflow: hidden;
white-space: nowrap;
position: relative;
height: 26px;
line-height: 26px;
height: 23px;
line-height: 24px;
padding: 0 0 0 8px;
color: #444;
color: #444444;
text-decoration: none;
}
.chzn-container-single .chzn-default {
color: #999;
}
.chzn-container-single .chzn-single span {
margin-right: 26px;
display: block;
@ -61,25 +61,22 @@ select.chzn-select {
white-space: nowrap;
-o-text-overflow: ellipsis;
-ms-text-overflow: ellipsis;
-moz-binding: url('/xml/ellipsis.xml#ellipsis');
text-overflow: ellipsis;
}
.chzn-container-single .chzn-single abbr {
display: block;
position: absolute;
right: 26px;
top: 6px;
width: 12px;
height: 13px;
font-size: 1px;
background: url(chosen-sprite.png) right top no-repeat;
}
.chzn-container-single .chzn-single abbr:hover {
background-position: right -11px;
}
.chzn-container-single .chzn-single div {
-webkit-border-radius: 0 4px 4px 0;
-moz-border-radius : 0 4px 4px 0;
border-radius : 0 4px 4px 0;
-moz-background-clip : padding;
-webkit-background-clip: padding-box;
background-clip : padding-box;
background: #ccc;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, #ccc), color-stop(0.6, #eee));
background-image: -webkit-linear-gradient(center bottom, #ccc 0%, #eee 60%);
background-image: -moz-linear-gradient(center bottom, #ccc 0%, #eee 60%);
background-image: -o-linear-gradient(bottom, #ccc 0%, #eee 60%);
background-image: -ms-linear-gradient(top, #cccccc 0%,#eeeeee 60%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#cccccc', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #cccccc 0%,#eeeeee 60%);
border-left: 1px solid #aaa;
position: absolute;
right: 0;
top: 0;
@ -88,25 +85,26 @@ select.chzn-select {
width: 18px;
}
.chzn-container-single .chzn-single div b {
background: url('chosen-sprite.png') no-repeat 0 1px;
background: url('chosen-sprite.png') no-repeat 0 0;
display: block;
width: 100%;
height: 100%;
}
.chzn-container-single .chzn-search {
padding: 3px 4px;
position: relative;
margin: 0;
white-space: nowrap;
z-index: 1010;
}
.chzn-container-single .chzn-search input {
background: #fff url('chosen-sprite.png') no-repeat 100% -20px;
background: url('chosen-sprite.png') no-repeat 100% -20px, -webkit-gradient(linear, left bottom, left top, color-stop(0.85, white), color-stop(0.99, #eeeeee));
background: url('chosen-sprite.png') no-repeat 100% -20px, -webkit-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -20px, -moz-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -20px, -o-linear-gradient(bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -20px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -20px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -20px, linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: #fff url('chosen-sprite.png') no-repeat 100% -22px;
background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, linear-gradient(top, #eeeeee 1%, #ffffff 15%);
margin: 1px 0;
padding: 4px 20px 4px 5px;
outline: 0;
@ -124,16 +122,20 @@ select.chzn-select {
}
/* @end */
.chzn-container-single-nosearch .chzn-search input {
position: absolute;
left: -9000px;
}
/* @group Multi Chosen */
.chzn-container-multi .chzn-choices {
background-color: #fff;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0.85, white), color-stop(0.99, #eeeeee));
background-image: -webkit-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background-image: -moz-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background-image: -o-linear-gradient(bottom, white 85%, #eeeeee 99%);
background-image: -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
background-image: -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: linear-gradient(top, #eeeeee 1%, #ffffff 15%);
border: 1px solid #aaa;
margin: 0;
padding: 0;
@ -156,6 +158,9 @@ select.chzn-select {
color: #666;
background: transparent !important;
border: 0 !important;
font-family: sans-serif;
font-size: 100%;
height: 15px;
padding: 5px;
margin: 1px 0;
outline: 0;
@ -175,21 +180,22 @@ select.chzn-select {
-webkit-background-clip: padding-box;
background-clip : padding-box;
background-color: #e4e4e4;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, #e4e4e4), color-stop(0.7, #eeeeee));
background-image: -webkit-linear-gradient(center bottom, #e4e4e4 0%, #eeeeee 70%);
background-image: -moz-linear-gradient(center bottom, #e4e4e4 0%, #eeeeee 70%);
background-image: -o-linear-gradient(bottom, #e4e4e4 0%, #eeeeee 70%);
background-image: -ms-linear-gradient(top, #e4e4e4 0%,#eeeeee 70%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#e4e4e4', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #e4e4e4 0%,#eeeeee 70%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f4f4f4', endColorstr='#eeeeee', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #f4f4f4), color-stop(50%, #f0f0f0), color-stop(52%, #e8e8e8), color-stop(100%, #eeeeee));
background-image: -webkit-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: -moz-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: -o-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: -ms-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
-webkit-box-shadow: 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05);
-moz-box-shadow : 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05);
box-shadow : 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05);
color: #333;
border: 1px solid #b4b4b4;
border: 1px solid #aaaaaa;
line-height: 13px;
padding: 3px 19px 3px 6px;
padding: 3px 20px 3px 5px;
margin: 3px 0 3px 5px;
position: relative;
}
.chzn-container-multi .chzn-choices .search-choice span {
cursor: default;
}
.chzn-container-multi .chzn-choices .search-choice-focus {
@ -198,25 +204,25 @@ select.chzn-select {
.chzn-container-multi .chzn-choices .search-choice .search-choice-close {
display: block;
position: absolute;
right: 5px;
top: 6px;
width: 8px;
height: 9px;
right: 3px;
top: 4px;
width: 12px;
height: 13px;
font-size: 1px;
background: url(chosen-sprite.png) right top no-repeat;
}
.chzn-container-multi .chzn-choices .search-choice .search-choice-close:hover {
background-position: right -9px;
background-position: right -11px;
}
.chzn-container-multi .chzn-choices .search-choice-focus .search-choice-close {
background-position: right -9px;
background-position: right -11px;
}
/* @end */
/* @group Results */
.chzn-container .chzn-results {
margin: 0 4px 4px 0;
max-height: 190px;
max-height: 240px;
padding: 0 0 0 4px;
position: relative;
overflow-x: hidden;
@ -227,16 +233,25 @@ select.chzn-select {
padding: 0;
}
.chzn-container .chzn-results li {
line-height: 80%;
padding: 7px 7px 8px;
display: none;
line-height: 15px;
padding: 5px 6px;
margin: 0;
list-style: none;
}
.chzn-container .chzn-results .active-result {
cursor: pointer;
display: list-item;
}
.chzn-container .chzn-results .highlighted {
background: #3875d7;
background-color: #3875d7;
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#3875d7', endColorstr='#2a62bc', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #3875d7), color-stop(90%, #2a62bc));
background-image: -webkit-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: -moz-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: -o-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: -ms-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: linear-gradient(top, #3875d7 20%, #2a62bc 90%);
color: #fff;
}
.chzn-container .chzn-results li em {
@ -248,6 +263,7 @@ select.chzn-select {
}
.chzn-container .chzn-results .no-results {
background: #f4f4f4;
display: list-item;
}
.chzn-container .chzn-results .group-result {
cursor: default;
@ -255,11 +271,34 @@ select.chzn-select {
font-weight: bold;
}
.chzn-container .chzn-results .group-option {
padding-left: 20px;
padding-left: 15px;
}
.chzn-container-multi .chzn-drop .result-selected {
display: none;
}
.chzn-container .chzn-results-scroll {
background: white;
margin: 0 4px;
position: absolute;
text-align: center;
width: 321px; /* This should by dynamic with js */
z-index: 1;
}
.chzn-container .chzn-results-scroll span {
display: inline-block;
height: 17px;
text-indent: -5000px;
width: 9px;
}
.chzn-container .chzn-results-scroll-down {
bottom: 0;
}
.chzn-container .chzn-results-scroll-down span {
background: url('chosen-sprite.png') no-repeat -4px -3px;
}
.chzn-container .chzn-results-scroll-up span {
background: url('chosen-sprite.png') no-repeat -22px -3px;
}
/* @end */
/* @group Active */
@ -277,13 +316,13 @@ select.chzn-select {
-o-box-shadow : 0 1px 0 #fff inset;
box-shadow : 0 1px 0 #fff inset;
background-color: #eee;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, white), color-stop(0.5, #eeeeee));
background-image: -webkit-linear-gradient(center bottom, white 0%, #eeeeee 50%);
background-image: -moz-linear-gradient(center bottom, white 0%, #eeeeee 50%);
background-image: -o-linear-gradient(bottom, white 0%, #eeeeee 50%);
background-image: -ms-linear-gradient(top, #ffffff 0%,#eeeeee 50%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #ffffff 0%,#eeeeee 50%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#eeeeee', endColorstr='#ffffff', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #eeeeee), color-stop(80%, #ffffff));
background-image: -webkit-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: -moz-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: -o-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: -ms-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: linear-gradient(top, #eeeeee 20%, #ffffff 80%);
-webkit-border-bottom-left-radius : 0;
-webkit-border-bottom-right-radius: 0;
-moz-border-radius-bottomleft : 0;
@ -310,32 +349,44 @@ select.chzn-select {
}
/* @end */
/* @group Right to Left */
.chzn-rtl { direction:rtl;text-align: right; }
.chzn-rtl .chzn-single { padding-left: 0; padding-right: 8px; }
.chzn-rtl .chzn-single span { margin-left: 26px; margin-right: 0; }
.chzn-rtl .chzn-single div {
left: 0; right: auto;
border-left: none; border-right: 1px solid #aaaaaa;
-webkit-border-radius: 4px 0 0 4px;
-moz-border-radius : 4px 0 0 4px;
border-radius : 4px 0 0 4px;
/* @group Disabled Support */
.chzn-disabled {
cursor: default;
opacity:0.5 !important;
}
.chzn-disabled .chzn-single {
cursor: default;
}
.chzn-disabled .chzn-choices .search-choice .search-choice-close {
cursor: default;
}
/* @group Right to Left */
.chzn-rtl { text-align: right; }
.chzn-rtl .chzn-single { padding: 0 8px 0 0; overflow: visible; }
.chzn-rtl .chzn-single span { margin-left: 26px; margin-right: 0; direction: rtl; }
.chzn-rtl .chzn-single div { left: 3px; right: auto; }
.chzn-rtl .chzn-single abbr {
left: 26px;
right: auto;
}
.chzn-rtl .chzn-choices .search-field input { direction: rtl; }
.chzn-rtl .chzn-choices li { float: right; }
.chzn-rtl .chzn-choices .search-choice { padding: 3px 6px 3px 19px; margin: 3px 5px 3px 0; }
.chzn-rtl .chzn-choices .search-choice .search-choice-close { left: 5px; right: auto; background-position: right top;}
.chzn-rtl.chzn-container-single .chzn-results { margin-left: 4px; margin-right: 0; padding-left: 0; padding-right: 4px; }
.chzn-rtl .chzn-results .group-option { padding-left: 0; padding-right: 20px; }
.chzn-rtl .chzn-choices .search-choice { padding: 3px 5px 3px 19px; margin: 3px 5px 3px 0; }
.chzn-rtl .chzn-choices .search-choice .search-choice-close { left: 4px; right: auto; background-position: right top;}
.chzn-rtl.chzn-container-single .chzn-results { margin: 0 0 4px 4px; padding: 0 4px 0 0; }
.chzn-rtl .chzn-results .group-option { padding-left: 0; padding-right: 15px; }
.chzn-rtl.chzn-container-active .chzn-single-with-drop div { border-right: none; }
.chzn-rtl .chzn-search input {
background: url('chosen-sprite.png') no-repeat -38px -20px, #ffffff;
background: url('chosen-sprite.png') no-repeat -38px -20px, -webkit-gradient(linear, left bottom, left top, color-stop(0.85, white), color-stop(0.99, #eeeeee));
background: url('chosen-sprite.png') no-repeat -38px -20px, -webkit-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -20px, -moz-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -20px, -o-linear-gradient(bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -20px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -20px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -20px, linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: #fff url('chosen-sprite.png') no-repeat -38px -22px;
background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, linear-gradient(top, #eeeeee 1%, #ffffff 15%);
padding: 4px 5px 4px 20px;
direction: rtl;
}
/* @end */
/* @end */

206
3rdparty/css/chosen/chosen.css vendored Normal file → Executable file
View File

@ -23,31 +23,37 @@
/* @group Single Chosen */
.chzn-container-single .chzn-single {
background-color: #fff;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, #eeeeee), color-stop(0.5, white));
background-image: -webkit-linear-gradient(center bottom, #eeeeee 0%, white 50%);
background-image: -moz-linear-gradient(center bottom, #eeeeee 0%, white 50%);
background-image: -o-linear-gradient(top, #eeeeee 0%,#ffffff 50%);
background-image: -ms-linear-gradient(top, #eeeeee 0%,#ffffff 50%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#eeeeee', endColorstr='#ffffff',GradientType=0 );
background-image: linear-gradient(top, #eeeeee 0%,#ffffff 50%);
-webkit-border-radius: 4px;
-moz-border-radius : 4px;
border-radius : 4px;
background-color: #ffffff;
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #ffffff), color-stop(50%, #f6f6f6), color-stop(52%, #eeeeee), color-stop(100%, #f4f4f4));
background-image: -webkit-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: -moz-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: -o-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: -ms-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
background-image: linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%);
-webkit-border-radius: 5px;
-moz-border-radius : 5px;
border-radius : 5px;
-moz-background-clip : padding;
-webkit-background-clip: padding-box;
background-clip : padding-box;
border: 1px solid #aaa;
border: 1px solid #aaaaaa;
-webkit-box-shadow: 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1);
-moz-box-shadow : 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1);
box-shadow : 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1);
display: block;
overflow: hidden;
white-space: nowrap;
position: relative;
height: 26px;
line-height: 26px;
height: 23px;
line-height: 24px;
padding: 0 0 0 8px;
color: #444;
color: #444444;
text-decoration: none;
}
.chzn-container-single .chzn-default {
color: #999;
}
.chzn-container-single .chzn-single span {
margin-right: 26px;
display: block;
@ -61,7 +67,7 @@
display: block;
position: absolute;
right: 26px;
top: 8px;
top: 6px;
width: 12px;
height: 13px;
font-size: 1px;
@ -71,21 +77,6 @@
background-position: right -11px;
}
.chzn-container-single .chzn-single div {
-webkit-border-radius: 0 4px 4px 0;
-moz-border-radius : 0 4px 4px 0;
border-radius : 0 4px 4px 0;
-moz-background-clip : padding;
-webkit-background-clip: padding-box;
background-clip : padding-box;
background: #ccc;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, #ccc), color-stop(0.6, #eee));
background-image: -webkit-linear-gradient(center bottom, #ccc 0%, #eee 60%);
background-image: -moz-linear-gradient(center bottom, #ccc 0%, #eee 60%);
background-image: -o-linear-gradient(bottom, #ccc 0%, #eee 60%);
background-image: -ms-linear-gradient(top, #cccccc 0%,#eeeeee 60%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#cccccc', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #cccccc 0%,#eeeeee 60%);
border-left: 1px solid #aaa;
position: absolute;
right: 0;
top: 0;
@ -94,7 +85,7 @@
width: 18px;
}
.chzn-container-single .chzn-single div b {
background: url('chosen-sprite.png') no-repeat 0 1px;
background: url('chosen-sprite.png') no-repeat 0 0;
display: block;
width: 100%;
height: 100%;
@ -104,16 +95,16 @@
position: relative;
margin: 0;
white-space: nowrap;
z-index: 1010;
}
.chzn-container-single .chzn-search input {
background: #fff url('chosen-sprite.png') no-repeat 100% -22px;
background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-gradient(linear, left bottom, left top, color-stop(0.85, white), color-stop(0.99, #eeeeee));
background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -moz-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -o-linear-gradient(bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -22px, linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat 100% -22px, linear-gradient(top, #eeeeee 1%, #ffffff 15%);
margin: 1px 0;
padding: 4px 20px 4px 5px;
outline: 0;
@ -139,13 +130,12 @@
/* @group Multi Chosen */
.chzn-container-multi .chzn-choices {
background-color: #fff;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0.85, white), color-stop(0.99, #eeeeee));
background-image: -webkit-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background-image: -moz-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background-image: -o-linear-gradient(bottom, white 85%, #eeeeee 99%);
background-image: -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
background-image: -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background-image: linear-gradient(top, #eeeeee 1%, #ffffff 15%);
border: 1px solid #aaa;
margin: 0;
padding: 0;
@ -168,6 +158,9 @@
color: #666;
background: transparent !important;
border: 0 !important;
font-family: sans-serif;
font-size: 100%;
height: 15px;
padding: 5px;
margin: 1px 0;
outline: 0;
@ -187,21 +180,22 @@
-webkit-background-clip: padding-box;
background-clip : padding-box;
background-color: #e4e4e4;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, #e4e4e4), color-stop(0.7, #eeeeee));
background-image: -webkit-linear-gradient(center bottom, #e4e4e4 0%, #eeeeee 70%);
background-image: -moz-linear-gradient(center bottom, #e4e4e4 0%, #eeeeee 70%);
background-image: -o-linear-gradient(bottom, #e4e4e4 0%, #eeeeee 70%);
background-image: -ms-linear-gradient(top, #e4e4e4 0%,#eeeeee 70%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#e4e4e4', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #e4e4e4 0%,#eeeeee 70%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f4f4f4', endColorstr='#eeeeee', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #f4f4f4), color-stop(50%, #f0f0f0), color-stop(52%, #e8e8e8), color-stop(100%, #eeeeee));
background-image: -webkit-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: -moz-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: -o-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: -ms-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
background-image: linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%);
-webkit-box-shadow: 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05);
-moz-box-shadow : 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05);
box-shadow : 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05);
color: #333;
border: 1px solid #b4b4b4;
border: 1px solid #aaaaaa;
line-height: 13px;
padding: 3px 19px 3px 6px;
padding: 3px 20px 3px 5px;
margin: 3px 0 3px 5px;
position: relative;
}
.chzn-container-multi .chzn-choices .search-choice span {
cursor: default;
}
.chzn-container-multi .chzn-choices .search-choice-focus {
@ -228,7 +222,7 @@
/* @group Results */
.chzn-container .chzn-results {
margin: 0 4px 4px 0;
max-height: 190px;
max-height: 240px;
padding: 0 0 0 4px;
position: relative;
overflow-x: hidden;
@ -240,8 +234,8 @@
}
.chzn-container .chzn-results li {
display: none;
line-height: 80%;
padding: 7px 7px 8px;
line-height: 15px;
padding: 5px 6px;
margin: 0;
list-style: none;
}
@ -250,7 +244,14 @@
display: list-item;
}
.chzn-container .chzn-results .highlighted {
background: #3875d7;
background-color: #3875d7;
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#3875d7', endColorstr='#2a62bc', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #3875d7), color-stop(90%, #2a62bc));
background-image: -webkit-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: -moz-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: -o-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: -ms-linear-gradient(top, #3875d7 20%, #2a62bc 90%);
background-image: linear-gradient(top, #3875d7 20%, #2a62bc 90%);
color: #fff;
}
.chzn-container .chzn-results li em {
@ -270,11 +271,34 @@
font-weight: bold;
}
.chzn-container .chzn-results .group-option {
padding-left: 20px;
padding-left: 15px;
}
.chzn-container-multi .chzn-drop .result-selected {
display: none;
}
.chzn-container .chzn-results-scroll {
background: white;
margin: 0 4px;
position: absolute;
text-align: center;
width: 321px; /* This should by dynamic with js */
z-index: 1;
}
.chzn-container .chzn-results-scroll span {
display: inline-block;
height: 17px;
text-indent: -5000px;
width: 9px;
}
.chzn-container .chzn-results-scroll-down {
bottom: 0;
}
.chzn-container .chzn-results-scroll-down span {
background: url('chosen-sprite.png') no-repeat -4px -3px;
}
.chzn-container .chzn-results-scroll-up span {
background: url('chosen-sprite.png') no-repeat -22px -3px;
}
/* @end */
/* @group Active */
@ -292,13 +316,13 @@
-o-box-shadow : 0 1px 0 #fff inset;
box-shadow : 0 1px 0 #fff inset;
background-color: #eee;
background-image: -webkit-gradient(linear, left bottom, left top, color-stop(0, white), color-stop(0.5, #eeeeee));
background-image: -webkit-linear-gradient(center bottom, white 0%, #eeeeee 50%);
background-image: -moz-linear-gradient(center bottom, white 0%, #eeeeee 50%);
background-image: -o-linear-gradient(bottom, white 0%, #eeeeee 50%);
background-image: -ms-linear-gradient(top, #ffffff 0%,#eeeeee 50%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee',GradientType=0 );
background-image: linear-gradient(top, #ffffff 0%,#eeeeee 50%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#eeeeee', endColorstr='#ffffff', GradientType=0 );
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #eeeeee), color-stop(80%, #ffffff));
background-image: -webkit-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: -moz-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: -o-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: -ms-linear-gradient(top, #eeeeee 20%, #ffffff 80%);
background-image: linear-gradient(top, #eeeeee 20%, #ffffff 80%);
-webkit-border-bottom-left-radius : 0;
-webkit-border-bottom-right-radius: 0;
-moz-border-radius-bottomleft : 0;
@ -338,31 +362,31 @@
}
/* @group Right to Left */
.chzn-rtl { direction:rtl;text-align: right; }
.chzn-rtl .chzn-single { padding-left: 0; padding-right: 8px; }
.chzn-rtl .chzn-single span { margin-left: 26px; margin-right: 0; }
.chzn-rtl .chzn-single div {
left: 0; right: auto;
border-left: none; border-right: 1px solid #aaaaaa;
-webkit-border-radius: 4px 0 0 4px;
-moz-border-radius : 4px 0 0 4px;
border-radius : 4px 0 0 4px;
.chzn-rtl { text-align: right; }
.chzn-rtl .chzn-single { padding: 0 8px 0 0; overflow: visible; }
.chzn-rtl .chzn-single span { margin-left: 26px; margin-right: 0; direction: rtl; }
.chzn-rtl .chzn-single div { left: 3px; right: auto; }
.chzn-rtl .chzn-single abbr {
left: 26px;
right: auto;
}
.chzn-rtl .chzn-choices .search-field input { direction: rtl; }
.chzn-rtl .chzn-choices li { float: right; }
.chzn-rtl .chzn-choices .search-choice { padding: 3px 6px 3px 19px; margin: 3px 5px 3px 0; }
.chzn-rtl .chzn-choices .search-choice .search-choice-close { left: 5px; right: auto; background-position: right top;}
.chzn-rtl.chzn-container-single .chzn-results { margin-left: 4px; margin-right: 0; padding-left: 0; padding-right: 4px; }
.chzn-rtl .chzn-results .group-option { padding-left: 0; padding-right: 20px; }
.chzn-rtl .chzn-choices .search-choice { padding: 3px 5px 3px 19px; margin: 3px 5px 3px 0; }
.chzn-rtl .chzn-choices .search-choice .search-choice-close { left: 4px; right: auto; background-position: right top;}
.chzn-rtl.chzn-container-single .chzn-results { margin: 0 0 4px 4px; padding: 0 4px 0 0; }
.chzn-rtl .chzn-results .group-option { padding-left: 0; padding-right: 15px; }
.chzn-rtl.chzn-container-active .chzn-single-with-drop div { border-right: none; }
.chzn-rtl .chzn-search input {
background: url('chosen-sprite.png') no-repeat -38px -22px, #ffffff;
background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-gradient(linear, left bottom, left top, color-stop(0.85, white), color-stop(0.99, #eeeeee));
background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -moz-linear-gradient(center bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -o-linear-gradient(bottom, white 85%, #eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -ms-linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: url('chosen-sprite.png') no-repeat -38px -22px, linear-gradient(top, #ffffff 85%,#eeeeee 99%);
background: #fff url('chosen-sprite.png') no-repeat -38px -22px;
background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%);
background: url('chosen-sprite.png') no-repeat -38px -22px, linear-gradient(top, #eeeeee 1%, #ffffff 15%);
padding: 4px 5px 4px 20px;
direction: rtl;
}
/* @end */
/* @end */

View File

@ -1,11 +1,11 @@
/*
* FullCalendar v1.5.3 Stylesheet
* FullCalendar v1.5.4 Stylesheet
*
* Copyright (c) 2011 Adam Shaw
* Dual licensed under the MIT and GPL licenses, located in
* MIT-LICENSE.txt and GPL-LICENSE.txt respectively.
*
* Date: Mon Feb 6 22:40:40 2012 -0800
* Date: Tue Sep 4 23:38:33 2012 -0700
*
*/

View File

@ -1,5 +1,5 @@
/*
* FullCalendar v1.5.3 Print Stylesheet
* FullCalendar v1.5.4 Print Stylesheet
*
* Include this stylesheet on your page to get a more printer-friendly calendar.
* When including this stylesheet, use the media='print' attribute of the <link> tag.
@ -9,7 +9,7 @@
* Dual licensed under the MIT and GPL licenses, located in
* MIT-LICENSE.txt and GPL-LICENSE.txt respectively.
*
* Date: Mon Feb 6 22:40:40 2012 -0800
* Date: Tue Sep 4 23:38:33 2012 -0700
*
*/

View File

@ -1,6 +1,6 @@
/**
* @preserve
* FullCalendar v1.5.3
* FullCalendar v1.5.4
* http://arshaw.com/fullcalendar/
*
* Use fullcalendar.css for basic styling.
@ -11,7 +11,7 @@
* Dual licensed under the MIT and GPL licenses, located in
* MIT-LICENSE.txt and GPL-LICENSE.txt respectively.
*
* Date: Mon Feb 6 22:40:40 2012 -0800
* Date: Tue Sep 4 23:38:33 2012 -0700
*
*/
@ -111,7 +111,7 @@ var rtlDefaults = {
var fc = $.fullCalendar = { version: "1.5.3" };
var fc = $.fullCalendar = { version: "1.5.4" };
var fcViews = fc.views = {};
@ -1658,7 +1658,7 @@ function sliceSegs(events, visEventEnds, start, end) {
msLength: segEnd - segStart
});
}
}
}
return segs.sort(segCmp);
}
@ -1742,29 +1742,26 @@ function setOuterHeight(element, height, includeMargins) {
}
// TODO: curCSS has been deprecated (jQuery 1.4.3 - 10/16/2010)
function hsides(element, includeMargins) {
return hpadding(element) + hborders(element) + (includeMargins ? hmargins(element) : 0);
}
function hpadding(element) {
return (parseFloat($.curCSS(element[0], 'paddingLeft', true)) || 0) +
(parseFloat($.curCSS(element[0], 'paddingRight', true)) || 0);
return (parseFloat($.css(element[0], 'paddingLeft', true)) || 0) +
(parseFloat($.css(element[0], 'paddingRight', true)) || 0);
}
function hmargins(element) {
return (parseFloat($.curCSS(element[0], 'marginLeft', true)) || 0) +
(parseFloat($.curCSS(element[0], 'marginRight', true)) || 0);
return (parseFloat($.css(element[0], 'marginLeft', true)) || 0) +
(parseFloat($.css(element[0], 'marginRight', true)) || 0);
}
function hborders(element) {
return (parseFloat($.curCSS(element[0], 'borderLeftWidth', true)) || 0) +
(parseFloat($.curCSS(element[0], 'borderRightWidth', true)) || 0);
return (parseFloat($.css(element[0], 'borderLeftWidth', true)) || 0) +
(parseFloat($.css(element[0], 'borderRightWidth', true)) || 0);
}
@ -1774,20 +1771,20 @@ function vsides(element, includeMargins) {
function vpadding(element) {
return (parseFloat($.curCSS(element[0], 'paddingTop', true)) || 0) +
(parseFloat($.curCSS(element[0], 'paddingBottom', true)) || 0);
return (parseFloat($.css(element[0], 'paddingTop', true)) || 0) +
(parseFloat($.css(element[0], 'paddingBottom', true)) || 0);
}
function vmargins(element) {
return (parseFloat($.curCSS(element[0], 'marginTop', true)) || 0) +
(parseFloat($.curCSS(element[0], 'marginBottom', true)) || 0);
return (parseFloat($.css(element[0], 'marginTop', true)) || 0) +
(parseFloat($.css(element[0], 'marginBottom', true)) || 0);
}
function vborders(element) {
return (parseFloat($.curCSS(element[0], 'borderTopWidth', true)) || 0) +
(parseFloat($.curCSS(element[0], 'borderBottomWidth', true)) || 0);
return (parseFloat($.css(element[0], 'borderTopWidth', true)) || 0) +
(parseFloat($.css(element[0], 'borderBottomWidth', true)) || 0);
}
@ -1956,7 +1953,6 @@ function firstDefined() {
}
fcViews.month = MonthView;
function MonthView(element, calendar) {
@ -4662,7 +4658,7 @@ function DayEventRenderer() {
"</span>";
}
html +=
"<span class='fc-event-title'>" + event.title + "</span>" +
"<span class='fc-event-title'>" + htmlEscape(event.title) + "</span>" +
"</div>";
if (seg.isEnd && isEventResizable(event)) {
html +=

View File

@ -1,6 +1,6 @@
/*
FullCalendar v1.5.3
FullCalendar v1.5.4
http://arshaw.com/fullcalendar/
Use fullcalendar.css for basic styling.
@ -11,7 +11,7 @@
Dual licensed under the MIT and GPL licenses, located in
MIT-LICENSE.txt and GPL-LICENSE.txt respectively.
Date: Mon Feb 6 22:40:40 2012 -0800
Date: Tue Sep 4 23:38:33 2012 -0700
*/
(function(m,ma){function wb(a){m.extend(true,Ya,a)}function Yb(a,b,e){function d(k){if(E){u();q();na();S(k)}else f()}function f(){B=b.theme?"ui":"fc";a.addClass("fc");b.isRTL&&a.addClass("fc-rtl");b.theme&&a.addClass("ui-widget");E=m("<div class='fc-content' style='position:relative'/>").prependTo(a);C=new Zb(X,b);(P=C.render())&&a.prepend(P);y(b.defaultView);m(window).resize(oa);t()||g()}function g(){setTimeout(function(){!n.start&&t()&&S()},0)}function l(){m(window).unbind("resize",oa);C.destroy();
@ -39,10 +39,10 @@ a[12])*1E3);lb(e,b)}else{e.setUTCFullYear(a[1],a[3]?a[3]-1:0,a[5]||1);e.setUTCHo
10):0)}}function Oa(a,b,e){return ib(a,null,b,e)}function ib(a,b,e,d){d=d||Ya;var f=a,g=b,l,j=e.length,t,y,S,Q="";for(l=0;l<j;l++){t=e.charAt(l);if(t=="'")for(y=l+1;y<j;y++){if(e.charAt(y)=="'"){if(f){Q+=y==l+1?"'":e.substring(l+1,y);l=y}break}}else if(t=="(")for(y=l+1;y<j;y++){if(e.charAt(y)==")"){l=Oa(f,e.substring(l+1,y),d);if(parseInt(l.replace(/\D/,""),10))Q+=l;l=y;break}}else if(t=="[")for(y=l+1;y<j;y++){if(e.charAt(y)=="]"){t=e.substring(l+1,y);l=Oa(f,t,d);if(l!=Oa(g,t,d))Q+=l;l=y;break}}else if(t==
"{"){f=b;g=a}else if(t=="}"){f=a;g=b}else{for(y=j;y>l;y--)if(S=dc[e.substring(l,y)]){if(f)Q+=S(f,d);l=y-1;break}if(y==l)if(f)Q+=t}}return Q}function Ua(a){return a.end?ec(a.end,a.allDay):ba(N(a.start),1)}function ec(a,b){a=N(a);return b||a.getHours()||a.getMinutes()?ba(a,1):Ka(a)}function fc(a,b){return(b.msLength-a.msLength)*100+(a.event.start-b.event.start)}function Cb(a,b){return a.end>b.start&&a.start<b.end}function nb(a,b,e,d){var f=[],g,l=a.length,j,t,y,S,Q;for(g=0;g<l;g++){j=a[g];t=j.start;
y=b[g];if(y>e&&t<d){if(t<e){t=N(e);S=false}else{t=t;S=true}if(y>d){y=N(d);Q=false}else{y=y;Q=true}f.push({event:j,start:t,end:y,isStart:S,isEnd:Q,msLength:y-t})}}return f.sort(fc)}function ob(a){var b=[],e,d=a.length,f,g,l,j;for(e=0;e<d;e++){f=a[e];for(g=0;;){l=false;if(b[g])for(j=0;j<b[g].length;j++)if(Cb(b[g][j],f)){l=true;break}if(l)g++;else break}if(b[g])b[g].push(f);else b[g]=[f]}return b}function Db(a,b,e){a.unbind("mouseover").mouseover(function(d){for(var f=d.target,g;f!=this;){g=f;f=f.parentNode}if((f=
g._fci)!==ma){g._fci=ma;g=b[f];e(g.event,g.element,g);m(d.target).trigger(d)}d.stopPropagation()})}function Va(a,b,e){for(var d=0,f;d<a.length;d++){f=m(a[d]);f.width(Math.max(0,b-pb(f,e)))}}function Eb(a,b,e){for(var d=0,f;d<a.length;d++){f=m(a[d]);f.height(Math.max(0,b-Sa(f,e)))}}function pb(a,b){return gc(a)+hc(a)+(b?ic(a):0)}function gc(a){return(parseFloat(m.curCSS(a[0],"paddingLeft",true))||0)+(parseFloat(m.curCSS(a[0],"paddingRight",true))||0)}function ic(a){return(parseFloat(m.curCSS(a[0],
"marginLeft",true))||0)+(parseFloat(m.curCSS(a[0],"marginRight",true))||0)}function hc(a){return(parseFloat(m.curCSS(a[0],"borderLeftWidth",true))||0)+(parseFloat(m.curCSS(a[0],"borderRightWidth",true))||0)}function Sa(a,b){return jc(a)+kc(a)+(b?Fb(a):0)}function jc(a){return(parseFloat(m.curCSS(a[0],"paddingTop",true))||0)+(parseFloat(m.curCSS(a[0],"paddingBottom",true))||0)}function Fb(a){return(parseFloat(m.curCSS(a[0],"marginTop",true))||0)+(parseFloat(m.curCSS(a[0],"marginBottom",true))||0)}
function kc(a){return(parseFloat(m.curCSS(a[0],"borderTopWidth",true))||0)+(parseFloat(m.curCSS(a[0],"borderBottomWidth",true))||0)}function Za(a,b){b=typeof b=="number"?b+"px":b;a.each(function(e,d){d.style.cssText+=";min-height:"+b+";_height:"+b})}function xb(){}function Gb(a,b){return a-b}function Hb(a){return Math.max.apply(Math,a)}function Pa(a){return(a<10?"0":"")+a}function jb(a,b){if(a[b]!==ma)return a[b];b=b.split(/(?=[A-Z])/);for(var e=b.length-1,d;e>=0;e--){d=a[b[e].toLowerCase()];if(d!==
ma)return d}return a[""]}function Qa(a){return a.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/'/g,"&#039;").replace(/"/g,"&quot;").replace(/\n/g,"<br />")}function Ib(a){return a.id+"/"+a.className+"/"+a.style.cssText.replace(/(^|;)\s*(top|left|width|height)\s*:[^;]*/ig,"")}function qb(a){a.attr("unselectable","on").css("MozUserSelect","none").bind("selectstart.ui",function(){return false})}function ab(a){a.children().removeClass("fc-first fc-last").filter(":first-child").addClass("fc-first").end().filter(":last-child").addClass("fc-last")}
g._fci)!==ma){g._fci=ma;g=b[f];e(g.event,g.element,g);m(d.target).trigger(d)}d.stopPropagation()})}function Va(a,b,e){for(var d=0,f;d<a.length;d++){f=m(a[d]);f.width(Math.max(0,b-pb(f,e)))}}function Eb(a,b,e){for(var d=0,f;d<a.length;d++){f=m(a[d]);f.height(Math.max(0,b-Sa(f,e)))}}function pb(a,b){return gc(a)+hc(a)+(b?ic(a):0)}function gc(a){return(parseFloat(m.css(a[0],"paddingLeft",true))||0)+(parseFloat(m.css(a[0],"paddingRight",true))||0)}function ic(a){return(parseFloat(m.css(a[0],"marginLeft",
true))||0)+(parseFloat(m.css(a[0],"marginRight",true))||0)}function hc(a){return(parseFloat(m.css(a[0],"borderLeftWidth",true))||0)+(parseFloat(m.css(a[0],"borderRightWidth",true))||0)}function Sa(a,b){return jc(a)+kc(a)+(b?Fb(a):0)}function jc(a){return(parseFloat(m.css(a[0],"paddingTop",true))||0)+(parseFloat(m.css(a[0],"paddingBottom",true))||0)}function Fb(a){return(parseFloat(m.css(a[0],"marginTop",true))||0)+(parseFloat(m.css(a[0],"marginBottom",true))||0)}function kc(a){return(parseFloat(m.css(a[0],
"borderTopWidth",true))||0)+(parseFloat(m.css(a[0],"borderBottomWidth",true))||0)}function Za(a,b){b=typeof b=="number"?b+"px":b;a.each(function(e,d){d.style.cssText+=";min-height:"+b+";_height:"+b})}function xb(){}function Gb(a,b){return a-b}function Hb(a){return Math.max.apply(Math,a)}function Pa(a){return(a<10?"0":"")+a}function jb(a,b){if(a[b]!==ma)return a[b];b=b.split(/(?=[A-Z])/);for(var e=b.length-1,d;e>=0;e--){d=a[b[e].toLowerCase()];if(d!==ma)return d}return a[""]}function Qa(a){return a.replace(/&/g,
"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/'/g,"&#039;").replace(/"/g,"&quot;").replace(/\n/g,"<br />")}function Ib(a){return a.id+"/"+a.className+"/"+a.style.cssText.replace(/(^|;)\s*(top|left|width|height)\s*:[^;]*/ig,"")}function qb(a){a.attr("unselectable","on").css("MozUserSelect","none").bind("selectstart.ui",function(){return false})}function ab(a){a.children().removeClass("fc-first fc-last").filter(":first-child").addClass("fc-first").end().filter(":last-child").addClass("fc-last")}
function rb(a,b){a.each(function(e,d){d.className=d.className.replace(/^fc-\w*/,"fc-"+lc[b.getDay()])})}function Jb(a,b){var e=a.source||{},d=a.color,f=e.color,g=b("eventColor"),l=a.backgroundColor||d||e.backgroundColor||f||b("eventBackgroundColor")||g;d=a.borderColor||d||e.borderColor||f||b("eventBorderColor")||g;a=a.textColor||e.textColor||b("eventTextColor");b=[];l&&b.push("background-color:"+l);d&&b.push("border-color:"+d);a&&b.push("color:"+a);return b.join(";")}function $a(a,b,e){if(m.isFunction(a))a=
[a];if(a){var d,f;for(d=0;d<a.length;d++)f=a[d].apply(b,e)||f;return f}}function Ta(){for(var a=0;a<arguments.length;a++)if(arguments[a]!==ma)return arguments[a]}function mc(a,b){function e(j,t){if(t){hb(j,t);j.setDate(1)}j=N(j,true);j.setDate(1);t=hb(N(j),1);var y=N(j),S=N(t),Q=f("firstDay"),q=f("weekends")?0:1;if(q){Fa(y);Fa(S,-1,true)}ba(y,-((y.getDay()-Math.max(Q,q)+7)%7));ba(S,(7-S.getDay()+Math.max(Q,q))%7);Q=Math.round((S-y)/(Ab*7));if(f("weekMode")=="fixed"){ba(S,(6-Q)*7);Q=6}d.title=l(j,
f("titleFormat"));d.start=j;d.end=t;d.visStart=y;d.visEnd=S;g(6,Q,q?5:7,true)}var d=this;d.render=e;sb.call(d,a,b,"month");var f=d.opt,g=d.renderBasic,l=b.formatDate}function nc(a,b){function e(j,t){t&&ba(j,t*7);j=ba(N(j),-((j.getDay()-f("firstDay")+7)%7));t=ba(N(j),7);var y=N(j),S=N(t),Q=f("weekends");if(!Q){Fa(y);Fa(S,-1,true)}d.title=l(y,ba(N(S),-1),f("titleFormat"));d.start=j;d.end=t;d.visStart=y;d.visEnd=S;g(1,1,Q?7:5,false)}var d=this;d.render=e;sb.call(d,a,b,"basicWeek");var f=d.opt,g=d.renderBasic,
@ -106,7 +106,7 @@ t,y=-1,S=-1;for(t=0;t<l;t++)if(g>=e[t][0]&&g<e[t][1]){y=t;break}for(t=0;t<j;t++)
g=l=null;a.build();b(t);d=y||"mousemove";m(document).bind(d,b)};e.stop=function(){m(document).unbind(d,b);return l}}function xc(a){if(a.pageX===ma){a.pageX=a.originalEvent.pageX;a.pageY=a.originalEvent.pageY}}function Pb(a){function b(l){return d[l]=d[l]||a(l)}var e=this,d={},f={},g={};e.left=function(l){return f[l]=f[l]===ma?b(l).position().left:f[l]};e.right=function(l){return g[l]=g[l]===ma?e.left(l)+b(l).width():g[l]};e.clear=function(){d={};f={};g={}}}var Ya={defaultView:"month",aspectRatio:1.35,
header:{left:"title",center:"",right:"today prev,next"},weekends:true,allDayDefault:true,ignoreTimezone:true,lazyFetching:true,startParam:"start",endParam:"end",titleFormat:{month:"MMMM yyyy",week:"MMM d[ yyyy]{ '&#8212;'[ MMM] d yyyy}",day:"dddd, MMM d, yyyy"},columnFormat:{month:"ddd",week:"ddd M/d",day:"dddd M/d"},timeFormat:{"":"h(:mm)t"},isRTL:false,firstDay:0,monthNames:["January","February","March","April","May","June","July","August","September","October","November","December"],monthNamesShort:["Jan",
"Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],dayNames:["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],dayNamesShort:["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],buttonText:{prev:"&nbsp;&#9668;&nbsp;",next:"&nbsp;&#9658;&nbsp;",prevYear:"&nbsp;&lt;&lt;&nbsp;",nextYear:"&nbsp;&gt;&gt;&nbsp;",today:"today",month:"month",week:"week",day:"day"},theme:false,buttonIcons:{prev:"circle-triangle-w",next:"circle-triangle-e"},unselectAuto:true,dropAccept:"*"},yc=
{header:{left:"next,prev today",center:"",right:"title"},buttonText:{prev:"&nbsp;&#9658;&nbsp;",next:"&nbsp;&#9668;&nbsp;",prevYear:"&nbsp;&gt;&gt;&nbsp;",nextYear:"&nbsp;&lt;&lt;&nbsp;"},buttonIcons:{prev:"circle-triangle-e",next:"circle-triangle-w"}},Aa=m.fullCalendar={version:"1.5.3"},Ja=Aa.views={};m.fn.fullCalendar=function(a){if(typeof a=="string"){var b=Array.prototype.slice.call(arguments,1),e;this.each(function(){var f=m.data(this,"fullCalendar");if(f&&m.isFunction(f[a])){f=f[a].apply(f,
{header:{left:"next,prev today",center:"",right:"title"},buttonText:{prev:"&nbsp;&#9658;&nbsp;",next:"&nbsp;&#9668;&nbsp;",prevYear:"&nbsp;&gt;&gt;&nbsp;",nextYear:"&nbsp;&lt;&lt;&nbsp;"},buttonIcons:{prev:"circle-triangle-e",next:"circle-triangle-w"}},Aa=m.fullCalendar={version:"1.5.4"},Ja=Aa.views={};m.fn.fullCalendar=function(a){if(typeof a=="string"){var b=Array.prototype.slice.call(arguments,1),e;this.each(function(){var f=m.data(this,"fullCalendar");if(f&&m.isFunction(f[a])){f=f[a].apply(f,
b);if(e===ma)e=f;a=="destroy"&&m.removeData(this,"fullCalendar")}});if(e!==ma)return e;return this}var d=a.eventSources||[];delete a.eventSources;if(a.events){d.push(a.events);delete a.events}a=m.extend(true,{},Ya,a.isRTL||a.isRTL===ma&&Ya.isRTL?yc:{},a);this.each(function(f,g){f=m(g);g=new Yb(f,a,d);f.data("fullCalendar",g);g.render()});return this};Aa.sourceNormalizers=[];Aa.sourceFetchers=[];var ac={dataType:"json",cache:false},bc=1;Aa.addDays=ba;Aa.cloneDate=N;Aa.parseDate=kb;Aa.parseISO8601=
Bb;Aa.parseTime=mb;Aa.formatDate=Oa;Aa.formatDates=ib;var lc=["sun","mon","tue","wed","thu","fri","sat"],Ab=864E5,cc=36E5,wc=6E4,dc={s:function(a){return a.getSeconds()},ss:function(a){return Pa(a.getSeconds())},m:function(a){return a.getMinutes()},mm:function(a){return Pa(a.getMinutes())},h:function(a){return a.getHours()%12||12},hh:function(a){return Pa(a.getHours()%12||12)},H:function(a){return a.getHours()},HH:function(a){return Pa(a.getHours())},d:function(a){return a.getDate()},dd:function(a){return Pa(a.getDate())},
ddd:function(a,b){return b.dayNamesShort[a.getDay()]},dddd:function(a,b){return b.dayNames[a.getDay()]},M:function(a){return a.getMonth()+1},MM:function(a){return Pa(a.getMonth()+1)},MMM:function(a,b){return b.monthNamesShort[a.getMonth()]},MMMM:function(a,b){return b.monthNames[a.getMonth()]},yy:function(a){return(a.getFullYear()+"").substring(2)},yyyy:function(a){return a.getFullYear()},t:function(a){return a.getHours()<12?"a":"p"},tt:function(a){return a.getHours()<12?"am":"pm"},T:function(a){return a.getHours()<

View File

@ -1,11 +1,11 @@
/*
* FullCalendar v1.5.3 Google Calendar Plugin
* FullCalendar v1.5.4 Google Calendar Plugin
*
* Copyright (c) 2011 Adam Shaw
* Dual licensed under the MIT and GPL licenses, located in
* MIT-LICENSE.txt and GPL-LICENSE.txt respectively.
*
* Date: Mon Feb 6 22:40:40 2012 -0800
* Date: Tue Sep 4 23:38:33 2012 -0700
*
*/

View File

@ -1 +1 @@
0.9.5
0.9.8

745
3rdparty/js/chosen/chosen.jquery.js vendored Normal file → Executable file

File diff suppressed because it is too large Load Diff

4
3rdparty/js/chosen/chosen.jquery.min.js vendored Normal file → Executable file

File diff suppressed because one or more lines are too long

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 KiB

After

Width:  |  Height:  |  Size: 706 B

View File

@ -1,19 +1,13 @@
.miniColors-trigger {
height: 22px;
width: 22px;
background: url(images/trigger.png) center no-repeat;
vertical-align: middle;
margin: 0 .25em;
display: inline-block;
outline: none;
INPUT.miniColors {
margin-right: 4px;
}
.miniColors-selector {
position: absolute;
width: 175px;
height: 150px;
background: #FFF;
border: solid 1px #BBB;
background: white;
border: solid 1px #bababa;
-moz-box-shadow: 0 0 6px rgba(0, 0, 0, .25);
-webkit-box-shadow: 0 0 6px rgba(0, 0, 0, .25);
box-shadow: 0 0 6px rgba(0, 0, 0, .25);
@ -24,9 +18,13 @@
z-index: 999999;
}
.miniColors.opacity.miniColors-selector {
width: 200px;
}
.miniColors-selector.black {
background: #000;
border-color: #000;
background: black;
border-color: black;
}
.miniColors-colors {
@ -35,25 +33,43 @@
left: 5px;
width: 150px;
height: 150px;
background: url(images/colors.png) right no-repeat;
background: url(images/colors.png) -40px 0 no-repeat;
cursor: crosshair;
}
.miniColors.opacity .miniColors-colors {
left: 30px;
}
.miniColors-hues {
position: absolute;
top: 5px;
left: 160px;
width: 20px;
height: 150px;
background: url(images/colors.png) left no-repeat;
background: url(images/colors.png) 0 0 no-repeat;
cursor: crosshair;
}
.miniColors.opacity .miniColors-hues {
left: 185px;
}
.miniColors-opacity {
position: absolute;
top: 5px;
left: 5px;
width: 20px;
height: 150px;
background: url(images/colors.png) -20px 0 no-repeat;
cursor: crosshair;
}
.miniColors-colorPicker {
position: absolute;
width: 9px;
height: 9px;
border: 1px solid #fff;
width: 11px;
height: 11px;
border: 1px solid black;
-moz-border-radius: 11px;
-webkit-border-radius: 11px;
border-radius: 11px;
@ -64,18 +80,46 @@
left: 0;
width: 7px;
height: 7px;
border: 1px solid #000;
border: 2px solid white;
-moz-border-radius: 9px;
-webkit-border-radius: 9px;
border-radius: 9px;
}
.miniColors-huePicker {
.miniColors-huePicker,
.miniColors-opacityPicker {
position: absolute;
left: -3px;
width: 24px;
height: 1px;
border: 1px solid #fff;
left: -2px;
width: 22px;
height: 2px;
border: 1px solid black;
background: white;
margin-top: -1px;
border-radius: 2px;
background: #000;
}
.miniColors-trigger,
.miniColors-triggerWrap {
width: 22px;
height: 22px;
display: inline-block;
}
.miniColors-triggerWrap {
background: url(images/trigger.png) -22px 0 no-repeat;
}
.miniColors-triggerWrap.disabled {
filter: alpha(opacity=50);
opacity: .5;
}
.miniColors-trigger {
vertical-align: middle;
outline: none;
background: url(images/trigger.png) 0 0 no-repeat;
}
.miniColors-triggerWrap.disabled .miniColors-trigger {
cursor: default;
}

View File

@ -1,7 +1,7 @@
/*
* jQuery miniColors: A small color selector
*
* Copyright 2011 Cory LaViska for A Beautiful Site, LLC. (http://abeautifulsite.net/)
* Copyright 2012 Cory LaViska for A Beautiful Site, LLC. (http://www.abeautifulsite.net/)
*
* Dual licensed under the MIT or GPL Version 2 licenses
*
@ -18,20 +18,30 @@ if(jQuery) (function($) {
//
// Determine initial color (defaults to white)
var color = expandHex(input.val());
if( !color ) color = 'ffffff';
var hsb = hex2hsb(color);
var color = expandHex(input.val()) || 'ffffff',
hsb = hex2hsb(color),
rgb = hsb2rgb(hsb),
alpha = parseFloat(input.attr('data-opacity')).toFixed(2);
if( alpha > 1 ) alpha = 1;
if( alpha < 0 ) alpha = 0;
// Create trigger
var trigger = $('<a class="miniColors-trigger" style="background-color: #' + color + '" href="#"></a>');
trigger.insertAfter(input);
trigger.wrap('<span class="miniColors-triggerWrap"></span>');
if( o.opacity ) {
trigger.css('backgroundColor', 'rgba(' + rgb.r + ', ' + rgb.g + ', ' + rgb.b + ', ' + alpha + ')');
}
// Set input data and update attributes
input
.addClass('miniColors')
.data('original-maxlength', input.attr('maxlength') || null)
.data('original-autocomplete', input.attr('autocomplete') || null)
.data('letterCase', 'uppercase')
.data('letterCase', o.letterCase === 'uppercase' ? 'uppercase' : 'lowercase')
.data('opacity', o.opacity ? true : false)
.data('alpha', alpha)
.data('trigger', trigger)
.data('hsb', hsb)
.data('change', o.change ? o.change : null)
@ -42,11 +52,11 @@ if(jQuery) (function($) {
.val('#' + convertCase(color, o.letterCase));
// Handle options
if( o.readonly ) input.prop('readonly', true);
if( o.disabled ) disable(input);
if( o.readonly || input.prop('readonly') ) input.prop('readonly', true);
if( o.disabled || input.prop('disabled') ) disable(input);
// Show selector when trigger is clicked
trigger.bind('click.miniColors', function(event) {
trigger.on('click.miniColors', function(event) {
event.preventDefault();
if( input.val() === '' ) input.val('#');
show(input);
@ -54,29 +64,29 @@ if(jQuery) (function($) {
});
// Show selector when input receives focus
input.bind('focus.miniColors', function(event) {
input.on('focus.miniColors', function(event) {
if( input.val() === '' ) input.val('#');
show(input);
});
// Hide on blur
input.bind('blur.miniColors', function(event) {
input.on('blur.miniColors', function(event) {
var hex = expandHex( hsb2hex(input.data('hsb')) );
input.val( hex ? '#' + convertCase(hex, input.data('letterCase')) : '' );
});
// Hide when tabbing out of the input
input.bind('keydown.miniColors', function(event) {
input.on('keydown.miniColors', function(event) {
if( event.keyCode === 9 ) hide(input);
});
// Update when color is typed in
input.bind('keyup.miniColors', function(event) {
input.on('keyup.miniColors', function(event) {
setColorFromInput(input);
});
// Handle pasting
input.bind('paste.miniColors', function(event) {
input.on('paste.miniColors', function(event) {
// Short pause to wait for paste to complete
setTimeout( function() {
setColorFromInput(input);
@ -89,19 +99,18 @@ if(jQuery) (function($) {
//
// Destroys an active instance of the miniColors selector
//
hide();
input = $(input);
// Restore to original state
input.data('trigger').remove();
input.data('trigger').parent().remove();
input
.attr('autocomplete', input.data('original-autocomplete'))
.attr('maxlength', input.data('original-maxlength'))
.removeData()
.removeClass('miniColors')
.unbind('.miniColors');
$(document).unbind('.miniColors');
.off('.miniColors');
$(document).off('.miniColors');
};
var enable = function(input) {
@ -110,8 +119,7 @@ if(jQuery) (function($) {
//
input
.prop('disabled', false)
.data('trigger')
.css('opacity', 1);
.data('trigger').parent().removeClass('disabled');
};
var disable = function(input) {
@ -121,8 +129,7 @@ if(jQuery) (function($) {
hide(input);
input
.prop('disabled', true)
.data('trigger')
.css('opacity', 0.5);
.data('trigger').parent().addClass('disabled');
};
var show = function(input) {
@ -133,24 +140,27 @@ if(jQuery) (function($) {
// Hide all other instances
hide();
// Generate the selector
var selector = $('<div class="miniColors-selector"></div>');
selector
.append('<div class="miniColors-colors" style="background-color: #FFF;"><div class="miniColors-colorPicker"><div class="miniColors-colorPicker-inner"></div></div>')
.append('<div class="miniColors-hues"><div class="miniColors-huePicker"></div></div>')
.css({
top: input.is(':visible') ? input.offset().top + input.outerHeight() : input.data('trigger').offset().top + input.data('trigger').outerHeight(),
left: input.is(':visible') ? input.offset().left : input.data('trigger').offset().left,
display: 'none'
})
.append('<div class="miniColors-colors" style="background-color: #FFF;"><div class="miniColors-colorPicker"><div class="miniColors-colorPicker-inner"></div></div>')
.css('display', 'none')
.addClass( input.attr('class') );
// Opacity
if( input.data('opacity') ) {
selector
.addClass('opacity')
.prepend('<div class="miniColors-opacity"><div class="miniColors-opacityPicker"></div></div>');
}
// Set background for colors
var hsb = input.data('hsb');
selector
.find('.miniColors-colors')
.css('backgroundColor', '#' + hsb2hex({ h: hsb.h, s: 100, b: 100 }));
.find('.miniColors-colors').css('backgroundColor', '#' + hsb2hex({ h: hsb.h, s: 100, b: 100 })).end()
.find('.miniColors-opacity').css('backgroundColor', '#' + hsb2hex({ h: hsb.h, s: hsb.s, b: hsb.b })).end();
// Set colorPicker position
var colorPosition = input.data('colorPosition');
@ -162,64 +172,106 @@ if(jQuery) (function($) {
// Set huePicker position
var huePosition = input.data('huePosition');
if( !huePosition ) huePosition = getHuePositionFromHSB(hsb);
selector.find('.miniColors-huePicker').css('top', huePosition.y + 'px');
selector.find('.miniColors-huePicker').css('top', huePosition + 'px');
// Set opacity position
var opacityPosition = input.data('opacityPosition');
if( !opacityPosition ) opacityPosition = getOpacityPositionFromAlpha(input.attr('data-opacity'));
selector.find('.miniColors-opacityPicker').css('top', opacityPosition + 'px');
// Set input data
input
.data('selector', selector)
.data('huePicker', selector.find('.miniColors-huePicker'))
.data('opacityPicker', selector.find('.miniColors-opacityPicker'))
.data('colorPicker', selector.find('.miniColors-colorPicker'))
.data('mousebutton', 0);
$('BODY').append(selector);
selector.fadeIn(100);
// Position the selector
var trigger = input.data('trigger'),
hidden = !input.is(':visible'),
top = hidden ? trigger.offset().top + trigger.outerHeight() : input.offset().top + input.outerHeight(),
left = hidden ? trigger.offset().left : input.offset().left,
selectorWidth = selector.outerWidth(),
selectorHeight = selector.outerHeight(),
triggerWidth = trigger.outerWidth(),
triggerHeight = trigger.outerHeight(),
windowHeight = $(window).height(),
windowWidth = $(window).width(),
scrollTop = $(window).scrollTop(),
scrollLeft = $(window).scrollLeft();
// Adjust based on viewport
if( (top + selectorHeight) > windowHeight + scrollTop ) top = top - selectorHeight - triggerHeight;
if( (left + selectorWidth) > windowWidth + scrollLeft ) left = left - selectorWidth + triggerWidth;
// Set position and show
selector.css({
top: top,
left: left
}).fadeIn(100);
// Prevent text selection in IE
selector.bind('selectstart', function() { return false; });
selector.on('selectstart', function() { return false; });
$(document).bind('mousedown.miniColors touchstart.miniColors', function(event) {
input.data('mousebutton', 1);
var testSubject = $(event.target).parents().andSelf();
if( testSubject.hasClass('miniColors-colors') ) {
event.preventDefault();
input.data('moving', 'colors');
moveColor(input, event);
}
if( testSubject.hasClass('miniColors-hues') ) {
event.preventDefault();
input.data('moving', 'hues');
moveHue(input, event);
}
if( testSubject.hasClass('miniColors-selector') ) {
event.preventDefault();
return;
}
if( testSubject.hasClass('miniColors') ) return;
hide(input);
});
// Hide on resize (IE7/8 trigger this when any element is resized...)
if( !$.browser.msie || ($.browser.msie && $.browser.version >= 9) ) {
$(window).on('resize.miniColors', function(event) {
hide(input);
});
}
$(document)
.bind('mouseup.miniColors touchend.miniColors', function(event) {
.on('mousedown.miniColors touchstart.miniColors', function(event) {
input.data('mousebutton', 1);
var testSubject = $(event.target).parents().andSelf();
if( testSubject.hasClass('miniColors-colors') ) {
event.preventDefault();
input.data('moving', 'colors');
moveColor(input, event);
}
if( testSubject.hasClass('miniColors-hues') ) {
event.preventDefault();
input.data('moving', 'hues');
moveHue(input, event);
}
if( testSubject.hasClass('miniColors-opacity') ) {
event.preventDefault();
input.data('moving', 'opacity');
moveOpacity(input, event);
}
if( testSubject.hasClass('miniColors-selector') ) {
event.preventDefault();
return;
}
if( testSubject.hasClass('miniColors') ) return;
hide(input);
})
.on('mouseup.miniColors touchend.miniColors', function(event) {
event.preventDefault();
input.data('mousebutton', 0).removeData('moving');
})
.bind('mousemove.miniColors touchmove.miniColors', function(event) {
.on('mousemove.miniColors touchmove.miniColors', function(event) {
event.preventDefault();
if( input.data('mousebutton') === 1 ) {
if( input.data('moving') === 'colors' ) moveColor(input, event);
if( input.data('moving') === 'hues' ) moveHue(input, event);
if( input.data('moving') === 'opacity' ) moveOpacity(input, event);
}
});
// Fire open callback
if( input.data('open') ) {
input.data('open').call(input.get(0), '#' + hsb2hex(hsb), hsb2rgb(hsb));
input.data('open').call(input.get(0), '#' + hsb2hex(hsb), $.extend(hsb2rgb(hsb), { a: parseFloat(input.attr('data-opacity')) }));
}
};
@ -231,22 +283,22 @@ if(jQuery) (function($) {
//
// Hide all other instances if input isn't specified
if( !input ) input = '.miniColors';
if( !input ) input = $('.miniColors');
$(input).each( function() {
input.each( function() {
var selector = $(this).data('selector');
$(this).removeData('selector');
$(selector).fadeOut(100, function() {
// Fire close callback
if( input.data('close') ) {
var hsb = input.data('hsb'), hex = hsb2hex(hsb);
input.data('close').call(input.get(0), '#' + hex, hsb2rgb(hsb));
input.data('close').call(input.get(0), '#' + hex, $.extend(hsb2rgb(hsb), { a: parseFloat(input.attr('data-opacity')) }));
}
$(this).remove();
});
});
$(document).unbind('.miniColors');
$(document).off('.miniColors');
};
@ -266,8 +318,8 @@ if(jQuery) (function($) {
position.x = event.originalEvent.changedTouches[0].pageX;
position.y = event.originalEvent.changedTouches[0].pageY;
}
position.x = position.x - input.data('selector').find('.miniColors-colors').offset().left - 5;
position.y = position.y - input.data('selector').find('.miniColors-colors').offset().top - 5;
position.x = position.x - input.data('selector').find('.miniColors-colors').offset().left - 6;
position.y = position.y - input.data('selector').find('.miniColors-colors').offset().top - 6;
if( position.x <= -5 ) position.x = -5;
if( position.x >= 144 ) position.x = 144;
if( position.y <= -5 ) position.y = -5;
@ -301,23 +353,21 @@ if(jQuery) (function($) {
huePicker.hide();
var position = {
y: event.pageY
};
var position = event.pageY;
// Touch support
if( event.originalEvent.changedTouches ) {
position.y = event.originalEvent.changedTouches[0].pageY;
position = event.originalEvent.changedTouches[0].pageY;
}
position.y = position.y - input.data('selector').find('.miniColors-colors').offset().top - 1;
if( position.y <= -1 ) position.y = -1;
if( position.y >= 149 ) position.y = 149;
position = position - input.data('selector').find('.miniColors-colors').offset().top - 1;
if( position <= -1 ) position = -1;
if( position >= 149 ) position = 149;
input.data('huePosition', position);
huePicker.css('top', position.y).show();
huePicker.css('top', position).show();
// Calculate hue
var h = Math.round((150 - position.y - 1) * 2.4);
var h = Math.round((150 - position - 1) * 2.4);
if( h < 0 ) h = 0;
if( h > 360 ) h = 360;
@ -330,18 +380,65 @@ if(jQuery) (function($) {
};
var moveOpacity = function(input, event) {
var opacityPicker = input.data('opacityPicker');
opacityPicker.hide();
var position = event.pageY;
// Touch support
if( event.originalEvent.changedTouches ) {
position = event.originalEvent.changedTouches[0].pageY;
}
position = position - input.data('selector').find('.miniColors-colors').offset().top - 1;
if( position <= -1 ) position = -1;
if( position >= 149 ) position = 149;
input.data('opacityPosition', position);
opacityPicker.css('top', position).show();
// Calculate opacity
var alpha = parseFloat((150 - position - 1) / 150).toFixed(2);
if( alpha < 0 ) alpha = 0;
if( alpha > 1 ) alpha = 1;
// Update opacity
input
.data('alpha', alpha)
.attr('data-opacity', alpha);
// Set color
setColor(input, input.data('hsb'), true);
};
var setColor = function(input, hsb, updateInput) {
input.data('hsb', hsb);
var hex = hsb2hex(hsb);
var hex = hsb2hex(hsb),
selector = $(input.data('selector'));
if( updateInput ) input.val( '#' + convertCase(hex, input.data('letterCase')) );
selector
.find('.miniColors-colors').css('backgroundColor', '#' + hsb2hex({ h: hsb.h, s: 100, b: 100 })).end()
.find('.miniColors-opacity').css('backgroundColor', '#' + hex).end();
var rgb = hsb2rgb(hsb);
// Set background color (also fallback for non RGBA browsers)
input.data('trigger').css('backgroundColor', '#' + hex);
if( input.data('selector') ) input.data('selector').find('.miniColors-colors').css('backgroundColor', '#' + hsb2hex({ h: hsb.h, s: 100, b: 100 }));
// Set background color + opacity
if( input.data('opacity') ) {
input.data('trigger').css('backgroundColor', 'rgba(' + rgb.r + ', ' + rgb.g + ', ' + rgb.b + ', ' + input.attr('data-opacity') + ')');
}
// Fire change callback
if( input.data('change') ) {
if( hex === input.data('lastChange') ) return;
input.data('change').call(input.get(0), '#' + hex, hsb2rgb(hsb));
input.data('lastChange', hex);
if( (hex + ',' + input.attr('data-opacity')) === input.data('lastChange') ) return;
input.data('change').call(input.get(0), '#' + hex, $.extend(hsb2rgb(hsb), { a: parseFloat(input.attr('data-opacity')) }));
input.data('lastChange', hex + ',' + input.attr('data-opacity'));
}
};
@ -355,10 +452,6 @@ if(jQuery) (function($) {
// Get HSB equivalent
var hsb = hex2hsb(hex);
// If color is the same, no change required
var currentHSB = input.data('hsb');
if( hsb.h === currentHSB.h && hsb.s === currentHSB.s && hsb.b === currentHSB.b ) return true;
// Set colorPicker position
var colorPosition = getColorPositionFromHSB(hsb);
var colorPicker = $(input.data('colorPicker'));
@ -368,9 +461,14 @@ if(jQuery) (function($) {
// Set huePosition position
var huePosition = getHuePositionFromHSB(hsb);
var huePicker = $(input.data('huePicker'));
huePicker.css('top', huePosition.y + 'px');
huePicker.css('top', huePosition + 'px');
input.data('huePosition', huePosition);
// Set opacity position
var opacityPosition = getOpacityPositionFromAlpha(input.attr('data-opacity'));
var opacityPicker = $(input.data('opacityPicker'));
opacityPicker.css('top', opacityPosition + 'px');
input.data('opacityPosition', opacityPosition);
setColor(input, hsb);
return true;
@ -378,9 +476,11 @@ if(jQuery) (function($) {
};
var convertCase = function(string, letterCase) {
if( letterCase === 'lowercase' ) return string.toLowerCase();
if( letterCase === 'uppercase' ) return string.toUpperCase();
return string;
if( letterCase === 'uppercase' ) {
return string.toUpperCase();
} else {
return string.toLowerCase();
}
};
var getColorPositionFromHSB = function(hsb) {
@ -397,7 +497,14 @@ if(jQuery) (function($) {
var y = 150 - (hsb.h / 2.4);
if( y < 0 ) h = 0;
if( y > 150 ) h = 150;
return { y: y - 1 };
return y;
};
var getOpacityPositionFromAlpha = function(alpha) {
var y = 150 * alpha;
if( y < 0 ) y = 0;
if( y > 150 ) y = 150;
return 150 - y;
};
var cleanHex = function(hex) {
@ -542,6 +649,29 @@ if(jQuery) (function($) {
});
return $(this);
case 'opacity':
// Getter
if( data === undefined ) {
if( !$(this).hasClass('miniColors') ) return;
if( $(this).data('opacity') ) {
return parseFloat($(this).attr('data-opacity'));
} else {
return null;
}
}
// Setter
$(this).each( function() {
if( !$(this).hasClass('miniColors') ) return;
if( data < 0 ) data = 0;
if( data > 1 ) data = 1;
$(this).attr('data-opacity', data).data('alpha', data);
setColorFromInput($(this));
});
return $(this);
case 'destroy':

File diff suppressed because one or more lines are too long

View File

@ -2000,7 +2000,7 @@ class CF_Object
// }
//use OC's mimetype detection for files
if(is_file($handle)){
if(@is_file($handle)){
$this->content_type=OC_Helper::getMimeType($handle);
}else{
$this->content_type=OC_Helper::getStringMimeType($handle);
@ -2537,7 +2537,7 @@ class CF_Object
}
$md5 = hash_final($ctx, false);
rewind($data);
} elseif ((string)is_file($data)) {
} elseif ((string)@is_file($data)) {
$md5 = md5_file($data);
} else {
$md5 = md5($data);

View File

@ -1,399 +0,0 @@
Simple Test interface changes
=============================
Because the SimpleTest tool set is still evolving it is likely that tests
written with earlier versions will fail with the newest ones. The most
dramatic changes are in the alpha releases. Here is a list of possible
problems and their fixes...
assertText() no longer finds a string inside a <script> tag
-----------------------------------------------------------
The assertText() method is intended to match only visible,
human-readable text on the web page. Therefore, the contents of script
tags should not be matched by this assertion. However there was a bug
in the text normalisation code of simpletest which meant that <script>
tags spanning multiple lines would not have their content stripped
out. If you want to check the content of a <script> tag, use
assertPattern(), or write a custom expectation.
Overloaded method not working
-----------------------------
All protected and private methods had underscores
removed. This means that any private/protected methods that
you overloaded with those names need to be updated.
Fatal error: Call to undefined method Classname::classname()
------------------------------------------------------------
SimpleTest renamed all of its constructors from
Classname to __construct; derived classes invoking
their parent constructors should replace parent::Classname()
with parent::__construct().
Custom CSS in HtmlReporter not being applied
--------------------------------------------
Batch rename of protected and private methods
means that _getCss() was renamed to getCss().
Please rename your method and it should work again.
setReturnReference() throws errors in E_STRICT
----------------------------------------------
Happens when an object is passed by reference.
This also happens with setReturnReferenceAt().
If you want to return objects then replace these
with calls to returns() and returnsAt() with the
same arguments. This change was forced in the 1.1
version for E_STRICT compatibility.
assertReference() throws errors in E_STRICT
-------------------------------------------
Due to language restrictions you cannot compare
both variables and objects in E_STRICT mode. Use
assertSame() in this mode with objects. This change
was forced the 1.1 version.
Cannot create GroupTest
-----------------------
The GroupTest has been renamed TestSuite (see below).
It was removed completely in 1.1 in favour of this
name.
No method getRelativeUrls() or getAbsoluteUrls()
------------------------------------------------
These methods were always a bit weird anyway, and
the new parsing of the base tag makes them more so.
They have been replaced with getUrls() instead. If
you want the old functionality then simply chop
off the current domain from getUrls().
Method setWildcard() removed in mocks
-------------------------------------
Even setWildcard() has been removed in 1.0.1beta now.
If you want to test explicitely for a '*' string, then
simply pass in new IdenticalExpectation('*') instead.
No method _getTest() on mocks
-----------------------------
This has finally been removed. It was a pretty esoteric
flex point anyway. It was there to allow the mocks to
work with other test tools, but no one does this.
No method assertError(), assertNoErrors(), swallowErrors()
----------------------------------------------------------
These have been deprecated in 1.0.1beta in favour of
expectError() and expectException(). assertNoErrors() is
redundant if you use expectError() as failures are now reported
immediately.
No method TestCase::signal()
----------------------------
This has been deprecated in favour of triggering an error or
throwing an exception. Deprecated as of 1.0.1beta.
No method TestCase::sendMessage()
---------------------------------
This has been deprecated as of 1.0.1beta.
Failure to connect now emits failures
-------------------------------------
It used to be that you would have to use the
getTransferError() call on the web tester to see if
there was a socket level error in a fetch. This check
is now always carried out by the WebTestCase unless
the fetch is prefaced with WebTestCase::ignoreErrors().
The ignore directive only lasts for the next fetching
action such as get() and click().
No method SimpleTestOptions::ignore()
-------------------------------------
This is deprecated in version 1.0.1beta and has been moved
to SimpleTest::ignore() as that is more readable. In
addition, parent classes are also ignored automatically.
If you are using PHP5 you can skip this directive simply
by marking your test case as abstract.
No method assertCopy()
----------------------
This is deprecated in 1.0.1 in favour of assertClone().
The assertClone() method is slightly different in that
the objects must be identical, but without being a
reference. It is thus not a strict inversion of
assertReference().
Constructor wildcard override has no effect in mocks
----------------------------------------------------
As of 1.0.1beta this is now set with setWildcard() instead
of in the constructor.
No methods setStubBaseClass()/getStubBaseClass()
------------------------------------------------
As mocks are now used instead of stubs, these methods
stopped working and are now removed as of the 1.0.1beta
release. The mock objects may be freely used instead.
No method addPartialMockCode()
------------------------------
The ability to insert arbitrary partial mock code
has been removed. This was a low value feature
causing needless complications. It was removed
in the 1.0.1beta release.
No method setMockBaseClass()
----------------------------
The ability to change the mock base class has been
scheduled for removal and is deprecated since the
1.0.1beta version. This was a rarely used feature
except as a workaround for PHP5 limitations. As
these limitations are being resolved it's hoped
that the bundled mocks can be used directly.
No class Stub
-------------
Server stubs are deprecated from 1.0.1 as the mocks now
have exactly the same interface. Just use mock objects
instead.
No class SimpleTestOptions
--------------------------
This was replced by the shorter SimpleTest in 1.0.1beta1
and is since deprecated.
No file simple_test.php
-----------------------
This was renamed test_case.php in 1.0.1beta to more accurately
reflect it's purpose. This file should never be directly
included in test suites though, as it's part of the
underlying mechanics and has a tendency to be refactored.
No class WantedPatternExpectation
---------------------------------
This was deprecated in 1.0.1alpha in favour of the simpler
name PatternExpectation.
No class NoUnwantedPatternExpectation
-------------------------------------
This was deprecated in 1.0.1alpha in favour of the simpler
name NoPatternExpectation.
No method assertNoUnwantedPattern()
-----------------------------------
This has been renamed to assertNoPattern() in 1.0.1alpha and
the old form is deprecated.
No method assertWantedPattern()
-------------------------------
This has been renamed to assertPattern() in 1.0.1alpha and
the old form is deprecated.
No method assertExpectation()
-----------------------------
This was renamed as assert() in 1.0.1alpha and the old form
has been deprecated.
No class WildcardExpectation
----------------------------
This was a mostly internal class for the mock objects. It was
renamed AnythingExpectation to bring it closer to JMock and
NMock in version 1.0.1alpha.
Missing UnitTestCase::assertErrorPattern()
------------------------------------------
This method is deprecated for version 1.0.1 onwards.
This method has been subsumed by assertError() that can now
take an expectation. Simply pass a PatternExpectation
into assertError() to simulate the old behaviour.
No HTML when matching page elements
-----------------------------------
This behaviour has been switched to using plain text as if it
were seen by the user of the browser. This means that HTML tags
are suppressed, entities are converted and whitespace is
normalised. This should make it easier to match items in forms.
Also images are replaced with their "alt" text so that they
can be matched as well.
No method SimpleRunner::_getTestCase()
--------------------------------------
This was made public as getTestCase() in 1.0RC2.
No method restartSession()
--------------------------
This was renamed to restart() in the WebTestCase, SimpleBrowser
and the underlying SimpleUserAgent in 1.0RC2. Because it was
undocumented anyway, no attempt was made at backward
compatibility.
My custom test case ignored by tally()
--------------------------------------
The _assertTrue method has had it's signature changed due to a bug
in the PHP 5.0.1 release. You must now use getTest() from within
that method to get the test case. Mock compatibility with other
unit testers is now deprecated as of 1.0.1alpha as PEAR::PHPUnit2
should soon have mock support of it's own.
Broken code extending SimpleRunner
----------------------------------
This was replaced with SimpleScorer so that I could use the runner
name in another class. This happened in RC1 development and there
is no easy backward compatibility fix. The solution is simply to
extend SimpleScorer instead.
Missing method getBaseCookieValue()
-----------------------------------
This was renamed getCurrentCookieValue() in RC1.
Missing files from the SimpleTest suite
---------------------------------------
Versions of SimpleTest prior to Beta6 required a SIMPLE_TEST constant
to point at the SimpleTest folder location before any of the toolset
was loaded. This is no longer documented as it is now unnecessary
for later versions. If you are using an earlier version you may
need this constant. Consult the documentation that was bundled with
the release that you are using or upgrade to Beta6 or later.
No method SimpleBrowser::getCurrentUrl()
--------------------------------------
This is replaced with the more versatile showRequest() for
debugging. It only existed in this context for version Beta5.
Later versions will have SimpleBrowser::getHistory() for tracking
paths through pages. It is renamed as getUrl() since 1.0RC1.
No method Stub::setStubBaseClass()
----------------------------------
This method has finally been removed in 1.0RC1. Use
SimpleTestOptions::setStubBaseClass() instead.
No class CommandLineReporter
----------------------------
This was renamed to TextReporter in Beta3 and the deprecated version
was removed in 1.0RC1.
No method requireReturn()
-------------------------
This was deprecated in Beta3 and is now removed.
No method expectCookie()
------------------------
This method was abruptly removed in Beta4 so as to simplify the internals
until another mechanism can replace it. As a workaround it is necessary
to assert that the cookie has changed by setting it before the page
fetch and then assert the desired value.
No method clickSubmitByFormId()
-------------------------------
This method had an incorrect name as no button was involved. It was
renamed to submitByFormId() in Beta4 and the old version deprecated.
Now removed.
No method paintStart() or paintEnd()
------------------------------------
You should only get this error if you have subclassed the lower level
reporting and test runner machinery. These methods have been broken
down into events for test methods, events for test cases and events
for group tests. The new methods are...
paintStart() --> paintMethodStart(), paintCaseStart(), paintGroupStart()
paintEnd() --> paintMethodEnd(), paintCaseEnd(), paintGroupEnd()
This change was made in Beta3, ironically to make it easier to subclass
the inner machinery. Simply duplicating the code you had in the previous
methods should provide a temporary fix.
No class TestDisplay
--------------------
This has been folded into SimpleReporter in Beta3 and is now deprecated.
It was removed in RC1.
No method WebTestCase::fetch()
------------------------------
This was renamed get() in Alpha8. It is removed in Beta3.
No method submit()
------------------
This has been renamed clickSubmit() in Beta1. The old method was
removed in Beta2.
No method clearHistory()
------------------------
This method is deprecated in Beta2 and removed in RC1.
No method getCallCount()
------------------------
This method has been deprecated since Beta1 and has now been
removed. There are now more ways to set expectations on counts
and so this method should be unecessery. Removed in RC1.
Cannot find file *
------------------
The following public name changes have occoured...
simple_html_test.php --> reporter.php
simple_mock.php --> mock_objects.php
simple_unit.php --> unit_tester.php
simple_web.php --> web_tester.php
The old names were deprecated in Alpha8 and removed in Beta1.
No method attachObserver()
--------------------------
Prior to the Alpha8 release the old internal observer pattern was
gutted and replaced with a visitor. This is to trade flexibility of
test case expansion against the ease of writing user interfaces.
Code such as...
$test = &new MyTestCase();
$test->attachObserver(new TestHtmlDisplay());
$test->run();
...should be rewritten as...
$test = &new MyTestCase();
$test->run(new HtmlReporter());
If you previously attached multiple observers then the workaround
is to run the tests twice, once with each, until they can be combined.
For one observer the old method is simulated in Alpha 8, but is
removed in Beta1.
No class TestHtmlDisplay
------------------------
This class has been renamed to HtmlReporter in Alpha8. It is supported,
but deprecated in Beta1 and removed in Beta2. If you have subclassed
the display for your own design, then you will have to extend this
class (HtmlReporter) instead.
If you have accessed the event queue by overriding the notify() method
then I am afraid you are in big trouble :(. The reporter is now
carried around the test suite by the runner classes and the methods
called directly. In the unlikely event that this is a problem and
you don't want to upgrade the test tool then simplest is to write your
own runner class and invoke the tests with...
$test->accept(new MyRunner(new MyReporter()));
...rather than the run method. This should be easier to extend
anyway and gives much more control. Even this method is overhauled
in Beta3 where the runner class can be set within the test case. Really
the best thing to do is to upgrade to this version as whatever you were
trying to achieve before should now be very much easier.
Missing set options method
--------------------------
All test suite options are now in one class called SimpleTestOptions.
This means that options are set differently...
GroupTest::ignore() --> SimpleTestOptions::ignore()
Mock::setMockBaseClass() --> SimpleTestOptions::setMockBaseClass()
These changed in Alpha8 and the old versions are now removed in RC1.
No method setExpected*()
------------------------
The mock expectations changed their names in Alpha4 and the old names
ceased to be supported in Alpha8. The changes are...
setExpectedArguments() --> expectArguments()
setExpectedArgumentsSequence() --> expectArgumentsAt()
setExpectedCallCount() --> expectCallCount()
setMaximumCallCount() --> expectMaximumCallCount()
The parameters remained the same.

View File

@ -1,502 +0,0 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

View File

@ -1,102 +0,0 @@
SimpleTest
==========
You probably got this package from:
http://simpletest.org/en/download.html
If there is no licence agreement with this package please download
a version from the location above. You must read and accept that
licence to use this software. The file is titled simply LICENSE.
What is it? It's a framework for unit testing, web site testing and
mock objects for PHP 5.0.5+.
If you have used JUnit, you will find this PHP unit testing version very
similar. Also included is a mock objects and server stubs generator.
The stubs can have return values set for different arguments, can have
sequences set also by arguments and can return items by reference.
The mocks inherit all of this functionality and can also have
expectations set, again in sequences and for different arguments.
A web tester similar in concept to JWebUnit is also included. There is no
JavaScript or tables support, but forms, authentication, cookies and
frames are handled.
You can see a release schedule at http://simpletest.org/en/overview.html
which is also copied to the documentation folder with this release.
A full PHPDocumenter API documentation exists at
http://simpletest.org/api/.
The user interface is minimal in the extreme, but a lot of information
flows from the test suite. After version 1.0 we will release a better
web UI, but we are leaving XUL and GTK versions to volunteers as
everybody has their own opinion on a good GUI, and we don't want to
discourage development by shipping one with the toolkit. You can
download an Eclipse plug-in separately.
The unit tests for SimpleTest itself can be run here:
test/unit_tests.php
And tests involving live network connections as well are here:
test/all_tests.php
The full tests will typically overrun the 8Mb limit often allowed
to a PHP process. A workaround is to run the tests on the command
with a custom php.ini file or with the switch -dmemory_limit=-1
if you do not have access to your server version.
The full tests read some test data from simpletest.org. If the site
is down or has been modified for a later version then you will get
spurious errors. A unit_tests.php failure on the other hand would be
very serious. Please notify us if you find one.
Even if all of the tests run please verify that your existing test suites
also function as expected. The file:
HELP_MY_TESTS_DONT_WORK_ANYMORE
...contains information on interface changes. It also points out
deprecated interfaces, so you should read this even if all of
your current tests appear to run.
There is a documentation folder which contains the core reference information
in English and French, although this information is fairly basic.
You can find a tutorial on...
http://simpletest.org/en/first_test_tutorial.html
...to get you started and this material will eventually become included
with the project documentation. A French translation exists at:
http://simpletest.org/fr/first_test_tutorial.html
If you download and use, and possibly even extend this tool, please let us
know. Any feedback, even bad, is always welcome and we will work to get
your suggestions into the next release. Ideally please send your
comments to:
simpletest-support@lists.sourceforge.net
...so that others can read them too. We usually try to respond within 48
hours.
There is no change log except at Sourceforge. You can visit the
release notes to see the completed TODO list after each cycle and also the
status of any bugs, but if the bug is recent then it will be fixed in SVN only.
The SVN check-ins always have all the tests passing and so SVN snapshots should
be pretty usable, although the code may not look so good internally.
Oh, and one last thing: SimpleTest is called "Simple" because it should
be simple to use. We intend to add a complete set of tools for a test
first and "test as you code" type of development. "Simple" does not mean
"Lite" in this context.
Thanks to everyone who has sent comments and offered suggestions. They
really are invaluable, but sadly you are too many to mention in full.
Thanks to all on the advanced PHP forum on SitePoint, especially Harry
Fuecks. Early adopters are always an inspiration.
-- Marcus Baker, Jason Sweat, Travis Swicegood, Perrick Penet and Edward Z. Yang.

View File

@ -1 +0,0 @@
1.1.0

View File

@ -1,224 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: dumper.php 1909 2009-07-29 15:58:11Z dgheath $
*/
/**
* Parses the command line arguments.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleArguments {
private $all = array();
/**
* Parses the command line arguments. The usual formats
* are supported:
* -f value
* -f=value
* --flag=value
* --flag value
* -f (true)
* --flag (true)
* @param array $arguments Normally the PHP $argv.
*/
function __construct($arguments) {
array_shift($arguments);
while (count($arguments) > 0) {
list($key, $value) = $this->parseArgument($arguments);
$this->assign($key, $value);
}
}
/**
* Sets the value in the argments object. If multiple
* values are added under the same key, the key will
* give an array value in the order they were added.
* @param string $key The variable to assign to.
* @param string value The value that would norally
* be colected on the command line.
*/
function assign($key, $value) {
if ($this->$key === false) {
$this->all[$key] = $value;
} elseif (! is_array($this->$key)) {
$this->all[$key] = array($this->$key, $value);
} else {
$this->all[$key][] = $value;
}
}
/**
* Extracts the next key and value from the argument list.
* @param array $arguments The remaining arguments to be parsed.
* The argument list will be reduced.
* @return array Two item array of key and value.
* If no value can be found it will
* have the value true assigned instead.
*/
private function parseArgument(&$arguments) {
$argument = array_shift($arguments);
if (preg_match('/^-(\w)=(.+)$/', $argument, $matches)) {
return array($matches[1], $matches[2]);
} elseif (preg_match('/^-(\w)$/', $argument, $matches)) {
return array($matches[1], $this->nextNonFlagElseTrue($arguments));
} elseif (preg_match('/^--(\w+)=(.+)$/', $argument, $matches)) {
return array($matches[1], $matches[2]);
} elseif (preg_match('/^--(\w+)$/', $argument, $matches)) {
return array($matches[1], $this->nextNonFlagElseTrue($arguments));
}
}
/**
* Attempts to use the next argument as a value. It
* won't use what it thinks is a flag.
* @param array $arguments Remaining arguments to be parsed.
* This variable is modified if there
* is a value to be extracted.
* @return string/boolean The next value unless it's a flag.
*/
private function nextNonFlagElseTrue(&$arguments) {
return $this->valueIsNext($arguments) ? array_shift($arguments) : true;
}
/**
* Test to see if the next available argument is a valid value.
* If it starts with "-" or "--" it's a flag and doesn't count.
* @param array $arguments Remaining arguments to be parsed.
* Not affected by this call.
* boolean True if valid value.
*/
function valueIsNext($arguments) {
return isset($arguments[0]) && ! $this->isFlag($arguments[0]);
}
/**
* It's a flag if it starts with "-" or "--".
* @param string $argument Value to be tested.
* @return boolean True if it's a flag.
*/
function isFlag($argument) {
return strncmp($argument, '-', 1) == 0;
}
/**
* The arguments are available as individual member
* variables on the object.
* @param string $key Argument name.
* @return string/array/boolean Either false for no value,
* the value as a string or
* a list of multiple values if
* the flag had been specified more
* than once.
*/
function __get($key) {
if (isset($this->all[$key])) {
return $this->all[$key];
}
return false;
}
/**
* The entire argument set as a hash.
* @return hash Each argument and it's value(s).
*/
function all() {
return $this->all;
}
}
/**
* Renders the help for the command line arguments.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleHelp {
private $overview;
private $flag_sets = array();
private $explanations = array();
/**
* Sets up the top level explanation for the program.
* @param string $overview Summary of program.
*/
function __construct($overview = '') {
$this->overview = $overview;
}
/**
* Adds the explanation for a group of flags that all
* have the same function.
* @param string/array $flags Flag and alternates. Don't
* worry about leading dashes
* as these are inserted automatically.
* @param string $explanation What that flag group does.
*/
function explainFlag($flags, $explanation) {
$flags = is_array($flags) ? $flags : array($flags);
$this->flag_sets[] = $flags;
$this->explanations[] = $explanation;
}
/**
* Generates the help text.
* @returns string The complete formatted text.
*/
function render() {
$tab_stop = $this->longestFlag($this->flag_sets) + 4;
$text = $this->overview . "\n";
for ($i = 0; $i < count($this->flag_sets); $i++) {
$text .= $this->renderFlagSet($this->flag_sets[$i], $this->explanations[$i], $tab_stop);
}
return $this->noDuplicateNewLines($text);
}
/**
* Works out the longest flag for formatting purposes.
* @param array $flag_sets The internal flag set list.
*/
private function longestFlag($flag_sets) {
$longest = 0;
foreach ($flag_sets as $flags) {
foreach ($flags as $flag) {
$longest = max($longest, strlen($this->renderFlag($flag)));
}
}
return $longest;
}
/**
* Generates the text for a single flag and it's alternate flags.
* @returns string Help text for that flag group.
*/
private function renderFlagSet($flags, $explanation, $tab_stop) {
$flag = array_shift($flags);
$text = str_pad($this->renderFlag($flag), $tab_stop, ' ') . $explanation . "\n";
foreach ($flags as $flag) {
$text .= ' ' . $this->renderFlag($flag) . "\n";
}
return $text;
}
/**
* Generates the flag name including leading dashes.
* @param string $flag Just the name.
* @returns Fag with apropriate dashes.
*/
private function renderFlag($flag) {
return (strlen($flag) == 1 ? '-' : '--') . $flag;
}
/**
* Converts multiple new lines into a single new line.
* Just there to trap accidental duplicate new lines.
* @param string $text Text to clean up.
* @returns string Text with no blank lines.
*/
private function noDuplicateNewLines($text) {
return preg_replace('/(\n+)/', "\n", $text);
}
}
?>

View File

@ -1,237 +0,0 @@
<?php
/**
* Base include file for SimpleTest
* @package SimpleTest
* @subpackage WebTester
* @version $Id: authentication.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**
* include http class
*/
require_once(dirname(__FILE__) . '/http.php');
/**
* Represents a single security realm's identity.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleRealm {
private $type;
private $root;
private $username;
private $password;
/**
* Starts with the initial entry directory.
* @param string $type Authentication type for this
* realm. Only Basic authentication
* is currently supported.
* @param SimpleUrl $url Somewhere in realm.
* @access public
*/
function SimpleRealm($type, $url) {
$this->type = $type;
$this->root = $url->getBasePath();
$this->username = false;
$this->password = false;
}
/**
* Adds another location to the realm.
* @param SimpleUrl $url Somewhere in realm.
* @access public
*/
function stretch($url) {
$this->root = $this->getCommonPath($this->root, $url->getPath());
}
/**
* Finds the common starting path.
* @param string $first Path to compare.
* @param string $second Path to compare.
* @return string Common directories.
* @access private
*/
protected function getCommonPath($first, $second) {
$first = explode('/', $first);
$second = explode('/', $second);
for ($i = 0; $i < min(count($first), count($second)); $i++) {
if ($first[$i] != $second[$i]) {
return implode('/', array_slice($first, 0, $i)) . '/';
}
}
return implode('/', $first) . '/';
}
/**
* Sets the identity to try within this realm.
* @param string $username Username in authentication dialog.
* @param string $username Password in authentication dialog.
* @access public
*/
function setIdentity($username, $password) {
$this->username = $username;
$this->password = $password;
}
/**
* Accessor for current identity.
* @return string Last succesful username.
* @access public
*/
function getUsername() {
return $this->username;
}
/**
* Accessor for current identity.
* @return string Last succesful password.
* @access public
*/
function getPassword() {
return $this->password;
}
/**
* Test to see if the URL is within the directory
* tree of the realm.
* @param SimpleUrl $url URL to test.
* @return boolean True if subpath.
* @access public
*/
function isWithin($url) {
if ($this->isIn($this->root, $url->getBasePath())) {
return true;
}
if ($this->isIn($this->root, $url->getBasePath() . $url->getPage() . '/')) {
return true;
}
return false;
}
/**
* Tests to see if one string is a substring of
* another.
* @param string $part Small bit.
* @param string $whole Big bit.
* @return boolean True if the small bit is
* in the big bit.
* @access private
*/
protected function isIn($part, $whole) {
return strpos($whole, $part) === 0;
}
}
/**
* Manages security realms.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleAuthenticator {
private $realms;
/**
* Clears the realms.
* @access public
*/
function SimpleAuthenticator() {
$this->restartSession();
}
/**
* Starts with no realms set up.
* @access public
*/
function restartSession() {
$this->realms = array();
}
/**
* Adds a new realm centered the current URL.
* Browsers privatey wildly on their behaviour in this
* regard. Mozilla ignores the realm and presents
* only when challenged, wasting bandwidth. IE
* just carries on presenting until a new challenge
* occours. SimpleTest tries to follow the spirit of
* the original standards committee and treats the
* base URL as the root of a file tree shaped realm.
* @param SimpleUrl $url Base of realm.
* @param string $type Authentication type for this
* realm. Only Basic authentication
* is currently supported.
* @param string $realm Name of realm.
* @access public
*/
function addRealm($url, $type, $realm) {
$this->realms[$url->getHost()][$realm] = new SimpleRealm($type, $url);
}
/**
* Sets the current identity to be presented
* against that realm.
* @param string $host Server hosting realm.
* @param string $realm Name of realm.
* @param string $username Username for realm.
* @param string $password Password for realm.
* @access public
*/
function setIdentityForRealm($host, $realm, $username, $password) {
if (isset($this->realms[$host][$realm])) {
$this->realms[$host][$realm]->setIdentity($username, $password);
}
}
/**
* Finds the name of the realm by comparing URLs.
* @param SimpleUrl $url URL to test.
* @return SimpleRealm Name of realm.
* @access private
*/
protected function findRealmFromUrl($url) {
if (! isset($this->realms[$url->getHost()])) {
return false;
}
foreach ($this->realms[$url->getHost()] as $name => $realm) {
if ($realm->isWithin($url)) {
return $realm;
}
}
return false;
}
/**
* Presents the appropriate headers for this location.
* @param SimpleHttpRequest $request Request to modify.
* @param SimpleUrl $url Base of realm.
* @access public
*/
function addHeaders(&$request, $url) {
if ($url->getUsername() && $url->getPassword()) {
$username = $url->getUsername();
$password = $url->getPassword();
} elseif ($realm = $this->findRealmFromUrl($url)) {
$username = $realm->getUsername();
$password = $realm->getPassword();
} else {
return;
}
$this->addBasicHeaders($request, $username, $password);
}
/**
* Presents the appropriate headers for this
* location for basic authentication.
* @param SimpleHttpRequest $request Request to modify.
* @param string $username Username for realm.
* @param string $password Password for realm.
* @access public
*/
static function addBasicHeaders(&$request, $username, $password) {
if ($username && $password) {
$request->addHeaderLine(
'Authorization: Basic ' . base64_encode("$username:$password"));
}
}
}
?>

View File

@ -1,101 +0,0 @@
<?php
/**
* Autorunner which runs all tests cases found in a file
* that includes this module.
* @package SimpleTest
* @version $Id: autorun.php 2037 2011-11-30 17:58:21Z pp11 $
*/
/**#@+
* include simpletest files
*/
require_once dirname(__FILE__) . '/unit_tester.php';
require_once dirname(__FILE__) . '/mock_objects.php';
require_once dirname(__FILE__) . '/collector.php';
require_once dirname(__FILE__) . '/default_reporter.php';
/**#@-*/
$GLOBALS['SIMPLETEST_AUTORUNNER_INITIAL_CLASSES'] = get_declared_classes();
$GLOBALS['SIMPLETEST_AUTORUNNER_INITIAL_PATH'] = getcwd();
register_shutdown_function('simpletest_autorun');
/**
* Exit handler to run all recent test cases and exit system if in CLI
*/
function simpletest_autorun() {
chdir($GLOBALS['SIMPLETEST_AUTORUNNER_INITIAL_PATH']);
if (tests_have_run()) {
return;
}
$result = run_local_tests();
if (SimpleReporter::inCli()) {
exit($result ? 0 : 1);
}
}
/**
* run all recent test cases if no test has
* so far been run. Uses the DefaultReporter which can have
* it's output controlled with SimpleTest::prefer().
* @return boolean/null false if there were test failures, true if
* there were no failures, null if tests are
* already running
*/
function run_local_tests() {
try {
if (tests_have_run()) {
return;
}
$candidates = capture_new_classes();
$loader = new SimpleFileLoader();
$suite = $loader->createSuiteFromClasses(
basename(initial_file()),
$loader->selectRunnableTests($candidates));
return $suite->run(new DefaultReporter());
} catch (Exception $stack_frame_fix) {
print $stack_frame_fix->getMessage();
return false;
}
}
/**
* Checks the current test context to see if a test has
* ever been run.
* @return boolean True if tests have run.
*/
function tests_have_run() {
if ($context = SimpleTest::getContext()) {
return (boolean)$context->getTest();
}
return false;
}
/**
* The first autorun file.
* @return string Filename of first autorun script.
*/
function initial_file() {
static $file = false;
if (! $file) {
if (isset($_SERVER, $_SERVER['SCRIPT_FILENAME'])) {
$file = $_SERVER['SCRIPT_FILENAME'];
} else {
$included_files = get_included_files();
$file = reset($included_files);
}
}
return $file;
}
/**
* Every class since the first autorun include. This
* is safe enough if require_once() is always used.
* @return array Class names.
*/
function capture_new_classes() {
global $SIMPLETEST_AUTORUNNER_INITIAL_CLASSES;
return array_map('strtolower', array_diff(get_declared_classes(),
$SIMPLETEST_AUTORUNNER_INITIAL_CLASSES ?
$SIMPLETEST_AUTORUNNER_INITIAL_CLASSES : array()));
}
?>

File diff suppressed because it is too large Load Diff

View File

@ -1,122 +0,0 @@
<?php
/**
* This file contains the following classes: {@link SimpleCollector},
* {@link SimplePatternCollector}.
*
* @author Travis Swicegood <development@domain51.com>
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: collector.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**
* The basic collector for {@link GroupTest}
*
* @see collect(), GroupTest::collect()
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleCollector {
/**
* Strips off any kind of slash at the end so as to normalise the path.
* @param string $path Path to normalise.
* @return string Path without trailing slash.
*/
protected function removeTrailingSlash($path) {
if (substr($path, -1) == DIRECTORY_SEPARATOR) {
return substr($path, 0, -1);
} elseif (substr($path, -1) == '/') {
return substr($path, 0, -1);
} else {
return $path;
}
}
/**
* Scans the directory and adds what it can.
* @param object $test Group test with {@link GroupTest::addTestFile()} method.
* @param string $path Directory to scan.
* @see _attemptToAdd()
*/
function collect(&$test, $path) {
$path = $this->removeTrailingSlash($path);
if ($handle = opendir($path)) {
while (($entry = readdir($handle)) !== false) {
if ($this->isHidden($entry)) {
continue;
}
$this->handle($test, $path . DIRECTORY_SEPARATOR . $entry);
}
closedir($handle);
}
}
/**
* This method determines what should be done with a given file and adds
* it via {@link GroupTest::addTestFile()} if necessary.
*
* This method should be overriden to provide custom matching criteria,
* such as pattern matching, recursive matching, etc. For an example, see
* {@link SimplePatternCollector::_handle()}.
*
* @param object $test Group test with {@link GroupTest::addTestFile()} method.
* @param string $filename A filename as generated by {@link collect()}
* @see collect()
* @access protected
*/
protected function handle(&$test, $file) {
if (is_dir($file)) {
return;
}
$test->addFile($file);
}
/**
* Tests for hidden files so as to skip them. Currently
* only tests for Unix hidden files.
* @param string $filename Plain filename.
* @return boolean True if hidden file.
* @access private
*/
protected function isHidden($filename) {
return strncmp($filename, '.', 1) == 0;
}
}
/**
* An extension to {@link SimpleCollector} that only adds files matching a
* given pattern.
*
* @package SimpleTest
* @subpackage UnitTester
* @see SimpleCollector
*/
class SimplePatternCollector extends SimpleCollector {
private $pattern;
/**
*
* @param string $pattern Perl compatible regex to test name against
* See {@link http://us4.php.net/manual/en/reference.pcre.pattern.syntax.php PHP's PCRE}
* for full documentation of valid pattern.s
*/
function __construct($pattern = '/php$/i') {
$this->pattern = $pattern;
}
/**
* Attempts to add files that match a given pattern.
*
* @see SimpleCollector::_handle()
* @param object $test Group test with {@link GroupTest::addTestFile()} method.
* @param string $path Directory to scan.
* @access protected
*/
protected function handle(&$test, $filename) {
if (preg_match($this->pattern, $filename)) {
parent::handle($test, $filename);
}
}
}
?>

View File

@ -1,166 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @version $Id: compatibility.php 1900 2009-07-29 11:44:37Z lastcraft $
*/
/**
* Static methods for compatibility between different
* PHP versions.
* @package SimpleTest
*/
class SimpleTestCompatibility {
/**
* Creates a copy whether in PHP5 or PHP4.
* @param object $object Thing to copy.
* @return object A copy.
* @access public
*/
static function copy($object) {
if (version_compare(phpversion(), '5') >= 0) {
eval('$copy = clone $object;');
return $copy;
}
return $object;
}
/**
* Identity test. Drops back to equality + types for PHP5
* objects as the === operator counts as the
* stronger reference constraint.
* @param mixed $first Test subject.
* @param mixed $second Comparison object.
* @return boolean True if identical.
* @access public
*/
static function isIdentical($first, $second) {
if (version_compare(phpversion(), '5') >= 0) {
return SimpleTestCompatibility::isIdenticalType($first, $second);
}
if ($first != $second) {
return false;
}
return ($first === $second);
}
/**
* Recursive type test.
* @param mixed $first Test subject.
* @param mixed $second Comparison object.
* @return boolean True if same type.
* @access private
*/
protected static function isIdenticalType($first, $second) {
if (gettype($first) != gettype($second)) {
return false;
}
if (is_object($first) && is_object($second)) {
if (get_class($first) != get_class($second)) {
return false;
}
return SimpleTestCompatibility::isArrayOfIdenticalTypes(
(array) $first,
(array) $second);
}
if (is_array($first) && is_array($second)) {
return SimpleTestCompatibility::isArrayOfIdenticalTypes($first, $second);
}
if ($first !== $second) {
return false;
}
return true;
}
/**
* Recursive type test for each element of an array.
* @param mixed $first Test subject.
* @param mixed $second Comparison object.
* @return boolean True if identical.
* @access private
*/
protected static function isArrayOfIdenticalTypes($first, $second) {
if (array_keys($first) != array_keys($second)) {
return false;
}
foreach (array_keys($first) as $key) {
$is_identical = SimpleTestCompatibility::isIdenticalType(
$first[$key],
$second[$key]);
if (! $is_identical) {
return false;
}
}
return true;
}
/**
* Test for two variables being aliases.
* @param mixed $first Test subject.
* @param mixed $second Comparison object.
* @return boolean True if same.
* @access public
*/
static function isReference(&$first, &$second) {
if (version_compare(phpversion(), '5', '>=') && is_object($first)) {
return ($first === $second);
}
if (is_object($first) && is_object($second)) {
$id = uniqid("test");
$first->$id = true;
$is_ref = isset($second->$id);
unset($first->$id);
return $is_ref;
}
$temp = $first;
$first = uniqid("test");
$is_ref = ($first === $second);
$first = $temp;
return $is_ref;
}
/**
* Test to see if an object is a member of a
* class hiearchy.
* @param object $object Object to test.
* @param string $class Root name of hiearchy.
* @return boolean True if class in hiearchy.
* @access public
*/
static function isA($object, $class) {
if (version_compare(phpversion(), '5') >= 0) {
if (! class_exists($class, false)) {
if (function_exists('interface_exists')) {
if (! interface_exists($class, false)) {
return false;
}
}
}
eval("\$is_a = \$object instanceof $class;");
return $is_a;
}
if (function_exists('is_a')) {
return is_a($object, $class);
}
return ((strtolower($class) == get_class($object))
or (is_subclass_of($object, $class)));
}
/**
* Sets a socket timeout for each chunk.
* @param resource $handle Socket handle.
* @param integer $timeout Limit in seconds.
* @access public
*/
static function setTimeout($handle, $timeout) {
if (function_exists('stream_set_timeout')) {
stream_set_timeout($handle, $timeout, 0);
} elseif (function_exists('socket_set_timeout')) {
socket_set_timeout($handle, $timeout, 0);
} elseif (function_exists('set_socket_timeout')) {
set_socket_timeout($handle, $timeout, 0);
}
}
}
?>

View File

@ -1,380 +0,0 @@
<?php
/**
* Base include file for SimpleTest
* @package SimpleTest
* @subpackage WebTester
* @version $Id: cookies.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/url.php');
/**#@-*/
/**
* Cookie data holder. Cookie rules are full of pretty
* arbitary stuff. I have used...
* http://wp.netscape.com/newsref/std/cookie_spec.html
* http://www.cookiecentral.com/faq/
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleCookie {
private $host;
private $name;
private $value;
private $path;
private $expiry;
private $is_secure;
/**
* Constructor. Sets the stored values.
* @param string $name Cookie key.
* @param string $value Value of cookie.
* @param string $path Cookie path if not host wide.
* @param string $expiry Expiry date as string.
* @param boolean $is_secure Currently ignored.
*/
function __construct($name, $value = false, $path = false, $expiry = false, $is_secure = false) {
$this->host = false;
$this->name = $name;
$this->value = $value;
$this->path = ($path ? $this->fixPath($path) : "/");
$this->expiry = false;
if (is_string($expiry)) {
$this->expiry = strtotime($expiry);
} elseif (is_integer($expiry)) {
$this->expiry = $expiry;
}
$this->is_secure = $is_secure;
}
/**
* Sets the host. The cookie rules determine
* that the first two parts are taken for
* certain TLDs and three for others. If the
* new host does not match these rules then the
* call will fail.
* @param string $host New hostname.
* @return boolean True if hostname is valid.
* @access public
*/
function setHost($host) {
if ($host = $this->truncateHost($host)) {
$this->host = $host;
return true;
}
return false;
}
/**
* Accessor for the truncated host to which this
* cookie applies.
* @return string Truncated hostname.
* @access public
*/
function getHost() {
return $this->host;
}
/**
* Test for a cookie being valid for a host name.
* @param string $host Host to test against.
* @return boolean True if the cookie would be valid
* here.
*/
function isValidHost($host) {
return ($this->truncateHost($host) === $this->getHost());
}
/**
* Extracts just the domain part that determines a
* cookie's host validity.
* @param string $host Host name to truncate.
* @return string Domain or false on a bad host.
* @access private
*/
protected function truncateHost($host) {
$tlds = SimpleUrl::getAllTopLevelDomains();
if (preg_match('/[a-z\-]+\.(' . $tlds . ')$/i', $host, $matches)) {
return $matches[0];
} elseif (preg_match('/[a-z\-]+\.[a-z\-]+\.[a-z\-]+$/i', $host, $matches)) {
return $matches[0];
}
return false;
}
/**
* Accessor for name.
* @return string Cookie key.
* @access public
*/
function getName() {
return $this->name;
}
/**
* Accessor for value. A deleted cookie will
* have an empty string for this.
* @return string Cookie value.
* @access public
*/
function getValue() {
return $this->value;
}
/**
* Accessor for path.
* @return string Valid cookie path.
* @access public
*/
function getPath() {
return $this->path;
}
/**
* Tests a path to see if the cookie applies
* there. The test path must be longer or
* equal to the cookie path.
* @param string $path Path to test against.
* @return boolean True if cookie valid here.
* @access public
*/
function isValidPath($path) {
return (strncmp(
$this->fixPath($path),
$this->getPath(),
strlen($this->getPath())) == 0);
}
/**
* Accessor for expiry.
* @return string Expiry string.
* @access public
*/
function getExpiry() {
if (! $this->expiry) {
return false;
}
return gmdate("D, d M Y H:i:s", $this->expiry) . " GMT";
}
/**
* Test to see if cookie is expired against
* the cookie format time or timestamp.
* Will give true for a session cookie.
* @param integer/string $now Time to test against. Result
* will be false if this time
* is later than the cookie expiry.
* Can be either a timestamp integer
* or a cookie format date.
* @access public
*/
function isExpired($now) {
if (! $this->expiry) {
return true;
}
if (is_string($now)) {
$now = strtotime($now);
}
return ($this->expiry < $now);
}
/**
* Ages the cookie by the specified number of
* seconds.
* @param integer $interval In seconds.
* @public
*/
function agePrematurely($interval) {
if ($this->expiry) {
$this->expiry -= $interval;
}
}
/**
* Accessor for the secure flag.
* @return boolean True if cookie needs SSL.
* @access public
*/
function isSecure() {
return $this->is_secure;
}
/**
* Adds a trailing and leading slash to the path
* if missing.
* @param string $path Path to fix.
* @access private
*/
protected function fixPath($path) {
if (substr($path, 0, 1) != '/') {
$path = '/' . $path;
}
if (substr($path, -1, 1) != '/') {
$path .= '/';
}
return $path;
}
}
/**
* Repository for cookies. This stuff is a
* tiny bit browser dependent.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleCookieJar {
private $cookies;
/**
* Constructor. Jar starts empty.
* @access public
*/
function __construct() {
$this->cookies = array();
}
/**
* Removes expired and temporary cookies as if
* the browser was closed and re-opened.
* @param string/integer $now Time to test expiry against.
* @access public
*/
function restartSession($date = false) {
$surviving_cookies = array();
for ($i = 0; $i < count($this->cookies); $i++) {
if (! $this->cookies[$i]->getValue()) {
continue;
}
if (! $this->cookies[$i]->getExpiry()) {
continue;
}
if ($date && $this->cookies[$i]->isExpired($date)) {
continue;
}
$surviving_cookies[] = $this->cookies[$i];
}
$this->cookies = $surviving_cookies;
}
/**
* Ages all cookies in the cookie jar.
* @param integer $interval The old session is moved
* into the past by this number
* of seconds. Cookies now over
* age will be removed.
* @access public
*/
function agePrematurely($interval) {
for ($i = 0; $i < count($this->cookies); $i++) {
$this->cookies[$i]->agePrematurely($interval);
}
}
/**
* Sets an additional cookie. If a cookie has
* the same name and path it is replaced.
* @param string $name Cookie key.
* @param string $value Value of cookie.
* @param string $host Host upon which the cookie is valid.
* @param string $path Cookie path if not host wide.
* @param string $expiry Expiry date.
* @access public
*/
function setCookie($name, $value, $host = false, $path = '/', $expiry = false) {
$cookie = new SimpleCookie($name, $value, $path, $expiry);
if ($host) {
$cookie->setHost($host);
}
$this->cookies[$this->findFirstMatch($cookie)] = $cookie;
}
/**
* Finds a matching cookie to write over or the
* first empty slot if none.
* @param SimpleCookie $cookie Cookie to write into jar.
* @return integer Available slot.
* @access private
*/
protected function findFirstMatch($cookie) {
for ($i = 0; $i < count($this->cookies); $i++) {
$is_match = $this->isMatch(
$cookie,
$this->cookies[$i]->getHost(),
$this->cookies[$i]->getPath(),
$this->cookies[$i]->getName());
if ($is_match) {
return $i;
}
}
return count($this->cookies);
}
/**
* Reads the most specific cookie value from the
* browser cookies. Looks for the longest path that
* matches.
* @param string $host Host to search.
* @param string $path Applicable path.
* @param string $name Name of cookie to read.
* @return string False if not present, else the
* value as a string.
* @access public
*/
function getCookieValue($host, $path, $name) {
$longest_path = '';
foreach ($this->cookies as $cookie) {
if ($this->isMatch($cookie, $host, $path, $name)) {
if (strlen($cookie->getPath()) > strlen($longest_path)) {
$value = $cookie->getValue();
$longest_path = $cookie->getPath();
}
}
}
return (isset($value) ? $value : false);
}
/**
* Tests cookie for matching against search
* criteria.
* @param SimpleTest $cookie Cookie to test.
* @param string $host Host must match.
* @param string $path Cookie path must be shorter than
* this path.
* @param string $name Name must match.
* @return boolean True if matched.
* @access private
*/
protected function isMatch($cookie, $host, $path, $name) {
if ($cookie->getName() != $name) {
return false;
}
if ($host && $cookie->getHost() && ! $cookie->isValidHost($host)) {
return false;
}
if (! $cookie->isValidPath($path)) {
return false;
}
return true;
}
/**
* Uses a URL to sift relevant cookies by host and
* path. Results are list of strings of form "name=value".
* @param SimpleUrl $url Url to select by.
* @return array Valid name and value pairs.
* @access public
*/
function selectAsPairs($url) {
$pairs = array();
foreach ($this->cookies as $cookie) {
if ($this->isMatch($cookie, $url->getHost(), $url->getPath(), $cookie->getName())) {
$pairs[] = $cookie->getName() . '=' . $cookie->getValue();
}
}
return $pairs;
}
}
?>

View File

@ -1,163 +0,0 @@
<?php
/**
* Optional include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: default_reporter.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/simpletest.php');
require_once(dirname(__FILE__) . '/scorer.php');
require_once(dirname(__FILE__) . '/reporter.php');
require_once(dirname(__FILE__) . '/xml.php');
/**#@-*/
/**
* Parser for command line arguments. Extracts
* the a specific test to run and engages XML
* reporting when necessary.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleCommandLineParser {
private $to_property = array(
'case' => 'case', 'c' => 'case',
'test' => 'test', 't' => 'test',
);
private $case = '';
private $test = '';
private $xml = false;
private $help = false;
private $no_skips = false;
/**
* Parses raw command line arguments into object properties.
* @param string $arguments Raw commend line arguments.
*/
function __construct($arguments) {
if (! is_array($arguments)) {
return;
}
foreach ($arguments as $i => $argument) {
if (preg_match('/^--?(test|case|t|c)=(.+)$/', $argument, $matches)) {
$property = $this->to_property[$matches[1]];
$this->$property = $matches[2];
} elseif (preg_match('/^--?(test|case|t|c)$/', $argument, $matches)) {
$property = $this->to_property[$matches[1]];
if (isset($arguments[$i + 1])) {
$this->$property = $arguments[$i + 1];
}
} elseif (preg_match('/^--?(xml|x)$/', $argument)) {
$this->xml = true;
} elseif (preg_match('/^--?(no-skip|no-skips|s)$/', $argument)) {
$this->no_skips = true;
} elseif (preg_match('/^--?(help|h)$/', $argument)) {
$this->help = true;
}
}
}
/**
* Run only this test.
* @return string Test name to run.
*/
function getTest() {
return $this->test;
}
/**
* Run only this test suite.
* @return string Test class name to run.
*/
function getTestCase() {
return $this->case;
}
/**
* Output should be XML or not.
* @return boolean True if XML desired.
*/
function isXml() {
return $this->xml;
}
/**
* Output should suppress skip messages.
* @return boolean True for no skips.
*/
function noSkips() {
return $this->no_skips;
}
/**
* Output should be a help message. Disabled during XML mode.
* @return boolean True if help message desired.
*/
function help() {
return $this->help && ! $this->xml;
}
/**
* Returns plain-text help message for command line runner.
* @return string String help message
*/
function getHelpText() {
return <<<HELP
SimpleTest command line default reporter (autorun)
Usage: php <test_file> [args...]
-c <class> Run only the test-case <class>
-t <method> Run only the test method <method>
-s Suppress skip messages
-x Return test results in XML
-h Display this help message
HELP;
}
}
/**
* The default reporter used by SimpleTest's autorun
* feature. The actual reporters used are dependency
* injected and can be overridden.
* @package SimpleTest
* @subpackage UnitTester
*/
class DefaultReporter extends SimpleReporterDecorator {
/**
* Assembles the appropriate reporter for the environment.
*/
function __construct() {
if (SimpleReporter::inCli()) {
$parser = new SimpleCommandLineParser($_SERVER['argv']);
$interfaces = $parser->isXml() ? array('XmlReporter') : array('TextReporter');
if ($parser->help()) {
// I'm not sure if we should do the echo'ing here -- ezyang
echo $parser->getHelpText();
exit(1);
}
$reporter = new SelectiveReporter(
SimpleTest::preferred($interfaces),
$parser->getTestCase(),
$parser->getTest());
if ($parser->noSkips()) {
$reporter = new NoSkipsReporter($reporter);
}
} else {
$reporter = new SelectiveReporter(
SimpleTest::preferred('HtmlReporter'),
@$_GET['c'],
@$_GET['t']);
if (@$_GET['skips'] == 'no' || @$_GET['show-skips'] == 'no') {
$reporter = new NoSkipsReporter($reporter);
}
}
parent::__construct($reporter);
}
}
?>

View File

@ -1,96 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: detached.php 1784 2008-04-26 13:07:14Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/xml.php');
require_once(dirname(__FILE__) . '/shell_tester.php');
/**#@-*/
/**
* Runs an XML formated test in a separate process.
* @package SimpleTest
* @subpackage UnitTester
*/
class DetachedTestCase {
private $command;
private $dry_command;
private $size;
/**
* Sets the location of the remote test.
* @param string $command Test script.
* @param string $dry_command Script for dry run.
* @access public
*/
function __construct($command, $dry_command = false) {
$this->command = $command;
$this->dry_command = $dry_command ? $dry_command : $command;
$this->size = false;
}
/**
* Accessor for the test name for subclasses.
* @return string Name of the test.
* @access public
*/
function getLabel() {
return $this->command;
}
/**
* Runs the top level test for this class. Currently
* reads the data as a single chunk. I'll fix this
* once I have added iteration to the browser.
* @param SimpleReporter $reporter Target of test results.
* @returns boolean True if no failures.
* @access public
*/
function run(&$reporter) {
$shell = &new SimpleShell();
$shell->execute($this->command);
$parser = &$this->createParser($reporter);
if (! $parser->parse($shell->getOutput())) {
trigger_error('Cannot parse incoming XML from [' . $this->command . ']');
return false;
}
return true;
}
/**
* Accessor for the number of subtests.
* @return integer Number of test cases.
* @access public
*/
function getSize() {
if ($this->size === false) {
$shell = &new SimpleShell();
$shell->execute($this->dry_command);
$reporter = &new SimpleReporter();
$parser = &$this->createParser($reporter);
if (! $parser->parse($shell->getOutput())) {
trigger_error('Cannot parse incoming XML from [' . $this->dry_command . ']');
return false;
}
$this->size = $reporter->getTestCaseCount();
}
return $this->size;
}
/**
* Creates the XML parser.
* @param SimpleReporter $reporter Target of test results.
* @return SimpleTestXmlListener XML reader.
* @access protected
*/
protected function &createParser(&$reporter) {
return new SimpleTestXmlParser($reporter);
}
}
?>

View File

@ -1,378 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest documentation for testing log-in and authentication</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<span class="chosen">Authentication</span>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Authentication documentation</h1>
This page...
<ul>
<li>
Getting through <a href="#basic">Basic HTTP authentication</a>
</li>
<li>
Testing <a href="#cookies">cookie based authentication</a>
</li>
<li>
Managing <a href="#session">browser sessions</a> and timeouts
</li>
</ul>
<div class="content">
<p>
One of the trickiest, and yet most important, areas
of testing web sites is the security.
Testing these schemes is one of the core goals of
the SimpleTest web tester.
</p>
<h2>
<a class="target" name="basic"></a>Basic HTTP authentication</h2>
<p>
If you fetch a page protected by basic authentication then
rather than receiving content, you will instead get a 401
header.
We can illustrate this with this test...
<pre>
class AuthenticationTest extends WebTestCase {<strong>
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');
$this-&gt;showHeaders();
}</strong>
}
</pre>
This allows us to see the challenge header...
<div class="demo">
<h1>File test</h1>
<pre>
HTTP/1.1 401 Authorization Required
Date: Sat, 18 Sep 2004 19:25:18 GMT
Server: Apache/1.3.29 (Unix) PHP/4.3.4
WWW-Authenticate: Basic realm="SimpleTest basic authentication"
Connection: close
Content-Type: text/html; charset=iso-8859-1
</pre>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>0</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
We are trying to get away from visual inspection though, and so SimpleTest
allows to make automated assertions against the challenge.
Here is a thorough test of our header...
<pre>
class AuthenticationTest extends WebTestCase {
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');<strong>
$this-&gt;assertAuthentication('Basic');
$this-&gt;assertResponse(401);
$this-&gt;assertRealm('SimpleTest basic authentication');</strong>
}
}
</pre>
Any one of these tests would normally do on it's own depending
on the amount of detail you want to see.
</p>
<p>
One theme that runs through SimpleTest is the ability to use
<span class="new_code">SimpleExpectation</span> objects wherever a simple
match is not enough.
If you want only an approximate match to the realm for
example, you can do this...
<pre>
class AuthenticationTest extends WebTestCase {
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');
$this-&gt;assertRealm(<strong>new PatternExpectation('/simpletest/i')</strong>);
}
}
</pre>
This type of test, testing HTTP responses, is not typical.
</p>
<p>
Most of the time we are not interested in testing the
authentication itself, but want to get past it to test
the pages underneath.
As soon as the challenge has been issued we can reply with
an authentication response...
<pre>
class AuthenticationTest extends WebTestCase {
function testCanAuthenticate() {
$this-&gt;get('http://www.lastcraft.com/protected/');<strong>
$this-&gt;authenticate('Me', 'Secret');</strong>
$this-&gt;assertTitle(...);
}
}
</pre>
The username and password will now be sent with every
subsequent request to that directory and subdirectories.
You will have to authenticate again if you step outside
the authenticated directory, but SimpleTest is smart enough
to merge subdirectories into a common realm.
</p>
<p>
If you want, you can shortcut this step further by encoding
the log in details straight into the URL...
<pre>
class AuthenticationTest extends WebTestCase {
function testCanReadAuthenticatedPages() {
$this-&gt;get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/');
$this-&gt;assertTitle(...);
}
}
</pre>
If your username or password has special characters, then you
will have to URL encode them or the request will not be parsed
correctly.
I'm afraid we leave this up to you.
</p>
<p>
A problem with encoding the login details directly in the URL is
the authentication header will not be sent on subsequent requests.
If you navigate with relative URLs though, the authentication
information will be preserved along with the domain name.
</p>
<p>
Normally though, you use the <span class="new_code">authenticate()</span> call.
SimpleTest will then remember your login information on each request.
</p>
<p>
Only testing with basic authentication is currently supported, and
this is only really secure in tandem with HTTPS connections.
This is usually good enough to protect test server from prying eyes,
however.
Digest authentication and NTLM authentication may be added
in the future if enough people request this feature.
</p>
<h2>
<a class="target" name="cookies"></a>Cookies</h2>
<p>
Basic authentication doesn't give enough control over the
user interface for web developers.
More likely this functionality will be coded directly into
the web architecture using cookies with complicated timeouts.
We need to be able to test this too.
</p>
<p>
Starting with a simple log-in form...
<pre>
&lt;form&gt;
Username:
&lt;input type="text" name="u" value="" /&gt;&lt;br /&gt;
Password:
&lt;input type="password" name="p" value="" /&gt;&lt;br /&gt;
&lt;input type="submit" value="Log in" /&gt;
&lt;/form&gt;
</pre>
Which looks like...
</p>
<p>
<form class="demo">
Username:
<input type="text" name="u" value=""><br>
Password:
<input type="password" name="p" value=""><br>
<input type="submit" value="Log in">
</form>
</p>
<p>
Let's suppose that in fetching this page a cookie has been
set with a session ID.
We are not going to fill the form in yet, just test that
we are tracking the user.
Here is the test...
<pre>
class LogInTest extends WebTestCase {
function testSessionCookieSetBeforeForm() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$this-&gt;assertCookie('SID');</strong>
}
}
</pre>
All we are doing is confirming that the cookie is set.
As the value is likely to be rather cryptic it's not
really worth testing this with...
<pre>
class LogInTest extends WebTestCase {
function testSessionCookieIsCorrectPattern() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;assertCookie('SID', <strong>new PatternExpectation('/[a-f0-9]{32}/i')</strong>);
}
}
</pre>
If you are using PHP to handle sessions for you then
this test is even more useless, as we are just testing PHP itself.
</p>
<p>
The simplest test of logging in is to visually inspect the
next page to see if you are really logged in.
Just test the next page with <span class="new_code">WebTestCase::assertText()</span>.
</p>
<p>
The test is similar to any other form test,
but we might want to confirm that we still have the same
cookie after log-in as before we entered.
We wouldn't want to lose track of this after all.
Here is a possible test for this...
<pre>
class LogInTest extends WebTestCase {
...
function testSessionCookieSameAfterLogIn() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$session = $this-&gt;getCookie('SID');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;click('Log in');
$this-&gt;assertText('Welcome Me');
$this-&gt;assertCookie('SID', $session);</strong>
}
}
</pre>
This confirms that the session identifier is maintained
afer log-in and we haven't accidently reset it.
</p>
<p>
We could even attempt to hack our own system by setting
arbitrary cookies to gain access...
<pre>
class LogInTest extends WebTestCase {
...
function testSessionCookieSameAfterLogIn() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$this-&gt;setCookie('SID', 'Some other session');
$this-&gt;get('http://www.my-site.com/restricted.php');</strong>
$this-&gt;assertText('Access denied');
}
}
</pre>
Is your site protected from this attack?
</p>
<h2>
<a class="target" name="session"></a>Browser sessions</h2>
<p>
If you are testing an authentication system a critical piece
of behaviour is what happens when a user logs back in.
We would like to simulate closing and reopening a browser...
<pre>
class LogInTest extends WebTestCase {
...
function testLoseAuthenticationAfterBrowserClose() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;click('Log in');
$this-&gt;assertText('Welcome Me');<strong>
$this-&gt;restart();
$this-&gt;get('http://www.my-site.com/restricted.php');
$this-&gt;assertText('Access denied');</strong>
}
}
</pre>
The <span class="new_code">WebTestCase::restart()</span> method will
preserve cookies that have unexpired timeouts, but throw away
those that are temporary or expired.
You can optionally specify the time and date that the restart
happened.
</p>
<p>
Expiring cookies can be a problem.
After all, if you have a cookie that expires after an hour,
you don't want to stall the test for an hour while waiting
for the cookie to pass it's timeout.
</p>
<p>
To push the cookies over the hour limit you can age them
before you restart the session...
<pre>
class LogInTest extends WebTestCase {
...
function testLoseAuthenticationAfterOneHour() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;click('Log in');
$this-&gt;assertText('Welcome Me');
<strong>
$this-&gt;ageCookies(3600);</strong>
$this-&gt;restart();
$this-&gt;get('http://www.my-site.com/restricted.php');
$this-&gt;assertText('Access denied');
}
}
</pre>
After the restart it will appear that cookies are an
hour older, and any that pass their expiry will have
disappeared.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
The <a href="http://simpletest.org/api/">developer's API for SimpleTest</a>
gives full detail on the classes and assertions available.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<span class="chosen">Authentication</span>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,501 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest documentation for the scriptable web browser component</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<span class="chosen">Scriptable browser</span>
</div></div>
<h1>PHP Scriptable Web Browser</h1>
This page...
<ul>
<li>
Using the bundled <a href="#scripting">web browser in scripts</a>
</li>
<li>
<a href="#debug">Debugging</a> failed pages
</li>
<li>
Complex <a href="#unit">tests with multiple web browsers</a>
</li>
</ul>
<div class="content">
<p>
SimpleTest's web browser component can be used not just
outside of the <span class="new_code">WebTestCase</span> class, but also
independently of the SimpleTest framework itself.
</p>
<h2>
<a class="target" name="scripting"></a>The Scriptable Browser</h2>
<p>
You can use the web browser in PHP scripts to confirm
services are up and running, or to extract information
from them at a regular basis.
For example, here is a small script to extract the current number of
open PHP 5 bugs from the <a href="http://www.php.net/">PHP web site</a>...
<pre>
<strong>&lt;?php
require_once('simpletest/browser.php');
$browser = &amp;new SimpleBrowser();
$browser-&gt;get('http://php.net/');
$browser-&gt;click('reporting bugs');
$browser-&gt;click('statistics');
$page = $browser-&gt;click('PHP 5 bugs only');
preg_match('/status=Open.*?by=Any.*?(\d+)&lt;\/a&gt;/', $page, $matches);
print $matches[1];
?&gt;</strong>
</pre>
There are simpler methods to do this particular example in PHP
of course.
For example you can just use the PHP <span class="new_code">file()</span>
command against what here is a pretty fixed page.
However, using the web browser for scripts allows authentication,
correct handling of cookies, automatic loading of frames, redirects,
form submission and the ability to examine the page headers.
<p>
</p>
Methods such as periodic scraping are fragile against a site that is constantly
evolving and you would want a more direct way of accessing
data in a permanent set up, but for simple tasks this can provide
a very rapid solution.
</p>
<p>
All of the navigation methods used in the
<a href="web_tester_documentation.html">WebTestCase</a>
are present in the <span class="new_code">SimpleBrowser</span> class, but
the assertions are replaced with simpler accessors.
Here is a full list of the page navigation methods...
<table><tbody>
<tr>
<td><span class="new_code">addHeader($header)</span></td>
<td>Adds a header to every fetch</td>
</tr>
<tr>
<td><span class="new_code">useProxy($proxy, $username, $password)</span></td>
<td>Use this proxy from now on</td>
</tr>
<tr>
<td><span class="new_code">head($url, $parameters)</span></td>
<td>Perform a HEAD request</td>
</tr>
<tr>
<td><span class="new_code">get($url, $parameters)</span></td>
<td>Fetch a page with GET</td>
</tr>
<tr>
<td><span class="new_code">post($url, $parameters)</span></td>
<td>Fetch a page with POST</td>
</tr>
<tr>
<td><span class="new_code">click($label)</span></td>
<td>Clicks visible link or button text</td>
</tr>
<tr>
<td><span class="new_code">clickLink($label)</span></td>
<td>Follows a link by label</td>
</tr>
<tr>
<td><span class="new_code">clickLinkById($id)</span></td>
<td>Follows a link by attribute</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>Current URL of page or frame</td>
</tr>
<tr>
<td><span class="new_code">getTitle()</span></td>
<td>Page title</td>
</tr>
<tr>
<td><span class="new_code">getContent()</span></td>
<td>Raw page or frame</td>
</tr>
<tr>
<td><span class="new_code">getContentAsText()</span></td>
<td>HTML removed except for alt text</td>
</tr>
<tr>
<td><span class="new_code">retry()</span></td>
<td>Repeat the last request</td>
</tr>
<tr>
<td><span class="new_code">back()</span></td>
<td>Use the browser back button</td>
</tr>
<tr>
<td><span class="new_code">forward()</span></td>
<td>Use the browser forward button</td>
</tr>
<tr>
<td><span class="new_code">authenticate($username, $password)</span></td>
<td>Retry page or frame after a 401 response</td>
</tr>
<tr>
<td><span class="new_code">restart($date)</span></td>
<td>Restarts the browser for a new session</td>
</tr>
<tr>
<td><span class="new_code">ageCookies($interval)</span></td>
<td>Ages the cookies by the specified time</td>
</tr>
<tr>
<td><span class="new_code">setCookie($name, $value)</span></td>
<td>Sets an additional cookie</td>
</tr>
<tr>
<td><span class="new_code">getCookieValue($host, $path, $name)</span></td>
<td>Reads the most specific cookie</td>
</tr>
<tr>
<td><span class="new_code">getCurrentCookieValue($name)</span></td>
<td>Reads cookie for the current context</td>
</tr>
</tbody></table>
The methods <span class="new_code">SimpleBrowser::useProxy()</span> and
<span class="new_code">SimpleBrowser::addHeader()</span> are special.
Once called they continue to apply to all subsequent fetches.
</p>
<p>
Navigating forms is similar to the
<a href="form_testing_documentation.html">WebTestCase form navigation</a>...
<table><tbody>
<tr>
<td><span class="new_code">setField($label, $value)</span></td>
<td>Sets all form fields with that label or name</td>
</tr>
<tr>
<td><span class="new_code">setFieldByName($name, $value)</span></td>
<td>Sets all form fields with that name</td>
</tr>
<tr>
<td><span class="new_code">setFieldById($id, $value)</span></td>
<td>Sets all form fields with that id</td>
</tr>
<tr>
<td><span class="new_code">getField($label)</span></td>
<td>Accessor for a form element value by label tag and then name</td>
</tr>
<tr>
<td><span class="new_code">getFieldByName($name)</span></td>
<td>Accessor for a form element value using name attribute</td>
</tr>
<tr>
<td><span class="new_code">getFieldById($id)</span></td>
<td>Accessor for a form element value</td>
</tr>
<tr>
<td><span class="new_code">clickSubmit($label)</span></td>
<td>Submits form by button label</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitByName($name)</span></td>
<td>Submits form by button attribute</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitById($id)</span></td>
<td>Submits form by button attribute</td>
</tr>
<tr>
<td><span class="new_code">clickImage($label, $x, $y)</span></td>
<td>Clicks an input tag of type image by title or alt text</td>
</tr>
<tr>
<td><span class="new_code">clickImageByName($name, $x, $y)</span></td>
<td>Clicks an input tag of type image by name</td>
</tr>
<tr>
<td><span class="new_code">clickImageById($id, $x, $y)</span></td>
<td>Clicks an input tag of type image by ID attribute</td>
</tr>
<tr>
<td><span class="new_code">submitFormById($id)</span></td>
<td>Submits by the form tag attribute</td>
</tr>
</tbody></table>
At the moment there aren't many methods to list available links and fields.
<table><tbody>
<tr>
<td><span class="new_code">isClickable($label)</span></td>
<td>Test to see if a click target exists by label or name</td>
</tr>
<tr>
<td><span class="new_code">isSubmit($label)</span></td>
<td>Test for the existence of a button with that label or name</td>
</tr>
<tr>
<td><span class="new_code">isImage($label)</span></td>
<td>Test for the existence of an image button with that label or name</td>
</tr>
<tr>
<td><span class="new_code">getLink($label)</span></td>
<td>Finds a URL from its label</td>
</tr>
<tr>
<td><span class="new_code">getLinkById($label)</span></td>
<td>Finds a URL from its ID attribute</td>
</tr>
<tr>
<td><span class="new_code">getUrls()</span></td>
<td>Lists available links in the current page</td>
</tr>
</tbody></table>
This will be expanded in later versions of SimpleTest.
</p>
<p>
Frames are a rather esoteric feature these days, but SimpleTest has
retained support for them.
</p>
<p>
Within a page, individual frames can be selected.
If no selection is made then all the frames are merged together
in one large conceptual page.
The content of the current page will be a concatenation of all of the
frames in the order that they were specified in the "frameset"
tags.
<table><tbody>
<tr>
<td><span class="new_code">getFrames()</span></td>
<td>A dump of the current frame structure</td>
</tr>
<tr>
<td><span class="new_code">getFrameFocus()</span></td>
<td>Current frame label or index</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocusByIndex($choice)</span></td>
<td>Select a frame numbered from 1</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocus($name)</span></td>
<td>Select frame by label</td>
</tr>
<tr>
<td><span class="new_code">clearFrameFocus()</span></td>
<td>Treat all the frames as a single page</td>
</tr>
</tbody></table>
When focused on a single frame, the content will come from
that frame only.
This includes links to click and forms to submit.
</p>
<h2>
<a class="target" name="debug"></a>What went wrong?</h2>
<p>
All of this functionality is great when we actually manage to fetch pages,
but that doesn't always happen.
To help figure out what went wrong, the browser has some methods to
aid in debugging...
<table><tbody>
<tr>
<td><span class="new_code">setConnectionTimeout($timeout)</span></td>
<td>Close the socket on overrun</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>Url of most recent page fetched</td>
</tr>
<tr>
<td><span class="new_code">getRequest()</span></td>
<td>Raw request header of page or frame</td>
</tr>
<tr>
<td><span class="new_code">getHeaders()</span></td>
<td>Raw response header of page or frame</td>
</tr>
<tr>
<td><span class="new_code">getTransportError()</span></td>
<td>Any socket level errors in the last fetch</td>
</tr>
<tr>
<td><span class="new_code">getResponseCode()</span></td>
<td>HTTP response of page or frame</td>
</tr>
<tr>
<td><span class="new_code">getMimeType()</span></td>
<td>Mime type of page or frame</td>
</tr>
<tr>
<td><span class="new_code">getAuthentication()</span></td>
<td>Authentication type in 401 challenge header</td>
</tr>
<tr>
<td><span class="new_code">getRealm()</span></td>
<td>Authentication realm in 401 challenge header</td>
</tr>
<tr>
<td><span class="new_code">getBaseUrl()</span></td>
<td>Base url only of most recent page fetched</td>
</tr>
<tr>
<td><span class="new_code">setMaximumRedirects($max)</span></td>
<td>Number of redirects before page is loaded anyway</td>
</tr>
<tr>
<td><span class="new_code">setMaximumNestedFrames($max)</span></td>
<td>Protection against recursive framesets</td>
</tr>
<tr>
<td><span class="new_code">ignoreFrames()</span></td>
<td>Disables frames support</td>
</tr>
<tr>
<td><span class="new_code">useFrames()</span></td>
<td>Enables frames support</td>
</tr>
<tr>
<td><span class="new_code">ignoreCookies()</span></td>
<td>Disables sending and receiving of cookies</td>
</tr>
<tr>
<td><span class="new_code">useCookies()</span></td>
<td>Enables cookie support</td>
</tr>
</tbody></table>
The methods <span class="new_code">SimpleBrowser::setConnectionTimeout()</span>
<span class="new_code">SimpleBrowser::setMaximumRedirects()</span>,
<span class="new_code">SimpleBrowser::setMaximumNestedFrames()</span>,
<span class="new_code">SimpleBrowser::ignoreFrames()</span>,
<span class="new_code">SimpleBrowser::useFrames()</span>,
<span class="new_code">SimpleBrowser::ignoreCookies()</span> and
<span class="new_code">SimpleBrowser::useCokies()</span> continue to apply
to every subsequent request.
The other methods are frames aware.
This means that if you have an individual frame that is not
loading, navigate to it using <span class="new_code">SimpleBrowser::setFrameFocus()</span>
and you can then use <span class="new_code">SimpleBrowser::getRequest()</span>, etc to
see what happened.
</p>
<h2>
<a class="target" name="unit"></a>Complex unit tests with multiple browsers</h2>
<p>
Anything that could be done in a
<a href="web_tester_documentation.html">WebTestCase</a> can
now be done in a <a href="unit_tester_documentation.html">UnitTestCase</a>.
This means that we could freely mix domain object testing with the
web interface...
<pre>
<strong>class TestOfRegistration extends UnitTestCase {
function testNewUserAddedToAuthenticator() {</strong>
$browser = new SimpleBrowser();
$browser-&gt;get('http://my-site.com/register.php');
$browser-&gt;setField('email', 'me@here');
$browser-&gt;setField('password', 'Secret');
$browser-&gt;click('Register');
<strong>
$authenticator = new Authenticator();
$member = $authenticator-&gt;findByEmail('me@here');
$this-&gt;assertEqual($member-&gt;getPassword(), 'Secret');
}
}</strong>
</pre>
While this may be a useful temporary expediency, I am not a fan
of this type of testing.
The testing has cut across application layers, make it twice as
likely it will need refactoring when the code changes.
</p>
<p>
A more useful case of where using the browser directly can be helpful
is where the <span class="new_code">WebTestCase</span> cannot cope.
An example is where two browsers are needed at the same time.
</p>
<p>
For example, say we want to disallow multiple simultaneous
usage of a site with the same username.
This test case will do the job...
<pre>
class TestOfSecurity extends UnitTestCase {
function testNoMultipleLoginsFromSameUser() {<strong>
$first_attempt = new SimpleBrowser();
$first_attempt-&gt;get('http://my-site.com/login.php');
$first_attempt-&gt;setField('name', 'Me');
$first_attempt-&gt;setField('password', 'Secret');
$first_attempt-&gt;click('Enter');
$this-&gt;assertEqual($first_attempt-&gt;getTitle(), 'Welcome');
$second_attempt = new SimpleBrowser();
$second_attempt-&gt;get('http://my-site.com/login.php');
$second_attempt-&gt;setField('name', 'Me');
$second_attempt-&gt;setField('password', 'Secret');
$second_attempt-&gt;click('Enter');
$this-&gt;assertEqual($second_attempt-&gt;getTitle(), 'Access Denied');</strong>
}
}
</pre>
You can also use the <span class="new_code">SimpleBrowser</span> class
directly when you want to write test cases using a different
test tool than SimpleTest, such as PHPUnit.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
The <a href="http://simpletest.org/api/">developer's API for SimpleTest</a>
gives full detail on the classes and assertions available.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<span class="chosen">Scriptable browser</span>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,121 +0,0 @@
body {
padding-left: 3%;
padding-right: 3%;
}
h1, h2, h3 {
font-family: sans-serif;
}
h1 {
text-align: center;
}
pre {
font-family: "courier new", courier, typewriter, monospace;
font-size: 90%;
border: 1px solid;
border-color: #999966;
background-color: #ffffcc;
padding: 5px;
margin-left: 20px;
margin-right: 40px;
}
.code, .new_code, pre.new_code {
font-family: "courier new", courier, typewriter, monospace;
font-weight: bold;
}
div.copyright {
font-size: 80%;
color: gray;
}
div.copyright a {
margin-top: 1em;
color: gray;
}
ul.api {
border: 2px outset;
border-color: gray;
background-color: white;
margin: 5px;
margin-left: 5%;
margin-right: 5%;
}
ul.api li {
margin-top: 0.2em;
margin-bottom: 0.2em;
list-style: none;
text-indent: -3em;
padding-left: 1em;
}
div.demo {
border: 4px ridge;
border-color: gray;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: white;
}
div.demo span.fail {
color: red;
}
div.demo span.pass {
color: green;
}
div.demo h1 {
font-size: 12pt;
text-align: left;
font-weight: bold;
}
div.menu {
text-align: center;
}
table {
border: 2px outset;
border-color: gray;
background-color: white;
margin: 5px;
margin-left: 5%;
margin-right: 5%;
}
td {
font-size: 90%;
}
.shell {
color: white;
}
pre.shell {
border: 4px ridge;
border-color: gray;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: #000100;
color: #99ff99;
font-size: 90%;
}
pre.file {
color: black;
border: 1px solid;
border-color: black;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: white;
font-size: 90%;
}
form.demo {
background-color: lightgray;
border: 4px outset;
border-color: lightgray;
padding: 10px;
margin-right: 40%;
}
dl, dd {
margin: 10px;
margin-left: 30px;
}
em {
font-weight: bold;
font-family: "courier new", courier, typewriter, monospace;
}

View File

@ -1,476 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Extending the SimpleTest unit tester with additional expectation classes
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<span class="chosen">Expectations</span>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Expectation documentation</h1>
This page...
<ul>
<li>
Using expectations for
<a href="#mock">more precise testing with mock objects</a>
</li>
<li>
<a href="#behaviour">Changing mock object behaviour</a> with expectations
</li>
<li>
<a href="#extending">Extending the expectations</a>
</li>
<li>
Underneath SimpleTest <a href="#unit">uses expectation classes</a>
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="mock"></a>More control over mock objects</h2>
<p>
The default behaviour of the
<a href="mock_objects_documentation.html">mock objects</a>
in
<a href="http://sourceforge.net/projects/simpletest/">SimpleTest</a>
is either an identical match on the argument or to allow any argument at all.
For almost all tests this is sufficient.
Sometimes, though, you want to weaken a test case.
</p>
<p>
One place where a test can be too tightly coupled is with
text matching.
Suppose we have a component that outputs a helpful error
message when something goes wrong.
You want to test that the correct error was sent, but the actual
text may be rather long.
If you test for the text exactly, then every time the exact wording
of the message changes, you will have to go back and edit the test suite.
</p>
<p>
For example, suppose we have a news service that has failed
to connect to its remote source.
<pre>
<strong>class NewsService {
...
function publish($writer) {
if (! $this-&gt;isConnected()) {
$writer-&gt;write('Cannot connect to news service "' .
$this-&gt;_name . '" at this time. ' .
'Please try again later.');
}
...
}
}</strong>
</pre>
Here it is sending its content to a
<span class="new_code">Writer</span> class.
We could test this behaviour with a
<span class="new_code">MockWriter</span> like so...
<pre>
class TestOfNewsService extends UnitTestCase {
...
function testConnectionFailure() {<strong>
$writer = new MockWriter();
$writer-&gt;expectOnce('write', array(
'Cannot connect to news service ' .
'"BBC News" at this time. ' .
'Please try again later.'));
$service = new NewsService('BBC News');
$service-&gt;publish($writer);</strong>
}
}
</pre>
This is a good example of a brittle test.
If we decide to add additional instructions, such as
suggesting an alternative news source, we will break
our tests even though no underlying functionality
has been altered.
</p>
<p>
To get around this, we would like to do a regular expression
test rather than an exact match.
We can actually do this with...
<pre>
class TestOfNewsService extends UnitTestCase {
...
function testConnectionFailure() {
$writer = new MockWriter();<strong>
$writer-&gt;expectOnce(
'write',
array(new PatternExpectation('/cannot connect/i')));</strong>
$service = new NewsService('BBC News');
$service-&gt;publish($writer);
}
}
</pre>
Instead of passing in the expected parameter to the
<span class="new_code">MockWriter</span> we pass an
expectation class called
<span class="new_code">PatternExpectation</span>.
The mock object is smart enough to recognise this as special
and to treat it differently.
Rather than simply comparing the incoming argument to this
object, it uses the expectation object itself to
perform the test.
</p>
<p>
The <span class="new_code">PatternExpectation</span> takes
the regular expression to match in its constructor.
Whenever a comparison is made by the <span class="new_code">MockWriter</span>
against this expectation class, it will do a
<span class="new_code">preg_match()</span> with this pattern.
With our test case above, as long as "cannot connect"
appears in the text of the string, the mock will issue a pass
to the unit tester.
The rest of the text does not matter.
</p>
<p>
The possible expectation classes are...
<table><tbody>
<tr>
<td><span class="new_code">AnythingExpectation</span></td>
<td>Will always match</td>
</tr>
<tr>
<td><span class="new_code">EqualExpectation</span></td>
<td>An equality, rather than the stronger identity comparison</td>
</tr>
<tr>
<td><span class="new_code">NotEqualExpectation</span></td>
<td>An inequality comparison</td>
</tr>
<tr>
<td><span class="new_code">IndenticalExpectation</span></td>
<td>The default mock object check which must match exactly</td>
</tr>
<tr>
<td><span class="new_code">NotIndenticalExpectation</span></td>
<td>Inverts the mock object logic</td>
</tr>
<tr>
<td><span class="new_code">WithinMarginExpectation</span></td>
<td>Compares a value to within a margin</td>
</tr>
<tr>
<td><span class="new_code">OutsideMarginExpectation</span></td>
<td>Checks that a value is out side the margin</td>
</tr>
<tr>
<td><span class="new_code">PatternExpectation</span></td>
<td>Uses a Perl Regex to match a string</td>
</tr>
<tr>
<td><span class="new_code">NoPatternExpectation</span></td>
<td>Passes only if failing a Perl Regex</td>
</tr>
<tr>
<td><span class="new_code">IsAExpectation</span></td>
<td>Checks the type or class name only</td>
</tr>
<tr>
<td><span class="new_code">NotAExpectation</span></td>
<td>Opposite of the <span class="new_code">IsAExpectation</span>
</td>
</tr>
<tr>
<td><span class="new_code">MethodExistsExpectation</span></td>
<td>Checks a method is available on an object</td>
</tr>
<tr>
<td><span class="new_code">TrueExpectation</span></td>
<td>Accepts any PHP variable that evaluates to true</td>
</tr>
<tr>
<td><span class="new_code">FalseExpectation</span></td>
<td>Accepts any PHP variable that evaluates to false</td>
</tr>
</tbody></table>
Most take the expected value in the constructor.
The exceptions are the pattern matchers, which take a regular expression,
and the <span class="new_code">IsAExpectation</span> and <span class="new_code">NotAExpectation</span> which takes a type
or class name as a string.
</p>
<p>
Some examples...
</p>
<p>
<pre>
$mock-&gt;expectOnce('method', array(new IdenticalExpectation(14)));
</pre>
This is the same as <span class="new_code">$mock-&gt;expectOnce('method', array(14))</span>.
<pre>
$mock-&gt;expectOnce('method', array(new EqualExpectation(14)));
</pre>
This is different from the previous version in that the string
<span class="new_code">"14"</span> as a parameter will also pass.
Sometimes the additional type checks of SimpleTest are too restrictive.
<pre>
$mock-&gt;expectOnce('method', array(new AnythingExpectation(14)));
</pre>
This is the same as <span class="new_code">$mock-&gt;expectOnce('method', array('*'))</span>.
<pre>
$mock-&gt;expectOnce('method', array(new IdenticalExpectation('*')));
</pre>
This is handy if you want to assert a literal <span class="new_code">"*"</span>.
<pre>
new NotIdenticalExpectation(14)
</pre>
This matches on anything other than integer 14.
Even the string <span class="new_code">"14"</span> would pass.
<pre>
new WithinMarginExpectation(14.0, 0.001)
</pre>
This will accept any value from 13.999 to 14.001 inclusive.
</p>
<h2>
<a class="target" name="behaviour"></a>Using expectations to control stubs</h2>
<p>
The expectation classes can be used not just for sending assertions
from mock objects, but also for selecting behaviour for the
<a href="mock_objects_documentation.html">mock objects</a>.
Anywhere a list of arguments is given, a list of expectation objects
can be inserted instead.
</p>
<p>
Suppose we want a mock authorisation server to simulate a successful login,
but only if it receives a valid session object.
We can do this as follows...
<pre>
Mock::generate('Authorisation');
<strong>
$authorisation = new MockAuthorisation();
$authorisation-&gt;returns(
'isAllowed',
true,
array(new IsAExpectation('Session', 'Must be a session')));
$authorisation-&gt;returns('isAllowed', false);</strong>
</pre>
We have set the default mock behaviour to return false when
<span class="new_code">isAllowed</span> is called.
When we call the method with a single parameter that
is a <span class="new_code">Session</span> object, it will return true.
We have also added a second parameter as a message.
This will be displayed as part of the mock object
failure message if this expectation is the cause of
a failure.
</p>
<p>
This kind of sophistication is rarely useful, but is included for
completeness.
</p>
<h2>
<a class="target" name="extending"></a>Creating your own expectations</h2>
<p>
The expectation classes have a very simple structure.
So simple that it is easy to create your own versions for
commonly used test logic.
</p>
<p>
As an example here is the creation of a class to test for
valid IP addresses.
In order to work correctly with the stubs and mocks the new
expectation class should extend
<span class="new_code">SimpleExpectation</span> or further extend a subclass...
<pre>
<strong>class ValidIp extends SimpleExpectation {
function test($ip) {
return (ip2long($ip) != -1);
}
function testMessage($ip) {
return "Address [$ip] should be a valid IP address";
}
}</strong>
</pre>
There are only two methods to implement.
The <span class="new_code">test()</span> method should
evaluate to true if the expectation is to pass, and
false otherwise.
The <span class="new_code">testMessage()</span> method
should simply return some helpful text explaining the test
that was carried out.
</p>
<p>
This class can now be used in place of the earlier expectation
classes.
</p>
<p>
Here is a more typical example, matching part of a hash...
<pre>
<strong>class JustField extends EqualExpectation {
private $key;
function __construct($key, $expected) {
parent::__construct($expected);
$this-&gt;key = $key;
}
function test($compare) {
if (! isset($compare[$this-&gt;key])) {
return false;
}
return parent::test($compare[$this-&gt;key]);
}
function testMessage($compare) {
if (! isset($compare[$this-&gt;key])) {
return 'Key [' . $this-&gt;key . '] does not exist';
}
return 'Key [' . $this-&gt;key . '] -&gt; ' .
parent::testMessage($compare[$this-&gt;key]);
}
}</strong>
</pre>
We tend to seperate message clauses with
"&amp;nbsp;-&gt;&amp;nbsp;".
This allows derivative tools to reformat the output.
</p>
<p>
Suppose some authenticator is expecting to be given
a database row corresponding to the user, and we
only need to confirm the username is correct.
We can assert just their username with...
<pre>
$mock-&gt;expectOnce('authenticate',
array(new JustKey('username', 'marcus')));
</pre>
</p>
<h2>
<a class="target" name="unit"></a>Under the bonnet of the unit tester</h2>
<p>
The <a href="http://sourceforge.net/projects/simpletest/">SimpleTest unit testing framework</a>
also uses the expectation classes internally for the
<a href="unit_test_documentation.html">UnitTestCase class</a>.
We can also take advantage of these mechanisms to reuse our
homebrew expectation classes within the test suites directly.
</p>
<p>
The most crude way of doing this is to use the generic
<span class="new_code">SimpleTest::assert()</span> method to
test against it directly...
<pre>
<strong>class TestOfNetworking extends UnitTestCase {
...
function testGetValidIp() {
$server = &amp;new Server();
$this-&gt;assert(
new ValidIp(),
$server-&gt;getIp(),
'Server IP address-&gt;%s');
}
}</strong>
</pre>
<span class="new_code">assert()</span> will test any expectation class directly.
</p>
<p>
This is a little untidy compared with our usual
<span class="new_code">assert...()</span> syntax.
</p>
<p>
For such a simple case we would normally create a
separate assertion method on our test case rather
than bother using the expectation class.
If we pretend that our expectation is a little more
complicated for a moment, so that we want to reuse it,
we get...
<pre>
class TestOfNetworking extends UnitTestCase {
...<strong>
function assertValidIp($ip, $message = '%s') {
$this-&gt;assert(new ValidIp(), $ip, $message);
}</strong>
function testGetValidIp() {
$server = &amp;new Server();<strong>
$this-&gt;assertValidIp(
$server-&gt;getIp(),
'Server IP address-&gt;%s');</strong>
}
}
</pre>
It is rare to need the expectations for more than pattern
matching, but these facilities do allow testers to build
some sort of domain language for testing their application.
Also, complex expectation classes could make the tests
harder to read and debug.
In effect extending the test framework to create their own tool set.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
The expectations mimic the constraints in <a href="http://www.jmock.org/">JMock</a>.
</li>
<li>
<a href="http://simpletest.org/api/">Full API for SimpleTest</a>
from the PHPDoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<span class="chosen">Expectations</span>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,351 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest documentation for testing HTML forms</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<span class="chosen">Testing forms</span>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Form testing documentation</h1>
This page...
<ul>
<li>
Changing form values and successfully
<a href="#submit">Submitting a simple form</a>
</li>
<li>
Handling <a href="#multiple">widgets with multiple values</a>
by setting lists.
</li>
<li>
Bypassing javascript to <a href="#hidden-field">set a hidden field</a>.
</li>
<li>
<a href="#raw">Raw posting</a> when you don't have a button
to click.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="submit"></a>Submitting a simple form</h2>
<p>
When a page is fetched by the <span class="new_code">WebTestCase</span>
using <span class="new_code">get()</span> or
<span class="new_code">post()</span> the page content is
automatically parsed.
This results in any form controls that are inside &lt;form&gt; tags
being available from within the test case.
For example, if we have this snippet of HTML...
<pre>
&lt;form&gt;
&lt;input type="text" name="a" value="A default" /&gt;
&lt;input type="submit" value="Go" /&gt;
&lt;/form&gt;
</pre>
Which looks like this...
</p>
<p>
<form class="demo">
<input type="text" name="a" value="A default">
<input type="submit" value="Go">
</form>
</p>
<p>
We can navigate to this code, via the
<a href="http://www.lastcraft.com/form_testing_documentation.php">LastCraft</a>
site, with the following test...
<pre>
class SimpleFormTests extends WebTestCase {<strong>
function testDefaultValue() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('a', 'A default');
}</strong>
}
</pre>
Immediately after loading the page all of the HTML controls are set at
their default values just as they would appear in the web browser.
The assertion tests that a HTML widget exists in the page with the
name "a" and that it is currently set to the value
"A default".
As usual, we could use a pattern expectation instead of a fixed
string.
<pre>
class SimpleFormTests extends WebTestCase {
function testDefaultValue() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('a', <strong>new PatternExpectation('/default/')</strong>);
}
}
</pre>
We could submit the form straight away, but first we'll change
the value of the text field and only then submit it...
<pre>
class SimpleFormTests extends WebTestCase {
function testDefaultValue() {
$this-&gt;get('http://www.my-site.com/');
$this-&gt;assertField('a', 'A default');<strong>
$this-&gt;setField('a', 'New value');
$this-&gt;click('Go');</strong>
}
}
</pre>
Because we didn't specify a method attribute on the form tag, and
didn't specify an action either, the test case will follow
the usual browser behaviour of submitting the form data as a <em>GET</em>
request back to the same location.
In general SimpleTest tries to emulate typical browser behaviour as much as possible,
rather than attempting to catch any form of HTML omission.
This is because the target of the testing framework is the PHP application
logic, not syntax or other errors in the HTML code.
For HTML errors, other tools such as
<a href="http://www.w3.org/People/Raggett/tidy/">HTMLTidy</a> should be used,
or any of the HTML and CSS validators already out there.
</p>
<p>
If a field is not present in any form, or if an option is unavailable,
then <span class="new_code">WebTestCase::setField()</span> will return
<span class="new_code">false</span>.
For example, suppose we wish to verify that a "Superuser"
option is not present in this form...
<pre>
&lt;strong&gt;Select type of user to add:&lt;/strong&gt;
&lt;select name="type"&gt;
&lt;option&gt;Subscriber&lt;/option&gt;
&lt;option&gt;Author&lt;/option&gt;
&lt;option&gt;Administrator&lt;/option&gt;
&lt;/select&gt;
</pre>
Which looks like...
</p>
<p>
<form class="demo">
<strong>Select type of user to add:</strong>
<select name="type">
<option>Subscriber</option>
<option>Author</option>
<option>Administrator</option>
</select>
</form>
</p>
<p>
The following test will confirm it...
<pre>
class SimpleFormTests extends WebTestCase {
...
function testNoSuperuserChoiceAvailable() {<strong>
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertFalse($this-&gt;setField('type', 'Superuser'));</strong>
}
}
</pre>
The current selection will not be changed if the new value is not an option.
</p>
<p>
Here is the full list of widgets currently supported...
<ul>
<li>Text fields, including hidden and password fields.</li>
<li>Submit buttons including the button tag, although not yet reset buttons</li>
<li>Text area. This includes text wrapping behaviour.</li>
<li>Checkboxes, including multiple checkboxes in the same form.</li>
<li>Drop down selections, including multiple selects.</li>
<li>Radio buttons.</li>
<li>Images.</li>
</ul>
</p>
<p>
The browser emulation offered by SimpleTest mimics
the actions which can be perform by a user on a
standard HTML page. Javascript is not supported, and
it's unlikely that support will be added any time
soon.
</p>
<p>
Of particular note is that the Javascript idiom of
passing form results by setting a hidden field cannot
be performed using the normal SimpleTest
commands. See below for a way to test such forms.
</p>
<h2>
<a class="target" name="multiple"></a>Fields with multiple values</h2>
<p>
SimpleTest can cope with two types of multivalue controls: Multiple
selection drop downs, and multiple checkboxes with the same name
within a form.
The multivalue nature of these means that setting and testing
are slightly different.
Using checkboxes as an example...
<pre>
&lt;form class="demo"&gt;
&lt;strong&gt;Create privileges allowed:&lt;/strong&gt;
&lt;input type="checkbox" name="crud" value="c" checked&gt;&lt;br&gt;
&lt;strong&gt;Retrieve privileges allowed:&lt;/strong&gt;
&lt;input type="checkbox" name="crud" value="r" checked&gt;&lt;br&gt;
&lt;strong&gt;Update privileges allowed:&lt;/strong&gt;
&lt;input type="checkbox" name="crud" value="u" checked&gt;&lt;br&gt;
&lt;strong&gt;Destroy privileges allowed:&lt;/strong&gt;
&lt;input type="checkbox" name="crud" value="d" checked&gt;&lt;br&gt;
&lt;input type="submit" value="Enable Privileges"&gt;
&lt;/form&gt;
</pre>
Which renders as...
</p>
<p>
<form class="demo">
<strong>Create privileges allowed:</strong>
<input type="checkbox" name="crud" value="c" checked><br>
<strong>Retrieve privileges allowed:</strong>
<input type="checkbox" name="crud" value="r" checked><br>
<strong>Update privileges allowed:</strong>
<input type="checkbox" name="crud" value="u" checked><br>
<strong>Destroy privileges allowed:</strong>
<input type="checkbox" name="crud" value="d" checked><br>
<input type="submit" value="Enable Privileges">
</form>
</p>
<p>
If we wish to disable all but the retrieval privileges and
submit this information we can do it like this...
<pre>
class SimpleFormTests extends WebTestCase {
...<strong>
function testDisableNastyPrivileges() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('crud', array('c', 'r', 'u', 'd'));
$this-&gt;setField('crud', array('r'));
$this-&gt;click('Enable Privileges');
}</strong>
}
</pre>
Instead of setting the field to a single value, we give it a list
of values.
We do the same when testing expected values.
We can then write other test code to confirm the effect of this, perhaps
by logging in as that user and attempting an update.
</p>
<h2>
<a class="target" name="hidden-field"></a>Forms which use javascript to set a hidden field</h2>
<p>
If you want to test a form which relies on javascript to set a hidden
field, you can't just call setField().
The following code will <em>not</em> work:
<pre>
class SimpleFormTests extends WebTestCase {
function testEmulateMyJavascriptForm() {
<strong>// This does *not* work</strong>
$this-&gt;setField('a_hidden_field', '123');
$this-&gt;clickSubmit('OK');
}
}
</pre>
Instead, you need to pass the additional form parameters to the
clickSubmit() method:
<pre>
class SimpleFormTests extends WebTestCase {
function testMyJavascriptForm() {
<strong>$this-&gt;clickSubmit('OK', array('a_hidden_field'=&gt;'123'));</strong>
}
}
</pre>
Bear in mind that in doing this you're effectively stubbing out a
part of your software (the javascript code in the form), and
perhaps you might be better off using something like
<a href="http://selenium.openqa.org/">Selenium</a> to ensure a complete
test.
</p>
<h2>
<a class="target" name="raw"></a>Raw posting</h2>
<p>
If you want to test a form handler, but have not yet written
or do not have access to the form itself, you can create a
form submission by hand.
<pre>
class SimpleFormTests extends WebTestCase {
...<strong>
function testAttemptedHack() {
$this-&gt;post(
'http://www.my-site.com/add_user.php',
array('type' =&gt; 'superuser'));
$this-&gt;assertNoText('user created');
}</strong>
}
</pre>
By adding data to the <span class="new_code">WebTestCase::post()</span>
method, we are emulating a form submission.
You would normally only do this as a temporary expedient, or where
you are expecting a 3rd party to submit to a form.
The exception is when you want tests to protect you from
attempts to spoof your pages.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
The <a href="http://simpletest.org/api/">developer's API for SimpleTest</a>
gives full detail on the classes and assertions available.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<span class="chosen">Testing forms</span>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,252 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest for PHP test suites</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<span class="chosen">Group tests</span>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Test suite documentation</h1>
This page...
<ul>
<li>
Different ways to <a href="#group">group tests</a> together.
</li>
<li>
Combining group tests into <a href="#higher">larger groups</a>.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="group"></a>Grouping tests into suites</h2>
<p>
There are many ways to group tests together into test suites.
One way is to simply place multiple test cases into a single file...
<pre>
<strong>&lt;?php
require_once(dirname(__FILE__) . '/simpletest/autorun.php');
require_once(dirname(__FILE__) . '/../classes/io.php');
class FileTester extends UnitTestCase {
...
}
class SocketTester extends UnitTestCase {
...
}
?&gt;</strong>
</pre>
As many cases as needed can appear in a single file.
They should include any code they need, such as the library
being tested, but need none of the SimpleTest libraries.
</p>
<p>
Occasionally special subclasses are created that methods useful
for testing part of the application.
These new base classes are then used in place of <span class="new_code">UnitTestCase</span>
or <span class="new_code">WebTestCase</span>.
You don't normally want to run these as test cases.
Simply mark any base test cases that should not be run as abstract...
<pre>
<strong>abstract</strong> class MyFileTestCase extends UnitTestCase {
...
}
class FileTester extends MyFileTestCase { ... }
class SocketTester extends UnitTestCase { ... }
</pre>
Here the <span class="new_code">FileTester</span> class does
not contain any actual tests, but is the base class for other
test cases.
</p>
<p>
We will call this sample <em>file_test.php</em>.
Currently the test cases are grouped simply by being in the same file.
We can build larger constructs just by including other test files in.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('file_test.php');
?&gt;
</pre>
This will work, but create a purely flat hierarchy.
INstead we create a test suite file.
Our top level test suite can look like this...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class AllFileTests extends TestSuite {
function __construct() {
parent::__construct();
<strong>$this-&gt;addFile('file_test.php');</strong>
}
}
?&gt;
</pre>
What happens here is that the <span class="new_code">TestSuite</span>
class will do the <span class="new_code">require_once()</span>
for us.
It then checks to see if any new test case classes
have been created by the new file and automatically composes
them to the test suite.
This method gives us the most control as we just manually add
more test files as our test suite grows.
</p>
<p>
If this is too much typing, and you are willing to group
test suites together in their own directories or otherwise
tag the file names, then there is a more automatic way...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class AllFileTests extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;collect(dirname(__FILE__) . '/unit',
new SimplePatternCollector('/_test.php/'));
}
}
?&gt;
</pre>
This will scan a directory called "unit" for any files
ending with "_test.php" and load them.
You don't have to use <span class="new_code">SimplePatternCollector</span> to
filter by a pattern in the filename, but this is the most common
usage.
</p>
<p>
That snippet above is very common in practice.
Now all you have to do is drop a file of test cases into the
directory and it will run just by running the test suite script.
</p>
<p>
The catch is that you cannot control the order in which the test
cases are run.
If you want to see lower level components fail first in the test suite,
and this will make diagnosis a lot easier, then you should manually
call <span class="new_code">addFile()</span> for these.
Tests cases are only loaded once, so it's fine to have these included
again by a directory scan.
</p>
<p>
Test cases loaded with the <span class="new_code">addFile</span> method have some
useful properties.
You can guarantee that the constructor is run
just before the first test method and the destructor
is run just after the last test method.
This allows you to place test case wide set up and tear down
code in the constructor and destructor, just like a normal
class.
</p>
<h2>
<a class="target" name="higher"></a>Composite suites</h2>
<p>
The above method places all of the test cases into one large suite.
For larger projects though this may not be flexible enough; you
may want to group the tests together in all sorts of ways.
</p>
<p>
Everything we have described so far with test scripts applies to
<span class="new_code">TestSuite</span>s as well...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
<strong>
class BigTestSuite extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('file_tests.php');
}
}</strong>
?&gt;
</pre>
This effectively adds our test cases and a single suite below
the first.
When a test fails, we see the breadcrumb trail of the nesting.
We can even mix groups and test cases freely as long as
we are careful about loops in our includes.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class BigTestSuite extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('file_tests.php');
<strong>$this-&gt;addFile('some_other_test.php');</strong>
}
}
?&gt;
</pre>
Note that in the event of a double include, ony the first instance
of the test case will be run.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<span class="chosen">Group tests</span>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,542 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Download the SimpleTest testing framework -
Unit tests and mock objects for PHP
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<span class="chosen">SimpleTest</span>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>SimpleTest for PHP</h1>
This page...
<ul>
<li>
<a href="#unit">Using unit tester</a>
with an example.
</li>
<li>
<a href="#group">Grouping tests</a>
for testing with one click.
</li>
<li>
<a href="#mock">Using mock objects</a>
to ease testing and gain tighter control.
</li>
<li>
<a href="#web">Testing web pages</a>
at the browser level.
</li>
</ul>
<div class="content">
<p>
The following assumes that you are familiar with the concept
of unit testing as well as the PHP web development language.
It is a guide for the impatient new user of
<a href="https://sourceforge.net/project/showfiles.php?group_id=76550">SimpleTest</a>.
For fuller documentation, especially if you are new
to unit testing see the ongoing
<a href="unit_test_documentation.html">documentation</a>, and for
example test cases see the
<a href="http://www.lastcraft.com/first_test_tutorial.php">unit testing tutorial</a>.
</p>
<h2>
<a class="target" name="unit"></a>Using the tester quickly</h2>
<p>
Amongst software testing tools, a unit tester is the one
closest to the developer.
In the context of agile development the test code sits right
next to the source code as both are written simultaneously.
In this context SimpleTest aims to be a complete PHP developer
test solution and is called "Simple" because it
should be easy to use and extend.
It wasn't a good choice of name really.
It includes all of the typical functions you would expect from
<a href="http://www.junit.org/">JUnit</a> and the
<a href="http://sourceforge.net/projects/phpunit/">PHPUnit</a>
ports, and includes
<a href="http://www.mockobjects.com">mock objects</a>.
</p>
<p>
What makes this tool immediately useful to the PHP developer is the internal
web browser.
This allows tests that navigate web sites, fill in forms and test pages.
Being able to write these test in PHP means that it is easy to write
integrated tests.
An example might be confirming that a user was written to a database
after a signing up through the web site.
</p>
<p>
The quickest way to demonstrate SimpleTest is with an example.
</p>
<p>
Let us suppose we are testing a simple file logging class called
<span class="new_code">Log</span> in <em>classes/log.php</em>.
We start by creating a test script which we will call
<em>tests/log_test.php</em> and populate it as follows...
<pre>
&lt;?php
<strong>require_once('simpletest/autorun.php');</strong>
require_once('../classes/log.php');
class TestOfLogging extends <strong>UnitTestCase</strong> {
}
?&gt;
</pre>
Here the <em>simpletest</em> folder is either local or in the path.
You would have to edit these locations depending on where you
unpacked the toolset.
The "autorun.php" file does more than just include the
SimpleTest files, it also runs our test for us.
</p>
<p>
The <span class="new_code">TestOfLogging</span> is our first test case and it's
currently empty.
Each test case is a class that extends one of the SimpleTet base classes
and we can have as many of these in the file as we want.
</p>
<p>
With three lines of scaffolding, and our <span class="new_code">Log</span> class
include, we have a test suite.
No tests though.
</p>
<p>
For our first test, we'll assume that the <span class="new_code">Log</span> class
takes the file name to write to in the constructor, and we have
a temporary folder in which to place this file...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
class TestOfLogging extends UnitTestCase {
function <strong>testLogCreatesNewFileOnFirstMessage()</strong> {
@unlink('/temp/test.log');
$log = new Log('/temp/test.log');
<strong>$this-&gt;assertFalse(file_exists('/temp/test.log'));</strong>
$log-&gt;message('Should write this to a file');
<strong>$this-&gt;assertTrue(file_exists('/temp/test.log'));</strong>
}
}
?&gt;
</pre>
When a test case runs, it will search for any method that
starts with the string "test"
and execute that method.
If the method starts "test", it's a test.
Note the very long name <span class="new_code">testLogCreatesNewFileOnFirstMessage()</span>.
This is considered good style and makes the test output more readable.
</p>
<p>
We would normally have more than one test method in a test case,
but that's for later.
</p>
<p>
Assertions within the test methods trigger messages to the
test framework which displays the result immediately.
This immediate response is important, not just in the event
of the code causing a crash, but also so that
<span class="new_code">print</span> statements can display
their debugging content right next to the assertion concerned.
</p>
<p>
To see these results we have to actually run the tests.
No other code is necessary - we can just open the page
with our browser.
</p>
<p>
On failure the display looks like this...
<div class="demo">
<h1>TestOfLogging</h1>
<span class="fail">Fail</span>: testLogCreatesNewFileOnFirstMessage-&gt;True assertion failed.<br>
<div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete.
<strong>1</strong> passes and <strong>1</strong> fails.</div>
</div>
...and if it passes like this...
<div class="demo">
<h1>TestOfLogging</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>2</strong> passes and <strong>0</strong> fails.</div>
</div>
And if you get this...
<div class="demo">
<b>Fatal error</b>: Failed opening required '../classes/log.php' (include_path='') in <b>/home/marcus/projects/lastcraft/tutorial_tests/Log/tests/log_test.php</b> on line <b>7</b>
</div>
it means you're missing the <em>classes/Log.php</em> file that could look like...
<pre>
&lt;?php<strong>
class Log {
function Log($file_path) {
}
function message() {
}
}</strong>
?&gt;
</pre>
It's fun to write the code after the test.
More than fun even -
this system is called "Test Driven Development".
</p>
<p>
For more information about <span class="new_code">UnitTestCase</span>, see
the <a href="unit_test_documentation.html">unit test documentation</a>.
</p>
<h2>
<a class="target" name="group"></a>Building test suites</h2>
<p>
It is unlikely in a real application that we will only ever run
one test case.
This means that we need a way of grouping cases into a test
script that can, if need be, run every test for the application.
</p>
<p>
Our first step is to create a new file called <em>tests/all_tests.php</em>
and insert the following code...
<pre>
&lt;?php
<strong>require_once('simpletest/autorun.php');</strong>
class AllTests extends <strong>TestSuite</strong> {
function AllTests() {
$this-&gt;TestSuite(<strong>'All tests'</strong>);
<strong>$this-&gt;addFile('log_test.php');</strong>
}
}
?&gt;
</pre>
The "autorun" include allows our upcoming test suite
to be run just by invoking this script.
</p>
<p>
The <span class="new_code">TestSuite</span> subclass must chain it's constructor.
This limitation will be removed in future versions.
</p>
<p>
The method <span class="new_code">TestSuite::addFile()</span>
will include the test case file and read any new classes
that are descended from <span class="new_code">SimpleTestCase</span>.
<span class="new_code">UnitTestCase</span> is just one example of a class derived from
<span class="new_code">SimpleTestCase</span>, and you can create your own.
<span class="new_code">TestSuite::addFile()</span> can include other test suites.
</p>
<p>
The class will not be instantiated yet.
When the test suite runs it will construct each instance once
it reaches that test, then destroy it straight after.
This means that the constructor is run just before each run
of that test case, and the destructor is run before the next test case starts.
</p>
<p>
It is common to group test case code into superclasses which are not
supposed to run, but become the base classes of other tests.
For "autorun" to work properly the test case file should not blindly run
any other test case extensions that do not actually run tests.
This could result in extra test cases being counted during the test
run.
Hardly a major problem, but to avoid this inconvenience simply mark your
base class as <span class="new_code">abstract</span>.
SimpleTest won't run abstract classes.
If you are still using PHP4, then
a <span class="new_code">SimpleTestOptions::ignore()</span> directive
somewhere in the test case file will have the same effect.
</p>
<p>
Also, the test case file should not have been included
elsewhere or no cases will be added to this group test.
This would be a more serious error as if the test case classes are
already loaded by PHP the <span class="new_code">TestSuite::addFile()</span>
method will not detect them.
</p>
<p>
To display the results it is necessary only to invoke
<em>tests/all_tests.php</em> from the web server or the command line.
</p>
<p>
For more information about building test suites,
see the <a href="group_test_documentation.html">test suite documentation</a>.
</p>
<h2>
<a class="target" name="mock"></a>Using mock objects</h2>
<p>
Let's move further into the future and do something really complicated.
</p>
<p>
Assume that our logging class is tested and completed.
Assume also that we are testing another class that is
required to write log messages, say a
<span class="new_code">SessionPool</span>.
We want to test a method that will probably end up looking
like this...
<pre><strong>
class SessionPool {
...
function logIn($username) {
...
$this-&gt;_log-&gt;message("User $username logged in.");
...
}
...
}
</strong>
</pre>
In the spirit of reuse, we are using our
<span class="new_code">Log</span> class.
A conventional test case might look like this...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
<strong>require_once('../classes/session_pool.php');</strong>
class <strong>TestOfSessionLogging</strong> extends UnitTestCase {
function setUp() {
<strong>@unlink('/temp/test.log');</strong>
}
function tearDown() {
<strong>@unlink('/temp/test.log');</strong>
}
function testLoggingInIsLogged() {
<strong>$log = new Log('/temp/test.log');
$session_pool = &amp;new SessionPool($log);
$session_pool-&gt;logIn('fred');</strong>
$messages = file('/temp/test.log');
$this-&gt;assertEqual($messages[0], "User fred logged in.<strong>\n</strong>");
}
}
?&gt;
</pre>
We'll explain the <span class="new_code">setUp()</span> and <span class="new_code">tearDown()</span>
methods later.
</p>
<p>
This test case design is not all bad, but it could be improved.
We are spending time fiddling with log files which are
not part of our test.
We have created close ties with the <span class="new_code">Log</span> class and
this test.
What if we don't use files any more, but use ths
<em>syslog</em> library instead?
It means that our <span class="new_code">TestOfSessionLogging</span> test will
fail, even thouh it's not testing Logging.
</p>
<p>
It's fragile in smaller ways too.
Did you notice the extra carriage return in the message?
Was that added by the logger?
What if it also added a time stamp or other data?
</p>
<p>
The only part that we really want to test is that a particular
message was sent to the logger.
We can reduce coupling if we pass in a fake logging class
that simply records the message calls for testing, but
takes no action.
It would have to look exactly like our original though.
</p>
<p>
If the fake object doesn't write to a file then we save on deleting
the file before and after each test. We could save even more
test code if the fake object would kindly run the assertion for us.
<p>
</p>
Too good to be true?
We can create such an object easily...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
require_once('../classes/session_pool.php');
<strong>Mock::generate('Log');</strong>
class TestOfSessionLogging extends UnitTestCase {
function testLoggingInIsLogged() {<strong>
$log = &amp;new MockLog();
$log-&gt;expectOnce('message', array('User fred logged in.'));</strong>
$session_pool = &amp;new SessionPool(<strong>$log</strong>);
$session_pool-&gt;logIn('fred');
}
}
?&gt;
</pre>
The <span class="new_code">Mock::generate()</span> call code generated a new class
called <span class="new_code">MockLog</span>.
This looks like an identical clone, except that we can wire test code
to it.
That's what <span class="new_code">expectOnce()</span> does.
It says that if <span class="new_code">message()</span> is ever called on me, it had
better be with the parameter "User fred logged in.".
</p>
<p>
The test will be triggered when the call to
<span class="new_code">message()</span> is invoked on the
<span class="new_code">MockLog</span> object by <span class="new_code">SessionPool::logIn()</span> code.
The mock call will trigger a parameter comparison and then send the
resulting pass or fail event to the test display.
Wildcards can be included here too, so you don't have to test every parameter of
a call when you only want to test one.
</p>
<p>
If the mock reaches the end of the test case without the
method being called, the <span class="new_code">expectOnce()</span>
expectation will trigger a test failure.
In other words the mocks can detect the absence of
behaviour as well as the presence.
</p>
<p>
The mock objects in the SimpleTest suite can have arbitrary
return values set, sequences of returns, return values
selected according to the incoming arguments, sequences of
parameter expectations and limits on the number of times
a method is to be invoked.
</p>
<p>
For more information about mocking and stubbing, see the
<a href="mock_objects_documentation.html">mock objects documentation</a>.
</p>
<h2>
<a class="target" name="web"></a>Web page testing</h2>
<p>
One of the requirements of web sites is that they produce web
pages.
If you are building a project top-down and you want to fully
integrate testing along the way then you will want a way of
automatically navigating a site and examining output for
correctness.
This is the job of a web tester.
</p>
<p>
The web testing in SimpleTest is fairly primitive, as there is
no JavaScript.
Most other browser operations are simulated.
</p>
<p>
To give an idea here is a trivial example where a home
page is fetched, from which we navigate to an "about"
page and then test some client determined content.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
<strong>require_once('simpletest/web_tester.php');</strong>
class TestOfAbout extends <strong>WebTestCase</strong> {
function testOurAboutPageGivesFreeReignToOurEgo() {
<strong>$this-&gt;get('http://test-server/index.php');
$this-&gt;click('About');
$this-&gt;assertTitle('About why we are so great');
$this-&gt;assertText('We are really great');</strong>
}
}
?&gt;
</pre>
With this code as an acceptance test, you can ensure that
the content always meets the specifications of both the
developers, and the other project stakeholders.
</p>
<p>
You can navigate forms too...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('simpletest/web_tester.php');
class TestOfRankings extends WebTestCase {
function testWeAreTopOfGoogle() {
$this-&gt;get('http://google.com/');
$this-&gt;setField('q', 'simpletest');
$this-&gt;click("I'm Feeling Lucky");
$this-&gt;assertTitle('SimpleTest - Unit Testing for PHP');
}
}
?&gt;
</pre>
...although this could violate Google's(tm) terms and conditions.
</p>
<p>
For more information about web testing, see the
<a href="browser_documentation.html">scriptable
browser documentation</a> and the
<a href="web_tester_documentation.html">WebTestCase</a>.
</p>
<p>
<a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&amp;type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a>
</p>
</div>
References and related information...
<ul>
<li>
<a href="https://sourceforge.net/project/showfiles.php?group_id=76550&amp;release_id=153280">Download PHP SimpleTest</a>
from <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
The <a href="http://simpletest.org/api/">developer's API for SimpleTest</a>
gives full detail on the classes and assertions available.
</li>
</ul>
<div class="menu_back"><div class="menu">
<span class="chosen">SimpleTest</span>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,870 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest for PHP mock objects documentation</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<span class="chosen">Mock objects</span>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Mock objects documentation</h1>
This page...
<ul>
<li>
<a href="#what">What are mock objects?</a>
</li>
<li>
<a href="#creation">Creating mock objects</a>.
</li>
<li>
<a href="#expectations">Mocks as critics</a> with expectations.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="what"></a>What are mock objects?</h2>
<p>
Mock objects have two roles during a test case: actor and critic.
</p>
<p>
The actor behaviour is to simulate objects that are difficult to
set up or time consuming to set up for a test.
The classic example is a database connection.
Setting up a test database at the start of each test would slow
testing to a crawl and would require the installation of the
database engine and test data on the test machine.
If we can simulate the connection and return data of our
choosing we not only win on the pragmatics of testing, but can
also feed our code spurious data to see how it responds.
We can simulate databases being down or other extremes
without having to create a broken database for real.
In other words, we get greater control of the test environment.
</p>
<p>
If mock objects only behaved as actors they would simply be
known as "server stubs".
This was originally a pattern named by Robert Binder (<a href="">Testing
object-oriented systems</a>: models, patterns, and tools,
Addison-Wesley) in 1999.
</p>
<p>
A server stub is a simulation of an object or component.
It should exactly replace a component in a system for test
or prototyping purposes, but remain lightweight.
This allows tests to run more quickly, or if the simulated
class has not been written, to run at all.
</p>
<p>
However, the mock objects not only play a part (by supplying chosen
return values on demand) they are also sensitive to the
messages sent to them (via expectations).
By setting expected parameters for a method call they act
as a guard that the calls upon them are made correctly.
If expectations are not met they save us the effort of
writing a failed test assertion by performing that duty on our
behalf.
</p>
<p>
In the case of an imaginary database connection they can
test that the query, say SQL, was correctly formed by
the object that is using the connection.
Set them up with fairly tight expectations and you will
hardly need manual assertions at all.
</p>
<h2>
<a class="target" name="creation"></a>Creating mock objects</h2>
<p>
All we need is an existing class or interface, say a database connection
that looks like this...
<pre>
<strong>class DatabaseConnection {
function DatabaseConnection() { }
function query($sql) { }
function selectQuery($sql) { }
}</strong>
</pre>
To create a mock version of the class we need to run a
code generator...
<pre>
require_once('simpletest/autorun.php');
require_once('database_connection.php');
<strong>Mock::generate('DatabaseConnection');</strong>
</pre>
This code generates a clone class called
<span class="new_code">MockDatabaseConnection</span>.
This new class appears to be the same, but actually has no behaviour at all.
</p>
<p>
The new class is usually a subclass of <span class="new_code">DatabaseConnection</span>.
Unfortunately, there is no way to create a mock version of a
class with a <span class="new_code">final</span> method without having a living version of
that method.
We consider that unsafe.
If the target is an interface, or if <span class="new_code">final</span> methods are
present in a target class, then a whole new class
is created, but one implemeting the same interfaces.
If you try to pass this separate class through a type hint that specifies
the old concrete class name, it will fail.
Code like that insists on type hinting to a class with <span class="new_code">final</span>
methods probably cannot be safely tested with mocks.
</p>
<p>
If you want to see the generated code, then simply <span class="new_code">print</span>
the output of <span class="new_code">Mock::generate()</span>.
Here is the generated code for the <span class="new_code">DatabaseConnection</span>
class rather than the interface version...
<pre>
class MockDatabaseConnection extends DatabaseConnection {
public $mock;
protected $mocked_methods = array('databaseconnection', 'query', 'selectquery');
function MockDatabaseConnection() {
$this-&gt;mock = new SimpleMock();
$this-&gt;mock-&gt;disableExpectationNameChecks();
}
...
function DatabaseConnection() {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("DatabaseConnection", $args);
return $result;
}
function query($sql) {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("query", $args);
return $result;
}
function selectQuery($sql) {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("selectQuery", $args);
return $result;
}
}
</pre>
Your output may vary depending on the exact version
of SimpleTest you are using.
</p>
<p>
Besides the original methods of the class, you will see some extra
methods that help testing.
More on these later.
</p>
<p>
We can now create instances of the new class within
our test case...
<pre>
require_once('simpletest/autorun.php');
require_once('database_connection.php');
Mock::generate('DatabaseConnection');
class MyTestCase extends UnitTestCase {
function testSomething() {
<strong>$connection = new MockDatabaseConnection();</strong>
}
}
</pre>
The mock version now has all the methods of the original.
Also, any type hints will be faithfully preserved.
Say our query methods expect a <span class="new_code">Query</span> object...
<pre>
<strong>class DatabaseConnection {
function DatabaseConnection() { }
function query(Query $query) { }
function selectQuery(Query $query) { }
}</strong>
</pre>
If we now pass the wrong type of object, or worse a non-object...
<pre>
class MyTestCase extends UnitTestCase {
function testSomething() {
$connection = new MockDatabaseConnection();
$connection-&gt;query('insert into accounts () values ()');
}
}
</pre>
...the code will throw a type violation at you just as the
original class would.
</p>
<p>
The mock version now has all the methods of the original.
Unfortunately, they all return <span class="new_code">null</span>.
As methods that always return <span class="new_code">null</span> are not that useful,
we need to be able to set them to something else...
</p>
<p>
<a class="target" name="stub"><h2>Mocks as actors</h2></a>
</p>
<p>
Changing the return value of a method from <span class="new_code">null</span>
to something else is pretty easy...
<pre>
<strong>$connection-&gt;returns('query', 37)</strong>
</pre>
Now every time we call
<span class="new_code">$connection-&gt;query()</span> we get
the result of 37.
There is nothing special about 37.
The return value can be arbitrarily complicated.
</p>
<p>
Parameters are irrelevant here, we always get the same
values back each time once they have been set up this way.
That may not sound like a convincing replica of a
database connection, but for the half a dozen lines of
a test method it is usually all you need.
</p>
<p>
Things aren't always that simple though.
One common problem is iterators, where constantly returning
the same value could cause an endless loop in the object
being tested.
For these we need to set up sequences of values.
Let's say we have a simple iterator that looks like this...
<pre>
class Iterator {
function Iterator() { }
function next() { }
}
</pre>
This is about the simplest iterator you could have.
Assuming that this iterator only returns text until it
reaches the end, when it returns false, we can simulate it
with...
<pre>
Mock::generate('Iterator');
class IteratorTest extends UnitTestCase() {
function testASequence() {<strong>
$iterator = new MockIterator();
$iterator-&gt;returns('next', false);
$iterator-&gt;returnsAt(0, 'next', 'First string');
$iterator-&gt;returnsAt(1, 'next', 'Second string');</strong>
...
}
}
</pre>
When <span class="new_code">next()</span> is called on the
<span class="new_code">MockIterator</span> it will first return "First string",
on the second call "Second string" will be returned
and on any other call <span class="new_code">false</span> will
be returned.
The sequenced return values take precedence over the constant
return value.
The constant one is a kind of default if you like.
</p>
<p>
Another tricky situation is an overloaded
<span class="new_code">get()</span> operation.
An example of this is an information holder with name/value pairs.
Say we have a configuration class like...
<pre>
class Configuration {
function Configuration() { ... }
function get($key) { ... }
}
</pre>
This is a likely situation for using mock objects, as
actual configuration will vary from machine to machine and
even from test to test.
The problem though is that all the data comes through the
<span class="new_code">get()</span> method and yet
we want different results for different keys.
Luckily the mocks have a filter system...
<pre>
<strong>$config = &amp;new MockConfiguration();
$config-&gt;returns('get', 'primary', array('db_host'));
$config-&gt;returns('get', 'admin', array('db_user'));
$config-&gt;returns('get', 'secret', array('db_password'));</strong>
</pre>
The extra parameter is a list of arguments to attempt
to match.
In this case we are trying to match only one argument which
is the look up key.
Now when the mock object has the
<span class="new_code">get()</span> method invoked
like this...
<pre>
$config-&gt;get('db_user')
</pre>
...it will return "admin".
It finds this by attempting to match the calling arguments
to its list of returns one after another until
a complete match is found.
</p>
<p>
You can set a default argument argument like so...
<pre><strong>
$config-&gt;returns('get', false, array('*'));</strong>
</pre>
This is not the same as setting the return value without
any argument requirements like this...
<pre><strong>
$config-&gt;returns('get', false);</strong>
</pre>
In the first case it will accept any single argument,
but exactly one is required.
In the second case any number of arguments will do and
it acts as a catchall after all other matches.
Note that if we add further single parameter options after
the wildcard in the first case, they will be ignored as the wildcard
will match first.
With complex parameter lists the ordering could be important
or else desired matches could be masked by earlier wildcard
ones.
Declare the most specific matches first if you are not sure.
</p>
<p>
There are times when you want a specific reference to be
dished out by the mock rather than a copy or object handle.
This a rarity to say the least, but you might be simulating
a container that can hold primitives such as strings.
For example...
<pre>
class Pad {
function Pad() { }
function &amp;note($index) { }
}
</pre>
In this case you can set a reference into the mock's
return list...
<pre>
function testTaskReads() {
$note = 'Buy books';
$pad = new MockPad();
$vector-&gt;<strong>returnsByReference(</strong>'note', $note, array(3)<strong>)</strong>;
$task = new Task($pad);
...
}
</pre>
With this arrangement you know that every time
<span class="new_code">$pad-&gt;note(3)</span> is
called it will return the same <span class="new_code">$note</span> each time,
even if it get's modified.
</p>
<p>
These three factors, timing, parameters and whether to copy,
can be combined orthogonally.
For example...
<pre>
$buy_books = 'Buy books';
$write_code = 'Write code';
$pad = new MockPad();
$vector-&gt;<strong>returnsByReferenceAt(0, 'note', $buy_books, array('*', 3));</strong>
$vector-&gt;<strong>returnsByReferenceAt(1, 'note', $write_code, array('*', 3));</strong>
</pre>
This will return a reference to <span class="new_code">$buy_books</span> and
then to <span class="new_code">$write_code</span>, but only if two parameters
were set the second of which must be the integer 3.
That should cover most situations.
</p>
<p>
A final tricky case is one object creating another, known
as a factory pattern.
Suppose that on a successful query to our imaginary
database, a result set is returned as an iterator, with
each call to the the iterator's <span class="new_code">next()</span> giving
one row until false.
This sounds like a simulation nightmare, but in fact it can all
be mocked using the mechanics above...
<pre>
Mock::generate('DatabaseConnection');
Mock::generate('ResultIterator');
class DatabaseTest extends UnitTestCase {
function testUserFinderReadsResultsFromDatabase() {<strong>
$result = new MockResultIterator();
$result-&gt;returns('next', false);
$result-&gt;returnsAt(0, 'next', array(1, 'tom'));
$result-&gt;returnsAt(1, 'next', array(3, 'dick'));
$result-&gt;returnsAt(2, 'next', array(6, 'harry'));
$connection = new MockDatabaseConnection();
$connection-&gt;returns('selectQuery', $result);</strong>
$finder = new UserFinder(<strong>$connection</strong>);
$this-&gt;assertIdentical(
$finder-&gt;findNames(),
array('tom', 'dick', 'harry'));
}
}
</pre>
Now only if our
<span class="new_code">$connection</span> is called with the
<span class="new_code">query()</span> method will the
<span class="new_code">$result</span> be returned that is
itself exhausted after the third call to <span class="new_code">next()</span>.
This should be enough
information for our <span class="new_code">UserFinder</span> class,
the class actually
being tested here, to come up with goods.
A very precise test and not a real database in sight.
</p>
<p>
We could refine this test further by insisting that the correct
query is sent...
<pre>
$connection-&gt;returns('selectQuery', $result, array(<strong>'select name, id from people'</strong>));
</pre>
This is actually a bad idea.
</p>
<p>
We have a <span class="new_code">UserFinder</span> in object land, talking to
database tables using a large interface - the whole of SQL.
Imagine that we have written a lot of tests that now depend
on the exact SQL string passed.
These queries could change en masse for all sorts of reasons
not related to the specific test.
For example the quoting rules could change, a table name could
change, a link table added or whatever.
This would require the rewriting of every single test any time
one of these refactoring is made, yet the intended behaviour has
stayed the same.
Tests are supposed to help refactoring, not hinder it.
I'd certainly like to have a test suite that passes while I change
table names.
</p>
<p>
As a rule it is best not to mock a fat interface.
</p>
<p>
By contrast, here is the round trip test...
<pre>
class DatabaseTest extends UnitTestCase {<strong>
function setUp() { ... }
function tearDown() { ... }</strong>
function testUserFinderReadsResultsFromDatabase() {
$finder = new UserFinder(<strong>new DatabaseConnection()</strong>);
$finder-&gt;add('tom');
$finder-&gt;add('dick');
$finder-&gt;add('harry');
$this-&gt;assertIdentical(
$finder-&gt;findNames(),
array('tom', 'dick', 'harry'));
}
}
</pre>
This test is immune to schema changes.
It will only fail if you actually break the functionality, which
is what you want a test to do.
</p>
<p>
The catch is those <span class="new_code">setUp()</span> and <span class="new_code">tearDown()</span>
methods that we've rather glossed over.
They have to clear out the database tables and ensure that the
schema is defined correctly.
That can be a chunk of extra work, but you usually have this code
lying around anyway for deployment purposes.
</p>
<p>
One place where you definitely need a mock is simulating failures.
Say the database goes down while <span class="new_code">UserFinder</span> is doing
it's work.
Does <span class="new_code">UserFinder</span> behave well...?
<pre>
class DatabaseTest extends UnitTestCase {
function testUserFinder() {
$connection = new MockDatabaseConnection();<strong>
$connection-&gt;throwOn('selectQuery', new TimedOut('Ouch!'));</strong>
$alert = new MockAlerts();<strong>
$alert-&gt;expectOnce('notify', 'Database is busy - please retry');</strong>
$finder = new UserFinder($connection, $alert);
$this-&gt;assertIdentical($finder-&gt;findNames(), array());
}
}
</pre>
We've passed the <span class="new_code">UserFinder</span> an <span class="new_code">$alert</span>
object.
This is going to do some kind of pretty notifications in the
user interface in the event of an error.
We'd rather not sprinkle our code with hard wired <span class="new_code">print</span>
statements if we can avoid it.
Wrapping the means of output means we can use this code anywhere.
It also makes testing easier.
</p>
<p>
To pass this test, the finder has to write a nice user friendly
message to <span class="new_code">$alert</span>, rather than propogating the exception.
So far, so good.
</p>
<p>
How do we get the mock <span class="new_code">DatabaseConnection</span> to throw an exception?
We generate the exception using the <span class="new_code">throwOn</span> method
on the mock.
</p>
<p>
Finally, what if the method you want to simulate does not exist yet?
If you set a return value on a method that is not there, SimpleTest
will throw an error.
What if you are using <span class="new_code">__call()</span> to simulate dynamic methods?
</p>
<p>
Objects with dynamic interfaces, using <span class="new_code">__call</span>, can
be problematic with the current mock objects implementation.
You can mock the <span class="new_code">__call()</span> method, but this is ugly.
Why should a test know anything about such low level implementation details?
It just wants to simulate the call.
</p>
<p>
The way round this is to add extra methods to the mock when
generating it.
<pre>
<strong>Mock::generate('DatabaseConnection', 'MockDatabaseConnection', array('setOptions'));</strong>
</pre>
In a large test suite this could cause trouble, as you probably
already have a mock version of the class called
<span class="new_code">MockDatabaseConnection</span> without the extra methods.
The code generator will not generate a mock version of the class if
one of the same name already exists.
You will confusingly fail to see your method if another definition
was run first.
</p>
<p>
To cope with this, SimpleTest allows you to choose any name for the
new class at the same time as you add the extra methods.
<pre>
Mock::generate('DatabaseConnection', <strong>'MockDatabaseConnectionWithOptions'</strong>, array('setOptions'));
</pre>
Here the mock will behave as if the <span class="new_code">setOptions()</span>
existed in the original class.
</p>
<p>
Mock objects can only be used within test cases, as upon expectations
they send messages straight to the currently running test case.
Creating them outside a test case will cause a run time error
when an expectation is triggered and there is no running test case
for the message to end up.
We cover expectations next.
</p>
<h2>
<a class="target" name="expectations"></a>Mocks as critics</h2>
<p>
Although the server stubs approach insulates your tests from
real world disruption, it is only half the benefit.
You can have the class under test receiving the required
messages, but is your new class sending correct ones?
Testing this can get messy without a mock objects library.
</p>
<p>
By way of example, let's take a simple <span class="new_code">PageController</span>
class to handle a credit card payment form...
<pre>
class PaymentForm extends PageController {
function __construct($alert, $payment_gateway) { ... }
function makePayment($request) { ... }
}
</pre>
This class takes a <span class="new_code">PaymentGateway</span> to actually talk
to the bank.
It also takes an <span class="new_code">Alert</span> object to handle errors.
This class talks to the page or template.
It's responsible for painting the error message and highlighting any
form fields that are incorrect.
</p>
<p>
It might look something like...
<pre>
class Alert {
function warn($warning, $id) {
print '&lt;div class="warning"&gt;' . $warning . '&lt;/div&gt;';
print '&lt;style type="text/css"&gt;#' . $id . ' { background-color: red }&lt;/style&gt;';
}
}
</pre>
</p>
<p>
Our interest is in the <span class="new_code">makePayment()</span> method.
If we fail to enter a "CVV2" number (the three digit number
on the back of the credit card), we want to show an error rather than
try to process the payment.
In test form...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('payment_form.php');
Mock::generate('Alert');
Mock::generate('PaymentGateway');
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
<strong>$alert-&gt;expectOnce(
'warn',
array('Missing three digit security code', 'cvv2'));</strong>
$controller = new PaymentForm(<strong>$alert</strong>, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
function requestWithMissingCvv2() { ... }
}
?&gt;
</pre>
The first question you may be asking is, where are the assertions?
</p>
<p>
The call to <span class="new_code">expectOnce('warn', array(...))</span> instructs the mock
to expect a call to <span class="new_code">warn()</span> before the test ends.
When it gets a call to <span class="new_code">warn()</span>, it checks the arguments.
If the arguments don't match, then a failure is generated.
It also fails if the method is never called at all.
</p>
<p>
The test above not only asserts that <span class="new_code">warn</span> was called,
but that it received the string "Missing three digit security code"
and also the tag "cvv2".
The equivalent of <span class="new_code">assertIdentical()</span> is applied to both
fields when the parameters are compared.
</p>
<p>
If you are not interested in the actual message, and we are not
for user interface code that changes often, we can skip that
parameter with the "*" operator...
<pre>
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
$alert-&gt;expectOnce('warn', array(<strong>'*'</strong>, 'cvv2'));
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
function requestWithMissingCvv2() { ... }
}
</pre>
We can weaken the test further by missing
out the parameters array...
<pre>
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
<strong>$alert-&gt;expectOnce('warn');</strong>
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
</pre>
This will only test that the method is called,
which is a bit drastic in this case.
Later on, we'll see how we can weaken the expectations more precisely.
</p>
<p>
Tests without assertions can be both compact and very expressive.
Because we intercept the call on the way into an object, here of
the <span class="new_code">Alert</span> class, we avoid having to assert its state
afterwards.
This not only avoids the assertions in the tests, but also having
to add extra test only accessors to the original code.
If you catch yourself adding such accessors, called "state based testing",
it's probably time to consider using mocks in the tests.
This is called "behaviour based testing", and is normally superior.
</p>
<p>
Let's add another test.
Let's make sure that we don't even attempt a payment without a CVV2...
<pre>
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() { ... }
function testNoPaymentAttemptedWithMissingCvv2() {
$payment_gateway = new MockPaymentGateway();
<strong>$payment_gateway-&gt;expectNever('pay');</strong>
$controller = new PaymentForm(new MockAlert(), $payment_gateway);
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
...
}
</pre>
Asserting a negative can be very hard in tests, but
<span class="new_code">expectNever()</span> makes it easy.
</p>
<p>
<span class="new_code">expectOnce()</span> and <span class="new_code">expectNever()</span> are
sufficient for most tests, but
occasionally you want to test multiple events.
Normally for usability purposes we want all missing fields
in the form to light up, not just the first one.
This means that we should get multiple calls to
<span class="new_code">Alert::warn()</span>, not just one...
<pre>
function testAllRequiredFieldsHighlightedOnEmptyRequest() {
$alert = new MockAlert();<strong>
$alert-&gt;expectAt(0, 'warn', array('*', 'cc_number'));
$alert-&gt;expectAt(1, 'warn', array('*', 'expiry'));
$alert-&gt;expectAt(2, 'warn', array('*', 'cvv2'));
$alert-&gt;expectAt(3, 'warn', array('*', 'card_holder'));
$alert-&gt;expectAt(4, 'warn', array('*', 'address'));
$alert-&gt;expectAt(5, 'warn', array('*', 'postcode'));
$alert-&gt;expectAt(6, 'warn', array('*', 'country'));
$alert-&gt;expectCallCount('warn', 7);</strong>
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
</pre>
The counter in <span class="new_code">expectAt()</span> is the number of times
the method has been called already.
Here we are asserting that every field will be highlighted.
</p>
<p>
Note that we are forced to assert the order too.
SimpleTest does not yet have a way to avoid this, but
this will be fixed in future versions.
</p>
<p>
Here is the full list of expectations you can set on a mock object
in <a href="http://simpletest.org/">SimpleTest</a>.
As with the assertions, these methods take an optional failure message.
<table>
<thead><tr>
<th>Expectation</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td><span class="new_code">expect($method, $args)</span></td>
<td>Arguments must match if called</td>
</tr>
<tr>
<td><span class="new_code">expectAt($timing, $method, $args)</span></td>
<td>Arguments must match when called on the <span class="new_code">$timing</span>'th time</td>
</tr>
<tr>
<td><span class="new_code">expectCallCount($method, $count)</span></td>
<td>The method must be called exactly this many times</td>
</tr>
<tr>
<td><span class="new_code">expectMaximumCallCount($method, $count)</span></td>
<td>Call this method no more than <span class="new_code">$count</span> times</td>
</tr>
<tr>
<td><span class="new_code">expectMinimumCallCount($method, $count)</span></td>
<td>Must be called at least <span class="new_code">$count</span> times</td>
</tr>
<tr>
<td><span class="new_code">expectNever($method)</span></td>
<td>Must never be called</td>
</tr>
<tr>
<td><span class="new_code">expectOnce($method, $args)</span></td>
<td>Must be called once and with the expected arguments if supplied</td>
</tr>
<tr>
<td><span class="new_code">expectAtLeastOnce($method, $args)</span></td>
<td>Must be called at least once, and always with any expected arguments</td>
</tr>
</tbody>
</table>
Where the parameters are...
<dl>
<dt class="new_code">$method</dt>
<dd>The method name, as a string, to apply the condition to.</dd>
<dt class="new_code">$args</dt>
<dd>
The arguments as a list. Wildcards can be included in the same
manner as for <span class="new_code">setReturn()</span>.
This argument is optional for <span class="new_code">expectOnce()</span>
and <span class="new_code">expectAtLeastOnce()</span>.
</dd>
<dt class="new_code">$timing</dt>
<dd>
The only point in time to test the condition.
The first call starts at zero and the count is for
each method independently.
</dd>
<dt class="new_code">$count</dt>
<dd>The number of calls expected.</dd>
</dl>
</p>
<p>
If you have just one call in your test, make sure you're using
<span class="new_code">expectOnce</span>.<br>
Using <span class="new_code">$mocked-&gt;expectAt(0, 'method', 'args);</span>
on its own will allow the method to never be called.
Checking the arguments and the overall call count
are currently independant.
Add an <span class="new_code">expectCallCount()</span> expectation when you
are using <span class="new_code">expectAt()</span> unless zero calls is allowed.
</p>
<p>
Like the assertions within test cases, all of the expectations
can take a message override as an extra parameter.
Also the original failure message can be embedded in the output
as "%s".
</p>
</div>
References and related information...
<ul>
<li>
The original
<a href="http://www.mockobjects.com/">Mock objects</a> paper.
</li>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest home page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<span class="chosen">Mock objects</span>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,487 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Overview and feature list for the SimpleTest PHP unit tester and web tester
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<span class="chosen">Overview</span>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Overview of SimpleTest</h1>
This page...
<ul>
<li>
<a href="#summary">Quick summary</a>
of the SimpleTest tool for PHP.
</li>
<li>
<a href="#features">List of features</a>,
both current ones and those planned.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="summary"></a>What is SimpleTest?</h2>
<p>
The heart of SimpleTest is a testing framework built around
test case classes.
These are written as extensions of base test case classes,
each extended with methods that actually contain test code.
Each test method of a test case class is written to invoke
various assertions that the developer expects to be true such as
<span class="new_code">assertEqual()</span>.
If the expectation is correct, then a successful result is
dispatched to the observing test reporter, but any failure
or unexpected exception triggers an alert and a description
of the mismatch.
These test case declarations are transformed into executable
test scripts by including a SimpleTest aurorun.php file.
</p>
<p>
These documents apply to SimpleTest version 1.1, although we
try hard to maintain compatibility between versions.
If you get a test failure after an upgrade, check out the
file "HELP_MY_TESTS_DONT_WORK_ANYMORE" in the
simpletest directory to see if a feature you are using
has since been deprecated and later removed.
</p>
<p>
A <a href="unit_test_documentation.html">test case</a> looks like this...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class <strong>CanAddUp</strong> extends UnitTestCase {<strong>
function testOneAndOneMakesTwo() {
$this-&gt;assertEqual(1 + 1, 2);
}</strong>
}
?&gt;
</pre>
Tests are grouped into test cases, which are just
PHP classes that extend <span class="new_code">UnitTestCase</span>
or <span class="new_code">WebTestCase</span>.
The tests themselves are just normal methods that start
their name with the letters "test".
You can have as many test cases as you want in a test
script and each test case can have as many test methods
as it wants too.
</p>
<p>
This test script is immediately runnable.
You just invoke it on the command line like so...
<pre class="shell">
php adding_test.php
</pre>
</p>
<p>
When run on the command line you should see something like...
<pre class="shell">
adding_test.php
OK
Test cases run: 1/1, Passes: 1, Failures: 0, Exceptions: 0
</pre>
</p>
<p>
If you place it on a web server and point your
web browser at it...
<div class="demo">
<h1>adding_test.php</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>6</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
</p>
<p>
Of course this is a silly example.
A more realistic example might be...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('log.php');
class <strong>TestOfLogging</strong> extends UnitTestCase {
function testWillCreateLogFileOnFirstMessage() {
$log = new Log('my.log');
$this-&gt;assertFalse(file_exists('my.log'));
$log-&gt;message('Hello');
$this-&gt;assertTrue(file_exists('my.log'));
}&lt;/strong&gt;
}
?&gt;
</pre>
</p>
<p>
This tool is designed for the developer.
The target audience of this tool is anyone developing a small
to medium PHP application, including developers new to
unit and web regression testing.
The core principles are ease of use first, with extendibility and
essential features.
</p>
<p>
Tests are written in the PHP language itself more or less
as the application itself is built.
The advantage of using PHP as the testing language is that
there are no new languages to learn, testing can start straight away,
and the developer can test any part of the code.
Basically, all parts that can be accessed by the application code can also be
accessed by the test code when they are in the same programming language.
</p>
<p>
The simplest type of test case is the
<a href="unit_tester_documentation.html">UnitTestCase</a>.
This class of test case includes standard tests for equality,
references and pattern matching.
All these test the typical expectations of what you would
expect the result of a function or method to be.
This is by far the most common type of test in the daily
routine of development, making up about 95% of test cases.
</p>
<p>
The top level task of a web application though is not to
produce correct output from its methods and objects, but
to generate web pages.
The <a href="web_tester_documentation.html">WebTestCase</a> class tests web
pages.
It simulates a web browser requesting a page, complete with
cookies, proxies, secure connections, authentication, forms, frames and most
navigation elements.
With this type of test case, the developer can assert that
information is present in the page and that forms and
sessions are handled correctly.
</p>
<p>
A <a href="web_tester_documentation.html">WebTestCase</a> looks like this...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('simpletest/web_tester.php');
class <strong>MySiteTest</strong> extends WebTestCase {
<strong>
function testHomePageHasContactDetailsLink() {
$this-&gt;get('http://www.my-site.com/index.php');
$this-&gt;assertTitle('My Home Page');
$this-&gt;clickLink('Contact');
$this-&gt;assertTitle('Contact me');
$this-&gt;assertText('/Email me at/');
}</strong>
}
?&gt;
</pre>
</p>
<h2>
<a class="target" name="features"></a>Feature list</h2>
<p>
The following is a very rough outline of past and future features
and their expected point of release.
I am afraid it is liable to change without warning, as meeting the
milestones rather depends on time available.
</p>
<p>
Green stuff has been coded, but not necessarily released yet.
If you have a pressing need for a green but unreleased feature
then you should check-out the code from Sourceforge SVN directly.
<table>
<thead>
<tr>
<th>Feature</th>
<th>Description</th>
<th>Release</th>
</tr>
</thead>
<tbody>
<tr>
<td>Unit test case</td>
<td>Core test case class and assertions</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Html display</td>
<td>Simplest possible display</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Autoloading of test cases</td>
<td>
Reading a file with test cases and loading them into a
group test automatically
</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Mock objects</td>
<td>
Objects capable of simulating other objects removing
test dependencies
</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Web test case</td>
<td>Allows link following and title tag matching</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Partial mocks</td>
<td>
Mocking parts of a class for testing less than a class
or for complex simulations
</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Web cookie handling</td>
<td>Correct handling of cookies when fetching pages</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Following redirects</td>
<td>Page fetching automatically follows 300 redirects</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Form parsing</td>
<td>Ability to submit simple forms and read default form values</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Command line interface</td>
<td>Test display without the need of a web browser</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Exposure of expectation classes</td>
<td>Can create precise tests with mocks as well as test cases</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>XML output and parsing</td>
<td>
Allows multi host testing and the integration of acceptance
testing extensions
</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Browser component</td>
<td>
Exposure of lower level web browser interface for more
detailed test cases
</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>HTTP authentication</td>
<td>
Fetching protected web pages with basic authentication
only
</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>SSL support</td>
<td>Can connect to https: pages</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Proxy support</td>
<td>Can connect via. common proxies</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>Frames support</td>
<td>Handling of frames in web test cases</td>
<td style="color: green;">1.0</td>
</tr>
<tr>
<td>File upload testing</td>
<td>Can simulate the input type file tag</td>
<td style="color: green;">1.0.1</td>
</tr>
<tr>
<td>Mocking interfaces</td>
<td>
Can generate mock objects to interfaces as well as classes
and class interfaces are carried for type hints
</td>
<td style="color: green;">1.0.1</td>
</tr>
<tr>
<td>Testing exceptions</td>
<td>Similar to testing PHP errors</td>
<td style="color: green;">1.0.1</td>
</tr>
<tr>
<td>HTML label support</td>
<td>Can access all controls using the visual label</td>
<td style="color: green;">1.0.1</td>
</tr>
<tr>
<td>Base tag support</td>
<td>Respects page base tag when clicking</td>
<td style="color: green;">1.0.1</td>
</tr>
<tr>
<td>PHP 5 E_STRICT compliant</td>
<td>PHP 5 only version that works with the E_STRICT error level</td>
<td style="color: green;">1.1</td>
</tr>
<tr>
<td>Alternate HTML parsers</td>
<td>Can detect compiled parsers for performance improvements</td>
<td style="color: green;">1.1</td>
</tr>
<tr>
<td>REST support</td>
<td>Support for REST verbs as put(), delete(), etc.</td>
<td style="color: green;">1.1</td>
</tr>
<tr>
<td>BDD style fixtures</td>
<td>Can import fixtures using a mixin like given() method</td>
<td style="color: red;">1.5</td>
</tr>
<tr>
<td>Plug-in architecture</td>
<td>Automatic import of extensions including command line options</td>
<td style="color: red;">1.5</td>
</tr>
<tr>
<td>Reporting machinery enhancements</td>
<td>Improved message passing for better cooperation with IDEs</td>
<td style="color: red;">1.5</td>
</tr>
<tr>
<td>Fluent mock interface</td>
<td>More flexible and concise mock objects</td>
<td style="color: red;">1.6</td>
</tr>
<tr>
<td>Localisation</td>
<td>Messages abstracted and code generated as well as UTF support</td>
<td style="color: red;">1.6</td>
</tr>
<tr>
<td>CSS selectors</td>
<td>HTML content can be examined using CSS selectors</td>
<td style="color: red;">1.7</td>
</tr>
<tr>
<td>HTML table assertions</td>
<td>Can match HTML or other table elements to expectations</td>
<td style="color: red;">1.7</td>
</tr>
<tr>
<td>Unified acceptance testing model</td>
<td>Content searchable through selectors combined with expectations</td>
<td style="color: red;">1.7</td>
</tr>
<tr>
<td>DatabaseTestCase</td>
<td>SQL selectors and DB drivers</td>
<td style="color: red;">1.7</td>
</tr>
<tr>
<td>IFrame support</td>
<td>Reads IFrame content that can be refreshed</td>
<td style="color: red;">1.8</td>
</tr>
<tr>
<td>Integrated Selenium support</td>
<td>Easy to use built in Selenium driver and tutorial or similar browser automation</td>
<td style="color: red;">1.9</td>
</tr>
<tr>
<td>Code coverage</td>
<td>Reports using the bundled tool when using XDebug</td>
<td style="color: red;">1.9</td>
</tr>
<tr>
<td>Deprecation of old methods</td>
<td>Simpler interface for SimpleTest2</td>
<td style="color: red;">2.0</td>
</tr>
<tr>
<td>Javascript suport</td>
<td>Use of PECL module to add Javascript to the native browser</td>
<td style="color: red;">3.0</td>
</tr>
</tbody>
</table>
PHP 5 migration is complete, which means that only PHP 5.0.3+
will be supported in SimpleTest version 1.1+.
Earlier versions of SimpleTest are compatible with PHP 4.2 up to
PHP 5 (non E_STRICT).
</p>
</div>
References and related information...
<ul>
<li>
<a href="unit_test_documentation.html">Documentation for SimpleTest</a>.
</li>
<li>
<a href="http://www.lastcraft.com/first_test_tutorial.php">How to write PHP test cases</a>
is a fairly advanced tutorial.
</li>
<li>
<a href="http://simpletest.org/api/">SimpleTest API</a> from phpdoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<span class="chosen">Overview</span>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,457 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest for PHP partial mocks documentation</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<span class="chosen">Partial mocks</span>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Partial mock objects documentation</h1>
This page...
<ul>
<li>
<a href="#inject">The mock injection problem</a>.
</li>
<li>
Moving creation to a <a href="#creation">protected factory</a> method.
</li>
<li>
<a href="#partial">Partial mocks</a> generate subclasses.
</li>
<li>
Partial mocks <a href="#less">test less than a class</a>.
</li>
</ul>
<div class="content">
<p>
A partial mock is simply a pattern to alleviate a specific problem
in testing with mock objects,
that of getting mock objects into tight corners.
It's quite a limited tool and possibly not even a good idea.
It is included with SimpleTest because I have found it useful
on more than one occasion and has saved a lot of work at that point.
</p>
<h2>
<a class="target" name="inject"></a>The mock injection problem</h2>
<p>
When one object uses another it is very simple to just pass a mock
version in already set up with its expectations.
Things are rather tricker if one object creates another and the
creator is the one you want to test.
This means that the created object should be mocked, but we can
hardly tell our class under test to create a mock instead.
The tested class doesn't even know it is running inside a test
after all.
</p>
<p>
For example, suppose we are building a telnet client and it
needs to create a network socket to pass its messages.
The connection method might look something like...
<pre>
<strong>&lt;?php
require_once('socket.php');
class Telnet {
...
function connect($ip, $port, $username, $password) {
$socket = new Socket($ip, $port);
$socket-&gt;read( ... );
...
}
}
?&gt;</strong>
</pre>
We would really like to have a mock object version of the socket
here, what can we do?
</p>
<p>
The first solution is to pass the socket in as a parameter,
forcing the creation up a level.
Having the client handle this is actually a very good approach
if you can manage it and should lead to factoring the creation from
the doing.
In fact, this is one way in which testing with mock objects actually
forces you to code more tightly focused solutions.
They improve your programming.
</p>
<p>
Here this would be...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...
<strong>function connect($socket, $username, $password) {
$socket-&gt;read( ... );
...
}</strong>
}
?&gt;
</pre>
This means that the test code is typical for a test involving
mock objects.
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new Telnet();
$telnet-&gt;connect($socket, 'Me', 'Secret');
...</strong>
}
}
</pre>
It is pretty obvious though that one level is all you can go.
You would hardly want your top level application creating
every low level file, socket and database connection ever
needed.
It wouldn't know the constructor parameters anyway.
</p>
<p>
The next simplest compromise is to have the created object passed
in as an optional parameter...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...<strong>
function connect($ip, $port, $username, $password, $socket = false) {
if (! $socket) {
$socket = new Socket($ip, $port);
}
$socket-&gt;read( ... );</strong>
...
return $socket;
}
}
?&gt;
</pre>
For a quick solution this is usually good enough.
The test now looks almost the same as if the parameter
was formally passed...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret', $socket);
...</strong>
}
}
</pre>
The problem with this approach is its untidiness.
There is test code in the main class and parameters passed
in the test case that are never used.
This is a quick and dirty approach, but nevertheless effective
in most situations.
</p>
<p>
The next method is to pass in a factory object to do the creation...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {<strong>
function Telnet($network) {
$this-&gt;_network = $network;
}</strong>
...
function connect($ip, $port, $username, $password) {<strong>
$socket = $this-&gt;_network-&gt;createSocket($ip, $port);
$socket-&gt;read( ... );</strong>
...
return $socket;
}
}
?&gt;
</pre>
This is probably the most highly factored answer as creation
is now moved into a small specialist class.
The networking factory can now be tested separately, but mocked
easily when we are testing the telnet class...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$network = new MockNetwork();
$network-&gt;returnsByReference('createSocket', $socket);
$telnet = new Telnet($network);
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
The downside is that we are adding a lot more classes to the
library.
Also we are passing a lot of factories around which will
make the code a little less intuitive.
The most flexible solution, but the most complex.
</p>
<p>
Well techniques like "Dependency Injection" tackle the problem of
instantiating a lot of constructor parameters.
Unfortunately knowledge of this pattern is not widespread, and if you
are trying to get older code to work, rearchitecting the whole
application is not really an option.
</p>
<p>
Is there a middle ground?
</p>
<h2>
<a class="target" name="creation"></a>Protected factory method</h2>
<p>
There is a way we can circumvent the problem without creating
any new application classes, but it involves creating a subclass
when we do the actual testing.
Firstly we move the socket creation into its own method...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...
function connect($ip, $port, $username, $password) {
<strong>$socket = $this-&gt;createSocket($ip, $port);</strong>
$socket-&gt;read( ... );
...
}<strong>
protected function createSocket($ip, $port) {
return new Socket($ip, $port);
}</strong>
}
?&gt;
</pre>
This is a pretty safe step even for very tangled legacy code.
This is the only change we make to the application.
</p>
<p>
For the test case we have to create a subclass so that
we can intercept the socket creation...
<pre>
<strong>class TelnetTestVersion extends Telnet {
var $mock;
function TelnetTestVersion($mock) {
$this-&gt;mock = $mock;
$this-&gt;Telnet();
}
protected function createSocket() {
return $this-&gt;mock;
}
}</strong>
</pre>
Here I have passed the mock in the constructor, but a
setter would have done just as well.
Note that the mock was set into the object variable
before the constructor was chained.
This is necessary in case the constructor calls
<span class="new_code">connect()</span>.
Otherwise it could get a null value from
<span class="new_code">createSocket()</span>.
</p>
<p>
After the completion of all of this extra work the
actual test case is fairly easy.
We just test our new class instead...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion($socket);
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
The new class is very simple of course.
It just sets up a return value, rather like a mock.
It would be nice if it also checked the incoming parameters
as well.
Just like a mock.
It seems we are likely to do this often, can
we automate the subclass creation?
</p>
<h2>
<a class="target" name="partial"></a>A partial mock</h2>
<p>
Of course the answer is "yes" or I would have stopped writing
this by now!
The previous test case was a lot of work, but we can
generate the subclass using a similar approach to the mock objects.
</p>
<p>
Here is the partial mock version of the test...
<pre>
<strong>Mock::generatePartial(
'Telnet',
'TelnetTestVersion',
array('createSocket'));</strong>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion();
$telnet-&gt;setReturnReference('createSocket', $socket);
$telnet-&gt;Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
The partial mock is a subclass of the original with
selected methods "knocked out" with test
versions.
The <span class="new_code">generatePartial()</span> call
takes three parameters: the class to be subclassed,
the new test class name and a list of methods to mock.
</p>
<p>
Instantiating the resulting objects is slightly tricky.
The only constructor parameter of a partial mock is
the unit tester reference.
As with the normal mock objects this is needed for sending
test results in response to checked expectations.
</p>
<p>
The original constructor is not run yet.
This is necessary in case the constructor is going to
make use of the as yet unset mocked methods.
We set any return values at this point and then run the
constructor with its normal parameters.
This three step construction of "new", followed
by setting up the methods, followed by running the constructor
proper is what distinguishes the partial mock code.
</p>
<p>
Apart from construction, all of the mocked methods have
the same features as mock objects and all of the unmocked
methods behave as before.
We can set expectations very easily...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion();
$telnet-&gt;setReturnReference('createSocket', $socket);
<strong>$telnet-&gt;expectOnce('createSocket', array('127.0.0.1', 21));</strong>
$telnet-&gt;Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');
}
}
</pre>
Partial mocks are not used often.
I consider them transitory.
Useful while refactoring, but once the application has
all of it's dependencies nicely separated then the
partial mocks can wither away.
</p>
<h2>
<a class="target" name="less"></a>Testing less than a class</h2>
<p>
The mocked out methods don't have to be factory methods,
they could be any sort of method.
In this way partial mocks allow us to take control of any part of
a class except the constructor.
We could even go as far as to mock every method
except one we actually want to test.
</p>
<p>
This last situation is all rather hypothetical, as I've hardly
tried it.
I am a little worried that
forcing object granularity may be better for the code quality.
I personally use partial mocks as a way of overriding creation
or for occasional testing of the TemplateMethod pattern.
</p>
<p>
It's all going to come down to the coding standards of your
project to decide if you allow test mechanisms like this.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
<a href="http://simpletest.org/api/">Full API for SimpleTest</a>
from the PHPDoc.
</li>
<li>
The protected factory is described in
<a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">this paper from IBM</a>.
This is the only formal comment I have seen on this problem.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<span class="chosen">Partial mocks</span>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,616 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest for PHP test runner and display documentation</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<span class="chosen">Reporting</span>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Test reporter documentation</h1>
This page...
<ul>
<li>
Displaying <a href="#html">results in HTML</a>
</li>
<li>
Displaying and <a href="#other">reporting results</a>
in other formats
</li>
<li>
Using <a href="#cli">SimpleTest from the command line</a>
</li>
<li>
<a href="#xml">Using XML</a> for remote testing
</li>
</ul>
<div class="content">
<p>
SimpleTest pretty much follows the MVC-ish pattern
(Model-View-Controller).
The reporter classes are the view and the model is your
test cases and their hiearchy.
The controller is mostly hidden from the user of
SimpleTest unless you want to change how the test cases
are actually run, in which case it is possible to
override the runner objects from within the test case.
As usual with MVC, the controller is mostly undefined
and there are other places to control the test run.
</p>
<h2>
<a class="target" name="html"></a>Reporting results in HTML</h2>
<p>
The default HTML display is minimal in the extreme.
It reports success and failure with the conventional red and
green bars and shows a breadcrumb trail of test groups
for every failed assertion.
Here's a fail...
<div class="demo">
<h1>File test</h1>
<span class="fail">Fail</span>: createnewfile-&gt;True assertion failed.<br>
<div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete.
<strong>0</strong> passes, <strong>1</strong> fails and <strong>0</strong> exceptions.</div>
</div>
And here all tests passed...
<div class="demo">
<h1>File test</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>1</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
The good news is that there are several points in the display
hiearchy for subclassing.
</p>
<p>
For web page based displays there is the
<span class="new_code">HtmlReporter</span> class with the following
signature...
<pre>
class HtmlReporter extends SimpleReporter {
public __construct($encoding) { ... }
public makeDry(boolean $is_dry) { ... }
public void paintHeader(string $test_name) { ... }
public void sendNoCacheHeaders() { ... }
public void paintFooter(string $test_name) { ... }
public void paintGroupStart(string $test_name, integer $size) { ... }
public void paintGroupEnd(string $test_name) { ... }
public void paintCaseStart(string $test_name) { ... }
public void paintCaseEnd(string $test_name) { ... }
public void paintMethodStart(string $test_name) { ... }
public void paintMethodEnd(string $test_name) { ... }
public void paintFail(string $message) { ... }
public void paintPass(string $message) { ... }
public void paintError(string $message) { ... }
public void paintException(string $message) { ... }
public void paintMessage(string $message) { ... }
public void paintFormattedMessage(string $message) { ... }
protected string getCss() { ... }
public array getTestList() { ... }
public integer getPassCount() { ... }
public integer getFailCount() { ... }
public integer getExceptionCount() { ... }
public integer getTestCaseCount() { ... }
public integer getTestCaseProgress() { ... }
}
</pre>
Here is what some of these methods mean. First the display methods
that you will probably want to override...
<ul class="api">
<li>
<span class="new_code">HtmlReporter(string $encoding)</span><br>
is the constructor.
Note that the unit test sets up the link to the display
rather than the other way around.
The display is a mostly passive receiver of test events.
This allows easy adaption of the display for other test
systems beside unit tests, such as monitoring servers.
The encoding is the character encoding you wish to
display the test output in.
In order to correctly render debug output when
using the web tester, this should match the encoding
of the site you are trying to test.
The available character set strings are described in
the PHP <a href="http://www.php.net/manual/en/function.htmlentities.php">html_entities()</a>
function.
</li>
<li>
<span class="new_code">void paintHeader(string $test_name)</span><br>
is called once at the very start of the test when the first
start event arrives.
The first start event is usually delivered by the top level group
test and so this is where <span class="new_code">$test_name</span>
comes from.
It paints the page title, CSS, body tag, etc.
It returns nothing (<span class="new_code">void</span>).
</li>
<li>
<span class="new_code">void paintFooter(string $test_name)</span><br>
Called at the very end of the test to close any tags opened
by the page header.
By default it also displays the red/green bar and the final
count of results.
Actually the end of the test happens when a test end event
comes in with the same name as the one that started it all
at the same level.
The tests nest you see.
Closing the last test finishes the display.
</li>
<li>
<span class="new_code">void paintMethodStart(string $test_name)</span><br>
is called at the start of each test method.
The name normally comes from method name.
The other test start events behave the same way except
that the group test one tells the reporter how large
it is in number of held test cases.
This is so that the reporter can display a progress bar
as the runner churns through the test cases.
</li>
<li>
<span class="new_code">void paintMethodEnd(string $test_name)</span><br>
backs out of the test started with the same name.
</li>
<li>
<span class="new_code">void paintFail(string $message)</span><br>
paints a failure.
By default it just displays the word fail, a breadcrumbs trail
showing the current test nesting and the message issued by
the assertion.
</li>
<li>
<span class="new_code">void paintPass(string $message)</span><br>
by default does nothing.
</li>
<li>
<span class="new_code">string getCss()</span><br>
Returns the CSS styles as a string for the page header
method.
Additional styles have to be appended here if you are
not overriding the page header.
You will want to use this method in an overriden page header
if you want to include the original CSS.
</li>
</ul>
There are also some accessors to get information on the current
state of the test suite.
Use these to enrich the display...
<ul class="api">
<li>
<span class="new_code">array getTestList()</span><br>
is the first convenience method for subclasses.
Lists the current nesting of the tests as a list
of test names.
The first, top level test case, is first in the
list and the current test method will be last.
</li>
<li>
<span class="new_code">integer getPassCount()</span><br>
returns the number of passes chalked up so far.
Needed for the display at the end.
</li>
<li>
<span class="new_code">integer getFailCount()</span><br>
is likewise the number of fails so far.
</li>
<li>
<span class="new_code">integer getExceptionCount()</span><br>
is likewise the number of errors so far.
</li>
<li>
<span class="new_code">integer getTestCaseCount()</span><br>
is the total number of test cases in the test run.
This includes the grouping tests themselves.
</li>
<li>
<span class="new_code">integer getTestCaseProgress()</span><br>
is the number of test cases completed so far.
</li>
</ul>
One simple modification is to get the HtmlReporter to display
the passes as well as the failures and errors...
<pre>
<strong>class ReporterShowingPasses extends HtmlReporter {
function paintPass($message) {
parent::paintPass($message);
print "&lt;span class=\"pass\"&gt;Pass&lt;/span&gt;: ";
$breadcrumb = $this-&gt;getTestList();
array_shift($breadcrumb);
print implode("-&amp;gt;", $breadcrumb);
print "-&amp;gt;$message&lt;br /&gt;\n";
}
protected function getCss() {
return parent::getCss() . ' .pass { color: green; }';
}
}</strong>
</pre>
</p>
<p>
One method that was glossed over was the <span class="new_code">makeDry()</span>
method.
If you run this method, with no parameters, on the reporter
before the test suite is run no actual test methods
will be called.
You will still get the events of entering and leaving the
test methods and test cases, but no passes or failures etc,
because the test code will not actually be executed.
</p>
<p>
The reason for this is to allow for more sophistcated
GUI displays that allow the selection of individual test
cases.
In order to build a list of possible tests they need a
report on the test structure for drawing, say a tree view
of the test suite.
With a reporter set to dry run that just sends drawing events
this is easily accomplished.
</p>
<h2>
<a class="target" name="other"></a>Extending the reporter</h2>
<p>
Rather than simply modifying the existing display, you might want to
produce a whole new HTML look, or even generate text or XML.
Rather than override every method in
<span class="new_code">HtmlReporter</span> we can take one
step up the class hiearchy to <span class="new_code">SimpleReporter</span>
in the <em>simple_test.php</em> source file.
</p>
<p>
A do nothing display, a blank canvas for your own creation, would
be...
<pre>
<strong>require_once('simpletest/simpletest.php');</strong>
class MyDisplay extends SimpleReporter {<strong>
</strong>
function paintHeader($test_name) { }
function paintFooter($test_name) { }
function paintStart($test_name, $size) {<strong>
parent::paintStart($test_name, $size);</strong>
}
function paintEnd($test_name, $size) {<strong>
parent::paintEnd($test_name, $size);</strong>
}
function paintPass($message) {<strong>
parent::paintPass($message);</strong>
}
function paintFail($message) {<strong>
parent::paintFail($message);</strong>
}
function paintError($message) {<strong>
parent::paintError($message);</strong>
}
function paintException($exception) {<strong>
parent::paintException($exception);</strong>
}
}
</pre>
No output would come from this class until you add it.
</p>
<p>
The catch with using this low level class is that you must
explicitely invoke it in the test script.
The "autorun" facility will not be able to use
its runtime context (whether it's running in a web browser
or the command line) to select the reporter.
</p>
<p>
You explicitely invoke the test runner like so...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
$test-&gt;run(<strong>new MyReporter()</strong>);
?&gt;
</pre>
...perhaps like this...
<pre>
&lt;?php
require_once('simpletest/simpletest.php');
require_once('my_reporter.php');
class MyTest extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('tests/file_test.php');
}
}
$test = new MyTest();
$test-&gt;run(<strong>new MyReporter()</strong>);
?&gt;
</pre>
We'll show how to fit in with "autorun" later.
</p>
<h2>
<a class="target" name="cli"></a>The command line reporter</h2>
<p>
SimpleTest also ships with a minimal command line reporter.
The interface mimics JUnit to some extent, but paints the
failure messages as they arrive.
To use the command line reporter explicitely, substitute it
for the HTML version...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
$test-&gt;run(<strong>new TextReporter()</strong>);
?&gt;
</pre>
Then invoke the test suite from the command line...
<pre class="shell">
php file_test.php
</pre>
You will need the command line version of PHP installed
of course.
A passing test suite looks like this...
<pre class="shell">
File test
OK
Test cases run: 1/1, Passes: 1, Failures: 0, Exceptions: 0
</pre>
A failure triggers a display like this...
<pre class="shell">
File test
1) True assertion failed.
in createNewFile
FAILURES!!!
Test cases run: 1/1, Passes: 0, Failures: 1, Exceptions: 0
</pre>
</p>
<p>
One of the main reasons for using a command line driven
test suite is of using the tester as part of some automated
process.
To function properly in shell scripts the test script should
return a non-zero exit code on failure.
If a test suite fails the value <span class="new_code">false</span>
is returned from the <span class="new_code">SimpleTest::run()</span>
method.
We can use that result to exit the script with the desired return
code...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
<strong>exit ($test-&gt;run(new TextReporter()) ? 0 : 1);</strong>
?&gt;
</pre>
Of course we wouldn't really want to create two test scripts,
a command line one and a web browser one, for each test suite.
The command line reporter includes a method to sniff out the
run time environment...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
<strong>if (TextReporter::inCli()) {</strong>
exit ($test-&gt;run(new TextReporter()) ? 0 : 1);
<strong>}</strong>
$test-&gt;run(new HtmlReporter());
?&gt;
</pre>
This is the form used within SimpleTest itself.
When you use the "autorun.php", and no
test has been run by the end, this is pretty much
the code that SimpleTest will run for you implicitely.
</p>
<p>
In other words, this is gives the same result...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class MyTest extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('tests/file_test.php');
}
}
?&gt;
</pre>
</p>
<h2>
<a class="target" name="xml"></a>Remote testing</h2>
<p>
SimpleTest ships with an <span class="new_code">XmlReporter</span> class
used for internal communication.
When run the output looks like...
<pre class="shell">
&lt;?xml version="1.0"?&gt;
&lt;run&gt;
&lt;group size="4"&gt;
&lt;name&gt;Remote tests&lt;/name&gt;
&lt;group size="4"&gt;
&lt;name&gt;Visual test with 48 passes, 48 fails and 4 exceptions&lt;/name&gt;
&lt;case&gt;
&lt;name&gt;testofunittestcaseoutput&lt;/name&gt;
&lt;test&gt;
&lt;name&gt;testofresults&lt;/name&gt;
&lt;pass&gt;This assertion passed&lt;/pass&gt;
&lt;fail&gt;This assertion failed&lt;/fail&gt;
&lt;/test&gt;
&lt;test&gt;
...
&lt;/test&gt;
&lt;/case&gt;
&lt;/group&gt;
&lt;/group&gt;
&lt;/run&gt;
</pre>
To get your normal test cases to produce this format, on the
command line add the <span class="new_code">--xml</span> flag.
<pre class="shell">
php my_test.php --xml
</pre>
You can do teh same thing in the web browser by adding the
URL parameter <span class="new_code">xml=1</span>.
Any true value will do.
</p>
<p>
You can consume this format with the parser
supplied as part of SimpleTest itself.
This is called <span class="new_code">SimpleTestXmlParser</span> and
resides in <em>xml.php</em> within the SimpleTest package...
<pre>
&lt;?php
require_once('simpletest/xml.php');
...
$parser = new SimpleTestXmlParser(new HtmlReporter());
$parser-&gt;parse($test_output);
?&gt;
</pre>
The <span class="new_code">$test_output</span> should be the XML format
from the XML reporter, and could come from say a command
line run of a test case.
The parser sends events to the reporter just like any
other test run.
There are some odd occasions where this is actually useful.
</p>
<p>
Most likely it's when you want to isolate a problematic crash
prone test.
You can collect the XML output using the backtick operator
from another test.
In that way it runs in its own process...
<pre>
&lt;?php
require_once('simpletest/xml.php');
if (TextReporter::inCli()) {
$parser = new SimpleTestXmlParser(new TextReporter());
} else {
$parser = new SimpleTestXmlParser(new HtmlReporter());
}
$parser-&gt;parse(`php flakey_test.php --xml`);
?&gt;
</pre>
</p>
<p>
Another use is breaking up large test suites.
</p>
<p>
A problem with large test suites is thet they can exhaust
the default 16Mb memory limit on a PHP process.
By having the test groups output in XML and run in
separate processes, the output can be reparsed to
aggregate the results into a much smaller footprint top level
test.
</p>
<p>
Because the XML output can come from anywhere, this opens
up the possibility of aggregating test runs from remote
servers.
A test case already exists to do this within the SimpleTest
framework, but it is currently experimental...
<pre>
&lt;?php
<strong>require_once('../remote.php');</strong>
require_once('simpletest/autorun.php');
$test_url = ...;
$dry_url = ...;
class MyTestOnAnotherServer extends RemoteTestCase {
function __construct() {
$test_url = ...
parent::__construct($test_url, $test_url . ' --dry');
}
}
?&gt;
</pre>
The <span class="new_code">RemoteTestCase</span> takes the actual location
of the test runner, basically a web page in XML format.
It also takes the URL of a reporter set to do a dry run.
This is so that progress can be reported upward correctly.
The <span class="new_code">RemoteTestCase</span> can be added to test suites
just like any other test suite.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
The <a href="http://simpletest.org/api/">developer's API for SimpleTest</a>
gives full detail on the classes and assertions available.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<span class="chosen">Reporting</span>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,442 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest for PHP regression test documentation</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<span class="chosen">Unit tester</span>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>PHP Unit Test documentation</h1>
This page...
<ul>
<li>
<a href="#unit">Unit test cases</a> and basic assertions.
</li>
<li>
<a href="#extending_unit">Extending test cases</a> to
customise them for your own project.
</li>
<li>
<a href="#running_unit">Running a single case</a> as
a single script.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="unit"></a>Unit test cases</h2>
<p>
The core system is a regression testing framework built around
test cases.
A sample test case looks like this...
<pre>
<strong>class FileTestCase extends UnitTestCase {
}</strong>
</pre>
Actual tests are added as methods in the test case whose names
by default start with the string "test" and
when the test case is invoked all such methods are run in
the order that PHP introspection finds them.
As many test methods can be added as needed.
</p>
<p>
For example...
<pre>
require_once('simpletest/autorun.php');
require_once('../classes/writer.php');
class FileTestCase extends UnitTestCase {
function FileTestCase() {
$this-&gt;UnitTestCase('File test');
}<strong>
function setUp() {
@unlink('../temp/test.txt');
}
function tearDown() {
@unlink('../temp/test.txt');
}
function testCreation() {
$writer = &amp;new FileWriter('../temp/test.txt');
$writer-&gt;write('Hello');
$this-&gt;assertTrue(file_exists('../temp/test.txt'), 'File created');
}</strong>
}
</pre>
The constructor is optional and usually omitted.
Without a name, the class name is taken as the name of the test case.
</p>
<p>
Our only test method at the moment is <span class="new_code">testCreation()</span>
where we check that a file has been created by our
<span class="new_code">Writer</span> object.
We could have put the <span class="new_code">unlink()</span>
code into this method as well, but by placing it in
<span class="new_code">setUp()</span> and
<span class="new_code">tearDown()</span> we can use it with
other test methods that we add.
</p>
<p>
The <span class="new_code">setUp()</span> method is run
just before each and every test method.
<span class="new_code">tearDown()</span> is run just after
each and every test method.
</p>
<p>
You can place some test case set up into the constructor to
be run once for all the methods in the test case, but
you risk test interference that way.
This way is slightly slower, but it is safer.
Note that if you come from a JUnit background this will not
be the behaviour you are used to.
JUnit surprisingly reinstantiates the test case for each test
method to prevent such interference.
SimpleTest requires the end user to use <span class="new_code">setUp()</span>, but
supplies additional hooks for library writers.
</p>
<p>
The means of reporting test results (see below) are by a
visiting display class
that is notified by various <span class="new_code">assert...()</span>
methods.
Here is the full list for the <span class="new_code">UnitTestCase</span>
class, the default for SimpleTest...
<table><tbody>
<tr>
<td><span class="new_code">assertTrue($x)</span></td>
<td>Fail if $x is false</td>
</tr>
<tr>
<td><span class="new_code">assertFalse($x)</span></td>
<td>Fail if $x is true</td>
</tr>
<tr>
<td><span class="new_code">assertNull($x)</span></td>
<td>Fail if $x is set</td>
</tr>
<tr>
<td><span class="new_code">assertNotNull($x)</span></td>
<td>Fail if $x not set</td>
</tr>
<tr>
<td><span class="new_code">assertIsA($x, $t)</span></td>
<td>Fail if $x is not the class or type $t</td>
</tr>
<tr>
<td><span class="new_code">assertNotA($x, $t)</span></td>
<td>Fail if $x is of the class or type $t</td>
</tr>
<tr>
<td><span class="new_code">assertEqual($x, $y)</span></td>
<td>Fail if $x == $y is false</td>
</tr>
<tr>
<td><span class="new_code">assertNotEqual($x, $y)</span></td>
<td>Fail if $x == $y is true</td>
</tr>
<tr>
<td><span class="new_code">assertWithinMargin($x, $y, $m)</span></td>
<td>Fail if abs($x - $y) &lt; $m is false</td>
</tr>
<tr>
<td><span class="new_code">assertOutsideMargin($x, $y, $m)</span></td>
<td>Fail if abs($x - $y) &lt; $m is true</td>
</tr>
<tr>
<td><span class="new_code">assertIdentical($x, $y)</span></td>
<td>Fail if $x == $y is false or a type mismatch</td>
</tr>
<tr>
<td><span class="new_code">assertNotIdentical($x, $y)</span></td>
<td>Fail if $x == $y is true and types match</td>
</tr>
<tr>
<td><span class="new_code">assertReference($x, $y)</span></td>
<td>Fail unless $x and $y are the same variable</td>
</tr>
<tr>
<td><span class="new_code">assertClone($x, $y)</span></td>
<td>Fail unless $x and $y are identical copies</td>
</tr>
<tr>
<td><span class="new_code">assertPattern($p, $x)</span></td>
<td>Fail unless the regex $p matches $x</td>
</tr>
<tr>
<td><span class="new_code">assertNoPattern($p, $x)</span></td>
<td>Fail if the regex $p matches $x</td>
</tr>
<tr>
<td><span class="new_code">expectError($x)</span></td>
<td>Fail if matching error does not occour</td>
</tr>
<tr>
<td><span class="new_code">expectException($x)</span></td>
<td>Fail if matching exception is not thrown</td>
</tr>
<tr>
<td><span class="new_code">ignoreException($x)</span></td>
<td>Swallows any upcoming matching exception</td>
</tr>
<tr>
<td><span class="new_code">assert($e)</span></td>
<td>Fail on failed <a href="expectation_documentation.html">expectation</a> object $e</td>
</tr>
</tbody></table>
All assertion methods can take an optional description as a
last parameter.
This is to label the displayed result with.
If omitted a default message is sent instead, which is usually
sufficient.
This default message can still be embedded in your own message
if you include "%s" within the string.
All the assertions return true on a pass or false on failure.
</p>
<p>
Some examples...
<pre>
$variable = null;
<strong>$this-&gt;assertNull($variable, 'Should be cleared');</strong>
</pre>
...will pass and normally show no message.
If you have
<a href="http://www.lastcraft.com/display_subclass_tutorial.php">set up the tester to display passes</a>
as well then the message will be displayed as is.
<pre>
<strong>$this-&gt;assertIdentical(0, false, 'Zero is not false [%s]');</strong>
</pre>
This will fail as it performs a type
check, as well as a comparison, between the two values.
The "%s" part is replaced by the default
error message that would have been shown if we had not
supplied our own.
<pre>
$a = 1;
$b = $a;
<strong>$this-&gt;assertReference($a, $b);</strong>
</pre>
Will fail as the variable <span class="new_code">$a</span> is a copy of <span class="new_code">$b</span>.
<pre>
<strong>$this-&gt;assertPattern('/hello/i', 'Hello world');</strong>
</pre>
This will pass as using a case insensitive match the string
<span class="new_code">hello</span> is contained in <span class="new_code">Hello world</span>.
<pre>
<strong>$this-&gt;expectError();</strong>
trigger_error('Catastrophe');
</pre>
Here the check catches the "Catastrophe"
message without checking the text and passes.
This removes the error from the queue.
<pre>
<strong>$this-&gt;expectError('Catastrophe');</strong>
trigger_error('Catastrophe');
</pre>
The next error check tests not only the existence of the error,
but also the text which, here matches so another pass.
If any unchecked errors are left at the end of a test method then
an exception will be reported in the test.
</p>
<p>
Note that SimpleTest cannot catch compile time PHP errors.
</p>
<p>
The test cases also have some convenience methods for debugging
code or extending the suite...
<table><tbody>
<tr>
<td><span class="new_code">setUp()</span></td>
<td>Runs this before each test method</td>
</tr>
<tr>
<td><span class="new_code">tearDown()</span></td>
<td>Runs this after each test method</td>
</tr>
<tr>
<td><span class="new_code">pass()</span></td>
<td>Sends a test pass</td>
</tr>
<tr>
<td><span class="new_code">fail()</span></td>
<td>Sends a test failure</td>
</tr>
<tr>
<td><span class="new_code">error()</span></td>
<td>Sends an exception event</td>
</tr>
<tr>
<td><span class="new_code">signal($type, $payload)</span></td>
<td>Sends a user defined message to the test reporter</td>
</tr>
<tr>
<td><span class="new_code">dump($var)</span></td>
<td>Does a formatted <span class="new_code">print_r()</span> for quick and dirty debugging</td>
</tr>
</tbody></table>
</p>
<h2>
<a class="target" name="extending_unit"></a>Extending test cases</h2>
<p>
Of course additional test methods can be added to create
specific types of test case, so as to extend framework...
<pre>
require_once('simpletest/autorun.php');
<strong>
class FileTester extends UnitTestCase {
function FileTester($name = false) {
$this-&gt;UnitTestCase($name);
}
function assertFileExists($filename, $message = '%s') {
$this-&gt;assertTrue(
file_exists($filename),
sprintf($message, 'File [$filename] existence check'));
}</strong>
}
</pre>
Here the SimpleTest library is held in a folder called
<em>simpletest</em> that is local.
Substitute your own path for this.
</p>
<p>
To prevent this test case being run accidently, it is
advisable to mark it as <span class="new_code">abstract</span>.
</p>
<p>
Alternatively you could add a
<span class="new_code">SimpleTestOptions::ignore('FileTester');</span>
directive in your code.
</p>
<p>
This new case can be now be inherited just like
a normal test case...
<pre>
class FileTestCase extends <strong>FileTester</strong> {
function setUp() {
@unlink('../temp/test.txt');
}
function tearDown() {
@unlink('../temp/test.txt');
}
function testCreation() {
$writer = &amp;new FileWriter('../temp/test.txt');
$writer-&gt;write('Hello');<strong>
$this-&gt;assertFileExists('../temp/test.txt');</strong>
}
}
</pre>
</p>
<p>
If you want a test case that does not have all of the
<span class="new_code">UnitTestCase</span> assertions,
only your own and a few basics,
you need to extend the <span class="new_code">SimpleTestCase</span>
class instead.
It is found in <em>simple_test.php</em> rather than
<em>unit_tester.php</em>.
See <a href="group_test_documentation.html">later</a> if you
want to incorporate other unit tester's
test cases in your test suites.
</p>
<h2>
<a class="target" name="running_unit"></a>Running a single test case</h2>
<p>
You won't often run single test cases except when bashing
away at a module that is having difficulty, and you don't
want to upset the main test suite.
With <em>autorun</em> no particular scaffolding is needed,
just launch your particular test file and you're ready to go.
</p>
<p>
You can even decide which reporter (for example,
<span class="new_code">TextReporter</span> or <span class="new_code">HtmlReporter</span>)
you prefer for a specific file when launched on its own...
<pre>
&lt;?php
require_once('simpletest/autorun.php');<strong>
SimpleTest :: prefer(new TextReporter());</strong>
require_once('../classes/writer.php');
class FileTestCase extends UnitTestCase {
...
}
?&gt;
</pre>
This script will run as is, but of course will output zero passes
and zero failures until test methods are added.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">Full API for SimpleTest</a>
from the PHPDoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<span class="chosen">Unit tester</span>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,588 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleTest for PHP web script testing documentation</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<span class="chosen">Web tester</span>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Web tester documentation</h1>
This page...
<ul>
<li>
Successfully <a href="#fetch">fetching a web page</a>
</li>
<li>
Testing the <a href="#content">page content</a>
</li>
<li>
<a href="#navigation">Navigating a web site</a>
while testing
</li>
<li>
<a href="#request">Raw request modifications</a> and debugging methods
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="fetch"></a>Fetching a page</h2>
<p>
Testing classes is all very well, but PHP is predominately
a language for creating functionality within web pages.
How do we test the front end presentation role of our PHP
applications?
Well the web pages are just text, so we should be able to
examine them just like any other test data.
</p>
<p>
This leads to a tricky issue.
If we test at too low a level, testing for matching tags
in the page with pattern matching for example, our tests will
be brittle.
The slightest change in layout could break a large number of
tests.
If we test at too high a level, say using mock versions of a
template engine, then we lose the ability to automate some classes
of test.
For example, the interaction of forms and navigation will
have to be tested manually.
These types of test are extremely repetitive and error prone.
</p>
<p>
SimpleTest includes a special form of test case for the testing
of web page actions.
The <span class="new_code">WebTestCase</span> includes facilities
for navigation, content and cookie checks and form handling.
Usage of these test cases is similar to the
<a href="unit_tester_documentation.html">UnitTestCase</a>...
<pre>
<strong>class TestOfLastcraft extends WebTestCase {
}</strong>
</pre>
Here we are about to test the
<a href="http://www.lastcraft.com/">Last Craft</a> site itself.
If this test case is in a file called <em>lastcraft_test.php</em>
then it can be loaded in a runner script just like unit tests...
<pre>
&lt;?php
require_once('simpletest/autorun.php');<strong>
require_once('simpletest/web_tester.php');</strong>
SimpleTest::prefer(new TextReporter());
class WebTests extends TestSuite {
function WebTests() {
$this-&gt;TestSuite('Web site tests');<strong>
$this-&gt;addFile('lastcraft_test.php');</strong>
}
}
?&gt;
</pre>
I am using the text reporter here to more clearly
distinguish the web content from the test output.
</p>
<p>
Nothing is being tested yet.
We can fetch the home page by using the
<span class="new_code">get()</span> method...
<pre>
class TestOfLastcraft extends WebTestCase {
<strong>
function testHomepage() {
$this-&gt;assertTrue($this-&gt;get('http://www.lastcraft.com/'));
}</strong>
}
</pre>
The <span class="new_code">get()</span> method will
return true only if page content was successfully
loaded.
It is a simple, but crude way to check that a web page
was actually delivered by the web server.
However that content may be a 404 response and yet
our <span class="new_code">get()</span> method will still return true.
</p>
<p>
Assuming that the web server for the Last Craft site is up
(sadly not always the case), we should see...
<pre class="shell">
Web site tests
OK
Test cases run: 1/1, Failures: 0, Exceptions: 0
</pre>
All we have really checked is that any kind of page was
returned.
We don't yet know if it was the right one.
</p>
<h2>
<a class="target" name="content"></a>Testing page content</h2>
<p>
To confirm that the page we think we are on is actually the
page we are on, we need to verify the page content.
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {<strong>
$this-&gt;get('http://www.lastcraft.com/');
$this-&gt;assertText('Why the last craft');</strong>
}
}
</pre>
The page from the last fetch is held in a buffer in
the test case, so there is no need to refer to it directly.
The pattern match is always made against the buffer.
</p>
<p>
Here is the list of possible content assertions...
<table><tbody>
<tr>
<td><span class="new_code">assertTitle($title)</span></td>
<td>Pass if title is an exact match</td>
</tr>
<tr>
<td><span class="new_code">assertText($text)</span></td>
<td>Pass if matches visible and "alt" text</td>
</tr>
<tr>
<td><span class="new_code">assertNoText($text)</span></td>
<td>Pass if doesn't match visible and "alt" text</td>
</tr>
<tr>
<td><span class="new_code">assertPattern($pattern)</span></td>
<td>A Perl pattern match against the page content</td>
</tr>
<tr>
<td><span class="new_code">assertNoPattern($pattern)</span></td>
<td>A Perl pattern match to not find content</td>
</tr>
<tr>
<td><span class="new_code">assertLink($label)</span></td>
<td>Pass if a link with this text is present</td>
</tr>
<tr>
<td><span class="new_code">assertNoLink($label)</span></td>
<td>Pass if no link with this text is present</td>
</tr>
<tr>
<td><span class="new_code">assertLinkById($id)</span></td>
<td>Pass if a link with this id attribute is present</td>
</tr>
<tr>
<td><span class="new_code">assertNoLinkById($id)</span></td>
<td>Pass if no link with this id attribute is present</td>
</tr>
<tr>
<td><span class="new_code">assertField($name, $value)</span></td>
<td>Pass if an input tag with this name has this value</td>
</tr>
<tr>
<td><span class="new_code">assertFieldById($id, $value)</span></td>
<td>Pass if an input tag with this id has this value</td>
</tr>
<tr>
<td><span class="new_code">assertResponse($codes)</span></td>
<td>Pass if HTTP response matches this list</td>
</tr>
<tr>
<td><span class="new_code">assertMime($types)</span></td>
<td>Pass if MIME type is in this list</td>
</tr>
<tr>
<td><span class="new_code">assertAuthentication($protocol)</span></td>
<td>Pass if the current challenge is this protocol</td>
</tr>
<tr>
<td><span class="new_code">assertNoAuthentication()</span></td>
<td>Pass if there is no current challenge</td>
</tr>
<tr>
<td><span class="new_code">assertRealm($name)</span></td>
<td>Pass if the current challenge realm matches</td>
</tr>
<tr>
<td><span class="new_code">assertHeader($header, $content)</span></td>
<td>Pass if a header was fetched matching this value</td>
</tr>
<tr>
<td><span class="new_code">assertNoHeader($header)</span></td>
<td>Pass if a header was not fetched</td>
</tr>
<tr>
<td><span class="new_code">assertCookie($name, $value)</span></td>
<td>Pass if there is currently a matching cookie</td>
</tr>
<tr>
<td><span class="new_code">assertNoCookie($name)</span></td>
<td>Pass if there is currently no cookie of this name</td>
</tr>
</tbody></table>
As usual with the SimpleTest assertions, they all return
false on failure and true on pass.
They also allow an optional test message and you can embed
the original test message inside using "%s" inside
your custom message.
</p>
<p>
So now we could instead test against the title tag with...
<pre>
<strong>$this-&gt;assertTitle('The Last Craft? Web developer tutorials on PHP, Extreme programming and Object Oriented development');</strong>
</pre>
...or, if that is too long and fragile...
<pre>
<strong>$this-&gt;assertTitle(new PatternExpectation('/The Last Craft/'));</strong>
</pre>
As well as the simple HTML content checks we can check
that the MIME type is in a list of allowed types with...
<pre>
<strong>$this-&gt;assertMime(array('text/plain', 'text/html'));</strong>
</pre>
More interesting is checking the HTTP response code.
Like the MIME type, we can assert that the response code
is in a list of allowed values...
<pre>
class TestOfLastcraft extends WebTestCase {
function testRedirects() {
$this-&gt;get('http://www.lastcraft.com/test/redirect.php');
$this-&gt;assertResponse(200);&lt;/strong&gt;
}
}
</pre>
Here we are checking that the fetch is successful by
allowing only a 200 HTTP response.
This test will pass, but it is not actually correct to do so.
There is no page, instead the server issues a redirect.
The <span class="new_code">WebTestCase</span> will
automatically follow up to three such redirects.
The tests are more robust this way and we are usually
interested in the interaction with the pages rather
than their delivery.
If the redirects are of interest then this ability must
be disabled...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {<strong>
$this-&gt;setMaximumRedirects(0);</strong>
$this-&gt;get('http://www.lastcraft.com/test/redirect.php');
$this-&gt;assertResponse(200);
}
}
</pre>
The assertion now fails as expected...
<pre class="shell">
Web site tests
1) Expecting response in [200] got [302]
in testhomepage
in testoflastcraft
in lastcraft_test.php
FAILURES!!!
Test cases run: 1/1, Failures: 1, Exceptions: 0
</pre>
We can modify the test to correctly assert redirects with...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {
$this-&gt;setMaximumRedirects(0);
$this-&gt;get('http://www.lastcraft.com/test/redirect.php');
$this-&gt;assertResponse(<strong>array(301, 302, 303, 307)</strong>);
}
}
</pre>
This now passes.
</p>
<h2>
<a class="target" name="navigation"></a>Navigating a web site</h2>
<p>
Users don't often navigate sites by typing in URLs, but by
clicking links and buttons.
Here we confirm that the contact details can be reached
from the home page...
<pre>
class TestOfLastcraft extends WebTestCase {
...
function testContact() {
$this-&gt;get('http://www.lastcraft.com/');<strong>
$this-&gt;clickLink('About');
$this-&gt;assertTitle(new PatternExpectation('/About Last Craft/'));</strong>
}
}
</pre>
The parameter is the text of the link.
</p>
<p>
If the target is a button rather than an anchor tag, then
<span class="new_code">clickSubmit()</span> can be used
with the button title...
<pre>
<strong>$this-&gt;clickSubmit('Go!');</strong>
</pre>
If you are not sure or don't care, the usual case, then just
use the <span class="new_code">click()</span> method...
<pre>
<strong>$this-&gt;click('Go!');</strong>
</pre>
</p>
<p>
The list of navigation methods is...
<table><tbody>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>The current location</td>
</tr>
<tr>
<td><span class="new_code">get($url, $parameters)</span></td>
<td>Send a GET request with these parameters</td>
</tr>
<tr>
<td><span class="new_code">post($url, $parameters)</span></td>
<td>Send a POST request with these parameters</td>
</tr>
<tr>
<td><span class="new_code">head($url, $parameters)</span></td>
<td>Send a HEAD request without replacing the page content</td>
</tr>
<tr>
<td><span class="new_code">retry()</span></td>
<td>Reload the last request</td>
</tr>
<tr>
<td><span class="new_code">back()</span></td>
<td>Like the browser back button</td>
</tr>
<tr>
<td><span class="new_code">forward()</span></td>
<td>Like the browser forward button</td>
</tr>
<tr>
<td><span class="new_code">authenticate($name, $password)</span></td>
<td>Retry after a challenge</td>
</tr>
<tr>
<td><span class="new_code">restart()</span></td>
<td>Restarts the browser as if a new session</td>
</tr>
<tr>
<td><span class="new_code">getCookie($name)</span></td>
<td>Gets the cookie value for the current context</td>
</tr>
<tr>
<td><span class="new_code">ageCookies($interval)</span></td>
<td>Ages current cookies prior to a restart</td>
</tr>
<tr>
<td><span class="new_code">clearFrameFocus()</span></td>
<td>Go back to treating all frames as one page</td>
</tr>
<tr>
<td><span class="new_code">clickSubmit($label)</span></td>
<td>Click the first button with this label</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitByName($name)</span></td>
<td>Click the button with this name attribute</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitById($id)</span></td>
<td>Click the button with this ID attribute</td>
</tr>
<tr>
<td><span class="new_code">clickImage($label, $x, $y)</span></td>
<td>Click an input tag of type image by title or alt text</td>
</tr>
<tr>
<td><span class="new_code">clickImageByName($name, $x, $y)</span></td>
<td>Click an input tag of type image by name</td>
</tr>
<tr>
<td><span class="new_code">clickImageById($id, $x, $y)</span></td>
<td>Click an input tag of type image by ID attribute</td>
</tr>
<tr>
<td><span class="new_code">submitFormById($id)</span></td>
<td>Submit a form without the submit value</td>
</tr>
<tr>
<td><span class="new_code">clickLink($label, $index)</span></td>
<td>Click an anchor by the visible label text</td>
</tr>
<tr>
<td><span class="new_code">clickLinkById($id)</span></td>
<td>Click an anchor by the ID attribute</td>
</tr>
<tr>
<td><span class="new_code">getFrameFocus()</span></td>
<td>The name of the currently selected frame</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocusByIndex($choice)</span></td>
<td>Focus on a frame counting from 1</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocus($name)</span></td>
<td>Focus on a frame by name</td>
</tr>
</tbody></table>
</p>
<p>
The parameters in the <span class="new_code">get()</span>, <span class="new_code">post()</span> or
<span class="new_code">head()</span> methods are optional.
The HTTP HEAD fetch does not change the browser context, only loads
cookies.
This can be useful for when an image or stylesheet sets a cookie
for crafty robot blocking.
</p>
<p>
The <span class="new_code">retry()</span>, <span class="new_code">back()</span> and
<span class="new_code">forward()</span> commands work as they would on
your web browser.
They use the history to retry pages.
This can be handy for checking the effect of hitting the
back button on your forms.
</p>
<p>
The frame methods need a little explanation.
By default a framed page is treated just like any other.
Content will be searced for throughout the entire frameset,
so clicking a link will work no matter which frame
the anchor tag is in.
You can override this behaviour by focusing on a single
frame.
If you do that, all searches and actions will apply to that
frame alone, such as authentication and retries.
If a link or button is not in a focused frame then it cannot
be clicked.
</p>
<p>
Testing navigation on fixed pages only tells you when you
have broken an entire script.
For highly dynamic pages, such as for bulletin boards, this can
be crucial for verifying the correctness of the application.
For most applications though, the really tricky logic is usually in
the handling of forms and sessions.
Fortunately SimpleTest includes
<a href="form_testing_documentation.html">tools for testing web forms</a>
as well.
</p>
<h2>
<a class="target" name="request"></a>Modifying the request</h2>
<p>
Although SimpleTest does not have the goal of testing networking
problems, it does include some methods to modify and debug
the requests it makes.
Here is another method list...
<table><tbody>
<tr>
<td><span class="new_code">getTransportError()</span></td>
<td>The last socket error</td>
</tr>
<tr>
<td><span class="new_code">showRequest()</span></td>
<td>Dump the outgoing request</td>
</tr>
<tr>
<td><span class="new_code">showHeaders()</span></td>
<td>Dump the incoming headers</td>
</tr>
<tr>
<td><span class="new_code">showSource()</span></td>
<td>Dump the raw HTML page content</td>
</tr>
<tr>
<td><span class="new_code">ignoreFrames()</span></td>
<td>Do not load framesets</td>
</tr>
<tr>
<td><span class="new_code">setCookie($name, $value)</span></td>
<td>Set a cookie from now on</td>
</tr>
<tr>
<td><span class="new_code">addHeader($header)</span></td>
<td>Always add this header to the request</td>
</tr>
<tr>
<td><span class="new_code">setMaximumRedirects($max)</span></td>
<td>Stop after this many redirects</td>
</tr>
<tr>
<td><span class="new_code">setConnectionTimeout($timeout)</span></td>
<td>Kill the connection after this time between bytes</td>
</tr>
<tr>
<td><span class="new_code">useProxy($proxy, $name, $password)</span></td>
<td>Make requests via this proxy URL</td>
</tr>
</tbody></table>
These methods are principally for debugging.
</p>
</div>
References and related information...
<ul>
<li>
SimpleTest project page on <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
SimpleTest download page on <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
The <a href="http://simpletest.org/api/">developer's API for SimpleTest</a>
gives full detail on the classes and assertions available.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<span class="chosen">Web tester</span>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,372 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation Simple Test : tester l'authentification</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur l'authentification</h1>
This page...
<ul>
<li>
Passer au travers d'une <a href="#basique">authentification HTTP basique</a>
</li>
<li>
Tester l'<a href="#cookies">authentification basée sur des cookies</a>
</li>
<li>
Gérer les <a href="#session">sessions du navigateur</a> et les timeouts
</li>
</ul>
<div class="content">
<p>
Un des secteurs à la fois délicat et important lors d'un test
de site web reste la sécurité. Tester ces schémas est au coeur
des objectifs du testeur web de SimpleTest.
</p>
<h2>
<a class="target" name="basique"></a>Authentification HTTP basique</h2>
<p>
Si vous allez chercher une page web protégée
par une authentification basique, vous hériterez d'une entête 401.
Nous pouvons représenter ceci par ce test...
<pre>
class AuthenticationTest extends WebTestCase {<strong>
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');
$this-&gt;showHeaders();
}</strong>
}
</pre>
Ce qui nous permet de voir les entêtes reçues...
<div class="demo">
<h1>File test</h1>
<pre style="background-color: lightgray; color: black">
HTTP/1.1 401 Authorization Required
Date: Sat, 18 Sep 2004 19:25:18 GMT
Server: Apache/1.3.29 (Unix) PHP/4.3.4
WWW-Authenticate: Basic realm="SimpleTest basic authentication"
Connection: close
Content-Type: text/html; charset=iso-8859-1
</pre>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>0</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
Sauf que nous voulons éviter l'inspection visuelle,
on souhaite que SimpleTest puisse nous dire si oui ou non
la page est protégée. Voici un test en profondeur sur nos entêtes...
<pre>
class AuthenticationTest extends WebTestCase {
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');<strong>
$this-&gt;assertAuthentication('Basic');
$this-&gt;assertResponse(401);
$this-&gt;assertRealm('SimpleTest basic authentication');</strong>
}
}
</pre>
N'importe laquelle de ces assertions suffirait,
tout dépend de la masse de détails que vous souhaitez voir.
</p>
<p>
Un des axes qui traverse SimpleTest est la possibilité d'utiliser
des objets <span class="new_code">SimpleExpectation</span> à chaque fois qu'une
vérification simple suffit.
Si vous souhaitez vérifiez simplement le contenu du realm - l'identification
du domaine - dans notre exemple, il suffit de faire...
<pre>
class AuthenticationTest extends WebTestCase {
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');
$this-&gt;assertRealm(<strong>new PatternExpectation('/simpletest/i')</strong>);
}
}
</pre>
Ce type de test, vérifier les réponses HTTP, n'est cependant pas commun.
</p>
<p>
La plupart du temps, nous ne souhaitons pas tester
l'authentification en elle-même, mais plutôt
les pages protégées par cette authentification.
Dès que la tentative d'authentification est reçue,
nous pouvons y répondre à l'aide d'une réponse d'authentification :
<pre>
class AuthenticationTest extends WebTestCase {
function testAuthentication() {
$this-&gt;get('http://www.lastcraft.com/protected/');<strong>
$this-&gt;authenticate('Me', 'Secret');</strong>
$this-&gt;assertTitle(...);
}
}
</pre>
Le nom d'utilisateur et le mot de passe seront désormais
envoyés à chaque requête vers ce répertoire
et ses sous-répertoires.
En revanche vous devrez vous authentifier à nouveau
si vous sortez de ce répertoire mais SimpleTest est assez
intelligent pour fusionner les sous-répertoires dans un même domaine.
</p>
<p>
Vous pouvez gagner une ligne en définissant
l'authentification au niveau de l'URL...
<pre>
class AuthenticationTest extends WebTestCase {
function testCanReadAuthenticatedPages() {
$this-&gt;get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/');
$this-&gt;assertTitle(...);
}
}
</pre>
Si votre nom d'utilisateur ou mot de passe comporte
des caractères spéciaux, alors n'oubliez pas de les encoder,
sinon la requête ne sera pas analysée correctement.
De plus cette entête ne sera pas envoyée aux
sous requêtes si vous la définissez avec une URL absolue.
Par contre si vous naviguez avec des URL relatives,
l'information d'authentification sera préservée.
</p>
<p>
Normalement, vous utilisez l'appel <span class="new_code">authenticate()</span>. SimpleTest
utilisera alors vos informations de connexion à chaque requête.
</p>
<p>
Pour l'instant, seule l'authentification de base est implémentée
et elle n'est réellement fiable qu'en tandem avec une connexion HTTPS.
C'est généralement suffisant pour protéger
le serveur testé des regards malveillants.
Les authentifications Digest et NTLM pourraient être ajoutées prochainement.
</p>
<h2>
<a class="target" name="cookies"></a>Cookies</h2>
<p>
L'authentification de base ne donne pas assez de contrôle
au développeur Web sur l'interface utilisateur.
Il y a de forte chance pour que cette fonctionnalité
soit codée directement dans l'architecture web
à grand renfort de cookies et de timeouts compliqués.
</p>
<p>
Commençons par un simple formulaire de connexion...
<pre>
&lt;form&gt;
Username:
&lt;input type="text" name="u" value="" /&gt;&lt;br /&gt;
Password:
&lt;input type="password" name="p" value="" /&gt;&lt;br /&gt;
&lt;input type="submit" value="Log in" /&gt;
&lt;/form&gt;
</pre>
Lequel doit ressembler à...
</p>
<p>
<form class="demo">
Username:
<input type="text" name="u" value=""><br>
Password:
<input type="password" name="p" value=""><br>
<input type="submit" value="Log in">
</form>
</p>
<p>
Supposons que, durant le chargement de la page,
un cookie ait été inscrit avec un numéro d'identifiant de session.
Nous n'allons pas encore remplir le formulaire,
juste tester que nous pistons bien l'utilisateur.
Voici le test...
<pre>
class LogInTest extends WebTestCase {
function testSessionCookieSetBeforeForm() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$this-&gt;assertCookie('SID');</strong>
}
}
</pre>
Nous nous contentons ici de vérifier que le cookie a bien été défini.
Etant donné que sa valeur est plutôt énigmatique,
elle ne vaudrait pas la peine d'être testée avec...
<pre>
class LogInTest extends WebTestCase {
function testSessionCookieIsCorrectPattern() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;assertCookie('SID', <strong>new PatternExpectation('/[a-f0-9]{32}/i')</strong>);
}
}
</pre>
Si vous utilisez PHP pour gérer vos sessions alors
ce test est encore plus inutile, étant donné qu'il ne fait
que tester PHP lui-même.
</p>
<p>
Le test le plus simple pour vérifier que la connexion a bien eu lieu
reste d'inspecter visuellement la page suivante :
un simple appel à <span class="new_code">WebTestCase::assertText()</span> et le tour est joué.
</p>
<p>
Le reste du test est le même que dans n'importe quel autre formulaire,
mais nous pourrions souhaiter nous assurer
que le cookie n'a pas été modifié depuis la phase de connexion.
Voici comment cela pourrait être testé :
<pre>
class LogInTest extends WebTestCase {
...
function testSessionCookieSameAfterLogIn() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$session = $this-&gt;getCookie('SID');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;clickSubmit('Log in');
$this-&gt;assertWantedPattern('/Welcome Me/');
$this-&gt;assertCookie('SID', $session);</strong>
}
}
</pre>
Ceci confirme que l'identifiant de session
est identique avant et après la connexion.
</p>
<p>
Nous pouvons même essayer de duper notre propre système
en créant un cookie arbitraire pour se connecter...
<pre>
class LogInTest extends WebTestCase {
...
function testSessionCookieSameAfterLogIn() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$this-&gt;setCookie('SID', 'Some other session');
$this-&gt;get('http://www.my-site.com/restricted.php');</strong>
$this-&gt;assertWantedPattern('/Access denied/');
}
}
</pre>
Votre site est-il protégé contre ce type d'attaque ?
</p>
<h2>
<a class="target" name="session"></a>Sessions de navigateur</h2>
<p>
Si vous testez un système d'authentification,
la reconnexion par un utilisateur est un point sensible.
Essayons de simuler ce qui se passe dans ce cas :
<pre>
class LogInTest extends WebTestCase {
...
function testLoseAuthenticationAfterBrowserClose() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;clickSubmit('Log in');
$this-&gt;assertWantedPattern('/Welcome Me/');<strong>
$this-&gt;restart();
$this-&gt;get('http://www.my-site.com/restricted.php');
$this-&gt;assertWantedPattern('/Access denied/');</strong>
}
}
</pre>
La méthode <span class="new_code">WebTestCase::restart()</span> préserve
les cookies dont le timeout n'a pas expiré,
mais jette les cookies temporaires ou expirés.
Vous pouvez spécifier l'heure et la date de leur réactivation.
</p>
<p>
L'expiration des cookies peut être un problème.
Si vous avez un cookie qui doit expirer au bout d'une heure,
nous n'allons pas mettre le test en veille en attendant
que le cookie expire...
</p>
<p>
Afin de provoquer leur expiration,
vous pouvez dater manuellement les cookies,
avant le début de la session.
<pre>
class LogInTest extends WebTestCase {
...
function testLoseAuthenticationAfterOneHour() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;clickSubmit('Log in');
$this-&gt;assertWantedPattern('/Welcome Me/');
<strong>
$this-&gt;ageCookies(3600);</strong>
$this-&gt;restart();
$this-&gt;get('http://www.my-site.com/restricted.php');
$this-&gt;assertWantedPattern('/Access denied/');
}
}
</pre>
Après le redémarrage, les cookies seront plus vieux
d'une heure et que tous ceux dont la date d'expiration
sera passée auront disparus.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API du développeur pour SimpleTest</a> donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,500 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : le composant de navigation web scriptable</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le navigateur scriptable</h1>
This page...
<ul>
<li>
Utiliser le <a href="#scripting">navigateur web dans des scripts</a>
</li>
<li>
<a href="#deboguer">Déboguer</a> les erreurs sur les pages
</li>
<li>
<a href="#unit">Tests complexes avec des navigateurs web multiples</a>
</li>
</ul>
<div class="content">
<p>
Le composant de navigation web de SimpleTest peut être utilisé
non seulement à l'extérieur de la classe <span class="new_code">WebTestCase</span>,
mais aussi indépendamment du framework SimpleTest lui-même.
</p>
<h2>
<a class="target" name="script"></a>Le navigateur scriptable</h2>
<p>
Vous pouvez utiliser le navigateur web dans des scripts PHP
pour confirmer que des services marchent bien comme il faut
ou pour extraire des informations à partir de ceux-ci de façon régulière.
Par exemple, voici un petit script pour extraire
le nombre de bogues ouverts dans PHP 5 à partir
du <a href="http://www.php.net/">site web PHP</a>...
<pre>
&lt;?php
require_once('simpletest/browser.php');
$browser = &amp;new SimpleBrowser();
$browser-&gt;get('http://php.net/');
$browser-&gt;clickLink('reporting bugs');
$browser-&gt;clickLink('statistics');
$browser-&gt;clickLink('PHP 5 bugs only');
$page = $browser-&gt;getContent();
preg_match('/status=Open.*?by=Any.*?(\d+)&lt;\/a&gt;/', $page, $matches);
print $matches[1];
?&gt;
</pre>
Bien sûr Il y a des méthodes plus simple pour réaliser
cet exemple en PHP. Par exemple, vous pourriez juste
utiliser la commande PHP <span class="new_code">file()</span> sur ce qui est
ici une page fixe. Cependant, en utilisant des scripts
avec le navigateur web vous vous autorisez l'authentification,
la gestion des cookies, le chargement automatique des fenêtres,
les redirections, la transmission de formulaires et la capacité
d'examiner les entêtes.
</p>
<p>
Ces méthodes qui se basent sur le contenu textuel des pages
sont fragiles dans un site en constante évolution
et vous voudrez employer une méthode plus directe
pour accéder aux données de façon permanente,
mais pour des tâches simples cette technique peut s'avérer
une solution très rapide.
</p>
<p>
Toutes les méthode de navigation utilisées dans <a href="web_tester_documentation.html">WebTestCase</a> sont présente dans la classe <span class="new_code">SimpleBrowser</span>, mais les assertions sont remplacées par de simples accesseurs. Voici une liste complète des méthodes de navigation de page à page...
<table><tbody>
<tr>
<td><span class="new_code">addHeader($header)</span></td>
<td>Ajouter une entête à chaque téléchargement</td>
</tr>
<tr>
<td><span class="new_code">useProxy($proxy, $username, $password)</span></td>
<td>Utilise ce proxy à partir de maintenant</td>
</tr>
<tr>
<td><span class="new_code">head($url, $parameters)</span></td>
<td>Effectue une requête HEAD</td>
</tr>
<tr>
<td><span class="new_code">get($url, $parameters)</span></td>
<td>Télécharge une page avec un GET</td>
</tr>
<tr>
<td><span class="new_code">post($url, $parameters)</span></td>
<td>Télécharge une page avec un POST</td>
</tr>
<tr>
<td><span class="new_code">click($label)</span></td>
<td>Suit un lien visible ou un bouton texte par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">clickLink($label)</span></td>
<td>Suit un lien par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">isLink($label)</span></td>
<td>Vérifie l'existance d'un lien par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">clickLinkById($id)</span></td>
<td>Suit un lien par son attribut d'identification</td>
</tr>
<tr>
<td><span class="new_code">isLinkById($id)</span></td>
<td>Vérifie l'existance d'un lien par son attribut d'identification</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>La page ou la fenêtre URL en cours</td>
</tr>
<tr>
<td><span class="new_code">getTitle()</span></td>
<td>Le titre de la page</td>
</tr>
<tr>
<td><span class="new_code">getContent()</span></td>
<td>Le page ou la fenêtre brute</td>
</tr>
<tr>
<td><span class="new_code">getContentAsText()</span></td>
<td>Sans code HTML à l'exception du text "alt"</td>
</tr>
<tr>
<td><span class="new_code">retry()</span></td>
<td>Répète la dernière requête</td>
</tr>
<tr>
<td><span class="new_code">back()</span></td>
<td>Utilise le bouton "précédent" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">forward()</span></td>
<td>Utilise le bouton "suivant" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">authenticate($username, $password)</span></td>
<td>Retente la page ou la fenêtre après une réponse 401</td>
</tr>
<tr>
<td><span class="new_code">restart($date)</span></td>
<td>Relance le navigateur pour une nouvelle session</td>
</tr>
<tr>
<td><span class="new_code">ageCookies($interval)</span></td>
<td>Change la date des cookies</td>
</tr>
<tr>
<td><span class="new_code">setCookie($name, $value)</span></td>
<td>Lance un nouveau cookie</td>
</tr>
<tr>
<td><span class="new_code">getCookieValue($host, $path, $name)</span></td>
<td>Lit le cookie le plus spécifique</td>
</tr>
<tr>
<td><span class="new_code">getCurrentCookieValue($name)</span></td>
<td>Lit le contenue du cookie en cours</td>
</tr>
</tbody></table>
Les méthode <span class="new_code">SimpleBrowser::useProxy()</span> et
<span class="new_code">SimpleBrowser::addHeader()</span> sont spéciales.
Une fois appelées, elles continuent à s'appliquer sur les téléchargements suivants.
</p>
<p>
Naviguer dans les formulaires est similaire à la <a href="form_testing_documentation.html">navigation des formulaires via WebTestCase</a>...
<table><tbody>
<tr>
<td><span class="new_code">setField($label, $value)</span></td>
<td>Modifie tous les champs avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">setFieldByName($name, $value)</span></td>
<td>Modifie tous les champs avec ce nom</td>
</tr>
<tr>
<td><span class="new_code">setFieldById($id, $value)</span></td>
<td>Modifie tous les champs avec cet identifiant</td>
</tr>
<tr>
<td><span class="new_code">getField($label)</span></td>
<td>Accesseur de la valeur d'un élément de formulaire avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">getFieldByName($name)</span></td>
<td>Accesseur de la valeur d'un élément de formulaire avec ce nom</td>
</tr>
<tr>
<td><span class="new_code">getFieldById($id)</span></td>
<td>Accesseur de la valeur de l'élément de formulaire avec cet identifiant</td>
</tr>
<tr>
<td><span class="new_code">clickSubmit($label)</span></td>
<td>Transmet le formulaire avec l'étiquette de son bouton</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitByName($name)</span></td>
<td>Transmet le formulaire avec l'attribut de son bouton</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitById($id)</span></td>
<td>Transmet le formulaire avec l'identifiant de son bouton</td>
</tr>
<tr>
<td><span class="new_code">clickImage($label, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son titre (title="*") our son texte alternatif (alt="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageByName($name, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son attribut (name="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageById($id, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son identifiant (id="*")</td>
</tr>
<tr>
<td><span class="new_code">submitFormById($id)</span></td>
<td>Transmet le formulaire par son identifiant propre</td>
</tr>
</tbody></table>
Au jourd d'aujourd'hui il n'existe pas beaucoup de méthodes pour lister
les formulaires et les champs disponibles.
<table><tbody>
<tr>
<td><span class="new_code">isClickable($label)</span></td>
<td>Vérifie si un lien existe avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">isSubmit($label)</span></td>
<td>Vérifie si un bouton existe avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">isImage($label)</span></td>
<td>Vérifie si un bouton image existe avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">getLink($label)</span></td>
<td>Trouve une URL à partir de son label</td>
</tr>
<tr>
<td><span class="new_code">getLinkById($label)</span></td>
<td>Trouve une URL à partir de son identifiant</td>
</tr>
<tr>
<td><span class="new_code">getUrls()</span></td>
<td>Liste l'ensemble des liens de la page courante</td>
</tr>
</tbody></table>
Ce sera probablement
ajouté dans des versions successives de SimpleTest.
</p>
<p>
A l'intérieur d'une page, les fenêtres individuelles peuvent être
sélectionnées. Si aucune sélection n'est réalisée alors
toutes les fenêtres sont fusionnées ensemble dans
une unique et grande page.
Le contenu de la page en cours sera une concaténation des
toutes les fenêtres dans l'ordre spécifié par les balises "frameset".
<table><tbody>
<tr>
<td><span class="new_code">getFrames()</span></td>
<td>Un déchargement de la structure de la fenêtre courante</td>
</tr>
<tr>
<td><span class="new_code">getFrameFocus()</span></td>
<td>L'index ou l'étiquette de la fenêtre en courante</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocusByIndex($choice)</span></td>
<td>Sélectionne la fenêtre numérotée à partir de 1</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocus($name)</span></td>
<td>Sélectionne une fenêtre par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">clearFrameFocus()</span></td>
<td>Traite toutes les fenêtres comme une seule page</td>
</tr>
</tbody></table>
Lorsqu'on est focalisé sur une fenêtre unique,
le contenu viendra de celle-ci uniquement.
Cela comprend les liens à cliquer et les formulaires à transmettre.
</p>
<h2>
<a class="target" name="deboguer"></a>Où sont les erreurs ?</h2>
<p>
Toute cette masse de fonctionnalités est géniale
lorsqu'on arrive à bien télécharger les pages,
mais ce n'est pas toujours évident.
Pour aider à découvrir les erreurs, le navigateur a aussi
des méthodes pour aider au débogage.
<table><tbody>
<tr>
<td><span class="new_code">setConnectionTimeout($timeout)</span></td>
<td>Ferme la socket avec un délai trop long</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>L'URL de la page chargée le plus récemment</td>
</tr>
<tr>
<td><span class="new_code">getRequest()</span></td>
<td>L'entête de la requête brute de la page ou de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getHeaders()</span></td>
<td>L'entête de réponse de la page ou de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getTransportError()</span></td>
<td>N'importe quel erreur au niveau de la socket dans le dernier téléchargement</td>
</tr>
<tr>
<td><span class="new_code">getResponseCode()</span></td>
<td>La réponse HTTP de la page ou de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getMimeType()</span></td>
<td>Le type Mime de la page our de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getAuthentication()</span></td>
<td>Le type d'authentification dans l'entête d'une provocation 401</td>
</tr>
<tr>
<td><span class="new_code">getRealm()</span></td>
<td>Le realm d'authentification dans l'entête d'une provocation 401</td>
</tr>
<tr>
<td><span class="new_code">getBaseUrl()</span></td>
<td>Uniquement la base de l'URL de la page chargée le plus récemment</td>
</tr>
<tr>
<td><span class="new_code">setMaximumRedirects($max)</span></td>
<td>Nombre de redirections avant que la page ne soit chargée automatiquement</td>
</tr>
<tr>
<td><span class="new_code">setMaximumNestedFrames($max)</span></td>
<td>Protection contre des framesets récursifs</td>
</tr>
<tr>
<td><span class="new_code">ignoreFrames()</span></td>
<td>Neutralise le support des fenêtres</td>
</tr>
<tr>
<td><span class="new_code">useFrames()</span></td>
<td>Autorise le support des fenêtres</td>
</tr>
</tbody></table>
Les méthodes <span class="new_code">SimpleBrowser::setConnectionTimeout()</span>,
<span class="new_code">SimpleBrowser::setMaximumRedirects()</span>,
<span class="new_code">SimpleBrowser::setMaximumNestedFrames()</span>,
<span class="new_code">SimpleBrowser::ignoreFrames()</span>
et <span class="new_code">SimpleBrowser::useFrames()</span> continuent à s'appliquer
sur toutes les requêtes suivantes.
Les autres méthodes tiennent compte des fenêtres.
Cela veut dire que si une fenêtre individuelle ne se charge pas,
il suffit de se diriger vers elle avec
<span class="new_code">SimpleBrowser::setFrameFocus()</span> : ensuite on utilisera
<span class="new_code">SimpleBrowser::getRequest()</span>, etc. pour voir ce qui se passe.
</p>
<h2>
<a class="target" name="unit"></a>Tests unitaires complexes avec des navigateurs multiples</h2>
<p>
Tout ce qui peut être fait dans
<a href="web_tester_documentation.html">WebTestCase</a> peut maintenant
être fait dans un <a href="unit_tester_documentation.html">UnitTestCase</a>.
Ce qui revient à dire que nous pouvons librement mélanger
des tests sur des objets de domaine avec l'interface web...
<pre><strong>
class TestOfRegistration extends UnitTestCase {
function testNewUserAddedToAuthenticator() {</strong>
$browser = new SimpleBrowser();
$browser-&gt;get('http://my-site.com/register.php');
$browser-&gt;setField('email', 'me@here');
$browser-&gt;setField('password', 'Secret');
$browser-&gt;clickSubmit('Register');
<strong>
$authenticator = new Authenticator();
$member = $authenticator-&gt;findByEmail('me@here');
$this-&gt;assertEqual($member-&gt;getPassword(), 'Secret');</strong>
}
}
</pre>
Bien que ça puisse être utile par convenance temporaire,
je ne suis pas fan de ce genre de test. Ce test s'applique
à plusieurs couches de l'application, ça implique qu'il est
plus que probable qu'il faudra le remanier lorsque le code changera.
</p>
<p>
Un cas plus utile d'utilisation directe du navigateur est
le moment où le <span class="new_code">WebTestCase</span> ne peut plus suivre.
Un exemple ? Quand deux navigateurs doivent être utilisés en même temps.
</p>
<p>
Par exemple, supposons que nous voulions interdire
des usages simultanés d'un site avec le même login d'identification.
Ce scénario de test le vérifie...
<pre>
class TestOfSecurity extends UnitTestCase {
function testNoMultipleLoginsFromSameUser() {
$first = &amp;new SimpleBrowser();
$first-&gt;get('http://my-site.com/login.php');
$first-&gt;setField('name', 'Me');
$first-&gt;setField('password', 'Secret');
$first-&gt;clickSubmit('Enter');
$this-&gt;assertEqual($first-&gt;getTitle(), 'Welcome');
$second = &amp;new SimpleBrowser();
$second-&gt;get('http://my-site.com/login.php');
$second-&gt;setField('name', 'Me');
$second-&gt;setField('password', 'Secret');
$second-&gt;clickSubmit('Enter');
$this-&gt;assertEqual($second-&gt;getTitle(), 'Access Denied');
}
}
</pre>
Vous pouvez aussi utiliser la classe <span class="new_code">SimpleBrowser</span>
quand vous souhaitez écrire des scénarios de test en utilisant
un autre outil que SimpleTest, comme PHPUnit par exemple.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API de développeur pour SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,84 +0,0 @@
body {
padding-left: 3%;
padding-right: 3%;
}
pre {
font-family: "courier new", courier;
font-size: 80%;
border: 1px solid;
background-color: #cccccc;
padding: 5px;
margin-left: 5%;
margin-right: 8%;
}
.code, .new_code, pre.new_code {
font-weight: bold;
}
div.copyright {
font-size: 80%;
color: gray;
}
div.copyright a {
color: gray;
}
ul.api {
padding-left: 0em;
padding-right: 25%;
}
ul.api li {
margin-top: 0.2em;
margin-bottom: 0.2em;
list-style: none;
text-indent: -3em;
padding-left: 3em;
}
div.demo {
border: 4px ridge;
border-color: gray;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: white;
}
div.demo span.fail {
color: red;
}
div.demo span.pass {
color: green;
}
div.demo h1 {
font-size: 12pt;
text-align: left;
font-weight: bold;
}
table {
border: 2px outset;
border-color: gray;
background-color: white;
margin: 5px;
margin-left: 5%;
margin-right: 5%;
}
td {
font-size: 80%;
}
.shell {
color: white;
}
pre.shell {
border: 4px ridge;
border-color: gray;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: black;
}
form.demo {
background-color: lightgray;
border: 4px outset;
border-color: lightgray;
padding: 10px;
margin-right: 40%;
}

View File

@ -1,451 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : étendre le testeur unitaire avec des classes d'attentes supplémentaires</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les attentes</h1>
This page...
<ul>
<li>
Utiliser les attentes <a href="#fantaisie">pour des tests
plus précis avec des objets fantaisie</a>
</li>
<li>
<a href="#comportement">Changer le comportement d'un objet fantaisie</a>
avec des attentes
</li>
<li>
<a href="#etendre">Créer des attentes</a>
</li>
<li>
Par dessous SimpleTest <a href="#unitaire">utilise des classes d'attente</a>
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="fantaisie"></a>Plus de contrôle sur les objets fantaisie</h2>
<p>
Le comportement par défaut des
<a href="mock_objects_documentation.html">objets fantaisie</a> dans
<a href="http://sourceforge.net/projects/simpletest/">SimpleTest</a>
est soit une correspondance identique sur l'argument,
soit l'acceptation de n'importe quel argument.
Pour la plupart des tests, c'est suffisant.
Cependant il est parfois nécessaire de ramollir un scénario de test.
</p>
<p>
Un des endroits où un test peut être trop serré
est la reconnaissance textuelle. Prenons l'exemple
d'un composant qui produirait un message d'erreur
utile lorsque quelque chose plante. Il serait utile de tester
que l'erreur correcte est renvoyée,
mais le texte proprement dit risque d'être plutôt long.
Si vous testez le texte dans son ensemble alors
à chaque modification de ce même message
-- même un point ou une virgule -- vous aurez
à revenir sur la suite de test pour la modifier.
</p>
<p>
Voici un cas concret, nous avons un service d'actualités
qui a échoué dans sa tentative de connexion à sa source distante.
<pre>
<strong>class NewsService {
...
function publish($writer) {
if (! $this-&gt;isConnected()) {
$writer-&gt;write('Cannot connect to news service "' .
$this-&gt;_name . '" at this time. ' .
'Please try again later.');
}
...
}
}</strong>
</pre>
Là il envoie son contenu vers un classe <span class="new_code">Writer</span>.
Nous pourrions tester ce comportement avec un <span class="new_code">MockWriter</span>...
<pre>
class TestOfNewsService extends UnitTestCase {
...
function testConnectionFailure() {<strong>
$writer = new MockWriter($this);
$writer-&gt;expectOnce('write', array(
'Cannot connect to news service ' .
'"BBC News" at this time. ' .
'Please try again later.'));
$service = new NewsService('BBC News');
$service-&gt;publish($writer);
$writer-&gt;tally();</strong>
}
}
</pre>
C'est un bon exemple d'un test fragile.
Si nous décidons d'ajouter des instructions complémentaires,
par exemple proposer une source d'actualités alternative,
nous casserons nos tests par la même occasion sans pourtant
avoir modifié une seule fonctionnalité.
</p>
<p>
Pour contourner ce problème, nous voudrions utiliser
un test avec une expression rationnelle plutôt
qu'une correspondance exacte. Nous pouvons y parvenir avec...
<pre>
class TestOfNewsService extends UnitTestCase {
...
function testConnectionFailure() {
$writer = new MockWriter($this);<strong>
$writer-&gt;expectOnce(
'write',
array(new PatternExpectation('/cannot connect/i')));</strong>
$service = new NewsService('BBC News');
$service-&gt;publish($writer);
$writer-&gt;tally();
}
}
</pre>
Plutôt que de transmettre le paramètre attendu au <span class="new_code">MockWriter</span>,
nous envoyons une classe d'attente appelée <span class="new_code">PatternExpectation</span>.
L'objet fantaisie est suffisamment élégant pour reconnaître
qu'il s'agit d'un truc spécial et pour le traiter différemment.
Plutôt que de comparer l'argument entrant à cet objet,
il utilise l'objet attente lui-même pour exécuter le test.
</p>
<p>
<span class="new_code">PatternExpectation</span> utilise
l'expression rationnelle pour la comparaison avec son constructeur.
A chaque fois qu'une comparaison est fait à travers
<span class="new_code">MockWriter</span> par rapport à cette classe attente,
elle fera un <span class="new_code">preg_match()</span> avec ce motif.
Dans notre scénario de test ci-dessus, aussi longtemps
que la chaîne "cannot connect" apparaît dans le texte,
la fantaisie transmettra un succès au testeur unitaire.
Peu importe le reste du texte.
</p>
<p>
Les classes attente possibles sont...
<table><tbody>
<tr>
<td><span class="new_code">AnythingExpectation</span></td>
<td>Sera toujours validé</td>
</tr>
<tr>
<td><span class="new_code">EqualExpectation</span></td>
<td>Une égalité, plutôt que la plus forte comparaison à l'identique</td>
</tr>
<tr>
<td><span class="new_code">NotEqualExpectation</span></td>
<td>Une comparaison sur la non-égalité</td>
</tr>
<tr>
<td><span class="new_code">IndenticalExpectation</span></td>
<td>La vérification par défaut de l'objet fantaisie qui doit correspondre exactement</td>
</tr>
<tr>
<td><span class="new_code">NotIndenticalExpectation</span></td>
<td>Inverse la logique de l'objet fantaisie</td>
</tr>
<tr>
<td><span class="new_code">PatternExpectation</span></td>
<td>Utilise une expression rationnelle Perl pour comparer une chaîne</td>
</tr>
<tr>
<td><span class="new_code">NoPatternExpectation</span></td>
<td>Passe seulement si l'expression rationnelle Perl échoue</td>
</tr>
<tr>
<td><span class="new_code">IsAExpectation</span></td>
<td>Vérifie le type ou le nom de la classe uniquement</td>
</tr>
<tr>
<td><span class="new_code">NotAExpectation</span></td>
<td>L'opposé de <span class="new_code">IsAExpectation</span>
</td>
</tr>
<tr>
<td><span class="new_code">MethodExistsExpectation</span></td>
<td>Vérifie si la méthode est disponible sur un objet</td>
</tr>
<tr>
<td><span class="new_code">TrueExpectation</span></td>
<td>Accepte n'importe quelle variable PHP qui vaut vrai</td>
</tr>
<tr>
<td><span class="new_code">FalseExpectation</span></td>
<td>Accepte n'importe quelle variable PHP qui vaut faux</td>
</tr>
</tbody></table>
La plupart utilisent la valeur attendue dans le constructeur.
Les exceptions sont les vérifications sur motif,
qui utilisent une expression rationnelle, ainsi que
<span class="new_code">IsAExpectation</span> et <span class="new_code">NotAExpectation</span>,
qui prennent un type ou un nom de classe comme chaîne.
</p>
<h2>
<a class="target" name="comportement"></a>Utiliser les attentes pour contrôler les bouchons serveur</h2>
<p>
Les classes attente peuvent servir à autre chose
que l'envoi d'assertions depuis les objets fantaisie,
afin de choisir le comportement d'un
<a href="mock_objects_documentation.html">objet fantaisie</a>
ou celui d'un <a href="server_stubs_documentation.html">bouchon serveur</a>.
A chaque fois qu'une liste d'arguments est donnée,
une liste d'objets d'attente peut être insérée à la place.
</p>
<p>
Mettons que nous voulons qu'un bouchon serveur
d'autorisation simule une connexion réussie seulement
si il reçoit un objet de session valide.
Nous pouvons y arriver avec ce qui suit...
<pre>
Stub::generate('Authorisation');
<strong>
$authorisation = new StubAuthorisation();
$authorisation-&gt;returns(
'isAllowed',
true,
array(new IsAExpectation('Session', 'Must be a session')));
$authorisation-&gt;returns('isAllowed', false);</strong>
</pre>
Le comportement par défaut du bouchon serveur
est défini pour renvoyer <span class="new_code">false</span>
quand <span class="new_code">isAllowed</span> est appelé.
Lorsque nous appelons cette méthode avec un unique paramètre
qui est un objet <span class="new_code">Session</span>, il renverra <span class="new_code">true</span>.
Nous avons aussi ajouté un deuxième paramètre comme message.
Il sera affiché dans le message d'erreur de l'objet fantaisie
si l'attente est la cause de l'échec.
</p>
<p>
Ce niveau de sophistication est rarement utile :
il n'est inclut que pour être complet.
</p>
<h2>
<a class="target" name="etendre"></a>Créer vos propres attentes</h2>
<p>
Les classes d'attentes ont une structure très simple.
Tellement simple qu'il devient très simple de créer
vos propres version de logique pour des tests utilisés couramment.
</p>
<p>
Par exemple voici la création d'une classe pour tester
la validité d'adresses IP. Pour fonctionner correctement
avec les bouchons serveurs et les objets fantaisie,
cette nouvelle classe d'attente devrait étendre
<span class="new_code">SimpleExpectation</span> ou une autre de ses sous-classes...
<pre>
<strong>class ValidIp extends SimpleExpectation {
function test($ip) {
return (ip2long($ip) != -1);
}
function testMessage($ip) {
return "Address [$ip] should be a valid IP address";
}
}</strong>
</pre>
Il n'y a véritablement que deux méthodes à mettre en place.
La méthode <span class="new_code">test()</span> devrait renvoyer un <span class="new_code">true</span>
si l'attente doit passer, et une erreur <span class="new_code">false</span>
dans le cas contraire. La méthode <span class="new_code">testMessage()</span>
ne devrait renvoyer que du texte utile à la compréhension du test en lui-même.
</p>
<p>
Cette classe peut désormais être employée à la place
des classes d'attente précédentes.
</p>
<p>
Voici un exemple plus typique, vérifier un hash...
<pre>
<strong>class JustField extends EqualExpectation {
private $key;
function __construct($key, $expected) {
parent::__construct($expected);
$this-&gt;key = $key;
}
function test($compare) {
if (! isset($compare[$this-&gt;key])) {
return false;
}
return parent::test($compare[$this-&gt;key]);
}
function testMessage($compare) {
if (! isset($compare[$this-&gt;key])) {
return 'Key [' . $this-&gt;key . '] does not exist';
}
return 'Key [' . $this-&gt;key . '] -&gt; ' .
parent::testMessage($compare[$this-&gt;key]);
}
}</strong>
</pre>
L'habitude a été prise pour séparer les clauses du message avec
"&amp;nbsp;-&gt;&amp;nbsp;".
Cela permet aux outils dérivés de reformater la sortie.
</p>
<p>
Supposons qu'un authentificateur s'attend à recevoir
une ligne de base de données correspondant à l'utilisateur,
et que nous avons juste besoin de valider le nom d'utilisateur.
Nous pouvons le faire très simplement avec...
<pre>
$mock-&gt;expectOnce('authenticate',
array(new JustKey('username', 'marcus')));
</pre>
</p>
<h2>
<a class="target" name="unitaire"></a>Sous le capot du testeur unitaire</h2>
<p>
Le <a href="http://sourceforge.net/projects/simpletest/">framework
de test unitaire SimpleTest</a> utilise aussi dans son coeur
des classes d'attente pour
la <a href="unit_test_documentation.html">classe UnitTestCase</a>.
Nous pouvons aussi tirer parti de ces mécanismes pour réutiliser
nos propres classes attente à l'intérieur même des suites de test.
</p>
<p>
La méthode la plus directe est d'utiliser la méthode
<span class="new_code">SimpleTest::assert()</span> pour effectuer le test...
<pre>
<strong>class TestOfNetworking extends UnitTestCase {
...
function testGetValidIp() {
$server = &amp;new Server();
$this-&gt;assert(
new ValidIp(),
$server-&gt;getIp(),
'Server IP address-&gt;%s');
}
}</strong>
</pre>
<span class="new_code">assert()</span> testera toute attente directement.
</p>
<p>
C'est plutôt sale par rapport à notre syntaxe habituelle
du type <span class="new_code">assert...()</span>.
</p>
<p>
Pour un cas aussi simple, nous créons d'ordinaire une méthode
d'assertion distincte en utilisant la classe d'attente.
Supposons un instant que notre attente soit un peu plus
compliquée et que par conséquent nous souhaitions la réutiliser,
nous obtenons...
<pre>
class TestOfNetworking extends UnitTestCase {
...<strong>
function assertValidIp($ip, $message = '%s') {
$this-&gt;assertExpectation(new ValidIp(), $ip, $message);
}</strong>
function testGetValidIp() {
$server = &amp;new Server();<strong>
$this-&gt;assertValidIp(
$server-&gt;getIp(),
'Server IP address-&gt;%s');</strong>
}
}
</pre>
It is rare to need the expectations for more than pattern
matching, but these facilities do allow testers to build
some sort of domain language for testing their application.
Also, complex expectation classes could make the tests
harder to read and debug.
In effect extending the test framework to create their own tool set.
Il est assez rare que le besoin d'une attente dépasse
le stade de la reconnaissance d'un motif, mais ils permettent
aux testeurs de construire leur propre langage dédié ou DSL
(Domain Specific Language) pour tester leurs applications.
Attention, les classes d'attente complexes peuvent rendre
les tests difficiles à lire et à déboguer.
Ces mécanismes sont véritablement là pour les auteurs
de système qui étendront le framework de test
pour leurs propres outils de test.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
Les attentes imitent les contraintes dans
<a href="http://www.jmock.org/">JMock</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API complète pour SimpleTest</a>
réalisé avec PHPDoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,363 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : tester des formulaires HTML</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les tests de formulaire</h1>
This page...
<ul>
<li>
Modifier les valeurs d'un formulaire et
<a href="#submit">réussir à transmettre un simple formulaire</a>
</li>
<li>
Gérer des <a href="#multiple">objets à valeurs multiples</a>
en initialisant des listes.
</li>
<li>
Le cas des formulaires utilisant Javascript pour
modifier <a href="#hidden-field">un champ caché</a>
</li>
<li>
<a href="#brut">Envoi brut</a> quand il n'existe pas de bouton à cliquer.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="submit"></a>Valider un formulaire simple</h2>
<p>
Lorsqu'une page est téléchargée par <span class="new_code">WebTestCase</span>
en utilisant <span class="new_code">get()</span> ou <span class="new_code">post()</span>
le contenu de la page est automatiquement analysé.
De cette analyse découle le fait que toutes les commandes
à l'intérieur de la balise &lt;form&gt; sont disponibles
depuis l'intérieur du scénario de test.
Prenons par exemple cet extrait de code HTML...
<pre>
&lt;form&gt;
&lt;input type="text" name="a" value="A default" /&gt;
&lt;input type="submit" value="Go" /&gt;
&lt;/form&gt;
</pre>
Il ressemble à...
</p>
<p>
<form class="demo">
<input type="text" name="a" value="A default">
<input type="submit" value="Go">
</form>
</p>
<p>
Nous pouvons naviguer vers ce code, via le site
<a href="http://www.lastcraft.com/form_testing_documentation.php">LastCraft</a>,
avec le test suivant...
<pre>
class SimpleFormTests extends WebTestCase {<strong>
function testDefaultValue() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('a', 'A default');
}</strong>
}
</pre>
Directement après le chargement de la page toutes les commandes HTML
sont initiées avec leur valeur par défaut, comme elles apparaîtraient
dans un navigateur web. L'assertion teste qu'un objet HTML
avec le nom "a" existe dans la page
et qu'il contient la valeur "A default".
</p>
<p>
Nous pourrions retourner le formulaire tout de suite...
<pre>
class SimpleFormTests extends WebTestCase {
function testDefaultValue() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('a', <strong>new PatternExpectation('/default/')</strong>);
}
}
</pre>
Mais d'abord nous allons changer la valeur du champ texte.
Ce n'est qu'après que nous le transmettrons...
<pre>
class SimpleFormTests extends WebTestCase {
function testDefaultValue() {
$this-&gt;get('http://www.my-site.com/');
$this-&gt;assertField('a', 'A default');<strong>
$this-&gt;setField('a', 'New value');
$this-&gt;clickSubmit('Go');</strong>
}
}
</pre>
Parce que nous n'avons spécifié ni attribut "method"
sur la balise form, ni attribut "action",
le scénario de test suivra le comportement classique d'un navigateur :
transmission des données avec une requête <em>GET</em>
vers la même page. En règle générale SimpleTest essaie d'émuler
le comportement typique d'un navigateur autant que possible,
plutôt que d'essayer d'attraper des attributs manquants sur les balises.
La raison est simple : la cible d'un framework de test est
la logique d'une application PHP, pas les erreurs
-- de syntaxe ou autres -- du code HTML.
Pour les erreurs HTML, d'autres outils tel
<a href="http://www.w3.org/People/Raggett/tidy/">HTMLTidy</a>
devraient être employés, ou même n'importe lequel des validateurs HTML et CSS
déjà sur le marché.
</p>
<p>
Si un champ manque dans n'importe quel formulaire ou si
une option est indisponible alors <span class="new_code">WebTestCase::setField()</span>
renverra <span class="new_code">false</span>. Par exemple, supposons que
nous souhaitons vérifier qu'une option "Superuser"
n'est pas présente dans ce formulaire...
<pre>
<strong>Select type of user to add:</strong>
&lt;select name="type"&gt;
&lt;option&gt;Subscriber&lt;/option&gt;
&lt;option&gt;Author&lt;/option&gt;
&lt;option&gt;Administrator&lt;/option&gt;
&lt;/select&gt;
</pre>
Qui ressemble à...
</p>
<p>
<form class="demo">
<strong>Select type of user to add:</strong>
<select name="type">
<option>Subscriber</option>
<option>Author</option>
<option>Administrator</option>
</select>
</form>
</p>
<p>
Le test suivant le confirmera...
<pre>
class SimpleFormTests extends WebTestCase {
...
function testNoSuperuserChoiceAvailable() {<strong>
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertFalse($this-&gt;setField('type', 'Superuser'));</strong>
}
}
</pre>
La sélection ne sera pas changée si la nouvelle valeur n'est pas une des options.
</p>
<p>
Voici la liste complète des objets supportés à aujourd'hui...
<ul>
<li>Champs texte, y compris les champs masqués (hidden) ou cryptés (password).</li>
<li>Boutons submit, en incluant aussi la balise button, mais pas encore les boutons reset</li>
<li>Aires texte (textarea) avec leur gestion des retours à la ligne (wrap).</li>
<li>Cases à cocher, y compris les cases à cocher multiples dans un même formulaire.</li>
<li>Listes à menu déroulant, y compris celles à sélections multiples.</li>
<li>Boutons radio.</li>
<li>Images.</li>
</ul>
</p>
<p>
Le navigateur proposé par SimpleTest émule les actions
qui peuvent être réalisées par un utilisateur sur
une page HTML standard. Javascript n'est pas supporté et
il y a peu de chance pour qu'il le soit prochainement.
</p>
<p>
Une attention particulière doit être porté aux techniques Javascript
qui changent la valeur d'un champ caché : elles ne peuvent pas être
réalisées avec les commandes classiques de SimpleTest.
Une méthode alternative est proposée plus loin.
</p>
<h2>
<a class="target" name="multiple"></a>Champs à valeurs multiples</h2>
<p>
SimpleTest peut gérer deux types de commandes à valeur multiple :
les menus déroulants à sélection multiple et les cases à cocher
avec le même nom à l'intérieur même d'un formulaire.
La nature de ceux-ci implique que leur initialisation
et leur test sont légèrement différents.
Voici un exemple avec des cases à cocher...
<pre>
&lt;form class="demo"&gt;
<strong>Create privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="c" checked&gt;&lt;br&gt;
<strong>Retrieve privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="r" checked&gt;&lt;br&gt;
<strong>Update privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="u" checked&gt;&lt;br&gt;
<strong>Destroy privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="d" checked&gt;&lt;br&gt;
&lt;input type="submit" value="Enable Privileges"&gt;
&lt;/form&gt;
</pre>
Qui se traduit par...
</p>
<p>
<form class="demo">
<strong>Create privileges allowed:</strong>
<input type="checkbox" name="crud" value="c" checked><br>
<strong>Retrieve privileges allowed:</strong>
<input type="checkbox" name="crud" value="r" checked><br>
<strong>Update privileges allowed:</strong>
<input type="checkbox" name="crud" value="u" checked><br>
<strong>Destroy privileges allowed:</strong>
<input type="checkbox" name="crud" value="d" checked><br>
<input type="submit" value="Enable Privileges">
</form>
</p>
<p>
Si nous souhaitons désactiver tous les privilèges sauf
ceux de téléchargement (Retrieve) et transmettre cette information,
nous pouvons y arriver par...
<pre>
class SimpleFormTests extends WebTestCase {
...<strong>
function testDisableNastyPrivileges() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('crud', array('c', 'r', 'u', 'd'));
$this-&gt;setField('crud', array('r'));
$this-&gt;clickSubmit('Enable Privileges');
}</strong>
}
</pre>
Plutôt que d'initier le champ à une valeur unique,
nous lui donnons une liste de valeurs.
Nous faisons la même chose pour tester les valeurs attendues.
Nous pouvons écrire d'autres bouts de code de test
pour confirmer cet effet, peut-être en nous connectant
comme utilisateur et en essayant d'effectuer une mise à jour.
</p>
<h2>
<a class="target" name="hidden-field"></a>Formulaires utilisant Javascript pour changer un champ caché</h2>
<p>
Si vous souhaitez tester un formulaire dépendant de Javascript
pour la modification d'un champ caché, vous ne pouvez pas
simplement utiliser setField().
Le code suivant <em>ne fonctionnera pas</em> :
<pre>
class SimpleFormTests extends WebTestCase {
function testEmulateMyJavascriptForm() {
<strong>// This does *not* work</strong>
$this-&gt;setField('a_hidden_field', '123');
$this-&gt;clickSubmit('OK');
}
}
</pre>
A la place, vous aurez besoin d'ajouter le paramètre supplémentaire
du formulaire à la méthode clickSubmit() :
<pre>
class SimpleFormTests extends WebTestCase {
function testMyJavascriptForm() {
<strong>$this-&gt;clickSubmit('OK', array('a_hidden_field'=&gt;'123'));</strong>
}
}
</pre>
</p>
<p>
N'oubliez pas que de la sorte, vous êtes effectivement en train
de court-circuitez une partie de votre application (le code Javascript
dans le formulaire) et que peut-être serait-il plus prudent
d'utiliser un outil comme
<a href="http://selenium.openqa.org/">Selenium</a> pour mettre sur pied
un test complet.
</p>
<h2>
<a class="target" name="brut"></a>Envoi brut</h2>
<p>
Si vous souhaitez tester un gestionnaire de formulaire
mais que vous ne l'avez pas écrit ou que vous n'y avez
pas encore accès, vous pouvez créer un envoi de formulaire à la main.
<pre>
class SimpleFormTests extends WebTestCase {
...<strong>
function testAttemptedHack() {
$this-&gt;post(
'http://www.my-site.com/add_user.php',
array('type' =&gt; 'superuser'));
$this-&gt;assertNoUnwantedPattern('/user created/i');
}</strong>
}
</pre>
En ajoutant des données à la méthode <span class="new_code">WebTestCase::post()</span>,
nous émulons la transmission d'un formulaire.
D'ordinaire, vous ne ferez cela que pour parer au plus pressé,
ou alors si vous espérez un tiers (javascript ?) transmette le formulaire.
Il reste quand même exception : si vous souhaitez vous protégez
d'attaques de type "spoofing".
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API du développeur pour SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,265 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : Grouper des tests</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le groupement des tests</h1>
This page...
<ul>
<li>
Plusieurs approches pour <a href="#group">grouper des tests</a> ensemble.
</li>
<li>
Combiner des groupes des tests dans des
<a href="#plus-haut">groupes plus grands</a>.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="grouper"></a>Grouper des tests</h2>
<p>
Il existe beaucoup de moyens pour grouper des tests dans des suites de tests.
Le premier d'entre eux est tout simplement ajouter tous les scénarios de test
au fur et à mesure d'un unique fichier...
<pre>
<strong>&lt;?php
require_once(dirname(__FILE__) . '/simpletest/autorun.php');
require_once(dirname(__FILE__) . '/../classes/io.php');
class FileTester extends UnitTestCase {
...
}
class SocketTester extends UnitTestCase {
...
}
?&gt;</strong>
</pre>
Autant de scénarios que nécessaires peuvent être
mis dans cet unique fichier. Ils doivent contenir
tout le code nécessaire, entre autres la bibliothèque testée,
mais aucune des bibliothèques de SimpleTest.
</p>
<p>
Occasionnellement des sous-classes spéciales sont créés pour
ajouter des méthodes nécessaires à certains tests spécifiques
au sein de l'application.
Ces nouvelles classes de base sont ensuite utilisées
à la place de <span class="new_code">UnitTestCase</span>
ou de <span class="new_code">WebTestCase</span>.
Bien sûr vous ne souhaitez pas les lancer en tant que
scénario de tests : il suffit alors de les identifier
comme "abstraites"...
<pre>
<strong>abstract</strong> class MyFileTestCase extends UnitTestCase {
...
}
class FileTester extends MyFileTestCase { ... }
class SocketTester extends UnitTestCase { ... }
</pre>
La classe <span class="new_code">FileTester</span> ne contient aucun test véritable,
il s'agit d'une classe de base pour d'autres scénarios de test.
</p>
<p>
Nous appelons ce fichier <em>file_test.php</em>.
Pour l'instant les scénarios de tests sont simplement groupés dans le même fichier.
Nous pouvons mettre en place des structures plus importantes
en incluant d'autres fichiers de tests.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('file_test.php');
?&gt;
</pre>
Ceci fontionnera, tout en créant une hiérarchie tout à fait plate.
A la place, nous créons un fichier de suite de tests.
Notre suite des tests de premier niveau devient...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class AllFileTests extends TestSuite {
function __construct() {
parent::__construct();
<strong>$this-&gt;addFile('file_test.php');</strong>
}
}
?&gt;
</pre>
Voici ce qui arrive : la class <span class="new_code">TestSuite</span>
effecturera le <span class="new_code">require_once()</span> pour nous.
Ensuite elle vérifie si de nouvelles classes de test
ont été créées par ce nouveau fichier et les inclut
automatiquement dans la suite de tests.
Cette méthode nous donne un maximum de contrôle
tout comme le ferait des ajouts manuels de fichiers de tests
au fur et à mesure où notre suite grandit.
</p>
<p>
Si c'est trop de boulot pour vos petits doigts et qu'en plus
vous avez envie de grouper vos suites de tests par répertoire
ou par un tag dans le nom des fichiers, alors il y a un moyen
encore plus automatique...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class AllFileTests extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;collect(dirname(__FILE__) . '/unit',
new SimplePatternCollector('/_test.php/'));
}
}
?&gt;
</pre>
Cette fonctionnalités va scanner un répertoire appelé "unit",
y détecter tous les fichiers finissant par "_test.php"
et les charger.
Vous n'avez pas besoin d'utiliser <span class="new_code">SimplePatternCollector</span> pour
filtrer en fonction d'un motif dans le nom de fichier,
mais c'est son usage le plus courant.
</p>
<p>
Ce morceau de code est très courant.
Désormais la seule chose qu'il vous reste à faire, c'est de
déposer un fichier avec des scénarios de tests dans ce répertoire
et il sera lancé directement par le script de la suite de tests.
</p>
<p>
Juste un bémol : vous ne pouvez pas contrôler l'ordre de lancement
des tests.
Si vous souhaitez voir des composants de bas niveau renvoyer leurs erreurs
dès le début de la suite de tests - en particulier pour se facilier le travail
de diagnostic - alors vous devriez plutôt passer par <span class="new_code">addFile()</span>
pour ces cas spécifiques.
Les scénarios de tests ne sont chargés qu'une fois, pas d'inquiétude donc
lors du scan de votre répertoire avec tous les tests.
</p>
<p>
Les tests chargés avec la méthode <span class="new_code">addFile</span> ont certaines propriétés
qui peuvent s'avérer intéressantes.
Elle vous assure que le constructeur est lancé avant la première méthode
de test et que le destructeur est lancé après la dernière méthode de test.
Cela vous permet de placer une initialisation (setUp et tearDown) globale
au sein de ce destructeur et desctructeur, comme dans n'importe
quelle classe.
</p>
<h2>
<a class="target" name="plus-haut"></a>Groupements de plus haut niveau</h2>
<p>
La technique ci-dessus place tous les scénarios de test
dans un unique et grand groupe.
Sauf que pour des projets plus conséquents,
ce n'est probablement pas assez souple;
vous voudriez peut-être grouper les tests tout à fait différemment.
</p>
<p>
Tout ce que nous avons décrit avec des scripts de tests
s'applique pareillement avec des <span class="new_code">TestSuite</span>s...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
<strong>
class BigTestSuite extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('file_tests.php');
}
}</strong>
?&gt;
</pre>
Cette opération additionne nos scénarios de tests et une unique suite
sous la première.
Quand un test échoue, nous voyons le fil d'ariane avec l'enchainement.
Nous pouvons même mélanger groupes et tests librement en prenant
quand même soin d'éviter les inclusions en boucle.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class BigTestSuite extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('file_tests.php');
<strong>$this-&gt;addFile('some_other_test.php');</strong>
}
}
?&gt;
</pre>
Petite précision, en cas de double inclusion, seule la première instance
sera lancée.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,576 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Prise en main rapide de SimpleTest pour PHP -
Tests unitaire et objets fantaisie pour PHP
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Prise en main rapide de SimpleTest</h1>
This page...
<ul>
<li>
<a href="#unit">Utiliser le testeur rapidement</a>
avec un exemple.
</li>
<li>
<a href="#group">Groupes de tests</a>
pour tester en un seul clic.
</li>
<li>
<a href="#mock">Utiliser les objets fantaisie</a>
pour faciliter les tests et gagner en contrôle.
</li>
<li>
<a href="#web">Tester des pages web</a>
au niveau de l'HTML.
</li>
</ul>
<div class="content">
<p>
Le présent article présuppose que vous soyez familier avec
le concept de tests unitaires ainsi que celui de développement
web avec le langage PHP. Il s'agit d'un guide pour le nouvel
et impatient utilisateur de
<a href="https://sourceforge.net/project/showfiles.php?group_id=76550">SimpleTest</a>.
Pour une documentation plus complète, particulièrement si
vous découvrez les tests unitaires, consultez la
<a href="http://www.lastcraft.com/unit_test_documentation.php">documentation
en cours</a>, et pour des exemples de scénarios de test,
consultez le
<a href="http://www.lastcraft.com/first_test_tutorial.php">tutorial
sur les tests unitaires</a>.
</p>
<h2>
<a class="target" name="unit"></a>Utiliser le testeur rapidement</h2>
<p>
Parmi les outils de test pour logiciel, le testeur unitaire
est le plus proche du développeur. Dans un contexte de
développement agile, le code de test se place juste à côté
du code source étant donné que tous les deux sont écrits
simultanément. Dans ce contexte, SimpleTest aspire à être
une solution complète de test pour un développeur PHP et
s'appelle "Simple" parce qu'elle devrait être simple à
utiliser et à étendre. Ce nom n'était pas vraiment un bon
choix. Non seulement cette solution inclut toutes les
fonctions classiques qu'on est en droit d'attendre de la
part des portages de <a href="http://www.junit.org/">JUnit</a> et des <a href="http://sourceforge.net/projects/phpunit/">PHPUnit</a>,
mais elle inclut aussi les <a href="http://www.mockobjects.com/">objets fantaisie ou
"mock objects"</a>.
</p>
<p>
Ce qui rend cet outil immédiatement utile pour un développeur PHP,
c'est son navigateur web interne.
Il permet des tests qui parcourent des sites web, remplissent
des formulaires et testent le contenu des pages.
Etre capable d'écrire ces tests en PHP veut dire qu'il devient
facile d'écrire des tests de recette (ou d'intégration).
Un exemple serait de confirmer qu'un utilisateur a bien été ajouté
dans une base de données après s'être enregistré sur une site web.
</p>
<p>
La démonstration la plus rapide : l'exemple
</p>
<p>
Supposons que nous sommes en train de tester une simple
classe de log dans un fichier : elle s'appelle
<span class="new_code">Log</span> dans <em>classes/Log.php</em>. Commençons
par créer un script de test, appelé
<em>tests/log_test.php</em>. Son contenu est le suivant...
<pre>
&lt;?php
<strong>require_once('simpletest/autorun.php');</strong>
require_once('../classes/log.php');
class TestOfLogging extends <strong>UnitTestCase</strong> {
}
?&gt;
</pre>
Ici le répertoire <em>simpletest</em> est soit dans le
dossier courant, soit dans les dossiers pour fichiers
inclus. Vous auriez à éditer ces arborescences suivant
l'endroit où vous avez installé SimpleTest.
Le fichier "autorun.php" fait plus que juste inclure
les éléments de SimpleTest : il lance aussi les tests pour nous.
</p>
<p>
<span class="new_code">TestOfLogging</span> est notre premier scénario de test
et il est pour l'instant vide.
Chaque scénario de test est une classe qui étend une des classes
de base de SimpleTest. Nous pouvons avoir autant de classes de ce type
que nous voulons.
</p>
<p>
Avec ces trois lignes d'échafaudage
l'inclusion de notre classe <span class="new_code">Log</span>, nous avons une suite
de tests. Mais pas encore de test !
</p>
<p>
Pour notre premier test, supposons que la classe <span class="new_code">Log</span>
prenne le nom du fichier à écrire au sein du constructeur,
et que nous avons un répertoire temporaire dans lequel placer
ce fichier.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
class TestOfLogging extends UnitTestCase {
function <strong>testLogCreatesNewFileOnFirstMessage()</strong> {
@unlink('/temp/test.log');
$log = new Log('/temp/test.log');
<strong>$this-&gt;assertFalse(file_exists('/temp/test.log'));</strong>
$log-&gt;message('Should write this to a file');
<strong>$this-&gt;assertTrue(file_exists('/temp/test.log'));</strong>
}
}
?&gt;
</pre>
Au lancement du scénario de test, toutes les méthodes qui
commencent avec la chaîne <span class="new_code">test</span> sont
identifiées puis exécutées.
Si la méthode commence par <span class="new_code">test</span>, c'est un test.
Remarquez bien le nom très long de notre exemple :
<span class="new_code">testLogCreatesNewFileOnFirstMessage()</span>.
C'est bel et bien délibéré : ce style est considéré désirable
et il rend la sortie du test plus lisible.
</p>
<p>
D'ordinaire nous avons bien plusieurs méthodes de tests.
Mais ce sera pour plus tard.
</p>
<p>
Les assertions dans les
méthodes de test envoient des messages vers le framework de
test qui affiche immédiatement le résultat. Cette réponse
immédiate est importante, non seulement lors d'un crash
causé par le code, mais aussi de manière à rapprocher
l'affichage de l'erreur au plus près du scénario de test
concerné via un appel à <span class="new_code">print</span>code&gt;.
</p>
<p>
Pour voir ces résultats lançons effectivement les tests.
Aucun autre code n'est nécessaire, il suffit d'ouvrir
la page dans un navigateur.
</p>
<p>
En cas échec, l'affichage ressemble à...
<div class="demo">
<h1>TestOfLogging</h1>
<span class="fail">Fail</span>: testcreatingnewfile-&gt;True assertion failed.<br>
<div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete.
<strong>1</strong> passes and <strong>1</strong> fails.</div>
</div>
...et si ça passe, on obtient...
<div class="demo">
<h1>TestOfLogging</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>2</strong> passes and <strong>0</strong> fails.</div>
</div>
Et si vous obtenez ça...
<div class="demo">
<b>Fatal error</b>: Failed opening required '../classes/log.php' (include_path='') in <b>/home/marcus/projects/lastcraft/tutorial_tests/Log/tests/log_test.php</b> on line <b>7</b>
</div>
c'est qu'il vous manque le fichier <em>classes/Log.php</em>
qui pourrait ressembler à :
<pre>
&lt;?php<strong>
class Log {
function Log($file_path) {
}
function message() {
}
}</strong>
?&gt;
</pre>
C'est largement plus sympathique d'écrire le code après le test.
Plus que sympatique même - cette technique s'appelle
"Développement Piloté par les Tests" ou
"Test Driven Development" en anglais.
</p>
<p>
Pour plus de renseignements sur le testeur, voyez la
<a href="unit_test_documentation.html">documentation pour les tests de régression</a>.
</p>
<h2>
<a class="target" name="group"></a>Construire des groupes de tests</h2>
<p>
Il est peu probable que dans une véritable application on
ait uniquement besoin de passer un seul scénario de test.
Cela veut dire que nous avons besoin de grouper les
scénarios dans un script de test qui peut, si nécessaire,
lancer tous les tests de l'application.
</p>
<p>
Notre première étape est de créer un nouveau fichier appelé
<em>tests/all_tests.php</em> et d'y inclure le code suivant...
<pre>
&lt;?php
<strong>require_once('simpletest/autorun.php');</strong>
class AllTests extends <strong>TestSuite</strong> {
function AllTests() {
$this-&gt;TestSuite(<strong>'All tests'</strong>);
<strong>$this-&gt;addFile('log_test.php');</strong>
}
}
?&gt;
</pre>
L'inclusion de "autorun" permettra à notre future suite
de tests d'être lancée juste en invoquant ce script.
</p>
<p>
La sous-classe <span class="new_code">TestSuite</span> doit chaîner
son constructeur. Cette limitation sera supprimée dans
les versions à venir.
</p>
<p>
The method <span class="new_code">TestSuite::addFile()</span>
will include the test case file and read any new classes
that are descended from <span class="new_code">SimpleTestCase</span>.
Cette méthode <span class="new_code">TestSuite::addTestFile()</span> va
inclure le fichier de scénarios de test et lire parmi
toutes les nouvelles classes créées celles qui sont issues
de <span class="new_code">SimpleTestCase</span>.
<span class="new_code">UnitTestCase</span> est juste un exemple de classe dérivée
depuis <span class="new_code">SimpleTestCase</span> et vous pouvez créer les vôtres.
<span class="new_code">TestSuite::addFile()</span> peut aussi inclure d'autres suites.
</p>
<p>
La classe ne sera pas encore instanciée.
Quand la suite de tests est lancée, elle construira chaque instance
une fois le test atteint, et le détuira juste ensuite.
Cela veut dire que le constructeur n'est lancé qu'une fois avant
chaque initialisation de ce scénario de test et que le destructeur
est lui aussi lancé avant que le test suivant ne commence.
</p>
<p>
Il est commun de grouper des scénarios de test dans des super-classes
qui ne sont pas sensées être lancées, mais qui deviennent une classe de base
pour d'autres tests.
Pour que "autorun" fonctionne proprement les fichiers
des scénarios de test ne devraient pas lancer aveuglement
d'autres extensions de scénarios de test qui ne lanceraient pas
effectivement des tests.
Cela pourrait aboutir à un mauvais comptages des scénarios de test
pendant la procédure.
Pas vraiement un problème majeure, mais pour éviter cet inconvénient
il suffit de marquer vos classes de base comme <span class="new_code">abstract</span>.
SimpleTest ne lance pas les classes abstraites. Et si vous utilisez encore
PHP4 alors une directive <span class="new_code">SimpleTestOptions::ignore()</span>
dans votre fichier de scénario de test aura le même effet.
</p>
<p>
Par ailleurs, le fichier avec le scénario de test ne devrait pas
avoir été inclus ailleurs. Sinon aucun scénario de test
ne sera inclus à ce groupe.
Ceci pourrait se transformer en un problème plus grave :
si des fichiers ont déjà été inclus par PHP alors la méthode
<span class="new_code">TestSuite::addFile()</span> ne les détectera pas.
</p>
<p>
Pour afficher les résultats, il est seulement nécessaire
d'invoquer <em>tests/all_tests.php</em> à partir du serveur
web.
</p>
<p>
Pour plus de renseignements des groupes de tests, voyez le
<a href="group_test_documentation.html">documentation sur le groupement des tests</a>.
</p>
<h2>
<a class="target" name="mock"></a>Utiliser les objets fantaisie</h2>
<p>
Avançons un peu plus dans le futur.
</p>
<p>
Supposons que notre class logging soit testée et terminée.
Supposons aussi que nous testons une autre classe qui ait
besoin d'écrire des messages de log, disons
<span class="new_code">SessionPool</span>. Nous voulons tester une méthode
qui ressemblera probablement à quelque chose comme...
<pre><strong>
class SessionPool {
...
function logIn($username) {
...
$this-&gt;_log-&gt;message('User $username logged in.');
...
}
...
}
</strong>
</pre>
Avec le concept de "réutilisation de code" comme fil
conducteur, nous utilisons notre class <span class="new_code">Log</span>. Un
scénario de test classique ressemblera peut-être à...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
<strong>require_once('../classes/session_pool.php');</strong>
class <strong>TestOfSessionLogging</strong> extends UnitTestCase {
function setUp() {
<strong>@unlink('/temp/test.log');</strong>
}
function tearDown() {
<strong>@unlink('/temp/test.log');</strong>
}
function testLoggingInIsLogged() {
<strong>$log = new Log('/temp/test.log');
$session_pool = &amp;new SessionPool($log);
$session_pool-&gt;logIn('fred');</strong>
$messages = file('/temp/test.log');
$this-&gt;assertEqual($messages[0], "User fred logged in.<strong>\n</strong>");
}
}
?&gt;
</pre>
Nous expliquerons les méthodes <span class="new_code">setUp()</span>
et <span class="new_code">tearDown()</span> plus tard.
</p>
<p>
Le design de ce scénario de test n'est pas complètement
mauvais, mais on peut l'améliorer. Nous passons du temps à
tripoter les fichiers de log qui ne font pas partie de
notre test.
Pire, nous avons créé des liens de proximité
entre la classe <span class="new_code">Log</span> et ce test. Que se
passerait-il si nous n'utilisions plus de fichiers, mais la
bibliothèque <em>syslog</em> à la place ?
Cela veut dire que notre test <span class="new_code">TestOfSessionLogging</span>
enverra un échec alors même qu'il ne teste pas Logging.
</p>
<p>
Il est aussi fragile sur des petites retouches. Avez-vous
remarqué le retour chariot supplémentaire à la fin du
message ? A-t-il été ajouté par le loggueur ? Et si il
ajoutait aussi un timestamp ou d'autres données ?
</p>
<p>
L'unique partie à tester réellement est l'envoi d'un
message précis au loggueur.
Nous pouvons réduire le couplage en
créant une fausse classe de logging : elle ne fait
qu'enregistrer le message pour le test, mais ne produit
aucun résultat. Sauf qu'elle doit ressembler exactement à
l'original.
</p>
<p>
Si l'objet fantaisie n'écrit pas dans un fichier alors nous
nous épargnons la suppression du fichier avant et après le
test. Nous pourrions même nous épargner quelques lignes de
code supplémentaires si l'objet fantaisie pouvait exécuter
l'assertion.
<p>
</p>
Trop beau pour être vrai ? Pas vraiement on peut créer un tel
objet très facilement...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
require_once('../classes/session_pool.php');
<strong>Mock::generate('Log');</strong>
class TestOfSessionLogging extends UnitTestCase {
function testLoggingInIsLogged() {<strong>
$log = &amp;new MockLog();
$log-&gt;expectOnce('message', array('User fred logged in.'));</strong>
$session_pool = &amp;new SessionPool(<strong>$log</strong>);
$session_pool-&gt;logIn('fred');
}
}
?&gt;
</pre>
L'appel <span class="new_code">Mock::generate()</span> a généré
une nouvelle classe appelé <span class="new_code">MockLog</span>.
Cela ressemble à un clone identique, sauf que nous pouvons
y adjoindre du code de test.
C'est ce que fait <span class="new_code">expectOnce()</span>.
Cela dit que si <span class="new_code">message()</span> m'est appelé,
il a intérêt à l'être avec le paramètre
"User fred logged in.".
</p>
<p>
L'appel <span class="new_code">tally()</span> est nécessaire pour annoncer à
l'objet fantaisie qu'il n'y aura plus d'appels ultérieurs.
Sans ça l'objet fantaisie pourrait attendre pendant une
éternité l'appel de la méthode sans jamais prévenir le
scénario de test. Les autres tests sont déclenchés
automatiquement quand l'appel à <span class="new_code">message()</span> est
invoqué sur l'objet <span class="new_code">MockLog</span> par le code
<span class="new_code">SessionPool::logIn()</span>.
L'appel <span class="new_code">mock</span> va déclencher une comparaison des
paramètres et ensuite envoyer le message "pass" ou "fail"
au test pour l'affichage. Des jokers peuvent être inclus
pour ne pas avoir à tester tous les paramètres d'un appel
alors que vous ne souhaitez qu'en tester un.
</p>
<p>
Les objets fantaisie dans la suite SimpleTest peuvent avoir
un ensemble de valeurs de sortie arbitraires, des séquences
de sorties, des valeurs de sortie sélectionnées à partir
des arguments d'entrée, des séquences de paramètres
attendus et des limites sur le nombre de fois qu'une
méthode peut être invoquée.
</p>
<p>
Pour que ce test fonctionne la librairie avec les objets
fantaisie doit être incluse dans la suite de tests, par
exemple dans <em>all_tests.php</em>.
</p>
<p>
Pour plus de renseignements sur les objets fantaisie, voyez le
<a href="mock_objects_documentation.html">documentation sur les objets fantaisie</a>.
</p>
<h2>
<a class="target" name="web"></a>Tester une page web</h2>
<p>
Une des exigences des sites web, c'est qu'ils produisent
des pages web. Si vous construisez un projet de A à Z et
que vous voulez intégrer des tests au fur et à mesure alors
vous voulez un outil qui puisse effectuer une navigation
automatique et en examiner le résultat. C'est le boulot
d'un testeur web.
</p>
<p>
Effectuer un test web via SimpleTest reste assez primitif :
il n'y a pas de javascript par exemple.
La plupart des autres opérations d'un navigateur sont simulées.
</p>
<p>
Pour vous donner une idée, voici un exemple assez trivial :
aller chercher une page web,
à partir de là naviguer vers la page "about"
et finalement tester un contenu déterminé par le client.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
<strong>require_once('simpletest/web_tester.php');</strong>
class TestOfAbout extends <strong>WebTestCase</strong> {
function testOurAboutPageGivesFreeReignToOurEgo() {
<strong>$this-&gt;get('http://test-server/index.php');
$this-&gt;click('About');
$this-&gt;assertTitle('About why we are so great');
$this-&gt;assertText('We are really great');</strong>
}
}
?&gt;
</pre>
Avec ce code comme test de recette, vous pouvez vous
assurer que le contenu corresponde toujours aux
spécifications à la fois des développeurs et des autres
parties prenantes au projet.
</p>
<p>
Vous pouvez aussi naviguer à travers des formulaires...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('simpletest/web_tester.php');
class TestOfRankings extends WebTestCase {
function testWeAreTopOfGoogle() {
$this-&gt;get('http://google.com/');
$this-&gt;setField('q', 'simpletest');
$this-&gt;click("I'm Feeling Lucky");
$this-&gt;assertTitle('SimpleTest - Unit Testing for PHP');
}
}
?&gt;
</pre>
...même si cela pourrait constituer une violation
des documents juridiques de Google(tm).
</p>
<p>
Pour plus de renseignements sur comment tester une page web, voyez la
<a href="web_tester_documentation.html">documentation sur tester des scripts web</a>.
</p>
<p>
<a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&amp;type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a>
</p>
</div>
References and related information...
<ul>
<li>
<a href="https://sourceforge.net/project/showfiles.php?group_id=76550&amp;release_id=153280">Télécharger PHP SimpleTest</a>
depuis <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
L'<a href="http://simpletest.org/api/">API de SimpleTest pour développeur</a>
donne tous les détails sur les classes et assertions existantes.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,933 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : les objets fantaise</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les objets fantaisie</h1>
This page...
<ul>
<li>
<a href="#what">Que sont les objets fantaisie ?</a>
</li>
<li>
<a href="#creation">Créer des objets fantaisie</a>.
</li>
<li>
<a href="#expectations">Les objets fantaisie en tant que critiques</a> avec les attentes.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="what"></a>Que sont les objets fantaisie ?</h2>
<p>
Les objets fantaisie - ou "mock objects" en anglais -
ont deux rôles pendant un scénario de test : acteur et critique.
</p>
<p>
Le comportement d'acteur est celui de simuler
des objets difficiles à initialiser ou trop consommateurs
en temps pendant un test.
Le cas classique est celui de la connexion à une base de données.
Mettre sur pied une base de données de test au lancement
de chaque test ralentirait considérablement les tests
et en plus exigerait l'installation d'un moteur
de base de données ainsi que des données sur la machine de test.
Si nous pouvons simuler la connexion
et renvoyer des données à notre guise
alors non seulement nous gagnons en pragmatisme
sur les tests mais en sus nous pouvons nourrir
notre base avec des données falsifiées
et voir comment il répond. Nous pouvons
simuler une base de données en suspens ou
d'autres cas extrêmes sans avoir à créer
une véritable panne de base de données.
En d'autres termes nous pouvons gagner
en contrôle sur l'environnement de test.
</p>
<p>
Si les objets fantaisie ne se comportaient que comme
des acteurs alors on les connaîtrait sous le nom de
<a href="server_stubs_documentation.html">bouchons serveur</a>.
Il s'agissait originairement d'un patron de conception
identifié par Robert Binder (<a href="">Testing
object-oriented systems</a>: models, patterns, and tools,
Addison-Wesley) en 1999.
</p>
<p>
Un bouchon serveur est une simulation d'un objet ou d'un composant.
Il doit remplacer exactement un composant dans un système
en vue d'effectuer des tests ou un prototypage,
tout en restant ultra-léger.
Il permet aux tests de s'exécuter plus rapidement, ou
si la classe simulée n'a pas encore été écrite,
de se lancer tout court.
</p>
<p>
Cependant non seulement les objets fantaisie jouent
un rôle (en fournissant à la demande les valeurs requises)
mais en plus ils sont aussi sensibles aux messages qui
leur sont envoyés (par le biais d'attentes).
En posant les paramètres attendus d'une méthode
ils agissent comme des gardiens :
un appel sur eux doit être réalisé correctement.
Si les attentes ne sont pas atteintes ils nous épargnent
l'effort de l'écriture d'une assertion de test avec
échec en réalisant cette tâche à notre place.
</p>
<p>
Dans le cas d'une connexion à une base de données
imaginaire ils peuvent tester si la requête, disons SQL,
a bien été formé par l'objet qui utilise cette connexion.
Mettez-les sur pied avec des attentes assez précises
et vous verrez que vous n'aurez presque plus d'assertion à écrire manuellement.
</p>
<h2>
<a class="target" name="creation"></a>Créer des objets fantaisie</h2>
<p>
Tout ce dont nous avons besoin est une classe existante ou une interface,
par exemple une connexion à la base de données qui ressemblerait à...
<pre>
<strong>class DatabaseConnection {
function DatabaseConnection() { }
function query($sql) { }
function selectQuery($sql) { }
}</strong>
</pre>
Pour en créer sa version fantaisie nous devons juste
lancer le générateur...
<pre>
require_once('simpletest/autorun.php');
require_once('database_connection.php');
<strong>Mock::generate('DatabaseConnection');</strong>
</pre>
Ce code génère une classe clone appelée <span class="new_code">MockDatabaseConnection</span>.
Cette nouvelle classe lui ressemble en tout point,
sauf qu'elle ne fait rien du tout.
</p>
<p>
Cette nouvelle classe est génératlement
une sous-classe de <span class="new_code">DatabaseConnection</span>.
Malheureusement, il n'y as aucun moyen de créer une version fantaisie
d'une classe avec une méthode <span class="new_code">final</span> sans avoir
une version fonctionnelle de cette méthode.
Ce n'est pas pas très satisfaisant.
Si la cible est une interface ou si les méthodes <span class="new_code">final</span>
existent dans la classe cible, alors une toute nouvelle classe
est créée, elle implémente juste les même interfaces.
Si vous essayer de faire passer cette classe à travers un indice de type
qui spécifie le véritable nom de l'ancienne classe, alors il échouera.
Du code qui forcerait un indice de type tout en utilisant
des méthodes <span class="new_code">final</span> ne pourrait probablement pas être
testé efficacement avec des objets fantaisie.
</p>
<p>
Si vous voulez voir le code généré, il suffit de faire un <span class="new_code">print</span>
de la sortie de <span class="new_code">Mock::generate()</span>.
VOici le code généré pour la classe <span class="new_code">DatabaseConnection</span>
à la place de son interface...
<pre>
class MockDatabaseConnection extends DatabaseConnection {
public $mock;
protected $mocked_methods = array('databaseconnection', 'query', 'selectquery');
function MockDatabaseConnection() {
$this-&gt;mock = new SimpleMock();
$this-&gt;mock-&gt;disableExpectationNameChecks();
}
...
function DatabaseConnection() {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("DatabaseConnection", $args);
return $result;
}
function query($sql) {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("query", $args);
return $result;
}
function selectQuery($sql) {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("selectQuery", $args);
return $result;
}
}
</pre>
Votre sortie dépendra quelque peu de votre version précise de SimpleTest.
</p>
<p>
En plus des méthodes d'origine de la classe, vous en verrez d'autres
pour faciliter les tests.
Nous y reviendrons.
</p>
<p>
Nous pouvons désormais créer des instances de
cette nouvelle classe à l'intérieur même de notre scénario de test...
<pre>
require_once('simpletest/autorun.php');
require_once('database_connection.php');
Mock::generate('DatabaseConnection');
class MyTestCase extends UnitTestCase {
function testSomething() {
<strong>$connection = new MockDatabaseConnection();</strong>
}
}
</pre>
La version fantaisie contient toutles méthodes de l'originale.
En outre, tous les indices de type seront préservés.
Dison que nos méthodes de requête attend un objet <span class="new_code">Query</span>...
<pre>
<strong>class DatabaseConnection {
function DatabaseConnection() { }
function query(Query $query) { }
function selectQuery(Query $query) { }
}</strong>
</pre>
Si nous lui passons le mauvais type d'objet
ou même pire un non-objet...
<pre>
class MyTestCase extends UnitTestCase {
function testSomething() {
$connection = new MockDatabaseConnection();
$connection-&gt;query('insert into accounts () values ()');
}
}
</pre>
...alors le code renverra une violation de typage,
exactement comme on aurait pû s'y attendre
avec la classe d'origine.
</p>
<p>
Si la version fantaisie implémente bien toutes les méthodes
de l'originale, elle renvoit aussi systématiquement <span class="new_code">null</span>.
Et comme toutes les méthodes qui renvoient toujours <span class="new_code">null</span>
ne sont pas très utiles, nous avons besoin de leur faire dire
autre chose...
</p>
<h2>
<a class="target" name="bouchon"></a>Objets fantaisie en action</h2>
<p>
Changer le <span class="new_code">null</span> renvoyé par la méthode fantaisie
en autre chose est assez facile...
<pre>
<strong>$connection-&gt;returns('query', 37)</strong>
</pre>
Désormais à chaque appel de <span class="new_code">$connection-&gt;query()</span>
nous obtenons un résultat de 37.
Il n'y a rien de particulier à cette valeur de 37.
Cette valeur de retour peut être aussi compliqué que nécessaire.
</p>
<p>
Ici les paramètres ne sont pas significatifs,
nous aurons systématiquement la même valeur en retour
une fois initialisés de la sorte.
Cela pourrait ne pas ressembler à une copie convaincante
de notre connexion à la base de données, mais pour
la demi-douzaine de lignes de code de notre méthode de test
c'est généralement largement assez.
</p>
<p>
Sauf que les choses ne sont pas toujours si simples.
Les itérateurs sont un problème récurrent, si par exemple
renvoyer systématiquement la même valeur entraine
une boucle infinie dans l'objet testé.
Pour ces cas-là, nous avons besoin d'une séquence de valeurs.
Supposons que nous avons un itérateur simple qui ressemble à...
<pre>
class Iterator {
function Iterator() { }
function next() { }
}
</pre>
Il s'agit là de l'itérateur le plus basique que nous puissions imaginer.
Supponsons que cet itérateur ne renvoit que du texte
jusqu'à ce qu'il atteigne la fin et qu'il renvoie alors un false,
nous pouvons le simuler avec...
<pre>
Mock::generate('Iterator');
class IteratorTest extends UnitTestCase() {
function testASequence() {<strong>
$iterator = new MockIterator();
$iterator-&gt;returns('next', false);
$iterator-&gt;returnsAt(0, 'next', 'First string');
$iterator-&gt;returnsAt(1, 'next', 'Second string');</strong>
...
}
}
</pre>
Quand <span class="new_code">next()</span> est appelé par le <span class="new_code">MockIterator</span>
il commencera par renvoyer "First string",
au deuxième passage "Second string" sera renvoyé
et sur n'importe quel autre appel <span class="new_code">false</span> sera renvoyé
à son tour.
Les valeurs renvoyées les unes après les autres auront la priorité
sur la valeur constante.
Cette dernière est la valeur par défaut en quelque sorte.
</p>
<p>
Une autre situation délicate serait une opération
<span class="new_code">get()</span> surchargée.
Un exemple serait un conteneur d'information avec des pairs clef/valeur.
Nous partons cette fois d'une classe de configuration telle...
<pre>
class Configuration {
function Configuration() { ... }
function get($key) { ... }
}
</pre>
C'est une situation courante pour utiliser des objets fantaisie,
étant donné que la véritable configuration sera différente
d'une machine à l'autre et parfois même d'un test à l'autre.
Cependant un problème apparaît quand toutes les données passent
par la méthode <span class="new_code">get()</span> et que nous souhaitons
quand même des résultats différents pour des clefs différentes.
Par chance les objets fantaisie ont un système de filtre...
<pre>
<strong>$config = &amp;new MockConfiguration();
$config-&gt;returns('get', 'primary', array('db_host'));
$config-&gt;returns('get', 'admin', array('db_user'));
$config-&gt;returns('get', 'secret', array('db_password'));</strong>
</pre>
Le dernier paramètre est une liste d'arguements
pour vérifier une correspondance.
Dans ce cas, nous essayons de faire correspondre un argument
qui se trouve être la clef de recherche.
Désormais quand l'objet fantaisie voit
sa méthode <span class="new_code">get()</span> invoquée...
<pre>
$config-&gt;get('db_user')
</pre>
...il renverra "admin".
Il trouve cette valeur en essayant de faire correspondre
l'argument reçu à ceux de ses propres listes : dès qu'une
correspondance complète est trouvé, il s'arrête.
</p>
<p>
Vous pouvez préciser un argument par défaut via...
<pre><strong>
$config-&gt;returns('get', false, array('*'));</strong>
</pre>
Ce n'est pas la même chose que de définir la valeur renvoyée
sans aucun arguement...
<pre><strong>
$config-&gt;returns('get', false);</strong>
</pre>
Dans le premier cas, il acceptera n'importe quel argument,
mais il en faut au moins un.
Dans le deuxième cas, n'importe quel nombre d'arguments
fera l'affaire and il agit comme un attrape-tout après
toutes les autres vérifications.
Notez que si - dans le premier cas - nous ajoutons
d'autres options avec paramètre unique après le joker,
alors elle seront ignorés puisque le joker fera
la première correspondance.
Avec des listes complexes de paramètres, l'ordre devient
important au risque de voir la correspondance souhaitée
masqué par un joker apparu plus tôt.
Déclarez les plus spécifiques d'abord si vous n'êtes pas sûr.
</p>
<p>
Il y a des moments où vous souhaitez qu'une référence
bien spécifique soit servie par l'objet fantaisie plutôt
qu'une copie.
C'est plutôt rare pour dire le moins, mais vous pourriez
être en train de simuler un conteneur qui détiendrait
des primitives, tels des chaînes de caractères.
Par exemple.
<pre>
class Pad {
function Pad() { }
function &amp;note($index) { }
}
</pre>
Dans ce cas, vous pouvez définir une référence dans la liste
des valeurs retournées par l'objet fantaisie...
<pre>
function testTaskReads() {
$note = 'Buy books';
$pad = new MockPad();
$vector-&gt;<strong>returnsByReference(</strong>'note', $note, array(3)<strong>)</strong>;
$task = new Task($pad);
...
}
</pre>
Avec cet assemblage vous savez qu'à chaque fois
que <span class="new_code">$pad-&gt;note(3)</span> est appelé
il renverra toujours la même <span class="new_code">$note</span>,
même si celle-ci est modifiée.
</p>
<p>
Ces trois facteurs, timing, paramètres et références,
peuvent être combinés orthogonalement.
Par exemple...
<pre>
$buy_books = 'Buy books';
$write_code = 'Write code';
$pad = new MockPad();
$vector-&gt;<strong>returnsByReferenceAt(0, 'note', $buy_books, array('*', 3));</strong>
$vector-&gt;<strong>returnsByReferenceAt(1, 'note', $write_code, array('*', 3));</strong>
</pre>
Cela renverra une référence à <span class="new_code">$buy_books</span> et
ensuite à <span class="new_code">$write_code</span>, mais seuleent si deux paramètres
sont utilisés, le deuxième devant être l'entier 3.
Cela devrait couvrir la plupart des situations.
</p>
<p>
Un dernier cas délicat reste : celui d'un objet créant
un autre objet, plus connu sous le patron de conception "fabrique"
(ou "factory").
Supponsons qu'à la réussite d'une requête à
notre base de données imaginaire, un jeu d'enregistrements
est renvoyé sous la forme d'un itérateur, où chaque appel
au <span class="new_code">next()</span> sur notre itérateur donne une ligne
avant de s'arrêtre avec un false.
Cela semble à un cauchemar à simuler, alors qu'en fait un objet
fantaisie peut être créé avec les mécansimes ci-dessus...
<pre>
Mock::generate('DatabaseConnection');
Mock::generate('ResultIterator');
class DatabaseTest extends UnitTestCase {
function testUserFinderReadsResultsFromDatabase() {<strong>
$result = new MockResultIterator();
$result-&gt;returns('next', false);
$result-&gt;returnsAt(0, 'next', array(1, 'tom'));
$result-&gt;returnsAt(1, 'next', array(3, 'dick'));
$result-&gt;returnsAt(2, 'next', array(6, 'harry'));
$connection = new MockDatabaseConnection();
$connection-&gt;returns('selectQuery', $result);</strong>
$finder = new UserFinder(<strong>$connection</strong>);
$this-&gt;assertIdentical(
$finder-&gt;findNames(),
array('tom', 'dick', 'harry'));
}
}
</pre>
Désormais ce n'est que si notre <span class="new_code">$connection</span>
est appelée par la méthode <span class="new_code">query()</span>
que sera retourné le <span class="new_code">$result</span>,
lui-même s'arrêtant au troisième appel
à <span class="new_code">next()</span>.
Ce devrait être suffisant comme information
pour que notre classe <span class="new_code">UserFinder</span>,
la classe effectivement testée ici,
fasse son boulot.
Un test très précis et toujours pas
de base de données en vue.
</p>
<p>
Nous pourrsion affiner ce test encore plus
en insistant pour que la bonne requête
soit envoyée...
<pre>
$connection-&gt;returns('selectQuery', $result, array(<strong>'select name, id from people'</strong>));
</pre>
Là, c'est une mauvaise idée.
</p>
<p>
Niveau objet, nous avons un <span class="new_code">UserFinder</span>
qui parle à une base de données à travers une interface géante -
l'ensemble du SQL.
Imaginez si nous avions écrit un grand nombre de tests
qui dépendrait désormais de cette requête SQL précise.
Ces requêtes pourraient changer en masse pour tout un tas
de raisons non liés à ce test spécifique.
Par exemple, la règle pour les quotes pourrait changer,
un nom de table pourrait évoluer, une table de liaison pourrait
être ajouté, etc.
Cela entrainerait une ré-écriture de tous les tests à chaque fois
qu'un remaniement est fait, alors même que le comportement lui
n'a pas bougé.
Les tests sont censés aider au remaniement, pas le bloquer.
Pour ma part, je préfère avoir une suite de tests qui passent
quand je fais évoluer le nom des tables.
</p>
<p>
Et si vous voulez une règle, c'est toujours mieux de ne pas
créer un objet fantaisie sur une grosse interface.
</p>
<p>
Par contrast, voici le test complet...
<pre>
class DatabaseTest extends UnitTestCase {<strong>
function setUp() { ... }
function tearDown() { ... }</strong>
function testUserFinderReadsResultsFromDatabase() {
$finder = new UserFinder(<strong>new DatabaseConnection()</strong>);
$finder-&gt;add('tom');
$finder-&gt;add('dick');
$finder-&gt;add('harry');
$this-&gt;assertIdentical(
$finder-&gt;findNames(),
array('tom', 'dick', 'harry'));
}
}
</pre>
Ce test est immunisé contre le changement de schéma.
Il échouera uniquement si vous changez la fonctionnalité,
ce qui correspond bien à ce qu'un test doit faire.
</p>
<p>
Il faut juste faire attention à ces méthodes <span class="new_code">setUp()</span>
et <span class="new_code">tearDown()</span> que nous avons survolé pour l'instant.
Elles doivent vider les tables de la base de données
et s'assurer que le schéma est bien défini.
Cela peut se engendrer un peu de travail supplémentaire,
mais d'ordinaire ce type de code existe déjà - à commencer pour
le déploiement.
</p>
<p>
Il y a au moins un endroit où vous aurez besoin d'objets fantaisie :
c'est la simulation des erreurs.
Exemple, la base de données tombe pendant que <span class="new_code">UserFinder</span>
fait son travail. Le <span class="new_code">UserFinder</span> se comporte-t-il bien ?
<pre>
class DatabaseTest extends UnitTestCase {
function testUserFinder() {
$connection = new MockDatabaseConnection();<strong>
$connection-&gt;throwOn('selectQuery', new TimedOut('Ouch!'));</strong>
$alert = new MockAlerts();<strong>
$alert-&gt;expectOnce('notify', 'Database is busy - please retry');</strong>
$finder = new UserFinder($connection, $alert);
$this-&gt;assertIdentical($finder-&gt;findNames(), array());
}
}
</pre>
Nous avons transmis au <span class="new_code">UserFinder</span>
un objet <span class="new_code">$alert</span>.
Il va transmettre un certain nombre de belles notifications
à l'interface utilisatuer en cas d'erreur.
Nous préfèrerions éviter de saupoudrer notre code avec
des commandes <span class="new_code">print</span> codées en dur si nous pouvons
l'éviter.
Emballer les moyens de sortie veut dire que nous pouvons utiliser
ce code partout. Et cela rend notre code plus facile.
</p>
<p>
Pour faire passer ce test, le finder doit écrire un message sympathique
et compréhensible à l'<span class="new_code">$alert</span>, plutôt que de propager
l'exception. Jusque là, tout va bien.
</p>
<p>
Comment faire en sorte que la <span class="new_code">DatabaseConnection</span> fantaisie
soulève une exception ?
Nous la générons avec la méthode <span class="new_code">throwOn</span> sur l'objet fantaisie.
</p>
<p>
Enfin, que se passe-t-il si la méthode voulue pour la simulation
n'existe pas encore ?
Si vous définissez une valeur de retour sur une méthode absente,
alors SimpleTest vous répondra avec une erreur.
Et si vous utilisez <span class="new_code">__call()</span> pour simuler
des méthodes dynamiques ?
</p>
<p>
Les objets avec des interfaces dynamiques, avec <span class="new_code">__call</span>,
peuvent être problématiques dans l'implémentation courante
des objets fantaisie.
Vous pouvez en créer un autour de la méthode <span class="new_code">__call()</span>
mais c'est très laid.
Et pourquoi un test devrait connaître quelque chose avec un niveau
si bas dans l'implémentation. Il n'a besoin que de simuler l'appel.
</p>
<p>
Il y a bien moyen de contournement : ajouter des méthodes complémentaires
à l'objet fantaisie à la génération.
<pre>
<strong>Mock::generate('DatabaseConnection', 'MockDatabaseConnection', array('setOptions'));</strong>
</pre>
Dans une longue suite de tests cela pourrait entraîner des problèmes,
puisque vous avez probablement déjà une version fantaisie
de la classe appellée <span class="new_code">MockDatabaseConnection</span>
sans les méthodes complémentaires.
Le générateur de code ne générera pas la version fantaisie de la classe
s'il en existe déjà une version avec le même nom.
Il vous deviendra impossible de déterminer où est passée votre méthode
si une autre définition a été lancé au préalable.
</p>
<p>
Pour pallier à ce problème, SimpleTest vous permet de choisir
n'importe autre nom pour la nouvelle classe au moment même où
vous ajouter les méthodes complémentaires.
<pre>
Mock::generate('DatabaseConnection', <strong>'MockDatabaseConnectionWithOptions'</strong>, array('setOptions'));
</pre>
Ici l'objet fantaisie se comportera comme si
<span class="new_code">setOptions()</span> existait bel et bien
dans la classe originale.
</p>
<p>
Les objets fantaisie ne peuvent être utilisés qu'à l'intérieur
des scénarios de test, étant donné qu'à l'apparition d'une attente
ils envoient des messages directement au scénario de test courant.
Les créer en dehors d'un scénario de test entraînera une erreur
de run time quand une attente est déclenchée et qu'il n'y a pas
de scénario de test en cours pour recevoir le message.
Nous pouvons désormais couvrir ces attentes.
</p>
<h2>
<a class="target" name="expectations"></a>Objets fantaisie en tant que critiques</h2>
<p>
Même si les bouchons serveur isolent vos tests des perturbations
du monde réel, ils n'apportent que le moitié des bénéfices possibles.
Vous pouvez obtenir une classe de test qui reçoive les bons messages,
mais cette nouvelle classe envoie-t-elle les bons ?
Le tester peut devenir très bordélique sans
une librairie d'objets fantaise.
</p>
<p>
Voici un exemple, prenons une classe <span class="new_code">PageController</span>
toute simple qui traitera un formulaire de paiement
par carte bleue...
<pre>
class PaymentForm extends PageController {
function __construct($alert, $payment_gateway) { ... }
function makePayment($request) { ... }
}
</pre>
Cette classe a besoin d'un <span class="new_code">PaymentGateway</span>
pour parler concrètement à la banque.
Il utilise aussi un objet <span class="new_code">Alert</span>
pour gérer les erreurs.
Cette dernière classe parle à la page ou au template.
Elle est responsable de l'affichage du message d'erreur
et de la mise en valeur de tout champ du formulaire
qui serait incorrecte.
</p>
<p>
Elle pourrait ressembler à...
<pre>
class Alert {
function warn($warning, $id) {
print '&lt;div class="warning"&gt;' . $warning . '&lt;/div&gt;';
print '&lt;style type="text/css"&gt;#' . $id . ' { background-color: red }&lt;/style&gt;';
}
}
</pre>
</p>
<p>
Portons notre attention à la méthode <span class="new_code">makePayment()</span>.
Si nous n'inscrivons pas un numéro "CVV2" (celui à trois
chiffre au dos de la carte bleue), nous souhaitons afficher
une erreur plutôt que d'essayer de traiter le paiement.
En mode test...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('payment_form.php');
Mock::generate('Alert');
Mock::generate('PaymentGateway');
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
<strong>$alert-&gt;expectOnce(
'warn',
array('Missing three digit security code', 'cvv2'));</strong>
$controller = new PaymentForm(<strong>$alert</strong>, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
function requestWithMissingCvv2() { ... }
}
?&gt;
</pre>
Première question : où sont passés les assertions ?
</p>
<p>
L'appel à <span class="new_code">expectOnce('warn', array(...))</span> annonce
à l'objet fantaisie qu'il faut s'attendre à un appel à <span class="new_code">warn()</span>
avant la fin du test.
Quand il débouche sur l'appel à <span class="new_code">warn()</span>, il vérifie
les arguments. Si ceux-ci ne correspondent pas, alors un échec
est généré. Il échouera aussi si la méthode n'est jamais appelée.
</p>
<p>
Non seulement le test ci-dessus s'assure que <span class="new_code">warn</span>
a bien été appelé, mais en plus qu'il a bien reçu la chaîne
de caractère "Missing three digit security code"
et même le tag "cvv2".
L'équivalent de <span class="new_code">assertIdentical()</span> est appliqué
aux deux champs quand les paramètres sont comparés.
</p>
<p>
Si le contenu du message vous importe peu, surtout dans le cas
d'une interface utilisateur qui change régulièrement,
nous pouvons passer ce paramètre avec l'opérateur "*"...
<pre>
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
$alert-&gt;expectOnce('warn', array(<strong>'*'</strong>, 'cvv2'));
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
function requestWithMissingCvv2() { ... }
}
</pre>
Nous pouvons même rendre le test encore moins spécifique
en supprimant complètement la liste des paramètres...
<pre>
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
<strong>$alert-&gt;expectOnce('warn');</strong>
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
</pre>
Ceci vérifiera uniquement si la méthode a été appelé,
ce qui est peut-être un peu drastique dans ce cas.
Plus tard, nous verrons comment alléger les attentes
plus précisement.
</p>
<p>
Des tests sans assertions peuvent être à la fois compacts
et très expressifs. Parce que nous interceptons l'appel
sur le chemin de l'objet, ici de classe <span class="new_code">Alert</span>,
nous évitons de tester l'état par la suite.
Cela évite les assertions dans les tests, mais aussi
l'obligation d'ajouter des accesseurs uniquement
pour les tests dans le code original.
Si vous en arrivez à ajouter des accesseurs de ce type,
on parle alors de "state based testing" dans le jargon
("test piloté par l'état"),
il est probablement plus que temps d'utiliser
des objets fantaisie dans vos tests.
On peut alors parler de "behaviour based testing"
(ou "test piloté par le comportement") :
c'est largement mieux !
</p>
<p>
Ajoutons un autre test.
Assurons nous que nous essayons même pas un paiement sans CVV2...
<pre>
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() { ... }
function testNoPaymentAttemptedWithMissingCvv2() {
$payment_gateway = new MockPaymentGateway();
<strong>$payment_gateway-&gt;expectNever('pay');</strong>
$controller = new PaymentForm(new MockAlert(), $payment_gateway);
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
...
}
</pre>
Vérifier une négation peut être très difficile
dans les tests, mais <span class="new_code">expectNever()</span>
rend l'opération très facile heureusement.
</p>
<p>
<span class="new_code">expectOnce()</span> et <span class="new_code">expectNever()</span> sont
suffisants pour la plupart des tests, mais
occasionnellement vous voulez tester plusieurs évènements.
D'ordinaire pour des raisons d'usabilité, nous souhaitons
que tous les champs manquants du formulaire soient
mis en relief, et pas uniquement le premier.
Cela veut dire que nous devrions voir de multiples appels
à <span class="new_code">Alert::warn()</span>, pas juste un...
<pre>
function testAllRequiredFieldsHighlightedOnEmptyRequest() {
$alert = new MockAlert();<strong>
$alert-&gt;expectAt(0, 'warn', array('*', 'cc_number'));
$alert-&gt;expectAt(1, 'warn', array('*', 'expiry'));
$alert-&gt;expectAt(2, 'warn', array('*', 'cvv2'));
$alert-&gt;expectAt(3, 'warn', array('*', 'card_holder'));
$alert-&gt;expectAt(4, 'warn', array('*', 'address'));
$alert-&gt;expectAt(5, 'warn', array('*', 'postcode'));
$alert-&gt;expectAt(6, 'warn', array('*', 'country'));
$alert-&gt;expectCallCount('warn', 7);</strong>
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
</pre>
Le compteur dans <span class="new_code">expectAt()</span> précise
le nombre de fois que la méthode a déjà été appelée.
Ici nous vérifions que chaque champ sera bien mis en relief.
</p>
<p>
Notez que nous sommes forcé de tester l'ordre en même temps.
SimpleTest n'a pas encore de moyen pour éviter cela,
mais dans une version future ce sera corrigé.
</p>
<p>
Voici la liste complètes des attentes
que vous pouvez préciser sur une objet fantaisie
dans <a href="http://simpletest.org/">SimpleTest</a>.
Comme pour les assertions, ces méthodes prennent en option
un message d'erreur.
<table>
<thead><tr>
<th>Attente</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td><span class="new_code">expect($method, $args)</span></td>
<td>Les arguements doivent correspondre si appelés</td>
</tr>
<tr>
<td><span class="new_code">expectAt($timing, $method, $args)</span></td>
<td>Les arguements doiven correspondre si appelés lors du passage numéro <span class="new_code">$timing</span>
</td>
</tr>
<tr>
<td><span class="new_code">expectCallCount($method, $count)</span></td>
<td>La méthode doit être appelée exactement <span class="new_code">$count</span> fois</td>
</tr>
<tr>
<td><span class="new_code">expectMaximumCallCount($method, $count)</span></td>
<td>La méthode ne doit pas être appelée plus de <span class="new_code">$count</span> fois</td>
</tr>
<tr>
<td><span class="new_code">expectMinimumCallCount($method, $count)</span></td>
<td>La méthode ne doit pas être appelée moins de <span class="new_code">$count</span> fois</td>
</tr>
<tr>
<td><span class="new_code">expectNever($method)</span></td>
<td>La méthode ne doit jamais être appelée</td>
</tr>
<tr>
<td><span class="new_code">expectOnce($method, $args)</span></td>
<td>La méthode ne doit être appelée qu'une seule fois et avec les arguments (en option)</td>
</tr>
<tr>
<td><span class="new_code">expectAtLeastOnce($method, $args)</span></td>
<td>La méthode doit être appelée au moins une seule fois et toujours avec au moins un des arguments attendus</td>
</tr>
</tbody>
</table>
Où les paramètres sont...
<dl>
<dt class="new_code">$method</dt>
<dd>
Le nom de la méthode, sous la forme d'une chaîne de caractères,
à laquelle il faut appliquer la condition.
</dd>
<dt class="new_code">$args</dt>
<dd>
Les argumetns sous la forme d'une liste.
Les jokers peuvent être inclus de la même manière
que pour <span class="new_code">setReturn()</span>.
Cet argument est optionnel pour <span class="new_code">expectOnce()</span>
et <span class="new_code">expectAtLeastOnce()</span>.
</dd>
<dt class="new_code">$timing</dt>
<dd>
La seule marque dans le temps pour tester la condition.
Le premier appel commence à zéro et le comptage se fait
séparement sur chaque méthode.
</dd>
<dt class="new_code">$count</dt>
<dd>Le nombre d'appels attendu.</dd>
</dl>
</p>
<p>
Si vous n'avez qu'un seul appel dans votre test, assurez vous
d'utiliser <span class="new_code">expectOnce</span>.<br>
Utiliser <span class="new_code">$mocked-&gt;expectAt(0, 'method', 'args);</span>
tout seul ne permettra qu'à la méthode de ne jamais être appelée.
Vérifier les arguements et le comptage total sont pour le moment
indépendants.
Ajouter une attente <span class="new_code">expectCallCount()</span> quand
vous utilisez <span class="new_code">expectAt()</span> (dans le cas sans appel)
est permis.
</p>
<p>
Comme les assertions à l'intérieur des scénarios de test,
toutes ces attentes peuvent incorporer une surchage
sur le message sous la forme d'un paramètre supplémentaire.
Par ailleurs le message original peut être inclus dans la sortie
avec "%s".
</p>
</div>
References and related information...
<ul>
<li>
Le papier original sur les Objets fantaisie ou
<a href="http://www.mockobjects.com/">Mock objects</a>.
</li>
<li>
La page du projet SimpleTest sur <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page d'accueil de SimpleTest sur <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,321 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Aperçu et liste des fonctionnalités des testeurs unitaires PHP et web de SimpleTest PHP
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Apercu de SimpleTest</h1>
This page...
<ul>
<li>
<a href="#resume">Résumé rapide</a> de l'outil SimpleTest pour PHP.
</li>
<li>
<a href="#fonctionnalites">La liste des fonctionnalites</a>, à la fois présentes et à venir.
</li>
<li>
Il y a beaucoup de <a href="#ressources">ressources sur les tests unitaires</a> sur le web.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="resume"></a>Qu'est-ce que SimpleTest ?</h2>
<p>
Le coeur de SimpleTest est un framework de test construit autour de classes de scénarios de test. Celles-ci sont écrites comme des extensions des classes premières de scénarios de test, chacune élargie avec des méthodes qui contiennent le code de test effectif. Les scripts de test de haut niveau invoque la méthode <span class="new_code">run()</span> à chaque scénario de test successivement. Chaque méthode de test est écrite pour appeler des assertions diverses que le développeur suppose être vraies, <span class="new_code">assertEqual()</span> par exemple. Si l'assertion est correcte, alors un succès est expédié au rapporteur observant le test, mais toute erreur déclenche une alerte et une description de la dissension.
</p>
<p>
Un <a href="unit_test_documentation.html">scénario de test</a> ressemble à...
<pre>
class <strong>MyTestCase</strong> extends UnitTestCase {
<strong>
function testLog() {
$log = &amp;new Log('my.log');
$log-&gt;message('Hello');
$this-&gt;assertTrue(file_exists('my.log'));
}</strong>
}
</pre>
</p>
<p>
Ces outils sont conçus pour le développeur. Les tests sont écrits en PHP directement, plus ou moins simultanément avec la construction de l'application elle-même. L'avantage d'utiliser PHP lui-même comme langage de test est qu'il n'y a pas de nouveau langage à apprendre, les tests peuvent commencer directement et le développeur peut tester n'importe quelle partie du code. Plus simplement, toutes les parties qui peuvent être accédées par le code de l'application peuvent aussi être accédées par le code de test si ils sont tous les deux dans le même langage.
</p>
<p>
Le type de scénario de test le plus simple est le <span class="new_code">UnitTestCase</span>. Cette classe de scénario de test inclut les tests standards pour l'égalité, les références et l'appariement de motifs (via les expressions rationnelles). Ceux-ci testent ce que vous seriez en droit d'attendre du résultat d'une fonction ou d'une méthode. Il s'agit du type de test le plus commun pendant le quotidien du développeur, peut-être 95% des scénarios de test.
</p>
<p>
La tâche ultime d'une application web n'est cependant pas de produire une sortie correcte à partir de méthodes ou d'objets, mais plutôt de produire des pages web. La classe <span class="new_code">WebTestCase</span> teste des pages web. Elle simule un navigateur web demandant une page, de façon exhaustive : cookies, proxies, connexions sécurisées, authentification, formulaires, cadres et la plupart des éléments de navigation. Avec ce type de scénario de test, le développeur peut garantir que telle ou telle information est présente dans la page et que les formulaires ainsi que les sessions sont gérés comme il faut.
</p>
<p>
Un <a href="web_tester_documentation.html">scénario de test web</a> ressemble à...
<pre>
class <strong>MySiteTest</strong> extends WebTestCase {
<strong>
function testHomePage() {
$this-&gt;get('http://www.my-site.com/index.php');
$this-&gt;assertTitle('My Home Page');
$this-&gt;clickLink('Contact');
$this-&gt;assertTitle('Contact me');
$this-&gt;assertWantedPattern('/Email me at/');
}</strong>
}
</pre>
</p>
<h2>
<a class="target" name="fonctionnalites"></a>Liste des fonctionnalites</h2>
<p>
Ci-dessous vous trouverez un canevas assez brut des fonctionnalités à aujourd'hui et pour demain, sans oublier leur date approximative de publication. J'ai bien peur qu'il soit modifiable sans pré-avis étant donné que les jalons dépendent beaucoup sur le temps disponible. Les trucs en vert ont été codés, mais pas forcément déjà rendus public. Si vous avez une besoin pressant pour une fonctionnalité verte mais pas encore publique alors vous devriez retirer le code directement sur le CVS chez SourceFourge. Une fonctionnalitée publiée est indiqué par "Fini".
<table>
<thead>
<tr>
<th>Fonctionnalité</th>
<th>Description</th>
<th>Publication</th>
</tr>
</thead>
<tbody>
<tr>
<td>Scénariot de test unitaire</td>
<td>Les classes de test et assertions de base</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Affichage HTML</td>
<td>L'affichage le plus simple possible</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Autochargement des scénarios de test</td>
<td>Lire un fichier avec des scénarios de test et les charger dans un groupe de tests automatiquement</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Générateur de code d'objets fantaisie</td>
<td>Des objets capable de simuler d'autres objets, supprimant les dépendances dans les tests</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Bouchons serveur</td>
<td>Des objets fantaisie sans résultat attendu à utiliser à l'extérieur des scénarios de test, pour le prototypage par exemple.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Intégration d'autres testeurs unitaires</td>
<td>
La capacité de lire et simuler d'autres scénarios de test en provenance de PHPUnit et de PEAR::Phpunit.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Scénario de test web</td>
<td>Appariement basique de motifs dans une page téléchargée.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Analyse de page HTML</td>
<td>Permet de suivre les liens et de trouver la balise de titre</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Simulacre partiel</td>
<td>Simuler des parties d'une classe pour tester moins qu'une classe ou dans des cas complexes.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Gestion des cookies Web</td>
<td>Gestion correcte des cookies au téléchargement d'une page.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Suivi des redirections</td>
<td>Le téléchargement d'une page suit automatiquement une redirection 300.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Analyse d'un formulaire</td>
<td>La capacité de valider un formulaire simple et d'en lire les valeurs par défaut.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Interface en ligne de commande</td>
<td>Affiche le résultat des tests sans navigateur web.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Mise à nu des attentes d'une classe</td>
<td>Peut créer des tests précis avec des simulacres ainsi que des scénarios de test.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Sortie et analyse XML</td>
<td>Permet de tester sur plusieurs hôtes et d'intégrer des extensions d'acceptation de test.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Scénario de test en ligne de commande</td>
<td>Permet de tester des outils ou scripts en ligne de commande et de manier des fichiers.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Compatibilité avec PHP Documentor</td>
<td>Génération automatique et complète de la documentation au niveau des classes.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Interface navigateur</td>
<td>Mise à nu des niveaux bas de l'interface du navigateur web pour des scénarios de test plus précis.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Authentification HTTP</td>
<td>Téléchargement des pages web protégées avec une authentification basique seulement.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Boutons de navigation d'un navigateur</td>
<td>Arrière, avant et recommencer</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Support de SSL</td>
<td>Peut se connecter à des pages de type https.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Support de proxy</td>
<td>Peut se connecter via des proxys communs</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Support des cadres</td>
<td>Gère les cadres dans les scénarios de test web.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Test de l'upload de fichier</td>
<td>Peut simuler la balise input de type file</td>
<td style="color: red;">1.0.1</td>
</tr>
<tr>
<td>Amélioration sur la machinerie des rapports</td>
<td>Retouche sur la transmission des messages pour une meilleur coopération avec les IDEs</td>
<td style="color: red;">1.1</td>
</tr>
<tr>
<td>Amélioration de l'affichage des tests</td>
<td>Une meilleure interface graphique web, avec un arbre des scénarios de test.</td>
<td style="color: red;">1.1</td>
</tr>
<tr>
<td>Localisation</td>
<td>Abstraction des messages et génration du code à partir de fichiers XML.</td>
<td style="color: red;">1.1</td>
</tr>
<tr>
<td>Simulation d'interface</td>
<td>Peut générer des objets fantaisie tant vers des interfaces que vers des classes.</td>
<td style="color: red;">2.0</td>
</tr>
<tr>
<td>Test sur es exceptions</td>
<td>Dans le même esprit que sur les tests des erreurs PHP.</td>
<td style="color: red;">2.0</td>
</tr>
<tr>
<td>Rercherche d'éléments avec XPath</td>
<td>Peut utiliser Tidy HTML pour un appariement plus rapide et plus souple.</td>
<td style="color: red;">2.0</td>
</tr>
</tbody>
</table>
La migration vers PHP5 commencera juste après la série des 1.0, à partir de là PHP4 ne sera plus supporté. SimpleTest est actuellement compatible avec PHP5 mais n'utilisera aucune des nouvelles fonctionnalités avant la version 2.
</p>
<h2>
<a class="target" name="ressources"></a>Ressources sur le web pour les tests</h2>
<p>
Le processus est au moins aussi important que les outils. Le type de procédure que fait un usage le plus intensif des outils de test pour développeur est bien sûr l'<a href="http://www.extremeprogramming.org/">Extreme Programming</a>. Il s'agit là d'une des <a href="http://www.agilealliance.com/articles/index">méthodes agiles</a> qui combinent plusieurs pratiques pour "lisser la courbe de coût" du développement logiciel. La plus extrème reste le <a href="http://www.testdriven.com/modules/news/">développement piloté par les tests</a>, où vous devez adhérer à la règle du <cite>pas de code avant d'avoir un test</cite>. Si vous êtes plutôt du genre planninficateur ou que vous estimez que l'expérience compte plus que l'évolution, vous préférerez peut-être l'approche <a href="http://www.therationaledge.com/content/dec_01/f_spiritOfTheRUP_pk.html">RUP</a>. Je ne l'ai pas testé mais je peux voir où vous aurez besoin d'outils de test (cf. illustration 9).
</p>
<p>
La plupart des testeurs unitaires sont dans une certaine mesure un clone de <a href="http://www.junit.org/">JUnit</a>, au moins dans l'interface. Il y a énormément d'information sur le site de JUnit, à commencer par la <a href="http://junit.sourceforge.net/doc/faq/faq.htm">FAQ</a> quie contient pas mal de conseils généraux sur les tests. Une fois mordu par le bogue vous apprécierez sûrement la phrase <a href="http://junit.sourceforge.net/doc/testinfected/testing.htm">infecté par les tests</a> trouvée par Eric Gamma. Si vous êtes encore en train de tergiverser sur un testeur unitaire, sachez que les choix principaux sont <a href="http://phpunit.sourceforge.net/">PHPUnit</a> et <a href="http://pear.php.net/manual/en/package.php.phpunit.php">Pear PHP::PHPUnit</a>. De nombreuses fonctionnalités de SimpleTest leurs font défaut, mais la version PEAR a d'ores et déjà été mise à jour pour PHP5. Elle est aussi recommandée si vous portez des scénarios de test existant depuis <a href="http://www.junit.org/">JUnit</a>.
</p>
<p>
Les développeurs de bibliothèque n'ont pas l'air de livrer très souvent des tests avec leur code : c'est bien dommage. Le code d'une bibliothèque qui inclut des tests peut être remanié avec plus de sécurité et le code de test sert de documentation additionnelle dans un format assez standard. Ceci peut épargner la pêche aux indices dans le code source lorsque qu'un problème survient, en particulier lors de la mise à jour d'une telle bibliothèque. Parmi les bibliothèques utilisant SimpleTest comme testeur unitaire on retrouve <a href="http://wact.sourceforge.net/">WACT</a> et <a href="http://sourceforge.net/projects/htmlsax">PEAR::XML_HTMLSax</a>.
</p>
<p>
Au jour d'aujourd'hui il manque tristement beaucoup de matière sur les objets fantaisie : dommage, surtout que tester unitairement sans eux représente pas mal de travail en plus. L'<a href="http://www.sidewize.com/company/mockobjects.pdf">article original sur les objets fantaisie</a> est très orienté Java, mais reste intéressant à lire. Etant donné qu'il s'agit d'une nouvelle technologie il y a beaucoup de discussions et de débats sur comment les utiliser, souvent sur des wikis comme <a href="http://xpdeveloper.com/cgi-bin/oldwiki.cgi?MockObjects">Extreme Tuesday</a> ou <a href="http://www.mockobjects.com/MocksObjectsPaper.html">www.mockobjects.com</a>ou <a href="http://c2.com/cgi/wiki?MockObject">the original C2 Wiki</a>. Injecter des objets fantaisie dans une classe est un des champs principaux du débat : cet <a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">article chez IBM</a> en est un bon point de départ.
</p>
<p>
Il y a énormement d'outils de test web mais la plupart sont écrits en Java. De plus les tutoriels et autres conseils sont plutôt rares. Votre seul espoir est de regarder directement la documentation pour <a href="http://httpunit.sourceforge.net/">HTTPUnit</a>, <a href="http://htmlunit.sourceforge.net/">HTMLUnit</a> ou <a href="http://jwebunit.sourceforge.net/">JWebUnit</a> et d'espérer y trouver pour des indices. Il y a aussi des frameworks basés sur XML, mais de nouveau la plupart ont besoin de Java pour tourner.
</p>
</div>
References and related information...
<ul>
<li>
<a href="unit_test_documentation.html">Documentation pour SimpleTest</a>.
</li>
<li>
<a href="http://www.lastcraft.com/first_test_tutorial.php">Comment écrire des scénarios de test en PHP</a> est un tutoriel plutôt avancé.
</li>
<li>
<a href="http://simpletest.org/api/">L'API de SimpleTest</a> par phpdoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,475 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : les objets fantaisie partiels</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les objets fantaisie partiels</h1>
This page...
<ul>
<li>
<a href="#injection">Le problème de l'injection d'un objet fantaisie</a>.
</li>
<li>
Déplacer la création vers une méthode <a href="#creation">fabrique protégée</a>.
</li>
<li>
<a href="#partiel">L'objet fantaisie partiel</a> génère une sous-classe.
</li>
<li>
Les objets fantaisie partiels <a href="#moins">testent moins qu'une classe</a>.
</li>
</ul>
<div class="content">
<p>
Un objet fantaisie partiel n'est ni plus ni moins
qu'un modèle de conception pour soulager un problème spécifique
du test avec des objets fantaisie, celui de placer
des objets fantaisie dans des coins serrés.
Il s'agit d'un outil assez limité et peut-être même
une idée pas si bonne que ça. Elle est incluse dans SimpleTest
pour la simple raison que je l'ai trouvée utile
à plus d'une occasion et qu'elle m'a épargnée
pas mal de travail dans ces moments-là.
</p>
<h2>
<a class="target" name="injection"></a>Le problème de l'injection dans un objet fantaisie</h2>
<p>
Quand un objet en utilise un autre il est très simple
d'y faire circuler une version fantaisie déjà prête
avec ses attentes. Les choses deviennent un peu plus délicates
si un objet en crée un autre et que le créateur est celui
que l'on souhaite tester. Cela revient à dire que l'objet
créé devrait être une fantaisie, mais nous pouvons
difficilement dire à notre classe sous test de créer
un objet fantaisie plutôt qu'un "vrai" objet.
La classe testée ne sait même pas qu'elle travaille dans un environnement de test.
</p>
<p>
Par exemple, supposons que nous sommes en train
de construire un client telnet et qu'il a besoin
de créer une socket réseau pour envoyer ses messages.
La méthode de connexion pourrait ressemble à quelque chose comme...
<pre>
<strong>&lt;?php
require_once('socket.php');
class Telnet {
...
function connect($ip, $port, $username, $password) {
$socket = new Socket($ip, $port);
$socket-&gt;read( ... );
...
}
}
?&gt;</strong>
</pre>
Nous voudrions vraiment avoir une version fantaisie
de l'objet socket, que pouvons nous faire ?
</p>
<p>
La première solution est de passer la socket en
tant que paramètre, ce qui force la création
au niveau inférieur. Charger le client de cette tâche
est effectivement une bonne approche si c'est possible
et devrait conduire à un remaniement -- de la création
à partir de l'action. En fait, c'est là une des manières
avec lesquels tester en s'appuyant sur des objets fantaisie
vous force à coder des solutions plus resserrées sur leur objectif.
Ils améliorent votre programmation.
</p>
<p>
Voici ce que ça devrait être...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...
<strong>function connect($socket, $username, $password) {
$socket-&gt;read( ... );
...
}</strong>
}
?&gt;
</pre>
Sous-entendu, votre code de test est typique d'un cas
de test avec un objet fantaisie.
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new Telnet();
$telnet-&gt;connect($socket, 'Me', 'Secret');
...</strong>
}
}
</pre>
C'est assez évident que vous ne pouvez descendre que d'un niveau.
Vous ne voudriez pas que votre application de haut niveau
crée tous les fichiers de bas niveau, sockets et autres connexions
à la base de données dont elle aurait besoin.
Elle ne connaîtrait pas les paramètres du constructeur de toute façon.
</p>
<p>
La solution suivante est de passer l'objet créé sous la forme
d'un paramètre optionnel...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...<strong>
function connect($ip, $port, $username, $password, $socket = false) {
if (! $socket) {
$socket = new Socket($ip, $port);
}
$socket-&gt;read( ... );</strong>
...
return $socket;
}
}
?&gt;
</pre>
Pour une solution rapide, c'est généralement suffisant.
Ensuite le test est très similaire : comme si le paramètre
était transmis formellement...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret', $socket);
...</strong>
}
}
</pre>
Le problème de cette approche tient dans son manque de netteté.
Il y a du code de test dans la classe principale et aussi
des paramètres transmis dans le scénario de test
qui ne sont jamais utilisés. Il s'agit là d'une approche
rapide et sale, mais qui ne reste pas moins efficace
dans la plupart des situations.
</p>
<p>
Une autre solution encore est de laisser un objet fabrique
s'occuper de la création...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {<strong>
function Telnet($network) {
$this-&gt;_network = $network;
}</strong>
...
function connect($ip, $port, $username, $password) {<strong>
$socket = $this-&gt;_network-&gt;createSocket($ip, $port);
$socket-&gt;read( ... );</strong>
...
return $socket;
}
}
?&gt;
</pre>
Il s'agit là probablement de la réponse la plus travaillée
étant donné que la création est maintenant située
dans une petite classe spécialisée. La fabrique réseau
peut être testée séparément et utilisée en tant que fantaisie
quand nous testons la classe telnet...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$network = new MockNetwork();
$network-&gt;returnsByReference('createSocket', $socket);
$telnet = new Telnet($network);
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
Le problème reste que nous ajoutons beaucoup de classes
à la bibliothèque. Et aussi que nous utilisons beaucoup
de fabriques ce qui rend notre code un peu moins intuitif.
La solution la plus flexible, mais aussi la plus complexe.
</p>
<p>
Des techniques comme "l'Injection de Dépendance"
(ou "Dependency Injection") s'attelle au problème
de l'instanciation d'une classe avec beaucoup de paramètres.
Malheureusement la connaissance de ce patron de conception
n'est pas très répandue et si vous êtes en train d'essayer
de faire fonctionner du vieux code, ré-achitecturer toute
l'application n'est pas vraiment une option.
</p>
<p>
Peut-on trouver un juste milieu ?
</p>
<h2>
<a class="target" name="creation"></a>Méthode fabrique protégée</h2>
<p>
Il existe une technique pour palier à ce problème
sans créer de nouvelle classe dans l'application;
par contre elle induit la création d'une sous-classe au moment du test.
Premièrement nous déplaçons la création de la socket dans sa propre méthode...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...
function connect($ip, $port, $username, $password) {
<strong>$socket = $this-&gt;createSocket($ip, $port);</strong>
$socket-&gt;read( ... );
...
}<strong>
protected function createSocket($ip, $port) {
return new Socket($ip, $port);
}</strong>
}
?&gt;
</pre>
Une première étape plutôt précautionneuse même pour
du code legacy et intermélé.
Il s'agit là de la seule modification dans le code de l'application.
</p>
<p>
Pour le scénario de test, nous devons créer
une sous-classe de manière à intercepter la création de la socket...
<pre>
<strong>class TelnetTestVersion extends Telnet {
var $mock;
function TelnetTestVersion($mock) {
$this-&gt;mock = $mock;
$this-&gt;Telnet();
}
protected function createSocket() {
return $this-&gt;mock;
}
}</strong>
</pre>
Ici j'ai déplacé la fantaisie dans le constructeur,
mais un setter aurait fonctionné tout aussi bien.
Notez bien que la fantaisie est placée dans une variable
d'objet avant que le constructeur ne soit attaché.
C'est nécessaire dans le cas où le constructeur appelle
<span class="new_code">connect()</span>.
Autrement il pourrait donner un valeur nulle à partir de
<span class="new_code">createSocket()</span>.
</p>
<p>
Après la réalisation de tout ce travail supplémentaire
le scénario de test est assez simple.
Nous avons juste besoin de tester notre nouvelle classe à la place...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion($socket);
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
Cette nouvelle classe est très simple bien sûr.
Elle ne fait qu'initier une valeur renvoyée, à la manière
d'une fantaisie. Ce serait pas mal non plus si elle pouvait
vérifier les paramètres entrants.
Exactement comme un objet fantaisie.
Il se pourrait bien que nous ayons à réaliser cette astuce régulièrement :
serait-il possible d'automatiser la création de cette sous-classe ?
</p>
<h2>
<a class="target" name="partiel"></a>Un objet fantaisie partiel</h2>
<p>
Bien sûr la réponse est "oui"
ou alors j'aurais arrêté d'écrire depuis quelques temps déjà !
Le test précédent a représenté beaucoup de travail,
mais nous pouvons générer la sous-classe en utilisant
une approche à celle des objets fantaisie.
</p>
<p>
Voici donc une version avec objet fantaisie partiel du test...
<pre>
<strong>Mock::generatePartial(
'Telnet',
'TelnetTestVersion',
array('createSocket'));</strong>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion();
$telnet-&gt;setReturnReference('createSocket', $socket);
$telnet-&gt;Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
La fantaisie partielle est une sous-classe de l'original
dont on aurait "remplacé" les méthodes sélectionnées
avec des versions de test. L'appel à <span class="new_code">generatePartial()</span>
nécessite trois paramètres : la classe à sous classer,
le nom de la nouvelle classe et une liste des méthodes à simuler.
</p>
<p>
Instancier les objets qui en résultent est plutôt délicat.
L'unique paramètre du constructeur d'un objet fantaisie partiel
est la référence du testeur unitaire.
Comme avec les objets fantaisie classiques c'est nécessaire
pour l'envoi des résultats de test en réponse à la vérification des attentes.
</p>
<p>
Une nouvelle fois le constructeur original n'est pas lancé.
Indispensable dans le cas où le constructeur aurait besoin
des méthodes fantaisie : elles n'ont pas encore été initiées !
Nous initions les valeurs retournées à cet instant et
ensuite lançons le constructeur avec ses paramètres normaux.
Cette construction en trois étapes de "new",
suivie par la mise en place des méthodes et ensuite
par la lancement du constructeur proprement dit est
ce qui distingue le code d'un objet fantaisie partiel.
</p>
<p>
A part pour leur construction, toutes ces méthodes
fantaisie ont les mêmes fonctionnalités que dans
le cas des objets fantaisie et toutes les méthodes
non fantaisie se comportent comme avant.
Nous pouvons mettre en place des attentes très facilement...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion();
$telnet-&gt;setReturnReference('createSocket', $socket);
<strong>$telnet-&gt;expectOnce('createSocket', array('127.0.0.1', 21));</strong>
$telnet-&gt;Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');
}
}
</pre>
Les objets fantaisie partiels ne sont pas très utilisés.
Je les considère comme transitoire.
Utile lors d'un remaniement, mais une fois que l'application
a eu toutes ses dépendances bien séparées alors
ils peuvent disparaître.
</p>
<h2>
<a class="target" name="moins"></a>Tester moins qu'une classe</h2>
<p>
Les méthodes issues d'un objet fantaisie n'ont pas
besoin d'être des méthodes fabrique, Il peut s'agir
de n'importe quelle sorte de méthode.
Ainsi les objets fantaisie partiels nous permettent
de prendre le contrôle de n'importe quelle partie d'une classe,
le constructeur excepté. Nous pourrions même aller jusqu'à
créer des fantaisies sur toutes les méthodes à part celle
que nous voulons effectivement tester.
</p>
<p>
Cette situation est assez hypothétique, étant donné
que je ne l'ai pas souvent essayée.
Je crains qu'en forçant la granularité d'un objet
on n'obtienne pas forcément un code de meilleur qualité.
Personnellement j'utilise les objets fantaisie partiels
comme moyen de passer outre la création ou alors
de temps en temps pour tester le modèle de conception TemplateMethod.
</p>
<p>
On en revient toujours aux standards de code de votre projet :
c'est à vous de trancher si vous autorisez ce mécanisme ou non.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API complète pour SimpleTest</a>
à partir de PHPDoc.
</li>
<li>
La méthode fabrique protégée est décrite dans
<a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">
cet article d'IBM</a>. Il s'agit de l'unique papier
formel que j'ai vu sur ce problème.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,630 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : le rapporteur de test</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le rapporteur de test</h1>
This page...
<ul>
<li>
Afficher <a href="#html">les résultats en HTML</a>
</li>
<li>
Afficher et <a href="#autres">rapporter les résultats</a>
dans d'autres formats
</li>
<li>
Utilisé <a href="#cli">SimpleTest depuis la ligne de commande</a>
</li>
<li>
<a href="#xml">Utiliser XML</a> pour des tests distants
</li>
</ul>
<div class="content">
<p>
SimpleTest suit plutôt plus que moins le modèle MVC (Modèle-Vue-Contrôleur).
Les classes "reporter" sont les vues et les modèles
sont vos scénarios de test et leur hiérarchie.
Le contrôleur est le plus souvent masqué à l'utilisateur
de SimpleTest à moins de vouloir changer la façon
dont les tests sont effectivement exécutés,
auquel cas il est possible de surcharger les objets
"runner" (ceux de l'exécuteur) depuis l'intérieur
d'un scénario de test. Comme d'habitude avec MVC,
le contrôleur est plutôt indéfini et il existe d'autres endroits
pour contrôler l'exécution des tests.
</p>
<h2>
<a class="target" name="html"></a>Les résultats rapportés au format HTML</h2>
<p>
L'affichage par défaut est minimal à l'extrême.
Il renvoie le succès ou l'échec avec les barres conventionnelles
- rouge et verte - et affichent une trace d'arborescence
des groupes de test pour chaque assertion erronée. Voici un tel échec...
<div class="demo">
<h1>File test</h1>
<span class="fail">Fail</span>: createnewfile-&gt;True assertion failed.<br>
<div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete.
<strong>0</strong> passes, <strong>1</strong> fails and <strong>0</strong> exceptions.</div>
</div>
Alors qu'ici tous les tests passent...
<div class="demo">
<h1>File test</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>1</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
La bonne nouvelle, c'est qu'il existe pas mal de points
dans la hiérarchie de l'affichage pour créer des sous-classes.
</p>
<p>
Pour l'affichage basé sur des pages web,
il y a la classe <span class="new_code">HtmlReporter</span> avec la signature suivante...
<pre>
class HtmlReporter extends SimpleReporter {
public __construct($encoding) { ... }
public makeDry(boolean $is_dry) { ... }
public void paintHeader(string $test_name) { ... }
public void sendNoCacheHeaders() { ... }
public void paintFooter(string $test_name) { ... }
public void paintGroupStart(string $test_name, integer $size) { ... }
public void paintGroupEnd(string $test_name) { ... }
public void paintCaseStart(string $test_name) { ... }
public void paintCaseEnd(string $test_name) { ... }
public void paintMethodStart(string $test_name) { ... }
public void paintMethodEnd(string $test_name) { ... }
public void paintFail(string $message) { ... }
public void paintPass(string $message) { ... }
public void paintError(string $message) { ... }
public void paintException(string $message) { ... }
public void paintMessage(string $message) { ... }
public void paintFormattedMessage(string $message) { ... }
protected string getCss() { ... }
public array getTestList() { ... }
public integer getPassCount() { ... }
public integer getFailCount() { ... }
public integer getExceptionCount() { ... }
public integer getTestCaseCount() { ... }
public integer getTestCaseProgress() { ... }
}
</pre>
Voici ce que certaines de ces méthodes veulent dire.
Premièrement les méthodes d'affichage que vous voudrez probablement surcharger...
<ul class="api">
<li>
<span class="new_code">HtmlReporter(string $encoding)</span><br>
est le constructeur. Notez que le test unitaire initie
le lien à l'affichage plutôt que l'opposé.
L'affichage est principalement un receveur passif
des évènements de tests. Cela permet d'adapter
facilement l'affichage pour d'autres systèmes
en dehors des tests unitaires, tel le suivi
de la charge de serveurs.
L'"encoding" est le type d'encodage
que vous souhaitez utiliser pour l'affichage du test.
Pour pouvoir effectuer un rendu correct de la sortie
de débogage quand on utilise le testeur web,
il doit correspondre à l'encodage du site testé.
Les chaînes de caractères disponibles
sont indiquées dans la fonction PHP
<a href="http://www.php.net/manual/fr/function.htmlentities.php">html_entities()</a>.
</li>
<li>
<span class="new_code">void paintHeader(string $test_name)</span><br>
est appelé une fois, au début du test quand l'évènement
de démarrage survient. Le premier évènement de démarrage
est souvent délivré par le groupe de tests du niveau
le plus haut et donc c'est de là que le
<span class="new_code">$test_name</span> arrive.
Il peint le titre de la page, CSS, la balise "body", etc.
Il ne renvoie rien du tout (<span class="new_code">void</span>).
</li>
<li>
<span class="new_code">void paintFooter(string $test_name)</span><br>
est appelé à la toute fin du test pour fermer
les balises ouvertes par l'entête de la page.
Par défaut il affiche aussi la barre rouge ou verte
et le décompte final des résultats.
En fait la fin des tests arrive quand l'évènement
de fin de test arrive avec le même nom
que celui qui l'a initié au même niveau.
Le nid des tests en quelque sorte.
Fermer le dernier test finit l'affichage.
</li>
<li>
<span class="new_code">void paintMethodStart(string $test_name)</span><br>
est appelé au début de chaque méthode de test.
Normalement le nom vient de celui de la méthode.
Les autres évènements de départ de test
se comportent de la même manière sauf que
celui du groupe de tests indique au rapporteur
le nombre de scénarios de test qu'il contient.
De la sorte le rapporteur peut afficher une barre
de progrès au fur et à mesure que l'exécuteur
passe en revue les scénarios de test.
</li>
<li>
<span class="new_code">void paintMethodEnd(string $test_name)</span><br>
clôt le test lancé avec le même nom.
</li>
<li>
<span class="new_code">void paintFail(string $message)</span><br>
peint un échec. Par défaut il ne fait qu'afficher
le mot "fail", une trace d'arborescence
affichant la position du test en cours
et le message transmis par l'assertion.
</li>
<li>
<span class="new_code">void paintPass(string $message)</span><br>
ne fait rien, par défaut.
</li>
<li>
<span class="new_code">string getCss()</span><br>
renvoie les styles CSS sous la forme d'une chaîne
à l'attention de la méthode d'entêtes d'une page.
Des styles additionnels peuvent être ajoutés ici
si vous ne surchargez pas les entêtes de la page.
Vous ne voudrez pas utiliser cette méthode dans
des entêtes d'une page surchargée si vous souhaitez
inclure le feuille de style CSS d'origine.
</li>
</ul>
Il y a aussi des accesseurs pour aller chercher l'information
sur l'état courant de la suite de test. Vous les utiliserez
pour enrichir l'affichage...
<ul class="api">
<li>
<span class="new_code">array getTestList()</span><br>
est la première méthode très commode pour les sous-classes.
Elle liste l'arborescence courante des tests
sous la forme d'une liste de noms de tests.
Le premier test -- celui de premier niveau --
sera le premier dans la liste et la méthode de test
en cours sera la dernière.
</li>
<li>
<span class="new_code">integer getPassCount()</span><br>
renvoie le nombre de succès atteint. Il est nécessaire
pour l'affichage à la fin.
</li>
<li>
<span class="new_code">integer getFailCount()</span><br>
renvoie de la même manière le nombre d'échecs.
</li>
<li>
<span class="new_code">integer getExceptionCount()</span><br>
renvoie quant à lui le nombre d'erreurs.
</li>
<li>
<span class="new_code">integer getTestCaseCount()</span><br>
est le nombre total de scénarios lors de l'exécution des tests.
Il comprend aussi les tests groupés.
</li>
<li>
<span class="new_code">integer getTestCaseProgress()</span><br>
est le nombre de scénarios réalisés jusqu'à présent.
</li>
</ul>
Une modification simple : demander à l'HtmlReporter d'afficher
aussi bien les succès que les échecs et les erreurs...
<pre>
<strong>class ReporterShowingPasses extends HtmlReporter {
function paintPass($message) {
parent::paintPass($message);
print "&lt;span class=\"pass\"&gt;Pass&lt;/span&gt;: ";
$breadcrumb = $this-&gt;getTestList();
array_shift($breadcrumb);
print implode("-&amp;gt;", $breadcrumb);
print "-&amp;gt;$message&lt;br /&gt;\n";
}
protected function getCss() {
return parent::getCss() . ' .pass { color: green; }';
}
}</strong>
</pre>
</p>
<p>
Une méthode qui a beaucoup fait jaser reste la méthode <span class="new_code">makeDry()</span>.
Si vous lancez cette méthode, sans paramètre,
sur le rapporteur avant que la suite de test
ne soit exécutée alors aucune méthode de test
ne sera appelée. Vous continuerez à avoir
les évènements entrants et sortants des méthodes
et scénarios de test, mais aucun succès ni échec ou erreur,
parce que le code de test ne sera pas exécuté.
</p>
<p>
La raison ? Pour permettre un affichage complexe
d'une IHM (ou GUI) qui permettrait la sélection
de scénarios de test individuels.
Afin de construire une liste de tests possibles,
ils ont besoin d'un rapport sur la structure du test
pour l'affichage, par exemple, d'une vue en arbre
de la suite de test. Avec un rapporteur lancé
sur une exécution sèche qui ne renverrait
que les évènements d'affichage, cela devient
facilement réalisable.
</p>
<h2>
<a class="target" name="autre"></a>Etendre le rapporteur</h2>
<p>
Plutôt que de modifier l'affichage existant,
vous voudrez peut-être produire une présentation HTML
complètement différente, ou même générer une version texte ou XML.
Plutôt que de surcharger chaque méthode dans
<span class="new_code">HtmlReporter</span> nous pouvons nous rendre
une étape plus haut dans la hiérarchie de classe vers
<span class="new_code">SimpleReporter</span> dans le fichier source <em>simple_test.php</em>.
</p>
<p>
Un affichage sans rien, un canevas vierge
pour votre propre création, serait...
<pre>
<strong>require_once('simpletest/simpletest.php');</strong>
class MyDisplay extends SimpleReporter {<strong>
</strong>
function paintHeader($test_name) { }
function paintFooter($test_name) { }
function paintStart($test_name, $size) {<strong>
parent::paintStart($test_name, $size);</strong>
}
function paintEnd($test_name, $size) {<strong>
parent::paintEnd($test_name, $size);</strong>
}
function paintPass($message) {<strong>
parent::paintPass($message);</strong>
}
function paintFail($message) {<strong>
parent::paintFail($message);</strong>
}
function paintError($message) {<strong>
parent::paintError($message);</strong>
}
function paintException($exception) {<strong>
parent::paintException($exception);</strong>
}
}
</pre>
Aucune sortie ne viendrait de cette classe jusqu'à un ajout de votre part.
</p>
<p>
Sauf qu'il y a un problème : en utilisant cette cette classe
de bas niveau, vous devez explicitement l'invoquer
dans les scripts de test.
La commande "autorun" ne sera pas capable
d'utiliser son contexte courant (qu'elle soit lancée
dans un navigateur web ou via une ligne de commande)
pour sélectionner le rapporteur.
</p>
<p>
Vous invoquez explicitement la lanceur de tests comme suit...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
$test-&gt;run(<strong>new MyReporter()</strong>);
?&gt;
</pre>
...ou peut-être comme cela...
<pre>
&lt;?php
require_once('simpletest/simpletest.php');
require_once('my_reporter.php');
class MyTest extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('tests/file_test.php');
}
}
$test = new MyTest();
$test-&gt;run(<strong>new MyReporter()</strong>);
?&gt;
</pre>
Nous verrons plus comment l'intégrer avec l'"autorun".
</p>
<h2>
<a class="target" name="cli"></a>Le rapporteur en ligne de commande</h2>
<p>
SimpleTest est aussi livré avec un rapporteur
en ligne de commande, minime lui aussi.
Pour utiliser le rapporteur en ligne de commande explicitement,
il suffit de l'intervertir avec celui de la version HTML...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
$test-&gt;run(<strong>new TextReporter()</strong>);
?&gt;
</pre>
Et ensuite d'invoquer la suite de test à partir d'une ligne de commande...
<pre class="shell">
php file_test.php
</pre>
Bien sûr vous aurez besoin d'installer PHP
en ligne de commande. Une suite de test qui
passerait toutes ses assertions ressemble à...
<pre class="shell">
File test
OK
Test cases run: 1/1, Passes: 1, Failures: 0, Exceptions: 0
</pre>
Un échec déclenche un affichage comme...
<pre class="shell">
File test
1) True assertion failed.
in createNewFile
FAILURES!!!
Test cases run: 1/1, Passes: 0, Failures: 1, Exceptions: 0
</pre>
</p>
<p>
Une des principales raisons pour utiliser
une suite de test en ligne de commande tient
dans l'utilisation possible du testeur avec
un processus automatisé. Pour fonctionner comme
il faut dans des scripts shell le script de test
devrait renvoyer un code de sortie non-nul suite à un échec.
Si une suite de test échoue la valeur <span class="new_code">false</span>
est renvoyée par la méthode <span class="new_code">SimpleTest::run()</span>.
Nous pouvons utiliser ce résultat pour terminer le script
avec la bonne valeur renvoyée...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
<strong>exit ($test-&gt;run(new TextReporter()) ? 0 : 1);</strong>
?&gt;
</pre>
Bien sûr l'objectif ne serait pas de créer deux scripts de test,
l'un en ligne de commande et l'autre pour un navigateur web,
pour chaque suite de test.
Le rapporteur en ligne de commande inclut
une méthode pour déterminer l'environnement d'exécution...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
<strong>if (TextReporter::inCli()) {</strong>
exit ($test-&gt;run(new TextReporter()) ? 0 : 1);
<strong>}</strong>
$test-&gt;run(new HtmlReporter());
?&gt;
</pre>
Il s'agit là de la forme utilisée par SimpleTest lui-même.
Quand vous utilisez l'"autorun.php"
et qu'aucun test n'a été lancé avant la fin,
c'est quasiment le code que SimpleTest lancera
pour vous implicitement.
</p>
<p>
En d'autres termes, ceci donne le même résultat...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class MyTest extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('tests/file_test.php');
}
}
?&gt;
</pre> </p>
<h2>
<a class="target" name="xml"></a>Test distant</h2>
<p>
SimpleTest est livré avec une classe <span class="new_code">XmlReporter</span>
utilisée pour de la communication interne.
Lors de son exécution, le résultat ressemble à...
<pre class="shell">
&lt;?xml version="1.0"?&gt;
&lt;run&gt;
&lt;group size="4"&gt;
&lt;name&gt;Remote tests&lt;/name&gt;
&lt;group size="4"&gt;
&lt;name&gt;Visual test with 48 passes, 48 fails and 4 exceptions&lt;/name&gt;
&lt;case&gt;
&lt;name&gt;testofunittestcaseoutput&lt;/name&gt;
&lt;test&gt;
&lt;name&gt;testofresults&lt;/name&gt;
&lt;pass&gt;This assertion passed&lt;/pass&gt;
&lt;fail&gt;This assertion failed&lt;/fail&gt;
&lt;/test&gt;
&lt;test&gt;
...
&lt;/test&gt;
&lt;/case&gt;
&lt;/group&gt;
&lt;/group&gt;
&lt;/run&gt;
</pre>
Pour faire en sorte ue vos scénarios de test produisent ce format,
dans la ligne de commande, ajoutez le flag <span class="new_code">--xml</span>.
<pre class="shell">
php my_test.php --xml
</pre>
Vous pouvez faire la même chose dans le navigation web
en ajoutant le paramètre <span class="new_code">xml=1</span> dans l'URL.
N'importe quelle valeur "true" fera l'affaire.
</p>
<p>
Vous pouvez utiliser ce format avec le parseur
fourni dans SimpleTest lui-même.
Il s'agit de <span class="new_code">SimpleTestXmlParser</span>
et se trouve <em>xml.php</em> à l'intérieur du paquet SimpleTest...
<pre>
&lt;?php
require_once('simpletest/xml.php');
...
$parser = new SimpleTestXmlParser(new HtmlReporter());
$parser-&gt;parse($test_output);
?&gt;
</pre>
<span class="new_code">$test_output</span> devrait être au format XML,
à partir du rapporteur XML, et pourrait venir
d'une exécution en ligne de commande d'un scénario de test.
Le parseur envoie des évènements au rapporteur exactement
comme tout autre exécution de test.
Il y a des occasions bizarres dans lesquelles c'est en fait très utile.
</p>
<p>
Le plus courant, c'est quand vous voulez isoler
un test sensible au crash.
Vous pouvez collecter la sortie XML en utilisant
l'opérateur antiquote (Ndt : backtick) à partir
d'un autre test.
De la sorte, il tourne dans son propre processus...
<pre>
&lt;?php
require_once('simpletest/xml.php');
if (TextReporter::inCli()) {
$parser = new SimpleTestXmlParser(new TextReporter());
} else {
$parser = new SimpleTestXmlParser(new HtmlReporter());
}
$parser-&gt;parse(`php flakey_test.php --xml`);
?&gt;
</pre>
</p>
<p>
Un autre cas est celui des très longues suites de tests.
</p>
<p>
Elles peuvent venir à bout de la limite de mémoire
par défaut d'un process PHP - 16Mb.
En plaçant la sortie des groupes de test dans du XML
et leur exécution dans des process différents,
le résultat peut être parsé à nouveau pour agréger
les résultats avec moins d'impact sur le test au premier niveau.
</p>
<p>
Parce que la sortie XML peut venir de n'importe où,
ça ouvre des possibilités d'agrégation d'exécutions de test
depuis des serveur distants.
Un scénario de test pour le réaliser existe déjà
à l'intérieur du framework SimpleTest, mais il est encore expérimental...
<pre>
&lt;?php
<strong>require_once('../remote.php');</strong>
require_once('simpletest/autorun.php');
$test_url = ...;
$dry_url = ...;
class MyTestOnAnotherServer extends RemoteTestCase {
function __construct() {
$test_url = ...
parent::__construct($test_url, $test_url . ' --dry');
}
}
?&gt;
</pre>
<span class="new_code">RemoteTestCase</span> prend la localisation réelle
du lanceur de test, tout simplement un page web au format XML.
Il prend aussi l'URL d'un rapporteur initié
pour effectuer une exécution sèche.
Cette technique est employée pour que les progrès
soient correctement rapportés vers le haut.
<span class="new_code">RemoteTestCase</span> peut être ajouté à
une suite de test comme n'importe quelle autre suite de tests.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
L'<a href="http://simpletest.org/api/">API pour développeur de SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,447 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest pour les tests de régression en PHP</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les tests unitaires en PHP</h1>
This page...
<ul>
<li>
<a href="#unitaire">Scénarios de test unitaire</a>
et opérations basiques.
</li>
<li>
<a href="#extension_unitaire">Étendre des scénarios de test</a>
pour les personnaliser à votre propre projet.
</li>
<li>
<a href="#lancement_unitaire">Lancer un scénario seul</a>
comme un script unique.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="unitaire"></a>Scénarios de tests unitaires</h2>
<p>
Le coeur du système est un framework de tests de régression
construit autour des scénarios de test.
Un exemple de scénario de test ressemble à...
<pre>
<strong>class FileTestCase extends UnitTestCase {
}</strong>
</pre>
Si aucun nom de test n'est fourni au moment
de la liaison avec le constructeur alors
le nom de la classe sera utilisé.
Il s'agit du nom qui sera affiché dans les résultats du test.
</p>
<p>
Les véritables tests sont ajoutés en tant que méthode
dans le scénario de test dont le nom par défaut
commence par la chaîne "test"
et quand le scénario de test est appelé toutes les méthodes
de ce type sont exécutées dans l'ordre utilisé
par l'introspection de PHP pour les trouver.
Peuvent être ajoutées autant de méthodes de test que nécessaires.
Par exemple...
<pre>
require_once('simpletest/autorun.php');
require_once('../classes/writer.php');
class FileTestCase extends UnitTestCase {
function FileTestCase() {
$this-&gt;UnitTestCase('File test');
}<strong>
function setUp() {
@unlink('../temp/test.txt');
}
function tearDown() {
@unlink('../temp/test.txt');
}
function testCreation() {
$writer = &amp;new FileWriter('../temp/test.txt');
$writer-&gt;write('Hello');
$this-&gt;assertTrue(file_exists('../temp/test.txt'), 'File created');
}</strong>
}
</pre>
Le constructeur est optionnel et souvent omis. Sans nom,
le nom de la classe est utilisé comme nom pour le scénario de test.
</p>
<p>
Notre unique méthode de test pour le moment est
<span class="new_code">testCreation()</span> où nous vérifions
qu'un fichier a bien été créé par notre objet
<span class="new_code">Writer</span>. Nous pourrions avoir mis
le code <span class="new_code">unlink()</span> dans cette méthode,
mais en la plaçant dans <span class="new_code">setUp()</span>
et <span class="new_code">tearDown()</span> nous pouvons l'utiliser
pour nos autres méthodes de test que nous ajouterons.
</p>
<p>
La méthode <span class="new_code">setUp()</span> est lancé
juste avant chaque méthode de test.
<span class="new_code">tearDown()</span> est lancé après chaque méthode de test.
</p>
<p>
Vous pouvez placer une initialisation de
scénario de test dans le constructeur afin qu'elle soit lancée
pour toutes les méthodes dans le scénario de test
mais dans un tel cas vous vous exposeriez à des interférences.
Cette façon de faire est légèrement moins rapide,
mais elle est plus sûre.
Notez que si vous arrivez avec des notions de JUnit,
il ne s'agit pas du comportement auquel vous êtes habitués.
Bizarrement JUnit re-instancie le scénario de test
pour chaque méthode de test pour se prévenir
d'une telle interférence.
SimpleTest demande à l'utilisateur final d'utiliser
<span class="new_code">setUp()</span>, mais fournit aux codeurs de bibliothèque d'autres crochets.
</p>
<p>
Pour rapporter les résultats de test,
le passage par une classe d'affichage - notifiée par
les différentes méthodes de type <span class="new_code">assert...()</span> -
est utilisée. En voici la liste complète pour
la classe <span class="new_code">UnitTestCase</span>,
celle par défaut dans SimpleTest...
<table><tbody>
<tr>
<td><span class="new_code">assertTrue($x)</span></td>
<td>Echoue si $x est faux</td>
</tr>
<tr>
<td><span class="new_code">assertFalse($x)</span></td>
<td>Echoue si $x est vrai</td>
</tr>
<tr>
<td><span class="new_code">assertNull($x)</span></td>
<td>Echoue si $x est initialisé</td>
</tr>
<tr>
<td><span class="new_code">assertNotNull($x)</span></td>
<td>Echoue si $x n'est pas initialisé</td>
</tr>
<tr>
<td><span class="new_code">assertIsA($x, $t)</span></td>
<td>Echoue si $x n'est pas de la classe ou du type $t</td>
</tr>
<tr>
<td><span class="new_code">assertEqual($x, $y)</span></td>
<td>Echoue si $x == $y est faux</td>
</tr>
<tr>
<td><span class="new_code">assertNotEqual($x, $y)</span></td>
<td>Echoue si $x == $y est vrai</td>
</tr>
<tr>
<td><span class="new_code">assertIdentical($x, $y)</span></td>
<td>Echoue si $x === $y est faux</td>
</tr>
<tr>
<td><span class="new_code">assertNotIdentical($x, $y)</span></td>
<td>Echoue si $x === $y est vrai</td>
</tr>
<tr>
<td><span class="new_code">assertReference($x, $y)</span></td>
<td>Echoue sauf si $x et $y sont la même variable</td>
</tr>
<tr>
<td><span class="new_code">assertCopy($x, $y)</span></td>
<td>Echoue si $x et $y sont la même variable</td>
</tr>
<tr>
<td><span class="new_code">assertPattern($p, $x)</span></td>
<td>Echoue sauf si l'expression rationnelle $p capture $x</td>
</tr>
<tr>
<td><span class="new_code">assertNoPattern($p, $x)</span></td>
<td>Echoue si l'expression rationnelle $p capture $x</td>
</tr>
<tr>
<td><span class="new_code">expectError($x)</span></td>
<td>Echoue si l'erreur correspondante n'arrive pas</td>
</tr>
<tr>
<td><span class="new_code">expectException($x)</span></td>
<td>Echoue si l'exception correspondante n'est pas levée</td>
</tr>
<tr>
<td><span class="new_code">ignoreException($x)</span></td>
<td>Avale toutes les exceptions correspondantes qui surviendraient</td>
</tr>
<tr>
<td><span class="new_code">assert($e)</span></td>
<td>Echoue sur un objet <a href="expectation_documentation.html">attente</a> $e qui échouerait</td>
</tr>
</tbody></table>
Toutes les méthodes d'assertion peuvent recevoir
une description optionnelle :
cette description sert pour étiqueter le résultat.
Sans elle, une message par défaut est envoyée à la place :
il est généralement suffisant.
Ce message par défaut peut encore être encadré
dans votre propre message si vous incluez "%s"
dans la chaîne.
Toutes les assertions renvoient vrai / true en cas de succès
et faux / false en cas d'échec.
</p>
<p>
D'autres exemples...
<pre>
<strong>$variable = null;
$this-&gt;assertNull($variable, 'Should be cleared');</strong>
</pre>
...passera et normalement n'affichera aucun message.
Si vous avez <a href="http://www.lastcraft.com/display_subclass_tutorial.php">
configuré le testeur pour afficher aussi les succès</a>
alors le message sera affiché comme tel.
<pre>
<strong>$this-&gt;assertIdentical(0, false, 'Zero is not false [%s]');</strong>
</pre>
Ceci échouera étant donné qu'il effectue une vérification
sur le type en plus d'une comparaison sur les deux valeurs.
La partie "%s" est remplacée par le message d'erreur
par défaut qui aurait été affiché si nous n'avions pas fourni le nôtre.
Cela nous permet d'emboîter les messages de test.
<pre>
<strong>$a = 1;
$b = $a;
$this-&gt;assertReference($a, $b);</strong>
</pre>
Échouera étant donné que la variable <span class="new_code">$b</span>
est une copie de <span class="new_code">$a</span>.
<pre>
<strong>$this-&gt;assertPattern('/hello/i', 'Hello world');</strong>
</pre>
Là, ça passe puisque la recherche est insensible
à la casse et que donc <span class="new_code">hello</span>
est bien repérable dans <span class="new_code">Hello world</span>.
<pre>
<strong>$this-&gt;expectError();</strong>
trigger_error('Catastrophe');
</pre>
Ici la vérification attrape le message "Catastrophe"
sans vérifier le texte et passe.
Elle enlève l'erreur de la queue au passage.
<pre>
<strong>$this-&gt;expectError('Catastrophe');</strong>
trigger_error('Catastrophe');
</pre>
La vérification d'erreur suivante teste non seulement
l'existance de l'erreur mais aussi le texte qui,
dans le cas présent, correspond et donc un nouveau succès.
Si des erreurs non vérifiées sont laissées pour compte
à la fin d'une méthode de test alors un exception sera levé
dans le test.
</p>
<p>
Notez que SimpleTest ne peut pas attraper des erreurs PHP
au moment de la compilation.
</p>
<p>
Les scénarios de tests peuvent utiliser des méthodes
bien pratiques pour déboguer le code ou pour étendre la suite...
<table><tbody>
<tr>
<td><span class="new_code">setUp()</span></td>
<td>Est lancée avant chaque méthode de test</td>
</tr>
<tr>
<td><span class="new_code">tearDown()</span></td>
<td>Est lancée après chaque méthode de test</td>
</tr>
<tr>
<td><span class="new_code">pass()</span></td>
<td>Envoie un succès</td>
</tr>
<tr>
<td><span class="new_code">fail()</span></td>
<td>Envoie un échec</td>
</tr>
<tr>
<td><span class="new_code">error()</span></td>
<td>Envoi un évènement exception</td>
</tr>
<tr>
<td><span class="new_code">signal($type, $payload)</span></td>
<td>Envoie un message défini par l'utilisateur au rapporteur du test</td>
</tr>
<tr>
<td><span class="new_code">dump($var)</span></td>
<td>Effectue un <span class="new_code">print_r()</span> formaté pour du déboguage rapide et grossier</td>
</tr>
</tbody></table>
</p>
<h2>
<a class="target" name="extension_unitaire"></a>Etendre les scénarios de test</h2>
<p>
Bien sûr des méthodes supplémentaires de test
peuvent être ajoutées pour créer d'autres types
de scénario de test afin d'étendre le framework...
<pre>
require_once('simpletest/autorun.php');
<strong>
class FileTester extends UnitTestCase {
function FileTester($name = false) {
$this-&gt;UnitTestCase($name);
}
function assertFileExists($filename, $message = '%s') {
$this-&gt;assertTrue(
file_exists($filename),
sprintf($message, 'File [$filename] existence check'));
}</strong>
}
</pre>
Ici la bibliothèque SimpleTest est localisée
dans un répertoire local appelé <em>simpletest</em>.
Pensez à le modifier pour votre propre environnement.
</p>
<p>
Alternativement vous pourriez utiliser dans votre code
un directive <span class="new_code">SimpleTestOptions::ignore('FileTester');</span>.
</p>
<p>
Ce nouveau scénario peut être hérité exactement
comme un scénario de test classique...
<pre>
class FileTestCase extends <strong>FileTester</strong> {
function setUp() {
@unlink('../temp/test.txt');
}
function tearDown() {
@unlink('../temp/test.txt');
}
function testCreation() {
$writer = &amp;new FileWriter('../temp/test.txt');
$writer-&gt;write('Hello');<strong>
$this-&gt;assertFileExists('../temp/test.txt');</strong>
}
}
</pre>
</p>
<p>
Si vous souhaitez un scénario de test sans
toutes les assertions de <span class="new_code">UnitTestCase</span>
mais uniquement avec les vôtres propres,
vous aurez besoin d'étendre la classe
<span class="new_code">SimpleTestCase</span> à la place.
Elle se trouve dans <em>simple_test.php</em>
en lieu et place de <em>unit_tester.php</em>.
A consulter <a href="group_test_documentation.html">plus tard</a>
si vous souhaitez incorporer les scénarios
d'autres testeurs unitaires dans votre suite de test.
</p>
<h2>
<a class="target" name="lancement_unitaire"></a>Lancer un unique scénario de test</h2>
<p>
Ce n'est pas souvent qu'il faille lancer des scénarios
avec un unique test. Sauf lorsqu'il s'agit de s'arracher
les cheveux sur un module à problème sans pour
autant désorganiser la suite de test principale.
Avec <em>autorun</em> aucun échafaudage particulier
n'est nécessaire, il suffit de lancer votre test et
vous y êtes.
</p>
<p>
Vous pouvez même décider quel rapporteur
(par exemple, <span class="new_code">TextReporter</span> ou <span class="new_code">HtmlReporter</span>)
vous préférez pour un fichier spécifique quand il est lancé
tout seul...
<pre>
&lt;?php
require_once('simpletest/autorun.php');<strong>
SimpleTest :: prefer(new TextReporter());</strong>
require_once('../classes/writer.php');
class FileTestCase extends UnitTestCase {
...
}
?&gt;
</pre>
Ce script sera lancé tel que mais il n'y aura
aucun succès ou échec avant que des méthodes de test soient ajoutées.
</p>
</div>
References and related information...
<ul>
<li>
La page de SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API complète de SimpleTest</a>
à partir de PHPDoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,570 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : tester des scripts web</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le testeur web</h1>
This page...
<ul>
<li>
Réussir à <a href="#telecharger">télécharger une page web</a>
</li>
<li>
Tester le <a href="#contenu">contenu de la page</a>
</li>
<li>
<a href="#navigation">Naviguer sur un site web</a> pendant le test
</li>
<li>
Méthodes pour <a href="#requete">modifier une requête</a> et pour déboguer
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="telecharger"></a>Télécharger une page</h2>
<p>
Tester des classes c'est très bien.
Reste que PHP est avant tout un langage
pour créer des fonctionnalités à l'intérieur de pages web.
Comment pouvons tester la partie de devant
-- celle de l'interface -- dans nos applications en PHP ?
Etant donné qu'une page web n'est constituée que de texte,
nous devrions pouvoir les examiner exactement
comme n'importe quelle autre donnée de test.
</p>
<p>
Cela nous amène à une situation délicate.
Si nous testons dans un niveau trop bas,
vérifier des balises avec un motif ad hoc par exemple,
nos tests seront trop fragiles. Le moindre changement
dans la présentation pourrait casser un grand nombre de test.
Si nos tests sont situés trop haut, en utilisant
une version fantaisie du moteur de template pour
donner un cas précis, alors nous perdons complètement
la capacité à automatiser certaines classes de test.
Par exemple, l'interaction entre des formulaires
et la navigation devra être testé manuellement.
Ces types de test sont extrêmement fastidieux
et plutôt sensibles aux erreurs.
</p>
<p>
SimpleTest comprend une forme spéciale de scénario
de test pour tester les actions d'une page web.
<span class="new_code">WebTestCase</span> inclut des facilités pour la navigation,
des vérifications sur le contenu
et les cookies ainsi que la gestion des formulaires.
Utiliser ces scénarios de test ressemble
fortement à <span class="new_code">UnitTestCase</span>...
<pre>
<strong>class TestOfLastcraft extends WebTestCase {
}</strong>
</pre>
Ici nous sommes sur le point de tester
le site de <a href="http://www.lastcraft.com/">Last Craft</a>.
Si ce scénario de test est situé dans un fichier appelé
<em>lastcraft_test.php</em> alors il peut être chargé
dans un script de lancement tout comme des tests unitaires...
<pre>
&lt;?php
require_once('simpletest/autorun.php');<strong>
require_once('simpletest/web_tester.php');</strong>
SimpleTest::prefer(new TextReporter());
class WebTests extends TestSuite {
function WebTests() {
$this-&gt;TestSuite('Web site tests');<strong>
$this-&gt;addFile('lastcraft_test.php');</strong>
}
}
?&gt;
</pre>
J'utilise ici le rapporteur en mode texte
pour mieux distinguer le contenu au format HTML
du résultat du test proprement dit.
</p>
<p>
Rien n'est encore testé. Nous pouvons télécharger
la page d'accueil en utilisant la méthode <span class="new_code">get()</span>...
<pre>
class TestOfLastcraft extends WebTestCase {
<strong>
function testHomepage() {
$this-&gt;assertTrue($this-&gt;get('http://www.lastcraft.com/'));
}</strong>
}
</pre>
La méthode <span class="new_code">get()</span> renverra "true"
uniquement si le contenu de la page a bien été téléchargé.
C'est un moyen simple, mais efficace pour vérifier
qu'une page web a bien été délivré par le serveur web.
Cependant le contenu peut révéler être une erreur 404
et dans ce cas notre méthode <span class="new_code">get()</span> renverrait encore un succès.
</p>
<p>
En supposant que le serveur web pour le site Last Craft
soit opérationnel (malheureusement ce n'est pas toujours le cas),
nous devrions voir...
<pre class="shell">
Web site tests
OK
Test cases run: 1/1, Failures: 0, Exceptions: 0
</pre>
Nous avons vérifié qu'une page, de n'importe quel type,
a bien été renvoyée. Nous ne savons pas encore
s'il s'agit de celle que nous souhaitions.
</p>
<h2>
<a class="target" name="contenu"></a>Tester le contenu d'une page</h2>
<p>
Pour obtenir la confirmation que la page téléchargée
est bien celle que nous attendions,
nous devons vérifier son contenu.
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {<strong>
$this-&gt;get('http://www.lastcraft.com/');
$this-&gt;assertWantedPattern('/why the last craft/i');</strong>
}
}
</pre>
La page obtenue par le dernier téléchargement est
placée dans un buffer au sein même du scénario de test.
Il n'est donc pas nécessaire de s'y référer directement.
La correspondance du motif est toujours effectuée
par rapport à ce buffer.
</p>
<p>
Voici une liste possible d'assertions sur le contenu...
<table><tbody>
<tr>
<td><span class="new_code">assertWantedPattern($pattern)</span></td>
<td>Vérifier une correspondance sur le contenu via une expression rationnelle Perl</td>
</tr>
<tr>
<td><span class="new_code">assertNoUnwantedPattern($pattern)</span></td>
<td>Une expression rationnelle Perl pour vérifier une absence</td>
</tr>
<tr>
<td><span class="new_code">assertTitle($title)</span></td>
<td>Passe si le titre de la page correspond exactement</td>
</tr>
<tr>
<td><span class="new_code">assertLink($label)</span></td>
<td>Passe si un lien avec ce texte est présent</td>
</tr>
<tr>
<td><span class="new_code">assertNoLink($label)</span></td>
<td>Passe si aucun lien avec ce texte est présent</td>
</tr>
<tr>
<td><span class="new_code">assertLinkById($id)</span></td>
<td>Passe si un lien avec cet attribut d'identification est présent</td>
</tr>
<tr>
<td><span class="new_code">assertField($name, $value)</span></td>
<td>Passe si une balise input avec ce nom contient cette valeur</td>
</tr>
<tr>
<td><span class="new_code">assertFieldById($id, $value)</span></td>
<td>Passe si une balise input avec cet identifiant contient cette valeur</td>
</tr>
<tr>
<td><span class="new_code">assertResponse($codes)</span></td>
<td>Passe si la réponse HTTP trouve une correspondance dans la liste</td>
</tr>
<tr>
<td><span class="new_code">assertMime($types)</span></td>
<td>Passe si le type MIME se retrouve dans cette liste</td>
</tr>
<tr>
<td><span class="new_code">assertAuthentication($protocol)</span></td>
<td>Passe si l'authentification provoquée est de ce type de protocole</td>
</tr>
<tr>
<td><span class="new_code">assertNoAuthentication()</span></td>
<td>Passe s'il n'y pas d'authentification provoquée en cours</td>
</tr>
<tr>
<td><span class="new_code">assertRealm($name)</span></td>
<td>Passe si le domaine provoqué correspond</td>
</tr>
<tr>
<td><span class="new_code">assertHeader($header, $content)</span></td>
<td>Passe si une entête téléchargée correspond à cette valeur</td>
</tr>
<tr>
<td><span class="new_code">assertNoUnwantedHeader($header)</span></td>
<td>Passe si une entête n'a pas été téléchargé</td>
</tr>
<tr>
<td><span class="new_code">assertHeaderPattern($header, $pattern)</span></td>
<td>Passe si une entête téléchargée correspond à cette expression rationnelle Perl</td>
</tr>
<tr>
<td><span class="new_code">assertCookie($name, $value)</span></td>
<td>Passe s'il existe un cookie correspondant</td>
</tr>
<tr>
<td><span class="new_code">assertNoCookie($name)</span></td>
<td>Passe s'il n'y a pas de cookie avec un tel nom</td>
</tr>
</tbody></table>
Comme d'habitude avec les assertions de SimpleTest,
elles renvoient toutes "false" en cas d'échec
et "true" si c'est un succès.
Elles renvoient aussi un message de test optionnel :
vous pouvez l'ajouter dans votre propre message en utilisant "%s".
</p>
<p>
A présent nous pourrions effectué le test sur le titre uniquement...
<pre>
<strong>$this-&gt;assertTitle('The Last Craft?');</strong>
</pre>
En plus d'une simple vérification sur le contenu HTML,
nous pouvons aussi vérifier que le type MIME est bien d'un type acceptable...
<pre>
<strong>$this-&gt;assertMime(array('text/plain', 'text/html'));</strong>
</pre>
Plus intéressant encore est la vérification sur
le code de la réponse HTTP. Pareillement au type MIME,
nous pouvons nous assurer que le code renvoyé se trouve
bien dans un liste de valeurs possibles...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {
$this-&gt;get('http://simpletest.sourceforge.net/');<strong>
$this-&gt;assertResponse(200);</strong>
}
}
</pre>
Ici nous vérifions que le téléchargement s'est
bien terminé en ne permettant qu'une réponse HTTP 200.
Ce test passera, mais ce n'est pas la meilleure façon de procéder.
Il n'existe aucune page sur <em>http://simpletest.sourceforge.net/</em>,
à la place le serveur renverra une redirection vers
<em>http://www.lastcraft.com/simple_test.php</em>.
<span class="new_code">WebTestCase</span> suit automatiquement trois
de ces redirections. Les tests sont quelque peu plus
robustes de la sorte. Surtout qu'on est souvent plus intéressé
par l'interaction entre les pages que de leur simple livraison.
Si les redirections se révèlent être digne d'intérêt,
il reste possible de les supprimer...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {<strong>
$this-&gt;setMaximumRedirects(0);</strong>
$this-&gt;get('http://simpletest.sourceforge.net/');
$this-&gt;assertResponse(200);
}
}
</pre>
Alors l'assertion échoue comme prévue...
<pre class="shell">
Web site tests
1) Expecting response in [200] got [302]
in testhomepage
in testoflastcraft
in lastcraft_test.php
FAILURES!!!
Test cases run: 1/1, Failures: 1, Exceptions: 0
</pre>
Nous pouvons modifier le test pour accepter les redirections...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {
$this-&gt;setMaximumRedirects(0);
$this-&gt;get('http://simpletest.sourceforge.net/');
$this-&gt;assertResponse(<strong>array(301, 302, 303, 307)</strong>);
}
}
</pre>
Maitenant ça passe.
</p>
<h2>
<a class="target" name="navigation"></a>Navigeur dans un site web</h2>
<p>
Les utilisateurs ne naviguent pas souvent en tapant les URLs,
mais surtout en cliquant sur des liens et des boutons.
Ici nous confirmons que les informations sur le contact
peuvent être atteintes depuis la page d'accueil...
<pre>
class TestOfLastcraft extends WebTestCase {
...
function testContact() {
$this-&gt;get('http://www.lastcraft.com/');<strong>
$this-&gt;clickLink('About');
$this-&gt;assertTitle('About Last Craft');</strong>
}
}
</pre>
Le paramètre est le texte du lien.
</p>
<p>
Il l'objectif est un bouton plutôt qu'une balise ancre,
alors <span class="new_code">clickSubmit()</span> doit être utilisé avec
le titre du bouton...
<pre>
<strong>$this-&gt;clickSubmit('Go!');</strong>
</pre>
</p>
<p>
La liste des méthodes de navigation est...
<table><tbody>
<tr>
<td><span class="new_code">get($url, $parameters)</span></td>
<td>Envoie une requête GET avec ces paramètres</td>
</tr>
<tr>
<td><span class="new_code">post($url, $parameters)</span></td>
<td>Envoie une requête POST avec ces paramètres</td>
</tr>
<tr>
<td><span class="new_code">head($url, $parameters)</span></td>
<td>Envoie une requête HEAD sans remplacer le contenu de la page</td>
</tr>
<tr>
<td><span class="new_code">retry()</span></td>
<td>Relance la dernière requête</td>
</tr>
<tr>
<td><span class="new_code">back()</span></td>
<td>Identique au bouton "Précédent" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">forward()</span></td>
<td>Identique au bouton "Suivant" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">authenticate($name, $password)</span></td>
<td>Re-essaye avec une tentative d'authentification</td>
</tr>
<tr>
<td><span class="new_code">getFrameFocus()</span></td>
<td>Le nom de la fenêtre en cours d'utilisation</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocusByIndex($choice)</span></td>
<td>Change le focus d'une fenêtre en commençant par 1</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocus($name)</span></td>
<td>Change le focus d'une fenêtre en utilisant son nom</td>
</tr>
<tr>
<td><span class="new_code">clearFrameFocus()</span></td>
<td>Revient à un traitement de toutes les fenêtres comme une seule</td>
</tr>
<tr>
<td><span class="new_code">clickSubmit($label)</span></td>
<td>Clique sur le premier bouton avec cette étiquette</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitByName($name)</span></td>
<td>Clique sur le bouton avec cet attribut de nom</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitById($id)</span></td>
<td>Clique sur le bouton avec cet attribut d'identification</td>
</tr>
<tr>
<td><span class="new_code">clickImage($label, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son titre (title="*") our son texte alternatif (alt="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageByName($name, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son attribut (name="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageById($id, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son identifiant (id="*")</td>
</tr>
<tr>
<td><span class="new_code">submitFormById($id)</span></td>
<td>Soumet un formulaire sans valeur de soumission</td>
</tr>
<tr>
<td><span class="new_code">clickLink($label, $index)</span></td>
<td>Clique sur une ancre avec ce texte d'étiquette visible</td>
</tr>
<tr>
<td><span class="new_code">clickLinkById($id)</span></td>
<td>Clique sur une ancre avec cet attribut d'identification</td>
</tr>
</tbody></table>
</p>
<p>
Les paramètres dans les méthodes <span class="new_code">get()</span>,
<span class="new_code">post()</span> et <span class="new_code">head()</span> sont optionnels.
Le téléchargement via HTTP HEAD ne modifie pas
le contexte du navigateur, il se limite au chargement des cookies.
Cela peut être utilise lorsqu'une image ou une feuille de style
initie un cookie pour bloquer un robot trop entreprenant.
</p>
<p>
Les commandes <span class="new_code">retry()</span>, <span class="new_code">back()</span>
et <span class="new_code">forward()</span> fonctionnent exactement comme
dans un navigateur. Elles utilisent l'historique pour
relancer les pages. Une technique bien pratique pour
vérifier les effets d'un bouton retour sur vos formulaires.
</p>
<p>
Les méthodes sur les fenêtres méritent une petite explication.
Par défaut, une page avec des fenêtres est traitée comme toutes
les autres. Le contenu sera vérifié à travers l'ensemble de
la "frameset", par conséquent un lien fonctionnera,
peu importe la fenêtre qui contient la balise ancre.
Vous pouvez outrepassé ce comportement en exigeant
le focus sur une unique fenêtre. Si vous réalisez cela,
toutes les recherches et toutes les actions se limiteront
à cette unique fenêtre, y compris les demandes d'authentification.
Si un lien ou un bouton n'est pas dans la fenêtre en focus alors
il ne peut pas être cliqué.
</p>
<p>
Tester la navigation sur des pages fixes ne vous alerte que
quand vous avez cassé un script entier.
Pour des pages fortement dynamiques,
un forum de discussion par exemple,
ça peut être crucial pour vérifier l'état de l'application.
Pour la plupart des applications cependant,
la logique vraiment délicate se situe dans la gestion
des formulaires et des sessions.
Heureusement SimpleTest aussi inclut
<a href="form_testing_documentation.html">
des outils pour tester des formulaires web</a>.
</p>
<h2>
<a class="target" name="requete"></a>Modifier la requête</h2>
<p>
Bien que SimpleTest n'ait pas comme objectif
de contrôler des erreurs réseau, il contient quand même
des méthodes pour modifier et déboguer les requêtes qu'il lance.
Voici une autre liste de méthode...
<table><tbody>
<tr>
<td><span class="new_code">getTransportError()</span></td>
<td>La dernière erreur de socket</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>La localisation courante</td>
</tr>
<tr>
<td><span class="new_code">showRequest()</span></td>
<td>Déverse la requête sortante</td>
</tr>
<tr>
<td><span class="new_code">showHeaders()</span></td>
<td>Déverse les entêtes d'entrée</td>
</tr>
<tr>
<td><span class="new_code">showSource()</span></td>
<td>Déverse le contenu brut de la page HTML</td>
</tr>
<tr>
<td><span class="new_code">ignoreFrames()</span></td>
<td>Ne recharge pas les framesets</td>
</tr>
<tr>
<td><span class="new_code">setCookie($name, $value)</span></td>
<td>Initie un cookie à partir de maintenant</td>
</tr>
<tr>
<td><span class="new_code">addHeader($header)</span></td>
<td>Ajoute toujours cette entête à la requête</td>
</tr>
<tr>
<td><span class="new_code">setMaximumRedirects($max)</span></td>
<td>S'arrête après autant de redirections</td>
</tr>
<tr>
<td><span class="new_code">setConnectionTimeout($timeout)</span></td>
<td>Termine la connexion après autant de temps entre les bytes</td>
</tr>
<tr>
<td><span class="new_code">useProxy($proxy, $name, $password)</span></td>
<td>Effectue les requêtes à travers ce proxy d'URL</td>
</tr>
</tbody></table>
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API du développeur pour SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@ -1,407 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: dumper.php 1909 2009-07-29 15:58:11Z dgheath $
*/
/**
* does type matter
*/
if (! defined('TYPE_MATTERS')) {
define('TYPE_MATTERS', true);
}
/**
* Displays variables as text and does diffs.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleDumper {
/**
* Renders a variable in a shorter form than print_r().
* @param mixed $value Variable to render as a string.
* @return string Human readable string form.
* @access public
*/
function describeValue($value) {
$type = $this->getType($value);
switch($type) {
case "Null":
return "NULL";
case "Boolean":
return "Boolean: " . ($value ? "true" : "false");
case "Array":
return "Array: " . count($value) . " items";
case "Object":
return "Object: of " . get_class($value);
case "String":
return "String: " . $this->clipString($value, 200);
default:
return "$type: $value";
}
return "Unknown";
}
/**
* Gets the string representation of a type.
* @param mixed $value Variable to check against.
* @return string Type.
* @access public
*/
function getType($value) {
if (! isset($value)) {
return "Null";
} elseif (is_bool($value)) {
return "Boolean";
} elseif (is_string($value)) {
return "String";
} elseif (is_integer($value)) {
return "Integer";
} elseif (is_float($value)) {
return "Float";
} elseif (is_array($value)) {
return "Array";
} elseif (is_resource($value)) {
return "Resource";
} elseif (is_object($value)) {
return "Object";
}
return "Unknown";
}
/**
* Creates a human readable description of the
* difference between two variables. Uses a
* dynamic call.
* @param mixed $first First variable.
* @param mixed $second Value to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Description of difference.
* @access public
*/
function describeDifference($first, $second, $identical = false) {
if ($identical) {
if (! $this->isTypeMatch($first, $second)) {
return "with type mismatch as [" . $this->describeValue($first) .
"] does not match [" . $this->describeValue($second) . "]";
}
}
$type = $this->getType($first);
if ($type == "Unknown") {
return "with unknown type";
}
$method = 'describe' . $type . 'Difference';
return $this->$method($first, $second, $identical);
}
/**
* Tests to see if types match.
* @param mixed $first First variable.
* @param mixed $second Value to compare with.
* @return boolean True if matches.
* @access private
*/
protected function isTypeMatch($first, $second) {
return ($this->getType($first) == $this->getType($second));
}
/**
* Clips a string to a maximum length.
* @param string $value String to truncate.
* @param integer $size Minimum string size to show.
* @param integer $position Centre of string section.
* @return string Shortened version.
* @access public
*/
function clipString($value, $size, $position = 0) {
$length = strlen($value);
if ($length <= $size) {
return $value;
}
$position = min($position, $length);
$start = ($size/2 > $position ? 0 : $position - $size/2);
if ($start + $size > $length) {
$start = $length - $size;
}
$value = substr($value, $start, $size);
return ($start > 0 ? "..." : "") . $value . ($start + $size < $length ? "..." : "");
}
/**
* Creates a human readable description of the
* difference between two variables. The minimal
* version.
* @param null $first First value.
* @param mixed $second Value to compare with.
* @return string Human readable description.
* @access private
*/
protected function describeGenericDifference($first, $second) {
return "as [" . $this->describeValue($first) .
"] does not match [" .
$this->describeValue($second) . "]";
}
/**
* Creates a human readable description of the
* difference between a null and another variable.
* @param null $first First null.
* @param mixed $second Null to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeNullDifference($first, $second, $identical) {
return $this->describeGenericDifference($first, $second);
}
/**
* Creates a human readable description of the
* difference between a boolean and another variable.
* @param boolean $first First boolean.
* @param mixed $second Boolean to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeBooleanDifference($first, $second, $identical) {
return $this->describeGenericDifference($first, $second);
}
/**
* Creates a human readable description of the
* difference between a string and another variable.
* @param string $first First string.
* @param mixed $second String to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeStringDifference($first, $second, $identical) {
if (is_object($second) || is_array($second)) {
return $this->describeGenericDifference($first, $second);
}
$position = $this->stringDiffersAt($first, $second);
$message = "at character $position";
$message .= " with [" .
$this->clipString($first, 200, $position) . "] and [" .
$this->clipString($second, 200, $position) . "]";
return $message;
}
/**
* Creates a human readable description of the
* difference between an integer and another variable.
* @param integer $first First number.
* @param mixed $second Number to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeIntegerDifference($first, $second, $identical) {
if (is_object($second) || is_array($second)) {
return $this->describeGenericDifference($first, $second);
}
return "because [" . $this->describeValue($first) .
"] differs from [" .
$this->describeValue($second) . "] by " .
abs($first - $second);
}
/**
* Creates a human readable description of the
* difference between two floating point numbers.
* @param float $first First float.
* @param mixed $second Float to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeFloatDifference($first, $second, $identical) {
if (is_object($second) || is_array($second)) {
return $this->describeGenericDifference($first, $second);
}
return "because [" . $this->describeValue($first) .
"] differs from [" .
$this->describeValue($second) . "] by " .
abs($first - $second);
}
/**
* Creates a human readable description of the
* difference between two arrays.
* @param array $first First array.
* @param mixed $second Array to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeArrayDifference($first, $second, $identical) {
if (! is_array($second)) {
return $this->describeGenericDifference($first, $second);
}
if (! $this->isMatchingKeys($first, $second, $identical)) {
return "as key list [" .
implode(", ", array_keys($first)) . "] does not match key list [" .
implode(", ", array_keys($second)) . "]";
}
foreach (array_keys($first) as $key) {
if ($identical && ($first[$key] === $second[$key])) {
continue;
}
if (! $identical && ($first[$key] == $second[$key])) {
continue;
}
return "with member [$key] " . $this->describeDifference(
$first[$key],
$second[$key],
$identical);
}
return "";
}
/**
* Compares two arrays to see if their key lists match.
* For an identical match, the ordering and types of the keys
* is significant.
* @param array $first First array.
* @param array $second Array to compare with.
* @param boolean $identical If true then type anomolies count.
* @return boolean True if matching.
* @access private
*/
protected function isMatchingKeys($first, $second, $identical) {
$first_keys = array_keys($first);
$second_keys = array_keys($second);
if ($identical) {
return ($first_keys === $second_keys);
}
sort($first_keys);
sort($second_keys);
return ($first_keys == $second_keys);
}
/**
* Creates a human readable description of the
* difference between a resource and another variable.
* @param resource $first First resource.
* @param mixed $second Resource to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
* @access private
*/
protected function describeResourceDifference($first, $second, $identical) {
return $this->describeGenericDifference($first, $second);
}
/**
* Creates a human readable description of the
* difference between two objects.
* @param object $first First object.
* @param mixed $second Object to compare with.
* @param boolean $identical If true then type anomolies count.
* @return string Human readable description.
*/
protected function describeObjectDifference($first, $second, $identical) {
if (! is_object($second)) {
return $this->describeGenericDifference($first, $second);
}
return $this->describeArrayDifference(
$this->getMembers($first),
$this->getMembers($second),
$identical);
}
/**
* Get all members of an object including private and protected ones.
* A safer form of casting to an array.
* @param object $object Object to list members of,
* including private ones.
* @return array Names and values in the object.
*/
protected function getMembers($object) {
$reflection = new ReflectionObject($object);
$members = array();
foreach ($reflection->getProperties() as $property) {
if (method_exists($property, 'setAccessible')) {
$property->setAccessible(true);
}
try {
$members[$property->getName()] = $property->getValue($object);
} catch (ReflectionException $e) {
$members[$property->getName()] =
$this->getPrivatePropertyNoMatterWhat($property->getName(), $object);
}
}
return $members;
}
/**
* Extracts a private member's value when reflection won't play ball.
* @param string $name Property name.
* @param object $object Object to read.
* @return mixed Value of property.
*/
private function getPrivatePropertyNoMatterWhat($name, $object) {
foreach ((array)$object as $mangled_name => $value) {
if ($this->unmangle($mangled_name) == $name) {
return $value;
}
}
}
/**
* Removes crud from property name after it's been converted
* to an array.
* @param string $mangled Name from array cast.
* @return string Cleaned up name.
*/
function unmangle($mangled) {
$parts = preg_split('/[^a-zA-Z0-9_\x7f-\xff]+/', $mangled);
return array_pop($parts);
}
/**
* Find the first character position that differs
* in two strings by binary chop.
* @param string $first First string.
* @param string $second String to compare with.
* @return integer Position of first differing
* character.
* @access private
*/
protected function stringDiffersAt($first, $second) {
if (! $first || ! $second) {
return 0;
}
if (strlen($first) < strlen($second)) {
list($first, $second) = array($second, $first);
}
$position = 0;
$step = strlen($first);
while ($step > 1) {
$step = (integer)(($step + 1) / 2);
if (strncmp($first, $second, $position + $step) == 0) {
$position += $step;
}
}
return $position;
}
/**
* Sends a formatted dump of a variable to a string.
* @param mixed $variable Variable to display.
* @return string Output from print_r().
* @access public
*/
function dump($variable) {
ob_start();
print_r($variable);
$formatted = ob_get_contents();
ob_end_clean();
return $formatted;
}
}
?>

View File

@ -1,307 +0,0 @@
<?php
/**
* base include file for eclipse plugin
* @package SimpleTest
* @subpackage Eclipse
* @version $Id: eclipse.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* simpletest include files
*/
include_once 'unit_tester.php';
include_once 'test_case.php';
include_once 'invoker.php';
include_once 'socket.php';
include_once 'mock_objects.php';
/**#@-*/
/**
* base reported class for eclipse plugin
* @package SimpleTest
* @subpackage Eclipse
*/
class EclipseReporter extends SimpleScorer {
/**
* Reporter to be run inside of Eclipse interface.
* @param object $listener Eclipse listener (?).
* @param boolean $cc Whether to include test coverage.
*/
function __construct(&$listener, $cc=false){
$this->listener = &$listener;
$this->SimpleScorer();
$this->case = "";
$this->group = "";
$this->method = "";
$this->cc = $cc;
$this->error = false;
$this->fail = false;
}
/**
* Means to display human readable object comparisons.
* @return SimpleDumper Visual comparer.
*/
function getDumper() {
return new SimpleDumper();
}
/**
* Localhost connection from Eclipse.
* @param integer $port Port to connect to Eclipse.
* @param string $host Normally localhost.
* @return SimpleSocket Connection to Eclipse.
*/
function &createListener($port, $host="127.0.0.1"){
$tmplistener = &new SimpleSocket($host, $port, 5);
return $tmplistener;
}
/**
* Wraps the test in an output buffer.
* @param SimpleInvoker $invoker Current test runner.
* @return EclipseInvoker Decorator with output buffering.
* @access public
*/
function &createInvoker(&$invoker){
$eclinvoker = &new EclipseInvoker($invoker, $this->listener);
return $eclinvoker;
}
/**
* C style escaping.
* @param string $raw String with backslashes, quotes and whitespace.
* @return string Replaced with C backslashed tokens.
*/
function escapeVal($raw){
$needle = array("\\","\"","/","\b","\f","\n","\r","\t");
$replace = array('\\\\','\"','\/','\b','\f','\n','\r','\t');
return str_replace($needle, $replace, $raw);
}
/**
* Stash the first passing item. Clicking the test
* item goes to first pass.
* @param string $message Test message, but we only wnat the first.
* @access public
*/
function paintPass($message){
if (! $this->pass){
$this->message = $this->escapeVal($message);
}
$this->pass = true;
}
/**
* Stash the first failing item. Clicking the test
* item goes to first fail.
* @param string $message Test message, but we only wnat the first.
* @access public
*/
function paintFail($message){
//only get the first failure or error
if (! $this->fail && ! $this->error){
$this->fail = true;
$this->message = $this->escapeVal($message);
$this->listener->write('{status:"fail",message:"'.$this->message.'",group:"'.$this->group.'",case:"'.$this->case.'",method:"'.$this->method.'"}');
}
}
/**
* Stash the first error. Clicking the test
* item goes to first error.
* @param string $message Test message, but we only wnat the first.
* @access public
*/
function paintError($message){
if (! $this->fail && ! $this->error){
$this->error = true;
$this->message = $this->escapeVal($message);
$this->listener->write('{status:"error",message:"'.$this->message.'",group:"'.$this->group.'",case:"'.$this->case.'",method:"'.$this->method.'"}');
}
}
/**
* Stash the first exception. Clicking the test
* item goes to first message.
* @param string $message Test message, but we only wnat the first.
* @access public
*/
function paintException($exception){
if (! $this->fail && ! $this->error){
$this->error = true;
$message = 'Unexpected exception of type[' . get_class($exception) .
'] with message [' . $exception->getMessage() . '] in [' .
$exception->getFile() .' line '. $exception->getLine() . ']';
$this->message = $this->escapeVal($message);
$this->listener->write(
'{status:"error",message:"' . $this->message . '",group:"' .
$this->group . '",case:"' . $this->case . '",method:"' . $this->method
. '"}');
}
}
/**
* We don't display any special header.
* @param string $test_name First test top level
* to start.
* @access public
*/
function paintHeader($test_name) {
}
/**
* We don't display any special footer.
* @param string $test_name The top level test.
* @access public
*/
function paintFooter($test_name) {
}
/**
* Paints nothing at the start of a test method, but stash
* the method name for later.
* @param string $test_name Name of test that is starting.
* @access public
*/
function paintMethodStart($method) {
$this->pass = false;
$this->fail = false;
$this->error = false;
$this->method = $this->escapeVal($method);
}
/**
* Only send one message if the test passes, after that
* suppress the message.
* @param string $test_name Name of test that is ending.
* @access public
*/
function paintMethodEnd($method){
if ($this->fail || $this->error || ! $this->pass){
} else {
$this->listener->write(
'{status:"pass",message:"' . $this->message . '",group:"' .
$this->group . '",case:"' . $this->case . '",method:"' .
$this->method . '"}');
}
}
/**
* Stashes the test case name for the later failure message.
* @param string $test_name Name of test or other label.
* @access public
*/
function paintCaseStart($case){
$this->case = $this->escapeVal($case);
}
/**
* Drops the name.
* @param string $test_name Name of test or other label.
* @access public
*/
function paintCaseEnd($case){
$this->case = "";
}
/**
* Stashes the name of the test suite. Starts test coverage
* if enabled.
* @param string $group Name of test or other label.
* @param integer $size Number of test cases starting.
* @access public
*/
function paintGroupStart($group, $size){
$this->group = $this->escapeVal($group);
if ($this->cc){
if (extension_loaded('xdebug')){
xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);
}
}
}
/**
* Paints coverage report if enabled.
* @param string $group Name of test or other label.
* @access public
*/
function paintGroupEnd($group){
$this->group = "";
$cc = "";
if ($this->cc){
if (extension_loaded('xdebug')){
$arrfiles = xdebug_get_code_coverage();
xdebug_stop_code_coverage();
$thisdir = dirname(__FILE__);
$thisdirlen = strlen($thisdir);
foreach ($arrfiles as $index=>$file){
if (substr($index, 0, $thisdirlen)===$thisdir){
continue;
}
$lcnt = 0;
$ccnt = 0;
foreach ($file as $line){
if ($line == -2){
continue;
}
$lcnt++;
if ($line==1){
$ccnt++;
}
}
if ($lcnt > 0){
$cc .= round(($ccnt/$lcnt) * 100, 2) . '%';
}else{
$cc .= "0.00%";
}
$cc.= "\t". $index . "\n";
}
}
}
$this->listener->write('{status:"coverage",message:"' .
EclipseReporter::escapeVal($cc) . '"}');
}
}
/**
* Invoker decorator for Eclipse. Captures output until
* the end of the test.
* @package SimpleTest
* @subpackage Eclipse
*/
class EclipseInvoker extends SimpleInvokerDecorator{
function __construct(&$invoker, &$listener) {
$this->listener = &$listener;
$this->SimpleInvokerDecorator($invoker);
}
/**
* Starts output buffering.
* @param string $method Test method to call.
* @access public
*/
function before($method){
ob_start();
$this->invoker->before($method);
}
/**
* Stops output buffering and send the captured output
* to the listener.
* @param string $method Test method to call.
* @access public
*/
function after($method) {
$this->invoker->after($method);
$output = ob_get_contents();
ob_end_clean();
if ($output !== ""){
$result = $this->listener->write('{status:"info",message:"' .
EclipseReporter::escapeVal($output) . '"}');
}
}
}
?>

View File

@ -1,649 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage WebTester
* @version $Id: encoding.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/socket.php');
/**#@-*/
/**
* Single post parameter.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleEncodedPair {
private $key;
private $value;
/**
* Stashes the data for rendering later.
* @param string $key Form element name.
* @param string $value Data to send.
*/
function __construct($key, $value) {
$this->key = $key;
$this->value = $value;
}
/**
* The pair as a single string.
* @return string Encoded pair.
* @access public
*/
function asRequest() {
return urlencode($this->key) . '=' . urlencode($this->value);
}
/**
* The MIME part as a string.
* @return string MIME part encoding.
* @access public
*/
function asMime() {
$part = 'Content-Disposition: form-data; ';
$part .= "name=\"" . $this->key . "\"\r\n";
$part .= "\r\n" . $this->value;
return $part;
}
/**
* Is this the value we are looking for?
* @param string $key Identifier.
* @return boolean True if matched.
* @access public
*/
function isKey($key) {
return $key == $this->key;
}
/**
* Is this the value we are looking for?
* @return string Identifier.
* @access public
*/
function getKey() {
return $this->key;
}
/**
* Is this the value we are looking for?
* @return string Content.
* @access public
*/
function getValue() {
return $this->value;
}
}
/**
* Single post parameter.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleAttachment {
private $key;
private $content;
private $filename;
/**
* Stashes the data for rendering later.
* @param string $key Key to add value to.
* @param string $content Raw data.
* @param hash $filename Original filename.
*/
function __construct($key, $content, $filename) {
$this->key = $key;
$this->content = $content;
$this->filename = $filename;
}
/**
* The pair as a single string.
* @return string Encoded pair.
* @access public
*/
function asRequest() {
return '';
}
/**
* The MIME part as a string.
* @return string MIME part encoding.
* @access public
*/
function asMime() {
$part = 'Content-Disposition: form-data; ';
$part .= 'name="' . $this->key . '"; ';
$part .= 'filename="' . $this->filename . '"';
$part .= "\r\nContent-Type: " . $this->deduceMimeType();
$part .= "\r\n\r\n" . $this->content;
return $part;
}
/**
* Attempts to figure out the MIME type from the
* file extension and the content.
* @return string MIME type.
* @access private
*/
protected function deduceMimeType() {
if ($this->isOnlyAscii($this->content)) {
return 'text/plain';
}
return 'application/octet-stream';
}
/**
* Tests each character is in the range 0-127.
* @param string $ascii String to test.
* @access private
*/
protected function isOnlyAscii($ascii) {
for ($i = 0, $length = strlen($ascii); $i < $length; $i++) {
if (ord($ascii[$i]) > 127) {
return false;
}
}
return true;
}
/**
* Is this the value we are looking for?
* @param string $key Identifier.
* @return boolean True if matched.
* @access public
*/
function isKey($key) {
return $key == $this->key;
}
/**
* Is this the value we are looking for?
* @return string Identifier.
* @access public
*/
function getKey() {
return $this->key;
}
/**
* Is this the value we are looking for?
* @return string Content.
* @access public
*/
function getValue() {
return $this->filename;
}
}
/**
* Bundle of GET/POST parameters. Can include
* repeated parameters.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleEncoding {
private $request;
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false) {
if (! $query) {
$query = array();
}
$this->clear();
$this->merge($query);
}
/**
* Empties the request of parameters.
* @access public
*/
function clear() {
$this->request = array();
}
/**
* Adds a parameter to the query.
* @param string $key Key to add value to.
* @param string/array $value New data.
* @access public
*/
function add($key, $value) {
if ($value === false) {
return;
}
if (is_array($value)) {
foreach ($value as $item) {
$this->addPair($key, $item);
}
} else {
$this->addPair($key, $value);
}
}
/**
* Adds a new value into the request.
* @param string $key Key to add value to.
* @param string/array $value New data.
* @access private
*/
protected function addPair($key, $value) {
$this->request[] = new SimpleEncodedPair($key, $value);
}
/**
* Adds a MIME part to the query. Does nothing for a
* form encoded packet.
* @param string $key Key to add value to.
* @param string $content Raw data.
* @param hash $filename Original filename.
* @access public
*/
function attach($key, $content, $filename) {
$this->request[] = new SimpleAttachment($key, $content, $filename);
}
/**
* Adds a set of parameters to this query.
* @param array/SimpleQueryString $query Multiple values are
* as lists on a single key.
* @access public
*/
function merge($query) {
if (is_object($query)) {
$this->request = array_merge($this->request, $query->getAll());
} elseif (is_array($query)) {
foreach ($query as $key => $value) {
$this->add($key, $value);
}
}
}
/**
* Accessor for single value.
* @return string/array False if missing, string
* if present and array if
* multiple entries.
* @access public
*/
function getValue($key) {
$values = array();
foreach ($this->request as $pair) {
if ($pair->isKey($key)) {
$values[] = $pair->getValue();
}
}
if (count($values) == 0) {
return false;
} elseif (count($values) == 1) {
return $values[0];
} else {
return $values;
}
}
/**
* Accessor for listing of pairs.
* @return array All pair objects.
* @access public
*/
function getAll() {
return $this->request;
}
/**
* Renders the query string as a URL encoded
* request part.
* @return string Part of URL.
* @access protected
*/
protected function encode() {
$statements = array();
foreach ($this->request as $pair) {
if ($statement = $pair->asRequest()) {
$statements[] = $statement;
}
}
return implode('&', $statements);
}
}
/**
* Bundle of GET parameters. Can include
* repeated parameters.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleGetEncoding extends SimpleEncoding {
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false) {
parent::__construct($query);
}
/**
* HTTP request method.
* @return string Always GET.
* @access public
*/
function getMethod() {
return 'GET';
}
/**
* Writes no extra headers.
* @param SimpleSocket $socket Socket to write to.
* @access public
*/
function writeHeadersTo(&$socket) {
}
/**
* No data is sent to the socket as the data is encoded into
* the URL.
* @param SimpleSocket $socket Socket to write to.
* @access public
*/
function writeTo(&$socket) {
}
/**
* Renders the query string as a URL encoded
* request part for attaching to a URL.
* @return string Part of URL.
* @access public
*/
function asUrlRequest() {
return $this->encode();
}
}
/**
* Bundle of URL parameters for a HEAD request.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleHeadEncoding extends SimpleGetEncoding {
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false) {
parent::__construct($query);
}
/**
* HTTP request method.
* @return string Always HEAD.
* @access public
*/
function getMethod() {
return 'HEAD';
}
}
/**
* Bundle of URL parameters for a DELETE request.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleDeleteEncoding extends SimpleGetEncoding {
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false) {
parent::__construct($query);
}
/**
* HTTP request method.
* @return string Always DELETE.
* @access public
*/
function getMethod() {
return 'DELETE';
}
}
/**
* Bundles an entity-body for transporting
* a raw content payload with the request.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleEntityEncoding extends SimpleEncoding {
private $content_type;
private $body;
function __construct($query = false, $content_type = false) {
$this->content_type = $content_type;
if (is_string($query)) {
$this->body = $query;
parent::__construct();
} else {
parent::__construct($query);
}
}
/**
* Returns the media type of the entity body
* @return string
* @access public
*/
function getContentType() {
if (!$this->content_type) {
return ($this->body) ? 'text/plain' : 'application/x-www-form-urlencoded';
}
return $this->content_type;
}
/**
* Dispatches the form headers down the socket.
* @param SimpleSocket $socket Socket to write to.
* @access public
*/
function writeHeadersTo(&$socket) {
$socket->write("Content-Length: " . (integer)strlen($this->encode()) . "\r\n");
$socket->write("Content-Type: " . $this->getContentType() . "\r\n");
}
/**
* Dispatches the form data down the socket.
* @param SimpleSocket $socket Socket to write to.
* @access public
*/
function writeTo(&$socket) {
$socket->write($this->encode());
}
/**
* Renders the request body
* @return Encoded entity body
* @access protected
*/
protected function encode() {
return ($this->body) ? $this->body : parent::encode();
}
}
/**
* Bundle of POST parameters. Can include
* repeated parameters.
* @package SimpleTest
* @subpackage WebTester
*/
class SimplePostEncoding extends SimpleEntityEncoding {
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false, $content_type = false) {
if (is_array($query) and $this->hasMoreThanOneLevel($query)) {
$query = $this->rewriteArrayWithMultipleLevels($query);
}
parent::__construct($query, $content_type);
}
function hasMoreThanOneLevel($query) {
foreach ($query as $key => $value) {
if (is_array($value)) {
return true;
}
}
return false;
}
function rewriteArrayWithMultipleLevels($query) {
$query_ = array();
foreach ($query as $key => $value) {
if (is_array($value)) {
foreach ($value as $sub_key => $sub_value) {
$query_[$key."[".$sub_key."]"] = $sub_value;
}
} else {
$query_[$key] = $value;
}
}
if ($this->hasMoreThanOneLevel($query_)) {
$query_ = $this->rewriteArrayWithMultipleLevels($query_);
}
return $query_;
}
/**
* HTTP request method.
* @return string Always POST.
* @access public
*/
function getMethod() {
return 'POST';
}
/**
* Renders the query string as a URL encoded
* request part for attaching to a URL.
* @return string Part of URL.
* @access public
*/
function asUrlRequest() {
return '';
}
}
/**
* Encoded entity body for a PUT request.
* @package SimpleTest
* @subpackage WebTester
*/
class SimplePutEncoding extends SimpleEntityEncoding {
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false, $content_type = false) {
parent::__construct($query, $content_type);
}
/**
* HTTP request method.
* @return string Always PUT.
* @access public
*/
function getMethod() {
return 'PUT';
}
}
/**
* Bundle of POST parameters in the multipart
* format. Can include file uploads.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleMultipartEncoding extends SimplePostEncoding {
private $boundary;
/**
* Starts empty.
* @param array $query Hash of parameters.
* Multiple values are
* as lists on a single key.
* @access public
*/
function __construct($query = false, $boundary = false) {
parent::__construct($query);
$this->boundary = ($boundary === false ? uniqid('st') : $boundary);
}
/**
* Dispatches the form headers down the socket.
* @param SimpleSocket $socket Socket to write to.
* @access public
*/
function writeHeadersTo(&$socket) {
$socket->write("Content-Length: " . (integer)strlen($this->encode()) . "\r\n");
$socket->write("Content-Type: multipart/form-data; boundary=" . $this->boundary . "\r\n");
}
/**
* Dispatches the form data down the socket.
* @param SimpleSocket $socket Socket to write to.
* @access public
*/
function writeTo(&$socket) {
$socket->write($this->encode());
}
/**
* Renders the query string as a URL encoded
* request part.
* @return string Part of URL.
* @access public
*/
function encode() {
$stream = '';
foreach ($this->getAll() as $pair) {
$stream .= "--" . $this->boundary . "\r\n";
$stream .= $pair->asMime() . "\r\n";
}
$stream .= "--" . $this->boundary . "--\r\n";
return $stream;
}
}
?>

View File

@ -1,267 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: errors.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* Includes SimpleTest files.
*/
require_once dirname(__FILE__) . '/invoker.php';
require_once dirname(__FILE__) . '/test_case.php';
require_once dirname(__FILE__) . '/expectation.php';
/**#@-*/
/**
* Extension that traps errors into an error queue.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleErrorTrappingInvoker extends SimpleInvokerDecorator {
/**
* Stores the invoker to wrap.
* @param SimpleInvoker $invoker Test method runner.
*/
function __construct($invoker) {
parent::__construct($invoker);
}
/**
* Invokes a test method and dispatches any
* untrapped errors. Called back from
* the visiting runner.
* @param string $method Test method to call.
* @access public
*/
function invoke($method) {
$queue = $this->createErrorQueue();
set_error_handler('SimpleTestErrorHandler');
parent::invoke($method);
restore_error_handler();
$queue->tally();
}
/**
* Wires up the error queue for a single test.
* @return SimpleErrorQueue Queue connected to the test.
* @access private
*/
protected function createErrorQueue() {
$context = SimpleTest::getContext();
$test = $this->getTestCase();
$queue = $context->get('SimpleErrorQueue');
$queue->setTestCase($test);
return $queue;
}
}
/**
* Error queue used to record trapped
* errors.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleErrorQueue {
private $queue;
private $expectation_queue;
private $test;
private $using_expect_style = false;
/**
* Starts with an empty queue.
*/
function __construct() {
$this->clear();
}
/**
* Discards the contents of the error queue.
* @access public
*/
function clear() {
$this->queue = array();
$this->expectation_queue = array();
}
/**
* Sets the currently running test case.
* @param SimpleTestCase $test Test case to send messages to.
* @access public
*/
function setTestCase($test) {
$this->test = $test;
}
/**
* Sets up an expectation of an error. If this is
* not fulfilled at the end of the test, a failure
* will occour. If the error does happen, then this
* will cancel it out and send a pass message.
* @param SimpleExpectation $expected Expected error match.
* @param string $message Message to display.
* @access public
*/
function expectError($expected, $message) {
array_push($this->expectation_queue, array($expected, $message));
}
/**
* Adds an error to the front of the queue.
* @param integer $severity PHP error code.
* @param string $content Text of error.
* @param string $filename File error occoured in.
* @param integer $line Line number of error.
* @access public
*/
function add($severity, $content, $filename, $line) {
$content = str_replace('%', '%%', $content);
$this->testLatestError($severity, $content, $filename, $line);
}
/**
* Any errors still in the queue are sent to the test
* case. Any unfulfilled expectations trigger failures.
* @access public
*/
function tally() {
while (list($severity, $message, $file, $line) = $this->extract()) {
$severity = $this->getSeverityAsString($severity);
$this->test->error($severity, $message, $file, $line);
}
while (list($expected, $message) = $this->extractExpectation()) {
$this->test->assert($expected, false, "%s -> Expected error not caught");
}
}
/**
* Tests the error against the most recent expected
* error.
* @param integer $severity PHP error code.
* @param string $content Text of error.
* @param string $filename File error occoured in.
* @param integer $line Line number of error.
* @access private
*/
protected function testLatestError($severity, $content, $filename, $line) {
if ($expectation = $this->extractExpectation()) {
list($expected, $message) = $expectation;
$this->test->assert($expected, $content, sprintf(
$message,
"%s -> PHP error [$content] severity [" .
$this->getSeverityAsString($severity) .
"] in [$filename] line [$line]"));
} else {
$this->test->error($severity, $content, $filename, $line);
}
}
/**
* Pulls the earliest error from the queue.
* @return mixed False if none, or a list of error
* information. Elements are: severity
* as the PHP error code, the error message,
* the file with the error, the line number
* and a list of PHP super global arrays.
* @access public
*/
function extract() {
if (count($this->queue)) {
return array_shift($this->queue);
}
return false;
}
/**
* Pulls the earliest expectation from the queue.
* @return SimpleExpectation False if none.
* @access private
*/
protected function extractExpectation() {
if (count($this->expectation_queue)) {
return array_shift($this->expectation_queue);
}
return false;
}
/**
* Converts an error code into it's string
* representation.
* @param $severity PHP integer error code.
* @return String version of error code.
* @access public
*/
static function getSeverityAsString($severity) {
static $map = array(
E_STRICT => 'E_STRICT',
E_ERROR => 'E_ERROR',
E_WARNING => 'E_WARNING',
E_PARSE => 'E_PARSE',
E_NOTICE => 'E_NOTICE',
E_CORE_ERROR => 'E_CORE_ERROR',
E_CORE_WARNING => 'E_CORE_WARNING',
E_COMPILE_ERROR => 'E_COMPILE_ERROR',
E_COMPILE_WARNING => 'E_COMPILE_WARNING',
E_USER_ERROR => 'E_USER_ERROR',
E_USER_WARNING => 'E_USER_WARNING',
E_USER_NOTICE => 'E_USER_NOTICE');
if (defined('E_RECOVERABLE_ERROR')) {
$map[E_RECOVERABLE_ERROR] = 'E_RECOVERABLE_ERROR';
}
if (defined('E_DEPRECATED')) {
$map[E_DEPRECATED] = 'E_DEPRECATED';
}
return $map[$severity];
}
}
/**
* Error handler that simply stashes any errors into the global
* error queue. Simulates the existing behaviour with respect to
* logging errors, but this feature may be removed in future.
* @param $severity PHP error code.
* @param $message Text of error.
* @param $filename File error occoured in.
* @param $line Line number of error.
* @param $super_globals Hash of PHP super global arrays.
* @access public
*/
function SimpleTestErrorHandler($severity, $message, $filename = null, $line = null, $super_globals = null, $mask = null) {
$severity = $severity & error_reporting();
if ($severity) {
restore_error_handler();
if (IsNotCausedBySimpleTest($message) && IsNotTimeZoneNag($message)) {
if (ini_get('log_errors')) {
$label = SimpleErrorQueue::getSeverityAsString($severity);
error_log("$label: $message in $filename on line $line");
}
$queue = SimpleTest::getContext()->get('SimpleErrorQueue');
$queue->add($severity, $message, $filename, $line);
}
set_error_handler('SimpleTestErrorHandler');
}
return true;
}
/**
* Certain messages can be caused by the unit tester itself.
* These have to be filtered.
* @param string $message Message to filter.
* @return boolean True if genuine failure.
*/
function IsNotCausedBySimpleTest($message) {
return ! preg_match('/returned by reference/', $message);
}
/**
* Certain messages caused by PHP are just noise.
* These have to be filtered.
* @param string $message Message to filter.
* @return boolean True if genuine failure.
*/
function IsNotTimeZoneNag($message) {
return ! preg_match('/not safe to rely .* timezone settings/', $message);
}
?>

View File

@ -1,226 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: exceptions.php 1882 2009-07-01 14:30:05Z lastcraft $
*/
/**#@+
* Include required SimpleTest files
*/
require_once dirname(__FILE__) . '/invoker.php';
require_once dirname(__FILE__) . '/expectation.php';
/**#@-*/
/**
* Extension that traps exceptions and turns them into
* an error message. PHP5 only.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleExceptionTrappingInvoker extends SimpleInvokerDecorator {
/**
* Stores the invoker to be wrapped.
* @param SimpleInvoker $invoker Test method runner.
*/
function __construct($invoker) {
parent::__construct($invoker);
}
/**
* Invokes a test method whilst trapping expected
* exceptions. Any left over unthrown exceptions
* are then reported as failures.
* @param string $method Test method to call.
*/
function invoke($method) {
$trap = SimpleTest::getContext()->get('SimpleExceptionTrap');
$trap->clear();
try {
$has_thrown = false;
parent::invoke($method);
} catch (Exception $exception) {
$has_thrown = true;
if (! $trap->isExpected($this->getTestCase(), $exception)) {
$this->getTestCase()->exception($exception);
}
$trap->clear();
}
if ($message = $trap->getOutstanding()) {
$this->getTestCase()->fail($message);
}
if ($has_thrown) {
try {
parent::getTestCase()->tearDown();
} catch (Exception $e) { }
}
}
}
/**
* Tests exceptions either by type or the exact
* exception. This could be improved to accept
* a pattern expectation to test the error
* message, but that will have to come later.
* @package SimpleTest
* @subpackage UnitTester
*/
class ExceptionExpectation extends SimpleExpectation {
private $expected;
/**
* Sets up the conditions to test against.
* If the expected value is a string, then
* it will act as a test of the class name.
* An exception as the comparison will
* trigger an identical match. Writing this
* down now makes it look doubly dumb. I hope
* come up with a better scheme later.
* @param mixed $expected A class name or an actual
* exception to compare with.
* @param string $message Message to display.
*/
function __construct($expected, $message = '%s') {
$this->expected = $expected;
parent::__construct($message);
}
/**
* Carry out the test.
* @param Exception $compare Value to check.
* @return boolean True if matched.
*/
function test($compare) {
if (is_string($this->expected)) {
return ($compare instanceof $this->expected);
}
if (get_class($compare) != get_class($this->expected)) {
return false;
}
return $compare->getMessage() == $this->expected->getMessage();
}
/**
* Create the message to display describing the test.
* @param Exception $compare Exception to match.
* @return string Final message.
*/
function testMessage($compare) {
if (is_string($this->expected)) {
return "Exception [" . $this->describeException($compare) .
"] should be type [" . $this->expected . "]";
}
return "Exception [" . $this->describeException($compare) .
"] should match [" .
$this->describeException($this->expected) . "]";
}
/**
* Summary of an Exception object.
* @param Exception $compare Exception to describe.
* @return string Text description.
*/
protected function describeException($exception) {
return get_class($exception) . ": " . $exception->getMessage();
}
}
/**
* Stores expected exceptions for when they
* get thrown. Saves the irritating try...catch
* block.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleExceptionTrap {
private $expected;
private $ignored;
private $message;
/**
* Clears down the queue ready for action.
*/
function __construct() {
$this->clear();
}
/**
* Sets up an expectation of an exception.
* This has the effect of intercepting an
* exception that matches.
* @param SimpleExpectation $expected Expected exception to match.
* @param string $message Message to display.
* @access public
*/
function expectException($expected = false, $message = '%s') {
$this->expected = $this->coerceToExpectation($expected);
$this->message = $message;
}
/**
* Adds an exception to the ignore list. This is the list
* of exceptions that when thrown do not affect the test.
* @param SimpleExpectation $ignored Exception to skip.
* @access public
*/
function ignoreException($ignored) {
$this->ignored[] = $this->coerceToExpectation($ignored);
}
/**
* Compares the expected exception with any
* in the queue. Issues a pass or fail and
* returns the state of the test.
* @param SimpleTestCase $test Test case to send messages to.
* @param Exception $exception Exception to compare.
* @return boolean False on no match.
*/
function isExpected($test, $exception) {
if ($this->expected) {
return $test->assert($this->expected, $exception, $this->message);
}
foreach ($this->ignored as $ignored) {
if ($ignored->test($exception)) {
return true;
}
}
return false;
}
/**
* Turns an expected exception into a SimpleExpectation object.
* @param mixed $exception Exception, expectation or
* class name of exception.
* @return SimpleExpectation Expectation that will match the
* exception.
*/
private function coerceToExpectation($exception) {
if ($exception === false) {
return new AnythingExpectation();
}
if (! SimpleExpectation::isExpectation($exception)) {
return new ExceptionExpectation($exception);
}
return $exception;
}
/**
* Tests for any left over exception.
* @return string/false The failure message or false if none.
*/
function getOutstanding() {
return sprintf($this->message, 'Failed to trap exception');
}
/**
* Discards the contents of the error queue.
*/
function clear() {
$this->expected = false;
$this->message = false;
$this->ignored = array();
}
}
?>

View File

@ -1,984 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: expectation.php 2009 2011-04-28 08:57:25Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/dumper.php');
require_once(dirname(__FILE__) . '/compatibility.php');
/**#@-*/
/**
* Assertion that can display failure information.
* Also includes various helper methods.
* @package SimpleTest
* @subpackage UnitTester
* @abstract
*/
class SimpleExpectation {
protected $dumper = false;
private $message;
/**
* Creates a dumper for displaying values and sets
* the test message.
* @param string $message Customised message on failure.
*/
function __construct($message = '%s') {
$this->message = $message;
}
/**
* Tests the expectation. True if correct.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
* @abstract
*/
function test($compare) {
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
* @abstract
*/
function testMessage($compare) {
}
/**
* Overlays the generated message onto the stored user
* message. An additional message can be interjected.
* @param mixed $compare Comparison value.
* @param SimpleDumper $dumper For formatting the results.
* @return string Description of success
* or failure.
* @access public
*/
function overlayMessage($compare, $dumper) {
$this->dumper = $dumper;
return sprintf($this->message, $this->testMessage($compare));
}
/**
* Accessor for the dumper.
* @return SimpleDumper Current value dumper.
* @access protected
*/
protected function getDumper() {
if (! $this->dumper) {
$dumper = new SimpleDumper();
return $dumper;
}
return $this->dumper;
}
/**
* Test to see if a value is an expectation object.
* A useful utility method.
* @param mixed $expectation Hopefully an Expectation
* class.
* @return boolean True if descended from
* this class.
* @access public
*/
static function isExpectation($expectation) {
return is_object($expectation) &&
SimpleTestCompatibility::isA($expectation, 'SimpleExpectation');
}
}
/**
* A wildcard expectation always matches.
* @package SimpleTest
* @subpackage MockObjects
*/
class AnythingExpectation extends SimpleExpectation {
/**
* Tests the expectation. Always true.
* @param mixed $compare Ignored.
* @return boolean True.
* @access public
*/
function test($compare) {
return true;
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
return 'Anything always matches [' . $dumper->describeValue($compare) . ']';
}
}
/**
* An expectation that never matches.
* @package SimpleTest
* @subpackage MockObjects
*/
class FailedExpectation extends SimpleExpectation {
/**
* Tests the expectation. Always false.
* @param mixed $compare Ignored.
* @return boolean True.
* @access public
*/
function test($compare) {
return false;
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
return 'Failed expectation never matches [' . $dumper->describeValue($compare) . ']';
}
}
/**
* An expectation that passes on boolean true.
* @package SimpleTest
* @subpackage MockObjects
*/
class TrueExpectation extends SimpleExpectation {
/**
* Tests the expectation.
* @param mixed $compare Should be true.
* @return boolean True on match.
* @access public
*/
function test($compare) {
return (boolean)$compare;
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
return 'Expected true, got [' . $dumper->describeValue($compare) . ']';
}
}
/**
* An expectation that passes on boolean false.
* @package SimpleTest
* @subpackage MockObjects
*/
class FalseExpectation extends SimpleExpectation {
/**
* Tests the expectation.
* @param mixed $compare Should be false.
* @return boolean True on match.
* @access public
*/
function test($compare) {
return ! (boolean)$compare;
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
return 'Expected false, got [' . $dumper->describeValue($compare) . ']';
}
}
/**
* Test for equality.
* @package SimpleTest
* @subpackage UnitTester
*/
class EqualExpectation extends SimpleExpectation {
private $value;
/**
* Sets the value to compare against.
* @param mixed $value Test value to match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($value, $message = '%s') {
parent::__construct($message);
$this->value = $value;
}
/**
* Tests the expectation. True if it matches the
* held value.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return (($this->value == $compare) && ($compare == $this->value));
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
if ($this->test($compare)) {
return "Equal expectation [" . $this->dumper->describeValue($this->value) . "]";
} else {
return "Equal expectation fails " .
$this->dumper->describeDifference($this->value, $compare);
}
}
/**
* Accessor for comparison value.
* @return mixed Held value to compare with.
* @access protected
*/
protected function getValue() {
return $this->value;
}
}
/**
* Test for inequality.
* @package SimpleTest
* @subpackage UnitTester
*/
class NotEqualExpectation extends EqualExpectation {
/**
* Sets the value to compare against.
* @param mixed $value Test value to match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($value, $message = '%s') {
parent::__construct($value, $message);
}
/**
* Tests the expectation. True if it differs from the
* held value.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return ! parent::test($compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
if ($this->test($compare)) {
return "Not equal expectation passes " .
$dumper->describeDifference($this->getValue(), $compare);
} else {
return "Not equal expectation fails [" .
$dumper->describeValue($this->getValue()) .
"] matches";
}
}
}
/**
* Test for being within a range.
* @package SimpleTest
* @subpackage UnitTester
*/
class WithinMarginExpectation extends SimpleExpectation {
private $upper;
private $lower;
/**
* Sets the value to compare against and the fuzziness of
* the match. Used for comparing floating point values.
* @param mixed $value Test value to match.
* @param mixed $margin Fuzziness of match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($value, $margin, $message = '%s') {
parent::__construct($message);
$this->upper = $value + $margin;
$this->lower = $value - $margin;
}
/**
* Tests the expectation. True if it matches the
* held value.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return (($compare <= $this->upper) && ($compare >= $this->lower));
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
if ($this->test($compare)) {
return $this->withinMessage($compare);
} else {
return $this->outsideMessage($compare);
}
}
/**
* Creates a the message for being within the range.
* @param mixed $compare Value being tested.
* @access private
*/
protected function withinMessage($compare) {
return "Within expectation [" . $this->dumper->describeValue($this->lower) . "] and [" .
$this->dumper->describeValue($this->upper) . "]";
}
/**
* Creates a the message for being within the range.
* @param mixed $compare Value being tested.
* @access private
*/
protected function outsideMessage($compare) {
if ($compare > $this->upper) {
return "Outside expectation " .
$this->dumper->describeDifference($compare, $this->upper);
} else {
return "Outside expectation " .
$this->dumper->describeDifference($compare, $this->lower);
}
}
}
/**
* Test for being outside of a range.
* @package SimpleTest
* @subpackage UnitTester
*/
class OutsideMarginExpectation extends WithinMarginExpectation {
/**
* Sets the value to compare against and the fuzziness of
* the match. Used for comparing floating point values.
* @param mixed $value Test value to not match.
* @param mixed $margin Fuzziness of match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($value, $margin, $message = '%s') {
parent::__construct($value, $margin, $message);
}
/**
* Tests the expectation. True if it matches the
* held value.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return ! parent::test($compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
if (! $this->test($compare)) {
return $this->withinMessage($compare);
} else {
return $this->outsideMessage($compare);
}
}
}
/**
* Test for reference.
* @package SimpleTest
* @subpackage UnitTester
*/
class ReferenceExpectation {
private $value;
/**
* Sets the reference value to compare against.
* @param mixed $value Test reference to match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct(&$value, $message = '%s') {
$this->message = $message;
$this->value = &$value;
}
/**
* Tests the expectation. True if it exactly
* references the held value.
* @param mixed $compare Comparison reference.
* @return boolean True if correct.
* @access public
*/
function test(&$compare) {
return SimpleTestCompatibility::isReference($this->value, $compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
if ($this->test($compare)) {
return "Reference expectation [" . $this->dumper->describeValue($this->value) . "]";
} else {
return "Reference expectation fails " .
$this->dumper->describeDifference($this->value, $compare);
}
}
/**
* Overlays the generated message onto the stored user
* message. An additional message can be interjected.
* @param mixed $compare Comparison value.
* @param SimpleDumper $dumper For formatting the results.
* @return string Description of success
* or failure.
* @access public
*/
function overlayMessage($compare, $dumper) {
$this->dumper = $dumper;
return sprintf($this->message, $this->testMessage($compare));
}
/**
* Accessor for the dumper.
* @return SimpleDumper Current value dumper.
* @access protected
*/
protected function getDumper() {
if (! $this->dumper) {
$dumper = new SimpleDumper();
return $dumper;
}
return $this->dumper;
}
}
/**
* Test for identity.
* @package SimpleTest
* @subpackage UnitTester
*/
class IdenticalExpectation extends EqualExpectation {
/**
* Sets the value to compare against.
* @param mixed $value Test value to match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($value, $message = '%s') {
parent::__construct($value, $message);
}
/**
* Tests the expectation. True if it exactly
* matches the held value.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return SimpleTestCompatibility::isIdentical($this->getValue(), $compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
if ($this->test($compare)) {
return "Identical expectation [" . $dumper->describeValue($this->getValue()) . "]";
} else {
return "Identical expectation [" . $dumper->describeValue($this->getValue()) .
"] fails with [" .
$dumper->describeValue($compare) . "] " .
$dumper->describeDifference($this->getValue(), $compare, TYPE_MATTERS);
}
}
}
/**
* Test for non-identity.
* @package SimpleTest
* @subpackage UnitTester
*/
class NotIdenticalExpectation extends IdenticalExpectation {
/**
* Sets the value to compare against.
* @param mixed $value Test value to match.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($value, $message = '%s') {
parent::__construct($value, $message);
}
/**
* Tests the expectation. True if it differs from the
* held value.
* @param mixed $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return ! parent::test($compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
if ($this->test($compare)) {
return "Not identical expectation passes " .
$dumper->describeDifference($this->getValue(), $compare, TYPE_MATTERS);
} else {
return "Not identical expectation [" . $dumper->describeValue($this->getValue()) . "] matches";
}
}
}
/**
* Test for a pattern using Perl regex rules.
* @package SimpleTest
* @subpackage UnitTester
*/
class PatternExpectation extends SimpleExpectation {
private $pattern;
/**
* Sets the value to compare against.
* @param string $pattern Pattern to search for.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($pattern, $message = '%s') {
parent::__construct($message);
$this->pattern = $pattern;
}
/**
* Accessor for the pattern.
* @return string Perl regex as string.
* @access protected
*/
protected function getPattern() {
return $this->pattern;
}
/**
* Tests the expectation. True if the Perl regex
* matches the comparison value.
* @param string $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return (boolean)preg_match($this->getPattern(), $compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
if ($this->test($compare)) {
return $this->describePatternMatch($this->getPattern(), $compare);
} else {
$dumper = $this->getDumper();
return "Pattern [" . $this->getPattern() .
"] not detected in [" .
$dumper->describeValue($compare) . "]";
}
}
/**
* Describes a pattern match including the string
* found and it's position.
* @param string $pattern Regex to match against.
* @param string $subject Subject to search.
* @access protected
*/
protected function describePatternMatch($pattern, $subject) {
preg_match($pattern, $subject, $matches);
$position = strpos($subject, $matches[0]);
$dumper = $this->getDumper();
return "Pattern [$pattern] detected at character [$position] in [" .
$dumper->describeValue($subject) . "] as [" .
$matches[0] . "] in region [" .
$dumper->clipString($subject, 100, $position) . "]";
}
}
/**
* Fail if a pattern is detected within the
* comparison.
* @package SimpleTest
* @subpackage UnitTester
*/
class NoPatternExpectation extends PatternExpectation {
/**
* Sets the reject pattern
* @param string $pattern Pattern to search for.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($pattern, $message = '%s') {
parent::__construct($pattern, $message);
}
/**
* Tests the expectation. False if the Perl regex
* matches the comparison value.
* @param string $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
return ! parent::test($compare);
}
/**
* Returns a human readable test message.
* @param string $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
if ($this->test($compare)) {
$dumper = $this->getDumper();
return "Pattern [" . $this->getPattern() .
"] not detected in [" .
$dumper->describeValue($compare) . "]";
} else {
return $this->describePatternMatch($this->getPattern(), $compare);
}
}
}
/**
* Tests either type or class name if it's an object.
* @package SimpleTest
* @subpackage UnitTester
*/
class IsAExpectation extends SimpleExpectation {
private $type;
/**
* Sets the type to compare with.
* @param string $type Type or class name.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($type, $message = '%s') {
parent::__construct($message);
$this->type = $type;
}
/**
* Accessor for type to check against.
* @return string Type or class name.
* @access protected
*/
protected function getType() {
return $this->type;
}
/**
* Tests the expectation. True if the type or
* class matches the string value.
* @param string $compare Comparison value.
* @return boolean True if correct.
* @access public
*/
function test($compare) {
if (is_object($compare)) {
return SimpleTestCompatibility::isA($compare, $this->type);
} else {
$function = 'is_'.$this->canonicalType($this->type);
if (is_callable($function)) {
return $function($compare);
}
return false;
}
}
/**
* Coerces type name into a is_*() match.
* @param string $type User type.
* @return string Simpler type.
* @access private
*/
protected function canonicalType($type) {
$type = strtolower($type);
$map = array('boolean' => 'bool');
if (isset($map[$type])) {
$type = $map[$type];
}
return $type;
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
return "Value [" . $dumper->describeValue($compare) .
"] should be type [" . $this->type . "]";
}
}
/**
* Tests either type or class name if it's an object.
* Will succeed if the type does not match.
* @package SimpleTest
* @subpackage UnitTester
*/
class NotAExpectation extends IsAExpectation {
private $type;
/**
* Sets the type to compare with.
* @param string $type Type or class name.
* @param string $message Customised message on failure.
* @access public
*/
function __construct($type, $message = '%s') {
parent::__construct($type, $message);
}
/**
* Tests the expectation. False if the type or
* class matches the string value.
* @param string $compare Comparison value.
* @return boolean True if different.
* @access public
*/
function test($compare) {
return ! parent::test($compare);
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
* @access public
*/
function testMessage($compare) {
$dumper = $this->getDumper();
return "Value [" . $dumper->describeValue($compare) .
"] should not be type [" . $this->getType() . "]";
}
}
/**
* Tests for existance of a method in an object
* @package SimpleTest
* @subpackage UnitTester
*/
class MethodExistsExpectation extends SimpleExpectation {
private $method;
/**
* Sets the value to compare against.
* @param string $method Method to check.
* @param string $message Customised message on failure.
* @return void
*/
function __construct($method, $message = '%s') {
parent::__construct($message);
$this->method = &$method;
}
/**
* Tests the expectation. True if the method exists in the test object.
* @param string $compare Comparison method name.
* @return boolean True if correct.
*/
function test($compare) {
return (boolean)(is_object($compare) && method_exists($compare, $this->method));
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
*/
function testMessage($compare) {
$dumper = $this->getDumper();
if (! is_object($compare)) {
return 'No method on non-object [' . $dumper->describeValue($compare) . ']';
}
$method = $this->method;
return "Object [" . $dumper->describeValue($compare) .
"] should contain method [$method]";
}
}
/**
* Compares an object member's value even if private.
* @package SimpleTest
* @subpackage UnitTester
*/
class MemberExpectation extends IdenticalExpectation {
private $name;
/**
* Sets the value to compare against.
* @param string $method Method to check.
* @param string $message Customised message on failure.
* @return void
*/
function __construct($name, $expected) {
$this->name = $name;
parent::__construct($expected);
}
/**
* Tests the expectation. True if the property value is identical.
* @param object $actual Comparison object.
* @return boolean True if identical.
*/
function test($actual) {
if (! is_object($actual)) {
return false;
}
return parent::test($this->getProperty($this->name, $actual));
}
/**
* Returns a human readable test message.
* @param mixed $compare Comparison value.
* @return string Description of success
* or failure.
*/
function testMessage($actual) {
return parent::testMessage($this->getProperty($this->name, $actual));
}
/**
* Extracts the member value even if private using reflection.
* @param string $name Property name.
* @param object $object Object to read.
* @return mixed Value of property.
*/
private function getProperty($name, $object) {
$reflection = new ReflectionObject($object);
$property = $reflection->getProperty($name);
if (method_exists($property, 'setAccessible')) {
$property->setAccessible(true);
}
try {
return $property->getValue($object);
} catch (ReflectionException $e) {
return $this->getPrivatePropertyNoMatterWhat($name, $object);
}
}
/**
* Extracts a private member's value when reflection won't play ball.
* @param string $name Property name.
* @param object $object Object to read.
* @return mixed Value of property.
*/
private function getPrivatePropertyNoMatterWhat($name, $object) {
foreach ((array)$object as $mangled_name => $value) {
if ($this->unmangle($mangled_name) == $name) {
return $value;
}
}
}
/**
* Removes crud from property name after it's been converted
* to an array.
* @param string $mangled Name from array cast.
* @return string Cleaned up name.
*/
function unmangle($mangled) {
$parts = preg_split('/[^a-zA-Z0-9_\x7f-\xff]+/', $mangled);
return array_pop($parts);
}
}
?>

View File

@ -1,29 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**
* Include this in any file to start coverage, coverage will automatically end
* when process dies.
*/
require_once(dirname(__FILE__) .'/coverage.php');
if (CodeCoverage::isCoverageOn()) {
$coverage = CodeCoverage::getInstance();
$coverage->startCoverage();
register_shutdown_function("stop_coverage");
}
function stop_coverage() {
# hack until i can think of a way to run tests first and w/o exiting
$autorun = function_exists("run_local_tests");
if ($autorun) {
$result = run_local_tests();
}
CodeCoverage::getInstance()->stopCoverage();
if ($autorun) {
exit($result ? 0 : 1);
}
}
?>

View File

@ -1,14 +0,0 @@
<?php
/**
* Close code coverage data collection, next step is to generate report
* @package SimpleTest
* @subpackage Extensions
*/
/**
* include coverage files
*/
require_once(dirname(__FILE__) . '/../coverage.php');
$cc = CodeCoverage::getInstance();
$cc->readSettings();
$cc->writeUntouched();
?>

View File

@ -1,31 +0,0 @@
<?php
/**
* Initialize code coverage data collection, next step is to run your tests
* with ini setting auto_prepend_file=autocoverage.php ...
*
* @package SimpleTest
* @subpackage Extensions
*/
# optional arguments:
# --include=<some filepath regexp> these files should be included coverage report
# --exclude=<come filepath regexp> these files should not be included in coverage report
# --maxdepth=2 when considering which file were not touched, scan directories
#
# Example:
# php-coverage-open.php --include='.*\.php$' --include='.*\.inc$' --exclude='.*/tests/.*'
/**#@+
* include coverage files
*/
require_once(dirname(__FILE__) . '/../coverage_utils.php');
CoverageUtils::requireSqlite();
require_once(dirname(__FILE__) . '/../coverage.php');
/**#@-*/
$cc = new CodeCoverage();
$cc->log = 'coverage.sqlite';
$args = CoverageUtils::parseArguments($_SERVER['argv'], TRUE);
$cc->includes = CoverageUtils::issetOr($args['include[]'], array('.*\.php$'));
$cc->excludes = CoverageUtils::issetOr($args['exclude[]']);
$cc->maxDirectoryDepth = (int)CoverageUtils::issetOr($args['maxdepth'], '1');
$cc->resetLog();
$cc->writeSettings();
?>

View File

@ -1,29 +0,0 @@
<?php
/**
* Generate a code coverage report
*
* @package SimpleTest
* @subpackage Extensions
*/
# optional arguments:
# --reportDir=some/directory the default is ./coverage-report
# --title='My Coverage Report' title the main page of your report
/**#@+
* include coverage files
*/
require_once(dirname(__FILE__) . '/../coverage_utils.php');
require_once(dirname(__FILE__) . '/../coverage.php');
require_once(dirname(__FILE__) . '/../coverage_reporter.php');
/**#@-*/
$cc = CodeCoverage::getInstance();
$cc->readSettings();
$handler = new CoverageDataHandler($cc->log);
$report = new CoverageReporter();
$args = CoverageUtils::parseArguments($_SERVER['argv']);
$report->reportDir = CoverageUtils::issetOr($args['reportDir'], 'coverage-report');
$report->title = CoverageUtils::issetOr($args['title'], "Simpletest Coverage");
$report->coverage = $handler->read();
$report->untouched = $handler->readUntouchedFiles();
$report->generate();
?>

View File

@ -1,196 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**
* load coverage data handle
*/
require_once dirname(__FILE__) . '/coverage_data_handler.php';
/**
* Orchestrates code coverage both in this thread and in subthread under apache
* Assumes this is running on same machine as apache.
* @package SimpleTest
* @subpackage Extensions
*/
class CodeCoverage {
var $log;
var $root;
var $includes;
var $excludes;
var $directoryDepth;
var $maxDirectoryDepth = 20; // reasonable, otherwise arbitrary
var $title = "Code Coverage";
# NOTE: This assumes all code shares the same current working directory.
var $settingsFile = './code-coverage-settings.dat';
static $instance;
function writeUntouched() {
$touched = array_flip($this->getTouchedFiles());
$untouched = array();
$this->getUntouchedFiles($untouched, $touched, '.', '.');
$this->includeUntouchedFiles($untouched);
}
function &getTouchedFiles() {
$handler = new CoverageDataHandler($this->log);
$touched = $handler->getFilenames();
return $touched;
}
function includeUntouchedFiles($untouched) {
$handler = new CoverageDataHandler($this->log);
foreach ($untouched as $file) {
$handler->writeUntouchedFile($file);
}
}
function getUntouchedFiles(&$untouched, $touched, $parentPath, $rootPath, $directoryDepth = 1) {
$parent = opendir($parentPath);
while ($file = readdir($parent)) {
$path = "$parentPath/$file";
if (is_dir($path)) {
if ($file != '.' && $file != '..') {
if ($this->isDirectoryIncluded($path, $directoryDepth)) {
$this->getUntouchedFiles($untouched, $touched, $path, $rootPath, $directoryDepth + 1);
}
}
}
else if ($this->isFileIncluded($path)) {
$relativePath = CoverageDataHandler::ltrim($rootPath .'/', $path);
if (!array_key_exists($relativePath, $touched)) {
$untouched[] = $relativePath;
}
}
}
closedir($parent);
}
function resetLog() {
error_log('reseting log');
$new_file = fopen($this->log, "w");
if (!$new_file) {
throw new Exception("Could not create ". $this->log);
}
fclose($new_file);
if (!chmod($this->log, 0666)) {
throw new Exception("Could not change ownership on file ". $this->log);
}
$handler = new CoverageDataHandler($this->log);
$handler->createSchema();
}
function startCoverage() {
$this->root = getcwd();
if(!extension_loaded("xdebug")) {
throw new Exception("Could not load xdebug extension");
};
xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);
}
function stopCoverage() {
$cov = xdebug_get_code_coverage();
$this->filter($cov);
$data = new CoverageDataHandler($this->log);
chdir($this->root);
$data->write($cov);
unset($data); // release sqlite connection
xdebug_stop_code_coverage();
// make sure we wind up on same current working directory, otherwise
// coverage handler writer doesn't know what directory to chop off
chdir($this->root);
}
function readSettings() {
if (file_exists($this->settingsFile)) {
$this->setSettings(file_get_contents($this->settingsFile));
} else {
error_log("could not find file ". $this->settingsFile);
}
}
function writeSettings() {
file_put_contents($this->settingsFile, $this->getSettings());
}
function getSettings() {
$data = array(
'log' => realpath($this->log),
'includes' => $this->includes,
'excludes' => $this->excludes);
return serialize($data);
}
function setSettings($settings) {
$data = unserialize($settings);
$this->log = $data['log'];
$this->includes = $data['includes'];
$this->excludes = $data['excludes'];
}
function filter(&$coverage) {
foreach ($coverage as $file => $line) {
if (!$this->isFileIncluded($file)) {
unset($coverage[$file]);
}
}
}
function isFileIncluded($file) {
if (!empty($this->excludes)) {
foreach ($this->excludes as $path) {
if (preg_match('|' . $path . '|', $file)) {
return False;
}
}
}
if (!empty($this->includes)) {
foreach ($this->includes as $path) {
if (preg_match('|' . $path . '|', $file)) {
return True;
}
}
return False;
}
return True;
}
function isDirectoryIncluded($dir, $directoryDepth) {
if ($directoryDepth >= $this->maxDirectoryDepth) {
return false;
}
if (isset($this->excludes)) {
foreach ($this->excludes as $path) {
if (preg_match('|' . $path . '|', $dir)) {
return False;
}
}
}
return True;
}
static function isCoverageOn() {
$coverage = self::getInstance();
$coverage->readSettings();
if (empty($coverage->log) || !file_exists($coverage->log)) {
trigger_error('No coverage log');
return False;
}
return True;
}
static function getInstance() {
if (self::$instance == NULL) {
self::$instance = new CodeCoverage();
self::$instance->readSettings();
}
return self::$instance;
}
}
?>

View File

@ -1,98 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**
* @package SimpleTest
* @subpackage Extensions
*/
class CoverageCalculator {
function coverageByFileVariables($file, $coverage) {
$hnd = fopen($file, 'r');
if ($hnd == null) {
throw new Exception("File $file is missing");
}
$lines = array();
for ($i = 1; !feof($hnd); $i++) {
$line = fgets($hnd);
$lineCoverage = $this->lineCoverageCodeToStyleClass($coverage, $i);
$lines[$i] = array('lineCoverage' => $lineCoverage, 'code' => $line);
}
fclose($hnd);
$var = compact('file', 'lines', 'coverage');
return $var;
}
function lineCoverageCodeToStyleClass($coverage, $line) {
if (!array_key_exists($line, $coverage)) {
return "comment";
}
$code = $coverage[$line];
if (empty($code)) {
return "comment";
}
switch ($code) {
case -1:
return "missed";
case -2:
return "dead";
}
return "covered";
}
function totalLoc($total, $coverage) {
return $total + sizeof($coverage);
}
function lineCoverage($total, $line) {
# NOTE: counting dead code as covered, as it's almost always an executable line
# strange artifact of xdebug or underlying system
return $total + ($line > 0 || $line == -2 ? 1 : 0);
}
function totalCoverage($total, $coverage) {
return $total + array_reduce($coverage, array(&$this, "lineCoverage"));
}
static function reportFilename($filename) {
return preg_replace('|[/\\\\]|', '_', $filename) . '.html';
}
function percentCoverageByFile($coverage, $file, &$results) {
$byFileReport = self::reportFilename($file);
$loc = sizeof($coverage);
if ($loc == 0)
return 0;
$lineCoverage = array_reduce($coverage, array(&$this, "lineCoverage"));
$percentage = 100 * ($lineCoverage / $loc);
$results[0][$file] = array('byFileReport' => $byFileReport, 'percentage' => $percentage);
}
function variables($coverage, $untouched) {
$coverageByFile = array();
array_walk($coverage, array(&$this, "percentCoverageByFile"), array(&$coverageByFile));
$totalLoc = array_reduce($coverage, array(&$this, "totalLoc"));
if ($totalLoc > 0) {
$totalLinesOfCoverage = array_reduce($coverage, array(&$this, "totalCoverage"));
$totalPercentCoverage = 100 * ($totalLinesOfCoverage / $totalLoc);
}
$untouchedPercentageDenominator = sizeof($coverage) + sizeof($untouched);
if ($untouchedPercentageDenominator > 0) {
$filesTouchedPercentage = 100 * sizeof($coverage) / $untouchedPercentageDenominator;
}
$var = compact('coverageByFile', 'totalPercentCoverage', 'totalLoc', 'totalLinesOfCoverage', 'filesTouchedPercentage');
$var['untouched'] = $untouched;
return $var;
}
}
?>

View File

@ -1,125 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**
* @todo which db abstraction layer is this?
*/
require_once 'DB/sqlite.php';
/**
* Persists code coverage data into SQLite database and aggregate data for convienent
* interpretation in report generator. Be sure to not to keep an instance longer
* than you have, otherwise you risk overwriting database edits from another process
* also trying to make updates.
* @package SimpleTest
* @subpackage Extensions
*/
class CoverageDataHandler {
var $db;
function __construct($filename) {
$this->filename = $filename;
$this->db = new SQLiteDatabase($filename);
if (empty($this->db)) {
throw new Exception("Could not create sqlite db ". $filename);
}
}
function createSchema() {
$this->db->queryExec("create table untouched (filename text)");
$this->db->queryExec("create table coverage (name text, coverage text)");
}
function &getFilenames() {
$filenames = array();
$cursor = $this->db->unbufferedQuery("select distinct name from coverage");
while ($row = $cursor->fetch()) {
$filenames[] = $row[0];
}
return $filenames;
}
function write($coverage) {
foreach ($coverage as $file => $lines) {
$coverageStr = serialize($lines);
$relativeFilename = self::ltrim(getcwd() . '/', $file);
$sql = "insert into coverage (name, coverage) values ('$relativeFilename', '$coverageStr')";
# if this fails, check you have write permission
$this->db->queryExec($sql);
}
}
function read() {
$coverage = array_flip($this->getFilenames());
foreach($coverage as $file => $garbage) {
$coverage[$file] = $this->readFile($file);
}
return $coverage;
}
function &readFile($file) {
$sql = "select coverage from coverage where name = '$file'";
$aggregate = array();
$result = $this->db->query($sql);
while ($result->valid()) {
$row = $result->current();
$this->aggregateCoverage($aggregate, unserialize($row[0]));
$result->next();
}
return $aggregate;
}
function aggregateCoverage(&$total, $next) {
foreach ($next as $lineno => $code) {
if (!isset($total[$lineno])) {
$total[$lineno] = $code;
} else {
$total[$lineno] = $this->aggregateCoverageCode($total[$lineno], $code);
}
}
}
function aggregateCoverageCode($code1, $code2) {
switch($code1) {
case -2: return -2;
case -1: return $code2;
default:
switch ($code2) {
case -2: return -2;
case -1: return $code1;
}
}
return $code1 + $code2;
}
static function ltrim($cruft, $pristine) {
if(stripos($pristine, $cruft) === 0) {
return substr($pristine, strlen($cruft));
}
return $pristine;
}
function writeUntouchedFile($file) {
$relativeFile = CoverageDataHandler::ltrim('./', $file);
$sql = "insert into untouched values ('$relativeFile')";
$this->db->queryExec($sql);
}
function &readUntouchedFiles() {
$untouched = array();
$result = $this->db->query("select filename from untouched order by filename");
while ($result->valid()) {
$row = $result->current();
$untouched[] = $row[0];
$result->next();
}
return $untouched;
}
}
?>

View File

@ -1,68 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**#@+
* include additional coverage files
*/
require_once dirname(__FILE__) .'/coverage_calculator.php';
require_once dirname(__FILE__) .'/coverage_utils.php';
require_once dirname(__FILE__) .'/simple_coverage_writer.php';
/**#@-*/
/**
* Take aggregated coverage data and generate reports from it using smarty
* templates
* @package SimpleTest
* @subpackage Extensions
*/
class CoverageReporter {
var $coverage;
var $untouched;
var $reportDir;
var $title = 'Coverage';
var $writer;
var $calculator;
function __construct() {
$this->writer = new SimpleCoverageWriter();
$this->calculator = new CoverageCalculator();
}
function generateSummaryReport($out) {
$variables = $this->calculator->variables($this->coverage, $this->untouched);
$variables['title'] = $this->title;
$report = $this->writer->writeSummary($out, $variables);
fwrite($out, $report);
}
function generate() {
CoverageUtils::mkdir($this->reportDir);
$index = $this->reportDir .'/index.html';
$hnd = fopen($index, 'w');
$this->generateSummaryReport($hnd);
fclose($hnd);
foreach ($this->coverage as $file => $cov) {
$byFile = $this->reportDir .'/'. self::reportFilename($file);
$byFileHnd = fopen($byFile, 'w');
$this->generateCoverageByFile($byFileHnd, $file, $cov);
fclose($byFileHnd);
}
echo "generated report $index\n";
}
function generateCoverageByFile($out, $file, $cov) {
$variables = $this->calculator->coverageByFileVariables($file, $cov);
$variables['title'] = $this->title .' - '. $file;
$this->writer->writeByFile($out, $variables);
}
static function reportFilename($filename) {
return preg_replace('|[/\\\\]|', '_', $filename) . '.html';
}
}
?>

View File

@ -1,114 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**
* @package SimpleTest
* @subpackage Extensions
*/
class CoverageUtils {
static function mkdir($dir) {
if (!file_exists($dir)) {
mkdir($dir, 0777, True);
} else {
if (!is_dir($dir)) {
throw new Exception($dir .' exists as a file, not a directory');
}
}
}
static function requireSqlite() {
if (!self::isPackageClassAvailable('DB/sqlite.php', 'SQLiteDatabase')) {
echo "sqlite library is required to be installed and available in include_path";
exit(1);
}
}
static function isPackageClassAvailable($includeFile, $class) {
@include_once($includeFile);
return class_exists($class);
}
/**
* Parses simple parameters from CLI.
*
* Puts trailing parameters into string array in 'extraArguments'
*
* Example:
* $args = CoverageUtil::parseArguments($_SERVER['argv']);
* if ($args['verbose']) echo "Verbose Mode On\n";
* $files = $args['extraArguments'];
*
* Example CLI:
* --foo=blah -x -h some trailing arguments
*
* if multiValueMode is true
* Example CLI:
* --include=a --include=b --exclude=c
* Then
* $args = CoverageUtil::parseArguments($_SERVER['argv']);
* $args['include[]'] will equal array('a', 'b')
* $args['exclude[]'] will equal array('c')
* $args['exclude'] will equal c
* $args['include'] will equal b NOTE: only keeps last value
*
* @param unknown_type $argv
* @param supportMutliValue - will store 2nd copy of value in an array with key "foo[]"
* @return unknown
*/
static public function parseArguments($argv, $mutliValueMode = False) {
$args = array();
$args['extraArguments'] = array();
array_shift($argv); // scriptname
foreach ($argv as $arg) {
if (ereg('^--([^=]+)=(.*)', $arg, $reg)) {
$args[$reg[1]] = $reg[2];
if ($mutliValueMode) {
self::addItemAsArray($args, $reg[1], $reg[2]);
}
} elseif (ereg('^[-]{1,2}([^[:blank:]]+)', $arg, $reg)) {
$nonnull = '';
$args[$reg[1]] = $nonnull;
if ($mutliValueMode) {
self::addItemAsArray($args, $reg[1], $nonnull);
}
} else {
$args['extraArguments'][] = $arg;
}
}
return $args;
}
/**
* Adds a value as an array of one, or appends to an existing array elements
*
* @param unknown_type $array
* @param unknown_type $item
*/
static function addItemAsArray(&$array, $key, $item) {
$array_key = $key .'[]';
if (array_key_exists($array_key, $array)) {
$array[$array_key][] = $item;
} else {
$array[$array_key] = array($item);
}
}
/**
* isset function with default value
*
* Example: $z = CoverageUtils::issetOr($array[$key], 'no value given')
*
* @param unknown_type $val
* @param unknown_type $default
* @return first value unless value is not set then returns 2nd arg or null if no 2nd arg
*/
static public function issetOr(&$val, $default = null)
{
return isset($val) ? $val : $default;
}
}
?>

View File

@ -1,16 +0,0 @@
<?php
/**
* @package SimpleTest
* @subpackage Extensions
*/
/**
* @package SimpleTest
* @subpackage Extensions
*/
interface CoverageWriter {
function writeSummary($out, $variables);
function writeByFile($out, $variables);
}
?>

View File

@ -1,39 +0,0 @@
<?php
/**
* SimpleCoverageWriter class file
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: unit_tester.php 1882 2009-07-01 14:30:05Z lastcraft $
*/
/**
* base coverage writer class
*/
require_once dirname(__FILE__) .'/coverage_writer.php';
/**
* SimpleCoverageWriter class
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleCoverageWriter implements CoverageWriter {
function writeSummary($out, $variables) {
extract($variables);
$now = date("F j, Y, g:i a");
ob_start();
include dirname(__FILE__) . '/templates/index.php';
$contents = ob_get_contents();
fwrite ($out, $contents);
ob_end_clean();
}
function writeByFile($out, $variables) {
extract($variables);
ob_start();
include dirname(__FILE__) . '/templates/file.php';
$contents = ob_get_contents();
fwrite ($out, $contents);
ob_end_clean();
}
}
?>

View File

@ -1,60 +0,0 @@
<html>
<head>
<title><?php echo $title ?></title>
</head>
<style type="text/css">
body {
font-family: "Gill Sans MT", "Gill Sans", GillSans, Arial, Helvetica, sans-serif;
}
h1 {
font-size: medium;
}
#code {
border-spacing: 0;
}
.lineNo {
color: #ccc;
}
.code, .lineNo {
white-space: pre;
font-family: monospace;
}
.covered {
color: #090;
}
.missed {
color: #f00;
}
.dead {
color: #00f;
}
.comment {
color: #333;
}
</style>
<body>
<h1 id="title"><?php echo $title ?></h1>
<table id="code">
<tbody>
<?php foreach ($lines as $lineNo => $line) { ?>
<tr>
<td><span class="lineNo"><?php echo $lineNo ?></span></td>
<td><span class="<?php echo $line['lineCoverage'] ?> code"><?php echo htmlentities($line['code']) ?></span></td>
</tr>
<?php } ?>
</tbody>
</table>
<h2>Legend</h2>
<dl>
<dt><span class="missed">Missed</span></dt>
<dd>lines code that <strong>were not</strong> excersized during program execution.</dd>
<dt><span class="covered">Covered</span></dt>
<dd>lines code <strong>were</strong> excersized during program execution.</dd>
<dt><span class="comment">Comment/non executable</span></dt>
<dd>Comment or non-executable line of code.</dd>
<dt><span class="dead">Dead</span></dt>
<dd>lines of code that according to xdebug could not be executed. This is counted as coverage code because
in almost all cases it is code that runnable.</dd>
</dl>
</body>
</html>

View File

@ -1,106 +0,0 @@
<html>
<head>
<title><?php echo $title ?></title>
</head>
<style type="text/css">
h1 {
font-size: medium;
}
body {
font-family: "Gill Sans MT", "Gill Sans", GillSans, Arial, Helvetica,
sans-serif;
}
td.percentage {
text-align: right;
}
caption {
border-bottom: thin solid;
font-weight: bolder;
}
dt {
font-weight: bolder;
}
table {
margin: 1em;
}
</style>
<body>
<h1 id="title"><?php echo $title ?></h1>
<table>
<caption>Summary</caption>
<tbody>
<tr>
<td>Total Coverage (<a href="#total-coverage">?</a>) :</td>
<td class="percentage"><span class="totalPercentCoverage"><?php echo number_format($totalPercentCoverage, 0) ?>%</span></td>
</tr>
<tr>
<td>Total Files Covered (<a href="#total-files-covered">?</a>) :</td>
<td class="percentage"><span class="filesTouchedPercentage"><?php echo number_format($filesTouchedPercentage, 0) ?>%</span></td>
</tr>
<tr>
<td>Report Generation Date :</td>
<td><?php echo $now ?></td>
</tr>
</tbody>
</table>
<table id="covered-files">
<caption>Coverage (<a href="#coverage">?</a>)</caption>
<thead>
<tr>
<th>File</th>
<th>Coverage</th>
</tr>
</thead>
<tbody>
<?php foreach ($coverageByFile as $file => $coverage) { ?>
<tr>
<td><a class="byFileReportLink" href="<?php echo $coverage['byFileReport'] ?>"><?php echo $file ?></a></td>
<td class="percentage"><span class="percentCoverage"><?php echo number_format($coverage['percentage'], 0) ?>%</span></td>
</tr>
<?php } ?>
</tbody>
</table>
<table>
<caption>Files Not Covered (<a href="#untouched">?</a>)</caption>
<tbody>
<?php foreach ($untouched as $key => $file) { ?>
<tr>
<td><span class="untouchedFile"><?php echo $file ?></span></td>
</tr>
<?php } ?>
</tbody>
</table>
<h2>Glossary</h2>
<dl>
<dt><a name="total-coverage">Total Coverage</a></dt>
<dd>Ratio of all the lines of executable code that were executed to the
lines of code that were not executed. This does not include the files
that were not covered at all.</dd>
<dt><a name="total-files-covered">Total Files Covered</a></dt>
<dd>This is the ratio of the number of files tested, to the number of
files not tested at all.</dd>
<dt><a name="coverage">Coverage</a></dt>
<dd>These files were parsed and loaded by the php interpreter while
running the tests. Percentage is determined by the ratio of number of
lines of code executed to the number of possible executable lines of
code. "dead" lines of code, or code that could not be executed
according to xdebug, are counted as covered because in almost all cases
it is the end of a logical loop.</dd>
<dt><a name="untouched">Files Not Covered</a></dt>
<dd>These files were not loaded by the php interpreter at anytime
during a unit test. You could consider these files having 0% coverage,
but because it is difficult to determine the total coverage unless you
could count the lines for executable code, this is not reflected in the
Total Coverage calculation.</dd>
</dl>
<p>Code coverage generated by <a href="http://www.simpletest.org">SimpleTest</a></p>
</body>
</html>

View File

@ -1,65 +0,0 @@
<?php
require_once(dirname(__FILE__) . '/../../../autorun.php');
class CoverageCalculatorTest extends UnitTestCase {
function skip() {
$this->skipIf(
!file_exists('DB/sqlite.php'),
'The Coverage extension needs to have PEAR installed');
}
function setUp() {
require_once dirname(__FILE__) .'/../coverage_calculator.php';
$this->calc = new CoverageCalculator();
}
function testVariables() {
$coverage = array('file' => array(1,1,1,1));
$untouched = array('missed-file');
$variables = $this->calc->variables($coverage, $untouched);
$this->assertEqual(4, $variables['totalLoc']);
$this->assertEqual(100, $variables['totalPercentCoverage']);
$this->assertEqual(4, $variables['totalLinesOfCoverage']);
$expected = array('file' => array('byFileReport' => 'file.html', 'percentage' => 100));
$this->assertEqual($expected, $variables['coverageByFile']);
$this->assertEqual(50, $variables['filesTouchedPercentage']);
$this->assertEqual($untouched, $variables['untouched']);
}
function testPercentageCoverageByFile() {
$coverage = array(0,0,0,1,1,1);
$results = array();
$this->calc->percentCoverageByFile($coverage, 'file', $results);
$pct = $results[0];
$this->assertEqual(50, $pct['file']['percentage']);
$this->assertEqual('file.html', $pct['file']['byFileReport']);
}
function testTotalLoc() {
$this->assertEqual(13, $this->calc->totalLoc(10, array(1,2,3)));
}
function testLineCoverage() {
$this->assertEqual(10, $this->calc->lineCoverage(10, -1));
$this->assertEqual(10, $this->calc->lineCoverage(10, 0));
$this->assertEqual(11, $this->calc->lineCoverage(10, 1));
}
function testTotalCoverage() {
$this->assertEqual(11, $this->calc->totalCoverage(10, array(-1,1)));
}
static function getAttribute($element, $attribute) {
$a = $element->attributes();
return $a[$attribute];
}
static function dom($stream) {
rewind($stream);
$actual = stream_get_contents($stream);
$html = DOMDocument::loadHTML($actual);
return simplexml_import_dom($html);
}
}
?>

View File

@ -1,83 +0,0 @@
<?php
require_once(dirname(__FILE__) . '/../../../autorun.php');
class CoverageDataHandlerTest extends UnitTestCase {
function skip() {
$this->skipIf(
!file_exists('DB/sqlite.php'),
'The Coverage extension needs to have PEAR installed');
}
function setUp() {
require_once dirname(__FILE__) .'/../coverage_data_handler.php';
}
function testAggregateCoverageCode() {
$handler = new CoverageDataHandler($this->tempdb());
$this->assertEqual(-2, $handler->aggregateCoverageCode(-2, -2));
$this->assertEqual(-2, $handler->aggregateCoverageCode(-2, 10));
$this->assertEqual(-2, $handler->aggregateCoverageCode(10, -2));
$this->assertEqual(-1, $handler->aggregateCoverageCode(-1, -1));
$this->assertEqual(10, $handler->aggregateCoverageCode(-1, 10));
$this->assertEqual(10, $handler->aggregateCoverageCode(10, -1));
$this->assertEqual(20, $handler->aggregateCoverageCode(10, 10));
}
function testSimpleWriteRead() {
$handler = new CoverageDataHandler($this->tempdb());
$handler->createSchema();
$coverage = array(10 => -2, 20 => -1, 30 => 0, 40 => 1);
$handler->write(array('file' => $coverage));
$actual = $handler->readFile('file');
$expected = array(10 => -2, 20 => -1, 30 => 0, 40 => 1);
$this->assertEqual($expected, $actual);
}
function testMultiFileWriteRead() {
$handler = new CoverageDataHandler($this->tempdb());
$handler->createSchema();
$handler->write(array(
'file1' => array(-2, -1, 1),
'file2' => array(-2, -1, 1)
));
$handler->write(array(
'file1' => array(-2, -1, 1)
));
$expected = array(
'file1' => array(-2, -1, 2),
'file2' => array(-2, -1, 1)
);
$actual = $handler->read();
$this->assertEqual($expected, $actual);
}
function testGetfilenames() {
$handler = new CoverageDataHandler($this->tempdb());
$handler->createSchema();
$rawCoverage = array('file0' => array(), 'file1' => array());
$handler->write($rawCoverage);
$actual = $handler->getFilenames();
$this->assertEqual(array('file0', 'file1'), $actual);
}
function testWriteUntouchedFiles() {
$handler = new CoverageDataHandler($this->tempdb());
$handler->createSchema();
$handler->writeUntouchedFile('bluejay');
$handler->writeUntouchedFile('robin');
$this->assertEqual(array('bluejay', 'robin'), $handler->readUntouchedFiles());
}
function testLtrim() {
$this->assertEqual('ber', CoverageDataHandler::ltrim('goo', 'goober'));
$this->assertEqual('some/file', CoverageDataHandler::ltrim('./', './some/file'));
$this->assertEqual('/x/y/z/a/b/c', CoverageDataHandler::ltrim('/a/b/', '/x/y/z/a/b/c'));
}
function tempdb() {
return tempnam(NULL, 'coverage.test.db');
}
}
?>

View File

@ -1,22 +0,0 @@
<?php
require_once(dirname(__FILE__) . '/../../../autorun.php');
class CoverageReporterTest extends UnitTestCase {
function skip() {
$this->skipIf(
!file_exists('DB/sqlite.php'),
'The Coverage extension needs to have PEAR installed');
}
function setUp() {
require_once dirname(__FILE__) .'/../coverage_reporter.php';
new CoverageReporter();
}
function testreportFilename() {
$this->assertEqual("parula.php.html", CoverageReporter::reportFilename("parula.php"));
$this->assertEqual("warbler_parula.php.html", CoverageReporter::reportFilename("warbler/parula.php"));
$this->assertEqual("warbler_parula.php.html", CoverageReporter::reportFilename("warbler\\parula.php"));
}
}
?>

View File

@ -1,109 +0,0 @@
<?php
require_once(dirname(__FILE__) . '/../../../autorun.php');
require_once(dirname(__FILE__) . '/../../../mock_objects.php');
class CodeCoverageTest extends UnitTestCase {
function skip() {
$this->skipIf(
!file_exists('DB/sqlite.php'),
'The Coverage extension needs to have PEAR installed');
}
function setUp() {
require_once dirname(__FILE__) .'/../coverage.php';
}
function testIsFileIncluded() {
$coverage = new CodeCoverage();
$this->assertTrue($coverage->isFileIncluded('aaa'));
$coverage->includes = array('a');
$this->assertTrue($coverage->isFileIncluded('aaa'));
$coverage->includes = array('x');
$this->assertFalse($coverage->isFileIncluded('aaa'));
$coverage->excludes = array('aa');
$this->assertFalse($coverage->isFileIncluded('aaa'));
}
function testIsFileIncludedRegexp() {
$coverage = new CodeCoverage();
$coverage->includes = array('modules/.*\.php$');
$coverage->excludes = array('bad-bunny.php');
$this->assertFalse($coverage->isFileIncluded('modules/a.test'));
$this->assertFalse($coverage->isFileIncluded('modules/bad-bunny.test'));
$this->assertTrue($coverage->isFileIncluded('modules/test.php'));
$this->assertFalse($coverage->isFileIncluded('module-bad/good-bunny.php'));
$this->assertTrue($coverage->isFileIncluded('modules/good-bunny.php'));
}
function testIsDirectoryIncludedPastMaxDepth() {
$coverage = new CodeCoverage();
$coverage->maxDirectoryDepth = 5;
$this->assertTrue($coverage->isDirectoryIncluded('aaa', 1));
$this->assertFalse($coverage->isDirectoryIncluded('aaa', 5));
}
function testIsDirectoryIncluded() {
$coverage = new CodeCoverage();
$this->assertTrue($coverage->isDirectoryIncluded('aaa', 0));
$coverage->excludes = array('b$');
$this->assertTrue($coverage->isDirectoryIncluded('aaa', 0));
$coverage->includes = array('a$'); // includes are ignore, all dirs are included unless excluded
$this->assertTrue($coverage->isDirectoryIncluded('aaa', 0));
$coverage->excludes = array('.*a$');
$this->assertFalse($coverage->isDirectoryIncluded('aaa', 0));
}
function testFilter() {
$coverage = new CodeCoverage();
$data = array('a' => 0, 'b' => 0, 'c' => 0);
$coverage->includes = array('b');
$coverage->filter($data);
$this->assertEqual(array('b' => 0), $data);
}
function testUntouchedFiles() {
$coverage = new CodeCoverage();
$touched = array_flip(array("test/coverage_test.php"));
$actual = array();
$coverage->includes = array('coverage_test\.php$');
$parentDir = realpath(dirname(__FILE__));
$coverage->getUntouchedFiles($actual, $touched, $parentDir, $parentDir);
$this->assertEqual(array("coverage_test.php"), $actual);
}
function testResetLog() {
$coverage = new CodeCoverage();
$coverage->log = tempnam(NULL, 'php.xdebug.coverage.test.');
$coverage->resetLog();
$this->assertTrue(file_exists($coverage->log));
}
function testSettingsSerialization() {
$coverage = new CodeCoverage();
$coverage->log = '/banana/boat';
$coverage->includes = array('apple', 'orange');
$coverage->excludes = array('tomato', 'pea');
$data = $coverage->getSettings();
$this->assertNotNull($data);
$actual = new CodeCoverage();
$actual->setSettings($data);
$this->assertEqual('/banana/boat', $actual->log);
$this->assertEqual(array('apple', 'orange'), $actual->includes);
$this->assertEqual(array('tomato', 'pea'), $actual->excludes);
}
function testSettingsCanBeReadWrittenToDisk() {
$settings_file = 'banana-boat-coverage-settings-test.dat';
$coverage = new CodeCoverage();
$coverage->log = '/banana/boat';
$coverage->settingsFile = $settings_file;
$coverage->writeSettings();
$actual = new CodeCoverage();
$actual->settingsFile = $settings_file;
$actual->readSettings();
$this->assertEqual('/banana/boat', $actual->log);
}
}
?>

View File

@ -1,70 +0,0 @@
<?php
require_once dirname(__FILE__) . '/../../../autorun.php';
class CoverageUtilsTest extends UnitTestCase {
function skip() {
$this->skipIf(
!file_exists('DB/sqlite.php'),
'The Coverage extension needs to have PEAR installed');
}
function setUp() {
require_once dirname(__FILE__) .'/../coverage_utils.php';
}
function testMkdir() {
CoverageUtils::mkdir(dirname(__FILE__));
try {
CoverageUtils::mkdir(__FILE__);
$this->fail("Should give error about cannot create dir of a file");
} catch (Exception $expected) {
}
}
function testIsPackageClassAvailable() {
$coverageSource = dirname(__FILE__) .'/../coverage_calculator.php';
$this->assertTrue(CoverageUtils::isPackageClassAvailable($coverageSource, 'CoverageCalculator'));
$this->assertFalse(CoverageUtils::isPackageClassAvailable($coverageSource, 'BogusCoverage'));
$this->assertFalse(CoverageUtils::isPackageClassAvailable('bogus-file', 'BogusCoverage'));
$this->assertTrue(CoverageUtils::isPackageClassAvailable('bogus-file', 'CoverageUtils'));
}
function testParseArgumentsMultiValue() {
$actual = CoverageUtils::parseArguments(array('scriptname', '--a=b', '--a=c'), True);
$expected = array('extraArguments' => array(), 'a' => 'c', 'a[]' => array('b', 'c'));
$this->assertEqual($expected, $actual);
}
function testParseArguments() {
$actual = CoverageUtils::parseArguments(array('scriptname', '--a=b', '-c', 'xxx'));
$expected = array('a' => 'b', 'c' => '', 'extraArguments' => array('xxx'));
$this->assertEqual($expected, $actual);
}
function testParseDoubleDashNoArguments() {
$actual = CoverageUtils::parseArguments(array('scriptname', '--aa'));
$this->assertTrue(isset($actual['aa']));
}
function testParseHyphenedExtraArguments() {
$actual = CoverageUtils::parseArguments(array('scriptname', '--alpha-beta=b', 'gamma-lambda'));
$expected = array('alpha-beta' => 'b', 'extraArguments' => array('gamma-lambda'));
$this->assertEqual($expected, $actual);
}
function testAddItemAsArray() {
$actual = array();
CoverageUtils::addItemAsArray($actual, 'bird', 'duck');
$this->assertEqual(array('bird[]' => array('duck')), $actual);
CoverageUtils::addItemAsArray(&$actual, 'bird', 'pigeon');
$this->assertEqual(array('bird[]' => array('duck', 'pigeon')), $actual);
}
function testIssetOr() {
$data = array('bird' => 'gull');
$this->assertEqual('lab', CoverageUtils::issetOr($data['dog'], 'lab'));
$this->assertEqual('gull', CoverageUtils::issetOr($data['bird'], 'sparrow'));
}
}
?>

View File

@ -1,4 +0,0 @@
<?php
// sample code
$x = 1 + 2;
if (false) echo "dead";

View File

@ -1,69 +0,0 @@
<?php
require_once(dirname(__FILE__) . '/../../../autorun.php');
class SimpleCoverageWriterTest extends UnitTestCase {
function skip() {
$this->skipIf(
!file_exists('DB/sqlite.php'),
'The Coverage extension needs to have PEAR installed');
}
function setUp() {
require_once dirname(__FILE__) .'/../simple_coverage_writer.php';
require_once dirname(__FILE__) .'/../coverage_calculator.php';
}
function testGenerateSummaryReport() {
$writer = new SimpleCoverageWriter();
$coverage = array('file' => array(0, 1));
$untouched = array('missed-file');
$calc = new CoverageCalculator();
$variables = $calc->variables($coverage, $untouched);
$variables['title'] = 'coverage';
$out = fopen("php://memory", 'w');
$writer->writeSummary($out, $variables);
$dom = self::dom($out);
$totalPercentCoverage = $dom->elements->xpath("//span[@class='totalPercentCoverage']");
$this->assertEqual('50%', (string)$totalPercentCoverage[0]);
$fileLinks = $dom->elements->xpath("//a[@class='byFileReportLink']");
$fileLinkAttr = $fileLinks[0]->attributes();
$this->assertEqual('file.html', $fileLinkAttr['href']);
$this->assertEqual('file', (string)($fileLinks[0]));
$untouchedFile = $dom->elements->xpath("//span[@class='untouchedFile']");
$this->assertEqual('missed-file', (string)$untouchedFile[0]);
}
function testGenerateCoverageByFile() {
$writer = new SimpleCoverageWriter();
$cov = array(3 => 1, 4 => -2); // 2 comments, 1 code, 1 dead (1-based indexes)
$out = fopen("php://memory", 'w');
$file = dirname(__FILE__) .'/sample/code.php';
$calc = new CoverageCalculator();
$variables = $calc->coverageByFileVariables($file, $cov);
$variables['title'] = 'coverage';
$writer->writeByFile($out, $variables);
$dom = self::dom($out);
$cells = $dom->elements->xpath("//table[@id='code']/tbody/tr/td/span");
$this->assertEqual("comment code", self::getAttribute($cells[1], 'class'));
$this->assertEqual("comment code", self::getAttribute($cells[3], 'class'));
$this->assertEqual("covered code", self::getAttribute($cells[5], 'class'));
$this->assertEqual("dead code", self::getAttribute($cells[7], 'class'));
}
static function getAttribute($element, $attribute) {
$a = $element->attributes();
return $a[$attribute];
}
static function dom($stream) {
rewind($stream);
$actual = stream_get_contents($stream);
$html = DOMDocument::loadHTML($actual);
return simplexml_import_dom($html);
}
}
?>

View File

@ -1,14 +0,0 @@
<?php
// $Id: $
require_once(dirname(__FILE__) . '/../../../autorun.php');
class CoverageUnitTests extends TestSuite {
function CoverageUnitTests() {
$this->TestSuite('Coverage Unit tests');
$path = dirname(__FILE__) . '/*_test.php';
foreach(glob($path) as $test) {
$this->addFile($test);
}
}
}
?>

View File

@ -1,196 +0,0 @@
<?php
/**
* adapter for SimpleTest to use PEAR PHPUnit test cases
* @package SimpleTest
* @subpackage Extensions
* @version $Id: pear_test_case.php 1836 2008-12-21 00:02:26Z edwardzyang $
*/
/**#@+
* include SimpleTest files
*/
require_once(dirname(__FILE__) . '/../dumper.php');
require_once(dirname(__FILE__) . '/../compatibility.php');
require_once(dirname(__FILE__) . '/../test_case.php');
require_once(dirname(__FILE__) . '/../expectation.php');
/**#@-*/
/**
* Adapter for PEAR PHPUnit test case to allow
* legacy PEAR test cases to be used with SimpleTest.
* @package SimpleTest
* @subpackage Extensions
*/
class PHPUnit_TestCase extends SimpleTestCase {
private $_loosely_typed;
/**
* Constructor. Sets the test name.
* @param $label Test name to display.
* @public
*/
function __construct($label = false) {
parent::__construct($label);
$this->_loosely_typed = false;
}
/**
* Will test straight equality if set to loose
* typing, or identity if not.
* @param $first First value.
* @param $second Comparison value.
* @param $message Message to display.
* @public
*/
function assertEquals($first, $second, $message = "%s", $delta = 0) {
if ($this->_loosely_typed) {
$expectation = new EqualExpectation($first);
} else {
$expectation = new IdenticalExpectation($first);
}
$this->assert($expectation, $second, $message);
}
/**
* Passes if the value tested is not null.
* @param $value Value to test against.
* @param $message Message to display.
* @public
*/
function assertNotNull($value, $message = "%s") {
parent::assert(new TrueExpectation(), isset($value), $message);
}
/**
* Passes if the value tested is null.
* @param $value Value to test against.
* @param $message Message to display.
* @public
*/
function assertNull($value, $message = "%s") {
parent::assert(new TrueExpectation(), !isset($value), $message);
}
/**
* Identity test tests for the same object.
* @param $first First object handle.
* @param $second Hopefully the same handle.
* @param $message Message to display.
* @public
*/
function assertSame($first, $second, $message = "%s") {
$dumper = new SimpleDumper();
$message = sprintf(
$message,
"[" . $dumper->describeValue($first) .
"] and [" . $dumper->describeValue($second) .
"] should reference the same object");
return $this->assert(
new TrueExpectation(),
SimpleTestCompatibility::isReference($first, $second),
$message);
}
/**
* Inverted identity test.
* @param $first First object handle.
* @param $second Hopefully a different handle.
* @param $message Message to display.
* @public
*/
function assertNotSame($first, $second, $message = "%s") {
$dumper = new SimpleDumper();
$message = sprintf(
$message,
"[" . $dumper->describeValue($first) .
"] and [" . $dumper->describeValue($second) .
"] should not be the same object");
return $this->assert(
new falseExpectation(),
SimpleTestCompatibility::isReference($first, $second),
$message);
}
/**
* Sends pass if the test condition resolves true,
* a fail otherwise.
* @param $condition Condition to test true.
* @param $message Message to display.
* @public
*/
function assertTrue($condition, $message = "%s") {
parent::assert(new TrueExpectation(), $condition, $message);
}
/**
* Sends pass if the test condition resolves false,
* a fail otherwise.
* @param $condition Condition to test false.
* @param $message Message to display.
* @public
*/
function assertFalse($condition, $message = "%s") {
parent::assert(new FalseExpectation(), $condition, $message);
}
/**
* Tests a regex match. Needs refactoring.
* @param $pattern Regex to match.
* @param $subject String to search in.
* @param $message Message to display.
* @public
*/
function assertRegExp($pattern, $subject, $message = "%s") {
$this->assert(new PatternExpectation($pattern), $subject, $message);
}
/**
* Tests the type of a value.
* @param $value Value to take type of.
* @param $type Hoped for type.
* @param $message Message to display.
* @public
*/
function assertType($value, $type, $message = "%s") {
parent::assert(new TrueExpectation(), gettype($value) == strtolower($type), $message);
}
/**
* Sets equality operation to act as a simple equal
* comparison only, allowing a broader range of
* matches.
* @param $loosely_typed True for broader comparison.
* @public
*/
function setLooselyTyped($loosely_typed) {
$this->_loosely_typed = $loosely_typed;
}
/**
* For progress indication during
* a test amongst other things.
* @return Usually one.
* @public
*/
function countTestCases() {
return $this->getSize();
}
/**
* Accessor for name, normally just the class
* name.
* @public
*/
function getName() {
return $this->getLabel();
}
/**
* Does nothing. For compatibility only.
* @param $name Dummy
* @public
*/
function setName($name) {
}
}
?>

View File

@ -1,53 +0,0 @@
<?php
/**
* Extension for a TestDox reporter
* @package SimpleTest
* @subpackage Extensions
* @version $Id: testdox.php 2004 2010-10-31 13:44:14Z jsweat $
*/
/**
* TestDox reporter
* @package SimpleTest
* @subpackage Extensions
*/
class TestDoxReporter extends SimpleReporter
{
var $_test_case_pattern = '/^TestOf(.*)$/';
function __construct($test_case_pattern = '/^TestOf(.*)$/') {
parent::__construct();
$this->_test_case_pattern = empty($test_case_pattern) ? '/^(.*)$/' : $test_case_pattern;
}
function paintCaseStart($test_name) {
preg_match($this->_test_case_pattern, $test_name, $matches);
if (!empty($matches[1])) {
echo $matches[1] . "\n";
} else {
echo $test_name . "\n";
}
}
function paintCaseEnd($test_name) {
echo "\n";
}
function paintMethodStart($test_name) {
if (!preg_match('/^test(.*)$/i', $test_name, $matches)) {
return;
}
$test_name = $matches[1];
$test_name = preg_replace('/([A-Z])([A-Z])/', '$1 $2', $test_name);
echo '- ' . strtolower(preg_replace('/([a-zA-Z])([A-Z0-9])/', '$1 $2', $test_name));
}
function paintMethodEnd($test_name) {
echo "\n";
}
function paintFail($message) {
echo " [FAILED]";
}
}
?>

View File

@ -1,107 +0,0 @@
<?php
// $Id: test.php 1748 2008-04-14 01:50:41Z lastcraft $
require_once dirname(__FILE__) . '/../../autorun.php';
require_once dirname(__FILE__) . '/../testdox.php';
// uncomment to see test dox in action
//SimpleTest::prefer(new TestDoxReporter());
class TestOfTestDoxReporter extends UnitTestCase
{
function testIsAnInstanceOfSimpleScorerAndReporter() {
$dox = new TestDoxReporter();
$this->assertIsA($dox, 'SimpleScorer');
$this->assertIsA($dox, 'SimpleReporter');
}
function testOutputsNameOfTestCase() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintCaseStart('TestOfTestDoxReporter');
$buffer = ob_get_clean();
$this->assertPattern('/^TestDoxReporter/', $buffer);
}
function testOutputOfTestCaseNameFilteredByConstructParameter() {
$dox = new TestDoxReporter('/^(.*)Test$/');
ob_start();
$dox->paintCaseStart('SomeGreatWidgetTest');
$buffer = ob_get_clean();
$this->assertPattern('/^SomeGreatWidget/', $buffer);
}
function testIfTest_case_patternIsEmptyAssumeEverythingMatches() {
$dox = new TestDoxReporter('');
ob_start();
$dox->paintCaseStart('TestOfTestDoxReporter');
$buffer = ob_get_clean();
$this->assertPattern('/^TestOfTestDoxReporter/', $buffer);
}
function testEmptyLineInsertedWhenCaseEnds() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintCaseEnd('TestOfTestDoxReporter');
$buffer = ob_get_clean();
$this->assertEqual("\n", $buffer);
}
function testPaintsTestMethodInTestDoxFormat() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintMethodStart('testSomeGreatTestCase');
$buffer = ob_get_clean();
$this->assertEqual("- some great test case", $buffer);
unset($buffer);
$random = rand(100, 200);
ob_start();
$dox->paintMethodStart("testRandomNumberIs{$random}");
$buffer = ob_get_clean();
$this->assertEqual("- random number is {$random}", $buffer);
}
function testDoesNotOutputAnythingOnNoneTestMethods() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintMethodStart('nonMatchingMethod');
$buffer = ob_get_clean();
$this->assertEqual('', $buffer);
}
function testPaintMethodAddLineBreak() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintMethodEnd('someMethod');
$buffer = ob_get_clean();
$this->assertEqual("\n", $buffer);
}
function testProperlySpacesSingleLettersInMethodName() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintMethodStart('testAVerySimpleAgainAVerySimpleMethod');
$buffer = ob_get_clean();
$this->assertEqual('- a very simple again a very simple method', $buffer);
}
function testOnFailureThisPrintsFailureNotice() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintFail('');
$buffer = ob_get_clean();
$this->assertEqual(' [FAILED]', $buffer);
}
function testWhenMatchingMethodNamesTestPrefixIsCaseInsensitive() {
$dox = new TestDoxReporter();
ob_start();
$dox->paintMethodStart('TESTSupportsAllUppercaseTestPrefixEvenThoughIDoNotKnowWhyYouWouldDoThat');
$buffer = ob_get_clean();
$this->assertEqual(
'- supports all uppercase test prefix even though i do not know why you would do that',
$buffer
);
}
}
?>

View File

@ -1,361 +0,0 @@
<?php
/**
* Base include file for SimpleTest.
* @package SimpleTest
* @subpackage WebTester
* @version $Id: form.php 2013 2011-04-29 09:29:45Z pp11 $
*/
/**#@+
* include SimpleTest files
*/
require_once(dirname(__FILE__) . '/tag.php');
require_once(dirname(__FILE__) . '/encoding.php');
require_once(dirname(__FILE__) . '/selector.php');
/**#@-*/
/**
* Form tag class to hold widget values.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleForm {
private $method;
private $action;
private $encoding;
private $default_target;
private $id;
private $buttons;
private $images;
private $widgets;
private $radios;
private $checkboxes;
/**
* Starts with no held controls/widgets.
* @param SimpleTag $tag Form tag to read.
* @param SimplePage $page Holding page.
*/
function __construct($tag, $page) {
$this->method = $tag->getAttribute('method');
$this->action = $this->createAction($tag->getAttribute('action'), $page);
$this->encoding = $this->setEncodingClass($tag);
$this->default_target = false;
$this->id = $tag->getAttribute('id');
$this->buttons = array();
$this->images = array();
$this->widgets = array();
$this->radios = array();
$this->checkboxes = array();
}
/**
* Creates the request packet to be sent by the form.
* @param SimpleTag $tag Form tag to read.
* @return string Packet class.
* @access private
*/
protected function setEncodingClass($tag) {
if (strtolower($tag->getAttribute('method')) == 'post') {
if (strtolower($tag->getAttribute('enctype')) == 'multipart/form-data') {
return 'SimpleMultipartEncoding';
}
return 'SimplePostEncoding';
}
return 'SimpleGetEncoding';
}
/**
* Sets the frame target within a frameset.
* @param string $frame Name of frame.
* @access public
*/
function setDefaultTarget($frame) {
$this->default_target = $frame;
}
/**
* Accessor for method of form submission.
* @return string Either get or post.
* @access public
*/
function getMethod() {
return ($this->method ? strtolower($this->method) : 'get');
}
/**
* Combined action attribute with current location
* to get an absolute form target.
* @param string $action Action attribute from form tag.
* @param SimpleUrl $base Page location.
* @return SimpleUrl Absolute form target.
*/
protected function createAction($action, $page) {
if (($action === '') || ($action === false)) {
return $page->expandUrl($page->getUrl());
}
return $page->expandUrl(new SimpleUrl($action));;
}
/**
* Absolute URL of the target.
* @return SimpleUrl URL target.
* @access public
*/
function getAction() {
$url = $this->action;
if ($this->default_target && ! $url->getTarget()) {
$url->setTarget($this->default_target);
}
if ($this->getMethod() == 'get') {
$url->clearRequest();
}
return $url;
}
/**
* Creates the encoding for the current values in the
* form.
* @return SimpleFormEncoding Request to submit.
* @access private
*/
protected function encode() {
$class = $this->encoding;
$encoding = new $class();
for ($i = 0, $count = count($this->widgets); $i < $count; $i++) {
$this->widgets[$i]->write($encoding);
}
return $encoding;
}
/**
* ID field of form for unique identification.
* @return string Unique tag ID.
* @access public
*/
function getId() {
return $this->id;
}
/**
* Adds a tag contents to the form.
* @param SimpleWidget $tag Input tag to add.
*/
function addWidget($tag) {
if (strtolower($tag->getAttribute('type')) == 'submit') {
$this->buttons[] = $tag;
} elseif (strtolower($tag->getAttribute('type')) == 'image') {
$this->images[] = $tag;
} elseif ($tag->getName()) {
$this->setWidget($tag);
}
}
/**
* Sets the widget into the form, grouping radio
* buttons if any.
* @param SimpleWidget $tag Incoming form control.
* @access private
*/
protected function setWidget($tag) {
if (strtolower($tag->getAttribute('type')) == 'radio') {
$this->addRadioButton($tag);
} elseif (strtolower($tag->getAttribute('type')) == 'checkbox') {
$this->addCheckbox($tag);
} else {
$this->widgets[] = &$tag;
}
}
/**
* Adds a radio button, building a group if necessary.
* @param SimpleRadioButtonTag $tag Incoming form control.
* @access private
*/
protected function addRadioButton($tag) {
if (! isset($this->radios[$tag->getName()])) {
$this->widgets[] = new SimpleRadioGroup();
$this->radios[$tag->getName()] = count($this->widgets) - 1;
}
$this->widgets[$this->radios[$tag->getName()]]->addWidget($tag);
}
/**
* Adds a checkbox, making it a group on a repeated name.
* @param SimpleCheckboxTag $tag Incoming form control.
* @access private
*/
protected function addCheckbox($tag) {
if (! isset($this->checkboxes[$tag->getName()])) {
$this->widgets[] = $tag;
$this->checkboxes[$tag->getName()] = count($this->widgets) - 1;
} else {
$index = $this->checkboxes[$tag->getName()];
if (! SimpleTestCompatibility::isA($this->widgets[$index], 'SimpleCheckboxGroup')) {
$previous = $this->widgets[$index];
$this->widgets[$index] = new SimpleCheckboxGroup();
$this->widgets[$index]->addWidget($previous);
}
$this->widgets[$index]->addWidget($tag);
}
}
/**
* Extracts current value from form.
* @param SimpleSelector $selector Criteria to apply.
* @return string/array Value(s) as string or null
* if not set.
* @access public
*/
function getValue($selector) {
for ($i = 0, $count = count($this->widgets); $i < $count; $i++) {
if ($selector->isMatch($this->widgets[$i])) {
return $this->widgets[$i]->getValue();
}
}
foreach ($this->buttons as $button) {
if ($selector->isMatch($button)) {
return $button->getValue();
}
}
return null;
}
/**
* Sets a widget value within the form.
* @param SimpleSelector $selector Criteria to apply.
* @param string $value Value to input into the widget.
* @return boolean True if value is legal, false
* otherwise. If the field is not
* present, nothing will be set.
* @access public
*/
function setField($selector, $value, $position=false) {
$success = false;
$_position = 0;
for ($i = 0, $count = count($this->widgets); $i < $count; $i++) {
if ($selector->isMatch($this->widgets[$i])) {
$_position++;
if ($position === false or $_position === (int)$position) {
if ($this->widgets[$i]->setValue($value)) {
$success = true;
}
}
}
}
return $success;
}
/**
* Used by the page object to set widgets labels to
* external label tags.
* @param SimpleSelector $selector Criteria to apply.
* @access public
*/
function attachLabelBySelector($selector, $label) {
for ($i = 0, $count = count($this->widgets); $i < $count; $i++) {
if ($selector->isMatch($this->widgets[$i])) {
if (method_exists($this->widgets[$i], 'setLabel')) {
$this->widgets[$i]->setLabel($label);
return;
}
}
}
}
/**
* Test to see if a form has a submit button.
* @param SimpleSelector $selector Criteria to apply.
* @return boolean True if present.
* @access public
*/
function hasSubmit($selector) {
foreach ($this->buttons as $button) {
if ($selector->isMatch($button)) {
return true;
}
}
return false;
}
/**
* Test to see if a form has an image control.
* @param SimpleSelector $selector Criteria to apply.
* @return boolean True if present.
* @access public
*/
function hasImage($selector) {
foreach ($this->images as $image) {
if ($selector->isMatch($image)) {
return true;
}
}
return false;
}
/**
* Gets the submit values for a selected button.
* @param SimpleSelector $selector Criteria to apply.
* @param hash $additional Additional data for the form.
* @return SimpleEncoding Submitted values or false
* if there is no such button
* in the form.
* @access public
*/
function submitButton($selector, $additional = false) {
$additional = $additional ? $additional : array();
foreach ($this->buttons as $button) {
if ($selector->isMatch($button)) {
$encoding = $this->encode();
$button->write($encoding);
if ($additional) {
$encoding->merge($additional);
}
return $encoding;
}
}
return false;
}
/**
* Gets the submit values for an image.
* @param SimpleSelector $selector Criteria to apply.
* @param integer $x X-coordinate of click.
* @param integer $y Y-coordinate of click.
* @param hash $additional Additional data for the form.
* @return SimpleEncoding Submitted values or false
* if there is no such button in the
* form.
* @access public
*/
function submitImage($selector, $x, $y, $additional = false) {
$additional = $additional ? $additional : array();
foreach ($this->images as $image) {
if ($selector->isMatch($image)) {
$encoding = $this->encode();
$image->write($encoding, $x, $y);
if ($additional) {
$encoding->merge($additional);
}
return $encoding;
}
}
return false;
}
/**
* Simply submits the form without the submit button
* value. Used when there is only one button or it
* is unimportant.
* @return hash Submitted values.
* @access public
*/
function submit($additional = false) {
$encoding = $this->encode();
if ($additional) {
$encoding->merge($additional);
}
return $encoding;
}
}
?>

View File

@ -1,592 +0,0 @@
<?php
/**
* Base include file for SimpleTest
* @package SimpleTest
* @subpackage WebTester
* @version $Id: frames.php 1784 2008-04-26 13:07:14Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/page.php');
require_once(dirname(__FILE__) . '/user_agent.php');
/**#@-*/
/**
* A composite page. Wraps a frameset page and
* adds subframes. The original page will be
* mostly ignored. Implements the SimplePage
* interface so as to be interchangeable.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleFrameset {
private $frameset;
private $frames;
private $focus;
private $names;
/**
* Stashes the frameset page. Will make use of the
* browser to fetch the sub frames recursively.
* @param SimplePage $page Frameset page.
*/
function __construct($page) {
$this->frameset = $page;
$this->frames = array();
$this->focus = false;
$this->names = array();
}
/**
* Adds a parsed page to the frameset.
* @param SimplePage $page Frame page.
* @param string $name Name of frame in frameset.
* @access public
*/
function addFrame($page, $name = false) {
$this->frames[] = $page;
if ($name) {
$this->names[$name] = count($this->frames) - 1;
}
}
/**
* Replaces existing frame with another. If the
* frame is nested, then the call is passed down
* one level.
* @param array $path Path of frame in frameset.
* @param SimplePage $page Frame source.
* @access public
*/
function setFrame($path, $page) {
$name = array_shift($path);
if (isset($this->names[$name])) {
$index = $this->names[$name];
} else {
$index = $name - 1;
}
if (count($path) == 0) {
$this->frames[$index] = &$page;
return;
}
$this->frames[$index]->setFrame($path, $page);
}
/**
* Accessor for current frame focus. Will be
* false if no frame has focus. Will have the nested
* frame focus if any.
* @return array Labels or indexes of nested frames.
* @access public
*/
function getFrameFocus() {
if ($this->focus === false) {
return array();
}
return array_merge(
array($this->getPublicNameFromIndex($this->focus)),
$this->frames[$this->focus]->getFrameFocus());
}
/**
* Turns an internal array index into the frames list
* into a public name, or if none, then a one offset
* index.
* @param integer $subject Internal index.
* @return integer/string Public name.
* @access private
*/
protected function getPublicNameFromIndex($subject) {
foreach ($this->names as $name => $index) {
if ($subject == $index) {
return $name;
}
}
return $subject + 1;
}
/**
* Sets the focus by index. The integer index starts from 1.
* If already focused and the target frame also has frames,
* then the nested frame will be focused.
* @param integer $choice Chosen frame.
* @return boolean True if frame exists.
* @access public
*/
function setFrameFocusByIndex($choice) {
if (is_integer($this->focus)) {
if ($this->frames[$this->focus]->hasFrames()) {
return $this->frames[$this->focus]->setFrameFocusByIndex($choice);
}
}
if (($choice < 1) || ($choice > count($this->frames))) {
return false;
}
$this->focus = $choice - 1;
return true;
}
/**
* Sets the focus by name. If already focused and the
* target frame also has frames, then the nested frame
* will be focused.
* @param string $name Chosen frame.
* @return boolean True if frame exists.
* @access public
*/
function setFrameFocus($name) {
if (is_integer($this->focus)) {
if ($this->frames[$this->focus]->hasFrames()) {
return $this->frames[$this->focus]->setFrameFocus($name);
}
}
if (in_array($name, array_keys($this->names))) {
$this->focus = $this->names[$name];
return true;
}
return false;
}
/**
* Clears the frame focus.
* @access public
*/
function clearFrameFocus() {
$this->focus = false;
$this->clearNestedFramesFocus();
}
/**
* Clears the frame focus for any nested frames.
* @access private
*/
protected function clearNestedFramesFocus() {
for ($i = 0; $i < count($this->frames); $i++) {
$this->frames[$i]->clearFrameFocus();
}
}
/**
* Test for the presence of a frameset.
* @return boolean Always true.
* @access public
*/
function hasFrames() {
return true;
}
/**
* Accessor for frames information.
* @return array/string Recursive hash of frame URL strings.
* The key is either a numerical
* index or the name attribute.
* @access public
*/
function getFrames() {
$report = array();
for ($i = 0; $i < count($this->frames); $i++) {
$report[$this->getPublicNameFromIndex($i)] =
$this->frames[$i]->getFrames();
}
return $report;
}
/**
* Accessor for raw text of either all the pages or
* the frame in focus.
* @return string Raw unparsed content.
* @access public
*/
function getRaw() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getRaw();
}
$raw = '';
for ($i = 0; $i < count($this->frames); $i++) {
$raw .= $this->frames[$i]->getRaw();
}
return $raw;
}
/**
* Accessor for plain text of either all the pages or
* the frame in focus.
* @return string Plain text content.
* @access public
*/
function getText() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getText();
}
$raw = '';
for ($i = 0; $i < count($this->frames); $i++) {
$raw .= ' ' . $this->frames[$i]->getText();
}
return trim($raw);
}
/**
* Accessor for last error.
* @return string Error from last response.
* @access public
*/
function getTransportError() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getTransportError();
}
return $this->frameset->getTransportError();
}
/**
* Request method used to fetch this frame.
* @return string GET, POST or HEAD.
* @access public
*/
function getMethod() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getMethod();
}
return $this->frameset->getMethod();
}
/**
* Original resource name.
* @return SimpleUrl Current url.
* @access public
*/
function getUrl() {
if (is_integer($this->focus)) {
$url = $this->frames[$this->focus]->getUrl();
$url->setTarget($this->getPublicNameFromIndex($this->focus));
} else {
$url = $this->frameset->getUrl();
}
return $url;
}
/**
* Page base URL.
* @return SimpleUrl Current url.
* @access public
*/
function getBaseUrl() {
if (is_integer($this->focus)) {
$url = $this->frames[$this->focus]->getBaseUrl();
} else {
$url = $this->frameset->getBaseUrl();
}
return $url;
}
/**
* Expands expandomatic URLs into fully qualified
* URLs for the frameset page.
* @param SimpleUrl $url Relative URL.
* @return SimpleUrl Absolute URL.
* @access public
*/
function expandUrl($url) {
return $this->frameset->expandUrl($url);
}
/**
* Original request data.
* @return mixed Sent content.
* @access public
*/
function getRequestData() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getRequestData();
}
return $this->frameset->getRequestData();
}
/**
* Accessor for current MIME type.
* @return string MIME type as string; e.g. 'text/html'
* @access public
*/
function getMimeType() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getMimeType();
}
return $this->frameset->getMimeType();
}
/**
* Accessor for last response code.
* @return integer Last HTTP response code received.
* @access public
*/
function getResponseCode() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getResponseCode();
}
return $this->frameset->getResponseCode();
}
/**
* Accessor for last Authentication type. Only valid
* straight after a challenge (401).
* @return string Description of challenge type.
* @access public
*/
function getAuthentication() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getAuthentication();
}
return $this->frameset->getAuthentication();
}
/**
* Accessor for last Authentication realm. Only valid
* straight after a challenge (401).
* @return string Name of security realm.
* @access public
*/
function getRealm() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getRealm();
}
return $this->frameset->getRealm();
}
/**
* Accessor for outgoing header information.
* @return string Header block.
* @access public
*/
function getRequest() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getRequest();
}
return $this->frameset->getRequest();
}
/**
* Accessor for raw header information.
* @return string Header block.
* @access public
*/
function getHeaders() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getHeaders();
}
return $this->frameset->getHeaders();
}
/**
* Accessor for parsed title.
* @return string Title or false if no title is present.
* @access public
*/
function getTitle() {
return $this->frameset->getTitle();
}
/**
* Accessor for a list of all fixed links.
* @return array List of urls as strings.
* @access public
*/
function getUrls() {
if (is_integer($this->focus)) {
return $this->frames[$this->focus]->getUrls();
}
$urls = array();
foreach ($this->frames as $frame) {
$urls = array_merge($urls, $frame->getUrls());
}
return array_values(array_unique($urls));
}
/**
* Accessor for URLs by the link label. Label will match
* regardess of whitespace issues and case.
* @param string $label Text of link.
* @return array List of links with that label.
* @access public
*/
function getUrlsByLabel($label) {
if (is_integer($this->focus)) {
return $this->tagUrlsWithFrame(
$this->frames[$this->focus]->getUrlsByLabel($label),
$this->focus);
}
$urls = array();
foreach ($this->frames as $index => $frame) {
$urls = array_merge(
$urls,
$this->tagUrlsWithFrame(
$frame->getUrlsByLabel($label),
$index));
}
return $urls;
}
/**
* Accessor for a URL by the id attribute. If in a frameset
* then the first link found with that ID attribute is
* returned only. Focus on a frame if you want one from
* a specific part of the frameset.
* @param string $id Id attribute of link.
* @return string URL with that id.
* @access public
*/
function getUrlById($id) {
foreach ($this->frames as $index => $frame) {
if ($url = $frame->getUrlById($id)) {
if (! $url->gettarget()) {
$url->setTarget($this->getPublicNameFromIndex($index));
}
return $url;
}
}
return false;
}
/**
* Attaches the intended frame index to a list of URLs.
* @param array $urls List of SimpleUrls.
* @param string $frame Name of frame or index.
* @return array List of tagged URLs.
* @access private
*/
protected function tagUrlsWithFrame($urls, $frame) {
$tagged = array();
foreach ($urls as $url) {
if (! $url->getTarget()) {
$url->setTarget($this->getPublicNameFromIndex($frame));
}
$tagged[] = $url;
}
return $tagged;
}
/**
* Finds a held form by button label. Will only
* search correctly built forms.
* @param SimpleSelector $selector Button finder.
* @return SimpleForm Form object containing
* the button.
* @access public
*/
function getFormBySubmit($selector) {
return $this->findForm('getFormBySubmit', $selector);
}
/**
* Finds a held form by image using a selector.
* Will only search correctly built forms. The first
* form found either within the focused frame, or
* across frames, will be the one returned.
* @param SimpleSelector $selector Image finder.
* @return SimpleForm Form object containing
* the image.
* @access public
*/
function getFormByImage($selector) {
return $this->findForm('getFormByImage', $selector);
}
/**
* Finds a held form by the form ID. A way of
* identifying a specific form when we have control
* of the HTML code. The first form found
* either within the focused frame, or across frames,
* will be the one returned.
* @param string $id Form label.
* @return SimpleForm Form object containing the matching ID.
* @access public
*/
function getFormById($id) {
return $this->findForm('getFormById', $id);
}
/**
* General form finder. Will search all the frames or
* just the one in focus.
* @param string $method Method to use to find in a page.
* @param string $attribute Label, name or ID.
* @return SimpleForm Form object containing the matching ID.
* @access private
*/
protected function findForm($method, $attribute) {
if (is_integer($this->focus)) {
return $this->findFormInFrame(
$this->frames[$this->focus],
$this->focus,
$method,
$attribute);
}
for ($i = 0; $i < count($this->frames); $i++) {
$form = $this->findFormInFrame(
$this->frames[$i],
$i,
$method,
$attribute);
if ($form) {
return $form;
}
}
$null = null;
return $null;
}
/**
* Finds a form in a page using a form finding method. Will
* also tag the form with the frame name it belongs in.
* @param SimplePage $page Page content of frame.
* @param integer $index Internal frame representation.
* @param string $method Method to use to find in a page.
* @param string $attribute Label, name or ID.
* @return SimpleForm Form object containing the matching ID.
* @access private
*/
protected function findFormInFrame($page, $index, $method, $attribute) {
$form = $this->frames[$index]->$method($attribute);
if (isset($form)) {
$form->setDefaultTarget($this->getPublicNameFromIndex($index));
}
return $form;
}
/**
* Sets a field on each form in which the field is
* available.
* @param SimpleSelector $selector Field finder.
* @param string $value Value to set field to.
* @return boolean True if value is valid.
* @access public
*/
function setField($selector, $value) {
if (is_integer($this->focus)) {
$this->frames[$this->focus]->setField($selector, $value);
} else {
for ($i = 0; $i < count($this->frames); $i++) {
$this->frames[$i]->setField($selector, $value);
}
}
}
/**
* Accessor for a form element value within a page.
* @param SimpleSelector $selector Field finder.
* @return string/boolean A string if the field is
* present, false if unchecked
* and null if missing.
* @access public
*/
function getField($selector) {
for ($i = 0; $i < count($this->frames); $i++) {
$value = $this->frames[$i]->getField($selector);
if (isset($value)) {
return $value;
}
}
return null;
}
}
?>

View File

@ -1,628 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage WebTester
* @version $Id: http.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/socket.php');
require_once(dirname(__FILE__) . '/cookies.php');
require_once(dirname(__FILE__) . '/url.php');
/**#@-*/
/**
* Creates HTTP headers for the end point of
* a HTTP request.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleRoute {
private $url;
/**
* Sets the target URL.
* @param SimpleUrl $url URL as object.
* @access public
*/
function __construct($url) {
$this->url = $url;
}
/**
* Resource name.
* @return SimpleUrl Current url.
* @access protected
*/
function getUrl() {
return $this->url;
}
/**
* Creates the first line which is the actual request.
* @param string $method HTTP request method, usually GET.
* @return string Request line content.
* @access protected
*/
protected function getRequestLine($method) {
return $method . ' ' . $this->url->getPath() .
$this->url->getEncodedRequest() . ' HTTP/1.0';
}
/**
* Creates the host part of the request.
* @return string Host line content.
* @access protected
*/
protected function getHostLine() {
$line = 'Host: ' . $this->url->getHost();
if ($this->url->getPort()) {
$line .= ':' . $this->url->getPort();
}
return $line;
}
/**
* Opens a socket to the route.
* @param string $method HTTP request method, usually GET.
* @param integer $timeout Connection timeout.
* @return SimpleSocket New socket.
* @access public
*/
function createConnection($method, $timeout) {
$default_port = ('https' == $this->url->getScheme()) ? 443 : 80;
$socket = $this->createSocket(
$this->url->getScheme() ? $this->url->getScheme() : 'http',
$this->url->getHost(),
$this->url->getPort() ? $this->url->getPort() : $default_port,
$timeout);
if (! $socket->isError()) {
$socket->write($this->getRequestLine($method) . "\r\n");
$socket->write($this->getHostLine() . "\r\n");
$socket->write("Connection: close\r\n");
}
return $socket;
}
/**
* Factory for socket.
* @param string $scheme Protocol to use.
* @param string $host Hostname to connect to.
* @param integer $port Remote port.
* @param integer $timeout Connection timeout.
* @return SimpleSocket/SimpleSecureSocket New socket.
* @access protected
*/
protected function createSocket($scheme, $host, $port, $timeout) {
if (in_array($scheme, array('file'))) {
return new SimpleFileSocket($this->url);
} elseif (in_array($scheme, array('https'))) {
return new SimpleSecureSocket($host, $port, $timeout);
} else {
return new SimpleSocket($host, $port, $timeout);
}
}
}
/**
* Creates HTTP headers for the end point of
* a HTTP request via a proxy server.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleProxyRoute extends SimpleRoute {
private $proxy;
private $username;
private $password;
/**
* Stashes the proxy address.
* @param SimpleUrl $url URL as object.
* @param string $proxy Proxy URL.
* @param string $username Username for autentication.
* @param string $password Password for autentication.
* @access public
*/
function __construct($url, $proxy, $username = false, $password = false) {
parent::__construct($url);
$this->proxy = $proxy;
$this->username = $username;
$this->password = $password;
}
/**
* Creates the first line which is the actual request.
* @param string $method HTTP request method, usually GET.
* @param SimpleUrl $url URL as object.
* @return string Request line content.
* @access protected
*/
function getRequestLine($method) {
$url = $this->getUrl();
$scheme = $url->getScheme() ? $url->getScheme() : 'http';
$port = $url->getPort() ? ':' . $url->getPort() : '';
return $method . ' ' . $scheme . '://' . $url->getHost() . $port .
$url->getPath() . $url->getEncodedRequest() . ' HTTP/1.0';
}
/**
* Creates the host part of the request.
* @param SimpleUrl $url URL as object.
* @return string Host line content.
* @access protected
*/
function getHostLine() {
$host = 'Host: ' . $this->proxy->getHost();
$port = $this->proxy->getPort() ? $this->proxy->getPort() : 8080;
return "$host:$port";
}
/**
* Opens a socket to the route.
* @param string $method HTTP request method, usually GET.
* @param integer $timeout Connection timeout.
* @return SimpleSocket New socket.
* @access public
*/
function createConnection($method, $timeout) {
$socket = $this->createSocket(
$this->proxy->getScheme() ? $this->proxy->getScheme() : 'http',
$this->proxy->getHost(),
$this->proxy->getPort() ? $this->proxy->getPort() : 8080,
$timeout);
if ($socket->isError()) {
return $socket;
}
$socket->write($this->getRequestLine($method) . "\r\n");
$socket->write($this->getHostLine() . "\r\n");
if ($this->username && $this->password) {
$socket->write('Proxy-Authorization: Basic ' .
base64_encode($this->username . ':' . $this->password) .
"\r\n");
}
$socket->write("Connection: close\r\n");
return $socket;
}
}
/**
* HTTP request for a web page. Factory for
* HttpResponse object.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleHttpRequest {
private $route;
private $encoding;
private $headers;
private $cookies;
/**
* Builds the socket request from the different pieces.
* These include proxy information, URL, cookies, headers,
* request method and choice of encoding.
* @param SimpleRoute $route Request route.
* @param SimpleFormEncoding $encoding Content to send with
* request.
* @access public
*/
function __construct($route, $encoding) {
$this->route = $route;
$this->encoding = $encoding;
$this->headers = array();
$this->cookies = array();
}
/**
* Dispatches the content to the route's socket.
* @param integer $timeout Connection timeout.
* @return SimpleHttpResponse A response which may only have
* an error, but hopefully has a
* complete web page.
* @access public
*/
function fetch($timeout) {
$socket = $this->route->createConnection($this->encoding->getMethod(), $timeout);
if (! $socket->isError()) {
$this->dispatchRequest($socket, $this->encoding);
}
return $this->createResponse($socket);
}
/**
* Sends the headers.
* @param SimpleSocket $socket Open socket.
* @param string $method HTTP request method,
* usually GET.
* @param SimpleFormEncoding $encoding Content to send with request.
* @access private
*/
protected function dispatchRequest($socket, $encoding) {
foreach ($this->headers as $header_line) {
$socket->write($header_line . "\r\n");
}
if (count($this->cookies) > 0) {
$socket->write("Cookie: " . implode(";", $this->cookies) . "\r\n");
}
$encoding->writeHeadersTo($socket);
$socket->write("\r\n");
$encoding->writeTo($socket);
}
/**
* Adds a header line to the request.
* @param string $header_line Text of full header line.
* @access public
*/
function addHeaderLine($header_line) {
$this->headers[] = $header_line;
}
/**
* Reads all the relevant cookies from the
* cookie jar.
* @param SimpleCookieJar $jar Jar to read
* @param SimpleUrl $url Url to use for scope.
* @access public
*/
function readCookiesFromJar($jar, $url) {
$this->cookies = $jar->selectAsPairs($url);
}
/**
* Wraps the socket in a response parser.
* @param SimpleSocket $socket Responding socket.
* @return SimpleHttpResponse Parsed response object.
* @access protected
*/
protected function createResponse($socket) {
$response = new SimpleHttpResponse(
$socket,
$this->route->getUrl(),
$this->encoding);
$socket->close();
return $response;
}
}
/**
* Collection of header lines in the response.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleHttpHeaders {
private $raw_headers;
private $response_code;
private $http_version;
private $mime_type;
private $location;
private $cookies;
private $authentication;
private $realm;
/**
* Parses the incoming header block.
* @param string $headers Header block.
* @access public
*/
function __construct($headers) {
$this->raw_headers = $headers;
$this->response_code = false;
$this->http_version = false;
$this->mime_type = '';
$this->location = false;
$this->cookies = array();
$this->authentication = false;
$this->realm = false;
foreach (explode("\r\n", $headers) as $header_line) {
$this->parseHeaderLine($header_line);
}
}
/**
* Accessor for parsed HTTP protocol version.
* @return integer HTTP error code.
* @access public
*/
function getHttpVersion() {
return $this->http_version;
}
/**
* Accessor for raw header block.
* @return string All headers as raw string.
* @access public
*/
function getRaw() {
return $this->raw_headers;
}
/**
* Accessor for parsed HTTP error code.
* @return integer HTTP error code.
* @access public
*/
function getResponseCode() {
return (integer)$this->response_code;
}
/**
* Returns the redirected URL or false if
* no redirection.
* @return string URL or false for none.
* @access public
*/
function getLocation() {
return $this->location;
}
/**
* Test to see if the response is a valid redirect.
* @return boolean True if valid redirect.
* @access public
*/
function isRedirect() {
return in_array($this->response_code, array(301, 302, 303, 307)) &&
(boolean)$this->getLocation();
}
/**
* Test to see if the response is an authentication
* challenge.
* @return boolean True if challenge.
* @access public
*/
function isChallenge() {
return ($this->response_code == 401) &&
(boolean)$this->authentication &&
(boolean)$this->realm;
}
/**
* Accessor for MIME type header information.
* @return string MIME type.
* @access public
*/
function getMimeType() {
return $this->mime_type;
}
/**
* Accessor for authentication type.
* @return string Type.
* @access public
*/
function getAuthentication() {
return $this->authentication;
}
/**
* Accessor for security realm.
* @return string Realm.
* @access public
*/
function getRealm() {
return $this->realm;
}
/**
* Writes new cookies to the cookie jar.
* @param SimpleCookieJar $jar Jar to write to.
* @param SimpleUrl $url Host and path to write under.
* @access public
*/
function writeCookiesToJar($jar, $url) {
foreach ($this->cookies as $cookie) {
$jar->setCookie(
$cookie->getName(),
$cookie->getValue(),
$url->getHost(),
$cookie->getPath(),
$cookie->getExpiry());
}
}
/**
* Called on each header line to accumulate the held
* data within the class.
* @param string $header_line One line of header.
* @access protected
*/
protected function parseHeaderLine($header_line) {
if (preg_match('/HTTP\/(\d+\.\d+)\s+(\d+)/i', $header_line, $matches)) {
$this->http_version = $matches[1];
$this->response_code = $matches[2];
}
if (preg_match('/Content-type:\s*(.*)/i', $header_line, $matches)) {
$this->mime_type = trim($matches[1]);
}
if (preg_match('/Location:\s*(.*)/i', $header_line, $matches)) {
$this->location = trim($matches[1]);
}
if (preg_match('/Set-cookie:(.*)/i', $header_line, $matches)) {
$this->cookies[] = $this->parseCookie($matches[1]);
}
if (preg_match('/WWW-Authenticate:\s+(\S+)\s+realm=\"(.*?)\"/i', $header_line, $matches)) {
$this->authentication = $matches[1];
$this->realm = trim($matches[2]);
}
}
/**
* Parse the Set-cookie content.
* @param string $cookie_line Text after "Set-cookie:"
* @return SimpleCookie New cookie object.
* @access private
*/
protected function parseCookie($cookie_line) {
$parts = explode(";", $cookie_line);
$cookie = array();
preg_match('/\s*(.*?)\s*=(.*)/', array_shift($parts), $cookie);
foreach ($parts as $part) {
if (preg_match('/\s*(.*?)\s*=(.*)/', $part, $matches)) {
$cookie[$matches[1]] = trim($matches[2]);
}
}
return new SimpleCookie(
$cookie[1],
trim($cookie[2]),
isset($cookie["path"]) ? $cookie["path"] : "",
isset($cookie["expires"]) ? $cookie["expires"] : false);
}
}
/**
* Basic HTTP response.
* @package SimpleTest
* @subpackage WebTester
*/
class SimpleHttpResponse extends SimpleStickyError {
private $url;
private $encoding;
private $sent;
private $content;
private $headers;
/**
* Constructor. Reads and parses the incoming
* content and headers.
* @param SimpleSocket $socket Network connection to fetch
* response text from.
* @param SimpleUrl $url Resource name.
* @param mixed $encoding Record of content sent.
* @access public
*/
function __construct($socket, $url, $encoding) {
parent::__construct();
$this->url = $url;
$this->encoding = $encoding;
$this->sent = $socket->getSent();
$this->content = false;
$raw = $this->readAll($socket);
if ($socket->isError()) {
$this->setError('Error reading socket [' . $socket->getError() . ']');
return;
}
$this->parse($raw);
}
/**
* Splits up the headers and the rest of the content.
* @param string $raw Content to parse.
* @access private
*/
protected function parse($raw) {
if (! $raw) {
$this->setError('Nothing fetched');
$this->headers = new SimpleHttpHeaders('');
} elseif ('file' == $this->url->getScheme()) {
$this->headers = new SimpleHttpHeaders('');
$this->content = $raw;
} elseif (! strstr($raw, "\r\n\r\n")) {
$this->setError('Could not split headers from content');
$this->headers = new SimpleHttpHeaders($raw);
} else {
list($headers, $this->content) = explode("\r\n\r\n", $raw, 2);
$this->headers = new SimpleHttpHeaders($headers);
}
}
/**
* Original request method.
* @return string GET, POST or HEAD.
* @access public
*/
function getMethod() {
return $this->encoding->getMethod();
}
/**
* Resource name.
* @return SimpleUrl Current url.
* @access public
*/
function getUrl() {
return $this->url;
}
/**
* Original request data.
* @return mixed Sent content.
* @access public
*/
function getRequestData() {
return $this->encoding;
}
/**
* Raw request that was sent down the wire.
* @return string Bytes actually sent.
* @access public
*/
function getSent() {
return $this->sent;
}
/**
* Accessor for the content after the last
* header line.
* @return string All content.
* @access public
*/
function getContent() {
return $this->content;
}
/**
* Accessor for header block. The response is the
* combination of this and the content.
* @return SimpleHeaders Wrapped header block.
* @access public
*/
function getHeaders() {
return $this->headers;
}
/**
* Accessor for any new cookies.
* @return array List of new cookies.
* @access public
*/
function getNewCookies() {
return $this->headers->getNewCookies();
}
/**
* Reads the whole of the socket output into a
* single string.
* @param SimpleSocket $socket Unread socket.
* @return string Raw output if successful
* else false.
* @access private
*/
protected function readAll($socket) {
$all = '';
while (! $this->isLastPacket($next = $socket->read())) {
$all .= $next;
}
return $all;
}
/**
* Test to see if the packet from the socket is the
* last one.
* @param string $packet Chunk to interpret.
* @return boolean True if empty or EOF.
* @access private
*/
protected function isLastPacket($packet) {
if (is_string($packet)) {
return $packet === '';
}
return ! $packet;
}
}
?>

View File

@ -1,139 +0,0 @@
<?php
/**
* Base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: invoker.php 1785 2008-04-26 13:56:41Z pp11 $
*/
/**#@+
* Includes SimpleTest files and defined the root constant
* for dependent libraries.
*/
require_once(dirname(__FILE__) . '/errors.php');
require_once(dirname(__FILE__) . '/compatibility.php');
require_once(dirname(__FILE__) . '/scorer.php');
require_once(dirname(__FILE__) . '/expectation.php');
require_once(dirname(__FILE__) . '/dumper.php');
if (! defined('SIMPLE_TEST')) {
define('SIMPLE_TEST', dirname(__FILE__) . '/');
}
/**#@-*/
/**
* This is called by the class runner to run a
* single test method. Will also run the setUp()
* and tearDown() methods.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleInvoker {
private $test_case;
/**
* Stashes the test case for later.
* @param SimpleTestCase $test_case Test case to run.
*/
function __construct($test_case) {
$this->test_case = $test_case;
}
/**
* Accessor for test case being run.
* @return SimpleTestCase Test case.
* @access public
*/
function getTestCase() {
return $this->test_case;
}
/**
* Runs test level set up. Used for changing
* the mechanics of base test cases.
* @param string $method Test method to call.
* @access public
*/
function before($method) {
$this->test_case->before($method);
}
/**
* Invokes a test method and buffered with setUp()
* and tearDown() calls.
* @param string $method Test method to call.
* @access public
*/
function invoke($method) {
$this->test_case->setUp();
$this->test_case->$method();
$this->test_case->tearDown();
}
/**
* Runs test level clean up. Used for changing
* the mechanics of base test cases.
* @param string $method Test method to call.
* @access public
*/
function after($method) {
$this->test_case->after($method);
}
}
/**
* Do nothing decorator. Just passes the invocation
* straight through.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleInvokerDecorator {
private $invoker;
/**
* Stores the invoker to wrap.
* @param SimpleInvoker $invoker Test method runner.
*/
function __construct($invoker) {
$this->invoker = $invoker;
}
/**
* Accessor for test case being run.
* @return SimpleTestCase Test case.
* @access public
*/
function getTestCase() {
return $this->invoker->getTestCase();
}
/**
* Runs test level set up. Used for changing
* the mechanics of base test cases.
* @param string $method Test method to call.
* @access public
*/
function before($method) {
$this->invoker->before($method);
}
/**
* Invokes a test method and buffered with setUp()
* and tearDown() calls.
* @param string $method Test method to call.
* @access public
*/
function invoke($method) {
$this->invoker->invoke($method);
}
/**
* Runs test level clean up. Used for changing
* the mechanics of base test cases.
* @param string $method Test method to call.
* @access public
*/
function after($method) {
$this->invoker->after($method);
}
}
?>

File diff suppressed because it is too large Load Diff

View File

@ -1,542 +0,0 @@
<?php
/**
* Base include file for SimpleTest
* @package SimpleTest
* @subpackage WebTester
* @version $Id: page.php 1938 2009-08-05 17:16:23Z dgheath $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/http.php');
require_once(dirname(__FILE__) . '/php_parser.php');
require_once(dirname(__FILE__) . '/tag.php');
require_once(dirname(__FILE__) . '/form.php');
require_once(dirname(__FILE__) . '/selector.php');
/**#@-*/
/**
* A wrapper for a web page.
* @package SimpleTest
* @subpackage WebTester
*/
class SimplePage {
private $links = array();
private $title = false;
private $last_widget;
private $label;
private $forms = array();
private $frames = array();
private $transport_error;
private $raw;
private $text = false;
private $sent;
private $headers;
private $method;
private $url;
private $base = false;
private $request_data;
/**
* Parses a page ready to access it's contents.
* @param SimpleHttpResponse $response Result of HTTP fetch.
* @access public
*/
function __construct($response = false) {
if ($response) {
$this->extractResponse($response);
} else {
$this->noResponse();
}
}
/**
* Extracts all of the response information.
* @param SimpleHttpResponse $response Response being parsed.
* @access private
*/
protected function extractResponse($response) {
$this->transport_error = $response->getError();
$this->raw = $response->getContent();
$this->sent = $response->getSent();
$this->headers = $response->getHeaders();
$this->method = $response->getMethod();
$this->url = $response->getUrl();
$this->request_data = $response->getRequestData();
}
/**
* Sets up a missing response.
* @access private
*/
protected function noResponse() {
$this->transport_error = 'No page fetched yet';
$this->raw = false;
$this->sent = false;
$this->headers = false;
$this->method = 'GET';
$this->url = false;
$this->request_data = false;
}
/**
* Original request as bytes sent down the wire.
* @return mixed Sent content.
* @access public
*/
function getRequest() {
return $this->sent;
}
/**
* Accessor for raw text of page.
* @return string Raw unparsed content.
* @access public
*/
function getRaw() {
return $this->raw;
}
/**
* Accessor for plain text of page as a text browser
* would see it.
* @return string Plain text of page.
* @access public
*/
function getText() {
if (! $this->text) {
$this->text = SimplePage::normalise($this->raw);
}
return $this->text;
}
/**
* Accessor for raw headers of page.
* @return string Header block as text.
* @access public
*/
function getHeaders() {
if ($this->headers) {
return $this->headers->getRaw();
}
return false;
}
/**
* Original request method.
* @return string GET, POST or HEAD.
* @access public
*/
function getMethod() {
return $this->method;
}
/**
* Original resource name.
* @return SimpleUrl Current url.
* @access public
*/
function getUrl() {
return $this->url;
}
/**
* Base URL if set via BASE tag page url otherwise
* @return SimpleUrl Base url.
* @access public
*/
function getBaseUrl() {
return $this->base;
}
/**
* Original request data.
* @return mixed Sent content.
* @access public
*/
function getRequestData() {
return $this->request_data;
}
/**
* Accessor for last error.
* @return string Error from last response.
* @access public
*/
function getTransportError() {
return $this->transport_error;
}
/**
* Accessor for current MIME type.
* @return string MIME type as string; e.g. 'text/html'
* @access public
*/
function getMimeType() {
if ($this->headers) {
return $this->headers->getMimeType();
}
return false;
}
/**
* Accessor for HTTP response code.
* @return integer HTTP response code received.
* @access public
*/
function getResponseCode() {
if ($this->headers) {
return $this->headers->getResponseCode();
}
return false;
}
/**
* Accessor for last Authentication type. Only valid
* straight after a challenge (401).
* @return string Description of challenge type.
* @access public
*/
function getAuthentication() {
if ($this->headers) {
return $this->headers->getAuthentication();
}
return false;
}
/**
* Accessor for last Authentication realm. Only valid
* straight after a challenge (401).
* @return string Name of security realm.
* @access public
*/
function getRealm() {
if ($this->headers) {
return $this->headers->getRealm();
}
return false;
}
/**
* Accessor for current frame focus. Will be
* false as no frames.
* @return array Always empty.
* @access public
*/
function getFrameFocus() {
return array();
}
/**
* Sets the focus by index. The integer index starts from 1.
* @param integer $choice Chosen frame.
* @return boolean Always false.
* @access public
*/
function setFrameFocusByIndex($choice) {
return false;
}
/**
* Sets the focus by name. Always fails for a leaf page.
* @param string $name Chosen frame.
* @return boolean False as no frames.
* @access public
*/
function setFrameFocus($name) {
return false;
}
/**
* Clears the frame focus. Does nothing for a leaf page.
* @access public
*/
function clearFrameFocus() {
}
/**
* TODO: write docs
*/
function setFrames($frames) {
$this->frames = $frames;
}
/**
* Test to see if link is an absolute one.
* @param string $url Url to test.
* @return boolean True if absolute.
* @access protected
*/
protected function linkIsAbsolute($url) {
$parsed = new SimpleUrl($url);
return (boolean)($parsed->getScheme() && $parsed->getHost());
}
/**
* Adds a link to the page.
* @param SimpleAnchorTag $tag Link to accept.
*/
function addLink($tag) {
$this->links[] = $tag;
}
/**
* Set the forms
* @param array $forms An array of SimpleForm objects
*/
function setForms($forms) {
$this->forms = $forms;
}
/**
* Test for the presence of a frameset.
* @return boolean True if frameset.
* @access public
*/
function hasFrames() {
return count($this->frames) > 0;
}
/**
* Accessor for frame name and source URL for every frame that
* will need to be loaded. Immediate children only.
* @return boolean/array False if no frameset or
* otherwise a hash of frame URLs.
* The key is either a numerical
* base one index or the name attribute.
* @access public
*/
function getFrameset() {
if (! $this->hasFrames()) {
return false;
}
$urls = array();
for ($i = 0; $i < count($this->frames); $i++) {
$name = $this->frames[$i]->getAttribute('name');
$url = new SimpleUrl($this->frames[$i]->getAttribute('src'));
$urls[$name ? $name : $i + 1] = $this->expandUrl($url);
}
return $urls;
}
/**
* Fetches a list of loaded frames.
* @return array/string Just the URL for a single page.
* @access public
*/
function getFrames() {
$url = $this->expandUrl($this->getUrl());
return $url->asString();
}
/**
* Accessor for a list of all links.
* @return array List of urls with scheme of
* http or https and hostname.
* @access public
*/
function getUrls() {
$all = array();
foreach ($this->links as $link) {
$url = $this->getUrlFromLink($link);
$all[] = $url->asString();
}
return $all;
}
/**
* Accessor for URLs by the link label. Label will match
* regardess of whitespace issues and case.
* @param string $label Text of link.
* @return array List of links with that label.
* @access public
*/
function getUrlsByLabel($label) {
$matches = array();
foreach ($this->links as $link) {
if ($link->getText() == $label) {
$matches[] = $this->getUrlFromLink($link);
}
}
return $matches;
}
/**
* Accessor for a URL by the id attribute.
* @param string $id Id attribute of link.
* @return SimpleUrl URL with that id of false if none.
* @access public
*/
function getUrlById($id) {
foreach ($this->links as $link) {
if ($link->getAttribute('id') === (string)$id) {
return $this->getUrlFromLink($link);
}
}
return false;
}
/**
* Converts a link tag into a target URL.
* @param SimpleAnchor $link Parsed link.
* @return SimpleUrl URL with frame target if any.
* @access private
*/
protected function getUrlFromLink($link) {
$url = $this->expandUrl($link->getHref());
if ($link->getAttribute('target')) {
$url->setTarget($link->getAttribute('target'));
}
return $url;
}
/**
* Expands expandomatic URLs into fully qualified
* URLs.
* @param SimpleUrl $url Relative URL.
* @return SimpleUrl Absolute URL.
* @access public
*/
function expandUrl($url) {
if (! is_object($url)) {
$url = new SimpleUrl($url);
}
$location = $this->getBaseUrl() ? $this->getBaseUrl() : new SimpleUrl();
return $url->makeAbsolute($location->makeAbsolute($this->getUrl()));
}
/**
* Sets the base url for the page.
* @param string $url Base URL for page.
*/
function setBase($url) {
$this->base = new SimpleUrl($url);
}
/**
* Sets the title tag contents.
* @param SimpleTitleTag $tag Title of page.
*/
function setTitle($tag) {
$this->title = $tag;
}
/**
* Accessor for parsed title.
* @return string Title or false if no title is present.
* @access public
*/
function getTitle() {
if ($this->title) {
return $this->title->getText();
}
return false;
}
/**
* Finds a held form by button label. Will only
* search correctly built forms.
* @param SimpleSelector $selector Button finder.
* @return SimpleForm Form object containing
* the button.
* @access public
*/
function getFormBySubmit($selector) {
for ($i = 0; $i < count($this->forms); $i++) {
if ($this->forms[$i]->hasSubmit($selector)) {
return $this->forms[$i];
}
}
return null;
}
/**
* Finds a held form by image using a selector.
* Will only search correctly built forms.
* @param SimpleSelector $selector Image finder.
* @return SimpleForm Form object containing
* the image.
* @access public
*/
function getFormByImage($selector) {
for ($i = 0; $i < count($this->forms); $i++) {
if ($this->forms[$i]->hasImage($selector)) {
return $this->forms[$i];
}
}
return null;
}
/**
* Finds a held form by the form ID. A way of
* identifying a specific form when we have control
* of the HTML code.
* @param string $id Form label.
* @return SimpleForm Form object containing the matching ID.
* @access public
*/
function getFormById($id) {
for ($i = 0; $i < count($this->forms); $i++) {
if ($this->forms[$i]->getId() == $id) {
return $this->forms[$i];
}
}
return null;
}
/**
* Sets a field on each form in which the field is
* available.
* @param SimpleSelector $selector Field finder.
* @param string $value Value to set field to.
* @return boolean True if value is valid.
* @access public
*/
function setField($selector, $value, $position=false) {
$is_set = false;
for ($i = 0; $i < count($this->forms); $i++) {
if ($this->forms[$i]->setField($selector, $value, $position)) {
$is_set = true;
}
}
return $is_set;
}
/**
* Accessor for a form element value within a page.
* @param SimpleSelector $selector Field finder.
* @return string/boolean A string if the field is
* present, false if unchecked
* and null if missing.
* @access public
*/
function getField($selector) {
for ($i = 0; $i < count($this->forms); $i++) {
$value = $this->forms[$i]->getValue($selector);
if (isset($value)) {
return $value;
}
}
return null;
}
/**
* Turns HTML into text browser visible text. Images
* are converted to their alt text and tags are supressed.
* Entities are converted to their visible representation.
* @param string $html HTML to convert.
* @return string Plain text.
* @access public
*/
static function normalise($html) {
$text = preg_replace('#<!--.*?-->#si', '', $html);
$text = preg_replace('#<(script|option|textarea)[^>]*>.*?</\1>#si', '', $text);
$text = preg_replace('#<img[^>]*alt\s*=\s*("([^"]*)"|\'([^\']*)\'|([a-zA-Z_]+))[^>]*>#', ' \2\3\4 ', $text);
$text = preg_replace('#<[^>]*>#', '', $text);
$text = html_entity_decode($text, ENT_QUOTES);
$text = preg_replace('#\s+#', ' ', $text);
return trim(trim($text), "\xA0"); // TODO: The \xAO is a &nbsp;. Add a test for this.
}
}
?>

File diff suppressed because it is too large Load Diff

View File

@ -1,101 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage Extensions
* @author Rene vd O (original code)
* @author Perrick Penet
* @author Marcus Baker
* @version $Id: recorder.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/scorer.php');
/**
* A single test result.
* @package SimpleTest
* @subpackage Extensions
*/
abstract class SimpleResult {
public $time;
public $breadcrumb;
public $message;
/**
* Records the test result as public members.
* @param array $breadcrumb Test stack at the time of the event.
* @param string $message The messsage to the human.
*/
function __construct($breadcrumb, $message) {
list($this->time, $this->breadcrumb, $this->message) =
array(time(), $breadcrumb, $message);
}
}
/**
* A single pass captured for later.
* @package SimpleTest
* @subpackage Extensions
*/
class SimpleResultOfPass extends SimpleResult { }
/**
* A single failure captured for later.
* @package SimpleTest
* @subpackage Extensions
*/
class SimpleResultOfFail extends SimpleResult { }
/**
* A single exception captured for later.
* @package SimpleTest
* @subpackage Extensions
*/
class SimpleResultOfException extends SimpleResult { }
/**
* Array-based test recorder. Returns an array
* with timestamp, status, test name and message for each pass and failure.
* @package SimpleTest
* @subpackage Extensions
*/
class Recorder extends SimpleReporterDecorator {
public $results = array();
/**
* Stashes the pass as a SimpleResultOfPass
* for later retrieval.
* @param string $message Pass message to be displayed
* eventually.
*/
function paintPass($message) {
parent::paintPass($message);
$this->results[] = new SimpleResultOfPass(parent::getTestList(), $message);
}
/**
* Stashes the fail as a SimpleResultOfFail
* for later retrieval.
* @param string $message Failure message to be displayed
* eventually.
*/
function paintFail($message) {
parent::paintFail($message);
$this->results[] = new SimpleResultOfFail(parent::getTestList(), $message);
}
/**
* Stashes the exception as a SimpleResultOfException
* for later retrieval.
* @param string $message Exception message to be displayed
* eventually.
*/
function paintException($message) {
parent::paintException($message);
$this->results[] = new SimpleResultOfException(parent::getTestList(), $message);
}
}
?>

View File

@ -1,136 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: reflection_php4.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**
* Version specific reflection API.
* @package SimpleTest
* @subpackage UnitTester
* @ignore duplicate with reflection_php5.php
*/
class SimpleReflection {
var $_interface;
/**
* Stashes the class/interface.
* @param string $interface Class or interface
* to inspect.
*/
function SimpleReflection($interface) {
$this->_interface = $interface;
}
/**
* Checks that a class has been declared.
* @return boolean True if defined.
* @access public
*/
function classExists() {
return class_exists($this->_interface);
}
/**
* Needed to kill the autoload feature in PHP5
* for classes created dynamically.
* @return boolean True if defined.
* @access public
*/
function classExistsSansAutoload() {
return class_exists($this->_interface);
}
/**
* Checks that a class or interface has been
* declared.
* @return boolean True if defined.
* @access public
*/
function classOrInterfaceExists() {
return class_exists($this->_interface);
}
/**
* Needed to kill the autoload feature in PHP5
* for classes created dynamically.
* @return boolean True if defined.
* @access public
*/
function classOrInterfaceExistsSansAutoload() {
return class_exists($this->_interface);
}
/**
* Gets the list of methods on a class or
* interface.
* @returns array List of method names.
* @access public
*/
function getMethods() {
return get_class_methods($this->_interface);
}
/**
* Gets the list of interfaces from a class. If the
* class name is actually an interface then just that
* interface is returned.
* @returns array List of interfaces.
* @access public
*/
function getInterfaces() {
return array();
}
/**
* Finds the parent class name.
* @returns string Parent class name.
* @access public
*/
function getParent() {
return strtolower(get_parent_class($this->_interface));
}
/**
* Determines if the class is abstract, which for PHP 4
* will never be the case.
* @returns boolean True if abstract.
* @access public
*/
function isAbstract() {
return false;
}
/**
* Determines if the the entity is an interface, which for PHP 4
* will never be the case.
* @returns boolean True if interface.
* @access public
*/
function isInterface() {
return false;
}
/**
* Scans for final methods, but as it's PHP 4 there
* aren't any.
* @returns boolean True if the class has a final method.
* @access public
*/
function hasFinal() {
return false;
}
/**
* Gets the source code matching the declaration
* of a method.
* @param string $method Method name.
* @access public
*/
function getSignature($method) {
return "function &$method()";
}
}
?>

View File

@ -1,386 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: reflection_php5.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**
* Version specific reflection API.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleReflection {
private $interface;
/**
* Stashes the class/interface.
* @param string $interface Class or interface
* to inspect.
*/
function __construct($interface) {
$this->interface = $interface;
}
/**
* Checks that a class has been declared. Versions
* before PHP5.0.2 need a check that it's not really
* an interface.
* @return boolean True if defined.
* @access public
*/
function classExists() {
if (! class_exists($this->interface)) {
return false;
}
$reflection = new ReflectionClass($this->interface);
return ! $reflection->isInterface();
}
/**
* Needed to kill the autoload feature in PHP5
* for classes created dynamically.
* @return boolean True if defined.
* @access public
*/
function classExistsSansAutoload() {
return class_exists($this->interface, false);
}
/**
* Checks that a class or interface has been
* declared.
* @return boolean True if defined.
* @access public
*/
function classOrInterfaceExists() {
return $this->classOrInterfaceExistsWithAutoload($this->interface, true);
}
/**
* Needed to kill the autoload feature in PHP5
* for classes created dynamically.
* @return boolean True if defined.
* @access public
*/
function classOrInterfaceExistsSansAutoload() {
return $this->classOrInterfaceExistsWithAutoload($this->interface, false);
}
/**
* Needed to select the autoload feature in PHP5
* for classes created dynamically.
* @param string $interface Class or interface name.
* @param boolean $autoload True totriggerautoload.
* @return boolean True if interface defined.
* @access private
*/
protected function classOrInterfaceExistsWithAutoload($interface, $autoload) {
if (function_exists('interface_exists')) {
if (interface_exists($this->interface, $autoload)) {
return true;
}
}
return class_exists($this->interface, $autoload);
}
/**
* Gets the list of methods on a class or
* interface.
* @returns array List of method names.
* @access public
*/
function getMethods() {
return array_unique(get_class_methods($this->interface));
}
/**
* Gets the list of interfaces from a class. If the
* class name is actually an interface then just that
* interface is returned.
* @returns array List of interfaces.
* @access public
*/
function getInterfaces() {
$reflection = new ReflectionClass($this->interface);
if ($reflection->isInterface()) {
return array($this->interface);
}
return $this->onlyParents($reflection->getInterfaces());
}
/**
* Gets the list of methods for the implemented
* interfaces only.
* @returns array List of enforced method signatures.
* @access public
*/
function getInterfaceMethods() {
$methods = array();
foreach ($this->getInterfaces() as $interface) {
$methods = array_merge($methods, get_class_methods($interface));
}
return array_unique($methods);
}
/**
* Checks to see if the method signature has to be tightly
* specified.
* @param string $method Method name.
* @returns boolean True if enforced.
* @access private
*/
protected function isInterfaceMethod($method) {
return in_array($method, $this->getInterfaceMethods());
}
/**
* Finds the parent class name.
* @returns string Parent class name.
* @access public
*/
function getParent() {
$reflection = new ReflectionClass($this->interface);
$parent = $reflection->getParentClass();
if ($parent) {
return $parent->getName();
}
return false;
}
/**
* Trivially determines if the class is abstract.
* @returns boolean True if abstract.
* @access public
*/
function isAbstract() {
$reflection = new ReflectionClass($this->interface);
return $reflection->isAbstract();
}
/**
* Trivially determines if the class is an interface.
* @returns boolean True if interface.
* @access public
*/
function isInterface() {
$reflection = new ReflectionClass($this->interface);
return $reflection->isInterface();
}
/**
* Scans for final methods, as they screw up inherited
* mocks by not allowing you to override them.
* @returns boolean True if the class has a final method.
* @access public
*/
function hasFinal() {
$reflection = new ReflectionClass($this->interface);
foreach ($reflection->getMethods() as $method) {
if ($method->isFinal()) {
return true;
}
}
return false;
}
/**
* Whittles a list of interfaces down to only the
* necessary top level parents.
* @param array $interfaces Reflection API interfaces
* to reduce.
* @returns array List of parent interface names.
* @access private
*/
protected function onlyParents($interfaces) {
$parents = array();
$blacklist = array();
foreach ($interfaces as $interface) {
foreach($interfaces as $possible_parent) {
if ($interface->getName() == $possible_parent->getName()) {
continue;
}
if ($interface->isSubClassOf($possible_parent)) {
$blacklist[$possible_parent->getName()] = true;
}
}
if (!isset($blacklist[$interface->getName()])) {
$parents[] = $interface->getName();
}
}
return $parents;
}
/**
* Checks whether a method is abstract or not.
* @param string $name Method name.
* @return bool true if method is abstract, else false
* @access private
*/
protected function isAbstractMethod($name) {
$interface = new ReflectionClass($this->interface);
if (! $interface->hasMethod($name)) {
return false;
}
return $interface->getMethod($name)->isAbstract();
}
/**
* Checks whether a method is the constructor.
* @param string $name Method name.
* @return bool true if method is the constructor
* @access private
*/
protected function isConstructor($name) {
return ($name == '__construct') || ($name == $this->interface);
}
/**
* Checks whether a method is abstract in all parents or not.
* @param string $name Method name.
* @return bool true if method is abstract in parent, else false
* @access private
*/
protected function isAbstractMethodInParents($name) {
$interface = new ReflectionClass($this->interface);
$parent = $interface->getParentClass();
while($parent) {
if (! $parent->hasMethod($name)) {
return false;
}
if ($parent->getMethod($name)->isAbstract()) {
return true;
}
$parent = $parent->getParentClass();
}
return false;
}
/**
* Checks whether a method is static or not.
* @param string $name Method name
* @return bool true if method is static, else false
* @access private
*/
protected function isStaticMethod($name) {
$interface = new ReflectionClass($this->interface);
if (! $interface->hasMethod($name)) {
return false;
}
return $interface->getMethod($name)->isStatic();
}
/**
* Writes the source code matching the declaration
* of a method.
* @param string $name Method name.
* @return string Method signature up to last
* bracket.
* @access public
*/
function getSignature($name) {
if ($name == '__set') {
return 'function __set($key, $value)';
}
if ($name == '__call') {
return 'function __call($method, $arguments)';
}
if (version_compare(phpversion(), '5.1.0', '>=')) {
if (in_array($name, array('__get', '__isset', $name == '__unset'))) {
return "function {$name}(\$key)";
}
}
if ($name == '__toString') {
return "function $name()";
}
// This wonky try-catch is a work around for a faulty method_exists()
// in early versions of PHP 5 which would return false for static
// methods. The Reflection classes work fine, but hasMethod()
// doesn't exist prior to PHP 5.1.0, so we need to use a more crude
// detection method.
try {
$interface = new ReflectionClass($this->interface);
$interface->getMethod($name);
} catch (ReflectionException $e) {
return "function $name()";
}
return $this->getFullSignature($name);
}
/**
* For a signature specified in an interface, full
* details must be replicated to be a valid implementation.
* @param string $name Method name.
* @return string Method signature up to last
* bracket.
* @access private
*/
protected function getFullSignature($name) {
$interface = new ReflectionClass($this->interface);
$method = $interface->getMethod($name);
$reference = $method->returnsReference() ? '&' : '';
$static = $method->isStatic() ? 'static ' : '';
return "{$static}function $reference$name(" .
implode(', ', $this->getParameterSignatures($method)) .
")";
}
/**
* Gets the source code for each parameter.
* @param ReflectionMethod $method Method object from
* reflection API
* @return array List of strings, each
* a snippet of code.
* @access private
*/
protected function getParameterSignatures($method) {
$signatures = array();
foreach ($method->getParameters() as $parameter) {
$signature = '';
$type = $parameter->getClass();
if (is_null($type) && version_compare(phpversion(), '5.1.0', '>=') && $parameter->isArray()) {
$signature .= 'array ';
} elseif (!is_null($type)) {
$signature .= $type->getName() . ' ';
}
if ($parameter->isPassedByReference()) {
$signature .= '&';
}
$signature .= '$' . $this->suppressSpurious($parameter->getName());
if ($this->isOptional($parameter)) {
$signature .= ' = null';
}
$signatures[] = $signature;
}
return $signatures;
}
/**
* The SPL library has problems with the
* Reflection library. In particular, you can
* get extra characters in parameter names :(.
* @param string $name Parameter name.
* @return string Cleaner name.
* @access private
*/
protected function suppressSpurious($name) {
return str_replace(array('[', ']', ' '), '', $name);
}
/**
* Test of a reflection parameter being optional
* that works with early versions of PHP5.
* @param reflectionParameter $parameter Is this optional.
* @return boolean True if optional.
* @access private
*/
protected function isOptional($parameter) {
if (method_exists($parameter, 'isOptional')) {
return $parameter->isOptional();
}
return false;
}
}
?>

View File

@ -1,115 +0,0 @@
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id: remote.php 2011 2011-04-29 08:22:48Z pp11 $
*/
/**#@+
* include other SimpleTest class files
*/
require_once(dirname(__FILE__) . '/browser.php');
require_once(dirname(__FILE__) . '/xml.php');
require_once(dirname(__FILE__) . '/test_case.php');
/**#@-*/
/**
* Runs an XML formated test on a remote server.
* @package SimpleTest
* @subpackage UnitTester
*/
class RemoteTestCase {
private $url;
private $dry_url;
private $size;
/**
* Sets the location of the remote test.
* @param string $url Test location.
* @param string $dry_url Location for dry run.
* @access public
*/
function __construct($url, $dry_url = false) {
$this->url = $url;
$this->dry_url = $dry_url ? $dry_url : $url;
$this->size = false;
}
/**
* Accessor for the test name for subclasses.
* @return string Name of the test.
* @access public
*/
function getLabel() {
return $this->url;
}
/**
* Runs the top level test for this class. Currently
* reads the data as a single chunk. I'll fix this
* once I have added iteration to the browser.
* @param SimpleReporter $reporter Target of test results.
* @returns boolean True if no failures.
* @access public
*/
function run($reporter) {
$browser = $this->createBrowser();
$xml = $browser->get($this->url);
if (! $xml) {
trigger_error('Cannot read remote test URL [' . $this->url . ']');
return false;
}
$parser = $this->createParser($reporter);
if (! $parser->parse($xml)) {
trigger_error('Cannot parse incoming XML from [' . $this->url . ']');
return false;
}
return true;
}
/**
* Creates a new web browser object for fetching
* the XML report.
* @return SimpleBrowser New browser.
* @access protected
*/
protected function createBrowser() {
return new SimpleBrowser();
}
/**
* Creates the XML parser.
* @param SimpleReporter $reporter Target of test results.
* @return SimpleTestXmlListener XML reader.
* @access protected
*/
protected function createParser($reporter) {
return new SimpleTestXmlParser($reporter);
}
/**
* Accessor for the number of subtests.
* @return integer Number of test cases.
* @access public
*/
function getSize() {
if ($this->size === false) {
$browser = $this->createBrowser();
$xml = $browser->get($this->dry_url);
if (! $xml) {
trigger_error('Cannot read remote test URL [' . $this->dry_url . ']');
return false;
}
$reporter = new SimpleReporter();
$parser = $this->createParser($reporter);
if (! $parser->parse($xml)) {
trigger_error('Cannot parse incoming XML from [' . $this->dry_url . ']');
return false;
}
$this->size = $reporter->getTestCaseCount();
}
return $this->size;
}
}
?>

Some files were not shown because too many files have changed in this diff Show More