diff options
195 files changed, 29551 insertions, 34657 deletions
diff --git a/.gitattributes b/.gitattributes index a309ea01..2f5fbd05 100644 --- a/.gitattributes +++ b/.gitattributes @@ -807,6 +807,7 @@ demos/quickstart/protected/pages/Configurations/Templates3.page -text demos/quickstart/protected/pages/Construction.page -text demos/quickstart/protected/pages/Controls/Button.page -text demos/quickstart/protected/pages/Controls/CheckBox.page -text +demos/quickstart/protected/pages/Controls/ClientScript.page -text demos/quickstart/protected/pages/Controls/ColorPicker.page -text demos/quickstart/protected/pages/Controls/Data.page -text demos/quickstart/protected/pages/Controls/DataGrid.page -text @@ -1705,9 +1706,6 @@ requirements/messages.txt -text requirements/template-bg.html -text requirements/template-zh.html -text requirements/template.html -text -tests/FunctionalTests/PradoTester.php -text -tests/FunctionalTests/README.txt -text -tests/FunctionalTests/config.php -text tests/FunctionalTests/features.php -text tests/FunctionalTests/features/index.php -text tests/FunctionalTests/features/protected/application.xml -text @@ -1727,11 +1725,8 @@ tests/FunctionalTests/features/protected/pages/ActiveControls/VisibleUpdate.page tests/FunctionalTests/features/protected/pages/ActiveControls/VisibleUpdate.php -text tests/FunctionalTests/features/protected/pages/ActiveControls/config.xml -text tests/FunctionalTests/features/protected/pages/ColorPicker.page -text -tests/FunctionalTests/features/protected/pages/CompositeControl.page -text -tests/FunctionalTests/features/protected/pages/DatePicker.page -text tests/FunctionalTests/features/protected/pages/FeatureList.page -text tests/FunctionalTests/features/protected/pages/FeatureList.php -text -tests/FunctionalTests/features/protected/pages/HtmlArea.page -text tests/FunctionalTests/features/protected/pages/I18N/BasicI18N.page -text tests/FunctionalTests/features/protected/pages/I18N/BasicI18N.php -text tests/FunctionalTests/features/protected/pages/I18N/Home.page -text @@ -1739,9 +1734,7 @@ tests/FunctionalTests/features/protected/pages/I18N/Home.zh_CN.page -text tests/FunctionalTests/features/protected/pages/I18N/config.xml -text tests/FunctionalTests/features/protected/pages/RatingList.page -text tests/FunctionalTests/features/protected/pages/ValidatorEffects.page -text -tests/FunctionalTests/features/tests/CompositeControlTestCase.php -text tests/FunctionalTests/index.php -text -tests/FunctionalTests/quickstart.php -text tests/FunctionalTests/quickstart/Advanced/I18N.php -text tests/FunctionalTests/quickstart/Controls/BulletedListTestCase.php -text tests/FunctionalTests/quickstart/Controls/ButtonTestCase.php -text @@ -1781,39 +1774,6 @@ tests/FunctionalTests/quickstart/Controls/Wizard3TestCase.php -text tests/FunctionalTests/quickstart/Controls/Wizard4TestCase.php -text tests/FunctionalTests/quickstart/Controls/Wizard5TestCase.php -text tests/FunctionalTests/quickstart/Fundamentals/HangmanTestCase.php -text -tests/FunctionalTests/selenium/core/SeleneseRunner.html -text -tests/FunctionalTests/selenium/core/SeleniumLog.html -text -tests/FunctionalTests/selenium/core/TestPrompt.html -text -tests/FunctionalTests/selenium/core/TestRunner-splash.html -text -tests/FunctionalTests/selenium/core/TestRunner.html -text -tests/FunctionalTests/selenium/core/domviewer/butmin.gif -text -tests/FunctionalTests/selenium/core/domviewer/butplus.gif -text -tests/FunctionalTests/selenium/core/domviewer/domviewer.css -text -tests/FunctionalTests/selenium/core/domviewer/domviewer.html -text -tests/FunctionalTests/selenium/core/domviewer/selenium-domviewer.js -text -tests/FunctionalTests/selenium/core/scripts/find_matching_child.js -text -tests/FunctionalTests/selenium/core/scripts/htmlutils.js -text -tests/FunctionalTests/selenium/core/scripts/prototype-1.4.0.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-api.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-browserbot.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-browserdetect.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-commandhandlers.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-executionloop.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-logging.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-seleneserunner.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-testrunner.js -text -tests/FunctionalTests/selenium/core/scripts/selenium-version.js -text -tests/FunctionalTests/selenium/core/scripts/user-extensions.js.sample -text -tests/FunctionalTests/selenium/core/scripts/xmlextras.js -text -tests/FunctionalTests/selenium/core/selenium-logo.png -text -tests/FunctionalTests/selenium/core/selenium.css -text -tests/FunctionalTests/selenium/core/xpath/dom.js -text -tests/FunctionalTests/selenium/core/xpath/misc.js -text -tests/FunctionalTests/selenium/core/xpath/xpath.js -text -tests/FunctionalTests/selenium/php/TestRunner.php -text -tests/FunctionalTests/selenium/php/results.php -text -tests/FunctionalTests/selenium/php/selenium.php -text -tests/FunctionalTests/selenium/prado-functional-test.js -text tests/FunctionalTests/tickets.php -text tests/FunctionalTests/tickets/index.php -text tests/FunctionalTests/tickets/protected/pages/Layout.php -text @@ -1895,135 +1855,6 @@ tests/FunctionalTests/validators/tests/RegExpValidatorTestCase.php -text tests/FunctionalTests/validators/tests/RequiredFieldTestCase.php -text tests/FunctionalTests/validators/tests/RequiredListTestCase.php -text tests/FunctionalTests/validators/tests/ValidationSummaryTestCase.php -text -tests/UnitTests/TODO.txt -text -tests/UnitTests/framework/Collections/utList.php -text -tests/UnitTests/framework/Collections/utMap.php -text -tests/UnitTests/framework/Data/CacheTestCase.php -text -tests/UnitTests/framework/Data/test.db -text -tests/UnitTests/framework/Data/utAPCCache.php -text -tests/UnitTests/framework/Data/utDateTimeSimpleFormatter.php -text -tests/UnitTests/framework/Data/utMemCache.php -text -tests/UnitTests/framework/Data/utSqliteCache.php -text -tests/UnitTests/framework/Data/utXmlDocument.php -text -tests/UnitTests/framework/Data/xml/data1.xml -text -tests/UnitTests/framework/Data/xml/data1.xml.out -text -tests/UnitTests/framework/Data/xml/data2.xml -text -tests/UnitTests/framework/Data/xml/data2.xml.out -text -tests/UnitTests/framework/Data/xml/data3.xml -text -tests/UnitTests/framework/Data/xml/data3.xml.out -text -tests/UnitTests/framework/I18N/TestOfDateTimeFormatInfo.php -text -tests/UnitTests/framework/I18N/messages/en/tests.mo -text -tests/UnitTests/framework/I18N/messages/en/tests.po -text -tests/UnitTests/framework/I18N/messages/en/tests.xml -text -tests/UnitTests/framework/I18N/messages/en_AU/tests.mo -text -tests/UnitTests/framework/I18N/messages/en_AU/tests.mo.bak -text -tests/UnitTests/framework/I18N/messages/en_AU/tests.po -text -tests/UnitTests/framework/I18N/messages/en_AU/tests.po.bak -text -tests/UnitTests/framework/I18N/messages/en_AU/tests.xml -text -tests/UnitTests/framework/I18N/messages/en_AU/tests.xml.bak -text -tests/UnitTests/framework/I18N/messages/messages.db -text -tests/UnitTests/framework/I18N/messages/messages.db.bak -text -tests/UnitTests/framework/I18N/messages/messages.en.mo -text -tests/UnitTests/framework/I18N/messages/messages.en.po -text -tests/UnitTests/framework/I18N/messages/messages.en.xml -text -tests/UnitTests/framework/I18N/messages/messages.en_AU.mo -text -tests/UnitTests/framework/I18N/messages/messages.en_AU.mo.bak -text -tests/UnitTests/framework/I18N/messages/messages.en_AU.po -text -tests/UnitTests/framework/I18N/messages/messages.en_AU.po.bak -text -tests/UnitTests/framework/I18N/messages/messages.en_AU.xml -text -tests/UnitTests/framework/I18N/messages/messages.en_AU.xml.bak -text -tests/UnitTests/framework/I18N/messages/messages.mo -text -tests/UnitTests/framework/I18N/messages/messages.po -text -tests/UnitTests/framework/I18N/messages/messages.xml -text -tests/UnitTests/framework/I18N/messages/messages_mysql.sql -text -tests/UnitTests/framework/I18N/messages/tests.en_AU.po -text -tests/UnitTests/framework/I18N/messages/tests.mo -text -tests/UnitTests/framework/I18N/messages/tests.po -text -tests/UnitTests/framework/I18N/messages/tests.xml -text -tests/UnitTests/framework/I18N/testChoiceFormat.php -text -tests/UnitTests/framework/I18N/testCultureInfo.php -text -tests/UnitTests/framework/I18N/testDateFormat.php -text -tests/UnitTests/framework/I18N/testMessageFormat.php -text -tests/UnitTests/framework/I18N/testMessageFormat_SQLite.php -text -tests/UnitTests/framework/I18N/testMessageFormat_XLIFF.php -text -tests/UnitTests/framework/I18N/testMessageFormat_gettext.php -text -tests/UnitTests/framework/I18N/testNumberFormat.php -text -tests/UnitTests/framework/I18N/testNumberFormatInfo.php -text -tests/UnitTests/framework/I18N/tmp/cache.txt -text -tests/UnitTests/framework/TestSystem/protected/application.xml -text -tests/UnitTests/framework/TestSystem/protected/data/test.db -text -tests/UnitTests/framework/TestSystem/protected/pages/config.xml -text -tests/UnitTests/framework/Web/UI/utControl.php -text -tests/UnitTests/framework/Web/UI/utJavascriptSerializer.php -text -tests/UnitTests/framework/Web/utHttpRequest.php -text -tests/UnitTests/framework/common.php -text -tests/UnitTests/framework/index.php -text -tests/UnitTests/framework/utApplication.php -text -tests/UnitTests/framework/utComponent.php -text -tests/UnitTests/framework/utPradoBase.php -text -tests/UnitTests/simpletest/CHANGELOG -text -tests/UnitTests/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE -text -tests/UnitTests/simpletest/HtmlReporterWithCoverage.php -text -tests/UnitTests/simpletest/LICENSE -text -tests/UnitTests/simpletest/README -text -tests/UnitTests/simpletest/VERSION -text -tests/UnitTests/simpletest/authentication.php -text -tests/UnitTests/simpletest/browser.php -text -tests/UnitTests/simpletest/docs/en/authentication_documentation.html -text -tests/UnitTests/simpletest/docs/en/browser_documentation.html -text -tests/UnitTests/simpletest/docs/en/docs.css -text -tests/UnitTests/simpletest/docs/en/expectation_documentation.html -text -tests/UnitTests/simpletest/docs/en/form_testing_documentation.html -text -tests/UnitTests/simpletest/docs/en/group_test_documentation.html -text -tests/UnitTests/simpletest/docs/en/index.html -text -tests/UnitTests/simpletest/docs/en/mock_objects_documentation.html -text -tests/UnitTests/simpletest/docs/en/overview.html -text -tests/UnitTests/simpletest/docs/en/partial_mocks_documentation.html -text -tests/UnitTests/simpletest/docs/en/reporter_documentation.html -text -tests/UnitTests/simpletest/docs/en/server_stubs_documentation.html -text -tests/UnitTests/simpletest/docs/en/unit_test_documentation.html -text -tests/UnitTests/simpletest/docs/en/web_tester_documentation.html -text -tests/UnitTests/simpletest/docs/fr/authentication_documentation.html -text -tests/UnitTests/simpletest/docs/fr/browser_documentation.html -text -tests/UnitTests/simpletest/docs/fr/docs.css -text -tests/UnitTests/simpletest/docs/fr/expectation_documentation.html -text -tests/UnitTests/simpletest/docs/fr/form_testing_documentation.html -text -tests/UnitTests/simpletest/docs/fr/group_test_documentation.html -text -tests/UnitTests/simpletest/docs/fr/index.html -text -tests/UnitTests/simpletest/docs/fr/mock_objects_documentation.html -text -tests/UnitTests/simpletest/docs/fr/overview.html -text -tests/UnitTests/simpletest/docs/fr/partial_mocks_documentation.html -text -tests/UnitTests/simpletest/docs/fr/reporter_documentation.html -text -tests/UnitTests/simpletest/docs/fr/server_stubs_documentation.html -text -tests/UnitTests/simpletest/docs/fr/unit_test_documentation.html -text -tests/UnitTests/simpletest/docs/fr/web_tester_documentation.html -text -tests/UnitTests/simpletest/dumper.php -text -tests/UnitTests/simpletest/encoding.php -text -tests/UnitTests/simpletest/errors.php -text -tests/UnitTests/simpletest/expectation.php -text -tests/UnitTests/simpletest/extensions/pear_test_case.php -text -tests/UnitTests/simpletest/extensions/phpunit_test_case.php -text -tests/UnitTests/simpletest/form.php -text -tests/UnitTests/simpletest/frames.php -text -tests/UnitTests/simpletest/http.php -text -tests/UnitTests/simpletest/mock_objects.php -text -tests/UnitTests/simpletest/mytests/log_test.php -text -tests/UnitTests/simpletest/options.php -text -tests/UnitTests/simpletest/page.php -text -tests/UnitTests/simpletest/parser.php -text -tests/UnitTests/simpletest/remote.php -text -tests/UnitTests/simpletest/reporter.php -text -tests/UnitTests/simpletest/runner.php -text -tests/UnitTests/simpletest/scorer.php -text -tests/UnitTests/simpletest/shell_tester.php -text -tests/UnitTests/simpletest/simple_test.php -text -tests/UnitTests/simpletest/socket.php -text -tests/UnitTests/simpletest/tag.php -text -tests/UnitTests/simpletest/unit_tester.php -text -tests/UnitTests/simpletest/url.php -text -tests/UnitTests/simpletest/user_agent.php -text -tests/UnitTests/simpletest/web_tester.php -text -tests/UnitTests/simpletest/xml.php -text tests/unit/Collections/TListTest.php -text tests/unit/Collections/TMapTest.php -text tests/unit/I18N/core/CultureInfoTest.php -text @@ -15,6 +15,9 @@ Version 3.0.3 August 6, 2006 BUG: Ticket#264 - Typos in some exception throw statements (Knut)
BUG: Ticket#268 - THttpResponse.redirect() may fail for some browsers (Qiang)
BUG: TDataGrid may complain getting ItemType on a non-object if the grid is not data-bound (Qiang)
+ENH: Ticket#220 - TClientScripts method to import custom javascript files (Wei)
+ENH: Ticket#225 - TRadioButton::getRadioButtonsInGroup() added (Wei)
+ENH: Ticket#223 - Use TRequiredFieldValidator for TRadioButtons with GroupName property (Wei)
NEW: Added TStyleSheet (Wei)
Version 3.0.2 July 2, 2006
diff --git a/buildscripts/texbuilder/pages.php b/buildscripts/texbuilder/pages.php index f49d15fd..9b8a97ad 100644 --- a/buildscripts/texbuilder/pages.php +++ b/buildscripts/texbuilder/pages.php @@ -33,6 +33,7 @@ $pages['Configurations'] = array( $pages['Control Reference : Standard Controls'] = array(
'Controls/Button.page',
'Controls/CheckBox.page',
+ 'Controls/ClientScript.page',
'Controls/ColorPicker.page',
'Controls/DatePicker.page',
'Controls/Expression.page',
diff --git a/demos/quickstart/protected/pages/Advanced/Scripts3.page b/demos/quickstart/protected/pages/Advanced/Scripts3.page index 9883f43e..123caa3a 100644 --- a/demos/quickstart/protected/pages/Advanced/Scripts3.page +++ b/demos/quickstart/protected/pages/Advanced/Scripts3.page @@ -29,4 +29,7 @@ that require a particular library will also automatically load the necessary lib For example, if you add a TDatePicker component on the page, the <tt>datapicker</tt>
and its dependencies will be automatically included on the page.</p>
+<p>See <a href="?page=Controls.ClientScript">TClientScript</a> for options of adding
+ your custom javascript code to the page.</p>
+
</com:TContent>
\ No newline at end of file diff --git a/demos/quickstart/protected/pages/Controls/ClientScript.page b/demos/quickstart/protected/pages/Controls/ClientScript.page new file mode 100644 index 00000000..5dab41d5 --- /dev/null +++ b/demos/quickstart/protected/pages/Controls/ClientScript.page @@ -0,0 +1,52 @@ +<com:TContent ID="body" > + +<h1>TClientScript</h1> +<com:DocLink ClassPath="System.Web.UI.WebControls.TClientScript" /> +<h2>Including Bundled Javascript Libraries in Prado</h2> +<p> +<tt>TClientScript</tt> allows javascript code to be insert or linked to the +page template. Prado is bundled with a large library of javascript functionality +including effects, AJAX, basic event handlers, and many others. The bundled +javascript libraries can be linked to the current page template using the +<tt>UsingPradoScripts</tt> property. Multiple bundled javascript libraries +can be specified using comma delimited string of the name of javascript library +to include on the page. For following example will include the "ajax" and "effects" library. +</p> +<com:TTextHighlighter Language="prado" CssClass="source"> +<com:TClientScript UsingPradoScripts="ajax, effects" /> +</com:TTextHighlighter> + +<p> + The available bundled libraries included in Prado are + <ul> + <li><tt>prado</tt> : basic prado javascript framework based on Prototype</li> + <li><tt>effects</tt> : visual effects from script.aculo.us</li> + <li><tt>ajax</tt> : ajax and callback related based on Prototype</li> + <li><tt>validator</tt> : validation</li> + <li><tt>logger</tt> : javascript logger and object browser</li> + <li><tt>datepicker</tt> : datepicker</li> + <li><tt>rico</tt> : Rico library</li> + <li><tt>colorpicker</tt> : colorpicker</li> + </ul> +</p> +<p>The dependencies for each library are automatically resolved. That is, + specifying, say the "ajax", will also include the "prado" library.</p> + +<h2>Including Custom Javascript Files</h2> +<p>Custom javascript files can be register using the <tt>ScriptUrl</tt> property. +The following example includes the javascript file "test.js" to the page. In this case, the file +"test.js" is relative the current template you are using. Since the property value is +<a href="?page=Configurations.Templates3">dynamic asset tag</a>, the file "test.js" will be published +automatically, that is, the file will be copied to the assets directory if necessary. +</p> +<com:TTextHighlighter Language="prado" CssClass="source"> +<com:TClientScript ScriptUrl=<%~ test.js %> /> +</com:TTextHighlighter> +<p>You can include javascript files from other servers by specifying the full URL string in + the <tt>ScriptUrl</tt> property.</p> + +<h2>Including Custom Javascript Code Blocks</h2> +<p> Any content within the <tt>TClientScript</tt> control tag will be considered as + javascript code and will be rendered where it is declared.</p> + +</com:TContent>
\ No newline at end of file diff --git a/demos/quickstart/protected/pages/Controls/Standard.page b/demos/quickstart/protected/pages/Controls/Standard.page index 156b39e5..086ba293 100644 --- a/demos/quickstart/protected/pages/Controls/Standard.page +++ b/demos/quickstart/protected/pages/Controls/Standard.page @@ -11,6 +11,10 @@ <a href="?page=Controls.CheckBox">TCheckBox</a> represents a checkbox on a Web page. It can be used to collect two-state user input.
</li>
+ <li>
+ <a href="?page=Controls.ClientScript">TClientScript</a> adds javascript code to the page.
+ </li>
+
<li>*
<a href="?page=Controls.ColorPicker">TColorPicker</a> represents an input field taking color values via a color dialog.
</li>
diff --git a/framework/Web/Javascripts/js/validator.js b/framework/Web/Javascripts/js/validator.js index 43624d38..fd206508 100644 --- a/framework/Web/Javascripts/js/validator.js +++ b/framework/Web/Javascripts/js/validator.js @@ -129,9 +129,13 @@ switch(this.options.ControlType) return this.trim($F(control));else {this.observeDatePickerChanges();return Prado.WebUI.TDatePicker.getDropDownDate(control).getTime();} case'THtmlArea':if(typeof tinyMCE!="undefined") -tinyMCE.triggerSave();return this.trim($F(control));default:if(this.isListControlType()) +tinyMCE.triggerSave();return this.trim($F(control));case'TRadioButton':if(this.options.GroupName) +return this.getRadioButtonGroupValue();default:if(this.isListControlType()) return this.getFirstSelectedListValue();else -return this.trim($F(control));}},observeDatePickerChanges:function() +return this.trim($F(control));}},getRadioButtonGroupValue:function() +{name=this.control.name;value="";$A(document.getElementsByName(name)).each(function(el) +{if(el.checked) +value=el.value;});return value;},observeDatePickerChanges:function() {if(Prado.Browser().ie) {var DatePicker=Prado.WebUI.TDatePicker;this.observeChanges(DatePicker.getDayListControl(this.control));this.observeChanges(DatePicker.getMonthListControl(this.control));this.observeChanges(DatePicker.getYearListControl(this.control));}},getSelectedValuesAndChecks:function(elements,initialValue) {var checked=0;var values=[];var isSelected=this.isCheckBoxType(elements[0])?'checked':'selected';elements.each(function(element) diff --git a/framework/Web/Javascripts/prado/validation3.js b/framework/Web/Javascripts/prado/validation3.js index 6285dd52..ae28e1fa 100644 --- a/framework/Web/Javascripts/prado/validation3.js +++ b/framework/Web/Javascripts/prado/validation3.js @@ -787,6 +787,9 @@ Prado.WebUI.TBaseValidator.prototype = if(typeof tinyMCE != "undefined")
tinyMCE.triggerSave();
return this.trim($F(control));
+ case 'TRadioButton':
+ if(this.options.GroupName)
+ return this.getRadioButtonGroupValue();
default:
if(this.isListControlType())
return this.getFirstSelectedListValue();
@@ -795,6 +798,18 @@ Prado.WebUI.TBaseValidator.prototype = }
},
+ getRadioButtonGroupValue : function()
+ {
+ name = this.control.name;
+ value = "";
+ $A(document.getElementsByName(name)).each(function(el)
+ {
+ if(el.checked)
+ value = el.value;
+ });
+ return value;
+ },
+
/**
* Observe changes in the drop down list date picker, IE only.
*/
diff --git a/framework/Web/UI/WebControls/TClientScript.php b/framework/Web/UI/WebControls/TClientScript.php index 79279a93..88f7f7d4 100644 --- a/framework/Web/UI/WebControls/TClientScript.php +++ b/framework/Web/UI/WebControls/TClientScript.php @@ -14,19 +14,14 @@ * TClientScript class
*
* Allows importing of Prado Client Scripts from template via the
- * {@link setUsingPradoScripts UsingPradoScripts} property. Multiple Prado
+ * {@link setPradoScripts PradoScripts} property. Multiple Prado
* client-scripts can be specified using comma delimited string of the
* javascript library to include on the page. For example,
*
* <code>
- * <com:TClientScript UsingPradoScripts="effects, rico" />
+ * <com:TClientScript PradoScripts="effects, rico" />
* </code>
*
- * The {@link setPreRenderControlTypes PreRenderControlTypes} property can
- * be used to specify that controls type/class names that should pre-render itself
- * even though they may not be rendered on the page. This is useful to publish
- * controls that require assets and is only visible after a callback response.
- *
* Custom javascript files can be register using the {@link setScriptUrl ScriptUrl}
* property.
* <code>
@@ -34,17 +29,12 @@ * </code>
*
* Contents within TClientScript will be treated as javascript code and will be
- * rendered.
- *
- * The {@link setScriptPosition ScriptPosition} property specifies where the script
- * will be rendered. The allows values of {@link setScriptPosition ScriptPosition} are
+ * rendered in place.
*
- * - <b>Head</b> -- renders the script within the <head>
- * - <b>Begin</b> -- renders the script within and near the begining of TForm
- * - <b>Here</b> -- renders the script inplace, this is the default
- * - <b>End</b> -- renders the script within and near the end of TForm
- *
- * TODO: Allow binding expressions inside scripts
+ * The {@link setPreRenderControlTypes PreRenderControlTypes} property can
+ * be used to specify that controls type/class names that should pre-render itself
+ * even though they may not be rendered on the page. This is useful to publish
+ * controls that require assets and is only visible after a callback response.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @version $Revision: $ $Date: $
@@ -54,15 +44,10 @@ class TClientScript extends TControl
{
/**
- * @var string body contents
- */
- private $_content = '';
-
- /**
* @return string comma delimited list of javascript libraries to included
* on the page.
*/
- public function getUsingPradoScripts()
+ public function getPradoScripts()
{
return $this->getViewState('PradoScripts', '');
}
@@ -75,7 +60,7 @@ class TClientScript extends TControl *
* @param string comma delimited list of javascript libraries to include.
*/
- public function setUsingPradoScripts($value)
+ public function setPradoScripts($value)
{
$this->setViewState('PradoScripts', $value, '');
}
@@ -114,25 +99,6 @@ class TClientScript extends TControl }
/**
- * @return string position the script should be rendered, default is 'Here'.
- */
- public function getScriptPosition()
- {
- return $this->getViewState('ScriptPosition', 'Here');
- }
-
- /**
- * Sets the position where the script will be rendered.
- * The allow positions are 'Head', 'Begin', 'Here', and 'End', default is 'Here'.
- * @param string script position 'Head', 'Begin', 'Here' or 'End'.
- */
- public function setScriptPosition($value)
- {
- $this->setViewState('ScriptPosition',
- TPropertyValue::ensureEnum($value, 'Head', 'Begin', 'Here', 'End'), 'Here');
- }
-
- /**
* Calls the client script manager to add each of the requested client
* script libraries.
* @param mixed event parameter
@@ -140,51 +106,17 @@ class TClientScript extends TControl public function onPreRender($param)
{
parent::onPreRender($param);
- $scripts = preg_split('/,|\s+/', $this->getUsingPradoScripts());
+ $scripts = preg_split('/,|\s+/', $this->getPradoScripts());
$cs = $this->getPage()->getClientScript();
foreach($scripts as $script)
{
- $script = trim($script);
- if(strlen($script) > 0)
+ if(($script = trim($script))!=='')
$cs->registerPradoScript($script);
}
- if($this->getEnabled(true))
- {
- $this->registerCustomScriptFile();
- $this->registerCustomScript();
- }
$this->preRenderControls($param);
}
/**
- * Registers the custom script file.
- */
- protected function registerCustomScriptFile()
- {
- $scriptUrl = $this->getScriptUrl();
- if(strlen($scriptUrl))
- {
- $position = $this->getScriptPosition();
- $cs = $this->getPage()->getClientScript();
- switch($this->getScriptPosition())
- {
- case 'Head':
- $cs->registerHeadScriptFile($scriptUrl, $scriptUrl);
- break;
- case 'Begin':
- $cs->registerScriptFile($scriptUrl, $scriptUrl);
- break;
- case 'Here':
- $this->_content .= TJavascript::renderScriptFile($scriptUrl);
- break;
- default :
- throw new TConfigurationException('clientscript_invalid_file_position',
- $this->getID(), $position);
- }
- }
- }
-
- /**
* Renders the body content as javascript block.
* Overrides parent implementation, parent renderChildren method is called during
* {@link registerCustomScript}.
@@ -192,31 +124,31 @@ class TClientScript extends TControl */
public function render($writer)
{
- if($this->getEnabled(true) && strlen($this->_content) > 0)
- $writer->write($this->_content);
+ $this->renderCustomScriptFile($writer);
+ $this->renderCustomScript($writer);
+ }
+
+ /**
+ * Renders the custom script file.
+ * @param THtmLWriter the renderer
+ */
+ protected function renderCustomScriptFile($writer)
+ {
+ if(($scriptUrl = $this->getScriptUrl())!=='')
+ $writer->write("<script type=\"text/javascript\" src=\"$scriptUrl\"></script>\n");
}
/**
- * Registers the body content as scripts at specific locations. Calls
- * {@link parent::renderChildren} to capture the body contents.
+ * Registers the body content as javascript.
+ * @param THtmlWriter the renderer
*/
- protected function registerCustomScript()
+ protected function renderCustomScript($writer)
{
- $textWriter=new TTextWriter;
- $this->renderChildren(new THtmlWriter($textWriter));
- $script=$textWriter->flush();
- if(strlen($script)>0)
+ if($this->getHasControls())
{
- $cs = $this->getPage()->getClientScript();
- $position = $this->getScriptPosition();
- if($position == 'Here')
- $this->_content .= TJavaScript::renderScriptBlock($script);
- else
- {
- $key = sprintf('%08X', crc32($script));
- $method = 'register'.$position.'Script';
- $cs->{$method}($key, $script);
- }
+ $writer->write("<script type=\"text/javascript\">\n/*<![CDATA[*/\n");
+ $this->renderChildren($writer);
+ $writer->write("\n/*]]>*/\n</script>\n");
}
}
diff --git a/framework/Web/UI/WebControls/TDataList.php b/framework/Web/UI/WebControls/TDataList.php index 48392b1d..2c562d6d 100644 --- a/framework/Web/UI/WebControls/TDataList.php +++ b/framework/Web/UI/WebControls/TDataList.php @@ -960,6 +960,8 @@ class TDataList extends TBaseDataList implements INamingContainer, IRepeatInfoUs foreach($this->getControls() as $index=>$item)
{
+ if(!($item instanceof TDataListItem))
+ continue;
switch($item->getItemType())
{
case 'Header':
@@ -1112,9 +1114,9 @@ class TDataList extends TBaseDataList implements INamingContainer, IRepeatInfoUs $items=$this->getItems();
$selectedIndex=$this->getSelectedItemIndex();
$editIndex=$this->getEditItemIndex();
+ $hasSeparator=$this->_separatorTemplate!==null;
if($this->_headerTemplate!==null)
$this->_header=$this->createItemInternal(-1,'Header',false,null);
- $hasSeparator=$this->_separatorTemplate!==null;
for($i=0;$i<$itemCount;++$i)
{
if($hasSeparator && $i>0)
diff --git a/framework/Web/UI/WebControls/TRadioButton.php b/framework/Web/UI/WebControls/TRadioButton.php index 2bbdf22e..974a431c 100644 --- a/framework/Web/UI/WebControls/TRadioButton.php +++ b/framework/Web/UI/WebControls/TRadioButton.php @@ -37,6 +37,8 @@ Prado::using('System.Web.UI.WebControls.TRadioButtonList'); * between posts to the server.
*
* TRadioButton uses {@link setGroupName GroupName} to group together a set of radio buttons.
+ * Once the {@link setGroupName GroupName} is set, you can use the {@link getRadioButtonsInGroup}
+ * method to get an array of TRadioButtons having the same group name.
*
* If {@link setAutoPostBack AutoPostBack} is set true, changing the radio button state
* will cause postback action. And if {@link setCausesValidation CausesValidation}
@@ -54,10 +56,50 @@ Prado::using('System.Web.UI.WebControls.TRadioButtonList'); class TRadioButton extends TCheckBox
{
/**
+ * @param array list of radio buttons registered.
+ */
+ private static $_radiobuttons=array();
+ /**
* @var string the name used to fetch radiobutton post data
*/
private $_uniqueGroupName=null;
+ /**
+ * @var int number radio buttons created
+ */
+ private static $_counter=0;
+ /**
+ * @var int unique unmutable radio button id
+ */
+ private $_radioUid;
+ public function __construct()
+ {
+ parent::__construct();
+ $this->_radioUid = self::$_counter++;
+ }
+
+ /**
+ * Registers the radio button groupings. If overriding onInit method,
+ * ensure to call parent implemenation.
+ * @param TEventParameter event parameter to be passed to the event handlers
+ */
+ public function onInit($param)
+ {
+ parent::onInit($param);
+ $this->registerRadioButton($this);
+ }
+
+ /**
+ * Unregisters the radio button groupings. If overriding onInit method,
+ * ensure to call parent implemenation.
+ * @param TEventParameter event parameter to be passed to the event handlers
+ */
+ public function onUnLoad($param)
+ {
+ parent::onUnLoad($param);
+ $this->unregisterRadioButton($this);
+ }
+
/**
* Loads user input data.
* This method is primarly used by framework developers.
@@ -100,6 +142,43 @@ class TRadioButton extends TCheckBox {
$this->setViewState('GroupName',$value,'');
}
+
+ /**
+ * Register radio button control grouping.
+ * @param TRadioButton control to add
+ */
+ protected function registerRadioButton(TRadioButton $control)
+ {
+ if(!isset(self::$_radiobuttons[$control->_radioUid]))
+ self::$_radiobuttons[$control->_radioUid] = $control;
+ }
+
+ /**
+ * Unregister radio button control for grouping
+ * @param TRadioButton control to unregister.
+ */
+ protected function unregisterRadioButton(TRadioButton $control)
+ {
+ if(isset(self::$_radiobuttons[$control->_radioUid]))
+ unset(self::$_radiobuttons[$control->_radioUid]);
+ }
+
+ /**
+ * Gets an array of RadioButtons with same group name. This method will
+ * always return at least the current radio button in the array.
+ * @return array list of TRadioButton with the same group
+ */
+ public function getRadioButtonsInGroup()
+ {
+ $group = $this->getUniqueGroupName();
+ $buttons = array();
+ foreach(self::$_radiobuttons as $control)
+ {
+ if($control->getUniqueGroupName() === $group)
+ $buttons[] = $control;
+ }
+ return count($buttons) > 0 ? $buttons : array($this);
+ }
/**
* @return string the value attribute to be rendered
diff --git a/framework/Web/UI/WebControls/TRequiredFieldValidator.php b/framework/Web/UI/WebControls/TRequiredFieldValidator.php index b8a939ad..c99d9c19 100644 --- a/framework/Web/UI/WebControls/TRequiredFieldValidator.php +++ b/framework/Web/UI/WebControls/TRequiredFieldValidator.php @@ -76,22 +76,47 @@ class TRequiredFieldValidator extends TBaseValidator protected function evaluateIsValid()
{
$control = $this->getValidationTarget();
- $initial = trim($this->getInitialValue());
if($control instanceof TListControl)
+ return $this->validateListControl($control);
+ else if($control instanceof TRadioButton && strlen($control->getGroupName()) > 0)
+ return $this->validateRadioButtonGroup($control);
+ else
+ return $this->validateStandardControl($control);
+ }
+
+ private function validateListControl($control)
+ {
+ $initial = trim($this->getInitialValue());
+ $count = 0;
+ foreach($control->getItems() as $item)
{
- $count = 0;
- foreach($control->getItems() as $item)
- {
- if($item->getSelected() && $item->getValue() != $initial)
- $count++;
- }
- return $count > 0;
+ if($item->getSelected() && $item->getValue() != $initial)
+ $count++;
}
- else
+ return $count > 0;
+ }
+
+ private function validateRadioButtonGroup($control)
+ {
+ $initial = trim($this->getInitialValue());
+ foreach($control->getRadioButtonsInGroup() as $radio)
{
- $value=$this->getValidationValue($control);
- return trim($value)!==$initial || (is_bool($value) && $value);
+ if($radio->getChecked())
+ {
+ if(strlen($value = $radio->getValue()) > 0)
+ return $value !== $initial;
+ else
+ return true;
+ }
}
+ return false;
+ }
+
+ private function validateStandardControl($control)
+ {
+ $initial = trim($this->getInitialValue());
+ $value=$this->getValidationValue($control);
+ return trim($value)!==$initial || (is_bool($value) && $value);
}
/**
@@ -105,6 +130,8 @@ class TRequiredFieldValidator extends TBaseValidator $control = $this->getValidationTarget();
if($control instanceof TListControl)
$options['TotalItems'] = $control->getItemCount();
+ if($control instanceof TRadioButton && strlen($control->getGroupName()) > 0)
+ $options['GroupName'] = $control->getGroupName();
return $options;
}
}
diff --git a/framework/Web/UI/WebControls/TStyleSheet.php b/framework/Web/UI/WebControls/TStyleSheet.php index 02ac40cd..5925645c 100644 --- a/framework/Web/UI/WebControls/TStyleSheet.php +++ b/framework/Web/UI/WebControls/TStyleSheet.php @@ -52,11 +52,8 @@ class TStyleSheet extends TControl */ public function onPreRender($param) { - if($this->getEnabled(true)) - { - if(($url=$this->getStyleSheetUrl())!=='') - $this->getPage()->getClientScript()->registerStyleSheetFile($url,$url); - } + if(($url=$this->getStyleSheetUrl())!=='') + $this->getPage()->getClientScript()->registerStyleSheetFile($url,$url); } /** diff --git a/framework/prado-cli.php b/framework/prado-cli.php index f8ce826c..1a0e5498 100755 --- a/framework/prado-cli.php +++ b/framework/prado-cli.php @@ -10,12 +10,16 @@ if(!isset($_SERVER['argv'])) //command line options. $options['create'] = array('c:', 'create=', '<directory>', 'create a new project <directory>'); +$options['tests'] = array('t', 'create-tests', '', 'create unit and function test fixtures'); + $console = new ConsoleOptions($options, $_SERVER['argv']); if($console->hasOptions()) { if($dir = $console->getOption('create')) create_new_prado_project($dir); + if($console->getOption('tests')) + create_test_fixtures($dir); } else { @@ -51,32 +55,106 @@ function create_new_prado_project($dir) $htaccessFile = $protectedPath.'/.htaccess'; $defaultPageFile = $pagesPath.'/Home.page'; + $tests = $basePath.'/tests'; + $unit_tests = $tests.'/unit'; + $functional_tests = $tests.'/functional'; + create_directory($basePath, 0755); create_directory($assetPath,0777); create_directory($protectedPath,0755); create_directory($runtimePath,0777); create_directory($pagesPath,0755); + + create_directory($tests,0755); + create_directory($unit_tests,0755); + create_directory($functional_tests,0755); + + create_file($indexFile, render_index_file()); + create_file($htaccessFile, render_htaccess_file()); + create_file($defaultPageFile, render_default_page()); +} + +function create_test_fixtures($dir) +{ + if(strlen(trim($dir)) == 0) + return; - file_put_contents($indexFile, render_index_file()); - file_put_contents($htaccessFile, render_htaccess_file()); - file_put_contents($defaultPageFile, render_default_page()); + $rootPath = realpath(dirname(trim($dir))); + $basePath = $rootPath.'/'.basename($dir); + + $tests = $basePath.'/tests'; + $unit_tests = $tests.'/unit'; + $functional_tests = $tests.'/functional'; + + create_directory($tests,0755); + create_directory($unit_tests,0755); + create_directory($functional_tests,0755); + + $unit_test_index = $tests.'/unit.php'; + $functional_test_index = $tests.'/functional.php'; + + create_file($unit_test_index, render_unit_test_fixture()); + create_file($functional_test_index, render_functional_test_fixture()); +} + +function render_unit_test_fixture() +{ + $tester = realpath(dirname(__FILE__).'/../tests/test_tools/unit_tests.php'); +return '<?php + +include_once \''.$tester.'\'; + +$app_directory = "../protected"; +$test_cases = dirname(__FILE__)."/unit"; + +$tester = new PradoUnitTester($test_cases, $app_directory); +$tester->run(new HtmlReporter()); + +?>'; +} + +function render_functional_test_fixture() +{ + $tester = realpath(dirname(__FILE__).'/../tests/test_tools/functional_tests.php'); +return '<?php + +include_once \''.$tester.'\'; + +$test_cases = dirname(__FILE__)."/functional"; + +$tester=new PradoFunctionalTester($test_cases); +$tester->run(new SimpleReporter()); + +?>'; } function create_directory($dir, $mask) { if(!is_dir($dir)) + { mkdir($dir); + echo "creating $dir\n"; + } if(is_dir($dir)) chmod($dir, $mask); } +function create_file($filename, $content) +{ + if(!is_file($filename)) + { + file_put_contents($filename, $content); + echo "creating $filename\n"; + } +} + function render_index_file() { $framework = realpath(dirname(__FILE__)).'/prado.php'; return '<?php $basePath=dirname(__FILE__); -$frameworkPath="'.$framework.'"; +$frameworkPath=\''.$framework.'\'; $assetsPath=$basePath."/assets"; $runtimePath=$basePath."/protected/runtime"; @@ -214,6 +292,7 @@ class ConsoleOptions { if(is_null($this->_values)) $this->_values = $this->getNamedOptions(); + return isset($this->_values[$name]) ? $this->_values[$name] : null; } @@ -248,9 +327,10 @@ class ConsoleOptions { foreach($this->_options as $name => $option) { - if(strpos($option[0],$value[0]) !== false - || strpos($option[1], $value[0]) !== false) - $options[$name] = $value[1]; + $short = str_replace(':', '', $option[0]); + $long = str_replace('=', '', $option[1]); + if($short == $value[0] || $long == $value[0]) + $options[$name] = is_null($value[1]) ? true : $value[1]; } } return $options; diff --git a/tests/FunctionalTests/config.php b/tests/FunctionalTests/config.php deleted file mode 100644 index 358fb8e2..00000000 --- a/tests/FunctionalTests/config.php +++ /dev/null @@ -1,159 +0,0 @@ -<?php - -//error_reporting(E_ALL); -//restore_error_handler(); - -$SIMPLE_TEST = dirname(__FILE__).'/../UnitTests'; - -require_once($SIMPLE_TEST.'/simpletest/unit_tester.php'); -require_once($SIMPLE_TEST.'/simpletest/web_tester.php'); -require_once($SIMPLE_TEST.'/simpletest/mock_objects.php'); -require_once($SIMPLE_TEST.'/simpletest/reporter.php'); -require(dirname(__FILE__).'/selenium/php/selenium.php'); -//require_once(PradoTestConfig::framework().'/prado.php'); - -/** test configurations , OVERRIDE to suite your enviornment !!! **/ -class PradoTestConfig -{ - //directories containing test files - public function unit_test_groups() - { - return array(); - } - - //test directory base - public function tests_directory() - { - return dirname(__FILE__).'/protected/'; - } - - //prado frame work directory - public static function framework() - { - return realpath(dirname(__FILE__).'/../../framework/'); - } - - //do test that require mysql database connection? - public function doMySQLTests() - { - return false; - } - - //run the prado application - public function runApplication($appUrl='tests.php', $class='PradoApplicationTester') - { - $app = new $class($this, $appUrl); - $app->run(); - } - - //file patterns to accept for test - public function acceptPattern() - { - return '/\w+\.php/'; - } - - public function rejectPattern() - { - return null; - } - - public function getTestCase() - { - return isset($_GET['file']) ? $_GET['file'] : ''; - } -} - -//set up the PradoApplication Testing stub. - -class PradoApplicationTester -{ - protected $appUrl; - protected $testConfig; - - public function __construct($config, $appUrl) - { - $this->appUrl = $appUrl; - $this->testConfig = $config; - } - - public function run() - { - } - - public function getTestPage($file) - { - $parameter = $this->getTestServiceParameter($file); - return $this->appUrl.'?page='.$parameter; - } - - protected function getTestServiceParameter($file) - { - $file = strtr(realpath($file),'\\','/'); - $base = strtr(realpath($this->testConfig->tests_directory().'/pages/'),'\\','/'); - $search = array($base, '.php'); - $replace = array('', ''); - $pagePath = str_replace($search, $replace, $file); - return strtr(trim($pagePath,'/'),'/','.'); - } -} - -/** set up the tests **/ - -class PradoSimpleTester -{ - protected $tester; - - function __construct($tester) - { - $this->tester = $tester; - $this->tester->runApplication(); - } - - function getTests($name='All Tests') - { - $unit_tests = new GroupTest($name); - - foreach($this->tester->unit_test_groups() as $group => $dir) - { - $unit_tests->addTestCase($this->testSuits($group, $dir)); - } - return $unit_tests; - } - - protected function testSuits($group, $path) - { - $suite = new GroupTest($group); - $dir = dir($path); - - while (false !== ($entry = $dir->read())) - { - $file = strtr(realpath($path.'/'.$entry),'\\','/'); - $matchFile = $this->tester->getTestCase(); - if(is_file($file) && $this->filePatternMatch($file)) - { - if(empty($matchFile) || - (!empty($matchFile) - && is_int(strpos($file, $matchFile)))) - $suite->addTestFile($file); - } - - } - $dir->close(); - return $suite; - } - - protected function filePatternMatch($file) - { - $accept = $this->tester->acceptPattern(); - $reject = $this->tester->rejectPattern(); - - $valid = true; - if(!is_null($accept)) - $valid = $valid && preg_match($accept, $file); - if(!is_null($reject)) - $valid = $valid && !preg_match($reject, $file); - return $valid; - } -} - -?>
\ No newline at end of file diff --git a/tests/FunctionalTests/features.php b/tests/FunctionalTests/features.php index 8a3c87a6..9005db14 100644 --- a/tests/FunctionalTests/features.php +++ b/tests/FunctionalTests/features.php @@ -1,8 +1,8 @@ <?php -require(dirname(__FILE__).'/PradoTester.php'); +require('../test_tools/functional_tests.php'); -$tester=new PradoTester(dirname(__FILE__).'/features/tests'); +$tester=new PradoFunctionalTester(dirname(__FILE__).'/features/tests'); $tester->run(new SimpleReporter()); ?>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/protected/pages/CompositeControl.page b/tests/FunctionalTests/features/protected/pages/CompositeControl.page deleted file mode 100644 index b135445a..00000000 --- a/tests/FunctionalTests/features/protected/pages/CompositeControl.page +++ /dev/null @@ -1,12 +0,0 @@ -<com:TContent ID="Content">
-<h1>Composite Control Test</h1>
- <com:LabeledTextBox id="user" Label.Text="username:" /><br />
- <com:LabeledTextBox id="pass" Label.Text="password:" /><br />
- <com:TButton Text="Submit" />
-
-<com:TPanel Visible=<%= $this->user->TextBox->Text != "" %> >
-<h2>Result</h2>
- User: <%= $this->user->TextBox->Text %> Pass: <%= $this->pass->TextBox->Text %>
-</com:TPanel>
-
-</com:TContent>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/protected/pages/DatePicker.page b/tests/FunctionalTests/features/protected/pages/DatePicker.page deleted file mode 100644 index 261a6994..00000000 --- a/tests/FunctionalTests/features/protected/pages/DatePicker.page +++ /dev/null @@ -1,61 +0,0 @@ -<com:TContent ID="Content">
-
-<h1>TDatePicker Samples</h1>
-
-<table class="sampletable">
-
-<tr>
- <td class="samplenote">Default TDatePicker</td>
- <td class="sampleaction">
- <com:TDatePicker />
- </td>
-</tr>
-
-<tr>
- <td class="samplenote">Button Mode, pre-selected date</td>
- <td class="sampleaction">
- <com:TDatePicker Mode="Button" Date="20-10-2005"/>
- </td>
-</tr>
-
-<tr>
- <td class="samplenote">InputMode="DropDownList", custom DateFormat</td>
- <td class="sampleaction">
- <com:TDatePicker DateFormat="yyyy/MMM" InputMode="DropDownList"/>
- </td>
-</tr>
-
-<tr>
- <td class="samplenote">InputMode="DropDownList", custom DateFormat, Culture</td>
- <td class="sampleaction">
- <com:TDatePicker DateFormat="MMM/yyyy" Culture="fr" InputMode="DropDownList"/>
- </td>
-</tr>
-
-
-<tr>
- <td class="samplenote">Custom DateFormat, culture, ImageButton mode, pre-selected date</td>
- <td class="sampleaction">
- <com:TDatePicker Mode="ImageButton" Culture="zh_CN"
- DateFormat="日期：yyyy年M月d日"
- Timestamp=<%= @strtotime("-1 year") %>/>
- </td>
-</tr>
-
-<tr>
- <td class="samplenote">Custom DateFormat, DropDownList, pre-selected date set in as Text</td>
- <td class="sampleaction">
- <com:TDatePicker DateFormat="yyyy/MMMM/dd" Date="2005/05/15" InputMode="DropDownList"/>
- </td>
-</tr>
-
-<tr>
- <td class="samplenote">DropDownList, pre-selected date as integer</td>
- <td class="sampleaction">
- <com:TDatePicker InputMode="DropDownList" Timestamp=<%= @strtotime("-1 month") %>/>
- </td>
-</tr>
-
-</table>
-
-</com:TContent>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/protected/pages/HtmlArea.page b/tests/FunctionalTests/features/protected/pages/HtmlArea.page deleted file mode 100644 index 3936e68c..00000000 --- a/tests/FunctionalTests/features/protected/pages/HtmlArea.page +++ /dev/null @@ -1,25 +0,0 @@ -
-<com:TContent ID="Content">
-
- <com:THtmlArea ID="text1" />
-
- <com:TRequiredFieldValidator
- ControlToValidate="text1"
- ErrorMessage="*" />
-
- <com:TButton ID="button1" Text="submit 1" />
-
- <com:TButton ID="button2" Text="submit 2" />
-
- <com:THtmlArea ID="text2" />
-
- <com:TRequiredFieldValidator
- ControlToValidate="text2"
- ValidationGroup="group2"
- ErrorMessage="*" />
-
- <com:TButton ID="button3" ValidationGroup="group2" Text="submit 3" />
-
- <com:TButton ID="button4" ValidationGroup="group2" Text="submit 4" />
-
-</com:TContent>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/protected/pages/ValidatorEffects.page b/tests/FunctionalTests/features/protected/pages/ValidatorEffects.page index 1a97a249..7fca0f56 100644 --- a/tests/FunctionalTests/features/protected/pages/ValidatorEffects.page +++ b/tests/FunctionalTests/features/protected/pages/ValidatorEffects.page @@ -93,5 +93,14 @@ </fieldset>
+<com:TLinkButton ID="linkButton1"
+ Text="Click Me"
+ OnClick="linkButton1_Clicked">
+ <prop:Attributes.onclick>
+ if(!confirm('<%= Prado::localize("Confirm Delete") %>'))
+ return false;
+ </prop:Attributes.onclick>
+</com:TLinkButton>
+
</com:TContent>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/tests/CompositeControlTestCase.php b/tests/FunctionalTests/features/tests/CompositeControlTestCase.php deleted file mode 100644 index dda3f63b..00000000 --- a/tests/FunctionalTests/features/tests/CompositeControlTestCase.php +++ /dev/null @@ -1,23 +0,0 @@ -<?php
-/*
- * Created on 28/04/2006
- */
-
-class CompositeControlTestCase extends SeleniumTestCase
-{
-
- function test()
- {
- $base = "ctl0_Content_";
- $this->open("features/index.php?page=CompositeControl", "");
- $this->verifyTextPresent("Composite Control Test", "");
- $this->type("{$base}user_textbox", "Hello");
- $this->type("{$base}pass_textbox", "world");
- $this->clickAndWait("//input[@type='submit' and @value='Submit']", "");
- $this->verifyTextPresent("Result", "");
- $this->verifyTextPresent("User: Hello Pass: world", "");
- }
-
-}
-
-?>
diff --git a/tests/FunctionalTests/quickstart.php b/tests/FunctionalTests/quickstart.php index aa6dc119..3493a907 100644..100755 --- a/tests/FunctionalTests/quickstart.php +++ b/tests/FunctionalTests/quickstart.php @@ -1,8 +1,8 @@ <?php -require(dirname(__FILE__).'/PradoTester.php'); +require('../test_tools/functional_tests.php'); -$tester=new PradoTester(dirname(__FILE__).'/quickstart'); +$tester=new PradoFunctionalTester(dirname(__FILE__).'/quickstart'); $tester->run(new SimpleReporter()); ?>
\ No newline at end of file diff --git a/tests/FunctionalTests/selenium/core/SeleneseRunner.html b/tests/FunctionalTests/selenium/core/SeleneseRunner.html deleted file mode 100755 index 49eef6f6..00000000 --- a/tests/FunctionalTests/selenium/core/SeleneseRunner.html +++ /dev/null @@ -1,111 +0,0 @@ -<html> - -<!-- -Copyright 2004 ThoughtWorks, Inc - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<HTA:APPLICATION ID="SeleniumHTARunner" APPLICATIONNAME="Selenium" > -<head> -<meta content="text/html; charset=ISO-8859-1" -http-equiv="content-type"> -<title>Selenium Functional Test Runner</title> -<link rel="stylesheet" type="text/css" href="selenium.css" /> -<script language="JavaScript" type="text/javascript" src="jsunit/app/jsUnitCore.js"></script> -<script type="text/javascript" src="scripts/xmlextras.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-browserdetect.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-browserbot.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/prototype-1.4.0.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/find_matching_child.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-api.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-commandhandlers.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-executionloop.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-seleneserunner.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-logging.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-version.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/htmlutils.js"></script> -<script language="JavaScript" type="text/javascript" src="xpath/misc.js"></script> -<script language="JavaScript" type="text/javascript" src="xpath/dom.js"></script> -<script language="JavaScript" type="text/javascript" src="xpath/xpath.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/user-extensions.js"></script> -<script language="JavaScript" type="text/javascript"> - function openDomViewer() { - var autFrame = document.getElementById('myiframe'); - var autFrameDocument = getIframeDocument(autFrame); - var domViewer = window.open(getDocumentBase(document) + 'domviewer/domviewer.html'); - domViewer.rootDocument = autFrameDocument; - return false; - } - - function cleanUp() { - if (LOG != null) { - LOG.close(); - } - } - -</script> -<script> -</script> -</head> - -<body onLoad="runTest()" onUnload="cleanUp()"> - -<table border="1" style="height: 100%;"> - <tr> - <td width="50%" height="30%"> - <table> - <tr> - <td> - <img src="selenium-logo.png"> - </td> - <td> - <h1><a href="http://selenium.thoughtworks.com" >Selenium</a> Functional Testing for Web Apps</h1> - Open Source From <a href="http://www.thoughtworks.com">ThoughtWorks, Inc</a> and Friends - <form action=""> - <br/>Slow Mode:<INPUT TYPE="CHECKBOX" NAME="FASTMODE" VALUE="YES" onmouseup="slowClicked()"> - - <fieldset> - <legend>Tools</legend> - - <button type="button" id="domViewer1" onclick="openDomViewer();"> - View DOM - </button> - <button type="button" onclick="LOG.show();"> - Show Log - </button> - </fieldset> - - </form> - - </td> - </tr> - </table> - <form action=""> - <label id="context" name="context"></label> - </form> - </td> - <td width="50%" height="30%"> - <b>Last Four Test Commands:</b><br/> - <div id="commandList"></div> - </td> - </tr> - <tr> - <td colspan="2" height="70%"> - <iframe name="myiframe" id="myiframe" src="" height="100%" width="100%"></iframe> - </td> - </tr> -</table> - -</body> -</html> - diff --git a/tests/FunctionalTests/selenium/core/TestPrompt.html b/tests/FunctionalTests/selenium/core/TestPrompt.html deleted file mode 100755 index f62bad87..00000000 --- a/tests/FunctionalTests/selenium/core/TestPrompt.html +++ /dev/null @@ -1,93 +0,0 @@ -<html>
-<!--
-Copyright 2004 ThoughtWorks, Inc
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<head>
-<meta content="text/html; charset=ISO-8859-1"
-http-equiv="content-type">
-<title>Select a Test Suite</title>
-<script language="JavaScript" type="text/javascript" src="scripts/selenium-browserdetect.js"></script>
-<script>
-
-function load() {
- if (browserVersion.isHTA) {
- document.getElementById("save-div").style.display = "inline";
- }
-}
-
-function autoCheck() {
- var auto = document.getElementById("auto");
- var autoDiv = document.getElementById("auto-div");
- if (auto.checked) {
- autoDiv.style.display = "inline";
-
- } else {
- autoDiv.style.display = "none";
- }
-}
-
-function saveCheck() {
- var results = document.getElementById("results");
- var check = document.getElementById("save").checked;
- if (check) {
- results.firstChild.nodeValue = "Results file ";
- document.getElementById("resultsUrl").value = "results.html";
- } else {
- results.firstChild.nodeValue = "Results URL ";
- document.getElementById("resultsUrl").value = "../postResults";
- }
-}
-
-function go() {
-
- var inputs = document.getElementsByTagName("input");
- var queryString = "";
- for (var i = 0; i < inputs.length; i++) {
- var elem = inputs[i];
- var name = elem.name;
- var value = elem.value;
- if (elem.checked) {
- value = "true";
- }
- queryString += escape(name) + "=" + escape(value);
- if (i < (inputs.length - 1)) {
- queryString += "&";
- }
- }
-
- window.parent.queryString = queryString;
- window.parent.loadSuiteFrame();
- return false;
-}
-</script>
-</head>
-<body onload="load()" style="font-size: x-small">
-<form id="prompt" target="_top" method="GET" onsubmit="return go();" action="TestRunner.html">
-<p>Select an HTML test suite:</p>
-<input id="test" name="test" size="30" value="../tests/TestSuite.html"/>
-<p><label for="auto">Auto-run </label><input id="auto" type="checkbox" name="auto" value="false" onclick="autoCheck();"/>
-<div id="auto-div" style="display: none">
-<label for="close" >Close afterwards </label><input id="close" type="checkbox" name="close" />
-<div id="save-div" style="display: none">
- <br/><label for="save">Save to file </label><input id="save" type="checkbox" name="save" onclick="saveCheck();"/>
-</div>
-</p>
-<p id="results" >Results URL <input id="resultsUrl" name="resultsUrl" value="../postResults"/></p>
-</div>
-<p><input type="submit" value="go"/></p>
-</form>
-</body>
-</html>
\ No newline at end of file diff --git a/tests/FunctionalTests/selenium/core/TestRunner.html b/tests/FunctionalTests/selenium/core/TestRunner.html deleted file mode 100755 index f933ab9f..00000000 --- a/tests/FunctionalTests/selenium/core/TestRunner.html +++ /dev/null @@ -1,157 +0,0 @@ -<html> - -<head> -<HTA:APPLICATION ID="SeleniumHTARunner" APPLICATIONNAME="Selenium" > -<!-- the previous line is only relevant if you rename this - file to "TestRunner.hta" --> - -<!-- The copyright notice and other comments have been moved to after the HTA declaration, - to work-around a bug in IE on Win2K whereby the HTA application doesn't function correctly --> -<!-- -Copyright 2004 ThoughtWorks, Inc - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" /> - -<title>Selenium Functional Test Runner</title> -<link rel="stylesheet" type="text/css" href="selenium.css" /> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-browserdetect.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-browserbot.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/prototype-1.4.0.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/find_matching_child.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-api.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-commandhandlers.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-executionloop.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-testrunner.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-logging.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/selenium-version.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/htmlutils.js"></script> -<script language="JavaScript" type="text/javascript" src="xpath/misc.js"></script> -<script language="JavaScript" type="text/javascript" src="xpath/dom.js"></script> -<script language="JavaScript" type="text/javascript" src="xpath/xpath.js"></script> -<script language="JavaScript" type="text/javascript" src="scripts/user-extensions.js"></script> -<script language="JavaScript" type="text/javascript"> - function openDomViewer() { - var autFrame = document.getElementById('myiframe'); - var autFrameDocument = getIframeDocument(autFrame); - this.rootDocument = autFrameDocument; - var domViewer = window.open(getDocumentBase(document) + 'domviewer/domviewer.html'); - return false; - } -</script> -</head> - -<body onLoad="start();"> - - <table class="layout"> - <form action="" name="controlPanel"> - - <!-- Suite, Test, Control Panel --> - - <tr class="selenium"> - <td width="25%" height="30%" ><iframe name="testSuiteFrame" id="testSuiteFrame" src="./TestPrompt.html" application="yes"></iframe></td> - <td width="50%" height="30%" ><iframe name="testFrame" id="testFrame" application="yes"></iframe></td> - - <td width="25%"> - <table class="layout"> - <tr class="selenium"> - <th width="25%" height="1" class="header"> - <h1><a href="http://selenium.thoughtworks.com" title="The Selenium Project">Selenium</a> TestRunner</h1> - </th> - </tr> - <tr> - <td width="25%" height="30%" id="controlPanel"> - - <fieldset> - <legend>Execute Tests</legend> - - <div> - <input id="modeRun" type="radio" name="runMode" value="0" checked="checked"/><label for="modeRun">Run</label> - <input id="modeWalk" type="radio" name="runMode" value="500" /><label for="modeWalk">Walk</label> - <input id="modeStep" type="radio" name="runMode" value="-1" /><label for="modeStep">Step</label> - </div> - - <div> - <button type="button" id="runSuite" onClick="startTestSuite();" - title="Run the entire Test-Suite"> - <strong>All</strong> - </button> - <button type="button" id="runTest" onClick="runSingleTest();" - title="Run the current Test"> - <em>Selected</em> - </button> - <button type="button" id="continueTest" disabled="disabled" - title="Continue the Test"> - Continue - </button> - </div> - - </fieldset> - - <table id="stats" align="center"> - <tr> - <td colspan="2" align="right">Elapsed:</td> - <td id="elapsedTime" colspan="2">00.00</td> - </tr> - <tr> - <th colspan="2">Tests</th> - <th colspan="2">Commands</th> - </tr> - <tr> - <td class="count" id="testRuns">0</td> - <td>run</td> - <td class="count" id="commandPasses">0</td> - <td>passed</td> - </tr> - <tr> - <td class="count" id="testFailures">0</td> - <td>failed</td> - <td class="count" id="commandFailures">0</td> - <td>failed</td> - </tr> - <tr> - <td colspan="2"></td> - <td class="count" id="commandErrors">0</td> - <td>incomplete</td> - </tr> - </table> - - <fieldset> - <legend>Tools</legend> - - <button type="button" id="domViewer1" onClick="openDomViewer();"> - View DOM - </button> - <button type="button" onClick="LOG.show();"> - Show Log - </button> - - </fieldset> - - </td> - </tr> - </table> - </td> - </tr> - - <!-- AUT --> - - <tr> - <td colspan="3" height="70%"><iframe name="myiframe" id="myiframe" src="TestRunner-splash.html"></iframe></td> - </tr> - </form> - </table> - -</body> -</html> diff --git a/tests/FunctionalTests/selenium/core/domviewer/butmin.gif b/tests/FunctionalTests/selenium/core/domviewer/butmin.gif Binary files differdeleted file mode 100755 index 7b7cefd5..00000000 --- a/tests/FunctionalTests/selenium/core/domviewer/butmin.gif +++ /dev/null diff --git a/tests/FunctionalTests/selenium/core/domviewer/butplus.gif b/tests/FunctionalTests/selenium/core/domviewer/butplus.gif Binary files differdeleted file mode 100755 index 6d68cfa9..00000000 --- a/tests/FunctionalTests/selenium/core/domviewer/butplus.gif +++ /dev/null diff --git a/tests/FunctionalTests/selenium/core/domviewer/domviewer.css b/tests/FunctionalTests/selenium/core/domviewer/domviewer.css deleted file mode 100755 index b64b2435..00000000 --- a/tests/FunctionalTests/selenium/core/domviewer/domviewer.css +++ /dev/null @@ -1,298 +0,0 @@ -/******************************************************************************
-* Defines default styles for site pages. *
-******************************************************************************/
-.hidden {
- display: none;
-}
-
-img{
- display: inline;
- border: none;
-}
-
-.box{
- background: #fcfcfc;
- border: 1px solid #000;
- border-color: blue;
- color: #000000;
- margin: 10px auto;
- padding: 3px;
- vertical-align: bottom;
-}
-a {
- text-decoration: none;
-}
-
-body {
- background-color: #ffffff;
- color: #000000;
- font-family: Arial, Helvetica, sans-serif;
- font-size: 10pt;
-}
-
-h2 {
- font-size: 140%;
-}
-
-h3 {
- font-size: 120%;
-}
-
-h4 {
- font-size: 100%;
-}
-
-pre {
- font-family: Courier New, Courier, monospace;
- font-size: 80%;
-}
-
-td, th {
- font-family: Arial, Helvetica, sans-serif;
- font-size: 10pt;
- text-align: left;
- vertical-align: top;
-}
-
-th {
- font-weight: bold;
- vertical-align: bottom;
-}
-
-ul {
- list-style-type: square;
-}
-
-#demoBox {
- border-color: #000000;
- border-style: solid;
- border-width: 1px;
- padding: 8px;
- width: 24em;
-}
-
-.footer {
- margin-bottom: 0px;
- text-align: center;
-}
-
-/* Boxed table styles */
-
-table.boxed {
- border-spacing: 2px;
- empty-cells: hide;
-}
-
-td.boxed, th.boxed, th.boxedHeader {
- background-color: #ffffff;
- border-color: #000000;
- border-style: solid;
- border-width: 1px;
- color: #000000;
- padding: 2px;
- padding-left: 8px;
- padding-right: 8px;
-}
-
-th.boxed {
- background-color: #c0c0c0;
-}
-
-th.boxedHeader {
- background-color: #808080;
- color: #ffffff;
-}
-
-a.object {
- color: #0000ff;
-}
-
-li {
- white-space: nowrap;
-}
-
-ul {
- list-style-type: square;
- margin-left: 0px;
- padding-left: 1em;
-}
-
-.boxlevel1{
- background: #FFD700;
-}
-
-.boxlevel2{
- background: #D2691E;
-}
-
-.boxlevel3{
- background: #DCDCDC;
-}
-
-.boxlevel4{
- background: #F5F5F5;
-}
-
-.boxlevel5{
- background: #BEBEBE;
-}
-
-.boxlevel6{
- background: #D3D3D3;
-}
-
-.boxlevel7{
- background: #A9A9A9;
-}
-
-.boxlevel8{
- background: #191970;
-}
-
-.boxlevel9{
- background: #000080;
-}
-
-.boxlevel10{
- background: #6495ED;
-}
-
-.boxlevel11{
- background: #483D8B;
-}
-
-.boxlevel12{
- background: #6A5ACD;
-}
-
-.boxlevel13{
- background: #7B68EE;
-}
-
-.boxlevel14{
- background: #8470FF;
-}
-
-.boxlevel15{
- background: #0000CD;
-}
-
-.boxlevel16{
- background: #4169E1;
-}
-
-.boxlevel17{
- background: #0000FF;
-}
-
-.boxlevel18{
- background: #1E90FF;
-}
-
-.boxlevel19{
- background: #00BFFF;
-}
-
-.boxlevel20{
- background: #87CEEB;
-}
-
-.boxlevel21{
- background: #B0C4DE;
-}
-
-.boxlevel22{
- background: #ADD8E6;
-}
-
-.boxlevel23{
- background: #00CED1;
-}
-
-.boxlevel24{
- background: #48D1CC;
-}
-
-.boxlevel25{
- background: #40E0D0;
-}
-
-.boxlevel26{
- background: #008B8B;
-}
-
-.boxlevel27{
- background: #00FFFF;
-}
-
-.boxlevel28{
- background: #E0FFFF;
-}
-
-.boxlevel29{
- background: #5F9EA0;
-}
-
-.boxlevel30{
- background: #66CDAA;
-}
-
-.boxlevel31{
- background: #7FFFD4;
-}
-
-.boxlevel32{
- background: #006400;
-}
-
-.boxlevel33{
- background: #556B2F;
-}
-
-.boxlevel34{
- background: #8FBC8F;
-}
-
-.boxlevel35{
- background: #2E8B57;
-}
-
-.boxlevel36{
- background: #3CB371;
-}
-
-.boxlevel37{
- background: #20B2AA;
-}
-
-.boxlevel38{
- background: #00FF7F;
-}
-
-.boxlevel39{
- background: #7CFC00;
-}
-
-.boxlevel40{
- background: #90EE90;
-}
-
-.boxlevel41{
- background: #00FF00;
-}
-
-.boxlevel41{
- background: #7FFF00;
-}
-
-.boxlevel42{
- background: #00FA9A;
-}
-
-.boxlevel43{
- background: #ADFF2F;
-}
-
-.boxlevel44{
- background: #32CD32;
-}
\ No newline at end of file diff --git a/tests/FunctionalTests/selenium/core/domviewer/domviewer.html b/tests/FunctionalTests/selenium/core/domviewer/domviewer.html deleted file mode 100755 index 9158a50f..00000000 --- a/tests/FunctionalTests/selenium/core/domviewer/domviewer.html +++ /dev/null @@ -1,16 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> - <head> - <title>DOM Viewer</title> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> - <link rel="stylesheet" type="text/css" href="domviewer.css"/> - <script type="text/javascript" src="selenium-domviewer.js"></script> - </head> - <body onload="loadDomViewer();"> - <h3>DOM Viewer</h3> - <p> This page is generated using JavaScript. If you see this text, your - browser doesn't support JavaScript.</p> - </body> - -</html> diff --git a/tests/FunctionalTests/selenium/core/domviewer/selenium-domviewer.js b/tests/FunctionalTests/selenium/core/domviewer/selenium-domviewer.js deleted file mode 100755 index 941aab16..00000000 --- a/tests/FunctionalTests/selenium/core/domviewer/selenium-domviewer.js +++ /dev/null @@ -1,205 +0,0 @@ -var HIDDEN="hidden"; -var LEVEL = "level"; -var PLUS_SRC="butplus.gif"; -var MIN_SRC="butmin.gif"; -var newRoot; -var maxColumns=1; - -function loadDomViewer() { - // See if the rootDocument variable has been set on this window. - var rootDocument = window.rootDocument; - - // If not look to the opener for an explicity rootDocument variable, otherwise, use the opener document - if (!rootDocument && window.opener) { - rootDocument = window.opener.rootDocument || window.opener.document; - } - - if (rootDocument) { - document.body.innerHTML = displayDOM(rootDocument); - } - else { - document.body.innerHTML = "<b>Must specify rootDocument for window. This can be done by setting the rootDocument variable on this window, or on the opener window for a popup window.</b>"; - } -} - - -function displayDOM(root){ - var str = ""; - str+="<table>"; - str += treeTraversal(root,0); - // to make table columns work well. - str += "<tr>"; - for (var i=0; i < maxColumns; i++) { - str+= "<td> </td>"; - } - str += "</tr>"; - str += "</table>"; - return str; -} - -function checkForChildren(element){ - if(!element.hasChildNodes()) - return false; - - var nodes = element.childNodes; - var size = nodes.length; - var count=0; - - for(var i=0; i< size; i++){ - var node = nodes.item(i); - //if(node.toString()=="[object Text]"){ - //this is equalent to the above - //but will work with more browsers - if(node.nodeType!=1){ - count++; - } - } - - if(count == size) - return false; - else - return true; -} - -function treeTraversal(root, level){ - var str = ""; - var nodes= null; - var size = null; - //it is supposed to show the last node, - //but the last node is always nodeText type - //and we don't show it - if(!root.hasChildNodes()) - return "";//displayNode(root,level,false); - - nodes = root.childNodes; - size = nodes.length; - - for(var i=0; i< size; i++){ - var element = nodes.item(i); - //if the node is textNode, don't display - if(element.nodeType==1){ - str+= displayNode(element,level,checkForChildren(element)); - str+=treeTraversal(element, level+1); - } - } - return str; -} - -function displayNode(element, level, isLink){ - nodeContent = getNodeContent(element); - columns = Math.round((nodeContent.length / 12) + 0.5); - if (columns + level > maxColumns) { - maxColumns = columns + level; - } - var str ="<tr class='"+LEVEL+level+"'>"; - for (var i=0; i < level; i++) - str+= "<td> </td>"; - str+="<td colspan='"+ columns +"' class='box"+" boxlevel"+level+"' >"; - if(isLink){ - str+='<a onclick="hide(this);return false;" href="javascript:void();">'; - str+='<img src="'+MIN_SRC+'" />'; - } - str += nodeContent; - if(isLink) - str+="</a></td></tr>"; - return str; -} - -function getNodeContent(element) { - - str = ""; - id =""; - if (element.id != null && element.id != "") { - id = " ID(" + element.id +")"; - } - name =""; - if (element.name != null && element.name != "") { - name = " NAME(" + element.name + ")"; - } - value =""; - if (element.value != null && element.value != "") { - value = " VALUE(" + element.value + ")"; - } - href =""; - if (element.href != null && element.href != "") { - href = " HREF(" + element.href + ")"; - } - clazz = ""; - if (element.className != null && element.className != "") { - clazz = " CLASS(" + element.className + ")"; - } - src = ""; - if (element.src != null && element.src != "") { - src = " SRC(" + element.src + ")"; - } - alt = ""; - if (element.alt != null && element.alt != "") { - alt = " ALT(" + element.alt + ")"; - } - type = ""; - if (element.type != null && element.type != "") { - type = " TYPE(" + element.type + ")"; - } - text =""; - if (element.text != null && element.text != "" && element.text != "undefined") { - text = " #TEXT(" + trim(element.text) +")"; - } - str+=" <b>"+ element.nodeName + id + alt + type + clazz + name + value + href + src + text + "</b>"; - return str; - -} - -function trim(val) { - val2 = val.substring(0,40) + " "; - var spaceChr = String.fromCharCode(32); - var length = val2.length; - var retVal = ""; - var ix = length -1; - - while(ix > -1){ - if(val2.charAt(ix) == spaceChr) { - } else { - retVal = val2.substring(0, ix +1); - break; - } - ix = ix-1; - } - if (val.length > 40) { - retVal += "..."; - } - return retVal; -} - -function hide(hlink){ - var isHidden = false; - var image = hlink.firstChild; - if(image.src.toString().indexOf(MIN_SRC)!=-1){ - image.src=PLUS_SRC; - isHidden=true; - }else{ - image.src=MIN_SRC; - } - var rowObj= hlink.parentNode.parentNode; - var rowLevel = parseInt(rowObj.className.substring(LEVEL.length)); - - var sibling = rowObj.nextSibling; - var siblingLevel = sibling.className.substring(LEVEL.length); - if(siblingLevel.indexOf(HIDDEN)!=-1){ - siblingLevel = siblingLevel.substring(0,siblingLevel.length - HIDDEN.length-1); - } - siblingLevel=parseInt(siblingLevel); - while(sibling!=null && rowLevel<siblingLevel){ - if(isHidden){ - sibling.className += " "+ HIDDEN; - }else if(!isHidden && sibling.className.indexOf(HIDDEN)!=-1){ - var str = sibling.className; - sibling.className=str.substring(0, str.length - HIDDEN.length-1); - } - sibling = sibling.nextSibling; - siblingLevel = parseInt(sibling.className.substring(LEVEL.length)); - } -} - -function LOG(message) { - window.opener.LOG.warn(message); -} diff --git a/tests/FunctionalTests/selenium/core/selenium-logo.png b/tests/FunctionalTests/selenium/core/selenium-logo.png Binary files differdeleted file mode 100755 index 1de09290..00000000 --- a/tests/FunctionalTests/selenium/core/selenium-logo.png +++ /dev/null diff --git a/tests/FunctionalTests/tickets.php b/tests/FunctionalTests/tickets.php index 36511e73..ef8b52d6 100644 --- a/tests/FunctionalTests/tickets.php +++ b/tests/FunctionalTests/tickets.php @@ -1,8 +1,8 @@ <?php -require(dirname(__FILE__).'/PradoTester.php'); +require('../test_tools/functional_tests.php'); -$tester=new PradoTester(dirname(__FILE__).'/tickets/tests'); +$tester=new PradoFunctionalTester(dirname(__FILE__).'/tickets/tests'); $tester->run(new SimpleReporter()); ?>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/protected/pages/ClientScripTest.page b/tests/FunctionalTests/tickets/protected/pages/Ticket220.page index 8dbf7133..d5b6e182 100644 --- a/tests/FunctionalTests/features/protected/pages/ClientScripTest.page +++ b/tests/FunctionalTests/tickets/protected/pages/Ticket220.page @@ -1,13 +1,13 @@ <com:TContent ID="Content"> <h1>ClientScript Test</h1> - <com:TClientScript ScriptUrl=<%~ test.js %> ScriptPosition="Head"> + <com:TClientScript ScriptUrl=<%~ test.js %>> if(typeof(ClientScriptInfo) == "undefined") ClientScriptInfo = []; ClientScriptInfo.push("ok 3?") </com:TClientScript> - <com:TClientScript ScriptPosition="Begin"> + <com:TClientScript> if(typeof(ClientScriptInfo) == "undefined") ClientScriptInfo = []; ClientScriptInfo.push("ok 2!") @@ -16,12 +16,12 @@ <com:TLabel ID="label1" Text="Label 1" /> <input type="button" id="button1" value="update" /> - <com:TClientScript ScriptPosition="End" UsingPradoScripts="prado"> + <com:TClientScript UsingPradoScripts="prado"> Event.observe("button1", "click", function() { element = $("<%= $this->label1->ClientID %>"); if(element) - element.innerHTML = inspect(ClientScriptInfo); + element.innerHTML = "Label 1: "+inspect(ClientScriptInfo); else alert("failed"); }); diff --git a/tests/FunctionalTests/tickets/protected/pages/Ticket225.page b/tests/FunctionalTests/tickets/protected/pages/Ticket225.page new file mode 100644 index 00000000..362c4dce --- /dev/null +++ b/tests/FunctionalTests/tickets/protected/pages/Ticket225.page @@ -0,0 +1,14 @@ +<com:TContent ID="Content"> + <h1>RadioButton Group Tests</h1> + <com:TRadioButton ID="button1" Text="Button 1" GroupName="group1" /> + <com:TRadioButton ID="button2" Text="Button 2" GroupName="group1" /> + <com:TRadioButton ID="button3" Text="Button 3" GroupName="group1" /> + + <com:TRequiredFieldValidator id="validator1" + ControlToValidate="button1" + ErrorMessage="*" /> + + <com:TLabel ID="label1" Text="Label 1" /> + + <com:TButton ID="button4" Text="Show Groupings" OnClick="button4_Clicked" /> +</com:TContent>
\ No newline at end of file diff --git a/tests/FunctionalTests/tickets/protected/pages/Ticket225.php b/tests/FunctionalTests/tickets/protected/pages/Ticket225.php new file mode 100644 index 00000000..2cc3fc38 --- /dev/null +++ b/tests/FunctionalTests/tickets/protected/pages/Ticket225.php @@ -0,0 +1,19 @@ +<?php + +class Ticket225 extends TPage +{ + function button4_Clicked() + { + $this->label1->setText($this->getGroupIDs($this->button1)); + } + + private function getGroupIDs($radio) + { + $ids = ''; + foreach($radio->getRadioButtonsInGroup() as $control) + $ids .= " ".$control->getUniqueID(); + return $ids; + } +} + +?>
\ No newline at end of file diff --git a/tests/FunctionalTests/features/protected/pages/test.js b/tests/FunctionalTests/tickets/protected/pages/test.js index e8e80b19..e8e80b19 100644 --- a/tests/FunctionalTests/features/protected/pages/test.js +++ b/tests/FunctionalTests/tickets/protected/pages/test.js diff --git a/tests/FunctionalTests/tickets/tests/Ticket220TestCase.php b/tests/FunctionalTests/tickets/tests/Ticket220TestCase.php new file mode 100644 index 00000000..0753f732 --- /dev/null +++ b/tests/FunctionalTests/tickets/tests/Ticket220TestCase.php @@ -0,0 +1,18 @@ +<?php + +class Ticket220TestCase extends SeleniumTestCase +{ + function test() + { + $base="ctl0_Content_"; + $this->open('tickets/index.php?page=Ticket220'); + $this->assertTextPresent('ClientScript Test'); + $this->assertText("{$base}label1", "Label 1"); + + $this->click("button1"); + $this->assertText("{$base}label1", 'Label 1: ["ok", "ok 3?", "ok 2!"]'); + $this->assertAlertNotPresent(); + } +} + +?>
\ No newline at end of file diff --git a/tests/FunctionalTests/tickets/tests/Ticket225TestCase.php b/tests/FunctionalTests/tickets/tests/Ticket225TestCase.php new file mode 100644 index 00000000..966e8383 --- /dev/null +++ b/tests/FunctionalTests/tickets/tests/Ticket225TestCase.php @@ -0,0 +1,24 @@ +<?php + +class Ticket225TestCase extends SeleniumTestCase +{ + function test() + { + $base="ctl0_Content_"; + $this->open('tickets/index.php?page=Ticket225'); + $this->assertTextPresent('RadioButton Group Tests'); + $this->assertText("{$base}label1", "Label 1"); + + $this->assertNotVisible("{$base}validator1"); + $this->click("{$base}button4"); + $this->assertVisible("{$base}validator1"); + + $this->click("{$base}button2"); + $this->clickAndWait("{$base}button4"); + + $this->assertText("{$base}label1", 'ctl0$Content$button1 ctl0$Content$button2 ctl0$Content$button3'); + $this->assertNotVisible("{$base}validator1"); + } +} + +?>
\ No newline at end of file diff --git a/tests/FunctionalTests/validators.php b/tests/FunctionalTests/validators.php index c86604c8..521cca56 100644 --- a/tests/FunctionalTests/validators.php +++ b/tests/FunctionalTests/validators.php @@ -1,8 +1,8 @@ <?php -require(dirname(__FILE__).'/PradoTester.php'); +require('../test_tools/functional_tests.php'); -$tester=new PradoTester(dirname(__FILE__).'/validators/tests'); +$tester=new PradoFunctionalTester(dirname(__FILE__).'/validators/tests'); $tester->run(new SimpleReporter()); ?>
\ No newline at end of file diff --git a/tests/UnitTests/TODO.txt b/tests/UnitTests/TODO.txt deleted file mode 100644 index e96afb69..00000000 --- a/tests/UnitTests/TODO.txt +++ /dev/null @@ -1,5 +0,0 @@ -- test TPropertyValue
-- test TControl lifecycles with a Web page
-- test TControl state management with a Web page
-- test TControl adding and removing child controls with a Web page
-- test TControl::applyStyleSheetSkin() with a Web page
\ No newline at end of file diff --git a/tests/UnitTests/framework/Collections/utList.php b/tests/UnitTests/framework/Collections/utList.php deleted file mode 100644 index e95f718b..00000000 --- a/tests/UnitTests/framework/Collections/utList.php +++ /dev/null @@ -1,236 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-
-class ListItem
-{
- public $data='data';
-}
-
-class utList extends UnitTestCase
-{
- protected $list;
- protected $item1,$item2,$item3;
-
- public function setUp()
- {
- $this->list=new TList;
- $this->item1=new ListItem;
- $this->item2=new ListItem;
- $this->item3=new ListItem;
- $this->list->add($this->item1);
- $this->list->add($this->item2);
- }
-
- public function tearDown()
- {
- $this->list=null;
- $this->item1=null;
- $this->item2=null;
- $this->item3=null;
- }
-
- public function testConstruct()
- {
- $a=array(1,2,3);
- $list=new TList($a);
- $this->assertEqual(3,$list->getCount());
- $list2=new TList($this->list);
- $this->assertEqual(2,$list2->getCount());
- }
- public function testGetCount()
- {
- $this->assertEqual(2,$this->list->getCount());
- $this->assertEqual(2,$this->list->Count);
- }
-
- public function testAdd()
- {
- $this->list->add(null);
- $this->list->add($this->item3);
- $this->assertEqual(4,$this->list->getCount());
- $this->assertEqual(3,$this->list->indexOf($this->item3));
- }
-
-
- public function testInsertAt()
- {
- $this->list->insertAt(0,$this->item3);
- $this->assertEqual(3,$this->list->getCount());
- $this->assertEqual(2,$this->list->indexOf($this->item2));
- $this->assertEqual(0,$this->list->indexOf($this->item3));
- $this->assertEqual(1,$this->list->indexOf($this->item1));
- try
- {
- $this->list->insertAt(4,$this->item3);
- $this->fail('exception not raised when adding item at an out-of-range index');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- }
-
- public function testRemove()
- {
- $this->list->remove($this->item1);
- $this->assertEqual(1,$this->list->getCount());
- $this->assertEqual(-1,$this->list->indexOf($this->item1));
- $this->assertEqual(0,$this->list->indexOf($this->item2));
- try
- {
- $this->list->remove($this->item1);
- $this->fail('exception not raised when removing nonexisting item');
- }
- catch(Exception $e)
- {
- $this->pass();
- }
- }
-
- public function testRemoveAt()
- {
- $this->list->add($this->item3);
- $this->list->removeAt(1);
- $this->assertEqual(-1,$this->list->indexOf($this->item2));
- $this->assertEqual(1,$this->list->indexOf($this->item3));
- $this->assertEqual(0,$this->list->indexOf($this->item1));
- try
- {
- $this->list->removeAt(2);
- $this->fail('exception not raised when removing item with invalid index');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- }
-
- public function testClear()
- {
- $this->list->clear();
- $this->assertEqual(0,$this->list->getCount());
- $this->assertEqual(-1,$this->list->indexOf($this->item1));
- $this->assertEqual(-1,$this->list->indexOf($this->item2));
- }
-
- public function testContains()
- {
- $this->assertTrue($this->list->contains($this->item1));
- $this->assertTrue($this->list->contains($this->item2));
- $this->assertFalse($this->list->contains($this->item3));
- }
-
- public function testIndexOf()
- {
- $this->assertEqual(0,$this->list->indexOf($this->item1));
- $this->assertEqual(1,$this->list->indexOf($this->item2));
- $this->assertEqual(-1,$this->list->indexOf($this->item3));
- }
-
- public function testCopyFrom()
- {
- $array=array($this->item3,$this->item1);
- $this->list->copyFrom($array);
- $this->assertTrue(count($array)==2 && $this->list[0]===$this->item3 && $this->list[1]===$this->item1);
- try
- {
- $this->list->copyFrom($this);
- $this->fail('exception not raised when copying from non-traversable object');
- }
- catch(TInvalidDataTypeException $e)
- {
- $this->pass();
- }
- }
-
- public function testMergeWith()
- {
- $array=array($this->item3,$this->item1);
- $this->list->mergeWith($array);
- $this->assertTrue($this->list->getCount()==4 && $this->list[0]===$this->item1 && $this->list[3]===$this->item1);
- try
- {
- $this->list->mergeWith($this);
- $this->fail('exception not raised when copying from non-traversable object');
- }
- catch(TInvalidDataTypeException $e)
- {
- $this->pass();
- }
- }
-
- public function testToArray()
- {
- $array=$this->list->toArray();
- $this->assertTrue(count($array)==2 && $array[0]===$this->item1 && $array[1]===$this->item2);
- }
-
- public function testArrayRead()
- {
- $this->assertTrue($this->list[0]===$this->item1);
- $this->assertTrue($this->list[1]===$this->item2);
- try
- {
- $a=$this->list[2];
- $this->fail('exception not raised when accessing item with out-of-range index');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- }
-
- public function testArrayWrite()
- {
- $this->list[]=$this->item3;
- $this->assertTrue($this->list[2]===$this->item3 && $this->list->getCount()===3);
- $this->list[0]=$this->item3;
- $this->assertTrue($this->list[0]===$this->item3 && $this->list->getCount()===3 && $this->list->indexOf($this->item1)===-1);
- unset($this->list[1]);
- $this->assertTrue($this->list->getCount()===2 && $this->list->indexOf($this->item2)===-1);
- try
- {
- $this->list[5]=$this->item3;
- $this->fail('exception not raised when setting item at an out-of-range index');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- try
- {
- unset($this->list[5]);
- $this->fail('exception not raised when unsetting item at an out-of-range index');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- }
-
- public function testGetIterator()
- {
- $n=0;
- $found=0;
- foreach($this->list as $index=>$item)
- {
- foreach($this->list as $a=>$b); // test of iterator
- $n++;
- if($index===0 && $item===$this->item1)
- $found++;
- if($index===1 && $item===$this->item2)
- $found++;
- }
- $this->assertTrue($n==2 && $found==2);
- }
-
- public function testArrayMisc()
- {
- $this->assertEqual(1,count($this->list));
- $this->assertTrue(isset($this->list[1]));
- $this->assertFalse(isset($this->list[2]));
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Collections/utMap.php b/tests/UnitTests/framework/Collections/utMap.php deleted file mode 100644 index 37818542..00000000 --- a/tests/UnitTests/framework/Collections/utMap.php +++ /dev/null @@ -1,160 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-
-class MapItem
-{
- public $data='data';
-}
-
-class utMap extends UnitTestCase
-{
- protected $map;
- protected $item1,$item2,$item3;
-
- public function setUp()
- {
- $this->map=new TMap;
- $this->item1=new MapItem;
- $this->item2=new MapItem;
- $this->item3=new MapItem;
- $this->map->add('key1',$this->item1);
- $this->map->add('key2',$this->item2);
- }
-
- public function tearDown()
- {
- $this->map=null;
- $this->item1=null;
- $this->item2=null;
- $this->item3=null;
- }
-
- public function testConstruct()
- {
- $a=array(1,2,'key3'=>3);
- $map=new TMap($a);
- $this->assertEqual(3,$map->getCount());
- $map2=new TMap($this->map);
- $this->assertEqual(2,$map2->getCount());
- }
-
- public function testGetCount()
- {
- $this->assertEqual(2,$this->map->getCount());
- }
-
- public function testGetKeys()
- {
- $keys=$this->map->getKeys();
- $this->assertTrue(count($keys)===2 && $keys[0]==='key1' && $keys[1]==='key2');
- }
-
- public function testAdd()
- {
- $this->map->add('key3',$this->item3);
- $this->assertTrue($this->map->getCount()==3 && $this->map->contains('key3'));
- }
-
- public function testRemove()
- {
- $this->map->remove('key1');
- $this->assertTrue($this->map->getCount()==1 && !$this->map->contains('key1'));
- $this->assertTrue($this->map->remove('unknown key')===null);
- }
-
- public function testClear()
- {
- $this->map->clear();
- $this->assertTrue($this->map->getCount()==0 && !$this->map->contains('key1') && !$this->map->contains('key2'));
- }
-
- public function testContains()
- {
- $this->assertTrue($this->map->contains('key1'));
- $this->assertTrue($this->map->contains('key2'));
- $this->assertFalse($this->map->contains('key3'));
- }
-
- public function testCopyFrom()
- {
- $array=array('key3'=>$this->item3,'key4'=>$this->item1);
- $this->map->copyFrom($array);
- $this->assertTrue($this->map->getCount()==2 && $this->map['key3']===$this->item3 && $this->map['key4']===$this->item1);
- try
- {
- $this->map->copyFrom($this);
- $this->fail('no exception raised when copying a non-traversable object');
- }
- catch(TInvalidDataTypeException $e)
- {
- $this->pass();
- }
- }
-
- public function testMergeWith()
- {
- $array=array('key2'=>$this->item1,'key3'=>$this->item3);
- $this->map->mergeWith($array);
- $this->assertTrue($this->map->getCount()==3 && $this->map['key2']===$this->item1 && $this->map['key3']===$this->item3);
- try
- {
- $this->map->mergeWith($this);
- $this->fail('no exception raised when copying a non-traversable object');
- }
- catch(TInvalidDataTypeException $e)
- {
- $this->pass();
- }
- }
-
- public function testArrayRead()
- {
- $this->assertTrue($this->map['key1']===$this->item1);
- $this->assertTrue($this->map['key2']===$this->item2);
- $this->assertEqual(null,$this->map['key3']);
- }
-
- public function testArrayWrite()
- {
- $this->map['key3']=$this->item3;
- $this->assertTrue($this->map['key3']===$this->item3 && $this->map->getCount()===3);
- $this->map['key1']=$this->item3;
- $this->assertTrue($this->map['key1']===$this->item3 && $this->map->getCount()===3);
- unset($this->map['key2']);
- $this->assertTrue($this->map->getCount()===2 && !$this->map->contains('key2'));
- try
- {
- unset($this->map['unknown key']);
- $this->pass();
- }
- catch(Exception $e)
- {
- $this->fail('exception raised when unsetting element with unknown key');
- }
- }
-
- public function testArrayForeach()
- {
- $n=0;
- $found=0;
- foreach($this->map as $index=>$item)
- {
- $n++;
- if($index==='key1' && $item===$this->item1)
- $found++;
- if($index==='key2' && $item===$this->item2)
- $found++;
- }
- $this->assertTrue($n==2 && $found==2);
- }
-
- public function testArrayMisc()
- {
- $this->assertEqual(1,count($this->map));
- $this->assertTrue(isset($this->map['key1']));
- $this->assertFalse(isset($this->map['unknown key']));
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/CacheTestCase.php b/tests/UnitTests/framework/Data/CacheTestCase.php deleted file mode 100644 index 68a7b067..00000000 --- a/tests/UnitTests/framework/Data/CacheTestCase.php +++ /dev/null @@ -1,98 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-
-class CacheTestCase extends UnitTestCase
-{
- private $_cache;
-
- public function getCache()
- {
- return $this->_cache;
- }
-
- public function setCache($cache)
- {
- $this->_cache=$cache;
- }
-
- public function basicOperations()
- {
- $object=new TComponent;
- $number=12345;
- $string='12345\'"';
- $array=array('123'=>123,'abc'=>'def');
-
- // test set (first time)
- $this->assertFalse($this->_cache->get('object'));
- $this->assertTrue($this->_cache->set('object',$object));
- $this->assertTrue($this->_cache->get('object') instanceof TComponent);
- $this->assertFalse($this->_cache->get('number'));
- $this->assertTrue($this->_cache->set('number',$number));
- $this->assertTrue($this->_cache->get('number')===$number);
- $this->assertFalse($this->_cache->get('string'));
- $this->assertTrue($this->_cache->set('string',$string));
- $this->assertTrue($this->_cache->get('string')===$string);
- $this->assertFalse($this->_cache->get('array'));
- $this->assertTrue($this->_cache->set('array',$array));
- $this->assertTrue($this->_cache->get('array')===$array);
-
- // test set (second time)
- $this->assertTrue($this->_cache->set('object',$array));
- $this->assertTrue($this->_cache->get('object')===$array);
-
- // test delete
- $this->assertTrue($this->_cache->delete('object'));
- $this->assertFalse($this->_cache->get('object'));
- $this->assertTrue($this->_cache->delete('number'));
- $this->assertFalse($this->_cache->get('number'));
- $this->assertTrue($this->_cache->delete('string'));
- $this->assertFalse($this->_cache->get('string'));
- $this->assertTrue($this->_cache->delete('array'));
- $this->assertFalse($this->_cache->get('array'));
-
- // test add (first time)
- $this->assertFalse($this->_cache->get('object'));
- $this->assertTrue($this->_cache->add('object',$object));
- $this->assertTrue($this->_cache->get('object') instanceof TComponent);
- $this->assertFalse($this->_cache->get('number'));
- $this->assertTrue($this->_cache->add('number',$number));
- $this->assertTrue($this->_cache->get('number')===$number);
- $this->assertFalse($this->_cache->get('string'));
- $this->assertTrue($this->_cache->add('string',$string));
- $this->assertTrue($this->_cache->get('string')===$string);
- $this->assertFalse($this->_cache->get('array'));
- $this->assertTrue($this->_cache->add('array',$array));
- $this->assertTrue($this->_cache->get('array')===$array);
-
- // test add (second time)
- $this->assertFalse($this->_cache->add('object',$array));
- $this->assertTrue($this->_cache->get('object') instanceof TComponent);
-
- // test replace
- $this->assertTrue($this->_cache->replace('object',$array));
- $this->assertTrue($this->_cache->get('object')===$array);
- $this->assertFalse($this->_cache->replace('object2',$array));
- $this->assertFalse($this->_cache->get('object2'));
-
- // test flush
- $this->assertTrue($this->_cache->set('number',$number));
- $this->assertTrue($this->_cache->get('number')===$number);
- $this->assertTrue($this->_cache->flush());
- $this->assertFalse($this->_cache->get('number'));
-
- // test expiring
- // set a value with 5sec valid time
- $this->_cache->set('expiring',123,3);
- $this->assertTrue($this->_cache->get('expiring')===123);
- $this->_cache->set('nonexpiring',456);
- $this->assertTrue($this->_cache->get('nonexpiring')===456);
-
- // wait 6sec to see if the value still exists
- sleep(4);
- $this->assertFalse($this->_cache->get('expiring'));
- $this->assertTrue($this->_cache->get('nonexpiring')===456);
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/test.db b/tests/UnitTests/framework/Data/test.db Binary files differdeleted file mode 100644 index fcf08f16..00000000 --- a/tests/UnitTests/framework/Data/test.db +++ /dev/null diff --git a/tests/UnitTests/framework/Data/utAPCCache.php b/tests/UnitTests/framework/Data/utAPCCache.php deleted file mode 100644 index 48458c27..00000000 --- a/tests/UnitTests/framework/Data/utAPCCache.php +++ /dev/null @@ -1,45 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-require_once(dirname(__FILE__).'/CacheTestCase.php');
-Prado::using('System.Caching.TAPCCache');
-
-class utAPCCache extends CacheTestCase
-{
-
- public function testInit()
- {
- if(!extension_loaded('apc'))
- {
- $this->fail('TAPCCache is not tested. PHP extension "apc" is required by TAPCCache.');
- return;
- }
- //compatibility test as this time of writing 01/02/2006 (dd//mm//yyyy)
- $apc_default_ini = $apc_default=ini_get('apc.cache_by_default');
- if ($apc_default=='Off' || $apc_default='off')
- $apc_default=0;
- elseif($apc_default=='On' || $apc_default='on')
- $apc_default=1;
- $apc_default=(boolean)$apc_default;
- if($apc_default) {
- $this->fail('You have to disable apc.cache_by_default in your php.ini : you have apc.cache_by_default='.$apc_default_ini.' but currently prado won\'t execute without errors with APC caching all prado php files.');
- return;
- }
- }
-
- public function testBasicOperations()
- {
- if(!extension_loaded('apc'))
- {
- $this->fail('TAPCCache is not tested. PHP extension "apc" is required by TAPCCache.');
- return;
- }
- $cache=new TAPCCache;
- $cache->init(null);
- $this->setCache($cache);
- $this->basicOperations();
- $this->setCache(null);
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/utDateTimeSimpleFormatter.php b/tests/UnitTests/framework/Data/utDateTimeSimpleFormatter.php deleted file mode 100644 index 9c505481..00000000 --- a/tests/UnitTests/framework/Data/utDateTimeSimpleFormatter.php +++ /dev/null @@ -1,81 +0,0 @@ -<?php
-
-// NOTE: This file must be saved with charset GB2312
-require_once(dirname(__FILE__).'/../common.php');
-
-Prado::using('System.Util.TDateTimeSimpleFormatter');
-
-class utDateTimeSimpleFormatter extends UnitTestCase
-{
- function testFormatting()
- {
- $time = mktime(0,0,0,12,30,2005);
- $pattern = "dd-MM-yyyy";
- $expect = '30-12-2005';
-
- $formatter = new TDateTimeSimpleFormatter($pattern);
- $this->assertEqual($expect, $formatter->format($time));
-
- $time = mktime(0,0,0,5,6,2005);
- $pattern = "d-M-yy";
- $expect = "6-5-05";
-
- $formatter->setPattern($pattern);
- $this->assertEqual($expect, $formatter->format($time));
-
- $pattern = "dd-MM-yy";
- $expect = "06-05-05";
-
- $formatter->setPattern($pattern);
- $this->assertEqual($expect, $formatter->format($time));
-
- $pattern = "yyyyÄêMMÔÂddÈÕ";
- $expect = "2005Äê05ÔÂ06ÈÕ";
-
- $formatter = new TDateTimeSimpleFormatter($pattern, 'GB2312');
- $this->assertEqual($expect, $formatter->format($time));
-
- $pattern = "MM/dd/yyyy";
- $expect = "05/06/2005";
-
- $formatter = new TDateTimeSimpleFormatter($pattern, 'UTF-8');
- $this->assertEqual($expect, $formatter->format($time));
-
- }
-
- function testParsing()
- {
- $pattern = "yyyyÄêMMÔÂddÈÕ";
- $value = "2005Äê05ÔÂ06ÈÕ";
- $expect = mktime(0,0,0,5,6,2005);
-
- $formatter = new TDateTimeSimpleFormatter($pattern, 'GB2312');
- $this->assertEqual($expect, $formatter->parse($value));
-
- $pattern = "dd-MM-yy";
- $value= "06-05-05";
-
- $formatter = new TDateTimeSimpleFormatter($pattern);
- $this->assertEqual($expect, $formatter->parse($value));
-
- $pattern = "d-M-yy";
- $value = "6-5-05";
- $formatter = new TDateTimeSimpleFormatter($pattern);
- $this->assertEqual($expect, $formatter->parse($value));
-
- $pattern = "MM/dd/yyyy";
- $value = "05/06/2005";
- $formatter = new TDateTimeSimpleFormatter($pattern);
- $this->assertEqual($expect, $formatter->parse($value));
-
-
- $pattern = "dd-MM-yyyy";
- $value = '30-12-2005';
- $expect = mktime(0,0,0,12,30,2005);
-
- $formatter = new TDateTimeSimpleFormatter($pattern);
- $this->assertEqual($expect, $formatter->parse($value));
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/utMemCache.php b/tests/UnitTests/framework/Data/utMemCache.php deleted file mode 100644 index cbe9bdad..00000000 --- a/tests/UnitTests/framework/Data/utMemCache.php +++ /dev/null @@ -1,66 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-require_once(dirname(__FILE__).'/CacheTestCase.php');
-Prado::using('System.Caching.TMemCache');
-
-class utMemCache extends UnitTestCase
-{
- private $_prefix='';
- private $_server='localhost';
- private $_port=11211;
-
- public function testInit()
- {
- if(!extension_loaded('memcache'))
- {
- $this->fail('TMemCache is not tested. PHP extension "memcache" is required by TMemCache.');
- return;
- }
- $cache=new TMemCache;
-
- $this->assertTrue($cache->getHost()==='localhost');
- $cache->setHost('localhost2');
- $this->assertTrue($cache->getHost()==='localhost2');
-
- $this->assertTrue($cache->getPort()===11211);
- $cache->setPort(1000);
- $this->assertTrue($cache->getPort()===1000);
-
- $cache->init(null,null);
- try
- {
- $cache->setHost('newhost');
- $this->fail('exception not raised when setting Server after init');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- try
- {
- $cache->setPort(10000);
- $this->fail('exception not raised when setting Port after init');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testBasicOperations()
- {
- if(!extension_loaded('memcache'))
- {
- $this->fail('TMemCache is not tested. PHP extension "memcache" is required by TMemCache.');
- return;
- }
- $cache=new TMemCache;
- $cache->init(null,null);
- $this->setCache($cache);
- $this->basicOperations();
- $this->setCache(null);
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/utSqliteCache.php b/tests/UnitTests/framework/Data/utSqliteCache.php deleted file mode 100644 index eded351f..00000000 --- a/tests/UnitTests/framework/Data/utSqliteCache.php +++ /dev/null @@ -1,59 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-require_once(dirname(__FILE__).'/CacheTestCase.php');
-Prado::using('System.Caching.TSqliteCache');
-
-class utSqliteCache extends CacheTestCase
-{
- private $dbFile;
-
- public function __construct()
- {
- parent::__construct();
- if(Prado::getPathOfAlias('utSqliteCache')===null)
- Prado::setPathOfAlias('utSqliteCache',dirname(__FILE__));
- $this->dbFile='utSqliteCache.test';
- }
-
- public function tearDown()
- {
- $file=Prado::getPathOfNamespace('utSqliteCache.test',TSqliteCache::DB_FILE_EXT);
- if(is_file($file))
- unlink($file);
- else
- $this->fail("Unable to clean up db file: '".$file."'.");
- }
-
- public function testInit()
- {
- $cache=new TSqliteCache;
-
- $this->assertTrue($cache->getDbFile()===null);
- $cache->setDbFile($this->dbFile);
- $this->assertTrue($cache->getDbFile()===$this->dbFile);
-
- $cache->init(null,null);
- try
- {
- $cache->setDbFile('newfile.db');
- $this->fail('exception not raised when setting DbFile after init');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testBasicOperations()
- {
- $cache=new TSqliteCache;
- $cache->setDbFile($this->dbFile);
- $cache->init(null,null);
- $this->setCache($cache);
- $this->basicOperations();
- $this->setCache(null);
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/utXmlDocument.php b/tests/UnitTests/framework/Data/utXmlDocument.php deleted file mode 100644 index ec0e43c7..00000000 --- a/tests/UnitTests/framework/Data/utXmlDocument.php +++ /dev/null @@ -1,82 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../common.php');
-
-class utXmlDocument extends UnitTestCase
-{
- public function setUp()
- {
- }
-
- public function tearDown()
- {
- }
-
- public function testLoadAndSave()
- {
- $dir=dirname(__FILE__).'/xml';
-
- $doc=new TXmlDocument;
- try
- {
- $doc->loadFromFile('nonexisting.xml');
- $this->fail('exception not raised when openning a nonexistent file.');
- }
- catch(TIOException $e)
- {
- $this->pass();
- }
-
- $doc=new TXmlDocument;
- $this->assertFalse(@$doc->loadFromString('$12341'));
-
- // a regular XML file
- $doc=new TXmlDocument;
- $doc->loadFromFile($dir.'/data1.xml');
- $doc->saveToFile($dir.'/data1.xml.tmp');
- $this->assertTrue($this->compareFiles($dir.'/data1.xml.tmp',$dir.'/data1.xml.out'));
- @unlink($dir.'/data1.xml.tmp');
-
- // an XML file with Chinese characters
- $doc->loadFromFile($dir.'/data2.xml');
- $doc->saveToFile($dir.'/data2.xml.tmp');
- $this->assertTrue($this->compareFiles($dir.'/data2.xml.tmp',$dir.'/data2.xml.out'));
- @unlink($dir.'/data2.xml.tmp');
-
- // a typical Prado Application configuration file
- $doc=new TXmlDocument;
- $doc->loadFromFile($dir.'/data3.xml');
- $doc->saveToFile($dir.'/data3.xml.tmp');
- $this->assertTrue($this->compareFiles($dir.'/data3.xml.tmp',$dir.'/data3.xml.out'));
- @unlink($dir.'/data3.xml.tmp');
- }
-
- protected function compareFiles($file1,$file2)
- {
- return file_get_contents($file1)===file_get_contents($file2);
- }
-
- public function testAccessDomTree()
- {
- $dir=dirname(__FILE__).'/xml';
- $doc=new TXmlDocument;
- $doc->loadFromFile($dir.'/data1.xml');
- $this->assertTrue($doc->getVersion()==='1.0');
- $this->assertTrue($doc->getEncoding()==='utf-8');
- $this->assertTrue($doc->getElements()->getCount()===2);
- $this->assertTrue($doc->getElements()->itemAt(0)->getTagName()==='title');
- $this->assertTrue($doc->getElements()->itemAt(0)->getValue()==='My lists');
- $this->assertTrue($doc->getElements()->itemAt(1)->getTagName()==='chapter');
- $this->assertTrue($doc->getElements()->itemAt(1)->getAttribute('id')==='books');
- }
-
- public function testUpdateDomTree()
- {
- }
-
- public function testComposeDomTree()
- {
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/xml/data1.xml b/tests/UnitTests/framework/Data/xml/data1.xml deleted file mode 100644 index d865680a..00000000 --- a/tests/UnitTests/framework/Data/xml/data1.xml +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-]>
-<book id="listing">
- <title>My lists</title>
- <chapter id="books">
- <title>My books</title>
- <para>
- <informaltable>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Title</entry>
- <entry>Author</entry>
- <entry>Language</entry>
- <entry>ISBN</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>The Grapes of Wrath</entry>
- <entry>John Steinbeck</entry>
- <entry>en</entry>
- <entry>0140186409</entry>
- </row>
- <row>
- <entry>The Pearl</entry>
- <entry>John Steinbeck</entry>
- <entry>en</entry>
- <entry>014017737X</entry>
- </row>
- <row>
- <entry>Samarcande</entry>
- <entry>Amine Maalouf</entry>
- <entry>fr</entry>
- <entry>2253051209</entry>
- </row>
- <!-- TODO: I have a lot of remaining books to add.. -->
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </chapter>
-</book>
diff --git a/tests/UnitTests/framework/Data/xml/data1.xml.out b/tests/UnitTests/framework/Data/xml/data1.xml.out deleted file mode 100644 index de491e4c..00000000 --- a/tests/UnitTests/framework/Data/xml/data1.xml.out +++ /dev/null @@ -1,41 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<book id="listing"> - <title>My lists</title> - <chapter id="books"> - <title>My books</title> - <para> - <informaltable> - <tgroup cols="4"> - <thead> - <row> - <entry>Title</entry> - <entry>Author</entry> - <entry>Language</entry> - <entry>ISBN</entry> - </row> - </thead> - <tbody> - <row> - <entry>The Grapes of Wrath</entry> - <entry>John Steinbeck</entry> - <entry>en</entry> - <entry>0140186409</entry> - </row> - <row> - <entry>The Pearl</entry> - <entry>John Steinbeck</entry> - <entry>en</entry> - <entry>014017737X</entry> - </row> - <row> - <entry>Samarcande</entry> - <entry>Amine Maalouf</entry> - <entry>fr</entry> - <entry>2253051209</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </chapter> -</book>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/xml/data2.xml b/tests/UnitTests/framework/Data/xml/data2.xml deleted file mode 100644 index 9231ef7b..00000000 --- a/tests/UnitTests/framework/Data/xml/data2.xml +++ /dev/null @@ -1,41 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?>
-<book id="listing" title="我的书å•">
- <chapter id="books">
- <title>我的书</title>
- <para>
- <informaltable>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>æ ‡é¢˜</entry>
- <entry>作者</entry>
- <entry>è¯è¨€</entry>
- <entry>ISBN</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>The Grapes of Wrath</entry>
- <entry>John Steinbeck</entry>
- <entry>en</entry>
- <entry>0140186409</entry>
- </row>
- <row>
- <entry>The Pearl</entry>
- <entry>John Steinbeck</entry>
- <entry>en</entry>
- <entry>014017737X</entry>
- </row>
- <row>
- <entry>Samarcande</entry>
- <entry>Amine Maalouf</entry>
- <entry>fr</entry>
- <entry>2253051209</entry>
- </row>
- <!-- TODO: I have a lot of remaining books to add.. -->
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </chapter>
-</book>
diff --git a/tests/UnitTests/framework/Data/xml/data2.xml.out b/tests/UnitTests/framework/Data/xml/data2.xml.out deleted file mode 100644 index d688884c..00000000 --- a/tests/UnitTests/framework/Data/xml/data2.xml.out +++ /dev/null @@ -1,40 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<book id="listing" title="我的书å•"> - <chapter id="books"> - <title>我的书</title> - <para> - <informaltable> - <tgroup cols="4"> - <thead> - <row> - <entry>æ ‡é¢˜</entry> - <entry>作者</entry> - <entry>è¯è¨€</entry> - <entry>ISBN</entry> - </row> - </thead> - <tbody> - <row> - <entry>The Grapes of Wrath</entry> - <entry>John Steinbeck</entry> - <entry>en</entry> - <entry>0140186409</entry> - </row> - <row> - <entry>The Pearl</entry> - <entry>John Steinbeck</entry> - <entry>en</entry> - <entry>014017737X</entry> - </row> - <row> - <entry>Samarcande</entry> - <entry>Amine Maalouf</entry> - <entry>fr</entry> - <entry>2253051209</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </chapter> -</book>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Data/xml/data3.xml b/tests/UnitTests/framework/Data/xml/data3.xml deleted file mode 100644 index 5eaece3b..00000000 --- a/tests/UnitTests/framework/Data/xml/data3.xml +++ /dev/null @@ -1,46 +0,0 @@ -<?xml version="1.0"?>
-<application id="test">
- <modules>
- <module id="request" />
- <module id="response" />
- <module id="cache" type="System.Modules.TSqliteCache"
- DbFile="protected/cache.db" />
- <module id="error">
- <case id="exception" handler="processException" />
- <default handler="processHttpError" />
- </module>
- </modules>
- <services default="page">
- <service id="page" BasePath="protected/pages">
- <modules>
- <module id="template" type="System.Modules.TTemplateManager" />
- <module id="session" type="System.Modules.TSession" />
- </modules>
- <pages default="home">
- <page id="home" type="HomePage" />
- <page id="about" type="AboutPage" />
- </pages>
- <location path="users">
- <security>
- <allow page="register,login" />
- <deny page="profile" user="?" />
- <allow page="admin" role="admin" />
- <deny page="admin" />
- </security>
- <pages>
- <page id="register" type="RegisterPage" />
- <page id="login" type="LoginPage" />
- <page id="admin" type="AdminPage" />
- <page id="profile" type="ProfilePage" />
- </pages>
- </location>
- <parameters>
- </parameters>
- </service>
- <service id="asset" type="System.Services.TAssetService" />
- </services>
- <parameters>
- <parameter id="AdminEmail">qiang.xue@gmail.com</parameter>
- <parameter id="NetShow" type="Demo.NetShow" Host="localhost" />
- </parameters>
-</application>
diff --git a/tests/UnitTests/framework/Data/xml/data3.xml.out b/tests/UnitTests/framework/Data/xml/data3.xml.out deleted file mode 100644 index d46e65b9..00000000 --- a/tests/UnitTests/framework/Data/xml/data3.xml.out +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0"?> -<application id="test"> - <modules> - <module id="request" /> - <module id="response" /> - <module id="cache" type="System.Modules.TSqliteCache" DbFile="protected/cache.db" /> - <module id="error"> - <case id="exception" handler="processException" /> - <default handler="processHttpError" /> - </module> - </modules> - <services default="page"> - <service id="page" BasePath="protected/pages"> - <modules> - <module id="template" type="System.Modules.TTemplateManager" /> - <module id="session" type="System.Modules.TSession" /> - </modules> - <pages default="home"> - <page id="home" type="HomePage" /> - <page id="about" type="AboutPage" /> - </pages> - <location path="users"> - <security> - <allow page="register,login" /> - <deny page="profile" user="?" /> - <allow page="admin" role="admin" /> - <deny page="admin" /> - </security> - <pages> - <page id="register" type="RegisterPage" /> - <page id="login" type="LoginPage" /> - <page id="admin" type="AdminPage" /> - <page id="profile" type="ProfilePage" /> - </pages> - </location> - <parameters> - </parameters> - </service> - <service id="asset" type="System.Services.TAssetService" /> - </services> - <parameters> - <parameter id="AdminEmail">qiang.xue@gmail.com</parameter> - <parameter id="NetShow" type="Demo.NetShow" Host="localhost" /> - </parameters> -</application>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/TestOfDateTimeFormatInfo.php b/tests/UnitTests/framework/I18N/TestOfDateTimeFormatInfo.php deleted file mode 100644 index a2d78807..00000000 --- a/tests/UnitTests/framework/I18N/TestOfDateTimeFormatInfo.php +++ /dev/null @@ -1,223 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.DateTimeFormatInfo');
-
-class TestOfDateTimeFormatInfo extends UnitTestCase
-{
- protected $format;
-
- function TestOfDateTimeFormatInfo()
- {
- $this->UnitTestCase();
- }
-
- function setUp()
- {
- $this->format = DateTimeFormatInfo::getInstance('en');
- }
-
- function testAbbreviatedDayNames()
- {
- $names = $this->format->AbbreviatedDayNames;
- $this->assertTrue(is_array($names),'Must be an array!');
- $this->assertEqual(count($names),7,'Must have 7 day names');
-
- //assuming invariant culture.
- $days = array("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat");
- $this->assertEqual($names, $days);
-
- //try to set the data
- $data = array('Hel', 'wor');
- $this->format->AbbreviatedDayNames = $data;
- $newNames = $this->format->AbbreviatedDayNames;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
- }
-
- function testNarrowDayNames()
- {
- $names = $this->format->NarrowDayNames;
- $this->assertTrue(is_array($names),'Must be an array!');
- $this->assertEqual(count($names),7,'Must have 7 day names');
-
- //assuming invariant culture.
- $days = array("S", "M", "T", "W", "T", "F", "S");
- $this->assertEqual($names, $days);
-
- //try to set the data
- $data = array('H', 'w');
- $this->format->NarrowDayNames = $data;
- $newNames = $this->format->NarrowDayNames;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
- }
-
- function testDayNames()
- {
- $names = $this->format->DayNames;
- $this->assertTrue(is_array($names),'Must be an array!');
- $this->assertEqual(count($names),7,'Must have 7 day names');
-
- //assuming invariant culture.
- $days = array( "Sunday","Monday", "Tuesday", "Wednesday",
- "Thursday", "Friday", "Saturday");
- $this->assertEqual($names, $days);
-
- //try to set the data
- $data = array('Hello', 'world');
- $this->format->DayNames = $data;
- $newNames = $this->format->DayNames;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
- }
-
- function testMonthNames()
- {
- $names = $this->format->MonthNames;
- $this->assertTrue(is_array($names),'Must be an array!');
- $this->assertEqual(count($names),12,'Must have 12 month names');
-
- //assuming invariant culture.
- $days = array( "January", "February", "March", "April",
- "May", "June", "July", "August", "September",
- "October", "November", "December");
- $this->assertEqual($names, $days);
-
- //try to set the data
- $data = array('Hello', 'world');
- $this->format->MonthNames = $data;
- $newNames = $this->format->MonthNames;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
- }
-
- function testNarrowMonthNames()
- {
- $names = $this->format->NarrowMonthNames;
- $this->assertTrue(is_array($names),'Must be an array!');
- $this->assertEqual(count($names),12,'Must have 12 month names');
-
- //assuming invariant culture.
- $days = array( "J", "F", "M", "A", "M", "J", "J",
- "A", "S", "O", "N", "D");
- $this->assertEqual($names, $days);
-
- //try to set the data
- $data = array('Hello', 'world');
- $this->format->NarrowMonthNames = $data;
- $newNames = $this->format->NarrowMonthNames;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
- }
-
- function testAbbreviatedMonthNames()
- {
- $names = $this->format->AbbreviatedMonthNames;
- $this->assertTrue(is_array($names),'Must be an array!');
- $this->assertEqual(count($names),12,'Must have 12 month names');
-
- //assuming invariant culture.
- $days = array( "Jan", "Feb", "Mar", "Apr",
- "May", "Jun", "Jul", "Aug", "Sep",
- "Oct", "Nov", "Dec");
- $this->assertEqual($names, $days);
-
- //try to set the data
- $data = array('Hello', 'world');
- $this->format->AbbreviatedMonthNames = $data;
- $newNames = $this->format->AbbreviatedMonthNames;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
- }
-
- function testEra()
- {
- //era for invariant culture is assumed to have
- // 1 for AD and 0 for BC
- $this->assertEqual('AD', $this->format->getEra(1));
- $this->assertEqual('BC', $this->format->getEra(0));
- }
-
- function testAMPMMarkers()
- {
- $am_pm = array('AM','PM');
- $data = $this->format->AMPMMarkers;
- $this->assertTrue(is_array($data));
- $this->assertEqual($am_pm, $data);
- $this->assertEqual('AM', $this->format->AMDesignator);
- $this->assertEqual('PM', $this->format->PMDesignator);
-
- //try to set the data
- $data = array('Hello', 'world');
- $this->format->AMPMMarkers = $data;
- $newNames = $this->format->AMPMMarkers;
- $this->assertTrue(is_array($newNames),'Must be an array!');
- $this->assertEqual(count($newNames),2,'Must have 2 entries');
- $this->assertEqual($newNames, $data);
-
- $this->format->AMDesignator = 'TTTT';
- $this->assertEqual('TTTT',$this->format->AMDesignator);
-
- $this->format->PMDesignator = 'SSS';
- $this->assertEqual('SSS',$this->format->PMDesignator);
- }
-
- function testPatterns()
- {
- //patterns for invariant
- $patterns = array(
- 'FullTimePattern' => 'h:mm:ss a z',
- 'LongTimePattern' => 'h:mm:ss a z',
- 'MediumTimePattern' => 'h:mm:ss a',
- 'ShortTimePattern' => 'h:mm a',
- 'FullDatePattern' => 'EEEE, MMMM d, yyyy',
- 'LongDatePattern' => 'MMMM d, yyyy',
- 'MediumDatePattern' => 'MMM d, yyyy',
- 'ShortDatePattern' => 'M/d/yy',
- 'DateTimeOrderPattern' => '{1} {0}'
- );
-
- foreach($patterns as $property => $pattern)
- {
- $this->assertEqual($pattern, $this->format->$property);
- }
-
- $hello = 'Hello';
- $world = 'world';
- $expectedResult = $hello.' '.$world;
- $this->assertEqual($expectedResult,
- $this->format->formatDateTime($hello, $world));
- }
-
- function testInvariantInfo()
- {
- $format = DateTimeFormatInfo::getInstance();
-
- //the variant datetime format for medium date
- //should be the follow
- $pattern = 'MMM d, yyyy';
-
- $this->assertEqual($pattern, $format->MediumDatePattern);
-
- $invariant = $format->getInvariantInfo();
-
- $this->assertIdentical($format, $invariant);
- }
-
- function testGetInstance()
- {
- $format = DateTimeFormatInfo::getInstance('zh_CN');
-
- $pattern = 'yyyy-M-d';
- $this->assertEqual($pattern, $format->MediumDatePattern);
- }
-}
-
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/messages/en/tests.mo b/tests/UnitTests/framework/I18N/messages/en/tests.mo Binary files differdeleted file mode 100644 index ee243202..00000000 --- a/tests/UnitTests/framework/I18N/messages/en/tests.mo +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/en/tests.po b/tests/UnitTests/framework/I18N/messages/en/tests.po deleted file mode 100644 index 07860851..00000000 --- a/tests/UnitTests/framework/I18N/messages/en/tests.po +++ /dev/null @@ -1,18 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2005-01-09 14:11+1000\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\tests\n"
-
-msgid "Hello"
-msgstr "hello"
-
-msgid "Goodbye"
-msgstr "Sayonara"
-
diff --git a/tests/UnitTests/framework/I18N/messages/en/tests.xml b/tests/UnitTests/framework/I18N/messages/en/tests.xml deleted file mode 100644 index dbcd6831..00000000 --- a/tests/UnitTests/framework/I18N/messages/en/tests.xml +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: tests.xml,v 1.1 2005/01/09 22:15:32 weizhuo Exp $ -->
- <file source-language="EN" target-language="EN-AU" datatype="plaintext" original="articles.php" date="2002-01-25T21:06:01Z" product-name="Articles">
- <body>
- <trans-unit id="1">
- <source>Hello</source>
- <target>hello</target>
- </trans-unit>
- <trans-unit id="2">
- <source>Goodbye</source>
- <target>Sayonara</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
diff --git a/tests/UnitTests/framework/I18N/messages/en_AU/tests.mo b/tests/UnitTests/framework/I18N/messages/en_AU/tests.mo Binary files differdeleted file mode 100644 index a9a26db2..00000000 --- a/tests/UnitTests/framework/I18N/messages/en_AU/tests.mo +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/en_AU/tests.mo.bak b/tests/UnitTests/framework/I18N/messages/en_AU/tests.mo.bak Binary files differdeleted file mode 100644 index a9a26db2..00000000 --- a/tests/UnitTests/framework/I18N/messages/en_AU/tests.mo.bak +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/en_AU/tests.po b/tests/UnitTests/framework/I18N/messages/en_AU/tests.po deleted file mode 100644 index 9f81f650..00000000 --- a/tests/UnitTests/framework/I18N/messages/en_AU/tests.po +++ /dev/null @@ -1,15 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2004-12-25 12:25+1000\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\tests\n"
-
-msgid "Hello"
-msgstr "Howdy!"
-
diff --git a/tests/UnitTests/framework/I18N/messages/en_AU/tests.po.bak b/tests/UnitTests/framework/I18N/messages/en_AU/tests.po.bak deleted file mode 100644 index 9f81f650..00000000 --- a/tests/UnitTests/framework/I18N/messages/en_AU/tests.po.bak +++ /dev/null @@ -1,15 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2004-12-25 12:25+1000\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\tests\n"
-
-msgid "Hello"
-msgstr "Howdy!"
-
diff --git a/tests/UnitTests/framework/I18N/messages/en_AU/tests.xml b/tests/UnitTests/framework/I18N/messages/en_AU/tests.xml deleted file mode 100644 index 7ed84220..00000000 --- a/tests/UnitTests/framework/I18N/messages/en_AU/tests.xml +++ /dev/null @@ -1,13 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: tests.xml.bak,v 1.1 2005/01/09 22:15:33 weizhuo Exp $ -->
- <file source-language="EN" target-language="EN-AU" datatype="plaintext" original="articles.php" date="2002-01-25T21:06:01Z" product-name="Articles">
- <body>
- <trans-unit id="1">
- <source>Hello</source>
- <target>Howdy!</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
diff --git a/tests/UnitTests/framework/I18N/messages/en_AU/tests.xml.bak b/tests/UnitTests/framework/I18N/messages/en_AU/tests.xml.bak deleted file mode 100644 index 7ed84220..00000000 --- a/tests/UnitTests/framework/I18N/messages/en_AU/tests.xml.bak +++ /dev/null @@ -1,13 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: tests.xml.bak,v 1.1 2005/01/09 22:15:33 weizhuo Exp $ -->
- <file source-language="EN" target-language="EN-AU" datatype="plaintext" original="articles.php" date="2002-01-25T21:06:01Z" product-name="Articles">
- <body>
- <trans-unit id="1">
- <source>Hello</source>
- <target>Howdy!</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
diff --git a/tests/UnitTests/framework/I18N/messages/messages.db b/tests/UnitTests/framework/I18N/messages/messages.db Binary files differdeleted file mode 100644 index 73b518c5..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.db +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/messages.db.bak b/tests/UnitTests/framework/I18N/messages/messages.db.bak Binary files differdeleted file mode 100644 index 73b518c5..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.db.bak +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/messages.en.mo b/tests/UnitTests/framework/I18N/messages/messages.en.mo Binary files differdeleted file mode 100644 index db8838e3..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en.mo +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/messages.en.po b/tests/UnitTests/framework/I18N/messages/messages.en.po deleted file mode 100644 index 9299045c..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en.po +++ /dev/null @@ -1,15 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2004-12-25 12:26+1000\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\tests\n"
-
-msgid "Hello"
-msgstr "Hello :)"
-
diff --git a/tests/UnitTests/framework/I18N/messages/messages.en.xml b/tests/UnitTests/framework/I18N/messages/messages.en.xml deleted file mode 100644 index c3eb465b..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en.xml +++ /dev/null @@ -1,19 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: messages.en.xml,v 1.1 2004/12/28 09:28:07 weizhuo Exp $ -->
- <file
- source-language="EN"
- target-language="EN"
- datatype="plaintext"
- original="articles.php"
- date="2002-01-25T21:06:00Z"
- product-name="Articles">
- <body>
- <trans-unit id='1'>
- <source>Hello</source>
- <target>Hello :)</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/messages/messages.en_AU.mo b/tests/UnitTests/framework/I18N/messages/messages.en_AU.mo Binary files differdeleted file mode 100644 index f4822800..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en_AU.mo +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/messages.en_AU.mo.bak b/tests/UnitTests/framework/I18N/messages/messages.en_AU.mo.bak Binary files differdeleted file mode 100644 index f4822800..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en_AU.mo.bak +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/messages.en_AU.po b/tests/UnitTests/framework/I18N/messages/messages.en_AU.po deleted file mode 100644 index d795be2b..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en_AU.po +++ /dev/null @@ -1,18 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2005-01-09 14:02:25\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\ ests\n"
-
-msgid "Hello"
-msgstr "G'day Mate!"
-
-msgid "Welcome"
-msgstr "Welcome Mate!"
-
diff --git a/tests/UnitTests/framework/I18N/messages/messages.en_AU.po.bak b/tests/UnitTests/framework/I18N/messages/messages.en_AU.po.bak deleted file mode 100644 index d795be2b..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en_AU.po.bak +++ /dev/null @@ -1,18 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2005-01-09 14:02:25\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\ ests\n"
-
-msgid "Hello"
-msgstr "G'day Mate!"
-
-msgid "Welcome"
-msgstr "Welcome Mate!"
-
diff --git a/tests/UnitTests/framework/I18N/messages/messages.en_AU.xml b/tests/UnitTests/framework/I18N/messages/messages.en_AU.xml deleted file mode 100644 index cb4c4255..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en_AU.xml +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: messages.en_AU.xml.bak,v 1.1 2005/01/09 22:15:32 weizhuo Exp $ -->
- <file source-language="EN" target-language="EN-AU" datatype="plaintext" original="articles.php" date="2002-01-25T21:06:01Z" product-name="Articles">
- <body>
- <trans-unit id="1">
- <source>Hello</source>
- <target>G'day Mate!</target>
- </trans-unit>
- <trans-unit id="2">
- <source>Welcome</source>
- <target>Welcome Mate!</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
diff --git a/tests/UnitTests/framework/I18N/messages/messages.en_AU.xml.bak b/tests/UnitTests/framework/I18N/messages/messages.en_AU.xml.bak deleted file mode 100644 index cb4c4255..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.en_AU.xml.bak +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: messages.en_AU.xml.bak,v 1.1 2005/01/09 22:15:32 weizhuo Exp $ -->
- <file source-language="EN" target-language="EN-AU" datatype="plaintext" original="articles.php" date="2002-01-25T21:06:01Z" product-name="Articles">
- <body>
- <trans-unit id="1">
- <source>Hello</source>
- <target>G'day Mate!</target>
- </trans-unit>
- <trans-unit id="2">
- <source>Welcome</source>
- <target>Welcome Mate!</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
diff --git a/tests/UnitTests/framework/I18N/messages/messages.mo b/tests/UnitTests/framework/I18N/messages/messages.mo Binary files differdeleted file mode 100644 index 12cf1ff8..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.mo +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/messages.po b/tests/UnitTests/framework/I18N/messages/messages.po deleted file mode 100644 index ade60e01..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.po +++ /dev/null @@ -1,18 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2004-12-25 12:25+1000\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\tests\n"
-
-msgid "Hello"
-msgstr "Hello World"
-
-msgid "Welcome"
-msgstr "Welcome!"
-
diff --git a/tests/UnitTests/framework/I18N/messages/messages.xml b/tests/UnitTests/framework/I18N/messages/messages.xml deleted file mode 100644 index 5fe588b6..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: messages.xml,v 1.1 2004/12/28 09:28:07 weizhuo Exp $ -->
- <file
- source-language="EN"
- target-language="EN"
- datatype="plaintext"
- original="articles.php"
- date="2002-01-25T21:06:00Z"
- product-name="Articles">
- <body>
- <trans-unit id='1'>
- <source>Hello</source>
- <target>Hello World</target>
- </trans-unit>
- <trans-unit id='2'>
- <source>Welcome</source>
- <target>Welcome!</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/messages/messages_mysql.sql b/tests/UnitTests/framework/I18N/messages/messages_mysql.sql deleted file mode 100644 index 811010c4..00000000 --- a/tests/UnitTests/framework/I18N/messages/messages_mysql.sql +++ /dev/null @@ -1,69 +0,0 @@ -# phpMyAdmin SQL Dump
-# version 2.5.5-rc2
-# http://www.phpmyadmin.net
-#
-# Host: localhost
-# Generation Time: Jan 09, 2005 at 09:24 PM
-# Server version: 4.0.17
-# PHP Version: 5.0.2
-#
-# Database : `messages`
-#
-
-# --------------------------------------------------------
-
-#
-# Table structure for table `catalogue`
-#
-
-DROP TABLE IF EXISTS catalogue;
-CREATE TABLE catalogue (
- cat_id int(11) NOT NULL auto_increment,
- name varchar(100) NOT NULL default '',
- source_lang varchar(100) NOT NULL default '',
- target_lang varchar(100) NOT NULL default '',
- date_created int(11) NOT NULL default '0',
- date_modified int(11) NOT NULL default '0',
- author varchar(255) NOT NULL default '',
- PRIMARY KEY (cat_id)
-) TYPE=MyISAM AUTO_INCREMENT=7 ;
-
-
-INSERT INTO catalogue VALUES ('1', 'messages', '', '', '', '1103936017', '');
-INSERT INTO catalogue VALUES ('2', 'messages.en', '', '', '', '1103936017', '');
-INSERT INTO catalogue VALUES ('3', 'messages.en_AU', '', '', '', '1105250301', '');
-INSERT INTO catalogue VALUES ('4', 'tests', '', '', '', '1103936017', '');
-INSERT INTO catalogue VALUES ('5', 'tests.en', '', '', '', '1103936017', '');
-INSERT INTO catalogue VALUES ('6', 'tests.en_AU', '', '', '', '1103936017', '');
-
-# --------------------------------------------------------
-
-#
-# Table structure for table `trans_unit`
-#
-
-DROP TABLE IF EXISTS trans_unit;
-CREATE TABLE trans_unit (
- msg_id int(11) NOT NULL auto_increment,
- cat_id int(11) NOT NULL default '1',
- id varchar(255) NOT NULL default '',
- source text NOT NULL,
- target text NOT NULL,
- comments text NOT NULL,
- date_added int(11) NOT NULL default '0',
- date_modified int(11) NOT NULL default '0',
- author varchar(255) NOT NULL default '',
- translated tinyint(1) NOT NULL default '0',
- PRIMARY KEY (msg_id)
-) TYPE=MyISAM AUTO_INCREMENT=19 ;
-
-INSERT INTO trans_unit VALUES ('1', '1', '1', 'Hello', 'Hello World', '', '', '', '', '1');
-INSERT INTO trans_unit VALUES ('2', '2', '1', 'Hello', 'Hello :)', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('3', '1', '1', 'Welcome', 'Welcome!', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('4', '3', '1', 'Hello', 'G''day Mate!', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('5', '3', '2', 'Welcome', 'Welcome Mate!', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('13', '4', '1', 'Goodbye', 'Aloha!', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('14', '4', '2', 'Welcome', 'Ho Ho!', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('15', '5', '1', 'Hello', 'hello', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('16', '5', '2', 'Goodbye', 'Sayonara', '', '', '', '', '0');
-INSERT INTO trans_unit VALUES ('17', '6', '1', 'Hello', 'Howdy!', '', '', '', '', '0');
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/messages/tests.en_AU.po b/tests/UnitTests/framework/I18N/messages/tests.en_AU.po deleted file mode 100644 index fda7021d..00000000 --- a/tests/UnitTests/framework/I18N/messages/tests.en_AU.po +++ /dev/null @@ -1,7 +0,0 @@ -msgid ""
-msgstr ""
-"PO-Revision-Date: 2005-01-09 14:17:13\n"
-
-msgid "Testing123"
-msgstr ""
-
diff --git a/tests/UnitTests/framework/I18N/messages/tests.mo b/tests/UnitTests/framework/I18N/messages/tests.mo Binary files differdeleted file mode 100644 index 394b6196..00000000 --- a/tests/UnitTests/framework/I18N/messages/tests.mo +++ /dev/null diff --git a/tests/UnitTests/framework/I18N/messages/tests.po b/tests/UnitTests/framework/I18N/messages/tests.po deleted file mode 100644 index 4f5f3fbc..00000000 --- a/tests/UnitTests/framework/I18N/messages/tests.po +++ /dev/null @@ -1,18 +0,0 @@ -msgid ""
-msgstr ""
-"Project-Id-Version: I18N Tests\n"
-"POT-Creation-Date: \n"
-"PO-Revision-Date: 2005-01-09 14:07+1000\n"
-"Last-Translator: \n"
-"Language-Team: Wei Zhuo\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Poedit-Basepath: F:\\www\\prado\\framework\\I18N\\tests\n"
-
-msgid "Goodbye"
-msgstr "Aloha!"
-
-msgid "Welcome"
-msgstr "Ho Ho!"
-
diff --git a/tests/UnitTests/framework/I18N/messages/tests.xml b/tests/UnitTests/framework/I18N/messages/tests.xml deleted file mode 100644 index 73f404b1..00000000 --- a/tests/UnitTests/framework/I18N/messages/tests.xml +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version="1.0"?>
-<xliff version="1.0">
-<!-- @author $Author: weizhuo $ -->
-<!-- @version $Id: tests.xml,v 1.1 2005/01/09 22:15:32 weizhuo Exp $ -->
- <file source-language="EN" target-language="EN-AU" datatype="plaintext" original="articles.php" date="2002-01-25T21:06:01Z" product-name="Articles">
- <body>
- <trans-unit id="1">
- <source>Goodbye</source>
- <target>Aloha!</target>
- </trans-unit>
- <trans-unit id="2">
- <source>Welcome</source>
- <target>Ho Ho!</target>
- </trans-unit>
- </body>
- </file>
-</xliff>
diff --git a/tests/UnitTests/framework/I18N/testChoiceFormat.php b/tests/UnitTests/framework/I18N/testChoiceFormat.php deleted file mode 100644 index 8cc3f1d3..00000000 --- a/tests/UnitTests/framework/I18N/testChoiceFormat.php +++ /dev/null @@ -1,34 +0,0 @@ -<?php
-Prado::using('System.I18N.core.ChoiceFormat');
-
-class testChoiceFormat extends UnitTestCase
-{
- function testChoiceFormat()
- {
- $this->UnitTestCase();
- }
-
- function testChoices()
- {
- $choice = new ChoiceFormat();
- $string = '[0] are no files |[1] is one file |(1,Inf] are {number} files';
-
- $want = 'are no files';
- $this->assertEqual($want, $choice->format($string, 0));
-
- $want = 'is one file';
- $this->assertEqual($want, $choice->format($string, 1));
-
- $want = 'are {number} files';
- $this->assertEqual($want, $choice->format($string, 5));
-
- $this->assertFalse($choice->format($string, -1));
-
- $string = '{1,2} one two |{3,4} three four |[2,5] two to five inclusive';
- $this->assertEqual($choice->format($string,1),'one two');
- $this->assertEqual($choice->format($string,2.1),'two to five inclusive');
- $this->assertEqual($choice->format($string,3),'three four');
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testCultureInfo.php b/tests/UnitTests/framework/I18N/testCultureInfo.php deleted file mode 100644 index 7e204ede..00000000 --- a/tests/UnitTests/framework/I18N/testCultureInfo.php +++ /dev/null @@ -1,94 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.CultureInfo');
-
-class testCultureInfo extends UnitTestCase
-{
- protected $culture;
-
- function testCultureInfo()
- {
- $this->UnitTestCase();
- }
-
- function setUp()
- {
- $this->culture = CultureInfo::getInvariantCulture();
- }
-
- function testCultureName()
- {
- $name = 'en';
-
- $this->assertEqual($name, $this->culture->Name);
-
- //the default/invariant culture should be neutral
- $this->assertTrue($this->culture->IsNeutralCulture);
- }
-
- function testCultureList()
- {
- $allCultures = CultureInfo::getCultures();
- $neutralCultures = CultureInfo::getCultures(CultureInfo::NEUTRAL);
- $specificCultures = CultureInfo::getCultures(CultureInfo::SPECIFIC);
-
- //there should be 246 cultures all together.
- $this->assertEqual(count($allCultures),246);
- $this->assertEqual(count($neutralCultures),76);
- $this->assertEqual(count($specificCultures),170);
-
- }
-
- function testParentCultures()
- {
- $zh_CN = new CultureInfo('zh_CN');
- $parent = $zh_CN->Parent;
- $grandparent = $parent->Parent;
-
- $this->assertEqual($zh_CN->Name, 'zh_CN');
- $this->assertEqual($parent->Name, 'zh');
- $this->assertEqual($grandparent->Name, 'en');
- $this->assertEqual($grandparent->Parent->Name, 'en');
- }
-
- function testCountryNames()
- {
- $culture = new CultureInfo('fr_FR');
- $this->assertEqual($culture->Countries['AE'], 'Émirats arabes unis');
- }
-
- function testCurrencies()
- {
- $culture = new CultureInfo('en_AU');
- $au = array('$', 'Australian Dollar');
- $this->assertEqual($au, $culture->Currencies['AUD']);
- }
-
- function testLanguages()
- {
- $culture = new CultureInfo('fr_BE');
- $this->assertEqual($culture->Languages['fr'], 'français');
- }
-
- function testScripts()
- {
- $culture = new CultureInfo('fr');
- $this->assertEqual($culture->Scripts['Armn'], 'arménien');
- }
-
- function testTimeZones()
- {
- $culture = new CultureInfo('fi');
- $zone = array(
- "America/Los_Angeles",
- "Tyynenmeren normaaliaika",
- "PST",
- "Tyynenmeren kesäaika",
- "PDT",
- "Los Angeles");
- $this->assertEqual($culture->TimeZones[1],$zone);
- }
-
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testDateFormat.php b/tests/UnitTests/framework/I18N/testDateFormat.php deleted file mode 100644 index 7e4259d6..00000000 --- a/tests/UnitTests/framework/I18N/testDateFormat.php +++ /dev/null @@ -1,99 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.DateFormat');
-
-class testDateFormat extends UnitTestCase
-{
- function testDateFormat()
- {
- $this->UnitTestCase();
- }
-
- function testStandardPatterns()
- {
- $dateFormatter = new DateFormat();
-
- $time = @mktime(9, 9, 9, 9, 1, 2004);
- $zone = @date('T', $time);
- //var_dump(date('c',$time));
- //for ShortDatePattern "M/d/yy"
- $this->assertEqual('9/1/04', $dateFormatter->format($time, 'd'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'d'))));
-
- //for LongDatePattern "MMMM d, yyyy"
- $wants = 'September 1, 2004';
- $this->assertEqual($wants, $dateFormatter->format($time, 'D'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'D'))));
-
- //for Full date and time "MMMM d, yyyy h:mm a"
- $wants = 'September 1, 2004 9:09 AM';
- $this->assertEqual($wants, $dateFormatter->format($time, 'f'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'f'))));
-
- //for FullDateTimePattern "MMMM d, yyyy h:mm:ss a z"
- $wants = 'September 1, 2004 9:09:09 AM '.$zone;
- $this->assertEqual($wants, $dateFormatter->format($time, 'F'));
-
- //for General "M/d/yy h:mm a"
- $wants = '9/1/04 9:09 AM';
- $this->assertEqual($wants, $dateFormatter->format($time, 'g'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'g'))));
-
- //for General "M/d/yy h:mm:ss a z"
- $wants = '9/1/04 9:09:09 AM '.$zone;
- $this->assertEqual($wants, $dateFormatter->format($time, 'G'));
-
- //for MonthDayPattern "MMMM dd" (invariant)
- $wants = 'September 01';
- $this->assertEqual($wants, $dateFormatter->format($time, 'm'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'m'))));
-
- //for RFC1123Pattern "EEE, dd MMM yyyy HH:mm:ss" (invariant)
- $wants = 'Wed, 01 Sep 2004 09:09:09';
- $this->assertEqual($wants, $dateFormatter->format($time, 'r'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'r'))));
-
- //for SortableDateTimePattern "yyyy-MM-ddTHH:mm:ss" (invariant)
- $wants = '2004-09-01T09:09:09';
- $this->assertEqual($wants, $dateFormatter->format($time, 's'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'s'))));
-
- //for ShortTimePattern "H:mm a"
- $wants = '9:09 AM';
- $this->assertEqual($wants, $dateFormatter->format($time, 't'));
- //(date('c',strtotime($dateFormatter->format($time,'t'))));
-
- //for LongTimePattern "H:mm:ss a z"
- $wants = '9:09:09 AM '.$zone;
- $this->assertEqual($wants, $dateFormatter->format($time, 'T'));
-
- //for UniversalSortableDateTimePattern "yyyy-MM-dd HH:mm:ss z"
- //(invariant)
- $wants = '2004-09-01 09:09:09 '.$zone;
- $this->assertEqual($wants, $dateFormatter->format($time, 'u'));
-
- //for Full date and time "EEEE dd MMMM yyyy HH:mm:ss" (invariant)
- $wants = 'Wednesday 01 September 2004 09:09:09';
- $this->assertEqual($wants, $dateFormatter->format($time, 'U'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'U'))));
-
- //for YearMonthPattern "yyyy MMMM" (invariant)
- $wants = '2004 September';
- $this->assertEqual($wants, $dateFormatter->format($time, 'y'));
- //var_dump(date('c',strtotime($dateFormatter->format($time,'y'))));
- }
-
- function testCustomPatterns()
- {
- $dateFormatter = new DateFormat();
-
- $time = @mktime(9, 9, 9, 9, 1, 2004);
-
- $pattern = "'Hello' EEEE, 'it should be' MMM yyyy HH:mm:ss!!!";
- $wants = 'Hello Wednesday, it should be Sep 2004 09:09:09!!!';
- $this->assertEqual($wants, $dateFormatter->format($time, $pattern));
-
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testMessageFormat.php b/tests/UnitTests/framework/I18N/testMessageFormat.php deleted file mode 100644 index 74b6f23f..00000000 --- a/tests/UnitTests/framework/I18N/testMessageFormat.php +++ /dev/null @@ -1,13 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.MessageFormat');
-
-class testMessageFormat extends UnitTestCase
-{
- function testMessageFormat()
- {
- $this->UnitTestCase();
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testMessageFormat_SQLite.php b/tests/UnitTests/framework/I18N/testMessageFormat_SQLite.php deleted file mode 100644 index 5b75a0a7..00000000 --- a/tests/UnitTests/framework/I18N/testMessageFormat_SQLite.php +++ /dev/null @@ -1,142 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.MessageFormat');
-
-class testMessageFormat_SQLite extends UnitTestCase
-{
-
- protected $type = 'SQLite';
- protected $source = 'sqlite:///./messages/messages.db';
- protected $tmp;
- protected $dir;
-
- function testMessageFormat_SQLite()
- {
- $this->UnitTestCase();
- $this->dir = dirname(__FILE__);
- $this->tmp = $this->dir.'/tmp/';
- $this->source = "sqlite:///{$this->dir}/messages/messages.db";
-
- }
-
- function test1()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
- $this->assertEqual($formatter->format('Hello'),'G\'day Mate!');
-
- $this->assertEqual($formatter->format('Goodbye'), 'Goodbye');
-
- $formatter->setUntranslatedPS(array('[T]','[/T]'));
- $this->assertEqual($formatter->format('Hi'), '[T]Hi[/T]');
-
- $source->getCache()->clear();
-
- //save the untranslated
-
- }
-
- function getAllContents($file)
- {
- $db = sqlite_open($file);
- $rs = sqlite_query('SELECT * FROM trans_unit',$db);
- $result = '';
- while($row = sqlite_fetch_array($rs,SQLITE_NUM))
- {
- $result .= implode(', ',$row)."\n";
- }
- sqlite_close($db);
- return $result;
- }
-
- function testSaveUpdateDelete()
- {
- $backup = $this->dir.'/messages/messages.db.bak';
- $dbfile = $this->dir.'/messages/messages.db';
-
- //restore using the back file
- copy($backup,$dbfile);
-
- //test that the back file doesn't contain the 'Testing123' string.
- $contents = $this->getAllContents($dbfile);
- $this->assertNoUnwantedPattern('/Testing123/',$contents);
-
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
-
- $formatter->setUntranslatedPS(array('[t]','[/t]'));
-
- //add a untranslated string
- $this->assertEqual($formatter->format('Testing123'), '[t]Testing123[/t]');
-
- //save it
- $this->assertTrue($formatter->getSource()->save());
-
- //check the contents
- $contents = $this->getAllContents($dbfile);
- $this->assertWantedPattern('/Testing123/',$contents);
-
- //testing for update.
- $this->assertTrue($formatter->getSource()->update(
- 'Testing123', '123Test', 'update comments'));
-
- $contents = $this->getAllContents($dbfile);
- $this->assertWantedPattern('/123Test/',$contents);
- $this->assertWantedPattern('/update comments/',$contents);
-
- //var_dump(htmlspecialchars($contents));
-
- //now doing some delete
- //doesn't detect missing source
- $this->assertTrue($formatter->getSource()->delete('Test123'));
- $this->assertTrue($formatter->getSource()->delete('Testing123'));
-
- $contents = $this->getAllContents($dbfile);
- $this->assertNoUnwantedPattern('/Testing123/',$contents);
-
- //restore using the backup file.
- copy($backup,$dbfile);
- $source->getCache()->clear();
- }
-
- function testCatalogueList()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $result[] = array('messages',NULL);
- $result[] = array('messages', 'en');
- $result[] = array('messages','en_AU');
- $result[] = array('tests',NULL);
- $result[] = array('tests','en');
- $result[] = array('tests','en_AU');
-
- $this->assertEqual($result, $source->catalogues());
- }
-
- function testAltCatalogue()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
- $formatter->Catalogue = 'tests';
-
- //from a different catalogue
- $this->assertEqual($formatter->format('Hello'), 'Howdy!');
- $this->assertEqual($formatter->format('Welcome'), 'Ho Ho!');
- $this->assertEqual($formatter->format('Goodbye'), 'Sayonara');
-
- //switch to 'messages' catalogue
- $this->assertEqual($formatter->format('Hello',null,'messages'),'G\'day Mate!');
-
- $source->getCache()->clear();
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testMessageFormat_XLIFF.php b/tests/UnitTests/framework/I18N/testMessageFormat_XLIFF.php deleted file mode 100644 index 4072c4ce..00000000 --- a/tests/UnitTests/framework/I18N/testMessageFormat_XLIFF.php +++ /dev/null @@ -1,174 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.MessageFormat');
-
-class testMessageFormat_XLIFF extends UnitTestCase
-{
- protected $type = 'XLIFF';
- protected $source = './messages';
- protected $tmp;
- protected $dir;
-
- function testMessageFormat_XLIFF()
- {
- $this->UnitTestCase();
- $this->dir = dirname(__FILE__);
- $this->tmp = $this->dir.'/tmp/';
- $this->source = $this->dir.'/messages';
-
- }
-
- function test1()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
- $this->assertEqual($formatter->format('Hello'),'G\'day Mate!');
-
- $this->assertEqual($formatter->format('Goodbye'), 'Goodbye');
-
- $formatter->setUntranslatedPS(array('[T]','[/T]'));
- $this->assertEqual($formatter->format('Hi'), '[T]Hi[/T]');
-
- //clear cache
- $source->getCache()->clear();
-
- }
-
- function testSaveUpdateDelete()
- {
- $backup = $this->dir.'/messages/messages.en_AU.xml.bak';
- $xmlfile = $this->dir.'/messages/messages.en_AU.xml';
-
- //restore using the back file
- copy($backup,$xmlfile);
-
- //test that the back file doesn't contain the 'Testing123' string.
- $contents = file_get_contents($xmlfile);
- $this->assertNoUnwantedPattern('/Testing123/',$contents);
-
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
-
- //add a untranslated string
- $this->assertEqual($formatter->format('Testing123'), 'Testing123');
-
- //save it
- $this->assertTrue($formatter->getSource()->save());
-
- //check the contents
- $contents = file_get_contents($xmlfile);
- $this->assertWantedPattern('/Testing123/',$contents);
-
- //testing for update.
- $this->assertTrue($formatter->getSource()->update(
- 'Testing123', '123Test', 'update comments'));
-
- $contents = file_get_contents($xmlfile);
- $this->assertWantedPattern('/123Test/',$contents);
- $this->assertWantedPattern('/update comments/',$contents);
-
- //var_dump(htmlspecialchars($contents));
-
- //now doing some delete
- $this->assertFalse($formatter->getSource()->delete('Test123'));
- $this->assertTrue($formatter->getSource()->delete('Testing123'));
-
- $contents = file_get_contents($xmlfile);
- $this->assertNoUnwantedPattern('/Testing123/',$contents);
-
- //restore using the backup file.
- copy($backup,$xmlfile);
-
- $source->getCache()->clear();
- }
-
- function testCatalogueList()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $result[] = array('messages',NULL);
- $result[] = array('messages', 'en');
- $result[] = array('messages','en_AU');
- $result[] = array('tests',NULL);
- $result[] = array('tests','en');
- $result[] = array('tests','en_AU');
-
- $this->assertEqual($result, $source->catalogues());
- }
-
- function testAltCatalogue()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
- $formatter->Catalogue = 'tests';
-
- //from a different catalogue
- $this->assertEqual($formatter->format('Hello'), 'Howdy!');
- $this->assertEqual($formatter->format('Welcome'), 'Ho Ho!');
- $this->assertEqual($formatter->format('Goodbye'), 'Sayonara');
-
- //switch to 'messages' catalogue
- $this->assertEqual($formatter->format('Hello',null,'messages'),'G\'day Mate!');
-
- $source->getCache()->clear();
- }
-
- function testDirectoryTypeSaveUpdateDelete()
- {
- $backup = $this->dir.'/messages/en_AU/tests.xml.bak';
- $xmlfile = $this->dir.'/messages/en_AU/tests.xml';
-
- //restore using the back file
- copy($backup,$xmlfile);
-
- //test that the back file doesn't contain the 'Testing123' string.
- $contents = file_get_contents($xmlfile);
- $this->assertNoUnwantedPattern('/Testing123/',$contents);
-
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
-
- //add a untranslated string, note, doesn't matter which catalogue
- $this->assertEqual($formatter->format('Testing123'), 'Testing123');
-
- //save it to the 'tests' catalgoue
- $this->assertTrue($formatter->getSource()->save('tests'));
-
- //check the contents
- $contents = file_get_contents($xmlfile);
- $this->assertWantedPattern('/Testing123/',$contents);
-
- //testing for update. Update it to the 'tests' catalogue
- $this->assertTrue($formatter->getSource()->update(
- 'Testing123', '123Test', 'update comments','tests'));
-
- $contents = file_get_contents($xmlfile);
- $this->assertWantedPattern('/123Test/',$contents);
- $this->assertWantedPattern('/update comments/',$contents);
-
- //now doing some delete from the 'tests' catalogue
- $this->assertFalse($formatter->getSource()->delete('Test123','tests'));
- $this->assertTrue($formatter->getSource()->delete('Testing123','tests'));
-
- $contents = file_get_contents($xmlfile);
- $this->assertNoUnwantedPattern('/Testing123/',$contents);
-
- //restore using the backup file.
- copy($backup,$xmlfile);
-
- $source->getCache()->clear();
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testMessageFormat_gettext.php b/tests/UnitTests/framework/I18N/testMessageFormat_gettext.php deleted file mode 100644 index 6fa00e80..00000000 --- a/tests/UnitTests/framework/I18N/testMessageFormat_gettext.php +++ /dev/null @@ -1,176 +0,0 @@ -<?php
-
-Prado::using('System.I18N.core.MessageFormat');
-
-class testMessageFormat_gettext extends UnitTestCase
-{
- protected $type = 'gettext';
- protected $source;
- protected $tmp;
- protected $dir;
-
- function testMessageFormat_gettext()
- {
- $this->UnitTestCase();
- $this->dir = dirname(__FILE__);
- $this->tmp = $this->dir.'/tmp/';
- $this->source = $this->dir.'/messages';
- }
-
- function test1()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
- $this->assertEqual($formatter->format('Hello'),'G\'day Mate!');
-
- $this->assertEqual($formatter->format('Goodbye'), 'Goodbye');
-
- $formatter->setUntranslatedPS(array('[T]','[/T]'));
- $this->assertEqual($formatter->format('Hi'), '[T]Hi[/T]');
-
- $source->getCache()->clear();
- }
-
- function testSaveUpdateDelete()
- {
- $MObackup = $this->dir.'/messages/messages.en_AU.mo.bak';
- $MOfile = $this->dir.'/messages/messages.en_AU.mo';
- $PObackup = $this->dir.'/messages/messages.en_AU.po.bak';
- $POfile = $this->dir.'/messages/messages.en_AU.po';
-
- //restore using the back file
- copy($MObackup,$MOfile);
- copy($PObackup,$POfile);
-
- //test that the back file doesn't contain the 'Testing123' string.
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($MOfile));
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($POfile));
-
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
-
- //add a untranslated string
- $this->assertEqual($formatter->format('Testing123'), 'Testing123');
-
- //save it
- $this->assertTrue($formatter->getSource()->save());
-
- //check the contents
- //$this->assertWantedPattern('/Testing123/',file_get_contents($MOfile));
- $this->assertWantedPattern('/Testing123/',file_get_contents($POfile));
-
- //testing for update.
- $this->assertTrue($formatter->getSource()->update(
- 'Testing123', '123Test', 'update comments'));
-
- $this->assertWantedPattern('/123Test/',file_get_contents($MOfile));
-
-
- //var_dump(htmlspecialchars($contents));
-
- //now doing some delete
- $this->assertFalse($formatter->getSource()->delete('Test123'));
- $this->assertTrue($formatter->getSource()->delete('Testing123'));
-
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($MOfile));
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($POfile));
-
- //restore using the backup file.
- copy($MObackup,$MOfile);
- copy($PObackup,$POfile);
-
- $source->getCache()->clear();
- }
-
- function testCatalogueList()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $result[] = array('messages',NULL);
- $result[] = array('messages', 'en');
- $result[] = array('messages','en_AU');
- $result[] = array('tests',NULL);
- $result[] = array('tests','en');
- $result[] = array('tests','en_AU');
-
- $this->assertEqual($result, $source->catalogues());
- }
-
- function testAltCatalogue()
- {
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
- $formatter->Catalogue = 'tests';
-
- //from a different catalogue
- $this->assertEqual($formatter->format('Hello'), 'Howdy!');
- $this->assertEqual($formatter->format('Welcome'), 'Ho Ho!');
- $this->assertEqual($formatter->format('Goodbye'), 'Sayonara');
-
- //switch to 'messages' catalogue
- $this->assertEqual($formatter->format('Hello',null,'messages'),'G\'day Mate!');
-
- $source->getCache()->clear();
- }
-
- function testDirectoryTypeSaveUpdateDelete()
- {
- $MObackup = $this->dir.'/messages/en_AU/tests.mo.bak';
- $MOfile = $this->dir.'/messages/en_AU/tests.mo';
- $PObackup = $this->dir.'/messages/en_AU/tests.po.bak';
- $POfile = $this->dir.'/messages/en_AU/tests.po';
-
- //restore using the back file
- copy($MObackup,$MOfile);
- copy($PObackup,$POfile);
-
- //test that the back file doesn't contain the 'Testing123' string.
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($MOfile));
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($POfile));
-
- $source = MessageSource::factory($this->type, $this->source);
- $source->setCulture('en_AU');
- $source->setCache(new MessageCache($this->tmp));
-
- $formatter = new MessageFormat($source);
-
- //add a untranslated string, note, doesn't matter which catalogue
- $this->assertEqual($formatter->format('Testing123'), 'Testing123');
-
- //save it to the 'tests' catalgoue
- $this->assertTrue($formatter->getSource()->save('tests'));
-
- //check the contents
- //$this->assertWantedPattern('/Testing123/',file_get_contents($MOfile));
- $this->assertWantedPattern('/Testing123/',file_get_contents($POfile));
-
- //testing for update. Update it to the 'tests' catalogue
- $this->assertTrue($formatter->getSource()->update(
- 'Testing123', '123Test', 'update comments','tests'));
-
- $this->assertWantedPattern('/123Test/',file_get_contents($MOfile));
-
- //now doing some delete from the 'tests' catalogue
- $this->assertFalse($formatter->getSource()->delete('Test123','tests'));
- $this->assertTrue($formatter->getSource()->delete('Testing123','tests'));
-
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($MOfile));
- $this->assertNoUnwantedPattern('/Testing123/',file_get_contents($POfile));
-
- //restore using the backup file.
- copy($MObackup,$MOfile);
- copy($PObackup,$POfile);
-
- $source->getCache()->clear();
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testNumberFormat.php b/tests/UnitTests/framework/I18N/testNumberFormat.php deleted file mode 100644 index 48342d9c..00000000 --- a/tests/UnitTests/framework/I18N/testNumberFormat.php +++ /dev/null @@ -1,113 +0,0 @@ -<?php
-
-//NOTE: This page require UTF-8 aware editors
-
-Prado::using('System.I18N.core.NumberFormat');
-
-class testNumberFormat extends UnitTestCase
-{
- function testNumberFormat()
- {
- $this->UnitTestCase();
- }
-
- function testDefaultFormats()
- {
- $formatter = new NumberFormat();
- $number = '123456789.125156';
- $wanted = '123,456,789.125156';
- $this->assertEqual($wanted, $formatter->format($number));
-
- //currency
- $wanted = 'US$123,456,789.13';
- $this->assertEqual($wanted, $formatter->format($number,'c'));
- }
-
- function testLocalizedCurrencyFormats()
- {
- $fr = new NumberFormat('fr');
- $de = new NumberFormat('de');
- $ja = new NumberFormat('ja_JP');
-
- $number = '123456789.125156';
-
- //french
- $wanted = '123Â 456Â 789,13 F';
- $this->assertEqual($wanted, $fr->format($number,'c','FRF'));
-
- //german
- $wanted = 'DES 123.456.789,13';
- $this->assertEqual($wanted, $de->format($number,'c','DES'));
-
- //japanese
- $wanted = 'ï¿¥123,456,789';
- $this->assertEqual($wanted, $ja->format($number,'c','JPY'));
-
- //custom/unkown currency
- $wanted = 'DLL123,456,789';
- $this->assertEqual($wanted, $ja->format($number,'c','DLL'));
- }
-
- function testCustomFormat()
- {
- $formatter = new NumberFormat();
- $number = '123456789.125156';
-
- //primay and secondary grouping test
- $pattern = '#,###,##.###';
- $wanted = '1,234,567,89.125156';
- $this->assertEqual($wanted, $formatter->format($number, $pattern));
-
- //4 digits grouping test
- $pattern = '#,####.###';
- $wanted = '1,2345,6789.125156';
- $this->assertEqual($wanted, $formatter->format($number, $pattern));
-
- //custom percentage
- $pattern = '#,###.00%';
- $wanted = '123,456,789.13%';
- $this->assertEqual($wanted, $formatter->format($number, $pattern));
- }
-
- function testPercentageFormat()
- {
- $formatter = new NumberFormat();
- $number = '0.125156';
- $wanted = '12%';
- $this->assertEqual($wanted, $formatter->format($number, 'p'));
- }
-
- function testQuotes()
- {
- $formatter = new NumberFormat();
- $number = '123456789.125156';
-
- $pattern = "# o'clock";
- $wanted = "123456789 o'clock";
- $this->assertEqual($wanted, $formatter->format($number, $pattern));
-
- }
-
- function testPadding()
- {
- $formatter = new NumberFormat();
- $number = '5';
-
- $pattern = '0000';
- $wanted = '0005';
-
- //this should fail!!!
- $this->assertEqual($wanted, $formatter->format($number, $pattern));
- }
-
- function testNegativeValue()
- {
- $formatter = new NumberFormat();
- $number = "-1.2";
-
- $wanted = "-1.2";
- $this->assertEqual($wanted, $formatter->format($number));
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/testNumberFormatInfo.php b/tests/UnitTests/framework/I18N/testNumberFormatInfo.php deleted file mode 100644 index 0b0a3140..00000000 --- a/tests/UnitTests/framework/I18N/testNumberFormatInfo.php +++ /dev/null @@ -1,105 +0,0 @@ -<?php
-
-//NOTE: This page require UTF-8 aware editors
-
-Prado::using('System.I18N.core.NumberFormatInfo');
-
-class testNumberFormatInfo extends UnitTestCase
-{
- function testNumberFormatInfo()
- {
- $this->UnitTestCase();
- }
-
- function testCurrencyPatterns()
- {
- $numberInfo = NumberFormatInfo::getCurrencyInstance();
-
- //there should be 2 decimal places.
- $this->assertEqual($numberInfo->DecimalDigits,2);
-
- $this->assertEqual($numberInfo->DecimalSeparator,'.');
-
- $this->assertEqual($numberInfo->GroupSeparator,',');
-
- //there should be only 1 grouping of size 3
- $groupsize = array(3,false);
- $this->assertEqual($numberInfo->GroupSizes, $groupsize);
-
- //the default negative pattern prefix and postfix
- $negPattern = array('-¤','');
- $this->assertEqual($numberInfo->NegativePattern, $negPattern);
-
- //the default positive pattern prefix and postfix
- $negPattern = array('¤','');
- $this->assertEqual($numberInfo->PositivePattern, $negPattern);
-
- //the default currency symbol
- $this->assertEqual($numberInfo->CurrencySymbol, 'US$');
-
- $this->assertEqual($numberInfo->getCurrencySymbol('JPY'), 'Â¥');
-
- $this->assertEqual($numberInfo->NegativeInfinitySymbol, '-∞');
-
- $this->assertEqual($numberInfo->PositiveInfinitySymbol, '+∞');
-
- $this->assertEqual($numberInfo->NegativeSign, '-');
-
- $this->assertEqual($numberInfo->PositiveSign, '+');
-
- $this->assertEqual($numberInfo->NaNSymbol, '�');
-
- $this->assertEqual($numberInfo->PercentSymbol, '%');
-
- $this->assertEqual($numberInfo->PerMilleSymbol, '‰');
-
- }
-
- function testPatternsSet()
- {
- $numberInfo = NumberFormatInfo::getInstance();
-
- $numberInfo->DecimalDigits = 0;
- $this->assertEqual($numberInfo->DecimalDigits,0);
-
- $numberInfo->DecimalSeparator = ',';
- $this->assertEqual($numberInfo->DecimalSeparator,',');
-
- $numberInfo->GroupSeparator = ' ';
- $this->assertEqual($numberInfo->GroupSeparator,' ');
-
- $numberInfo->GroupSizes = array(2,3);
- $groupsize = array(2,3);
- $this->assertEqual($numberInfo->GroupSizes, $groupsize);
-
- $numberInfo->NegativePattern = array('-$$','.');
- $negPattern = array('-$$','.');
- $this->assertEqual($numberInfo->NegativePattern, $negPattern);
-
- $numberInfo->PositivePattern = array('YY','.');
- $negPattern = array('YY','.');
- $this->assertEqual($numberInfo->PositivePattern, $negPattern);
-
- //the default CurrencySymbol symbol
- $numberInfo->CurrencySymbol = '$$$';
- $this->assertEqual($numberInfo->CurrencySymbol, '$$$');
- }
-
- function testLocalizedPatterns()
- {
- $fr = NumberFormatInfo::getInstance('fr');
- $de = NumberFormatInfo::getInstance('de');
- $en = NumberFormatInfo::getInstance('en_US');
-
- $this->assertEqual($fr->DecimalSeparator, ',');
- $this->assertEqual($de->DecimalSeparator, ',');
- $this->assertEqual($en->DecimalSeparator, '.');
-
- $this->assertEqual($fr->GroupSeparator, 'Â ');
- $this->assertEqual($de->GroupSeparator, '.');
- $this->assertEqual($en->GroupSeparator, ',');
- }
-
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/I18N/tmp/cache.txt b/tests/UnitTests/framework/I18N/tmp/cache.txt deleted file mode 100644 index e69de29b..00000000 --- a/tests/UnitTests/framework/I18N/tmp/cache.txt +++ /dev/null diff --git a/tests/UnitTests/framework/TestSystem/protected/application.xml b/tests/UnitTests/framework/TestSystem/protected/application.xml deleted file mode 100644 index 38bfff9e..00000000 --- a/tests/UnitTests/framework/TestSystem/protected/application.xml +++ /dev/null @@ -1,21 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?>
-
-<configuration>
- <paths>
- <alias id="Test" path="pages" />
- <using namespace="Test" />
- </paths>
- <modules>
- <module id="request" />
- <module id="cache" type="System.Caching.TSqliteCache" DbFile="TestSystem/protected/data/test.db" />
- </modules>
- <services>
- <service id="page" BasePath="TestSystem/protected/pages" />
- </services>
- <parameters>
- <parameter id="param1">value 1</parameter>
- <parameter id="param2"></parameter>
- <parameter id="param3" type="System.TComponent" />
- <parameter id="param4" type="TComponent" />
- </parameters>
-</configuration>
\ No newline at end of file diff --git a/tests/UnitTests/framework/TestSystem/protected/data/test.db b/tests/UnitTests/framework/TestSystem/protected/data/test.db Binary files differdeleted file mode 100644 index 9bc20c39..00000000 --- a/tests/UnitTests/framework/TestSystem/protected/data/test.db +++ /dev/null diff --git a/tests/UnitTests/framework/TestSystem/protected/pages/config.xml b/tests/UnitTests/framework/TestSystem/protected/pages/config.xml deleted file mode 100644 index 6a49df82..00000000 --- a/tests/UnitTests/framework/TestSystem/protected/pages/config.xml +++ /dev/null @@ -1,12 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?>
-
-<configuration>
- <pages>
- </pages>
- <parameters>
- <parameter id="param1">value 1</parameter>
- <parameter id="param2"></parameter>
- <parameter id="param3" type="System.TComponent" />
- <parameter id="param4" type="TComponent" />
- </parameters>
-</configuration>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Web/UI/utControl.php b/tests/UnitTests/framework/Web/UI/utControl.php deleted file mode 100644 index ed2ddd22..00000000 --- a/tests/UnitTests/framework/Web/UI/utControl.php +++ /dev/null @@ -1,416 +0,0 @@ -<?php
-
-require_once(PRADO_DIR.'/Collections/TList.php');
-require_once(PRADO_DIR.'/Collections/TMap.php');
-require_once(PRADO_DIR.'/Web/UI/TControl.php');
-
-class TContext extends TComponent
-{
- public static $_instance=null;
- public function __construct()
- {
- if(self::$_instance)
- throw new Exception('....');
- self::$_instance=$this;
- }
-
- public static function getInstance()
- {
- return self::$_instance;
- }
-}
-
-class ContainerControl extends TControl implements INamingContainer
-{
-}
-
-class PageControl extends TControl implements INamingContainer
-{
- public $eventRaised=false;
- private $_context;
-
- function __construct($context)
- {
- $this->setPage($this);
- $this->_context=$context;
- }
-
- public function getContext()
- {
- return $this->_context;
- }
-
- public function clicked($sender,$param)
- {
- $this->eventRaised=true;
- }
-
- public function getContainsTheme()
- {
- return false;
- }
-
- public function runTo($lifecycle)
- {
- switch($lifecycle)
- {
- case 'init':
- $this->initRecursive(null);
- break;
- case 'load':
- $this->initRecursive(null);
- $this->loadRecursive();
- break;
- case 'prerender':
- $this->initRecursive(null);
- $this->loadRecursive();
- $this->preRenderRecursive();
- break;
- }
- }
-}
-
-class WebControl extends TControl
-{
- public function getText()
- {
- return $this->getViewState('Text','');
- }
-
- public function setText($value)
- {
- return $this->setViewState('Text',$value,'');
- }
-
- public function getData()
- {
- return $this->getControlState('Data','');
- }
-
- public function setData($value)
- {
- $this->setControlState('Data',$value,'');
- }
-
- public function onClick($param)
- {
- $this->raiseEvent('OnClick',$this,$param);
- }
-}
-
-class utControl extends UnitTestCase
-{
- private $context;
- private $button1;
- private $button2;
- private $page;
- private $form;
- private $panel;
-
- public function setUp()
- {
- // we mock up a page consisting of a form which encloses a panel.
- // in the panel there are two buttons, button1 and button2
- // The panel is a naming container
- $this->context=new TContext;
- $this->page=new PageControl($this->context);
- $this->form=new WebControl;
- $this->panel=new ContainerControl;
- $this->button1=new WebControl;
- $this->button2=new WebControl;
- $this->form->setTemplateControl($this->page);
- $this->panel->setTemplateControl($this->page);
- $this->button1->setTemplateControl($this->page);
- $this->button2->setTemplateControl($this->page);
- $this->page->getControls()->add($this->form);
- $this->form->getControls()->add($this->panel);
- $this->panel->getControls()->add($this->button1);
- $this->panel->getControls()->add($this->button2);
- $this->button1->setID('button1');
- $this->page->declareObject('button1',$this->button1);
- }
-
- public function tearDown()
- {
- $this->page=null;
- $this->form=null;
- $this->panel=null;
- $this->button1=null;
- $this->button2=null;
- $this->context=null;
- TContext::$_instance=null;
- }
-
- public function testOverload()
- {
- $this->assertEqual($this->page->button1,$this->button1);
- try
- {
- $button=$this->page->button2;
- $this->fail('non exception raised when accessing non-declared control');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testParent()
- {
- $this->assertEqual(null,$this->page->getParent());
- $this->assertEqual($this->page,$this->form->getParent());
- }
-
- public function testNamingContainer()
- {
- $this->assertEqual(null,$this->page->getNamingContainer());
- $this->assertEqual($this->page,$this->panel->getNamingContainer());
- $this->assertEqual($this->panel,$this->button1->getNamingContainer());
- }
-
- public function testPage()
- {
- $this->assertEqual($this->page,$this->page->getPage());
- $this->assertEqual($this->page,$this->panel->getPage());
- $this->assertEqual($this->page,$this->button1->getPage());
- }
-
- public function testTemplateControl()
- {
- $this->assertEqual(null,$this->page->getTemplateControl());
- $this->assertEqual($this->page,$this->panel->getTemplateControl());
- $this->assertEqual($this->page,$this->button1->getTemplateControl());
- }
-
- public function testContext()
- {
- $this->assertEqual($this->context,$this->button1->getContext());
- }
-
- public function testSkinID()
- {
- $this->assertEqual('',$this->button1->getSkinID());
- $this->button1->setSkinID('buttonSkin');
- $this->assertEqual('buttonSkin',$this->button1->getSkinID());
- $this->page->runTo('init');
- try
- {
- $this->button1->setSkinID('buttonSkin2');
- $this->fail('no exception raised when SkinID is set after PreInit');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testID()
- {
- $this->assertEqual('button1',$this->button1->getID());
- $this->assertEqual('',$this->button2->getID());
- $this->assertEqual('ctl1',$this->button2->getID(false));
- $this->button2->setID('button2');
- $this->assertEqual('button2',$this->button2->getID());
- try
- {
- $this->button2->setID('123');
- $this->fail('exception not raised when control is set with an invalid ID');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- }
-
- public function testUniqueID()
- {
- $sep=TControl::ID_SEPARATOR;
- $this->assertEqual('ctl0',$this->form->getUniqueID());
- $this->assertEqual('ctl1',$this->panel->getUniqueID());
- $this->assertEqual('ctl1'.$sep.'button1',$this->button1->getUniqueID());
- $this->assertEqual('ctl1'.$sep.'ctl1',$this->button2->getUniqueID());
- $this->button2->setID('button2');
- $this->assertEqual('ctl1'.$sep.'button2',$this->button2->getUniqueID());
- $this->panel->setID('panel');
- $this->assertEqual('panel'.$sep.'button2',$this->button2->getUniqueID());
- }
-
- public function testEnableTheming()
- {
- $this->assertEqual(true,$this->button1->getEnableTheming());
- $this->page->setEnableTheming(false);
- $this->assertEqual(false,$this->button1->getEnableTheming());
- $this->page->setEnableTheming(true);
- $this->assertEqual(true,$this->button1->getEnableTheming());
- $this->button1->setEnableTheming(false);
- $this->assertEqual(false,$this->button1->getEnableTheming());
-
- $this->page->runTo('init');
- try
- {
- $this->button1->setEnableTheming(true);
- $this->fail('no exception raised when EnableTheming is set after PreInit');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testHasControls()
- {
- $this->assertEqual(true,$this->page->getHasControls());
- $this->assertEqual(false,$this->button1->getHasControls());
- }
-
- public function testControls()
- {
- $this->assertEqual(1,$this->page->getControls()->getCount());
- $control=new WebControl;
- $this->panel->getControls()->add($control);
- $this->assertEqual(3,$this->panel->getControls()->getCount());
- $this->panel->getControls()->remove($this->button1);
- $this->assertEqual(2,$this->panel->getControls()->getCount());
- }
-
- public function testVisible()
- {
- $this->assertEqual(true,$this->button1->getVisible());
- $this->page->setVisible(false);
- $this->assertEqual(false,$this->button1->getVisible());
- $this->page->setVisible(true);
- $this->assertEqual(true,$this->button1->getVisible());
- $this->button1->setVisible(false);
- $this->assertEqual(false,$this->button1->getVisible());
- }
-
- public function testEnabled()
- {
- $this->assertEqual(true,$this->button1->getEnabled());
- $this->page->setEnabled(false);
- $this->assertEqual(true,$this->button1->getEnabled());
- $this->assertEqual(false,$this->button1->getEnabled(true));
- $this->page->setEnabled(true);
- $this->assertEqual(true,$this->button1->getEnabled(true));
- $this->button1->setEnabled(false);
- $this->assertEqual(false,$this->button1->getEnabled(true));
- $this->assertEqual(false,$this->button1->getEnabled());
- }
-
- public function testHasAttributes()
- {
- $this->assertEqual(false,$this->button1->getHasAttributes());
- $this->button1->getAttributes()->add('name','value');
- $this->assertEqual(true,$this->button1->getHasAttributes());
- $this->button1->getAttributes()->clear();
- $this->assertEqual(false,$this->button1->getHasAttributes());
- }
-
- public function testAttributes()
- {
- $this->assertEqual(0,$this->button1->getAttributes()->getCount());
- $this->button1->getAttributes()->add('name1','value1');
- $this->button1->getAttributes()->add('name2','value2');
- $this->assertEqual(2,$this->button1->getAttributes()->getCount());
- $this->button1->getAttributes()->remove('name1');
- $this->assertEqual(1,$this->button1->getAttributes()->getCount());
- }
-
- public function testEnableViewState()
- {
- $this->assertEqual(true,$this->button1->getEnableViewState());
- $this->button1->setEnableViewState(false);
- $this->assertEqual(false,$this->button1->getEnableViewState());
-
- }
-
- public function testViewState()
- {
- $this->assertEqual('',$this->button1->getText());
- $this->button1->setText('abc');
- $this->assertEqual('abc',$this->button1->getText());
- }
-
- public function testControlState()
- {
- $this->assertEqual('',$this->button1->getData());
- $this->button1->setData('abc');
- $this->assertEqual('abc',$this->button1->getData());
- }
-
- public function testEventScheme()
- {
- $this->assertEqual(true,$this->button1->hasEvent('OnClick'));
- $this->assertEqual(false,$this->button1->hasEvent('Click'));
- $this->button1->attachEventHandler('OnClick','Page.clicked');
- $this->assertEqual(false,$this->page->eventRaised);
- $this->button1->raiseEvent('OnClick',$this,null);
- $this->assertEqual(true,$this->page->eventRaised);
- $this->button1->getEventHandlers('OnClick')->clear();
- try
- {
- $this->button1->attachEventHandler('OnClick','clicked');
- $this->fail('no exception raised when undefined event is raised');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- $this->assertEqual(0,$this->button1->getEventHandlers('OnClick')->getCount());
- $this->button1->attachEventHandler('OnClick','Pages.clicked');
- try
- {
- $this->button1->raiseEvent('OnClick',$this,null);
- $this->fail('no exception raised when undefined event handler is invoked');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testDataBindingScheme()
- {
- $this->button1->bindProperty('Text','"abc"."def"');
- $this->button1->dataBind();
- $this->assertEqual('abcdef',$this->button1->getText());
- $this->button2->bindProperty('Text','"abc"."def"');
- $this->button2->unbindProperty('Text');
- $this->button2->dataBind();
- $this->assertEqual('',$this->button2->getText());
- $this->button1->bindProperty('Texts','"abc"."def"');
- try
- {
- $this->button1->dataBind();
- $this->fail('no exception raised for invalid databinding');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testFindControl()
- {
- $this->assertEqual($this->button1,$this->panel->findControl('button1'));
- $this->assertEqual(null,$this->panel->findControl('button2'));
- $this->assertEqual($this->button1,$this->page->findControl($this->panel->getID(false).TControl::ID_SEPARATOR.'button1'));
- $this->button1->setID('button3');
- $this->assertEqual($this->button1,$this->panel->findControl('button3'));
- }
-
- public function testAddRemoveControl()
- {
-
- }
-}
-
-
-if(!defined('RUN_ALL_TESTS'))
-{
- $className=basename(__FILE__,'.php');
- $test = new $className;
- $test->run(new HtmlReporter());
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Web/UI/utJavascriptSerializer.php b/tests/UnitTests/framework/Web/UI/utJavascriptSerializer.php deleted file mode 100644 index 89a54820..00000000 --- a/tests/UnitTests/framework/Web/UI/utJavascriptSerializer.php +++ /dev/null @@ -1,181 +0,0 @@ -<?php
-
-require_once(PRADO_DIR.'/Web/Javascripts/TJavascriptSerializer.php');
-
-class testSerializerObject
-{
- public $public = 'public data';
- protected $protected = 'protected data';
- private $private = 'private !';
-}
-
-class testComponentObject extends TComponent
-{
- public $public = 'public data';
- protected $protected = 'protected data';
- private $private = 'private !';
-
- public function getData()
- {
- return "component data";
- }
-}
-
-class utJavascriptSerializer extends UnitTestCase
-{
- function testString()
- {
- $string = "Stan's world!";
- $expect = "'Stan\\'s world!'";
- $js = new TJavascriptSerializer($string);
- $this->assertEqual($expect, $js->toJavascript());
-
- $string = "";
- $expect = "''";
- $js = new TJavascriptSerializer($string);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- function testInteger()
- {
- $int = 10;
- $expect = "10";
- $js = new TJavascriptSerializer($int);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- function testFloat()
- {
- $float = 10.2;
- $expect = "10.2";
- $js = new TJavascriptSerializer($float);
- $this->assertEqual($expect, $js->toJavascript());
-
- $float = INF;
- $expect = "Number.POSITIVE_INFINITY";
- $js = new TJavascriptSerializer($float);
- $this->assertEqual($expect, $js->toJavascript());
-
- $expect = "Number.NEGATIVE_INFINITY";
- $js = new TJavascriptSerializer(-$float);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- function testBoolean()
- {
- $bool = false;
- $expect = "false";
- $js = new TJavascriptSerializer($bool);
- $this->assertEqual($expect, $js->toJavascript());
-
- $expect = "true";
- $js = new TJavascriptSerializer(!$bool);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- function testNull()
- {
- $null = null;
- $expect = "null";
- $js = new TJavascriptSerializer($null);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- function testArray()
- {
- $data[0] = 1;
- $data[1] = "hello";
- $data[2] = 1.20;
- $data[3] = true;
- $data[4] = false;
- $data[5] = null;
- $data[6] = array("one");
-
- $expect = "[1,'hello',1.2,true,false,null,['one']]";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toJavascript());
-
- $data = array();
- $expect = "[]";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toJavascript(true));
- }
-
- function testMap()
- {
- $data['hello'] = 'world';
- $data['more'] = array('yes' => 'yah!');
- $expect = "{'hello':'world','more':{'yes':'yah!'}}";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toMap());
- }
-
- function testObject()
- {
- $data = new testSerializerObject;
- $expect = "{'public':'public data'}";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- //should not serialize components!
- function testComponent()
- {
- $data = new testComponentObject;
- $expect = "{'public':'public data','Data':'component data'}";
- $js = new TJavascriptSerializer($data);
- try
- {
- $js->toJavascript();
- $this->fail();
- }
- catch(TException $e)
- {
- $this->pass();
- }
- }
-
- function testComplexStrings()
- {
- $data[] = "\"It's slash \/ wonderful\"";
- $expect = "['\\\"It\'s slash \\\\/ wonderful\\\"']";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
-
- function testArrayString()
- {
- $data[] = "['hello', 1]";
- $data[] = "{'asd':'asdasd'}";
- $data[] = "[hasdkj}";
- $expect = "[['hello', 1],{'asd':'asdasd'},'[hasdkj}']";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toJavascript());
- }
-
- function testArrayComplex()
- {
- $data = array("hello", 1, 2.12, array("world", null, "", array()));
- $expect = "['hello',1,2.12,['world',null]]";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toJavascript());
-
- $expect = "['hello',1,2.12,['world',null,'',[]]]";
- $this->assertEqual($expect, $js->toJavascript(true));
- }
-
- function testListComplex()
- {
- $data = array("hello"=>"world", 1, 2.12);
- $data["more"] = array("the" => "world", null, "good"=>"", array());
- $expect = "{'hello':'world','0':1,'1':2.12,'more':{'the':'world','0':null}}";
- $js = new TJavascriptSerializer($data);
- $this->assertEqual($expect, $js->toMap());
-
- $expect = "{'hello':'world','0':1,'1':2.12,'more':{'the':'world','0':null,'good':'','1':{}}}";
- $this->assertEqual($expect, $js->toMap(true));
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/Web/utHttpRequest.php b/tests/UnitTests/framework/Web/utHttpRequest.php deleted file mode 100644 index 3da58a69..00000000 --- a/tests/UnitTests/framework/Web/utHttpRequest.php +++ /dev/null @@ -1,268 +0,0 @@ -<?php - -require_once(dirname(__FILE__).'/../common.php'); - -class utHttpRequest extends ModuleTestCase { - - /** - * @var THttpRequest protected. The THttpRequest object we're using for testing. - */ - protected $request; - - - public function testSetUp() { - $this->request =& new THttpRequest(); - $this->module =& $this->request; // $this->module is used automatically by the underlying class - $this->initModule($this->defaultConfig); - } - - public function tearDown() { - $this->request = null; - parent::tearDown(); - } - - public function testInit($application,$config) { - // Configuration case 1... - $_SERVER = array( - "REQUEST_URI" => "/foo.php?bar", - "SCRIPT_NAME" => "/foo.php", - "QUEST_STRING" => "bar", - "PATH_INFO" => "/foo.php", - "PHP_SELF" => "/foo.php", - ); - $this->mockApplication->expectOnce("setRequest"); - $this->initModule(); - $this->mockApplication->tally(); - $this->assertIsA($this->request->getItems(), "TMap"); - - $this->assertEqual($this->request->getRequestUri(), "/foo.php?bar"); - $this->assertEqual($this->request->getPathInfo(), "/foo.php"); - - $_SERVER = array( - "REQUEST_URI" => "/aaa/bbb/ccc/foo.php?bar", - "SCRIPT_NAME" => "", - "QUEST_STRING" => "", - "PATH_INFO" => "/aaa/bbb/ccc/foo.php", - "PHP_SELF" => "/aaa/bbb/ccc/foo.php", - ); - $this->initModule(); - $this->assertEqual($this->request->getRequestUri(), "/aaa/bbb/ccc/foo.php?bar"); - $this->assertEqual($this->request->getPathInfo(), "/aaa/bbb/ccc/foo.php"); - - $_SERVER = array( - "SCRIPT_NAME" => "/foo.php", - "QUEST_STRING" => "bar", - "PATH_INFO" => "", - "PHP_SELF" => "/foo.php", - ); - $this->initModule(); - $this->assertEqual($this->request->getRequestUri(), "/foo.php?bar"); - $this->assertEqual($this->request->getPathInfo(), "/foo.php"); - - $_SERVER = array( - "REQUEST_URI" => "/foo.php?bar", - "PATH_INFO" => "/foo.php?bar", - ); - $this->initModule(); - $this->assertEqual($this->request->getRequestUri(), "/foo.php?bar"); - $this->assertEqual($this->request->getPathInfo(), "/foo.php"); - } - - /*public function testGetUrl() { - if($this->_url===null) - { - $secure=$this->getIsSecureConnection(); - $url=$secure?'https://':'http://'; - if(empty($_SERVER['HTTP_HOST'])) - { - $url.=$_SERVER['SERVER_NAME']; - $port=$_SERVER['SERVER_PORT']; - if(($port!=80 && !$secure) || ($port!=443 && $secure)) - $url.=':'.$port; - } - else - $url.=$_SERVER['HTTP_HOST']; - $url.=$this->getRequestUri(); - $this->_url=new TUri($url); - } - return $this->_url; - }*/ - - public function testGetRequestType() { - $_SERVER = array("REQUEST_METHOD" => "GET"); - $this->assertEqual($this->request->getRequestType(), "GET"); - } - - public function testGetIsSecureConnection() { - $_SERVER = array("HTTPS" => "true"); - $this->assertTrue($this->request->getIsSecureConnection()); - $_SERVER = array("HTTPS" => ""); - $this->assertFalse($this->request->getIsSecureConnection()); - $_SERVER = array(); - $this->assertFalse($this->request->getIsSecureConnection()); - } - - public function testGetQueryString() { - $_SERVER = array("QUERY_STRING" => "foo=bar"); - $this->assertEqual($this->request->getQueryString(), "foo=bar"); - $_SERVER = array("QUERY_STRING" => ""); - $this->assertEqual($this->request->getQueryString(), ""); - $_SERVER = array(); - $this->assertEqual($this->request->getQueryString(), ""); - } - - public function testGetApplicationPath() { - $_SERVER = array("SCRIPT_NAME" => "/foo/bar.php"); - $this->assertEqual($this->request->getApplicationPath(), "/foo/bar.php"); - } - - public function testGetPhysicalApplicationPath() { - $_SERVER = array("SCRIPT_FILENAME" => "/var/www/foo.php"); - $this->assertEqual($this->request->getPhysicalApplicationPath(), "/var/www/foo.php"); - $_SERVER = array("SCRIPT_FILENAME" => "C:\\web\\foo.php"); - $this->assertEqual($this->request->getPhysicalApplicationPath(), "/web/foo.php"); - } - - public function testGetServerName() { - $_SERVER = array("SERVER_NAME" => "foobar"); - $this->assertEqual($this->request->getApplicationPath(), "foobar"); - } - - public function testGetServerPort() { - $_SERVER = array("SERVER_PORT" => "80"); - $this->assertEqual($this->request->getApplicationPath(), 80); - } - - public function testGetUrlReferrer() { - $_SERVER = array("HTTP_REFERRER" => "http://www.google.com/"); - $this->assertEqual($this->request->getPhysicalApplicationPath(), "http://www.google.com/"); - $_SERVER = array(); - $this->assertNull($this->request->getPhysicalApplicationPath()); - } - - /*public function testGetBrowser() { - return get_browser(); - }*/ - - public function testGetUserAgent() { - $_SERVER = array("HTTP_USER_AGENT" => "foo"); - $this->assertEqual($this->request->getUserAgent(), "foo"); - } - - public function testGetUserHostAddress() { - $_SERVER = array("REMOTE_ADDR" => "121.212.121.212"); - $this->assertEqual($this->request->getUserHostAddress(), "121.212.121.212"); - } - - public function testGetUserHost() { - $_SERVER = array("REMOTE_ADDR" => "foo"); - $this->assertEqual($this->request->getUserHostAddress(), "foo"); - $_SERVER = array(); - $this->assertNull($this->request->getUserHostAddress()); - } - - public function testGetAcceptTypes() { - $_SERVER = array("REMOTE_ADDR" => "foo bar"); - $this->assertEqual($this->request->getAcceptTypes(), "foo bar"); - } - - public function testGetUserLanguages() { - $_SERVER = array("HTTP_ACCEPT_LANGUAGE" => "foo"); - $this->assertEqual($this->request->getUserLanguages(), "foo"); - } - - public function testGetCookies() { - $_COOKIES = array("foo" => "bar", "xxx" => "yyy"); - - // Repeat this twice. The first time tests the parsing logic for $_COOKIES. - // The second time tests the internal caching logic. - for ($i = 0; $i < 2; $i++) { - $cookies = $this->request->getCookies(); - $this->assertIsA($cookies, "THttpCookieCollection"); - $this->asserEqual($cookies->getCount(), 2); - $first = $cookies->itemAt(0); - $this->assertEqual($first->getName(), "foo"); - $this->assertEqual($first->getName(), "bar"); - $second = $cookies->itemAt(0); - $this->assertEqual($second->getName(), "xxx"); - $this->assertEqual($second->getName(), "yyy"); - } - } - - /*public function testGetUploadedFiles() { - if($this->_files===null) - $this->_files=new TMap($_FILES); - return $this->_files; - } - - public function testGetServerVariables() { - if($this->_server===null) - $this->_server=new TMap($_SERVER); - return $this->_server; - } - - public function testGetEnvironmentVariables() { - if($this->_env===null) - $this->_env=new TMap($_ENV); - return $this->_env; - }*/ - - public function testConstructUrl($serviceID,$serviceParam,$getItems=null) { - $_SERVER = array("SCRIPT_NAME" => "/foo/bar.php"); - $sv = THttpRequest::SERVICE_VAR; - - // Note: we can't undefine SID so we can't ensure that the case when SID is not present will be tested. - // Therefore, we define it here so we can be sure that it *is* defined. If it was already defined before - // entering this function then this define() will be ignored. This doesn't matter as immediately after defining - // SID we read it into $sid. - define("SID", "123"); - $sid = SID; - - $this->assertEqual($this->request->constructUrl("page", ""), "/foo/bar.php?$sv=page&$sid"); - $this->assertEqual($this->request->constructUrl("page", null), "/foo/bar.php?$sv=page&$sid"); - $this->assertEqual($this->request->constructUrl("page", "myPage"), "/foo/bar.php?$sv=page.myPage&$sid"); - $this->assertEqual($this->request->constructUrl("page", "myPage", array("aaa"=>"aaa")), "/foo/bar.php?$sv=page.myPage&aaa=aaa&$sid"); - $this->assertEqual($this->request->constructUrl("page", "myPage", array("aaa"=>"aaa","bbb"=>"bbb")), "/foo/bar.php?$sv=page.myPage&aaa=aaa&bbb=bbb&$sid"); - $this->assertEqual($this->request->constructUrl("page", "myPage", new TList(array("aaa"=>"aaa"))), "/foo/bar.php?$sv=page.myPage&aaa=aaa&$sid"); - } - - protected function testResolveRequest() { - $sv = THttpRequest::SERVICE_VAR; - - $_POST = array($sv => "page"); - $this->initModule(); - $this->request->resolveRequest(); - $this->assertEqual($this->request->getServiceID(), "page"); - $this->assertEqual($this->request->getServiceParameter(), ""); - - $_POST = array($sv => "page.xxx"); - $this->initModule(); - $this->request->resolveRequest(); - $this->assertEqual($this->request->getServiceID(), "page"); - $this->assertEqual($this->request->getServiceParameter(), "xxx"); - - $_GET = array($sv => "page.xxx"); - $this->initModule(); - $this->request->resolveRequest(); - $this->assertEqual($this->request->getServiceID(), "page"); - $this->assertEqual($this->request->getServiceParameter(), "xxx"); - - $_POST = array($sv => "page"); - $this->initModule(); - $this->request->resolveRequest(); - $this->assertEqual($this->request->getServiceID(), "page"); - $this->assertEqual($this->request->getServiceParameter(), ""); - } - - public function testGetSetServiceID() { - $this->request->setServiceID("foo"); - $this->assertEqual($this->request->getServiceID(), "foo"); - } - - public function testGetSetServiceParameterD() { - $this->request->setServiceParameter("foo"); - $this->assertEqual($this->request->getServiceParameter(), "foo"); - } -} - -?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/common.php b/tests/UnitTests/framework/common.php deleted file mode 100644 index 059dd142..00000000 --- a/tests/UnitTests/framework/common.php +++ /dev/null @@ -1,99 +0,0 @@ -<?php
-
-if(!defined('FRAMEWORK_DIR'))
- define('FRAMEWORK_DIR',realpath(dirname(__FILE__).'/../../../framework'));
-if(!defined('SIMPLETEST_DIR'))
- define('SIMPLETEST_DIR',realpath(dirname(__FILE__).'/../simpletest'));
-
-require_once(SIMPLETEST_DIR.'/unit_tester.php');
-require_once(SIMPLETEST_DIR.'/mock_objects.php');
-require_once(SIMPLETEST_DIR.'/reporter.php');
-require_once(SIMPLETEST_DIR.'/HtmlReporterWithCoverage.php');
-
-require_once(FRAMEWORK_DIR.'/prado.php');
-
-set_include_path(get_include_path().";".FRAMEWORK_DIR);
-
-
-error_reporting(E_ALL);
-restore_error_handler();
-
-
-/**
- * PradoUnitTestCase class.
- *
- * Extends the simpletest UnitTestCase class to provide some fairly generic extra functionality.
- *
- * @author Alex Flint <alex@linium.net>
- */
-class PradoUnitTestCase extends UnitTestCase {
-
- /**
- * Tests whether the given code results in an appropriate exception being raised.
- * @param string the PHP code to execute. must end with a semi-colon.
- * @param string the type of exception that should be raised.
- * @return boolean true
- */
- public function assertException(string $code, string $exceptionType) {
- $ex = null;
- eval("try { $code } catch ($exceptionType \$e) { \$ex = \$e; }");
- $this->assertIsA($ex, $exceptionType);
- }
-}
-
-
-
-/**
- * Generate a class called MockTApplication to mock the TApplication class
- * for the purpose of testing IModule objects.
- */
-__autoload("TApplication");
-Mock::generate("TApplication");
-
-/**
- * ModuleTestCase class.
- *
- * Provides functionality designed to support testing of objects implementing the IModule
- * interface.
- *
- * Also provides some specific tests for IModule objects.
- *
- * @author Alex Flint <alex@linium.net>
- */
-
-class ModuleTestCase extends PradoUnitTestCase {
-
- protected $module = null;
- protected $mockApplication = null;
-
- public function __construct() {
- $file = "";
- $tihs->mockApplication = new MockTApplication($file);
- }
-
- public function testGetSetID() {
- if ($this->module instanceof IModule) {
- $this->module->setId(123);
- $this->assertEqual($this->module->getId(123));
- }
- }
-
- /**
- * Initializes $this->module by calling the init() method with the provided configuration.
- * If no application object is provided then a mock application object $this->mockApplication.
- * @param array optional. The configuration array to provide to the module. If none provided then
- * an empty array will be used.
- * @param TApplication optional. The TApplication to pass to the init() function of the module.
- * If none provided then $this->mockApplication will be used.
- */
- public function initModule($config=array(), $application=null) {
- if ($this->module instanceof IModule) {
- if (is_null($application)) {
- $application =& $this->mockApplication;
- }
- $this->module->init($config, $application);
- }
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/index.php b/tests/UnitTests/framework/index.php deleted file mode 100644 index 33c953f8..00000000 --- a/tests/UnitTests/framework/index.php +++ /dev/null @@ -1,103 +0,0 @@ -<?php
-
-class TestFolder
-{
- public $name='';
- public $url='';
- public $subFolders=array();
- public $testFiles=array();
-
- public function __construct($path,$rootPath,$rootUri)
- {
- $this->url="$rootUri/index.php?target=".strtr(substr($path,strlen($rootPath)+1),"\\",'/');
- $this->name=basename($path);
- $dir=opendir($path);
- while(($entry=readdir($dir))!==false)
- {
- $fullpath="$path/$entry";
- if($entry!=='.' && $entry!=='..' && $entry!=='.svn' && is_dir($fullpath))
- {
- $folder=new TestFolder($fullpath,$rootPath,$rootUri);
- if(!empty($folder->subFolders) || !empty($folder->testFiles))
- $this->subFolders[]=$folder;
- }
- else if(is_file($fullpath) && (strncmp($entry,'ut',2)===0
- || preg_match('/test.*\.php/', strtolower($entry))))
- {
- $this->testFiles[$entry]="$rootUri/index.php?target=".strtr(substr($fullpath,strlen($rootPath)+1),"\\",'/');
- }
- }
- closedir($dir);
- }
-
- public function getHtml($level=0)
- {
- $str=str_repeat(' ',$level*4)."[ <a href=\"{$this->url}\">{$this->name}</a> ]<br/>\n";
- foreach($this->subFolders as $folder)
- $str.=$folder->getHtml($level+1);
- foreach($this->testFiles as $name=>$url)
- $str.=str_repeat(' ',($level+1)*4)."<a href=\"$url\">$name</a><br/>\n";
- return $str;
- }
-}
-
-
-function addTests($test,$path,$recursive)
-{
- $dir=opendir($path);
- while(($entry=readdir($dir))!==false)
- {
- if(is_file($path.'/'.$entry) && (strncmp($entry,'ut',2)===0||preg_match('/test.*\.php/', strtolower($entry))))
- $test->addTestFile($path.'/'.$entry);
- else if($entry!=='.' && $entry!=='..' && $entry!=='.svn' && is_dir($path.'/'.$entry) && $recursive)
- addTests($test,$path.'/'.$entry,$recursive);
- }
- closedir($dir);
-}
-
-
-$rootPath=realpath(dirname(__FILE__));
-$rootUri=dirname($_SERVER['PHP_SELF']);
-
-if(isset($_GET['target']))
-{
- $target=$_GET['target'];
- $recursive=true;
- $fullpath=realpath("$rootPath/$target");
- if($fullpath===false || strpos($fullpath,$rootPath)!==0)
- die('invalid test target');
- include_once($rootPath.'/common.php');
-
- if(is_dir($fullpath))
- {
-
- $test=new GroupTest(basename($rootPath)."/$target");
- addTests($test,$fullpath,$recursive);
- $test->run(new HtmlReporter());
- //$test->run(new HtmlReporterWithCoverage('index.php',$rootPath));
- }
- else
- {
- $testClass=basename($fullpath,'.php');
- include_once($fullpath);
- $test=new $testClass(basename($rootPath)."/$target");
-
- $test->run(new HtmlReporter());
- }
-}
-else
-{
- echo "<html>
-<head>
-<title>Prado Framework Unit Tests</title>
-<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">
-</head>
-<body>
-<h1>Prado Framework Unit Tests</h1>
-";
- $root=new TestFolder($rootPath,$rootPath,$rootUri);
- echo $root->getHtml();
- echo "</body>\n</html>";
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/utApplication.php b/tests/UnitTests/framework/utApplication.php deleted file mode 100644 index 603f9fc3..00000000 --- a/tests/UnitTests/framework/utApplication.php +++ /dev/null @@ -1,25 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/common.php');
-require_once(FRAMEWORK_DIR.'/TApplication.php');
-
-class utApplication extends UnitTestCase
-{
- public function testCreateApplication()
- {
- $dir=getcwd();
- chdir(dirname(__FILE__));
- $application=new TApplication(dirname(__FILE__).'/TestSystem/protected/application.xml');
- try
- {
- new TApplication(dirname(__FILE__).'/TestSystem/protected/application.xml');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- chdir($dir);
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/utComponent.php b/tests/UnitTests/framework/utComponent.php deleted file mode 100644 index cfd40ce8..00000000 --- a/tests/UnitTests/framework/utComponent.php +++ /dev/null @@ -1,329 +0,0 @@ -<?php
-//test
-require_once(dirname(__FILE__).'/common.php');
-
-class NewComponent extends TComponent
-{
- private $_object=null;
- private $_text='default';
- private $_eventHandled=false;
-
- public function getText()
- {
- return $this->_text;
- }
-
- public function setText($value)
- {
- $this->_text=$value;
- }
-
- public function getObject()
- {
- if(!$this->_object)
- {
- $this->_object=new NewComponent;
- $this->_object->_text='object text';
- }
- return $this->_object;
- }
-
- public function onMyEvent($param)
- {
- $this->raiseEvent('OnMyEvent',$this,$param);
- }
-
- public function myEventHandler($sender,$param)
- {
- $this->_eventHandled=true;
- }
-
- public function isEventHandled()
- {
- return $this->_eventHandled;
- }
-}
-
-class utComponent extends UnitTestCase
-{
- protected $component;
-
- public function setUp()
- {
- $this->component=new NewComponent;
- }
-
- public function tearDown()
- {
- $this->component=null;
- }
-
- public function testHasProperty()
- {
- $this->assertTrue($this->component->hasProperty('Text'));
- $this->assertTrue($this->component->hasProperty('text'));
- $this->assertFalse($this->component->hasProperty('Caption'));
- }
-
- public function testCanGetProperty()
- {
- $this->assertTrue($this->component->canGetProperty('Text'));
- $this->assertTrue($this->component->canGetProperty('text'));
- $this->assertFalse($this->component->canGetProperty('Caption'));
- }
-
- public function testCanSetProperty()
- {
- $this->assertTrue($this->component->canSetProperty('Text'));
- $this->assertTrue($this->component->canSetProperty('text'));
- $this->assertFalse($this->component->canSetProperty('Caption'));
- }
-
- public function testGetProperty()
- {
- $this->assertTrue('default'===$this->component->Text);
- try
- {
- $value2=$this->component->Caption;
- $this->fail('exception not raised when getting undefined property');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testSetProperty()
- {
- $value='new value';
- $this->component->Text=$value;
- $text=$this->component->Text;
- $this->assertTrue($value===$this->component->Text);
- try
- {
- $this->component->NewMember=$value;
- $this->fail('exception not raised when setting undefined property');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testGetSubProperty()
- {
- $this->assertTrue('object text'===$this->component->getSubProperty('Object.Text'));
- }
-
- public function testSetSubProperty()
- {
- $this->component->setSubProperty('Object.Text','new object text');
- $this->assertEqual('new object text',$this->component->getSubProperty('Object.Text'));
- }
-
- public function testHasEvent()
- {
- $this->assertTrue($this->component->hasEvent('OnMyEvent'));
- $this->assertTrue($this->component->hasEvent('onmyevent'));
- $this->assertFalse($this->component->hasEvent('onYourEvent'));
- }
-
- public function testHasEventHandler()
- {
- $this->assertFalse($this->component->hasEventHandler('OnMyEvent'));
- $this->component->attachEventHandler('OnMyEvent','foo');
- $this->assertTrue($this->component->hasEventHandler('OnMyEvent'));
- }
-
- public function testGetEventHandlers()
- {
- $list=$this->component->getEventHandlers('OnMyEvent');
- $this->assertTrue(($list instanceof TList) && ($list->getCount()===0));
- $this->component->attachEventHandler('OnMyEvent','foo');
- $this->assertTrue(($list instanceof TList) && ($list->getCount()===1));
- try
- {
- $list=$this->component->getEventHandlers('YourEvent');
- $this->fail('exception not raised when getting event handlers for undefined event');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- }
-
- public function testAttachEventHandler()
- {
- $this->component->attachEventHandler('OnMyEvent','foo');
- $this->assertTrue($this->component->getEventHandlers('OnMyEvent')->getCount()===1);
- try
- {
- $this->component->attachEventHandler('YourEvent','foo');
- $this->fail('exception not raised when attaching event handlers for undefined event');
- }
- catch(TInvalidOperationException $e)
- {
- $this->pass();
- }
- /*$this->component->MyEvent[]='foo2';
- $this->assertTrue($this->component->getEventHandlers('MyEvent')->getCount()===2);
- $this->component->getEventHandlers('MyEvent')->add('foo3');
- $this->assertTrue($this->component->getEventHandlers('MyEvent')->getCount()===3);
- $this->component->MyEvent[0]='foo4';
- $this->assertTrue($this->component->getEventHandlers('MyEvent')->getCount()===3);
- $this->component->getEventHandlers('MyEvent')->insert(0,'foo5');
- $this->assertTrue($this->component->MyEvent->Count===4 && $this->component->MyEvent[0]==='foo5');
- $this->component->MyEvent='foo6';
- $this->assertTrue($this->component->MyEvent->Count===5 && $this->component->MyEvent[4]==='foo6');*/
- }
-
- public function testRaiseEvent()
- {
- $this->component->attachEventHandler('OnMyEvent',array($this->component,'myEventHandler'));
- $this->assertFalse($this->component->isEventHandled());
- $this->component->raiseEvent('OnMyEvent',$this,null);
- $this->assertTrue($this->component->isEventHandled());
- $this->component->attachEventHandler('OnMyEvent',array($this->component,'Object.myEventHandler'));
- $this->assertFalse($this->component->Object->isEventHandled());
- $this->component->raiseEvent('OnMyEvent',$this,null);
- $this->assertTrue($this->component->Object->isEventHandled());
- }
-
- public function testEvaluateExpression()
- {
- $expression="1+2";
- $this->assertTrue(3===$this->component->evaluateExpression($expression));
- try
- {
- $button=$this->component->evaluateExpression('$this->button');
- $this->fail('exception not raised when evaluating an invalid exception');
- }
- catch(Exception $e)
- {
- $this->pass();
- }
- }
-
- public function testEvaluateStatements()
- {
- $statements='$a="test string"; echo $a;';
- $this->assertEqual('test string',$this->component->evaluateStatements($statements));
- try
- {
- $statements='$a=new NewComponent; echo $a->button;';
- $button=$this->component->evaluateStatements($statements);
- $this->fail('exception not raised when evaluating an invalid statement');
- }
- catch(Exception $e)
- {
- $this->pass();
- }
- }
-
-
- /**
- * Tests the TPropertyValue::ensureBoolean function
- */
- public function testEnsureBoolean()
- {
- // Note: we must use assertEqual not assertTrue or assertFalse because then we can check that the return value is strictly of type boolean
- $this->assertEqual(TPropertyValue::ensureBoolean('false'), false);
- $this->assertEqual(TPropertyValue::ensureBoolean('False'), false);
- $this->assertEqual(TPropertyValue::ensureBoolean(false), false);
- $this->assertEqual(TPropertyValue::ensureBoolean(0), false);
- $this->assertEqual(TPropertyValue::ensureBoolean(0.0), false);
- $this->assertEqual(TPropertyValue::ensureBoolean(""), false);
- $this->assertEqual(TPropertyValue::ensureBoolean("0"), false);
- $this->assertEqual(TPropertyValue::ensureBoolean(array()), false);
- $this->assertEqual(TPropertyValue::ensureBoolean(null), false);
-
- $this->assertEqual(TPropertyValue::ensureBoolean('true'), true);
- $this->assertEqual(TPropertyValue::ensureBoolean('True'), true);
- $this->assertEqual(TPropertyValue::ensureBoolean(1), true);
- $this->assertEqual(TPropertyValue::ensureBoolean("1"), true);
- $this->assertEqual(TPropertyValue::ensureBoolean("-1"), true);
- $this->assertEqual(TPropertyValue::ensureBoolean(array("foboar")), true);
- }
-
- /**
- * Tests the TPropertyValue::ensureString function
- */
- public function testEnsureString()
- {
- $this->assertEqual(TPropertyValue::ensureString("foobar"), "foobar");
- $this->assertEqual(TPropertyValue::ensureString(true), "true");
- $this->assertEqual(TPropertyValue::ensureString(false), "false");
- $this->assertEqual(TPropertyValue::ensureString(array("foo","bar")), (string)array("foo","bar"));
- }
-
- /**
- * Tests the TPropertyValue::ensureInteger function
- */
- public function testEnsureInteger()
- {
- $this->assertEqual(TPropertyValue::ensureInteger(123), 123);
- $this->assertEqual(TPropertyValue::ensureInteger("123"), 123);
- $this->assertEqual(TPropertyValue::ensureInteger(""), 0);
- }
-
- /**
- * Tests the TPropertyValue::ensureFloat function
- */
- public function testEnsureFloat()
- {
- $this->assertEqual(TPropertyValue::ensureFloat(123.123), 123.123);
- $this->assertEqual(TPropertyValue::ensureFloat("123.123"), 123.123);
- $this->assertEqual(TPropertyValue::ensureFloat(""), 0.0);
- }
-
- /**
- * Tests the TPropertyValue::ensureArray function
- */
- public function testEnsureArray()
- {
- $this->assertEqual(TPropertyValue::ensureArray(array()), array());
- $this->assertEqual(TPropertyValue::ensureArray(array(1,2,3)), array(1,2,3));
- $this->assertEqual(TPropertyValue::ensureArray("(1,2,3)"), array(1,2,3));
- $this->assertEqual(TPropertyValue::ensureArray(""), array());
- }
-
- /**
- * Tests the TPropertyValue::ensureObject function
- */
- public function testEnsureObject()
- {
- $this->assertEqual(TPropertyValue::ensureObject($this->component), $this->component);
- }
-
- /**
- * Tests the TPropertyValue::ensureEnum function
- */
- public function testEnsureEnum()
- {
- $this->assertEqual(TPropertyValue::ensureEnum("foo", array("foo", "bar", "BAR")), "foo");
- $this->assertEqual(TPropertyValue::ensureEnum("bar", array("foo", "bar", "BAR")), "bar");
- $this->assertEqual(TPropertyValue::ensureEnum("BAR", array("foo", "bar", "BAR")), "BAR");
- $pass = false;
- try {
- $this->assertEqual(TPropertyValue::ensureEnum("xxx", array("foo", "bar", "BAR")), "BAR");
- } catch (TInvalidDataValueException $e) {
- $this->pass();
- $pass = true;
- }
- if (!$pass) {
- $this->fail("ensureEnun didn't raise a TInvalidDataValueException when it should have");
- }
- $pass = false;
- try {
- $this->assertEqual(TPropertyValue::ensureEnum("FOO", array("foo", "bar", "BAR")), "BAR");
- } catch (TInvalidDataValueException $e) {
- $this->pass();
- $pass = true;
- }
- if (!$pass) {
- $this->fail("ensureEnun didn't raise a TInvalidDataValueException when it should have");
- }
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/framework/utPradoBase.php b/tests/UnitTests/framework/utPradoBase.php deleted file mode 100644 index a53c17dd..00000000 --- a/tests/UnitTests/framework/utPradoBase.php +++ /dev/null @@ -1,110 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/common.php');
-
-class testNode
-{
- public $data='';
- public $parent=null;
- public $child=null;
- public function __construct($data)
- {
- $this->data=$data;
- }
-}
-
-class utPradoBase extends UnitTestCase
-{
- public function testFrameworkPath()
- {
- $this->assertTrue(FRAMEWORK_DIR===Prado::getFrameworkPath());
- }
-
- public function testSerialization()
- {
- $object=new TComponent;
- $number=12345.123;
- $string='12345\'"';
- $array=array('123'=>123,'abc'=>'def');
- $this->assertFalse($object===Prado::unserialize(Prado::serialize($object)));
- $this->assertTrue(Prado::unserialize(Prado::serialize($object)) instanceof TComponent);
- $this->assertTrue($number===Prado::unserialize(Prado::serialize($number)));
- $this->assertTrue($string===Prado::unserialize(Prado::serialize($string)));
- $this->assertTrue($array===Prado::unserialize(Prado::serialize($array)));
-
- // test complex object reference structure grandparent <-> parent <-> child
- $grandp=new testNode('grandp');
- $parent=new testNode('parent');
- $child=new testNode('child');
- $grandp->child=$parent;
- $parent->child=$child;
- $child->parent=$parent;
- $parent->parent=$grandp;
-
- $newGrandp=Prado::unserialize(Prado::serialize($grandp));
- $this->assertTrue($newGrandp!==$grandp);
- $this->assertTrue($newGrandp instanceof testNode);
- $this->assertTrue($newGrandp->parent===null);
- $this->assertTrue($newGrandp->data==='grandp');
-
- $newParent=$newGrandp->child;
- $this->assertTrue($newParent!==$parent);
- $this->assertTrue($newParent instanceof testNode);
- $this->assertTrue($newParent->parent===$newGrandp);
- $this->assertTrue($newParent->data==='parent');
-
- $newChild=$newParent->child;
- $this->assertTrue($newChild!==$child);
- $this->assertTrue($newChild instanceof testNode);
- $this->assertTrue($newChild->parent===$newParent);
- $this->assertTrue($newChild->child===null);
- $this->assertTrue($newChild->data==='child');
- }
-
- public function testCreateComponent()
- {
- $this->assertTrue(Prado::createComponent('TComponent') instanceof TComponent);
- $this->assertTrue(Prado::createComponent('System.TComponent') instanceof TComponent);
- try
- {
- Prado::createComponent('System.TComponent2');
- $this->fail('exception not raised when creating a nonexistent component');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- }
-
- public function testNamespace()
- {
- $this->assertTrue(FRAMEWORK_DIR===Prado::getPathOfAlias('System'));
- $this->assertTrue(Prado::getPathOfAlias('System2')===null);
- $testSystem=dirname(__FILE__).'/TestSystem';
-
- Prado::setPathOfAlias('TestSystem',$testSystem);
- $this->assertTrue(realpath($testSystem)===Prado::getPathOfAlias('TestSystem'));
-
- $this->assertTrue(Prado::getPathOfNamespace('TestSystem.*')===realpath($testSystem));
- $this->assertTrue(Prado::getPathOfNamespace('TestSystem.protected.*')===realpath($testSystem).'/protected');
-
- // test repeatedly using the same namespaces
- Prado::using('System.*');
- Prado::using('System.*');
- Prado::using('System.TComponent');
- Prado::using('System.TComponent');
-
- try
- {
- Prado::using('System');
- $this->fail('no exception raised when using an invalid namespace for a directory');
- }
- catch(TInvalidDataValueException $e)
- {
- $this->pass();
- }
- // TODO: using new namespaces to see if classes can be automatically loaded or found
- }
-}
-
-?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/mytests/log_test.php b/tests/UnitTests/simpletest/mytests/log_test.php deleted file mode 100644 index d1254b7a..00000000 --- a/tests/UnitTests/simpletest/mytests/log_test.php +++ /dev/null @@ -1,18 +0,0 @@ -<?php
-
-require_once(dirname(__FILE__).'/../unit_tester.php');
-require_once(dirname(__FILE__).'/../reporter.php');
-
-class TestOfLogging extends UnitTestCase
-{
- function testCreatingNewFile() {
- $this->assertFalse(false);
- //$log->message('Should write this to a file');
- $this->assertTrue(true);
- }
-}
-
-$test = new TestOfLogging();
-$test->run(new HtmlReporter());
-
-?>
\ No newline at end of file diff --git a/tests/FunctionalTests/README.txt b/tests/test_tools/README.txt index 06519092..cfa02abe 100644 --- a/tests/FunctionalTests/README.txt +++ b/tests/test_tools/README.txt @@ -1,532 +1,532 @@ -== PRADO Functional Tests ==
-
-Functional tests are browser based that tests the overall functional of a Prado application. The tests can be written in PHP, see "framework/..." within this directory to see some examples. To run the tests, open your browser to "../tests/FunctionalTests/index.php" and click on the "All" button.
-
-
-=== Writing Tests ===
-Lets test some part of a Prado application. Create a new php file, e.g.
-
-testExample1.php
-
-<php>
-<?php
-class testExample1 extends SeleniumTestCase
-{
- function setup()
- {
- $this->open('../examples/myexample/index.php');
- }
-
- function testButtonClickExample()
- {
- //using xpath to find the button with value "Click Me!"
- $this->click('//input[@value="Click Me!"]');
-
- //..more commands and assertions
- }
-}
-?>
-</php>
-
-=== Tests as part of Example code ===
-Tests can also be place within the example page, e.g. suppose we have an example call MyButtonExample.
-
-File: MyButtonExample.php
-<php>
-<?php
-//Example class, changes the Text of a button when clicked.
-class MyButtonExample extends TPage
-{
- function button_clicked($sender, $param)
- {
- $sender->Text = "Hello World!";
- }
-}
-
-
-class testMyButtonExample extends SeleniumTestCase
-{
- function setup()
- {
- //get the test page url
- $page = Prado::getApplication()->getTestPage(__FILE__);
-
- //open MyButtonExample page
- $this->open($page);
- }
-
- function testButtonClick()
- {
- $this->assertTextPresent("My Button Example");
- $this->click('//input[@value="Click Me!"]');
- $this->click('//input[@value="Hello World!"]');
- }
-}
-?>
-</php>
-
-File: MyButtonExample.tpl
-<prado>
-<com:TForm>
- <h1>My Button Example</h1>
- <com:TButton Text="Click Me!"
- Click="button_clicked" />
-</com:TForm>
-</prado>
-
-== Selenium Reference ==
-
-A '''command''' is what tells Selenium what to do. Selenium commands come in two 'flavors', '''Actions''' and '''Assertions'''. Each command call has the following syntax
-<php>
- $this->[command]([target], [value]);
-</php>
-Note that some commands does not need a [value].
-
-'''Actions''' are commands that generally manipulate the state of the application. They do things like "click this link" and "select that option". If an Action fails, or has an error, the execution of the current test is stopped.
-
-
-'''Checks''' verify the state of the application conforms to what is expected. Examples include "make sure the page title is X" and "check that this checkbox is checked". It is possible to tell Selenium to stop the test when an Assertion fails, or to simply record the failure and continue.
-
-'''Element Locators''' tell Selenium which HTML element a command refers to. Many commands require an Element Locator as the "target" attribute. Examples of Element Locators include "elementId" and "document.forms[0].element". These are described more clearly in the next section.
-
-'''Patterns''' are used for various reasons, e.g. to specify the expected value of an input field, or identify a select option. Selenium supports various types of pattern, including regular-expressions, all of which are described in more detail below.
-
-=== Element Locators ===
-
-Element Locators allow Selenium to identify which HTML element a command refers to. Selenium support the following strategies for locating elements:
-
-==== '''id='''''id'' ====
-Select the element with the specified @id attribute.
-
-==== '''name='''''name'' ====
-Select the first element with the specified @name attribute.
-
-==== '''identifier='''''id''====
-Select the element with the specified @id attribute. If no match is found, select the first element whose @name attribute is ''id''.
-
-==== '''dom='''''javascriptExpression''====
-Find an element using JavaScript traversal of the HTML Document Object Model. DOM locators ''must'' begin with "document.".
-* dom=document.forms['myForm'].myDropdown
-* dom=document.images[56]
-
-==== '''xpath='''''xpathExpression''====
-Locate an element using an XPath expression. XPath locators ''must'' begin with "//".
-* xpath=//img[@alt='The image alt text']
-* xpath=//table[@id='table1']//tr[4]/td[2]
-
-==== '''link='''''textPattern'' ====
-Select the link (anchor) element which contains text matching the specified ''pattern''.
-* link=The link text
-
-Without a locator prefix, Selenium uses:
-
-* dom, for locators starting with "document."
-* xpath, for locators starting with "//"
-* identifier, otherwise
-
-
-=== Select Option Specifiers ===
-
-Select Option Specifiers provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Specifier.
-
-==== label=labelPattern ====
-matches options based on their labels, i.e. the visible text.
-* label=regexp:^[Oo]ther
-
-==== value=valuePattern ====
-matches options based on their values.
-* value=other
-
-==== id=id ====
-matches options based on their ids.
-* id=option1
-
-==== index=index ====
-matches an option based on its index (offset from zero).
-* index=2
-
-Without a prefix, the default behaviour is to only match on labels.
-
-String-match Patterns
-
- Various Pattern syntaxes are available for matching string values:
-
- glob:pattern
- Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a kind of limited regular-expression syntax typically used in command-line shells. In a glob pattern, "*" represents any sequence of characters, and "?" represents any single character. Glob patterns match against the entire string.
- regexp:regexp
- Match a string using a regular-expression. The full power of JavaScript regular-expressions is available.
- exact:string
- Match a string exactly, verbatim, without any of that fancy wildcard stuff.
-
- If no pattern prefix is specified, Selenium assumes that it's a "glob" pattern.
-
-Selenium Actions
-
- Actions tell Selenium to do something in the application. They generally represent something a user would do.
-
- Many Actions can be called with the "AndWait" suffix. This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load. The exceptions to this pattern are the "open" and "click" actions, which will both wait for a page to load by default.
-
- open( url )
-
- Opens a URL in the test frame. This accepts both relative and absolute URLs.
-
- Note: The URL must be on the same site as Selenium due to security restrictions in the browser (Cross Site Scripting).
-
- examples:
-
- open /mypage
- open http://localhost/
-
- click( elementLocator )
-
- Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), use "clickAndWait".
-
- examples:
-
- click aCheckbox
- clickAndWait submitButton
- clickAndWait anyLink
-
- note:
- Selenium will always automatically click on a popup dialog raised by the alert() or confirm() methods. (The exception is those raised during 'onload', which are not yet handled by Selenium). You must use [verify|assert]Alert or [verify|assert]Confirmation to tell Selenium that you expect the popup dialog. You may use chooseCancelOnNextConfirmation to click 'cancel' on the next confirmation dialog instead of clicking 'OK'.
-
- type( inputLocator, value )
-
- Sets the value of an input field, as though you typed it in.
-
- Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text.
-
- examples:
-
- type nameField John Smith
- typeAndWait textBoxThatSubmitsOnChange newValue
-
- select( dropDownLocator, optionSpecifier )
-
- Select an option from a drop-down, based on the optionSpecifier. If more than one option matches the specifier (e.g. due to the use of globs like "f*b*", or due to more than one option having the same label or value), then the first matches is selected.
-
- examples:
-
- select dropDown Australian Dollars
- select dropDown index=0
- selectAndWait currencySelector value=AUD
- selectAndWait currencySelector label=Aus*lian D*rs
-
- selectWindow( windowId )
-
- Selects a popup window. Once a popup window has been selected, all commands go to that window. To select the main window again, use "null" as the target.
-
- target: The id of the window to select.
-
- value: ignored
-
- examples:
-
- selectWindow myPopupWindow
- selectWindow null
-
- goBack()
-
- Simulates the user clicking the "back" button on their browser.
-
- examples:
-
- goBack
-
- close()
-
- Simulates the user clicking the "close" button in the titlebar of a popup window.
-
- examples:
-
- close
-
- pause( milliseconds )
-
- Pauses the execution of the test script for a specified amount of time. This is useful for debugging a script or pausing to wait for some server side action.
-
- examples:
-
- pause 5000
- pause 2000
-
- fireEvent( elementLocator, eventName )
-
- Explicitly simulate an event, to trigger the corresponding "onevent" handler.
-
- examples:
-
- fireEvent textField focus
- fireEvent dropDown blur
-
- waitForValue( inputLocator, value )
-
- Waits for a specified input (e.g. a hidden field) to have a specified value. Will succeed immediately if the input already has the value. This is implemented by polling for the value. Warning: can block indefinitely if the input never has the specified value.
-
- example:
-
- waitForValue finishIndication isfinished
-
- store( valueToStore, variableName )
-
- Stores a value into a variable. The value can be constructed using either variable substitution or javascript evaluation, as detailed in 'Parameter construction and Variables' (below).
-
- examples:
-
- store Mr John Smith fullname
- store ${title} ${firstname} ${surname} fullname
- store javascript{Math.round(Math.PI * 100) / 100} PI
-
- storeValue( inputLocator, variableName )
-
- Stores the value of an input field into a variable.
-
- examples:
-
- storeValue userName userID
- type userName ${userID}
-
- storeText( elementLocator, variableName )
-
- Stores the text of an element into a variable.
-
- examples:
-
- storeText currentDate expectedStartDate
- verifyValue startDate ${expectedStartDate}
-
- storeAttribute( elementLocator@attributeName, variableName )
-
- Stores the value of an element attribute into a variable.
-
- examples:
-
- storeAttribute input1@class classOfInput1
- verifyAttribute input2@class ${classOfInput1}
-
- chooseCancelOnNextConfirmation()
-
- Instructs Selenium to click Cancel on the next javascript confirmation dialog to be raised. By default, the confirm function will return true, having the same effect as manually clicking OK. After running this command, the next confirmation will behave as if the user had clicked Cancel.
-
- examples:
-
- chooseCancelOnNextConfirmation
-
- answerOnNextPrompt( answerString )
-
- Instructs Selenium to return the specified answerString in response to the next prompt.
-
- examples:
-
- answerOnNextPrompt Kangaroo
-
-Selenium Checks
-
- Checks are used to verify the state of the application. They can be used to check the value of a form field, the presense of some text, or the URL of the current page.
-
- All Selenium Checks can be used in 2 modes, "assert" and "verify". These behave identically, except that when an "assert" check fails, the test is aborted. When a "verify" check fails, the test will continue execution. This allows a single "assert" to ensure that the application is on the correct page, followed by a bunch of "verify" checks to test form field values, labels, etc.
-
- assertLocation( relativeLocation )
-
- examples:
-
- verifyLocation /mypage
- assertLocation /mypage
-
- assertTitle( titlePattern )
-
- Verifies the title of the current page.
-
- examples:
-
- verifyTitle My Page
- assertTitle My Page
-
- assertValue( inputLocator, valuePattern )
-
- Verifies the value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not.
-
- examples:
-
- verifyValue nameField John Smith
- assertValue document.forms[2].nameField John Smith
-
- assertSelected( selectLocator, optionSpecifier )
-
- Verifies that the selected option of a drop-down satisfies the optionSpecifier.
-
- examples:
-
- verifySelected dropdown2 John Smith
- verifySelected dropdown2 value=js*123
- assertSelected document.forms[2].dropDown label=J* Smith
- assertSelected document.forms[2].dropDown index=0
-
- assertSelectOptions( selectLocator, optionLabelList )
-
- Verifies the labels of all options in a drop-down against a comma-separated list. Commas in an expected option can be escaped as ",".
-
- examples:
-
- verifySelectOptions dropdown2 John Smith,Dave Bird
- assertSelectOptions document.forms[2].dropDown Smith\, J,Bird\, D
-
- assertText( elementLocator, textPattern )
-
- Verifies the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user.
-
- examples:
-
- verifyText statusMessage Successful
- assertText //div[@id='foo']//h1 Successful
-
- assertAttribute( elementLocator@attributeName, valuePattern )
-
- Verifies the value of an element attribute.
-
- examples:
-
- verifyAttribute txt1@class bigAndBold
- assertAttribute document.images[0]@alt alt-text
- verifyAttribute //img[@id='foo']/@alt alt-text
-
- assertTextPresent( text )
-
- Verifies that the specified text appears somewhere on the rendered page shown to the user.
-
- examples:
-
- verifyTextPresent You are now logged in.
- assertTextPresent You are now logged in.
-
- assertTextNotPresent( text )
-
- Verifies that the specified text does NOT appear anywhere on the rendered page.
-
- assertElementPresent( elementLocator )
-
- Verifies that the specified element is somewhere on the page.
-
- examples:
-
- verifyElementPresent submitButton
- assertElementPresent //img[@alt='foo']
-
- assertElementNotPresent( elementLocator )
-
- Verifies that the specified element is NOT on the page.
-
- examples:
-
- verifyElementNotPresent cancelButton
- assertElementNotPresent cancelButton
-
- assertTable( cellAddress, valuePattern )
-
- Verifies the text in a cell of a table. The cellAddress syntax tableName.row.column, where row and column start at 0.
-
- examples:
-
- verifyTable myTable.1.6 Submitted
- assertTable results.0.2 13
-
- assertVisible( elementLocator )
-
- Verifies that the specified element is both present and visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors.
-
- examples:
-
- verifyVisible postcode
- assertVisible postcode
-
- assertNotVisible( elementLocator )
-
- Verifies that the specified element is NOT visible. Elements that are simply not present are also considered invisible.
-
- examples:
-
- verifyNotVisible postcode
- assertNotVisible postcode
-
- verifyEditable / assertEditable( inputLocator )
-
- Verifies that the specified element is editable, ie. it's an input element, and hasn't been disabled.
-
- examples:
-
- verifyEditable shape
- assertEditable colour
-
- assertNotEditable( inputLocator )
-
- Verifies that the specified element is NOT editable, ie. it's NOT an input element, or has been disabled.
-
- assertAlert( messagePattern )
-
- Verifies that a javascript alert with the specified message was generated. Alerts must be verified in the same order that they were generated.
-
- Verifying an alert has the same effect as manually clicking OK. If an alert is generated but you do not verify it, the next Selenium action will fail.
-
- NOTE: under Selenium, javascript alerts will NOT pop up a visible alert dialog.
-
- NOTE: Selenium does NOT support javascript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.
-
- examples:
-
- verifyAlert Invalid Phone Number
- assertAlert Invalid Phone Number
-
- assertConfirmation( messagePattern )
-
- Verifies that a javascript confirmation dialog with the specified message was generated. Like alerts, confirmations must be verified in the same order that they were generated.
-
- By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command (see above). If an confirmation is generated but you do not verify it, the next Selenium action will fail.
-
- NOTE: under Selenium, javascript confirmations will NOT pop up a visible dialog.
-
- NOTE: Selenium does NOT support javascript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.
-
- examples:
-
- assertConfirmation Remove this user?
- verifyConfirmation Are you sure?
-
- assertPrompt( messagePattern )
-
- Verifies that a javascript prompt dialog with the specified message was generated. Like alerts, prompts must be verified in the same order that they were generated.
-
- Successful handling of the prompt requires prior execution of the answerOnNextPrompt command (see above). If a prompt is generated but you do not verify it, the next Selenium action will fail.
-
- examples:
-
- answerOnNextPrompt Joe
- click id=delegate
- verifyPrompt Delegate to who?
-
-Parameter construction and Variables
-
- All Selenium command parameters can be constructed using both simple variable substitution as well as full javascript. Both of these mechanisms can access previously stored variables, but do so using different syntax.
-
- Stored Variables
-
- The commands store, storeValue and storeText can be used to store a variable value for later access. Internally, these variables are stored in a map called "storedVars", with values keyed by the variable name. These commands are documented in the command reference.
-
- Variable substitution
-
- Variable substitution provides a simple way to include a previously stored variable in a command parameter. This is a simple mechanism, by which the variable to substitute is indicated by ${variableName}. Multiple variables can be substituted, and intermixed with static text.
-
- Example:
-
- store Mr title
- storeValue nameField surname
- store ${title} ${surname} fullname
- type textElement Full name is: ${fullname}
-
- Javascript evaluation
-
- Javascript evaluation provides the full power of javascript in constructing a command parameter. To use this mechanism, the entire parameter value must be prefixed by 'javascript{' with a trailing '}'. The text inside the braces is evaluated as a javascript expression, and can access previously stored variables using the storedVars map detailed above. Note that variable substitution cannot be combined with javascript evaluation.
-
- Example:
-
- store javascript{'merchant' + (new Date()).getTime()} merchantId
+== PRADO Functional Tests == + +Functional tests are browser based that tests the overall functional of a Prado application. The tests can be written in PHP, see "framework/..." within this directory to see some examples. To run the tests, open your browser to "../tests/FunctionalTests/index.php" and click on the "All" button. + + +=== Writing Tests === +Lets test some part of a Prado application. Create a new php file, e.g. + +testExample1.php + +<php> +<?php +class testExample1 extends SeleniumTestCase +{ + function setup() + { + $this->open('../examples/myexample/index.php'); + } + + function testButtonClickExample() + { + //using xpath to find the button with value "Click Me!" + $this->click('//input[@value="Click Me!"]'); + + //..more commands and assertions + } +} +?> +</php> + +=== Tests as part of Example code === +Tests can also be place within the example page, e.g. suppose we have an example call MyButtonExample. + +File: MyButtonExample.php +<php> +<?php +//Example class, changes the Text of a button when clicked. +class MyButtonExample extends TPage +{ + function button_clicked($sender, $param) + { + $sender->Text = "Hello World!"; + } +} + + +class testMyButtonExample extends SeleniumTestCase +{ + function setup() + { + //get the test page url + $page = Prado::getApplication()->getTestPage(__FILE__); + + //open MyButtonExample page + $this->open($page); + } + + function testButtonClick() + { + $this->assertTextPresent("My Button Example"); + $this->click('//input[@value="Click Me!"]'); + $this->click('//input[@value="Hello World!"]'); + } +} +?> +</php> + +File: MyButtonExample.tpl +<prado> +<com:TForm> + <h1>My Button Example</h1> + <com:TButton Text="Click Me!" + Click="button_clicked" /> +</com:TForm> +</prado> + +== Selenium Reference == + +A '''command''' is what tells Selenium what to do. Selenium commands come in two 'flavors', '''Actions''' and '''Assertions'''. Each command call has the following syntax +<php> + $this->[command]([target], [value]); +</php> +Note that some commands does not need a [value]. + +'''Actions''' are commands that generally manipulate the state of the application. They do things like "click this link" and "select that option". If an Action fails, or has an error, the execution of the current test is stopped. + + +'''Checks''' verify the state of the application conforms to what is expected. Examples include "make sure the page title is X" and "check that this checkbox is checked". It is possible to tell Selenium to stop the test when an Assertion fails, or to simply record the failure and continue. + +'''Element Locators''' tell Selenium which HTML element a command refers to. Many commands require an Element Locator as the "target" attribute. Examples of Element Locators include "elementId" and "document.forms[0].element". These are described more clearly in the next section. + +'''Patterns''' are used for various reasons, e.g. to specify the expected value of an input field, or identify a select option. Selenium supports various types of pattern, including regular-expressions, all of which are described in more detail below. + +=== Element Locators === + +Element Locators allow Selenium to identify which HTML element a command refers to. Selenium support the following strategies for locating elements: + +==== '''id='''''id'' ==== +Select the element with the specified @id attribute. + +==== '''name='''''name'' ==== +Select the first element with the specified @name attribute. + +==== '''identifier='''''id''==== +Select the element with the specified @id attribute. If no match is found, select the first element whose @name attribute is ''id''. + +==== '''dom='''''javascriptExpression''==== +Find an element using JavaScript traversal of the HTML Document Object Model. DOM locators ''must'' begin with "document.". +* dom=document.forms['myForm'].myDropdown +* dom=document.images[56] + +==== '''xpath='''''xpathExpression''==== +Locate an element using an XPath expression. XPath locators ''must'' begin with "//". +* xpath=//img[@alt='The image alt text'] +* xpath=//table[@id='table1']//tr[4]/td[2] + +==== '''link='''''textPattern'' ==== +Select the link (anchor) element which contains text matching the specified ''pattern''. +* link=The link text + +Without a locator prefix, Selenium uses: + +* dom, for locators starting with "document." +* xpath, for locators starting with "//" +* identifier, otherwise + + +=== Select Option Specifiers === + +Select Option Specifiers provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Specifier. + +==== label=labelPattern ==== +matches options based on their labels, i.e. the visible text. +* label=regexp:^[Oo]ther + +==== value=valuePattern ==== +matches options based on their values. +* value=other + +==== id=id ==== +matches options based on their ids. +* id=option1 + +==== index=index ==== +matches an option based on its index (offset from zero). +* index=2 + +Without a prefix, the default behaviour is to only match on labels. + +String-match Patterns + + Various Pattern syntaxes are available for matching string values: + + glob:pattern + Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a kind of limited regular-expression syntax typically used in command-line shells. In a glob pattern, "*" represents any sequence of characters, and "?" represents any single character. Glob patterns match against the entire string. + regexp:regexp + Match a string using a regular-expression. The full power of JavaScript regular-expressions is available. + exact:string + Match a string exactly, verbatim, without any of that fancy wildcard stuff. + + If no pattern prefix is specified, Selenium assumes that it's a "glob" pattern. + +Selenium Actions + + Actions tell Selenium to do something in the application. They generally represent something a user would do. + + Many Actions can be called with the "AndWait" suffix. This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load. The exceptions to this pattern are the "open" and "click" actions, which will both wait for a page to load by default. + + open( url ) + + Opens a URL in the test frame. This accepts both relative and absolute URLs. + + Note: The URL must be on the same site as Selenium due to security restrictions in the browser (Cross Site Scripting). + + examples: + + open /mypage + open http://localhost/ + + click( elementLocator ) + + Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), use "clickAndWait". + + examples: + + click aCheckbox + clickAndWait submitButton + clickAndWait anyLink + + note: + Selenium will always automatically click on a popup dialog raised by the alert() or confirm() methods. (The exception is those raised during 'onload', which are not yet handled by Selenium). You must use [verify|assert]Alert or [verify|assert]Confirmation to tell Selenium that you expect the popup dialog. You may use chooseCancelOnNextConfirmation to click 'cancel' on the next confirmation dialog instead of clicking 'OK'. + + type( inputLocator, value ) + + Sets the value of an input field, as though you typed it in. + + Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text. + + examples: + + type nameField John Smith + typeAndWait textBoxThatSubmitsOnChange newValue + + select( dropDownLocator, optionSpecifier ) + + Select an option from a drop-down, based on the optionSpecifier. If more than one option matches the specifier (e.g. due to the use of globs like "f*b*", or due to more than one option having the same label or value), then the first matches is selected. + + examples: + + select dropDown Australian Dollars + select dropDown index=0 + selectAndWait currencySelector value=AUD + selectAndWait currencySelector label=Aus*lian D*rs + + selectWindow( windowId ) + + Selects a popup window. Once a popup window has been selected, all commands go to that window. To select the main window again, use "null" as the target. + + target: The id of the window to select. + + value: ignored + + examples: + + selectWindow myPopupWindow + selectWindow null + + goBack() + + Simulates the user clicking the "back" button on their browser. + + examples: + + goBack + + close() + + Simulates the user clicking the "close" button in the titlebar of a popup window. + + examples: + + close + + pause( milliseconds ) + + Pauses the execution of the test script for a specified amount of time. This is useful for debugging a script or pausing to wait for some server side action. + + examples: + + pause 5000 + pause 2000 + + fireEvent( elementLocator, eventName ) + + Explicitly simulate an event, to trigger the corresponding "onevent" handler. + + examples: + + fireEvent textField focus + fireEvent dropDown blur + + waitForValue( inputLocator, value ) + + Waits for a specified input (e.g. a hidden field) to have a specified value. Will succeed immediately if the input already has the value. This is implemented by polling for the value. Warning: can block indefinitely if the input never has the specified value. + + example: + + waitForValue finishIndication isfinished + + store( valueToStore, variableName ) + + Stores a value into a variable. The value can be constructed using either variable substitution or javascript evaluation, as detailed in 'Parameter construction and Variables' (below). + + examples: + + store Mr John Smith fullname + store ${title} ${firstname} ${surname} fullname + store javascript{Math.round(Math.PI * 100) / 100} PI + + storeValue( inputLocator, variableName ) + + Stores the value of an input field into a variable. + + examples: + + storeValue userName userID + type userName ${userID} + + storeText( elementLocator, variableName ) + + Stores the text of an element into a variable. + + examples: + + storeText currentDate expectedStartDate + verifyValue startDate ${expectedStartDate} + + storeAttribute( elementLocator@attributeName, variableName ) + + Stores the value of an element attribute into a variable. + + examples: + + storeAttribute input1@class classOfInput1 + verifyAttribute input2@class ${classOfInput1} + + chooseCancelOnNextConfirmation() + + Instructs Selenium to click Cancel on the next javascript confirmation dialog to be raised. By default, the confirm function will return true, having the same effect as manually clicking OK. After running this command, the next confirmation will behave as if the user had clicked Cancel. + + examples: + + chooseCancelOnNextConfirmation + + answerOnNextPrompt( answerString ) + + Instructs Selenium to return the specified answerString in response to the next prompt. + + examples: + + answerOnNextPrompt Kangaroo + +Selenium Checks + + Checks are used to verify the state of the application. They can be used to check the value of a form field, the presense of some text, or the URL of the current page. + + All Selenium Checks can be used in 2 modes, "assert" and "verify". These behave identically, except that when an "assert" check fails, the test is aborted. When a "verify" check fails, the test will continue execution. This allows a single "assert" to ensure that the application is on the correct page, followed by a bunch of "verify" checks to test form field values, labels, etc. + + assertLocation( relativeLocation ) + + examples: + + verifyLocation /mypage + assertLocation /mypage + + assertTitle( titlePattern ) + + Verifies the title of the current page. + + examples: + + verifyTitle My Page + assertTitle My Page + + assertValue( inputLocator, valuePattern ) + + Verifies the value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not. + + examples: + + verifyValue nameField John Smith + assertValue document.forms[2].nameField John Smith + + assertSelected( selectLocator, optionSpecifier ) + + Verifies that the selected option of a drop-down satisfies the optionSpecifier. + + examples: + + verifySelected dropdown2 John Smith + verifySelected dropdown2 value=js*123 + assertSelected document.forms[2].dropDown label=J* Smith + assertSelected document.forms[2].dropDown index=0 + + assertSelectOptions( selectLocator, optionLabelList ) + + Verifies the labels of all options in a drop-down against a comma-separated list. Commas in an expected option can be escaped as ",". + + examples: + + verifySelectOptions dropdown2 John Smith,Dave Bird + assertSelectOptions document.forms[2].dropDown Smith\, J,Bird\, D + + assertText( elementLocator, textPattern ) + + Verifies the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user. + + examples: + + verifyText statusMessage Successful + assertText //div[@id='foo']//h1 Successful + + assertAttribute( elementLocator@attributeName, valuePattern ) + + Verifies the value of an element attribute. + + examples: + + verifyAttribute txt1@class bigAndBold + assertAttribute document.images[0]@alt alt-text + verifyAttribute //img[@id='foo']/@alt alt-text + + assertTextPresent( text ) + + Verifies that the specified text appears somewhere on the rendered page shown to the user. + + examples: + + verifyTextPresent You are now logged in. + assertTextPresent You are now logged in. + + assertTextNotPresent( text ) + + Verifies that the specified text does NOT appear anywhere on the rendered page. + + assertElementPresent( elementLocator ) + + Verifies that the specified element is somewhere on the page. + + examples: + + verifyElementPresent submitButton + assertElementPresent //img[@alt='foo'] + + assertElementNotPresent( elementLocator ) + + Verifies that the specified element is NOT on the page. + + examples: + + verifyElementNotPresent cancelButton + assertElementNotPresent cancelButton + + assertTable( cellAddress, valuePattern ) + + Verifies the text in a cell of a table. The cellAddress syntax tableName.row.column, where row and column start at 0. + + examples: + + verifyTable myTable.1.6 Submitted + assertTable results.0.2 13 + + assertVisible( elementLocator ) + + Verifies that the specified element is both present and visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. + + examples: + + verifyVisible postcode + assertVisible postcode + + assertNotVisible( elementLocator ) + + Verifies that the specified element is NOT visible. Elements that are simply not present are also considered invisible. + + examples: + + verifyNotVisible postcode + assertNotVisible postcode + + verifyEditable / assertEditable( inputLocator ) + + Verifies that the specified element is editable, ie. it's an input element, and hasn't been disabled. + + examples: + + verifyEditable shape + assertEditable colour + + assertNotEditable( inputLocator ) + + Verifies that the specified element is NOT editable, ie. it's NOT an input element, or has been disabled. + + assertAlert( messagePattern ) + + Verifies that a javascript alert with the specified message was generated. Alerts must be verified in the same order that they were generated. + + Verifying an alert has the same effect as manually clicking OK. If an alert is generated but you do not verify it, the next Selenium action will fail. + + NOTE: under Selenium, javascript alerts will NOT pop up a visible alert dialog. + + NOTE: Selenium does NOT support javascript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK. + + examples: + + verifyAlert Invalid Phone Number + assertAlert Invalid Phone Number + + assertConfirmation( messagePattern ) + + Verifies that a javascript confirmation dialog with the specified message was generated. Like alerts, confirmations must be verified in the same order that they were generated. + + By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command (see above). If an confirmation is generated but you do not verify it, the next Selenium action will fail. + + NOTE: under Selenium, javascript confirmations will NOT pop up a visible dialog. + + NOTE: Selenium does NOT support javascript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK. + + examples: + + assertConfirmation Remove this user? + verifyConfirmation Are you sure? + + assertPrompt( messagePattern ) + + Verifies that a javascript prompt dialog with the specified message was generated. Like alerts, prompts must be verified in the same order that they were generated. + + Successful handling of the prompt requires prior execution of the answerOnNextPrompt command (see above). If a prompt is generated but you do not verify it, the next Selenium action will fail. + + examples: + + answerOnNextPrompt Joe + click id=delegate + verifyPrompt Delegate to who? + +Parameter construction and Variables + + All Selenium command parameters can be constructed using both simple variable substitution as well as full javascript. Both of these mechanisms can access previously stored variables, but do so using different syntax. + + Stored Variables + + The commands store, storeValue and storeText can be used to store a variable value for later access. Internally, these variables are stored in a map called "storedVars", with values keyed by the variable name. These commands are documented in the command reference. + + Variable substitution + + Variable substitution provides a simple way to include a previously stored variable in a command parameter. This is a simple mechanism, by which the variable to substitute is indicated by ${variableName}. Multiple variables can be substituted, and intermixed with static text. + + Example: + + store Mr title + storeValue nameField surname + store ${title} ${surname} fullname + type textElement Full name is: ${fullname} + + Javascript evaluation + + Javascript evaluation provides the full power of javascript in constructing a command parameter. To use this mechanism, the entire parameter value must be prefixed by 'javascript{' with a trailing '}'. The text inside the braces is evaluated as a javascript expression, and can access previously stored variables using the storedVars map detailed above. Note that variable substitution cannot be combined with javascript evaluation. + + Example: + + store javascript{'merchant' + (new Date()).getTime()} merchantId type textElement javascript{storedVars['merchantId'].toUpperCase()}
\ No newline at end of file diff --git a/tests/FunctionalTests/PradoTester.php b/tests/test_tools/functional_tests.php index 0c83217e..73bd6226 100644 --- a/tests/FunctionalTests/PradoTester.php +++ b/tests/test_tools/functional_tests.php @@ -1,54 +1,66 @@ -<?php
-
-$SIMPLE_TEST = dirname(__FILE__).'/../UnitTests';
-
-require_once($SIMPLE_TEST.'/simpletest/unit_tester.php');
-require_once($SIMPLE_TEST.'/simpletest/web_tester.php');
-require_once($SIMPLE_TEST.'/simpletest/mock_objects.php');
-require_once($SIMPLE_TEST.'/simpletest/reporter.php');
-require(dirname(__FILE__).'/selenium/php/selenium.php');
-
-class PradoTester
-{
- private $_name;
- private $_basePath;
-
- public function __construct($basePath,$name='All Tests')
- {
- $this->_name=$name;
- if($basePath==='' || ($this->_basePath=realpath($basePath))===false)
- throw new Exception('Invalid base path '.$basePath);
- $this->_basePath=strtr($this->_basePath,'\\','/');
- }
-
- public function run($simpleReporter)
- {
- $groupTest=new GroupTest($this->_name);
- $this->collectTestFiles($groupTest,$this->_basePath);
- $groupTest->run($simpleReporter);
-
- $server=SimpleSeleniumProxyServer::getInstance(dirname(__FILE__));
- $server->handleRequest();
- }
-
- protected function collectTestFiles($groupTest,$basePath)
- {
- $folder=@opendir($basePath);
- while($entry=@readdir($folder))
- {
- $fullPath=strtr($basePath.'/'.$entry,'\\','/');
- if(is_file($fullPath) && $this->isValidFile($entry))
- $groupTest->addTestFile($fullPath);
- else if($entry[0]!=='.')
- $this->collectTestFiles($groupTest,$fullPath);
- }
- @closedir($folder);
- }
-
- protected function isValidFile($entry)
- {
- return preg_match('/\w+\.php$/',$entry);
- }
-}
-
+<?php + +$TEST_TOOLS = dirname(__FILE__); + +if(isset($_GET['sr'])) +{ + + if(($selenium_resource=realpath($TEST_TOOLS.'/selenium/'.$_GET['sr']))!==false) + echo file_get_contents($selenium_resource); + exit; +} + +require_once($TEST_TOOLS.'/simpletest/unit_tester.php'); +require_once($TEST_TOOLS.'/simpletest/web_tester.php'); +require_once($TEST_TOOLS.'/simpletest/mock_objects.php'); +require_once($TEST_TOOLS.'/simpletest/reporter.php'); +require_once($TEST_TOOLS.'/selenium/php/selenium.php'); + +class PradoFunctionalTester +{ + private $_name; + private $_basePath; + private $_selenium; + + public function __construct($basePath,$selenium='',$name='All Tests') + { + $this->_name=$name; + if($basePath==='' || ($this->_basePath=realpath($basePath))===false) + throw new Exception('Invalid base path '.$basePath); + $this->_basePath=strtr($this->_basePath,'\\','/'); + + $this->_selenium = $selenium.'selenium/'; + } + + public function run($simpleReporter) + { + $server=SimpleSeleniumProxyServer::getInstance(dirname(__FILE__));//, '', $this->_selenium); + + $groupTest=new GroupTest($this->_name); + $this->collectTestFiles($groupTest,$this->_basePath); + $groupTest->run($simpleReporter); + + $server->handleRequest(); + } + + protected function collectTestFiles($groupTest,$basePath) + { + $folder=@opendir($basePath); + while($entry=@readdir($folder)) + { + $fullPath=strtr($basePath.'/'.$entry,'\\','/'); + if(is_file($fullPath) && $this->isValidFile($entry)) + $groupTest->addTestFile($fullPath); + else if($entry[0]!=='.') + $this->collectTestFiles($groupTest,$fullPath); + } + @closedir($folder); + } + + protected function isValidFile($entry) + { + return preg_match('/\w+\.php$/',$entry); + } +} + ?>
\ No newline at end of file diff --git a/tests/FunctionalTests/selenium/core/SeleniumLog.html b/tests/test_tools/selenium/core/SeleniumLog.html index 291e1f77..dfa0080a 100755..100644 --- a/tests/FunctionalTests/selenium/core/SeleniumLog.html +++ b/tests/test_tools/selenium/core/SeleniumLog.html @@ -2,7 +2,6 @@ <head> <title>Selenium Log Console</title> -<link id="cssLink" rel="stylesheet" href="selenium.css" /> </head> <body id="logging-console"> diff --git a/tests/FunctionalTests/selenium/core/TestRunner-splash.html b/tests/test_tools/selenium/core/TestRunner-splash.html index da2acdce..205bb8ef 100755..100644 --- a/tests/FunctionalTests/selenium/core/TestRunner-splash.html +++ b/tests/test_tools/selenium/core/TestRunner-splash.html @@ -1,55 +1,52 @@ -<!--
-Copyright 2005 ThoughtWorks, Inc
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<html>
-<link rel="stylesheet" type="text/css" href="selenium.css" />
-<body>
-<table width="100%">
-
-<tr>
- <th>↑</th>
- <th>↑</th>
- <th>↑</th>
-</tr>
-<tr>
- <th width="25%">Test Suite</th>
- <th width="50%">Current Test</th>
- <th width="25%">Control Panel</th>
-</tr>
-<tr><td> </td></tr>
-
-<tr>
-<td></td>
-<td class="selenium splash">
-
-<img src="selenium-logo.png" align="right">
-
-<h1>Selenium</h1>
-<h2>by <a href="http://www.thoughtworks.com">ThoughtWorks</a> and friends</h2>
-
-<p>
-For more information on Selenium, visit
-
-<pre>
- <a href="http://selenium.openqa.org" target="_blank">http://selenium.openqa.org</a>
-</pre>
-
-</td>
-<tr>
-
-</table>
-</body>
-</html>
+<!-- +Copyright 2005 ThoughtWorks, Inc + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> +<body> +<table width="100%"> + +<tr> + <th>↑</th> + <th>↑</th> + <th>↑</th> +</tr> +<tr> + <th width="25%">Test Suite</th> + <th width="50%">Current Test</th> + <th width="25%">Control Panel</th> +</tr> +<tr><td> </td></tr> + +<tr> +<td></td> +<td class="selenium splash"> + +<h1>Selenium</h1> +<h2>by <a href="http://www.thoughtworks.com">ThoughtWorks</a> and friends</h2> + +<p> +For more information on Selenium, visit + +<pre> + <a href="http://selenium.openqa.org" target="_blank">http://selenium.openqa.org</a> +</pre> + +</td> +<tr> + +</table> +</body> +</html> diff --git a/tests/FunctionalTests/selenium/core/scripts/find_matching_child.js b/tests/test_tools/selenium/core/scripts/find_matching_child.js index 5b635a27..197d1032 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/find_matching_child.js +++ b/tests/test_tools/selenium/core/scripts/find_matching_child.js @@ -1,69 +1,69 @@ -/*
- * Copyright 2004 ThoughtWorks, Inc
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-
-Element.findMatchingChildren = function(element, selector) {
- var matches = $A([]);
-
- var childCount = element.childNodes.length;
- for (var i=0; i<childCount; i++) {
- var child = element.childNodes[i];
- if (selector(child)) {
- matches.push(child);
- } else {
- childMatches = Element.findMatchingChildren(child, selector);
- matches.push(childMatches);
- }
- }
-
- return matches.flatten();
-}
-
-ELEMENT_NODE_TYPE = 1;
-
-Element.findFirstMatchingChild = function(element, selector) {
-
- var childCount = element.childNodes.length;
- for (var i=0; i<childCount; i++) {
- var child = element.childNodes[i];
- if (child.nodeType == ELEMENT_NODE_TYPE) {
- if (selector(child)) {
- return child;
- }
- result = Element.findFirstMatchingChild(child, selector);
- if (result) {
- return result;
- }
- }
- }
- return null;
-}
-
-Element.findFirstMatchingParent = function(element, selector) {
- var current = element.parentNode;
- while (current != null) {
- if (selector(current)) {
- break;
- }
- current = current.parentNode;
- }
- return current;
-}
-
-Element.findMatchingChildById = function(element, id) {
- return Element.findFirstMatchingChild(element, function(element){return element.id==id} );
-}
-
+/* + * Copyright 2004 ThoughtWorks, Inc + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +Element.findMatchingChildren = function(element, selector) { + var matches = $A([]); + + var childCount = element.childNodes.length; + for (var i=0; i<childCount; i++) { + var child = element.childNodes[i]; + if (selector(child)) { + matches.push(child); + } else { + childMatches = Element.findMatchingChildren(child, selector); + matches.push(childMatches); + } + } + + return matches.flatten(); +} + +ELEMENT_NODE_TYPE = 1; + +Element.findFirstMatchingChild = function(element, selector) { + + var childCount = element.childNodes.length; + for (var i=0; i<childCount; i++) { + var child = element.childNodes[i]; + if (child.nodeType == ELEMENT_NODE_TYPE) { + if (selector(child)) { + return child; + } + result = Element.findFirstMatchingChild(child, selector); + if (result) { + return result; + } + } + } + return null; +} + +Element.findFirstMatchingParent = function(element, selector) { + var current = element.parentNode; + while (current != null) { + if (selector(current)) { + break; + } + current = current.parentNode; + } + return current; +} + +Element.findMatchingChildById = function(element, id) { + return Element.findFirstMatchingChild(element, function(element){return element.id==id} ); +} + diff --git a/tests/FunctionalTests/selenium/core/scripts/htmlutils.js b/tests/test_tools/selenium/core/scripts/htmlutils.js index fcb1ee44..fcb1ee44 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/htmlutils.js +++ b/tests/test_tools/selenium/core/scripts/htmlutils.js diff --git a/tests/FunctionalTests/selenium/core/scripts/prototype-1.4.0.js b/tests/test_tools/selenium/core/scripts/prototype-1.4.0.js index 0e85338b..0e85338b 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/prototype-1.4.0.js +++ b/tests/test_tools/selenium/core/scripts/prototype-1.4.0.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-api.js b/tests/test_tools/selenium/core/scripts/selenium-api.js index ad0509ee..ad0509ee 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-api.js +++ b/tests/test_tools/selenium/core/scripts/selenium-api.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-browserbot.js b/tests/test_tools/selenium/core/scripts/selenium-browserbot.js index 8df46865..8df46865 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-browserbot.js +++ b/tests/test_tools/selenium/core/scripts/selenium-browserbot.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-browserdetect.js b/tests/test_tools/selenium/core/scripts/selenium-browserdetect.js index 137a1518..137a1518 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-browserdetect.js +++ b/tests/test_tools/selenium/core/scripts/selenium-browserdetect.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-commandhandlers.js b/tests/test_tools/selenium/core/scripts/selenium-commandhandlers.js index ee01ea76..ee01ea76 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-commandhandlers.js +++ b/tests/test_tools/selenium/core/scripts/selenium-commandhandlers.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-executionloop.js b/tests/test_tools/selenium/core/scripts/selenium-executionloop.js index 14c1a07a..14c1a07a 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-executionloop.js +++ b/tests/test_tools/selenium/core/scripts/selenium-executionloop.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-logging.js b/tests/test_tools/selenium/core/scripts/selenium-logging.js index b0fc67e4..b0fc67e4 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-logging.js +++ b/tests/test_tools/selenium/core/scripts/selenium-logging.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-seleneserunner.js b/tests/test_tools/selenium/core/scripts/selenium-seleneserunner.js index 041b3bf9..041b3bf9 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-seleneserunner.js +++ b/tests/test_tools/selenium/core/scripts/selenium-seleneserunner.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-testrunner.js b/tests/test_tools/selenium/core/scripts/selenium-testrunner.js index 1ced0a11..1ced0a11 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-testrunner.js +++ b/tests/test_tools/selenium/core/scripts/selenium-testrunner.js diff --git a/tests/FunctionalTests/selenium/core/scripts/selenium-version.js b/tests/test_tools/selenium/core/scripts/selenium-version.js index 1fee837b..1fee837b 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/selenium-version.js +++ b/tests/test_tools/selenium/core/scripts/selenium-version.js diff --git a/tests/FunctionalTests/selenium/core/scripts/user-extensions.js.sample b/tests/test_tools/selenium/core/scripts/user-extensions.js.sample index 0f0ca840..0f0ca840 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/user-extensions.js.sample +++ b/tests/test_tools/selenium/core/scripts/user-extensions.js.sample diff --git a/tests/FunctionalTests/selenium/core/scripts/xmlextras.js b/tests/test_tools/selenium/core/scripts/xmlextras.js index 267aa058..267aa058 100755..100644 --- a/tests/FunctionalTests/selenium/core/scripts/xmlextras.js +++ b/tests/test_tools/selenium/core/scripts/xmlextras.js diff --git a/tests/FunctionalTests/selenium/core/selenium.css b/tests/test_tools/selenium/core/selenium.css index 6e9f3f30..6e9f3f30 100755..100644 --- a/tests/FunctionalTests/selenium/core/selenium.css +++ b/tests/test_tools/selenium/core/selenium.css diff --git a/tests/FunctionalTests/selenium/core/xpath/dom.js b/tests/test_tools/selenium/core/xpath/dom.js index 5e49748c..85e0ab08 100755..100644 --- a/tests/FunctionalTests/selenium/core/xpath/dom.js +++ b/tests/test_tools/selenium/core/xpath/dom.js @@ -1,428 +1,428 @@ -// Copyright 2005 Google Inc.
-// All Rights Reserved
-//
-// An XML parse and a minimal DOM implementation that just supportes
-// the subset of the W3C DOM that is used in the XSLT implementation.
-//
-// References:
-//
-// [DOM] W3C DOM Level 3 Core Specification
-// <http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/>.
-//
-//
-// Author: Steffen Meschkat <mesch@google.com>
-
-// NOTE: The split() method in IE omits empty result strings. This is
-// utterly annoying. So we don't use it here.
-
-// Resolve entities in XML text fragments. According to the DOM
-// specification, the DOM is supposed to resolve entity references at
-// the API level. I.e. no entity references are passed through the
-// API. See "Entities and the DOM core", p.12, DOM 2 Core
-// Spec. However, different browsers actually pass very different
-// values at the API.
-//
-function xmlResolveEntities(s) {
-
- var parts = stringSplit(s, '&');
-
- var ret = parts[0];
- for (var i = 1; i < parts.length; ++i) {
- var rp = stringSplit(parts[i], ';');
- if (rp.length == 1) {
- // no entity reference: just a & but no ;
- ret += parts[i];
- continue;
- }
-
- var ch;
- switch (rp[0]) {
- case 'lt':
- ch = '<';
- break;
- case 'gt':
- ch = '>';
- break;
- case 'amp':
- ch = '&';
- break;
- case 'quot':
- ch = '"';
- break;
- case 'apos':
- ch = '\'';
- break;
- case 'nbsp':
- ch = String.fromCharCode(160);
- break;
- default:
- // Cool trick: let the DOM do the entity decoding. We assign
- // the entity text through non-W3C DOM properties and read it
- // through the W3C DOM. W3C DOM access is specified to resolve
- // entities.
- var span = window.document.createElement('span');
- span.innerHTML = '&' + rp[0] + '; ';
- ch = span.childNodes[0].nodeValue.charAt(0);
- }
- ret += ch + rp[1];
- }
-
- return ret;
-}
-
-
-// Parses the given XML string with our custom, JavaScript XML parser. Written
-// by Steffen Meschkat (mesch@google.com).
-function xmlParse(xml) {
- Timer.start('xmlparse');
- var regex_empty = /\/$/;
-
- // See also <http://www.w3.org/TR/REC-xml/#sec-common-syn> for
- // allowed chars in a tag and attribute name. TODO(mesch): the
- // following is still not completely correct.
-
- var regex_tagname = /^([\w:-]*)/;
- var regex_attribute = /([\w:-]+)\s?=\s?('([^\']*)'|"([^\"]*)")/g;
-
- var xmldoc = new XDocument();
- var root = xmldoc;
-
- // For the record: in Safari, we would create native DOM nodes, but
- // in Opera that is not possible, because the DOM only allows HTML
- // element nodes to be created, so we have to do our own DOM nodes.
-
- // xmldoc = document.implementation.createDocument('','',null);
- // root = xmldoc; // .createDocumentFragment();
- // NOTE(mesch): using the DocumentFragment instead of the Document
- // crashes my Safari 1.2.4 (v125.12).
- var stack = [];
-
- var parent = root;
- stack.push(parent);
-
- var x = stringSplit(xml, '<');
- for (var i = 1; i < x.length; ++i) {
- var xx = stringSplit(x[i], '>');
- var tag = xx[0];
- var text = xmlResolveEntities(xx[1] || '');
-
- if (tag.charAt(0) == '/') {
- stack.pop();
- parent = stack[stack.length-1];
-
- } else if (tag.charAt(0) == '?') {
- // Ignore XML declaration and processing instructions
- } else if (tag.charAt(0) == '!') {
- // Ignore notation and comments
- } else {
- var empty = tag.match(regex_empty);
- var tagname = regex_tagname.exec(tag)[1];
- var node = xmldoc.createElement(tagname);
-
- var att;
- while (att = regex_attribute.exec(tag)) {
- var val = xmlResolveEntities(att[3] || att[4] || '');
- node.setAttribute(att[1], val);
- }
-
- if (empty) {
- parent.appendChild(node);
- } else {
- parent.appendChild(node);
- parent = node;
- stack.push(node);
- }
- }
-
- if (text && parent != root) {
- parent.appendChild(xmldoc.createTextNode(text));
- }
- }
-
- Timer.end('xmlparse');
- return root;
-}
-
-
-// Our W3C DOM Node implementation. Note we call it XNode because we
-// can't define the identifier Node. We do this mostly for Opera,
-// where we can't reuse the HTML DOM for parsing our own XML, and for
-// Safari, where it is too expensive to have the template processor
-// operate on native DOM nodes.
-function XNode(type, name, value, owner) {
- this.attributes = [];
- this.childNodes = [];
-
- XNode.init.call(this, type, name, value, owner);
-}
-
-// Don't call as method, use apply() or call().
-XNode.init = function(type, name, value, owner) {
- this.nodeType = type - 0;
- this.nodeName = '' + name;
- this.nodeValue = '' + value;
- this.ownerDocument = owner;
-
- this.firstChild = null;
- this.lastChild = null;
- this.nextSibling = null;
- this.previousSibling = null;
- this.parentNode = null;
-}
-
-XNode.unused_ = [];
-
-XNode.recycle = function(node) {
- if (!node) {
- return;
- }
-
- if (node.constructor == XDocument) {
- XNode.recycle(node.documentElement);
- return;
- }
-
- if (node.constructor != this) {
- return;
- }
-
- XNode.unused_.push(node);
- for (var a = 0; a < node.attributes.length; ++a) {
- XNode.recycle(node.attributes[a]);
- }
- for (var c = 0; c < node.childNodes.length; ++c) {
- XNode.recycle(node.childNodes[c]);
- }
- node.attributes.length = 0;
- node.childNodes.length = 0;
- XNode.init.call(node, 0, '', '', null);
-}
-
-XNode.create = function(type, name, value, owner) {
- if (XNode.unused_.length > 0) {
- var node = XNode.unused_.pop();
- XNode.init.call(node, type, name, value, owner);
- return node;
- } else {
- return new XNode(type, name, value, owner);
- }
-}
-
-XNode.prototype.appendChild = function(node) {
- // firstChild
- if (this.childNodes.length == 0) {
- this.firstChild = node;
- }
-
- // previousSibling
- node.previousSibling = this.lastChild;
-
- // nextSibling
- node.nextSibling = null;
- if (this.lastChild) {
- this.lastChild.nextSibling = node;
- }
-
- // parentNode
- node.parentNode = this;
-
- // lastChild
- this.lastChild = node;
-
- // childNodes
- this.childNodes.push(node);
-}
-
-
-XNode.prototype.replaceChild = function(newNode, oldNode) {
- if (oldNode == newNode) {
- return;
- }
-
- for (var i = 0; i < this.childNodes.length; ++i) {
- if (this.childNodes[i] == oldNode) {
- this.childNodes[i] = newNode;
-
- var p = oldNode.parentNode;
- oldNode.parentNode = null;
- newNode.parentNode = p;
-
- p = oldNode.previousSibling;
- oldNode.previousSibling = null;
- newNode.previousSibling = p;
- if (newNode.previousSibling) {
- newNode.previousSibling.nextSibling = newNode;
- }
-
- p = oldNode.nextSibling;
- oldNode.nextSibling = null;
- newNode.nextSibling = p;
- if (newNode.nextSibling) {
- newNode.nextSibling.previousSibling = newNode;
- }
-
- if (this.firstChild == oldNode) {
- this.firstChild = newNode;
- }
-
- if (this.lastChild == oldNode) {
- this.lastChild = newNode;
- }
-
- break;
- }
- }
-}
-
-XNode.prototype.insertBefore = function(newNode, oldNode) {
- if (oldNode == newNode) {
- return;
- }
-
- if (oldNode.parentNode != this) {
- return;
- }
-
- if (newNode.parentNode) {
- newNode.parentNode.removeChild(newNode);
- }
-
- var newChildren = [];
- for (var i = 0; i < this.childNodes.length; ++i) {
- var c = this.childNodes[i];
- if (c == oldNode) {
- newChildren.push(newNode);
-
- newNode.parentNode = this;
-
- newNode.previousSibling = oldNode.previousSibling;
- oldNode.previousSibling = newNode;
- if (newNode.previousSibling) {
- newNode.previousSibling.nextSibling = newNode;
- }
-
- newNode.nextSibling = oldNode;
-
- if (this.firstChild == oldNode) {
- this.firstChild = newNode;
- }
- }
- newChildren.push(c);
- }
- this.childNodes = newChildren;
-}
-
-XNode.prototype.removeChild = function(node) {
- var newChildren = [];
- for (var i = 0; i < this.childNodes.length; ++i) {
- var c = this.childNodes[i];
- if (c != node) {
- newChildren.push(c);
- } else {
- if (c.previousSibling) {
- c.previousSibling.nextSibling = c.nextSibling;
- }
- if (c.nextSibling) {
- c.nextSibling.previousSibling = c.previousSibling;
- }
- if (this.firstChild == c) {
- this.firstChild = c.nextSibling;
- }
- if (this.lastChild == c) {
- this.lastChild = c.previousSibling;
- }
- }
- }
- this.childNodes = newChildren;
-}
-
-
-XNode.prototype.hasAttributes = function() {
- return this.attributes.length > 0;
-}
-
-
-XNode.prototype.setAttribute = function(name, value) {
- for (var i = 0; i < this.attributes.length; ++i) {
- if (this.attributes[i].nodeName == name) {
- this.attributes[i].nodeValue = '' + value;
- return;
- }
- }
- this.attributes.push(new XNode(DOM_ATTRIBUTE_NODE, name, value));
-}
-
-
-XNode.prototype.getAttribute = function(name) {
- for (var i = 0; i < this.attributes.length; ++i) {
- if (this.attributes[i].nodeName == name) {
- return this.attributes[i].nodeValue;
- }
- }
- return null;
-}
-
-XNode.prototype.removeAttribute = function(name) {
- var a = [];
- for (var i = 0; i < this.attributes.length; ++i) {
- if (this.attributes[i].nodeName != name) {
- a.push(this.attributes[i]);
- }
- }
- this.attributes = a;
-}
-
-
-function XDocument() {
- XNode.call(this, DOM_DOCUMENT_NODE, '#document', null, this);
- this.documentElement = null;
-}
-
-XDocument.prototype = new XNode(DOM_DOCUMENT_NODE, '#document');
-
-XDocument.prototype.clear = function() {
- XNode.recycle(this.documentElement);
- this.documentElement = null;
-}
-
-XDocument.prototype.appendChild = function(node) {
- XNode.prototype.appendChild.call(this, node);
- this.documentElement = this.childNodes[0];
-}
-
-XDocument.prototype.createElement = function(name) {
- return XNode.create(DOM_ELEMENT_NODE, name, null, this);
-}
-
-XDocument.prototype.createDocumentFragment = function() {
- return XNode.create(DOM_DOCUMENT_FRAGMENT_NODE, '#document-fragment',
- null, this);
-}
-
-XDocument.prototype.createTextNode = function(value) {
- return XNode.create(DOM_TEXT_NODE, '#text', value, this);
-}
-
-XDocument.prototype.createAttribute = function(name) {
- return XNode.create(DOM_ATTRIBUTE_NODE, name, null, this);
-}
-
-XDocument.prototype.createComment = function(data) {
- return XNode.create(DOM_COMMENT_NODE, '#comment', data, this);
-}
-
-XNode.prototype.getElementsByTagName = function(name, list) {
- if (!list) {
- list = [];
- }
-
- if (this.nodeName == name) {
- list.push(this);
- }
-
- for (var i = 0; i < this.childNodes.length; ++i) {
- this.childNodes[i].getElementsByTagName(name, list);
- }
-
- return list;
-}
+// Copyright 2005 Google Inc. +// All Rights Reserved +// +// An XML parse and a minimal DOM implementation that just supportes +// the subset of the W3C DOM that is used in the XSLT implementation. +// +// References: +// +// [DOM] W3C DOM Level 3 Core Specification +// <http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/>. +// +// +// Author: Steffen Meschkat <mesch@google.com> + +// NOTE: The split() method in IE omits empty result strings. This is +// utterly annoying. So we don't use it here. + +// Resolve entities in XML text fragments. According to the DOM +// specification, the DOM is supposed to resolve entity references at +// the API level. I.e. no entity references are passed through the +// API. See "Entities and the DOM core", p.12, DOM 2 Core +// Spec. However, different browsers actually pass very different +// values at the API. +// +function xmlResolveEntities(s) { + + var parts = stringSplit(s, '&'); + + var ret = parts[0]; + for (var i = 1; i < parts.length; ++i) { + var rp = stringSplit(parts[i], ';'); + if (rp.length == 1) { + // no entity reference: just a & but no ; + ret += parts[i]; + continue; + } + + var ch; + switch (rp[0]) { + case 'lt': + ch = '<'; + break; + case 'gt': + ch = '>'; + break; + case 'amp': + ch = '&'; + break; + case 'quot': + ch = '"'; + break; + case 'apos': + ch = '\''; + break; + case 'nbsp': + ch = String.fromCharCode(160); + break; + default: + // Cool trick: let the DOM do the entity decoding. We assign + // the entity text through non-W3C DOM properties and read it + // through the W3C DOM. W3C DOM access is specified to resolve + // entities. + var span = window.document.createElement('span'); + span.innerHTML = '&' + rp[0] + '; '; + ch = span.childNodes[0].nodeValue.charAt(0); + } + ret += ch + rp[1]; + } + + return ret; +} + + +// Parses the given XML string with our custom, JavaScript XML parser. Written +// by Steffen Meschkat (mesch@google.com). +function xmlParse(xml) { + Timer.start('xmlparse'); + var regex_empty = /\/$/; + + // See also <http://www.w3.org/TR/REC-xml/#sec-common-syn> for + // allowed chars in a tag and attribute name. TODO(mesch): the + // following is still not completely correct. + + var regex_tagname = /^([\w:-]*)/; + var regex_attribute = /([\w:-]+)\s?=\s?('([^\']*)'|"([^\"]*)")/g; + + var xmldoc = new XDocument(); + var root = xmldoc; + + // For the record: in Safari, we would create native DOM nodes, but + // in Opera that is not possible, because the DOM only allows HTML + // element nodes to be created, so we have to do our own DOM nodes. + + // xmldoc = document.implementation.createDocument('','',null); + // root = xmldoc; // .createDocumentFragment(); + // NOTE(mesch): using the DocumentFragment instead of the Document + // crashes my Safari 1.2.4 (v125.12). + var stack = []; + + var parent = root; + stack.push(parent); + + var x = stringSplit(xml, '<'); + for (var i = 1; i < x.length; ++i) { + var xx = stringSplit(x[i], '>'); + var tag = xx[0]; + var text = xmlResolveEntities(xx[1] || ''); + + if (tag.charAt(0) == '/') { + stack.pop(); + parent = stack[stack.length-1]; + + } else if (tag.charAt(0) == '?') { + // Ignore XML declaration and processing instructions + } else if (tag.charAt(0) == '!') { + // Ignore notation and comments + } else { + var empty = tag.match(regex_empty); + var tagname = regex_tagname.exec(tag)[1]; + var node = xmldoc.createElement(tagname); + + var att; + while (att = regex_attribute.exec(tag)) { + var val = xmlResolveEntities(att[3] || att[4] || ''); + node.setAttribute(att[1], val); + } + + if (empty) { + parent.appendChild(node); + } else { + parent.appendChild(node); + parent = node; + stack.push(node); + } + } + + if (text && parent != root) { + parent.appendChild(xmldoc.createTextNode(text)); + } + } + + Timer.end('xmlparse'); + return root; +} + + +// Our W3C DOM Node implementation. Note we call it XNode because we +// can't define the identifier Node. We do this mostly for Opera, +// where we can't reuse the HTML DOM for parsing our own XML, and for +// Safari, where it is too expensive to have the template processor +// operate on native DOM nodes. +function XNode(type, name, value, owner) { + this.attributes = []; + this.childNodes = []; + + XNode.init.call(this, type, name, value, owner); +} + +// Don't call as method, use apply() or call(). +XNode.init = function(type, name, value, owner) { + this.nodeType = type - 0; + this.nodeName = '' + name; + this.nodeValue = '' + value; + this.ownerDocument = owner; + + this.firstChild = null; + this.lastChild = null; + this.nextSibling = null; + this.previousSibling = null; + this.parentNode = null; +} + +XNode.unused_ = []; + +XNode.recycle = function(node) { + if (!node) { + return; + } + + if (node.constructor == XDocument) { + XNode.recycle(node.documentElement); + return; + } + + if (node.constructor != this) { + return; + } + + XNode.unused_.push(node); + for (var a = 0; a < node.attributes.length; ++a) { + XNode.recycle(node.attributes[a]); + } + for (var c = 0; c < node.childNodes.length; ++c) { + XNode.recycle(node.childNodes[c]); + } + node.attributes.length = 0; + node.childNodes.length = 0; + XNode.init.call(node, 0, '', '', null); +} + +XNode.create = function(type, name, value, owner) { + if (XNode.unused_.length > 0) { + var node = XNode.unused_.pop(); + XNode.init.call(node, type, name, value, owner); + return node; + } else { + return new XNode(type, name, value, owner); + } +} + +XNode.prototype.appendChild = function(node) { + // firstChild + if (this.childNodes.length == 0) { + this.firstChild = node; + } + + // previousSibling + node.previousSibling = this.lastChild; + + // nextSibling + node.nextSibling = null; + if (this.lastChild) { + this.lastChild.nextSibling = node; + } + + // parentNode + node.parentNode = this; + + // lastChild + this.lastChild = node; + + // childNodes + this.childNodes.push(node); +} + + +XNode.prototype.replaceChild = function(newNode, oldNode) { + if (oldNode == newNode) { + return; + } + + for (var i = 0; i < this.childNodes.length; ++i) { + if (this.childNodes[i] == oldNode) { + this.childNodes[i] = newNode; + + var p = oldNode.parentNode; + oldNode.parentNode = null; + newNode.parentNode = p; + + p = oldNode.previousSibling; + oldNode.previousSibling = null; + newNode.previousSibling = p; + if (newNode.previousSibling) { + newNode.previousSibling.nextSibling = newNode; + } + + p = oldNode.nextSibling; + oldNode.nextSibling = null; + newNode.nextSibling = p; + if (newNode.nextSibling) { + newNode.nextSibling.previousSibling = newNode; + } + + if (this.firstChild == oldNode) { + this.firstChild = newNode; + } + + if (this.lastChild == oldNode) { + this.lastChild = newNode; + } + + break; + } + } +} + +XNode.prototype.insertBefore = function(newNode, oldNode) { + if (oldNode == newNode) { + return; + } + + if (oldNode.parentNode != this) { + return; + } + + if (newNode.parentNode) { + newNode.parentNode.removeChild(newNode); + } + + var newChildren = []; + for (var i = 0; i < this.childNodes.length; ++i) { + var c = this.childNodes[i]; + if (c == oldNode) { + newChildren.push(newNode); + + newNode.parentNode = this; + + newNode.previousSibling = oldNode.previousSibling; + oldNode.previousSibling = newNode; + if (newNode.previousSibling) { + newNode.previousSibling.nextSibling = newNode; + } + + newNode.nextSibling = oldNode; + + if (this.firstChild == oldNode) { + this.firstChild = newNode; + } + } + newChildren.push(c); + } + this.childNodes = newChildren; +} + +XNode.prototype.removeChild = function(node) { + var newChildren = []; + for (var i = 0; i < this.childNodes.length; ++i) { + var c = this.childNodes[i]; + if (c != node) { + newChildren.push(c); + } else { + if (c.previousSibling) { + c.previousSibling.nextSibling = c.nextSibling; + } + if (c.nextSibling) { + c.nextSibling.previousSibling = c.previousSibling; + } + if (this.firstChild == c) { + this.firstChild = c.nextSibling; + } + if (this.lastChild == c) { + this.lastChild = c.previousSibling; + } + } + } + this.childNodes = newChildren; +} + + +XNode.prototype.hasAttributes = function() { + return this.attributes.length > 0; +} + + +XNode.prototype.setAttribute = function(name, value) { + for (var i = 0; i < this.attributes.length; ++i) { + if (this.attributes[i].nodeName == name) { + this.attributes[i].nodeValue = '' + value; + return; + } + } + this.attributes.push(new XNode(DOM_ATTRIBUTE_NODE, name, value)); +} + + +XNode.prototype.getAttribute = function(name) { + for (var i = 0; i < this.attributes.length; ++i) { + if (this.attributes[i].nodeName == name) { + return this.attributes[i].nodeValue; + } + } + return null; +} + +XNode.prototype.removeAttribute = function(name) { + var a = []; + for (var i = 0; i < this.attributes.length; ++i) { + if (this.attributes[i].nodeName != name) { + a.push(this.attributes[i]); + } + } + this.attributes = a; +} + + +function XDocument() { + XNode.call(this, DOM_DOCUMENT_NODE, '#document', null, this); + this.documentElement = null; +} + +XDocument.prototype = new XNode(DOM_DOCUMENT_NODE, '#document'); + +XDocument.prototype.clear = function() { + XNode.recycle(this.documentElement); + this.documentElement = null; +} + +XDocument.prototype.appendChild = function(node) { + XNode.prototype.appendChild.call(this, node); + this.documentElement = this.childNodes[0]; +} + +XDocument.prototype.createElement = function(name) { + return XNode.create(DOM_ELEMENT_NODE, name, null, this); +} + +XDocument.prototype.createDocumentFragment = function() { + return XNode.create(DOM_DOCUMENT_FRAGMENT_NODE, '#document-fragment', + null, this); +} + +XDocument.prototype.createTextNode = function(value) { + return XNode.create(DOM_TEXT_NODE, '#text', value, this); +} + +XDocument.prototype.createAttribute = function(name) { + return XNode.create(DOM_ATTRIBUTE_NODE, name, null, this); +} + +XDocument.prototype.createComment = function(data) { + return XNode.create(DOM_COMMENT_NODE, '#comment', data, this); +} + +XNode.prototype.getElementsByTagName = function(name, list) { + if (!list) { + list = []; + } + + if (this.nodeName == name) { + list.push(this); + } + + for (var i = 0; i < this.childNodes.length; ++i) { + this.childNodes[i].getElementsByTagName(name, list); + } + + return list; +} diff --git a/tests/FunctionalTests/selenium/core/xpath/misc.js b/tests/test_tools/selenium/core/xpath/misc.js index 9017542e..b9573a22 100755..100644 --- a/tests/FunctionalTests/selenium/core/xpath/misc.js +++ b/tests/test_tools/selenium/core/xpath/misc.js @@ -1,255 +1,255 @@ -// Copyright 2005 Google Inc.
-// All Rights Reserved
-//
-// Miscellania that support the ajaxslt implementation.
-//
-// Author: Steffen Meschkat <mesch@google.com>
-//
-
-function el(i) {
- return document.getElementById(i);
-}
-
-function px(x) {
- return x + 'px';
-}
-
-// Split a string s at all occurrences of character c. This is like
-// the split() method of the string object, but IE omits empty
-// strings, which violates the invariant (s.split(x).join(x) == s).
-function stringSplit(s, c) {
- var a = s.indexOf(c);
- if (a == -1) {
- return [ s ];
- }
-
- var parts = [];
- parts.push(s.substr(0,a));
- while (a != -1) {
- var a1 = s.indexOf(c, a + 1);
- if (a1 != -1) {
- parts.push(s.substr(a + 1, a1 - a - 1));
- } else {
- parts.push(s.substr(a + 1));
- }
- a = a1;
- }
-
- return parts;
-}
-
-// Returns the text value if a node; for nodes without children this
-// is the nodeValue, for nodes with children this is the concatenation
-// of the value of all children.
-function xmlValue(node) {
- if (!node) {
- return '';
- }
-
- var ret = '';
- if (node.nodeType == DOM_TEXT_NODE ||
- node.nodeType == DOM_CDATA_SECTION_NODE ||
- node.nodeType == DOM_ATTRIBUTE_NODE) {
- ret += node.nodeValue;
-
- } else if (node.nodeType == DOM_ELEMENT_NODE ||
- node.nodeType == DOM_DOCUMENT_NODE ||
- node.nodeType == DOM_DOCUMENT_FRAGMENT_NODE) {
- for (var i = 0; i < node.childNodes.length; ++i) {
- ret += arguments.callee(node.childNodes[i]);
- }
- }
- return ret;
-}
-
-// Returns the representation of a node as XML text.
-function xmlText(node) {
- var ret = '';
- if (node.nodeType == DOM_TEXT_NODE) {
- ret += xmlEscapeText(node.nodeValue);
-
- } else if (node.nodeType == DOM_ELEMENT_NODE) {
- ret += '<' + node.nodeName;
- for (var i = 0; i < node.attributes.length; ++i) {
- var a = node.attributes[i];
- if (a && a.nodeName && a.nodeValue) {
- ret += ' ' + a.nodeName;
- ret += '="' + xmlEscapeAttr(a.nodeValue) + '"';
- }
- }
-
- if (node.childNodes.length == 0) {
- ret += '/>';
-
- } else {
- ret += '>';
- for (var i = 0; i < node.childNodes.length; ++i) {
- ret += arguments.callee(node.childNodes[i]);
- }
- ret += '</' + node.nodeName + '>';
- }
-
- } else if (node.nodeType == DOM_DOCUMENT_NODE ||
- node.nodeType == DOM_DOCUMENT_FRAGMENT_NODE) {
- for (var i = 0; i < node.childNodes.length; ++i) {
- ret += arguments.callee(node.childNodes[i]);
- }
- }
-
- return ret;
-}
-
-// Applies the given function to each element of the array.
-function mapExec(array, func) {
- for (var i = 0; i < array.length; ++i) {
- func(array[i]);
- }
-}
-
-// Returns an array that contains the return value of the given
-// function applied to every element of the input array.
-function mapExpr(array, func) {
- var ret = [];
- for (var i = 0; i < array.length; ++i) {
- ret.push(func(array[i]));
- }
- return ret;
-};
-
-// Reverses the given array in place.
-function reverseInplace(array) {
- for (var i = 0; i < array.length / 2; ++i) {
- var h = array[i];
- var ii = array.length - i - 1;
- array[i] = array[ii];
- array[ii] = h;
- }
-}
-
-// Shallow-copies an array.
-function copyArray(dst, src) {
- for (var i = 0; i < src.length; ++i) {
- dst.push(src[i]);
- }
-}
-
-function assert(b) {
- if (!b) {
- throw 'assertion failed';
- }
-}
-
-// Based on
-// <http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1950641247>
-var DOM_ELEMENT_NODE = 1;
-var DOM_ATTRIBUTE_NODE = 2;
-var DOM_TEXT_NODE = 3;
-var DOM_CDATA_SECTION_NODE = 4;
-var DOM_ENTITY_REFERENCE_NODE = 5;
-var DOM_ENTITY_NODE = 6;
-var DOM_PROCESSING_INSTRUCTION_NODE = 7;
-var DOM_COMMENT_NODE = 8;
-var DOM_DOCUMENT_NODE = 9;
-var DOM_DOCUMENT_TYPE_NODE = 10;
-var DOM_DOCUMENT_FRAGMENT_NODE = 11;
-var DOM_NOTATION_NODE = 12;
-
-
-var xpathdebug = false; // trace xpath parsing
-var xsltdebug = false; // trace xslt processing
-
-
-// Escape XML special markup chracters: tag delimiter < > and entity
-// reference start delimiter &. The escaped string can be used in XML
-// text portions (i.e. between tags).
-function xmlEscapeText(s) {
- return s.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>');
-}
-
-// Escape XML special markup characters: tag delimiter < > entity
-// reference start delimiter & and quotes ". The escaped string can be
-// used in double quoted XML attribute value portions (i.e. in
-// attributes within start tags).
-function xmlEscapeAttr(s) {
- return xmlEscapeText(s).replace(/\"/g, '"');
-}
-
-// Escape markup in XML text, but don't touch entity references. The
-// escaped string can be used as XML text (i.e. between tags).
-function xmlEscapeTags(s) {
- return s.replace(/</g, '<').replace(/>/g, '>');
-}
-
-// An implementation of the debug log.
-
-var logging__ = false;
-
-function Log() {};
-
-Log.lines = [];
-
-Log.write = function(s) {
- if (logging__) {
- this.lines.push(xmlEscapeText(s));
- this.show();
- }
-};
-
-// Writes the given XML with every tag on a new line.
-Log.writeXML = function(xml) {
- if (logging__) {
- var s0 = xml.replace(/</g, '\n<');
- var s1 = xmlEscapeText(s0);
- var s2 = s1.replace(/\s*\n(\s|\n)*/g, '<br/>');
- this.lines.push(s2);
- this.show();
- }
-}
-
-// Writes without any escaping
-Log.writeRaw = function(s) {
- if (logging__) {
- this.lines.push(s);
- this.show();
- }
-}
-
-Log.clear = function() {
- if (logging__) {
- var l = this.div();
- l.innerHTML = '';
- this.lines = [];
- }
-}
-
-Log.show = function() {
- var l = this.div();
- l.innerHTML += this.lines.join('<br/>') + '<br/>';
- this.lines = [];
- l.scrollTop = l.scrollHeight;
-}
-
-Log.div = function() {
- var l = document.getElementById('log');
- if (!l) {
- l = document.createElement('div');
- l.id = 'log';
- l.style.position = 'absolute';
- l.style.right = '5px';
- l.style.top = '5px';
- l.style.width = '250px';
- l.style.height = '150px';
- l.style.overflow = 'auto';
- l.style.backgroundColor = '#f0f0f0';
- l.style.border = '1px solid gray';
- l.style.fontSize = '10px';
- l.style.padding = '5px';
- document.body.appendChild(l);
- }
- return l;
-}
-
-
-function Timer() {}
-Timer.start = function() {}
-Timer.end = function() {}
+// Copyright 2005 Google Inc. +// All Rights Reserved +// +// Miscellania that support the ajaxslt implementation. +// +// Author: Steffen Meschkat <mesch@google.com> +// + +function el(i) { + return document.getElementById(i); +} + +function px(x) { + return x + 'px'; +} + +// Split a string s at all occurrences of character c. This is like +// the split() method of the string object, but IE omits empty +// strings, which violates the invariant (s.split(x).join(x) == s). +function stringSplit(s, c) { + var a = s.indexOf(c); + if (a == -1) { + return [ s ]; + } + + var parts = []; + parts.push(s.substr(0,a)); + while (a != -1) { + var a1 = s.indexOf(c, a + 1); + if (a1 != -1) { + parts.push(s.substr(a + 1, a1 - a - 1)); + } else { + parts.push(s.substr(a + 1)); + } + a = a1; + } + + return parts; +} + +// Returns the text value if a node; for nodes without children this +// is the nodeValue, for nodes with children this is the concatenation +// of the value of all children. +function xmlValue(node) { + if (!node) { + return ''; + } + + var ret = ''; + if (node.nodeType == DOM_TEXT_NODE || + node.nodeType == DOM_CDATA_SECTION_NODE || + node.nodeType == DOM_ATTRIBUTE_NODE) { + ret += node.nodeValue; + + } else if (node.nodeType == DOM_ELEMENT_NODE || + node.nodeType == DOM_DOCUMENT_NODE || + node.nodeType == DOM_DOCUMENT_FRAGMENT_NODE) { + for (var i = 0; i < node.childNodes.length; ++i) { + ret += arguments.callee(node.childNodes[i]); + } + } + return ret; +} + +// Returns the representation of a node as XML text. +function xmlText(node) { + var ret = ''; + if (node.nodeType == DOM_TEXT_NODE) { + ret += xmlEscapeText(node.nodeValue); + + } else if (node.nodeType == DOM_ELEMENT_NODE) { + ret += '<' + node.nodeName; + for (var i = 0; i < node.attributes.length; ++i) { + var a = node.attributes[i]; + if (a && a.nodeName && a.nodeValue) { + ret += ' ' + a.nodeName; + ret += '="' + xmlEscapeAttr(a.nodeValue) + '"'; + } + } + + if (node.childNodes.length == 0) { + ret += '/>'; + + } else { + ret += '>'; + for (var i = 0; i < node.childNodes.length; ++i) { + ret += arguments.callee(node.childNodes[i]); + } + ret += '</' + node.nodeName + '>'; + } + + } else if (node.nodeType == DOM_DOCUMENT_NODE || + node.nodeType == DOM_DOCUMENT_FRAGMENT_NODE) { + for (var i = 0; i < node.childNodes.length; ++i) { + ret += arguments.callee(node.childNodes[i]); + } + } + + return ret; +} + +// Applies the given function to each element of the array. +function mapExec(array, func) { + for (var i = 0; i < array.length; ++i) { + func(array[i]); + } +} + +// Returns an array that contains the return value of the given +// function applied to every element of the input array. +function mapExpr(array, func) { + var ret = []; + for (var i = 0; i < array.length; ++i) { + ret.push(func(array[i])); + } + return ret; +}; + +// Reverses the given array in place. +function reverseInplace(array) { + for (var i = 0; i < array.length / 2; ++i) { + var h = array[i]; + var ii = array.length - i - 1; + array[i] = array[ii]; + array[ii] = h; + } +} + +// Shallow-copies an array. +function copyArray(dst, src) { + for (var i = 0; i < src.length; ++i) { + dst.push(src[i]); + } +} + +function assert(b) { + if (!b) { + throw 'assertion failed'; + } +} + +// Based on +// <http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1950641247> +var DOM_ELEMENT_NODE = 1; +var DOM_ATTRIBUTE_NODE = 2; +var DOM_TEXT_NODE = 3; +var DOM_CDATA_SECTION_NODE = 4; +var DOM_ENTITY_REFERENCE_NODE = 5; +var DOM_ENTITY_NODE = 6; +var DOM_PROCESSING_INSTRUCTION_NODE = 7; +var DOM_COMMENT_NODE = 8; +var DOM_DOCUMENT_NODE = 9; +var DOM_DOCUMENT_TYPE_NODE = 10; +var DOM_DOCUMENT_FRAGMENT_NODE = 11; +var DOM_NOTATION_NODE = 12; + + +var xpathdebug = false; // trace xpath parsing +var xsltdebug = false; // trace xslt processing + + +// Escape XML special markup chracters: tag delimiter < > and entity +// reference start delimiter &. The escaped string can be used in XML +// text portions (i.e. between tags). +function xmlEscapeText(s) { + return s.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>'); +} + +// Escape XML special markup characters: tag delimiter < > entity +// reference start delimiter & and quotes ". The escaped string can be +// used in double quoted XML attribute value portions (i.e. in +// attributes within start tags). +function xmlEscapeAttr(s) { + return xmlEscapeText(s).replace(/\"/g, '"'); +} + +// Escape markup in XML text, but don't touch entity references. The +// escaped string can be used as XML text (i.e. between tags). +function xmlEscapeTags(s) { + return s.replace(/</g, '<').replace(/>/g, '>'); +} + +// An implementation of the debug log. + +var logging__ = false; + +function Log() {}; + +Log.lines = []; + +Log.write = function(s) { + if (logging__) { + this.lines.push(xmlEscapeText(s)); + this.show(); + } +}; + +// Writes the given XML with every tag on a new line. +Log.writeXML = function(xml) { + if (logging__) { + var s0 = xml.replace(/</g, '\n<'); + var s1 = xmlEscapeText(s0); + var s2 = s1.replace(/\s*\n(\s|\n)*/g, '<br/>'); + this.lines.push(s2); + this.show(); + } +} + +// Writes without any escaping +Log.writeRaw = function(s) { + if (logging__) { + this.lines.push(s); + this.show(); + } +} + +Log.clear = function() { + if (logging__) { + var l = this.div(); + l.innerHTML = ''; + this.lines = []; + } +} + +Log.show = function() { + var l = this.div(); + l.innerHTML += this.lines.join('<br/>') + '<br/>'; + this.lines = []; + l.scrollTop = l.scrollHeight; +} + +Log.div = function() { + var l = document.getElementById('log'); + if (!l) { + l = document.createElement('div'); + l.id = 'log'; + l.style.position = 'absolute'; + l.style.right = '5px'; + l.style.top = '5px'; + l.style.width = '250px'; + l.style.height = '150px'; + l.style.overflow = 'auto'; + l.style.backgroundColor = '#f0f0f0'; + l.style.border = '1px solid gray'; + l.style.fontSize = '10px'; + l.style.padding = '5px'; + document.body.appendChild(l); + } + return l; +} + + +function Timer() {} +Timer.start = function() {} +Timer.end = function() {} diff --git a/tests/FunctionalTests/selenium/core/xpath/xpath.js b/tests/test_tools/selenium/core/xpath/xpath.js index ce784585..b93469f2 100755..100644 --- a/tests/FunctionalTests/selenium/core/xpath/xpath.js +++ b/tests/test_tools/selenium/core/xpath/xpath.js @@ -1,2182 +1,2182 @@ -// Copyright 2005 Google Inc.
-// All Rights Reserved
-//
-// An XPath parser and evaluator written in JavaScript. The
-// implementation is complete except for functions handling
-// namespaces.
-//
-// Reference: [XPATH] XPath Specification
-// <http://www.w3.org/TR/1999/REC-xpath-19991116>.
-//
-//
-// The API of the parser has several parts:
-//
-// 1. The parser function xpathParse() that takes a string and returns
-// an expession object.
-//
-// 2. The expression object that has an evaluate() method to evaluate the
-// XPath expression it represents. (It is actually a hierarchy of
-// objects that resembles the parse tree, but an application will call
-// evaluate() only on the top node of this hierarchy.)
-//
-// 3. The context object that is passed as an argument to the evaluate()
-// method, which represents the DOM context in which the expression is
-// evaluated.
-//
-// 4. The value object that is returned from evaluate() and represents
-// values of the different types that are defined by XPath (number,
-// string, boolean, and node-set), and allows to convert between them.
-//
-// These parts are near the top of the file, the functions and data
-// that are used internally follow after them.
-//
-//
-// TODO(mesch): add jsdoc comments. Use more coherent naming.
-//
-//
-// Author: Steffen Meschkat <mesch@google.com>
-
-
-// The entry point for the parser.
-//
-// @param expr a string that contains an XPath expression.
-// @return an expression object that can be evaluated with an
-// expression context.
-
-function xpathParse(expr) {
- if (xpathdebug) {
- Log.write('XPath parse ' + expr);
- }
- xpathParseInit();
-
- var cached = xpathCacheLookup(expr);
- if (cached) {
- if (xpathdebug) {
- Log.write(' ... cached');
- }
- return cached;
- }
-
- // Optimize for a few common cases: simple attribute node tests
- // (@id), simple element node tests (page), variable references
- // ($address), numbers (4), multi-step path expressions where each
- // step is a plain element node test
- // (page/overlay/locations/location).
-
- if (expr.match(/^(\$|@)?\w+$/i)) {
- var ret = makeSimpleExpr(expr);
- xpathParseCache[expr] = ret;
- if (xpathdebug) {
- Log.write(' ... simple');
- }
- return ret;
- }
-
- if (expr.match(/^\w+(\/\w+)*$/i)) {
- var ret = makeSimpleExpr2(expr);
- xpathParseCache[expr] = ret;
- if (xpathdebug) {
- Log.write(' ... simple 2');
- }
- return ret;
- }
-
- var cachekey = expr; // expr is modified during parse
- if (xpathdebug) {
- Timer.start('XPath parse', cachekey);
- }
-
- var stack = [];
- var ahead = null;
- var previous = null;
- var done = false;
-
- var parse_count = 0;
- var lexer_count = 0;
- var reduce_count = 0;
-
- while (!done) {
- parse_count++;
- expr = expr.replace(/^\s*/, '');
- previous = ahead;
- ahead = null;
-
- var rule = null;
- var match = '';
- for (var i = 0; i < xpathTokenRules.length; ++i) {
- var result = xpathTokenRules[i].re.exec(expr);
- lexer_count++;
- if (result && result.length > 0 && result[0].length > match.length) {
- rule = xpathTokenRules[i];
- match = result[0];
- break;
- }
- }
-
- // Special case: allow operator keywords to be element and
- // variable names.
-
- // NOTE(mesch): The parser resolves conflicts by looking ahead,
- // and this is the only case where we look back to
- // disambiguate. So this is indeed something different, and
- // looking back is usually done in the lexer (via states in the
- // general case, called "start conditions" in flex(1)). Also,the
- // conflict resolution in the parser is not as robust as it could
- // be, so I'd like to keep as much off the parser as possible (all
- // these precedence values should be computed from the grammar
- // rules and possibly associativity declarations, as in bison(1),
- // and not explicitly set.
-
- if (rule &&
- (rule == TOK_DIV ||
- rule == TOK_MOD ||
- rule == TOK_AND ||
- rule == TOK_OR) &&
- (!previous ||
- previous.tag == TOK_AT ||
- previous.tag == TOK_DSLASH ||
- previous.tag == TOK_SLASH ||
- previous.tag == TOK_AXIS ||
- previous.tag == TOK_DOLLAR)) {
- rule = TOK_QNAME;
- }
-
- if (rule) {
- expr = expr.substr(match.length);
- if (xpathdebug) {
- Log.write('token: ' + match + ' -- ' + rule.label);
- }
- ahead = {
- tag: rule,
- match: match,
- prec: rule.prec ? rule.prec : 0, // || 0 is removed by the compiler
- expr: makeTokenExpr(match)
- };
-
- } else {
- if (xpathdebug) {
- Log.write('DONE');
- }
- done = true;
- }
-
- while (xpathReduce(stack, ahead)) {
- reduce_count++;
- if (xpathdebug) {
- Log.write('stack: ' + stackToString(stack));
- }
- }
- }
-
- if (xpathdebug) {
- Log.write(stackToString(stack));
- }
-
- if (stack.length != 1) {
- throw 'XPath parse error ' + cachekey + ':\n' + stackToString(stack);
- }
-
- var result = stack[0].expr;
- xpathParseCache[cachekey] = result;
-
- if (xpathdebug) {
- Timer.end('XPath parse', cachekey);
- }
-
- if (xpathdebug) {
- Log.write('XPath parse: ' + parse_count + ' / ' +
- lexer_count + ' / ' + reduce_count);
- }
-
- return result;
-}
-
-var xpathParseCache = {};
-
-function xpathCacheLookup(expr) {
- return xpathParseCache[expr];
-}
-
-function xpathReduce(stack, ahead) {
- var cand = null;
-
- if (stack.length > 0) {
- var top = stack[stack.length-1];
- var ruleset = xpathRules[top.tag.key];
-
- if (ruleset) {
- for (var i = 0; i < ruleset.length; ++i) {
- var rule = ruleset[i];
- var match = xpathMatchStack(stack, rule[1]);
- if (match.length) {
- cand = {
- tag: rule[0],
- rule: rule,
- match: match
- };
- cand.prec = xpathGrammarPrecedence(cand);
- break;
- }
- }
- }
- }
-
- var ret;
- if (cand && (!ahead || cand.prec > ahead.prec ||
- (ahead.tag.left && cand.prec >= ahead.prec))) {
- for (var i = 0; i < cand.match.matchlength; ++i) {
- stack.pop();
- }
-
- if (xpathdebug) {
- Log.write('reduce ' + cand.tag.label + ' ' + cand.prec +
- ' ahead ' + (ahead ? ahead.tag.label + ' ' + ahead.prec +
- (ahead.tag.left ? ' left' : '')
- : ' none '));
- }
-
- var matchexpr = mapExpr(cand.match, function(m) { return m.expr; });
- cand.expr = cand.rule[3].apply(null, matchexpr);
-
- stack.push(cand);
- ret = true;
-
- } else {
- if (ahead) {
- if (xpathdebug) {
- Log.write('shift ' + ahead.tag.label + ' ' + ahead.prec +
- (ahead.tag.left ? ' left' : '') +
- ' over ' + (cand ? cand.tag.label + ' ' +
- cand.prec : ' none'));
- }
- stack.push(ahead);
- }
- ret = false;
- }
- return ret;
-}
-
-function xpathMatchStack(stack, pattern) {
-
- // NOTE(mesch): The stack matches for variable cardinality are
- // greedy but don't do backtracking. This would be an issue only
- // with rules of the form A* A, i.e. with an element with variable
- // cardinality followed by the same element. Since that doesn't
- // occur in the grammar at hand, all matches on the stack are
- // unambiguous.
-
- var S = stack.length;
- var P = pattern.length;
- var p, s;
- var match = [];
- match.matchlength = 0;
- var ds = 0;
- for (p = P - 1, s = S - 1; p >= 0 && s >= 0; --p, s -= ds) {
- ds = 0;
- var qmatch = [];
- if (pattern[p] == Q_MM) {
- p -= 1;
- match.push(qmatch);
- while (s - ds >= 0 && stack[s - ds].tag == pattern[p]) {
- qmatch.push(stack[s - ds]);
- ds += 1;
- match.matchlength += 1;
- }
-
- } else if (pattern[p] == Q_01) {
- p -= 1;
- match.push(qmatch);
- while (s - ds >= 0 && ds < 2 && stack[s - ds].tag == pattern[p]) {
- qmatch.push(stack[s - ds]);
- ds += 1;
- match.matchlength += 1;
- }
-
- } else if (pattern[p] == Q_1M) {
- p -= 1;
- match.push(qmatch);
- if (stack[s].tag == pattern[p]) {
- while (s - ds >= 0 && stack[s - ds].tag == pattern[p]) {
- qmatch.push(stack[s - ds]);
- ds += 1;
- match.matchlength += 1;
- }
- } else {
- return [];
- }
-
- } else if (stack[s].tag == pattern[p]) {
- match.push(stack[s]);
- ds += 1;
- match.matchlength += 1;
-
- } else {
- return [];
- }
-
- reverseInplace(qmatch);
- qmatch.expr = mapExpr(qmatch, function(m) { return m.expr; });
- }
-
- reverseInplace(match);
-
- if (p == -1) {
- return match;
-
- } else {
- return [];
- }
-}
-
-function xpathTokenPrecedence(tag) {
- return tag.prec || 2;
-}
-
-function xpathGrammarPrecedence(frame) {
- var ret = 0;
-
- if (frame.rule) { /* normal reduce */
- if (frame.rule.length >= 3 && frame.rule[2] >= 0) {
- ret = frame.rule[2];
-
- } else {
- for (var i = 0; i < frame.rule[1].length; ++i) {
- var p = xpathTokenPrecedence(frame.rule[1][i]);
- ret = Math.max(ret, p);
- }
- }
- } else if (frame.tag) { /* TOKEN match */
- ret = xpathTokenPrecedence(frame.tag);
-
- } else if (frame.length) { /* Q_ match */
- for (var j = 0; j < frame.length; ++j) {
- var p = xpathGrammarPrecedence(frame[j]);
- ret = Math.max(ret, p);
- }
- }
-
- return ret;
-}
-
-function stackToString(stack) {
- var ret = '';
- for (var i = 0; i < stack.length; ++i) {
- if (ret) {
- ret += '\n';
- }
- ret += stack[i].tag.label;
- }
- return ret;
-}
-
-
-// XPath expression evaluation context. An XPath context consists of a
-// DOM node, a list of DOM nodes that contains this node, a number
-// that represents the position of the single node in the list, and a
-// current set of variable bindings. (See XPath spec.)
-//
-// The interface of the expression context:
-//
-// Constructor -- gets the node, its position, the node set it
-// belongs to, and a parent context as arguments. The parent context
-// is used to implement scoping rules for variables: if a variable
-// is not found in the current context, it is looked for in the
-// parent context, recursively. Except for node, all arguments have
-// default values: default position is 0, default node set is the
-// set that contains only the node, and the default parent is null.
-//
-// Notice that position starts at 0 at the outside interface;
-// inside XPath expressions this shows up as position()=1.
-//
-// clone() -- creates a new context with the current context as
-// parent. If passed as argument to clone(), the new context has a
-// different node, position, or node set. What is not passed is
-// inherited from the cloned context.
-//
-// setVariable(name, expr) -- binds given XPath expression to the
-// name.
-//
-// getVariable(name) -- what the name says.
-//
-// setNode(node, position) -- sets the context to the new node and
-// its corresponding position. Needed to implement scoping rules for
-// variables in XPath. (A variable is visible to all subsequent
-// siblings, not only to its children.)
-
-function ExprContext(node, position, nodelist, parent) {
- this.node = node;
- this.position = position || 0;
- this.nodelist = nodelist || [ node ];
- this.variables = {};
- this.parent = parent || null;
- this.root = parent ? parent.root : node.ownerDocument;
-}
-
-ExprContext.prototype.clone = function(node, position, nodelist) {
- return new
- ExprContext(node || this.node,
- typeof position != 'undefined' ? position : this.position,
- nodelist || this.nodelist, this);
-};
-
-ExprContext.prototype.setVariable = function(name, value) {
- this.variables[name] = value;
-};
-
-ExprContext.prototype.getVariable = function(name) {
- if (typeof this.variables[name] != 'undefined') {
- return this.variables[name];
-
- } else if (this.parent) {
- return this.parent.getVariable(name);
-
- } else {
- return null;
- }
-}
-
-ExprContext.prototype.setNode = function(node, position) {
- this.node = node;
- this.position = position;
-}
-
-
-// XPath expression values. They are what XPath expressions evaluate
-// to. Strangely, the different value types are not specified in the
-// XPath syntax, but only in the semantics, so they don't show up as
-// nonterminals in the grammar. Yet, some expressions are required to
-// evaluate to particular types, and not every type can be coerced
-// into every other type. Although the types of XPath values are
-// similar to the types present in JavaScript, the type coercion rules
-// are a bit peculiar, so we explicitly model XPath types instead of
-// mapping them onto JavaScript types. (See XPath spec.)
-//
-// The four types are:
-//
-// StringValue
-//
-// NumberValue
-//
-// BooleanValue
-//
-// NodeSetValue
-//
-// The common interface of the value classes consists of methods that
-// implement the XPath type coercion rules:
-//
-// stringValue() -- returns the value as a JavaScript String,
-//
-// numberValue() -- returns the value as a JavaScript Number,
-//
-// booleanValue() -- returns the value as a JavaScript Boolean,
-//
-// nodeSetValue() -- returns the value as a JavaScript Array of DOM
-// Node objects.
-//
-
-function StringValue(value) {
- this.value = value;
- this.type = 'string';
-}
-
-StringValue.prototype.stringValue = function() {
- return this.value;
-}
-
-StringValue.prototype.booleanValue = function() {
- return this.value.length > 0;
-}
-
-StringValue.prototype.numberValue = function() {
- return this.value - 0;
-}
-
-StringValue.prototype.nodeSetValue = function() {
- throw this + ' ' + Error().stack;
-}
-
-function BooleanValue(value) {
- this.value = value;
- this.type = 'boolean';
-}
-
-BooleanValue.prototype.stringValue = function() {
- return '' + this.value;
-}
-
-BooleanValue.prototype.booleanValue = function() {
- return this.value;
-}
-
-BooleanValue.prototype.numberValue = function() {
- return this.value ? 1 : 0;
-}
-
-BooleanValue.prototype.nodeSetValue = function() {
- throw this + ' ' + Error().stack;
-}
-
-function NumberValue(value) {
- this.value = value;
- this.type = 'number';
-}
-
-NumberValue.prototype.stringValue = function() {
- return '' + this.value;
-}
-
-NumberValue.prototype.booleanValue = function() {
- return !!this.value;
-}
-
-NumberValue.prototype.numberValue = function() {
- return this.value - 0;
-}
-
-NumberValue.prototype.nodeSetValue = function() {
- throw this + ' ' + Error().stack;
-}
-
-function NodeSetValue(value) {
- this.value = value;
- this.type = 'node-set';
-}
-
-NodeSetValue.prototype.stringValue = function() {
- if (this.value.length == 0) {
- return '';
- } else {
- return xmlValue(this.value[0]);
- }
-}
-
-NodeSetValue.prototype.booleanValue = function() {
- return this.value.length > 0;
-}
-
-NodeSetValue.prototype.numberValue = function() {
- return this.stringValue() - 0;
-}
-
-NodeSetValue.prototype.nodeSetValue = function() {
- return this.value;
-};
-
-// XPath expressions. They are used as nodes in the parse tree and
-// possess an evaluate() method to compute an XPath value given an XPath
-// context. Expressions are returned from the parser. Teh set of
-// expression classes closely mirrors the set of non terminal symbols
-// in the grammar. Every non trivial nonterminal symbol has a
-// corresponding expression class.
-//
-// The common expression interface consists of the following methods:
-//
-// evaluate(context) -- evaluates the expression, returns a value.
-//
-// toString() -- returns the XPath text representation of the
-// expression (defined in xsltdebug.js).
-//
-// parseTree(indent) -- returns a parse tree representation of the
-// expression (defined in xsltdebug.js).
-
-function TokenExpr(m) {
- this.value = m;
-}
-
-TokenExpr.prototype.evaluate = function() {
- return new StringValue(this.value);
-};
-
-function LocationExpr() {
- this.absolute = false;
- this.steps = [];
-}
-
-LocationExpr.prototype.appendStep = function(s) {
- this.steps.push(s);
-}
-
-LocationExpr.prototype.prependStep = function(s) {
- var steps0 = this.steps;
- this.steps = [ s ];
- for (var i = 0; i < steps0.length; ++i) {
- this.steps.push(steps0[i]);
- }
-};
-
-LocationExpr.prototype.evaluate = function(ctx) {
- var start;
- if (this.absolute) {
- start = ctx.root;
-
- } else {
- start = ctx.node;
- }
-
- var nodes = [];
- xPathStep(nodes, this.steps, 0, start, ctx);
- return new NodeSetValue(nodes);
-};
-
-function xPathStep(nodes, steps, step, input, ctx) {
- var s = steps[step];
- var ctx2 = ctx.clone(input);
- var nodelist = s.evaluate(ctx2).nodeSetValue();
-
- for (var i = 0; i < nodelist.length; ++i) {
- if (step == steps.length - 1) {
- nodes.push(nodelist[i]);
- } else {
- xPathStep(nodes, steps, step + 1, nodelist[i], ctx);
- }
- }
-}
-
-function StepExpr(axis, nodetest, predicate) {
- this.axis = axis;
- this.nodetest = nodetest;
- this.predicate = predicate || [];
-}
-
-StepExpr.prototype.appendPredicate = function(p) {
- this.predicate.push(p);
-}
-
-StepExpr.prototype.evaluate = function(ctx) {
- var input = ctx.node;
- var nodelist = [];
-
- // NOTE(mesch): When this was a switch() statement, it didn't work
- // in Safari/2.0. Not sure why though; it resulted in the JavaScript
- // console output "undefined" (without any line number or so).
-
- if (this.axis == xpathAxis.ANCESTOR_OR_SELF) {
- nodelist.push(input);
- for (var n = input.parentNode; n; n = input.parentNode) {
- nodelist.push(n);
- }
-
- } else if (this.axis == xpathAxis.ANCESTOR) {
- for (var n = input.parentNode; n; n = input.parentNode) {
- nodelist.push(n);
- }
-
- } else if (this.axis == xpathAxis.ATTRIBUTE) {
- copyArray(nodelist, input.attributes);
-
- } else if (this.axis == xpathAxis.CHILD) {
- copyArray(nodelist, input.childNodes);
-
- } else if (this.axis == xpathAxis.DESCENDANT_OR_SELF) {
- nodelist.push(input);
- xpathCollectDescendants(nodelist, input);
-
- } else if (this.axis == xpathAxis.DESCENDANT) {
- xpathCollectDescendants(nodelist, input);
-
- } else if (this.axis == xpathAxis.FOLLOWING) {
- for (var n = input.parentNode; n; n = n.parentNode) {
- for (var nn = n.nextSibling; nn; nn = nn.nextSibling) {
- nodelist.push(nn);
- xpathCollectDescendants(nodelist, nn);
- }
- }
-
- } else if (this.axis == xpathAxis.FOLLOWING_SIBLING) {
- for (var n = input.nextSibling; n; n = input.nextSibling) {
- nodelist.push(n);
- }
-
- } else if (this.axis == xpathAxis.NAMESPACE) {
- alert('not implemented: axis namespace');
-
- } else if (this.axis == xpathAxis.PARENT) {
- if (input.parentNode) {
- nodelist.push(input.parentNode);
- }
-
- } else if (this.axis == xpathAxis.PRECEDING) {
- for (var n = input.parentNode; n; n = n.parentNode) {
- for (var nn = n.previousSibling; nn; nn = nn.previousSibling) {
- nodelist.push(nn);
- xpathCollectDescendantsReverse(nodelist, nn);
- }
- }
-
- } else if (this.axis == xpathAxis.PRECEDING_SIBLING) {
- for (var n = input.previousSibling; n; n = input.previousSibling) {
- nodelist.push(n);
- }
-
- } else if (this.axis == xpathAxis.SELF) {
- nodelist.push(input);
-
- } else {
- throw 'ERROR -- NO SUCH AXIS: ' + this.axis;
- }
-
- // process node test
- var nodelist0 = nodelist;
- nodelist = [];
- for (var i = 0; i < nodelist0.length; ++i) {
- var n = nodelist0[i];
- if (this.nodetest.evaluate(ctx.clone(n, i, nodelist0)).booleanValue()) {
- nodelist.push(n);
- }
- }
-
- // process predicates
- for (var i = 0; i < this.predicate.length; ++i) {
- var nodelist0 = nodelist;
- nodelist = [];
- for (var ii = 0; ii < nodelist0.length; ++ii) {
- var n = nodelist0[ii];
- if (this.predicate[i].evaluate(ctx.clone(n, ii, nodelist0)).booleanValue()) {
- nodelist.push(n);
- }
- }
- }
-
- return new NodeSetValue(nodelist);
-};
-
-function NodeTestAny() {
- this.value = new BooleanValue(true);
-}
-
-NodeTestAny.prototype.evaluate = function(ctx) {
- return this.value;
-};
-
-function NodeTestElement() {}
-
-NodeTestElement.prototype.evaluate = function(ctx) {
- return new BooleanValue(ctx.node.nodeType == DOM_ELEMENT_NODE);
-}
-
-function NodeTestText() {}
-
-NodeTestText.prototype.evaluate = function(ctx) {
- return new BooleanValue(ctx.node.nodeType == DOM_TEXT_NODE);
-}
-
-function NodeTestComment() {}
-
-NodeTestComment.prototype.evaluate = function(ctx) {
- return new BooleanValue(ctx.node.nodeType == DOM_COMMENT_NODE);
-}
-
-function NodeTestPI(target) {
- this.target = target;
-}
-
-NodeTestPI.prototype.evaluate = function(ctx) {
- return new
- BooleanValue(ctx.node.nodeType == DOM_PROCESSING_INSTRUCTION_NODE &&
- (!this.target || ctx.node.nodeName == this.target));
-}
-
-function NodeTestNC(nsprefix) {
- this.regex = new RegExp("^" + nsprefix + ":");
- this.nsprefix = nsprefix;
-}
-
-NodeTestNC.prototype.evaluate = function(ctx) {
- var n = ctx.node;
- return new BooleanValue(this.regex.match(n.nodeName));
-}
-
-function NodeTestName(name) {
- this.name = name;
-}
-
-NodeTestName.prototype.evaluate = function(ctx) {
- var n = ctx.node;
- // NOTE (Patrick Lightbody): this change allows node selection to be case-insensitive
- return new BooleanValue(n.nodeName.toUpperCase() == this.name.toUpperCase());
-}
-
-function PredicateExpr(expr) {
- this.expr = expr;
-}
-
-PredicateExpr.prototype.evaluate = function(ctx) {
- var v = this.expr.evaluate(ctx);
- if (v.type == 'number') {
- // NOTE(mesch): Internally, position is represented starting with
- // 0, however in XPath position starts with 1. See functions
- // position() and last().
- return new BooleanValue(ctx.position == v.numberValue() - 1);
- } else {
- return new BooleanValue(v.booleanValue());
- }
-};
-
-function FunctionCallExpr(name) {
- this.name = name;
- this.args = [];
-}
-
-FunctionCallExpr.prototype.appendArg = function(arg) {
- this.args.push(arg);
-};
-
-FunctionCallExpr.prototype.evaluate = function(ctx) {
- var fn = '' + this.name.value;
- var f = this.xpathfunctions[fn];
- if (f) {
- return f.call(this, ctx);
- } else {
- Log.write('XPath NO SUCH FUNCTION ' + fn);
- return new BooleanValue(false);
- }
-};
-
-FunctionCallExpr.prototype.xpathfunctions = {
- 'last': function(ctx) {
- assert(this.args.length == 0);
- // NOTE(mesch): XPath position starts at 1.
- return new NumberValue(ctx.nodelist.length);
- },
-
- 'position': function(ctx) {
- assert(this.args.length == 0);
- // NOTE(mesch): XPath position starts at 1.
- return new NumberValue(ctx.position + 1);
- },
-
- 'count': function(ctx) {
- assert(this.args.length == 1);
- var v = this.args[0].evaluate(ctx);
- return new NumberValue(v.nodeSetValue().length);
- },
-
- 'id': function(ctx) {
- assert(this.args.length == 1);
- var e = this.args.evaluate(ctx);
- var ret = [];
- var ids;
- if (e.type == 'node-set') {
- ids = [];
- for (var i = 0; i < e.length; ++i) {
- var v = xmlValue(e[i]).split(/\s+/);
- for (var ii = 0; ii < v.length; ++ii) {
- ids.push(v[ii]);
- }
- }
- } else {
- ids = e.split(/\s+/);
- }
- var d = ctx.node.ownerDocument;
- for (var i = 0; i < ids.length; ++i) {
- var n = d.getElementById(ids[i]);
- if (n) {
- ret.push(n);
- }
- }
- return new NodeSetValue(ret);
- },
-
- 'local-name': function(ctx) {
- alert('not implmented yet: XPath function local-name()');
- },
-
- 'namespace-uri': function(ctx) {
- alert('not implmented yet: XPath function namespace-uri()');
- },
-
- 'name': function(ctx) {
- assert(this.args.length == 1 || this.args.length == 0);
- var n;
- if (this.args.length == 0) {
- n = [ ctx.node ];
- } else {
- n = this.args[0].evaluate(ctx).nodeSetValue();
- }
-
- if (n.length == 0) {
- return new StringValue('');
- } else {
- return new StringValue(n[0].nodeName);
- }
- },
-
- 'string': function(ctx) {
- assert(this.args.length == 1 || this.args.length == 0);
- if (this.args.length == 0) {
- return new StringValue(new NodeSetValue([ ctx.node ]).stringValue());
- } else {
- return new StringValue(this.args[0].evaluate(ctx).stringValue());
- }
- },
-
- 'concat': function(ctx) {
- var ret = '';
- for (var i = 0; i < this.args.length; ++i) {
- ret += this.args[i].evaluate(ctx).stringValue();
- }
- return new StringValue(ret);
- },
-
- 'starts-with': function(ctx) {
- assert(this.args.length == 2);
- var s0 = this.args[0].evaluate(ctx).stringValue();
- var s1 = this.args[1].evaluate(ctx).stringValue();
- return new BooleanValue(s0.indexOf(s1) == 0);
- },
-
- 'contains': function(ctx) {
- assert(this.args.length == 2);
- var s0 = this.args[0].evaluate(ctx).stringValue();
- var s1 = this.args[1].evaluate(ctx).stringValue();
- return new BooleanValue(s0.indexOf(s1) != -1);
- },
-
- 'substring-before': function(ctx) {
- assert(this.args.length == 2);
- var s0 = this.args[0].evaluate(ctx).stringValue();
- var s1 = this.args[1].evaluate(ctx).stringValue();
- var i = s0.indexOf(s1);
- var ret;
- if (i == -1) {
- ret = '';
- } else {
- ret = s0.substr(0,i);
- }
- return new StringValue(ret);
- },
-
- 'substring-after': function(ctx) {
- assert(this.args.length == 2);
- var s0 = this.args[0].evaluate(ctx).stringValue();
- var s1 = this.args[1].evaluate(ctx).stringValue();
- var i = s0.indexOf(s1);
- var ret;
- if (i == -1) {
- ret = '';
- } else {
- ret = s0.substr(i + s1.length);
- }
- return new StringValue(ret);
- },
-
- 'substring': function(ctx) {
- // NOTE: XPath defines the position of the first character in a
- // string to be 1, in JavaScript this is 0 ([XPATH] Section 4.2).
- assert(this.args.length == 2 || this.args.length == 3);
- var s0 = this.args[0].evaluate(ctx).stringValue();
- var s1 = this.args[1].evaluate(ctx).numberValue();
- var ret;
- if (this.args.length == 2) {
- var i1 = Math.max(0, Math.round(s1) - 1);
- ret = s0.substr(i1);
-
- } else {
- var s2 = this.args[2].evaluate(ctx).numberValue();
- var i0 = Math.round(s1) - 1;
- var i1 = Math.max(0, i0);
- var i2 = Math.round(s2) - Math.max(0, -i0);
- ret = s0.substr(i1, i2);
- }
- return new StringValue(ret);
- },
-
- 'string-length': function(ctx) {
- var s;
- if (this.args.length > 0) {
- s = this.args[0].evaluate(ctx).stringValue();
- } else {
- s = new NodeSetValue([ ctx.node ]).stringValue();
- }
- return new NumberValue(s.length);
- },
-
- 'normalize-space': function(ctx) {
- var s;
- if (this.args.length > 0) {
- s = this.args[0].evaluate(ctx).stringValue();
- } else {
- s = new NodeSetValue([ ctx.node ]).stringValue();
- }
- s = s.replace(/^\s*/,'').replace(/\s*$/,'').replace(/\s+/g, ' ');
- return new StringValue(s);
- },
-
- 'translate': function(ctx) {
- assert(this.args.length == 3);
- var s0 = this.args[0].evaluate(ctx).stringValue();
- var s1 = this.args[1].evaluate(ctx).stringValue();
- var s2 = this.args[2].evaluate(ctx).stringValue();
-
- for (var i = 0; i < s1.length; ++i) {
- s0 = s0.replace(new RegExp(s1.charAt(i), 'g'), s2.charAt(i));
- }
- return new StringValue(s0);
- },
-
- 'boolean': function(ctx) {
- assert(this.args.length == 1);
- return new BooleanValue(this.args[0].evaluate(ctx).booleanValue());
- },
-
- 'not': function(ctx) {
- assert(this.args.length == 1);
- var ret = !this.args[0].evaluate(ctx).booleanValue();
- return new BooleanValue(ret);
- },
-
- 'true': function(ctx) {
- assert(this.args.length == 0);
- return new BooleanValue(true);
- },
-
- 'false': function(ctx) {
- assert(this.args.length == 0);
- return new BooleanValue(false);
- },
-
- 'lang': function(ctx) {
- assert(this.args.length == 1);
- var lang = this.args[0].evaluate(ctx).stringValue();
- var xmllang;
- var n = ctx.node;
- while (n && n != n.parentNode /* just in case ... */) {
- xmllang = n.getAttribute('xml:lang');
- if (xmllang) {
- break;
- }
- n = n.parentNode;
- }
- if (!xmllang) {
- return new BooleanValue(false);
- } else {
- var re = new RegExp('^' + lang + '$', 'i');
- return new BooleanValue(xmllang.match(re) ||
- xmllang.replace(/_.*$/,'').match(re));
- }
- },
-
- 'number': function(ctx) {
- assert(this.args.length == 1 || this.args.length == 0);
-
- if (this.args.length == 1) {
- return new NumberValue(this.args[0].evaluate(ctx).numberValue());
- } else {
- return new NumberValue(new NodeSetValue([ ctx.node ]).numberValue());
- }
- },
-
- 'sum': function(ctx) {
- assert(this.args.length == 1);
- var n = this.args[0].evaluate(ctx).nodeSetValue();
- var sum = 0;
- for (var i = 0; i < n.length; ++i) {
- sum += xmlValue(n[i]) - 0;
- }
- return new NumberValue(sum);
- },
-
- 'floor': function(ctx) {
- assert(this.args.length == 1);
- var num = this.args[0].evaluate(ctx).numberValue();
- return new NumberValue(Math.floor(num));
- },
-
- 'ceiling': function(ctx) {
- assert(this.args.length == 1);
- var num = this.args[0].evaluate(ctx).numberValue();
- return new NumberValue(Math.ceil(num));
- },
-
- 'round': function(ctx) {
- assert(this.args.length == 1);
- var num = this.args[0].evaluate(ctx).numberValue();
- return new NumberValue(Math.round(num));
- },
-
- // TODO(mesch): The following functions are custom. There is a
- // standard that defines how to add functions, which should be
- // applied here.
-
- 'ext-join': function(ctx) {
- assert(this.args.length == 2);
- var nodes = this.args[0].evaluate(ctx).nodeSetValue();
- var delim = this.args[1].evaluate(ctx).stringValue();
- var ret = '';
- for (var i = 0; i < nodes.length; ++i) {
- if (ret) {
- ret += delim;
- }
- ret += xmlValue(nodes[i]);
- }
- return new StringValue(ret);
- },
-
- // ext-if() evaluates and returns its second argument, if the
- // boolean value of its first argument is true, otherwise it
- // evaluates and returns its third argument.
-
- 'ext-if': function(ctx) {
- assert(this.args.length == 3);
- if (this.args[0].evaluate(ctx).booleanValue()) {
- return this.args[1].evaluate(ctx);
- } else {
- return this.args[2].evaluate(ctx);
- }
- },
-
- 'ext-sprintf': function(ctx) {
- assert(this.args.length >= 1);
- var args = [];
- for (var i = 0; i < this.args.length; ++i) {
- args.push(this.args[i].evaluate(ctx).stringValue());
- }
- return new StringValue(sprintf.apply(null, args));
- },
-
- // ext-cardinal() evaluates its single argument as a number, and
- // returns the current node that many times. It can be used in the
- // select attribute to iterate over an integer range.
-
- 'ext-cardinal': function(ctx) {
- assert(this.args.length >= 1);
- var c = this.args[0].evaluate(ctx).numberValue();
- var ret = [];
- for (var i = 0; i < c; ++i) {
- ret.push(ctx.node);
- }
- return new NodeSetValue(ret);
- }
-};
-
-function UnionExpr(expr1, expr2) {
- this.expr1 = expr1;
- this.expr2 = expr2;
-}
-
-UnionExpr.prototype.evaluate = function(ctx) {
- var nodes1 = this.expr1.evaluate(ctx).nodeSetValue();
- var nodes2 = this.expr2.evaluate(ctx).nodeSetValue();
- var I1 = nodes1.length;
- for (var i2 = 0; i2 < nodes2.length; ++i2) {
- for (var i1 = 0; i1 < I1; ++i1) {
- if (nodes1[i1] == nodes2[i2]) {
- // break inner loop and continue outer loop, labels confuse
- // the js compiler, so we don't use them here.
- i1 = I1;
- }
- }
- nodes1.push(nodes2[i2]);
- }
- return new NodeSetValue(nodes2);
-};
-
-function PathExpr(filter, rel) {
- this.filter = filter;
- this.rel = rel;
-}
-
-PathExpr.prototype.evaluate = function(ctx) {
- var nodes = this.filter.evaluate(ctx).nodeSetValue();
- var nodes1 = [];
- for (var i = 0; i < nodes.length; ++i) {
- var nodes0 = this.rel.evaluate(ctx.clone(nodes[i], i, nodes)).nodeSetValue();
- for (var ii = 0; ii < nodes0.length; ++ii) {
- nodes1.push(nodes0[ii]);
- }
- }
- return new NodeSetValue(nodes1);
-};
-
-function FilterExpr(expr, predicate) {
- this.expr = expr;
- this.predicate = predicate;
-}
-
-FilterExpr.prototype.evaluate = function(ctx) {
- var nodes = this.expr.evaluate(ctx).nodeSetValue();
- for (var i = 0; i < this.predicate.length; ++i) {
- var nodes0 = nodes;
- nodes = [];
- for (var j = 0; j < nodes0.length; ++j) {
- var n = nodes0[j];
- if (this.predicate[i].evaluate(ctx.clone(n, j, nodes0)).booleanValue()) {
- nodes.push(n);
- }
- }
- }
-
- return new NodeSetValue(nodes);
-}
-
-function UnaryMinusExpr(expr) {
- this.expr = expr;
-}
-
-UnaryMinusExpr.prototype.evaluate = function(ctx) {
- return new NumberValue(-this.expr.evaluate(ctx).numberValue());
-};
-
-function BinaryExpr(expr1, op, expr2) {
- this.expr1 = expr1;
- this.expr2 = expr2;
- this.op = op;
-}
-
-BinaryExpr.prototype.evaluate = function(ctx) {
- var ret;
- switch (this.op.value) {
- case 'or':
- ret = new BooleanValue(this.expr1.evaluate(ctx).booleanValue() ||
- this.expr2.evaluate(ctx).booleanValue());
- break;
-
- case 'and':
- ret = new BooleanValue(this.expr1.evaluate(ctx).booleanValue() &&
- this.expr2.evaluate(ctx).booleanValue());
- break;
-
- case '+':
- ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() +
- this.expr2.evaluate(ctx).numberValue());
- break;
-
- case '-':
- ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() -
- this.expr2.evaluate(ctx).numberValue());
- break;
-
- case '*':
- ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() *
- this.expr2.evaluate(ctx).numberValue());
- break;
-
- case 'mod':
- ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() %
- this.expr2.evaluate(ctx).numberValue());
- break;
-
- case 'div':
- ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() /
- this.expr2.evaluate(ctx).numberValue());
- break;
-
- case '=':
- ret = this.compare(ctx, function(x1, x2) { return x1 == x2; });
- break;
-
- case '!=':
- ret = this.compare(ctx, function(x1, x2) { return x1 != x2; });
- break;
-
- case '<':
- ret = this.compare(ctx, function(x1, x2) { return x1 < x2; });
- break;
-
- case '<=':
- ret = this.compare(ctx, function(x1, x2) { return x1 <= x2; });
- break;
-
- case '>':
- ret = this.compare(ctx, function(x1, x2) { return x1 > x2; });
- break;
-
- case '>=':
- ret = this.compare(ctx, function(x1, x2) { return x1 >= x2; });
- break;
-
- default:
- alert('BinaryExpr.evaluate: ' + this.op.value);
- }
- return ret;
-};
-
-BinaryExpr.prototype.compare = function(ctx, cmp) {
- var v1 = this.expr1.evaluate(ctx);
- var v2 = this.expr2.evaluate(ctx);
-
- var ret;
- if (v1.type == 'node-set' && v2.type == 'node-set') {
- var n1 = v1.nodeSetValue();
- var n2 = v2.nodeSetValue();
- ret = false;
- for (var i1 = 0; i1 < n1.length; ++i1) {
- for (var i2 = 0; i2 < n2.length; ++i2) {
- if (cmp(xmlValue(n1[i1]), xmlValue(n2[i2]))) {
- ret = true;
- // Break outer loop. Labels confuse the jscompiler and we
- // don't use them.
- i2 = n2.length;
- i1 = n1.length;
- }
- }
- }
-
- } else if (v1.type == 'node-set' || v2.type == 'node-set') {
-
- if (v1.type == 'number') {
- var s = v1.numberValue();
- var n = v2.nodeSetValue();
-
- ret = false;
- for (var i = 0; i < n.length; ++i) {
- var nn = xmlValue(n[i]) - 0;
- if (cmp(s, nn)) {
- ret = true;
- break;
- }
- }
-
- } else if (v2.type == 'number') {
- var n = v1.nodeSetValue();
- var s = v2.numberValue();
-
- ret = false;
- for (var i = 0; i < n.length; ++i) {
- var nn = xmlValue(n[i]) - 0;
- if (cmp(nn, s)) {
- ret = true;
- break;
- }
- }
-
- } else if (v1.type == 'string') {
- var s = v1.stringValue();
- var n = v2.nodeSetValue();
-
- ret = false;
- for (var i = 0; i < n.length; ++i) {
- var nn = xmlValue(n[i]);
- if (cmp(s, nn)) {
- ret = true;
- break;
- }
- }
-
- } else if (v2.type == 'string') {
- var n = v1.nodeSetValue();
- var s = v2.stringValue();
-
- ret = false;
- for (var i = 0; i < n.length; ++i) {
- var nn = xmlValue(n[i]);
- if (cmp(nn, s)) {
- ret = true;
- break;
- }
- }
-
- } else {
- ret = cmp(v1.booleanValue(), v2.booleanValue());
- }
-
- } else if (v1.type == 'boolean' || v2.type == 'boolean') {
- ret = cmp(v1.booleanValue(), v2.booleanValue());
-
- } else if (v1.type == 'number' || v2.type == 'number') {
- ret = cmp(v1.numberValue(), v2.numberValue());
-
- } else {
- ret = cmp(v1.stringValue(), v2.stringValue());
- }
-
- return new BooleanValue(ret);
-}
-
-function LiteralExpr(value) {
- this.value = value;
-}
-
-LiteralExpr.prototype.evaluate = function(ctx) {
- return new StringValue(this.value);
-};
-
-function NumberExpr(value) {
- this.value = value;
-}
-
-NumberExpr.prototype.evaluate = function(ctx) {
- return new NumberValue(this.value);
-};
-
-function VariableExpr(name) {
- this.name = name;
-}
-
-VariableExpr.prototype.evaluate = function(ctx) {
- return ctx.getVariable(this.name);
-}
-
-// Factory functions for semantic values (i.e. Expressions) of the
-// productions in the grammar. When a production is matched to reduce
-// the current parse state stack, the function is called with the
-// semantic values of the matched elements as arguments, and returns
-// another semantic value. The semantic value is a node of the parse
-// tree, an expression object with an evaluate() method that evaluates the
-// expression in an actual context. These factory functions are used
-// in the specification of the grammar rules, below.
-
-function makeTokenExpr(m) {
- return new TokenExpr(m);
-}
-
-function passExpr(e) {
- return e;
-}
-
-function makeLocationExpr1(slash, rel) {
- rel.absolute = true;
- return rel;
-}
-
-function makeLocationExpr2(dslash, rel) {
- rel.absolute = true;
- rel.prependStep(makeAbbrevStep(dslash.value));
- return rel;
-}
-
-function makeLocationExpr3(slash) {
- var ret = new LocationExpr();
- ret.appendStep(makeAbbrevStep('.'));
- ret.absolute = true;
- return ret;
-}
-
-function makeLocationExpr4(dslash) {
- var ret = new LocationExpr();
- ret.absolute = true;
- ret.appendStep(makeAbbrevStep(dslash.value));
- return ret;
-}
-
-function makeLocationExpr5(step) {
- var ret = new LocationExpr();
- ret.appendStep(step);
- return ret;
-}
-
-function makeLocationExpr6(rel, slash, step) {
- rel.appendStep(step);
- return rel;
-}
-
-function makeLocationExpr7(rel, dslash, step) {
- rel.appendStep(makeAbbrevStep(dslash.value));
- return rel;
-}
-
-function makeStepExpr1(dot) {
- return makeAbbrevStep(dot.value);
-}
-
-function makeStepExpr2(ddot) {
- return makeAbbrevStep(ddot.value);
-}
-
-function makeStepExpr3(axisname, axis, nodetest) {
- return new StepExpr(axisname.value, nodetest);
-}
-
-function makeStepExpr4(at, nodetest) {
- return new StepExpr('attribute', nodetest);
-}
-
-function makeStepExpr5(nodetest) {
- return new StepExpr('child', nodetest);
-}
-
-function makeStepExpr6(step, predicate) {
- step.appendPredicate(predicate);
- return step;
-}
-
-function makeAbbrevStep(abbrev) {
- switch (abbrev) {
- case '//':
- return new StepExpr('descendant-or-self', new NodeTestAny);
-
- case '.':
- return new StepExpr('self', new NodeTestAny);
-
- case '..':
- return new StepExpr('parent', new NodeTestAny);
- }
-}
-
-function makeNodeTestExpr1(asterisk) {
- return new NodeTestElement;
-}
-
-function makeNodeTestExpr2(ncname, colon, asterisk) {
- return new NodeTestNC(ncname.value);
-}
-
-function makeNodeTestExpr3(qname) {
- return new NodeTestName(qname.value);
-}
-
-function makeNodeTestExpr4(typeo, parenc) {
- var type = typeo.value.replace(/\s*\($/, '');
- switch(type) {
- case 'node':
- return new NodeTestAny;
-
- case 'text':
- return new NodeTestText;
-
- case 'comment':
- return new NodeTestComment;
-
- case 'processing-instruction':
- return new NodeTestPI;
- }
-}
-
-function makeNodeTestExpr5(typeo, target, parenc) {
- var type = typeo.replace(/\s*\($/, '');
- if (type != 'processing-instruction') {
- throw type + ' ' + Error().stack;
- }
- return new NodeTestPI(target.value);
-}
-
-function makePredicateExpr(pareno, expr, parenc) {
- return new PredicateExpr(expr);
-}
-
-function makePrimaryExpr(pareno, expr, parenc) {
- return expr;
-}
-
-function makeFunctionCallExpr1(name, pareno, parenc) {
- return new FunctionCallExpr(name);
-}
-
-function makeFunctionCallExpr2(name, pareno, arg1, args, parenc) {
- var ret = new FunctionCallExpr(name);
- ret.appendArg(arg1);
- for (var i = 0; i < args.length; ++i) {
- ret.appendArg(args[i]);
- }
- return ret;
-}
-
-function makeArgumentExpr(comma, expr) {
- return expr;
-}
-
-function makeUnionExpr(expr1, pipe, expr2) {
- return new UnionExpr(expr1, expr2);
-}
-
-function makePathExpr1(filter, slash, rel) {
- return new PathExpr(filter, rel);
-}
-
-function makePathExpr2(filter, dslash, rel) {
- rel.prependStep(makeAbbrevStep(dslash.value));
- return new PathExpr(filter, rel);
-}
-
-function makeFilterExpr(expr, predicates) {
- if (predicates.length > 0) {
- return new FilterExpr(expr, predicates);
- } else {
- return expr;
- }
-}
-
-function makeUnaryMinusExpr(minus, expr) {
- return new UnaryMinusExpr(expr);
-}
-
-function makeBinaryExpr(expr1, op, expr2) {
- return new BinaryExpr(expr1, op, expr2);
-}
-
-function makeLiteralExpr(token) {
- // remove quotes from the parsed value:
- var value = token.value.substring(1, token.value.length - 1);
- return new LiteralExpr(value);
-}
-
-function makeNumberExpr(token) {
- return new NumberExpr(token.value);
-}
-
-function makeVariableReference(dollar, name) {
- return new VariableExpr(name.value);
-}
-
-// Used before parsing for optimization of common simple cases. See
-// the begin of xpathParse() for which they are.
-function makeSimpleExpr(expr) {
- if (expr.charAt(0) == '$') {
- return new VariableExpr(expr.substr(1));
- } else if (expr.charAt(0) == '@') {
- var a = new NodeTestName(expr.substr(1));
- var b = new StepExpr('attribute', a);
- var c = new LocationExpr();
- c.appendStep(b);
- return c;
- } else if (expr.match(/^[0-9]+$/)) {
- return new NumberExpr(expr);
- } else {
- var a = new NodeTestName(expr);
- var b = new StepExpr('child', a);
- var c = new LocationExpr();
- c.appendStep(b);
- return c;
- }
-}
-
-function makeSimpleExpr2(expr) {
- var steps = expr.split('/');
- var c = new LocationExpr();
- for (var i in steps) {
- var a = new NodeTestName(steps[i]);
- var b = new StepExpr('child', a);
- c.appendStep(b);
- }
- return c;
-}
-
-// The axes of XPath expressions.
-
-var xpathAxis = {
- ANCESTOR_OR_SELF: 'ancestor-or-self',
- ANCESTOR: 'ancestor',
- ATTRIBUTE: 'attribute',
- CHILD: 'child',
- DESCENDANT_OR_SELF: 'descendant-or-self',
- DESCENDANT: 'descendant',
- FOLLOWING_SIBLING: 'following-sibling',
- FOLLOWING: 'following',
- NAMESPACE: 'namespace',
- PARENT: 'parent',
- PRECEDING_SIBLING: 'preceding-sibling',
- PRECEDING: 'preceding',
- SELF: 'self'
-};
-
-var xpathAxesRe = [
- xpathAxis.ANCESTOR_OR_SELF,
- xpathAxis.ANCESTOR,
- xpathAxis.ATTRIBUTE,
- xpathAxis.CHILD,
- xpathAxis.DESCENDANT_OR_SELF,
- xpathAxis.DESCENDANT,
- xpathAxis.FOLLOWING_SIBLING,
- xpathAxis.FOLLOWING,
- xpathAxis.NAMESPACE,
- xpathAxis.PARENT,
- xpathAxis.PRECEDING_SIBLING,
- xpathAxis.PRECEDING,
- xpathAxis.SELF
-].join('|');
-
-
-// The tokens of the language. The label property is just used for
-// generating debug output. The prec property is the precedence used
-// for shift/reduce resolution. Default precedence is 0 as a lookahead
-// token and 2 on the stack. TODO(mesch): this is certainly not
-// necessary and too complicated. Simplify this!
-
-// NOTE: tabular formatting is the big exception, but here it should
-// be OK.
-
-var TOK_PIPE = { label: "|", prec: 17, re: new RegExp("^\\|") };
-var TOK_DSLASH = { label: "//", prec: 19, re: new RegExp("^//") };
-var TOK_SLASH = { label: "/", prec: 30, re: new RegExp("^/") };
-var TOK_AXIS = { label: "::", prec: 20, re: new RegExp("^::") };
-var TOK_COLON = { label: ":", prec: 1000, re: new RegExp("^:") };
-var TOK_AXISNAME = { label: "[axis]", re: new RegExp('^(' + xpathAxesRe + ')') };
-var TOK_PARENO = { label: "(", prec: 34, re: new RegExp("^\\(") };
-var TOK_PARENC = { label: ")", re: new RegExp("^\\)") };
-var TOK_DDOT = { label: "..", prec: 34, re: new RegExp("^\\.\\.") };
-var TOK_DOT = { label: ".", prec: 34, re: new RegExp("^\\.") };
-var TOK_AT = { label: "@", prec: 34, re: new RegExp("^@") };
-
-var TOK_COMMA = { label: ",", re: new RegExp("^,") };
-
-var TOK_OR = { label: "or", prec: 10, re: new RegExp("^or\\b") };
-var TOK_AND = { label: "and", prec: 11, re: new RegExp("^and\\b") };
-var TOK_EQ = { label: "=", prec: 12, re: new RegExp("^=") };
-var TOK_NEQ = { label: "!=", prec: 12, re: new RegExp("^!=") };
-var TOK_GE = { label: ">=", prec: 13, re: new RegExp("^>=") };
-var TOK_GT = { label: ">", prec: 13, re: new RegExp("^>") };
-var TOK_LE = { label: "<=", prec: 13, re: new RegExp("^<=") };
-var TOK_LT = { label: "<", prec: 13, re: new RegExp("^<") };
-var TOK_PLUS = { label: "+", prec: 14, re: new RegExp("^\\+"), left: true };
-var TOK_MINUS = { label: "-", prec: 14, re: new RegExp("^\\-"), left: true };
-var TOK_DIV = { label: "div", prec: 15, re: new RegExp("^div\\b"), left: true };
-var TOK_MOD = { label: "mod", prec: 15, re: new RegExp("^mod\\b"), left: true };
-
-var TOK_BRACKO = { label: "[", prec: 32, re: new RegExp("^\\[") };
-var TOK_BRACKC = { label: "]", re: new RegExp("^\\]") };
-var TOK_DOLLAR = { label: "$", re: new RegExp("^\\$") };
-
-var TOK_NCNAME = { label: "[ncname]", re: new RegExp('^[a-z][-\\w]*','i') };
-
-var TOK_ASTERISK = { label: "*", prec: 15, re: new RegExp("^\\*"), left: true };
-var TOK_LITERALQ = { label: "[litq]", prec: 20, re: new RegExp("^'[^\\']*'") };
-var TOK_LITERALQQ = {
- label: "[litqq]",
- prec: 20,
- re: new RegExp('^"[^\\"]*"')
-};
-
-var TOK_NUMBER = {
- label: "[number]",
- prec: 35,
- re: new RegExp('^\\d+(\\.\\d*)?') };
-
-var TOK_QNAME = {
- label: "[qname]",
- re: new RegExp('^([a-z][-\\w]*:)?[a-z][-\\w]*','i')
-};
-
-var TOK_NODEO = {
- label: "[nodetest-start]",
- re: new RegExp('^(processing-instruction|comment|text|node)\\(')
-};
-
-// The table of the tokens of our grammar, used by the lexer: first
-// column the tag, second column a regexp to recognize it in the
-// input, third column the precedence of the token, fourth column a
-// factory function for the semantic value of the token.
-//
-// NOTE: order of this list is important, because the first match
-// counts. Cf. DDOT and DOT, and AXIS and COLON.
-
-var xpathTokenRules = [
- TOK_DSLASH,
- TOK_SLASH,
- TOK_DDOT,
- TOK_DOT,
- TOK_AXIS,
- TOK_COLON,
- TOK_AXISNAME,
- TOK_NODEO,
- TOK_PARENO,
- TOK_PARENC,
- TOK_BRACKO,
- TOK_BRACKC,
- TOK_AT,
- TOK_COMMA,
- TOK_OR,
- TOK_AND,
- TOK_NEQ,
- TOK_EQ,
- TOK_GE,
- TOK_GT,
- TOK_LE,
- TOK_LT,
- TOK_PLUS,
- TOK_MINUS,
- TOK_ASTERISK,
- TOK_PIPE,
- TOK_MOD,
- TOK_DIV,
- TOK_LITERALQ,
- TOK_LITERALQQ,
- TOK_NUMBER,
- TOK_QNAME,
- TOK_NCNAME,
- TOK_DOLLAR
-];
-
-// All the nonterminals of the grammar. The nonterminal objects are
-// identified by object identity; the labels are used in the debug
-// output only.
-var XPathLocationPath = { label: "LocationPath" };
-var XPathRelativeLocationPath = { label: "RelativeLocationPath" };
-var XPathAbsoluteLocationPath = { label: "AbsoluteLocationPath" };
-var XPathStep = { label: "Step" };
-var XPathNodeTest = { label: "NodeTest" };
-var XPathPredicate = { label: "Predicate" };
-var XPathLiteral = { label: "Literal" };
-var XPathExpr = { label: "Expr" };
-var XPathPrimaryExpr = { label: "PrimaryExpr" };
-var XPathVariableReference = { label: "Variablereference" };
-var XPathNumber = { label: "Number" };
-var XPathFunctionCall = { label: "FunctionCall" };
-var XPathArgumentRemainder = { label: "ArgumentRemainder" };
-var XPathPathExpr = { label: "PathExpr" };
-var XPathUnionExpr = { label: "UnionExpr" };
-var XPathFilterExpr = { label: "FilterExpr" };
-var XPathDigits = { label: "Digits" };
-
-var xpathNonTerminals = [
- XPathLocationPath,
- XPathRelativeLocationPath,
- XPathAbsoluteLocationPath,
- XPathStep,
- XPathNodeTest,
- XPathPredicate,
- XPathLiteral,
- XPathExpr,
- XPathPrimaryExpr,
- XPathVariableReference,
- XPathNumber,
- XPathFunctionCall,
- XPathArgumentRemainder,
- XPathPathExpr,
- XPathUnionExpr,
- XPathFilterExpr,
- XPathDigits
-];
-
-// Quantifiers that are used in the productions of the grammar.
-var Q_01 = { label: "?" };
-var Q_MM = { label: "*" };
-var Q_1M = { label: "+" };
-
-// Tag for left associativity (right assoc is implied by undefined).
-var ASSOC_LEFT = true;
-
-// The productions of the grammar. Columns of the table:
-//
-// - target nonterminal,
-// - pattern,
-// - precedence,
-// - semantic value factory
-//
-// The semantic value factory is a function that receives parse tree
-// nodes from the stack frames of the matched symbols as arguments and
-// returns an a node of the parse tree. The node is stored in the top
-// stack frame along with the target object of the rule. The node in
-// the parse tree is an expression object that has an evaluate() method
-// and thus evaluates XPath expressions.
-//
-// The precedence is used to decide between reducing and shifting by
-// comparing the precendence of the rule that is candidate for
-// reducing with the precedence of the look ahead token. Precedence of
-// -1 means that the precedence of the tokens in the pattern is used
-// instead. TODO: It shouldn't be necessary to explicitly assign
-// precedences to rules.
-
-var xpathGrammarRules =
- [
- [ XPathLocationPath, [ XPathRelativeLocationPath ], 18,
- passExpr ],
- [ XPathLocationPath, [ XPathAbsoluteLocationPath ], 18,
- passExpr ],
-
- [ XPathAbsoluteLocationPath, [ TOK_SLASH, XPathRelativeLocationPath ], 18,
- makeLocationExpr1 ],
- [ XPathAbsoluteLocationPath, [ TOK_DSLASH, XPathRelativeLocationPath ], 18,
- makeLocationExpr2 ],
-
- [ XPathAbsoluteLocationPath, [ TOK_SLASH ], 0,
- makeLocationExpr3 ],
- [ XPathAbsoluteLocationPath, [ TOK_DSLASH ], 0,
- makeLocationExpr4 ],
-
- [ XPathRelativeLocationPath, [ XPathStep ], 31,
- makeLocationExpr5 ],
- [ XPathRelativeLocationPath,
- [ XPathRelativeLocationPath, TOK_SLASH, XPathStep ], 31,
- makeLocationExpr6 ],
- [ XPathRelativeLocationPath,
- [ XPathRelativeLocationPath, TOK_DSLASH, XPathStep ], 31,
- makeLocationExpr7 ],
-
- [ XPathStep, [ TOK_DOT ], 33,
- makeStepExpr1 ],
- [ XPathStep, [ TOK_DDOT ], 33,
- makeStepExpr2 ],
- [ XPathStep,
- [ TOK_AXISNAME, TOK_AXIS, XPathNodeTest ], 33,
- makeStepExpr3 ],
- [ XPathStep, [ TOK_AT, XPathNodeTest ], 33,
- makeStepExpr4 ],
- [ XPathStep, [ XPathNodeTest ], 33,
- makeStepExpr5 ],
- [ XPathStep, [ XPathStep, XPathPredicate ], 33,
- makeStepExpr6 ],
-
- [ XPathNodeTest, [ TOK_ASTERISK ], 33,
- makeNodeTestExpr1 ],
- [ XPathNodeTest, [ TOK_NCNAME, TOK_COLON, TOK_ASTERISK ], 33,
- makeNodeTestExpr2 ],
- [ XPathNodeTest, [ TOK_QNAME ], 33,
- makeNodeTestExpr3 ],
- [ XPathNodeTest, [ TOK_NODEO, TOK_PARENC ], 33,
- makeNodeTestExpr4 ],
- [ XPathNodeTest, [ TOK_NODEO, XPathLiteral, TOK_PARENC ], 33,
- makeNodeTestExpr5 ],
-
- [ XPathPredicate, [ TOK_BRACKO, XPathExpr, TOK_BRACKC ], 33,
- makePredicateExpr ],
-
- [ XPathPrimaryExpr, [ XPathVariableReference ], 33,
- passExpr ],
- [ XPathPrimaryExpr, [ TOK_PARENO, XPathExpr, TOK_PARENC ], 33,
- makePrimaryExpr ],
- [ XPathPrimaryExpr, [ XPathLiteral ], 30,
- passExpr ],
- [ XPathPrimaryExpr, [ XPathNumber ], 30,
- passExpr ],
- [ XPathPrimaryExpr, [ XPathFunctionCall ], 30,
- passExpr ],
-
- [ XPathFunctionCall, [ TOK_QNAME, TOK_PARENO, TOK_PARENC ], -1,
- makeFunctionCallExpr1 ],
- [ XPathFunctionCall,
- [ TOK_QNAME, TOK_PARENO, XPathExpr, XPathArgumentRemainder, Q_MM,
- TOK_PARENC ], -1,
- makeFunctionCallExpr2 ],
- [ XPathArgumentRemainder, [ TOK_COMMA, XPathExpr ], -1,
- makeArgumentExpr ],
-
- [ XPathUnionExpr, [ XPathPathExpr ], 20,
- passExpr ],
- [ XPathUnionExpr, [ XPathUnionExpr, TOK_PIPE, XPathPathExpr ], 20,
- makeUnionExpr ],
-
- [ XPathPathExpr, [ XPathLocationPath ], 20,
- passExpr ],
- [ XPathPathExpr, [ XPathFilterExpr ], 19,
- passExpr ],
- [ XPathPathExpr,
- [ XPathFilterExpr, TOK_SLASH, XPathRelativeLocationPath ], 20,
- makePathExpr1 ],
- [ XPathPathExpr,
- [ XPathFilterExpr, TOK_DSLASH, XPathRelativeLocationPath ], 20,
- makePathExpr2 ],
-
- [ XPathFilterExpr, [ XPathPrimaryExpr, XPathPredicate, Q_MM ], 20,
- makeFilterExpr ],
-
- [ XPathExpr, [ XPathPrimaryExpr ], 16,
- passExpr ],
- [ XPathExpr, [ XPathUnionExpr ], 16,
- passExpr ],
-
- [ XPathExpr, [ TOK_MINUS, XPathExpr ], -1,
- makeUnaryMinusExpr ],
-
- [ XPathExpr, [ XPathExpr, TOK_OR, XPathExpr ], -1,
- makeBinaryExpr ],
- [ XPathExpr, [ XPathExpr, TOK_AND, XPathExpr ], -1,
- makeBinaryExpr ],
-
- [ XPathExpr, [ XPathExpr, TOK_EQ, XPathExpr ], -1,
- makeBinaryExpr ],
- [ XPathExpr, [ XPathExpr, TOK_NEQ, XPathExpr ], -1,
- makeBinaryExpr ],
-
- [ XPathExpr, [ XPathExpr, TOK_LT, XPathExpr ], -1,
- makeBinaryExpr ],
- [ XPathExpr, [ XPathExpr, TOK_LE, XPathExpr ], -1,
- makeBinaryExpr ],
- [ XPathExpr, [ XPathExpr, TOK_GT, XPathExpr ], -1,
- makeBinaryExpr ],
- [ XPathExpr, [ XPathExpr, TOK_GE, XPathExpr ], -1,
- makeBinaryExpr ],
-
- [ XPathExpr, [ XPathExpr, TOK_PLUS, XPathExpr ], -1,
- makeBinaryExpr, ASSOC_LEFT ],
- [ XPathExpr, [ XPathExpr, TOK_MINUS, XPathExpr ], -1,
- makeBinaryExpr, ASSOC_LEFT ],
-
- [ XPathExpr, [ XPathExpr, TOK_ASTERISK, XPathExpr ], -1,
- makeBinaryExpr, ASSOC_LEFT ],
- [ XPathExpr, [ XPathExpr, TOK_DIV, XPathExpr ], -1,
- makeBinaryExpr, ASSOC_LEFT ],
- [ XPathExpr, [ XPathExpr, TOK_MOD, XPathExpr ], -1,
- makeBinaryExpr, ASSOC_LEFT ],
-
- [ XPathLiteral, [ TOK_LITERALQ ], -1,
- makeLiteralExpr ],
- [ XPathLiteral, [ TOK_LITERALQQ ], -1,
- makeLiteralExpr ],
-
- [ XPathNumber, [ TOK_NUMBER ], -1,
- makeNumberExpr ],
-
- [ XPathVariableReference, [ TOK_DOLLAR, TOK_QNAME ], 200,
- makeVariableReference ]
- ];
-
-// That function computes some optimizations of the above data
-// structures and will be called right here. It merely takes the
-// counter variables out of the global scope.
-
-var xpathRules = [];
-
-function xpathParseInit() {
- if (xpathRules.length) {
- return;
- }
-
- // Some simple optimizations for the xpath expression parser: sort
- // grammar rules descending by length, so that the longest match is
- // first found.
-
- xpathGrammarRules.sort(function(a,b) {
- var la = a[1].length;
- var lb = b[1].length;
- if (la < lb) {
- return 1;
- } else if (la > lb) {
- return -1;
- } else {
- return 0;
- }
- });
-
- var k = 1;
- for (var i = 0; i < xpathNonTerminals.length; ++i) {
- xpathNonTerminals[i].key = k++;
- }
-
- for (i = 0; i < xpathTokenRules.length; ++i) {
- xpathTokenRules[i].key = k++;
- }
-
- Log.write('XPath parse INIT: ' + k + ' rules');
-
- // Another slight optimization: sort the rules into bins according
- // to the last element (observing quantifiers), so we can restrict
- // the match against the stack to the subest of rules that match the
- // top of the stack.
- //
- // TODO(mesch): What we actually want is to compute states as in
- // bison, so that we don't have to do any explicit and iterated
- // match against the stack.
-
- function push_(array, position, element) {
- if (!array[position]) {
- array[position] = [];
- }
- array[position].push(element);
- }
-
- for (i = 0; i < xpathGrammarRules.length; ++i) {
- var rule = xpathGrammarRules[i];
- var pattern = rule[1];
-
- for (var j = pattern.length - 1; j >= 0; --j) {
- if (pattern[j] == Q_1M) {
- push_(xpathRules, pattern[j-1].key, rule);
- break;
-
- } else if (pattern[j] == Q_MM || pattern[j] == Q_01) {
- push_(xpathRules, pattern[j-1].key, rule);
- --j;
-
- } else {
- push_(xpathRules, pattern[j].key, rule);
- break;
- }
- }
- }
-
- Log.write('XPath parse INIT: ' + xpathRules.length + ' rule bins');
-
- var sum = 0;
- mapExec(xpathRules, function(i) {
- if (i) {
- sum += i.length;
- }
- });
-
- Log.write('XPath parse INIT: ' + (sum / xpathRules.length) + ' average bin size');
-}
-
-// Local utility functions that are used by the lexer or parser.
-
-function xpathCollectDescendants(nodelist, node) {
- for (var n = node.firstChild; n; n = n.nextSibling) {
- nodelist.push(n);
- arguments.callee(nodelist, n);
- }
-}
-
-function xpathCollectDescendantsReverse(nodelist, node) {
- for (var n = node.lastChild; n; n = n.previousSibling) {
- nodelist.push(n);
- arguments.callee(nodelist, n);
- }
-}
-
-
-// The entry point for the library: match an expression against a DOM
-// node. Returns an XPath value.
-function xpathDomEval(expr, node) {
- var expr1 = xpathParse(expr);
- var ret = expr1.evaluate(new ExprContext(node));
- return ret;
-}
-
-// Utility function to sort a list of nodes. Used by xsltSort() and
-// nxslSelect().
-function xpathSort(input, sort) {
- if (sort.length == 0) {
- return;
- }
-
- var sortlist = [];
-
- for (var i = 0; i < input.nodelist.length; ++i) {
- var node = input.nodelist[i];
- var sortitem = { node: node, key: [] };
- var context = input.clone(node, 0, [ node ]);
-
- for (var j = 0; j < sort.length; ++j) {
- var s = sort[j];
- var value = s.expr.evaluate(context);
-
- var evalue;
- if (s.type == 'text') {
- evalue = value.stringValue();
- } else if (s.type == 'number') {
- evalue = value.numberValue();
- }
- sortitem.key.push({ value: evalue, order: s.order });
- }
-
- // Make the sort stable by adding a lowest priority sort by
- // id. This is very convenient and furthermore required by the
- // spec ([XSLT] - Section 10 Sorting).
- sortitem.key.push({ value: i, order: 'ascending' });
-
- sortlist.push(sortitem);
- }
-
- sortlist.sort(xpathSortByKey);
-
- var nodes = [];
- for (var i = 0; i < sortlist.length; ++i) {
- nodes.push(sortlist[i].node);
- }
- input.nodelist = nodes;
- input.setNode(nodes[0], 0);
-}
-
-
-// Sorts by all order criteria defined. According to the JavaScript
-// spec ([ECMA] Section 11.8.5), the compare operators compare strings
-// as strings and numbers as numbers.
-//
-// NOTE: In browsers which do not follow the spec, this breaks only in
-// the case that numbers should be sorted as strings, which is very
-// uncommon.
-
-function xpathSortByKey(v1, v2) {
- // NOTE: Sort key vectors of different length never occur in
- // xsltSort.
-
- for (var i = 0; i < v1.key.length; ++i) {
- var o = v1.key[i].order == 'descending' ? -1 : 1;
- if (v1.key[i].value > v2.key[i].value) {
- return +1 * o;
- } else if (v1.key[i].value < v2.key[i].value) {
- return -1 * o;
- }
- }
-
- return 0;
-}
+// Copyright 2005 Google Inc. +// All Rights Reserved +// +// An XPath parser and evaluator written in JavaScript. The +// implementation is complete except for functions handling +// namespaces. +// +// Reference: [XPATH] XPath Specification +// <http://www.w3.org/TR/1999/REC-xpath-19991116>. +// +// +// The API of the parser has several parts: +// +// 1. The parser function xpathParse() that takes a string and returns +// an expession object. +// +// 2. The expression object that has an evaluate() method to evaluate the +// XPath expression it represents. (It is actually a hierarchy of +// objects that resembles the parse tree, but an application will call +// evaluate() only on the top node of this hierarchy.) +// +// 3. The context object that is passed as an argument to the evaluate() +// method, which represents the DOM context in which the expression is +// evaluated. +// +// 4. The value object that is returned from evaluate() and represents +// values of the different types that are defined by XPath (number, +// string, boolean, and node-set), and allows to convert between them. +// +// These parts are near the top of the file, the functions and data +// that are used internally follow after them. +// +// +// TODO(mesch): add jsdoc comments. Use more coherent naming. +// +// +// Author: Steffen Meschkat <mesch@google.com> + + +// The entry point for the parser. +// +// @param expr a string that contains an XPath expression. +// @return an expression object that can be evaluated with an +// expression context. + +function xpathParse(expr) { + if (xpathdebug) { + Log.write('XPath parse ' + expr); + } + xpathParseInit(); + + var cached = xpathCacheLookup(expr); + if (cached) { + if (xpathdebug) { + Log.write(' ... cached'); + } + return cached; + } + + // Optimize for a few common cases: simple attribute node tests + // (@id), simple element node tests (page), variable references + // ($address), numbers (4), multi-step path expressions where each + // step is a plain element node test + // (page/overlay/locations/location). + + if (expr.match(/^(\$|@)?\w+$/i)) { + var ret = makeSimpleExpr(expr); + xpathParseCache[expr] = ret; + if (xpathdebug) { + Log.write(' ... simple'); + } + return ret; + } + + if (expr.match(/^\w+(\/\w+)*$/i)) { + var ret = makeSimpleExpr2(expr); + xpathParseCache[expr] = ret; + if (xpathdebug) { + Log.write(' ... simple 2'); + } + return ret; + } + + var cachekey = expr; // expr is modified during parse + if (xpathdebug) { + Timer.start('XPath parse', cachekey); + } + + var stack = []; + var ahead = null; + var previous = null; + var done = false; + + var parse_count = 0; + var lexer_count = 0; + var reduce_count = 0; + + while (!done) { + parse_count++; + expr = expr.replace(/^\s*/, ''); + previous = ahead; + ahead = null; + + var rule = null; + var match = ''; + for (var i = 0; i < xpathTokenRules.length; ++i) { + var result = xpathTokenRules[i].re.exec(expr); + lexer_count++; + if (result && result.length > 0 && result[0].length > match.length) { + rule = xpathTokenRules[i]; + match = result[0]; + break; + } + } + + // Special case: allow operator keywords to be element and + // variable names. + + // NOTE(mesch): The parser resolves conflicts by looking ahead, + // and this is the only case where we look back to + // disambiguate. So this is indeed something different, and + // looking back is usually done in the lexer (via states in the + // general case, called "start conditions" in flex(1)). Also,the + // conflict resolution in the parser is not as robust as it could + // be, so I'd like to keep as much off the parser as possible (all + // these precedence values should be computed from the grammar + // rules and possibly associativity declarations, as in bison(1), + // and not explicitly set. + + if (rule && + (rule == TOK_DIV || + rule == TOK_MOD || + rule == TOK_AND || + rule == TOK_OR) && + (!previous || + previous.tag == TOK_AT || + previous.tag == TOK_DSLASH || + previous.tag == TOK_SLASH || + previous.tag == TOK_AXIS || + previous.tag == TOK_DOLLAR)) { + rule = TOK_QNAME; + } + + if (rule) { + expr = expr.substr(match.length); + if (xpathdebug) { + Log.write('token: ' + match + ' -- ' + rule.label); + } + ahead = { + tag: rule, + match: match, + prec: rule.prec ? rule.prec : 0, // || 0 is removed by the compiler + expr: makeTokenExpr(match) + }; + + } else { + if (xpathdebug) { + Log.write('DONE'); + } + done = true; + } + + while (xpathReduce(stack, ahead)) { + reduce_count++; + if (xpathdebug) { + Log.write('stack: ' + stackToString(stack)); + } + } + } + + if (xpathdebug) { + Log.write(stackToString(stack)); + } + + if (stack.length != 1) { + throw 'XPath parse error ' + cachekey + ':\n' + stackToString(stack); + } + + var result = stack[0].expr; + xpathParseCache[cachekey] = result; + + if (xpathdebug) { + Timer.end('XPath parse', cachekey); + } + + if (xpathdebug) { + Log.write('XPath parse: ' + parse_count + ' / ' + + lexer_count + ' / ' + reduce_count); + } + + return result; +} + +var xpathParseCache = {}; + +function xpathCacheLookup(expr) { + return xpathParseCache[expr]; +} + +function xpathReduce(stack, ahead) { + var cand = null; + + if (stack.length > 0) { + var top = stack[stack.length-1]; + var ruleset = xpathRules[top.tag.key]; + + if (ruleset) { + for (var i = 0; i < ruleset.length; ++i) { + var rule = ruleset[i]; + var match = xpathMatchStack(stack, rule[1]); + if (match.length) { + cand = { + tag: rule[0], + rule: rule, + match: match + }; + cand.prec = xpathGrammarPrecedence(cand); + break; + } + } + } + } + + var ret; + if (cand && (!ahead || cand.prec > ahead.prec || + (ahead.tag.left && cand.prec >= ahead.prec))) { + for (var i = 0; i < cand.match.matchlength; ++i) { + stack.pop(); + } + + if (xpathdebug) { + Log.write('reduce ' + cand.tag.label + ' ' + cand.prec + + ' ahead ' + (ahead ? ahead.tag.label + ' ' + ahead.prec + + (ahead.tag.left ? ' left' : '') + : ' none ')); + } + + var matchexpr = mapExpr(cand.match, function(m) { return m.expr; }); + cand.expr = cand.rule[3].apply(null, matchexpr); + + stack.push(cand); + ret = true; + + } else { + if (ahead) { + if (xpathdebug) { + Log.write('shift ' + ahead.tag.label + ' ' + ahead.prec + + (ahead.tag.left ? ' left' : '') + + ' over ' + (cand ? cand.tag.label + ' ' + + cand.prec : ' none')); + } + stack.push(ahead); + } + ret = false; + } + return ret; +} + +function xpathMatchStack(stack, pattern) { + + // NOTE(mesch): The stack matches for variable cardinality are + // greedy but don't do backtracking. This would be an issue only + // with rules of the form A* A, i.e. with an element with variable + // cardinality followed by the same element. Since that doesn't + // occur in the grammar at hand, all matches on the stack are + // unambiguous. + + var S = stack.length; + var P = pattern.length; + var p, s; + var match = []; + match.matchlength = 0; + var ds = 0; + for (p = P - 1, s = S - 1; p >= 0 && s >= 0; --p, s -= ds) { + ds = 0; + var qmatch = []; + if (pattern[p] == Q_MM) { + p -= 1; + match.push(qmatch); + while (s - ds >= 0 && stack[s - ds].tag == pattern[p]) { + qmatch.push(stack[s - ds]); + ds += 1; + match.matchlength += 1; + } + + } else if (pattern[p] == Q_01) { + p -= 1; + match.push(qmatch); + while (s - ds >= 0 && ds < 2 && stack[s - ds].tag == pattern[p]) { + qmatch.push(stack[s - ds]); + ds += 1; + match.matchlength += 1; + } + + } else if (pattern[p] == Q_1M) { + p -= 1; + match.push(qmatch); + if (stack[s].tag == pattern[p]) { + while (s - ds >= 0 && stack[s - ds].tag == pattern[p]) { + qmatch.push(stack[s - ds]); + ds += 1; + match.matchlength += 1; + } + } else { + return []; + } + + } else if (stack[s].tag == pattern[p]) { + match.push(stack[s]); + ds += 1; + match.matchlength += 1; + + } else { + return []; + } + + reverseInplace(qmatch); + qmatch.expr = mapExpr(qmatch, function(m) { return m.expr; }); + } + + reverseInplace(match); + + if (p == -1) { + return match; + + } else { + return []; + } +} + +function xpathTokenPrecedence(tag) { + return tag.prec || 2; +} + +function xpathGrammarPrecedence(frame) { + var ret = 0; + + if (frame.rule) { /* normal reduce */ + if (frame.rule.length >= 3 && frame.rule[2] >= 0) { + ret = frame.rule[2]; + + } else { + for (var i = 0; i < frame.rule[1].length; ++i) { + var p = xpathTokenPrecedence(frame.rule[1][i]); + ret = Math.max(ret, p); + } + } + } else if (frame.tag) { /* TOKEN match */ + ret = xpathTokenPrecedence(frame.tag); + + } else if (frame.length) { /* Q_ match */ + for (var j = 0; j < frame.length; ++j) { + var p = xpathGrammarPrecedence(frame[j]); + ret = Math.max(ret, p); + } + } + + return ret; +} + +function stackToString(stack) { + var ret = ''; + for (var i = 0; i < stack.length; ++i) { + if (ret) { + ret += '\n'; + } + ret += stack[i].tag.label; + } + return ret; +} + + +// XPath expression evaluation context. An XPath context consists of a +// DOM node, a list of DOM nodes that contains this node, a number +// that represents the position of the single node in the list, and a +// current set of variable bindings. (See XPath spec.) +// +// The interface of the expression context: +// +// Constructor -- gets the node, its position, the node set it +// belongs to, and a parent context as arguments. The parent context +// is used to implement scoping rules for variables: if a variable +// is not found in the current context, it is looked for in the +// parent context, recursively. Except for node, all arguments have +// default values: default position is 0, default node set is the +// set that contains only the node, and the default parent is null. +// +// Notice that position starts at 0 at the outside interface; +// inside XPath expressions this shows up as position()=1. +// +// clone() -- creates a new context with the current context as +// parent. If passed as argument to clone(), the new context has a +// different node, position, or node set. What is not passed is +// inherited from the cloned context. +// +// setVariable(name, expr) -- binds given XPath expression to the +// name. +// +// getVariable(name) -- what the name says. +// +// setNode(node, position) -- sets the context to the new node and +// its corresponding position. Needed to implement scoping rules for +// variables in XPath. (A variable is visible to all subsequent +// siblings, not only to its children.) + +function ExprContext(node, position, nodelist, parent) { + this.node = node; + this.position = position || 0; + this.nodelist = nodelist || [ node ]; + this.variables = {}; + this.parent = parent || null; + this.root = parent ? parent.root : node.ownerDocument; +} + +ExprContext.prototype.clone = function(node, position, nodelist) { + return new + ExprContext(node || this.node, + typeof position != 'undefined' ? position : this.position, + nodelist || this.nodelist, this); +}; + +ExprContext.prototype.setVariable = function(name, value) { + this.variables[name] = value; +}; + +ExprContext.prototype.getVariable = function(name) { + if (typeof this.variables[name] != 'undefined') { + return this.variables[name]; + + } else if (this.parent) { + return this.parent.getVariable(name); + + } else { + return null; + } +} + +ExprContext.prototype.setNode = function(node, position) { + this.node = node; + this.position = position; +} + + +// XPath expression values. They are what XPath expressions evaluate +// to. Strangely, the different value types are not specified in the +// XPath syntax, but only in the semantics, so they don't show up as +// nonterminals in the grammar. Yet, some expressions are required to +// evaluate to particular types, and not every type can be coerced +// into every other type. Although the types of XPath values are +// similar to the types present in JavaScript, the type coercion rules +// are a bit peculiar, so we explicitly model XPath types instead of +// mapping them onto JavaScript types. (See XPath spec.) +// +// The four types are: +// +// StringValue +// +// NumberValue +// +// BooleanValue +// +// NodeSetValue +// +// The common interface of the value classes consists of methods that +// implement the XPath type coercion rules: +// +// stringValue() -- returns the value as a JavaScript String, +// +// numberValue() -- returns the value as a JavaScript Number, +// +// booleanValue() -- returns the value as a JavaScript Boolean, +// +// nodeSetValue() -- returns the value as a JavaScript Array of DOM +// Node objects. +// + +function StringValue(value) { + this.value = value; + this.type = 'string'; +} + +StringValue.prototype.stringValue = function() { + return this.value; +} + +StringValue.prototype.booleanValue = function() { + return this.value.length > 0; +} + +StringValue.prototype.numberValue = function() { + return this.value - 0; +} + +StringValue.prototype.nodeSetValue = function() { + throw this + ' ' + Error().stack; +} + +function BooleanValue(value) { + this.value = value; + this.type = 'boolean'; +} + +BooleanValue.prototype.stringValue = function() { + return '' + this.value; +} + +BooleanValue.prototype.booleanValue = function() { + return this.value; +} + +BooleanValue.prototype.numberValue = function() { + return this.value ? 1 : 0; +} + +BooleanValue.prototype.nodeSetValue = function() { + throw this + ' ' + Error().stack; +} + +function NumberValue(value) { + this.value = value; + this.type = 'number'; +} + +NumberValue.prototype.stringValue = function() { + return '' + this.value; +} + +NumberValue.prototype.booleanValue = function() { + return !!this.value; +} + +NumberValue.prototype.numberValue = function() { + return this.value - 0; +} + +NumberValue.prototype.nodeSetValue = function() { + throw this + ' ' + Error().stack; +} + +function NodeSetValue(value) { + this.value = value; + this.type = 'node-set'; +} + +NodeSetValue.prototype.stringValue = function() { + if (this.value.length == 0) { + return ''; + } else { + return xmlValue(this.value[0]); + } +} + +NodeSetValue.prototype.booleanValue = function() { + return this.value.length > 0; +} + +NodeSetValue.prototype.numberValue = function() { + return this.stringValue() - 0; +} + +NodeSetValue.prototype.nodeSetValue = function() { + return this.value; +}; + +// XPath expressions. They are used as nodes in the parse tree and +// possess an evaluate() method to compute an XPath value given an XPath +// context. Expressions are returned from the parser. Teh set of +// expression classes closely mirrors the set of non terminal symbols +// in the grammar. Every non trivial nonterminal symbol has a +// corresponding expression class. +// +// The common expression interface consists of the following methods: +// +// evaluate(context) -- evaluates the expression, returns a value. +// +// toString() -- returns the XPath text representation of the +// expression (defined in xsltdebug.js). +// +// parseTree(indent) -- returns a parse tree representation of the +// expression (defined in xsltdebug.js). + +function TokenExpr(m) { + this.value = m; +} + +TokenExpr.prototype.evaluate = function() { + return new StringValue(this.value); +}; + +function LocationExpr() { + this.absolute = false; + this.steps = []; +} + +LocationExpr.prototype.appendStep = function(s) { + this.steps.push(s); +} + +LocationExpr.prototype.prependStep = function(s) { + var steps0 = this.steps; + this.steps = [ s ]; + for (var i = 0; i < steps0.length; ++i) { + this.steps.push(steps0[i]); + } +}; + +LocationExpr.prototype.evaluate = function(ctx) { + var start; + if (this.absolute) { + start = ctx.root; + + } else { + start = ctx.node; + } + + var nodes = []; + xPathStep(nodes, this.steps, 0, start, ctx); + return new NodeSetValue(nodes); +}; + +function xPathStep(nodes, steps, step, input, ctx) { + var s = steps[step]; + var ctx2 = ctx.clone(input); + var nodelist = s.evaluate(ctx2).nodeSetValue(); + + for (var i = 0; i < nodelist.length; ++i) { + if (step == steps.length - 1) { + nodes.push(nodelist[i]); + } else { + xPathStep(nodes, steps, step + 1, nodelist[i], ctx); + } + } +} + +function StepExpr(axis, nodetest, predicate) { + this.axis = axis; + this.nodetest = nodetest; + this.predicate = predicate || []; +} + +StepExpr.prototype.appendPredicate = function(p) { + this.predicate.push(p); +} + +StepExpr.prototype.evaluate = function(ctx) { + var input = ctx.node; + var nodelist = []; + + // NOTE(mesch): When this was a switch() statement, it didn't work + // in Safari/2.0. Not sure why though; it resulted in the JavaScript + // console output "undefined" (without any line number or so). + + if (this.axis == xpathAxis.ANCESTOR_OR_SELF) { + nodelist.push(input); + for (var n = input.parentNode; n; n = input.parentNode) { + nodelist.push(n); + } + + } else if (this.axis == xpathAxis.ANCESTOR) { + for (var n = input.parentNode; n; n = input.parentNode) { + nodelist.push(n); + } + + } else if (this.axis == xpathAxis.ATTRIBUTE) { + copyArray(nodelist, input.attributes); + + } else if (this.axis == xpathAxis.CHILD) { + copyArray(nodelist, input.childNodes); + + } else if (this.axis == xpathAxis.DESCENDANT_OR_SELF) { + nodelist.push(input); + xpathCollectDescendants(nodelist, input); + + } else if (this.axis == xpathAxis.DESCENDANT) { + xpathCollectDescendants(nodelist, input); + + } else if (this.axis == xpathAxis.FOLLOWING) { + for (var n = input.parentNode; n; n = n.parentNode) { + for (var nn = n.nextSibling; nn; nn = nn.nextSibling) { + nodelist.push(nn); + xpathCollectDescendants(nodelist, nn); + } + } + + } else if (this.axis == xpathAxis.FOLLOWING_SIBLING) { + for (var n = input.nextSibling; n; n = input.nextSibling) { + nodelist.push(n); + } + + } else if (this.axis == xpathAxis.NAMESPACE) { + alert('not implemented: axis namespace'); + + } else if (this.axis == xpathAxis.PARENT) { + if (input.parentNode) { + nodelist.push(input.parentNode); + } + + } else if (this.axis == xpathAxis.PRECEDING) { + for (var n = input.parentNode; n; n = n.parentNode) { + for (var nn = n.previousSibling; nn; nn = nn.previousSibling) { + nodelist.push(nn); + xpathCollectDescendantsReverse(nodelist, nn); + } + } + + } else if (this.axis == xpathAxis.PRECEDING_SIBLING) { + for (var n = input.previousSibling; n; n = input.previousSibling) { + nodelist.push(n); + } + + } else if (this.axis == xpathAxis.SELF) { + nodelist.push(input); + + } else { + throw 'ERROR -- NO SUCH AXIS: ' + this.axis; + } + + // process node test + var nodelist0 = nodelist; + nodelist = []; + for (var i = 0; i < nodelist0.length; ++i) { + var n = nodelist0[i]; + if (this.nodetest.evaluate(ctx.clone(n, i, nodelist0)).booleanValue()) { + nodelist.push(n); + } + } + + // process predicates + for (var i = 0; i < this.predicate.length; ++i) { + var nodelist0 = nodelist; + nodelist = []; + for (var ii = 0; ii < nodelist0.length; ++ii) { + var n = nodelist0[ii]; + if (this.predicate[i].evaluate(ctx.clone(n, ii, nodelist0)).booleanValue()) { + nodelist.push(n); + } + } + } + + return new NodeSetValue(nodelist); +}; + +function NodeTestAny() { + this.value = new BooleanValue(true); +} + +NodeTestAny.prototype.evaluate = function(ctx) { + return this.value; +}; + +function NodeTestElement() {} + +NodeTestElement.prototype.evaluate = function(ctx) { + return new BooleanValue(ctx.node.nodeType == DOM_ELEMENT_NODE); +} + +function NodeTestText() {} + +NodeTestText.prototype.evaluate = function(ctx) { + return new BooleanValue(ctx.node.nodeType == DOM_TEXT_NODE); +} + +function NodeTestComment() {} + +NodeTestComment.prototype.evaluate = function(ctx) { + return new BooleanValue(ctx.node.nodeType == DOM_COMMENT_NODE); +} + +function NodeTestPI(target) { + this.target = target; +} + +NodeTestPI.prototype.evaluate = function(ctx) { + return new + BooleanValue(ctx.node.nodeType == DOM_PROCESSING_INSTRUCTION_NODE && + (!this.target || ctx.node.nodeName == this.target)); +} + +function NodeTestNC(nsprefix) { + this.regex = new RegExp("^" + nsprefix + ":"); + this.nsprefix = nsprefix; +} + +NodeTestNC.prototype.evaluate = function(ctx) { + var n = ctx.node; + return new BooleanValue(this.regex.match(n.nodeName)); +} + +function NodeTestName(name) { + this.name = name; +} + +NodeTestName.prototype.evaluate = function(ctx) { + var n = ctx.node; + // NOTE (Patrick Lightbody): this change allows node selection to be case-insensitive + return new BooleanValue(n.nodeName.toUpperCase() == this.name.toUpperCase()); +} + +function PredicateExpr(expr) { + this.expr = expr; +} + +PredicateExpr.prototype.evaluate = function(ctx) { + var v = this.expr.evaluate(ctx); + if (v.type == 'number') { + // NOTE(mesch): Internally, position is represented starting with + // 0, however in XPath position starts with 1. See functions + // position() and last(). + return new BooleanValue(ctx.position == v.numberValue() - 1); + } else { + return new BooleanValue(v.booleanValue()); + } +}; + +function FunctionCallExpr(name) { + this.name = name; + this.args = []; +} + +FunctionCallExpr.prototype.appendArg = function(arg) { + this.args.push(arg); +}; + +FunctionCallExpr.prototype.evaluate = function(ctx) { + var fn = '' + this.name.value; + var f = this.xpathfunctions[fn]; + if (f) { + return f.call(this, ctx); + } else { + Log.write('XPath NO SUCH FUNCTION ' + fn); + return new BooleanValue(false); + } +}; + +FunctionCallExpr.prototype.xpathfunctions = { + 'last': function(ctx) { + assert(this.args.length == 0); + // NOTE(mesch): XPath position starts at 1. + return new NumberValue(ctx.nodelist.length); + }, + + 'position': function(ctx) { + assert(this.args.length == 0); + // NOTE(mesch): XPath position starts at 1. + return new NumberValue(ctx.position + 1); + }, + + 'count': function(ctx) { + assert(this.args.length == 1); + var v = this.args[0].evaluate(ctx); + return new NumberValue(v.nodeSetValue().length); + }, + + 'id': function(ctx) { + assert(this.args.length == 1); + var e = this.args.evaluate(ctx); + var ret = []; + var ids; + if (e.type == 'node-set') { + ids = []; + for (var i = 0; i < e.length; ++i) { + var v = xmlValue(e[i]).split(/\s+/); + for (var ii = 0; ii < v.length; ++ii) { + ids.push(v[ii]); + } + } + } else { + ids = e.split(/\s+/); + } + var d = ctx.node.ownerDocument; + for (var i = 0; i < ids.length; ++i) { + var n = d.getElementById(ids[i]); + if (n) { + ret.push(n); + } + } + return new NodeSetValue(ret); + }, + + 'local-name': function(ctx) { + alert('not implmented yet: XPath function local-name()'); + }, + + 'namespace-uri': function(ctx) { + alert('not implmented yet: XPath function namespace-uri()'); + }, + + 'name': function(ctx) { + assert(this.args.length == 1 || this.args.length == 0); + var n; + if (this.args.length == 0) { + n = [ ctx.node ]; + } else { + n = this.args[0].evaluate(ctx).nodeSetValue(); + } + + if (n.length == 0) { + return new StringValue(''); + } else { + return new StringValue(n[0].nodeName); + } + }, + + 'string': function(ctx) { + assert(this.args.length == 1 || this.args.length == 0); + if (this.args.length == 0) { + return new StringValue(new NodeSetValue([ ctx.node ]).stringValue()); + } else { + return new StringValue(this.args[0].evaluate(ctx).stringValue()); + } + }, + + 'concat': function(ctx) { + var ret = ''; + for (var i = 0; i < this.args.length; ++i) { + ret += this.args[i].evaluate(ctx).stringValue(); + } + return new StringValue(ret); + }, + + 'starts-with': function(ctx) { + assert(this.args.length == 2); + var s0 = this.args[0].evaluate(ctx).stringValue(); + var s1 = this.args[1].evaluate(ctx).stringValue(); + return new BooleanValue(s0.indexOf(s1) == 0); + }, + + 'contains': function(ctx) { + assert(this.args.length == 2); + var s0 = this.args[0].evaluate(ctx).stringValue(); + var s1 = this.args[1].evaluate(ctx).stringValue(); + return new BooleanValue(s0.indexOf(s1) != -1); + }, + + 'substring-before': function(ctx) { + assert(this.args.length == 2); + var s0 = this.args[0].evaluate(ctx).stringValue(); + var s1 = this.args[1].evaluate(ctx).stringValue(); + var i = s0.indexOf(s1); + var ret; + if (i == -1) { + ret = ''; + } else { + ret = s0.substr(0,i); + } + return new StringValue(ret); + }, + + 'substring-after': function(ctx) { + assert(this.args.length == 2); + var s0 = this.args[0].evaluate(ctx).stringValue(); + var s1 = this.args[1].evaluate(ctx).stringValue(); + var i = s0.indexOf(s1); + var ret; + if (i == -1) { + ret = ''; + } else { + ret = s0.substr(i + s1.length); + } + return new StringValue(ret); + }, + + 'substring': function(ctx) { + // NOTE: XPath defines the position of the first character in a + // string to be 1, in JavaScript this is 0 ([XPATH] Section 4.2). + assert(this.args.length == 2 || this.args.length == 3); + var s0 = this.args[0].evaluate(ctx).stringValue(); + var s1 = this.args[1].evaluate(ctx).numberValue(); + var ret; + if (this.args.length == 2) { + var i1 = Math.max(0, Math.round(s1) - 1); + ret = s0.substr(i1); + + } else { + var s2 = this.args[2].evaluate(ctx).numberValue(); + var i0 = Math.round(s1) - 1; + var i1 = Math.max(0, i0); + var i2 = Math.round(s2) - Math.max(0, -i0); + ret = s0.substr(i1, i2); + } + return new StringValue(ret); + }, + + 'string-length': function(ctx) { + var s; + if (this.args.length > 0) { + s = this.args[0].evaluate(ctx).stringValue(); + } else { + s = new NodeSetValue([ ctx.node ]).stringValue(); + } + return new NumberValue(s.length); + }, + + 'normalize-space': function(ctx) { + var s; + if (this.args.length > 0) { + s = this.args[0].evaluate(ctx).stringValue(); + } else { + s = new NodeSetValue([ ctx.node ]).stringValue(); + } + s = s.replace(/^\s*/,'').replace(/\s*$/,'').replace(/\s+/g, ' '); + return new StringValue(s); + }, + + 'translate': function(ctx) { + assert(this.args.length == 3); + var s0 = this.args[0].evaluate(ctx).stringValue(); + var s1 = this.args[1].evaluate(ctx).stringValue(); + var s2 = this.args[2].evaluate(ctx).stringValue(); + + for (var i = 0; i < s1.length; ++i) { + s0 = s0.replace(new RegExp(s1.charAt(i), 'g'), s2.charAt(i)); + } + return new StringValue(s0); + }, + + 'boolean': function(ctx) { + assert(this.args.length == 1); + return new BooleanValue(this.args[0].evaluate(ctx).booleanValue()); + }, + + 'not': function(ctx) { + assert(this.args.length == 1); + var ret = !this.args[0].evaluate(ctx).booleanValue(); + return new BooleanValue(ret); + }, + + 'true': function(ctx) { + assert(this.args.length == 0); + return new BooleanValue(true); + }, + + 'false': function(ctx) { + assert(this.args.length == 0); + return new BooleanValue(false); + }, + + 'lang': function(ctx) { + assert(this.args.length == 1); + var lang = this.args[0].evaluate(ctx).stringValue(); + var xmllang; + var n = ctx.node; + while (n && n != n.parentNode /* just in case ... */) { + xmllang = n.getAttribute('xml:lang'); + if (xmllang) { + break; + } + n = n.parentNode; + } + if (!xmllang) { + return new BooleanValue(false); + } else { + var re = new RegExp('^' + lang + '$', 'i'); + return new BooleanValue(xmllang.match(re) || + xmllang.replace(/_.*$/,'').match(re)); + } + }, + + 'number': function(ctx) { + assert(this.args.length == 1 || this.args.length == 0); + + if (this.args.length == 1) { + return new NumberValue(this.args[0].evaluate(ctx).numberValue()); + } else { + return new NumberValue(new NodeSetValue([ ctx.node ]).numberValue()); + } + }, + + 'sum': function(ctx) { + assert(this.args.length == 1); + var n = this.args[0].evaluate(ctx).nodeSetValue(); + var sum = 0; + for (var i = 0; i < n.length; ++i) { + sum += xmlValue(n[i]) - 0; + } + return new NumberValue(sum); + }, + + 'floor': function(ctx) { + assert(this.args.length == 1); + var num = this.args[0].evaluate(ctx).numberValue(); + return new NumberValue(Math.floor(num)); + }, + + 'ceiling': function(ctx) { + assert(this.args.length == 1); + var num = this.args[0].evaluate(ctx).numberValue(); + return new NumberValue(Math.ceil(num)); + }, + + 'round': function(ctx) { + assert(this.args.length == 1); + var num = this.args[0].evaluate(ctx).numberValue(); + return new NumberValue(Math.round(num)); + }, + + // TODO(mesch): The following functions are custom. There is a + // standard that defines how to add functions, which should be + // applied here. + + 'ext-join': function(ctx) { + assert(this.args.length == 2); + var nodes = this.args[0].evaluate(ctx).nodeSetValue(); + var delim = this.args[1].evaluate(ctx).stringValue(); + var ret = ''; + for (var i = 0; i < nodes.length; ++i) { + if (ret) { + ret += delim; + } + ret += xmlValue(nodes[i]); + } + return new StringValue(ret); + }, + + // ext-if() evaluates and returns its second argument, if the + // boolean value of its first argument is true, otherwise it + // evaluates and returns its third argument. + + 'ext-if': function(ctx) { + assert(this.args.length == 3); + if (this.args[0].evaluate(ctx).booleanValue()) { + return this.args[1].evaluate(ctx); + } else { + return this.args[2].evaluate(ctx); + } + }, + + 'ext-sprintf': function(ctx) { + assert(this.args.length >= 1); + var args = []; + for (var i = 0; i < this.args.length; ++i) { + args.push(this.args[i].evaluate(ctx).stringValue()); + } + return new StringValue(sprintf.apply(null, args)); + }, + + // ext-cardinal() evaluates its single argument as a number, and + // returns the current node that many times. It can be used in the + // select attribute to iterate over an integer range. + + 'ext-cardinal': function(ctx) { + assert(this.args.length >= 1); + var c = this.args[0].evaluate(ctx).numberValue(); + var ret = []; + for (var i = 0; i < c; ++i) { + ret.push(ctx.node); + } + return new NodeSetValue(ret); + } +}; + +function UnionExpr(expr1, expr2) { + this.expr1 = expr1; + this.expr2 = expr2; +} + +UnionExpr.prototype.evaluate = function(ctx) { + var nodes1 = this.expr1.evaluate(ctx).nodeSetValue(); + var nodes2 = this.expr2.evaluate(ctx).nodeSetValue(); + var I1 = nodes1.length; + for (var i2 = 0; i2 < nodes2.length; ++i2) { + for (var i1 = 0; i1 < I1; ++i1) { + if (nodes1[i1] == nodes2[i2]) { + // break inner loop and continue outer loop, labels confuse + // the js compiler, so we don't use them here. + i1 = I1; + } + } + nodes1.push(nodes2[i2]); + } + return new NodeSetValue(nodes2); +}; + +function PathExpr(filter, rel) { + this.filter = filter; + this.rel = rel; +} + +PathExpr.prototype.evaluate = function(ctx) { + var nodes = this.filter.evaluate(ctx).nodeSetValue(); + var nodes1 = []; + for (var i = 0; i < nodes.length; ++i) { + var nodes0 = this.rel.evaluate(ctx.clone(nodes[i], i, nodes)).nodeSetValue(); + for (var ii = 0; ii < nodes0.length; ++ii) { + nodes1.push(nodes0[ii]); + } + } + return new NodeSetValue(nodes1); +}; + +function FilterExpr(expr, predicate) { + this.expr = expr; + this.predicate = predicate; +} + +FilterExpr.prototype.evaluate = function(ctx) { + var nodes = this.expr.evaluate(ctx).nodeSetValue(); + for (var i = 0; i < this.predicate.length; ++i) { + var nodes0 = nodes; + nodes = []; + for (var j = 0; j < nodes0.length; ++j) { + var n = nodes0[j]; + if (this.predicate[i].evaluate(ctx.clone(n, j, nodes0)).booleanValue()) { + nodes.push(n); + } + } + } + + return new NodeSetValue(nodes); +} + +function UnaryMinusExpr(expr) { + this.expr = expr; +} + +UnaryMinusExpr.prototype.evaluate = function(ctx) { + return new NumberValue(-this.expr.evaluate(ctx).numberValue()); +}; + +function BinaryExpr(expr1, op, expr2) { + this.expr1 = expr1; + this.expr2 = expr2; + this.op = op; +} + +BinaryExpr.prototype.evaluate = function(ctx) { + var ret; + switch (this.op.value) { + case 'or': + ret = new BooleanValue(this.expr1.evaluate(ctx).booleanValue() || + this.expr2.evaluate(ctx).booleanValue()); + break; + + case 'and': + ret = new BooleanValue(this.expr1.evaluate(ctx).booleanValue() && + this.expr2.evaluate(ctx).booleanValue()); + break; + + case '+': + ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() + + this.expr2.evaluate(ctx).numberValue()); + break; + + case '-': + ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() - + this.expr2.evaluate(ctx).numberValue()); + break; + + case '*': + ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() * + this.expr2.evaluate(ctx).numberValue()); + break; + + case 'mod': + ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() % + this.expr2.evaluate(ctx).numberValue()); + break; + + case 'div': + ret = new NumberValue(this.expr1.evaluate(ctx).numberValue() / + this.expr2.evaluate(ctx).numberValue()); + break; + + case '=': + ret = this.compare(ctx, function(x1, x2) { return x1 == x2; }); + break; + + case '!=': + ret = this.compare(ctx, function(x1, x2) { return x1 != x2; }); + break; + + case '<': + ret = this.compare(ctx, function(x1, x2) { return x1 < x2; }); + break; + + case '<=': + ret = this.compare(ctx, function(x1, x2) { return x1 <= x2; }); + break; + + case '>': + ret = this.compare(ctx, function(x1, x2) { return x1 > x2; }); + break; + + case '>=': + ret = this.compare(ctx, function(x1, x2) { return x1 >= x2; }); + break; + + default: + alert('BinaryExpr.evaluate: ' + this.op.value); + } + return ret; +}; + +BinaryExpr.prototype.compare = function(ctx, cmp) { + var v1 = this.expr1.evaluate(ctx); + var v2 = this.expr2.evaluate(ctx); + + var ret; + if (v1.type == 'node-set' && v2.type == 'node-set') { + var n1 = v1.nodeSetValue(); + var n2 = v2.nodeSetValue(); + ret = false; + for (var i1 = 0; i1 < n1.length; ++i1) { + for (var i2 = 0; i2 < n2.length; ++i2) { + if (cmp(xmlValue(n1[i1]), xmlValue(n2[i2]))) { + ret = true; + // Break outer loop. Labels confuse the jscompiler and we + // don't use them. + i2 = n2.length; + i1 = n1.length; + } + } + } + + } else if (v1.type == 'node-set' || v2.type == 'node-set') { + + if (v1.type == 'number') { + var s = v1.numberValue(); + var n = v2.nodeSetValue(); + + ret = false; + for (var i = 0; i < n.length; ++i) { + var nn = xmlValue(n[i]) - 0; + if (cmp(s, nn)) { + ret = true; + break; + } + } + + } else if (v2.type == 'number') { + var n = v1.nodeSetValue(); + var s = v2.numberValue(); + + ret = false; + for (var i = 0; i < n.length; ++i) { + var nn = xmlValue(n[i]) - 0; + if (cmp(nn, s)) { + ret = true; + break; + } + } + + } else if (v1.type == 'string') { + var s = v1.stringValue(); + var n = v2.nodeSetValue(); + + ret = false; + for (var i = 0; i < n.length; ++i) { + var nn = xmlValue(n[i]); + if (cmp(s, nn)) { + ret = true; + break; + } + } + + } else if (v2.type == 'string') { + var n = v1.nodeSetValue(); + var s = v2.stringValue(); + + ret = false; + for (var i = 0; i < n.length; ++i) { + var nn = xmlValue(n[i]); + if (cmp(nn, s)) { + ret = true; + break; + } + } + + } else { + ret = cmp(v1.booleanValue(), v2.booleanValue()); + } + + } else if (v1.type == 'boolean' || v2.type == 'boolean') { + ret = cmp(v1.booleanValue(), v2.booleanValue()); + + } else if (v1.type == 'number' || v2.type == 'number') { + ret = cmp(v1.numberValue(), v2.numberValue()); + + } else { + ret = cmp(v1.stringValue(), v2.stringValue()); + } + + return new BooleanValue(ret); +} + +function LiteralExpr(value) { + this.value = value; +} + +LiteralExpr.prototype.evaluate = function(ctx) { + return new StringValue(this.value); +}; + +function NumberExpr(value) { + this.value = value; +} + +NumberExpr.prototype.evaluate = function(ctx) { + return new NumberValue(this.value); +}; + +function VariableExpr(name) { + this.name = name; +} + +VariableExpr.prototype.evaluate = function(ctx) { + return ctx.getVariable(this.name); +} + +// Factory functions for semantic values (i.e. Expressions) of the +// productions in the grammar. When a production is matched to reduce +// the current parse state stack, the function is called with the +// semantic values of the matched elements as arguments, and returns +// another semantic value. The semantic value is a node of the parse +// tree, an expression object with an evaluate() method that evaluates the +// expression in an actual context. These factory functions are used +// in the specification of the grammar rules, below. + +function makeTokenExpr(m) { + return new TokenExpr(m); +} + +function passExpr(e) { + return e; +} + +function makeLocationExpr1(slash, rel) { + rel.absolute = true; + return rel; +} + +function makeLocationExpr2(dslash, rel) { + rel.absolute = true; + rel.prependStep(makeAbbrevStep(dslash.value)); + return rel; +} + +function makeLocationExpr3(slash) { + var ret = new LocationExpr(); + ret.appendStep(makeAbbrevStep('.')); + ret.absolute = true; + return ret; +} + +function makeLocationExpr4(dslash) { + var ret = new LocationExpr(); + ret.absolute = true; + ret.appendStep(makeAbbrevStep(dslash.value)); + return ret; +} + +function makeLocationExpr5(step) { + var ret = new LocationExpr(); + ret.appendStep(step); + return ret; +} + +function makeLocationExpr6(rel, slash, step) { + rel.appendStep(step); + return rel; +} + +function makeLocationExpr7(rel, dslash, step) { + rel.appendStep(makeAbbrevStep(dslash.value)); + return rel; +} + +function makeStepExpr1(dot) { + return makeAbbrevStep(dot.value); +} + +function makeStepExpr2(ddot) { + return makeAbbrevStep(ddot.value); +} + +function makeStepExpr3(axisname, axis, nodetest) { + return new StepExpr(axisname.value, nodetest); +} + +function makeStepExpr4(at, nodetest) { + return new StepExpr('attribute', nodetest); +} + +function makeStepExpr5(nodetest) { + return new StepExpr('child', nodetest); +} + +function makeStepExpr6(step, predicate) { + step.appendPredicate(predicate); + return step; +} + +function makeAbbrevStep(abbrev) { + switch (abbrev) { + case '//': + return new StepExpr('descendant-or-self', new NodeTestAny); + + case '.': + return new StepExpr('self', new NodeTestAny); + + case '..': + return new StepExpr('parent', new NodeTestAny); + } +} + +function makeNodeTestExpr1(asterisk) { + return new NodeTestElement; +} + +function makeNodeTestExpr2(ncname, colon, asterisk) { + return new NodeTestNC(ncname.value); +} + +function makeNodeTestExpr3(qname) { + return new NodeTestName(qname.value); +} + +function makeNodeTestExpr4(typeo, parenc) { + var type = typeo.value.replace(/\s*\($/, ''); + switch(type) { + case 'node': + return new NodeTestAny; + + case 'text': + return new NodeTestText; + + case 'comment': + return new NodeTestComment; + + case 'processing-instruction': + return new NodeTestPI; + } +} + +function makeNodeTestExpr5(typeo, target, parenc) { + var type = typeo.replace(/\s*\($/, ''); + if (type != 'processing-instruction') { + throw type + ' ' + Error().stack; + } + return new NodeTestPI(target.value); +} + +function makePredicateExpr(pareno, expr, parenc) { + return new PredicateExpr(expr); +} + +function makePrimaryExpr(pareno, expr, parenc) { + return expr; +} + +function makeFunctionCallExpr1(name, pareno, parenc) { + return new FunctionCallExpr(name); +} + +function makeFunctionCallExpr2(name, pareno, arg1, args, parenc) { + var ret = new FunctionCallExpr(name); + ret.appendArg(arg1); + for (var i = 0; i < args.length; ++i) { + ret.appendArg(args[i]); + } + return ret; +} + +function makeArgumentExpr(comma, expr) { + return expr; +} + +function makeUnionExpr(expr1, pipe, expr2) { + return new UnionExpr(expr1, expr2); +} + +function makePathExpr1(filter, slash, rel) { + return new PathExpr(filter, rel); +} + +function makePathExpr2(filter, dslash, rel) { + rel.prependStep(makeAbbrevStep(dslash.value)); + return new PathExpr(filter, rel); +} + +function makeFilterExpr(expr, predicates) { + if (predicates.length > 0) { + return new FilterExpr(expr, predicates); + } else { + return expr; + } +} + +function makeUnaryMinusExpr(minus, expr) { + return new UnaryMinusExpr(expr); +} + +function makeBinaryExpr(expr1, op, expr2) { + return new BinaryExpr(expr1, op, expr2); +} + +function makeLiteralExpr(token) { + // remove quotes from the parsed value: + var value = token.value.substring(1, token.value.length - 1); + return new LiteralExpr(value); +} + +function makeNumberExpr(token) { + return new NumberExpr(token.value); +} + +function makeVariableReference(dollar, name) { + return new VariableExpr(name.value); +} + +// Used before parsing for optimization of common simple cases. See +// the begin of xpathParse() for which they are. +function makeSimpleExpr(expr) { + if (expr.charAt(0) == '$') { + return new VariableExpr(expr.substr(1)); + } else if (expr.charAt(0) == '@') { + var a = new NodeTestName(expr.substr(1)); + var b = new StepExpr('attribute', a); + var c = new LocationExpr(); + c.appendStep(b); + return c; + } else if (expr.match(/^[0-9]+$/)) { + return new NumberExpr(expr); + } else { + var a = new NodeTestName(expr); + var b = new StepExpr('child', a); + var c = new LocationExpr(); + c.appendStep(b); + return c; + } +} + +function makeSimpleExpr2(expr) { + var steps = expr.split('/'); + var c = new LocationExpr(); + for (var i in steps) { + var a = new NodeTestName(steps[i]); + var b = new StepExpr('child', a); + c.appendStep(b); + } + return c; +} + +// The axes of XPath expressions. + +var xpathAxis = { + ANCESTOR_OR_SELF: 'ancestor-or-self', + ANCESTOR: 'ancestor', + ATTRIBUTE: 'attribute', + CHILD: 'child', + DESCENDANT_OR_SELF: 'descendant-or-self', + DESCENDANT: 'descendant', + FOLLOWING_SIBLING: 'following-sibling', + FOLLOWING: 'following', + NAMESPACE: 'namespace', + PARENT: 'parent', + PRECEDING_SIBLING: 'preceding-sibling', + PRECEDING: 'preceding', + SELF: 'self' +}; + +var xpathAxesRe = [ + xpathAxis.ANCESTOR_OR_SELF, + xpathAxis.ANCESTOR, + xpathAxis.ATTRIBUTE, + xpathAxis.CHILD, + xpathAxis.DESCENDANT_OR_SELF, + xpathAxis.DESCENDANT, + xpathAxis.FOLLOWING_SIBLING, + xpathAxis.FOLLOWING, + xpathAxis.NAMESPACE, + xpathAxis.PARENT, + xpathAxis.PRECEDING_SIBLING, + xpathAxis.PRECEDING, + xpathAxis.SELF +].join('|'); + + +// The tokens of the language. The label property is just used for +// generating debug output. The prec property is the precedence used +// for shift/reduce resolution. Default precedence is 0 as a lookahead +// token and 2 on the stack. TODO(mesch): this is certainly not +// necessary and too complicated. Simplify this! + +// NOTE: tabular formatting is the big exception, but here it should +// be OK. + +var TOK_PIPE = { label: "|", prec: 17, re: new RegExp("^\\|") }; +var TOK_DSLASH = { label: "//", prec: 19, re: new RegExp("^//") }; +var TOK_SLASH = { label: "/", prec: 30, re: new RegExp("^/") }; +var TOK_AXIS = { label: "::", prec: 20, re: new RegExp("^::") }; +var TOK_COLON = { label: ":", prec: 1000, re: new RegExp("^:") }; +var TOK_AXISNAME = { label: "[axis]", re: new RegExp('^(' + xpathAxesRe + ')') }; +var TOK_PARENO = { label: "(", prec: 34, re: new RegExp("^\\(") }; +var TOK_PARENC = { label: ")", re: new RegExp("^\\)") }; +var TOK_DDOT = { label: "..", prec: 34, re: new RegExp("^\\.\\.") }; +var TOK_DOT = { label: ".", prec: 34, re: new RegExp("^\\.") }; +var TOK_AT = { label: "@", prec: 34, re: new RegExp("^@") }; + +var TOK_COMMA = { label: ",", re: new RegExp("^,") }; + +var TOK_OR = { label: "or", prec: 10, re: new RegExp("^or\\b") }; +var TOK_AND = { label: "and", prec: 11, re: new RegExp("^and\\b") }; +var TOK_EQ = { label: "=", prec: 12, re: new RegExp("^=") }; +var TOK_NEQ = { label: "!=", prec: 12, re: new RegExp("^!=") }; +var TOK_GE = { label: ">=", prec: 13, re: new RegExp("^>=") }; +var TOK_GT = { label: ">", prec: 13, re: new RegExp("^>") }; +var TOK_LE = { label: "<=", prec: 13, re: new RegExp("^<=") }; +var TOK_LT = { label: "<", prec: 13, re: new RegExp("^<") }; +var TOK_PLUS = { label: "+", prec: 14, re: new RegExp("^\\+"), left: true }; +var TOK_MINUS = { label: "-", prec: 14, re: new RegExp("^\\-"), left: true }; +var TOK_DIV = { label: "div", prec: 15, re: new RegExp("^div\\b"), left: true }; +var TOK_MOD = { label: "mod", prec: 15, re: new RegExp("^mod\\b"), left: true }; + +var TOK_BRACKO = { label: "[", prec: 32, re: new RegExp("^\\[") }; +var TOK_BRACKC = { label: "]", re: new RegExp("^\\]") }; +var TOK_DOLLAR = { label: "$", re: new RegExp("^\\$") }; + +var TOK_NCNAME = { label: "[ncname]", re: new RegExp('^[a-z][-\\w]*','i') }; + +var TOK_ASTERISK = { label: "*", prec: 15, re: new RegExp("^\\*"), left: true }; +var TOK_LITERALQ = { label: "[litq]", prec: 20, re: new RegExp("^'[^\\']*'") }; +var TOK_LITERALQQ = { + label: "[litqq]", + prec: 20, + re: new RegExp('^"[^\\"]*"') +}; + +var TOK_NUMBER = { + label: "[number]", + prec: 35, + re: new RegExp('^\\d+(\\.\\d*)?') }; + +var TOK_QNAME = { + label: "[qname]", + re: new RegExp('^([a-z][-\\w]*:)?[a-z][-\\w]*','i') +}; + +var TOK_NODEO = { + label: "[nodetest-start]", + re: new RegExp('^(processing-instruction|comment|text|node)\\(') +}; + +// The table of the tokens of our grammar, used by the lexer: first +// column the tag, second column a regexp to recognize it in the +// input, third column the precedence of the token, fourth column a +// factory function for the semantic value of the token. +// +// NOTE: order of this list is important, because the first match +// counts. Cf. DDOT and DOT, and AXIS and COLON. + +var xpathTokenRules = [ + TOK_DSLASH, + TOK_SLASH, + TOK_DDOT, + TOK_DOT, + TOK_AXIS, + TOK_COLON, + TOK_AXISNAME, + TOK_NODEO, + TOK_PARENO, + TOK_PARENC, + TOK_BRACKO, + TOK_BRACKC, + TOK_AT, + TOK_COMMA, + TOK_OR, + TOK_AND, + TOK_NEQ, + TOK_EQ, + TOK_GE, + TOK_GT, + TOK_LE, + TOK_LT, + TOK_PLUS, + TOK_MINUS, + TOK_ASTERISK, + TOK_PIPE, + TOK_MOD, + TOK_DIV, + TOK_LITERALQ, + TOK_LITERALQQ, + TOK_NUMBER, + TOK_QNAME, + TOK_NCNAME, + TOK_DOLLAR +]; + +// All the nonterminals of the grammar. The nonterminal objects are +// identified by object identity; the labels are used in the debug +// output only. +var XPathLocationPath = { label: "LocationPath" }; +var XPathRelativeLocationPath = { label: "RelativeLocationPath" }; +var XPathAbsoluteLocationPath = { label: "AbsoluteLocationPath" }; +var XPathStep = { label: "Step" }; +var XPathNodeTest = { label: "NodeTest" }; +var XPathPredicate = { label: "Predicate" }; +var XPathLiteral = { label: "Literal" }; +var XPathExpr = { label: "Expr" }; +var XPathPrimaryExpr = { label: "PrimaryExpr" }; +var XPathVariableReference = { label: "Variablereference" }; +var XPathNumber = { label: "Number" }; +var XPathFunctionCall = { label: "FunctionCall" }; +var XPathArgumentRemainder = { label: "ArgumentRemainder" }; +var XPathPathExpr = { label: "PathExpr" }; +var XPathUnionExpr = { label: "UnionExpr" }; +var XPathFilterExpr = { label: "FilterExpr" }; +var XPathDigits = { label: "Digits" }; + +var xpathNonTerminals = [ + XPathLocationPath, + XPathRelativeLocationPath, + XPathAbsoluteLocationPath, + XPathStep, + XPathNodeTest, + XPathPredicate, + XPathLiteral, + XPathExpr, + XPathPrimaryExpr, + XPathVariableReference, + XPathNumber, + XPathFunctionCall, + XPathArgumentRemainder, + XPathPathExpr, + XPathUnionExpr, + XPathFilterExpr, + XPathDigits +]; + +// Quantifiers that are used in the productions of the grammar. +var Q_01 = { label: "?" }; +var Q_MM = { label: "*" }; +var Q_1M = { label: "+" }; + +// Tag for left associativity (right assoc is implied by undefined). +var ASSOC_LEFT = true; + +// The productions of the grammar. Columns of the table: +// +// - target nonterminal, +// - pattern, +// - precedence, +// - semantic value factory +// +// The semantic value factory is a function that receives parse tree +// nodes from the stack frames of the matched symbols as arguments and +// returns an a node of the parse tree. The node is stored in the top +// stack frame along with the target object of the rule. The node in +// the parse tree is an expression object that has an evaluate() method +// and thus evaluates XPath expressions. +// +// The precedence is used to decide between reducing and shifting by +// comparing the precendence of the rule that is candidate for +// reducing with the precedence of the look ahead token. Precedence of +// -1 means that the precedence of the tokens in the pattern is used +// instead. TODO: It shouldn't be necessary to explicitly assign +// precedences to rules. + +var xpathGrammarRules = + [ + [ XPathLocationPath, [ XPathRelativeLocationPath ], 18, + passExpr ], + [ XPathLocationPath, [ XPathAbsoluteLocationPath ], 18, + passExpr ], + + [ XPathAbsoluteLocationPath, [ TOK_SLASH, XPathRelativeLocationPath ], 18, + makeLocationExpr1 ], + [ XPathAbsoluteLocationPath, [ TOK_DSLASH, XPathRelativeLocationPath ], 18, + makeLocationExpr2 ], + + [ XPathAbsoluteLocationPath, [ TOK_SLASH ], 0, + makeLocationExpr3 ], + [ XPathAbsoluteLocationPath, [ TOK_DSLASH ], 0, + makeLocationExpr4 ], + + [ XPathRelativeLocationPath, [ XPathStep ], 31, + makeLocationExpr5 ], + [ XPathRelativeLocationPath, + [ XPathRelativeLocationPath, TOK_SLASH, XPathStep ], 31, + makeLocationExpr6 ], + [ XPathRelativeLocationPath, + [ XPathRelativeLocationPath, TOK_DSLASH, XPathStep ], 31, + makeLocationExpr7 ], + + [ XPathStep, [ TOK_DOT ], 33, + makeStepExpr1 ], + [ XPathStep, [ TOK_DDOT ], 33, + makeStepExpr2 ], + [ XPathStep, + [ TOK_AXISNAME, TOK_AXIS, XPathNodeTest ], 33, + makeStepExpr3 ], + [ XPathStep, [ TOK_AT, XPathNodeTest ], 33, + makeStepExpr4 ], + [ XPathStep, [ XPathNodeTest ], 33, + makeStepExpr5 ], + [ XPathStep, [ XPathStep, XPathPredicate ], 33, + makeStepExpr6 ], + + [ XPathNodeTest, [ TOK_ASTERISK ], 33, + makeNodeTestExpr1 ], + [ XPathNodeTest, [ TOK_NCNAME, TOK_COLON, TOK_ASTERISK ], 33, + makeNodeTestExpr2 ], + [ XPathNodeTest, [ TOK_QNAME ], 33, + makeNodeTestExpr3 ], + [ XPathNodeTest, [ TOK_NODEO, TOK_PARENC ], 33, + makeNodeTestExpr4 ], + [ XPathNodeTest, [ TOK_NODEO, XPathLiteral, TOK_PARENC ], 33, + makeNodeTestExpr5 ], + + [ XPathPredicate, [ TOK_BRACKO, XPathExpr, TOK_BRACKC ], 33, + makePredicateExpr ], + + [ XPathPrimaryExpr, [ XPathVariableReference ], 33, + passExpr ], + [ XPathPrimaryExpr, [ TOK_PARENO, XPathExpr, TOK_PARENC ], 33, + makePrimaryExpr ], + [ XPathPrimaryExpr, [ XPathLiteral ], 30, + passExpr ], + [ XPathPrimaryExpr, [ XPathNumber ], 30, + passExpr ], + [ XPathPrimaryExpr, [ XPathFunctionCall ], 30, + passExpr ], + + [ XPathFunctionCall, [ TOK_QNAME, TOK_PARENO, TOK_PARENC ], -1, + makeFunctionCallExpr1 ], + [ XPathFunctionCall, + [ TOK_QNAME, TOK_PARENO, XPathExpr, XPathArgumentRemainder, Q_MM, + TOK_PARENC ], -1, + makeFunctionCallExpr2 ], + [ XPathArgumentRemainder, [ TOK_COMMA, XPathExpr ], -1, + makeArgumentExpr ], + + [ XPathUnionExpr, [ XPathPathExpr ], 20, + passExpr ], + [ XPathUnionExpr, [ XPathUnionExpr, TOK_PIPE, XPathPathExpr ], 20, + makeUnionExpr ], + + [ XPathPathExpr, [ XPathLocationPath ], 20, + passExpr ], + [ XPathPathExpr, [ XPathFilterExpr ], 19, + passExpr ], + [ XPathPathExpr, + [ XPathFilterExpr, TOK_SLASH, XPathRelativeLocationPath ], 20, + makePathExpr1 ], + [ XPathPathExpr, + [ XPathFilterExpr, TOK_DSLASH, XPathRelativeLocationPath ], 20, + makePathExpr2 ], + + [ XPathFilterExpr, [ XPathPrimaryExpr, XPathPredicate, Q_MM ], 20, + makeFilterExpr ], + + [ XPathExpr, [ XPathPrimaryExpr ], 16, + passExpr ], + [ XPathExpr, [ XPathUnionExpr ], 16, + passExpr ], + + [ XPathExpr, [ TOK_MINUS, XPathExpr ], -1, + makeUnaryMinusExpr ], + + [ XPathExpr, [ XPathExpr, TOK_OR, XPathExpr ], -1, + makeBinaryExpr ], + [ XPathExpr, [ XPathExpr, TOK_AND, XPathExpr ], -1, + makeBinaryExpr ], + + [ XPathExpr, [ XPathExpr, TOK_EQ, XPathExpr ], -1, + makeBinaryExpr ], + [ XPathExpr, [ XPathExpr, TOK_NEQ, XPathExpr ], -1, + makeBinaryExpr ], + + [ XPathExpr, [ XPathExpr, TOK_LT, XPathExpr ], -1, + makeBinaryExpr ], + [ XPathExpr, [ XPathExpr, TOK_LE, XPathExpr ], -1, + makeBinaryExpr ], + [ XPathExpr, [ XPathExpr, TOK_GT, XPathExpr ], -1, + makeBinaryExpr ], + [ XPathExpr, [ XPathExpr, TOK_GE, XPathExpr ], -1, + makeBinaryExpr ], + + [ XPathExpr, [ XPathExpr, TOK_PLUS, XPathExpr ], -1, + makeBinaryExpr, ASSOC_LEFT ], + [ XPathExpr, [ XPathExpr, TOK_MINUS, XPathExpr ], -1, + makeBinaryExpr, ASSOC_LEFT ], + + [ XPathExpr, [ XPathExpr, TOK_ASTERISK, XPathExpr ], -1, + makeBinaryExpr, ASSOC_LEFT ], + [ XPathExpr, [ XPathExpr, TOK_DIV, XPathExpr ], -1, + makeBinaryExpr, ASSOC_LEFT ], + [ XPathExpr, [ XPathExpr, TOK_MOD, XPathExpr ], -1, + makeBinaryExpr, ASSOC_LEFT ], + + [ XPathLiteral, [ TOK_LITERALQ ], -1, + makeLiteralExpr ], + [ XPathLiteral, [ TOK_LITERALQQ ], -1, + makeLiteralExpr ], + + [ XPathNumber, [ TOK_NUMBER ], -1, + makeNumberExpr ], + + [ XPathVariableReference, [ TOK_DOLLAR, TOK_QNAME ], 200, + makeVariableReference ] + ]; + +// That function computes some optimizations of the above data +// structures and will be called right here. It merely takes the +// counter variables out of the global scope. + +var xpathRules = []; + +function xpathParseInit() { + if (xpathRules.length) { + return; + } + + // Some simple optimizations for the xpath expression parser: sort + // grammar rules descending by length, so that the longest match is + // first found. + + xpathGrammarRules.sort(function(a,b) { + var la = a[1].length; + var lb = b[1].length; + if (la < lb) { + return 1; + } else if (la > lb) { + return -1; + } else { + return 0; + } + }); + + var k = 1; + for (var i = 0; i < xpathNonTerminals.length; ++i) { + xpathNonTerminals[i].key = k++; + } + + for (i = 0; i < xpathTokenRules.length; ++i) { + xpathTokenRules[i].key = k++; + } + + Log.write('XPath parse INIT: ' + k + ' rules'); + + // Another slight optimization: sort the rules into bins according + // to the last element (observing quantifiers), so we can restrict + // the match against the stack to the subest of rules that match the + // top of the stack. + // + // TODO(mesch): What we actually want is to compute states as in + // bison, so that we don't have to do any explicit and iterated + // match against the stack. + + function push_(array, position, element) { + if (!array[position]) { + array[position] = []; + } + array[position].push(element); + } + + for (i = 0; i < xpathGrammarRules.length; ++i) { + var rule = xpathGrammarRules[i]; + var pattern = rule[1]; + + for (var j = pattern.length - 1; j >= 0; --j) { + if (pattern[j] == Q_1M) { + push_(xpathRules, pattern[j-1].key, rule); + break; + + } else if (pattern[j] == Q_MM || pattern[j] == Q_01) { + push_(xpathRules, pattern[j-1].key, rule); + --j; + + } else { + push_(xpathRules, pattern[j].key, rule); + break; + } + } + } + + Log.write('XPath parse INIT: ' + xpathRules.length + ' rule bins'); + + var sum = 0; + mapExec(xpathRules, function(i) { + if (i) { + sum += i.length; + } + }); + + Log.write('XPath parse INIT: ' + (sum / xpathRules.length) + ' average bin size'); +} + +// Local utility functions that are used by the lexer or parser. + +function xpathCollectDescendants(nodelist, node) { + for (var n = node.firstChild; n; n = n.nextSibling) { + nodelist.push(n); + arguments.callee(nodelist, n); + } +} + +function xpathCollectDescendantsReverse(nodelist, node) { + for (var n = node.lastChild; n; n = n.previousSibling) { + nodelist.push(n); + arguments.callee(nodelist, n); + } +} + + +// The entry point for the library: match an expression against a DOM +// node. Returns an XPath value. +function xpathDomEval(expr, node) { + var expr1 = xpathParse(expr); + var ret = expr1.evaluate(new ExprContext(node)); + return ret; +} + +// Utility function to sort a list of nodes. Used by xsltSort() and +// nxslSelect(). +function xpathSort(input, sort) { + if (sort.length == 0) { + return; + } + + var sortlist = []; + + for (var i = 0; i < input.nodelist.length; ++i) { + var node = input.nodelist[i]; + var sortitem = { node: node, key: [] }; + var context = input.clone(node, 0, [ node ]); + + for (var j = 0; j < sort.length; ++j) { + var s = sort[j]; + var value = s.expr.evaluate(context); + + var evalue; + if (s.type == 'text') { + evalue = value.stringValue(); + } else if (s.type == 'number') { + evalue = value.numberValue(); + } + sortitem.key.push({ value: evalue, order: s.order }); + } + + // Make the sort stable by adding a lowest priority sort by + // id. This is very convenient and furthermore required by the + // spec ([XSLT] - Section 10 Sorting). + sortitem.key.push({ value: i, order: 'ascending' }); + + sortlist.push(sortitem); + } + + sortlist.sort(xpathSortByKey); + + var nodes = []; + for (var i = 0; i < sortlist.length; ++i) { + nodes.push(sortlist[i].node); + } + input.nodelist = nodes; + input.setNode(nodes[0], 0); +} + + +// Sorts by all order criteria defined. According to the JavaScript +// spec ([ECMA] Section 11.8.5), the compare operators compare strings +// as strings and numbers as numbers. +// +// NOTE: In browsers which do not follow the spec, this breaks only in +// the case that numbers should be sorted as strings, which is very +// uncommon. + +function xpathSortByKey(v1, v2) { + // NOTE: Sort key vectors of different length never occur in + // xsltSort. + + for (var i = 0; i < v1.key.length; ++i) { + var o = v1.key[i].order == 'descending' ? -1 : 1; + if (v1.key[i].value > v2.key[i].value) { + return +1 * o; + } else if (v1.key[i].value < v2.key[i].value) { + return -1 * o; + } + } + + return 0; +} diff --git a/tests/FunctionalTests/selenium/php/TestRunner.php b/tests/test_tools/selenium/php/TestRunner.php index 9bb5ada3..a82ce0dd 100644 --- a/tests/FunctionalTests/selenium/php/TestRunner.php +++ b/tests/test_tools/selenium/php/TestRunner.php @@ -80,7 +80,7 @@ Copyright 2004 ThoughtWorks, Inc <table class="layout"> <tr class="selenium"> <th width="25%" height="1" class="header"> - <h1><a href="http://selenium.thoughtworks.com" title="The Selenium Project">Selenium</a> TestRunner</h1> + <h3><a href="http://selenium.thoughtworks.com" title="The Selenium Project">Selenium</a></h3> </th> </tr> <tr> @@ -139,19 +139,18 @@ Copyright 2004 ThoughtWorks, Inc <td>incomplete</td> </tr> </table> - + <!-- <fieldset> <legend>Tools</legend> - <button type="button" id="domViewer1" onClick="openDomViewer();"> View DOM - </button> + </button> <button type="button" onClick="LOG.show();"> Show Log </button> </fieldset> - + --> </td> </tr> </table> diff --git a/tests/FunctionalTests/selenium/php/results.php b/tests/test_tools/selenium/php/results.php index 77dab43b..77dab43b 100644 --- a/tests/FunctionalTests/selenium/php/results.php +++ b/tests/test_tools/selenium/php/results.php diff --git a/tests/FunctionalTests/selenium/php/selenium.php b/tests/test_tools/selenium/php/selenium.php index 960791b8..9ad4955b 100644 --- a/tests/FunctionalTests/selenium/php/selenium.php +++ b/tests/test_tools/selenium/php/selenium.php @@ -49,7 +49,9 @@ class SeleniumTestRunner if((php_sapi_name() == 'cli')) return; $file = dirname(__FILE__).'/TestRunner.php'; $driver = $this->driver; - $base_dir = $this->base_dir; + + //$base_dir = $this->base_dir; + $base_dir = $driver.'?sr='; include($file); } @@ -164,7 +166,7 @@ class SeleniumTestTrace } } -class SimpleSeleniumProxyServer// extends SeleniumProxyServer +class SimpleSeleniumProxyServer { protected $runner; protected $int; @@ -207,20 +209,9 @@ class SimpleSeleniumProxyServer// extends SeleniumProxyServer public function serveResults() { - $result = null; - if(isset($_POST['result'])) { $result = new SeleniumTestResult(); - file_put_contents($this->result_file, serialize($result)); - } - else if(isset($_GET['results'])) - { - if(is_file($this->result_file)) - $result = unserialize(file_get_contents($this->result_file)); - } - if(!is_null($result)) - { $reporter = new SeleniumHtmlReporter($result); $reporter->render(); exit(); diff --git a/tests/FunctionalTests/selenium/prado-functional-test.js b/tests/test_tools/selenium/prado-functional-test.js index 306f6a74..306f6a74 100644 --- a/tests/FunctionalTests/selenium/prado-functional-test.js +++ b/tests/test_tools/selenium/prado-functional-test.js diff --git a/tests/UnitTests/simpletest/CHANGELOG b/tests/test_tools/simpletest/CHANGELOG index e416f9a6..961ce208 100644..100755 --- a/tests/UnitTests/simpletest/CHANGELOG +++ b/tests/test_tools/simpletest/CHANGELOG @@ -1,6 +1,6 @@ -June 7, 2005, by Qiang Xue (qiang.xue@gmail.com)
-------------------------------------------------
-- changed all class memeber declarations from 'var $varname' to 'private $varname'.
-- removed all reference usages, including creating new objects, returning and passing objects.
-- modified expectation.php line 106 from 'function test($compare, &$nasty=false) {' to 'function test($compare) {'.
+June 7, 2005, by Qiang Xue (qiang.xue@gmail.com) +------------------------------------------------ +- changed all class memeber declarations from 'var $varname' to 'private $varname'. +- removed all reference usages, including creating new objects, returning and passing objects. +- modified expectation.php line 106 from 'function test($compare, &$nasty=false) {' to 'function test($compare) {'. - added HtmlReporterWithCoverage.php
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE b/tests/test_tools/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE index 357ff092..99c3be2d 100644..100755 --- a/tests/UnitTests/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE +++ b/tests/test_tools/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE @@ -1,201 +1,201 @@ -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...
-
-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.
-
-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.
+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... + +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. + +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. diff --git a/tests/UnitTests/simpletest/HtmlReporterWithCoverage.php b/tests/test_tools/simpletest/HtmlReporterWithCoverage.php index dd900051..abd10076 100644 --- a/tests/UnitTests/simpletest/HtmlReporterWithCoverage.php +++ b/tests/test_tools/simpletest/HtmlReporterWithCoverage.php @@ -1,268 +1,268 @@ -<?php
-
-if (!defined('T_ML_COMMENT'))
- define('T_ML_COMMENT', T_COMMENT);
-else
- define('T_DOC_COMMENT', T_ML_COMMENT);
-
-class HtmlReporterWithCoverage extends HtmlReporter
-{
- protected $coverage = array();
-
- protected $painter;
-
- protected $base_dir;
-
- function __construct($painter = 'index.php', $base_dir)
- {
- $this->painter = $painter;
- $this->base_dir = $base_dir;
- }
-
- function paintHeader($test_name, $charset="UTF-8")
- {
- $this->sendNoCacheHeaders();
- header('Content-Type: text/html; Charset='.$charset);
- print "<html>\n<head>\n<title>$test_name</title>\n";
- print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset={$charset}\"/>";
- print "<style type=\"text/css\">\n";
- print $this->_getCss() . "\n";
- print "</style>\n";
- print "</head>\n<body>\n";
- print "<h1>$test_name</h1>\n";
- flush();
-
- if (extension_loaded('xdebug'))
- xdebug_start_code_coverage(XDEBUG_CC_UNUSED);
-
- }
-
- /**
- *
- */
- function _getCss()
- {
- $contents = parent::_getCss()."\n ";
- $contents .= '
- .bar { float: left; display: inline; border: 1px solid #eee; width: 300px; white-space: nowrap;}
- .percentage { float: left; background-color: #eef; font-family: Verdana, Geneva, Arial, Helvetica, sans-serif; font-size: 0.65em; padding: 5px; margin-right: }
- .coverage {margin: 0.4em; }
- .coverage a {
- padding-left: 0.5em;
- }
- .coverage:after {
- content: ".";
- display: block;
- height: 0;
- clear: both;
- visibility: hidden;
- }
- .coverage {display: inline-block;}
- /* Hides from IE-mac \*/
- * html .coverage {height: 1%;}
- .coverage {display: block;}
- /* End hide from IE-mac */
- ';
- Return $contents;
- }
-
- function paintFooter($test_name)
- {
- if (extension_loaded('xdebug'))
- {
- $this->coverage = xdebug_get_code_coverage();
- xdebug_stop_code_coverage();
- }
-
- $colour = ($this->getFailCount() + $this->getExceptionCount() > 0 ? "red" : "green");
- print "<div style=\"";
- print "padding: 8px; margin-top: 1em; background-color: $colour; color: white;";
- print "\">";
- print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount();
- print " test cases complete:\n";
- print "<strong>" . $this->getPassCount() . "</strong> passes, ";
- print "<strong>" . $this->getFailCount() . "</strong> fails and ";
- print "<strong>" . $this->getExceptionCount() . "</strong> exceptions.";
- print "</div>\n";
- $this->paintCoverage();
- print "</body>\n</html>\n";
- }
-
- function paintCoverage()
- {
- $dir = dirname(__FILE__);
- if(count($this->coverage) > 0)
- print '<h2>Code Coverage</h2>';
-
-
- ksort($this->coverage);
-
- $details = array();
- foreach($this->coverage as $file => $coverage)
- {
- if(is_int(strpos($file, $dir)) == false
- && is_int(strpos($file, 'simpletest')) == false
- && is_int(strpos($file, $this->base_dir)))
- {
- $total = HTMLCoverageReport::codelines($file);
- $executed = count($coverage);
- $percentage = sprintf('%01d',$executed/$total*100);
- $width = $percentage * 3;
- $filename = str_replace($this->base_dir, '',$file);
- $link = $this->constructURL($filename, $coverage);
-
- $detail['total'] = $total;
- $detail['executed'] = $executed;
- $detail['width'] = $width;
- $detail['filename'] = $filename;
- $detail['link'] = $link;
- $details[$percentage][] = $detail;
- }
- }
- krsort($details);
- foreach($details as $percentage => $files)
- {
- foreach($files as $detail)
- {
- $total = $detail['total'];
- $executed = $detail['executed'];
- $width = $detail['width'];
- $filename = $detail['filename'];
- $link = $detail['link'];
-
- print "<div class=\"coverage\">";
- print "<span class=\"bar\">";
- print "<span class=\"percentage\" style=\"width:{$width}px\">";
- print "$executed/$total\n";
- print "$percentage%</span></span>\n";
- print "<a href=\"{$link}\">{$filename}</a>\n";
- print "</div>\n";
- }
- }
- }
-
- function constructURL($file, $coverage)
- {
- $file = rawurlencode($file);
- $lines = implode(',', array_keys($coverage));
- return $this->painter.'?file='.$file.'&lines='.$lines;
- }
-}
-
-
-class HTMLCoverageReport extends HtmlReporter
-{
- protected $file;
- protected $lines;
- protected $name;
-
- function __construct($file, $name, $lines)
- {
- $this->file = $file;
- $this->lines = $lines;
- $this->name = $name;
- }
-
- function show()
- {
- $this->paintHeader($this->name);
-
- $contents = file($this->file);
- foreach($contents as $count => $line)
- {
- $num = ($count+1);
- $line = preg_replace("/\\n|\\r/",'',$line);
- $line = htmlspecialchars($line);
- $line = str_replace(' ',' ',$line);
- $line = str_replace("\t",' ',$line);
- if(in_array($count+1, $this->lines))
- echo "<div class=\"highlight\"><tt>$num $line</tt></div>\n";
- else
- echo "<tt>$num $line</tt><br />\n";
- }
-
- $this->paintFooter();
- }
-
- function paintHeader($file, $charset="UTF-8")
- {
- $total = $this->codelines($this->file);
- $executed = count($this->lines);
- $percentage = sprintf('%01.2f',$executed/$total*100);
-
- $this->sendNoCacheHeaders();
- header('Content-Type: text/html Charset='.$charset);
- print "<html>\n<head>\n<title>Code Coverage: $file</title>\n";
- print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset={$charset}\"/>";
- print "<style type=\"text/css\">\n";
- print $this->_getCss() . "\n";
- print ".highlight { background-color: #eef; } \n";
- print ".filename { margin-bottom: 2em; } \n";
- print "</style>\n";
- print "</head>\n<body>\n";
- print "<h1>Code Coverage</h1>\n";
- print "<div class=\"filename\"><strong>$file</strong></div>";
- print "<div class=\"filename\"><tt> Total code lines: {$total} <br /> Total lines executed: {$executed} ({$percentage}%)</tt></div>";
- flush();
- }
-
- function paintFooter($test_name)
- {
- print "</body>\n</html>\n";
- }
-
- static function codelines($file)
- {
- $source = file_get_contents($file);
- $tokens = @token_get_all($source);
-
- $lines = '';
-
- foreach ($tokens as $token)
- {
- if (is_string($token))
- {
- // simple 1-character token
- $lines .= $token;
- }
- else
- {
- // token array
- list($id, $text) = $token;
-
- switch ($id)
- {
- case T_COMMENT:
- case T_ML_COMMENT: // we've defined this
- case T_DOC_COMMENT: // and this
- // no action on comments
- break;
-
- default:
- // anything else -> output "as is"
- //echo $text;
- $lines .= $text;
- break;
- }
- }
- }
-
- $lines = preg_replace('/\\n\s*$/m',"",$lines);
- $codelines = explode("\n",$lines);
- $count = 0;
- $patterns[] = '^\s*{\s*$';
- $patterns[] = '<\?';
- $patterns[] = '^\s*(private|protected|public)\s+\$';
- $pattern = '/'.implode('|', $patterns).'/';
- foreach($codelines as $line)
- {
- if(!preg_match($pattern, $line))
- $count++;
- }
- return $count;
- //var_dump($codelines);
- //return count($codelines);
- }
-}
-
-?>
+<?php + +if (!defined('T_ML_COMMENT')) + define('T_ML_COMMENT', T_COMMENT); +else + define('T_DOC_COMMENT', T_ML_COMMENT); + +class HtmlReporterWithCoverage extends HtmlReporter +{ + protected $coverage = array(); + + protected $painter; + + protected $base_dir; + + function __construct($painter = 'index.php', $base_dir) + { + $this->painter = $painter; + $this->base_dir = $base_dir; + } + + function paintHeader($test_name, $charset="UTF-8") + { + $this->sendNoCacheHeaders(); + header('Content-Type: text/html; Charset='.$charset); + print "<html>\n<head>\n<title>$test_name</title>\n"; + print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset={$charset}\"/>"; + print "<style type=\"text/css\">\n"; + print $this->_getCss() . "\n"; + print "</style>\n"; + print "</head>\n<body>\n"; + print "<h1>$test_name</h1>\n"; + flush(); + + if (extension_loaded('xdebug')) + xdebug_start_code_coverage(XDEBUG_CC_UNUSED); + + } + + /** + * + */ + function _getCss() + { + $contents = parent::_getCss()."\n "; + $contents .= ' + .bar { float: left; display: inline; border: 1px solid #eee; width: 300px; white-space: nowrap;} + .percentage { float: left; background-color: #eef; font-family: Verdana, Geneva, Arial, Helvetica, sans-serif; font-size: 0.65em; padding: 5px; margin-right: } + .coverage {margin: 0.4em; } + .coverage a { + padding-left: 0.5em; + } + .coverage:after { + content: "."; + display: block; + height: 0; + clear: both; + visibility: hidden; + } + .coverage {display: inline-block;} + /* Hides from IE-mac \*/ + * html .coverage {height: 1%;} + .coverage {display: block;} + /* End hide from IE-mac */ + '; + Return $contents; + } + + function paintFooter($test_name) + { + if (extension_loaded('xdebug')) + { + $this->coverage = xdebug_get_code_coverage(); + xdebug_stop_code_coverage(); + } + + $colour = ($this->getFailCount() + $this->getExceptionCount() > 0 ? "red" : "green"); + print "<div style=\""; + print "padding: 8px; margin-top: 1em; background-color: $colour; color: white;"; + print "\">"; + print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount(); + print " test cases complete:\n"; + print "<strong>" . $this->getPassCount() . "</strong> passes, "; + print "<strong>" . $this->getFailCount() . "</strong> fails and "; + print "<strong>" . $this->getExceptionCount() . "</strong> exceptions."; + print "</div>\n"; + $this->paintCoverage(); + print "</body>\n</html>\n"; + } + + function paintCoverage() + { + $dir = dirname(__FILE__); + if(count($this->coverage) > 0) + print '<h2>Code Coverage</h2>'; + + + ksort($this->coverage); + + $details = array(); + foreach($this->coverage as $file => $coverage) + { + if(is_int(strpos($file, $dir)) == false + && is_int(strpos($file, 'simpletest')) == false + && is_int(strpos($file, $this->base_dir))) + { + $total = HTMLCoverageReport::codelines($file); + $executed = count($coverage); + $percentage = sprintf('%01d',$executed/$total*100); + $width = $percentage * 3; + $filename = str_replace($this->base_dir, '',$file); + $link = $this->constructURL($filename, $coverage); + + $detail['total'] = $total; + $detail['executed'] = $executed; + $detail['width'] = $width; + $detail['filename'] = $filename; + $detail['link'] = $link; + $details[$percentage][] = $detail; + } + } + krsort($details); + foreach($details as $percentage => $files) + { + foreach($files as $detail) + { + $total = $detail['total']; + $executed = $detail['executed']; + $width = $detail['width']; + $filename = $detail['filename']; + $link = $detail['link']; + + print "<div class=\"coverage\">"; + print "<span class=\"bar\">"; + print "<span class=\"percentage\" style=\"width:{$width}px\">"; + print "$executed/$total\n"; + print "$percentage%</span></span>\n"; + print "<a href=\"{$link}\">{$filename}</a>\n"; + print "</div>\n"; + } + } + } + + function constructURL($file, $coverage) + { + $file = rawurlencode($file); + $lines = implode(',', array_keys($coverage)); + return $this->painter.'?file='.$file.'&lines='.$lines; + } +} + + +class HTMLCoverageReport extends HtmlReporter +{ + protected $file; + protected $lines; + protected $name; + + function __construct($file, $name, $lines) + { + $this->file = $file; + $this->lines = $lines; + $this->name = $name; + } + + function show() + { + $this->paintHeader($this->name); + + $contents = file($this->file); + foreach($contents as $count => $line) + { + $num = ($count+1); + $line = preg_replace("/\\n|\\r/",'',$line); + $line = htmlspecialchars($line); + $line = str_replace(' ',' ',$line); + $line = str_replace("\t",' ',$line); + if(in_array($count+1, $this->lines)) + echo "<div class=\"highlight\"><tt>$num $line</tt></div>\n"; + else + echo "<tt>$num $line</tt><br />\n"; + } + + $this->paintFooter(); + } + + function paintHeader($file, $charset="UTF-8") + { + $total = $this->codelines($this->file); + $executed = count($this->lines); + $percentage = sprintf('%01.2f',$executed/$total*100); + + $this->sendNoCacheHeaders(); + header('Content-Type: text/html Charset='.$charset); + print "<html>\n<head>\n<title>Code Coverage: $file</title>\n"; + print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset={$charset}\"/>"; + print "<style type=\"text/css\">\n"; + print $this->_getCss() . "\n"; + print ".highlight { background-color: #eef; } \n"; + print ".filename { margin-bottom: 2em; } \n"; + print "</style>\n"; + print "</head>\n<body>\n"; + print "<h1>Code Coverage</h1>\n"; + print "<div class=\"filename\"><strong>$file</strong></div>"; + print "<div class=\"filename\"><tt> Total code lines: {$total} <br /> Total lines executed: {$executed} ({$percentage}%)</tt></div>"; + flush(); + } + + function paintFooter($test_name) + { + print "</body>\n</html>\n"; + } + + static function codelines($file) + { + $source = file_get_contents($file); + $tokens = @token_get_all($source); + + $lines = ''; + + foreach ($tokens as $token) + { + if (is_string($token)) + { + // simple 1-character token + $lines .= $token; + } + else + { + // token array + list($id, $text) = $token; + + switch ($id) + { + case T_COMMENT: + case T_ML_COMMENT: // we've defined this + case T_DOC_COMMENT: // and this + // no action on comments + break; + + default: + // anything else -> output "as is" + //echo $text; + $lines .= $text; + break; + } + } + } + + $lines = preg_replace('/\\n\s*$/m',"",$lines); + $codelines = explode("\n",$lines); + $count = 0; + $patterns[] = '^\s*{\s*$'; + $patterns[] = '<\?'; + $patterns[] = '^\s*(private|protected|public)\s+\$'; + $pattern = '/'.implode('|', $patterns).'/'; + foreach($codelines as $line) + { + if(!preg_match($pattern, $line)) + $count++; + } + return $count; + //var_dump($codelines); + //return count($codelines); + } +} + +?> diff --git a/tests/UnitTests/simpletest/LICENSE b/tests/test_tools/simpletest/LICENSE index 78d032ad..93acab79 100644..100755 --- a/tests/UnitTests/simpletest/LICENSE +++ b/tests/test_tools/simpletest/LICENSE @@ -1,49 +1,49 @@ -The Open Group Test Suite License
-
-Preamble
-
-The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications.
-
-Testing is essential for proper development and maintenance of standards-based products.
-
-For buyers: adequate conformance testing leads to reduced integration costs and protection of investments in applications, software and people.
-
-For software developers: conformance testing of platforms and middleware greatly reduces the cost of developing and maintaining multi-platform application software.
-
-For suppliers: In-depth testing increases customer satisfaction and keeps development and support costs in check. API conformance is highly measurable and suppliers who claim it must be able to substantiate that claim.
-
-As such, since these are benchmark measures of conformance, we feel the integrity of test tools is of importance. In order to preserve the integrity of the existing conformance modes of this test package and to permit recipients of modified versions of this package to run the original test modes, this license requires that the original test modes be preserved.
-
-If you find a bug in one of the standards mode test cases, please let us know so we can feed this back into the original, and also raise any specification issues with the appropriate bodies (for example the POSIX committees).
-
-Definitions:
-
- * "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification.
- * "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder.
- * "Copyright Holder" is whoever is named in the copyright or copyrights for the package. "You" is you, if you're thinking about copying or distributing this Package.
- * "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.)
-* "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it.
-
-1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers.
-
-2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version.
-
-3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least the following:
-
-rename any non-standard executables and testcases so the names do not conflict with standard executables and testcases, which must also be provided, and provide a separate manual page for each non-standard executable and testcase that clearly documents how it differs from the Standard Version.
-
-4. You may distribute the programs of this Package in object code or executable form, provided that you do at least the following:
-
-accompany any non-standard executables and testcases with their corresponding Standard Version executables and testcases, giving the non-standard executables and testcases non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version.
-
-5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own.
-
-6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package.
-
-7.Subroutines supplied by you and linked into this Package shall not be considered part of this Package.
-
-8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission.
-
-9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-The End
+The Open Group Test Suite License + +Preamble + +The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. + +Testing is essential for proper development and maintenance of standards-based products. + +For buyers: adequate conformance testing leads to reduced integration costs and protection of investments in applications, software and people. + +For software developers: conformance testing of platforms and middleware greatly reduces the cost of developing and maintaining multi-platform application software. + +For suppliers: In-depth testing increases customer satisfaction and keeps development and support costs in check. API conformance is highly measurable and suppliers who claim it must be able to substantiate that claim. + +As such, since these are benchmark measures of conformance, we feel the integrity of test tools is of importance. In order to preserve the integrity of the existing conformance modes of this test package and to permit recipients of modified versions of this package to run the original test modes, this license requires that the original test modes be preserved. + +If you find a bug in one of the standards mode test cases, please let us know so we can feed this back into the original, and also raise any specification issues with the appropriate bodies (for example the POSIX committees). + +Definitions: + + * "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. + * "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. + * "Copyright Holder" is whoever is named in the copyright or copyrights for the package. "You" is you, if you're thinking about copying or distributing this Package. + * "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) +* "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. + +1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least the following: + +rename any non-standard executables and testcases so the names do not conflict with standard executables and testcases, which must also be provided, and provide a separate manual page for each non-standard executable and testcase that clearly documents how it differs from the Standard Version. + +4. You may distribute the programs of this Package in object code or executable form, provided that you do at least the following: + +accompany any non-standard executables and testcases with their corresponding Standard Version executables and testcases, giving the non-standard executables and testcases non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. + +5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. + +7.Subroutines supplied by you and linked into this Package shall not be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End diff --git a/tests/UnitTests/simpletest/README b/tests/test_tools/simpletest/README index b8dd6d1a..50fa4aaa 100644..100755 --- a/tests/UnitTests/simpletest/README +++ b/tests/test_tools/simpletest/README @@ -1,110 +1,110 @@ -SimpleTest
-==========
-You probably got this package from...
-http://sourceforge.net/projects/simpletest/
-
-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 4.2.0+.
-
-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 are not tied to just using SimpleTest, though. The mocks and stubs
-will work with other test frameworks and SimpleTest can use other
-framework's (PHPUnit, PEAR::PhpUnit) test cases as it's own. The
-web browser part of the web tester can also be used independently either
-in other testers or as part of a scripting solution.
-
-You can see a release schedule at http://www.lastcraft.com/overview.php
-which is also copied to the documentation folder with this release.
-A full PHPDocumenter API documentation exists at
-http://simpletest.sourceforge.net/.
-
-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 are looking at a first full release. The unit tests for SimpleTest
-itself can be run here...
-
-simpletest/test/unit_tests.php
-
-And tests involving live network connections as well are here...
-
-simpletest/test/all_tests.php
-
-The full tests will typically overrun the 8Mb limit usually allowed
-to a PHP process. A workaround is to run the tests on the command
-with a custom php.ini file if you do not have access to your server
-version.
-
-You will have to edit the all_tests.php file if you are accesssing
-the internet through a proxy server. See the comments in all_tests.php
-for instructions.
-
-The full tests read some test data from the LastCraft site. 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. As far as we know we haven't yet managed to check in any
-test failures so please correct us if you find one.
-
-Even if all of the tests run please verify that your existing test suites
-also function as expected. If they don't see the file...
-
-HELP_MY_TESTS_DONT_WORK_ANYMORE
-
-This 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://www.lastcraft.com/first_test_tutorial.php
-to get you started and this material will eventually become included
-with the project documentation. A French translation exists at
-http://www.onpk.net/index.php/2005/01/12/254-tutoriel-simpletest-decouvrir-les-tests-unitaires.
-
-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 version one 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 as yet 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 CVS only.
-The CVS check-ins always have all the tests passing and so CVS snapshots should
-be pretty usable, although the code may not look so good internally.
-
-Oh, yes. It 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
-Feucks. Early adopters are always an inspiration.
-
-yours Marcus Baker, Jason Sweat and Perrick Penet.
---
-marcus@lastcraft.com
+SimpleTest +========== +You probably got this package from... +http://sourceforge.net/projects/simpletest/ + +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 4.2.0+. + +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 are not tied to just using SimpleTest, though. The mocks and stubs +will work with other test frameworks and SimpleTest can use other +framework's (PHPUnit, PEAR::PhpUnit) test cases as it's own. The +web browser part of the web tester can also be used independently either +in other testers or as part of a scripting solution. + +You can see a release schedule at http://www.lastcraft.com/overview.php +which is also copied to the documentation folder with this release. +A full PHPDocumenter API documentation exists at +http://simpletest.sourceforge.net/. + +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 are looking at a first full release. The unit tests for SimpleTest +itself can be run here... + +simpletest/test/unit_tests.php + +And tests involving live network connections as well are here... + +simpletest/test/all_tests.php + +The full tests will typically overrun the 8Mb limit usually allowed +to a PHP process. A workaround is to run the tests on the command +with a custom php.ini file if you do not have access to your server +version. + +You will have to edit the all_tests.php file if you are accesssing +the internet through a proxy server. See the comments in all_tests.php +for instructions. + +The full tests read some test data from the LastCraft site. 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. As far as we know we haven't yet managed to check in any +test failures so please correct us if you find one. + +Even if all of the tests run please verify that your existing test suites +also function as expected. If they don't see the file... + +HELP_MY_TESTS_DONT_WORK_ANYMORE + +This 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://www.lastcraft.com/first_test_tutorial.php +to get you started and this material will eventually become included +with the project documentation. A French translation exists at +http://www.onpk.net/index.php/2005/01/12/254-tutoriel-simpletest-decouvrir-les-tests-unitaires. + +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 version one 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 as yet 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 CVS only. +The CVS check-ins always have all the tests passing and so CVS snapshots should +be pretty usable, although the code may not look so good internally. + +Oh, yes. It 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 +Feucks. Early adopters are always an inspiration. + +yours Marcus Baker, Jason Sweat and Perrick Penet. +-- +marcus@lastcraft.com diff --git a/tests/UnitTests/simpletest/VERSION b/tests/test_tools/simpletest/VERSION index d69d4fac..d3827e75 100644..100755 --- a/tests/UnitTests/simpletest/VERSION +++ b/tests/test_tools/simpletest/VERSION @@ -1 +1 @@ -1.0
+1.0 diff --git a/tests/UnitTests/simpletest/authentication.php b/tests/test_tools/simpletest/authentication.php index 6ec7bc0c..7b6ed4ba 100644 --- a/tests/UnitTests/simpletest/authentication.php +++ b/tests/test_tools/simpletest/authentication.php @@ -1,219 +1,219 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: authentication.php,v 1.9 2004/09/19 17:24:11 lastcraft Exp $
- */
- /**
- * include http class
- */
- require_once(dirname(__FILE__) . '/http.php');
-
- /**
- * Represents a single security realm's identity.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleRealm {
- protected $_type;
- protected $_root;
- protected $_username;
- protected $_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
- */
- 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) {
- return (strpos($url->getBasePath(), $this->_root) === 0);
- }
- }
-
- /**
- * Manages security realms.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleAuthenticator {
- protected $_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 vary 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
- */
- 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"));
- }
- }
- }
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: authentication.php,v 1.9 2004/09/19 17:24:11 lastcraft Exp $ + */ + /** + * include http class + */ + require_once(dirname(__FILE__) . '/http.php'); + + /** + * Represents a single security realm's identity. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleRealm { + protected $_type; + protected $_root; + protected $_username; + protected $_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 + */ + 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) { + return (strpos($url->getBasePath(), $this->_root) === 0); + } + } + + /** + * Manages security realms. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleAuthenticator { + protected $_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 vary 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 + */ + 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")); + } + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/browser.php b/tests/test_tools/simpletest/browser.php index 0e281e5a..06e1b8d7 100644 --- a/tests/UnitTests/simpletest/browser.php +++ b/tests/test_tools/simpletest/browser.php @@ -1,1016 +1,1016 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: browser.php,v 1.141 2005/02/22 02:39:21 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/options.php');
- require_once(dirname(__FILE__) . '/http.php');
- require_once(dirname(__FILE__) . '/encoding.php');
- require_once(dirname(__FILE__) . '/page.php');
- require_once(dirname(__FILE__) . '/frames.php');
- require_once(dirname(__FILE__) . '/user_agent.php');
- /**#@-*/
-
- define('DEFAULT_MAX_NESTED_FRAMES', 3);
-
- /**
- * Browser history list.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleBrowserHistory {
- protected $_sequence;
- protected $_position;
-
- /**
- * Starts empty.
- * @access public
- */
- function SimpleBrowserHistory() {
- $this->_sequence = array();
- $this->_position = -1;
- }
-
- /**
- * Test for no entries yet.
- * @return boolean True if empty.
- * @access private
- */
- function _isEmpty() {
- return ($this->_position == -1);
- }
-
- /**
- * Test for being at the beginning.
- * @return boolean True if first.
- * @access private
- */
- function _atBeginning() {
- return ($this->_position == 0) && ! $this->_isEmpty();
- }
-
- /**
- * Test for being at the last entry.
- * @return boolean True if last.
- * @access private
- */
- function _atEnd() {
- return ($this->_position + 1 >= count($this->_sequence)) && ! $this->_isEmpty();
- }
-
- /**
- * Adds a successfully fetched page to the history.
- * @param string $method GET or POST.
- * @param SimpleUrl $url URL of fetch.
- * @param SimpleFormEncoding $parameters Any post data with the fetch.
- * @access public
- */
- function recordEntry($method, $url, $parameters) {
- $this->_dropFuture();
- array_push(
- $this->_sequence,
- array('method' => $method, 'url' => $url, 'parameters' => $parameters));
- $this->_position++;
- }
-
- /**
- * Last fetching method for current history
- * position.
- * @return string GET or POST for this point in
- * the history.
- * @access public
- */
- function getMethod() {
- if ($this->_isEmpty()) {
- return false;
- }
- return $this->_sequence[$this->_position]['method'];
- }
-
- /**
- * Last fully qualified URL for current history
- * position.
- * @return SimpleUrl URL for this position.
- * @access public
- */
- function getUrl() {
- if ($this->_isEmpty()) {
- return false;
- }
- return $this->_sequence[$this->_position]['url'];
- }
-
- /**
- * Parameters of last fetch from current history
- * position.
- * @return SimpleFormEncoding Post parameters.
- * @access public
- */
- function getParameters() {
- if ($this->_isEmpty()) {
- return false;
- }
- return $this->_sequence[$this->_position]['parameters'];
- }
-
- /**
- * Step back one place in the history. Stops at
- * the first page.
- * @return boolean True if any previous entries.
- * @access public
- */
- function back() {
- if ($this->_isEmpty() || $this->_atBeginning()) {
- return false;
- }
- $this->_position--;
- return true;
- }
-
- /**
- * Step forward one place. If already at the
- * latest entry then nothing will happen.
- * @return boolean True if any future entries.
- * @access public
- */
- function forward() {
- if ($this->_isEmpty() || $this->_atEnd()) {
- return false;
- }
- $this->_position++;
- return true;
- }
-
- /**
- * Ditches all future entries beyond the current
- * point.
- * @access private
- */
- function _dropFuture() {
- if ($this->_isEmpty()) {
- return;
- }
- while (! $this->_atEnd()) {
- array_pop($this->_sequence);
- }
- }
- }
-
- /**
- * Simulated web browser. This is an aggregate of
- * the user agent, the HTML parsing, request history
- * and the last header set.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleBrowser {
- protected $_user_agent;
- protected $_page;
- protected $_history;
- protected $_ignore_frames;
- protected $_maximum_nested_frames;
-
- /**
- * Starts with a fresh browser with no
- * cookie or any other state information. The
- * exception is that a default proxy will be
- * set up if specified in the options.
- * @access public
- */
- function SimpleBrowser() {
- $this->_user_agent = $this->_createUserAgent();
- $this->_user_agent->useProxy(
- SimpleTestOptions::getDefaultProxy(),
- SimpleTestOptions::getDefaultProxyUsername(),
- SimpleTestOptions::getDefaultProxyPassword());
- $this->_page = new SimplePage();
- $this->_history = $this->_createHistory();
- $this->_ignore_frames = false;
- $this->_maximum_nested_frames = DEFAULT_MAX_NESTED_FRAMES;
- }
-
- /**
- * Creates the underlying user agent.
- * @return SimpleFetcher Content fetcher.
- * @access protected
- */
- function _createUserAgent() {
- return new SimpleUserAgent();
- }
-
- /**
- * Creates a new empty history list.
- * @return SimpleBrowserHistory New list.
- * @access protected
- */
- function _createHistory() {
- return new SimpleBrowserHistory();
- }
-
- /**
- * Disables frames support. Frames will not be fetched
- * and the frameset page will be used instead.
- * @access public
- */
- function ignoreFrames() {
- $this->_ignore_frames = true;
- }
-
- /**
- * Enables frames support. Frames will be fetched from
- * now on.
- * @access public
- */
- function useFrames() {
- $this->_ignore_frames = false;
- }
-
- /**
- * Parses the raw content into a page. Will load further
- * frame pages unless frames are disabled.
- * @param SimpleHttpResponse $response Response from fetch.
- * @param integer $depth Nested frameset depth.
- * @return SimplePage Parsed HTML.
- * @access protected
- */
- function _parse($response, $depth = 0) {
- $builder = new SimplePageBuilder();
- $page = $builder->parse($response);
- if ($this->_ignore_frames || ! $page->hasFrames() || ($depth > $this->_maximum_nested_frames)) {
- return $page;
- }
- $frameset = new SimpleFrameset($page);
- foreach ($page->getFrameset() as $key => $url) {
- $frame = $this->_fetch('GET', $url, array(), $depth + 1);
- $frameset->addFrame($frame, $key);
- }
- return $frameset;
- }
-
- /**
- * Fetches a page.
- * @param string $method GET or POST.
- * @param string/SimpleUrl $url Target to fetch as string.
- * @param SimpleFormEncoding $parameters POST parameters.
- * @param integer $depth Nested frameset depth protection.
- * @return SimplePage Parsed page.
- * @access private
- */
- function _fetch($method, $url, $parameters, $depth = 0) {
- $response = $this->_user_agent->fetchResponse($method, $url, $parameters);
- if ($response->isError()) {
- return new SimplePage($response);
- }
- return $this->_parse($response, $depth);
- }
-
- /**
- * Fetches a page or a single frame if that is the current
- * focus.
- * @param string $method GET or POST.
- * @param string/SimpleUrl $url Target to fetch as string.
- * @param SimpleFormEncoding $parameters POST parameters.
- * @return string Raw content of page.
- * @access private
- */
- function _load($method, $url, $parameters = false) {
- $frame = $url->getTarget();
- if (! $frame || ! $this->_page->hasFrames() || (strtolower($frame) == '_top')) {
- return $this->_loadPage($method, $url, $parameters);
- }
- return $this->_loadFrame(array($frame), $method, $url, $parameters);
- }
-
- /**
- * Fetches a page and makes it the current page/frame.
- * @param string $method GET or POST.
- * @param string/SimpleUrl $url Target to fetch as string.
- * @param SimpleFormEncoding $parameters POST parameters.
- * @return string Raw content of page.
- * @access private
- */
- function _loadPage($method, $url, $parameters = false) {
- $this->_page = $this->_fetch(strtoupper($method), $url, $parameters);
- $this->_history->recordEntry(
- $this->_page->getMethod(),
- $this->_page->getUrl(),
- $this->_page->getRequestData());
- return $this->_page->getRaw();
- }
-
- /**
- * Fetches a frame into the existing frameset replacing the
- * original.
- * @param array $frames List of names to drill down.
- * @param string $method GET or POST.
- * @param string/SimpleUrl $url Target to fetch as string.
- * @param SimpleFormEncoding $parameters POST parameters.
- * @return string Raw content of page.
- * @access private
- */
- function _loadFrame($frames, $method, $url, $parameters = false) {
- $page = $this->_fetch(strtoupper($method), $url, $parameters);
- $this->_page->setFrame($frames, $page);
- }
-
- /**
- * Removes expired and temporary cookies as if
- * the browser was closed and re-opened.
- * @param string/integer $date Time when session restarted.
- * If omitted then all persistent
- * cookies are kept.
- * @access public
- */
- function restart($date = false) {
- $this->_user_agent->restart($date);
- }
-
- /**
- * Adds a header to every fetch.
- * @param string $header Header line to add to every
- * request until cleared.
- * @access public
- */
- function addHeader($header) {
- $this->_user_agent->addHeader($header);
- }
-
- /**
- * Ages the cookies by the specified time.
- * @param integer $interval Amount in seconds.
- * @access public
- */
- function ageCookies($interval) {
- $this->_user_agent->ageCookies($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) {
- $this->_user_agent->setCookie($name, $value, $host, $path, $expiry);
- }
-
- /**
- * Reads the most specific cookie value from the
- * browser cookies.
- * @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) {
- return $this->_user_agent->getCookieValue($host, $path, $name);
- }
-
- /**
- * Reads the current cookies for the current URL.
- * @param string $name Key of cookie to find.
- * @return string Null if there is no current URL, false
- * if the cookie is not set.
- * @access public
- */
- function getCurrentCookieValue($name) {
- return $this->_user_agent->getBaseCookieValue($name, $this->_page->getUrl());
- }
-
- /**
- * Sets the maximum number of redirects before
- * a page will be loaded anyway.
- * @param integer $max Most hops allowed.
- * @access public
- */
- function setMaximumRedirects($max) {
- $this->_user_agent->setMaximumRedirects($max);
- }
-
- /**
- * Sets the maximum number of nesting of framed pages
- * within a framed page to prevent loops.
- * @param integer $max Highest depth allowed.
- * @access public
- */
- function setMaximumNestedFrames($max) {
- $this->_maximum_nested_frames = $max;
- }
-
- /**
- * Sets the socket timeout for opening a connection.
- * @param integer $timeout Maximum time in seconds.
- * @access public
- */
- function setConnectionTimeout($timeout) {
- $this->_user_agent->setConnectionTimeout($timeout);
- }
-
- /**
- * Sets proxy to use on all requests for when
- * testing from behind a firewall. Set URL
- * to false to disable.
- * @param string $proxy Proxy URL.
- * @param string $username Proxy username for authentication.
- * @param string $password Proxy password for authentication.
- * @access public
- */
- function useProxy($proxy, $username = false, $password = false) {
- $this->_user_agent->useProxy($proxy, $username, $password);
- }
-
- /**
- * Fetches the page content with a HEAD request.
- * Will affect cookies, but will not change the base URL.
- * @param string/SimpleUrl $url Target to fetch as string.
- * @param hash/SimpleFormEncoding $parameters Additional parameters for
- * HEAD request.
- * @return boolean True if successful.
- * @access public
- */
- function head($url, $parameters = false) {
- if (! is_object($url)) {
- $url = new SimpleUrl($url);
- }
- if (is_array($parameters)) {
- $parameters = new SimpleFormEncoding($parameters);
- }
- if ($this->getUrl()) {
- $url = $url->makeAbsolute($this->getUrl());
- }
- $response = $this->_user_agent->fetchResponse(
- 'HEAD',
- $url,
- $parameters);
- return ! $response->isError();
- }
-
- /**
- * Fetches the page content with a simple GET request.
- * @param string/SimpleUrl $url Target to fetch.
- * @param hash/SimpleFormEncoding $parameters Additional parameters for
- * GET request.
- * @return string Content of page or false.
- * @access public
- */
- function get($url, $parameters = false) {
- if (! is_object($url)) {
- $url = new SimpleUrl($url);
- }
- if (is_array($parameters)) {
- $parameters = new SimpleFormEncoding($parameters);
- }
- if ($this->getUrl()) {
- $url = $url->makeAbsolute($this->getUrl());
- }
- return $this->_load('GET', $url, $parameters);
- }
-
- /**
- * Fetches the page content with a POST request.
- * @param string/SimpleUrl $url Target to fetch as string.
- * @param hash/SimpleFormEncoding $parameters POST parameters.
- * @return string Content of page.
- * @access public
- */
- function post($url, $parameters = false) {
- if (! is_object($url)) {
- $url = new SimpleUrl($url);
- }
- if (is_array($parameters)) {
- $parameters = new SimpleFormEncoding($parameters);
- }
- if ($this->getUrl()) {
- $url = $url->makeAbsolute($this->getUrl());
- }
- return $this->_load('POST', $url, $parameters);
- }
-
- /**
- * Equivalent to hitting the retry button on the
- * browser. Will attempt to repeat the page fetch. If
- * there is no history to repeat it will give false.
- * @return string/boolean Content if fetch succeeded
- * else false.
- * @access public
- */
- function retry() {
- $frames = $this->_page->getFrameFocus();
- if (count($frames) > 0) {
- $this->_loadFrame(
- $frames,
- $this->_page->getMethod(),
- $this->_page->getUrl(),
- $this->_page->getRequestData());
- return $this->_page->getRaw();
- }
- if ($method = $this->_history->getMethod()) {
- $this->_page = $this->_fetch(
- $method,
- $this->_history->getUrl(),
- $this->_history->getParameters());
- return $this->_page->getRaw();
- }
- return false;
- }
-
- /**
- * Equivalent to hitting the back button on the
- * browser. The browser history is unchanged on
- * failure.
- * @return boolean True if history entry and
- * fetch succeeded
- * @access public
- */
- function back() {
- if (! $this->_history->back()) {
- return false;
- }
- $content = $this->retry();
- if (! $content) {
- $this->_history->forward();
- }
- return $content;
- }
-
- /**
- * Equivalent to hitting the forward button on the
- * browser. The browser history is unchanged on
- * failure.
- * @return boolean True if history entry and
- * fetch succeeded
- * @access public
- */
- function forward() {
- if (! $this->_history->forward()) {
- return false;
- }
- $content = $this->retry();
- if (! $content) {
- $this->_history->back();
- }
- return $content;
- }
-
- /**
- * Retries a request after setting the authentication
- * for the current realm.
- * @param string $username Username for realm.
- * @param string $password Password for realm.
- * @return boolean True if successful fetch. Note
- * that authentication may still have
- * failed.
- * @access public
- */
- function authenticate($username, $password) {
- if (! $this->_page->getRealm()) {
- return false;
- }
- $url = $this->_page->getUrl();
- if (! $url) {
- return false;
- }
- $this->_user_agent->setIdentity(
- $url->getHost(),
- $this->_page->getRealm(),
- $username,
- $password);
- return $this->retry();
- }
-
- /**
- * Accessor for a breakdown of the frameset.
- * @return array Hash tree of frames by name
- * or index if no name.
- * @access public
- */
- function getFrames() {
- return $this->_page->getFrames();
- }
-
- /**
- * Accessor for current frame focus. Will be
- * false if no frame has focus.
- * @return integer/string/boolean Label if any, otherwise
- * the position in the frameset
- * or false if none.
- * @access public
- */
- function getFrameFocus() {
- return $this->_page->getFrameFocus();
- }
-
- /**
- * Sets the focus by index. The integer index starts from 1.
- * @param integer $choice Chosen frame.
- * @return boolean True if frame exists.
- * @access public
- */
- function setFrameFocusByIndex($choice) {
- return $this->_page->setFrameFocusByIndex($choice);
- }
-
- /**
- * Sets the focus by name.
- * @param string $name Chosen frame.
- * @return boolean True if frame exists.
- * @access public
- */
- function setFrameFocus($name) {
- return $this->_page->setFrameFocus($name);
- }
-
- /**
- * Clears the frame focus. All frames will be searched
- * for content.
- * @access public
- */
- function clearFrameFocus() {
- return $this->_page->clearFrameFocus();
- }
-
- /**
- * Accessor for last error.
- * @return string Error from last response.
- * @access public
- */
- function getTransportError() {
- return $this->_page->getTransportError();
- }
-
- /**
- * Accessor for current MIME type.
- * @return string MIME type as string; e.g. 'text/html'
- * @access public
- */
- function getMimeType() {
- return $this->_page->getMimeType();
- }
-
- /**
- * Accessor for last response code.
- * @return integer Last HTTP response code received.
- * @access public
- */
- function getResponseCode() {
- return $this->_page->getResponseCode();
- }
-
- /**
- * Accessor for last Authentication type. Only valid
- * straight after a challenge (401).
- * @return string Description of challenge type.
- * @access public
- */
- function getAuthentication() {
- return $this->_page->getAuthentication();
- }
-
- /**
- * Accessor for last Authentication realm. Only valid
- * straight after a challenge (401).
- * @return string Name of security realm.
- * @access public
- */
- function getRealm() {
- return $this->_page->getRealm();
- }
-
- /**
- * Accessor for current URL of page or frame if
- * focused.
- * @return string Location of current page or frame as
- * a string.
- */
- function getUrl() {
- $url = $this->_page->getUrl();
- return $url ? $url->asString() : false;
- }
-
- /**
- * Accessor for raw bytes sent down the wire.
- * @return string Original text sent.
- * @access public
- */
- function getRequest() {
- return $this->_page->getRequest();
- }
-
- /**
- * Accessor for raw header information.
- * @return string Header block.
- * @access public
- */
- function getHeaders() {
- return $this->_page->getHeaders();
- }
-
- /**
- * Accessor for raw page information.
- * @return string Original text content of web page.
- * @access public
- */
- function getContent() {
- return $this->_page->getRaw();
- }
-
- /**
- * Accessor for plain text version of the page.
- * @return string Normalised text representation.
- * @access public
- */
- function getContentAsText() {
- return $this->_page->getText();
- }
-
- /**
- * Accessor for parsed title.
- * @return string Title or false if no title is present.
- * @access public
- */
- function getTitle() {
- return $this->_page->getTitle();
- }
-
- /**
- * Accessor for a list of all fixed links in current page.
- * @return array List of urls with scheme of
- * http or https and hostname.
- * @access public
- */
- function getAbsoluteUrls() {
- return $this->_page->getAbsoluteUrls();
- }
-
- /**
- * Accessor for a list of all relative links.
- * @return array List of urls without hostname.
- * @access public
- */
- function getRelativeUrls() {
- return $this->_page->getRelativeUrls();
- }
-
- /**
- * Sets all form fields with that name.
- * @param string $name Name of field in forms.
- * @param string $value New value of field.
- * @return boolean True if field exists, otherwise false.
- * @access public
- */
- function setField($name, $value) {
- return $this->_page->setField($name, $value);
- }
-
- /**
- * Sets all form fields with that id attribute.
- * @param string/integer $id Id of field in forms.
- * @param string $value New value of field.
- * @return boolean True if field exists, otherwise false.
- * @access public
- */
- function setFieldById($id, $value) {
- return $this->_page->setFieldById($id, $value);
- }
-
- /**
- * Accessor for a form element value within the page.
- * Finds the first match.
- * @param string $name Field name.
- * @return string/boolean A string if the field is
- * present, false if unchecked
- * and null if missing.
- * @access public
- */
- function getField($name) {
- return $this->_page->getField($name);
- }
-
- /**
- * Accessor for a form element value within the page.
- * @param string/integer $id Id of field in forms.
- * @return string/boolean A string if the field is
- * present, false if unchecked
- * and null if missing.
- * @access public
- */
- function getFieldById($id) {
- return $this->_page->getFieldById($id);
- }
-
- /**
- * Clicks the submit button by label. The owning
- * form will be submitted by this.
- * @param string $label Button label. An unlabeled
- * button can be triggered by 'Submit'.
- * @param hash $additional Additional form data.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickSubmit($label = 'Submit', $additional = false) {
- if (! ($form = $this->_page->getFormBySubmitLabel($label))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submitButtonByLabel($label, $additional));
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Clicks the submit button by name attribute. The owning
- * form will be submitted by this.
- * @param string $name Button name.
- * @param hash $additional Additional form data.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickSubmitByName($name, $additional = false) {
- if (! ($form = $this->_page->getFormBySubmitName($name))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submitButtonByName($name, $additional));
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Clicks the submit button by ID attribute of the button
- * itself. The owning form will be submitted by this.
- * @param string $id Button ID.
- * @param hash $additional Additional form data.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickSubmitById($id, $additional = false) {
- if (! ($form = $this->_page->getFormBySubmitId($id))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submitButtonById($id, $additional));
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Clicks the submit image by some kind of label. Usually
- * the alt tag or the nearest equivalent. The owning
- * form will be submitted by this. Clicking outside of
- * the boundary of the coordinates will result in
- * a failure.
- * @param string $label ID attribute of button.
- * @param integer $x X-coordinate of imaginary click.
- * @param integer $y Y-coordinate of imaginary click.
- * @param hash $additional Additional form data.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickImage($label, $x = 1, $y = 1, $additional = false) {
- if (! ($form = $this->_page->getFormByImageLabel($label))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submitImageByLabel($label, $x, $y, $additional));
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Clicks the submit image by the name. Usually
- * the alt tag or the nearest equivalent. The owning
- * form will be submitted by this. Clicking outside of
- * the boundary of the coordinates will result in
- * a failure.
- * @param string $name Name attribute of button.
- * @param integer $x X-coordinate of imaginary click.
- * @param integer $y Y-coordinate of imaginary click.
- * @param hash $additional Additional form data.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickImageByName($name, $x = 1, $y = 1, $additional = false) {
- if (! ($form = $this->_page->getFormByImageName($name))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submitImageByName($name, $x, $y, $additional));
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Clicks the submit image by ID attribute. The owning
- * form will be submitted by this. Clicking outside of
- * the boundary of the coordinates will result in
- * a failure.
- * @param integer/string $id ID attribute of button.
- * @param integer $x X-coordinate of imaginary click.
- * @param integer $y Y-coordinate of imaginary click.
- * @param hash $additional Additional form data.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickImageById($id, $x = 1, $y = 1, $additional = false) {
- if (! ($form = $this->_page->getFormByImageId($id))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submitImageById($id, $x, $y, $additional));
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Submits a form by the ID.
- * @param string $id The form ID. No submit button value
- * will be sent.
- * @return string/boolean Page on success.
- * @access public
- */
- function submitFormById($id) {
- if (! ($form = $this->_page->getFormById($id))) {
- return false;
- }
- $success = $this->_load(
- $form->getMethod(),
- $form->getAction(),
- $form->submit());
- return ($success ? $this->getContent() : $success);
- }
-
- /**
- * Follows a link by label. Will click the first link
- * found with this link text by default, or a later
- * one if an index is given. The match ignores case and
- * white space issues.
- * @param string $label Text between the anchor tags.
- * @param integer $index Link position counting from zero.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickLink($label, $index = 0) {
- $urls = $this->_page->getUrlsByLabel($label);
- if (count($urls) == 0) {
- return false;
- }
- if (count($urls) < $index + 1) {
- return false;
- }
- $this->_load('GET', $urls[$index]);
- return $this->getContent();
- }
-
- /**
- * Tests to see if a link is present by label.
- * @param string $label Text of value attribute.
- * @return boolean True if link present.
- * @access public
- */
- function isLink($label) {
- return (count($this->_page->getUrlsByLabel($label)) > 0);
- }
-
- /**
- * Follows a link by id attribute.
- * @param string $id ID attribute value.
- * @return string/boolean Page on success.
- * @access public
- */
- function clickLinkById($id) {
- if (! ($url = $this->_page->getUrlById($id))) {
- return false;
- }
- $this->_load('GET', $url);
- return $this->getContent();
- }
-
- /**
- * Tests to see if a link is present by ID attribute.
- * @param string $id Text of id attribute.
- * @return boolean True if link present.
- * @access public
- */
- function isLinkById($id) {
- return (boolean)$this->_page->getUrlById($id);
- }
- }
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: browser.php,v 1.141 2005/02/22 02:39:21 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/options.php'); + require_once(dirname(__FILE__) . '/http.php'); + require_once(dirname(__FILE__) . '/encoding.php'); + require_once(dirname(__FILE__) . '/page.php'); + require_once(dirname(__FILE__) . '/frames.php'); + require_once(dirname(__FILE__) . '/user_agent.php'); + /**#@-*/ + + define('DEFAULT_MAX_NESTED_FRAMES', 3); + + /** + * Browser history list. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleBrowserHistory { + protected $_sequence; + protected $_position; + + /** + * Starts empty. + * @access public + */ + function SimpleBrowserHistory() { + $this->_sequence = array(); + $this->_position = -1; + } + + /** + * Test for no entries yet. + * @return boolean True if empty. + * @access private + */ + function _isEmpty() { + return ($this->_position == -1); + } + + /** + * Test for being at the beginning. + * @return boolean True if first. + * @access private + */ + function _atBeginning() { + return ($this->_position == 0) && ! $this->_isEmpty(); + } + + /** + * Test for being at the last entry. + * @return boolean True if last. + * @access private + */ + function _atEnd() { + return ($this->_position + 1 >= count($this->_sequence)) && ! $this->_isEmpty(); + } + + /** + * Adds a successfully fetched page to the history. + * @param string $method GET or POST. + * @param SimpleUrl $url URL of fetch. + * @param SimpleFormEncoding $parameters Any post data with the fetch. + * @access public + */ + function recordEntry($method, $url, $parameters) { + $this->_dropFuture(); + array_push( + $this->_sequence, + array('method' => $method, 'url' => $url, 'parameters' => $parameters)); + $this->_position++; + } + + /** + * Last fetching method for current history + * position. + * @return string GET or POST for this point in + * the history. + * @access public + */ + function getMethod() { + if ($this->_isEmpty()) { + return false; + } + return $this->_sequence[$this->_position]['method']; + } + + /** + * Last fully qualified URL for current history + * position. + * @return SimpleUrl URL for this position. + * @access public + */ + function getUrl() { + if ($this->_isEmpty()) { + return false; + } + return $this->_sequence[$this->_position]['url']; + } + + /** + * Parameters of last fetch from current history + * position. + * @return SimpleFormEncoding Post parameters. + * @access public + */ + function getParameters() { + if ($this->_isEmpty()) { + return false; + } + return $this->_sequence[$this->_position]['parameters']; + } + + /** + * Step back one place in the history. Stops at + * the first page. + * @return boolean True if any previous entries. + * @access public + */ + function back() { + if ($this->_isEmpty() || $this->_atBeginning()) { + return false; + } + $this->_position--; + return true; + } + + /** + * Step forward one place. If already at the + * latest entry then nothing will happen. + * @return boolean True if any future entries. + * @access public + */ + function forward() { + if ($this->_isEmpty() || $this->_atEnd()) { + return false; + } + $this->_position++; + return true; + } + + /** + * Ditches all future entries beyond the current + * point. + * @access private + */ + function _dropFuture() { + if ($this->_isEmpty()) { + return; + } + while (! $this->_atEnd()) { + array_pop($this->_sequence); + } + } + } + + /** + * Simulated web browser. This is an aggregate of + * the user agent, the HTML parsing, request history + * and the last header set. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleBrowser { + protected $_user_agent; + protected $_page; + protected $_history; + protected $_ignore_frames; + protected $_maximum_nested_frames; + + /** + * Starts with a fresh browser with no + * cookie or any other state information. The + * exception is that a default proxy will be + * set up if specified in the options. + * @access public + */ + function SimpleBrowser() { + $this->_user_agent = $this->_createUserAgent(); + $this->_user_agent->useProxy( + SimpleTestOptions::getDefaultProxy(), + SimpleTestOptions::getDefaultProxyUsername(), + SimpleTestOptions::getDefaultProxyPassword()); + $this->_page = new SimplePage(); + $this->_history = $this->_createHistory(); + $this->_ignore_frames = false; + $this->_maximum_nested_frames = DEFAULT_MAX_NESTED_FRAMES; + } + + /** + * Creates the underlying user agent. + * @return SimpleFetcher Content fetcher. + * @access protected + */ + function _createUserAgent() { + return new SimpleUserAgent(); + } + + /** + * Creates a new empty history list. + * @return SimpleBrowserHistory New list. + * @access protected + */ + function _createHistory() { + return new SimpleBrowserHistory(); + } + + /** + * Disables frames support. Frames will not be fetched + * and the frameset page will be used instead. + * @access public + */ + function ignoreFrames() { + $this->_ignore_frames = true; + } + + /** + * Enables frames support. Frames will be fetched from + * now on. + * @access public + */ + function useFrames() { + $this->_ignore_frames = false; + } + + /** + * Parses the raw content into a page. Will load further + * frame pages unless frames are disabled. + * @param SimpleHttpResponse $response Response from fetch. + * @param integer $depth Nested frameset depth. + * @return SimplePage Parsed HTML. + * @access protected + */ + function _parse($response, $depth = 0) { + $builder = new SimplePageBuilder(); + $page = $builder->parse($response); + if ($this->_ignore_frames || ! $page->hasFrames() || ($depth > $this->_maximum_nested_frames)) { + return $page; + } + $frameset = new SimpleFrameset($page); + foreach ($page->getFrameset() as $key => $url) { + $frame = $this->_fetch('GET', $url, array(), $depth + 1); + $frameset->addFrame($frame, $key); + } + return $frameset; + } + + /** + * Fetches a page. + * @param string $method GET or POST. + * @param string/SimpleUrl $url Target to fetch as string. + * @param SimpleFormEncoding $parameters POST parameters. + * @param integer $depth Nested frameset depth protection. + * @return SimplePage Parsed page. + * @access private + */ + function _fetch($method, $url, $parameters, $depth = 0) { + $response = $this->_user_agent->fetchResponse($method, $url, $parameters); + if ($response->isError()) { + return new SimplePage($response); + } + return $this->_parse($response, $depth); + } + + /** + * Fetches a page or a single frame if that is the current + * focus. + * @param string $method GET or POST. + * @param string/SimpleUrl $url Target to fetch as string. + * @param SimpleFormEncoding $parameters POST parameters. + * @return string Raw content of page. + * @access private + */ + function _load($method, $url, $parameters = false) { + $frame = $url->getTarget(); + if (! $frame || ! $this->_page->hasFrames() || (strtolower($frame) == '_top')) { + return $this->_loadPage($method, $url, $parameters); + } + return $this->_loadFrame(array($frame), $method, $url, $parameters); + } + + /** + * Fetches a page and makes it the current page/frame. + * @param string $method GET or POST. + * @param string/SimpleUrl $url Target to fetch as string. + * @param SimpleFormEncoding $parameters POST parameters. + * @return string Raw content of page. + * @access private + */ + function _loadPage($method, $url, $parameters = false) { + $this->_page = $this->_fetch(strtoupper($method), $url, $parameters); + $this->_history->recordEntry( + $this->_page->getMethod(), + $this->_page->getUrl(), + $this->_page->getRequestData()); + return $this->_page->getRaw(); + } + + /** + * Fetches a frame into the existing frameset replacing the + * original. + * @param array $frames List of names to drill down. + * @param string $method GET or POST. + * @param string/SimpleUrl $url Target to fetch as string. + * @param SimpleFormEncoding $parameters POST parameters. + * @return string Raw content of page. + * @access private + */ + function _loadFrame($frames, $method, $url, $parameters = false) { + $page = $this->_fetch(strtoupper($method), $url, $parameters); + $this->_page->setFrame($frames, $page); + } + + /** + * Removes expired and temporary cookies as if + * the browser was closed and re-opened. + * @param string/integer $date Time when session restarted. + * If omitted then all persistent + * cookies are kept. + * @access public + */ + function restart($date = false) { + $this->_user_agent->restart($date); + } + + /** + * Adds a header to every fetch. + * @param string $header Header line to add to every + * request until cleared. + * @access public + */ + function addHeader($header) { + $this->_user_agent->addHeader($header); + } + + /** + * Ages the cookies by the specified time. + * @param integer $interval Amount in seconds. + * @access public + */ + function ageCookies($interval) { + $this->_user_agent->ageCookies($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) { + $this->_user_agent->setCookie($name, $value, $host, $path, $expiry); + } + + /** + * Reads the most specific cookie value from the + * browser cookies. + * @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) { + return $this->_user_agent->getCookieValue($host, $path, $name); + } + + /** + * Reads the current cookies for the current URL. + * @param string $name Key of cookie to find. + * @return string Null if there is no current URL, false + * if the cookie is not set. + * @access public + */ + function getCurrentCookieValue($name) { + return $this->_user_agent->getBaseCookieValue($name, $this->_page->getUrl()); + } + + /** + * Sets the maximum number of redirects before + * a page will be loaded anyway. + * @param integer $max Most hops allowed. + * @access public + */ + function setMaximumRedirects($max) { + $this->_user_agent->setMaximumRedirects($max); + } + + /** + * Sets the maximum number of nesting of framed pages + * within a framed page to prevent loops. + * @param integer $max Highest depth allowed. + * @access public + */ + function setMaximumNestedFrames($max) { + $this->_maximum_nested_frames = $max; + } + + /** + * Sets the socket timeout for opening a connection. + * @param integer $timeout Maximum time in seconds. + * @access public + */ + function setConnectionTimeout($timeout) { + $this->_user_agent->setConnectionTimeout($timeout); + } + + /** + * Sets proxy to use on all requests for when + * testing from behind a firewall. Set URL + * to false to disable. + * @param string $proxy Proxy URL. + * @param string $username Proxy username for authentication. + * @param string $password Proxy password for authentication. + * @access public + */ + function useProxy($proxy, $username = false, $password = false) { + $this->_user_agent->useProxy($proxy, $username, $password); + } + + /** + * Fetches the page content with a HEAD request. + * Will affect cookies, but will not change the base URL. + * @param string/SimpleUrl $url Target to fetch as string. + * @param hash/SimpleFormEncoding $parameters Additional parameters for + * HEAD request. + * @return boolean True if successful. + * @access public + */ + function head($url, $parameters = false) { + if (! is_object($url)) { + $url = new SimpleUrl($url); + } + if (is_array($parameters)) { + $parameters = new SimpleFormEncoding($parameters); + } + if ($this->getUrl()) { + $url = $url->makeAbsolute($this->getUrl()); + } + $response = $this->_user_agent->fetchResponse( + 'HEAD', + $url, + $parameters); + return ! $response->isError(); + } + + /** + * Fetches the page content with a simple GET request. + * @param string/SimpleUrl $url Target to fetch. + * @param hash/SimpleFormEncoding $parameters Additional parameters for + * GET request. + * @return string Content of page or false. + * @access public + */ + function get($url, $parameters = false) { + if (! is_object($url)) { + $url = new SimpleUrl($url); + } + if (is_array($parameters)) { + $parameters = new SimpleFormEncoding($parameters); + } + if ($this->getUrl()) { + $url = $url->makeAbsolute($this->getUrl()); + } + return $this->_load('GET', $url, $parameters); + } + + /** + * Fetches the page content with a POST request. + * @param string/SimpleUrl $url Target to fetch as string. + * @param hash/SimpleFormEncoding $parameters POST parameters. + * @return string Content of page. + * @access public + */ + function post($url, $parameters = false) { + if (! is_object($url)) { + $url = new SimpleUrl($url); + } + if (is_array($parameters)) { + $parameters = new SimpleFormEncoding($parameters); + } + if ($this->getUrl()) { + $url = $url->makeAbsolute($this->getUrl()); + } + return $this->_load('POST', $url, $parameters); + } + + /** + * Equivalent to hitting the retry button on the + * browser. Will attempt to repeat the page fetch. If + * there is no history to repeat it will give false. + * @return string/boolean Content if fetch succeeded + * else false. + * @access public + */ + function retry() { + $frames = $this->_page->getFrameFocus(); + if (count($frames) > 0) { + $this->_loadFrame( + $frames, + $this->_page->getMethod(), + $this->_page->getUrl(), + $this->_page->getRequestData()); + return $this->_page->getRaw(); + } + if ($method = $this->_history->getMethod()) { + $this->_page = $this->_fetch( + $method, + $this->_history->getUrl(), + $this->_history->getParameters()); + return $this->_page->getRaw(); + } + return false; + } + + /** + * Equivalent to hitting the back button on the + * browser. The browser history is unchanged on + * failure. + * @return boolean True if history entry and + * fetch succeeded + * @access public + */ + function back() { + if (! $this->_history->back()) { + return false; + } + $content = $this->retry(); + if (! $content) { + $this->_history->forward(); + } + return $content; + } + + /** + * Equivalent to hitting the forward button on the + * browser. The browser history is unchanged on + * failure. + * @return boolean True if history entry and + * fetch succeeded + * @access public + */ + function forward() { + if (! $this->_history->forward()) { + return false; + } + $content = $this->retry(); + if (! $content) { + $this->_history->back(); + } + return $content; + } + + /** + * Retries a request after setting the authentication + * for the current realm. + * @param string $username Username for realm. + * @param string $password Password for realm. + * @return boolean True if successful fetch. Note + * that authentication may still have + * failed. + * @access public + */ + function authenticate($username, $password) { + if (! $this->_page->getRealm()) { + return false; + } + $url = $this->_page->getUrl(); + if (! $url) { + return false; + } + $this->_user_agent->setIdentity( + $url->getHost(), + $this->_page->getRealm(), + $username, + $password); + return $this->retry(); + } + + /** + * Accessor for a breakdown of the frameset. + * @return array Hash tree of frames by name + * or index if no name. + * @access public + */ + function getFrames() { + return $this->_page->getFrames(); + } + + /** + * Accessor for current frame focus. Will be + * false if no frame has focus. + * @return integer/string/boolean Label if any, otherwise + * the position in the frameset + * or false if none. + * @access public + */ + function getFrameFocus() { + return $this->_page->getFrameFocus(); + } + + /** + * Sets the focus by index. The integer index starts from 1. + * @param integer $choice Chosen frame. + * @return boolean True if frame exists. + * @access public + */ + function setFrameFocusByIndex($choice) { + return $this->_page->setFrameFocusByIndex($choice); + } + + /** + * Sets the focus by name. + * @param string $name Chosen frame. + * @return boolean True if frame exists. + * @access public + */ + function setFrameFocus($name) { + return $this->_page->setFrameFocus($name); + } + + /** + * Clears the frame focus. All frames will be searched + * for content. + * @access public + */ + function clearFrameFocus() { + return $this->_page->clearFrameFocus(); + } + + /** + * Accessor for last error. + * @return string Error from last response. + * @access public + */ + function getTransportError() { + return $this->_page->getTransportError(); + } + + /** + * Accessor for current MIME type. + * @return string MIME type as string; e.g. 'text/html' + * @access public + */ + function getMimeType() { + return $this->_page->getMimeType(); + } + + /** + * Accessor for last response code. + * @return integer Last HTTP response code received. + * @access public + */ + function getResponseCode() { + return $this->_page->getResponseCode(); + } + + /** + * Accessor for last Authentication type. Only valid + * straight after a challenge (401). + * @return string Description of challenge type. + * @access public + */ + function getAuthentication() { + return $this->_page->getAuthentication(); + } + + /** + * Accessor for last Authentication realm. Only valid + * straight after a challenge (401). + * @return string Name of security realm. + * @access public + */ + function getRealm() { + return $this->_page->getRealm(); + } + + /** + * Accessor for current URL of page or frame if + * focused. + * @return string Location of current page or frame as + * a string. + */ + function getUrl() { + $url = $this->_page->getUrl(); + return $url ? $url->asString() : false; + } + + /** + * Accessor for raw bytes sent down the wire. + * @return string Original text sent. + * @access public + */ + function getRequest() { + return $this->_page->getRequest(); + } + + /** + * Accessor for raw header information. + * @return string Header block. + * @access public + */ + function getHeaders() { + return $this->_page->getHeaders(); + } + + /** + * Accessor for raw page information. + * @return string Original text content of web page. + * @access public + */ + function getContent() { + return $this->_page->getRaw(); + } + + /** + * Accessor for plain text version of the page. + * @return string Normalised text representation. + * @access public + */ + function getContentAsText() { + return $this->_page->getText(); + } + + /** + * Accessor for parsed title. + * @return string Title or false if no title is present. + * @access public + */ + function getTitle() { + return $this->_page->getTitle(); + } + + /** + * Accessor for a list of all fixed links in current page. + * @return array List of urls with scheme of + * http or https and hostname. + * @access public + */ + function getAbsoluteUrls() { + return $this->_page->getAbsoluteUrls(); + } + + /** + * Accessor for a list of all relative links. + * @return array List of urls without hostname. + * @access public + */ + function getRelativeUrls() { + return $this->_page->getRelativeUrls(); + } + + /** + * Sets all form fields with that name. + * @param string $name Name of field in forms. + * @param string $value New value of field. + * @return boolean True if field exists, otherwise false. + * @access public + */ + function setField($name, $value) { + return $this->_page->setField($name, $value); + } + + /** + * Sets all form fields with that id attribute. + * @param string/integer $id Id of field in forms. + * @param string $value New value of field. + * @return boolean True if field exists, otherwise false. + * @access public + */ + function setFieldById($id, $value) { + return $this->_page->setFieldById($id, $value); + } + + /** + * Accessor for a form element value within the page. + * Finds the first match. + * @param string $name Field name. + * @return string/boolean A string if the field is + * present, false if unchecked + * and null if missing. + * @access public + */ + function getField($name) { + return $this->_page->getField($name); + } + + /** + * Accessor for a form element value within the page. + * @param string/integer $id Id of field in forms. + * @return string/boolean A string if the field is + * present, false if unchecked + * and null if missing. + * @access public + */ + function getFieldById($id) { + return $this->_page->getFieldById($id); + } + + /** + * Clicks the submit button by label. The owning + * form will be submitted by this. + * @param string $label Button label. An unlabeled + * button can be triggered by 'Submit'. + * @param hash $additional Additional form data. + * @return string/boolean Page on success. + * @access public + */ + function clickSubmit($label = 'Submit', $additional = false) { + if (! ($form = $this->_page->getFormBySubmitLabel($label))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submitButtonByLabel($label, $additional)); + return ($success ? $this->getContent() : $success); + } + + /** + * Clicks the submit button by name attribute. The owning + * form will be submitted by this. + * @param string $name Button name. + * @param hash $additional Additional form data. + * @return string/boolean Page on success. + * @access public + */ + function clickSubmitByName($name, $additional = false) { + if (! ($form = $this->_page->getFormBySubmitName($name))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submitButtonByName($name, $additional)); + return ($success ? $this->getContent() : $success); + } + + /** + * Clicks the submit button by ID attribute of the button + * itself. The owning form will be submitted by this. + * @param string $id Button ID. + * @param hash $additional Additional form data. + * @return string/boolean Page on success. + * @access public + */ + function clickSubmitById($id, $additional = false) { + if (! ($form = $this->_page->getFormBySubmitId($id))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submitButtonById($id, $additional)); + return ($success ? $this->getContent() : $success); + } + + /** + * Clicks the submit image by some kind of label. Usually + * the alt tag or the nearest equivalent. The owning + * form will be submitted by this. Clicking outside of + * the boundary of the coordinates will result in + * a failure. + * @param string $label ID attribute of button. + * @param integer $x X-coordinate of imaginary click. + * @param integer $y Y-coordinate of imaginary click. + * @param hash $additional Additional form data. + * @return string/boolean Page on success. + * @access public + */ + function clickImage($label, $x = 1, $y = 1, $additional = false) { + if (! ($form = $this->_page->getFormByImageLabel($label))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submitImageByLabel($label, $x, $y, $additional)); + return ($success ? $this->getContent() : $success); + } + + /** + * Clicks the submit image by the name. Usually + * the alt tag or the nearest equivalent. The owning + * form will be submitted by this. Clicking outside of + * the boundary of the coordinates will result in + * a failure. + * @param string $name Name attribute of button. + * @param integer $x X-coordinate of imaginary click. + * @param integer $y Y-coordinate of imaginary click. + * @param hash $additional Additional form data. + * @return string/boolean Page on success. + * @access public + */ + function clickImageByName($name, $x = 1, $y = 1, $additional = false) { + if (! ($form = $this->_page->getFormByImageName($name))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submitImageByName($name, $x, $y, $additional)); + return ($success ? $this->getContent() : $success); + } + + /** + * Clicks the submit image by ID attribute. The owning + * form will be submitted by this. Clicking outside of + * the boundary of the coordinates will result in + * a failure. + * @param integer/string $id ID attribute of button. + * @param integer $x X-coordinate of imaginary click. + * @param integer $y Y-coordinate of imaginary click. + * @param hash $additional Additional form data. + * @return string/boolean Page on success. + * @access public + */ + function clickImageById($id, $x = 1, $y = 1, $additional = false) { + if (! ($form = $this->_page->getFormByImageId($id))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submitImageById($id, $x, $y, $additional)); + return ($success ? $this->getContent() : $success); + } + + /** + * Submits a form by the ID. + * @param string $id The form ID. No submit button value + * will be sent. + * @return string/boolean Page on success. + * @access public + */ + function submitFormById($id) { + if (! ($form = $this->_page->getFormById($id))) { + return false; + } + $success = $this->_load( + $form->getMethod(), + $form->getAction(), + $form->submit()); + return ($success ? $this->getContent() : $success); + } + + /** + * Follows a link by label. Will click the first link + * found with this link text by default, or a later + * one if an index is given. The match ignores case and + * white space issues. + * @param string $label Text between the anchor tags. + * @param integer $index Link position counting from zero. + * @return string/boolean Page on success. + * @access public + */ + function clickLink($label, $index = 0) { + $urls = $this->_page->getUrlsByLabel($label); + if (count($urls) == 0) { + return false; + } + if (count($urls) < $index + 1) { + return false; + } + $this->_load('GET', $urls[$index]); + return $this->getContent(); + } + + /** + * Tests to see if a link is present by label. + * @param string $label Text of value attribute. + * @return boolean True if link present. + * @access public + */ + function isLink($label) { + return (count($this->_page->getUrlsByLabel($label)) > 0); + } + + /** + * Follows a link by id attribute. + * @param string $id ID attribute value. + * @return string/boolean Page on success. + * @access public + */ + function clickLinkById($id) { + if (! ($url = $this->_page->getUrlById($id))) { + return false; + } + $this->_load('GET', $url); + return $this->getContent(); + } + + /** + * Tests to see if a link is present by ID attribute. + * @param string $id Text of id attribute. + * @return boolean True if link present. + * @access public + */ + function isLinkById($id) { + return (boolean)$this->_page->getUrlById($id); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/docs/en/authentication_documentation.html b/tests/test_tools/simpletest/docs/en/authentication_documentation.html index a83f448b..0623023c 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/authentication_documentation.html +++ b/tests/test_tools/simpletest/docs/en/authentication_documentation.html @@ -1,320 +1,320 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<span class="chosen">Authentication</span>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Authentication documentation</h1>
-<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>
-
- <p>
-<a class="target" name="basic">
-<h2>Basic HTTP authentication</h2>
-</a>
-</p>
- <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->get('http://www.lastcraft.com/protected/');
- $this->showHeaders();
- }</strong>
-}
-</pre>
- This allows us to see the challenge header...
- <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>
- 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->get('http://www.lastcraft.com/protected/');<strong>
- $this->assertAuthentication('Basic');
- $this->assertResponse(401);
- $this->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>
- 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 testAuthentication() {
- $this->get('http://www.lastcraft.com/protected/');<strong>
- $this->authenticate('Me', 'Secret');</strong>
- $this->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>
- You can shortcut this step further by encoding the log in
- details straight into the URL...
-<pre>
-class AuthenticationTest extends WebTestCase {
- function testCanReadAuthenticatedPages() {
- $this->get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/');
- $this->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.
- Also this header will not be sent on subsequent requests if
- you request a page with a fully qualified URL.
- If you navigate with relative URLs though, the authentication
- information will be preserved.
- </p>
- <p>
- Only basic authentication is currently supported and this is
- only really secure in tandem with HTTPS connections.
- This is usually enough to protect test server from prying eyes,
- however.
- Digest authentication and NTLM authentication may be added
- in the future.
- </p>
-
- <p>
-<a class="target" name="cookies">
-<h2>Cookies</h2>
-</a>
-</p>
- <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 and complicated timeouts.
- </p>
- <p>
- Starting with a simple log-in form...
-<pre>
-<form>
- Username:
- <input type="text" name="u" value="" /><br />
- Password:
- <input type="password" name="p" value="" /><br />
- <input type="submit" value="Log in" />
-</form>
-</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->get('http://www.my-site.com/login.php');<strong>
- $this->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.
- </p>
- <p>
- The rest of the test would be the same as any other form,
- 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->get('http://www.my-site.com/login.php');<strong>
- $session = $this->getCookie('SID');
- $this->setField('u', 'Me');
- $this->setField('p', 'Secret');
- $this->clickSubmit('Log in');
- $this->assertWantedPattern('/Welcome Me/');
- $this->assertCookie('SID', $session);</strong>
- }
-}
-</pre>
- This confirms that the session identifier is maintained
- afer log-in.
- </p>
- <p>
- We could even attempt to spoof our own system by setting
- arbitrary cookies to gain access...
-<pre>
-class LogInTest extends WebTestCase {
- ...
- function testSessionCookieSameAfterLogIn() {
- $this->get('http://www.my-site.com/login.php');<strong>
- $this->setCookie('SID', 'Some other session');
- $this->get('http://www.my-site.com/restricted.php');</strong>
- $this->assertWantedPattern('/Access denied/');
- }
-}
-</pre>
- Is your site protected from this attack?
- </p>
-
- <p>
-<a class="target" name="session">
-<h2>Browser sessions</h2>
-</a>
-</p>
- <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->get('http://www.my-site.com/login.php');
- $this->setField('u', 'Me');
- $this->setField('p', 'Secret');
- $this->clickSubmit('Log in');
- $this->assertWantedPattern('/Welcome Me/');<strong>
-
- $this->restart();
- $this->get('http://www.my-site.com/restricted.php');
- $this->assertWantedPattern('/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 the
- cookie passes 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->get('http://www.my-site.com/login.php');
- $this->setField('u', 'Me');
- $this->setField('p', 'Secret');
- $this->clickSubmit('Log in');
- $this->assertWantedPattern('/Welcome Me/');
- <strong>
- $this->ageCookies(3600);</strong>
- $this->restart();
- $this->get('http://www.my-site.com/restricted.php');
- $this->assertWantedPattern('/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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<span class="chosen">Authentication</span> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Authentication documentation</h1> +<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> + + <p> +<a class="target" name="basic"> +<h2>Basic HTTP authentication</h2> +</a> +</p> + <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->get('http://www.lastcraft.com/protected/'); + $this->showHeaders(); + }</strong> +} +</pre> + This allows us to see the challenge header... + <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> + 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->get('http://www.lastcraft.com/protected/');<strong> + $this->assertAuthentication('Basic'); + $this->assertResponse(401); + $this->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> + 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 testAuthentication() { + $this->get('http://www.lastcraft.com/protected/');<strong> + $this->authenticate('Me', 'Secret');</strong> + $this->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> + You can shortcut this step further by encoding the log in + details straight into the URL... +<pre> +class AuthenticationTest extends WebTestCase { + function testCanReadAuthenticatedPages() { + $this->get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/'); + $this->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. + Also this header will not be sent on subsequent requests if + you request a page with a fully qualified URL. + If you navigate with relative URLs though, the authentication + information will be preserved. + </p> + <p> + Only basic authentication is currently supported and this is + only really secure in tandem with HTTPS connections. + This is usually enough to protect test server from prying eyes, + however. + Digest authentication and NTLM authentication may be added + in the future. + </p> + + <p> +<a class="target" name="cookies"> +<h2>Cookies</h2> +</a> +</p> + <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 and complicated timeouts. + </p> + <p> + Starting with a simple log-in form... +<pre> +<form> + Username: + <input type="text" name="u" value="" /><br /> + Password: + <input type="password" name="p" value="" /><br /> + <input type="submit" value="Log in" /> +</form> +</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->get('http://www.my-site.com/login.php');<strong> + $this->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. + </p> + <p> + The rest of the test would be the same as any other form, + 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->get('http://www.my-site.com/login.php');<strong> + $session = $this->getCookie('SID'); + $this->setField('u', 'Me'); + $this->setField('p', 'Secret'); + $this->clickSubmit('Log in'); + $this->assertWantedPattern('/Welcome Me/'); + $this->assertCookie('SID', $session);</strong> + } +} +</pre> + This confirms that the session identifier is maintained + afer log-in. + </p> + <p> + We could even attempt to spoof our own system by setting + arbitrary cookies to gain access... +<pre> +class LogInTest extends WebTestCase { + ... + function testSessionCookieSameAfterLogIn() { + $this->get('http://www.my-site.com/login.php');<strong> + $this->setCookie('SID', 'Some other session'); + $this->get('http://www.my-site.com/restricted.php');</strong> + $this->assertWantedPattern('/Access denied/'); + } +} +</pre> + Is your site protected from this attack? + </p> + + <p> +<a class="target" name="session"> +<h2>Browser sessions</h2> +</a> +</p> + <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->get('http://www.my-site.com/login.php'); + $this->setField('u', 'Me'); + $this->setField('p', 'Secret'); + $this->clickSubmit('Log in'); + $this->assertWantedPattern('/Welcome Me/');<strong> + + $this->restart(); + $this->get('http://www.my-site.com/restricted.php'); + $this->assertWantedPattern('/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 the + cookie passes 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->get('http://www.my-site.com/login.php'); + $this->setField('u', 'Me'); + $this->setField('p', 'Secret'); + $this->clickSubmit('Log in'); + $this->assertWantedPattern('/Welcome Me/'); + <strong> + $this->ageCookies(3600);</strong> + $this->restart(); + $this->get('http://www.my-site.com/restricted.php'); + $this->assertWantedPattern('/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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/browser_documentation.html b/tests/test_tools/simpletest/docs/en/browser_documentation.html index 18c4d353..ef54aaea 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/browser_documentation.html +++ b/tests/test_tools/simpletest/docs/en/browser_documentation.html @@ -1,386 +1,386 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<span class="chosen">Scriptable browser</span>
-</li>
-</ul>
-</div>
-</div>
-<h1>PHP Scriptable Web Browser</h1>
-<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>
-
- <p>
-<a class="target" name="scripting">
-<h2>The Scriptable Browser</h2>
-</a>
-</p>
- <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><?php
- require_once('simpletest/browser.php');
-
- $browser = &new SimpleBrowser();
- $browser->get('http://php.net/');
- $browser->clickLink('reporting bugs');
- $browser->clickLink('statistics');
- $page = $browser->clickLink('PHP 5 bugs only');
- preg_match('/status=Open.*?by=Any.*?(\d+)<\/a>/', $page, $matches);
- print $matches[1];
-?></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.
- Such methods 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">clickLink($label)</span></td><td>Follows a link by label</td>
-</tr>
- <tr>
-<td><span class="new_code">isLink($label)</span></td><td>See if a link is present 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">isLinkById($id)</span></td><td>See if a link is present by attribut</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($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($name)</span></td><td>Accessor for a form element value</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 the image by alt text</td>
-</tr>
- <tr>
-<td><span class="new_code">clickImageByName($name, $x, $y)</span></td><td>Clicks the image by attribute</td>
-</tr>
- <tr>
-<td><span class="new_code">clickImageById($id, $x, $y)</span></td><td>Clicks the image by 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 any methods to list available forms
- and fields.
- This will probably be added to later versions of SimpleTest.
- </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>
-
- <p>
-<a class="target" name="debug">
-<h2>What went wrong?</h2>
-</a>
-</p>
- <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">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">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>
- </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> and
- <span class="new_code">SimpleBrowser::useFrames()</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>
-
- <p>
-<a class="target" name="unit">
-<h2>Complex unit tests with multiple browsers</h2>
-</a>
-</p>
- <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 can freely mix domain object testing with the
- web interface...
-<pre>
-<strong>
-class TestOfRegistration extends UnitTestCase {
- function testNewUserAddedToAuthenticator() {</strong>
- $browser = &new SimpleBrowser();
- $browser->get('http://my-site.com/register.php');
- $browser->setField('email', 'me@here');
- $browser->setField('password', 'Secret');
- $browser->clickSubmit('Register');
- <strong>
- $authenticator = &new Authenticator();
- $member = &$authenticator->findByEmail('me@here');
- $this->assertEqual($member->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 = &new SimpleBrowser();
- $first->get('http://my-site.com/login.php');
- $first->setField('name', 'Me');
- $first->setField('password', 'Secret');
- $first->clickSubmit('Enter');
- $this->assertEqual($first->getTitle(), 'Welcome');
-
- $second = &new SimpleBrowser();
- $second->get('http://my-site.com/login.php');
- $second->setField('name', 'Me');
- $second->setField('password', 'Secret');
- $second->clickSubmit('Enter');
- $this->assertEqual($second->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.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<span class="chosen">Scriptable browser</span> +</li> +</ul> +</div> +</div> +<h1>PHP Scriptable Web Browser</h1> +<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> + + <p> +<a class="target" name="scripting"> +<h2>The Scriptable Browser</h2> +</a> +</p> + <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><?php + require_once('simpletest/browser.php'); + + $browser = &new SimpleBrowser(); + $browser->get('http://php.net/'); + $browser->clickLink('reporting bugs'); + $browser->clickLink('statistics'); + $page = $browser->clickLink('PHP 5 bugs only'); + preg_match('/status=Open.*?by=Any.*?(\d+)<\/a>/', $page, $matches); + print $matches[1]; +?></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. + Such methods 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">clickLink($label)</span></td><td>Follows a link by label</td> +</tr> + <tr> +<td><span class="new_code">isLink($label)</span></td><td>See if a link is present 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">isLinkById($id)</span></td><td>See if a link is present by attribut</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($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($name)</span></td><td>Accessor for a form element value</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 the image by alt text</td> +</tr> + <tr> +<td><span class="new_code">clickImageByName($name, $x, $y)</span></td><td>Clicks the image by attribute</td> +</tr> + <tr> +<td><span class="new_code">clickImageById($id, $x, $y)</span></td><td>Clicks the image by 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 any methods to list available forms + and fields. + This will probably be added to later versions of SimpleTest. + </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> + + <p> +<a class="target" name="debug"> +<h2>What went wrong?</h2> +</a> +</p> + <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">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">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> + </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> and + <span class="new_code">SimpleBrowser::useFrames()</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> + + <p> +<a class="target" name="unit"> +<h2>Complex unit tests with multiple browsers</h2> +</a> +</p> + <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 can freely mix domain object testing with the + web interface... +<pre> +<strong> +class TestOfRegistration extends UnitTestCase { + function testNewUserAddedToAuthenticator() {</strong> + $browser = &new SimpleBrowser(); + $browser->get('http://my-site.com/register.php'); + $browser->setField('email', 'me@here'); + $browser->setField('password', 'Secret'); + $browser->clickSubmit('Register'); + <strong> + $authenticator = &new Authenticator(); + $member = &$authenticator->findByEmail('me@here'); + $this->assertEqual($member->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 = &new SimpleBrowser(); + $first->get('http://my-site.com/login.php'); + $first->setField('name', 'Me'); + $first->setField('password', 'Secret'); + $first->clickSubmit('Enter'); + $this->assertEqual($first->getTitle(), 'Welcome'); + + $second = &new SimpleBrowser(); + $second->get('http://my-site.com/login.php'); + $second->setField('name', 'Me'); + $second->setField('password', 'Secret'); + $second->clickSubmit('Enter'); + $this->assertEqual($second->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. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/docs.css b/tests/test_tools/simpletest/docs/en/docs.css index c59b9cd2..93226cd7 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/docs.css +++ b/tests/test_tools/simpletest/docs/en/docs.css @@ -1,84 +1,84 @@ -body {
- padding-left: 3%;
- padding-right: 3%;
-}
-pre {
- font-family: 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%;
-}
+body { + padding-left: 3%; + padding-right: 3%; +} +pre { + font-family: 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%; +} diff --git a/tests/UnitTests/simpletest/docs/en/expectation_documentation.html b/tests/test_tools/simpletest/docs/en/expectation_documentation.html index ed1484a9..0165988c 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/expectation_documentation.html +++ b/tests/test_tools/simpletest/docs/en/expectation_documentation.html @@ -1,356 +1,356 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<span class="chosen">Expectations</span>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Expectation documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="mock">
-<h2>More control over mock objects</h2>
-</a>
-</p>
- <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->isConnected()) {
- $writer->write('Cannot connect to news service "' .
- $this->_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($this);
- $writer->expectOnce('write', array(
- 'Cannot connect to news service ' .
- '"BBC News" at this time. ' .
- 'Please try again later.'));
-
- $service = &new NewsService('BBC News');
- $service->publish($writer);
-
- $writer->tally();</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($this);<strong>
- $writer->expectOnce(
- 'write',
- array(new WantedPatternExpectation('/cannot connect/i')));</strong>
-
- $service = &new NewsService('BBC News');
- $service->publish($writer);
-
- $writer->tally();
- }
-}
-</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">WantedPatternExpectation</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">WantedPatternExpectation</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">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">WantedPatternExpectation</span></td><td>Uses a Perl Regex to match a string</td>
-</tr>
- <tr>
-<td><span class="new_code">NoUnwantedPatternExpectation</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>
- </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>
-<a class="target" name="behaviour">
-<h2>Using expectations to control stubs</h2>
-</a>
-</p>
- <p>
- The expectation classes can be used not just for sending assertions
- from mock objects, but also for selecting behaviour for either
- the
- <a href="mock_objects_documentation.html">mock objects</a>
- or the
- <a href="server_stubs_documentation.html">server stubs</a>.
- Anywhere a list of arguments is given, a list of expectation objects
- can be inserted instead.
- </p>
- <p>
- Suppose we want an authorisation server stub to simulate a successful login
- only if it receives a valid session object.
- We can do this as follows...
-<pre>
-Stub::generate('Authorisation');
-<strong>
-$authorisation = new StubAuthorisation();
-$authorisation->setReturnValue(
- 'isAllowed',
- true,
- array(new IsAExpectation('Session', 'Must be a session')));
-$authorisation->setReturnValue('isAllowed', false);</strong>
-</pre>
- We have set the default stub 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>
-
- <p>
-<a class="target" name="extending">
-<h2>Creating your own expectations</h2>
-</a>
-</p>
- <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>...
-<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>
-<a class="target" name="unit">
-<h2>Under the bonnet of the unit tester</h2>
-</a>
-</p>
- <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
- <span class="new_code">SimpleTest::assertExpectation()</span> method to
- test against it directly...
-<pre>
-<strong>class TestOfNetworking extends UnitTestCase {
- ...
- function testGetValidIp() {
- $server = &new Server();
- $this->assertExpectation(
- new ValidIp(),
- $server->getIp(),
- 'Server IP address->%s');
- }
-}</strong>
-</pre>
- 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->assertExpectation(new ValidIp(), $ip, $message);
- }</strong>
-
- function testGetValidIp() {
- $server = &new Server();<strong>
- $this->assertValidIp(
- $server->getIp(),
- 'Server IP address->%s');</strong>
- }
-}
-</pre>
- It is unlikely we would ever need this degree of control
- over the testing machinery.
- It is rare to need the expectations for more than pattern
- matching.
- Also, complex expectation classes could make the tests
- harder to read and debug.
- These mechanisms are really of most use to authors of systems
- that will extend the test framework to create their own tool set.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<span class="chosen">Expectations</span> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Expectation documentation</h1> +<div class="content"> + <p> +<a class="target" name="mock"> +<h2>More control over mock objects</h2> +</a> +</p> + <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->isConnected()) { + $writer->write('Cannot connect to news service "' . + $this->_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($this); + $writer->expectOnce('write', array( + 'Cannot connect to news service ' . + '"BBC News" at this time. ' . + 'Please try again later.')); + + $service = &new NewsService('BBC News'); + $service->publish($writer); + + $writer->tally();</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($this);<strong> + $writer->expectOnce( + 'write', + array(new WantedPatternExpectation('/cannot connect/i')));</strong> + + $service = &new NewsService('BBC News'); + $service->publish($writer); + + $writer->tally(); + } +} +</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">WantedPatternExpectation</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">WantedPatternExpectation</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">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">WantedPatternExpectation</span></td><td>Uses a Perl Regex to match a string</td> +</tr> + <tr> +<td><span class="new_code">NoUnwantedPatternExpectation</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> + </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> +<a class="target" name="behaviour"> +<h2>Using expectations to control stubs</h2> +</a> +</p> + <p> + The expectation classes can be used not just for sending assertions + from mock objects, but also for selecting behaviour for either + the + <a href="mock_objects_documentation.html">mock objects</a> + or the + <a href="server_stubs_documentation.html">server stubs</a>. + Anywhere a list of arguments is given, a list of expectation objects + can be inserted instead. + </p> + <p> + Suppose we want an authorisation server stub to simulate a successful login + only if it receives a valid session object. + We can do this as follows... +<pre> +Stub::generate('Authorisation'); +<strong> +$authorisation = new StubAuthorisation(); +$authorisation->setReturnValue( + 'isAllowed', + true, + array(new IsAExpectation('Session', 'Must be a session'))); +$authorisation->setReturnValue('isAllowed', false);</strong> +</pre> + We have set the default stub 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> + + <p> +<a class="target" name="extending"> +<h2>Creating your own expectations</h2> +</a> +</p> + <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>... +<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> +<a class="target" name="unit"> +<h2>Under the bonnet of the unit tester</h2> +</a> +</p> + <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 + <span class="new_code">SimpleTest::assertExpectation()</span> method to + test against it directly... +<pre> +<strong>class TestOfNetworking extends UnitTestCase { + ... + function testGetValidIp() { + $server = &new Server(); + $this->assertExpectation( + new ValidIp(), + $server->getIp(), + 'Server IP address->%s'); + } +}</strong> +</pre> + 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->assertExpectation(new ValidIp(), $ip, $message); + }</strong> + + function testGetValidIp() { + $server = &new Server();<strong> + $this->assertValidIp( + $server->getIp(), + 'Server IP address->%s');</strong> + } +} +</pre> + It is unlikely we would ever need this degree of control + over the testing machinery. + It is rare to need the expectations for more than pattern + matching. + Also, complex expectation classes could make the tests + harder to read and debug. + These mechanisms are really of most use to authors of systems + that will extend the test framework to create their own tool set. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/form_testing_documentation.html b/tests/test_tools/simpletest/docs/en/form_testing_documentation.html index 597db3b0..b1e15b3d 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/form_testing_documentation.html +++ b/tests/test_tools/simpletest/docs/en/form_testing_documentation.html @@ -1,277 +1,277 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Simple Test 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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<span class="chosen">Testing forms</span>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Form testing documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="submit">
-<h2>Submitting a simple form</h2>
-</a>
-</p>
- <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 <form> tags
- being available from within the test case.
- For example, if we have this snippet of HTML...
-<pre>
-<form>
- <input type="text" name="a" value="A default" />
- <input type="submit" value="Go" />
-</form>
-</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->get('http://www.lastcraft.com/form_testing_documentation.php');
- $this->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"
- </p>
- <p>
- 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->get('http://www.my-site.com/');
- $this->assertField('a', 'A default');<strong>
- $this->setField('a', 'New value');
- $this->clickSubmit('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.
- SimpleTest tries to emulate typical browser behaviour as much as possible,
- rather than attempting to catch missing attributes on tags.
- 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.
- </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>
-<strong>Select type of user to add:</strong>
-<select name="type">
- <option>Subscriber</option>
- <option>Author</option>
- <option>Administrator</option>
-</select>
-</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->get('http://www.lastcraft.com/form_testing_documentation.php');
- $this->assertFalse($this->setField('type', 'Superuser'));</strong>
- }
-}
-</pre>
- The selection will not be changed on a failure to set
- a widget value.
- </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>
- Although most standard HTML widgets are catered for by <em>SimpleTest</em>'s
- built in parser, it is unlikely that JavaScript will be implemented
- anytime soon.
- </p>
-
- <p>
-<a class="target" name="multiple">
-<h2>Fields with multiple values</h2>
-</a>
-</p>
- <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>
-<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>
-</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->get('http://www.lastcraft.com/form_testing_documentation.php');
- $this->assertField('crud', array('c', 'r', 'u', 'd'));
- $this->setField('crud', array('r'));
- $this->clickSubmit('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>
- <p>
- <a class="target" name="raw">
-<h2>Raw posting</h2>
-</a>
- </p>
- <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->post(
- 'http://www.my-site.com/add_user.php',
- array('type' => 'superuser'));
- $this->assertNoUnwantedPattern('/user created/i');
- }</strong>
-}
-</pre>
- By adding data to the <span class="new_code">WebTestCase::post()</span>
- method, we are attempting to fetch the page as a form submission.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Simple Test 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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<span class="chosen">Testing forms</span> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Form testing documentation</h1> +<div class="content"> + <p> +<a class="target" name="submit"> +<h2>Submitting a simple form</h2> +</a> +</p> + <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 <form> tags + being available from within the test case. + For example, if we have this snippet of HTML... +<pre> +<form> + <input type="text" name="a" value="A default" /> + <input type="submit" value="Go" /> +</form> +</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->get('http://www.lastcraft.com/form_testing_documentation.php'); + $this->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" + </p> + <p> + 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->get('http://www.my-site.com/'); + $this->assertField('a', 'A default');<strong> + $this->setField('a', 'New value'); + $this->clickSubmit('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. + SimpleTest tries to emulate typical browser behaviour as much as possible, + rather than attempting to catch missing attributes on tags. + 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. + </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> +<strong>Select type of user to add:</strong> +<select name="type"> + <option>Subscriber</option> + <option>Author</option> + <option>Administrator</option> +</select> +</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->get('http://www.lastcraft.com/form_testing_documentation.php'); + $this->assertFalse($this->setField('type', 'Superuser'));</strong> + } +} +</pre> + The selection will not be changed on a failure to set + a widget value. + </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> + Although most standard HTML widgets are catered for by <em>SimpleTest</em>'s + built in parser, it is unlikely that JavaScript will be implemented + anytime soon. + </p> + + <p> +<a class="target" name="multiple"> +<h2>Fields with multiple values</h2> +</a> +</p> + <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> +<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> +</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->get('http://www.lastcraft.com/form_testing_documentation.php'); + $this->assertField('crud', array('c', 'r', 'u', 'd')); + $this->setField('crud', array('r')); + $this->clickSubmit('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> + <p> + <a class="target" name="raw"> +<h2>Raw posting</h2> +</a> + </p> + <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->post( + 'http://www.my-site.com/add_user.php', + array('type' => 'superuser')); + $this->assertNoUnwantedPattern('/user created/i'); + }</strong> +} +</pre> + By adding data to the <span class="new_code">WebTestCase::post()</span> + method, we are attempting to fetch the page as a form submission. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/group_test_documentation.html b/tests/test_tools/simpletest/docs/en/group_test_documentation.html index e7a067ec..adbc66ef 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/group_test_documentation.html +++ b/tests/test_tools/simpletest/docs/en/group_test_documentation.html @@ -1,357 +1,357 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>SimpleTest for PHP group test documentation</title>
-<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
-</head>
-<body>
-<div class="menu_back">
-<div class="menu">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<span class="chosen">Group tests</span>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Group Test documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="group">
-<h2>Grouping tests</h2>
-</a>
-</p>
- <p>
- To run test cases as part of a group the test cases should really
- be placed in files without the runner code...
-<pre>
-<strong><?php
- require_once('../classes/io.php');
-
- class FileTester extends UnitTestCase {
- ...
- }
-
- class SocketTester extends UnitTestCase {
- ...
- }
-?></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 none of the simple test libraries.
- </p>
- <p>
- If you have extended any test cases, you can include them
- as well.
-<pre>
-<?php
- require_once('../classes/io.php');
-<strong>
- class MyFileTestCase extends UnitTestCase {
- ...
- }
- SimpleTestOptions::ignore('MyFileTestCase');</strong>
-
- class FileTester extends MyFileTestCase {
- ...
- }
-
- class SocketTester extends UnitTestCase {
- ...
- }
-?>
-</pre>
- The <span class="new_code">FileTester</span> class does
- not contain any actual tests, but is a base class for other
- test cases.
- For this reason we use the
- <span class="new_code">SimpleTestOptions::ignore()</span> directive
- to tell the upcoming group test to ignore it.
- This directive can appear anywhere in the file and works
- when a whole file of test cases is loaded (see below).
- We will call this sample <em>file_test.php</em>.
- </p>
- <p>
- Next we create a group test file, called say <em>group_test.php</em>.
- You will think of a better name I am sure.
- We will add the test file using a safe method...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');<strong>
- require_once('file_test.php');
-
- $test = &new GroupTest('All file tests');
- $test->addTestCase(new FileTestCase());
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- This instantiates the test case before the test suite is
- run.
- This could get a little expensive with a large number of test
- cases, so another method is provided that will only
- instantiate the class when it is needed...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
- require_once('file_test.php');
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestClass('FileTestCase');</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- The problem with this method is that for every test case
- that we add we will have
- to <span class="new_code">require_once()</span> the test code
- file and manually instantiate each and every test case.
- We can save a lot of typing with...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestFile('file_test.php');</strong>
- $test->run(new HtmlReporter());
-?&gt;
-</pre>
- What happens here is that the <span class="new_code">GroupTest</span>
- class has done 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 adds
- them to the group test.
- Now all we have to do is add each new file.
- </p>
- <p>
- There are two things that could go wrong and which require care...
- <ol>
- <li>
- The file could already have been parsed by PHP and so no
- new classes will have been added. You should make
- sure that the test cases are only included in this file
- and no others.
- </li>
- <li>
- New test case extension classes that get included will be
- placed in the group test and run also.
- You will need to add a <span class="new_code">SimpleTestOptions::ignore()</span>
- directive for these classes or make sure that they are included
- before the <span class="new_code">GroupTest::addTestFile()</span>
- line.
- </li>
- </ol>
- </p>
-
- <p>
-<a class="target" name="higher">
-<h2>Higher groupings</h2>
-</a>
-</p>
- <p>
- The above method places all of the test cases into one large group.
- For larger projects though this may not be flexible enough; you
- may want to group the tests in all sorts of ways.
- </p>
- <p>
- To get a more flexible group test we can subclass
- <span class="new_code">GroupTest</span> and then instantiate it as needed...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
- <strong>
- class FileGroupTest extends GroupTest {
- function FileGroupTest() {
- $this->GroupTest('All file tests');
- $this->addTestFile('file_test.php');
- }
- }</strong>
-?>
-</pre>
- This effectively names the test in the constructor and then
- adds our test cases and a single group below.
- Of course we can add more than one group at this point.
- We can now invoke the tests from a separate runner file...
-<pre>
-<?php
- require_once('file_group_test.php');
- <strong>
- $test = &new FileGroupTest();
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- ...or we can group them into even larger group tests...
-<pre>
-<?php
- require_once('file_group_test.php');
- <strong>
- $test = &new BigGroupTest('Big group');
- $test->addTestCase(new FileGroupTest());
- $test->addTestCase(...);
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- If we still wish to run the original group test and we
- don't want all of these little runner files, we can
- put the test runner code around guard bars when we create
- each group.
-<pre>
-<?php
- class FileGroupTest extends GroupTest {
- function FileGroupTest() {
- $this->GroupTest('All file tests');
- $test->addTestFile('file_test.php');
- }
- }
- <strong>
- if (! defined('RUNNER')) {
- define('RUNNER', true);</strong>
- $test = &new FileGroupTest();
- $test->run(new HtmlReporter());
- }
-?>
-</pre>
- This approach requires the guard to be set when including
- the group test file, but this is still less hassle than
- lots of separate runner files.
- You include the same guard on the top level tests to make sure
- that <span class="new_code">run()</span> will run once only
- from the top level script that has been invoked.
-<pre>
-<?php<strong>
- define('RUNNER', true);</strong>
- require_once('file_group_test.php');
-
- $test = &new BigGroupTest('Big group');
- $test->addTestCase(new FileGroupTest());
- $test->addTestCase(...);
- $test->run(new HtmlReporter());
-?>
-</pre>
- As with the normal test cases, a <span class="new_code">GroupTest</span> can
- be loaded with the <span class="new_code">GroupTest::addTestFile()</span> method.
-<pre>
-<?php
- define('RUNNER', true);
-
- $test = &new BigGroupTest('Big group');<strong>
- $test->addTestFile('file_group_test.php');
- $test->addTestFile(...);</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- </p>
-
- <p>
-<a class="target" name="legacy">
-<h2>Integrating legacy test cases</h2>
-</a>
-</p>
- <p>
- If you already have unit tests for your code or are extending external
- classes that have tests, it is unlikely that all of the test cases
- are in SimpleTest format.
- Fortunately it is possible to incorporate test cases from other
- unit testers directly into SimpleTest group tests.
- </p>
- <p>
- Say we have the following
- <a href="http://sourceforge.net/projects/phpunit">PhpUnit</a>
- test case in the file <em>config_test.php</em>...
-<pre>
-<strong>class ConfigFileTest extends TestCase {
- function ConfigFileTest() {
- $this->TestCase('Config file test');
- }
-
- function testContents() {
- $config = new ConfigFile('test.conf');
- $this->assertRegexp('/me/', $config->getValue('username'));
- }
-}</strong>
-</pre>
- The group test can recognise this as long as we include
- the appropriate adapter class before we add the test
- file...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');<strong>
- require_once('simpletest/adapters/phpunit_test_case.php');</strong>
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestFile('config_test.php');</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- There are only two adapters, the other is for the
- <a href="http://pear.php.net/manual/en/package.php.phpunit.php">PEAR</a>
- 1.0 unit tester...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');<strong>
- require_once('simpletest/adapters/pear_test_case.php');</strong>
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestFile('some_pear_test_cases.php');</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- The PEAR test cases can be freely mixed with SimpleTest
- ones even in the same test file,
- but you cannot use SimpleTest assertions in the legacy
- test case versions.
- This is done as a check that you are not accidently making
- your test cases completely dependent on SimpleTest.
- You may want to do a PEAR release of your library for example
- which would mean shipping it with valid PEAR::PhpUnit test
- cases.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SimpleTest for PHP group test documentation</title> +<link rel="stylesheet" type="text/css" href="docs.css" title="Styles"> +</head> +<body> +<div class="menu_back"> +<div class="menu"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<span class="chosen">Group tests</span> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Group Test documentation</h1> +<div class="content"> + <p> +<a class="target" name="group"> +<h2>Grouping tests</h2> +</a> +</p> + <p> + To run test cases as part of a group the test cases should really + be placed in files without the runner code... +<pre> +<strong><?php + require_once('../classes/io.php'); + + class FileTester extends UnitTestCase { + ... + } + + class SocketTester extends UnitTestCase { + ... + } +?></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 none of the simple test libraries. + </p> + <p> + If you have extended any test cases, you can include them + as well. +<pre> +<?php + require_once('../classes/io.php'); +<strong> + class MyFileTestCase extends UnitTestCase { + ... + } + SimpleTestOptions::ignore('MyFileTestCase');</strong> + + class FileTester extends MyFileTestCase { + ... + } + + class SocketTester extends UnitTestCase { + ... + } +?> +</pre> + The <span class="new_code">FileTester</span> class does + not contain any actual tests, but is a base class for other + test cases. + For this reason we use the + <span class="new_code">SimpleTestOptions::ignore()</span> directive + to tell the upcoming group test to ignore it. + This directive can appear anywhere in the file and works + when a whole file of test cases is loaded (see below). + We will call this sample <em>file_test.php</em>. + </p> + <p> + Next we create a group test file, called say <em>group_test.php</em>. + You will think of a better name I am sure. + We will add the test file using a safe method... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php');<strong> + require_once('file_test.php'); + + $test = &new GroupTest('All file tests'); + $test->addTestCase(new FileTestCase()); + $test->run(new HtmlReporter());</strong> +?> +</pre> + This instantiates the test case before the test suite is + run. + This could get a little expensive with a large number of test + cases, so another method is provided that will only + instantiate the class when it is needed... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + require_once('file_test.php'); + + $test = &new GroupTest('All file tests');<strong> + $test->addTestClass('FileTestCase');</strong> + $test->run(new HtmlReporter()); +?> +</pre> + The problem with this method is that for every test case + that we add we will have + to <span class="new_code">require_once()</span> the test code + file and manually instantiate each and every test case. + We can save a lot of typing with... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('All file tests');<strong> + $test->addTestFile('file_test.php');</strong> + $test->run(new HtmlReporter()); +?&gt; +</pre> + What happens here is that the <span class="new_code">GroupTest</span> + class has done 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 adds + them to the group test. + Now all we have to do is add each new file. + </p> + <p> + There are two things that could go wrong and which require care... + <ol> + <li> + The file could already have been parsed by PHP and so no + new classes will have been added. You should make + sure that the test cases are only included in this file + and no others. + </li> + <li> + New test case extension classes that get included will be + placed in the group test and run also. + You will need to add a <span class="new_code">SimpleTestOptions::ignore()</span> + directive for these classes or make sure that they are included + before the <span class="new_code">GroupTest::addTestFile()</span> + line. + </li> + </ol> + </p> + + <p> +<a class="target" name="higher"> +<h2>Higher groupings</h2> +</a> +</p> + <p> + The above method places all of the test cases into one large group. + For larger projects though this may not be flexible enough; you + may want to group the tests in all sorts of ways. + </p> + <p> + To get a more flexible group test we can subclass + <span class="new_code">GroupTest</span> and then instantiate it as needed... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + <strong> + class FileGroupTest extends GroupTest { + function FileGroupTest() { + $this->GroupTest('All file tests'); + $this->addTestFile('file_test.php'); + } + }</strong> +?> +</pre> + This effectively names the test in the constructor and then + adds our test cases and a single group below. + Of course we can add more than one group at this point. + We can now invoke the tests from a separate runner file... +<pre> +<?php + require_once('file_group_test.php'); + <strong> + $test = &new FileGroupTest(); + $test->run(new HtmlReporter());</strong> +?> +</pre> + ...or we can group them into even larger group tests... +<pre> +<?php + require_once('file_group_test.php'); + <strong> + $test = &new BigGroupTest('Big group'); + $test->addTestCase(new FileGroupTest()); + $test->addTestCase(...); + $test->run(new HtmlReporter());</strong> +?> +</pre> + If we still wish to run the original group test and we + don't want all of these little runner files, we can + put the test runner code around guard bars when we create + each group. +<pre> +<?php + class FileGroupTest extends GroupTest { + function FileGroupTest() { + $this->GroupTest('All file tests'); + $test->addTestFile('file_test.php'); + } + } + <strong> + if (! defined('RUNNER')) { + define('RUNNER', true);</strong> + $test = &new FileGroupTest(); + $test->run(new HtmlReporter()); + } +?> +</pre> + This approach requires the guard to be set when including + the group test file, but this is still less hassle than + lots of separate runner files. + You include the same guard on the top level tests to make sure + that <span class="new_code">run()</span> will run once only + from the top level script that has been invoked. +<pre> +<?php<strong> + define('RUNNER', true);</strong> + require_once('file_group_test.php'); + + $test = &new BigGroupTest('Big group'); + $test->addTestCase(new FileGroupTest()); + $test->addTestCase(...); + $test->run(new HtmlReporter()); +?> +</pre> + As with the normal test cases, a <span class="new_code">GroupTest</span> can + be loaded with the <span class="new_code">GroupTest::addTestFile()</span> method. +<pre> +<?php + define('RUNNER', true); + + $test = &new BigGroupTest('Big group');<strong> + $test->addTestFile('file_group_test.php'); + $test->addTestFile(...);</strong> + $test->run(new HtmlReporter()); +?> +</pre> + </p> + + <p> +<a class="target" name="legacy"> +<h2>Integrating legacy test cases</h2> +</a> +</p> + <p> + If you already have unit tests for your code or are extending external + classes that have tests, it is unlikely that all of the test cases + are in SimpleTest format. + Fortunately it is possible to incorporate test cases from other + unit testers directly into SimpleTest group tests. + </p> + <p> + Say we have the following + <a href="http://sourceforge.net/projects/phpunit">PhpUnit</a> + test case in the file <em>config_test.php</em>... +<pre> +<strong>class ConfigFileTest extends TestCase { + function ConfigFileTest() { + $this->TestCase('Config file test'); + } + + function testContents() { + $config = new ConfigFile('test.conf'); + $this->assertRegexp('/me/', $config->getValue('username')); + } +}</strong> +</pre> + The group test can recognise this as long as we include + the appropriate adapter class before we add the test + file... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php');<strong> + require_once('simpletest/adapters/phpunit_test_case.php');</strong> + + $test = &new GroupTest('All file tests');<strong> + $test->addTestFile('config_test.php');</strong> + $test->run(new HtmlReporter()); +?> +</pre> + There are only two adapters, the other is for the + <a href="http://pear.php.net/manual/en/package.php.phpunit.php">PEAR</a> + 1.0 unit tester... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php');<strong> + require_once('simpletest/adapters/pear_test_case.php');</strong> + + $test = &new GroupTest('All file tests');<strong> + $test->addTestFile('some_pear_test_cases.php');</strong> + $test->run(new HtmlReporter()); +?> +</pre> + The PEAR test cases can be freely mixed with SimpleTest + ones even in the same test file, + but you cannot use SimpleTest assertions in the legacy + test case versions. + This is done as a check that you are not accidently making + your test cases completely dependent on SimpleTest. + You may want to do a PEAR release of your library for example + which would mean shipping it with valid PEAR::PhpUnit test + cases. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/index.html b/tests/test_tools/simpletest/docs/en/index.html index d5a30d31..04797272 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/index.html +++ b/tests/test_tools/simpletest/docs/en/index.html @@ -1,467 +1,467 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>
- Download the Simple Test 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">
-<h2>
-<span class="chosen">SimpleTest</span>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Simple Test for PHP</h1>
-<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>
-
- <p>
-<a class="target" name="unit">
-<h2>Using the tester quickly</h2>
-</a>
-</p>
- <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, but also adds
- <a href="http://www.mockobjects.com">mock objects</a>.
- It has some <a href="http://sourceforge.net/projects/jwebunit/">JWebUnit</a>
- functionality as well.
- This includes web page navigation, cookie testing and form submission.
- </p>
- <p>
- The quickest way to demonstrate 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>
-<strong><?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-?></strong>
-</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
- placed the toolset.
- Next we create a test case...
-<pre>
-<?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-<strong>
-class TestOfLogging extends UnitTestCase {
-}</strong>
-?>
-</pre>
- Now we have five lines of scaffolding code and still no tests.
- However from this part on we get return on our investment very quickly.
- 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>
-<?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-
-class TestOfLogging extends UnitTestCase {
- <strong>
- function testCreatingNewFile() {
- @unlink('/temp/test.log');
- $log = new Log('/temp/test.log');
- $this->assertFalse(file_exists('/temp/test.log'));
- $log->message('Should write this to a file');
- $this->assertTrue(file_exists('/temp/test.log'));
- }</strong>
-}
-?>
-</pre>
- When a test case runs it will search for any method that
- starts with the string <span class="new_code">test</span>
- and execute that method.
- We would normally have more than one test method of course.
- 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 content right next to the test case concerned.
- </p>
- <p>
- To see these results we have to actually run the tests.
- If this is the only test case we wish to run we can achieve
- it with...
-<pre>
-<?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-
-class TestOfLogging extends UnitTestCase {
-
- function testCreatingNewFile() {
- @unlink('/temp/test.log');
- $log = new Log('/temp/test.log');
- $this->assertFalse(file_exists('/temp/test.log'));
- $log->message('Should write this to a file');
- $this->assertTrue(file_exists('/temp/test.log'));
- }
-}
-<strong>
-$test = &new TestOfLogging();
-$test->run(new HtmlReporter());</strong>
-?>
-</pre>
- </p>
- <p>
- On failure the display looks like this...
- <div class="demo">
- <h1>testoflogging</h1>
- <span class="fail">Fail</span>: testcreatingnewfile->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>
-<?php
-class Log {
-
- function Log($file_path) {
- }
-
- function message() {
- }
-}
-?>;
-</pre>
- </p>
-
- <p>
-<a class="target" name="group">
-<h2>Building group tests</h2>
-</a>
-</p>
- <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 in the application.
- </p>
- <p>
- Our first step is to strip the includes and to undo our
- previous hack...
-<pre>
-<?php<strong>
-require_once('../classes/log.php');</strong>
-
-class TestOfLogging extends UnitTestCase {
-
- function testCreatingNewFile() {
- @unlink('/temp/test.log');
- $log = new Log('/temp/test.log');
- $this->assertFalse(file_exists('/temp/test.log'));
- $log->message('Should write this to a file');
- $this->assertTrue(file_exists('/temp/test.log'));<strong>
- }
-}
-?></strong>
-</pre>
- Next we create a new file called <em>tests/all_tests.php</em>
- and insert the following code...
-<pre>
-<strong><?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-
-$test = &new GroupTest('All tests');
-$test->addTestFile('log_test.php');
-$test->run(new HtmlReporter());
-?></strong>
-</pre>
- The method <span class="new_code">GroupTest::addTestFile()</span>
- will include the test case file and read any new classes created
- that are descended from <span class="new_code">SimpleTestCase</span>, of which
- <span class="new_code">UnitTestCase</span> is one example.
- Just the class names are stored for now, so that the test runner
- can instantiate the class when it works its way
- through your test suite.
- </p>
- <p>
- For this to work properly the test case file should not blindly include
- 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 add
- a <span class="new_code">SimpleTestOptions::ignore()</span> directive
- somewhere in the test case file.
- 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">GroupTest::addTestFile()</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.
- </p>
-
- <p>
-<a class="target" name="mock">
-<h2>Using mock objects</h2>
-</a>
-</p>
- <p>
- Let's move further into the future.
- </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->_log->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>
-<strong>
-<?php
-require_once('../classes/log.php');
-require_once('../classes/session_pool.php');
-
-class TestOfSessionLogging extends UnitTestCase {
-
- function setUp() {
- @unlink('/temp/test.log');
- }
-
- function tearDown() {
- @unlink('/temp/test.log');
- }
-
- function testLogInIsLogged() {
- $log = new Log('/temp/test.log');
- $session_pool = &new SessionPool($log);
- $session_pool->logIn('fred');
- $messages = file('/temp/test.log');
- $this->assertEqual($messages[0], "User fred logged in.\n");
- }
-}
-?></strong>
-</pre>
- 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. Worse, 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?
- 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 reduce coupling if we can 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?
- Luckily we can create such an object easily...
-<pre>
-<?php
-require_once('../classes/log.php');
-require_once('../classes/session_pool.php');<strong>
-Mock::generate('Log');</strong>
-
-class TestOfSessionLogging extends UnitTestCase {
-
- function testLogInIsLogged() {<strong>
- $log = &new MockLog($this);
- $log->expectOnce('message', array('User fred logged in.'));</strong>
- $session_pool = &new SessionPool($log);
- $session_pool->logIn('fred');<strong>
- $log->tally();</strong>
- }
-}
-?>
-</pre>
- The <span class="new_code">tally()</span> call is needed to
- tell the mock object that time is up for the expected call
- count.
- Without it the mock would wait forever for the method
- call to come in without ever actually notifying the test case.
- The other 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.
- 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 as to prevent tests
- becoming too specific.
- </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 this test to run the mock objects library must have been
- included in the test suite, say in <em>all_tests.php</em>.
- </p>
-
- <p>
-<a class="target" name="web">
-<h2>Web page testing</h2>
-</a>
-</p>
- <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, there is
- no JavaScript for example.
- 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>
-<?php<strong>
-require_once('simpletest/web_tester.php');</strong>
-require_once('simpletest/reporter.php');
-<strong>
-class TestOfAbout extends WebTestCase {
-
- function setUp() {
- $this->get('http://test-server/index.php');
- $this->clickLink('About');
- }
-
- function testSearchEngineOptimisations() {
- $this->assertTitle('A long title about us for search engines');
- $this->assertWantedPattern('/a popular keyphrase/i');
- }
-}</strong>
-$test = &new TestOfAbout();
-$test->run(new HtmlReporter());
-?>
-</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>
- <a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a>
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> + Download the Simple Test 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"> +<h2> +<span class="chosen">SimpleTest</span> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Simple Test for PHP</h1> +<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> + + <p> +<a class="target" name="unit"> +<h2>Using the tester quickly</h2> +</a> +</p> + <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, but also adds + <a href="http://www.mockobjects.com">mock objects</a>. + It has some <a href="http://sourceforge.net/projects/jwebunit/">JWebUnit</a> + functionality as well. + This includes web page navigation, cookie testing and form submission. + </p> + <p> + The quickest way to demonstrate 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> +<strong><?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); +?></strong> +</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 + placed the toolset. + Next we create a test case... +<pre> +<?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); +<strong> +class TestOfLogging extends UnitTestCase { +}</strong> +?> +</pre> + Now we have five lines of scaffolding code and still no tests. + However from this part on we get return on our investment very quickly. + 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> +<?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); + +class TestOfLogging extends UnitTestCase { + <strong> + function testCreatingNewFile() { + @unlink('/temp/test.log'); + $log = new Log('/temp/test.log'); + $this->assertFalse(file_exists('/temp/test.log')); + $log->message('Should write this to a file'); + $this->assertTrue(file_exists('/temp/test.log')); + }</strong> +} +?> +</pre> + When a test case runs it will search for any method that + starts with the string <span class="new_code">test</span> + and execute that method. + We would normally have more than one test method of course. + 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 content right next to the test case concerned. + </p> + <p> + To see these results we have to actually run the tests. + If this is the only test case we wish to run we can achieve + it with... +<pre> +<?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); + +class TestOfLogging extends UnitTestCase { + + function testCreatingNewFile() { + @unlink('/temp/test.log'); + $log = new Log('/temp/test.log'); + $this->assertFalse(file_exists('/temp/test.log')); + $log->message('Should write this to a file'); + $this->assertTrue(file_exists('/temp/test.log')); + } +} +<strong> +$test = &new TestOfLogging(); +$test->run(new HtmlReporter());</strong> +?> +</pre> + </p> + <p> + On failure the display looks like this... + <div class="demo"> + <h1>testoflogging</h1> + <span class="fail">Fail</span>: testcreatingnewfile->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> +<?php +class Log { + + function Log($file_path) { + } + + function message() { + } +} +?>; +</pre> + </p> + + <p> +<a class="target" name="group"> +<h2>Building group tests</h2> +</a> +</p> + <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 in the application. + </p> + <p> + Our first step is to strip the includes and to undo our + previous hack... +<pre> +<?php<strong> +require_once('../classes/log.php');</strong> + +class TestOfLogging extends UnitTestCase { + + function testCreatingNewFile() { + @unlink('/temp/test.log'); + $log = new Log('/temp/test.log'); + $this->assertFalse(file_exists('/temp/test.log')); + $log->message('Should write this to a file'); + $this->assertTrue(file_exists('/temp/test.log'));<strong> + } +} +?></strong> +</pre> + Next we create a new file called <em>tests/all_tests.php</em> + and insert the following code... +<pre> +<strong><?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); + +$test = &new GroupTest('All tests'); +$test->addTestFile('log_test.php'); +$test->run(new HtmlReporter()); +?></strong> +</pre> + The method <span class="new_code">GroupTest::addTestFile()</span> + will include the test case file and read any new classes created + that are descended from <span class="new_code">SimpleTestCase</span>, of which + <span class="new_code">UnitTestCase</span> is one example. + Just the class names are stored for now, so that the test runner + can instantiate the class when it works its way + through your test suite. + </p> + <p> + For this to work properly the test case file should not blindly include + 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 add + a <span class="new_code">SimpleTestOptions::ignore()</span> directive + somewhere in the test case file. + 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">GroupTest::addTestFile()</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. + </p> + + <p> +<a class="target" name="mock"> +<h2>Using mock objects</h2> +</a> +</p> + <p> + Let's move further into the future. + </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->_log->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> +<strong> +<?php +require_once('../classes/log.php'); +require_once('../classes/session_pool.php'); + +class TestOfSessionLogging extends UnitTestCase { + + function setUp() { + @unlink('/temp/test.log'); + } + + function tearDown() { + @unlink('/temp/test.log'); + } + + function testLogInIsLogged() { + $log = new Log('/temp/test.log'); + $session_pool = &new SessionPool($log); + $session_pool->logIn('fred'); + $messages = file('/temp/test.log'); + $this->assertEqual($messages[0], "User fred logged in.\n"); + } +} +?></strong> +</pre> + 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. Worse, 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? + 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 reduce coupling if we can 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? + Luckily we can create such an object easily... +<pre> +<?php +require_once('../classes/log.php'); +require_once('../classes/session_pool.php');<strong> +Mock::generate('Log');</strong> + +class TestOfSessionLogging extends UnitTestCase { + + function testLogInIsLogged() {<strong> + $log = &new MockLog($this); + $log->expectOnce('message', array('User fred logged in.'));</strong> + $session_pool = &new SessionPool($log); + $session_pool->logIn('fred');<strong> + $log->tally();</strong> + } +} +?> +</pre> + The <span class="new_code">tally()</span> call is needed to + tell the mock object that time is up for the expected call + count. + Without it the mock would wait forever for the method + call to come in without ever actually notifying the test case. + The other 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. + 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 as to prevent tests + becoming too specific. + </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 this test to run the mock objects library must have been + included in the test suite, say in <em>all_tests.php</em>. + </p> + + <p> +<a class="target" name="web"> +<h2>Web page testing</h2> +</a> +</p> + <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, there is + no JavaScript for example. + 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> +<?php<strong> +require_once('simpletest/web_tester.php');</strong> +require_once('simpletest/reporter.php'); +<strong> +class TestOfAbout extends WebTestCase { + + function setUp() { + $this->get('http://test-server/index.php'); + $this->clickLink('About'); + } + + function testSearchEngineOptimisations() { + $this->assertTitle('A long title about us for search engines'); + $this->assertWantedPattern('/a popular keyphrase/i'); + } +}</strong> +$test = &new TestOfAbout(); +$test->run(new HtmlReporter()); +?> +</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> + <a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a> + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/mock_objects_documentation.html b/tests/test_tools/simpletest/docs/en/mock_objects_documentation.html index 126b58dd..2f8a1f90 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/mock_objects_documentation.html +++ b/tests/test_tools/simpletest/docs/en/mock_objects_documentation.html @@ -1,713 +1,713 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<span class="chosen">Mock objects</span>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Mock objects documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="what">
-<h2>What are mock objects?</h2>
-</a>
-</p>
- <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 <a href="server_stubs_documentation.html">server stubs</a>.
- </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.
- 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>
-
- <p>
-<a class="target" name="creation">
-<h2>Creating mock objects</h2>
-</a>
-</p>
- <p>
- In the same way that we create server stubs, all we need is an
- existing class, say a database connection that looks like this...
-<pre>
-<strong>class DatabaseConnection {
- function DatabaseConnection() {
- }
-
- function query() {
- }
-
- function selectQuery() {
- }
-}</strong>
-</pre>
- The class does not need to have been implemented yet.
- To create a mock version of the class we need to include the
- mock object library and run the generator...
-<pre>
-<strong>require_once('simpletest/unit_tester.php');
-require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-
-Mock::generate('DatabaseConnection');</strong>
-</pre>
- This generates a clone class called
- <span class="new_code">MockDatabaseConnection</span>.
- We can now create instances of the new class within
- our test case...
-<pre>
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-
-Mock::generate('DatabaseConnection');
-<strong>
-class MyTestCase extends UnitTestCase {
-
- function testSomething() {
- $connection = &new MockDatabaseConnection($this);
- }
-}</strong>
-</pre>
- Unlike the generated stubs the mock constructor needs a reference
- to the test case so that it can dispatch passes and failures while
- checking its expectations.
- This means that mock objects can only be used within test cases.
- Despite this their extra power means that stubs are hardly ever used
- if mocks are available.
- </p>
- <p>
- <a class="target" name="stub">
-<h2>Mocks as actors</h2>
-</a>
- </p>
- <p>
- The mock version of a class has all the methods of the original
- so that operations like
- <span class="new_code">$connection->query()</span> are still
- legal.
- As with stubs we can replace the default null return values...
-<pre>
-<strong>$connection->setReturnValue('query', 37);</strong>
-</pre>
- Now every time we call
- <span class="new_code">$connection->query()</span> we get
- the result of 37.
- As with the stubs we can set wildcards and we can overload the
- wildcard parameter.
- We can also add extra methods to the mock when generating it
- and choose our own class name...
-<pre>
-<strong>Mock::generate('DatabaseConnection', 'MyMockDatabaseConnection', array('setOptions'));</strong>
-</pre>
- Here the mock will behave as if the <span class="new_code">setOptions()</span>
- existed in the original class.
- This is handy if a class has used the PHP <span class="new_code">overload()</span>
- mechanism to add dynamic methods.
- You can create a special mock to simulate this situation.
- </p>
- <p>
- All of the patterns available with server stubs are available
- to mock objects...
-<pre>
-class Iterator {
- function Iterator() {
- }
-
- function next() {
- }
-}
-</pre>
- Again, 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($this);
- $iterator->setReturnValue('next', false);
- $iterator->setReturnValueAt(0, 'next', 'First string');
- $iterator->setReturnValueAt(1, 'next', 'Second string');</strong>
- ...
- }
-}
-</pre>
- When <span class="new_code">next()</span> is called on the
- mock iterator 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>
- A repeat of the stubbed information holder with name/value pairs...
-<pre>
-class Configuration {
- function Configuration() {
- }
-
- function getValue($key) {
- }
-}
-</pre>
- This is a classic situation for using mock objects as
- actual configuration will vary from machine to machine,
- hardly helping the reliability of our tests if we use it
- directly.
- The problem though is that all the data comes through the
- <span class="new_code">getValue()</span> method and yet
- we want different results for different keys.
- Luckily the mocks have a filter system...
-<pre>
-<strong>$config = &new MockConfiguration($this);
-$config->setReturnValue('getValue', 'primary', array('db_host'));
-$config->setReturnValue('getValue', 'admin', array('db_user'));
-$config->setReturnValue('getValue', '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">getValue()</span> method invoked
- like this...
-<pre>
-$config->getValue('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>
- There are times when you want a specific object to be
- dished out by the mock rather than a copy.
- Again this is identical to the server stubs mechanism...
-<pre>
-class Thing {
-}
-
-class Vector {
- function Vector() {
- }
-
- function get($index) {
- }
-}
-</pre>
- In this case you can set a reference into the mock's
- return list...
-<pre>
-$thing = new Thing();<strong>
-$vector = &new MockVector($this);
-$vector->setReturnReference('get', $thing, array(12));</strong>
-</pre>
- With this arrangement you know that every time
- <span class="new_code">$vector->get(12)</span> is
- called it will return the same
- <span class="new_code">$thing</span> each time.
- </p>
-
- <p>
-<a class="target" name="expectations">
-<h2>Mocks as critics</h2>
-</a>
-</p>
- <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, suppose we have a
- <span class="new_code">SessionPool</span> class that we
- want to add logging to.
- Rather than grow the original class into something more
- complicated, we want to add this behaviour with a decorator (GOF).
- The <span class="new_code">SessionPool</span> code currently looks
- like this...
-<pre>
-<strong>class SessionPool {
- function SessionPool() {
- ...
- }
-
- function &findSession($cookie) {
- ...
- }
- ...
-}
-
-class Session {
- ...
-}</strong>
-</php>
- While our logging code looks like this...
-<php><strong>
-class Log {
- function Log() {
- ...
- }
-
- function message() {
- ...
- }
-}
-
-class LoggingSessionPool {
- function LoggingSessionPool(&$session_pool, &$log) {
- ...
- }
-
- function &findSession(\$cookie) {
- ...
- }
- ...
-}</strong>
-</pre>
- Out of all of this, the only class we want to test here
- is the <span class="new_code">LoggingSessionPool</span>.
- In particular we would like to check that the
- <span class="new_code">findSession()</span> method is
- called with the correct session ID in the cookie and that
- it sent the message "Starting session $cookie"
- to the logger.
- </p>
- <p>
- Despite the fact that we are testing only a few lines of
- production code, here is what we would have to do in a
- conventional test case:
- <ol>
- <li>Create a log object.</li>
- <li>Set a directory to place the log file.</li>
- <li>Set the directory permissions so we can write the log.</li>
- <li>Create a <span class="new_code">SessionPool</span> object.</li>
- <li>Hand start a session, which probably does lot's of things.</li>
- <li>Invoke <span class="new_code">findSession()</span>.</li>
- <li>Read the new Session ID (hope there is an accessor!).</li>
- <li>Raise a test assertion to confirm that the ID matches the cookie.</li>
- <li>Read the last line of the log file.</li>
- <li>Pattern match out the extra logging timestamps, etc.</li>
- <li>Assert that the session message is contained in the text.</li>
- </ol>
- It is hardly surprising that developers hate writing tests
- when they are this much drudgery.
- To make things worse, every time the logging format changes or
- the method of creating new sessions changes, we have to rewrite
- parts of this test even though this test does not officially
- test those parts of the system.
- We are creating headaches for the writers of these other classes.
- </p>
- <p>
- Instead, here is the complete test method using mock object magic...
-<pre>
-Mock::generate('Session');
-Mock::generate('SessionPool');
-Mock::generate('Log');
-
-class LoggingSessionPoolTest extends UnitTestCase {
- ...
- function testFindSessionLogging() {<strong>
- $session = &new MockSession($this);
- $pool = &new MockSessionPool($this);
- $pool->setReturnReference('findSession', $session);
- $pool->expectOnce('findSession', array('abc'));
-
- $log = &new MockLog($this);
- $log->expectOnce('message', array('Starting session abc'));
-
- $logging_pool = &new LoggingSessionPool($pool, $log);
- $this->assertReference($logging_pool->findSession('abc'), $session);
- $pool->tally();
- $log->tally();</strong>
- }
-}
-</pre>
- We start by creating a dummy session.
- We don't have to be too fussy about this as the check
- for which session we want is done elsewhere.
- We only need to check that it was the same one that came
- from the session pool.
- </p>
- <p>
- <span class="new_code">findSession()</span> is a factory
- method the simulation of which is described <a href="#stub">above</a>.
- The point of departure comes with the first
- <span class="new_code">expectOnce()</span> call.
- This line states that whenever
- <span class="new_code">findSession()</span> is invoked on the
- mock, it will test the incoming arguments.
- If it receives the single argument of a string "abc"
- then a test pass is sent to the unit tester, otherwise a fail is
- generated.
- This was the part where we checked that the right session was asked for.
- The argument list follows the same format as the one for setting
- return values.
- You can have wildcards and sequences and the order of
- evaluation is the same.
- </p>
- <p>
- If the call is never made then neither a pass nor a failure will
- generated.
- To get around this we must tell the mock when the test is over
- so that the object can decide if the expectation has been met.
- The unit tester assertion for this is triggered by the
- <span class="new_code">tally()</span> call at the end of
- the test.
- </p>
- <p>
- We use the same pattern to set up the mock logger.
- We tell it that it should have
- <span class="new_code">message()</span> invoked
- once only with the argument "Starting session abc".
- By testing the calling arguments, rather than the logger output,
- we insulate the test from any display changes in the logger.
- </p>
- <p>
- We start to run our tests when we create the new
- <span class="new_code">LoggingSessionPool</span> and feed
- it our preset mock objects.
- Everything is now under our control.
- Finally we confirm that the
- <span class="new_code">$session</span> we gave our decorator
- is the one that we get back and tell the mocks to run their
- internal call count tests with the
- <span class="new_code">tally()</span> calls.
- </p>
- <p>
- This is still quite a bit of test code, but the code is very
- strict.
- If it still seems rather daunting there is a lot less of it
- than if we tried this without mocks and this particular test,
- interactions rather than output, is always more work to set
- up.
- More often you will be testing more complex situations without
- needing this level or precision.
- Also some of this can be refactored into a test case
- <span class="new_code">setUp()</span> method.
- </p>
- <p>
- Here is the full list of expectations you can set on a mock object
- in <a href="http://www.lastcraft.com/simple_test.php">SimpleTest</a>...
- <table>
-<thead>
- <tr>
-<th>Expectation</th><th>Needs <span class="new_code">tally()</span></th>
-</tr>
- </thead>
-<tbody>
-<tr>
- <td><span class="new_code">expectArguments($method, $args)</span></td>
- <td style="text-align: center">No</td>
- </tr>
- <tr>
- <td><span class="new_code">expectArgumentsAt($timing, $method, $args)</span></td>
- <td style="text-align: center">No</td>
- </tr>
- <tr>
- <td><span class="new_code">expectCallCount($method, $count)</span></td>
- <td style="text-align: center">Yes</td>
- </tr>
- <tr>
- <td><span class="new_code">expectMaximumCallCount($method, $count)</span></td>
- <td style="text-align: center">No</td>
- </tr>
- <tr>
- <td><span class="new_code">expectMinimumCallCount($method, $count)</span></td>
- <td style="text-align: center">Yes</td>
- </tr>
- <tr>
- <td><span class="new_code">expectNever($method)</span></td>
- <td style="text-align: center">No</td>
- </tr>
- <tr>
- <td><span class="new_code">expectOnce($method, $args)</span></td>
- <td style="text-align: center">Yes</td>
- </tr>
- <tr>
- <td><span class="new_code">expectAtLeastOnce($method, $args)</span></td>
- <td style="text-align: center">Yes</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.
- </dd>
- <dt class="new_code">$count</dt>
- <dd>The number of calls expected.</dd>
- </dl>
- The method <span class="new_code">expectMaximumCallCount()</span>
- is slightly different in that it will only ever generate a failure.
- It is silent if the limit is never reached.
- </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>
-
- <p>
-<a class="target" name="approaches">
-<h2>Other approaches</h2>
-</a>
-</p>
- <p>
- There are three approaches to creating mocks including the one
- that SimpleTest employs.
- Coding them by hand using a base class, generating them to
- a file and dynamically generating them on the fly.
- </p>
- <p>
- Mock objects generated with <a href="simple_test.html">SimpleTest</a>
- are dynamic.
- They are created at run time in memory, using
- <span class="new_code">eval()</span>, rather than written
- out to a file.
- This makes the mocks easy to create, a one liner,
- especially compared with hand
- crafting them in a parallel class hierarchy.
- The problem is that the behaviour is usually set up in the tests
- themselves.
- If the original objects change the mock versions
- that the tests rely on can get out of sync.
- This can happen with the parallel hierarchy approach as well,
- but is far more quickly detected.
- </p>
- <p>
- The solution, of course, is to add some real integration
- tests.
- You don't need very many and the convenience gained
- from the mocks more than outweighs the small amount of
- extra testing.
- You cannot trust code that was only tested with mocks.
- </p>
- <p>
- If you are still determined to build static libraries of mocks
- because you want to simulate very specific behaviour, you can
- achieve the same effect using the SimpleTest class generator.
- In your library file, say <em>mocks/connection.php</em> for a
- database connection, create a mock and inherit to override
- special methods or add presets...
-<pre>
-<?php
- require_once('simpletest/mock_objects.php');
- require_once('../classes/connection.php');
-<strong>
- Mock::generate('Connection', 'BasicMockConnection');
- class MockConnection extends BasicMockConnection {
- function MockConnection(&$test, $wildcard = '*') {
- $this->BasicMockConnection($test, $wildcard);
- $this->setReturn('query', false);
- }
- }</strong>
-?>
-</pre>
- The generate call tells the class generator to create
- a class called <span class="new_code">BasicMockConnection</span>
- rather than the usual <span class="new_code">MockConnection</span>.
- We then inherit from this to get our version of
- <span class="new_code">MockConnection</span>.
- By intercepting in this way we can add behaviour, here setting
- the default value of <span class="new_code">query()</span> to be false.
- By using the default name we make sure that the mock class
- generator will not recreate a different one when invoked elsewhere in the
- tests.
- It never creates a class if it already exists.
- As long as the above file is included first then all tests
- that generated <span class="new_code">MockConnection</span> should
- now be using our one instead.
- If we don't get the order right and the mock library
- creates one first then the class creation will simply fail.
- </p>
- <p>
- Use this trick if you find you have a lot of common mock behaviour
- or you are getting frequent integration problems at later
- stages of testing.
- </p>
-
- <p>
-<a class="target" name="other_testers">
-<h2>I think SimpleTest stinks!</h2>
-</a>
-</p>
- <p>
- But at the time of writing it is the only one with mock objects,
- so are you stuck with it?
- </p>
- <p>
- No, not at all.
- <a href="simple_test.html">SimpleTest</a> is a toolkit and one of those
- tools is the mock objects which can be employed independently.
- Suppose you have your own favourite unit tester and all your current
- test cases are written using it.
- Pretend that you have called your unit tester PHPUnit (everyone else has)
- and the core test class looks like this...
-<pre>
-class PHPUnit {
- function PHPUnit() {
- }
-
- function assertion($message, $assertion) {
- }
- ...
-}
-</pre>
- All the <span class="new_code">assertion()</span> method does
- is print some fancy output and the boolean assertion parameter determines
- whether to print a pass or a failure.
- Let's say that it is used like this...
-<pre>
-$unit_test = new PHPUnit();
-$unit_test>assertion('I hope this file exists', file_exists('my_file'));
-</pre>
- How do you use mocks with this?
- </p>
- <p>
- There is a protected method on the base mock class
- <span class="new_code">SimpleMock</span> called
- <span class="new_code">_assertTrue()</span> and
- by overriding this method we can use our own assertion format.
- We start with a subclass, in say <em>my_mock.php</em>...
-<pre>
-<strong><?php
- require_once('simpletest/mock_objects.php');
-
- class MyMock extends SimpleMock() {
- function MyMock(&$test, $wildcard) {
- $this->SimpleMock($test, $wildcard);
- }
-
- function _assertTrue($assertion, $message) {
- $test = &$this->getTest();
- $test->assertion($message, $assertion);
- }
- }
-?></strong>
-</pre>
- Now instantiating <span class="new_code">MyMock</span> will create
- an object that speaks the same language as your tester.
- The catch is of course that we never create such an object, the
- code generator does.
- We need just one more line of code to tell the generator to use
- your mock instead...
-<pre>
-<?php
- require_once('simpletst/mock_objects.php');
-
- class MyMock extends SimpleMock() {
- function MyMock($test, $wildcard) {
- $this->SimpleMock(&$test, $wildcard);
- }
-
- function _assertTrue($assertion, $message , &$test) {
- $test->assertion($message, $assertion);
- }
- }<strong>
- SimpleTestOptions::setMockBaseClass('MyMock');</strong>
-?>
-</pre>
- From now on you just include <em>my_mock.php</em> instead of the
- default <em>mock_objects.php</em> version and you can introduce
- mock objects into your existing test suite.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<span class="chosen">Mock objects</span> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Mock objects documentation</h1> +<div class="content"> + <p> +<a class="target" name="what"> +<h2>What are mock objects?</h2> +</a> +</p> + <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 <a href="server_stubs_documentation.html">server stubs</a>. + </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. + 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> + + <p> +<a class="target" name="creation"> +<h2>Creating mock objects</h2> +</a> +</p> + <p> + In the same way that we create server stubs, all we need is an + existing class, say a database connection that looks like this... +<pre> +<strong>class DatabaseConnection { + function DatabaseConnection() { + } + + function query() { + } + + function selectQuery() { + } +}</strong> +</pre> + The class does not need to have been implemented yet. + To create a mock version of the class we need to include the + mock object library and run the generator... +<pre> +<strong>require_once('simpletest/unit_tester.php'); +require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); + +Mock::generate('DatabaseConnection');</strong> +</pre> + This generates a clone class called + <span class="new_code">MockDatabaseConnection</span>. + We can now create instances of the new class within + our test case... +<pre> +require_once('simpletest/unit_tester.php'); +require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); + +Mock::generate('DatabaseConnection'); +<strong> +class MyTestCase extends UnitTestCase { + + function testSomething() { + $connection = &new MockDatabaseConnection($this); + } +}</strong> +</pre> + Unlike the generated stubs the mock constructor needs a reference + to the test case so that it can dispatch passes and failures while + checking its expectations. + This means that mock objects can only be used within test cases. + Despite this their extra power means that stubs are hardly ever used + if mocks are available. + </p> + <p> + <a class="target" name="stub"> +<h2>Mocks as actors</h2> +</a> + </p> + <p> + The mock version of a class has all the methods of the original + so that operations like + <span class="new_code">$connection->query()</span> are still + legal. + As with stubs we can replace the default null return values... +<pre> +<strong>$connection->setReturnValue('query', 37);</strong> +</pre> + Now every time we call + <span class="new_code">$connection->query()</span> we get + the result of 37. + As with the stubs we can set wildcards and we can overload the + wildcard parameter. + We can also add extra methods to the mock when generating it + and choose our own class name... +<pre> +<strong>Mock::generate('DatabaseConnection', 'MyMockDatabaseConnection', array('setOptions'));</strong> +</pre> + Here the mock will behave as if the <span class="new_code">setOptions()</span> + existed in the original class. + This is handy if a class has used the PHP <span class="new_code">overload()</span> + mechanism to add dynamic methods. + You can create a special mock to simulate this situation. + </p> + <p> + All of the patterns available with server stubs are available + to mock objects... +<pre> +class Iterator { + function Iterator() { + } + + function next() { + } +} +</pre> + Again, 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($this); + $iterator->setReturnValue('next', false); + $iterator->setReturnValueAt(0, 'next', 'First string'); + $iterator->setReturnValueAt(1, 'next', 'Second string');</strong> + ... + } +} +</pre> + When <span class="new_code">next()</span> is called on the + mock iterator 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> + A repeat of the stubbed information holder with name/value pairs... +<pre> +class Configuration { + function Configuration() { + } + + function getValue($key) { + } +} +</pre> + This is a classic situation for using mock objects as + actual configuration will vary from machine to machine, + hardly helping the reliability of our tests if we use it + directly. + The problem though is that all the data comes through the + <span class="new_code">getValue()</span> method and yet + we want different results for different keys. + Luckily the mocks have a filter system... +<pre> +<strong>$config = &new MockConfiguration($this); +$config->setReturnValue('getValue', 'primary', array('db_host')); +$config->setReturnValue('getValue', 'admin', array('db_user')); +$config->setReturnValue('getValue', '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">getValue()</span> method invoked + like this... +<pre> +$config->getValue('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> + There are times when you want a specific object to be + dished out by the mock rather than a copy. + Again this is identical to the server stubs mechanism... +<pre> +class Thing { +} + +class Vector { + function Vector() { + } + + function get($index) { + } +} +</pre> + In this case you can set a reference into the mock's + return list... +<pre> +$thing = new Thing();<strong> +$vector = &new MockVector($this); +$vector->setReturnReference('get', $thing, array(12));</strong> +</pre> + With this arrangement you know that every time + <span class="new_code">$vector->get(12)</span> is + called it will return the same + <span class="new_code">$thing</span> each time. + </p> + + <p> +<a class="target" name="expectations"> +<h2>Mocks as critics</h2> +</a> +</p> + <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, suppose we have a + <span class="new_code">SessionPool</span> class that we + want to add logging to. + Rather than grow the original class into something more + complicated, we want to add this behaviour with a decorator (GOF). + The <span class="new_code">SessionPool</span> code currently looks + like this... +<pre> +<strong>class SessionPool { + function SessionPool() { + ... + } + + function &findSession($cookie) { + ... + } + ... +} + +class Session { + ... +}</strong> +</php> + While our logging code looks like this... +<php><strong> +class Log { + function Log() { + ... + } + + function message() { + ... + } +} + +class LoggingSessionPool { + function LoggingSessionPool(&$session_pool, &$log) { + ... + } + + function &findSession(\$cookie) { + ... + } + ... +}</strong> +</pre> + Out of all of this, the only class we want to test here + is the <span class="new_code">LoggingSessionPool</span>. + In particular we would like to check that the + <span class="new_code">findSession()</span> method is + called with the correct session ID in the cookie and that + it sent the message "Starting session $cookie" + to the logger. + </p> + <p> + Despite the fact that we are testing only a few lines of + production code, here is what we would have to do in a + conventional test case: + <ol> + <li>Create a log object.</li> + <li>Set a directory to place the log file.</li> + <li>Set the directory permissions so we can write the log.</li> + <li>Create a <span class="new_code">SessionPool</span> object.</li> + <li>Hand start a session, which probably does lot's of things.</li> + <li>Invoke <span class="new_code">findSession()</span>.</li> + <li>Read the new Session ID (hope there is an accessor!).</li> + <li>Raise a test assertion to confirm that the ID matches the cookie.</li> + <li>Read the last line of the log file.</li> + <li>Pattern match out the extra logging timestamps, etc.</li> + <li>Assert that the session message is contained in the text.</li> + </ol> + It is hardly surprising that developers hate writing tests + when they are this much drudgery. + To make things worse, every time the logging format changes or + the method of creating new sessions changes, we have to rewrite + parts of this test even though this test does not officially + test those parts of the system. + We are creating headaches for the writers of these other classes. + </p> + <p> + Instead, here is the complete test method using mock object magic... +<pre> +Mock::generate('Session'); +Mock::generate('SessionPool'); +Mock::generate('Log'); + +class LoggingSessionPoolTest extends UnitTestCase { + ... + function testFindSessionLogging() {<strong> + $session = &new MockSession($this); + $pool = &new MockSessionPool($this); + $pool->setReturnReference('findSession', $session); + $pool->expectOnce('findSession', array('abc')); + + $log = &new MockLog($this); + $log->expectOnce('message', array('Starting session abc')); + + $logging_pool = &new LoggingSessionPool($pool, $log); + $this->assertReference($logging_pool->findSession('abc'), $session); + $pool->tally(); + $log->tally();</strong> + } +} +</pre> + We start by creating a dummy session. + We don't have to be too fussy about this as the check + for which session we want is done elsewhere. + We only need to check that it was the same one that came + from the session pool. + </p> + <p> + <span class="new_code">findSession()</span> is a factory + method the simulation of which is described <a href="#stub">above</a>. + The point of departure comes with the first + <span class="new_code">expectOnce()</span> call. + This line states that whenever + <span class="new_code">findSession()</span> is invoked on the + mock, it will test the incoming arguments. + If it receives the single argument of a string "abc" + then a test pass is sent to the unit tester, otherwise a fail is + generated. + This was the part where we checked that the right session was asked for. + The argument list follows the same format as the one for setting + return values. + You can have wildcards and sequences and the order of + evaluation is the same. + </p> + <p> + If the call is never made then neither a pass nor a failure will + generated. + To get around this we must tell the mock when the test is over + so that the object can decide if the expectation has been met. + The unit tester assertion for this is triggered by the + <span class="new_code">tally()</span> call at the end of + the test. + </p> + <p> + We use the same pattern to set up the mock logger. + We tell it that it should have + <span class="new_code">message()</span> invoked + once only with the argument "Starting session abc". + By testing the calling arguments, rather than the logger output, + we insulate the test from any display changes in the logger. + </p> + <p> + We start to run our tests when we create the new + <span class="new_code">LoggingSessionPool</span> and feed + it our preset mock objects. + Everything is now under our control. + Finally we confirm that the + <span class="new_code">$session</span> we gave our decorator + is the one that we get back and tell the mocks to run their + internal call count tests with the + <span class="new_code">tally()</span> calls. + </p> + <p> + This is still quite a bit of test code, but the code is very + strict. + If it still seems rather daunting there is a lot less of it + than if we tried this without mocks and this particular test, + interactions rather than output, is always more work to set + up. + More often you will be testing more complex situations without + needing this level or precision. + Also some of this can be refactored into a test case + <span class="new_code">setUp()</span> method. + </p> + <p> + Here is the full list of expectations you can set on a mock object + in <a href="http://www.lastcraft.com/simple_test.php">SimpleTest</a>... + <table> +<thead> + <tr> +<th>Expectation</th><th>Needs <span class="new_code">tally()</span></th> +</tr> + </thead> +<tbody> +<tr> + <td><span class="new_code">expectArguments($method, $args)</span></td> + <td style="text-align: center">No</td> + </tr> + <tr> + <td><span class="new_code">expectArgumentsAt($timing, $method, $args)</span></td> + <td style="text-align: center">No</td> + </tr> + <tr> + <td><span class="new_code">expectCallCount($method, $count)</span></td> + <td style="text-align: center">Yes</td> + </tr> + <tr> + <td><span class="new_code">expectMaximumCallCount($method, $count)</span></td> + <td style="text-align: center">No</td> + </tr> + <tr> + <td><span class="new_code">expectMinimumCallCount($method, $count)</span></td> + <td style="text-align: center">Yes</td> + </tr> + <tr> + <td><span class="new_code">expectNever($method)</span></td> + <td style="text-align: center">No</td> + </tr> + <tr> + <td><span class="new_code">expectOnce($method, $args)</span></td> + <td style="text-align: center">Yes</td> + </tr> + <tr> + <td><span class="new_code">expectAtLeastOnce($method, $args)</span></td> + <td style="text-align: center">Yes</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. + </dd> + <dt class="new_code">$count</dt> + <dd>The number of calls expected.</dd> + </dl> + The method <span class="new_code">expectMaximumCallCount()</span> + is slightly different in that it will only ever generate a failure. + It is silent if the limit is never reached. + </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> + + <p> +<a class="target" name="approaches"> +<h2>Other approaches</h2> +</a> +</p> + <p> + There are three approaches to creating mocks including the one + that SimpleTest employs. + Coding them by hand using a base class, generating them to + a file and dynamically generating them on the fly. + </p> + <p> + Mock objects generated with <a href="simple_test.html">SimpleTest</a> + are dynamic. + They are created at run time in memory, using + <span class="new_code">eval()</span>, rather than written + out to a file. + This makes the mocks easy to create, a one liner, + especially compared with hand + crafting them in a parallel class hierarchy. + The problem is that the behaviour is usually set up in the tests + themselves. + If the original objects change the mock versions + that the tests rely on can get out of sync. + This can happen with the parallel hierarchy approach as well, + but is far more quickly detected. + </p> + <p> + The solution, of course, is to add some real integration + tests. + You don't need very many and the convenience gained + from the mocks more than outweighs the small amount of + extra testing. + You cannot trust code that was only tested with mocks. + </p> + <p> + If you are still determined to build static libraries of mocks + because you want to simulate very specific behaviour, you can + achieve the same effect using the SimpleTest class generator. + In your library file, say <em>mocks/connection.php</em> for a + database connection, create a mock and inherit to override + special methods or add presets... +<pre> +<?php + require_once('simpletest/mock_objects.php'); + require_once('../classes/connection.php'); +<strong> + Mock::generate('Connection', 'BasicMockConnection'); + class MockConnection extends BasicMockConnection { + function MockConnection(&$test, $wildcard = '*') { + $this->BasicMockConnection($test, $wildcard); + $this->setReturn('query', false); + } + }</strong> +?> +</pre> + The generate call tells the class generator to create + a class called <span class="new_code">BasicMockConnection</span> + rather than the usual <span class="new_code">MockConnection</span>. + We then inherit from this to get our version of + <span class="new_code">MockConnection</span>. + By intercepting in this way we can add behaviour, here setting + the default value of <span class="new_code">query()</span> to be false. + By using the default name we make sure that the mock class + generator will not recreate a different one when invoked elsewhere in the + tests. + It never creates a class if it already exists. + As long as the above file is included first then all tests + that generated <span class="new_code">MockConnection</span> should + now be using our one instead. + If we don't get the order right and the mock library + creates one first then the class creation will simply fail. + </p> + <p> + Use this trick if you find you have a lot of common mock behaviour + or you are getting frequent integration problems at later + stages of testing. + </p> + + <p> +<a class="target" name="other_testers"> +<h2>I think SimpleTest stinks!</h2> +</a> +</p> + <p> + But at the time of writing it is the only one with mock objects, + so are you stuck with it? + </p> + <p> + No, not at all. + <a href="simple_test.html">SimpleTest</a> is a toolkit and one of those + tools is the mock objects which can be employed independently. + Suppose you have your own favourite unit tester and all your current + test cases are written using it. + Pretend that you have called your unit tester PHPUnit (everyone else has) + and the core test class looks like this... +<pre> +class PHPUnit { + function PHPUnit() { + } + + function assertion($message, $assertion) { + } + ... +} +</pre> + All the <span class="new_code">assertion()</span> method does + is print some fancy output and the boolean assertion parameter determines + whether to print a pass or a failure. + Let's say that it is used like this... +<pre> +$unit_test = new PHPUnit(); +$unit_test>assertion('I hope this file exists', file_exists('my_file')); +</pre> + How do you use mocks with this? + </p> + <p> + There is a protected method on the base mock class + <span class="new_code">SimpleMock</span> called + <span class="new_code">_assertTrue()</span> and + by overriding this method we can use our own assertion format. + We start with a subclass, in say <em>my_mock.php</em>... +<pre> +<strong><?php + require_once('simpletest/mock_objects.php'); + + class MyMock extends SimpleMock() { + function MyMock(&$test, $wildcard) { + $this->SimpleMock($test, $wildcard); + } + + function _assertTrue($assertion, $message) { + $test = &$this->getTest(); + $test->assertion($message, $assertion); + } + } +?></strong> +</pre> + Now instantiating <span class="new_code">MyMock</span> will create + an object that speaks the same language as your tester. + The catch is of course that we never create such an object, the + code generator does. + We need just one more line of code to tell the generator to use + your mock instead... +<pre> +<?php + require_once('simpletst/mock_objects.php'); + + class MyMock extends SimpleMock() { + function MyMock($test, $wildcard) { + $this->SimpleMock(&$test, $wildcard); + } + + function _assertTrue($assertion, $message , &$test) { + $test->assertion($message, $assertion); + } + }<strong> + SimpleTestOptions::setMockBaseClass('MyMock');</strong> +?> +</pre> + From now on you just include <em>my_mock.php</em> instead of the + default <em>mock_objects.php</em> version and you can introduce + mock objects into your existing test suite. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/overview.html b/tests/test_tools/simpletest/docs/en/overview.html index 5047598d..d4965de3 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/overview.html +++ b/tests/test_tools/simpletest/docs/en/overview.html @@ -1,422 +1,422 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<span class="chosen">Overview</span>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Overview of SimpleTest</h1>
-<div class="content">
- <p>
-<a class="target" name="summary">
-<h2>What is SimpleTest?</h2>
-</a>
-</p>
- <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.
- Top level test scripts then invoke the <span class="new_code">run()</span>
- methods on every one of these test cases in order.
- Each test method 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 triggers an alert
- and a description of the mismatch.
- </p>
- <p>
- A <a href="unit_test_documentation.html">test case</a> looks like this...
-<pre>
-<?php
-class <strong>MyTestCase</strong> extends UnitTestCase {
- <strong>
- function testLog() {
- $log = &new Log('my.log');
- $log->message('Hello');
- $this->assertTrue(file_exists('my.log'));
- }</strong>
-}
-?>
-</pre>
- </p>
- <p>
- These tools are designed for the developer.
- Tests are written in the PHP language itself more or less
- as the application itself is built.
- The advantage of using PHP itself 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 if they are in the same 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>
-<?php
-class <strong>MySiteTest</strong> extends WebTestCase {
- <strong>
- function testHomePage() {
- $this->get('http://www.my-site.com/index.php');
- $this->assertTitle('My Home Page');
- $this->clickLink('Contact');
- $this->assertTitle('Contact me');
- $this->assertWantedPattern('/Email me at/');
- }</strong>
-}
-?>
-</pre>
- </p>
-
- <p>
-<a class="target" name="features">
-<h2>Feature list</h2>
-</a>
-</p>
- <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.
- 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 CVS directly.
- A released feature is marked as "Done".
- <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;">Done</td>
- </tr>
- <tr>
- <td>Html display</td>
- <td>Simplest possible display</td>
- <td style="color: green;">Done</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;">Done</td>
- </tr>
- <tr>
- <td>Mock objects code generator</td>
- <td>
- Objects capable of simulating other objects removing
- test dependencies
- </td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Server stubs</td>
- <td>
- Mocks without expectations to be used outside of test cases,
- e.g. for prototyping
- </td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Integration of other unit testers</td>
- <td>
- The ability to read and simulate test cases from PHPUnit
- and PEAR::PhpUnit
- </td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Web test case</td>
- <td>Basic pattern matching of fetched pages</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>HTML parsing of pages</td>
- <td>Allows link following and title tag matching</td>
- <td style="color: green;">Done</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;">Done</td>
- </tr>
- <tr>
- <td>Web cookie handling</td>
- <td>Correct handling of cookies when fetching pages</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Following redirects</td>
- <td>Page fetching automatically follows 300 redirects</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Form parsing</td>
- <td>Ability to submit simple forms and read default form values</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Command line interface</td>
- <td>Test display without the need of a web browser</td>
- <td style="color: green;">Done</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;">Done</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;">Done</td>
- </tr>
- <tr>
- <td>Command line test case</td>
- <td>Allows testing of utilities and file handling</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>PHP Documentor compatibility</td>
- <td>Fully generated class level documentation</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Browser interface</td>
- <td>
- Exposure of lower level web browser interface for more
- detailed test cases
- </td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>HTTP authentication</td>
- <td>
- Fetching protected web pages with basic authentication
- only
- </td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Browser navigation buttons</td>
- <td>Back, forward and retry</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>SSL support</td>
- <td>Can connect to https: pages</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Proxy support</td>
- <td>Can connect via. common proxies</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Frames support</td>
- <td>Handling of frames in web test cases</td>
- <td style="color: green;">Done</td>
- </tr>
- <tr>
- <td>Improved display</td>
- <td>Better web GUI with tree display of test cases</td>
- <td style="color: red;">1.1</td>
- </tr>
- <tr>
- <td>Localisation</td>
- <td>Messages abstracted and code generated from XML</td>
- <td style="color: red;">1.1</td>
- </tr>
- <tr>
- <td>File upload testing</td>
- <td>Can simulate the input type file tag</td>
- <td style="color: red;">1.1</td>
- </tr>
- <tr>
- <td>Mocking interfaces</td>
- <td>Can generate mock objects to interfaces as well as classes</td>
- <td style="color: red;">2.0</td>
- </tr>
- <tr>
- <td>Testing exceptions</td>
- <td>Similar to testing PHP errors</td>
- <td style="color: red;">2.0</td>
- </tr>
- <tr>
- <td>XPath searching of elements</td>
- <td>Can make use of HTML tidy for faster and more flexible content matching</td>
- <td style="color: red;">2.0</td>
- </tr>
- </tbody>
-</table>
- PHP5 migraton will start straight after the version 1.1 series,
- whereupon PHP4 will no longer be supported.
- SimpleTest is currently compatible with PHP5, but will not
- make use of all of the new features until version 2.
- </p>
-
- <p>
-<a class="target" name="resources">
-<h2>Web resources for testing</h2>
-</a>
-</p>
- <p>
- Process is at least as important as tools.
- The type of process that makes the heaviest use of a developer's
- testing tool is of course
- <a href="http://www.extremeprogramming.org/">Extreme Programming</a>.
- This is one of the
- <a href="http://www.agilealliance.com/articles/index">Agile Methodologies</a>
- which combine various practices to "flatten the cost curve" of software development.
- More extreme still is <a href="http://www.testdriven.com/modules/news/">Test Driven Development</a>,
- where you very strictly adhere to the rule of no coding until you have a test.
- If you're more of a planner or believe that experience trumps evolution,
- you may prefer the
- <a href="http://www.therationaledge.com/content/dec_01/f_spiritOfTheRUP_pk.html">RUP</a> approach.
- I haven't tried it, but even I can see that you will need test tools (see figure 9).
- </p>
- <p>
- Most unit testers clone <a href="http://www.junit.org/">JUnit</a> to some degree,
- as far as the interface at least. There is a wealth of information on the
- JUnit site including the
- <a href="http://junit.sourceforge.net/doc/faq/faq.htm">FAQ</a>
- which contains plenty of general advice on testing.
- Once you get bitten by the bug you will certainly appreciate the phrase
- <a href="http://junit.sourceforge.net/doc/testinfected/testing.htm">test infected</a>
- coined by Eric Gamma.
- If you are still reviewing which unit tester to use the main choices
- are <a href="http://phpunit.sourceforge.net/">PHPUnit</a>
- and <a href="http://pear.php.net/manual/en/package.php.phpunit.php">Pear PHP::PHPUnit</a>.
- They currently lack a lot of features found in
- <a href="http://www.lastcraft.com/simple_test.php">SimpleTest</a>, but the PEAR
- version at least has been upgraded for PHP5 and is recommended if you are porting
- existing <a href="http://www.junit.org/">JUnit</a> test cases.
- </p>
- <p>
- Library writers don't seem to ship tests with their code very often
- which is a shame.
- Library code that includes tests can be more safely refactored and
- the test code can act as additional documentation in a fairly standard
- form.
- This can save trawling the source code for clues when problems occour,
- especially when upgrading such a library.
- Libraries using SimpleTest for their unit testing include
- <a href="http://wact.sourceforge.net/">WACT</a> and
- <a href="http://sourceforge.net/projects/htmlsax">PEAR::XML_HTMLSax</a>.
- </p>
- <p>
- There is currently a sad lack of material on mock objects, which is a shame
- as unit testing without them is a lot more work.
- The <a href="http://www.sidewize.com/company/mockobjects.pdf">original mock objects paper</a>
- is very Java focused, but still worth a read.
- As a new technology there are plenty of discussions and debate on how to use mocks,
- often on Wikis such as
- <a href="http://xpdeveloper.com/cgi-bin/oldwiki.cgi?MockObjects">Extreme Tuesday</a>
- or <a href="http://www.mockobjects.com/wiki/MocksObjectsPaper">www.mockobjects.com</a>
- or <a href="http://c2.com/cgi/wiki?MockObject">the original C2 Wiki</a>.
- Injecting mocks into a class is the main area of debate for which this
- <a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">paper on IBM</a>
- makes a good starting point.
- </p>
- <p>
- There are plenty of web testing tools, but most are written in Java and
- tutorials and advice are rather thin on the ground.
- The only hope is to look at the documentation for
- <a href="http://httpunit.sourceforge.net/">HTTPUnit</a>,
- <a href="http://htmlunit.sourceforge.net/">HTMLUnit</a>
- or <a href="http://jwebunit.sourceforge.net/">JWebUnit</a> and hope for clues.
- There are some XML driven test frameworks, but again most
- require Java to run.
- As SimpleTest does not support JavaScript you would probably
- have to look at these tools anyway if you have highly dynamic
- pages.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<span class="chosen">Overview</span> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Overview of SimpleTest</h1> +<div class="content"> + <p> +<a class="target" name="summary"> +<h2>What is SimpleTest?</h2> +</a> +</p> + <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. + Top level test scripts then invoke the <span class="new_code">run()</span> + methods on every one of these test cases in order. + Each test method 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 triggers an alert + and a description of the mismatch. + </p> + <p> + A <a href="unit_test_documentation.html">test case</a> looks like this... +<pre> +<?php +class <strong>MyTestCase</strong> extends UnitTestCase { + <strong> + function testLog() { + $log = &new Log('my.log'); + $log->message('Hello'); + $this->assertTrue(file_exists('my.log')); + }</strong> +} +?> +</pre> + </p> + <p> + These tools are designed for the developer. + Tests are written in the PHP language itself more or less + as the application itself is built. + The advantage of using PHP itself 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 if they are in the same 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> +<?php +class <strong>MySiteTest</strong> extends WebTestCase { + <strong> + function testHomePage() { + $this->get('http://www.my-site.com/index.php'); + $this->assertTitle('My Home Page'); + $this->clickLink('Contact'); + $this->assertTitle('Contact me'); + $this->assertWantedPattern('/Email me at/'); + }</strong> +} +?> +</pre> + </p> + + <p> +<a class="target" name="features"> +<h2>Feature list</h2> +</a> +</p> + <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. + 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 CVS directly. + A released feature is marked as "Done". + <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;">Done</td> + </tr> + <tr> + <td>Html display</td> + <td>Simplest possible display</td> + <td style="color: green;">Done</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;">Done</td> + </tr> + <tr> + <td>Mock objects code generator</td> + <td> + Objects capable of simulating other objects removing + test dependencies + </td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Server stubs</td> + <td> + Mocks without expectations to be used outside of test cases, + e.g. for prototyping + </td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Integration of other unit testers</td> + <td> + The ability to read and simulate test cases from PHPUnit + and PEAR::PhpUnit + </td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Web test case</td> + <td>Basic pattern matching of fetched pages</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>HTML parsing of pages</td> + <td>Allows link following and title tag matching</td> + <td style="color: green;">Done</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;">Done</td> + </tr> + <tr> + <td>Web cookie handling</td> + <td>Correct handling of cookies when fetching pages</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Following redirects</td> + <td>Page fetching automatically follows 300 redirects</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Form parsing</td> + <td>Ability to submit simple forms and read default form values</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Command line interface</td> + <td>Test display without the need of a web browser</td> + <td style="color: green;">Done</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;">Done</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;">Done</td> + </tr> + <tr> + <td>Command line test case</td> + <td>Allows testing of utilities and file handling</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>PHP Documentor compatibility</td> + <td>Fully generated class level documentation</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Browser interface</td> + <td> + Exposure of lower level web browser interface for more + detailed test cases + </td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>HTTP authentication</td> + <td> + Fetching protected web pages with basic authentication + only + </td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Browser navigation buttons</td> + <td>Back, forward and retry</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>SSL support</td> + <td>Can connect to https: pages</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Proxy support</td> + <td>Can connect via. common proxies</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Frames support</td> + <td>Handling of frames in web test cases</td> + <td style="color: green;">Done</td> + </tr> + <tr> + <td>Improved display</td> + <td>Better web GUI with tree display of test cases</td> + <td style="color: red;">1.1</td> + </tr> + <tr> + <td>Localisation</td> + <td>Messages abstracted and code generated from XML</td> + <td style="color: red;">1.1</td> + </tr> + <tr> + <td>File upload testing</td> + <td>Can simulate the input type file tag</td> + <td style="color: red;">1.1</td> + </tr> + <tr> + <td>Mocking interfaces</td> + <td>Can generate mock objects to interfaces as well as classes</td> + <td style="color: red;">2.0</td> + </tr> + <tr> + <td>Testing exceptions</td> + <td>Similar to testing PHP errors</td> + <td style="color: red;">2.0</td> + </tr> + <tr> + <td>XPath searching of elements</td> + <td>Can make use of HTML tidy for faster and more flexible content matching</td> + <td style="color: red;">2.0</td> + </tr> + </tbody> +</table> + PHP5 migraton will start straight after the version 1.1 series, + whereupon PHP4 will no longer be supported. + SimpleTest is currently compatible with PHP5, but will not + make use of all of the new features until version 2. + </p> + + <p> +<a class="target" name="resources"> +<h2>Web resources for testing</h2> +</a> +</p> + <p> + Process is at least as important as tools. + The type of process that makes the heaviest use of a developer's + testing tool is of course + <a href="http://www.extremeprogramming.org/">Extreme Programming</a>. + This is one of the + <a href="http://www.agilealliance.com/articles/index">Agile Methodologies</a> + which combine various practices to "flatten the cost curve" of software development. + More extreme still is <a href="http://www.testdriven.com/modules/news/">Test Driven Development</a>, + where you very strictly adhere to the rule of no coding until you have a test. + If you're more of a planner or believe that experience trumps evolution, + you may prefer the + <a href="http://www.therationaledge.com/content/dec_01/f_spiritOfTheRUP_pk.html">RUP</a> approach. + I haven't tried it, but even I can see that you will need test tools (see figure 9). + </p> + <p> + Most unit testers clone <a href="http://www.junit.org/">JUnit</a> to some degree, + as far as the interface at least. There is a wealth of information on the + JUnit site including the + <a href="http://junit.sourceforge.net/doc/faq/faq.htm">FAQ</a> + which contains plenty of general advice on testing. + Once you get bitten by the bug you will certainly appreciate the phrase + <a href="http://junit.sourceforge.net/doc/testinfected/testing.htm">test infected</a> + coined by Eric Gamma. + If you are still reviewing which unit tester to use the main choices + are <a href="http://phpunit.sourceforge.net/">PHPUnit</a> + and <a href="http://pear.php.net/manual/en/package.php.phpunit.php">Pear PHP::PHPUnit</a>. + They currently lack a lot of features found in + <a href="http://www.lastcraft.com/simple_test.php">SimpleTest</a>, but the PEAR + version at least has been upgraded for PHP5 and is recommended if you are porting + existing <a href="http://www.junit.org/">JUnit</a> test cases. + </p> + <p> + Library writers don't seem to ship tests with their code very often + which is a shame. + Library code that includes tests can be more safely refactored and + the test code can act as additional documentation in a fairly standard + form. + This can save trawling the source code for clues when problems occour, + especially when upgrading such a library. + Libraries using SimpleTest for their unit testing include + <a href="http://wact.sourceforge.net/">WACT</a> and + <a href="http://sourceforge.net/projects/htmlsax">PEAR::XML_HTMLSax</a>. + </p> + <p> + There is currently a sad lack of material on mock objects, which is a shame + as unit testing without them is a lot more work. + The <a href="http://www.sidewize.com/company/mockobjects.pdf">original mock objects paper</a> + is very Java focused, but still worth a read. + As a new technology there are plenty of discussions and debate on how to use mocks, + often on Wikis such as + <a href="http://xpdeveloper.com/cgi-bin/oldwiki.cgi?MockObjects">Extreme Tuesday</a> + or <a href="http://www.mockobjects.com/wiki/MocksObjectsPaper">www.mockobjects.com</a> + or <a href="http://c2.com/cgi/wiki?MockObject">the original C2 Wiki</a>. + Injecting mocks into a class is the main area of debate for which this + <a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">paper on IBM</a> + makes a good starting point. + </p> + <p> + There are plenty of web testing tools, but most are written in Java and + tutorials and advice are rather thin on the ground. + The only hope is to look at the documentation for + <a href="http://httpunit.sourceforge.net/">HTTPUnit</a>, + <a href="http://htmlunit.sourceforge.net/">HTMLUnit</a> + or <a href="http://jwebunit.sourceforge.net/">JWebUnit</a> and hope for clues. + There are some XML driven test frameworks, but again most + require Java to run. + As SimpleTest does not support JavaScript you would probably + have to look at these tools anyway if you have highly dynamic + pages. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/partial_mocks_documentation.html b/tests/test_tools/simpletest/docs/en/partial_mocks_documentation.html index f4a6af00..20749415 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/partial_mocks_documentation.html +++ b/tests/test_tools/simpletest/docs/en/partial_mocks_documentation.html @@ -1,426 +1,426 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<span class="chosen">Partial mocks</span>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Partial mock objects documentation</h1>
-<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>
-
- <p>
-<a class="target" name="inject">
-<h2>The mock injection problem</h2>
-</a>
-</p>
- <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><?php
- require_once('socket.php');
-
- class Telnet {
- ...
- function &connect($ip, $port, $username, $password) {
- $socket = &new Socket($ip, $port);
- $socket->read( ... );
- ...
- }
- }
-?></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>
-<?php
- require_once('socket.php');
-
- class Telnet {
- ...
- <strong>function &connect(&$socket, $username, $password) {
- $socket->read( ... );
- ...
- }</strong>
- }
-?>
-</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($this);
- ...
- $telnet = &new Telnet();
- $telnet->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>
-<?php
- require_once('socket.php');
-
- class Telnet {
- ...<strong>
- function &connect($ip, $port, $username, $password, $socket = false) {
- if (!$socket) {
- $socket = &new Socket($ip, $port);
- }
- $socket->read( ... );</strong>
- ...
- return $socket;
- }
- }
-?>
-</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($this);
- ...
- $telnet = &new Telnet();
- $telnet->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>
-<?php
- require_once('socket.php');
-
- class Telnet {<strong>
- function Telnet(&$network) {
- $this->_network = &$network;
- }</strong>
- ...
- function &connect($ip, $port, $username, $password) {<strong>
- $socket = &$this->_network->createSocket($ip, $port);
- $socket->read( ... );</strong>
- ...
- return $socket;
- }
- }
-?>
-</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($this);
- ...
- $network = &new MockNetwork($this);
- $network->setReturnReference('createSocket', $socket);
- $telnet = &new Telnet($network);
- $telnet->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>
- Is there a middle ground?
- </p>
-
- <p>
-<a class="target" name="creation">
-<h2>Protected factory method</h2>
-</a>
-</p>
- <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>
-<?php
- require_once('socket.php');
-
- class Telnet {
- ...
- function &connect($ip, $port, $username, $password) {<strong>
- $socket = &$this->_createSocket($ip, $port);</strong>
- $socket->read( ... );
- ...
- }<strong>
-
- function &_createSocket($ip, $port) {
- return new Socket($ip, $port);
- }</strong>
- }
-?>
-</pre>
- This is the only change we make to the application code.
- </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->_mock = &$mock;
- $this->Telnet();
- }
-
- function &_createSocket() {
- return $this->_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($this);
- ...
- $telnet = &new TelnetTestVersion($socket);
- $telnet->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>
-
- <p>
-<a class="target" name="partial">
-<h2>A partial mock</h2>
-</a>
-</p>
- <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($this);
- ...
- $telnet = &new TelnetTestVersion($this);
- $telnet->setReturnReference('_createSocket', $socket);
- $telnet->Telnet();
- $telnet->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($this);
- ...
- $telnet = &new TelnetTestVersion($this);
- $telnet->setReturnReference('_createSocket', $socket);<strong>
- $telnet->expectOnce('_createSocket', array('127.0.0.1', 21));</strong>
- $telnet->Telnet();
- $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
- ...<strong>
- $telnet->tally();</strong>
- }
-}
-</pre>
- </p>
-
- <p>
-<a class="target" name="less">
-<h2>Testing less than a class</h2>
-</a>
-</p>
- <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 haven't
- tried it.
- I am open to the possibility, but 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 which mechanism you use.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<span class="chosen">Partial mocks</span> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Partial mock objects documentation</h1> +<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> + + <p> +<a class="target" name="inject"> +<h2>The mock injection problem</h2> +</a> +</p> + <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><?php + require_once('socket.php'); + + class Telnet { + ... + function &connect($ip, $port, $username, $password) { + $socket = &new Socket($ip, $port); + $socket->read( ... ); + ... + } + } +?></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> +<?php + require_once('socket.php'); + + class Telnet { + ... + <strong>function &connect(&$socket, $username, $password) { + $socket->read( ... ); + ... + }</strong> + } +?> +</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($this); + ... + $telnet = &new Telnet(); + $telnet->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> +<?php + require_once('socket.php'); + + class Telnet { + ...<strong> + function &connect($ip, $port, $username, $password, $socket = false) { + if (!$socket) { + $socket = &new Socket($ip, $port); + } + $socket->read( ... );</strong> + ... + return $socket; + } + } +?> +</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($this); + ... + $telnet = &new Telnet(); + $telnet->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> +<?php + require_once('socket.php'); + + class Telnet {<strong> + function Telnet(&$network) { + $this->_network = &$network; + }</strong> + ... + function &connect($ip, $port, $username, $password) {<strong> + $socket = &$this->_network->createSocket($ip, $port); + $socket->read( ... );</strong> + ... + return $socket; + } + } +?> +</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($this); + ... + $network = &new MockNetwork($this); + $network->setReturnReference('createSocket', $socket); + $telnet = &new Telnet($network); + $telnet->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> + Is there a middle ground? + </p> + + <p> +<a class="target" name="creation"> +<h2>Protected factory method</h2> +</a> +</p> + <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> +<?php + require_once('socket.php'); + + class Telnet { + ... + function &connect($ip, $port, $username, $password) {<strong> + $socket = &$this->_createSocket($ip, $port);</strong> + $socket->read( ... ); + ... + }<strong> + + function &_createSocket($ip, $port) { + return new Socket($ip, $port); + }</strong> + } +?> +</pre> + This is the only change we make to the application code. + </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->_mock = &$mock; + $this->Telnet(); + } + + function &_createSocket() { + return $this->_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($this); + ... + $telnet = &new TelnetTestVersion($socket); + $telnet->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> + + <p> +<a class="target" name="partial"> +<h2>A partial mock</h2> +</a> +</p> + <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($this); + ... + $telnet = &new TelnetTestVersion($this); + $telnet->setReturnReference('_createSocket', $socket); + $telnet->Telnet(); + $telnet->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($this); + ... + $telnet = &new TelnetTestVersion($this); + $telnet->setReturnReference('_createSocket', $socket);<strong> + $telnet->expectOnce('_createSocket', array('127.0.0.1', 21));</strong> + $telnet->Telnet(); + $telnet->connect('127.0.0.1', 21, 'Me', 'Secret'); + ...<strong> + $telnet->tally();</strong> + } +} +</pre> + </p> + + <p> +<a class="target" name="less"> +<h2>Testing less than a class</h2> +</a> +</p> + <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 haven't + tried it. + I am open to the possibility, but 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 which mechanism you use. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/reporter_documentation.html b/tests/test_tools/simpletest/docs/en/reporter_documentation.html index 2794c5ab..44be8b1e 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/reporter_documentation.html +++ b/tests/test_tools/simpletest/docs/en/reporter_documentation.html @@ -1,515 +1,515 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<span class="chosen">Reporting</span>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Test reporter documentation</h1>
-<div class="content">
-
- <p>
- SimpleTest pretty much follows the MVC 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>
-
- <p>
-<a class="target" name="html">
-<h2>Reporting results in HTML</h2>
-</a>
-</p>
- <p>
- The default test 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->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 HtmlReporter($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 titles, 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, most deeply nested test, 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 ShowPasses extends HtmlReporter {
-
- function paintPass($message) {
- parent::paintPass($message);
- print "&<span class=\"pass\">Pass</span>: ";
- $breadcrumb = $this->getTestList();
- array_shift($breadcrumb);
- print implode("-&gt;", $breadcrumb);
- print "-&gt;$message<br />\n";
- }
-
- 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>
-
- <p>
-<a class="target" name="other">
-<h2>Extending the reporter</h2>
-</a>
-</p>
- <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/simple_test.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>
- }
-}
-</pre>
- No output would come from this class until you add it.
- </p>
-
- <p>
-<a class="target" name="cli">
-<h2>The command line reporter</h2>
-</a>
-</p>
- <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 simply substitute it
- for the HTML version...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('File test');
- $test->addTestFile('tests/file_test.php');
- $test->run(<strong>new TextReporter()</strong>);
-?>
-</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, 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, 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>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('File test');
- $test->addTestFile('tests/file_test.php');
- <strong>exit ($test->run(new TextReporter()) ? 0 : 1);</strong>
-?>
-</pre>
- Of course we don'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>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('File test');
- $test->addTestFile('tests/file_test.php');
- <strong>if (TextReporter::inCli()) {</strong>
- exit ($test->run(new TextReporter()) ? 0 : 1);
- <strong>}</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- This is the form used within SimpleTest itself.
- </p>
-
- <p>
-<a class="target" name="xml">
-<h2>Remote testing</h2>
-</a>
-</p>
- <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">
-<?xml version="1.0"?>
-<run>
- <group size="4">
- <name>Remote tests</name>
- <group size="4">
- <name>Visual test with 48 passes, 48 fails and 4 exceptions</name>
- <case>
- <name>testofunittestcaseoutput</name>
- <test>
- <name>testofresults</name>
- <pass>This assertion passed</pass>
- <fail>This assertion failed</fail>
- </test>
- <test>
- ...
- </test>
- </case>
- </group>
- </group>
-</run>
-</pre>
- You can make use of 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>
-<?php
- require_once('simpletest/xml.php');
-
- ...
- $parser = &new SimpleTestXmlParser(new HtmlReporter());
- $parser->parse($test_output);
-?>
-</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>
- A problem with large test suites is thet they can exhaust
- the default 8Mb 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>
-<?php
- <strong>require_once('../remote.php');</strong>
- require_once('../reporter.php');
-
- $test_url = ...;
- $dry_url = ...;
-
- $test = &new GroupTest('Remote tests');
- $test->addTestCase(<strong>new RemoteTestCase($test_url, $dry_url)</strong>);
- $test->run(new HtmlReporter());
-?>
-</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 group test.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<span class="chosen">Reporting</span> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Test reporter documentation</h1> +<div class="content"> + + <p> + SimpleTest pretty much follows the MVC 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> + + <p> +<a class="target" name="html"> +<h2>Reporting results in HTML</h2> +</a> +</p> + <p> + The default test 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->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 HtmlReporter($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 titles, 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, most deeply nested test, 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 ShowPasses extends HtmlReporter { + + function paintPass($message) { + parent::paintPass($message); + print "&<span class=\"pass\">Pass</span>: "; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print implode("-&gt;", $breadcrumb); + print "-&gt;$message<br />\n"; + } + + 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> + + <p> +<a class="target" name="other"> +<h2>Extending the reporter</h2> +</a> +</p> + <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/simple_test.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> + } +} +</pre> + No output would come from this class until you add it. + </p> + + <p> +<a class="target" name="cli"> +<h2>The command line reporter</h2> +</a> +</p> + <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 simply substitute it + for the HTML version... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('File test'); + $test->addTestFile('tests/file_test.php'); + $test->run(<strong>new TextReporter()</strong>); +?> +</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, 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, 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> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('File test'); + $test->addTestFile('tests/file_test.php'); + <strong>exit ($test->run(new TextReporter()) ? 0 : 1);</strong> +?> +</pre> + Of course we don'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> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('File test'); + $test->addTestFile('tests/file_test.php'); + <strong>if (TextReporter::inCli()) {</strong> + exit ($test->run(new TextReporter()) ? 0 : 1); + <strong>}</strong> + $test->run(new HtmlReporter()); +?> +</pre> + This is the form used within SimpleTest itself. + </p> + + <p> +<a class="target" name="xml"> +<h2>Remote testing</h2> +</a> +</p> + <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"> +<?xml version="1.0"?> +<run> + <group size="4"> + <name>Remote tests</name> + <group size="4"> + <name>Visual test with 48 passes, 48 fails and 4 exceptions</name> + <case> + <name>testofunittestcaseoutput</name> + <test> + <name>testofresults</name> + <pass>This assertion passed</pass> + <fail>This assertion failed</fail> + </test> + <test> + ... + </test> + </case> + </group> + </group> +</run> +</pre> + You can make use of 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> +<?php + require_once('simpletest/xml.php'); + + ... + $parser = &new SimpleTestXmlParser(new HtmlReporter()); + $parser->parse($test_output); +?> +</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> + A problem with large test suites is thet they can exhaust + the default 8Mb 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> +<?php + <strong>require_once('../remote.php');</strong> + require_once('../reporter.php'); + + $test_url = ...; + $dry_url = ...; + + $test = &new GroupTest('Remote tests'); + $test->addTestCase(<strong>new RemoteTestCase($test_url, $dry_url)</strong>); + $test->run(new HtmlReporter()); +?> +</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 group test. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/server_stubs_documentation.html b/tests/test_tools/simpletest/docs/en/server_stubs_documentation.html index 445ba63e..4b18bb0b 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/server_stubs_documentation.html +++ b/tests/test_tools/simpletest/docs/en/server_stubs_documentation.html @@ -1,388 +1,388 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>SimpleTest for PHP server stubs documentation</title>
-<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
-</head>
-<body>
-<div class="menu_back">
-<div class="menu">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<span class="chosen">Server stubs</span>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Server stubs documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="what">
-<h2>What are server stubs?</h2>
-</a>
-</p>
- <p>
- This was originally a pattern named by Robert Binder (Testing
- object-oriented systems: models, patterns, and tools,
- Addison-Wesley) in 1999.
- 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>
-<a class="target" name="creation">
-<h2>Creating server stubs</h2>
-</a>
-</p>
- <p>
- All we need is an existing class, say a database connection
- that looks like this...
-<pre>
-<strong>class DatabaseConnection {
- function DatabaseConnection() {
- }
-
- function query() {
- }
-
- function selectQuery() {
- }
-}</strong>
-</pre>
- The class does not need to have been implemented yet.
- To create a stub version of the class we need to include the
- server stub library and run the generator...
-<pre>
-<strong>require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-Stub::generate('DatabaseConnection');</strong>
-</pre>
- This generates a clone class called
- <span class="new_code">StubDatabaseConnection</span>.
- We can now create instances of the new class within
- our prototype script...
-<pre>
-require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-Stub::generate('DatabaseConnection');
-<strong>
-$connection = new StubDatabaseConnection();
-</strong>
-</pre>
- The stub version of a class has all the methods of the original
- so that operations like
- <span class="new_code">$connection->query()</span> are still
- legal.
- The return value will be <span class="new_code">null</span>,
- but we can change that with...
-<pre>
-<strong>$connection->setReturnValue('query', 37)</strong>
-</pre>
- Now every time we call
- <span class="new_code">$connection->query()</span> we get
- the result of 37.
- We can set the return value to anything, say a hash of
- imaginary database results or a list of persistent objects.
- 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>
-<a class="target" name="patterns">
-<h2>Simulation patterns</h2>
-</a>
-</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>
-<strong>Stub::generate('Iterator');
-
-$iterator = new StubIterator();
-$iterator->setReturnValue('next', false);
-$iterator->setReturnValueAt(0, 'next', 'First string');
-$iterator->setReturnValueAt(1, 'next', 'Second string');</strong>
-</pre>
- When <span class="new_code">next()</span> is called on the
- stub iterator 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 getValue($key) {
- }
-}
-</pre>
- This is a classic situation for using stub objects as
- actual configuration will vary from machine to machine,
- hardly helping the reliability of our tests if we use it
- directly.
- The problem though is that all the data comes through the
- <span class="new_code">getValue()</span> method and yet
- we want different results for different keys.
- Luckily the stubs have a filter system...
-<pre>
-<strong>Stub::generate('Configuration');
-
-$config = &new StubConfiguration();
-$config->setReturnValue('getValue', 'primary', array('db_host'));
-$config->setReturnValue('getValue', 'admin', array('db_user'));
-$config->setReturnValue('getValue', '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 server stub has the
- <span class="new_code">getValue()</span> method invoked
- like this...
-<pre>
-$config->getValue('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->setReturnValue('getValue', false, array('*'));</strong>
-</pre>
- This is not the same as setting the return value without
- any argument requirements like this...
-<pre>
-<strong>
-$config->setReturnValue('getValue', 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 object to be
- dished out by the stub rather than just a copy.
- The PHP copy semantics force us to use a different method
- for this.
- You might be simulating a container for example...
-<pre>
-class Thing {
-}
-
-class Vector {
- function Vector() {
- }
-
- function get($index) {
- }
-}
-</pre>
- In this case you can set a reference into the stub's
- return list...
-<pre>
-Stub::generate('Vector');
-
-$thing = new Thing();<strong>
-$vector = &new StubVector();
-$vector->setReturnReference('get', $thing, array(12));</strong>
-</pre>
- With this arrangement you know that every time
- <span class="new_code">$vector->get(12)</span> is
- called it will return the same
- <span class="new_code">$thing</span> each time.
- </p>
- <p>
- These three factors, timing, parameters and whether to copy,
- can be combined orthogonally.
- For example...
-<pre>
-$complex = &new StubComplexThing();
-$stuff = new Stuff();<strong>
-$complex->setReturnReferenceAt(3, 'get', $stuff, array('*', 1));</strong>
-</pre>
- This will return the <span class="new_code">$stuff</span> only on the third
- call and only if two parameters were set the second of
- which must be the integer 1.
- That should cover most simple prototyping 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 <span class="new_code">next()</span> giving
- one row until false.
- This sounds like a simulation nightmare, but in fact it can all
- be stubbed using the mechanics above.
- </p>
- <p>
- Here's how...
-<pre>
-Stub::generate('DatabaseConnection');
-Stub::generate('ResultIterator');
-
-class DatabaseTest extends UnitTestCase {
-
- function testUserFinder() {<strong>
- $result = &new StubResultIterator();
- $result->setReturnValue('next', false);
- $result->setReturnValueAt(0, 'next', array(1, 'tom'));
- $result->setReturnValueAt(1, 'next', array(3, 'dick'));
- $result->setReturnValueAt(2, 'next', array(6, 'harry'));
-
- $connection = &new StubDatabaseConnection();
- $connection->setReturnValue('query', false);
- $connection->setReturnReference(
- 'query',
- $result,
- array('select id, name from users'));</strong>
-
- $finder = &new UserFinder($connection);
- $this->assertIdentical(
- $finder->findNames(),
- array('tom', 'dick', 'harry'));
- }
-}
-</pre>
- Now only if our
- <span class="new_code">$connection</span> is called with the correct
- <span class="new_code">query()</span> 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>
-<a class="target" name="options">
-<h2>Stub creation options</h2>
-</a>
-</p>
- <p>
- There are some additional options when creating stubs.
- At the generation stage we can change the class name...
-<pre>
-<strong>Stub::generate('Iterator', 'MyStubIterator');
-$iterator = &new MyStubIterator();
-</strong>
-</pre>
- This is not very useful in itself as there would be no difference
- in this class and the default except for the name.
- However we can also add additional methods not found in the
- original interface...
-<pre>
-class Iterator {
-}
-<strong>Stub::generate('Iterator', 'PrototypeIterator', array('next', 'isError'));
-$iterator = &new PrototypeIterator();
-$iterator->setReturnValue('next', 0);
-</strong>
-</pre>
- The <span class="new_code">next()</span> and
- <span class="new_code">isError()</span> methods can now have
- return values set just as if they existed in the original class.
- </p>
- <p>
- One other esoteric way of customising the stubs is to change
- the default wildcard used for parameter matching.
-<pre>
-<strong>Stub::generate('Connection');
-$iterator = &new StubConnection('wild');
-$iterator->setReturnValue('query', array('id' => 33), array('wild'));
-</strong>
-</pre>
- The only reason to do this is if you genuinely wanted to test
- against the literal string "*" and didn't want it
- interpreted as "any".
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SimpleTest for PHP server stubs documentation</title> +<link rel="stylesheet" type="text/css" href="docs.css" title="Styles"> +</head> +<body> +<div class="menu_back"> +<div class="menu"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<span class="chosen">Server stubs</span> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Server stubs documentation</h1> +<div class="content"> + <p> +<a class="target" name="what"> +<h2>What are server stubs?</h2> +</a> +</p> + <p> + This was originally a pattern named by Robert Binder (Testing + object-oriented systems: models, patterns, and tools, + Addison-Wesley) in 1999. + 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> +<a class="target" name="creation"> +<h2>Creating server stubs</h2> +</a> +</p> + <p> + All we need is an existing class, say a database connection + that looks like this... +<pre> +<strong>class DatabaseConnection { + function DatabaseConnection() { + } + + function query() { + } + + function selectQuery() { + } +}</strong> +</pre> + The class does not need to have been implemented yet. + To create a stub version of the class we need to include the + server stub library and run the generator... +<pre> +<strong>require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); +Stub::generate('DatabaseConnection');</strong> +</pre> + This generates a clone class called + <span class="new_code">StubDatabaseConnection</span>. + We can now create instances of the new class within + our prototype script... +<pre> +require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); +Stub::generate('DatabaseConnection'); +<strong> +$connection = new StubDatabaseConnection(); +</strong> +</pre> + The stub version of a class has all the methods of the original + so that operations like + <span class="new_code">$connection->query()</span> are still + legal. + The return value will be <span class="new_code">null</span>, + but we can change that with... +<pre> +<strong>$connection->setReturnValue('query', 37)</strong> +</pre> + Now every time we call + <span class="new_code">$connection->query()</span> we get + the result of 37. + We can set the return value to anything, say a hash of + imaginary database results or a list of persistent objects. + 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> +<a class="target" name="patterns"> +<h2>Simulation patterns</h2> +</a> +</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> +<strong>Stub::generate('Iterator'); + +$iterator = new StubIterator(); +$iterator->setReturnValue('next', false); +$iterator->setReturnValueAt(0, 'next', 'First string'); +$iterator->setReturnValueAt(1, 'next', 'Second string');</strong> +</pre> + When <span class="new_code">next()</span> is called on the + stub iterator 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 getValue($key) { + } +} +</pre> + This is a classic situation for using stub objects as + actual configuration will vary from machine to machine, + hardly helping the reliability of our tests if we use it + directly. + The problem though is that all the data comes through the + <span class="new_code">getValue()</span> method and yet + we want different results for different keys. + Luckily the stubs have a filter system... +<pre> +<strong>Stub::generate('Configuration'); + +$config = &new StubConfiguration(); +$config->setReturnValue('getValue', 'primary', array('db_host')); +$config->setReturnValue('getValue', 'admin', array('db_user')); +$config->setReturnValue('getValue', '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 server stub has the + <span class="new_code">getValue()</span> method invoked + like this... +<pre> +$config->getValue('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->setReturnValue('getValue', false, array('*'));</strong> +</pre> + This is not the same as setting the return value without + any argument requirements like this... +<pre> +<strong> +$config->setReturnValue('getValue', 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 object to be + dished out by the stub rather than just a copy. + The PHP copy semantics force us to use a different method + for this. + You might be simulating a container for example... +<pre> +class Thing { +} + +class Vector { + function Vector() { + } + + function get($index) { + } +} +</pre> + In this case you can set a reference into the stub's + return list... +<pre> +Stub::generate('Vector'); + +$thing = new Thing();<strong> +$vector = &new StubVector(); +$vector->setReturnReference('get', $thing, array(12));</strong> +</pre> + With this arrangement you know that every time + <span class="new_code">$vector->get(12)</span> is + called it will return the same + <span class="new_code">$thing</span> each time. + </p> + <p> + These three factors, timing, parameters and whether to copy, + can be combined orthogonally. + For example... +<pre> +$complex = &new StubComplexThing(); +$stuff = new Stuff();<strong> +$complex->setReturnReferenceAt(3, 'get', $stuff, array('*', 1));</strong> +</pre> + This will return the <span class="new_code">$stuff</span> only on the third + call and only if two parameters were set the second of + which must be the integer 1. + That should cover most simple prototyping 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 <span class="new_code">next()</span> giving + one row until false. + This sounds like a simulation nightmare, but in fact it can all + be stubbed using the mechanics above. + </p> + <p> + Here's how... +<pre> +Stub::generate('DatabaseConnection'); +Stub::generate('ResultIterator'); + +class DatabaseTest extends UnitTestCase { + + function testUserFinder() {<strong> + $result = &new StubResultIterator(); + $result->setReturnValue('next', false); + $result->setReturnValueAt(0, 'next', array(1, 'tom')); + $result->setReturnValueAt(1, 'next', array(3, 'dick')); + $result->setReturnValueAt(2, 'next', array(6, 'harry')); + + $connection = &new StubDatabaseConnection(); + $connection->setReturnValue('query', false); + $connection->setReturnReference( + 'query', + $result, + array('select id, name from users'));</strong> + + $finder = &new UserFinder($connection); + $this->assertIdentical( + $finder->findNames(), + array('tom', 'dick', 'harry')); + } +} +</pre> + Now only if our + <span class="new_code">$connection</span> is called with the correct + <span class="new_code">query()</span> 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> +<a class="target" name="options"> +<h2>Stub creation options</h2> +</a> +</p> + <p> + There are some additional options when creating stubs. + At the generation stage we can change the class name... +<pre> +<strong>Stub::generate('Iterator', 'MyStubIterator'); +$iterator = &new MyStubIterator(); +</strong> +</pre> + This is not very useful in itself as there would be no difference + in this class and the default except for the name. + However we can also add additional methods not found in the + original interface... +<pre> +class Iterator { +} +<strong>Stub::generate('Iterator', 'PrototypeIterator', array('next', 'isError')); +$iterator = &new PrototypeIterator(); +$iterator->setReturnValue('next', 0); +</strong> +</pre> + The <span class="new_code">next()</span> and + <span class="new_code">isError()</span> methods can now have + return values set just as if they existed in the original class. + </p> + <p> + One other esoteric way of customising the stubs is to change + the default wildcard used for parameter matching. +<pre> +<strong>Stub::generate('Connection'); +$iterator = &new StubConnection('wild'); +$iterator->setReturnValue('query', array('id' => 33), array('wild')); +</strong> +</pre> + The only reason to do this is if you genuinely wanted to test + against the literal string "*" and didn't want it + interpreted as "any". + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/unit_test_documentation.html b/tests/test_tools/simpletest/docs/en/unit_test_documentation.html index ddc2f0f0..6aa8d8a7 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/unit_test_documentation.html +++ b/tests/test_tools/simpletest/docs/en/unit_test_documentation.html @@ -1,387 +1,387 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<span class="chosen">Unit tester</span>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>PHP Unit Test documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="unit">
-<h2>Unit test cases</h2>
-</a>
-</p>
- <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>
- If no test name is supplied when chaining the constructor then
- the class name will be taken instead.
- This will be the name displayed in the test results.
- </p>
- <p>
- 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.
- For example...
-<pre>
-require_once('../classes/writer.php');
-
-class FileTestCase extends UnitTestCase {
- function FileTestCase() {
- $this->UnitTestCase('File test');
- }<strong>
-
- function setUp() {
- @unlink('../temp/test.txt');
- }
-
- function tearDown() {
- @unlink('../temp/test.txt');
- }
-
- function testCreation() {
- $writer = &new FileWriter('../temp/test.txt');
- $writer->write('Hello');
- $this->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 inteference 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">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">assertCopy($x, $y)</span></td><td>Fail if $x and $y are the same variable</td>
-</tr>
- <tr>
-<td><span class="new_code">assertWantedPattern($p, $x)</span></td><td>Fail unless the regex $p matches $x</td>
-</tr>
- <tr>
-<td><span class="new_code">assertNoUnwantedPattern($p, $x)</span></td><td>Fail if the regex $p matches $x</td>
-</tr>
- <tr>
-<td><span class="new_code">assertNoErrors()</span></td><td>Fail if any PHP error occoured</td>
-</tr>
- <tr>
-<td><span class="new_code">assertError($x)</span></td><td>Fail if no PHP error or incorrect message</td>
-</tr>
- <tr>
-<td><span class="new_code">assertErrorPattern($p)</span></td><td>Fail unless the error matches the regex $p</td>
-</tr>
- </tbody>
-</table>
- All assertion methods can take an optional description 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>
-<strong>$variable = null;
-$this->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->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.
- This also allows us to nest test messages.
-<pre>
-<strong>$a = 1;
-$b = $a;
-$this->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->assertWantedPattern('/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>trigger_error('Disaster');
-trigger_error('Catastrophe');
-$this->assertError();
-$this->assertError('Catastrophe');
-$this->assertNoErrors();</strong>
-</pre>
- This one takes some explanation as in fact they all pass!
- </p>
- <p>
- PHP errors in SimpleTest are trapped and placed in a queue.
- Here the first error check catches the "Disaster"
- message without checking the text and passes.
- This removes the error from the queue.
- The next error check tests not only the existence of the error,
- but also the text which here matches so another pass.
- With the queue now empty the last test will pass as well.
- If any unchecked errors are left at the end of a test method then
- an exception will be reported in the test.
- 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">sendMessage()</span></td><td>Sends a status message to those displays that support it</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>
- <tr>
-<td><span class="new_code">swallowErrors()</span></td><td>Clears the error queue</td>
-</tr>
- </tbody>
-</table>
- </p>
-
- <p>
-<a class="target" name="extending_unit">
-<h2>Extending test cases</h2>
-</a>
-</p>
- <p>
- Of course additional test methods can be added to create
- specific types of test case too so as to extend framework...
-<pre>
-require_once('simpletest/unit_tester.php');
-<strong>
-class FileTester extends UnitTestCase {
- function FileTester($name = false) {
- $this->UnitTestCase($name);
- }
-
- function assertFileExists($filename, $message = '%s') {
- $this->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>
- 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 = &new FileWriter('../temp/test.txt');
- $writer->write('Hello');<strong>
- $this->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 <span class="new_code">assertTrue()</span>,
- 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>
-
- <p>
-<a class="target" name="running_unit">
-<h2>Running a single test case</h2>
-</a>
-</p>
- <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.
- Here is the scaffolding needed to run the a lone test case...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');<strong>
- require_once('simpletest/reporter.php');</strong>
- require_once('../classes/writer.php');
-
- class FileTestCase extends UnitTestCase {
- function FileTestCase() {
- $this->UnitTestCase('File test');
- }
- }<strong>
-
- $test = &new FileTestCase();
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- This script will run as is, but will output zero passes
- and zero failures until test methods are added.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<span class="chosen">Unit tester</span> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>PHP Unit Test documentation</h1> +<div class="content"> + <p> +<a class="target" name="unit"> +<h2>Unit test cases</h2> +</a> +</p> + <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> + If no test name is supplied when chaining the constructor then + the class name will be taken instead. + This will be the name displayed in the test results. + </p> + <p> + 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. + For example... +<pre> +require_once('../classes/writer.php'); + +class FileTestCase extends UnitTestCase { + function FileTestCase() { + $this->UnitTestCase('File test'); + }<strong> + + function setUp() { + @unlink('../temp/test.txt'); + } + + function tearDown() { + @unlink('../temp/test.txt'); + } + + function testCreation() { + $writer = &new FileWriter('../temp/test.txt'); + $writer->write('Hello'); + $this->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 inteference 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">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">assertCopy($x, $y)</span></td><td>Fail if $x and $y are the same variable</td> +</tr> + <tr> +<td><span class="new_code">assertWantedPattern($p, $x)</span></td><td>Fail unless the regex $p matches $x</td> +</tr> + <tr> +<td><span class="new_code">assertNoUnwantedPattern($p, $x)</span></td><td>Fail if the regex $p matches $x</td> +</tr> + <tr> +<td><span class="new_code">assertNoErrors()</span></td><td>Fail if any PHP error occoured</td> +</tr> + <tr> +<td><span class="new_code">assertError($x)</span></td><td>Fail if no PHP error or incorrect message</td> +</tr> + <tr> +<td><span class="new_code">assertErrorPattern($p)</span></td><td>Fail unless the error matches the regex $p</td> +</tr> + </tbody> +</table> + All assertion methods can take an optional description 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> +<strong>$variable = null; +$this->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->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. + This also allows us to nest test messages. +<pre> +<strong>$a = 1; +$b = $a; +$this->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->assertWantedPattern('/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>trigger_error('Disaster'); +trigger_error('Catastrophe'); +$this->assertError(); +$this->assertError('Catastrophe'); +$this->assertNoErrors();</strong> +</pre> + This one takes some explanation as in fact they all pass! + </p> + <p> + PHP errors in SimpleTest are trapped and placed in a queue. + Here the first error check catches the "Disaster" + message without checking the text and passes. + This removes the error from the queue. + The next error check tests not only the existence of the error, + but also the text which here matches so another pass. + With the queue now empty the last test will pass as well. + If any unchecked errors are left at the end of a test method then + an exception will be reported in the test. + 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">sendMessage()</span></td><td>Sends a status message to those displays that support it</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> + <tr> +<td><span class="new_code">swallowErrors()</span></td><td>Clears the error queue</td> +</tr> + </tbody> +</table> + </p> + + <p> +<a class="target" name="extending_unit"> +<h2>Extending test cases</h2> +</a> +</p> + <p> + Of course additional test methods can be added to create + specific types of test case too so as to extend framework... +<pre> +require_once('simpletest/unit_tester.php'); +<strong> +class FileTester extends UnitTestCase { + function FileTester($name = false) { + $this->UnitTestCase($name); + } + + function assertFileExists($filename, $message = '%s') { + $this->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> + 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 = &new FileWriter('../temp/test.txt'); + $writer->write('Hello');<strong> + $this->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 <span class="new_code">assertTrue()</span>, + 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> + + <p> +<a class="target" name="running_unit"> +<h2>Running a single test case</h2> +</a> +</p> + <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. + Here is the scaffolding needed to run the a lone test case... +<pre> +<?php + require_once('simpletest/unit_tester.php');<strong> + require_once('simpletest/reporter.php');</strong> + require_once('../classes/writer.php'); + + class FileTestCase extends UnitTestCase { + function FileTestCase() { + $this->UnitTestCase('File test'); + } + }<strong> + + $test = &new FileTestCase(); + $test->run(new HtmlReporter());</strong> +?> +</pre> + This script will run as is, but will output zero passes + and zero failures until test methods are added. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/en/web_tester_documentation.html b/tests/test_tools/simpletest/docs/en/web_tester_documentation.html index 0ad5303c..51f604be 100644..100755 --- a/tests/UnitTests/simpletest/docs/en/web_tester_documentation.html +++ b/tests/test_tools/simpletest/docs/en/web_tester_documentation.html @@ -1,508 +1,508 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Simple Test 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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<span class="chosen">Web tester</span>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Web tester documentation</h1>
-<div class="content">
- <p>
-<a class="target" name="fetch">
-<h2>Fetching a page</h2>
-</a>
-</p>
- <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>
-<?php<strong>
- require_once('simpletest/web_tester.php');</strong>
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('Web site tests');<strong>
- $test->addTestFile('lastcraft_test.php');</strong>
- exit ($test->run(new TextReporter()) ? 0 : 1);
-?>
-</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->assertTrue($this->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>
-
- <p>
-<a class="target" name="content">
-<h2>Testing page content</h2>
-</a>
-</p>
- <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->get('http://www.lastcraft.com/');
- $this->assertWantedPattern('/why the last craft/i');</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">assertWantedPattern($pattern)</span></td><td>A Perl pattern match against the page content</td>
-</tr>
- <tr>
-<td><span class="new_code">assertNoUnwantedPattern($pattern)</span></td><td>A Perl pattern match to not find content</td>
-</tr>
- <tr>
-<td><span class="new_code">assertWantedText($text)</span></td><td>Pass if matches visible and "alt" text</td>
-</tr>
- <tr>
-<td><span class="new_code">assertNoUnwantedText($text)</span></td><td>Pass if doesn't match visible and "alt" text</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">assertNoUnwantedHeader($header)</span></td><td>Pass if a header was not fetched</td>
-</tr>
- <tr>
-<td><span class="new_code">assertHeaderPattern($header, $pattern)</span></td><td>Pass if a header was fetched matching this Perl regex</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->assertTitle('The Last Craft? Web developer tutorials on PHP, Extreme programming and Object Oriented development');</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->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->get('http://www.lastcraft.com/test/redirect.php');
- $this->assertResponse(200);</strong>
- }
-}
-</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->setMaximumRedirects(0);</strong>
- $this->get('http://www.lastcraft.com/test/redirect.php');
- $this->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->setMaximumRedirects(0);
- $this->get('http://www.lastcraft.com/test/redirect.php');
- $this->assertResponse(<strong>array(301, 302, 303, 307)</strong>);
- }
-}
-</pre>
- This now passes.
- </p>
-
- <p>
-<a class="target" name="navigation">
-<h2>Navigating a web site</h2>
-</a>
-</p>
- <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->get('http://www.lastcraft.com/');<strong>
- $this->clickLink('About');
- $this->assertTitle('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> should be used
- with the button title...
-<pre>
-<strong>$this->clickSubmit('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>
-
- <p>
-<a class="target" name="request">
-<h2>Modifying the request</h2>
-</a>
-</p>
- <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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Simple Test 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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<span class="chosen">Web tester</span> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Web tester documentation</h1> +<div class="content"> + <p> +<a class="target" name="fetch"> +<h2>Fetching a page</h2> +</a> +</p> + <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> +<?php<strong> + require_once('simpletest/web_tester.php');</strong> + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('Web site tests');<strong> + $test->addTestFile('lastcraft_test.php');</strong> + exit ($test->run(new TextReporter()) ? 0 : 1); +?> +</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->assertTrue($this->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> + + <p> +<a class="target" name="content"> +<h2>Testing page content</h2> +</a> +</p> + <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->get('http://www.lastcraft.com/'); + $this->assertWantedPattern('/why the last craft/i');</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">assertWantedPattern($pattern)</span></td><td>A Perl pattern match against the page content</td> +</tr> + <tr> +<td><span class="new_code">assertNoUnwantedPattern($pattern)</span></td><td>A Perl pattern match to not find content</td> +</tr> + <tr> +<td><span class="new_code">assertWantedText($text)</span></td><td>Pass if matches visible and "alt" text</td> +</tr> + <tr> +<td><span class="new_code">assertNoUnwantedText($text)</span></td><td>Pass if doesn't match visible and "alt" text</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">assertNoUnwantedHeader($header)</span></td><td>Pass if a header was not fetched</td> +</tr> + <tr> +<td><span class="new_code">assertHeaderPattern($header, $pattern)</span></td><td>Pass if a header was fetched matching this Perl regex</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->assertTitle('The Last Craft? Web developer tutorials on PHP, Extreme programming and Object Oriented development');</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->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->get('http://www.lastcraft.com/test/redirect.php'); + $this->assertResponse(200);</strong> + } +} +</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->setMaximumRedirects(0);</strong> + $this->get('http://www.lastcraft.com/test/redirect.php'); + $this->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->setMaximumRedirects(0); + $this->get('http://www.lastcraft.com/test/redirect.php'); + $this->assertResponse(<strong>array(301, 302, 303, 307)</strong>); + } +} +</pre> + This now passes. + </p> + + <p> +<a class="target" name="navigation"> +<h2>Navigating a web site</h2> +</a> +</p> + <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->get('http://www.lastcraft.com/');<strong> + $this->clickLink('About'); + $this->assertTitle('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> should be used + with the button title... +<pre> +<strong>$this->clickSubmit('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> + + <p> +<a class="target" name="request"> +<h2>Modifying the request</h2> +</a> +</p> + <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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/authentication_documentation.html b/tests/test_tools/simpletest/docs/fr/authentication_documentation.html index 39e21421..08cc2349 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/authentication_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/authentication_documentation.html @@ -1,264 +1,264 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur l'authentification</h1>
-<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>
-
- <p>
-<a class="target" name="basique">
-<h2>Authentification HTTP basique</h2>
-</a>
-</p>
- <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->get('http://www.lastcraft.com/protected/');
- $this->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->get('http://www.lastcraft.com/protected/');<strong>
- $this->assertAuthentication('Basic');
- $this->assertResponse(401);
- $this->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>
- 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->get('http://www.lastcraft.com/protected/');<strong>
- $this->authenticate('Me', 'Secret');</strong>
- $this->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.
- </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->get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/');
- $this->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>
- 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>
-
- <p>
-<a class="target" name="cookies">
-<h2>Cookies</h2>
-</a>
-</p>
- <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>
-<form>
- Username:
- <input type="text" name="u" value="" /><br />
- Password:
- <input type="password" name="p" value="" /><br />
- <input type="submit" value="Log in" />
-</form>
-</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->get('http://www.my-site.com/login.php');<strong>
- $this->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 vaut pas la peine d'être testée.
- </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->get('http://www.my-site.com/login.php');<strong>
- $session = $this->getCookie('SID');
- $this->setField('u', 'Me');
- $this->setField('p', 'Secret');
- $this->clickSubmit('Log in');
- $this->assertWantedPattern('/Welcome Me/');
- $this->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->get('http://www.my-site.com/login.php');<strong>
- $this->setCookie('SID', 'Some other session');
- $this->get('http://www.my-site.com/restricted.php');</strong>
- $this->assertWantedPattern('/Access denied/');
- }
-}
-</pre>
- Votre site est-il protégé contre ce type d'attaque ?
- </p>
-
- <p>
-<a class="target" name="session">
-<h2>Sessions de navigateur</h2>
-</a>
-</p>
- <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->get('http://www.my-site.com/login.php');
- $this->setField('u', 'Me');
- $this->setField('p', 'Secret');
- $this->clickSubmit('Log in');
- $this->assertWantedPattern('/Welcome Me/');<strong>
-
- $this->restart();
- $this->get('http://www.my-site.com/restricted.php');
- $this->assertWantedPattern('/Access denied/');</strong>
- }
-}
-</pre>
- La méthode <span class="new_code">WebTestCase::restart()</span> préserve les cookies dont le timeout a expiré, mais conserve 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->get('http://www.my-site.com/login.php');
- $this->setField('u', 'Me');
- $this->setField('p', 'Secret');
- $this->clickSubmit('Log in');
- $this->assertWantedPattern('/Welcome Me/');
- <strong>
- $this->ageCookies(3600);</strong>
- $this->restart();
- $this->get('http://www.my-site.com/restricted.php');
- $this->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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur l'authentification</h1> +<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> + + <p> +<a class="target" name="basique"> +<h2>Authentification HTTP basique</h2> +</a> +</p> + <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->get('http://www.lastcraft.com/protected/'); + $this->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->get('http://www.lastcraft.com/protected/');<strong> + $this->assertAuthentication('Basic'); + $this->assertResponse(401); + $this->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> + 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->get('http://www.lastcraft.com/protected/');<strong> + $this->authenticate('Me', 'Secret');</strong> + $this->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. + </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->get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/'); + $this->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> + 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> + + <p> +<a class="target" name="cookies"> +<h2>Cookies</h2> +</a> +</p> + <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> +<form> + Username: + <input type="text" name="u" value="" /><br /> + Password: + <input type="password" name="p" value="" /><br /> + <input type="submit" value="Log in" /> +</form> +</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->get('http://www.my-site.com/login.php');<strong> + $this->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 vaut pas la peine d'être testée. + </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->get('http://www.my-site.com/login.php');<strong> + $session = $this->getCookie('SID'); + $this->setField('u', 'Me'); + $this->setField('p', 'Secret'); + $this->clickSubmit('Log in'); + $this->assertWantedPattern('/Welcome Me/'); + $this->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->get('http://www.my-site.com/login.php');<strong> + $this->setCookie('SID', 'Some other session'); + $this->get('http://www.my-site.com/restricted.php');</strong> + $this->assertWantedPattern('/Access denied/'); + } +} +</pre> + Votre site est-il protégé contre ce type d'attaque ? + </p> + + <p> +<a class="target" name="session"> +<h2>Sessions de navigateur</h2> +</a> +</p> + <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->get('http://www.my-site.com/login.php'); + $this->setField('u', 'Me'); + $this->setField('p', 'Secret'); + $this->clickSubmit('Log in'); + $this->assertWantedPattern('/Welcome Me/');<strong> + + $this->restart(); + $this->get('http://www.my-site.com/restricted.php'); + $this->assertWantedPattern('/Access denied/');</strong> + } +} +</pre> + La méthode <span class="new_code">WebTestCase::restart()</span> préserve les cookies dont le timeout a expiré, mais conserve 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->get('http://www.my-site.com/login.php'); + $this->setField('u', 'Me'); + $this->setField('p', 'Secret'); + $this->clickSubmit('Log in'); + $this->assertWantedPattern('/Welcome Me/'); + <strong> + $this->ageCookies(3600);</strong> + $this->restart(); + $this->get('http://www.my-site.com/restricted.php'); + $this->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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/browser_documentation.html b/tests/test_tools/simpletest/docs/fr/browser_documentation.html index cf0c2511..fa8ad1b6 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/browser_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/browser_documentation.html @@ -1,329 +1,329 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur le navigateur scriptable</h1>
-<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 frameword SimpleTest lui-même.
- </p>
-
- <p>
-<a class="target" name="script">
-<h2>Le navigateur scriptable</h2>
-</a>
-</p>
- <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>
-<?php
- require_once('simpletest/browser.php');
-
- $browser = &new SimpleBrowser();
- $browser->get('http://php.net/');
- $browser->clickLink('reporting bugs');
- $browser->clickLink('statistics');
- $browser->clickLink('PHP 5 bugs only');
- $page = $browser->getContent();
- preg_match('/status=Open.*?by=Any.*?(\d+)<\/a>/', $page, $matches);
- print $matches[1];
-?>
-</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 formulaire et la capacité d'examiner les entêtes. De telles méthodes 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">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 si un lien avec cette étiquette existe</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 si un lien avec cet attribut d'identification existe</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 appellé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($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($name)</span></td><td>Accesseur de la valeur d'un élément de formulaire</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 l'image par son texte alternatif</td>
-</tr>
- <tr>
-<td><span class="new_code">clickImageByName($name, $x, $y)</span></td><td>Clique sur l'image par son attribut</td>
-</tr>
- <tr>
-<td><span class="new_code">clickImageById($id, $x, $y)</span></td><td>Clique sur l'image par son identifiant</td>
-</tr>
- <tr>
-<td><span class="new_code">submitFormById($id)</span></td><td>Transmet le formulaire par son identifiant propre</td>
-</tr>
- </tbody>
-</table>
- A aujourd'hui il n'existe aucune méthode pour lister les formulaires et les champs disponibles : 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 un 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>
-
- <p>
-<a class="target" name="deboguer">
-<h2>Où sont les erreurs ?</h2>
-</a>
-</p>
- <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">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'authenficiation 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">setMaximumRedirects($max)</span></td><td>Nombre de redirection 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 individuel 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>
-
- <p>
-<a class="target" name="unit">
-<h2>Tests unitaires complexes avec des navigateurs multiples</h2>
-</a>
-</p>
- <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>
-class TestOfRegistration extends UnitTestCase {
- function testNewUserAddedToAuthenticator() {
- $browser = &new SimpleBrowser();
- $browser->get('http://my-site.com/register.php');
- $browser->setField('email', 'me@here');
- $browser->setField('password', 'Secret');
- $browser->clickSubmit('Register');
-
- $authenticator = &new Authenticator();
- $member = &$authenticator->findByEmail('me@here');
- $this->assertEqual($member->getPassword(), 'Secret');
- }
-}
-</pre>
- Bien que ça puisse être utile par convenance temporaire, je ne suis pas fan de ce genre de test. Ce test s'applique à sur plusieurs couches de l'application, ça implique qu'il est plus que probable qu'il faudra le remanier lorsque le code change.
- </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 = &new SimpleBrowser();
- $first->get('http://my-site.com/login.php');
- $first->setField('name', 'Me');
- $first->setField('password', 'Secret');
- $first->clickSubmit('Enter');
- $this->assertEqual($first->getTitle(), 'Welcome');
-
- $second = &new SimpleBrowser();
- $second->get('http://my-site.com/login.php');
- $second->setField('name', 'Me');
- $second->setField('password', 'Secret');
- $second->clickSubmit('Enter');
- $this->assertEqual($second->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.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur le navigateur scriptable</h1> +<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 frameword SimpleTest lui-même. + </p> + + <p> +<a class="target" name="script"> +<h2>Le navigateur scriptable</h2> +</a> +</p> + <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> +<?php + require_once('simpletest/browser.php'); + + $browser = &new SimpleBrowser(); + $browser->get('http://php.net/'); + $browser->clickLink('reporting bugs'); + $browser->clickLink('statistics'); + $browser->clickLink('PHP 5 bugs only'); + $page = $browser->getContent(); + preg_match('/status=Open.*?by=Any.*?(\d+)<\/a>/', $page, $matches); + print $matches[1]; +?> +</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 formulaire et la capacité d'examiner les entêtes. De telles méthodes 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">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 si un lien avec cette étiquette existe</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 si un lien avec cet attribut d'identification existe</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 appellé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($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($name)</span></td><td>Accesseur de la valeur d'un élément de formulaire</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 l'image par son texte alternatif</td> +</tr> + <tr> +<td><span class="new_code">clickImageByName($name, $x, $y)</span></td><td>Clique sur l'image par son attribut</td> +</tr> + <tr> +<td><span class="new_code">clickImageById($id, $x, $y)</span></td><td>Clique sur l'image par son identifiant</td> +</tr> + <tr> +<td><span class="new_code">submitFormById($id)</span></td><td>Transmet le formulaire par son identifiant propre</td> +</tr> + </tbody> +</table> + A aujourd'hui il n'existe aucune méthode pour lister les formulaires et les champs disponibles : 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 un 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> + + <p> +<a class="target" name="deboguer"> +<h2>Où sont les erreurs ?</h2> +</a> +</p> + <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">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'authenficiation 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">setMaximumRedirects($max)</span></td><td>Nombre de redirection 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 individuel 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> + + <p> +<a class="target" name="unit"> +<h2>Tests unitaires complexes avec des navigateurs multiples</h2> +</a> +</p> + <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> +class TestOfRegistration extends UnitTestCase { + function testNewUserAddedToAuthenticator() { + $browser = &new SimpleBrowser(); + $browser->get('http://my-site.com/register.php'); + $browser->setField('email', 'me@here'); + $browser->setField('password', 'Secret'); + $browser->clickSubmit('Register'); + + $authenticator = &new Authenticator(); + $member = &$authenticator->findByEmail('me@here'); + $this->assertEqual($member->getPassword(), 'Secret'); + } +} +</pre> + Bien que ça puisse être utile par convenance temporaire, je ne suis pas fan de ce genre de test. Ce test s'applique à sur plusieurs couches de l'application, ça implique qu'il est plus que probable qu'il faudra le remanier lorsque le code change. + </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 = &new SimpleBrowser(); + $first->get('http://my-site.com/login.php'); + $first->setField('name', 'Me'); + $first->setField('password', 'Secret'); + $first->clickSubmit('Enter'); + $this->assertEqual($first->getTitle(), 'Welcome'); + + $second = &new SimpleBrowser(); + $second->get('http://my-site.com/login.php'); + $second->setField('name', 'Me'); + $second->setField('password', 'Secret'); + $second->clickSubmit('Enter'); + $this->assertEqual($second->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. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/docs.css b/tests/test_tools/simpletest/docs/fr/docs.css index c59b9cd2..93226cd7 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/docs.css +++ b/tests/test_tools/simpletest/docs/fr/docs.css @@ -1,84 +1,84 @@ -body {
- padding-left: 3%;
- padding-right: 3%;
-}
-pre {
- font-family: 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%;
-}
+body { + padding-left: 3%; + padding-right: 3%; +} +pre { + font-family: 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%; +} diff --git a/tests/UnitTests/simpletest/docs/fr/expectation_documentation.html b/tests/test_tools/simpletest/docs/fr/expectation_documentation.html index bbadfa02..ab9ef606 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/expectation_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/expectation_documentation.html @@ -1,263 +1,263 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur les attentes</h1>
-<div class="content">
- <p>
-<a class="target" name="fantaisie">
-<h2>Plus de contrôle sur les objets fantaisie</h2>
-</a>
-</p>
- <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->isConnected()) {
- $writer->write('Cannot connect to news service "' .
- $this->_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->expectOnce('write', array(
- 'Cannot connect to news service ' .
- '"BBC News" at this time. ' .
- 'Please try again later.'));
-
- $service = &new NewsService('BBC News');
- $service->publish($writer);
-
- $writer->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->expectOnce(
- 'write',
- array(new WantedPatternExpectation('/cannot connect/i')));</strong>
-
- $service = &new NewsService('BBC News');
- $service->publish($writer);
-
- $writer->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">WantedPatternExpectation</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">WantedPatternExpectation</span> utilise l'expression rationnelle pour la comparaison avec son constructeur. A chaque fois q'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">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">WantedPatternExpectation</span></td><td>Utilise une expression rationnelle Perl pour comparer une chaîne</td>
-</tr>
- <tr>
-<td><span class="new_code">NoUnwantedPatternExpectation</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>
- </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>
-
- <p>
-<a class="target" name="comportement">
-<h2>Utiliser les attentes pour contrôler les bouchons serveur</h2>
-</a>
-</p>
- <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> our 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 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->setReturnValue(
- 'isAllowed',
- true,
- array(new IsAExpectation('Session', 'Must be a session')));
-$authorisation->setReturnValue('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>
-
- <p>
-<a class="target" name="etendre">
-<h2>Créer vos propres attentes</h2>
-</a>
-</p>
- <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>...
-<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>
-<a class="target" name="unitaire">
-<h2>Sous le capot du testeur unitaire</h2>
-</a>
-</p>
- <p>
- Le <a href="http://sourceforge.net/projects/simpletest/">frameworkd 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::assertExpectation()</span> pour effectuer le test...
-<pre>
-<strong>class TestOfNetworking extends UnitTestCase {
- ...
- function testGetValidIp() {
- $server = &new Server();
- $this->assertExpectation(
- new ValidIp(),
- $server->getIp(),
- 'Server IP address->%s');
- }
-}</strong>
-</pre>
- 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->assertExpectation(new ValidIp(), $ip, $message);
- }</strong>
-
- function testGetValidIp() {
- $server = &new Server();<strong>
- $this->assertValidIp(
- $server->getIp(),
- 'Server IP address->%s');</strong>
- }
-}
-</pre>
- Il est peu probable que nous ayons besoin de ce niveau de contrôle sur la machinerie de test. Il est assez rare que le besoin d'une attente dépasse le stade de la reconnaissance d'un motif. De plus, 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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur les attentes</h1> +<div class="content"> + <p> +<a class="target" name="fantaisie"> +<h2>Plus de contrôle sur les objets fantaisie</h2> +</a> +</p> + <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->isConnected()) { + $writer->write('Cannot connect to news service "' . + $this->_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->expectOnce('write', array( + 'Cannot connect to news service ' . + '"BBC News" at this time. ' . + 'Please try again later.')); + + $service = &new NewsService('BBC News'); + $service->publish($writer); + + $writer->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->expectOnce( + 'write', + array(new WantedPatternExpectation('/cannot connect/i')));</strong> + + $service = &new NewsService('BBC News'); + $service->publish($writer); + + $writer->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">WantedPatternExpectation</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">WantedPatternExpectation</span> utilise l'expression rationnelle pour la comparaison avec son constructeur. A chaque fois q'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">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">WantedPatternExpectation</span></td><td>Utilise une expression rationnelle Perl pour comparer une chaîne</td> +</tr> + <tr> +<td><span class="new_code">NoUnwantedPatternExpectation</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> + </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> + + <p> +<a class="target" name="comportement"> +<h2>Utiliser les attentes pour contrôler les bouchons serveur</h2> +</a> +</p> + <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> our 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 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->setReturnValue( + 'isAllowed', + true, + array(new IsAExpectation('Session', 'Must be a session'))); +$authorisation->setReturnValue('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> + + <p> +<a class="target" name="etendre"> +<h2>Créer vos propres attentes</h2> +</a> +</p> + <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>... +<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> +<a class="target" name="unitaire"> +<h2>Sous le capot du testeur unitaire</h2> +</a> +</p> + <p> + Le <a href="http://sourceforge.net/projects/simpletest/">frameworkd 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::assertExpectation()</span> pour effectuer le test... +<pre> +<strong>class TestOfNetworking extends UnitTestCase { + ... + function testGetValidIp() { + $server = &new Server(); + $this->assertExpectation( + new ValidIp(), + $server->getIp(), + 'Server IP address->%s'); + } +}</strong> +</pre> + 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->assertExpectation(new ValidIp(), $ip, $message); + }</strong> + + function testGetValidIp() { + $server = &new Server();<strong> + $this->assertValidIp( + $server->getIp(), + 'Server IP address->%s');</strong> + } +} +</pre> + Il est peu probable que nous ayons besoin de ce niveau de contrôle sur la machinerie de test. Il est assez rare que le besoin d'une attente dépasse le stade de la reconnaissance d'un motif. De plus, 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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/form_testing_documentation.html b/tests/test_tools/simpletest/docs/fr/form_testing_documentation.html index 39ec01ce..f9f5d0df 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/form_testing_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/form_testing_documentation.html @@ -1,235 +1,235 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur les tests de formulaire</h1>
-<div class="content">
- <p>
-<a class="target" name="submit">
-<h2>Valider un formulaire simple</h2>
-</a>
-</p>
- <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 <form> sont disponibles depuis l'intérieur du scénario de test. Prenons pas exemple cet extrait de code HTML...
-<pre>
-<form>
- <input type="text" name="a" value="A default" />
- <input type="submit" value="Go" />
-</form>
-</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->get('http://www.lastcraft.com/form_testing_documentation.php');
- $this->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, mais d'abord nous allons changer la valeur du champ texte. Ce n'est qu'après que nous le transmettre...
-<pre>
-class SimpleFormTests extends WebTestCase {
-
- function testDefaultValue() {
- $this->get('http://www.my-site.com/');
- $this->assertField('a', 'A default');<strong>
- $this->setField('a', 'New value');
- $this->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. 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.
- </p>
- <p>
- Si un champ manque dans n'importe que 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>
-<select name="type">
- <option>Subscriber</option>
- <option>Author</option>
- <option>Administrator</option>
-</select>
-</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->get('http://www.lastcraft.com/form_testing_documentation.php');
- $this->assertFalse($this->setField('type', 'Superuser'));</strong>
- }
-}
-</pre>
- La sélection ne sera pas changée suite à un échec d'initialisation d'une valeur sur un objet.
- </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>
- Bien que la plupart des objets HTML standards soient couvert par le parseur de <em>SimpleTest</em>, il est peu probable que JavaScript soit implémenté dans un futur proche.
- </p>
-
- <p>
-<a class="target" name="multiple">
-<h2>Champs à valeurs multiples</h2>
-</a>
-</p>
- <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>
-<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>
-</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->get('http://www.lastcraft.com/form_testing_documentation.php');
- $this->assertField('crud', array('c', 'r', 'u', 'd'));
- $this->setField('crud', array('r'));
- $this->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'autre code de test pour confirmer cet effet, peut-être en nous connectant comme utilisateur et en essayant d'effectuer une mise à jour.
- </p>
- <p>
- <a class="target" name="brut">
-<h2>Envoi brut</h2>
-</a>
- </p>
- <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->post(
- 'http://www.my-site.com/add_user.php',
- array('type' => 'superuser'));
- $this->assertNoUnwantedPattern('/user created/i');
- }</strong>
-}
-</pre>
- En ajoutant des données à la méthode <span class="new_code">WebTestCase::post()</span>, nous essayons de télécharger la page via la transmission d'un formulaire.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur les tests de formulaire</h1> +<div class="content"> + <p> +<a class="target" name="submit"> +<h2>Valider un formulaire simple</h2> +</a> +</p> + <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 <form> sont disponibles depuis l'intérieur du scénario de test. Prenons pas exemple cet extrait de code HTML... +<pre> +<form> + <input type="text" name="a" value="A default" /> + <input type="submit" value="Go" /> +</form> +</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->get('http://www.lastcraft.com/form_testing_documentation.php'); + $this->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, mais d'abord nous allons changer la valeur du champ texte. Ce n'est qu'après que nous le transmettre... +<pre> +class SimpleFormTests extends WebTestCase { + + function testDefaultValue() { + $this->get('http://www.my-site.com/'); + $this->assertField('a', 'A default');<strong> + $this->setField('a', 'New value'); + $this->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. 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. + </p> + <p> + Si un champ manque dans n'importe que 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> +<select name="type"> + <option>Subscriber</option> + <option>Author</option> + <option>Administrator</option> +</select> +</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->get('http://www.lastcraft.com/form_testing_documentation.php'); + $this->assertFalse($this->setField('type', 'Superuser'));</strong> + } +} +</pre> + La sélection ne sera pas changée suite à un échec d'initialisation d'une valeur sur un objet. + </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> + Bien que la plupart des objets HTML standards soient couvert par le parseur de <em>SimpleTest</em>, il est peu probable que JavaScript soit implémenté dans un futur proche. + </p> + + <p> +<a class="target" name="multiple"> +<h2>Champs à valeurs multiples</h2> +</a> +</p> + <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> +<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> +</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->get('http://www.lastcraft.com/form_testing_documentation.php'); + $this->assertField('crud', array('c', 'r', 'u', 'd')); + $this->setField('crud', array('r')); + $this->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'autre code de test pour confirmer cet effet, peut-être en nous connectant comme utilisateur et en essayant d'effectuer une mise à jour. + </p> + <p> + <a class="target" name="brut"> +<h2>Envoi brut</h2> +</a> + </p> + <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->post( + 'http://www.my-site.com/add_user.php', + array('type' => 'superuser')); + $this->assertNoUnwantedPattern('/user created/i'); + }</strong> +} +</pre> + En ajoutant des données à la méthode <span class="new_code">WebTestCase::post()</span>, nous essayons de télécharger la page via la transmission d'un formulaire. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/group_test_documentation.html b/tests/test_tools/simpletest/docs/fr/group_test_documentation.html index b406f21e..662f868e 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/group_test_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/group_test_documentation.html @@ -1,288 +1,288 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur le groupement des tests</h1>
-<div class="content">
- <p>
-<a class="target" name="grouper">
-<h2>Grouper des tests</h2>
-</a>
-</p>
- <p>
- Pour lancer les scénarios de tests en tant que groupe, ils devraient être placés dans des fichiers sans le code du lanceur...
-<pre>
-<strong><?php
- require_once('../classes/io.php');
-
- class FileTester extends UnitTestCase {
- ...
- }
-
- class SocketTester extends UnitTestCase {
- ...
- }
-?></strong>
-</pre>
- Autant de scénarios que nécessaires peuvent être mis dans un fichier unique. Ils doivent contenir tout le code nécessaire, entre autres la bibliothèque testée, mais aucune des bibliothèques de SimpleTest.
- </p>
- <p>
- Si vous avez étendu l'un ou l'autre des scénarios de test, vous pouvez aussi les inclure.
-<pre>
-<?php
- require_once('../classes/io.php');
-<strong>
- class MyFileTestCase extends UnitTestCase {
- ...
- }
- SimpleTestOptions::ignore('MyFileTestCase');</strong>
-
- 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. Pour cette raison nous utilisons la directive <span class="new_code">SimpleTestOptions::ignore()</span> pour indiquer au prochain groupe de test de l'ignorer. Cette directive peut se placer n'importe où dans le fichier et fonctionne quand un fichier complet des scénarios de test est chargé (cf. ci-dessous). Nous l'appelons <em>file_test.php</em>.
- </p>
- <p>
- Ensuite nous créons un fichier de groupe de test, disons <em>group_test.php</em>. Vous penserez à un nom plus convaincant, j'en suis sûr. Nous lui ajoutons le fichier de test avec une méthode sans risque...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');<strong>
- require_once('file_test.php');
-
- $test = &new GroupTest('All file tests');
- $test->addTestCase(new FileTestCase());
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- Ceci instancie le scénario de test avant que la suite de test ne soit lancée. Ça pourrait devenir assez onéreux avec un grand nombre de scénarios de test : il existe donc une autre méthode qui instancie la classe uniquement quand elle devient nécessaire...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
- require_once('file_test.php');
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestClass('FileTestCase');</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- Le problème de cette technique est que pour chaque scénario de test supplémentaire nous aurons à <span class="new_code">require_once()</span> le fichier de code de test et à manuellement instancier chaque scénario de test. Nous pouvons nous épargner beaucoup de dactylographie avec...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestFile('file_test.php');</strong>
- $test->run(new HtmlReporter());
-?&gt;
-</pre>
- Voici ce qui vient de se passer : la classe <span class="new_code">GroupTest</span> a réalisé le <span class="new_code">require_once()</span> pour nous. Ensuite elle vérifie si de nouvelles classes de scénario de test ont été créées par ce nouveau fichier et les ajoute automatiquement au groupe de test. Désormais tout ce qu'il nous reste à faire, c'est d'ajouter chaque nouveau fichier.
- </p>
- <p>
- Il y a deux choses qui peuvent planter et qui demandent un minimum d'attention...
- <ol>
- <li>
- Le fichier peut déjà avoir été analysé par PHP et dans ce cas aucune classe ne sera ajoutée. Pensez à bien vérifier que les scénarios de test ne sont inclus que dans ce fichier et dans aucun autre.
- </li>
- <li>
- Les nouvelles classes d'extension de scénario de test qui sont incluses seront placées dans le groupe de test et exécutées par la même occasion. Vous aurez à ajouter une directive <span class="new_code">SimpleTestOptions::ignore()</span> pour ces classes ou alors pensez à les ajouter avant la ligne <span class="new_code">GroupTest::addTestFile()</span>.
- </li>
- </ol>
- </p>
-
- <p>
-<a class="target" name="plus-haut">
-<h2>Groupements de plus haut niveau</h2>
-</a>
-</p>
- <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>
- Pour obtenir un groupe de test plus souple nous pouvons sous classer <span class="new_code">GroupTest</span> et ensuite l'instancier au cas par cas...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
- <strong>
- class FileGroupTest extends GroupTest {
- function FileGroupTest() {
- $this->GroupTest('All file tests');
- $this->addTestFile('file_test.php');
- }
- }</strong>
-?>
-</pre>
- Ceci nomme le test dans le constructeur et ensuite ajoute à la fois nos scénarios de test et un unique groupe en dessous. Bien sûr nous pouvons ajouter plus d'un groupe à cet instant. Nous pouvons maintenant invoquer les tests à partir d'un autre fichier d'exécution...
-<pre>
-<?php
- require_once('file_group_test.php');
- <strong>
- $test = &new FileGroupTest();
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- ...ou alors nous pouvons les grouper dans un groupe de tests encore plus grand...
-<pre>
-<?php
- require_once('file_group_test.php');
- <strong>
- $test = &new BigGroupTest('Big group');
- $test->addTestCase(new FileGroupTest());
- $test->addTestCase(...);
- $test->run(new HtmlReporter());</strong>
-?>
-</pre>
- Si nous souhaitons lancer le groupe de test original sans utiliser ses petits fichiers d'exécution, nous pouvons mettre le code du lanceur de test derrière des barreaux quand nous créons chaque groupe.
-<pre>
-<?php
- class FileGroupTest extends GroupTest {
- function FileGroupTest() {
- $this->GroupTest('All file tests');
- $test->addTestFile('file_test.php');
- }
- }
- <strong>
- if (! defined('RUNNER')) {
- define('RUNNER', true);</strong>
- $test = &new FileGroupTest();
- $test->run(new HtmlReporter());
- }
-?>
-</pre>
- Cette approche exige aux barrières d'être activées à l'inclusion du fichier de groupe de test, mais c'est quand même moins de tracas que beaucoup de fichiers de lancement éparpillés. Reste à inclure des barreaux identiques au niveau supérieur afin de s'assurer que le <span class="new_code">run()</span> ne sera lancé qu'une seule fois à partir du script de haut niveau qui l'a invoqué.
-<pre>
-<?php
- define('RUNNER', true);
-
- require_once('file_group_test.php');
- $test = &new BigGroupTest('Big group');
- $test->addTestCase(new FileGroupTest());
- $test->addTestCase(...);
- $test->run(new HtmlReporter());
-?>
-</pre>
- Comme les scénarios de test normaux, un <span class="new_code">GroupTest</span> peut être chargé avec la méthode <span class="new_code">GroupTest::addTestFile()</span>.
-<pre>
-<?php
- define('RUNNER', true);
-
- $test = &new BigGroupTest('Big group');<strong>
- $test->addTestFile('file_group_test.php');
- $test->addTestFile(...);</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- </p>
-
- <p>
-<a class="target" name="heritage">
-<h2>Intégrer des scénarios de test hérités</h2>
-</a>
-</p>
- <p>
- Si vous avez déjà des tests unitaires pour votre code ou alors si vous étendez des classes externes qui ont déjà leurs propres tests, il y a peu de chances pour que ceux-ci soient déjà au format SimpleTest. Heureusement il est possible d'incorporer ces scénarios de test en provenance d'autres testeurs unitaires directement dans des groupes de test SimpleTest.
- </p>
- <p>
- Par exemple, supposons que nous ayons ce scénario de test prévu pour <a href="http://sourceforge.net/projects/phpunit">PhpUnit</a>dans le fichier <em>config_test.php</em>...
-<pre>
-<strong>class ConfigFileTest extends TestCase {
- function ConfigFileTest() {
- $this->TestCase('Config file test');
- }
-
- function testContents() {
- $config = new ConfigFile('test.conf');
- $this->assertRegexp('/me/', $config->getValue('username'));
- }
-}</strong>
-</pre>
- Le groupe de test peut le reconnaître à partir du moment où nous mettons l'adaptateur approprié avant d'ajouter le fichier de test...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');<strong>
- require_once('simpletest/adapters/phpunit_test_case.php');</strong>
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestFile('config_test.php');</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- Il n'y a que deux adaptateurs, l'autre est pour le paquet testeur unitaire de <a href="http://pear.php.net/manual/en/package.php.phpunit.php">PEAR</a>...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');<strong>
- require_once('simpletest/adapters/pear_test_case.php');</strong>
-
- $test = &new GroupTest('All file tests');<strong>
- $test->addTestFile('some_pear_test_cases.php');</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- Les scénarios de test de PEAR peuvent être librement mélangés avec ceux de SimpleTest mais vous ne pouvez pas utiliser les assertions de SimpleTest au sein des versions héritées des scénarios de test. La raison ? Une simple vérification que vous ne rendez pas par accident vos scénarios de test complètement dépendants de SimpleTest. Peut-être que vous souhaitez publier votre bibliothèque sur PEAR par exemple : ça voudrait dire la livrer avec des scénarios de test compatibles avec PEAR::PhpUnit.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur le groupement des tests</h1> +<div class="content"> + <p> +<a class="target" name="grouper"> +<h2>Grouper des tests</h2> +</a> +</p> + <p> + Pour lancer les scénarios de tests en tant que groupe, ils devraient être placés dans des fichiers sans le code du lanceur... +<pre> +<strong><?php + require_once('../classes/io.php'); + + class FileTester extends UnitTestCase { + ... + } + + class SocketTester extends UnitTestCase { + ... + } +?></strong> +</pre> + Autant de scénarios que nécessaires peuvent être mis dans un fichier unique. Ils doivent contenir tout le code nécessaire, entre autres la bibliothèque testée, mais aucune des bibliothèques de SimpleTest. + </p> + <p> + Si vous avez étendu l'un ou l'autre des scénarios de test, vous pouvez aussi les inclure. +<pre> +<?php + require_once('../classes/io.php'); +<strong> + class MyFileTestCase extends UnitTestCase { + ... + } + SimpleTestOptions::ignore('MyFileTestCase');</strong> + + 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. Pour cette raison nous utilisons la directive <span class="new_code">SimpleTestOptions::ignore()</span> pour indiquer au prochain groupe de test de l'ignorer. Cette directive peut se placer n'importe où dans le fichier et fonctionne quand un fichier complet des scénarios de test est chargé (cf. ci-dessous). Nous l'appelons <em>file_test.php</em>. + </p> + <p> + Ensuite nous créons un fichier de groupe de test, disons <em>group_test.php</em>. Vous penserez à un nom plus convaincant, j'en suis sûr. Nous lui ajoutons le fichier de test avec une méthode sans risque... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php');<strong> + require_once('file_test.php'); + + $test = &new GroupTest('All file tests'); + $test->addTestCase(new FileTestCase()); + $test->run(new HtmlReporter());</strong> +?> +</pre> + Ceci instancie le scénario de test avant que la suite de test ne soit lancée. Ça pourrait devenir assez onéreux avec un grand nombre de scénarios de test : il existe donc une autre méthode qui instancie la classe uniquement quand elle devient nécessaire... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + require_once('file_test.php'); + + $test = &new GroupTest('All file tests');<strong> + $test->addTestClass('FileTestCase');</strong> + $test->run(new HtmlReporter()); +?> +</pre> + Le problème de cette technique est que pour chaque scénario de test supplémentaire nous aurons à <span class="new_code">require_once()</span> le fichier de code de test et à manuellement instancier chaque scénario de test. Nous pouvons nous épargner beaucoup de dactylographie avec... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('All file tests');<strong> + $test->addTestFile('file_test.php');</strong> + $test->run(new HtmlReporter()); +?&gt; +</pre> + Voici ce qui vient de se passer : la classe <span class="new_code">GroupTest</span> a réalisé le <span class="new_code">require_once()</span> pour nous. Ensuite elle vérifie si de nouvelles classes de scénario de test ont été créées par ce nouveau fichier et les ajoute automatiquement au groupe de test. Désormais tout ce qu'il nous reste à faire, c'est d'ajouter chaque nouveau fichier. + </p> + <p> + Il y a deux choses qui peuvent planter et qui demandent un minimum d'attention... + <ol> + <li> + Le fichier peut déjà avoir été analysé par PHP et dans ce cas aucune classe ne sera ajoutée. Pensez à bien vérifier que les scénarios de test ne sont inclus que dans ce fichier et dans aucun autre. + </li> + <li> + Les nouvelles classes d'extension de scénario de test qui sont incluses seront placées dans le groupe de test et exécutées par la même occasion. Vous aurez à ajouter une directive <span class="new_code">SimpleTestOptions::ignore()</span> pour ces classes ou alors pensez à les ajouter avant la ligne <span class="new_code">GroupTest::addTestFile()</span>. + </li> + </ol> + </p> + + <p> +<a class="target" name="plus-haut"> +<h2>Groupements de plus haut niveau</h2> +</a> +</p> + <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> + Pour obtenir un groupe de test plus souple nous pouvons sous classer <span class="new_code">GroupTest</span> et ensuite l'instancier au cas par cas... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + <strong> + class FileGroupTest extends GroupTest { + function FileGroupTest() { + $this->GroupTest('All file tests'); + $this->addTestFile('file_test.php'); + } + }</strong> +?> +</pre> + Ceci nomme le test dans le constructeur et ensuite ajoute à la fois nos scénarios de test et un unique groupe en dessous. Bien sûr nous pouvons ajouter plus d'un groupe à cet instant. Nous pouvons maintenant invoquer les tests à partir d'un autre fichier d'exécution... +<pre> +<?php + require_once('file_group_test.php'); + <strong> + $test = &new FileGroupTest(); + $test->run(new HtmlReporter());</strong> +?> +</pre> + ...ou alors nous pouvons les grouper dans un groupe de tests encore plus grand... +<pre> +<?php + require_once('file_group_test.php'); + <strong> + $test = &new BigGroupTest('Big group'); + $test->addTestCase(new FileGroupTest()); + $test->addTestCase(...); + $test->run(new HtmlReporter());</strong> +?> +</pre> + Si nous souhaitons lancer le groupe de test original sans utiliser ses petits fichiers d'exécution, nous pouvons mettre le code du lanceur de test derrière des barreaux quand nous créons chaque groupe. +<pre> +<?php + class FileGroupTest extends GroupTest { + function FileGroupTest() { + $this->GroupTest('All file tests'); + $test->addTestFile('file_test.php'); + } + } + <strong> + if (! defined('RUNNER')) { + define('RUNNER', true);</strong> + $test = &new FileGroupTest(); + $test->run(new HtmlReporter()); + } +?> +</pre> + Cette approche exige aux barrières d'être activées à l'inclusion du fichier de groupe de test, mais c'est quand même moins de tracas que beaucoup de fichiers de lancement éparpillés. Reste à inclure des barreaux identiques au niveau supérieur afin de s'assurer que le <span class="new_code">run()</span> ne sera lancé qu'une seule fois à partir du script de haut niveau qui l'a invoqué. +<pre> +<?php + define('RUNNER', true); + + require_once('file_group_test.php'); + $test = &new BigGroupTest('Big group'); + $test->addTestCase(new FileGroupTest()); + $test->addTestCase(...); + $test->run(new HtmlReporter()); +?> +</pre> + Comme les scénarios de test normaux, un <span class="new_code">GroupTest</span> peut être chargé avec la méthode <span class="new_code">GroupTest::addTestFile()</span>. +<pre> +<?php + define('RUNNER', true); + + $test = &new BigGroupTest('Big group');<strong> + $test->addTestFile('file_group_test.php'); + $test->addTestFile(...);</strong> + $test->run(new HtmlReporter()); +?> +</pre> + </p> + + <p> +<a class="target" name="heritage"> +<h2>Intégrer des scénarios de test hérités</h2> +</a> +</p> + <p> + Si vous avez déjà des tests unitaires pour votre code ou alors si vous étendez des classes externes qui ont déjà leurs propres tests, il y a peu de chances pour que ceux-ci soient déjà au format SimpleTest. Heureusement il est possible d'incorporer ces scénarios de test en provenance d'autres testeurs unitaires directement dans des groupes de test SimpleTest. + </p> + <p> + Par exemple, supposons que nous ayons ce scénario de test prévu pour <a href="http://sourceforge.net/projects/phpunit">PhpUnit</a>dans le fichier <em>config_test.php</em>... +<pre> +<strong>class ConfigFileTest extends TestCase { + function ConfigFileTest() { + $this->TestCase('Config file test'); + } + + function testContents() { + $config = new ConfigFile('test.conf'); + $this->assertRegexp('/me/', $config->getValue('username')); + } +}</strong> +</pre> + Le groupe de test peut le reconnaître à partir du moment où nous mettons l'adaptateur approprié avant d'ajouter le fichier de test... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php');<strong> + require_once('simpletest/adapters/phpunit_test_case.php');</strong> + + $test = &new GroupTest('All file tests');<strong> + $test->addTestFile('config_test.php');</strong> + $test->run(new HtmlReporter()); +?> +</pre> + Il n'y a que deux adaptateurs, l'autre est pour le paquet testeur unitaire de <a href="http://pear.php.net/manual/en/package.php.phpunit.php">PEAR</a>... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php');<strong> + require_once('simpletest/adapters/pear_test_case.php');</strong> + + $test = &new GroupTest('All file tests');<strong> + $test->addTestFile('some_pear_test_cases.php');</strong> + $test->run(new HtmlReporter()); +?> +</pre> + Les scénarios de test de PEAR peuvent être librement mélangés avec ceux de SimpleTest mais vous ne pouvez pas utiliser les assertions de SimpleTest au sein des versions héritées des scénarios de test. La raison ? Une simple vérification que vous ne rendez pas par accident vos scénarios de test complètement dépendants de SimpleTest. Peut-être que vous souhaitez publier votre bibliothèque sur PEAR par exemple : ça voudrait dire la livrer avec des scénarios de test compatibles avec PEAR::PhpUnit. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/index.html b/tests/test_tools/simpletest/docs/fr/index.html index c0db74ae..f4b2ad93 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/index.html +++ b/tests/test_tools/simpletest/docs/fr/index.html @@ -1,343 +1,343 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>
- Télécharger le framework de tests Simple Test - 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">
-<h2>
-<span class="chosen">SimpleTest</span>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Simple Test pour PHP</h1>
-<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>
-
- <p>
-<a class="target" name="unit">
-<h2>Utiliser le testeur rapidement</h2>
-</a>
-</p>
- <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>. Sans compter quelques fonctionnalités de <a href="http://sourceforge.net/projects/jwebunit/">JWebUnit</a> : parmi celles-ci la navigation sur des pages web, les tests sur les cookies et l'envoi de formulaire.
- </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>
-<strong><?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-?></strong>
-</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. Ensuite créons un scénario de test...
-<pre>
-<?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-<strong>
-class TestOfLogging extends UnitTestCase {
-}</strong>
-?>
-</pre>
- A présent il y a 5 lignes de code d'échafaudage et toujours pas de test. Cependant à partir de cet instant le retour sur investissement arrive très rapidement. Supposons que la classe <span class="new_code">Log</span> prenne le nom du fichier à écrire dans le constructeur et que nous ayons un répertoire temporaire dans lequel placer ce fichier...
-<pre>
-<?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-
-class TestOfLogging extends UnitTestCase {
- <strong>
- function testCreatingNewFile() {
- @unlink('/temp/test.log');
- $log = new Log('/temp/test.log');
- $this->assertFalse(file_exists('/temp/test.log'));
- $log->message('Should write this to a file');
- $this->assertTrue(file_exists('/temp/test.log'));
- }</strong>
-}
-?>
-</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. D'ordinaire nous avons bien plusieurs méthodes de tests. 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é.
- </p>
- <p>
- Pour voir ces résultats lançons effectivement les tests. S'il s'agit de l'unique scénario de test à lancer, on peut y arriver avec...
-<pre>
-<?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-require_once('../classes/log.php');
-
-class TestOfLogging extends UnitTestCase {
-
- function testCreatingNewFile() {
- @unlink('/temp/test.log');
- $log = new Log('/temp/test.log');
- $this->assertFalse(file_exists('/temp/test.log'));
- $log->message('Should write this to a file');
- $this->assertTrue(file_exists('/temp/test.log'));
- }
-}
-<strong>
-$test = &new TestOfLogging();
-$test->run(new HtmlReporter());</strong>
-?>
-</pre>
- </p>
- <p>
- En cas échec, l'affichage ressemble à...
- <div class="demo">
- <h1>testoflogging</h1>
- <span class="fail">Fail</span>: testcreatingnewfile->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>
-<?php
-class Log {
-
- function Log($file_path) {
- }
-}
-?>;
-</pre>
- </p>
-
- <p>
-<a class="target" name="group">
-<h2>Construire des groupes de tests</h2>
-</a>
-</p>
- <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 supprimer les includes et de défaire notre hack précédent...
-<pre>
-<?php<strong>
-require_once('../classes/log.php');</strong>
-
-class TestOfLogging extends UnitTestCase {
-
- function testCreatingNewFile() {
- @unlink('/temp/test.log');
- $log = new Log('/temp/test.log');
- $this->assertFalse(file_exists('/temp/test.log'));
- $log->message('Should write this to a file');
- $this->assertTrue(file_exists('/temp/test.log'));<strong>
- }
-}
-?></strong>
-</pre>
- Ensuite nous créons un nouveau fichier appelé <em>tests/all_tests.php</em>. On y insert le code suivant...
-<pre>
-<strong><?php
-require_once('simpletest/unit_tester.php');
-require_once('simpletest/reporter.php');
-
-$test = &new GroupTest('All tests');
-$test->addTestFile('log_test.php');
-$test->run(new HtmlReporter());
-?></strong>
-</pre>
- Cette méthode <span class="new_code">GroupTest::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">TestCase</span>. Dans un premier temps, seuls les noms sont stockés, de la sorte le lanceur de test peut instancier la classe au fur et à mesure qu'il exécute votre suite de tests.
- </p>
- <p>
- Pour que ça puisse marcher proprement le fichier de suite de tests ne devrait pas inclure aveuglement d'autres extensions de scénarios de test qui n'exécuteraient pas effectivement de test. Le résultat pourrait être que des tests supplémentaires soient alors être comptabilisés pendant l'exécution des tests. Ce n'est pas un problème grave mais pour éviter ce désagrément, il suffit d'ajouter la commande <span class="new_code">SimpleTestOptions::ignore()</span> quelque part dans le fichier de scénario de test. Par ailleurs le scénario de test ne devrait pas avoir été inclus ailleurs ou alors aucun scénario ne sera ajouté aux groupes de test. Il s'agirait là d'une erreur autrement sérieuse : si tous les classes de scénario de test sont chargées par PHP, alors la méthode <span class="new_code">GroupTest::addTestFile()</span> ne pourra pas les détecter.
- </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>
-<a class="target" name="mock">
-<h2>Utiliser les objets fantaisie</h2>
-</a>
-</p>
- <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->_log->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>
-<strong>
-<?php
-require_once('../classes/log.php');
-require_once('../classes/session_pool.php');
-
-class TestOfSessionLogging extends UnitTestCase {
-
- function setUp() {
- @unlink('/temp/test.log');
- }
-
- function tearDown() {
- @unlink('/temp/test.log');
- }
-
- function testLogInIsLogged() {
- $log = new Log('/temp/test.log');
- $session_pool = &new SessionPool($log);
- $session_pool->logIn('fred');
- $messages = file('/temp/test.log');
- $this->assertEqual($messages[0], "User fred logged in.\n");
- }
-}
-?></strong>
-</pre>
- 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 ? 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 réduisons 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 ? Par chance on peut créer un tel objet très facilement...
-<pre>
-<?php
-require_once('../classes/log.php');
-require_once('../classes/session_pool.php');<strong>
-Mock::generate('Log');</strong>
-
-class TestOfSessionLogging extends UnitTestCase {
-
- function testLogInIsLogged() {<strong>
- $log = &new MockLog($this);
- $log->expectOnce('message', array('User fred logged in.'));</strong>
- $session_pool = &new SessionPool($log);
- $session_pool->logIn('fred');<strong>
- $log->tally();</strong>
- }
-}
-?>
-</pre>
- 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>. 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 ici aussi afin d'empêcher que les tests ne deviennent trop spécifiques.
- </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>
-<a class="target" name="web">
-<h2>Tester une page web</h2>
-</a>
-</p>
- <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. 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>
-<?php<strong>
-require_once('simpletest/web_tester.php');</strong>
-require_once('simpletest/reporter.php');
-<strong>
-class TestOfAbout extends WebTestCase {
-
- function setUp() {
- $this->get('http://test-server/index.php');
- $this->clickLink('About');
- }
-
- function testSearchEngineOptimisations() {
- $this->assertTitle('A long title about us for search engines');
- $this->assertWantedPattern('/a popular keyphrase/i');
- }
-}</strong>
-$test = &new TestOfAbout();
-$test->run(new HtmlReporter());
-?>
-</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>
- <a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a>
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> + Télécharger le framework de tests Simple Test - 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"> +<h2> +<span class="chosen">SimpleTest</span> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Simple Test pour PHP</h1> +<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> + + <p> +<a class="target" name="unit"> +<h2>Utiliser le testeur rapidement</h2> +</a> +</p> + <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>. Sans compter quelques fonctionnalités de <a href="http://sourceforge.net/projects/jwebunit/">JWebUnit</a> : parmi celles-ci la navigation sur des pages web, les tests sur les cookies et l'envoi de formulaire. + </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> +<strong><?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); +?></strong> +</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. Ensuite créons un scénario de test... +<pre> +<?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); +<strong> +class TestOfLogging extends UnitTestCase { +}</strong> +?> +</pre> + A présent il y a 5 lignes de code d'échafaudage et toujours pas de test. Cependant à partir de cet instant le retour sur investissement arrive très rapidement. Supposons que la classe <span class="new_code">Log</span> prenne le nom du fichier à écrire dans le constructeur et que nous ayons un répertoire temporaire dans lequel placer ce fichier... +<pre> +<?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); + +class TestOfLogging extends UnitTestCase { + <strong> + function testCreatingNewFile() { + @unlink('/temp/test.log'); + $log = new Log('/temp/test.log'); + $this->assertFalse(file_exists('/temp/test.log')); + $log->message('Should write this to a file'); + $this->assertTrue(file_exists('/temp/test.log')); + }</strong> +} +?> +</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. D'ordinaire nous avons bien plusieurs méthodes de tests. 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é. + </p> + <p> + Pour voir ces résultats lançons effectivement les tests. S'il s'agit de l'unique scénario de test à lancer, on peut y arriver avec... +<pre> +<?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); +require_once('../classes/log.php'); + +class TestOfLogging extends UnitTestCase { + + function testCreatingNewFile() { + @unlink('/temp/test.log'); + $log = new Log('/temp/test.log'); + $this->assertFalse(file_exists('/temp/test.log')); + $log->message('Should write this to a file'); + $this->assertTrue(file_exists('/temp/test.log')); + } +} +<strong> +$test = &new TestOfLogging(); +$test->run(new HtmlReporter());</strong> +?> +</pre> + </p> + <p> + En cas échec, l'affichage ressemble à... + <div class="demo"> + <h1>testoflogging</h1> + <span class="fail">Fail</span>: testcreatingnewfile->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> +<?php +class Log { + + function Log($file_path) { + } +} +?>; +</pre> + </p> + + <p> +<a class="target" name="group"> +<h2>Construire des groupes de tests</h2> +</a> +</p> + <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 supprimer les includes et de défaire notre hack précédent... +<pre> +<?php<strong> +require_once('../classes/log.php');</strong> + +class TestOfLogging extends UnitTestCase { + + function testCreatingNewFile() { + @unlink('/temp/test.log'); + $log = new Log('/temp/test.log'); + $this->assertFalse(file_exists('/temp/test.log')); + $log->message('Should write this to a file'); + $this->assertTrue(file_exists('/temp/test.log'));<strong> + } +} +?></strong> +</pre> + Ensuite nous créons un nouveau fichier appelé <em>tests/all_tests.php</em>. On y insert le code suivant... +<pre> +<strong><?php +require_once('simpletest/unit_tester.php'); +require_once('simpletest/reporter.php'); + +$test = &new GroupTest('All tests'); +$test->addTestFile('log_test.php'); +$test->run(new HtmlReporter()); +?></strong> +</pre> + Cette méthode <span class="new_code">GroupTest::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">TestCase</span>. Dans un premier temps, seuls les noms sont stockés, de la sorte le lanceur de test peut instancier la classe au fur et à mesure qu'il exécute votre suite de tests. + </p> + <p> + Pour que ça puisse marcher proprement le fichier de suite de tests ne devrait pas inclure aveuglement d'autres extensions de scénarios de test qui n'exécuteraient pas effectivement de test. Le résultat pourrait être que des tests supplémentaires soient alors être comptabilisés pendant l'exécution des tests. Ce n'est pas un problème grave mais pour éviter ce désagrément, il suffit d'ajouter la commande <span class="new_code">SimpleTestOptions::ignore()</span> quelque part dans le fichier de scénario de test. Par ailleurs le scénario de test ne devrait pas avoir été inclus ailleurs ou alors aucun scénario ne sera ajouté aux groupes de test. Il s'agirait là d'une erreur autrement sérieuse : si tous les classes de scénario de test sont chargées par PHP, alors la méthode <span class="new_code">GroupTest::addTestFile()</span> ne pourra pas les détecter. + </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> +<a class="target" name="mock"> +<h2>Utiliser les objets fantaisie</h2> +</a> +</p> + <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->_log->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> +<strong> +<?php +require_once('../classes/log.php'); +require_once('../classes/session_pool.php'); + +class TestOfSessionLogging extends UnitTestCase { + + function setUp() { + @unlink('/temp/test.log'); + } + + function tearDown() { + @unlink('/temp/test.log'); + } + + function testLogInIsLogged() { + $log = new Log('/temp/test.log'); + $session_pool = &new SessionPool($log); + $session_pool->logIn('fred'); + $messages = file('/temp/test.log'); + $this->assertEqual($messages[0], "User fred logged in.\n"); + } +} +?></strong> +</pre> + 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 ? 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 réduisons 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 ? Par chance on peut créer un tel objet très facilement... +<pre> +<?php +require_once('../classes/log.php'); +require_once('../classes/session_pool.php');<strong> +Mock::generate('Log');</strong> + +class TestOfSessionLogging extends UnitTestCase { + + function testLogInIsLogged() {<strong> + $log = &new MockLog($this); + $log->expectOnce('message', array('User fred logged in.'));</strong> + $session_pool = &new SessionPool($log); + $session_pool->logIn('fred');<strong> + $log->tally();</strong> + } +} +?> +</pre> + 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>. 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 ici aussi afin d'empêcher que les tests ne deviennent trop spécifiques. + </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> +<a class="target" name="web"> +<h2>Tester une page web</h2> +</a> +</p> + <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. 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> +<?php<strong> +require_once('simpletest/web_tester.php');</strong> +require_once('simpletest/reporter.php'); +<strong> +class TestOfAbout extends WebTestCase { + + function setUp() { + $this->get('http://test-server/index.php'); + $this->clickLink('About'); + } + + function testSearchEngineOptimisations() { + $this->assertTitle('A long title about us for search engines'); + $this->assertWantedPattern('/a popular keyphrase/i'); + } +}</strong> +$test = &new TestOfAbout(); +$test->run(new HtmlReporter()); +?> +</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> + <a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a> + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/mock_objects_documentation.html b/tests/test_tools/simpletest/docs/fr/mock_objects_documentation.html index 1a836083..0ce48bc9 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/mock_objects_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/mock_objects_documentation.html @@ -1,492 +1,492 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur les objets fantaisie</h1>
-<div class="content">
- <p>
-<a class="target" name="quoi">
-<h2>Que sont les objets fantaisie ?</h2>
-</a>
-</p>
- <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>.
- </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. 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>
-
- <p>
-<a class="target" name="creation">
-<h2>Créer des objets fantaisie</h2>
-</a>
-</p>
- <p>
- Comme pour la création des bouchons serveur, tout ce dont nous avons besoin c'est d'un classe existante. La fameuse connexion à une base de données qui ressemblerait à...
-<pre>
-<strong>class DatabaseConnection {
- function DatabaseConnection() {
- }
-
- function query() {
- }
-
- function selectQuery() {
- }
-}</strong>
-</pre>
- Cette classe n'a pas encore besoin d'être implémentée. Pour en créer sa version fantaisie nous devons juste inclure la librairie d'objet fantaisie puis lancer le générateur...
-<pre>
-<strong>require_once('simpletest/unit_tester.php');
-require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-
-Mock::generate('DatabaseConnection');</strong>
-</pre>
- Ceci génère une classe clone appelée <span class="new_code">MockDatabaseConnection</span>. 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/unit_tester.php');
-require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-
-Mock::generate('DatabaseConnection');
-<strong>
-class MyTestCase extends UnitTestCase {
-
- function testSomething() {
- $connection = &new MockDatabaseConnection($this);
- }
-}</strong>
-</pre>
- Contrairement aux bouchons, le constructeur d'une classe fantaisie a besoin d'une référence au scénario de test pour pouvoir transmettre les succès et les échecs pendant qu'il vérifie les attentes. Concrètement ça veut dire que les objets fantaisie ne peuvent être utilisés qu'au sein d'un scénario de test. Malgré tout, cette puissance supplémentaire implique que les bouchons ne sont que rarement utilisés si des objets fantaisie sont disponibles.
- </p>
- <p>
- <a class="target" name="bouchon">
-<h2>Objets fantaisie en action</h2>
-</a>
- </p>
- <p>
- La version fantaisie d'une classe contient toutes les méthodes de l'originale. De la sorte une opération comme <span class="new_code">$connection->query()</span> est encore possible. Tout comme avec les bouchons, nous pouvons remplacer la valeur nulle renvoyée par défaut...
-<pre>
-<strong>$connection->setReturnValue('query', 37);</strong>
-</pre>
- Désormais à chaque appel de <span class="new_code">$connection->query()</span> nous recevons comme résultat 37. Tout comme avec les bouchons nous pouvons utiliser des jokers et surcharger le paramètre joker. Nous pouvons aussi ajouter des méthodes supplémentaires à l'objet fantaisie lors de sa génération et lui choisir un nom de classe qui lui soit propre...
-<pre>
-<strong>Mock::generate('DatabaseConnection', 'MyMockDatabaseConnection', array('setOptions'));</strong>
-</pre>
- Ici l'objet fantaisie se comportera comme si <span class="new_code">setOptions()</span> existait dans la classe originale. C'est pratique si une classe a utilisé le mécanisme <span class="new_code">overload()</span> de PHP pour ajouter des méthodes dynamiques. Vous pouvez créer des fantaisies spéciales pour simuler cette situation.
- </p>
- <p>
- Tous les modèles disponibles avec les bouchons serveur le sont également avec les objets fantaisie...
-<pre>
-class Iterator {
- function Iterator() {
- }
-
- function next() {
- }
-}
-</pre>
- Une nouvelle fois, supposons que cet itérateur ne retourne que du texte jusqu'au moment où il atteint son terme, quand il renvoie <span class="new_code">false</span>. Nous pouvons le simuler avec...
-<pre>
-Mock::generate('Iterator');
-
-class IteratorTest extends UnitTestCase() {
-
- function testASequence() {<strong>
- $iterator = &new MockIterator($this);
- $iterator->setReturnValue('next', false);
- $iterator->setReturnValueAt(0, 'next', 'First string');
- $iterator->setReturnValueAt(1, 'next', 'Second string');</strong>
- ...
- }
-}
-</pre>
- Au moment du premier appel à <span class="new_code">next()</span> sur l'itérateur fantaisie il renverra tout d'abord "First string", puis ce sera au tour de "Second string" au deuxième appel et ensuite pour tout appel suivant <span class="new_code">false</span> sera renvoyé. Ces valeurs renvoyées successivement sont prioritaires sur la valeur constante retournée. Cette dernière est un genre de valeur par défaut si vous voulez.
- </p>
- <p>
- Reprenons aussi le conteneur d'information bouchonné avec des pairs clef / valeur...
-<pre>
-class Configuration {
- function Configuration() {
- }
-
- function getValue($key) {
- }
-}
-</pre>
- Il s'agit là d'une situation classique d'utilisation d'objets fantaisie étant donné que la configuration peut varier grandement de machine à machine : ça contraint fortement la fiabilité de nos tests si nous l'utilisons directement. Le problème est que toutes les données nous parviennent à travers la méthode <span class="new_code">getValue()</span> et que nous voulons des résultats différents pour des clefs différentes. Heureusement les objets fantaisie ont un système de filtrage...
-<pre>
-<strong>$config = &new MockConfiguration($this);
-$config->setReturnValue('getValue', 'primary', array('db_host'));
-$config->setReturnValue('getValue', 'admin', array('db_user'));
-$config->setReturnValue('getValue', 'secret', array('db_password'));</strong>
-</pre>
- Le paramètre en plus est une liste d'arguments à faire correspondre. Dans ce cas nous essayons de faire correspondre un unique argument : en l'occurrence la clef recherchée. Maintenant que la méthode <span class="new_code">getValue()</span> est invoquée sur l'objet fantaisie...
-<pre>
-$config->getValue('db_user')
-</pre>
- ...elle renverra "admin". Elle le trouve en essayant de faire correspondre les arguments entrants dans sa liste d'arguments sortants les uns après les autres jusqu'au moment où une correspondance exacte est atteinte.
- </p>
- <p>
- Il y a des fois où vous souhaitez qu'un objet spécifique soit servi par la fantaisie plutôt qu'une copie. De nouveau c'est identique au mécanisme des bouchons serveur...
-<pre>
-class Thing {
-}
-
-class Vector {
- function Vector() {
- }
-
- function get($index) {
- }
-}
-</pre>
- Dans ce cas vous pouvez placer une référence dans la liste renvoyée par l'objet fantaisie...
-<pre>
-$thing = new Thing();<strong>
-$vector = &new MockVector($this);
-$vector->setReturnReference('get', $thing, array(12));</strong>
-</pre>
- Avec cet arrangement vous savez qu'à chaque appel de <span class="new_code">$vector->get(12)</span> le même <span class="new_code">$thing</span> sera renvoyé.
- </p>
-
- <p>
-<a class="target" name="attentes">
-<h2>Objets fantaisie en critique</h2>
-</a>
-</p>
- <p>
- Même si les bouchons serveur vous isolent du désordre du monde réel, il ne s'agit là que de la moitié du bénéfice potentiel. Vous pouvez avoir une classe de test recevant les messages ad hoc, mais est-ce que votre nouvelle classe renvoie bien les bons ? Le tester peut devenir cafouillis sans une librairie d'objets fantaisie.
- </p>
- <p>
- Pour l'exemple, prenons une classe <span class="new_code">SessionPool</span> à laquelle nous allons ajouter une fonction de log. Plutôt que de complexifier la classe originale, nous souhaitons ajouter ce comportement avec un décorateur (GOF). Pour l'instant le code de <span class="new_code">SessionPool</span> ressemble à...
-<pre>
-<strong>class SessionPool {
- function SessionPool() {
- ...
- }
-
- function &findSession($cookie) {
- ...
- }
- ...
-}
-
-class Session {
- ...
-}</strong>
-
-</pre>
- Alors que pour notre code de log, nous avons...
-<pre>
-<strong>
-class Log {
- function Log() {
- ...
- }
-
- function message() {
- ...
- }
-}
-
-class LoggingSessionPool {
- function LoggingSessionPool(&$session_pool, &$log) {
- ...
- }
-
- function &findSession(\$cookie) {
- ...
- }
- ...
-}</strong>
-</pre>
- Dans tout ceci, la seule classe à tester est <span class="new_code">LoggingSessionPool</span>. En particulier, nous voulons vérifier que la méthode <span class="new_code">findSession()</span> est appelée avec le bon identifiant de session au sein du cookie et qu'elle renvoie bien le message "Starting session $cookie" au loggueur.
- </p>
- <p>
- Bien que nous ne testions que quelques lignes de code de production, voici la liste des choses à faire dans un scénario de test conventionnel :
- <ol>
- <li>Créer un objet de log.</li>
- <li>Indiquer le répertoire d'écriture du fichier de log.</li>
- <li>Modifier les droits sur le répertoire pour pouvoir y écrire le fichier.</li>
- <li>Créer un objet <span class="new_code">SessionPool</span>.</li>
- <li>Lancer une session, ce qui demande probablement pas mal de choses.</li>
- <li>Invoquer <span class="new_code">findSession()</span>.</li>
- <li>Lire le nouvel identifiant de sessions (en espérant qu'il existe un accesseur !).</li>
- <li>Lever une assertion de test pour vérifier que cet identifiant correspond bien au cookie.</li>
- <li>Lire la dernière ligne du fichier de log.</li>
- <li>Supprimer avec une (ou plusieurs) expression rationnelle les timestamps de log en trop, etc.</li>
- <li>Vérifier que le message de session est bien dans le texte.</li>
- </ol>
- Pas étonnant que les développeurs détestent écrire des tests quand ils sont aussi ingrats. Pour rendre les choses encore pire, à chaque fois que le format de log change ou bien que la méthode de création des sessions change, nous devons réécrire une partie des tests alors même qu'ils ne testent pas ces parties du système. Nous sommes en train de préparer le cauchemar pour les développeurs de ces autres classes.
- </p>
- <p>
- A la place, voici la méthode complète pour le test avec un peu de magie via les objets fantaisie...
-<pre>
-Mock::generate('Session');
-Mock::generate('SessionPool');
-Mock::generate('Log');
-
-class LoggingSessionPoolTest extends UnitTestCase {
- ...
- function testFindSessionLogging() {<strong>
- $session = &new MockSession($this);
- $pool = &new MockSessionPool($this);
- $pool->setReturnReference('findSession', $session);
- $pool->expectOnce('findSession', array('abc'));
-
- $log = &new MockLog($this);
- $log->expectOnce('message', array('Starting session abc'));
-
- $logging_pool = &new LoggingSessionPool($pool, $log);
- $this->assertReference($logging_pool->findSession('abc'), $session);
- $pool->tally();
- $log->tally();</strong>
- }
-}
-</pre>
- Commençons par écrire une session simulacre. Pas la peine d'être trop pointilleux avec celle-ci puisque la vérification de la session désirée est effectuée ailleurs. Nous avons juste besoin de vérifier qu'il s'agit de la même que celle qui vient du groupe commun des sessions.
- </p>
- <p>
- <span class="new_code">findSession()</span> est un méthode fabrique dont la simulation est décrite <a href="#stub">plus haut</a>. Le point de départ vient avec le premier appel <span class="new_code">expectOnce()</span>. Cette ligne indique qu'à chaque fois que <span class="new_code">findSession()</span> est invoqué sur l'objet fantaisie, il vérifiera les arguments entrant. S'il ne reçoit que la chaîne "abc" en tant qu'argument alors un succès est envoyé au testeur unitaire, sinon c'est un échec qui est généré. Il s'agit là de la partie qui teste si nous avons bien la bonne session. La liste des arguments suit une format identique à celui qui précise les valeurs renvoyées. Vous pouvez avoir des jokers et des séquences et l'ordre de l'évaluation restera le même.
- </p>
- <p>
- Si l'appel n'est jamais effectué alors n'est généré ni le succès, ni l'échec. Pour contourner cette limitation, nous devons dire à l'objet fantaisie que le test est terminé : il pourra alors décider si les attentes ont été répondues. L'assertion du testeur unitaire de ceci est déclenchée par l'appel <span class="new_code">tally()</span> à la fin du test.
- </p>
- <p>
- Nous utilisons le même modèle pour mettre sur pied le loggueur fantaisie. Nous lui indiquons que <span class="new_code">message()</span> devrait être invoqué une fois et une fois seulement avec l'argument "Starting session abc". En testant les arguments d'appel, plutôt que ceux de sorite du loggueur, nous isolons le test de tout modification dans le loggueur.
- </p>
- <p>
- Nous commençons le lancement nos tests à la création du nouveau <span class="new_code">LoggingSessionPool</span> et nous l'alimentons avec nos objets fantaisie juste créés. Désormais tout est sous contrôle. Au final nous confirmons que le <span class="new_code">$session</span> donné au décorateur est bien celui reçu et prions les objets fantaisie de lancer leurs tests de comptage d'appel interne avec les appels <span class="new_code">tally()</span>.
- </p>
- <p>
- Il y a encore pas mal de code de test, mais ce code est très strict. S'il vous semble encore terrifiant il l'est bien moins que si nous avions essayé sans les objets fantaisie et ce test en particulier, interactions plutôt que résultat, est toujours plus difficile à mettre en place. Le plus souvent vous aurez besoin de tester des situations plus complexes sans ce niveau ni cette précision. En outre une partie peut être remaniée avec la méthode de scénario de test <span class="new_code">setUp()</span>.
- </p>
- <p>
- Voici la liste complète des attentes que vous pouvez placer sur un objet fantaisie avec <a href="http://www.lastcraft.com/simple_test.php">SimpleTest</a>...
- <table>
-<thead>
- <tr>
-<th>Attente</th><th>Nécessite <span class="new_code">tally()</span></th>
-</tr>
- </thead>
-<tbody>
-<tr>
- <td><span class="new_code">expectArguments($method, $args)</span></td>
- <td style="text-align: center">Non</td>
- </tr>
- <tr>
- <td><span class="new_code">expectArgumentsAt($timing, $method, $args)</span></td>
- <td style="text-align: center">Non</td>
- </tr>
- <tr>
- <td><span class="new_code">expectCallCount($method, $count)</span></td>
- <td style="text-align: center">Oui</td>
- </tr>
- <tr>
- <td><span class="new_code">expectMaximumCallCount($method, $count)</span></td>
- <td style="text-align: center">Non</td>
- </tr>
- <tr>
- <td><span class="new_code">expectMinimumCallCount($method, $count)</span></td>
- <td style="text-align: center">Oui</td>
- </tr>
- <tr>
- <td><span class="new_code">expectNever($method)</span></td>
- <td style="text-align: center">Non</td>
- </tr>
- <tr>
- <td><span class="new_code">expectOnce($method, $args)</span></td>
- <td style="text-align: center">Oui</td>
- </tr>
- <tr>
- <td><span class="new_code">expectAtLeastOnce($method, $args)</span></td>
- <td style="text-align: center">Oui</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, à laquelle la condition doit être appliquée.</dd>
- <dt class="new_code">$args</dt>
- <dd>
- Les arguments sous la forme d'une liste. Les jokers peuvent être inclus de la même manière qu'avec <span class="new_code">setReturn()</span>. Cet argument est optionel pour <span class="new_code">expectOnce()</span> et <span class="new_code">expectAtLeastOnce()</span>.
- </dd>
- <dt class="new_code">$timing</dt>
- <dd>
- Le seul point dans le temps pour tester la condition. Le premier appel commence à zéro.
- </dd>
- <dt class="new_code">$count</dt>
- <dd>Le nombre d'appels attendu.</dd>
- </dl>
- La méthode <span class="new_code">expectMaximumCallCount()</span> est légèrement différente dans le sens où elle ne pourra générer qu'un échec. Elle reste silencieuse si la limite n'est jamais atteinte.
- </p>
- <p>
- Comme avec les assertions dans les scénarios de test, toutes ces attentes peuvent accepter une surcharge de message sous la forme d'un paramètre supplémentaire. Par ailleurs le message d'échec original peut être inclus dans le résultat avec "%s".
- </p>
-
- <p>
-<a class="target" name="approches">
-<h2>D'autres approches</h2>
-</a>
-</p>
- <p>
- Il existe trois approches pour créer des objets fantaisie en comprenant celle utiliser par SimpleTest. Les coder à la main en utilisant une classe de base, les générer dans un fichier ou les générer dynamiquement à la volée.
- </p>
- <p>
- Les objets fantaisie générés avec <a href="simple_test.html">SimpleTest</a> sont dynamiques. Ils sont créés à l'exécution dans la mémoire, grâce à <span class="new_code">eval()</span>, plutôt qu'écrit dans un fichier. Cette opération les rend facile à créer, en une seule ligne, surtout par rapport à leur création à la main dans une hiérarchie de classe parallèle. Le problème avec ce comportement tient généralement dans la mise en place des tests proprement dits. Si les objets originaux changent les versions fantaisie sur lesquels reposent les tests, une désynchronisation peut subvenir. Cela peut aussi arriver avec l'approche en hiérarchie parallèle, mais c'est détecté beaucoup plus vite.
- </p>
- <p>
- Bien sûr, la solution est d'ajouter de véritables tests d'intégration. Vous n'en avez pas besoin de beaucoup et le côté pratique des objets fantaisie fait plus que compenser la petite dose de test supplémentaire. Vous ne pouvez pas avoir confiance dans du code qui ne serait testé que par des objets fantaisie.
- </p>
- <p>
- Si vous restez déterminé de construire des librairies statiques d'objets fantaisie parce que vous souhaitez émuler un comportement très spécifique, vous pouvez y parvenir grâce au générateur de classe de SimpleTest. Dans votre fichier librairie, par exemple <em>mocks/connection.php</em> pour une connexion à une base de données, créer un objet fantaisie et provoquer m'héritage pour hériter pour surcharger des méthodes spéciales ou ajouter des préréglages...
-<pre>
-<?php
- require_once('simpletest/mock_objects.php');
- require_once('../classes/connection.php');
-<strong>
- Mock::generate('Connection', 'BasicMockConnection');
- class MockConnection extends BasicMockConnection {
- function MockConnection(&$test, $wildcard = '*') {
- $this->BasicMockConnection($test, $wildcard);
- $this->setReturn('query', false);
- }
- }</strong>
-?>
-</pre>
- L'appel <span class="new_code">generate</span> dit au générateur de classe d'en créer une appelée <span class="new_code">BasicMockConnection</span> plutôt que la plus courante <span class="new_code">MockConnection</span>. Ensuite nous héritons à partir de celle-ci pour obtenir notre version de <span class="new_code">MockConnection</span>. En interceptant de cette manière nous pouvons ajouter un comportement, ici transformer la valeur par défaut de <span class="new_code">query()</span> en "false".
- En utilisant le nom par défaut nous garantissons que le générateur de classe fantaisie n'en recréera pas une autre différente si il est invoqué ailleurs dans les tests. Il ne créera jamais de classe si elle existe déjà. Aussi longtemps que le fichier ci-dessus est inclus avant alors tous les tests qui généraient <span class="new_code">MockConnection</span> devraient utiliser notre version à présent. Par contre si nous avons une erreur dans l'ordre et que la librairie de fantaisie en crée une d'abord alors la création de la classe échouera tout simplement.
- </p>
- <p>
- Utiliser cette astuce si vous vous trouvez avec beaucoup de comportement en commun sur les objets fantaisie ou si vous avez de fréquents problèmes d'intégration plus tard dans les étapes de test.
- </p>
-
- <p>
-<a class="target" name="autres_testeurs">
-<h2>Je pense que SimpleTest pue !</h2>
-</a>
-</p>
- <p>
- Mais au moment d'écrire ces lignes c'est le seul à gérer les objets fantaisie, donc vous êtes bloqué avec lui ?
- </p>
- <p>
- Non, pas du tout.
- <a href="simple_test.html">SimpleTest</a> est une boîte à outils et parmi ceux-ci on trouve les objets fantaisie qui peuvent être utilisés indépendamment. Supposons que vous avez votre propre testeur unitaire favori et que tous vos tests actuels l'utilisent. Prétendez que vous avez appelé votre tester unitaire PHPUnit (c'est ce que tout le monde a fait) et que la classe principale de test ressemble à...
-<pre>
-class PHPUnit {
- function PHPUnit() {
- }
-
- function assertion($message, $assertion) {
- }
- ...
-}
-</pre>
- La seule chose que la méthode <span class="new_code">assertion()</span> réalise, c'est de préparer une sortie embellie alors le paramètre boolien de l'assertion sert à déterminer s'il s'agit d'une erreur ou d'un succès. Supposons qu'elle est utilisée de la manière suivante...
-<pre>
-$unit_test = new PHPUnit();
-$unit_test>assertion('I hope this file exists', file_exists('my_file'));
-</pre>
- Comment utiliser les objets fantaisie avec ceci ?
- </p>
- <p>
- Il y a une méthode protégée sur la classe de base des objets fantaisie : elle s'appelle <span class="new_code">_assertTrue()</span>. En surchargeant cette méthode nous pouvons utiliser notre propre format d'assertion. Nous commençons avec une sous-classe, dans <em>my_mock.php</em>...
-<pre>
-<strong><?php
- require_once('simpletest/mock_objects.php');
-
- class MyMock extends SimpleMock() {
- function MyMock(&$test, $wildcard) {
- $this->SimpleMock($test, $wildcard);
- }
-
- function _assertTrue($assertion, $message) {
- $test = &$this->getTest();
- $test->assertion($message, $assertion);
- }
- }
-?></strong>
-</pre>
- Maintenant une instance de <span class="new_code">MyMock</span> créera un objet qui parle le même langage que votre testeur. Bien sûr le truc c'est que nous créons jamais un tel objet : le générateur s'en chargera. Nous avons juste besoin d'une ligne de code supplémentaire pour dire au générateur d'utiliser vos nouveaux objets fantaisie...
-<pre>
-<?php
- require_once('simpletst/mock_objects.php');
-
- class MyMock extends SimpleMock() {
- function MyMock($test, $wildcard) {
- $this->SimpleMock(&$test, $wildcard);
- }
-
- function _assertTrue($assertion, $message , &$test) {
- $test->assertion($message, $assertion);
- }
- }<strong>
- SimpleTestOptions::setMockBaseClass('MyMock');</strong>
-?>
-</pre>
- A partir de maintenant vous avez juste à inclure <em>my_mock.php</em> à la place de la version par défaut <em>simple_mock.php</em> et vous pouvez introduire des objets fantaisie dans votre suite de tests existants.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur les objets fantaisie</h1> +<div class="content"> + <p> +<a class="target" name="quoi"> +<h2>Que sont les objets fantaisie ?</h2> +</a> +</p> + <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>. + </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. 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> + + <p> +<a class="target" name="creation"> +<h2>Créer des objets fantaisie</h2> +</a> +</p> + <p> + Comme pour la création des bouchons serveur, tout ce dont nous avons besoin c'est d'un classe existante. La fameuse connexion à une base de données qui ressemblerait à... +<pre> +<strong>class DatabaseConnection { + function DatabaseConnection() { + } + + function query() { + } + + function selectQuery() { + } +}</strong> +</pre> + Cette classe n'a pas encore besoin d'être implémentée. Pour en créer sa version fantaisie nous devons juste inclure la librairie d'objet fantaisie puis lancer le générateur... +<pre> +<strong>require_once('simpletest/unit_tester.php'); +require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); + +Mock::generate('DatabaseConnection');</strong> +</pre> + Ceci génère une classe clone appelée <span class="new_code">MockDatabaseConnection</span>. 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/unit_tester.php'); +require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); + +Mock::generate('DatabaseConnection'); +<strong> +class MyTestCase extends UnitTestCase { + + function testSomething() { + $connection = &new MockDatabaseConnection($this); + } +}</strong> +</pre> + Contrairement aux bouchons, le constructeur d'une classe fantaisie a besoin d'une référence au scénario de test pour pouvoir transmettre les succès et les échecs pendant qu'il vérifie les attentes. Concrètement ça veut dire que les objets fantaisie ne peuvent être utilisés qu'au sein d'un scénario de test. Malgré tout, cette puissance supplémentaire implique que les bouchons ne sont que rarement utilisés si des objets fantaisie sont disponibles. + </p> + <p> + <a class="target" name="bouchon"> +<h2>Objets fantaisie en action</h2> +</a> + </p> + <p> + La version fantaisie d'une classe contient toutes les méthodes de l'originale. De la sorte une opération comme <span class="new_code">$connection->query()</span> est encore possible. Tout comme avec les bouchons, nous pouvons remplacer la valeur nulle renvoyée par défaut... +<pre> +<strong>$connection->setReturnValue('query', 37);</strong> +</pre> + Désormais à chaque appel de <span class="new_code">$connection->query()</span> nous recevons comme résultat 37. Tout comme avec les bouchons nous pouvons utiliser des jokers et surcharger le paramètre joker. Nous pouvons aussi ajouter des méthodes supplémentaires à l'objet fantaisie lors de sa génération et lui choisir un nom de classe qui lui soit propre... +<pre> +<strong>Mock::generate('DatabaseConnection', 'MyMockDatabaseConnection', array('setOptions'));</strong> +</pre> + Ici l'objet fantaisie se comportera comme si <span class="new_code">setOptions()</span> existait dans la classe originale. C'est pratique si une classe a utilisé le mécanisme <span class="new_code">overload()</span> de PHP pour ajouter des méthodes dynamiques. Vous pouvez créer des fantaisies spéciales pour simuler cette situation. + </p> + <p> + Tous les modèles disponibles avec les bouchons serveur le sont également avec les objets fantaisie... +<pre> +class Iterator { + function Iterator() { + } + + function next() { + } +} +</pre> + Une nouvelle fois, supposons que cet itérateur ne retourne que du texte jusqu'au moment où il atteint son terme, quand il renvoie <span class="new_code">false</span>. Nous pouvons le simuler avec... +<pre> +Mock::generate('Iterator'); + +class IteratorTest extends UnitTestCase() { + + function testASequence() {<strong> + $iterator = &new MockIterator($this); + $iterator->setReturnValue('next', false); + $iterator->setReturnValueAt(0, 'next', 'First string'); + $iterator->setReturnValueAt(1, 'next', 'Second string');</strong> + ... + } +} +</pre> + Au moment du premier appel à <span class="new_code">next()</span> sur l'itérateur fantaisie il renverra tout d'abord "First string", puis ce sera au tour de "Second string" au deuxième appel et ensuite pour tout appel suivant <span class="new_code">false</span> sera renvoyé. Ces valeurs renvoyées successivement sont prioritaires sur la valeur constante retournée. Cette dernière est un genre de valeur par défaut si vous voulez. + </p> + <p> + Reprenons aussi le conteneur d'information bouchonné avec des pairs clef / valeur... +<pre> +class Configuration { + function Configuration() { + } + + function getValue($key) { + } +} +</pre> + Il s'agit là d'une situation classique d'utilisation d'objets fantaisie étant donné que la configuration peut varier grandement de machine à machine : ça contraint fortement la fiabilité de nos tests si nous l'utilisons directement. Le problème est que toutes les données nous parviennent à travers la méthode <span class="new_code">getValue()</span> et que nous voulons des résultats différents pour des clefs différentes. Heureusement les objets fantaisie ont un système de filtrage... +<pre> +<strong>$config = &new MockConfiguration($this); +$config->setReturnValue('getValue', 'primary', array('db_host')); +$config->setReturnValue('getValue', 'admin', array('db_user')); +$config->setReturnValue('getValue', 'secret', array('db_password'));</strong> +</pre> + Le paramètre en plus est une liste d'arguments à faire correspondre. Dans ce cas nous essayons de faire correspondre un unique argument : en l'occurrence la clef recherchée. Maintenant que la méthode <span class="new_code">getValue()</span> est invoquée sur l'objet fantaisie... +<pre> +$config->getValue('db_user') +</pre> + ...elle renverra "admin". Elle le trouve en essayant de faire correspondre les arguments entrants dans sa liste d'arguments sortants les uns après les autres jusqu'au moment où une correspondance exacte est atteinte. + </p> + <p> + Il y a des fois où vous souhaitez qu'un objet spécifique soit servi par la fantaisie plutôt qu'une copie. De nouveau c'est identique au mécanisme des bouchons serveur... +<pre> +class Thing { +} + +class Vector { + function Vector() { + } + + function get($index) { + } +} +</pre> + Dans ce cas vous pouvez placer une référence dans la liste renvoyée par l'objet fantaisie... +<pre> +$thing = new Thing();<strong> +$vector = &new MockVector($this); +$vector->setReturnReference('get', $thing, array(12));</strong> +</pre> + Avec cet arrangement vous savez qu'à chaque appel de <span class="new_code">$vector->get(12)</span> le même <span class="new_code">$thing</span> sera renvoyé. + </p> + + <p> +<a class="target" name="attentes"> +<h2>Objets fantaisie en critique</h2> +</a> +</p> + <p> + Même si les bouchons serveur vous isolent du désordre du monde réel, il ne s'agit là que de la moitié du bénéfice potentiel. Vous pouvez avoir une classe de test recevant les messages ad hoc, mais est-ce que votre nouvelle classe renvoie bien les bons ? Le tester peut devenir cafouillis sans une librairie d'objets fantaisie. + </p> + <p> + Pour l'exemple, prenons une classe <span class="new_code">SessionPool</span> à laquelle nous allons ajouter une fonction de log. Plutôt que de complexifier la classe originale, nous souhaitons ajouter ce comportement avec un décorateur (GOF). Pour l'instant le code de <span class="new_code">SessionPool</span> ressemble à... +<pre> +<strong>class SessionPool { + function SessionPool() { + ... + } + + function &findSession($cookie) { + ... + } + ... +} + +class Session { + ... +}</strong> + +</pre> + Alors que pour notre code de log, nous avons... +<pre> +<strong> +class Log { + function Log() { + ... + } + + function message() { + ... + } +} + +class LoggingSessionPool { + function LoggingSessionPool(&$session_pool, &$log) { + ... + } + + function &findSession(\$cookie) { + ... + } + ... +}</strong> +</pre> + Dans tout ceci, la seule classe à tester est <span class="new_code">LoggingSessionPool</span>. En particulier, nous voulons vérifier que la méthode <span class="new_code">findSession()</span> est appelée avec le bon identifiant de session au sein du cookie et qu'elle renvoie bien le message "Starting session $cookie" au loggueur. + </p> + <p> + Bien que nous ne testions que quelques lignes de code de production, voici la liste des choses à faire dans un scénario de test conventionnel : + <ol> + <li>Créer un objet de log.</li> + <li>Indiquer le répertoire d'écriture du fichier de log.</li> + <li>Modifier les droits sur le répertoire pour pouvoir y écrire le fichier.</li> + <li>Créer un objet <span class="new_code">SessionPool</span>.</li> + <li>Lancer une session, ce qui demande probablement pas mal de choses.</li> + <li>Invoquer <span class="new_code">findSession()</span>.</li> + <li>Lire le nouvel identifiant de sessions (en espérant qu'il existe un accesseur !).</li> + <li>Lever une assertion de test pour vérifier que cet identifiant correspond bien au cookie.</li> + <li>Lire la dernière ligne du fichier de log.</li> + <li>Supprimer avec une (ou plusieurs) expression rationnelle les timestamps de log en trop, etc.</li> + <li>Vérifier que le message de session est bien dans le texte.</li> + </ol> + Pas étonnant que les développeurs détestent écrire des tests quand ils sont aussi ingrats. Pour rendre les choses encore pire, à chaque fois que le format de log change ou bien que la méthode de création des sessions change, nous devons réécrire une partie des tests alors même qu'ils ne testent pas ces parties du système. Nous sommes en train de préparer le cauchemar pour les développeurs de ces autres classes. + </p> + <p> + A la place, voici la méthode complète pour le test avec un peu de magie via les objets fantaisie... +<pre> +Mock::generate('Session'); +Mock::generate('SessionPool'); +Mock::generate('Log'); + +class LoggingSessionPoolTest extends UnitTestCase { + ... + function testFindSessionLogging() {<strong> + $session = &new MockSession($this); + $pool = &new MockSessionPool($this); + $pool->setReturnReference('findSession', $session); + $pool->expectOnce('findSession', array('abc')); + + $log = &new MockLog($this); + $log->expectOnce('message', array('Starting session abc')); + + $logging_pool = &new LoggingSessionPool($pool, $log); + $this->assertReference($logging_pool->findSession('abc'), $session); + $pool->tally(); + $log->tally();</strong> + } +} +</pre> + Commençons par écrire une session simulacre. Pas la peine d'être trop pointilleux avec celle-ci puisque la vérification de la session désirée est effectuée ailleurs. Nous avons juste besoin de vérifier qu'il s'agit de la même que celle qui vient du groupe commun des sessions. + </p> + <p> + <span class="new_code">findSession()</span> est un méthode fabrique dont la simulation est décrite <a href="#stub">plus haut</a>. Le point de départ vient avec le premier appel <span class="new_code">expectOnce()</span>. Cette ligne indique qu'à chaque fois que <span class="new_code">findSession()</span> est invoqué sur l'objet fantaisie, il vérifiera les arguments entrant. S'il ne reçoit que la chaîne "abc" en tant qu'argument alors un succès est envoyé au testeur unitaire, sinon c'est un échec qui est généré. Il s'agit là de la partie qui teste si nous avons bien la bonne session. La liste des arguments suit une format identique à celui qui précise les valeurs renvoyées. Vous pouvez avoir des jokers et des séquences et l'ordre de l'évaluation restera le même. + </p> + <p> + Si l'appel n'est jamais effectué alors n'est généré ni le succès, ni l'échec. Pour contourner cette limitation, nous devons dire à l'objet fantaisie que le test est terminé : il pourra alors décider si les attentes ont été répondues. L'assertion du testeur unitaire de ceci est déclenchée par l'appel <span class="new_code">tally()</span> à la fin du test. + </p> + <p> + Nous utilisons le même modèle pour mettre sur pied le loggueur fantaisie. Nous lui indiquons que <span class="new_code">message()</span> devrait être invoqué une fois et une fois seulement avec l'argument "Starting session abc". En testant les arguments d'appel, plutôt que ceux de sorite du loggueur, nous isolons le test de tout modification dans le loggueur. + </p> + <p> + Nous commençons le lancement nos tests à la création du nouveau <span class="new_code">LoggingSessionPool</span> et nous l'alimentons avec nos objets fantaisie juste créés. Désormais tout est sous contrôle. Au final nous confirmons que le <span class="new_code">$session</span> donné au décorateur est bien celui reçu et prions les objets fantaisie de lancer leurs tests de comptage d'appel interne avec les appels <span class="new_code">tally()</span>. + </p> + <p> + Il y a encore pas mal de code de test, mais ce code est très strict. S'il vous semble encore terrifiant il l'est bien moins que si nous avions essayé sans les objets fantaisie et ce test en particulier, interactions plutôt que résultat, est toujours plus difficile à mettre en place. Le plus souvent vous aurez besoin de tester des situations plus complexes sans ce niveau ni cette précision. En outre une partie peut être remaniée avec la méthode de scénario de test <span class="new_code">setUp()</span>. + </p> + <p> + Voici la liste complète des attentes que vous pouvez placer sur un objet fantaisie avec <a href="http://www.lastcraft.com/simple_test.php">SimpleTest</a>... + <table> +<thead> + <tr> +<th>Attente</th><th>Nécessite <span class="new_code">tally()</span></th> +</tr> + </thead> +<tbody> +<tr> + <td><span class="new_code">expectArguments($method, $args)</span></td> + <td style="text-align: center">Non</td> + </tr> + <tr> + <td><span class="new_code">expectArgumentsAt($timing, $method, $args)</span></td> + <td style="text-align: center">Non</td> + </tr> + <tr> + <td><span class="new_code">expectCallCount($method, $count)</span></td> + <td style="text-align: center">Oui</td> + </tr> + <tr> + <td><span class="new_code">expectMaximumCallCount($method, $count)</span></td> + <td style="text-align: center">Non</td> + </tr> + <tr> + <td><span class="new_code">expectMinimumCallCount($method, $count)</span></td> + <td style="text-align: center">Oui</td> + </tr> + <tr> + <td><span class="new_code">expectNever($method)</span></td> + <td style="text-align: center">Non</td> + </tr> + <tr> + <td><span class="new_code">expectOnce($method, $args)</span></td> + <td style="text-align: center">Oui</td> + </tr> + <tr> + <td><span class="new_code">expectAtLeastOnce($method, $args)</span></td> + <td style="text-align: center">Oui</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, à laquelle la condition doit être appliquée.</dd> + <dt class="new_code">$args</dt> + <dd> + Les arguments sous la forme d'une liste. Les jokers peuvent être inclus de la même manière qu'avec <span class="new_code">setReturn()</span>. Cet argument est optionel pour <span class="new_code">expectOnce()</span> et <span class="new_code">expectAtLeastOnce()</span>. + </dd> + <dt class="new_code">$timing</dt> + <dd> + Le seul point dans le temps pour tester la condition. Le premier appel commence à zéro. + </dd> + <dt class="new_code">$count</dt> + <dd>Le nombre d'appels attendu.</dd> + </dl> + La méthode <span class="new_code">expectMaximumCallCount()</span> est légèrement différente dans le sens où elle ne pourra générer qu'un échec. Elle reste silencieuse si la limite n'est jamais atteinte. + </p> + <p> + Comme avec les assertions dans les scénarios de test, toutes ces attentes peuvent accepter une surcharge de message sous la forme d'un paramètre supplémentaire. Par ailleurs le message d'échec original peut être inclus dans le résultat avec "%s". + </p> + + <p> +<a class="target" name="approches"> +<h2>D'autres approches</h2> +</a> +</p> + <p> + Il existe trois approches pour créer des objets fantaisie en comprenant celle utiliser par SimpleTest. Les coder à la main en utilisant une classe de base, les générer dans un fichier ou les générer dynamiquement à la volée. + </p> + <p> + Les objets fantaisie générés avec <a href="simple_test.html">SimpleTest</a> sont dynamiques. Ils sont créés à l'exécution dans la mémoire, grâce à <span class="new_code">eval()</span>, plutôt qu'écrit dans un fichier. Cette opération les rend facile à créer, en une seule ligne, surtout par rapport à leur création à la main dans une hiérarchie de classe parallèle. Le problème avec ce comportement tient généralement dans la mise en place des tests proprement dits. Si les objets originaux changent les versions fantaisie sur lesquels reposent les tests, une désynchronisation peut subvenir. Cela peut aussi arriver avec l'approche en hiérarchie parallèle, mais c'est détecté beaucoup plus vite. + </p> + <p> + Bien sûr, la solution est d'ajouter de véritables tests d'intégration. Vous n'en avez pas besoin de beaucoup et le côté pratique des objets fantaisie fait plus que compenser la petite dose de test supplémentaire. Vous ne pouvez pas avoir confiance dans du code qui ne serait testé que par des objets fantaisie. + </p> + <p> + Si vous restez déterminé de construire des librairies statiques d'objets fantaisie parce que vous souhaitez émuler un comportement très spécifique, vous pouvez y parvenir grâce au générateur de classe de SimpleTest. Dans votre fichier librairie, par exemple <em>mocks/connection.php</em> pour une connexion à une base de données, créer un objet fantaisie et provoquer m'héritage pour hériter pour surcharger des méthodes spéciales ou ajouter des préréglages... +<pre> +<?php + require_once('simpletest/mock_objects.php'); + require_once('../classes/connection.php'); +<strong> + Mock::generate('Connection', 'BasicMockConnection'); + class MockConnection extends BasicMockConnection { + function MockConnection(&$test, $wildcard = '*') { + $this->BasicMockConnection($test, $wildcard); + $this->setReturn('query', false); + } + }</strong> +?> +</pre> + L'appel <span class="new_code">generate</span> dit au générateur de classe d'en créer une appelée <span class="new_code">BasicMockConnection</span> plutôt que la plus courante <span class="new_code">MockConnection</span>. Ensuite nous héritons à partir de celle-ci pour obtenir notre version de <span class="new_code">MockConnection</span>. En interceptant de cette manière nous pouvons ajouter un comportement, ici transformer la valeur par défaut de <span class="new_code">query()</span> en "false". + En utilisant le nom par défaut nous garantissons que le générateur de classe fantaisie n'en recréera pas une autre différente si il est invoqué ailleurs dans les tests. Il ne créera jamais de classe si elle existe déjà. Aussi longtemps que le fichier ci-dessus est inclus avant alors tous les tests qui généraient <span class="new_code">MockConnection</span> devraient utiliser notre version à présent. Par contre si nous avons une erreur dans l'ordre et que la librairie de fantaisie en crée une d'abord alors la création de la classe échouera tout simplement. + </p> + <p> + Utiliser cette astuce si vous vous trouvez avec beaucoup de comportement en commun sur les objets fantaisie ou si vous avez de fréquents problèmes d'intégration plus tard dans les étapes de test. + </p> + + <p> +<a class="target" name="autres_testeurs"> +<h2>Je pense que SimpleTest pue !</h2> +</a> +</p> + <p> + Mais au moment d'écrire ces lignes c'est le seul à gérer les objets fantaisie, donc vous êtes bloqué avec lui ? + </p> + <p> + Non, pas du tout. + <a href="simple_test.html">SimpleTest</a> est une boîte à outils et parmi ceux-ci on trouve les objets fantaisie qui peuvent être utilisés indépendamment. Supposons que vous avez votre propre testeur unitaire favori et que tous vos tests actuels l'utilisent. Prétendez que vous avez appelé votre tester unitaire PHPUnit (c'est ce que tout le monde a fait) et que la classe principale de test ressemble à... +<pre> +class PHPUnit { + function PHPUnit() { + } + + function assertion($message, $assertion) { + } + ... +} +</pre> + La seule chose que la méthode <span class="new_code">assertion()</span> réalise, c'est de préparer une sortie embellie alors le paramètre boolien de l'assertion sert à déterminer s'il s'agit d'une erreur ou d'un succès. Supposons qu'elle est utilisée de la manière suivante... +<pre> +$unit_test = new PHPUnit(); +$unit_test>assertion('I hope this file exists', file_exists('my_file')); +</pre> + Comment utiliser les objets fantaisie avec ceci ? + </p> + <p> + Il y a une méthode protégée sur la classe de base des objets fantaisie : elle s'appelle <span class="new_code">_assertTrue()</span>. En surchargeant cette méthode nous pouvons utiliser notre propre format d'assertion. Nous commençons avec une sous-classe, dans <em>my_mock.php</em>... +<pre> +<strong><?php + require_once('simpletest/mock_objects.php'); + + class MyMock extends SimpleMock() { + function MyMock(&$test, $wildcard) { + $this->SimpleMock($test, $wildcard); + } + + function _assertTrue($assertion, $message) { + $test = &$this->getTest(); + $test->assertion($message, $assertion); + } + } +?></strong> +</pre> + Maintenant une instance de <span class="new_code">MyMock</span> créera un objet qui parle le même langage que votre testeur. Bien sûr le truc c'est que nous créons jamais un tel objet : le générateur s'en chargera. Nous avons juste besoin d'une ligne de code supplémentaire pour dire au générateur d'utiliser vos nouveaux objets fantaisie... +<pre> +<?php + require_once('simpletst/mock_objects.php'); + + class MyMock extends SimpleMock() { + function MyMock($test, $wildcard) { + $this->SimpleMock(&$test, $wildcard); + } + + function _assertTrue($assertion, $message , &$test) { + $test->assertion($message, $assertion); + } + }<strong> + SimpleTestOptions::setMockBaseClass('MyMock');</strong> +?> +</pre> + A partir de maintenant vous avez juste à inclure <em>my_mock.php</em> à la place de la version par défaut <em>simple_mock.php</em> et vous pouvez introduire des objets fantaisie dans votre suite de tests existants. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/overview.html b/tests/test_tools/simpletest/docs/fr/overview.html index 3d6663a0..b6965753 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/overview.html +++ b/tests/test_tools/simpletest/docs/fr/overview.html @@ -1,294 +1,294 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Apercu de SimpleTest</h1>
-<div class="content">
- <p>
-<a class="target" name="resume">
-<h2>Qu'est-ce que SimpleTest ?</h2>
-</a>
-</p>
- <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 = &new Log('my.log');
- $log->message('Hello');
- $this->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->get('http://www.my-site.com/index.php');
- $this->assertTitle('My Home Page');
- $this->clickLink('Contact');
- $this->assertTitle('Contact me');
- $this->assertWantedPattern('/Email me at/');
- }</strong>
-}
-</pre>
- </p>
-
- <p>
-<a class="target" name="fonctionnalites">
-<h2>Liste des fonctionnalites</h2>
-</a>
-</p>
- <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 test 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>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>
- <tr>
- <td>Test de l'upload de fichier</td>
- <td>Peut simuler la balise input de type file</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>
-
- <p>
-<a class="target" name="ressources">
-<h2>Ressources sur le web pour les tests</h2>
-</a>
-</p>
- <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/wiki/MocksObjectsPaper">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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Apercu de SimpleTest</h1> +<div class="content"> + <p> +<a class="target" name="resume"> +<h2>Qu'est-ce que SimpleTest ?</h2> +</a> +</p> + <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 = &new Log('my.log'); + $log->message('Hello'); + $this->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->get('http://www.my-site.com/index.php'); + $this->assertTitle('My Home Page'); + $this->clickLink('Contact'); + $this->assertTitle('Contact me'); + $this->assertWantedPattern('/Email me at/'); + }</strong> +} +</pre> + </p> + + <p> +<a class="target" name="fonctionnalites"> +<h2>Liste des fonctionnalites</h2> +</a> +</p> + <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 test 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>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> + <tr> + <td>Test de l'upload de fichier</td> + <td>Peut simuler la balise input de type file</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> + + <p> +<a class="target" name="ressources"> +<h2>Ressources sur le web pour les tests</h2> +</a> +</p> + <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/wiki/MocksObjectsPaper">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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/partial_mocks_documentation.html b/tests/test_tools/simpletest/docs/fr/partial_mocks_documentation.html index e71bffdb..4098ab45 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/partial_mocks_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/partial_mocks_documentation.html @@ -1,333 +1,333 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur les objets fantaisie partiels</h1>
-<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>
-
- <p>
-<a class="target" name="injection">
-<h2>Le problème de l'injection dans un objet fantaisie</h2>
-</a>
-</p>
- <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><?php
- require_once('socket.php');
-
- class Telnet {
- ...
- function &connect($ip, $port, $username, $password) {
- $socket = &new Socket($ip, $port);
- $socket->read( ... );
- ...
- }
- }
-?></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>
-<?php
- require_once('socket.php');
-
- class Telnet {
- ...
- <strong>function &connect(&$socket, $username, $password) {
- $socket->read( ... );
- ...
- }</strong>
- }
-?>
-</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($this);
- ...
- $telnet = &new Telnet();
- $telnet->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>
-<?php
- require_once('socket.php');
-
- class Telnet {
- ...<strong>
- function &connect($ip, $port, $username, $password, $socket = false) {
- if (!$socket) {
- $socket = &new Socket($ip, $port);
- }
- $socket->read( ... );</strong>
- ...
- return $socket;
- }
- }
-?>
-</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($this);
- ...
- $telnet = &new Telnet();
- $telnet->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>
-<?php
- require_once('socket.php');
-
- class Telnet {<strong>
- function Telnet(&$network) {
- $this->_network = &$network;
- }</strong>
- ...
- function &connect($ip, $port, $username, $password) {<strong>
- $socket = &$this->_network->createSocket($ip, $port);
- $socket->read( ... );</strong>
- ...
- return $socket;
- }
- }
-?>
-</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($this);
- ...
- $network = &new MockNetwork($this);
- $network->setReturnReference('createSocket', $socket);
- $telnet = &new Telnet($network);
- $telnet->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>
- Peut-on trouver un juste milieu ?
- </p>
-
- <p>
-<a class="target" name="creation">
-<h2>Méthode fabrique protégée</h2>
-</a>
-</p>
- <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>
-<?php
- require_once('socket.php');
-
- class Telnet {
- ...
- function &connect($ip, $port, $username, $password) {<strong>
- $socket = &$this->_createSocket($ip, $port);</strong>
- $socket->read( ... );
- ...
- }<strong>
-
- function &_createSocket($ip, $port) {
- return new Socket($ip, $port);
- }</strong>
- }
-?>
-</pre>
- 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->_mock = &$mock;
- $this->Telnet();
- }
-
- function &_createSocket() {
- return $this->_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($this);
- ...
- $telnet = &new TelnetTestVersion($socket);
- $telnet->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>
-
- <p>
-<a class="target" name="partiel">
-<h2>Un objet fantaisie partiel</h2>
-</a>
-</p>
- <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($this);
- ...
- $telnet = &new TelnetTestVersion($this);
- $telnet->setReturnReference('_createSocket', $socket);
- $telnet->Telnet();
- $telnet->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($this);
- ...
- $telnet = &new TelnetTestVersion($this);
- $telnet->setReturnReference('_createSocket', $socket);<strong>
- $telnet->expectOnce('_createSocket', array('127.0.0.1', 21));</strong>
- $telnet->Telnet();
- $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
- ...<strong>
- $telnet->tally();</strong>
- }
-}
-</pre>
- </p>
-
- <p>
-<a class="target" name="moins">
-<h2>Tester moins qu'une classe</h2>
-</a>
-</p>
- <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éthode à part celle que nous voulons effectivement tester.
- </p>
- <p>
- Cette situation est assez hypothétique, étant donné que je ne l'ai jamais essayée. Je suis ouvert à cette possibilité, mais 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>
- Pour choisir le mécanisme à utiliser, on en revient toujours aux standards de code de votre projet.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur les objets fantaisie partiels</h1> +<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> + + <p> +<a class="target" name="injection"> +<h2>Le problème de l'injection dans un objet fantaisie</h2> +</a> +</p> + <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><?php + require_once('socket.php'); + + class Telnet { + ... + function &connect($ip, $port, $username, $password) { + $socket = &new Socket($ip, $port); + $socket->read( ... ); + ... + } + } +?></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> +<?php + require_once('socket.php'); + + class Telnet { + ... + <strong>function &connect(&$socket, $username, $password) { + $socket->read( ... ); + ... + }</strong> + } +?> +</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($this); + ... + $telnet = &new Telnet(); + $telnet->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> +<?php + require_once('socket.php'); + + class Telnet { + ...<strong> + function &connect($ip, $port, $username, $password, $socket = false) { + if (!$socket) { + $socket = &new Socket($ip, $port); + } + $socket->read( ... );</strong> + ... + return $socket; + } + } +?> +</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($this); + ... + $telnet = &new Telnet(); + $telnet->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> +<?php + require_once('socket.php'); + + class Telnet {<strong> + function Telnet(&$network) { + $this->_network = &$network; + }</strong> + ... + function &connect($ip, $port, $username, $password) {<strong> + $socket = &$this->_network->createSocket($ip, $port); + $socket->read( ... );</strong> + ... + return $socket; + } + } +?> +</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($this); + ... + $network = &new MockNetwork($this); + $network->setReturnReference('createSocket', $socket); + $telnet = &new Telnet($network); + $telnet->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> + Peut-on trouver un juste milieu ? + </p> + + <p> +<a class="target" name="creation"> +<h2>Méthode fabrique protégée</h2> +</a> +</p> + <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> +<?php + require_once('socket.php'); + + class Telnet { + ... + function &connect($ip, $port, $username, $password) {<strong> + $socket = &$this->_createSocket($ip, $port);</strong> + $socket->read( ... ); + ... + }<strong> + + function &_createSocket($ip, $port) { + return new Socket($ip, $port); + }</strong> + } +?> +</pre> + 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->_mock = &$mock; + $this->Telnet(); + } + + function &_createSocket() { + return $this->_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($this); + ... + $telnet = &new TelnetTestVersion($socket); + $telnet->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> + + <p> +<a class="target" name="partiel"> +<h2>Un objet fantaisie partiel</h2> +</a> +</p> + <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($this); + ... + $telnet = &new TelnetTestVersion($this); + $telnet->setReturnReference('_createSocket', $socket); + $telnet->Telnet(); + $telnet->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($this); + ... + $telnet = &new TelnetTestVersion($this); + $telnet->setReturnReference('_createSocket', $socket);<strong> + $telnet->expectOnce('_createSocket', array('127.0.0.1', 21));</strong> + $telnet->Telnet(); + $telnet->connect('127.0.0.1', 21, 'Me', 'Secret'); + ...<strong> + $telnet->tally();</strong> + } +} +</pre> + </p> + + <p> +<a class="target" name="moins"> +<h2>Tester moins qu'une classe</h2> +</a> +</p> + <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éthode à part celle que nous voulons effectivement tester. + </p> + <p> + Cette situation est assez hypothétique, étant donné que je ne l'ai jamais essayée. Je suis ouvert à cette possibilité, mais 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> + Pour choisir le mécanisme à utiliser, on en revient toujours aux standards de code de votre projet. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/reporter_documentation.html b/tests/test_tools/simpletest/docs/fr/reporter_documentation.html index 86c1607c..4f927781 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/reporter_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/reporter_documentation.html @@ -1,386 +1,386 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur le rapporteur de test</h1>
-<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>
-
- <p>
-<a class="target" name="html">
-<h2>Les résultats rapportés au format HTML</h2>
-</a>
-</p>
- <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->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 HtmlReporter($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 test du niveau le plus haut et donc c'est de là que le <span class="new_code">$test_name</span> arrive. Il peint les titres 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 test 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éfait 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 le plus proche du coeur -- 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 ShowPasses extends HtmlReporter {
-
- function paintPass($message) {
- parent::paintPass($message);
- print "&<span class=\"pass\">Pass</span>: ";
- $breadcrumb = $this->getTestList();
- array_shift($breadcrumb);
- print implode("-&gt;", $breadcrumb);
- print "-&gt;$message<br />\n";
- }
-
- 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, par exemple, l'affichage un 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>
-
- <p>
-<a class="target" name="autre">
-<h2>Etendre le rapporteur</h2>
-</a>
-</p>
- <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 canvas vierge pour votre propre création, serait...
-<pre>
-<strong>require_once('simpletest/simple_test.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>
- }
-}
-</pre>
- Aucune sortie ne viendrait de cette classe jusqu'à un ajout de votre part.
- </p>
-
- <p>
-<a class="target" name="cli">
-<h2>Le rapporteur en ligne de commande</h2>
-</a>
-</p>
- <p>
- SimpleTest est aussi livré avec un rapporteur en ligne de commande, minime lui aussi. L'interface imite celle de JUnit, sauf qu'elle envoie les messages d'erreur au fur et à mesure de leur arrivée. Pour utiliser le rapporteur en ligne de commande, il suffit de l'intervertir avec celui de la version HTML...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('File test');
- $test->addTestFile('tests/file_test.php');
- $test->run(<strong>new TextReporter()</strong>);
-?>
-</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, 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, 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>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('File test');
- $test->addTestFile('tests/file_test.php');
- <strong>exit ($test->run(new TextReporter()) ? 0 : 1);</strong>
-?>
-</pre>
- Bien sûr l'objectif n'est 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>
-<?php
- require_once('simpletest/unit_tester.php');
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('File test');
- $test->addTestFile('tests/file_test.php');
- <strong>if (TextReporter::inCli()) {</strong>
- exit ($test->run(new TextReporter()) ? 0 : 1);
- <strong>}</strong>
- $test->run(new HtmlReporter());
-?>
-</pre>
- Il s'agit là de la forme utilisée par SimpleTest lui-même.
- </p>
-
- <p>
-<a class="target" name="xml">
-<h2>Test distant</h2>
-</a>
-</p>
- <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">
-<?xml version="1.0"?>
-<run>
- <group size="4">
- <name>Remote tests</name>
- <group size="4">
- <name>Visual test with 48 passes, 48 fails and 4 exceptions</name>
- <case>
- <name>testofunittestcaseoutput</name>
- <test>
- <name>testofresults</name>
- <pass>This assertion passed</pass>
- <fail>This assertion failed</fail>
- </test>
- <test>
- ...
- </test>
- </case>
- </group>
- </group>
-</run>
-</pre>
- 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>
-<?php
- require_once('simpletest/xml.php');
-
- ...
- $parser = &new SimpleTestXmlParser(new HtmlReporter());
- $parser->parse($test_output);
-?>
-</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>
- Un problème des suites de test très grandes, c'est qu'elles peuvent venir à bout de la limite de mémoire par défaut d'un process PHP - 8Mb. 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 parser à nouveau pour agrégrer 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>
-<?php
- <strong>require_once('../remote.php');</strong>
- require_once('../reporter.php');
-
- $test_url = ...;
- $dry_url = ...;
-
- $test = &new GroupTest('Remote tests');
- $test->addTestCase(<strong>new RemoteTestCase($test_url, $dry_url)</strong>);
- $test->run(new HtmlReporter());
-?>
-</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 quel autre groupe de test.
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur le rapporteur de test</h1> +<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> + + <p> +<a class="target" name="html"> +<h2>Les résultats rapportés au format HTML</h2> +</a> +</p> + <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->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 HtmlReporter($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 test du niveau le plus haut et donc c'est de là que le <span class="new_code">$test_name</span> arrive. Il peint les titres 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 test 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éfait 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 le plus proche du coeur -- 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 ShowPasses extends HtmlReporter { + + function paintPass($message) { + parent::paintPass($message); + print "&<span class=\"pass\">Pass</span>: "; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print implode("-&gt;", $breadcrumb); + print "-&gt;$message<br />\n"; + } + + 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, par exemple, l'affichage un 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> + + <p> +<a class="target" name="autre"> +<h2>Etendre le rapporteur</h2> +</a> +</p> + <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 canvas vierge pour votre propre création, serait... +<pre> +<strong>require_once('simpletest/simple_test.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> + } +} +</pre> + Aucune sortie ne viendrait de cette classe jusqu'à un ajout de votre part. + </p> + + <p> +<a class="target" name="cli"> +<h2>Le rapporteur en ligne de commande</h2> +</a> +</p> + <p> + SimpleTest est aussi livré avec un rapporteur en ligne de commande, minime lui aussi. L'interface imite celle de JUnit, sauf qu'elle envoie les messages d'erreur au fur et à mesure de leur arrivée. Pour utiliser le rapporteur en ligne de commande, il suffit de l'intervertir avec celui de la version HTML... +<pre> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('File test'); + $test->addTestFile('tests/file_test.php'); + $test->run(<strong>new TextReporter()</strong>); +?> +</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, 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, 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> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('File test'); + $test->addTestFile('tests/file_test.php'); + <strong>exit ($test->run(new TextReporter()) ? 0 : 1);</strong> +?> +</pre> + Bien sûr l'objectif n'est 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> +<?php + require_once('simpletest/unit_tester.php'); + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('File test'); + $test->addTestFile('tests/file_test.php'); + <strong>if (TextReporter::inCli()) {</strong> + exit ($test->run(new TextReporter()) ? 0 : 1); + <strong>}</strong> + $test->run(new HtmlReporter()); +?> +</pre> + Il s'agit là de la forme utilisée par SimpleTest lui-même. + </p> + + <p> +<a class="target" name="xml"> +<h2>Test distant</h2> +</a> +</p> + <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"> +<?xml version="1.0"?> +<run> + <group size="4"> + <name>Remote tests</name> + <group size="4"> + <name>Visual test with 48 passes, 48 fails and 4 exceptions</name> + <case> + <name>testofunittestcaseoutput</name> + <test> + <name>testofresults</name> + <pass>This assertion passed</pass> + <fail>This assertion failed</fail> + </test> + <test> + ... + </test> + </case> + </group> + </group> +</run> +</pre> + 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> +<?php + require_once('simpletest/xml.php'); + + ... + $parser = &new SimpleTestXmlParser(new HtmlReporter()); + $parser->parse($test_output); +?> +</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> + Un problème des suites de test très grandes, c'est qu'elles peuvent venir à bout de la limite de mémoire par défaut d'un process PHP - 8Mb. 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 parser à nouveau pour agrégrer 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> +<?php + <strong>require_once('../remote.php');</strong> + require_once('../reporter.php'); + + $test_url = ...; + $dry_url = ...; + + $test = &new GroupTest('Remote tests'); + $test->addTestCase(<strong>new RemoteTestCase($test_url, $dry_url)</strong>); + $test->run(new HtmlReporter()); +?> +</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 quel autre groupe de test. + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/server_stubs_documentation.html b/tests/test_tools/simpletest/docs/fr/server_stubs_documentation.html index f5ddcc04..59085795 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/server_stubs_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/server_stubs_documentation.html @@ -1,279 +1,279 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Documentation SimpleTest : les bouchons serveur</title>
-<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
-</head>
-<body>
-<div class="menu_back">
-<div class="menu">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur les bouchons serveur</h1>
-<div class="content">
- <p>
-<a class="target" name="quoi">
-<h2>Que sont les bouchons serveur ?</h2>
-</a>
-</p>
- <p>
- Au départ il s'agit d'un modèle de conception initié par Robert Binder (Testing object-oriented systems: models, patterns, and tools, Addison-Wesley) in 1999. Un bouchon serveur est une simulation d'un objet ou d'un composant. Il doit remplacer exactement un composant dans un système pour des raisons de testabilité ou de prototypage, tout en restant léger. Il permet aux tests de tourner plus rapidement ou alors, si la classe simulée n'a pas été écrite, juste de fonctionner.
- </p>
-
- <p>
-<a class="target" name="creation">
-<h2>Créer des bouchons serveur</h2>
-</a>
-</p>
- <p>
- Nous avons juste besoin d'une classe préexistante, par exemple une connexion vers une base de données qui ressemblerait à...
-<pre>
-<strong>class DatabaseConnection {
- function DatabaseConnection() {
- }
-
- function query() {
- }
-
- function selectQuery() {
- }
-}</strong>
-</pre>
- La classe n'a même pas encore besoin d'avoir été implémentée. Pour créer la version bouchonnée de cette classe, nous incluons la librairie de bouchon serveur et exécutons le générateur...
-<pre>
-<strong>require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-Stub::generate('DatabaseConnection');</strong>
-</pre>
- Est généré un clone de la classe appelé <span class="new_code">StubDatabaseConnection</span>. Nous pouvons alors créer des instances de cette nouvelle classe à l'intérieur de notre prototype de script...
-<pre>
-require_once('simpletest/mock_objects.php');
-require_once('database_connection.php');
-Stub::generate('DatabaseConnection');
-<strong>
-$connection = new StubDatabaseConnection();
-</strong>
-</pre>
- La version bouchonnée de la classe contient toutes les méthodes de l'original de telle sorte qu'une opération comme <span class="new_code">$connection->query()</span> soit encore légale. La valeur retournée sera <span class="new_code">null</span>, Mais nous pouvons y remédier avec...
-<pre>
-<strong>$connection->setReturnValue('query', 37)</strong>
-</pre>
- Désormais à chaque appel de <span class="new_code">$connection->query()</span> nous obtenons un résultat de 37. Nous pouvons choisir n'importe quelle valeur pour le résultat, par exemple un hash de résultats provenant d'un base de données imaginaire ou alors une liste d'objets persistants. Peu importe les paramètres, nous obtenons systématiquement les même valeurs chaque fois qu'ils ont été initialisés de la sorte : ça ne ressemble peut-être pas à une réponse convaincante venant d'une connexion vers une base de données. Mais pour la demi-douzaine de lignes d'une méthode de test c'est souvent largement suffisant.
- </p>
-
- <p>
-<a class="target" name="mod%C3%A8les">
-<h2>Modèles de simulation</h2>
-</a>
-</p>
- <p>
- Sauf que les choses ne sont que rarement aussi simples. Parmi les problèmes les plus courants on trouve les itérateurs : le renvoi d'une valeur constante peut causer une boucle infini dans l'objet testé. Pour ceux-ci nous avons besoin de mettre sur pied une suite de valeurs. Prenons par exemple un itérateur simple qui ressemble à...
-<pre>
-class Iterator {
- function Iterator() {
- }
-
- function next() {
- }
-}
-</pre>
- C'est probablement le plus simple des itérateurs possibles. Supposons que cet itérateur ne retourne que du texte, jusqu'à la fin - quand il retourne <span class="new_code">false</span>. Une simulation est possible avec...
-<pre>
-<strong>Stub::generate('Iterator');
-
-$iterator = new StubIterator();
-$iterator->setReturnValue('next', false);
-$iterator->setReturnValueAt(0, 'next', 'First string');
-$iterator->setReturnValueAt(1, 'next', 'Second string');</strong>
-</pre>
- A l'appel de <span class="new_code">next()</span> sur l'itérateur bouchonné il va d'abord renvoyer "First string", puis au second appel c'est "Second string" qui sera renvoyé. Finalement pour tous les autres appels, il s'agira d'un <span class="new_code">false</span>. Les valeurs renvoyées successivement ont priorité sur la valeur constante renvoyé. Cette dernière est un genre de valeur par défaut.
- </p>
- <p>
- Une autre situation délicate est une opération <span class="new_code">get()</span> surchargée. Un exemple ? Un porteur d'information avec des pairs de clef / valeur. Prenons une classe de configuration...
-<pre>
-class Configuration {
- function Configuration() {
- }
-
- function getValue($key) {
- }
-}
-</pre>
- Il s'agit d'une situation propice à l'utilisation d'objets bouchon, surtout que la configuration en production dépend invariablement de la machine : l'utiliser directement ne va pas nous aider à maintenir notre confiance dans nos tests. Sauf que le problème tient de ce que toutes les données proviennent de la méthode <span class="new_code">getValue()</span> et que nous voulons des résultats différents suivant la clef. Par chance les bouchons ont un système de filtre...
-<pre>
-<strong>Stub::generate('Configuration');
-
-$config = &new StubConfiguration();
-$config->setReturnValue('getValue', 'primary', array('db_host'));
-$config->setReturnValue('getValue', 'admin', array('db_user'));
-$config->setReturnValue('getValue', 'secret', array('db_password'));</strong>
-</pre>
- Ce paramètre supplémentaire est une liste d'arguments que l'on peut utiliser. Dans ce cas nous essayons d'utiliser un unique argument, à savoir la clef recherchée. Maintenant quand on invoque le bouchon serveur via la méthode <span class="new_code">getValue()</span> avec...
-<pre>
-$config->getValue('db_user');
-</pre>
- ...il renvoie "admin". Il le trouve en essayant d'assortir successivement les arguments d'entrée avec sa liste de ceux de sortie jusqu'au moment où une correspondance exacte est trouvée.
- </p>
- <p>
- Vous pouvez définir un argument par défaut avec...
-<pre>
-<strong>
-$config->setReturnValue('getValue', false, array('*'));</strong>
-</pre>
- Attention ce n'est pas équivalent à initialiser la valeur retournée sans aucun argument.
-<pre>
-<strong>
-$config->setReturnValue('getValue', false);</strong>
-</pre>
- Dans le premier cas il acceptera n'importe quel argument, mais exactement un -- pas plus -- est nécessaire. Dans le second cas n'importe quel nombre d'arguments fera l'affaire : il agit comme un <cite>catchall</cite> après tous les correspondances. Prenez garde à l'ordre : si nous ajoutons un autre paramètre après le joker ('*') il sera ignoré puisque le joker aura été trouvé auparavant. Avec des listes de paramètres complexes l'ordre peut devenir crucial, au risque de perdre des correspondances souhaitées, masquées par un joker antérieur. Pensez à mettre d'abord les cas les plus spécifiques si vous n'êtes pas sûr.
- </p>
- <p>
- Il y a des fois où l'on souhaite qu'un objet spécifique soit servi par le bouchon plutôt qu'une simple copie. La sémantique de la copie en PHP nous force à utiliser une autre méthode pour cela. Vous êtes peut-être en train de simuler un conteneur par exemple...
-<pre>
-class Thing {
-}
-
-class Vector {
- function Vector() {
- }
-
- function get($index) {
- }
-}
-</pre>
- Dans ce cas vous pouvez mettre une référence dans la liste renvoyée par le bouchon...
-<pre>
-Stub::generate('Vector');
-
-$thing = new Thing();<strong>
-$vector = &new StubVector();
-$vector->setReturnReference('get', $thing, array(12));</strong>
-</pre>
- Avec ce petit arrangement vous vous assurez qu'à chaque fois que <span class="new_code">$vector->get(12)</span> est appelé il renverra le même <span class="new_code">$thing</span>.
- </p>
- <p>
- Ces trois facteurs, ordre, paramètres et copie (ou référence), peuvent être combinés orthogonalement. Par exemple...
-<pre>
-$complex = &new StubComplexThing();
-$stuff = new Stuff();<strong>
-$complex->setReturnReferenceAt(3, 'get', $stuff, array('*', 1));</strong>
-</pre>
- Le <span class="new_code">$stuff</span> ne sera renvoyé qu'au troisième appel et seulement si deux paramètres étaient indiqués, avec la contrainte que le second de ceux-ci soit l'entier 1. N'est-ce pas suffisant pour des situations de prototypage simple ?
- </p>
- <p>
- Un dernier cas critique reste celle d'un objet en créant un autre, connu sous le nom du modèle factory - fabrique. Supposons qu'après une requête réussie à notre base de données imaginaire, un ensemble de résultats est retourné sous la forme d'un itérateur, chaque appel à <span class="new_code">next()</span> donnant un ligne et à la fin un <span class="new_code">false</span>.
- Au premier abord, ça donne l'impression d'être cauchemardesque à simuler. Alors qu'en fait tout peut être bouchonné en utilisant les mécanismes ci-dessus.
- </p>
- <p>
- Voici comment...
-<pre>
-Stub::generate('DatabaseConnection');
-Stub::generate('ResultIterator');
-
-class DatabaseTest extends UnitTestCase {
-
- function testUserFinder() {<strong>
- $result = &new StubResultIterator();
- $result->setReturnValue('next', false);
- $result->setReturnValueAt(0, 'next', array(1, 'tom'));
- $result->setReturnValueAt(1, 'next', array(3, 'dick'));
- $result->setReturnValueAt(2, 'next', array(6, 'harry'));
-
- $connection = &new StubDatabaseConnection();
- $connection->setReturnValue('query', false);
- $connection->setReturnReference(
- 'query',
- $result,
- array('select id, name from users'));</strong>
-
- $finder = &new UserFinder($connection);
- $this->assertIdentical(
- $finder->findNames(),
- array('tom', 'dick', 'harry'));
- }
-}
-</pre>
- Désormais ce n'est que si notre <span class="new_code">$connection</span> est appelé avec la bonne <span class="new_code">query()</span> que le <span class="new_code">$result</span> sera renvoyé après le troisième appel à <span class="new_code">next()</span>. Cela devrait être suffisant pour que notre classe <span class="new_code">UserFinder</span>, la classe effectivement testée à ce niveau, puisse s'exécuter comme il faut. Un test très précis et pas une seule base de données à l'horizon.
- </p>
-
- <p>
-<a class="target" name="options">
-<h2>Options de création pour les bouchons</h2>
-</a>
-</p>
- <p>
- Il y a d'autres options additionnelles à la création d'un bouchon. Au moment de la génération nous pouvons changer le nom de la classe...
-<pre>
-<strong>Stub::generate('Iterator', 'MyStubIterator');
-$iterator = &new MyStubIterator();
-</strong>
-</pre>
- Pris tout seul ce n'est pas très utile étant donné qu'il n'y aurait pas de différence entre cette classe et celle par défaut -- à part le nom bien entendu. Par contre nous pouvons aussi lui ajouter d'autres méthodes qui ne se trouveraient pas dans l'interface originale...
-<pre>
-class Iterator {
-}
-<strong>Stub::generate('Iterator', 'PrototypeIterator', array('next', 'isError'));
-$iterator = &new PrototypeIterator();
-$iterator->setReturnValue('next', 0);
-</strong>
-</pre>
- Les méthodes <span class="new_code">next()</span> et <span class="new_code">isError()</span> peuvent maintenant renvoyer des ensembles de valeurs exactement comme si elles existaient dans la classe originale.
- </p>
- <p>
- Un moyen encore plus ésotérique de modifier les bouchons est de changer le joker utiliser par défaut pour la correspondance des paramètres.
-<pre>
-<strong>Stub::generate('Connection');
-$iterator = &new StubConnection('wild');
-$iterator->setReturnValue('query', array('id' => 33), array('wild'));
-</strong>
-</pre>
- L'unique raison valable pour effectuer cette opération, c'est quand vous souhaitez tester la chaîne "*" sans pour autant l'interpréter comme un "n'importe lequel".
- </p>
-
- </div>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Documentation SimpleTest : les bouchons serveur</title> +<link rel="stylesheet" type="text/css" href="docs.css" title="Styles"> +</head> +<body> +<div class="menu_back"> +<div class="menu"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur les bouchons serveur</h1> +<div class="content"> + <p> +<a class="target" name="quoi"> +<h2>Que sont les bouchons serveur ?</h2> +</a> +</p> + <p> + Au départ il s'agit d'un modèle de conception initié par Robert Binder (Testing object-oriented systems: models, patterns, and tools, Addison-Wesley) in 1999. Un bouchon serveur est une simulation d'un objet ou d'un composant. Il doit remplacer exactement un composant dans un système pour des raisons de testabilité ou de prototypage, tout en restant léger. Il permet aux tests de tourner plus rapidement ou alors, si la classe simulée n'a pas été écrite, juste de fonctionner. + </p> + + <p> +<a class="target" name="creation"> +<h2>Créer des bouchons serveur</h2> +</a> +</p> + <p> + Nous avons juste besoin d'une classe préexistante, par exemple une connexion vers une base de données qui ressemblerait à... +<pre> +<strong>class DatabaseConnection { + function DatabaseConnection() { + } + + function query() { + } + + function selectQuery() { + } +}</strong> +</pre> + La classe n'a même pas encore besoin d'avoir été implémentée. Pour créer la version bouchonnée de cette classe, nous incluons la librairie de bouchon serveur et exécutons le générateur... +<pre> +<strong>require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); +Stub::generate('DatabaseConnection');</strong> +</pre> + Est généré un clone de la classe appelé <span class="new_code">StubDatabaseConnection</span>. Nous pouvons alors créer des instances de cette nouvelle classe à l'intérieur de notre prototype de script... +<pre> +require_once('simpletest/mock_objects.php'); +require_once('database_connection.php'); +Stub::generate('DatabaseConnection'); +<strong> +$connection = new StubDatabaseConnection(); +</strong> +</pre> + La version bouchonnée de la classe contient toutes les méthodes de l'original de telle sorte qu'une opération comme <span class="new_code">$connection->query()</span> soit encore légale. La valeur retournée sera <span class="new_code">null</span>, Mais nous pouvons y remédier avec... +<pre> +<strong>$connection->setReturnValue('query', 37)</strong> +</pre> + Désormais à chaque appel de <span class="new_code">$connection->query()</span> nous obtenons un résultat de 37. Nous pouvons choisir n'importe quelle valeur pour le résultat, par exemple un hash de résultats provenant d'un base de données imaginaire ou alors une liste d'objets persistants. Peu importe les paramètres, nous obtenons systématiquement les même valeurs chaque fois qu'ils ont été initialisés de la sorte : ça ne ressemble peut-être pas à une réponse convaincante venant d'une connexion vers une base de données. Mais pour la demi-douzaine de lignes d'une méthode de test c'est souvent largement suffisant. + </p> + + <p> +<a class="target" name="mod%C3%A8les"> +<h2>Modèles de simulation</h2> +</a> +</p> + <p> + Sauf que les choses ne sont que rarement aussi simples. Parmi les problèmes les plus courants on trouve les itérateurs : le renvoi d'une valeur constante peut causer une boucle infini dans l'objet testé. Pour ceux-ci nous avons besoin de mettre sur pied une suite de valeurs. Prenons par exemple un itérateur simple qui ressemble à... +<pre> +class Iterator { + function Iterator() { + } + + function next() { + } +} +</pre> + C'est probablement le plus simple des itérateurs possibles. Supposons que cet itérateur ne retourne que du texte, jusqu'à la fin - quand il retourne <span class="new_code">false</span>. Une simulation est possible avec... +<pre> +<strong>Stub::generate('Iterator'); + +$iterator = new StubIterator(); +$iterator->setReturnValue('next', false); +$iterator->setReturnValueAt(0, 'next', 'First string'); +$iterator->setReturnValueAt(1, 'next', 'Second string');</strong> +</pre> + A l'appel de <span class="new_code">next()</span> sur l'itérateur bouchonné il va d'abord renvoyer "First string", puis au second appel c'est "Second string" qui sera renvoyé. Finalement pour tous les autres appels, il s'agira d'un <span class="new_code">false</span>. Les valeurs renvoyées successivement ont priorité sur la valeur constante renvoyé. Cette dernière est un genre de valeur par défaut. + </p> + <p> + Une autre situation délicate est une opération <span class="new_code">get()</span> surchargée. Un exemple ? Un porteur d'information avec des pairs de clef / valeur. Prenons une classe de configuration... +<pre> +class Configuration { + function Configuration() { + } + + function getValue($key) { + } +} +</pre> + Il s'agit d'une situation propice à l'utilisation d'objets bouchon, surtout que la configuration en production dépend invariablement de la machine : l'utiliser directement ne va pas nous aider à maintenir notre confiance dans nos tests. Sauf que le problème tient de ce que toutes les données proviennent de la méthode <span class="new_code">getValue()</span> et que nous voulons des résultats différents suivant la clef. Par chance les bouchons ont un système de filtre... +<pre> +<strong>Stub::generate('Configuration'); + +$config = &new StubConfiguration(); +$config->setReturnValue('getValue', 'primary', array('db_host')); +$config->setReturnValue('getValue', 'admin', array('db_user')); +$config->setReturnValue('getValue', 'secret', array('db_password'));</strong> +</pre> + Ce paramètre supplémentaire est une liste d'arguments que l'on peut utiliser. Dans ce cas nous essayons d'utiliser un unique argument, à savoir la clef recherchée. Maintenant quand on invoque le bouchon serveur via la méthode <span class="new_code">getValue()</span> avec... +<pre> +$config->getValue('db_user'); +</pre> + ...il renvoie "admin". Il le trouve en essayant d'assortir successivement les arguments d'entrée avec sa liste de ceux de sortie jusqu'au moment où une correspondance exacte est trouvée. + </p> + <p> + Vous pouvez définir un argument par défaut avec... +<pre> +<strong> +$config->setReturnValue('getValue', false, array('*'));</strong> +</pre> + Attention ce n'est pas équivalent à initialiser la valeur retournée sans aucun argument. +<pre> +<strong> +$config->setReturnValue('getValue', false);</strong> +</pre> + Dans le premier cas il acceptera n'importe quel argument, mais exactement un -- pas plus -- est nécessaire. Dans le second cas n'importe quel nombre d'arguments fera l'affaire : il agit comme un <cite>catchall</cite> après tous les correspondances. Prenez garde à l'ordre : si nous ajoutons un autre paramètre après le joker ('*') il sera ignoré puisque le joker aura été trouvé auparavant. Avec des listes de paramètres complexes l'ordre peut devenir crucial, au risque de perdre des correspondances souhaitées, masquées par un joker antérieur. Pensez à mettre d'abord les cas les plus spécifiques si vous n'êtes pas sûr. + </p> + <p> + Il y a des fois où l'on souhaite qu'un objet spécifique soit servi par le bouchon plutôt qu'une simple copie. La sémantique de la copie en PHP nous force à utiliser une autre méthode pour cela. Vous êtes peut-être en train de simuler un conteneur par exemple... +<pre> +class Thing { +} + +class Vector { + function Vector() { + } + + function get($index) { + } +} +</pre> + Dans ce cas vous pouvez mettre une référence dans la liste renvoyée par le bouchon... +<pre> +Stub::generate('Vector'); + +$thing = new Thing();<strong> +$vector = &new StubVector(); +$vector->setReturnReference('get', $thing, array(12));</strong> +</pre> + Avec ce petit arrangement vous vous assurez qu'à chaque fois que <span class="new_code">$vector->get(12)</span> est appelé il renverra le même <span class="new_code">$thing</span>. + </p> + <p> + Ces trois facteurs, ordre, paramètres et copie (ou référence), peuvent être combinés orthogonalement. Par exemple... +<pre> +$complex = &new StubComplexThing(); +$stuff = new Stuff();<strong> +$complex->setReturnReferenceAt(3, 'get', $stuff, array('*', 1));</strong> +</pre> + Le <span class="new_code">$stuff</span> ne sera renvoyé qu'au troisième appel et seulement si deux paramètres étaient indiqués, avec la contrainte que le second de ceux-ci soit l'entier 1. N'est-ce pas suffisant pour des situations de prototypage simple ? + </p> + <p> + Un dernier cas critique reste celle d'un objet en créant un autre, connu sous le nom du modèle factory - fabrique. Supposons qu'après une requête réussie à notre base de données imaginaire, un ensemble de résultats est retourné sous la forme d'un itérateur, chaque appel à <span class="new_code">next()</span> donnant un ligne et à la fin un <span class="new_code">false</span>. + Au premier abord, ça donne l'impression d'être cauchemardesque à simuler. Alors qu'en fait tout peut être bouchonné en utilisant les mécanismes ci-dessus. + </p> + <p> + Voici comment... +<pre> +Stub::generate('DatabaseConnection'); +Stub::generate('ResultIterator'); + +class DatabaseTest extends UnitTestCase { + + function testUserFinder() {<strong> + $result = &new StubResultIterator(); + $result->setReturnValue('next', false); + $result->setReturnValueAt(0, 'next', array(1, 'tom')); + $result->setReturnValueAt(1, 'next', array(3, 'dick')); + $result->setReturnValueAt(2, 'next', array(6, 'harry')); + + $connection = &new StubDatabaseConnection(); + $connection->setReturnValue('query', false); + $connection->setReturnReference( + 'query', + $result, + array('select id, name from users'));</strong> + + $finder = &new UserFinder($connection); + $this->assertIdentical( + $finder->findNames(), + array('tom', 'dick', 'harry')); + } +} +</pre> + Désormais ce n'est que si notre <span class="new_code">$connection</span> est appelé avec la bonne <span class="new_code">query()</span> que le <span class="new_code">$result</span> sera renvoyé après le troisième appel à <span class="new_code">next()</span>. Cela devrait être suffisant pour que notre classe <span class="new_code">UserFinder</span>, la classe effectivement testée à ce niveau, puisse s'exécuter comme il faut. Un test très précis et pas une seule base de données à l'horizon. + </p> + + <p> +<a class="target" name="options"> +<h2>Options de création pour les bouchons</h2> +</a> +</p> + <p> + Il y a d'autres options additionnelles à la création d'un bouchon. Au moment de la génération nous pouvons changer le nom de la classe... +<pre> +<strong>Stub::generate('Iterator', 'MyStubIterator'); +$iterator = &new MyStubIterator(); +</strong> +</pre> + Pris tout seul ce n'est pas très utile étant donné qu'il n'y aurait pas de différence entre cette classe et celle par défaut -- à part le nom bien entendu. Par contre nous pouvons aussi lui ajouter d'autres méthodes qui ne se trouveraient pas dans l'interface originale... +<pre> +class Iterator { +} +<strong>Stub::generate('Iterator', 'PrototypeIterator', array('next', 'isError')); +$iterator = &new PrototypeIterator(); +$iterator->setReturnValue('next', 0); +</strong> +</pre> + Les méthodes <span class="new_code">next()</span> et <span class="new_code">isError()</span> peuvent maintenant renvoyer des ensembles de valeurs exactement comme si elles existaient dans la classe originale. + </p> + <p> + Un moyen encore plus ésotérique de modifier les bouchons est de changer le joker utiliser par défaut pour la correspondance des paramètres. +<pre> +<strong>Stub::generate('Connection'); +$iterator = &new StubConnection('wild'); +$iterator->setReturnValue('query', array('id' => 33), array('wild')); +</strong> +</pre> + L'unique raison valable pour effectuer cette opération, c'est quand vous souhaitez tester la chaîne "*" sans pour autant l'interpréter comme un "n'importe lequel". + </p> + + </div> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/unit_test_documentation.html b/tests/test_tools/simpletest/docs/fr/unit_test_documentation.html index fbbd728b..3dcfeca5 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/unit_test_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/unit_test_documentation.html @@ -1,306 +1,306 @@ -<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Documenation 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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur les tests unitaires en PHP</h1>
-<div class="content">
- <p>
-<a class="target" name="unitaire">
-<h2>Scénarios de tests unitaires</h2>
-</a>
-</p>
- <p>
- Le coeur du système est un framework de test 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('../classes/writer.php');
-
-class FileTestCase extends UnitTestCase {
- function FileTestCase() {
- $this->UnitTestCase('File test');
- }<strong>
-
- function setUp() {
- @unlink('../temp/test.txt');
- }
-
- function tearDown() {
- @unlink('../temp/test.txt');
- }
-
- function testCreation() {
- $writer = &new FileWriter('../temp/test.txt');
- $writer->write('Hello');
- $this->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">assertWantedPattern($p, $x)</span></td><td>Echoue sauf si l'expression rationnelle $p capture $x</td>
-</tr>
- <tr>
-<td><span class="new_code">assertNoUnwantedPattern($p, $x)</span></td><td>Echoue si l'expression rationnelle $p capture $x</td>
-</tr>
- <tr>
-<td><span class="new_code">assertNoErrors()</span></td><td>Echoue si une erreur PHP arrive</td>
-</tr>
- <tr>
-<td><span class="new_code">assertError($x)</span></td><td>Echoue si aucune erreur ou message incorrect de PHP n'arrive</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->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->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->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->assertWantedPattern('/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>trigger_error('Disaster');
-trigger_error('Catastrophe');
-$this->assertError();
-$this->assertError('Catastrophe');
-$this->assertNoErrors();</strong>
-</pre>
- Ici, il y a besoin d'une petite explication : toutes passent !
- </p>
- <p>
- Les erreurs PHP dans SimpleTest sont piégées et placées dans une queue. Ici la première vérification d'erreur attrape le message "Disaster" sans vérifier le texte et passe. Résultat : l'erreur est supprimée de la queue. La vérification suivante teste non seulement l'existence de l'erreur mais aussi le texte qui correspond : un autre succès. Désormais la queue est vide et le dernier test passe aussi. Si une autre erreur non vérifiée est encore dans la queue à la fin de notre méthode de test alors une exception sera rapportée dans le test. Notez que SimpleTest ne peut pas attraper les erreurs PHP à la compilation.
- </p>
- <p>
- Les scénarios de test 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">sendMessage()</span></td><td>Envoie un message d'état aux systèmes d'affichage qui le supporte</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>
- <tr>
-<td><span class="new_code">swallowErrors()</span></td><td>Vide les erreurs de la queue</td>
-</tr>
- </tbody>
-</table>
- </p>
-
- <p>
-<a class="target" name="extension_unitaire">
-<h2>Etendre les scénarios de test</h2>
-</a>
-</p>
- <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/unit_tester.php');
-<strong>
-class FileTester extends UnitTestCase {
- function FileTester($name = false) {
- $this->UnitTestCase($name);
- }
-
- function assertFileExists($filename, $message = '%s') {
- $this->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>
- 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 = &new FileWriter('../temp/test.txt');
- $writer->write('Hello');<strong>
- $this->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>
-
- <p>
-<a class="target" name="lancement_unitaire">
-<h2>Lancer un unique scénario de test</h2>
-</a>
-</p>
- <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. Voici l'échafaudage nécessaire pour lancer un scénario de test solitaire...
-<pre>
-<?php
- require_once('simpletest/unit_tester.php');<strong>
- require_once('simpletest/reporter.php');</strong>
- require_once('../classes/writer.php');
-
- class FileTestCase extends UnitTestCase {
- function FileTestCase() {
- $this->UnitTestCase('File test');
- }
- }<strong>
-
- $test = &new FileTestCase();
- $test->run(new HtmlReporter());</strong>
-?>
-</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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Documenation 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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur les tests unitaires en PHP</h1> +<div class="content"> + <p> +<a class="target" name="unitaire"> +<h2>Scénarios de tests unitaires</h2> +</a> +</p> + <p> + Le coeur du système est un framework de test 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('../classes/writer.php'); + +class FileTestCase extends UnitTestCase { + function FileTestCase() { + $this->UnitTestCase('File test'); + }<strong> + + function setUp() { + @unlink('../temp/test.txt'); + } + + function tearDown() { + @unlink('../temp/test.txt'); + } + + function testCreation() { + $writer = &new FileWriter('../temp/test.txt'); + $writer->write('Hello'); + $this->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">assertWantedPattern($p, $x)</span></td><td>Echoue sauf si l'expression rationnelle $p capture $x</td> +</tr> + <tr> +<td><span class="new_code">assertNoUnwantedPattern($p, $x)</span></td><td>Echoue si l'expression rationnelle $p capture $x</td> +</tr> + <tr> +<td><span class="new_code">assertNoErrors()</span></td><td>Echoue si une erreur PHP arrive</td> +</tr> + <tr> +<td><span class="new_code">assertError($x)</span></td><td>Echoue si aucune erreur ou message incorrect de PHP n'arrive</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->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->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->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->assertWantedPattern('/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>trigger_error('Disaster'); +trigger_error('Catastrophe'); +$this->assertError(); +$this->assertError('Catastrophe'); +$this->assertNoErrors();</strong> +</pre> + Ici, il y a besoin d'une petite explication : toutes passent ! + </p> + <p> + Les erreurs PHP dans SimpleTest sont piégées et placées dans une queue. Ici la première vérification d'erreur attrape le message "Disaster" sans vérifier le texte et passe. Résultat : l'erreur est supprimée de la queue. La vérification suivante teste non seulement l'existence de l'erreur mais aussi le texte qui correspond : un autre succès. Désormais la queue est vide et le dernier test passe aussi. Si une autre erreur non vérifiée est encore dans la queue à la fin de notre méthode de test alors une exception sera rapportée dans le test. Notez que SimpleTest ne peut pas attraper les erreurs PHP à la compilation. + </p> + <p> + Les scénarios de test 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">sendMessage()</span></td><td>Envoie un message d'état aux systèmes d'affichage qui le supporte</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> + <tr> +<td><span class="new_code">swallowErrors()</span></td><td>Vide les erreurs de la queue</td> +</tr> + </tbody> +</table> + </p> + + <p> +<a class="target" name="extension_unitaire"> +<h2>Etendre les scénarios de test</h2> +</a> +</p> + <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/unit_tester.php'); +<strong> +class FileTester extends UnitTestCase { + function FileTester($name = false) { + $this->UnitTestCase($name); + } + + function assertFileExists($filename, $message = '%s') { + $this->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> + 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 = &new FileWriter('../temp/test.txt'); + $writer->write('Hello');<strong> + $this->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> + + <p> +<a class="target" name="lancement_unitaire"> +<h2>Lancer un unique scénario de test</h2> +</a> +</p> + <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. Voici l'échafaudage nécessaire pour lancer un scénario de test solitaire... +<pre> +<?php + require_once('simpletest/unit_tester.php');<strong> + require_once('simpletest/reporter.php');</strong> + require_once('../classes/writer.php'); + + class FileTestCase extends UnitTestCase { + function FileTestCase() { + $this->UnitTestCase('File test'); + } + }<strong> + + $test = &new FileTestCase(); + $test->run(new HtmlReporter());</strong> +?> +</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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/docs/fr/web_tester_documentation.html b/tests/test_tools/simpletest/docs/fr/web_tester_documentation.html index 7a2603a0..86044e5e 100644..100755 --- a/tests/UnitTests/simpletest/docs/fr/web_tester_documentation.html +++ b/tests/test_tools/simpletest/docs/fr/web_tester_documentation.html @@ -1,397 +1,397 @@ -<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">
-<h2>
-<a href="index.html">SimpleTest</a>
-</h2>
-<ul>
-<li>
-<a href="overview.html">Overview</a>
-</li>
-<li>
-<a href="unit_test_documentation.html">Unit tester</a>
-</li>
-<li>
-<a href="group_test_documentation.html">Group tests</a>
-</li>
-<li>
-<a href="server_stubs_documentation.html">Server stubs</a>
-</li>
-<li>
-<a href="mock_objects_documentation.html">Mock objects</a>
-</li>
-<li>
-<a href="partial_mocks_documentation.html">Partial mocks</a>
-</li>
-<li>
-<a href="reporter_documentation.html">Reporting</a>
-</li>
-<li>
-<a href="expectation_documentation.html">Expectations</a>
-</li>
-<li>
-<a href="web_tester_documentation.html">Web tester</a>
-</li>
-<li>
-<a href="form_testing_documentation.html">Testing forms</a>
-</li>
-<li>
-<a href="authentication_documentation.html">Authentication</a>
-</li>
-<li>
-<a href="browser_documentation.html">Scriptable browser</a>
-</li>
-</ul>
-</div>
-</div>
-<h1>Documentation sur le testeur web</h1>
-<div class="content">
- <p>
-<a class="target" name="telecharger">
-<h2>Télécharger une page</h2>
-</a>
-</p>
- <p>
- Tester des classes c'es 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>
-<?php<strong>
- require_once('simpletest/web_tester.php');</strong>
- require_once('simpletest/reporter.php');
-
- $test = &new GroupTest('Web site tests');<strong>
- $test->addTestFile('lastcraft_test.php');</strong>
- exit ($test->run(new TextReporter()) ? 0 : 1);
-?>
-</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->assertTrue($this->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>
-
- <p>
-<a class="target" name="contenu">
-<h2>Tester le contenu d'une page</h2>
-</a>
-</p>
- <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->get('http://www.lastcraft.com/');
- $this->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->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->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->get('http://simpletest.sourceforge.net/');<strong>
- $this->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->setMaximumRedirects(0);</strong>
- $this->get('http://simpletest.sourceforge.net/');
- $this->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->setMaximumRedirects(0);
- $this->get('http://simpletest.sourceforge.net/');
- $this->assertResponse(<strong>array(301, 302, 303, 307)</strong>);
- }
-}
-</pre>
- Maitenant ça passe.
- </p>
-
- <p>
-<a class="target" name="navigation">
-<h2>Navigeur dans un site web</h2>
-</a>
-</p>
- <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->get('http://www.lastcraft.com/');<strong>
- $this->clickLink('About');
- $this->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->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 avec ce titre ou ce texte dans l'attribut alt</td>
-</tr>
- <tr>
-<td><span class="new_code">clickImageByName($name, $x, $y)</span></td><td>Clique sur une balise input de type image avec ce nom</td>
-</tr>
- <tr>
-<td><span class="new_code">clickImageById($id, $x, $y)</span></td><td>Clique sur une balise input de type image avec cet attribut d'identification</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 un 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>
-
- <p>
-<a class="target" name="requete">
-<h2>Modifier la requête</h2>
-</a>
-</p>
- <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>
-<div class="copyright">
- Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004
- </div>
-</body>
-</html>
+<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"> +<h2> +<a href="index.html">SimpleTest</a> +</h2> +<ul> +<li> +<a href="overview.html">Overview</a> +</li> +<li> +<a href="unit_test_documentation.html">Unit tester</a> +</li> +<li> +<a href="group_test_documentation.html">Group tests</a> +</li> +<li> +<a href="server_stubs_documentation.html">Server stubs</a> +</li> +<li> +<a href="mock_objects_documentation.html">Mock objects</a> +</li> +<li> +<a href="partial_mocks_documentation.html">Partial mocks</a> +</li> +<li> +<a href="reporter_documentation.html">Reporting</a> +</li> +<li> +<a href="expectation_documentation.html">Expectations</a> +</li> +<li> +<a href="web_tester_documentation.html">Web tester</a> +</li> +<li> +<a href="form_testing_documentation.html">Testing forms</a> +</li> +<li> +<a href="authentication_documentation.html">Authentication</a> +</li> +<li> +<a href="browser_documentation.html">Scriptable browser</a> +</li> +</ul> +</div> +</div> +<h1>Documentation sur le testeur web</h1> +<div class="content"> + <p> +<a class="target" name="telecharger"> +<h2>Télécharger une page</h2> +</a> +</p> + <p> + Tester des classes c'es 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> +<?php<strong> + require_once('simpletest/web_tester.php');</strong> + require_once('simpletest/reporter.php'); + + $test = &new GroupTest('Web site tests');<strong> + $test->addTestFile('lastcraft_test.php');</strong> + exit ($test->run(new TextReporter()) ? 0 : 1); +?> +</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->assertTrue($this->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> + + <p> +<a class="target" name="contenu"> +<h2>Tester le contenu d'une page</h2> +</a> +</p> + <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->get('http://www.lastcraft.com/'); + $this->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->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->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->get('http://simpletest.sourceforge.net/');<strong> + $this->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->setMaximumRedirects(0);</strong> + $this->get('http://simpletest.sourceforge.net/'); + $this->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->setMaximumRedirects(0); + $this->get('http://simpletest.sourceforge.net/'); + $this->assertResponse(<strong>array(301, 302, 303, 307)</strong>); + } +} +</pre> + Maitenant ça passe. + </p> + + <p> +<a class="target" name="navigation"> +<h2>Navigeur dans un site web</h2> +</a> +</p> + <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->get('http://www.lastcraft.com/');<strong> + $this->clickLink('About'); + $this->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->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 avec ce titre ou ce texte dans l'attribut alt</td> +</tr> + <tr> +<td><span class="new_code">clickImageByName($name, $x, $y)</span></td><td>Clique sur une balise input de type image avec ce nom</td> +</tr> + <tr> +<td><span class="new_code">clickImageById($id, $x, $y)</span></td><td>Clique sur une balise input de type image avec cet attribut d'identification</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 un 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> + + <p> +<a class="target" name="requete"> +<h2>Modifier la requête</h2> +</a> +</p> + <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> +<div class="copyright"> + Copyright<br>Marcus Baker, Jason Sweat, Perrick Penet 2004 + </div> +</body> +</html> diff --git a/tests/UnitTests/simpletest/dumper.php b/tests/test_tools/simpletest/dumper.php index d6182e36..f54140ca 100644 --- a/tests/UnitTests/simpletest/dumper.php +++ b/tests/test_tools/simpletest/dumper.php @@ -1,380 +1,380 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: dumper.php,v 1.22 2005/02/05 04:51:17 lastcraft Exp $
- */
- /**
- * does type matter
- */
- 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, 100);
- 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
- */
- 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
- */
- 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
- */
- 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
- */
- 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
- */
- 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, 100, $position) . "] and [" .
- $this->clipString($second, 100, $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
- */
- 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
- */
- 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) . "]";
- }
-
- /**
- * 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
- */
- 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
- */
- 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
- */
- 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.
- * @access private
- */
- function _describeObjectDifference($first, $second, $identical) {
- if (! is_object($second)) {
- return $this->_describeGenericDifference($first, $second);
- }
- return $this->_describeArrayDifference(
- get_object_vars($first),
- get_object_vars($second),
- $identical);
- }
-
- /**
- * 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
- */
- 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
- * @static
- */
- function dump($variable) {
- ob_start();
- print_r($variable);
- $formatted = ob_get_contents();
- ob_end_clean();
- return $formatted;
- }
-
- /**
- * Extracts the last assertion that was not within
- * Simpletest itself. The name must start with "assert".
- * @param array $stack List of stack frames.
- * @param string $format String formatting.
- * @param string $prefix Prefix of method to search for.
- * @access public
- * @static
- */
- function getFormattedAssertionLine($stack, $format = '%d', $prefix = 'assert') {
- foreach ($stack as $frame) {
- if (isset($frame['file']) && strpos($frame['file'], 'simpletest') !== false) { // dirname() is a bit slow.
- if (substr(dirname($frame['file']), -10) == 'simpletest') {
- continue;
- }
- }
- if (strncmp($frame['function'], $prefix, strlen($prefix)) == 0) {
- return sprintf($format, $frame['line']);
- }
- }
- return '';
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: dumper.php,v 1.22 2005/02/05 04:51:17 lastcraft Exp $ + */ + /** + * does type matter + */ + 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, 100); + 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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, 100, $position) . "] and [" . + $this->clipString($second, 100, $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 + */ + 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 + */ + 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) . "]"; + } + + /** + * 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 + */ + 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 + */ + 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 + */ + 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. + * @access private + */ + function _describeObjectDifference($first, $second, $identical) { + if (! is_object($second)) { + return $this->_describeGenericDifference($first, $second); + } + return $this->_describeArrayDifference( + get_object_vars($first), + get_object_vars($second), + $identical); + } + + /** + * 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 + */ + 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 + * @static + */ + function dump($variable) { + ob_start(); + print_r($variable); + $formatted = ob_get_contents(); + ob_end_clean(); + return $formatted; + } + + /** + * Extracts the last assertion that was not within + * Simpletest itself. The name must start with "assert". + * @param array $stack List of stack frames. + * @param string $format String formatting. + * @param string $prefix Prefix of method to search for. + * @access public + * @static + */ + function getFormattedAssertionLine($stack, $format = '%d', $prefix = 'assert') { + foreach ($stack as $frame) { + if (isset($frame['file']) && strpos($frame['file'], 'simpletest') !== false) { // dirname() is a bit slow. + if (substr(dirname($frame['file']), -10) == 'simpletest') { + continue; + } + } + if (strncmp($frame['function'], $prefix, strlen($prefix)) == 0) { + return sprintf($format, $frame['line']); + } + } + return ''; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/encoding.php b/tests/test_tools/simpletest/encoding.php index fd2d918a..62ca2a1b 100644 --- a/tests/UnitTests/simpletest/encoding.php +++ b/tests/test_tools/simpletest/encoding.php @@ -1,156 +1,156 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: encoding.php,v 1.6 2005/01/02 23:43:23 lastcraft Exp $
- */
-
- /**
- * Bundle of GET/POST parameters. Can include
- * repeated parameters.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleFormEncoding {
- protected $_request;
- protected $_x;
- protected $_y;
-
- /**
- * Starts empty.
- * @param array $query/SimpleQueryString Hash of parameters.
- * Multiple values are
- * as lists on a single key.
- * @access public
- */
- function SimpleFormEncoding($query = false) {
- if (! $query) {
- $query = array();
- }
- $this->_request = array();
- $this->setCoordinates();
- $this->merge($query);
- }
-
- /**
- * 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 (! isset($this->_request[$key])) {
- $this->_request[$key] = array();
- }
- if (is_array($value)) {
- foreach ($value as $item) {
- $this->_request[$key][] = $item;
- }
- } else {
- $this->_request[$key][] = $value;
- }
- }
-
- /**
- * 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)) {
- foreach ($query->getKeys() as $key) {
- $this->add($key, $query->getValue($key));
- }
- if ($query->getX() !== false) {
- $this->setCoordinates($query->getX(), $query->getY());
- }
- } elseif (is_array($query)) {
- foreach ($query as $key => $value) {
- $this->add($key, $value);
- }
- }
- }
-
- /**
- * Sets image coordinates. Set to false to clear
- * them.
- * @param integer $x Horizontal position.
- * @param integer $y Vertical position.
- * @access public
- */
- function setCoordinates($x = false, $y = false) {
- if (($x === false) || ($y === false)) {
- $this->_x = $this->_y = false;
- return;
- }
- $this->_x = (integer)$x;
- $this->_y = (integer)$y;
- }
-
- /**
- * Accessor for horizontal image coordinate.
- * @return integer X value.
- * @access public
- */
- function getX() {
- return $this->_x;
- }
-
- /**
- * Accessor for vertical image coordinate.
- * @return integer Y value.
- * @access public
- */
- function getY() {
- return $this->_y;
- }
-
- /**
- * Accessor for single value.
- * @return string/array False if missing, string
- * if present and array if
- * multiple entries.
- * @access public
- */
- function getValue($key) {
- if (! isset($this->_request[$key])) {
- return false;
- } elseif (count($this->_request[$key]) == 1) {
- return $this->_request[$key][0];
- } else {
- return $this->_request[$key];
- }
- }
-
- /**
- * Accessor for key list.
- * @return array List of keys present.
- * @access public
- */
- function getKeys() {
- return array_keys($this->_request);
- }
-
- /**
- * Renders the query string as a URL encoded
- * request part.
- * @return string Part of URL.
- * @access public
- */
- function asString() {
- $statements = array();
- foreach ($this->_request as $key => $values) {
- foreach ($values as $value) {
- $statements[] = "$key=" . urlencode($value);
- }
- }
- $coords = ($this->_x !== false) ? '?' . $this->_x . ',' . $this->_y : '';
- return implode('&', $statements) . $coords;
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: encoding.php,v 1.6 2005/01/02 23:43:23 lastcraft Exp $ + */ + + /** + * Bundle of GET/POST parameters. Can include + * repeated parameters. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleFormEncoding { + protected $_request; + protected $_x; + protected $_y; + + /** + * Starts empty. + * @param array $query/SimpleQueryString Hash of parameters. + * Multiple values are + * as lists on a single key. + * @access public + */ + function SimpleFormEncoding($query = false) { + if (! $query) { + $query = array(); + } + $this->_request = array(); + $this->setCoordinates(); + $this->merge($query); + } + + /** + * 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 (! isset($this->_request[$key])) { + $this->_request[$key] = array(); + } + if (is_array($value)) { + foreach ($value as $item) { + $this->_request[$key][] = $item; + } + } else { + $this->_request[$key][] = $value; + } + } + + /** + * 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)) { + foreach ($query->getKeys() as $key) { + $this->add($key, $query->getValue($key)); + } + if ($query->getX() !== false) { + $this->setCoordinates($query->getX(), $query->getY()); + } + } elseif (is_array($query)) { + foreach ($query as $key => $value) { + $this->add($key, $value); + } + } + } + + /** + * Sets image coordinates. Set to false to clear + * them. + * @param integer $x Horizontal position. + * @param integer $y Vertical position. + * @access public + */ + function setCoordinates($x = false, $y = false) { + if (($x === false) || ($y === false)) { + $this->_x = $this->_y = false; + return; + } + $this->_x = (integer)$x; + $this->_y = (integer)$y; + } + + /** + * Accessor for horizontal image coordinate. + * @return integer X value. + * @access public + */ + function getX() { + return $this->_x; + } + + /** + * Accessor for vertical image coordinate. + * @return integer Y value. + * @access public + */ + function getY() { + return $this->_y; + } + + /** + * Accessor for single value. + * @return string/array False if missing, string + * if present and array if + * multiple entries. + * @access public + */ + function getValue($key) { + if (! isset($this->_request[$key])) { + return false; + } elseif (count($this->_request[$key]) == 1) { + return $this->_request[$key][0]; + } else { + return $this->_request[$key]; + } + } + + /** + * Accessor for key list. + * @return array List of keys present. + * @access public + */ + function getKeys() { + return array_keys($this->_request); + } + + /** + * Renders the query string as a URL encoded + * request part. + * @return string Part of URL. + * @access public + */ + function asString() { + $statements = array(); + foreach ($this->_request as $key => $values) { + foreach ($values as $value) { + $statements[] = "$key=" . urlencode($value); + } + } + $coords = ($this->_x !== false) ? '?' . $this->_x . ',' . $this->_y : ''; + return implode('&', $statements) . $coords; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/errors.php b/tests/test_tools/simpletest/errors.php index a1fbe546..70c6c338 100644 --- a/tests/UnitTests/simpletest/errors.php +++ b/tests/test_tools/simpletest/errors.php @@ -1,141 +1,141 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: errors.php,v 1.13 2005/01/08 03:48:39 lastcraft Exp $
- */
- /** @ignore - PHP5 compatibility fix. */
- if (! defined('E_STRICT')) {
- define('E_STRICT', 2048);
- }
-
- /**
- * Singleton error queue used to record trapped
- * errors.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleErrorQueue {
- protected $_queue;
-
- /**
- * Starts with an empty queue.
- * @access public
- */
- function SimpleErrorQueue() {
- $this->clear();
- }
-
- /**
- * Adds an error to the front of the queue.
- * @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 add($severity, $message, $filename, $line, $super_globals) {
- array_push(
- $this->_queue,
- array($severity, $message, $filename, $line, $super_globals));
- }
-
- /**
- * Pulls the earliest error from the queue.
- * @return 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;
- }
-
- /**
- * Discards the contents of the error queue.
- * @access public
- */
- function clear() {
- $this->_queue = array();
- }
-
- /**
- * Tests to see if the queue is empty.
- * @return True if empty.
- */
- function isEmpty() {
- return (count($this->_queue) == 0);
- }
-
- /**
- * Global access to a single error queue.
- * @return Global error queue object.
- * @access public
- * @static
- */
- static function instance() {
- static $queue = false;
- if (! $queue) {
- $queue = new SimpleErrorQueue();
- }
- return $queue;
- }
-
- /**
- * Converst an error code into it's string
- * representation.
- * @param $severity PHP integer error code.
- * @return String version of error code.
- * @access public
- * @static
- */
- 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');
- 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.
- * @static
- * @access public
- */
- function simpleTestErrorHandler($severity, $message, $filename, $line, $super_globals) {
- if ($severity = $severity & error_reporting()) {
- restore_error_handler();
- if (ini_get('log_errors')) {
- $label = SimpleErrorQueue::getSeverityAsString($severity);
- error_log("$label: $message in $filename on line $line");
- }
- $queue = SimpleErrorQueue::instance();
- $queue->add($severity, $message, $filename, $line, $super_globals);
- set_error_handler('simpleTestErrorHandler');
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: errors.php,v 1.13 2005/01/08 03:48:39 lastcraft Exp $ + */ + /** @ignore - PHP5 compatibility fix. */ + if (! defined('E_STRICT')) { + define('E_STRICT', 2048); + } + + /** + * Singleton error queue used to record trapped + * errors. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleErrorQueue { + protected $_queue; + + /** + * Starts with an empty queue. + * @access public + */ + function SimpleErrorQueue() { + $this->clear(); + } + + /** + * Adds an error to the front of the queue. + * @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 add($severity, $message, $filename, $line, $super_globals) { + array_push( + $this->_queue, + array($severity, $message, $filename, $line, $super_globals)); + } + + /** + * Pulls the earliest error from the queue. + * @return 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; + } + + /** + * Discards the contents of the error queue. + * @access public + */ + function clear() { + $this->_queue = array(); + } + + /** + * Tests to see if the queue is empty. + * @return True if empty. + */ + function isEmpty() { + return (count($this->_queue) == 0); + } + + /** + * Global access to a single error queue. + * @return Global error queue object. + * @access public + * @static + */ + static function instance() { + static $queue = false; + if (! $queue) { + $queue = new SimpleErrorQueue(); + } + return $queue; + } + + /** + * Converst an error code into it's string + * representation. + * @param $severity PHP integer error code. + * @return String version of error code. + * @access public + * @static + */ + 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'); + 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. + * @static + * @access public + */ + function simpleTestErrorHandler($severity, $message, $filename, $line, $super_globals) { + if ($severity = $severity & error_reporting()) { + restore_error_handler(); + if (ini_get('log_errors')) { + $label = SimpleErrorQueue::getSeverityAsString($severity); + error_log("$label: $message in $filename on line $line"); + } + $queue = SimpleErrorQueue::instance(); + $queue->add($severity, $message, $filename, $line, $super_globals); + set_error_handler('simpleTestErrorHandler'); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/expectation.php b/tests/test_tools/simpletest/expectation.php index ffc61376..355963b4 100644 --- a/tests/UnitTests/simpletest/expectation.php +++ b/tests/test_tools/simpletest/expectation.php @@ -1,568 +1,568 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: expectation.php,v 1.35 2005/01/23 22:20:43 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/dumper.php');
- require_once(dirname(__FILE__) . '/options.php');
- /**#@-*/
-
- /**
- * Assertion that can display failure information.
- * Also includes various helper methods.
- * @package SimpleTest
- * @subpackage UnitTester
- * @abstract
- */
- class SimpleExpectation {
- protected $_dumper;
- protected $_message;
-
- /**
- * Creates a dumper for displaying values and sets
- * the test message.
- * @param string $message Customised message on failure.
- */
- function SimpleExpectation($message = '%s') {
- $this->_dumper = new SimpleDumper();
- $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.
- * @param mixed $compare Comparison value.
- * @return string Description of success
- * or failure.
- * @access public
- */
- function overlayMessage($compare) {
- return sprintf($this->_message, $this->testMessage($compare));
- }
-
- /**
- * Accessor for the dumper.
- * @return SimpleDumper Current value dumper.
- * @access protected
- */
- function _getDumper() {
- return $this->_dumper;
- }
- }
-
- /**
- * Test for equality.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class EqualExpectation extends SimpleExpectation {
- protected $_value;
-
- /**
- * Sets the value to compare against.
- * @param mixed $value Test value to match.
- * @param string $message Customised message on failure.
- * @access public
- */
- function EqualExpectation($value, $message = '%s') {
- $this->SimpleExpectation($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
- */
- 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 NotEqualExpectation($value, $message = '%s') {
- $this->EqualExpectation($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 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 IdenticalExpectation($value, $message = '%s') {
- $this->EqualExpectation($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 NotIdenticalExpectation($value, $message = '%s') {
- $this->IdenticalExpectation($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 WantedPatternExpectation extends SimpleExpectation {
- protected $_pattern;
-
- /**
- * Sets the value to compare against.
- * @param string $pattern Pattern to search for.
- * @param string $message Customised message on failure.
- * @access public
- */
- function WantedPatternExpectation($pattern, $message = '%s') {
- $this->SimpleExpectation($message);
- $this->_pattern = $pattern;
- }
-
- /**
- * Accessor for the pattern.
- * @return string Perl regex as string.
- * @access 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
- */
- 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 UnwantedPatternExpectation extends WantedPatternExpectation {
-
- /**
- * Sets the reject pattern
- * @param string $pattern Pattern to search for.
- * @param string $message Customised message on failure.
- * @access public
- */
- function UnwantedPatternExpectation($pattern, $message = '%s') {
- $this->WantedPatternExpectation($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 {
- protected $_type;
-
- /**
- * Sets the type to compare with.
- * @param string $type Type or class name.
- * @param string $message Customised message on failure.
- * @access public
- */
- function IsAExpectation($type, $message = '%s') {
- $this->SimpleExpectation($message);
- $this->_type = $type;
- }
-
- /**
- * Accessor for type to check against.
- * @return string Type or class name.
- * @access 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 {
- return (strtolower(gettype($compare)) == $this->_canonicalType($this->_type));
- }
- }
-
- /**
- * Coerces type name into a gettype() match.
- * @param string $type User type.
- * @return string Simpler type.
- * @access private
- */
- function _canonicalType($type) {
- $type = strtolower($type);
- $map = array(
- 'bool' => 'boolean',
- 'float' => 'double',
- 'real' => 'double',
- 'int' => 'integer');
- 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 {
- protected $_type;
-
- /**
- * Sets the type to compare with.
- * @param string $type Type or class name.
- * @param string $message Customised message on failure.
- * @access public
- */
- function NotAExpectation($type, $message = '%s') {
- $this->IsAExpectation($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 {
- protected $_method;
-
- /**
- * Sets the value to compare against.
- * @param string $method Method to check.
- * @param string $message Customised message on failure.
- * @access public
- * @return void
- */
- function MethodExistsExpectation($method, $message = '%s') {
- $this->SimpleExpectation($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.
- * @access public
- */
- 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.
- * @access public
- */
- 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]";
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: expectation.php,v 1.35 2005/01/23 22:20:43 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/dumper.php'); + require_once(dirname(__FILE__) . '/options.php'); + /**#@-*/ + + /** + * Assertion that can display failure information. + * Also includes various helper methods. + * @package SimpleTest + * @subpackage UnitTester + * @abstract + */ + class SimpleExpectation { + protected $_dumper; + protected $_message; + + /** + * Creates a dumper for displaying values and sets + * the test message. + * @param string $message Customised message on failure. + */ + function SimpleExpectation($message = '%s') { + $this->_dumper = new SimpleDumper(); + $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. + * @param mixed $compare Comparison value. + * @return string Description of success + * or failure. + * @access public + */ + function overlayMessage($compare) { + return sprintf($this->_message, $this->testMessage($compare)); + } + + /** + * Accessor for the dumper. + * @return SimpleDumper Current value dumper. + * @access protected + */ + function _getDumper() { + return $this->_dumper; + } + } + + /** + * Test for equality. + * @package SimpleTest + * @subpackage UnitTester + */ + class EqualExpectation extends SimpleExpectation { + protected $_value; + + /** + * Sets the value to compare against. + * @param mixed $value Test value to match. + * @param string $message Customised message on failure. + * @access public + */ + function EqualExpectation($value, $message = '%s') { + $this->SimpleExpectation($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 + */ + 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 NotEqualExpectation($value, $message = '%s') { + $this->EqualExpectation($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 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 IdenticalExpectation($value, $message = '%s') { + $this->EqualExpectation($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 NotIdenticalExpectation($value, $message = '%s') { + $this->IdenticalExpectation($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 WantedPatternExpectation extends SimpleExpectation { + protected $_pattern; + + /** + * Sets the value to compare against. + * @param string $pattern Pattern to search for. + * @param string $message Customised message on failure. + * @access public + */ + function WantedPatternExpectation($pattern, $message = '%s') { + $this->SimpleExpectation($message); + $this->_pattern = $pattern; + } + + /** + * Accessor for the pattern. + * @return string Perl regex as string. + * @access 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 + */ + 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 UnwantedPatternExpectation extends WantedPatternExpectation { + + /** + * Sets the reject pattern + * @param string $pattern Pattern to search for. + * @param string $message Customised message on failure. + * @access public + */ + function UnwantedPatternExpectation($pattern, $message = '%s') { + $this->WantedPatternExpectation($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 { + protected $_type; + + /** + * Sets the type to compare with. + * @param string $type Type or class name. + * @param string $message Customised message on failure. + * @access public + */ + function IsAExpectation($type, $message = '%s') { + $this->SimpleExpectation($message); + $this->_type = $type; + } + + /** + * Accessor for type to check against. + * @return string Type or class name. + * @access 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 { + return (strtolower(gettype($compare)) == $this->_canonicalType($this->_type)); + } + } + + /** + * Coerces type name into a gettype() match. + * @param string $type User type. + * @return string Simpler type. + * @access private + */ + function _canonicalType($type) { + $type = strtolower($type); + $map = array( + 'bool' => 'boolean', + 'float' => 'double', + 'real' => 'double', + 'int' => 'integer'); + 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 { + protected $_type; + + /** + * Sets the type to compare with. + * @param string $type Type or class name. + * @param string $message Customised message on failure. + * @access public + */ + function NotAExpectation($type, $message = '%s') { + $this->IsAExpectation($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 { + protected $_method; + + /** + * Sets the value to compare against. + * @param string $method Method to check. + * @param string $message Customised message on failure. + * @access public + * @return void + */ + function MethodExistsExpectation($method, $message = '%s') { + $this->SimpleExpectation($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. + * @access public + */ + 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. + * @access public + */ + 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]"; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/extensions/pear_test_case.php b/tests/test_tools/simpletest/extensions/pear_test_case.php index c9ac0743..51727345 100644..100755 --- a/tests/UnitTests/simpletest/extensions/pear_test_case.php +++ b/tests/test_tools/simpletest/extensions/pear_test_case.php @@ -1,199 +1,199 @@ -<?php
- /**
- * adapter for SimpleTest to use PEAR PHPUnit test cases
- * @package SimpleTest
- * @subpackage Extensions
- * @version $Id: pear_test_case.php,v 1.4 2005/01/13 01:31:57 lastcraft Exp $
- */
-
- /**#@+
- * include SimpleTest files
- */
- require_once dirname(__FILE__) . '/../dumper.php';
- require_once dirname(__FILE__) . '/../options.php';
- require_once dirname(__FILE__) . '/../simple_test.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 {
- var $_loosely_typed;
-
- /**
- * Constructor. Sets the test name.
- * @param $label Test name to display.
- * @public
- */
- function PHPUnit_TestCase($label = false) {
- $this->SimpleTestCase($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->assertExpectation($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::assertTrue(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::assertTrue(!isset($value), $message);
- }
-
- /**
- * In PHP5 the identity test tests for the same
- * object. This is a reference test in PHP4.
- * @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->assertTrue(
- SimpleTestCompatibility::isReference($first, $second),
- $message);
- }
-
- /**
- * In PHP5 the identity test tests for the same
- * object. This is a reference test in PHP4.
- * @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->assertFalse(
- 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::assertTrue($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::assertTrue(!$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->assertExpectation(
- new WantedPatternExpectation($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::assertTrue(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) {
- }
- }
-?>
+<?php + /** + * adapter for SimpleTest to use PEAR PHPUnit test cases + * @package SimpleTest + * @subpackage Extensions + * @version $Id: pear_test_case.php,v 1.4 2005/01/13 01:31:57 lastcraft Exp $ + */ + + /**#@+ + * include SimpleTest files + */ + require_once dirname(__FILE__) . '/../dumper.php'; + require_once dirname(__FILE__) . '/../options.php'; + require_once dirname(__FILE__) . '/../simple_test.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 { + var $_loosely_typed; + + /** + * Constructor. Sets the test name. + * @param $label Test name to display. + * @public + */ + function PHPUnit_TestCase($label = false) { + $this->SimpleTestCase($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->assertExpectation($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::assertTrue(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::assertTrue(!isset($value), $message); + } + + /** + * In PHP5 the identity test tests for the same + * object. This is a reference test in PHP4. + * @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->assertTrue( + SimpleTestCompatibility::isReference($first, $second), + $message); + } + + /** + * In PHP5 the identity test tests for the same + * object. This is a reference test in PHP4. + * @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->assertFalse( + 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::assertTrue($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::assertTrue(!$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->assertExpectation( + new WantedPatternExpectation($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::assertTrue(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) { + } + } +?> diff --git a/tests/UnitTests/simpletest/extensions/phpunit_test_case.php b/tests/test_tools/simpletest/extensions/phpunit_test_case.php index 4c6fa54e..a0954d8b 100644..100755 --- a/tests/UnitTests/simpletest/extensions/phpunit_test_case.php +++ b/tests/test_tools/simpletest/extensions/phpunit_test_case.php @@ -1,108 +1,108 @@ -<?php
- /**
- * adapter for SimpleTest to use PHPUnit test cases
- * @package SimpleTest
- * @subpackage Extensions
- * @version $Id: phpunit_test_case.php,v 1.3 2004/04/23 03:11:56 jsweat Exp $
- */
-
- /**#@+
- * include SimpleTest files
- */
- require_once dirname(__FILE__).DIRECTORY_SEPARATOR
- .'..'.DIRECTORY_SEPARATOR . 'unit_tester.php';
- require_once dirname(__FILE__).DIRECTORY_SEPARATOR
- .'..'.DIRECTORY_SEPARATOR . 'expectation.php';
- /**#@-*/
-
- /**
- * Adapter for sourceforge PHPUnit test case to allow
- * legacy test cases to be used with SimpleTest.
- * @package SimpleTest
- * @subpackage Extensions
- */
- class TestCase extends SimpleTestCase {
-
- /**
- * Constructor. Sets the test name.
- * @param $label Test name to display.
- * @public
- */
- function TestCase($label) {
- $this->SimpleTestCase($label);
- }
-
- /**
- * Sends pass if the test condition resolves true,
- * a fail otherwise.
- * @param $condition Condition to test true.
- * @param $message Message to display.
- * @public
- */
- function assert($condition, $message = false) {
- parent::assertTrue($condition, $message);
- }
-
- /**
- * 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 = false) {
- $this->assertExpectation(
- new EqualExpectation($first),
- $second,
- $message);
- }
-
- /**
- * 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 assertEqualsMultilineStrings($first, $second, $message = false) {
- $this->assertExpectation(
- new EqualExpectation($first),
- $second,
- $message);
- }
-
- /**
- * Tests a regex match.
- * @param $pattern Regex to match.
- * @param $subject String to search in.
- * @param $message Message to display.
- * @public
- */
- function assertRegexp($pattern, $subject, $message = false) {
- $this->assertExpectation(
- new WantedPatternExpectation($pattern),
- $subject,
- $message);
- }
-
- /**
- * Sends an error which we interpret as a fail
- * with a different message for compatibility.
- * @param $message Message to display.
- * @public
- */
- function error($message) {
- parent::assertTrue(false, "Error triggered [$message]");
- }
-
- /**
- * Accessor for name.
- * @public
- */
- function name() {
- return $this->getLabel();
- }
- }
-?>
+<?php + /** + * adapter for SimpleTest to use PHPUnit test cases + * @package SimpleTest + * @subpackage Extensions + * @version $Id: phpunit_test_case.php,v 1.3 2004/04/23 03:11:56 jsweat Exp $ + */ + + /**#@+ + * include SimpleTest files + */ + require_once dirname(__FILE__).DIRECTORY_SEPARATOR + .'..'.DIRECTORY_SEPARATOR . 'unit_tester.php'; + require_once dirname(__FILE__).DIRECTORY_SEPARATOR + .'..'.DIRECTORY_SEPARATOR . 'expectation.php'; + /**#@-*/ + + /** + * Adapter for sourceforge PHPUnit test case to allow + * legacy test cases to be used with SimpleTest. + * @package SimpleTest + * @subpackage Extensions + */ + class TestCase extends SimpleTestCase { + + /** + * Constructor. Sets the test name. + * @param $label Test name to display. + * @public + */ + function TestCase($label) { + $this->SimpleTestCase($label); + } + + /** + * Sends pass if the test condition resolves true, + * a fail otherwise. + * @param $condition Condition to test true. + * @param $message Message to display. + * @public + */ + function assert($condition, $message = false) { + parent::assertTrue($condition, $message); + } + + /** + * 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 = false) { + $this->assertExpectation( + new EqualExpectation($first), + $second, + $message); + } + + /** + * 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 assertEqualsMultilineStrings($first, $second, $message = false) { + $this->assertExpectation( + new EqualExpectation($first), + $second, + $message); + } + + /** + * Tests a regex match. + * @param $pattern Regex to match. + * @param $subject String to search in. + * @param $message Message to display. + * @public + */ + function assertRegexp($pattern, $subject, $message = false) { + $this->assertExpectation( + new WantedPatternExpectation($pattern), + $subject, + $message); + } + + /** + * Sends an error which we interpret as a fail + * with a different message for compatibility. + * @param $message Message to display. + * @public + */ + function error($message) { + parent::assertTrue(false, "Error triggered [$message]"); + } + + /** + * Accessor for name. + * @public + */ + function name() { + return $this->getLabel(); + } + } +?> diff --git a/tests/UnitTests/simpletest/form.php b/tests/test_tools/simpletest/form.php index 05f5c72a..89b4948a 100644 --- a/tests/UnitTests/simpletest/form.php +++ b/tests/test_tools/simpletest/form.php @@ -1,619 +1,619 @@ -<?php
- /**
- * Base include file for SimpleTest.
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: form.php,v 1.16 2005/02/22 02:17:04 lastcraft Exp $
- */
-
- /**#@+
- * include SimpleTest files
- */
- require_once(dirname(__FILE__) . '/tag.php');
- require_once(dirname(__FILE__) . '/encoding.php');
- /**#@-*/
-
- /**
- * Used to extract form elements for testing against.
- * Searches by name attribute.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleNameSelector {
- protected $_name;
-
- /**
- * Stashes the name for later comparison.
- * @param string $name Name attribute to match.
- */
- function SimpleNameSelector($name) {
- $this->_name = $name;
- }
-
- /**
- * Comparison. Compares with name attribute of
- * widget.
- * @param SimpleWidget $widget Control to compare.
- * @access public
- */
- function isMatch($widget) {
- return ($widget->getName() == $this->_name);
- }
- }
-
- /**
- * Used to extract form elements for testing against.
- * Searches by visible label or alt text.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleLabelSelector {
- protected $_label;
-
- /**
- * Stashes the name for later comparison.
- * @param string $label Visible text to match.
- */
- function SimpleLabelSelector($label) {
- $this->_label = $label;
- }
-
- /**
- * Comparison. Compares visible text of widget.
- * @param SimpleWidget $widget Control to compare.
- * @access public
- */
- function isMatch($widget) {
- return (trim($widget->getLabel()) == trim($this->_label));
- }
- }
-
- /**
- * Used to extract form elements for testing against.
- * Searches dy id attribute.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleIdSelector {
- protected $_id;
-
- /**
- * Stashes the name for later comparison.
- * @param string $id ID atribute to match.
- */
- function SimpleIdSelector($id) {
- $this->_id = $id;
- }
-
- /**
- * Comparison. Compares id attribute of widget.
- * @param SimpleWidget $widget Control to compare.
- * @access public
- */
- function isMatch($widget) {
- return $widget->isId($this->_id);
- }
- }
-
- /**
- * Form tag class to hold widget values.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleForm {
- protected $_method;
- protected $_action;
- protected $_default_target;
- protected $_id;
- protected $_buttons;
- protected $_images;
- protected $_widgets;
- protected $_radios;
- protected $_checkboxes;
-
- /**
- * Starts with no held controls/widgets.
- * @param SimpleTag $tag Form tag to read.
- * @param SimpleUrl $url Location of holding page.
- */
- function SimpleForm($tag, $url) {
- $this->_method = $tag->getAttribute('method');
- $this->_action = $this->_createAction($tag->getAttribute('action'), $url);
- $this->_default_target = false;
- $this->_id = $tag->getAttribute('id');
- $this->_buttons = array();
- $this->_images = array();
- $this->_widgets = array();
- $this->_radios = array();
- $this->_checkboxes = array();
- }
-
- /**
- * Sets the frame target within a frameset.
- * @param string $frame Name of frame.
- * @access public
- */
- function setDefaultTarget($frame) {
- $this->_default_target = $frame;
- }
-
- /**
- * Accessor for form action.
- * @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.
- */
- function _createAction($action, $base) {
- if ($action === false) {
- return $base;
- }
- if ($action === true) {
- $url = new SimpleUrl('');
- } else {
- $url = new SimpleUrl($action);
- }
- return $url->makeAbsolute($base);
- }
-
- /**
- * 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);
- }
- return $url;
- }
-
- /**
- * 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.
- * @access public
- */
- 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
- */
- 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
- */
- 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
- */
- 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 _getValueBySelector($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;
- }
-
- /**
- * Extracts current value from form.
- * @param string $name Keyed by widget name.
- * @return string/array Value(s) or null
- * if not set.
- * @access public
- */
- function getValue($name) {
- return $this->_getValueBySelector(new SimpleNameSelector($name));
- }
-
- /**
- * Extracts current value from form by the ID.
- * @param string/integer $id Keyed by widget ID attribute.
- * @return string/array Value(s) or null
- * if not set.
- * @access public
- */
- function getValueById($id) {
- return $this->_getValueBySelector(new SimpleIdSelector($id));
- }
-
- /**
- * 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 _setFieldBySelector($selector, $value) {
- $success = false;
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($selector->isMatch($this->_widgets[$i])) {
- if ($this->_widgets[$i]->setValue($value)) {
- $success = true;
- }
- }
- }
- return $success;
- }
-
- /**
- * Sets a widget value within the form.
- * @param string $name Name of widget tag.
- * @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($name, $value) {
- return $this->_setFieldBySelector(new SimpleNameSelector($name), $value);
- }
-
- /**
- * Sets a widget value within the form by using the ID.
- * @param string/integer $id Name of widget tag.
- * @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 setFieldById($id, $value) {
- return $this->_setFieldBySelector(new SimpleIdSelector($id), $value);
- }
-
- /**
- * Creates the encoding for the current values in the
- * form.
- * @return SimpleFormEncoding Request to submit.
- * @access private
- */
- function _getEncoding() {
- $encoding = new SimpleFormEncoding();
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- $encoding->add(
- $this->_widgets[$i]->getName(),
- $this->_widgets[$i]->getValue());
- }
- return $encoding;
- }
-
- /**
- * Test to see if a form has a submit button.
- * @param SimpleSelector $selector Criteria to apply.
- * @return boolean True if present.
- * @access private
- */
- function _hasSubmitBySelector($selector) {
- foreach ($this->_buttons as $button) {
- if ($selector->isMatch($button)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Test to see if a form has a submit button with this
- * name attribute.
- * @param string $name Name to look for.
- * @return boolean True if present.
- * @access public
- */
- function hasSubmitName($name) {
- return $this->_hasSubmitBySelector(new SimpleNameSelector($name));
- }
-
- /**
- * Test to see if a form has a submit button with this
- * value attribute.
- * @param string $label Button label to search for.
- * @return boolean True if present.
- * @access public
- */
- function hasSubmitLabel($label) {
- return $this->_hasSubmitBySelector(new SimpleLabelSelector($label));
- }
-
- /**
- * Test to see if a form has a submit button with this
- * ID attribute.
- * @param string $id Button ID attribute to search for.
- * @return boolean True if present.
- * @access public
- */
- function hasSubmitId($id) {
- return $this->_hasSubmitBySelector(new SimpleIdSelector($id));
- }
-
- /**
- * Test to see if a form has an image control.
- * @param SimpleSelector $selector Criteria to apply.
- * @return boolean True if present.
- * @access public
- */
- function _hasImageBySelector($selector) {
- foreach ($this->_images as $image) {
- if ($selector->isMatch($image)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Test to see if a form has a submit button with this
- * name attribute.
- * @param string $label Button alt attribute to search for
- * or nearest equivalent.
- * @return boolean True if present.
- * @access public
- */
- function hasImageLabel($label) {
- return $this->_hasImageBySelector(new SimpleLabelSelector($label));
- }
-
- /**
- * Test to see if a form has a submittable image with this
- * field name.
- * @param string $name Image name to search for.
- * @return boolean True if present.
- * @access public
- */
- function hasImageName($name) {
- return $this->_hasImageBySelector(new SimpleNameSelector($name));
- }
-
- /**
- * Test to see if a form has a submittable image with this
- * ID attribute.
- * @param string $id Button ID attribute to search for.
- * @return boolean True if present.
- * @access public
- */
- function hasImageId($id) {
- return $this->_hasImageBySelector(new SimpleIdSelector($id));
- }
-
- /**
- * 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 _submitButtonBySelector($selector, $additional) {
- foreach ($this->_buttons as $button) {
- if ($selector->isMatch($button)) {
- $encoding = $this->_getEncoding();
- $encoding->merge($button->getSubmitValues());
- if ($additional) {
- $encoding->merge($additional);
- }
- return $encoding;
- }
- }
- return false;
- }
-
- /**
- * Gets the submit values for a named button.
- * @param string $name Button label to search for.
- * @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 submitButtonByName($name, $additional = false) {
- return $this->_submitButtonBySelector(
- new SimpleNameSelector($name),
- $additional);
- }
-
- /**
- * Gets the submit values for a named button.
- * @param string $label Button label to search for.
- * @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 submitButtonByLabel($label, $additional = false) {
- return $this->_submitButtonBySelector(
- new SimpleLabelSelector($label),
- $additional);
- }
-
- /**
- * Gets the submit values for a button identified by the ID.
- * @param string $id Button ID attribute to search for.
- * @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 submitButtonById($id, $additional = false) {
- return $this->_submitButtonBySelector(
- new SimpleIdSelector($id),
- $additional);
- }
-
- /**
- * 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 _submitImageBySelector($selector, $x, $y, $additional) {
- foreach ($this->_images as $image) {
- if ($selector->isMatch($image)) {
- $encoding = $this->_getEncoding();
- $encoding->merge($image->getSubmitValues($x, $y));
- if ($additional) {
- $encoding->merge($additional);
- }
- return $encoding;
- }
- }
- return false;
- }
-
- /**
- * Gets the submit values for an image identified by the alt
- * tag or nearest equivalent.
- * @param string $label Button label to search for.
- * @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 submitImageByLabel($label, $x, $y, $additional = false) {
- return $this->_submitImageBySelector(
- new SimpleLabelSelector($label),
- $x,
- $y,
- $additional);
- }
-
- /**
- * Gets the submit values for an image identified by the ID.
- * @param string $name Image name to search for.
- * @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 submitImageByName($name, $x, $y, $additional = false) {
- return $this->_submitImageBySelector(
- new SimpleNameSelector($name),
- $x,
- $y,
- $additional);
- }
-
- /**
- * Gets the submit values for an image identified by the ID.
- * @param string/integer $id Button ID attribute to search for.
- * @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 submitImageById($id, $x, $y, $additional = false) {
- return $this->_submitImageBySelector(
- new SimpleIdSelector($id),
- $x,
- $y,
- $additional);
- }
-
- /**
- * 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() {
- return $this->_getEncoding();
- }
- }
+<?php + /** + * Base include file for SimpleTest. + * @package SimpleTest + * @subpackage WebTester + * @version $Id: form.php,v 1.16 2005/02/22 02:17:04 lastcraft Exp $ + */ + + /**#@+ + * include SimpleTest files + */ + require_once(dirname(__FILE__) . '/tag.php'); + require_once(dirname(__FILE__) . '/encoding.php'); + /**#@-*/ + + /** + * Used to extract form elements for testing against. + * Searches by name attribute. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleNameSelector { + protected $_name; + + /** + * Stashes the name for later comparison. + * @param string $name Name attribute to match. + */ + function SimpleNameSelector($name) { + $this->_name = $name; + } + + /** + * Comparison. Compares with name attribute of + * widget. + * @param SimpleWidget $widget Control to compare. + * @access public + */ + function isMatch($widget) { + return ($widget->getName() == $this->_name); + } + } + + /** + * Used to extract form elements for testing against. + * Searches by visible label or alt text. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleLabelSelector { + protected $_label; + + /** + * Stashes the name for later comparison. + * @param string $label Visible text to match. + */ + function SimpleLabelSelector($label) { + $this->_label = $label; + } + + /** + * Comparison. Compares visible text of widget. + * @param SimpleWidget $widget Control to compare. + * @access public + */ + function isMatch($widget) { + return (trim($widget->getLabel()) == trim($this->_label)); + } + } + + /** + * Used to extract form elements for testing against. + * Searches dy id attribute. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleIdSelector { + protected $_id; + + /** + * Stashes the name for later comparison. + * @param string $id ID atribute to match. + */ + function SimpleIdSelector($id) { + $this->_id = $id; + } + + /** + * Comparison. Compares id attribute of widget. + * @param SimpleWidget $widget Control to compare. + * @access public + */ + function isMatch($widget) { + return $widget->isId($this->_id); + } + } + + /** + * Form tag class to hold widget values. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleForm { + protected $_method; + protected $_action; + protected $_default_target; + protected $_id; + protected $_buttons; + protected $_images; + protected $_widgets; + protected $_radios; + protected $_checkboxes; + + /** + * Starts with no held controls/widgets. + * @param SimpleTag $tag Form tag to read. + * @param SimpleUrl $url Location of holding page. + */ + function SimpleForm($tag, $url) { + $this->_method = $tag->getAttribute('method'); + $this->_action = $this->_createAction($tag->getAttribute('action'), $url); + $this->_default_target = false; + $this->_id = $tag->getAttribute('id'); + $this->_buttons = array(); + $this->_images = array(); + $this->_widgets = array(); + $this->_radios = array(); + $this->_checkboxes = array(); + } + + /** + * Sets the frame target within a frameset. + * @param string $frame Name of frame. + * @access public + */ + function setDefaultTarget($frame) { + $this->_default_target = $frame; + } + + /** + * Accessor for form action. + * @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. + */ + function _createAction($action, $base) { + if ($action === false) { + return $base; + } + if ($action === true) { + $url = new SimpleUrl(''); + } else { + $url = new SimpleUrl($action); + } + return $url->makeAbsolute($base); + } + + /** + * 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); + } + return $url; + } + + /** + * 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. + * @access public + */ + 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 + */ + 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 + */ + 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 + */ + 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 _getValueBySelector($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; + } + + /** + * Extracts current value from form. + * @param string $name Keyed by widget name. + * @return string/array Value(s) or null + * if not set. + * @access public + */ + function getValue($name) { + return $this->_getValueBySelector(new SimpleNameSelector($name)); + } + + /** + * Extracts current value from form by the ID. + * @param string/integer $id Keyed by widget ID attribute. + * @return string/array Value(s) or null + * if not set. + * @access public + */ + function getValueById($id) { + return $this->_getValueBySelector(new SimpleIdSelector($id)); + } + + /** + * 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 _setFieldBySelector($selector, $value) { + $success = false; + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($selector->isMatch($this->_widgets[$i])) { + if ($this->_widgets[$i]->setValue($value)) { + $success = true; + } + } + } + return $success; + } + + /** + * Sets a widget value within the form. + * @param string $name Name of widget tag. + * @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($name, $value) { + return $this->_setFieldBySelector(new SimpleNameSelector($name), $value); + } + + /** + * Sets a widget value within the form by using the ID. + * @param string/integer $id Name of widget tag. + * @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 setFieldById($id, $value) { + return $this->_setFieldBySelector(new SimpleIdSelector($id), $value); + } + + /** + * Creates the encoding for the current values in the + * form. + * @return SimpleFormEncoding Request to submit. + * @access private + */ + function _getEncoding() { + $encoding = new SimpleFormEncoding(); + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + $encoding->add( + $this->_widgets[$i]->getName(), + $this->_widgets[$i]->getValue()); + } + return $encoding; + } + + /** + * Test to see if a form has a submit button. + * @param SimpleSelector $selector Criteria to apply. + * @return boolean True if present. + * @access private + */ + function _hasSubmitBySelector($selector) { + foreach ($this->_buttons as $button) { + if ($selector->isMatch($button)) { + return true; + } + } + return false; + } + + /** + * Test to see if a form has a submit button with this + * name attribute. + * @param string $name Name to look for. + * @return boolean True if present. + * @access public + */ + function hasSubmitName($name) { + return $this->_hasSubmitBySelector(new SimpleNameSelector($name)); + } + + /** + * Test to see if a form has a submit button with this + * value attribute. + * @param string $label Button label to search for. + * @return boolean True if present. + * @access public + */ + function hasSubmitLabel($label) { + return $this->_hasSubmitBySelector(new SimpleLabelSelector($label)); + } + + /** + * Test to see if a form has a submit button with this + * ID attribute. + * @param string $id Button ID attribute to search for. + * @return boolean True if present. + * @access public + */ + function hasSubmitId($id) { + return $this->_hasSubmitBySelector(new SimpleIdSelector($id)); + } + + /** + * Test to see if a form has an image control. + * @param SimpleSelector $selector Criteria to apply. + * @return boolean True if present. + * @access public + */ + function _hasImageBySelector($selector) { + foreach ($this->_images as $image) { + if ($selector->isMatch($image)) { + return true; + } + } + return false; + } + + /** + * Test to see if a form has a submit button with this + * name attribute. + * @param string $label Button alt attribute to search for + * or nearest equivalent. + * @return boolean True if present. + * @access public + */ + function hasImageLabel($label) { + return $this->_hasImageBySelector(new SimpleLabelSelector($label)); + } + + /** + * Test to see if a form has a submittable image with this + * field name. + * @param string $name Image name to search for. + * @return boolean True if present. + * @access public + */ + function hasImageName($name) { + return $this->_hasImageBySelector(new SimpleNameSelector($name)); + } + + /** + * Test to see if a form has a submittable image with this + * ID attribute. + * @param string $id Button ID attribute to search for. + * @return boolean True if present. + * @access public + */ + function hasImageId($id) { + return $this->_hasImageBySelector(new SimpleIdSelector($id)); + } + + /** + * 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 _submitButtonBySelector($selector, $additional) { + foreach ($this->_buttons as $button) { + if ($selector->isMatch($button)) { + $encoding = $this->_getEncoding(); + $encoding->merge($button->getSubmitValues()); + if ($additional) { + $encoding->merge($additional); + } + return $encoding; + } + } + return false; + } + + /** + * Gets the submit values for a named button. + * @param string $name Button label to search for. + * @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 submitButtonByName($name, $additional = false) { + return $this->_submitButtonBySelector( + new SimpleNameSelector($name), + $additional); + } + + /** + * Gets the submit values for a named button. + * @param string $label Button label to search for. + * @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 submitButtonByLabel($label, $additional = false) { + return $this->_submitButtonBySelector( + new SimpleLabelSelector($label), + $additional); + } + + /** + * Gets the submit values for a button identified by the ID. + * @param string $id Button ID attribute to search for. + * @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 submitButtonById($id, $additional = false) { + return $this->_submitButtonBySelector( + new SimpleIdSelector($id), + $additional); + } + + /** + * 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 _submitImageBySelector($selector, $x, $y, $additional) { + foreach ($this->_images as $image) { + if ($selector->isMatch($image)) { + $encoding = $this->_getEncoding(); + $encoding->merge($image->getSubmitValues($x, $y)); + if ($additional) { + $encoding->merge($additional); + } + return $encoding; + } + } + return false; + } + + /** + * Gets the submit values for an image identified by the alt + * tag or nearest equivalent. + * @param string $label Button label to search for. + * @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 submitImageByLabel($label, $x, $y, $additional = false) { + return $this->_submitImageBySelector( + new SimpleLabelSelector($label), + $x, + $y, + $additional); + } + + /** + * Gets the submit values for an image identified by the ID. + * @param string $name Image name to search for. + * @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 submitImageByName($name, $x, $y, $additional = false) { + return $this->_submitImageBySelector( + new SimpleNameSelector($name), + $x, + $y, + $additional); + } + + /** + * Gets the submit values for an image identified by the ID. + * @param string/integer $id Button ID attribute to search for. + * @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 submitImageById($id, $x, $y, $additional = false) { + return $this->_submitImageBySelector( + new SimpleIdSelector($id), + $x, + $y, + $additional); + } + + /** + * 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() { + return $this->_getEncoding(); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/frames.php b/tests/test_tools/simpletest/frames.php index b18d28fc..75951476 100644 --- a/tests/UnitTests/simpletest/frames.php +++ b/tests/test_tools/simpletest/frames.php @@ -1,673 +1,673 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: frames.php,v 1.29 2004/11/30 05:33:56 lastcraft Exp $
- */
-
- /**#@+
- * 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 {
- protected $_frameset;
- protected $_frames;
- protected $_focus;
- protected $_names;
-
- /**
- * Stashes the frameset page. Will make use of the
- * browser to fetch the sub frames recursively.
- * @param SimplePage $page Frameset page.
- */
- function SimpleFrameset($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
- */
- 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
- */
- 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;
- }
-
- /**
- * 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 with scheme of
- * http or https and hostname.
- * @access public
- */
- function getAbsoluteUrls() {
- if (is_integer($this->_focus)) {
- return $this->_frames[$this->_focus]->getAbsoluteUrls();
- }
- $urls = array();
- foreach ($this->_frames as $frame) {
- $urls = array_merge($urls, $frame->getAbsoluteUrls());
- }
- return array_values(array_unique($urls));
- }
-
- /**
- * Accessor for a list of all relative links.
- * @return array List of urls without hostname.
- * @access public
- */
- function getRelativeUrls() {
- if (is_integer($this->_focus)) {
- return $this->_frames[$this->_focus]->getRelativeUrls();
- }
- $urls = array();
- foreach ($this->_frames as $frame) {
- $urls = array_merge($urls, $frame->getRelativeUrls());
- }
- 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
- */
- 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. The first form found
- * either within the focused frame, or across frames,
- * will be the one returned.
- * @param string $label Button label, default 'Submit'.
- * @return SimpleForm Form object containing the button.
- * @access public
- */
- function getFormBySubmitLabel($label) {
- return $this->_findForm('getFormBySubmitLabel', $label);
- }
-
- /**
- * Finds a held form by button label. Will only
- * search correctly built forms. The first form found
- * either within the focused frame, or across frames,
- * will be the one returned.
- * @param string $name Button name attribute.
- * @return SimpleForm Form object containing the button.
- * @access public
- */
- function getFormBySubmitName($name) {
- return $this->_findForm('getFormBySubmitName', $name);
- }
-
- /**
- * Finds a held form by button id. Will only
- * search correctly built forms. The first form found
- * either within the focused frame, or across frames,
- * will be the one returned.
- * @param string $id Button ID attribute.
- * @return SimpleForm Form object containing the button.
- * @access public
- */
- function getFormBySubmitId($id) {
- return $this->_findForm('getFormBySubmitId', $id);
- }
-
- /**
- * Finds a held form by image label. Will only
- * search correctly built forms. The first form found
- * either within the focused frame, or across frames,
- * will be the one returned.
- * @param string $label Usually the alt attribute.
- * @return SimpleForm Form object containing the image.
- * @access public
- */
- function getFormByImageLabel($label) {
- return $this->_findForm('getFormByImageLabel', $label);
- }
-
- /**
- * Finds a held form by image button id. Will only
- * search correctly built forms. The first form found
- * either within the focused frame, or across frames,
- * will be the one returned.
- * @param string $name Image name.
- * @return SimpleForm Form object containing the image.
- * @access public
- */
- function getFormByImageName($name) {
- return $this->_findForm('getFormByImageName', $name);
- }
-
- /**
- * Finds a held form by image button id. Will only
- * search correctly built forms. The first form found
- * either within the focused frame, or across frames,
- * will be the one returned.
- * @param string $id Image ID attribute.
- * @return SimpleForm Form object containing the image.
- * @access public
- */
- function getFormByImageId($id) {
- return $this->_findForm('getFormByImageId', $id);
- }
-
- /**
- * 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 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;
- }
- }
- 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 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 string $name Field name.
- * @param string $value Value to set field to.
- * @return boolean True if value is valid.
- * @access public
- */
- function setField($name, $value) {
- if (is_integer($this->_focus)) {
- $this->_frames[$this->_focus]->setField($name, $value);
- } else {
- for ($i = 0; $i < count($this->_frames); $i++) {
- $this->_frames[$i]->setField($name, $value);
- }
- }
- }
-
- /**
- * Sets a field on the form in which the unique field is
- * available.
- * @param string/integer $id Field ID attribute.
- * @param string $value Value to set field to.
- * @return boolean True if value is valid.
- * @access public
- */
- function setFieldById($id, $value) {
- if (is_integer($this->_focus)) {
- $this->_frames[$this->_focus]->setFieldById($id, $value);
- } else {
- for ($i = 0; $i < count($this->_frames); $i++) {
- $this->_frames[$i]->setFieldById($id, $value);
- }
- }
- }
-
- /**
- * Accessor for a form element value within a frameset.
- * Finds the first match amongst the frames.
- * @param string $name Field name.
- * @return string/boolean A string if the field is
- * present, false if unchecked
- * and null if missing.
- * @access public
- */
- function getField($name) {
- for ($i = 0; $i < count($this->_frames); $i++) {
- $value = $this->_frames[$i]->getField($name);
- if (isset($value)) {
- return $value;
- }
- }
- return null;
- }
-
- /**
- * Accessor for a form element value within a page.
- * Finds the first match.
- * @param string/integer $id Field ID attribute.
- * @return string/boolean A string if the field is
- * present, false if unchecked
- * and null if missing.
- * @access public
- */
- function getFieldById($id) {
- for ($i = 0; $i < count($this->_frames); $i++) {
- $value = $this->_frames[$i]->getFieldById($id);
- if (isset($value)) {
- return $value;
- }
- }
- return null;
- }
- }
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: frames.php,v 1.29 2004/11/30 05:33:56 lastcraft Exp $ + */ + + /**#@+ + * 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 { + protected $_frameset; + protected $_frames; + protected $_focus; + protected $_names; + + /** + * Stashes the frameset page. Will make use of the + * browser to fetch the sub frames recursively. + * @param SimplePage $page Frameset page. + */ + function SimpleFrameset($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 + */ + 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 + */ + 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; + } + + /** + * 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 with scheme of + * http or https and hostname. + * @access public + */ + function getAbsoluteUrls() { + if (is_integer($this->_focus)) { + return $this->_frames[$this->_focus]->getAbsoluteUrls(); + } + $urls = array(); + foreach ($this->_frames as $frame) { + $urls = array_merge($urls, $frame->getAbsoluteUrls()); + } + return array_values(array_unique($urls)); + } + + /** + * Accessor for a list of all relative links. + * @return array List of urls without hostname. + * @access public + */ + function getRelativeUrls() { + if (is_integer($this->_focus)) { + return $this->_frames[$this->_focus]->getRelativeUrls(); + } + $urls = array(); + foreach ($this->_frames as $frame) { + $urls = array_merge($urls, $frame->getRelativeUrls()); + } + 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 + */ + 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. The first form found + * either within the focused frame, or across frames, + * will be the one returned. + * @param string $label Button label, default 'Submit'. + * @return SimpleForm Form object containing the button. + * @access public + */ + function getFormBySubmitLabel($label) { + return $this->_findForm('getFormBySubmitLabel', $label); + } + + /** + * Finds a held form by button label. Will only + * search correctly built forms. The first form found + * either within the focused frame, or across frames, + * will be the one returned. + * @param string $name Button name attribute. + * @return SimpleForm Form object containing the button. + * @access public + */ + function getFormBySubmitName($name) { + return $this->_findForm('getFormBySubmitName', $name); + } + + /** + * Finds a held form by button id. Will only + * search correctly built forms. The first form found + * either within the focused frame, or across frames, + * will be the one returned. + * @param string $id Button ID attribute. + * @return SimpleForm Form object containing the button. + * @access public + */ + function getFormBySubmitId($id) { + return $this->_findForm('getFormBySubmitId', $id); + } + + /** + * Finds a held form by image label. Will only + * search correctly built forms. The first form found + * either within the focused frame, or across frames, + * will be the one returned. + * @param string $label Usually the alt attribute. + * @return SimpleForm Form object containing the image. + * @access public + */ + function getFormByImageLabel($label) { + return $this->_findForm('getFormByImageLabel', $label); + } + + /** + * Finds a held form by image button id. Will only + * search correctly built forms. The first form found + * either within the focused frame, or across frames, + * will be the one returned. + * @param string $name Image name. + * @return SimpleForm Form object containing the image. + * @access public + */ + function getFormByImageName($name) { + return $this->_findForm('getFormByImageName', $name); + } + + /** + * Finds a held form by image button id. Will only + * search correctly built forms. The first form found + * either within the focused frame, or across frames, + * will be the one returned. + * @param string $id Image ID attribute. + * @return SimpleForm Form object containing the image. + * @access public + */ + function getFormByImageId($id) { + return $this->_findForm('getFormByImageId', $id); + } + + /** + * 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 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; + } + } + 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 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 string $name Field name. + * @param string $value Value to set field to. + * @return boolean True if value is valid. + * @access public + */ + function setField($name, $value) { + if (is_integer($this->_focus)) { + $this->_frames[$this->_focus]->setField($name, $value); + } else { + for ($i = 0; $i < count($this->_frames); $i++) { + $this->_frames[$i]->setField($name, $value); + } + } + } + + /** + * Sets a field on the form in which the unique field is + * available. + * @param string/integer $id Field ID attribute. + * @param string $value Value to set field to. + * @return boolean True if value is valid. + * @access public + */ + function setFieldById($id, $value) { + if (is_integer($this->_focus)) { + $this->_frames[$this->_focus]->setFieldById($id, $value); + } else { + for ($i = 0; $i < count($this->_frames); $i++) { + $this->_frames[$i]->setFieldById($id, $value); + } + } + } + + /** + * Accessor for a form element value within a frameset. + * Finds the first match amongst the frames. + * @param string $name Field name. + * @return string/boolean A string if the field is + * present, false if unchecked + * and null if missing. + * @access public + */ + function getField($name) { + for ($i = 0; $i < count($this->_frames); $i++) { + $value = $this->_frames[$i]->getField($name); + if (isset($value)) { + return $value; + } + } + return null; + } + + /** + * Accessor for a form element value within a page. + * Finds the first match. + * @param string/integer $id Field ID attribute. + * @return string/boolean A string if the field is + * present, false if unchecked + * and null if missing. + * @access public + */ + function getFieldById($id) { + for ($i = 0; $i < count($this->_frames); $i++) { + $value = $this->_frames[$i]->getFieldById($id); + if (isset($value)) { + return $value; + } + } + return null; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/http.php b/tests/test_tools/simpletest/http.php index 36cb395f..fa27de9c 100644 --- a/tests/UnitTests/simpletest/http.php +++ b/tests/test_tools/simpletest/http.php @@ -1,853 +1,853 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: http.php,v 1.98 2005/02/02 23:25:23 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/socket.php');
- 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 {
- protected $_host;
- protected $_name;
- protected $_value;
- protected $_path;
- protected $_expiry;
- protected $_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 SimpleCookie($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
- */
- 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
- */
- function _fixPath($path) {
- if (substr($path, 0, 1) != '/') {
- $path = '/' . $path;
- }
- if (substr($path, -1, 1) != '/') {
- $path .= '/';
- }
- return $path;
- }
- }
-
- /**
- * Creates HTTP headers for the end point of
- * a HTTP request.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleRoute {
- protected $_url;
-
- /**
- * Sets the target URL.
- * @param SimpleUrl $url URL as object.
- * @access public
- */
- function SimpleRoute($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
- */
- 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
- */
- 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
- */
- function _createSocket($scheme, $host, $port, $timeout) {
- if (in_array($scheme, array('https'))) {
- return new SimpleSecureSocket($host, $port, $timeout);
- }
- 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 {
- protected $_proxy;
- protected $_username;
- protected $_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 SimpleProxyRoute($url, $proxy, $username = false, $password = false) {
- $this->SimpleRoute($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()) {
- $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 {
- protected $_route;
- protected $_method;
- protected $_encoding;
- protected $_headers;
- protected $_cookies;
-
- /**
- * Saves the URL ready for fetching.
- * @param SimpleRoute $route Request route.
- * @param string $method HTTP request method,
- * usually GET.
- * @param SimpleFormEncoding $encoding Content to send with
- * request or false.
- * @access public
- */
- function SimpleHttpRequest($route, $method, $encoding = false) {
- $this->_route = $route;
- $this->_method = $method;
- $this->_encoding = $encoding;
- $this->_headers = array();
- $this->_cookies = array();
- }
-
- /**
- * Fetches the content and parses the headers.
- * @param integer $timeout Connection timeout.
- * @return SimpleHttpResponse A response which may only have
- * an error.
- * @access public
- */
- function fetch($timeout) {
- $socket = $this->_route->createConnection($this->_method, $timeout);
- if ($socket->isError()) {
- return $this->_createResponse($socket);
- }
- $this->_dispatchRequest($socket, $this->_method, $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
- */
- function _dispatchRequest($socket, $method, $encoding) {
- if ($encoding || ($method == 'POST')) {
- $socket->write("Content-Length: " . $this->_getContentLength($encoding) . "\r\n");
- $socket->write("Content-Type: application/x-www-form-urlencoded\r\n");
- }
- foreach ($this->_headers as $header_line) {
- $socket->write($header_line . "\r\n");
- }
- if (count($this->_cookies) > 0) {
- $socket->write("Cookie: " . $this->_marshallCookies($this->_cookies) . "\r\n");
- }
- $socket->write("\r\n");
- if ($encoding) {
- $socket->write($encoding->asString());
- }
- }
-
- /**
- * Calculates the length of the encoded content.
- * @param SimpleFormEncoding $encoding Content to send with
- * request or false.
- */
- function _getContentLength($encoding) {
- if (! $encoding) {
- return 0;
- }
- return (integer)strlen($encoding->asString());
- }
-
- /**
- * Adds a header line to the request.
- * @param string $header_line Text of header line.
- * @access public
- */
- function addHeaderLine($header_line) {
- $this->_headers[] = $header_line;
- }
-
- /**
- * Adds a cookie to the request.
- * @param SimpleCookie $cookie Additional cookie.
- * @access public
- */
- function setCookie($cookie) {
- $this->_cookies[] = $cookie;
- }
-
- /**
- * Serialises the cookie hash ready for
- * transmission.
- * @param hash $cookies Parsed cookies.
- * @return array Cookies in header form.
- * @access private
- */
- function _marshallCookies($cookies) {
- $cookie_pairs = array();
- foreach ($cookies as $cookie) {
- $cookie_pairs[] = $cookie->getName() . "=" . $cookie->getValue();
- }
- return implode(";", $cookie_pairs);
- }
-
- /**
- * Wraps the socket in a response parser.
- * @param SimpleSocket $socket Responding socket.
- * @return SimpleHttpResponse Parsed response object.
- * @access protected
- */
- function _createResponse($socket) {
- return new SimpleHttpResponse(
- $socket,
- $this->_method,
- $this->_route->getUrl(),
- $this->_encoding);
- }
- }
-
- /**
- * Collection of header lines in the response.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleHttpHeaders {
- protected $_raw_headers;
- protected $_response_code;
- protected $_http_version;
- protected $_mime_type;
- protected $_location;
- protected $_cookies;
- protected $_authentication;
- protected $_realm;
-
- /**
- * Parses the incoming header block.
- * @param string $headers Header block.
- * @access public
- */
- function SimpleHttpHeaders($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 (split("\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;
- }
-
- /**
- * Accessor for any new cookies.
- * @return array List of new cookies.
- * @access public
- */
- function getNewCookies() {
- return $this->_cookies;
- }
-
- /**
- * Called on each header line to accumulate the held
- * data within the class.
- * @param string $header_line One line of header.
- * @access protected
- */
- function _parseHeaderLine($header_line) {
- if (preg_match('/HTTP\/(\d+\.\d+)\s+(.*?)\s/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
- */
- function _parseCookie($cookie_line) {
- $parts = split(";", $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 {
- protected $_method;
- protected $_url;
- protected $_request_data;
- protected $_sent;
- protected $_content;
- protected $_headers;
-
- /**
- * Constructor. Reads and parses the incoming
- * content and headers.
- * @param SimpleSocket $socket Network connection to fetch
- * response text from.
- * @param string $method HTTP request method.
- * @param SimpleUrl $url Resource name.
- * @param mixed $request_data Record of content sent.
- * @access public
- */
- function SimpleHttpResponse($socket, $method, $url, $request_data = '') {
- $this->SimpleStickyError();
- $this->_method = $method;
- $this->_url = $url;
- $this->_request_data = $request_data;
- $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
- */
- function _parse($raw) {
- if (! $raw) {
- $this->_setError('Nothing fetched');
- $this->_headers = new SimpleHttpHeaders('');
- } elseif (! strstr($raw, "\r\n\r\n")) {
- $this->_setError('Could not parse headers');
- $this->_headers = new SimpleHttpHeaders($raw);
- } else {
- list($headers, $this->_content) = split("\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->_method;
- }
-
- /**
- * 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->_request_data;
- }
-
- /**
- * 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
- */
- 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
- */
- function _isLastPacket($packet) {
- if (is_string($packet)) {
- return $packet === '';
- }
- return ! $packet;
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: http.php,v 1.98 2005/02/02 23:25:23 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/socket.php'); + 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 { + protected $_host; + protected $_name; + protected $_value; + protected $_path; + protected $_expiry; + protected $_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 SimpleCookie($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 + */ + 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 + */ + function _fixPath($path) { + if (substr($path, 0, 1) != '/') { + $path = '/' . $path; + } + if (substr($path, -1, 1) != '/') { + $path .= '/'; + } + return $path; + } + } + + /** + * Creates HTTP headers for the end point of + * a HTTP request. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleRoute { + protected $_url; + + /** + * Sets the target URL. + * @param SimpleUrl $url URL as object. + * @access public + */ + function SimpleRoute($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 + */ + 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 + */ + 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 + */ + function _createSocket($scheme, $host, $port, $timeout) { + if (in_array($scheme, array('https'))) { + return new SimpleSecureSocket($host, $port, $timeout); + } + 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 { + protected $_proxy; + protected $_username; + protected $_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 SimpleProxyRoute($url, $proxy, $username = false, $password = false) { + $this->SimpleRoute($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()) { + $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 { + protected $_route; + protected $_method; + protected $_encoding; + protected $_headers; + protected $_cookies; + + /** + * Saves the URL ready for fetching. + * @param SimpleRoute $route Request route. + * @param string $method HTTP request method, + * usually GET. + * @param SimpleFormEncoding $encoding Content to send with + * request or false. + * @access public + */ + function SimpleHttpRequest($route, $method, $encoding = false) { + $this->_route = $route; + $this->_method = $method; + $this->_encoding = $encoding; + $this->_headers = array(); + $this->_cookies = array(); + } + + /** + * Fetches the content and parses the headers. + * @param integer $timeout Connection timeout. + * @return SimpleHttpResponse A response which may only have + * an error. + * @access public + */ + function fetch($timeout) { + $socket = $this->_route->createConnection($this->_method, $timeout); + if ($socket->isError()) { + return $this->_createResponse($socket); + } + $this->_dispatchRequest($socket, $this->_method, $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 + */ + function _dispatchRequest($socket, $method, $encoding) { + if ($encoding || ($method == 'POST')) { + $socket->write("Content-Length: " . $this->_getContentLength($encoding) . "\r\n"); + $socket->write("Content-Type: application/x-www-form-urlencoded\r\n"); + } + foreach ($this->_headers as $header_line) { + $socket->write($header_line . "\r\n"); + } + if (count($this->_cookies) > 0) { + $socket->write("Cookie: " . $this->_marshallCookies($this->_cookies) . "\r\n"); + } + $socket->write("\r\n"); + if ($encoding) { + $socket->write($encoding->asString()); + } + } + + /** + * Calculates the length of the encoded content. + * @param SimpleFormEncoding $encoding Content to send with + * request or false. + */ + function _getContentLength($encoding) { + if (! $encoding) { + return 0; + } + return (integer)strlen($encoding->asString()); + } + + /** + * Adds a header line to the request. + * @param string $header_line Text of header line. + * @access public + */ + function addHeaderLine($header_line) { + $this->_headers[] = $header_line; + } + + /** + * Adds a cookie to the request. + * @param SimpleCookie $cookie Additional cookie. + * @access public + */ + function setCookie($cookie) { + $this->_cookies[] = $cookie; + } + + /** + * Serialises the cookie hash ready for + * transmission. + * @param hash $cookies Parsed cookies. + * @return array Cookies in header form. + * @access private + */ + function _marshallCookies($cookies) { + $cookie_pairs = array(); + foreach ($cookies as $cookie) { + $cookie_pairs[] = $cookie->getName() . "=" . $cookie->getValue(); + } + return implode(";", $cookie_pairs); + } + + /** + * Wraps the socket in a response parser. + * @param SimpleSocket $socket Responding socket. + * @return SimpleHttpResponse Parsed response object. + * @access protected + */ + function _createResponse($socket) { + return new SimpleHttpResponse( + $socket, + $this->_method, + $this->_route->getUrl(), + $this->_encoding); + } + } + + /** + * Collection of header lines in the response. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleHttpHeaders { + protected $_raw_headers; + protected $_response_code; + protected $_http_version; + protected $_mime_type; + protected $_location; + protected $_cookies; + protected $_authentication; + protected $_realm; + + /** + * Parses the incoming header block. + * @param string $headers Header block. + * @access public + */ + function SimpleHttpHeaders($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 (split("\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; + } + + /** + * Accessor for any new cookies. + * @return array List of new cookies. + * @access public + */ + function getNewCookies() { + return $this->_cookies; + } + + /** + * Called on each header line to accumulate the held + * data within the class. + * @param string $header_line One line of header. + * @access protected + */ + function _parseHeaderLine($header_line) { + if (preg_match('/HTTP\/(\d+\.\d+)\s+(.*?)\s/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 + */ + function _parseCookie($cookie_line) { + $parts = split(";", $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 { + protected $_method; + protected $_url; + protected $_request_data; + protected $_sent; + protected $_content; + protected $_headers; + + /** + * Constructor. Reads and parses the incoming + * content and headers. + * @param SimpleSocket $socket Network connection to fetch + * response text from. + * @param string $method HTTP request method. + * @param SimpleUrl $url Resource name. + * @param mixed $request_data Record of content sent. + * @access public + */ + function SimpleHttpResponse($socket, $method, $url, $request_data = '') { + $this->SimpleStickyError(); + $this->_method = $method; + $this->_url = $url; + $this->_request_data = $request_data; + $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 + */ + function _parse($raw) { + if (! $raw) { + $this->_setError('Nothing fetched'); + $this->_headers = new SimpleHttpHeaders(''); + } elseif (! strstr($raw, "\r\n\r\n")) { + $this->_setError('Could not parse headers'); + $this->_headers = new SimpleHttpHeaders($raw); + } else { + list($headers, $this->_content) = split("\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->_method; + } + + /** + * 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->_request_data; + } + + /** + * 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 + */ + 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 + */ + function _isLastPacket($packet) { + if (is_string($packet)) { + return $packet === ''; + } + return ! $packet; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/mock_objects.php b/tests/test_tools/simpletest/mock_objects.php index 6d7db4ce..d39eb84e 100644 --- a/tests/UnitTests/simpletest/mock_objects.php +++ b/tests/test_tools/simpletest/mock_objects.php @@ -1,1323 +1,1323 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage MockObjects
- * @version $Id: mock_objects.php,v 1.61 2005/02/13 01:09:25 lastcraft Exp $
- */
-
- /**#@+
- * include SimpleTest files
- */
- require_once(dirname(__FILE__) . '/expectation.php');
- require_once(dirname(__FILE__) . '/options.php');
- require_once(dirname(__FILE__) . '/dumper.php');
- /**#@-*/
-
- /**
- * Default character simpletest will substitute for any value
- */
- define('MOCK_WILDCARD', '*');
-
- /**
- * A wildcard expectation always matches.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class WildcardExpectation extends SimpleExpectation {
-
- /**
- * Chains constructor only.
- * @access public
- */
- function WildcardExpectation() {
- $this->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 'Wildcard always matches [' . $dumper->describeValue($compare) . ']';
- }
- }
-
- /**
- * Parameter comparison assertion.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class ParametersExpectation extends SimpleExpectation {
- protected $_expected;
-
- /**
- * Sets the expected parameter list.
- * @param array $parameters Array of parameters including
- * those that are wildcarded.
- * If the value is not an array
- * then it is considered to match any.
- * @param mixed $wildcard Any parameter matching this
- * will always match.
- * @param string $message Customised message on failure.
- * @access public
- */
- function ParametersExpectation($expected = false, $message = '%s') {
- $this->SimpleExpectation($message);
- $this->_expected = $expected;
- }
-
- /**
- * Tests the assertion. True if correct.
- * @param array $parameters Comparison values.
- * @return boolean True if correct.
- * @access public
- */
- function test($parameters) {
- if (! is_array($this->_expected)) {
- return true;
- }
- if (count($this->_expected) != count($parameters)) {
- return false;
- }
- for ($i = 0; $i < count($this->_expected); $i++) {
- if (! $this->_testParameter($parameters[$i], $this->_expected[$i])) {
- return false;
- }
- }
- return true;
- }
-
- /**
- * Tests an individual parameter.
- * @param mixed $parameter Value to test.
- * @param mixed $expected Comparison value.
- * @return boolean True if expectation
- * fulfilled.
- * @access private
- */
- function _testParameter($parameter, $expected) {
- $comparison = $this->_coerceToExpectation($expected);
- return $comparison->test($parameter);
- }
-
- /**
- * Returns a human readable test message.
- * @param array $comparison Incoming parameter list.
- * @return string Description of success
- * or failure.
- * @access public
- */
- function testMessage($parameters) {
- if ($this->test($parameters)) {
- return "Expectation of " . count($this->_expected) .
- " arguments of [" . $this->_renderArguments($this->_expected) .
- "] is correct";
- } else {
- return $this->_describeDifference($this->_expected, $parameters);
- }
- }
-
- /**
- * Message to display if expectation differs from
- * the parameters actually received.
- * @param array $expected Expected parameters as list.
- * @param array $parameters Actual parameters received.
- * @return string Description of difference.
- * @access private
- */
- function _describeDifference($expected, $parameters) {
- if (count($expected) != count($parameters)) {
- return "Expected " . count($expected) .
- " arguments of [" . $this->_renderArguments($expected) .
- "] but got " . count($parameters) .
- " arguments of [" . $this->_renderArguments($parameters) . "]";
- }
- $messages = array();
- for ($i = 0; $i < count($expected); $i++) {
- $comparison = $this->_coerceToExpectation($expected[$i]);
- if (! $comparison->test($parameters[$i])) {
- $messages[] = "parameter " . ($i + 1) . " with [" .
- $comparison->overlayMessage($parameters[$i]) . "]";
- }
- }
- return "Parameter expectation differs at " . implode(" and ", $messages);
- }
-
- /**
- * Creates an identical expectation if the
- * object/value is not already some type
- * of expectation.
- * @param mixed $expected Expected value.
- * @return SimpleExpectation Expectation object.
- * @access private
- */
- function _coerceToExpectation($expected) {
- if (SimpleTestCompatibility::isA($expected, 'SimpleExpectation')) {
- return $expected;
- }
- return new IdenticalExpectation($expected);
- }
-
- /**
- * Renders the argument list as a string for
- * messages.
- * @param array $args Incoming arguments.
- * @return string Simple description of type and value.
- * @access private
- */
- function _renderArguments($args) {
- $descriptions = array();
- if (is_array($args)) {
- foreach ($args as $arg) {
- $dumper = new SimpleDumper();
- $descriptions[] = $dumper->describeValue($arg);
- }
- }
- return implode(', ', $descriptions);
- }
- }
-
- /**
- * Confirms that the number of calls on a method is as expected.
- */
- class CallCountExpectation extends SimpleExpectation {
- protected $_method;
- protected $_count;
-
- /**
- * Stashes the method and expected count for later
- * reporting.
- * @param string $method Name of method to confirm against.
- * @param integer $count Expected number of calls.
- * @param string $message Custom error message.
- */
- function CallCountExpectation($method, $count, $message = '%s') {
- $this->_method = $method;
- $this->_count = $count;
- $this->SimpleExpectation($message);
- }
-
- /**
- * Tests the assertion. True if correct.
- * @param integer $compare Measured call count.
- * @return boolean True if expected.
- * @access public
- */
- function test($compare) {
- return ($this->_count == $compare);
- }
-
- /**
- * Reports the comparison.
- * @param integer $compare Measured call count.
- * @return string Message to show.
- * @access public
- */
- function testMessage($compare) {
- return 'Expected call count for [' . $this->_method .
- '] was [' . $this->_count .
- '] got [' . $compare . ']';
- }
- }
-
- /**
- * Confirms that the number of calls on a method is as expected.
- */
- class MinimumCallCountExpectation extends SimpleExpectation {
- protected $_method;
- protected $_count;
-
- /**
- * Stashes the method and expected count for later
- * reporting.
- * @param string $method Name of method to confirm against.
- * @param integer $count Minimum number of calls.
- * @param string $message Custom error message.
- */
- function MinimumCallCountExpectation($method, $count, $message = '%s') {
- $this->_method = $method;
- $this->_count = $count;
- $this->SimpleExpectation($message);
- }
-
- /**
- * Tests the assertion. True if correct.
- * @param integer $compare Measured call count.
- * @return boolean True if enough.
- * @access public
- */
- function test($compare) {
- return ($this->_count <= $compare);
- }
-
- /**
- * Reports the comparison.
- * @param integer $compare Measured call count.
- * @return string Message to show.
- * @access public
- */
- function testMessage($compare) {
- return 'Minimum call count for [' . $this->_method .
- '] was [' . $this->_count .
- '] got [' . $compare . ']';
- }
- }
-
- /**
- * Confirms that the number of calls on a method is as expected.
- */
- class MaximumCallCountExpectation extends SimpleExpectation {
- protected $_method;
- protected $_count;
-
- /**
- * Stashes the method and expected count for later
- * reporting.
- * @param string $method Name of method to confirm against.
- * @param integer $count Minimum number of calls.
- * @param string $message Custom error message.
- */
- function MaximumCallCountExpectation($method, $count, $message = '%s') {
- $this->_method = $method;
- $this->_count = $count;
- $this->SimpleExpectation($message);
- }
-
- /**
- * Tests the assertion. True if correct.
- * @param integer $compare Measured call count.
- * @return boolean True if not over.
- * @access public
- */
- function test($compare) {
- return ($this->_count >= $compare);
- }
-
- /**
- * Reports the comparison.
- * @param integer $compare Measured call count.
- * @return string Message to show.
- * @access public
- */
- function testMessage($compare) {
- return 'Maximum call count for [' . $this->_method .
- '] was [' . $this->_count .
- '] got [' . $compare . ']';
- }
- }
-
- /**
- * Retrieves values and references by searching the
- * parameter lists until a match is found.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class CallMap {
- protected $_map;
-
- /**
- * Creates an empty call map.
- * @access public
- */
- function CallMap() {
- $this->_map = array();
- }
-
- /**
- * Stashes a value against a method call.
- * @param array $parameters Arguments including wildcards.
- * @param mixed $value Value copied into the map.
- * @access public
- */
- function addValue($parameters, $value) {
- $this->addReference($parameters, $value);
- }
-
- /**
- * Stashes a reference against a method call.
- * @param array $parameters Array of arguments (including wildcards).
- * @param mixed $reference Array reference placed in the map.
- * @access public
- */
- function addReference($parameters, $reference) {
- $place = count($this->_map);
- $this->_map[$place] = array();
- $this->_map[$place]["params"] = new ParametersExpectation($parameters);
- $this->_map[$place]["content"] = $reference;
- }
-
- /**
- * Searches the call list for a matching parameter
- * set. Returned by reference.
- * @param array $parameters Parameters to search by
- * without wildcards.
- * @return object Object held in the first matching
- * slot, otherwise null.
- * @access public
- */
- function findFirstMatch($parameters) {
- $slot = $this->_findFirstSlot($parameters);
- if (!isset($slot)) {
- return null;
- }
- return $slot["content"];
- }
-
- /**
- * Searches the call list for a matching parameter
- * set. True if successful.
- * @param array $parameters Parameters to search by
- * without wildcards.
- * @return boolean True if a match is present.
- * @access public
- */
- function isMatch($parameters) {
- return ($this->_findFirstSlot($parameters) != null);
- }
-
- /**
- * Searches the map for a matching item.
- * @param array $parameters Parameters to search by
- * without wildcards.
- * @return array Reference to slot or null.
- * @access private
- */
- function _findFirstSlot($parameters) {
- $count = count($this->_map);
- for ($i = 0; $i < $count; $i++) {
- if ($this->_map[$i]["params"]->test($parameters)) {
- return $this->_map[$i];
- }
- }
- return null;
- }
- }
-
- /**
- * An empty collection of methods that can have their
- * return values set. Used for prototyping.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class SimpleStub {
- protected $_wildcard;
- protected $_is_strict;
- protected $_returns;
- protected $_return_sequence;
- protected $_call_counts;
-
- /**
- * Sets up the wildcard and everything else empty.
- * @param mixed $wildcard Parameter matching wildcard.
- * @param boolean $is_strict Enables method name checks.
- * @access public
- */
- function SimpleStub($wildcard, $is_strict = true) {
- $this->_wildcard = $wildcard;
- $this->_is_strict = $is_strict;
- $this->_returns = array();
- $this->_return_sequence = array();
- $this->_call_counts = array();
- }
-
- /**
- * Replaces wildcard matches with wildcard
- * expectations in the argument list.
- * @param array $args Raw argument list.
- * @return array Argument list with
- * expectations.
- * @access private
- */
- function _replaceWildcards($args) {
- if ($args === false) {
- return false;
- }
- for ($i = 0; $i < count($args); $i++) {
- if ($args[$i] === $this->_wildcard) {
- $args[$i] = new WildcardExpectation();
- }
- }
- return $args;
- }
-
- /**
- * Returns the expected value for the method name.
- * @param string $method Name of method to simulate.
- * @param array $args Arguments as an array.
- * @return mixed Stored return.
- * @access private
- */
- function _invoke($method, $args) {
- $method = strtolower($method);
- $step = $this->getCallCount($method);
- $this->_addCall($method, $args);
- return $this->_getReturn($method, $args, $step);
- }
-
- /**
- * Triggers a PHP error if the method is not part
- * of this object.
- * @param string $method Name of method.
- * @param string $task Description of task attempt.
- * @access protected
- */
- function _dieOnNoMethod($method, $task) {
- if ($this->_is_strict && !method_exists($this, $method)) {
- trigger_error(
- "Cannot $task as no ${method}() in class " . get_class($this),
- E_USER_ERROR);
- }
- }
-
- /**
- * Adds one to the call count of a method.
- * @param string $method Method called.
- * @param array $args Arguments as an array.
- * @access protected
- */
- function _addCall($method, $args) {
- if (!isset($this->_call_counts[$method])) {
- $this->_call_counts[$method] = 0;
- }
- $this->_call_counts[$method]++;
- }
-
- /**
- * Fetches the call count of a method so far.
- * @param string $method Method name called.
- * @return Number of calls so far.
- * @access public
- */
- function getCallCount($method) {
- $this->_dieOnNoMethod($method, "get call count");
- $method = strtolower($method);
- if (! isset($this->_call_counts[$method])) {
- return 0;
- }
- return $this->_call_counts[$method];
- }
-
- /**
- * Sets a return for a parameter list that will
- * be passed by value for all calls to this method.
- * @param string $method Method name.
- * @param mixed $value Result of call passed by value.
- * @param array $args List of parameters to match
- * including wildcards.
- * @access public
- */
- function setReturnValue($method, $value, $args = false) {
- $this->_dieOnNoMethod($method, "set return value");
- $args = $this->_replaceWildcards($args);
- $method = strtolower($method);
- if (! isset($this->_returns[$method])) {
- $this->_returns[$method] = new CallMap();
- }
- $this->_returns[$method]->addValue($args, $value);
- }
-
- /**
- * Sets a return for a parameter list that will
- * be passed by value only when the required call count
- * is reached.
- * @param integer $timing Number of calls in the future
- * to which the result applies. If
- * not set then all calls will return
- * the value.
- * @param string $method Method name.
- * @param mixed $value Result of call passed by value.
- * @param array $args List of parameters to match
- * including wildcards.
- * @access public
- */
- function setReturnValueAt($timing, $method, $value, $args = false) {
- $this->_dieOnNoMethod($method, "set return value sequence");
- $args = $this->_replaceWildcards($args);
- $method = strtolower($method);
- if (! isset($this->_return_sequence[$method])) {
- $this->_return_sequence[$method] = array();
- }
- if (! isset($this->_return_sequence[$method][$timing])) {
- $this->_return_sequence[$method][$timing] = new CallMap();
- }
- $this->_return_sequence[$method][$timing]->addValue($args, $value);
- }
-
- /**
- * Sets a return for a parameter list that will
- * be passed by reference for all calls.
- * @param string $method Method name.
- * @param mixed $reference Result of the call will be this object.
- * @param array $args List of parameters to match
- * including wildcards.
- * @access public
- */
- function setReturnReference($method, $reference, $args = false) {
- $this->_dieOnNoMethod($method, "set return reference");
- $args = $this->_replaceWildcards($args);
- $method = strtolower($method);
- if (! isset($this->_returns[$method])) {
- $this->_returns[$method] = new CallMap();
- }
- $this->_returns[$method]->addReference($args, $reference);
- }
-
- /**
- * Sets a return for a parameter list that will
- * be passed by value only when the required call count
- * is reached.
- * @param integer $timing Number of calls in the future
- * to which the result applies. If
- * not set then all calls will return
- * the value.
- * @param string $method Method name.
- * @param mixed $reference Result of the call will be this object.
- * @param array $args List of parameters to match
- * including wildcards.
- * @access public
- */
- function setReturnReferenceAt($timing, $method, $reference, $args = false) {
- $this->_dieOnNoMethod($method, "set return reference sequence");
- $args = $this->_replaceWildcards($args);
- $method = strtolower($method);
- if (! isset($this->_return_sequence[$method])) {
- $this->_return_sequence[$method] = array();
- }
- if (! isset($this->_return_sequence[$method][$timing])) {
- $this->_return_sequence[$method][$timing] = new CallMap();
- }
- $this->_return_sequence[$method][$timing]->addReference($args, $reference);
- }
-
- /**
- * Finds the return value matching the incoming
- * arguments. If there is no matching value found
- * then an error is triggered.
- * @param string $method Method name.
- * @param array $args Calling arguments.
- * @param integer $step Current position in the
- * call history.
- * @return mixed Stored return.
- * @access protected
- */
- function _getReturn($method, $args, $step) {
- if (isset($this->_return_sequence[$method][$step])) {
- if ($this->_return_sequence[$method][$step]->isMatch($args)) {
- return $this->_return_sequence[$method][$step]->findFirstMatch($args);
- }
- }
- if (isset($this->_returns[$method])) {
- return $this->_returns[$method]->findFirstMatch($args);
- }
- return null;
- }
- }
-
- /**
- * An empty collection of methods that can have their
- * return values set and expectations made of the
- * calls upon them. The mock will assert the
- * expectations against it's attached test case in
- * addition to the server stub behaviour.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class SimpleMock extends SimpleStub {
- protected $_test;
- protected $_expected_counts;
- protected $_max_counts;
- protected $_expected_args;
- protected $_expected_args_at;
-
- /**
- * Creates an empty return list and expectation list.
- * All call counts are set to zero.
- * @param SimpleTestCase $test Test case to test expectations in.
- * @param mixed $wildcard Parameter matching wildcard.
- * @param boolean $is_strict Enables method name checks on
- * expectations.
- * @access public
- */
- function SimpleMock($test, $wildcard, $is_strict = true) {
- $this->SimpleStub($wildcard, $is_strict);
- if (! $test) {
- trigger_error('No unit tester for mock object', E_USER_ERROR);
- return;
- }
- $this->_test = SimpleMock::registerTest($test);
- $this->_expected_counts = array();
- $this->_max_counts = array();
- $this->_expected_args = array();
- $this->_expected_args_at = array();
- }
-
- /**
- * Accessor for attached unit test so that when
- * subclassed, new expectations can be added easily.
- * @return SimpleTestCase Unit test passed in constructor.
- * @access public
- */
- function getTest() {
- return $this->_test;
- }
-
- /**
- * Die if bad arguments array is passed
- * @param mixed $args The arguments value to be checked.
- * @param string $task Description of task attempt.
- * @return boolean Valid arguments
- * @access private
- */
- function _checkArgumentsIsArray($args, $task) {
- if (! is_array($args)) {
- trigger_error(
- "Cannot $task as \$args parameter is not an array",
- E_USER_ERROR);
- }
- }
-
- /**
- * Sets up an expected call with a set of
- * expected parameters in that call. All
- * calls will be compared to these expectations
- * regardless of when the call is made.
- * @param string $method Method call to test.
- * @param array $args Expected parameters for the call
- * including wildcards.
- * @param string $message Overridden message.
- * @access public
- */
- function expectArguments($method, $args, $message = '%s') {
- $this->_dieOnNoMethod($method, 'set expected arguments');
- $this->_checkArgumentsIsArray($args, 'set expected arguments');
- $args = $this->_replaceWildcards($args);
- $message .= Mock::getExpectationLine(' at line [%d]');
- $this->_expected_args[strtolower($method)] =
- new ParametersExpectation($args, $message);
- }
-
- /**
- * Sets up an expected call with a set of
- * expected parameters in that call. The
- * expected call count will be adjusted if it
- * is set too low to reach this call.
- * @param integer $timing Number of calls in the future at
- * which to test. Next call is 0.
- * @param string $method Method call to test.
- * @param array $args Expected parameters for the call
- * including wildcards.
- * @param string $message Overridden message.
- * @access public
- */
- function expectArgumentsAt($timing, $method, $args, $message = '%s') {
- $this->_dieOnNoMethod($method, 'set expected arguments at time');
- $this->_checkArgumentsIsArray($args, 'set expected arguments at time');
- $args = $this->_replaceWildcards($args);
- if (! isset($this->_expected_args_at[$timing])) {
- $this->_expected_args_at[$timing] = array();
- }
- $method = strtolower($method);
- $message .= Mock::getExpectationLine(' at line [%d]');
- $this->_expected_args_at[$timing][$method] =
- new ParametersExpectation($args, $message);
- }
-
- /**
- * Sets an expectation for the number of times
- * a method will be called. The tally method
- * is used to check this.
- * @param string $method Method call to test.
- * @param integer $count Number of times it should
- * have been called at tally.
- * @param string $message Overridden message.
- * @access public
- */
- function expectCallCount($method, $count, $message = '%s') {
- $this->_dieOnNoMethod($method, 'set expected call count');
- $message .= Mock::getExpectationLine(' at line [%d]');
- $this->_expected_counts[strtolower($method)] =
- new CallCountExpectation($method, $count, $message);
- }
-
- /**
- * Sets the number of times a method may be called
- * before a test failure is triggered.
- * @param string $method Method call to test.
- * @param integer $count Most number of times it should
- * have been called.
- * @param string $message Overridden message.
- * @access public
- */
- function expectMaximumCallCount($method, $count, $message = '%s') {
- $this->_dieOnNoMethod($method, 'set maximum call count');
- $message .= Mock::getExpectationLine(' at line [%d]');
- $this->_max_counts[strtolower($method)] =
- new MaximumCallCountExpectation($method, $count, $message);
- }
-
- /**
- * Sets the number of times to call a method to prevent
- * a failure on the tally.
- * @param string $method Method call to test.
- * @param integer $count Least number of times it should
- * have been called.
- * @param string $message Overridden message.
- * @access public
- */
- function expectMinimumCallCount($method, $count, $message = '%s') {
- $this->_dieOnNoMethod($method, 'set minimum call count');
- $message .= Mock::getExpectationLine(' at line [%d]');
- $this->_expected_counts[strtolower($method)] =
- new MinimumCallCountExpectation($method, $count, $message);
- }
-
- /**
- * Convenience method for barring a method
- * call.
- * @param string $method Method call to ban.
- * @param string $message Overridden message.
- * @access public
- */
- function expectNever($method, $message = '%s') {
- $this->expectMaximumCallCount($method, 0, $message);
- }
-
- /**
- * Convenience method for a single method
- * call.
- * @param string $method Method call to track.
- * @param array $args Expected argument list or
- * false for any arguments.
- * @param string $message Overridden message.
- * @access public
- */
- function expectOnce($method, $args = false, $message = '%s') {
- $this->expectCallCount($method, 1, $message);
- if ($args !== false) {
- $this->expectArguments($method, $args, $message);
- }
- }
-
- /**
- * Convenience method for requiring a method
- * call.
- * @param string $method Method call to track.
- * @param array $args Expected argument list or
- * false for any arguments.
- * @param string $message Overridden message.
- * @access public
- */
- function expectAtLeastOnce($method, $args = false, $message = '%s') {
- $this->expectMinimumCallCount($method, 1, $message);
- if ($args !== false) {
- $this->expectArguments($method, $args, $message);
- }
- }
-
- /**
- * Totals up the call counts and triggers a test
- * assertion if a test is present for expected
- * call counts.
- * This method must be called explicitly for the call
- * count assertions to be triggered.
- * @access public
- */
- function tally() {
- foreach ($this->_expected_counts as $method => $expectation) {
- $this->_assertTrue(
- $expectation->test($this->getCallCount($method)),
- $expectation->overlayMessage($this->getCallCount($method)));
- }
- foreach ($this->_max_counts as $method => $expectation) {
- if ($expectation->test($this->getCallCount($method))) {
- $this->_assertTrue(
- true,
- $expectation->overlayMessage($this->getCallCount($method)));
- }
- }
- }
-
- /**
- * Returns the expected value for the method name
- * and checks expectations. Will generate any
- * test assertions as a result of expectations
- * if there is a test present.
- * @param string $method Name of method to simulate.
- * @param array $args Arguments as an array.
- * @return mixed Stored return.
- * @access private
- */
- function _invoke($method, $args) {
- $method = strtolower($method);
- $step = $this->getCallCount($method);
- $this->_addCall($method, $args);
- $this->_checkExpectations($method, $args, $step);
- return $this->_getReturn($method, $args, $step);
- }
-
- /**
- * Tests the arguments against expectations.
- * @param string $method Method to check.
- * @param array $args Argument list to match.
- * @param integer $timing The position of this call
- * in the call history.
- * @access private
- */
- function _checkExpectations($method, $args, $timing) {
- if (isset($this->_max_counts[$method])) {
- if (! $this->_max_counts[$method]->test($timing + 1)) {
- $this->_assertTrue(
- false,
- $this->_max_counts[$method]->overlayMessage($timing + 1));
- }
- }
- if (isset($this->_expected_args_at[$timing][$method])) {
- $this->_assertTrue(
- $this->_expected_args_at[$timing][$method]->test($args),
- "Mock method [$method] at [$timing] -> " .
- $this->_expected_args_at[$timing][$method]->overlayMessage($args));
- } elseif (isset($this->_expected_args[$method])) {
- $this->_assertTrue(
- $this->_expected_args[$method]->test($args),
- "Mock method [$method] -> " . $this->_expected_args[$method]->overlayMessage($args));
- }
- }
-
- /**
- * Triggers an assertion on the held test case.
- * Should be overridden when using another test
- * framework other than the SimpleTest one if the
- * assertion method has a different name.
- * @param boolean $assertion True will pass.
- * @param string $message Message that will go with
- * the test event.
- * @access protected
- */
- function _assertTrue($assertion, $message) {
- $test =SimpleMock::injectTest($this->_test);
- $test->assertTrue($assertion, $message);
- }
-
- /**
- * Stashes the test case for later recovery.
- * @param SimpleTestCase $test Test case.
- * @return string Key to find it again.
- * @access public
- * @static
- */
- function registerTest($test) {
- $registry =SimpleMock::_getRegistry();
- $registry[$class = get_class($test)] = $test;
- return $class;
- }
-
- /**
- * Resolves the dependency on the test case.
- * @param string $class Key to look up test case in.
- * @return SimpleTestCase Test case to send results to.
- * @access public
- * @static
- */
- function injectTest($key) {
- $registry =SimpleMock::_getRegistry();
- return $registry[$key];
- }
-
- /**
- * Registry for test cases. The reason for this is
- * to break the reference between the test cases and
- * the mocks. It was leading to a fatal error due to
- * recursive dependencies during comparisons. See
- * http://bugs.php.net/bug.php?id=31449 for the PHP
- * bug.
- * @return array List of references.
- * @access private
- * @static
- */
- function _getRegistry() {
- static $registry;
- if (! isset($registry)) {
- $registry = array();
- }
- return $registry;
- }
- }
-
- /**
- * Static methods only service class for code generation of
- * server stubs.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class Stub {
-
- /**
- * Factory for server stub classes.
- */
- function Stub() {
- trigger_error('Stub factory methods are class only.');
- }
-
- /**
- * Clones a class' interface and creates a stub version
- * that can have return values set.
- * @param string $class Class to clone.
- * @param string $stub_class New class name. Default is
- * the old name with "Stub"
- * prepended.
- * @param array $methods Additional methods to add beyond
- * those in the cloned class. Use this
- * to emulate the dynamic addition of
- * methods in the cloned class or when
- * the class hasn't been written yet.
- * @static
- * @access public
- */
- function generate($class, $stub_class = false, $methods = false) {
- if (! SimpleTestCompatibility::classExists($class)) {
- return false;
- }
- if (! $stub_class) {
- $stub_class = "Stub" . $class;
- }
- if (SimpleTestCompatibility::classExists($stub_class)) {
- return false;
- }
- return eval(Stub::_createClassCode(
- $class,
- $stub_class,
- $methods ? $methods : array()) . " return true;");
- }
-
- /**
- * The new server stub class code in string form.
- * @param string $class Class to clone.
- * @param string $mock_class New class name.
- * @param array $methods Additional methods.
- * @static
- * @access private
- */
- function _createClassCode($class, $stub_class, $methods) {
- $stub_base = SimpleTestOptions::getStubBaseClass();
- $code = "class $stub_class extends $stub_base {\n";
- $code .= " function $stub_class(\$wildcard = MOCK_WILDCARD) {\n";
- $code .= " \$this->$stub_base(\$wildcard);\n";
- $code .= " }\n";
- $code .= Stub::_createHandlerCode($class, $stub_base, $methods);
- $code .= "}\n";
- return $code;
- }
-
- /**
- * Creates code within a class to generate replaced
- * methods. All methods call the _invoke() handler
- * with the method name and the arguments in an
- * array.
- * @param string $class Class to clone.
- * @param string $base Base mock/stub class with methods that
- * cannot be cloned. Otherwise you
- * would be stubbing the accessors used
- * to set the stubs.
- * @param array $methods Additional methods.
- * @static
- * @access private
- */
- function _createHandlerCode($class, $base, $methods) {
- $code = "";
- $methods = array_merge($methods, get_class_methods($class));
- foreach ($methods as $method) {
- if (Stub::_isSpecialMethod($method)) {
- continue;
- }
- if (in_array($method, get_class_methods($base))) {
- continue;
- }
- $code .= " function $method() {\n";
- $code .= " \$args = func_get_args();\n";
- $code .= " return \$this->_invoke(\"$method\", \$args);\n";
- $code .= " }\n";
- }
- return $code;
- }
-
- /**
- * Tests to see if a special PHP method is about to
- * be stubbed by mistake.
- * @param string $method Method name.
- * @return boolean True if special.
- * @access private
- * @static
- */
- function _isSpecialMethod($method) {
- return in_array(
- strtolower($method),
- array('__construct', '__clone', '__get', '__set', '__call'));
- }
- }
-
- /**
- * Static methods only service class for code generation of
- * mock objects.
- * @package SimpleTest
- * @subpackage MockObjects
- */
- class Mock {
-
- /**
- * Factory for mock object classes.
- * @access public
- */
- function Mock() {
- trigger_error("Mock factory methods are class only.");
- }
-
- /**
- * Clones a class' interface and creates a mock version
- * that can have return values and expectations set.
- * @param string $class Class to clone.
- * @param string $mock_class New class name. Default is
- * the old name with "Mock"
- * prepended.
- * @param array $methods Additional methods to add beyond
- * those in th cloned class. Use this
- * to emulate the dynamic addition of
- * methods in the cloned class or when
- * the class hasn't been written yet.
- * @static
- * @access public
- */
- function generate($class, $mock_class = false, $methods = false) {
- if (! SimpleTestCompatibility::classExists($class)) {
- return false;
- }
- if (! $mock_class) {
- $mock_class = "Mock" . $class;
- }
- if (SimpleTestCompatibility::classExists($mock_class)) {
- return false;
- }
- return eval(Mock::_createClassCode(
- $class,
- $mock_class,
- $methods ? $methods : array()) . " return true;");
- }
-
- /**
- * Generates a version of a class with selected
- * methods mocked only. Inherits the old class
- * and chains the mock methods of an aggregated
- * mock object.
- * @param string $class Class to clone.
- * @param string $mock_class New class name.
- * @param array $methods Methods to be overridden
- * with mock versions.
- * @static
- * @access public
- */
- function generatePartial($class, $mock_class, $methods) {
- if (! SimpleTestCompatibility::classExists($class)) {
- return false;
- }
- if (SimpleTestCompatibility::classExists($mock_class)) {
- trigger_error("Partial mock class [$mock_class] already exists");
- return false;
- }
- return eval(Mock::_extendClassCode($class, $mock_class, $methods));
- }
-
- /**
- * The new mock class code as a string.
- * @param string $class Class to clone.
- * @param string $mock_class New class name.
- * @param array $methods Additional methods.
- * @return string Code for new mock class.
- * @static
- * @access private
- */
- function _createClassCode($class, $mock_class, $methods) {
- $mock_base = SimpleTestOptions::getMockBaseClass();
- $code = "class $mock_class extends $mock_base {\n";
- $code .= " function $mock_class(&\$test, \$wildcard = MOCK_WILDCARD) {\n";
- $code .= " \$this->$mock_base(\$test, \$wildcard);\n";
- $code .= " }\n";
- $code .= Stub::_createHandlerCode($class, $mock_base, $methods);
- $code .= "}\n";
- return $code;
- }
-
- /**
- * The extension class code as a string. The class
- * composites a mock object and chains mocked methods
- * to it.
- * @param string $class Class to extend.
- * @param string $mock_class New class name.
- * @param array $methods Mocked methods.
- * @return string Code for a new class.
- * @static
- * @access private
- */
- function _extendClassCode($class, $mock_class, $methods) {
- $mock_base = SimpleTestOptions::getMockBaseClass();
- $code = "class $mock_class extends $class {\n";
- $code .= " var \$_mock;\n";
- $code .= Mock::_addMethodList($methods);
- $code .= "\n";
- $code .= " function $mock_class(&\$test, \$wildcard = MOCK_WILDCARD) {\n";
- $code .= " \$this->_mock = new $mock_base(\$test, \$wildcard, false);\n";
- $code .= " }\n";
- $code .= Mock::_chainMockReturns();
- $code .= Mock::_chainMockExpectations();
- $code .= Mock::_overrideMethods($methods);
- $code .= SimpleTestOptions::getPartialMockCode();
- $code .= "}\n";
- return $code;
- }
-
- /**
- * Creates a list of mocked methods for error checking.
- * @param array $methods Mocked methods.
- * @return string Code for a method list.
- * @access private
- */
- function _addMethodList($methods) {
- return " var \$_mocked_methods = array('" . implode("', '", $methods) . "');\n";
- }
-
- /**
- * Creates code to abandon the expectation if not mocked.
- * @param string $alias Parameter name of method name.
- * @return string Code for bail out.
- * @access private
- */
- function _bailOutIfNotMocked($alias) {
- $code = " if (! in_array($alias, \$this->_mocked_methods)) {\n";
- $code .= " trigger_error(\"Method [$alias] is not mocked\");\n";
- $code .= " return;\n";
- $code .= " }\n";
- return $code;
- }
-
- /**
- * Creates source code for chaining to the composited
- * mock object.
- * @return string Code for mock set up.
- * @access private
- */
- function _chainMockReturns() {
- $code = " function setReturnValue(\$method, \$value, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->setReturnValue(\$method, \$value, \$args);\n";
- $code .= " }\n";
- $code .= " function setReturnValueAt(\$timing, \$method, \$value, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->setReturnValueAt(\$timing, \$method, \$value, \$args);\n";
- $code .= " }\n";
- $code .= " function setReturnReference(\$method, &\$ref, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->setReturnReference(\$method, \$ref, \$args);\n";
- $code .= " }\n";
- $code .= " function setReturnReferenceAt(\$timing, \$method, &\$ref, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->setReturnReferenceAt(\$timing, \$method, \$ref, \$args);\n";
- $code .= " }\n";
- return $code;
- }
-
- /**
- * Creates source code for chaining to an aggregated
- * mock object.
- * @return string Code for expectations.
- * @access private
- */
- function _chainMockExpectations() {
- $code = " function expectArguments(\$method, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectArguments(\$method, \$args);\n";
- $code .= " }\n";
- $code .= " function expectArgumentsAt(\$timing, \$method, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectArgumentsAt(\$timing, \$method, \$args);\n";
- $code .= " }\n";
- $code .= " function expectCallCount(\$method, \$count) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectCallCount(\$method, \$count);\n";
- $code .= " }\n";
- $code .= " function expectMaximumCallCount(\$method, \$count) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectMaximumCallCount(\$method, \$count);\n";
- $code .= " }\n";
- $code .= " function expectMinimumCallCount(\$method, \$count) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectMinimumCallCount(\$method, \$count);\n";
- $code .= " }\n";
- $code .= " function expectNever(\$method) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectNever(\$method);\n";
- $code .= " }\n";
- $code .= " function expectOnce(\$method, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectOnce(\$method, \$args);\n";
- $code .= " }\n";
- $code .= " function expectAtLeastOnce(\$method, \$args = false) {\n";
- $code .= Mock::_bailOutIfNotMocked("\$method");
- $code .= " \$this->_mock->expectAtLeastOnce(\$method, \$args);\n";
- $code .= " }\n";
- $code .= " function tally() {\n";
- $code .= " \$this->_mock->tally();\n";
- $code .= " }\n";
- return $code;
- }
-
- /**
- * Creates source code to override a list of methods
- * with mock versions.
- * @param array $methods Methods to be overridden
- * with mock versions.
- * @return string Code for overridden chains.
- * @access private
- */
- function _overrideMethods($methods) {
- $code = "";
- foreach ($methods as $method) {
- $code .= " function $method() {\n";
- $code .= " \$args = func_get_args();\n";
- $code .= " return \$this->_mock->_invoke(\"$method\", \$args);\n";
- $code .= " }\n";
- }
- return $code;
- }
-
- /**
- * Uses a stack trace to find the line of an assertion.
- * @param string $format String formatting.
- * @param array $stack Stack frames top most first. Only
- * needed if not using the PHP
- * backtrace function.
- * @return string Line number of first expect*
- * method embedded in format string.
- * @access public
- * @static
- */
- function getExpectationLine($format = '%d', $stack = false) {
- if ($stack === false) {
- $stack = SimpleTestCompatibility::getStackTrace();
- }
- return SimpleDumper::getFormattedAssertionLine($stack, $format, 'expect');
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage MockObjects + * @version $Id: mock_objects.php,v 1.61 2005/02/13 01:09:25 lastcraft Exp $ + */ + + /**#@+ + * include SimpleTest files + */ + require_once(dirname(__FILE__) . '/expectation.php'); + require_once(dirname(__FILE__) . '/options.php'); + require_once(dirname(__FILE__) . '/dumper.php'); + /**#@-*/ + + /** + * Default character simpletest will substitute for any value + */ + define('MOCK_WILDCARD', '*'); + + /** + * A wildcard expectation always matches. + * @package SimpleTest + * @subpackage MockObjects + */ + class WildcardExpectation extends SimpleExpectation { + + /** + * Chains constructor only. + * @access public + */ + function WildcardExpectation() { + $this->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 'Wildcard always matches [' . $dumper->describeValue($compare) . ']'; + } + } + + /** + * Parameter comparison assertion. + * @package SimpleTest + * @subpackage MockObjects + */ + class ParametersExpectation extends SimpleExpectation { + protected $_expected; + + /** + * Sets the expected parameter list. + * @param array $parameters Array of parameters including + * those that are wildcarded. + * If the value is not an array + * then it is considered to match any. + * @param mixed $wildcard Any parameter matching this + * will always match. + * @param string $message Customised message on failure. + * @access public + */ + function ParametersExpectation($expected = false, $message = '%s') { + $this->SimpleExpectation($message); + $this->_expected = $expected; + } + + /** + * Tests the assertion. True if correct. + * @param array $parameters Comparison values. + * @return boolean True if correct. + * @access public + */ + function test($parameters) { + if (! is_array($this->_expected)) { + return true; + } + if (count($this->_expected) != count($parameters)) { + return false; + } + for ($i = 0; $i < count($this->_expected); $i++) { + if (! $this->_testParameter($parameters[$i], $this->_expected[$i])) { + return false; + } + } + return true; + } + + /** + * Tests an individual parameter. + * @param mixed $parameter Value to test. + * @param mixed $expected Comparison value. + * @return boolean True if expectation + * fulfilled. + * @access private + */ + function _testParameter($parameter, $expected) { + $comparison = $this->_coerceToExpectation($expected); + return $comparison->test($parameter); + } + + /** + * Returns a human readable test message. + * @param array $comparison Incoming parameter list. + * @return string Description of success + * or failure. + * @access public + */ + function testMessage($parameters) { + if ($this->test($parameters)) { + return "Expectation of " . count($this->_expected) . + " arguments of [" . $this->_renderArguments($this->_expected) . + "] is correct"; + } else { + return $this->_describeDifference($this->_expected, $parameters); + } + } + + /** + * Message to display if expectation differs from + * the parameters actually received. + * @param array $expected Expected parameters as list. + * @param array $parameters Actual parameters received. + * @return string Description of difference. + * @access private + */ + function _describeDifference($expected, $parameters) { + if (count($expected) != count($parameters)) { + return "Expected " . count($expected) . + " arguments of [" . $this->_renderArguments($expected) . + "] but got " . count($parameters) . + " arguments of [" . $this->_renderArguments($parameters) . "]"; + } + $messages = array(); + for ($i = 0; $i < count($expected); $i++) { + $comparison = $this->_coerceToExpectation($expected[$i]); + if (! $comparison->test($parameters[$i])) { + $messages[] = "parameter " . ($i + 1) . " with [" . + $comparison->overlayMessage($parameters[$i]) . "]"; + } + } + return "Parameter expectation differs at " . implode(" and ", $messages); + } + + /** + * Creates an identical expectation if the + * object/value is not already some type + * of expectation. + * @param mixed $expected Expected value. + * @return SimpleExpectation Expectation object. + * @access private + */ + function _coerceToExpectation($expected) { + if (SimpleTestCompatibility::isA($expected, 'SimpleExpectation')) { + return $expected; + } + return new IdenticalExpectation($expected); + } + + /** + * Renders the argument list as a string for + * messages. + * @param array $args Incoming arguments. + * @return string Simple description of type and value. + * @access private + */ + function _renderArguments($args) { + $descriptions = array(); + if (is_array($args)) { + foreach ($args as $arg) { + $dumper = new SimpleDumper(); + $descriptions[] = $dumper->describeValue($arg); + } + } + return implode(', ', $descriptions); + } + } + + /** + * Confirms that the number of calls on a method is as expected. + */ + class CallCountExpectation extends SimpleExpectation { + protected $_method; + protected $_count; + + /** + * Stashes the method and expected count for later + * reporting. + * @param string $method Name of method to confirm against. + * @param integer $count Expected number of calls. + * @param string $message Custom error message. + */ + function CallCountExpectation($method, $count, $message = '%s') { + $this->_method = $method; + $this->_count = $count; + $this->SimpleExpectation($message); + } + + /** + * Tests the assertion. True if correct. + * @param integer $compare Measured call count. + * @return boolean True if expected. + * @access public + */ + function test($compare) { + return ($this->_count == $compare); + } + + /** + * Reports the comparison. + * @param integer $compare Measured call count. + * @return string Message to show. + * @access public + */ + function testMessage($compare) { + return 'Expected call count for [' . $this->_method . + '] was [' . $this->_count . + '] got [' . $compare . ']'; + } + } + + /** + * Confirms that the number of calls on a method is as expected. + */ + class MinimumCallCountExpectation extends SimpleExpectation { + protected $_method; + protected $_count; + + /** + * Stashes the method and expected count for later + * reporting. + * @param string $method Name of method to confirm against. + * @param integer $count Minimum number of calls. + * @param string $message Custom error message. + */ + function MinimumCallCountExpectation($method, $count, $message = '%s') { + $this->_method = $method; + $this->_count = $count; + $this->SimpleExpectation($message); + } + + /** + * Tests the assertion. True if correct. + * @param integer $compare Measured call count. + * @return boolean True if enough. + * @access public + */ + function test($compare) { + return ($this->_count <= $compare); + } + + /** + * Reports the comparison. + * @param integer $compare Measured call count. + * @return string Message to show. + * @access public + */ + function testMessage($compare) { + return 'Minimum call count for [' . $this->_method . + '] was [' . $this->_count . + '] got [' . $compare . ']'; + } + } + + /** + * Confirms that the number of calls on a method is as expected. + */ + class MaximumCallCountExpectation extends SimpleExpectation { + protected $_method; + protected $_count; + + /** + * Stashes the method and expected count for later + * reporting. + * @param string $method Name of method to confirm against. + * @param integer $count Minimum number of calls. + * @param string $message Custom error message. + */ + function MaximumCallCountExpectation($method, $count, $message = '%s') { + $this->_method = $method; + $this->_count = $count; + $this->SimpleExpectation($message); + } + + /** + * Tests the assertion. True if correct. + * @param integer $compare Measured call count. + * @return boolean True if not over. + * @access public + */ + function test($compare) { + return ($this->_count >= $compare); + } + + /** + * Reports the comparison. + * @param integer $compare Measured call count. + * @return string Message to show. + * @access public + */ + function testMessage($compare) { + return 'Maximum call count for [' . $this->_method . + '] was [' . $this->_count . + '] got [' . $compare . ']'; + } + } + + /** + * Retrieves values and references by searching the + * parameter lists until a match is found. + * @package SimpleTest + * @subpackage MockObjects + */ + class CallMap { + protected $_map; + + /** + * Creates an empty call map. + * @access public + */ + function CallMap() { + $this->_map = array(); + } + + /** + * Stashes a value against a method call. + * @param array $parameters Arguments including wildcards. + * @param mixed $value Value copied into the map. + * @access public + */ + function addValue($parameters, $value) { + $this->addReference($parameters, $value); + } + + /** + * Stashes a reference against a method call. + * @param array $parameters Array of arguments (including wildcards). + * @param mixed $reference Array reference placed in the map. + * @access public + */ + function addReference($parameters, $reference) { + $place = count($this->_map); + $this->_map[$place] = array(); + $this->_map[$place]["params"] = new ParametersExpectation($parameters); + $this->_map[$place]["content"] = $reference; + } + + /** + * Searches the call list for a matching parameter + * set. Returned by reference. + * @param array $parameters Parameters to search by + * without wildcards. + * @return object Object held in the first matching + * slot, otherwise null. + * @access public + */ + function findFirstMatch($parameters) { + $slot = $this->_findFirstSlot($parameters); + if (!isset($slot)) { + return null; + } + return $slot["content"]; + } + + /** + * Searches the call list for a matching parameter + * set. True if successful. + * @param array $parameters Parameters to search by + * without wildcards. + * @return boolean True if a match is present. + * @access public + */ + function isMatch($parameters) { + return ($this->_findFirstSlot($parameters) != null); + } + + /** + * Searches the map for a matching item. + * @param array $parameters Parameters to search by + * without wildcards. + * @return array Reference to slot or null. + * @access private + */ + function _findFirstSlot($parameters) { + $count = count($this->_map); + for ($i = 0; $i < $count; $i++) { + if ($this->_map[$i]["params"]->test($parameters)) { + return $this->_map[$i]; + } + } + return null; + } + } + + /** + * An empty collection of methods that can have their + * return values set. Used for prototyping. + * @package SimpleTest + * @subpackage MockObjects + */ + class SimpleStub { + protected $_wildcard; + protected $_is_strict; + protected $_returns; + protected $_return_sequence; + protected $_call_counts; + + /** + * Sets up the wildcard and everything else empty. + * @param mixed $wildcard Parameter matching wildcard. + * @param boolean $is_strict Enables method name checks. + * @access public + */ + function SimpleStub($wildcard, $is_strict = true) { + $this->_wildcard = $wildcard; + $this->_is_strict = $is_strict; + $this->_returns = array(); + $this->_return_sequence = array(); + $this->_call_counts = array(); + } + + /** + * Replaces wildcard matches with wildcard + * expectations in the argument list. + * @param array $args Raw argument list. + * @return array Argument list with + * expectations. + * @access private + */ + function _replaceWildcards($args) { + if ($args === false) { + return false; + } + for ($i = 0; $i < count($args); $i++) { + if ($args[$i] === $this->_wildcard) { + $args[$i] = new WildcardExpectation(); + } + } + return $args; + } + + /** + * Returns the expected value for the method name. + * @param string $method Name of method to simulate. + * @param array $args Arguments as an array. + * @return mixed Stored return. + * @access private + */ + function _invoke($method, $args) { + $method = strtolower($method); + $step = $this->getCallCount($method); + $this->_addCall($method, $args); + return $this->_getReturn($method, $args, $step); + } + + /** + * Triggers a PHP error if the method is not part + * of this object. + * @param string $method Name of method. + * @param string $task Description of task attempt. + * @access protected + */ + function _dieOnNoMethod($method, $task) { + if ($this->_is_strict && !method_exists($this, $method)) { + trigger_error( + "Cannot $task as no ${method}() in class " . get_class($this), + E_USER_ERROR); + } + } + + /** + * Adds one to the call count of a method. + * @param string $method Method called. + * @param array $args Arguments as an array. + * @access protected + */ + function _addCall($method, $args) { + if (!isset($this->_call_counts[$method])) { + $this->_call_counts[$method] = 0; + } + $this->_call_counts[$method]++; + } + + /** + * Fetches the call count of a method so far. + * @param string $method Method name called. + * @return Number of calls so far. + * @access public + */ + function getCallCount($method) { + $this->_dieOnNoMethod($method, "get call count"); + $method = strtolower($method); + if (! isset($this->_call_counts[$method])) { + return 0; + } + return $this->_call_counts[$method]; + } + + /** + * Sets a return for a parameter list that will + * be passed by value for all calls to this method. + * @param string $method Method name. + * @param mixed $value Result of call passed by value. + * @param array $args List of parameters to match + * including wildcards. + * @access public + */ + function setReturnValue($method, $value, $args = false) { + $this->_dieOnNoMethod($method, "set return value"); + $args = $this->_replaceWildcards($args); + $method = strtolower($method); + if (! isset($this->_returns[$method])) { + $this->_returns[$method] = new CallMap(); + } + $this->_returns[$method]->addValue($args, $value); + } + + /** + * Sets a return for a parameter list that will + * be passed by value only when the required call count + * is reached. + * @param integer $timing Number of calls in the future + * to which the result applies. If + * not set then all calls will return + * the value. + * @param string $method Method name. + * @param mixed $value Result of call passed by value. + * @param array $args List of parameters to match + * including wildcards. + * @access public + */ + function setReturnValueAt($timing, $method, $value, $args = false) { + $this->_dieOnNoMethod($method, "set return value sequence"); + $args = $this->_replaceWildcards($args); + $method = strtolower($method); + if (! isset($this->_return_sequence[$method])) { + $this->_return_sequence[$method] = array(); + } + if (! isset($this->_return_sequence[$method][$timing])) { + $this->_return_sequence[$method][$timing] = new CallMap(); + } + $this->_return_sequence[$method][$timing]->addValue($args, $value); + } + + /** + * Sets a return for a parameter list that will + * be passed by reference for all calls. + * @param string $method Method name. + * @param mixed $reference Result of the call will be this object. + * @param array $args List of parameters to match + * including wildcards. + * @access public + */ + function setReturnReference($method, $reference, $args = false) { + $this->_dieOnNoMethod($method, "set return reference"); + $args = $this->_replaceWildcards($args); + $method = strtolower($method); + if (! isset($this->_returns[$method])) { + $this->_returns[$method] = new CallMap(); + } + $this->_returns[$method]->addReference($args, $reference); + } + + /** + * Sets a return for a parameter list that will + * be passed by value only when the required call count + * is reached. + * @param integer $timing Number of calls in the future + * to which the result applies. If + * not set then all calls will return + * the value. + * @param string $method Method name. + * @param mixed $reference Result of the call will be this object. + * @param array $args List of parameters to match + * including wildcards. + * @access public + */ + function setReturnReferenceAt($timing, $method, $reference, $args = false) { + $this->_dieOnNoMethod($method, "set return reference sequence"); + $args = $this->_replaceWildcards($args); + $method = strtolower($method); + if (! isset($this->_return_sequence[$method])) { + $this->_return_sequence[$method] = array(); + } + if (! isset($this->_return_sequence[$method][$timing])) { + $this->_return_sequence[$method][$timing] = new CallMap(); + } + $this->_return_sequence[$method][$timing]->addReference($args, $reference); + } + + /** + * Finds the return value matching the incoming + * arguments. If there is no matching value found + * then an error is triggered. + * @param string $method Method name. + * @param array $args Calling arguments. + * @param integer $step Current position in the + * call history. + * @return mixed Stored return. + * @access protected + */ + function _getReturn($method, $args, $step) { + if (isset($this->_return_sequence[$method][$step])) { + if ($this->_return_sequence[$method][$step]->isMatch($args)) { + return $this->_return_sequence[$method][$step]->findFirstMatch($args); + } + } + if (isset($this->_returns[$method])) { + return $this->_returns[$method]->findFirstMatch($args); + } + return null; + } + } + + /** + * An empty collection of methods that can have their + * return values set and expectations made of the + * calls upon them. The mock will assert the + * expectations against it's attached test case in + * addition to the server stub behaviour. + * @package SimpleTest + * @subpackage MockObjects + */ + class SimpleMock extends SimpleStub { + protected $_test; + protected $_expected_counts; + protected $_max_counts; + protected $_expected_args; + protected $_expected_args_at; + + /** + * Creates an empty return list and expectation list. + * All call counts are set to zero. + * @param SimpleTestCase $test Test case to test expectations in. + * @param mixed $wildcard Parameter matching wildcard. + * @param boolean $is_strict Enables method name checks on + * expectations. + * @access public + */ + function SimpleMock($test, $wildcard, $is_strict = true) { + $this->SimpleStub($wildcard, $is_strict); + if (! $test) { + trigger_error('No unit tester for mock object', E_USER_ERROR); + return; + } + $this->_test = SimpleMock::registerTest($test); + $this->_expected_counts = array(); + $this->_max_counts = array(); + $this->_expected_args = array(); + $this->_expected_args_at = array(); + } + + /** + * Accessor for attached unit test so that when + * subclassed, new expectations can be added easily. + * @return SimpleTestCase Unit test passed in constructor. + * @access public + */ + function getTest() { + return $this->_test; + } + + /** + * Die if bad arguments array is passed + * @param mixed $args The arguments value to be checked. + * @param string $task Description of task attempt. + * @return boolean Valid arguments + * @access private + */ + function _checkArgumentsIsArray($args, $task) { + if (! is_array($args)) { + trigger_error( + "Cannot $task as \$args parameter is not an array", + E_USER_ERROR); + } + } + + /** + * Sets up an expected call with a set of + * expected parameters in that call. All + * calls will be compared to these expectations + * regardless of when the call is made. + * @param string $method Method call to test. + * @param array $args Expected parameters for the call + * including wildcards. + * @param string $message Overridden message. + * @access public + */ + function expectArguments($method, $args, $message = '%s') { + $this->_dieOnNoMethod($method, 'set expected arguments'); + $this->_checkArgumentsIsArray($args, 'set expected arguments'); + $args = $this->_replaceWildcards($args); + $message .= Mock::getExpectationLine(' at line [%d]'); + $this->_expected_args[strtolower($method)] = + new ParametersExpectation($args, $message); + } + + /** + * Sets up an expected call with a set of + * expected parameters in that call. The + * expected call count will be adjusted if it + * is set too low to reach this call. + * @param integer $timing Number of calls in the future at + * which to test. Next call is 0. + * @param string $method Method call to test. + * @param array $args Expected parameters for the call + * including wildcards. + * @param string $message Overridden message. + * @access public + */ + function expectArgumentsAt($timing, $method, $args, $message = '%s') { + $this->_dieOnNoMethod($method, 'set expected arguments at time'); + $this->_checkArgumentsIsArray($args, 'set expected arguments at time'); + $args = $this->_replaceWildcards($args); + if (! isset($this->_expected_args_at[$timing])) { + $this->_expected_args_at[$timing] = array(); + } + $method = strtolower($method); + $message .= Mock::getExpectationLine(' at line [%d]'); + $this->_expected_args_at[$timing][$method] = + new ParametersExpectation($args, $message); + } + + /** + * Sets an expectation for the number of times + * a method will be called. The tally method + * is used to check this. + * @param string $method Method call to test. + * @param integer $count Number of times it should + * have been called at tally. + * @param string $message Overridden message. + * @access public + */ + function expectCallCount($method, $count, $message = '%s') { + $this->_dieOnNoMethod($method, 'set expected call count'); + $message .= Mock::getExpectationLine(' at line [%d]'); + $this->_expected_counts[strtolower($method)] = + new CallCountExpectation($method, $count, $message); + } + + /** + * Sets the number of times a method may be called + * before a test failure is triggered. + * @param string $method Method call to test. + * @param integer $count Most number of times it should + * have been called. + * @param string $message Overridden message. + * @access public + */ + function expectMaximumCallCount($method, $count, $message = '%s') { + $this->_dieOnNoMethod($method, 'set maximum call count'); + $message .= Mock::getExpectationLine(' at line [%d]'); + $this->_max_counts[strtolower($method)] = + new MaximumCallCountExpectation($method, $count, $message); + } + + /** + * Sets the number of times to call a method to prevent + * a failure on the tally. + * @param string $method Method call to test. + * @param integer $count Least number of times it should + * have been called. + * @param string $message Overridden message. + * @access public + */ + function expectMinimumCallCount($method, $count, $message = '%s') { + $this->_dieOnNoMethod($method, 'set minimum call count'); + $message .= Mock::getExpectationLine(' at line [%d]'); + $this->_expected_counts[strtolower($method)] = + new MinimumCallCountExpectation($method, $count, $message); + } + + /** + * Convenience method for barring a method + * call. + * @param string $method Method call to ban. + * @param string $message Overridden message. + * @access public + */ + function expectNever($method, $message = '%s') { + $this->expectMaximumCallCount($method, 0, $message); + } + + /** + * Convenience method for a single method + * call. + * @param string $method Method call to track. + * @param array $args Expected argument list or + * false for any arguments. + * @param string $message Overridden message. + * @access public + */ + function expectOnce($method, $args = false, $message = '%s') { + $this->expectCallCount($method, 1, $message); + if ($args !== false) { + $this->expectArguments($method, $args, $message); + } + } + + /** + * Convenience method for requiring a method + * call. + * @param string $method Method call to track. + * @param array $args Expected argument list or + * false for any arguments. + * @param string $message Overridden message. + * @access public + */ + function expectAtLeastOnce($method, $args = false, $message = '%s') { + $this->expectMinimumCallCount($method, 1, $message); + if ($args !== false) { + $this->expectArguments($method, $args, $message); + } + } + + /** + * Totals up the call counts and triggers a test + * assertion if a test is present for expected + * call counts. + * This method must be called explicitly for the call + * count assertions to be triggered. + * @access public + */ + function tally() { + foreach ($this->_expected_counts as $method => $expectation) { + $this->_assertTrue( + $expectation->test($this->getCallCount($method)), + $expectation->overlayMessage($this->getCallCount($method))); + } + foreach ($this->_max_counts as $method => $expectation) { + if ($expectation->test($this->getCallCount($method))) { + $this->_assertTrue( + true, + $expectation->overlayMessage($this->getCallCount($method))); + } + } + } + + /** + * Returns the expected value for the method name + * and checks expectations. Will generate any + * test assertions as a result of expectations + * if there is a test present. + * @param string $method Name of method to simulate. + * @param array $args Arguments as an array. + * @return mixed Stored return. + * @access private + */ + function _invoke($method, $args) { + $method = strtolower($method); + $step = $this->getCallCount($method); + $this->_addCall($method, $args); + $this->_checkExpectations($method, $args, $step); + return $this->_getReturn($method, $args, $step); + } + + /** + * Tests the arguments against expectations. + * @param string $method Method to check. + * @param array $args Argument list to match. + * @param integer $timing The position of this call + * in the call history. + * @access private + */ + function _checkExpectations($method, $args, $timing) { + if (isset($this->_max_counts[$method])) { + if (! $this->_max_counts[$method]->test($timing + 1)) { + $this->_assertTrue( + false, + $this->_max_counts[$method]->overlayMessage($timing + 1)); + } + } + if (isset($this->_expected_args_at[$timing][$method])) { + $this->_assertTrue( + $this->_expected_args_at[$timing][$method]->test($args), + "Mock method [$method] at [$timing] -> " . + $this->_expected_args_at[$timing][$method]->overlayMessage($args)); + } elseif (isset($this->_expected_args[$method])) { + $this->_assertTrue( + $this->_expected_args[$method]->test($args), + "Mock method [$method] -> " . $this->_expected_args[$method]->overlayMessage($args)); + } + } + + /** + * Triggers an assertion on the held test case. + * Should be overridden when using another test + * framework other than the SimpleTest one if the + * assertion method has a different name. + * @param boolean $assertion True will pass. + * @param string $message Message that will go with + * the test event. + * @access protected + */ + function _assertTrue($assertion, $message) { + $test =SimpleMock::injectTest($this->_test); + $test->assertTrue($assertion, $message); + } + + /** + * Stashes the test case for later recovery. + * @param SimpleTestCase $test Test case. + * @return string Key to find it again. + * @access public + * @static + */ + function registerTest($test) { + $registry =SimpleMock::_getRegistry(); + $registry[$class = get_class($test)] = $test; + return $class; + } + + /** + * Resolves the dependency on the test case. + * @param string $class Key to look up test case in. + * @return SimpleTestCase Test case to send results to. + * @access public + * @static + */ + function injectTest($key) { + $registry =SimpleMock::_getRegistry(); + return $registry[$key]; + } + + /** + * Registry for test cases. The reason for this is + * to break the reference between the test cases and + * the mocks. It was leading to a fatal error due to + * recursive dependencies during comparisons. See + * http://bugs.php.net/bug.php?id=31449 for the PHP + * bug. + * @return array List of references. + * @access private + * @static + */ + function _getRegistry() { + static $registry; + if (! isset($registry)) { + $registry = array(); + } + return $registry; + } + } + + /** + * Static methods only service class for code generation of + * server stubs. + * @package SimpleTest + * @subpackage MockObjects + */ + class Stub { + + /** + * Factory for server stub classes. + */ + function Stub() { + trigger_error('Stub factory methods are class only.'); + } + + /** + * Clones a class' interface and creates a stub version + * that can have return values set. + * @param string $class Class to clone. + * @param string $stub_class New class name. Default is + * the old name with "Stub" + * prepended. + * @param array $methods Additional methods to add beyond + * those in the cloned class. Use this + * to emulate the dynamic addition of + * methods in the cloned class or when + * the class hasn't been written yet. + * @static + * @access public + */ + function generate($class, $stub_class = false, $methods = false) { + if (! SimpleTestCompatibility::classExists($class)) { + return false; + } + if (! $stub_class) { + $stub_class = "Stub" . $class; + } + if (SimpleTestCompatibility::classExists($stub_class)) { + return false; + } + return eval(Stub::_createClassCode( + $class, + $stub_class, + $methods ? $methods : array()) . " return true;"); + } + + /** + * The new server stub class code in string form. + * @param string $class Class to clone. + * @param string $mock_class New class name. + * @param array $methods Additional methods. + * @static + * @access private + */ + function _createClassCode($class, $stub_class, $methods) { + $stub_base = SimpleTestOptions::getStubBaseClass(); + $code = "class $stub_class extends $stub_base {\n"; + $code .= " function $stub_class(\$wildcard = MOCK_WILDCARD) {\n"; + $code .= " \$this->$stub_base(\$wildcard);\n"; + $code .= " }\n"; + $code .= Stub::_createHandlerCode($class, $stub_base, $methods); + $code .= "}\n"; + return $code; + } + + /** + * Creates code within a class to generate replaced + * methods. All methods call the _invoke() handler + * with the method name and the arguments in an + * array. + * @param string $class Class to clone. + * @param string $base Base mock/stub class with methods that + * cannot be cloned. Otherwise you + * would be stubbing the accessors used + * to set the stubs. + * @param array $methods Additional methods. + * @static + * @access private + */ + function _createHandlerCode($class, $base, $methods) { + $code = ""; + $methods = array_merge($methods, get_class_methods($class)); + foreach ($methods as $method) { + if (Stub::_isSpecialMethod($method)) { + continue; + } + if (in_array($method, get_class_methods($base))) { + continue; + } + $code .= " function $method() {\n"; + $code .= " \$args = func_get_args();\n"; + $code .= " return \$this->_invoke(\"$method\", \$args);\n"; + $code .= " }\n"; + } + return $code; + } + + /** + * Tests to see if a special PHP method is about to + * be stubbed by mistake. + * @param string $method Method name. + * @return boolean True if special. + * @access private + * @static + */ + function _isSpecialMethod($method) { + return in_array( + strtolower($method), + array('__construct', '__clone', '__get', '__set', '__call')); + } + } + + /** + * Static methods only service class for code generation of + * mock objects. + * @package SimpleTest + * @subpackage MockObjects + */ + class Mock { + + /** + * Factory for mock object classes. + * @access public + */ + function Mock() { + trigger_error("Mock factory methods are class only."); + } + + /** + * Clones a class' interface and creates a mock version + * that can have return values and expectations set. + * @param string $class Class to clone. + * @param string $mock_class New class name. Default is + * the old name with "Mock" + * prepended. + * @param array $methods Additional methods to add beyond + * those in th cloned class. Use this + * to emulate the dynamic addition of + * methods in the cloned class or when + * the class hasn't been written yet. + * @static + * @access public + */ + function generate($class, $mock_class = false, $methods = false) { + if (! SimpleTestCompatibility::classExists($class)) { + return false; + } + if (! $mock_class) { + $mock_class = "Mock" . $class; + } + if (SimpleTestCompatibility::classExists($mock_class)) { + return false; + } + return eval(Mock::_createClassCode( + $class, + $mock_class, + $methods ? $methods : array()) . " return true;"); + } + + /** + * Generates a version of a class with selected + * methods mocked only. Inherits the old class + * and chains the mock methods of an aggregated + * mock object. + * @param string $class Class to clone. + * @param string $mock_class New class name. + * @param array $methods Methods to be overridden + * with mock versions. + * @static + * @access public + */ + function generatePartial($class, $mock_class, $methods) { + if (! SimpleTestCompatibility::classExists($class)) { + return false; + } + if (SimpleTestCompatibility::classExists($mock_class)) { + trigger_error("Partial mock class [$mock_class] already exists"); + return false; + } + return eval(Mock::_extendClassCode($class, $mock_class, $methods)); + } + + /** + * The new mock class code as a string. + * @param string $class Class to clone. + * @param string $mock_class New class name. + * @param array $methods Additional methods. + * @return string Code for new mock class. + * @static + * @access private + */ + function _createClassCode($class, $mock_class, $methods) { + $mock_base = SimpleTestOptions::getMockBaseClass(); + $code = "class $mock_class extends $mock_base {\n"; + $code .= " function $mock_class(&\$test, \$wildcard = MOCK_WILDCARD) {\n"; + $code .= " \$this->$mock_base(\$test, \$wildcard);\n"; + $code .= " }\n"; + $code .= Stub::_createHandlerCode($class, $mock_base, $methods); + $code .= "}\n"; + return $code; + } + + /** + * The extension class code as a string. The class + * composites a mock object and chains mocked methods + * to it. + * @param string $class Class to extend. + * @param string $mock_class New class name. + * @param array $methods Mocked methods. + * @return string Code for a new class. + * @static + * @access private + */ + function _extendClassCode($class, $mock_class, $methods) { + $mock_base = SimpleTestOptions::getMockBaseClass(); + $code = "class $mock_class extends $class {\n"; + $code .= " var \$_mock;\n"; + $code .= Mock::_addMethodList($methods); + $code .= "\n"; + $code .= " function $mock_class(&\$test, \$wildcard = MOCK_WILDCARD) {\n"; + $code .= " \$this->_mock = new $mock_base(\$test, \$wildcard, false);\n"; + $code .= " }\n"; + $code .= Mock::_chainMockReturns(); + $code .= Mock::_chainMockExpectations(); + $code .= Mock::_overrideMethods($methods); + $code .= SimpleTestOptions::getPartialMockCode(); + $code .= "}\n"; + return $code; + } + + /** + * Creates a list of mocked methods for error checking. + * @param array $methods Mocked methods. + * @return string Code for a method list. + * @access private + */ + function _addMethodList($methods) { + return " var \$_mocked_methods = array('" . implode("', '", $methods) . "');\n"; + } + + /** + * Creates code to abandon the expectation if not mocked. + * @param string $alias Parameter name of method name. + * @return string Code for bail out. + * @access private + */ + function _bailOutIfNotMocked($alias) { + $code = " if (! in_array($alias, \$this->_mocked_methods)) {\n"; + $code .= " trigger_error(\"Method [$alias] is not mocked\");\n"; + $code .= " return;\n"; + $code .= " }\n"; + return $code; + } + + /** + * Creates source code for chaining to the composited + * mock object. + * @return string Code for mock set up. + * @access private + */ + function _chainMockReturns() { + $code = " function setReturnValue(\$method, \$value, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->setReturnValue(\$method, \$value, \$args);\n"; + $code .= " }\n"; + $code .= " function setReturnValueAt(\$timing, \$method, \$value, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->setReturnValueAt(\$timing, \$method, \$value, \$args);\n"; + $code .= " }\n"; + $code .= " function setReturnReference(\$method, &\$ref, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->setReturnReference(\$method, \$ref, \$args);\n"; + $code .= " }\n"; + $code .= " function setReturnReferenceAt(\$timing, \$method, &\$ref, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->setReturnReferenceAt(\$timing, \$method, \$ref, \$args);\n"; + $code .= " }\n"; + return $code; + } + + /** + * Creates source code for chaining to an aggregated + * mock object. + * @return string Code for expectations. + * @access private + */ + function _chainMockExpectations() { + $code = " function expectArguments(\$method, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectArguments(\$method, \$args);\n"; + $code .= " }\n"; + $code .= " function expectArgumentsAt(\$timing, \$method, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectArgumentsAt(\$timing, \$method, \$args);\n"; + $code .= " }\n"; + $code .= " function expectCallCount(\$method, \$count) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectCallCount(\$method, \$count);\n"; + $code .= " }\n"; + $code .= " function expectMaximumCallCount(\$method, \$count) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectMaximumCallCount(\$method, \$count);\n"; + $code .= " }\n"; + $code .= " function expectMinimumCallCount(\$method, \$count) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectMinimumCallCount(\$method, \$count);\n"; + $code .= " }\n"; + $code .= " function expectNever(\$method) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectNever(\$method);\n"; + $code .= " }\n"; + $code .= " function expectOnce(\$method, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectOnce(\$method, \$args);\n"; + $code .= " }\n"; + $code .= " function expectAtLeastOnce(\$method, \$args = false) {\n"; + $code .= Mock::_bailOutIfNotMocked("\$method"); + $code .= " \$this->_mock->expectAtLeastOnce(\$method, \$args);\n"; + $code .= " }\n"; + $code .= " function tally() {\n"; + $code .= " \$this->_mock->tally();\n"; + $code .= " }\n"; + return $code; + } + + /** + * Creates source code to override a list of methods + * with mock versions. + * @param array $methods Methods to be overridden + * with mock versions. + * @return string Code for overridden chains. + * @access private + */ + function _overrideMethods($methods) { + $code = ""; + foreach ($methods as $method) { + $code .= " function $method() {\n"; + $code .= " \$args = func_get_args();\n"; + $code .= " return \$this->_mock->_invoke(\"$method\", \$args);\n"; + $code .= " }\n"; + } + return $code; + } + + /** + * Uses a stack trace to find the line of an assertion. + * @param string $format String formatting. + * @param array $stack Stack frames top most first. Only + * needed if not using the PHP + * backtrace function. + * @return string Line number of first expect* + * method embedded in format string. + * @access public + * @static + */ + function getExpectationLine($format = '%d', $stack = false) { + if ($stack === false) { + $stack = SimpleTestCompatibility::getStackTrace(); + } + return SimpleDumper::getFormattedAssertionLine($stack, $format, 'expect'); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/options.php b/tests/test_tools/simpletest/options.php index 63b6b996..51ec5353 100644 --- a/tests/UnitTests/simpletest/options.php +++ b/tests/test_tools/simpletest/options.php @@ -1,366 +1,366 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @version $Id: options.php,v 1.35 2005/02/04 03:48:52 lastcraft Exp $
- */
-
- /**
- * Static global directives and options.
- * @package SimpleTest
- */
- class SimpleTestOptions {
-
- /**
- * Reads the SimpleTest version from the release file.
- * @return string Version string.
- * @static
- * @access public
- */
- function getVersion() {
- $content = file(dirname(__FILE__) . '/VERSION');
- return trim($content[0]);
- }
-
- /**
- * Sets the name of a test case to ignore, usually
- * because the class is an abstract case that should
- * not be run.
- * @param string $class Add a class to ignore.
- * @static
- * @access public
- */
- function ignore($class) {
- $registry =SimpleTestOptions::_getRegistry();
- $registry['IgnoreList'][] = strtolower($class);
- }
-
- /**
- * Test to see if a test case is in the ignore
- * list.
- * @param string $class Class name to test.
- * @return boolean True if should not be run.
- * @access public
- * @static
- */
- function isIgnored($class) {
- $registry =SimpleTestOptions::_getRegistry();
- return in_array(strtolower($class), $registry['IgnoreList']);
- }
-
- /**
- * The base class name is settable here. This is the
- * class that a new stub will inherited from.
- * To modify the generated stubs simply extend the
- * SimpleStub class and set it's name
- * with this method before any stubs are generated.
- * @param string $stub_base Server stub class to use.
- * @static
- * @access public
- */
- function setStubBaseClass($stub_base) {
- $registry =SimpleTestOptions::_getRegistry();
- $registry['StubBaseClass'] = $stub_base;
- }
-
- /**
- * Accessor for the currently set stub base class.
- * @return string Class name to inherit from.
- * @static
- * @access public
- */
- function getStubBaseClass() {
- $registry =SimpleTestOptions::_getRegistry();
- return $registry['StubBaseClass'];
- }
-
- /**
- * The base class name is settable here. This is the
- * class that a new mock will inherited from.
- * To modify the generated mocks simply extend the
- * SimpleMock class and set it's name
- * with this method before any mocks are generated.
- * @param string $mock_base Mock base class to use.
- * @static
- * @access public
- */
- function setMockBaseClass($mock_base) {
- $registry =SimpleTestOptions::_getRegistry();
- $registry['MockBaseClass'] = $mock_base;
- }
-
- /**
- * Accessor for the currently set mock base class.
- * @return string Class name to inherit from.
- * @static
- * @access public
- */
- function getMockBaseClass() {
- $registry =SimpleTestOptions::_getRegistry();
- return $registry['MockBaseClass'];
- }
-
- /**
- * Adds additional mock code.
- * @param string $code Extra code that can be added
- * to the partial mocks for
- * extra functionality. Useful
- * when a test tool has overridden
- * the mock base classes.
- * @access public
- */
- function addPartialMockCode($code = '') {
- $registry =SimpleTestOptions::_getRegistry();
- $registry['AdditionalPartialMockCode'] = $code;
- }
-
- /**
- * Accessor for additional partial mock code.
- * @return string Extra code.
- * @access public
- */
- function getPartialMockCode() {
- $registry =SimpleTestOptions::_getRegistry();
- return $registry['AdditionalPartialMockCode'];
- }
-
- /**
- * Sets proxy to use on all requests for when
- * testing from behind a firewall. Set host
- * to false to disable. This will take effect
- * if there are no other proxy settings.
- * @param string $proxy Proxy host as URL.
- * @param string $username Proxy username for authentication.
- * @param string $password Proxy password for authentication.
- * @access public
- */
- function useProxy($proxy, $username = false, $password = false) {
- $registry =SimpleTestOptions::_getRegistry();
- $registry['DefaultProxy'] = $proxy;
- $registry['DefaultProxyUsername'] = $username;
- $registry['DefaultProxyPassword'] = $password;
- }
-
- /**
- * Accessor for default proxy host.
- * @return string Proxy URL.
- * @access public
- */
- function getDefaultProxy() {
- $registry =SimpleTestOptions::_getRegistry();
- return $registry['DefaultProxy'];
- }
-
- /**
- * Accessor for default proxy username.
- * @return string Proxy username for authentication.
- * @access public
- */
- function getDefaultProxyUsername() {
- $registry =SimpleTestOptions::_getRegistry();
- return $registry['DefaultProxyUsername'];
- }
-
- /**
- * Accessor for default proxy password.
- * @return string Proxy password for authentication.
- * @access public
- */
- function getDefaultProxyPassword() {
- $registry =SimpleTestOptions::_getRegistry();
- return $registry['DefaultProxyPassword'];
- }
-
- /**
- * Accessor for global registry of options.
- * @return hash All stored values.
- * @access private
- * @static
- */
- function _getRegistry() {
- static $registry = false;
- if (! $registry) {
- $registry = SimpleTestOptions::_getDefaults();
- }
- return $registry;
- }
-
- /**
- * Constant default values.
- * @return hash All registry defaults.
- * @access private
- * @static
- */
- function _getDefaults() {
- return array(
- 'StubBaseClass' => 'SimpleStub',
- 'MockBaseClass' => 'SimpleMock',
- 'IgnoreList' => array(),
- 'AdditionalPartialMockCode' => '',
- 'DefaultProxy' => false,
- 'DefaultProxyUsername' => false,
- 'DefaultProxyPassword' => false);
- }
- }
-
- /**
- * Static methods for compatibility between different
- * PHP versions.
- * @package SimpleTest
- */
- class SimpleTestCompatibility {
-
- /**
- * 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.
- * @access public
- * @static
- */
- function isIdentical($first, $second) {
- if ($first != $second) {
- return false;
- }
- if (version_compare(phpversion(), '5') >= 0) {
- return SimpleTestCompatibility::_isIdenticalType($first, $second);
- }
- return ($first === $second);
- }
-
- /**
- * Recursive type test.
- * @param mixed $first Test subject.
- * @param mixed $second Comparison object.
- * @access private
- * @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(
- get_object_vars($first),
- get_object_vars($second));
- }
- if (is_array($first) && is_array($second)) {
- return SimpleTestCompatibility::_isArrayOfIdenticalTypes($first, $second);
- }
- return true;
- }
-
- /**
- * Recursive type test for each element of an array.
- * @param mixed $first Test subject.
- * @param mixed $second Comparison object.
- * @access private
- * @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.
- * @access public
- * @static
- */
- function isReference($first, $second) {
- if (version_compare(phpversion(), '5', '>=')
- && is_object($first)) {
- return ($first === $second);
- }
- $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.
- * @access public
- * @static
- */
- function isA($object, $class) {
- if (version_compare(phpversion(), '5') >= 0) {
- if (! class_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)));
- }
-
- /**
- * Autoload safe version of class_exists().
- * @param string $class Name of class to look for.
- * @return boolean True if class is defined.
- * @access public
- * @static
- */
- function classExists($class) {
- if (version_compare(phpversion(), '5') >= 0) {
- return class_exists($class, false);
- } else {
- return class_exists($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);
- }
- }
-
- /**
- * Gets the current stack trace topmost first.
- * @return array List of stack frames.
- * @access public
- * @static
- */
- function getStackTrace() {
- if (function_exists('debug_backtrace')) {
- return array_reverse(debug_backtrace());
- }
- return array();
- }
- }
-?>
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @version $Id: options.php,v 1.35 2005/02/04 03:48:52 lastcraft Exp $ + */ + + /** + * Static global directives and options. + * @package SimpleTest + */ + class SimpleTestOptions { + + /** + * Reads the SimpleTest version from the release file. + * @return string Version string. + * @static + * @access public + */ + function getVersion() { + $content = file(dirname(__FILE__) . '/VERSION'); + return trim($content[0]); + } + + /** + * Sets the name of a test case to ignore, usually + * because the class is an abstract case that should + * not be run. + * @param string $class Add a class to ignore. + * @static + * @access public + */ + function ignore($class) { + $registry =SimpleTestOptions::_getRegistry(); + $registry['IgnoreList'][] = strtolower($class); + } + + /** + * Test to see if a test case is in the ignore + * list. + * @param string $class Class name to test. + * @return boolean True if should not be run. + * @access public + * @static + */ + function isIgnored($class) { + $registry =SimpleTestOptions::_getRegistry(); + return in_array(strtolower($class), $registry['IgnoreList']); + } + + /** + * The base class name is settable here. This is the + * class that a new stub will inherited from. + * To modify the generated stubs simply extend the + * SimpleStub class and set it's name + * with this method before any stubs are generated. + * @param string $stub_base Server stub class to use. + * @static + * @access public + */ + function setStubBaseClass($stub_base) { + $registry =SimpleTestOptions::_getRegistry(); + $registry['StubBaseClass'] = $stub_base; + } + + /** + * Accessor for the currently set stub base class. + * @return string Class name to inherit from. + * @static + * @access public + */ + function getStubBaseClass() { + $registry =SimpleTestOptions::_getRegistry(); + return $registry['StubBaseClass']; + } + + /** + * The base class name is settable here. This is the + * class that a new mock will inherited from. + * To modify the generated mocks simply extend the + * SimpleMock class and set it's name + * with this method before any mocks are generated. + * @param string $mock_base Mock base class to use. + * @static + * @access public + */ + function setMockBaseClass($mock_base) { + $registry =SimpleTestOptions::_getRegistry(); + $registry['MockBaseClass'] = $mock_base; + } + + /** + * Accessor for the currently set mock base class. + * @return string Class name to inherit from. + * @static + * @access public + */ + function getMockBaseClass() { + $registry =SimpleTestOptions::_getRegistry(); + return $registry['MockBaseClass']; + } + + /** + * Adds additional mock code. + * @param string $code Extra code that can be added + * to the partial mocks for + * extra functionality. Useful + * when a test tool has overridden + * the mock base classes. + * @access public + */ + function addPartialMockCode($code = '') { + $registry =SimpleTestOptions::_getRegistry(); + $registry['AdditionalPartialMockCode'] = $code; + } + + /** + * Accessor for additional partial mock code. + * @return string Extra code. + * @access public + */ + function getPartialMockCode() { + $registry =SimpleTestOptions::_getRegistry(); + return $registry['AdditionalPartialMockCode']; + } + + /** + * Sets proxy to use on all requests for when + * testing from behind a firewall. Set host + * to false to disable. This will take effect + * if there are no other proxy settings. + * @param string $proxy Proxy host as URL. + * @param string $username Proxy username for authentication. + * @param string $password Proxy password for authentication. + * @access public + */ + function useProxy($proxy, $username = false, $password = false) { + $registry =SimpleTestOptions::_getRegistry(); + $registry['DefaultProxy'] = $proxy; + $registry['DefaultProxyUsername'] = $username; + $registry['DefaultProxyPassword'] = $password; + } + + /** + * Accessor for default proxy host. + * @return string Proxy URL. + * @access public + */ + function getDefaultProxy() { + $registry =SimpleTestOptions::_getRegistry(); + return $registry['DefaultProxy']; + } + + /** + * Accessor for default proxy username. + * @return string Proxy username for authentication. + * @access public + */ + function getDefaultProxyUsername() { + $registry =SimpleTestOptions::_getRegistry(); + return $registry['DefaultProxyUsername']; + } + + /** + * Accessor for default proxy password. + * @return string Proxy password for authentication. + * @access public + */ + function getDefaultProxyPassword() { + $registry =SimpleTestOptions::_getRegistry(); + return $registry['DefaultProxyPassword']; + } + + /** + * Accessor for global registry of options. + * @return hash All stored values. + * @access private + * @static + */ + function _getRegistry() { + static $registry = false; + if (! $registry) { + $registry = SimpleTestOptions::_getDefaults(); + } + return $registry; + } + + /** + * Constant default values. + * @return hash All registry defaults. + * @access private + * @static + */ + function _getDefaults() { + return array( + 'StubBaseClass' => 'SimpleStub', + 'MockBaseClass' => 'SimpleMock', + 'IgnoreList' => array(), + 'AdditionalPartialMockCode' => '', + 'DefaultProxy' => false, + 'DefaultProxyUsername' => false, + 'DefaultProxyPassword' => false); + } + } + + /** + * Static methods for compatibility between different + * PHP versions. + * @package SimpleTest + */ + class SimpleTestCompatibility { + + /** + * 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. + * @access public + * @static + */ + function isIdentical($first, $second) { + if ($first != $second) { + return false; + } + if (version_compare(phpversion(), '5') >= 0) { + return SimpleTestCompatibility::_isIdenticalType($first, $second); + } + return ($first === $second); + } + + /** + * Recursive type test. + * @param mixed $first Test subject. + * @param mixed $second Comparison object. + * @access private + * @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( + get_object_vars($first), + get_object_vars($second)); + } + if (is_array($first) && is_array($second)) { + return SimpleTestCompatibility::_isArrayOfIdenticalTypes($first, $second); + } + return true; + } + + /** + * Recursive type test for each element of an array. + * @param mixed $first Test subject. + * @param mixed $second Comparison object. + * @access private + * @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. + * @access public + * @static + */ + function isReference($first, $second) { + if (version_compare(phpversion(), '5', '>=') + && is_object($first)) { + return ($first === $second); + } + $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. + * @access public + * @static + */ + function isA($object, $class) { + if (version_compare(phpversion(), '5') >= 0) { + if (! class_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))); + } + + /** + * Autoload safe version of class_exists(). + * @param string $class Name of class to look for. + * @return boolean True if class is defined. + * @access public + * @static + */ + function classExists($class) { + if (version_compare(phpversion(), '5') >= 0) { + return class_exists($class, false); + } else { + return class_exists($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); + } + } + + /** + * Gets the current stack trace topmost first. + * @return array List of stack frames. + * @access public + * @static + */ + function getStackTrace() { + if (function_exists('debug_backtrace')) { + return array_reverse(debug_backtrace()); + } + return array(); + } + } +?> diff --git a/tests/UnitTests/simpletest/page.php b/tests/test_tools/simpletest/page.php index 03091d3e..843dedf5 100644 --- a/tests/UnitTests/simpletest/page.php +++ b/tests/test_tools/simpletest/page.php @@ -1,961 +1,961 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: page.php,v 1.105 2005/02/04 05:32:16 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/http.php');
- require_once(dirname(__FILE__) . '/parser.php');
- require_once(dirname(__FILE__) . '/tag.php');
- require_once(dirname(__FILE__) . '/form.php');
- /**#@-*/
-
- /**
- * SAX event handler. Maintains a list of
- * open tags and dispatches them as they close.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimplePageBuilder extends SimpleSaxListener {
- protected $_tags;
- protected $_page;
-
- /**
- * Sets the builder up empty.
- * @access public
- */
- function SimplePageBuilder() {
- $this->SimpleSaxListener();
- }
-
- /**
- * Reads the raw content and send events
- * into the page to be built.
- * @param $response SimpleHttpResponse Fetched response.
- * @return SimplePage Newly parsed page.
- * @access public
- */
- function parse($response) {
- $this->_tags = array();
- $this->_page = $this->_createPage($response);
- $parser = $this->_createParser($this);
- $parser->parse($response->getContent());
- $this->_page->acceptPageEnd();
- return $this->_page;
- }
-
- /**
- * Creates an empty page.
- * @return SimplePage New unparsed page.
- * @access protected
- */
- function _createPage($response) {
- return new SimplePage($response);
- }
-
- /**
- * Creates the parser used with the builder.
- * @param $listener SimpleSaxListener Target of parser.
- * @return SimpleSaxParser Parser to generate
- * events for the builder.
- * @access protected
- */
- function _createParser($listener) {
- return new SimpleSaxParser($listener);
- }
-
- /**
- * Make the keys lower case for case insensitive look-ups.
- * @param hash $map Hash to convert.
- * @return hash Unchanged values, but keys lower case.
- * @access private
- */
- function _keysToLowerCase($map) {
- $lower = array();
- foreach ($map as $key => $value) {
- $lower[strtolower($key)] = $value;
- }
- return $lower;
- }
-
- /**
- * Start of element event. Opens a new tag.
- * @param string $name Element name.
- * @param hash $attributes Attributes without content
- * are marked as true.
- * @return boolean False on parse error.
- * @access public
- */
- function startElement($name, $attributes) {
- $tag = $this->_createTag($name, $this->_keysToLowerCase($attributes));
- if ($name == 'form') {
- $this->_page->acceptFormStart($tag);
- return true;
- }
- if ($name == 'frameset') {
- $this->_page->acceptFramesetStart($tag);
- return true;
- }
- if ($name == 'frame') {
- $this->_page->acceptFrame($tag);
- return true;
- }
- if ($tag->expectEndTag()) {
- $this->_openTag($tag);
- return true;
- }
- $this->_page->acceptTag($tag);
- return true;
- }
-
- /**
- * End of element event.
- * @param string $name Element name.
- * @return boolean False on parse error.
- * @access public
- */
- function endElement($name) {
- if ($name == 'form') {
- $this->_page->acceptFormEnd();
- return true;
- }
- if ($name == 'frameset') {
- $this->_page->acceptFramesetEnd();
- return true;
- }
- if (isset($this->_tags[$name]) && (count($this->_tags[$name]) > 0)) {
- $tag = array_pop($this->_tags[$name]);
- $this->_addContentTagToOpenTags($tag);
- $this->_page->acceptTag($tag);
- return true;
- }
- return true;
- }
-
- /**
- * Unparsed, but relevant data. The data is added
- * to every open tag.
- * @param string $text May include unparsed tags.
- * @return boolean False on parse error.
- * @access public
- */
- function addContent($text) {
- foreach (array_keys($this->_tags) as $name) {
- for ($i = 0, $count = count($this->_tags[$name]); $i < $count; $i++) {
- $this->_tags[$name][$i]->addContent($text);
- }
- }
- return true;
- }
-
- /**
- * Parsed relevant data. The parsed tag is added
- * to every open tag.
- * @param SimpleTag $tag May include unparsed tags.
- * @access private
- */
- function _addContentTagToOpenTags($tag) {
- if ($tag->getTagName() != 'option') {
- return;
- }
- foreach (array_keys($this->_tags) as $name) {
- for ($i = 0, $count = count($this->_tags[$name]); $i < $count; $i++) {
- $this->_tags[$name][$i]->addTag($tag);
- }
- }
- }
-
- /**
- * Opens a tag for receiving content. Multiple tags
- * will be receiving input at the same time.
- * @param SimpleTag $tag New content tag.
- * @access private
- */
- function _openTag($tag) {
- $name = $tag->getTagName();
- if (! in_array($name, array_keys($this->_tags))) {
- $this->_tags[$name] = array();
- }
- array_push($this->_tags[$name], $tag);
- }
-
- /**
- * Factory for the tag objects. Creates the
- * appropriate tag object for the incoming tag name.
- * @param string $name HTML tag name.
- * @param hash $attributes Element attributes.
- * @return SimpleTag Tag object.
- * @access protected
- */
- function _createTag($name, $attributes) {
- if ($name == 'a') {
- return new SimpleAnchorTag($attributes);
- } elseif ($name == 'title') {
- return new SimpleTitleTag($attributes);
- } elseif ($name == 'input') {
- return $this->_createInputTag($attributes);
- } elseif ($name == 'button') {
- return new SimpleButtonTag($attributes);
- } elseif ($name == 'textarea') {
- return new SimpleTextAreaTag($attributes);
- } elseif ($name == 'select') {
- return $this->_createSelectionTag($attributes);
- } elseif ($name == 'option') {
- return new SimpleOptionTag($attributes);
- } elseif ($name == 'form') {
- return new SimpleFormTag($attributes);
- } elseif ($name == 'frame') {
- return new SimpleFrameTag($attributes);
- }
- return new SimpleTag($name, $attributes);
- }
-
- /**
- * Factory for selection fields.
- * @param hash $attributes Element attributes.
- * @return SimpleTag Tag object.
- * @access protected
- */
- function _createSelectionTag($attributes) {
- if (isset($attributes['multiple'])) {
- return new MultipleSelectionTag($attributes);
- }
- return new SimpleSelectionTag($attributes);
- }
-
- /**
- * Factory for input tags.
- * @param hash $attributes Element attributes.
- * @return SimpleTag Tag object.
- * @access protected
- */
- function _createInputTag($attributes) {
- if (! isset($attributes['type'])) {
- return new SimpleTextTag($attributes);
- }
- $type = strtolower($attributes['type']);
- if ($type == 'submit') {
- return new SimpleSubmitTag($attributes);
- } elseif ($type == 'image') {
- return new SimpleImageSubmitTag($attributes);
- } elseif ($type == 'checkbox') {
- return new SimpleCheckboxTag($attributes);
- } elseif ($type == 'radio') {
- return new SimpleRadioButtonTag($attributes);
- } else {
- return new SimpleTextTag($attributes);
- }
- }
- }
-
- /**
- * A wrapper for a web page.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimplePage {
- protected $_links;
- protected $_title;
- protected $_open_forms;
- protected $_complete_forms;
- protected $_frameset;
- protected $_frames;
- protected $_frameset_nesting_level;
- protected $_transport_error;
- protected $_raw;
- protected $_text;
- protected $_sent;
- protected $_headers;
- protected $_method;
- protected $_url;
- protected $_request_data;
-
- /**
- * Parses a page ready to access it's contents.
- * @param SimpleHttpResponse $response Result of HTTP fetch.
- * @access public
- */
- function SimplePage($response = false) {
- $this->_links = array();
- $this->_title = false;
- $this->_open_forms = array();
- $this->_complete_forms = array();
- $this->_frameset = false;
- $this->_frames = array();
- $this->_frameset_nesting_level = 0;
- $this->_text = false;
- if ($response) {
- $this->_extractResponse($response);
- } else {
- $this->_noResponse();
- }
- }
-
- /**
- * Extracts all of the response information.
- * @param SimpleHttpResponse $response Response being parsed.
- * @access private
- */
- 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
- */
- 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 = SimpleSaxParser::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;
- }
-
- /**
- * 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() {
- }
-
- /**
- * Adds a tag to the page.
- * @param SimpleTag $tag Tag to accept.
- * @access public
- */
- function acceptTag($tag) {
- if ($tag->getTagName() == "a") {
- $this->_addLink($tag);
- } elseif ($tag->getTagName() == "title") {
- $this->_setTitle($tag);
- } elseif ($this->_isFormElement($tag->getTagName())) {
- for ($i = 0; $i < count($this->_open_forms); $i++) {
- $this->_open_forms[$i]->addWidget($tag);
- }
- }
- }
-
- /**
- * Tests to see if a tag is a possible form
- * element.
- * @param string $name HTML element name.
- * @return boolean True if form element.
- * @access private
- */
- function _isFormElement($name) {
- return in_array($name, array('input', 'button', 'textarea', 'select'));
- }
-
- /**
- * Opens a form. New widgets go here.
- * @param SimpleFormTag $tag Tag to accept.
- * @access public
- */
- function acceptFormStart($tag) {
- $this->_open_forms[] = new SimpleForm($tag, $this->getUrl());
- }
-
- /**
- * Closes the most recently opened form.
- * @access public
- */
- function acceptFormEnd() {
- if (count($this->_open_forms)) {
- $this->_complete_forms[] = array_pop($this->_open_forms);
- }
- }
-
- /**
- * Opens a frameset. A frameset may contain nested
- * frameset tags.
- * @param SimpleFramesetTag $tag Tag to accept.
- * @access public
- */
- function acceptFramesetStart($tag) {
- if (! $this->_isLoadingFrames()) {
- $this->_frameset = $tag;
- }
- $this->_frameset_nesting_level++;
- }
-
- /**
- * Closes the most recently opened frameset.
- * @access public
- */
- function acceptFramesetEnd() {
- if ($this->_isLoadingFrames()) {
- $this->_frameset_nesting_level--;
- }
- }
-
- /**
- * Takes a single frame tag and stashes it in
- * the current frame set.
- * @param SimpleFrameTag $tag Tag to accept.
- * @access public
- */
- function acceptFrame($tag) {
- if ($this->_isLoadingFrames()) {
- if ($tag->getAttribute('src')) {
- $this->_frames[] = $tag;
- }
- }
- }
-
- /**
- * Test to see if in the middle of reading
- * a frameset.
- * @return boolean True if inframeset.
- * @access private
- */
- function _isLoadingFrames() {
- if (! $this->_frameset) {
- return false;
- }
- return ($this->_frameset_nesting_level > 0);
- }
-
- /**
- * Test to see if link is an absolute one.
- * @param string $url Url to test.
- * @return boolean True if absolute.
- * @access 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.
- * @access protected
- */
- function _addLink($tag) {
- $this->_links[] = $tag;
- }
-
- /**
- * Marker for end of complete page. Any work in
- * progress can now be closed.
- * @access public
- */
- function acceptPageEnd() {
- while (count($this->_open_forms)) {
- $this->_complete_forms[] = array_pop($this->_open_forms);
- }
- }
-
- /**
- * Test for the presence of a frameset.
- * @return boolean True if frameset.
- * @access public
- */
- function hasFrames() {
- return (boolean)$this->_frameset;
- }
-
- /**
- * 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->_frameset) {
- 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] = $url->makeAbsolute($this->getUrl());
- }
- return $urls;
- }
-
- /**
- * Fetches a list of loaded frames.
- * @return array/string Just the URL for a single page.
- * @access public
- */
- function getFrames() {
- $url = $this->getUrl();
- return $url->asString();
- }
-
- /**
- * Accessor for a list of all fixed links.
- * @return array List of urls with scheme of
- * http or https and hostname.
- * @access public
- */
- function getAbsoluteUrls() {
- $all = array();
- foreach ($this->_links as $link) {
- if ($this->_linkIsAbsolute($link->getHref())) {
- $all[] = $link->getHref();
- }
- }
- return $all;
- }
-
- /**
- * Accessor for a list of all relative links.
- * @return array List of urls without hostname.
- * @access public
- */
- function getRelativeUrls() {
- $all = array();
- foreach ($this->_links as $link) {
- if (! $this->_linkIsAbsolute($link->getHref())) {
- $all[] = $link->getHref();
- }
- }
- 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 into a target URL.
- * @param SimpleAnchor $link Parsed link.
- * @return SimpleUrl URL with frame target if any.
- * @access private
- */
- function _getUrlFromLink($link) {
- $url = $this->_makeAbsolute($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 protected
- */
- function _makeAbsolute($url) {
- if (! is_object($url)) {
- $url = new SimpleUrl($url);
- }
- return $url->makeAbsolute($this->getUrl());
- }
-
- /**
- * Sets the title tag contents.
- * @param SimpleTitleTag $tag Title of page.
- * @access protected
- */
- 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 string $label Button label, default 'Submit'.
- * @return SimpleForm Form object containing the button.
- * @access public
- */
- function getFormBySubmitLabel($label) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->hasSubmitLabel($label)) {
- return $this->_complete_forms[$i];
- }
- }
- return null;
- }
-
- /**
- * Finds a held form by button label. Will only
- * search correctly built forms.
- * @param string $name Button name attribute.
- * @return SimpleForm Form object containing the button.
- * @access public
- */
- function getFormBySubmitName($name) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->hasSubmitName($name)) {
- return $this->_complete_forms[$i];
- }
- }
- return null;
- }
-
- /**
- * Finds a held form by button id. Will only
- * search correctly built forms.
- * @param string $id Button ID attribute.
- * @return SimpleForm Form object containing the button.
- * @access public
- */
- function getFormBySubmitId($id) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->hasSubmitId($id)) {
- return $this->_complete_forms[$i];
- }
- }
- return null;
- }
-
- /**
- * Finds a held form by image label. Will only
- * search correctly built forms.
- * @param string $label Usually the alt attribute.
- * @return SimpleForm Form object containing the image.
- * @access public
- */
- function getFormByImageLabel($label) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->hasImageLabel($label)) {
- return $this->_complete_forms[$i];
- }
- }
- return null;
- }
-
- /**
- * Finds a held form by image button id. Will only
- * search correctly built forms.
- * @param string $name Image name.
- * @return SimpleForm Form object containing the image.
- * @access public
- */
- function getFormByImageName($name) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->hasImageName($name)) {
- return $this->_complete_forms[$i];
- }
- }
- return null;
- }
-
- /**
- * Finds a held form by image button id. Will only
- * search correctly built forms.
- * @param string $id Image ID attribute.
- * @return SimpleForm Form object containing the image.
- * @access public
- */
- function getFormByImageId($id) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->hasImageId($id)) {
- return $this->_complete_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->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->getId() == $id) {
- return $this->_complete_forms[$i];
- }
- }
- return null;
- }
-
- /**
- * Sets a field on each form in which the field is
- * available.
- * @param string $name Field name.
- * @param string $value Value to set field to.
- * @return boolean True if value is valid.
- * @access public
- */
- function setField($name, $value) {
- $is_set = false;
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->setField($name, $value)) {
- $is_set = true;
- }
- }
- return $is_set;
- }
-
- /**
- * Sets a field on the form in which the unique field is
- * available.
- * @param string/integer $id Field ID attribute.
- * @param string $value Value to set field to.
- * @return boolean True if value is valid.
- * @access public
- */
- function setFieldById($id, $value) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- if ($this->_complete_forms[$i]->setFieldById($id, $value)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Accessor for a form element value within a page.
- * Finds the first match.
- * @param string $name Field name.
- * @return string/boolean A string if the field is
- * present, false if unchecked
- * and null if missing.
- * @access public
- */
- function getField($name) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- $value = $this->_complete_forms[$i]->getValue($name);
- if (isset($value)) {
- return $value;
- }
- }
- return null;
- }
-
- /**
- * Accessor for a form element value within a page.
- * Finds the first match.
- * @param string/integer $id Field ID attribute.
- * @return string/boolean A string if the field is
- * present, false if unchecked
- * and null if missing.
- * @access public
- */
- function getFieldById($id) {
- for ($i = 0; $i < count($this->_complete_forms); $i++) {
- $value = $this->_complete_forms[$i]->getValueById($id);
- if (isset($value)) {
- return $value;
- }
- }
- return null;
- }
- }
-?>
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: page.php,v 1.105 2005/02/04 05:32:16 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/http.php'); + require_once(dirname(__FILE__) . '/parser.php'); + require_once(dirname(__FILE__) . '/tag.php'); + require_once(dirname(__FILE__) . '/form.php'); + /**#@-*/ + + /** + * SAX event handler. Maintains a list of + * open tags and dispatches them as they close. + * @package SimpleTest + * @subpackage WebTester + */ + class SimplePageBuilder extends SimpleSaxListener { + protected $_tags; + protected $_page; + + /** + * Sets the builder up empty. + * @access public + */ + function SimplePageBuilder() { + $this->SimpleSaxListener(); + } + + /** + * Reads the raw content and send events + * into the page to be built. + * @param $response SimpleHttpResponse Fetched response. + * @return SimplePage Newly parsed page. + * @access public + */ + function parse($response) { + $this->_tags = array(); + $this->_page = $this->_createPage($response); + $parser = $this->_createParser($this); + $parser->parse($response->getContent()); + $this->_page->acceptPageEnd(); + return $this->_page; + } + + /** + * Creates an empty page. + * @return SimplePage New unparsed page. + * @access protected + */ + function _createPage($response) { + return new SimplePage($response); + } + + /** + * Creates the parser used with the builder. + * @param $listener SimpleSaxListener Target of parser. + * @return SimpleSaxParser Parser to generate + * events for the builder. + * @access protected + */ + function _createParser($listener) { + return new SimpleSaxParser($listener); + } + + /** + * Make the keys lower case for case insensitive look-ups. + * @param hash $map Hash to convert. + * @return hash Unchanged values, but keys lower case. + * @access private + */ + function _keysToLowerCase($map) { + $lower = array(); + foreach ($map as $key => $value) { + $lower[strtolower($key)] = $value; + } + return $lower; + } + + /** + * Start of element event. Opens a new tag. + * @param string $name Element name. + * @param hash $attributes Attributes without content + * are marked as true. + * @return boolean False on parse error. + * @access public + */ + function startElement($name, $attributes) { + $tag = $this->_createTag($name, $this->_keysToLowerCase($attributes)); + if ($name == 'form') { + $this->_page->acceptFormStart($tag); + return true; + } + if ($name == 'frameset') { + $this->_page->acceptFramesetStart($tag); + return true; + } + if ($name == 'frame') { + $this->_page->acceptFrame($tag); + return true; + } + if ($tag->expectEndTag()) { + $this->_openTag($tag); + return true; + } + $this->_page->acceptTag($tag); + return true; + } + + /** + * End of element event. + * @param string $name Element name. + * @return boolean False on parse error. + * @access public + */ + function endElement($name) { + if ($name == 'form') { + $this->_page->acceptFormEnd(); + return true; + } + if ($name == 'frameset') { + $this->_page->acceptFramesetEnd(); + return true; + } + if (isset($this->_tags[$name]) && (count($this->_tags[$name]) > 0)) { + $tag = array_pop($this->_tags[$name]); + $this->_addContentTagToOpenTags($tag); + $this->_page->acceptTag($tag); + return true; + } + return true; + } + + /** + * Unparsed, but relevant data. The data is added + * to every open tag. + * @param string $text May include unparsed tags. + * @return boolean False on parse error. + * @access public + */ + function addContent($text) { + foreach (array_keys($this->_tags) as $name) { + for ($i = 0, $count = count($this->_tags[$name]); $i < $count; $i++) { + $this->_tags[$name][$i]->addContent($text); + } + } + return true; + } + + /** + * Parsed relevant data. The parsed tag is added + * to every open tag. + * @param SimpleTag $tag May include unparsed tags. + * @access private + */ + function _addContentTagToOpenTags($tag) { + if ($tag->getTagName() != 'option') { + return; + } + foreach (array_keys($this->_tags) as $name) { + for ($i = 0, $count = count($this->_tags[$name]); $i < $count; $i++) { + $this->_tags[$name][$i]->addTag($tag); + } + } + } + + /** + * Opens a tag for receiving content. Multiple tags + * will be receiving input at the same time. + * @param SimpleTag $tag New content tag. + * @access private + */ + function _openTag($tag) { + $name = $tag->getTagName(); + if (! in_array($name, array_keys($this->_tags))) { + $this->_tags[$name] = array(); + } + array_push($this->_tags[$name], $tag); + } + + /** + * Factory for the tag objects. Creates the + * appropriate tag object for the incoming tag name. + * @param string $name HTML tag name. + * @param hash $attributes Element attributes. + * @return SimpleTag Tag object. + * @access protected + */ + function _createTag($name, $attributes) { + if ($name == 'a') { + return new SimpleAnchorTag($attributes); + } elseif ($name == 'title') { + return new SimpleTitleTag($attributes); + } elseif ($name == 'input') { + return $this->_createInputTag($attributes); + } elseif ($name == 'button') { + return new SimpleButtonTag($attributes); + } elseif ($name == 'textarea') { + return new SimpleTextAreaTag($attributes); + } elseif ($name == 'select') { + return $this->_createSelectionTag($attributes); + } elseif ($name == 'option') { + return new SimpleOptionTag($attributes); + } elseif ($name == 'form') { + return new SimpleFormTag($attributes); + } elseif ($name == 'frame') { + return new SimpleFrameTag($attributes); + } + return new SimpleTag($name, $attributes); + } + + /** + * Factory for selection fields. + * @param hash $attributes Element attributes. + * @return SimpleTag Tag object. + * @access protected + */ + function _createSelectionTag($attributes) { + if (isset($attributes['multiple'])) { + return new MultipleSelectionTag($attributes); + } + return new SimpleSelectionTag($attributes); + } + + /** + * Factory for input tags. + * @param hash $attributes Element attributes. + * @return SimpleTag Tag object. + * @access protected + */ + function _createInputTag($attributes) { + if (! isset($attributes['type'])) { + return new SimpleTextTag($attributes); + } + $type = strtolower($attributes['type']); + if ($type == 'submit') { + return new SimpleSubmitTag($attributes); + } elseif ($type == 'image') { + return new SimpleImageSubmitTag($attributes); + } elseif ($type == 'checkbox') { + return new SimpleCheckboxTag($attributes); + } elseif ($type == 'radio') { + return new SimpleRadioButtonTag($attributes); + } else { + return new SimpleTextTag($attributes); + } + } + } + + /** + * A wrapper for a web page. + * @package SimpleTest + * @subpackage WebTester + */ + class SimplePage { + protected $_links; + protected $_title; + protected $_open_forms; + protected $_complete_forms; + protected $_frameset; + protected $_frames; + protected $_frameset_nesting_level; + protected $_transport_error; + protected $_raw; + protected $_text; + protected $_sent; + protected $_headers; + protected $_method; + protected $_url; + protected $_request_data; + + /** + * Parses a page ready to access it's contents. + * @param SimpleHttpResponse $response Result of HTTP fetch. + * @access public + */ + function SimplePage($response = false) { + $this->_links = array(); + $this->_title = false; + $this->_open_forms = array(); + $this->_complete_forms = array(); + $this->_frameset = false; + $this->_frames = array(); + $this->_frameset_nesting_level = 0; + $this->_text = false; + if ($response) { + $this->_extractResponse($response); + } else { + $this->_noResponse(); + } + } + + /** + * Extracts all of the response information. + * @param SimpleHttpResponse $response Response being parsed. + * @access private + */ + 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 + */ + 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 = SimpleSaxParser::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; + } + + /** + * 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() { + } + + /** + * Adds a tag to the page. + * @param SimpleTag $tag Tag to accept. + * @access public + */ + function acceptTag($tag) { + if ($tag->getTagName() == "a") { + $this->_addLink($tag); + } elseif ($tag->getTagName() == "title") { + $this->_setTitle($tag); + } elseif ($this->_isFormElement($tag->getTagName())) { + for ($i = 0; $i < count($this->_open_forms); $i++) { + $this->_open_forms[$i]->addWidget($tag); + } + } + } + + /** + * Tests to see if a tag is a possible form + * element. + * @param string $name HTML element name. + * @return boolean True if form element. + * @access private + */ + function _isFormElement($name) { + return in_array($name, array('input', 'button', 'textarea', 'select')); + } + + /** + * Opens a form. New widgets go here. + * @param SimpleFormTag $tag Tag to accept. + * @access public + */ + function acceptFormStart($tag) { + $this->_open_forms[] = new SimpleForm($tag, $this->getUrl()); + } + + /** + * Closes the most recently opened form. + * @access public + */ + function acceptFormEnd() { + if (count($this->_open_forms)) { + $this->_complete_forms[] = array_pop($this->_open_forms); + } + } + + /** + * Opens a frameset. A frameset may contain nested + * frameset tags. + * @param SimpleFramesetTag $tag Tag to accept. + * @access public + */ + function acceptFramesetStart($tag) { + if (! $this->_isLoadingFrames()) { + $this->_frameset = $tag; + } + $this->_frameset_nesting_level++; + } + + /** + * Closes the most recently opened frameset. + * @access public + */ + function acceptFramesetEnd() { + if ($this->_isLoadingFrames()) { + $this->_frameset_nesting_level--; + } + } + + /** + * Takes a single frame tag and stashes it in + * the current frame set. + * @param SimpleFrameTag $tag Tag to accept. + * @access public + */ + function acceptFrame($tag) { + if ($this->_isLoadingFrames()) { + if ($tag->getAttribute('src')) { + $this->_frames[] = $tag; + } + } + } + + /** + * Test to see if in the middle of reading + * a frameset. + * @return boolean True if inframeset. + * @access private + */ + function _isLoadingFrames() { + if (! $this->_frameset) { + return false; + } + return ($this->_frameset_nesting_level > 0); + } + + /** + * Test to see if link is an absolute one. + * @param string $url Url to test. + * @return boolean True if absolute. + * @access 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. + * @access protected + */ + function _addLink($tag) { + $this->_links[] = $tag; + } + + /** + * Marker for end of complete page. Any work in + * progress can now be closed. + * @access public + */ + function acceptPageEnd() { + while (count($this->_open_forms)) { + $this->_complete_forms[] = array_pop($this->_open_forms); + } + } + + /** + * Test for the presence of a frameset. + * @return boolean True if frameset. + * @access public + */ + function hasFrames() { + return (boolean)$this->_frameset; + } + + /** + * 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->_frameset) { + 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] = $url->makeAbsolute($this->getUrl()); + } + return $urls; + } + + /** + * Fetches a list of loaded frames. + * @return array/string Just the URL for a single page. + * @access public + */ + function getFrames() { + $url = $this->getUrl(); + return $url->asString(); + } + + /** + * Accessor for a list of all fixed links. + * @return array List of urls with scheme of + * http or https and hostname. + * @access public + */ + function getAbsoluteUrls() { + $all = array(); + foreach ($this->_links as $link) { + if ($this->_linkIsAbsolute($link->getHref())) { + $all[] = $link->getHref(); + } + } + return $all; + } + + /** + * Accessor for a list of all relative links. + * @return array List of urls without hostname. + * @access public + */ + function getRelativeUrls() { + $all = array(); + foreach ($this->_links as $link) { + if (! $this->_linkIsAbsolute($link->getHref())) { + $all[] = $link->getHref(); + } + } + 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 into a target URL. + * @param SimpleAnchor $link Parsed link. + * @return SimpleUrl URL with frame target if any. + * @access private + */ + function _getUrlFromLink($link) { + $url = $this->_makeAbsolute($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 protected + */ + function _makeAbsolute($url) { + if (! is_object($url)) { + $url = new SimpleUrl($url); + } + return $url->makeAbsolute($this->getUrl()); + } + + /** + * Sets the title tag contents. + * @param SimpleTitleTag $tag Title of page. + * @access protected + */ + 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 string $label Button label, default 'Submit'. + * @return SimpleForm Form object containing the button. + * @access public + */ + function getFormBySubmitLabel($label) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->hasSubmitLabel($label)) { + return $this->_complete_forms[$i]; + } + } + return null; + } + + /** + * Finds a held form by button label. Will only + * search correctly built forms. + * @param string $name Button name attribute. + * @return SimpleForm Form object containing the button. + * @access public + */ + function getFormBySubmitName($name) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->hasSubmitName($name)) { + return $this->_complete_forms[$i]; + } + } + return null; + } + + /** + * Finds a held form by button id. Will only + * search correctly built forms. + * @param string $id Button ID attribute. + * @return SimpleForm Form object containing the button. + * @access public + */ + function getFormBySubmitId($id) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->hasSubmitId($id)) { + return $this->_complete_forms[$i]; + } + } + return null; + } + + /** + * Finds a held form by image label. Will only + * search correctly built forms. + * @param string $label Usually the alt attribute. + * @return SimpleForm Form object containing the image. + * @access public + */ + function getFormByImageLabel($label) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->hasImageLabel($label)) { + return $this->_complete_forms[$i]; + } + } + return null; + } + + /** + * Finds a held form by image button id. Will only + * search correctly built forms. + * @param string $name Image name. + * @return SimpleForm Form object containing the image. + * @access public + */ + function getFormByImageName($name) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->hasImageName($name)) { + return $this->_complete_forms[$i]; + } + } + return null; + } + + /** + * Finds a held form by image button id. Will only + * search correctly built forms. + * @param string $id Image ID attribute. + * @return SimpleForm Form object containing the image. + * @access public + */ + function getFormByImageId($id) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->hasImageId($id)) { + return $this->_complete_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->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->getId() == $id) { + return $this->_complete_forms[$i]; + } + } + return null; + } + + /** + * Sets a field on each form in which the field is + * available. + * @param string $name Field name. + * @param string $value Value to set field to. + * @return boolean True if value is valid. + * @access public + */ + function setField($name, $value) { + $is_set = false; + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->setField($name, $value)) { + $is_set = true; + } + } + return $is_set; + } + + /** + * Sets a field on the form in which the unique field is + * available. + * @param string/integer $id Field ID attribute. + * @param string $value Value to set field to. + * @return boolean True if value is valid. + * @access public + */ + function setFieldById($id, $value) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + if ($this->_complete_forms[$i]->setFieldById($id, $value)) { + return true; + } + } + return false; + } + + /** + * Accessor for a form element value within a page. + * Finds the first match. + * @param string $name Field name. + * @return string/boolean A string if the field is + * present, false if unchecked + * and null if missing. + * @access public + */ + function getField($name) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + $value = $this->_complete_forms[$i]->getValue($name); + if (isset($value)) { + return $value; + } + } + return null; + } + + /** + * Accessor for a form element value within a page. + * Finds the first match. + * @param string/integer $id Field ID attribute. + * @return string/boolean A string if the field is + * present, false if unchecked + * and null if missing. + * @access public + */ + function getFieldById($id) { + for ($i = 0; $i < count($this->_complete_forms); $i++) { + $value = $this->_complete_forms[$i]->getValueById($id); + if (isset($value)) { + return $value; + } + } + return null; + } + } +?> diff --git a/tests/UnitTests/simpletest/parser.php b/tests/test_tools/simpletest/parser.php index cb9a3e75..7dc56a58 100644 --- a/tests/UnitTests/simpletest/parser.php +++ b/tests/test_tools/simpletest/parser.php @@ -1,750 +1,750 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage MockObjects
- * @version $Id: parser.php,v 1.66 2005/02/06 04:03:27 lastcraft Exp $
- */
-
- /**#@+
- * Lexer mode stack constants
- */
- define("LEXER_ENTER", 1);
- define("LEXER_MATCHED", 2);
- define("LEXER_UNMATCHED", 3);
- define("LEXER_EXIT", 4);
- define("LEXER_SPECIAL", 5);
- /**#@-*/
-
- /**
- * Compounded regular expression. Any of
- * the contained patterns could match and
- * when one does it's label is returned.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class ParallelRegex {
- protected $_patterns;
- protected $_labels;
- protected $_regex;
- protected $_case;
-
- /**
- * Constructor. Starts with no patterns.
- * @param boolean $case True for case sensitive, false
- * for insensitive.
- * @access public
- */
- function ParallelRegex($case) {
- $this->_case = $case;
- $this->_patterns = array();
- $this->_labels = array();
- $this->_regex = null;
- }
-
- /**
- * Adds a pattern with an optional label.
- * @param string $pattern Perl style regex, but ( and )
- * lose the usual meaning.
- * @param string $label Label of regex to be returned
- * on a match.
- * @access public
- */
- function addPattern($pattern, $label = true) {
- $count = count($this->_patterns);
- $this->_patterns[$count] = $pattern;
- $this->_labels[$count] = $label;
- $this->_regex = null;
- }
-
- /**
- * Attempts to match all patterns at once against
- * a string.
- * @param string $subject String to match against.
- * @param string $match First matched portion of
- * subject.
- * @return boolean True on success.
- * @access public
- */
- function match($subject, $match) {
- if (count($this->_patterns) == 0) {
- return false;
- }
- if (! preg_match($this->_getCompoundedRegex(), $subject, $matches)) {
- $match = '';
- return false;
- }
- $match = $matches[0];
- for ($i = 1; $i < count($matches); $i++) {
- if ($matches[$i]) {
- return $this->_labels[$i - 1];
- }
- }
- return true;
- }
-
- /**
- * Compounds the patterns into a single
- * regular expression separated with the
- * "or" operator. Caches the regex.
- * Will automatically escape (, ) and / tokens.
- * @param array $patterns List of patterns in order.
- * @access private
- */
- function _getCompoundedRegex() {
- if ($this->_regex == null) {
- for ($i = 0, $count = count($this->_patterns); $i < $count; $i++) {
- $this->_patterns[$i] = '(' . str_replace(
- array('/', '(', ')'),
- array('\/', '\(', '\)'),
- $this->_patterns[$i]) . ')';
- }
- $this->_regex = "/" . implode("|", $this->_patterns) . "/" . $this->_getPerlMatchingFlags();
- }
- return $this->_regex;
- }
-
- /**
- * Accessor for perl regex mode flags to use.
- * @return string Perl regex flags.
- * @access private
- */
- function _getPerlMatchingFlags() {
- return ($this->_case ? "msS" : "msSi");
- }
- }
-
- /**
- * States for a stack machine.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleStateStack {
- protected $_stack;
-
- /**
- * Constructor. Starts in named state.
- * @param string $start Starting state name.
- * @access public
- */
- function SimpleStateStack($start) {
- $this->_stack = array($start);
- }
-
- /**
- * Accessor for current state.
- * @return string State.
- * @access public
- */
- function getCurrent() {
- return $this->_stack[count($this->_stack) - 1];
- }
-
- /**
- * Adds a state to the stack and sets it
- * to be the current state.
- * @param string $state New state.
- * @access public
- */
- function enter($state) {
- array_push($this->_stack, $state);
- }
-
- /**
- * Leaves the current state and reverts
- * to the previous one.
- * @return boolean False if we drop off
- * the bottom of the list.
- * @access public
- */
- function leave() {
- if (count($this->_stack) == 1) {
- return false;
- }
- array_pop($this->_stack);
- return true;
- }
- }
-
- /**
- * Accepts text and breaks it into tokens.
- * Some optimisation to make the sure the
- * content is only scanned by the PHP regex
- * parser once. Lexer modes must not start
- * with leading underscores.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleLexer {
- protected $_regexes;
- protected $_parser;
- protected $_mode;
- protected $_mode_handlers;
- protected $_case;
-
- /**
- * Sets up the lexer in case insensitive matching
- * by default.
- * @param SimpleSaxParser $parser Handling strategy by
- * reference.
- * @param string $start Starting handler.
- * @param boolean $case True for case sensitive.
- * @access public
- */
- function SimpleLexer($parser, $start = "accept", $case = false) {
- $this->_case = $case;
- $this->_regexes = array();
- $this->_parser = $parser;
- $this->_mode = new SimpleStateStack($start);
- $this->_mode_handlers = array($start => $start);
- }
-
- /**
- * Adds a token search pattern for a particular
- * parsing mode. The pattern does not change the
- * current mode.
- * @param string $pattern Perl style regex, but ( and )
- * lose the usual meaning.
- * @param string $mode Should only apply this
- * pattern when dealing with
- * this type of input.
- * @access public
- */
- function addPattern($pattern, $mode = "accept") {
- if (! isset($this->_regexes[$mode])) {
- $this->_regexes[$mode] = new ParallelRegex($this->_case);
- }
- $this->_regexes[$mode]->addPattern($pattern);
- if (! isset($this->_mode_handlers[$mode])) {
- $this->_mode_handlers[$mode] = $mode;
- }
- }
-
- /**
- * Adds a pattern that will enter a new parsing
- * mode. Useful for entering parenthesis, strings,
- * tags, etc.
- * @param string $pattern Perl style regex, but ( and )
- * lose the usual meaning.
- * @param string $mode Should only apply this
- * pattern when dealing with
- * this type of input.
- * @param string $new_mode Change parsing to this new
- * nested mode.
- * @access public
- */
- function addEntryPattern($pattern, $mode, $new_mode) {
- if (! isset($this->_regexes[$mode])) {
- $this->_regexes[$mode] = new ParallelRegex($this->_case);
- }
- $this->_regexes[$mode]->addPattern($pattern, $new_mode);
- if (! isset($this->_mode_handlers[$new_mode])) {
- $this->_mode_handlers[$new_mode] = $new_mode;
- }
- }
-
- /**
- * Adds a pattern that will exit the current mode
- * and re-enter the previous one.
- * @param string $pattern Perl style regex, but ( and )
- * lose the usual meaning.
- * @param string $mode Mode to leave.
- * @access public
- */
- function addExitPattern($pattern, $mode) {
- if (! isset($this->_regexes[$mode])) {
- $this->_regexes[$mode] = new ParallelRegex($this->_case);
- }
- $this->_regexes[$mode]->addPattern($pattern, "__exit");
- if (! isset($this->_mode_handlers[$mode])) {
- $this->_mode_handlers[$mode] = $mode;
- }
- }
-
- /**
- * Adds a pattern that has a special mode. Acts as an entry
- * and exit pattern in one go, effectively calling a special
- * parser handler for this token only.
- * @param string $pattern Perl style regex, but ( and )
- * lose the usual meaning.
- * @param string $mode Should only apply this
- * pattern when dealing with
- * this type of input.
- * @param string $special Use this mode for this one token.
- * @access public
- */
- function addSpecialPattern($pattern, $mode, $special) {
- if (! isset($this->_regexes[$mode])) {
- $this->_regexes[$mode] = new ParallelRegex($this->_case);
- }
- $this->_regexes[$mode]->addPattern($pattern, "_$special");
- if (! isset($this->_mode_handlers[$special])) {
- $this->_mode_handlers[$special] = $special;
- }
- }
-
- /**
- * Adds a mapping from a mode to another handler.
- * @param string $mode Mode to be remapped.
- * @param string $handler New target handler.
- * @access public
- */
- function mapHandler($mode, $handler) {
- $this->_mode_handlers[$mode] = $handler;
- }
-
- /**
- * Splits the page text into tokens. Will fail
- * if the handlers report an error or if no
- * content is consumed. If successful then each
- * unparsed and parsed token invokes a call to the
- * held listener.
- * @param string $raw Raw HTML text.
- * @return boolean True on success, else false.
- * @access public
- */
- function parse($raw) {
- if (! isset($this->_parser)) {
- return false;
- }
- $length = strlen($raw);
- while (is_array($parsed = $this->_reduce($raw))) {
- list($raw, $unmatched, $matched, $mode) = $parsed;
- if (! $this->_dispatchTokens($unmatched, $matched, $mode)) {
- return false;
- }
- if ($raw === '') {
- return true;
- }
- if (strlen($raw) == $length) {
- return false;
- }
- $length = strlen($raw);
- }
- if (! $parsed) {
- return false;
- }
- return $this->_invokeParser($raw, LEXER_UNMATCHED);
- }
-
- /**
- * Sends the matched token and any leading unmatched
- * text to the parser changing the lexer to a new
- * mode if one is listed.
- * @param string $unmatched Unmatched leading portion.
- * @param string $matched Actual token match.
- * @param string $mode Mode after match. A boolean
- * false mode causes no change.
- * @return boolean False if there was any error
- * from the parser.
- * @access private
- */
- function _dispatchTokens($unmatched, $matched, $mode = false) {
- if (! $this->_invokeParser($unmatched, LEXER_UNMATCHED)) {
- return false;
- }
- if (is_bool($mode)) {
- return $this->_invokeParser($matched, LEXER_MATCHED);
- }
- if ($this->_isModeEnd($mode)) {
- if (! $this->_invokeParser($matched, LEXER_EXIT)) {
- return false;
- }
- return $this->_mode->leave();
- }
- if ($this->_isSpecialMode($mode)) {
- $this->_mode->enter($this->_decodeSpecial($mode));
- if (! $this->_invokeParser($matched, LEXER_SPECIAL)) {
- return false;
- }
- return $this->_mode->leave();
- }
- $this->_mode->enter($mode);
- return $this->_invokeParser($matched, LEXER_ENTER);
- }
-
- /**
- * Tests to see if the new mode is actually to leave
- * the current mode and pop an item from the matching
- * mode stack.
- * @param string $mode Mode to test.
- * @return boolean True if this is the exit mode.
- * @access private
- */
- function _isModeEnd($mode) {
- return ($mode === "__exit");
- }
-
- /**
- * Test to see if the mode is one where this mode
- * is entered for this token only and automatically
- * leaves immediately afterwoods.
- * @param string $mode Mode to test.
- * @return boolean True if this is the exit mode.
- * @access private
- */
- function _isSpecialMode($mode) {
- return (strncmp($mode, "_", 1) == 0);
- }
-
- /**
- * Strips the magic underscore marking single token
- * modes.
- * @param string $mode Mode to decode.
- * @return string Underlying mode name.
- * @access private
- */
- function _decodeSpecial($mode) {
- return substr($mode, 1);
- }
-
- /**
- * Calls the parser method named after the current
- * mode. Empty content will be ignored. The lexer
- * has a parser handler for each mode in the lexer.
- * @param string $content Text parsed.
- * @param boolean $is_match Token is recognised rather
- * than unparsed data.
- * @access private
- */
- function _invokeParser($content, $is_match) {
- if (($content === '') || ($content === false)) {
- return true;
- }
- $handler = $this->_mode_handlers[$this->_mode->getCurrent()];
- return $this->_parser->$handler($content, $is_match);
- }
-
- /**
- * Tries to match a chunk of text and if successful
- * removes the recognised chunk and any leading
- * unparsed data. Empty strings will not be matched.
- * @param string $raw The subject to parse. This is the
- * content that will be eaten.
- * @return array/boolean Three item list of unparsed
- * content followed by the
- * recognised token and finally the
- * action the parser is to take.
- * True if no match, false if there
- * is a parsing error.
- * @access private
- */
- function _reduce($raw) {
- if ($action = $this->_regexes[$this->_mode->getCurrent()]->match($raw, $match)) {
- $unparsed_character_count = strpos($raw, $match);
- $unparsed = substr($raw, 0, $unparsed_character_count);
- $raw = substr($raw, $unparsed_character_count + strlen($match));
- return array($raw, $unparsed, $match, $action);
- }
- return true;
- }
- }
-
- /**
- * Converts HTML tokens into selected SAX events.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleSaxParser {
- protected $_lexer;
- protected $_listener;
- protected $_tag;
- protected $_attributes;
- protected $_current_attribute;
-
- /**
- * Sets the listener.
- * @param SimpleSaxListener $listener SAX event handler.
- * @access public
- */
- function SimpleSaxParser($listener) {
- $this->_listener = $listener;
- $this->_lexer = $this->createLexer($this);
- $this->_tag = '';
- $this->_attributes = array();
- $this->_current_attribute = '';
- }
-
- /**
- * Runs the content through the lexer which
- * should call back to the acceptors.
- * @param string $raw Page text to parse.
- * @return boolean False if parse error.
- * @access public
- */
- function parse($raw) {
- return $this->_lexer->parse($raw);
- }
-
- /**
- * Sets up the matching lexer. Starts in 'text' mode.
- * @param SimpleSaxParser $parser Event generator, usually $self.
- * @return SimpleLexer Lexer suitable for this parser.
- * @access public
- * @static
- */
- function createLexer($parser) {
- $lexer = new SimpleLexer($parser, 'text');
- $lexer->mapHandler('text', 'acceptTextToken');
- SimpleSaxParser::_addSkipping($lexer);
- foreach (SimpleSaxParser::_getParsedTags() as $tag) {
- SimpleSaxParser::_addTag($lexer, $tag);
- }
- SimpleSaxParser::_addInTagTokens($lexer);
- return $lexer;
- }
-
- /**
- * List of parsed tags. Others are ignored.
- * @return array List of searched for tags.
- * @access private
- */
- function _getParsedTags() {
- return array('a', 'title', 'form', 'input', 'button', 'textarea', 'select',
- 'option', 'frameset', 'frame');
- }
-
- /**
- * The lexer has to skip certain sections such
- * as server code, client code and styles.
- * @param SimpleLexer $lexer Lexer to add patterns to.
- * @access private
- * @static
- */
- function _addSkipping($lexer) {
- $lexer->mapHandler('css', 'ignore');
- $lexer->addEntryPattern('<style', 'text', 'css');
- $lexer->addExitPattern('</style>', 'css');
- $lexer->mapHandler('js', 'ignore');
- $lexer->addEntryPattern('<script', 'text', 'js');
- $lexer->addExitPattern('</script>', 'js');
- $lexer->mapHandler('comment', 'ignore');
- $lexer->addEntryPattern('<!--', 'text', 'comment');
- $lexer->addExitPattern('-->', 'comment');
- }
-
- /**
- * Pattern matches to start and end a tag.
- * @param SimpleLexer $lexer Lexer to add patterns to.
- * @param string $tag Name of tag to scan for.
- * @access private
- * @static
- */
- function _addTag($lexer, $tag) {
- $lexer->addSpecialPattern("</$tag>", 'text', 'acceptEndToken');
- $lexer->addEntryPattern("<$tag", 'text', 'tag');
- }
-
- /**
- * Pattern matches to parse the inside of a tag
- * including the attributes and their quoting.
- * @param SimpleLexer $lexer Lexer to add patterns to.
- * @access private
- * @static
- */
- function _addInTagTokens($lexer) {
- $lexer->mapHandler('tag', 'acceptStartToken');
- $lexer->addSpecialPattern('\s+', 'tag', 'ignore');
- SimpleSaxParser::_addAttributeTokens($lexer);
- $lexer->addExitPattern('>', 'tag');
- }
-
- /**
- * Matches attributes that are either single quoted,
- * double quoted or unquoted.
- * @param SimpleLexer $lexer Lexer to add patterns to.
- * @access private
- * @static
- */
- function _addAttributeTokens($lexer) {
- $lexer->mapHandler('dq_attribute', 'acceptAttributeToken');
- $lexer->addEntryPattern('=\s*"', 'tag', 'dq_attribute');
- $lexer->addPattern("\\\\\"", 'dq_attribute');
- $lexer->addExitPattern('"', 'dq_attribute');
- $lexer->mapHandler('sq_attribute', 'acceptAttributeToken');
- $lexer->addEntryPattern("=\s*'", 'tag', 'sq_attribute');
- $lexer->addPattern("\\\\'", 'sq_attribute');
- $lexer->addExitPattern("'", 'sq_attribute');
- $lexer->mapHandler('uq_attribute', 'acceptAttributeToken');
- $lexer->addSpecialPattern('=\s*[^>\s]*', 'tag', 'uq_attribute');
- }
-
- /**
- * Accepts a token from the tag mode. If the
- * starting element completes then the element
- * is dispatched and the current attributes
- * set back to empty. The element or attribute
- * name is converted to lower case.
- * @param string $token Incoming characters.
- * @param integer $event Lexer event type.
- * @return boolean False if parse error.
- * @access public
- */
- function acceptStartToken($token, $event) {
- if ($event == LEXER_ENTER) {
- $this->_tag = strtolower(substr($token, 1));
- return true;
- }
- if ($event == LEXER_EXIT) {
- $success = $this->_listener->startElement(
- $this->_tag,
- $this->_attributes);
- $this->_tag = "";
- $this->_attributes = array();
- return $success;
- }
- if ($token != "=") {
- $this->_current_attribute = strtolower(SimpleSaxParser::decodeHtml($token));
- $this->_attributes[$this->_current_attribute] = "";
- }
- return true;
- }
-
- /**
- * Accepts a token from the end tag mode.
- * The element name is converted to lower case.
- * @param string $token Incoming characters.
- * @param integer $event Lexer event type.
- * @return boolean False if parse error.
- * @access public
- */
- function acceptEndToken($token, $event) {
- if (! preg_match('/<\/(.*)>/', $token, $matches)) {
- return false;
- }
- return $this->_listener->endElement(strtolower($matches[1]));
- }
-
- /**
- * Part of the tag data.
- * @param string $token Incoming characters.
- * @param integer $event Lexer event type.
- * @return boolean False if parse error.
- * @access public
- */
- function acceptAttributeToken($token, $event) {
- if ($event == LEXER_UNMATCHED) {
- $this->_attributes[$this->_current_attribute] .=
- SimpleSaxParser::decodeHtml($token);
- }
- if ($event == LEXER_SPECIAL) {
- $this->_attributes[$this->_current_attribute] .=
- preg_replace('/^=\s*/' , '', SimpleSaxParser::decodeHtml($token));
- }
- return true;
- }
-
- /**
- * A character entity.
- * @param string $token Incoming characters.
- * @param integer $event Lexer event type.
- * @return boolean False if parse error.
- * @access public
- */
- function acceptEntityToken($token, $event) {
- }
-
- /**
- * Character data between tags regarded as
- * important.
- * @param string $token Incoming characters.
- * @param integer $event Lexer event type.
- * @return boolean False if parse error.
- * @access public
- */
- function acceptTextToken($token, $event) {
- return $this->_listener->addContent($token);
- }
-
- /**
- * Incoming data to be ignored.
- * @param string $token Incoming characters.
- * @param integer $event Lexer event type.
- * @return boolean False if parse error.
- * @access public
- */
- function ignore($token, $event) {
- return true;
- }
-
- /**
- * Decodes any HTML entities.
- * @param string $html Incoming HTML.
- * @return string Outgoing plain text.
- * @access public
- * @static
- */
- function decodeHtml($html) {
- static $translations;
- if (! isset($translations)) {
- $translations = array_flip(get_html_translation_table(HTML_ENTITIES));
- }
- return strtr($html, $translations);
- }
-
- /**
- * 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('|<img.*?alt\s*=\s*"(.*?)".*?>|', ' \1 ', $html);
- $text = preg_replace('|<img.*?alt\s*=\s*\'(.*?)\'.*?>|', ' \1 ', $text);
- $text = preg_replace('|<img.*?alt\s*=\s*([a-zA-Z_]+).*?>|', ' \1 ', $text);
- $text = preg_replace('|<.*?>|', '', $text);
- $text = SimpleSaxParser::decodeHtml($text);
- $text = preg_replace('|\s+|', ' ', $text);
- return trim($text);
- }
- }
-
- /**
- * SAX event handler.
- * @package SimpleTest
- * @subpackage WebTester
- * @abstract
- */
- class SimpleSaxListener {
-
- /**
- * Sets the document to write to.
- * @access public
- */
- function SimpleSaxListener() {
- }
-
- /**
- * Start of element event.
- * @param string $name Element name.
- * @param hash $attributes Name value pairs.
- * Attributes without content
- * are marked as true.
- * @return boolean False on parse error.
- * @access public
- */
- function startElement($name, $attributes) {
- }
-
- /**
- * End of element event.
- * @param string $name Element name.
- * @return boolean False on parse error.
- * @access public
- */
- function endElement($name) {
- }
-
- /**
- * Unparsed, but relevant data.
- * @param string $text May include unparsed tags.
- * @return boolean False on parse error.
- * @access public
- */
- function addContent($text) {
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage MockObjects + * @version $Id: parser.php,v 1.66 2005/02/06 04:03:27 lastcraft Exp $ + */ + + /**#@+ + * Lexer mode stack constants + */ + define("LEXER_ENTER", 1); + define("LEXER_MATCHED", 2); + define("LEXER_UNMATCHED", 3); + define("LEXER_EXIT", 4); + define("LEXER_SPECIAL", 5); + /**#@-*/ + + /** + * Compounded regular expression. Any of + * the contained patterns could match and + * when one does it's label is returned. + * @package SimpleTest + * @subpackage WebTester + */ + class ParallelRegex { + protected $_patterns; + protected $_labels; + protected $_regex; + protected $_case; + + /** + * Constructor. Starts with no patterns. + * @param boolean $case True for case sensitive, false + * for insensitive. + * @access public + */ + function ParallelRegex($case) { + $this->_case = $case; + $this->_patterns = array(); + $this->_labels = array(); + $this->_regex = null; + } + + /** + * Adds a pattern with an optional label. + * @param string $pattern Perl style regex, but ( and ) + * lose the usual meaning. + * @param string $label Label of regex to be returned + * on a match. + * @access public + */ + function addPattern($pattern, $label = true) { + $count = count($this->_patterns); + $this->_patterns[$count] = $pattern; + $this->_labels[$count] = $label; + $this->_regex = null; + } + + /** + * Attempts to match all patterns at once against + * a string. + * @param string $subject String to match against. + * @param string $match First matched portion of + * subject. + * @return boolean True on success. + * @access public + */ + function match($subject, $match) { + if (count($this->_patterns) == 0) { + return false; + } + if (! preg_match($this->_getCompoundedRegex(), $subject, $matches)) { + $match = ''; + return false; + } + $match = $matches[0]; + for ($i = 1; $i < count($matches); $i++) { + if ($matches[$i]) { + return $this->_labels[$i - 1]; + } + } + return true; + } + + /** + * Compounds the patterns into a single + * regular expression separated with the + * "or" operator. Caches the regex. + * Will automatically escape (, ) and / tokens. + * @param array $patterns List of patterns in order. + * @access private + */ + function _getCompoundedRegex() { + if ($this->_regex == null) { + for ($i = 0, $count = count($this->_patterns); $i < $count; $i++) { + $this->_patterns[$i] = '(' . str_replace( + array('/', '(', ')'), + array('\/', '\(', '\)'), + $this->_patterns[$i]) . ')'; + } + $this->_regex = "/" . implode("|", $this->_patterns) . "/" . $this->_getPerlMatchingFlags(); + } + return $this->_regex; + } + + /** + * Accessor for perl regex mode flags to use. + * @return string Perl regex flags. + * @access private + */ + function _getPerlMatchingFlags() { + return ($this->_case ? "msS" : "msSi"); + } + } + + /** + * States for a stack machine. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleStateStack { + protected $_stack; + + /** + * Constructor. Starts in named state. + * @param string $start Starting state name. + * @access public + */ + function SimpleStateStack($start) { + $this->_stack = array($start); + } + + /** + * Accessor for current state. + * @return string State. + * @access public + */ + function getCurrent() { + return $this->_stack[count($this->_stack) - 1]; + } + + /** + * Adds a state to the stack and sets it + * to be the current state. + * @param string $state New state. + * @access public + */ + function enter($state) { + array_push($this->_stack, $state); + } + + /** + * Leaves the current state and reverts + * to the previous one. + * @return boolean False if we drop off + * the bottom of the list. + * @access public + */ + function leave() { + if (count($this->_stack) == 1) { + return false; + } + array_pop($this->_stack); + return true; + } + } + + /** + * Accepts text and breaks it into tokens. + * Some optimisation to make the sure the + * content is only scanned by the PHP regex + * parser once. Lexer modes must not start + * with leading underscores. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleLexer { + protected $_regexes; + protected $_parser; + protected $_mode; + protected $_mode_handlers; + protected $_case; + + /** + * Sets up the lexer in case insensitive matching + * by default. + * @param SimpleSaxParser $parser Handling strategy by + * reference. + * @param string $start Starting handler. + * @param boolean $case True for case sensitive. + * @access public + */ + function SimpleLexer($parser, $start = "accept", $case = false) { + $this->_case = $case; + $this->_regexes = array(); + $this->_parser = $parser; + $this->_mode = new SimpleStateStack($start); + $this->_mode_handlers = array($start => $start); + } + + /** + * Adds a token search pattern for a particular + * parsing mode. The pattern does not change the + * current mode. + * @param string $pattern Perl style regex, but ( and ) + * lose the usual meaning. + * @param string $mode Should only apply this + * pattern when dealing with + * this type of input. + * @access public + */ + function addPattern($pattern, $mode = "accept") { + if (! isset($this->_regexes[$mode])) { + $this->_regexes[$mode] = new ParallelRegex($this->_case); + } + $this->_regexes[$mode]->addPattern($pattern); + if (! isset($this->_mode_handlers[$mode])) { + $this->_mode_handlers[$mode] = $mode; + } + } + + /** + * Adds a pattern that will enter a new parsing + * mode. Useful for entering parenthesis, strings, + * tags, etc. + * @param string $pattern Perl style regex, but ( and ) + * lose the usual meaning. + * @param string $mode Should only apply this + * pattern when dealing with + * this type of input. + * @param string $new_mode Change parsing to this new + * nested mode. + * @access public + */ + function addEntryPattern($pattern, $mode, $new_mode) { + if (! isset($this->_regexes[$mode])) { + $this->_regexes[$mode] = new ParallelRegex($this->_case); + } + $this->_regexes[$mode]->addPattern($pattern, $new_mode); + if (! isset($this->_mode_handlers[$new_mode])) { + $this->_mode_handlers[$new_mode] = $new_mode; + } + } + + /** + * Adds a pattern that will exit the current mode + * and re-enter the previous one. + * @param string $pattern Perl style regex, but ( and ) + * lose the usual meaning. + * @param string $mode Mode to leave. + * @access public + */ + function addExitPattern($pattern, $mode) { + if (! isset($this->_regexes[$mode])) { + $this->_regexes[$mode] = new ParallelRegex($this->_case); + } + $this->_regexes[$mode]->addPattern($pattern, "__exit"); + if (! isset($this->_mode_handlers[$mode])) { + $this->_mode_handlers[$mode] = $mode; + } + } + + /** + * Adds a pattern that has a special mode. Acts as an entry + * and exit pattern in one go, effectively calling a special + * parser handler for this token only. + * @param string $pattern Perl style regex, but ( and ) + * lose the usual meaning. + * @param string $mode Should only apply this + * pattern when dealing with + * this type of input. + * @param string $special Use this mode for this one token. + * @access public + */ + function addSpecialPattern($pattern, $mode, $special) { + if (! isset($this->_regexes[$mode])) { + $this->_regexes[$mode] = new ParallelRegex($this->_case); + } + $this->_regexes[$mode]->addPattern($pattern, "_$special"); + if (! isset($this->_mode_handlers[$special])) { + $this->_mode_handlers[$special] = $special; + } + } + + /** + * Adds a mapping from a mode to another handler. + * @param string $mode Mode to be remapped. + * @param string $handler New target handler. + * @access public + */ + function mapHandler($mode, $handler) { + $this->_mode_handlers[$mode] = $handler; + } + + /** + * Splits the page text into tokens. Will fail + * if the handlers report an error or if no + * content is consumed. If successful then each + * unparsed and parsed token invokes a call to the + * held listener. + * @param string $raw Raw HTML text. + * @return boolean True on success, else false. + * @access public + */ + function parse($raw) { + if (! isset($this->_parser)) { + return false; + } + $length = strlen($raw); + while (is_array($parsed = $this->_reduce($raw))) { + list($raw, $unmatched, $matched, $mode) = $parsed; + if (! $this->_dispatchTokens($unmatched, $matched, $mode)) { + return false; + } + if ($raw === '') { + return true; + } + if (strlen($raw) == $length) { + return false; + } + $length = strlen($raw); + } + if (! $parsed) { + return false; + } + return $this->_invokeParser($raw, LEXER_UNMATCHED); + } + + /** + * Sends the matched token and any leading unmatched + * text to the parser changing the lexer to a new + * mode if one is listed. + * @param string $unmatched Unmatched leading portion. + * @param string $matched Actual token match. + * @param string $mode Mode after match. A boolean + * false mode causes no change. + * @return boolean False if there was any error + * from the parser. + * @access private + */ + function _dispatchTokens($unmatched, $matched, $mode = false) { + if (! $this->_invokeParser($unmatched, LEXER_UNMATCHED)) { + return false; + } + if (is_bool($mode)) { + return $this->_invokeParser($matched, LEXER_MATCHED); + } + if ($this->_isModeEnd($mode)) { + if (! $this->_invokeParser($matched, LEXER_EXIT)) { + return false; + } + return $this->_mode->leave(); + } + if ($this->_isSpecialMode($mode)) { + $this->_mode->enter($this->_decodeSpecial($mode)); + if (! $this->_invokeParser($matched, LEXER_SPECIAL)) { + return false; + } + return $this->_mode->leave(); + } + $this->_mode->enter($mode); + return $this->_invokeParser($matched, LEXER_ENTER); + } + + /** + * Tests to see if the new mode is actually to leave + * the current mode and pop an item from the matching + * mode stack. + * @param string $mode Mode to test. + * @return boolean True if this is the exit mode. + * @access private + */ + function _isModeEnd($mode) { + return ($mode === "__exit"); + } + + /** + * Test to see if the mode is one where this mode + * is entered for this token only and automatically + * leaves immediately afterwoods. + * @param string $mode Mode to test. + * @return boolean True if this is the exit mode. + * @access private + */ + function _isSpecialMode($mode) { + return (strncmp($mode, "_", 1) == 0); + } + + /** + * Strips the magic underscore marking single token + * modes. + * @param string $mode Mode to decode. + * @return string Underlying mode name. + * @access private + */ + function _decodeSpecial($mode) { + return substr($mode, 1); + } + + /** + * Calls the parser method named after the current + * mode. Empty content will be ignored. The lexer + * has a parser handler for each mode in the lexer. + * @param string $content Text parsed. + * @param boolean $is_match Token is recognised rather + * than unparsed data. + * @access private + */ + function _invokeParser($content, $is_match) { + if (($content === '') || ($content === false)) { + return true; + } + $handler = $this->_mode_handlers[$this->_mode->getCurrent()]; + return $this->_parser->$handler($content, $is_match); + } + + /** + * Tries to match a chunk of text and if successful + * removes the recognised chunk and any leading + * unparsed data. Empty strings will not be matched. + * @param string $raw The subject to parse. This is the + * content that will be eaten. + * @return array/boolean Three item list of unparsed + * content followed by the + * recognised token and finally the + * action the parser is to take. + * True if no match, false if there + * is a parsing error. + * @access private + */ + function _reduce($raw) { + if ($action = $this->_regexes[$this->_mode->getCurrent()]->match($raw, $match)) { + $unparsed_character_count = strpos($raw, $match); + $unparsed = substr($raw, 0, $unparsed_character_count); + $raw = substr($raw, $unparsed_character_count + strlen($match)); + return array($raw, $unparsed, $match, $action); + } + return true; + } + } + + /** + * Converts HTML tokens into selected SAX events. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleSaxParser { + protected $_lexer; + protected $_listener; + protected $_tag; + protected $_attributes; + protected $_current_attribute; + + /** + * Sets the listener. + * @param SimpleSaxListener $listener SAX event handler. + * @access public + */ + function SimpleSaxParser($listener) { + $this->_listener = $listener; + $this->_lexer = $this->createLexer($this); + $this->_tag = ''; + $this->_attributes = array(); + $this->_current_attribute = ''; + } + + /** + * Runs the content through the lexer which + * should call back to the acceptors. + * @param string $raw Page text to parse. + * @return boolean False if parse error. + * @access public + */ + function parse($raw) { + return $this->_lexer->parse($raw); + } + + /** + * Sets up the matching lexer. Starts in 'text' mode. + * @param SimpleSaxParser $parser Event generator, usually $self. + * @return SimpleLexer Lexer suitable for this parser. + * @access public + * @static + */ + function createLexer($parser) { + $lexer = new SimpleLexer($parser, 'text'); + $lexer->mapHandler('text', 'acceptTextToken'); + SimpleSaxParser::_addSkipping($lexer); + foreach (SimpleSaxParser::_getParsedTags() as $tag) { + SimpleSaxParser::_addTag($lexer, $tag); + } + SimpleSaxParser::_addInTagTokens($lexer); + return $lexer; + } + + /** + * List of parsed tags. Others are ignored. + * @return array List of searched for tags. + * @access private + */ + function _getParsedTags() { + return array('a', 'title', 'form', 'input', 'button', 'textarea', 'select', + 'option', 'frameset', 'frame'); + } + + /** + * The lexer has to skip certain sections such + * as server code, client code and styles. + * @param SimpleLexer $lexer Lexer to add patterns to. + * @access private + * @static + */ + function _addSkipping($lexer) { + $lexer->mapHandler('css', 'ignore'); + $lexer->addEntryPattern('<style', 'text', 'css'); + $lexer->addExitPattern('</style>', 'css'); + $lexer->mapHandler('js', 'ignore'); + $lexer->addEntryPattern('<script', 'text', 'js'); + $lexer->addExitPattern('</script>', 'js'); + $lexer->mapHandler('comment', 'ignore'); + $lexer->addEntryPattern('<!--', 'text', 'comment'); + $lexer->addExitPattern('-->', 'comment'); + } + + /** + * Pattern matches to start and end a tag. + * @param SimpleLexer $lexer Lexer to add patterns to. + * @param string $tag Name of tag to scan for. + * @access private + * @static + */ + function _addTag($lexer, $tag) { + $lexer->addSpecialPattern("</$tag>", 'text', 'acceptEndToken'); + $lexer->addEntryPattern("<$tag", 'text', 'tag'); + } + + /** + * Pattern matches to parse the inside of a tag + * including the attributes and their quoting. + * @param SimpleLexer $lexer Lexer to add patterns to. + * @access private + * @static + */ + function _addInTagTokens($lexer) { + $lexer->mapHandler('tag', 'acceptStartToken'); + $lexer->addSpecialPattern('\s+', 'tag', 'ignore'); + SimpleSaxParser::_addAttributeTokens($lexer); + $lexer->addExitPattern('>', 'tag'); + } + + /** + * Matches attributes that are either single quoted, + * double quoted or unquoted. + * @param SimpleLexer $lexer Lexer to add patterns to. + * @access private + * @static + */ + function _addAttributeTokens($lexer) { + $lexer->mapHandler('dq_attribute', 'acceptAttributeToken'); + $lexer->addEntryPattern('=\s*"', 'tag', 'dq_attribute'); + $lexer->addPattern("\\\\\"", 'dq_attribute'); + $lexer->addExitPattern('"', 'dq_attribute'); + $lexer->mapHandler('sq_attribute', 'acceptAttributeToken'); + $lexer->addEntryPattern("=\s*'", 'tag', 'sq_attribute'); + $lexer->addPattern("\\\\'", 'sq_attribute'); + $lexer->addExitPattern("'", 'sq_attribute'); + $lexer->mapHandler('uq_attribute', 'acceptAttributeToken'); + $lexer->addSpecialPattern('=\s*[^>\s]*', 'tag', 'uq_attribute'); + } + + /** + * Accepts a token from the tag mode. If the + * starting element completes then the element + * is dispatched and the current attributes + * set back to empty. The element or attribute + * name is converted to lower case. + * @param string $token Incoming characters. + * @param integer $event Lexer event type. + * @return boolean False if parse error. + * @access public + */ + function acceptStartToken($token, $event) { + if ($event == LEXER_ENTER) { + $this->_tag = strtolower(substr($token, 1)); + return true; + } + if ($event == LEXER_EXIT) { + $success = $this->_listener->startElement( + $this->_tag, + $this->_attributes); + $this->_tag = ""; + $this->_attributes = array(); + return $success; + } + if ($token != "=") { + $this->_current_attribute = strtolower(SimpleSaxParser::decodeHtml($token)); + $this->_attributes[$this->_current_attribute] = ""; + } + return true; + } + + /** + * Accepts a token from the end tag mode. + * The element name is converted to lower case. + * @param string $token Incoming characters. + * @param integer $event Lexer event type. + * @return boolean False if parse error. + * @access public + */ + function acceptEndToken($token, $event) { + if (! preg_match('/<\/(.*)>/', $token, $matches)) { + return false; + } + return $this->_listener->endElement(strtolower($matches[1])); + } + + /** + * Part of the tag data. + * @param string $token Incoming characters. + * @param integer $event Lexer event type. + * @return boolean False if parse error. + * @access public + */ + function acceptAttributeToken($token, $event) { + if ($event == LEXER_UNMATCHED) { + $this->_attributes[$this->_current_attribute] .= + SimpleSaxParser::decodeHtml($token); + } + if ($event == LEXER_SPECIAL) { + $this->_attributes[$this->_current_attribute] .= + preg_replace('/^=\s*/' , '', SimpleSaxParser::decodeHtml($token)); + } + return true; + } + + /** + * A character entity. + * @param string $token Incoming characters. + * @param integer $event Lexer event type. + * @return boolean False if parse error. + * @access public + */ + function acceptEntityToken($token, $event) { + } + + /** + * Character data between tags regarded as + * important. + * @param string $token Incoming characters. + * @param integer $event Lexer event type. + * @return boolean False if parse error. + * @access public + */ + function acceptTextToken($token, $event) { + return $this->_listener->addContent($token); + } + + /** + * Incoming data to be ignored. + * @param string $token Incoming characters. + * @param integer $event Lexer event type. + * @return boolean False if parse error. + * @access public + */ + function ignore($token, $event) { + return true; + } + + /** + * Decodes any HTML entities. + * @param string $html Incoming HTML. + * @return string Outgoing plain text. + * @access public + * @static + */ + function decodeHtml($html) { + static $translations; + if (! isset($translations)) { + $translations = array_flip(get_html_translation_table(HTML_ENTITIES)); + } + return strtr($html, $translations); + } + + /** + * 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('|<img.*?alt\s*=\s*"(.*?)".*?>|', ' \1 ', $html); + $text = preg_replace('|<img.*?alt\s*=\s*\'(.*?)\'.*?>|', ' \1 ', $text); + $text = preg_replace('|<img.*?alt\s*=\s*([a-zA-Z_]+).*?>|', ' \1 ', $text); + $text = preg_replace('|<.*?>|', '', $text); + $text = SimpleSaxParser::decodeHtml($text); + $text = preg_replace('|\s+|', ' ', $text); + return trim($text); + } + } + + /** + * SAX event handler. + * @package SimpleTest + * @subpackage WebTester + * @abstract + */ + class SimpleSaxListener { + + /** + * Sets the document to write to. + * @access public + */ + function SimpleSaxListener() { + } + + /** + * Start of element event. + * @param string $name Element name. + * @param hash $attributes Name value pairs. + * Attributes without content + * are marked as true. + * @return boolean False on parse error. + * @access public + */ + function startElement($name, $attributes) { + } + + /** + * End of element event. + * @param string $name Element name. + * @return boolean False on parse error. + * @access public + */ + function endElement($name) { + } + + /** + * Unparsed, but relevant data. + * @param string $text May include unparsed tags. + * @return boolean False on parse error. + * @access public + */ + function addContent($text) { + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/remote.php b/tests/test_tools/simpletest/remote.php index 2639ba8c..5a5f2d32 100644 --- a/tests/UnitTests/simpletest/remote.php +++ b/tests/test_tools/simpletest/remote.php @@ -1,115 +1,115 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: remote.php,v 1.11 2004/08/04 22:09:39 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/browser.php');
- require_once(dirname(__FILE__) . '/xml.php');
- require_once(dirname(__FILE__) . '/simple_test.php');
- /**#@-*/
-
- /**
- * Runs an XML formated test on a remote server.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class RemoteTestCase {
- protected $_url;
- protected $_dry_url;
- protected $_size;
-
- /**
- * Sets the location of the remote test.
- * @param string $url Test location.
- * @param string $dry_url Location for dry run.
- * @access public
- */
- function RemoteTestCase($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
- */
- function _createBrowser() {
- return new SimpleBrowser();
- }
-
- /**
- * Creates the XML parser.
- * @param SimpleReporter $reporter Target of test results.
- * @return SimpleTestXmlListener XML reader.
- * @access 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;
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: remote.php,v 1.11 2004/08/04 22:09:39 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/browser.php'); + require_once(dirname(__FILE__) . '/xml.php'); + require_once(dirname(__FILE__) . '/simple_test.php'); + /**#@-*/ + + /** + * Runs an XML formated test on a remote server. + * @package SimpleTest + * @subpackage UnitTester + */ + class RemoteTestCase { + protected $_url; + protected $_dry_url; + protected $_size; + + /** + * Sets the location of the remote test. + * @param string $url Test location. + * @param string $dry_url Location for dry run. + * @access public + */ + function RemoteTestCase($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 + */ + function _createBrowser() { + return new SimpleBrowser(); + } + + /** + * Creates the XML parser. + * @param SimpleReporter $reporter Target of test results. + * @return SimpleTestXmlListener XML reader. + * @access 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; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/reporter.php b/tests/test_tools/simpletest/reporter.php index 8abb18fc..32125c9b 100644 --- a/tests/UnitTests/simpletest/reporter.php +++ b/tests/test_tools/simpletest/reporter.php @@ -1,241 +1,241 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: reporter.php,v 1.33 2004/11/29 04:35:49 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/scorer.php');
- /**#@-*/
-
- /**
- * Sample minimal test displayer. Generates only
- * failure messages and a pass count.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class HtmlReporter extends SimpleReporter {
- protected $_character_set;
-
- /**
- * Does nothing yet. The first output will
- * be sent on the first test start. For use
- * by a web browser.
- * @access public
- */
- function HtmlReporter($character_set = 'ISO-8859-1') {
- $this->SimpleReporter();
- $this->_character_set = $character_set;
- }
-
- /**
- * Paints the top of the web page setting the
- * title to the name of the starting test.
- * @param string $test_name Name class of test.
- * @access public
- */
- function paintHeader($test_name) {
- $this->sendNoCacheHeaders();
- print "<html>\n<head>\n<title>$test_name</title>\n";
- print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" .
- $this->_character_set . "\">\n";
- print "<style type=\"text/css\">\n";
- print $this->_getCss() . "\n";
- print "</style>\n";
- print "</head>\n<body>\n";
- print "<h1>$test_name</h1>\n";
- flush();
- }
-
- /**
- * Send the headers necessary to ensure the page is
- * reloaded on every request. Otherwise you could be
- * scratching your head over out of date test data.
- * @access public
- * @static
- */
- function sendNoCacheHeaders() {
- if (! headers_sent()) {
- header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
- header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
- header("Cache-Control: no-store, no-cache, must-revalidate");
- header("Cache-Control: post-check=0, pre-check=0", false);
- header("Pragma: no-cache");
- }
- }
-
- /**
- * Paints the CSS. Add additional styles here.
- * @return string CSS code as text.
- * @access protected
- */
- function _getCss() {
- return ".fail { color: red; } pre { background-color: lightgray; }";
- }
-
- /**
- * Paints the end of the test with a summary of
- * the passes and failures.
- * @param string $test_name Name class of test.
- * @access public
- */
- function paintFooter($test_name) {
- $colour = ($this->getFailCount() + $this->getExceptionCount() > 0 ? "red" : "green");
- print "<div style=\"";
- print "padding: 8px; margin-top: 1em; background-color: $colour; color: white;";
- print "\">";
- print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount();
- print " test cases complete:\n";
- print "<strong>" . $this->getPassCount() . "</strong> passes, ";
- print "<strong>" . $this->getFailCount() . "</strong> fails and ";
- print "<strong>" . $this->getExceptionCount() . "</strong> exceptions.";
- print "</div>\n";
- print "</body>\n</html>\n";
- }
-
- /**
- * Paints the test failure with a breadcrumbs
- * trail of the nesting test suites below the
- * top level test.
- * @param string $message Failure message displayed in
- * the context of the other tests.
- * @access public
- */
- function paintFail($message) {
- parent::paintFail($message);
- print "<span class=\"fail\">Fail</span>: ";
- $breadcrumb = $this->getTestList();
- array_shift($breadcrumb);
- print implode(" -> ", $breadcrumb);
- print " -> " . $this->_htmlEntities($message) . "<br />\n";
- }
-
- /**
- * Paints a PHP error or exception.
- * @param string $message Message is ignored.
- * @access public
- * @abstract
- */
- function paintException($message) {
- parent::paintException($message);
- print "<span class=\"fail\">Exception</span>: ";
- $breadcrumb = $this->getTestList();
- array_shift($breadcrumb);
- print implode(" -> ", $breadcrumb);
- print " -> <strong>" . $this->_htmlEntities($message) . "</strong><br />\n";
- }
-
- /**
- * Paints formatted text such as dumped variables.
- * @param string $message Text to show.
- * @access public
- */
- function paintFormattedMessage($message) {
- print '<pre>' . $this->_htmlEntities($message) . '</pre>';
- }
-
- /**
- * Character set adjusted entity conversion.
- * @param string $message Plain text or Unicode message.
- * @return string Browser readable message.
- * @access protected
- */
- function _htmlEntities($message) {
- return htmlentities($message, ENT_COMPAT, $this->_character_set);
- }
- }
-
- /**
- * Sample minimal test displayer. Generates only
- * failure messages and a pass count. For command
- * line use. I've tried to make it look like JUnit,
- * but I wanted to output the errors as they arrived
- * which meant dropping the dots.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class TextReporter extends SimpleReporter {
-
- /**
- * Does nothing yet. The first output will
- * be sent on the first test start.
- * @access public
- */
- function TextReporter() {
- $this->SimpleReporter();
- }
-
- /**
- * Paints the title only.
- * @param string $test_name Name class of test.
- * @access public
- */
- function paintHeader($test_name) {
- if (! SimpleReporter::inCli()) {
- header('Content-type: text/plain');
- }
- print "$test_name\n";
- flush();
- }
-
- /**
- * Paints the end of the test with a summary of
- * the passes and failures.
- * @param string $test_name Name class of test.
- * @access public
- */
- function paintFooter($test_name) {
- if ($this->getFailCount() + $this->getExceptionCount() == 0) {
- print "OK\n";
- } else {
- print "FAILURES!!!\n";
- }
- print "Test cases run: " . $this->getTestCaseProgress() .
- "/" . $this->getTestCaseCount() .
- ", Passes: " . $this->getPassCount() .
- ", Failures: " . $this->getFailCount() .
- ", Exceptions: " . $this->getExceptionCount() . "\n";
-
- }
-
- /**
- * Paints the test failure as a stack trace.
- * @param string $message Failure message displayed in
- * the context of the other tests.
- * @access public
- */
- function paintFail($message) {
- parent::paintFail($message);
- print $this->getFailCount() . ") $message\n";
- $breadcrumb = $this->getTestList();
- array_shift($breadcrumb);
- print "\tin " . implode("\n\tin ", array_reverse($breadcrumb));
- print "\n";
- }
-
- /**
- * Paints a PHP error or exception.
- * @param string $message Message is ignored.
- * @access public
- * @abstract
- */
- function paintException($message) {
- parent::paintException($message);
- print "Exception " . $this->getExceptionCount() . "!\n$message\n";
- }
-
- /**
- * Paints formatted text such as dumped variables.
- * @param string $message Text to show.
- * @access public
- */
- function paintFormattedMessage($message) {
- print "$message\n";
- flush();
- }
- }
-?>
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: reporter.php,v 1.33 2004/11/29 04:35:49 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/scorer.php'); + /**#@-*/ + + /** + * Sample minimal test displayer. Generates only + * failure messages and a pass count. + * @package SimpleTest + * @subpackage UnitTester + */ + class HtmlReporter extends SimpleReporter { + protected $_character_set; + + /** + * Does nothing yet. The first output will + * be sent on the first test start. For use + * by a web browser. + * @access public + */ + function HtmlReporter($character_set = 'ISO-8859-1') { + $this->SimpleReporter(); + $this->_character_set = $character_set; + } + + /** + * Paints the top of the web page setting the + * title to the name of the starting test. + * @param string $test_name Name class of test. + * @access public + */ + function paintHeader($test_name) { + $this->sendNoCacheHeaders(); + print "<html>\n<head>\n<title>$test_name</title>\n"; + print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" . + $this->_character_set . "\">\n"; + print "<style type=\"text/css\">\n"; + print $this->_getCss() . "\n"; + print "</style>\n"; + print "</head>\n<body>\n"; + print "<h1>$test_name</h1>\n"; + flush(); + } + + /** + * Send the headers necessary to ensure the page is + * reloaded on every request. Otherwise you could be + * scratching your head over out of date test data. + * @access public + * @static + */ + function sendNoCacheHeaders() { + if (! headers_sent()) { + header("Expires: Mon, 26 Jul 1997 05:00:00 GMT"); + header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT"); + header("Cache-Control: no-store, no-cache, must-revalidate"); + header("Cache-Control: post-check=0, pre-check=0", false); + header("Pragma: no-cache"); + } + } + + /** + * Paints the CSS. Add additional styles here. + * @return string CSS code as text. + * @access protected + */ + function _getCss() { + return ".fail { color: red; } pre { background-color: lightgray; }"; + } + + /** + * Paints the end of the test with a summary of + * the passes and failures. + * @param string $test_name Name class of test. + * @access public + */ + function paintFooter($test_name) { + $colour = ($this->getFailCount() + $this->getExceptionCount() > 0 ? "red" : "green"); + print "<div style=\""; + print "padding: 8px; margin-top: 1em; background-color: $colour; color: white;"; + print "\">"; + print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount(); + print " test cases complete:\n"; + print "<strong>" . $this->getPassCount() . "</strong> passes, "; + print "<strong>" . $this->getFailCount() . "</strong> fails and "; + print "<strong>" . $this->getExceptionCount() . "</strong> exceptions."; + print "</div>\n"; + print "</body>\n</html>\n"; + } + + /** + * Paints the test failure with a breadcrumbs + * trail of the nesting test suites below the + * top level test. + * @param string $message Failure message displayed in + * the context of the other tests. + * @access public + */ + function paintFail($message) { + parent::paintFail($message); + print "<span class=\"fail\">Fail</span>: "; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print implode(" -> ", $breadcrumb); + print " -> " . $this->_htmlEntities($message) . "<br />\n"; + } + + /** + * Paints a PHP error or exception. + * @param string $message Message is ignored. + * @access public + * @abstract + */ + function paintException($message) { + parent::paintException($message); + print "<span class=\"fail\">Exception</span>: "; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print implode(" -> ", $breadcrumb); + print " -> <strong>" . $this->_htmlEntities($message) . "</strong><br />\n"; + } + + /** + * Paints formatted text such as dumped variables. + * @param string $message Text to show. + * @access public + */ + function paintFormattedMessage($message) { + print '<pre>' . $this->_htmlEntities($message) . '</pre>'; + } + + /** + * Character set adjusted entity conversion. + * @param string $message Plain text or Unicode message. + * @return string Browser readable message. + * @access protected + */ + function _htmlEntities($message) { + return htmlentities($message, ENT_COMPAT, $this->_character_set); + } + } + + /** + * Sample minimal test displayer. Generates only + * failure messages and a pass count. For command + * line use. I've tried to make it look like JUnit, + * but I wanted to output the errors as they arrived + * which meant dropping the dots. + * @package SimpleTest + * @subpackage UnitTester + */ + class TextReporter extends SimpleReporter { + + /** + * Does nothing yet. The first output will + * be sent on the first test start. + * @access public + */ + function TextReporter() { + $this->SimpleReporter(); + } + + /** + * Paints the title only. + * @param string $test_name Name class of test. + * @access public + */ + function paintHeader($test_name) { + if (! SimpleReporter::inCli()) { + header('Content-type: text/plain'); + } + print "$test_name\n"; + flush(); + } + + /** + * Paints the end of the test with a summary of + * the passes and failures. + * @param string $test_name Name class of test. + * @access public + */ + function paintFooter($test_name) { + if ($this->getFailCount() + $this->getExceptionCount() == 0) { + print "OK\n"; + } else { + print "FAILURES!!!\n"; + } + print "Test cases run: " . $this->getTestCaseProgress() . + "/" . $this->getTestCaseCount() . + ", Passes: " . $this->getPassCount() . + ", Failures: " . $this->getFailCount() . + ", Exceptions: " . $this->getExceptionCount() . "\n"; + + } + + /** + * Paints the test failure as a stack trace. + * @param string $message Failure message displayed in + * the context of the other tests. + * @access public + */ + function paintFail($message) { + parent::paintFail($message); + print $this->getFailCount() . ") $message\n"; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print "\tin " . implode("\n\tin ", array_reverse($breadcrumb)); + print "\n"; + } + + /** + * Paints a PHP error or exception. + * @param string $message Message is ignored. + * @access public + * @abstract + */ + function paintException($message) { + parent::paintException($message); + print "Exception " . $this->getExceptionCount() . "!\n$message\n"; + } + + /** + * Paints formatted text such as dumped variables. + * @param string $message Text to show. + * @access public + */ + function paintFormattedMessage($message) { + print "$message\n"; + flush(); + } + } +?> diff --git a/tests/UnitTests/simpletest/runner.php b/tests/test_tools/simpletest/runner.php index 5a14332d..411efe7e 100644 --- a/tests/UnitTests/simpletest/runner.php +++ b/tests/test_tools/simpletest/runner.php @@ -1,300 +1,300 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: runner.php,v 1.29 2005/01/11 04:03:46 lastcraft Exp $
- */
-
- /**#@+
- * Includes SimpleTest files and defined the root constant
- * for dependent libraries.
- */
- require_once(dirname(__FILE__) . '/errors.php');
- require_once(dirname(__FILE__) . '/options.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 {
- protected $_test_case;
-
- /**
- * Stashes the test case for later.
- * @param SimpleTestCase $test_case Test case to run.
- */
- function SimpleInvoker($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;
- }
-
- /**
- * 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();
- }
- }
-
- /**
- * Do nothing decorator. Just passes the invocation
- * straight through.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleInvokerDecorator {
- protected $_invoker;
-
- /**
- * Stores the invoker to wrap.
- * @param SimpleInvoker $invoker Test method runner.
- */
- function SimpleInvokerDecorator($invoker) {
- $this->_invoker = $invoker;
- }
-
- /**
- * Accessor for test case being run.
- * @return SimpleTestCase Test case.
- * @access public
- */
- function getTestCase() {
- return $this->_invoker->getTestCase();
- }
-
- /**
- * 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);
- }
- }
-
- /**
- * 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 SimpleErrorTrappingInvoker($invoker) {
- $this->SimpleInvokerDecorator($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) {
- set_error_handler('simpleTestErrorHandler');
- parent::invoke($method);
- $queue = SimpleErrorQueue::instance();
- while (list($severity, $message, $file, $line, $globals) = $queue->extract()) {
- $test_case = $this->getTestCase();
- $test_case->error($severity, $message, $file, $line, $globals);
- }
- restore_error_handler();
- }
- }
-
- /**
- * The standard runner. Will run every method starting
- * with test Basically the
- * Mediator pattern.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleRunner {
- protected $_test_case;
- protected $_scorer;
-
- /**
- * Takes in the test case and reporter to mediate between.
- * @param SimpleTestCase $test_case Test case to run.
- * @param SimpleScorer $scorer Reporter to receive events.
- */
- function SimpleRunner($test_case, $scorer) {
- $this->_test_case = $test_case;
- $this->_scorer = $scorer;
- }
-
- /**
- * Accessor for test case being run.
- * @return SimpleTestCase Test case.
- * @access public
- */
- function getTestCase() {
- return $this->_test_case;
- }
-
- /**
- * Runs the test methods in the test case.
- * @param SimpleTest $test_case Test case to run test on.
- * @param string $method Name of test method.
- * @access public
- */
- function run() {
- $methods = get_class_methods(get_class($this->_test_case));
- $invoker = $this->_test_case->createInvoker();
- foreach ($methods as $method) {
- if (! $this->_isTest($method)) {
- continue;
- }
- if ($this->_isConstructor($method)) {
- continue;
- }
- $this->_scorer->paintMethodStart($method);
- if ($this->_scorer->shouldInvoke($this->_test_case->getLabel(), $method)) {
- $invoker->invoke($method);
- }
- $this->_scorer->paintMethodEnd($method);
- }
- }
-
- /**
- * Tests to see if the method is the constructor and
- * so should be ignored.
- * @param string $method Method name to try.
- * @return boolean True if constructor.
- * @access protected
- */
- function _isConstructor($method) {
- return SimpleTestCompatibility::isA(
- $this->_test_case,
- strtolower($method));
- }
-
- /**
- * Tests to see if the method is a test that should
- * be run. Currently any method that starts with 'test'
- * is a candidate.
- * @param string $method Method name to try.
- * @return boolean True if test method.
- * @access protected
- */
- function _isTest($method) {
- return strtolower(substr($method, 0, 4)) == 'test';
- }
-
- /**
- * Paints the start of a test method.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintMethodStart($test_name) {
- $this->_scorer->paintMethodStart($test_name);
- }
-
- /**
- * Paints the end of a test method.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintMethodEnd($test_name) {
- $this->_scorer->paintMethodEnd($test_name);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param string $message Message is ignored.
- * @access public
- */
- function paintPass($message) {
- $this->_scorer->paintPass($message);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param string $message Message is ignored.
- * @access public
- */
- function paintFail($message) {
- $this->_scorer->paintFail($message);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param string $message Text of error formatted by
- * the test case.
- * @access public
- */
- function paintError($message) {
- $this->_scorer->paintError($message);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param Exception $exception Object thrown.
- * @access public
- */
- function paintException($exception) {
- $this->_scorer->paintException($exception);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param string $message Text to display.
- * @access public
- */
- function paintMessage($message) {
- $this->_scorer->paintMessage($message);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param string $message Text to display.
- * @access public
- */
- function paintFormattedMessage($message) {
- $this->_scorer->paintFormattedMessage($message);
- }
-
- /**
- * Chains to the wrapped reporter.
- * @param string $type Event type as text.
- * @param mixed $payload Message or object.
- * @return boolean Should return false if this
- * type of signal should fail the
- * test suite.
- * @access public
- */
- function paintSignal($type, $payload) {
- $this->_scorer->paintSignal($type, $payload);
- }
- }
-?>
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: runner.php,v 1.29 2005/01/11 04:03:46 lastcraft Exp $ + */ + + /**#@+ + * Includes SimpleTest files and defined the root constant + * for dependent libraries. + */ + require_once(dirname(__FILE__) . '/errors.php'); + require_once(dirname(__FILE__) . '/options.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 { + protected $_test_case; + + /** + * Stashes the test case for later. + * @param SimpleTestCase $test_case Test case to run. + */ + function SimpleInvoker($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; + } + + /** + * 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(); + } + } + + /** + * Do nothing decorator. Just passes the invocation + * straight through. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleInvokerDecorator { + protected $_invoker; + + /** + * Stores the invoker to wrap. + * @param SimpleInvoker $invoker Test method runner. + */ + function SimpleInvokerDecorator($invoker) { + $this->_invoker = $invoker; + } + + /** + * Accessor for test case being run. + * @return SimpleTestCase Test case. + * @access public + */ + function getTestCase() { + return $this->_invoker->getTestCase(); + } + + /** + * 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); + } + } + + /** + * 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 SimpleErrorTrappingInvoker($invoker) { + $this->SimpleInvokerDecorator($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) { + set_error_handler('simpleTestErrorHandler'); + parent::invoke($method); + $queue = SimpleErrorQueue::instance(); + while (list($severity, $message, $file, $line, $globals) = $queue->extract()) { + $test_case = $this->getTestCase(); + $test_case->error($severity, $message, $file, $line, $globals); + } + restore_error_handler(); + } + } + + /** + * The standard runner. Will run every method starting + * with test Basically the + * Mediator pattern. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleRunner { + protected $_test_case; + protected $_scorer; + + /** + * Takes in the test case and reporter to mediate between. + * @param SimpleTestCase $test_case Test case to run. + * @param SimpleScorer $scorer Reporter to receive events. + */ + function SimpleRunner($test_case, $scorer) { + $this->_test_case = $test_case; + $this->_scorer = $scorer; + } + + /** + * Accessor for test case being run. + * @return SimpleTestCase Test case. + * @access public + */ + function getTestCase() { + return $this->_test_case; + } + + /** + * Runs the test methods in the test case. + * @param SimpleTest $test_case Test case to run test on. + * @param string $method Name of test method. + * @access public + */ + function run() { + $methods = get_class_methods(get_class($this->_test_case)); + $invoker = $this->_test_case->createInvoker(); + foreach ($methods as $method) { + if (! $this->_isTest($method)) { + continue; + } + if ($this->_isConstructor($method)) { + continue; + } + $this->_scorer->paintMethodStart($method); + if ($this->_scorer->shouldInvoke($this->_test_case->getLabel(), $method)) { + $invoker->invoke($method); + } + $this->_scorer->paintMethodEnd($method); + } + } + + /** + * Tests to see if the method is the constructor and + * so should be ignored. + * @param string $method Method name to try. + * @return boolean True if constructor. + * @access protected + */ + function _isConstructor($method) { + return SimpleTestCompatibility::isA( + $this->_test_case, + strtolower($method)); + } + + /** + * Tests to see if the method is a test that should + * be run. Currently any method that starts with 'test' + * is a candidate. + * @param string $method Method name to try. + * @return boolean True if test method. + * @access protected + */ + function _isTest($method) { + return strtolower(substr($method, 0, 4)) == 'test'; + } + + /** + * Paints the start of a test method. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintMethodStart($test_name) { + $this->_scorer->paintMethodStart($test_name); + } + + /** + * Paints the end of a test method. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintMethodEnd($test_name) { + $this->_scorer->paintMethodEnd($test_name); + } + + /** + * Chains to the wrapped reporter. + * @param string $message Message is ignored. + * @access public + */ + function paintPass($message) { + $this->_scorer->paintPass($message); + } + + /** + * Chains to the wrapped reporter. + * @param string $message Message is ignored. + * @access public + */ + function paintFail($message) { + $this->_scorer->paintFail($message); + } + + /** + * Chains to the wrapped reporter. + * @param string $message Text of error formatted by + * the test case. + * @access public + */ + function paintError($message) { + $this->_scorer->paintError($message); + } + + /** + * Chains to the wrapped reporter. + * @param Exception $exception Object thrown. + * @access public + */ + function paintException($exception) { + $this->_scorer->paintException($exception); + } + + /** + * Chains to the wrapped reporter. + * @param string $message Text to display. + * @access public + */ + function paintMessage($message) { + $this->_scorer->paintMessage($message); + } + + /** + * Chains to the wrapped reporter. + * @param string $message Text to display. + * @access public + */ + function paintFormattedMessage($message) { + $this->_scorer->paintFormattedMessage($message); + } + + /** + * Chains to the wrapped reporter. + * @param string $type Event type as text. + * @param mixed $payload Message or object. + * @return boolean Should return false if this + * type of signal should fail the + * test suite. + * @access public + */ + function paintSignal($type, $payload) { + $this->_scorer->paintSignal($type, $payload); + } + } +?> diff --git a/tests/UnitTests/simpletest/scorer.php b/tests/test_tools/simpletest/scorer.php index 7861493c..6c321f8c 100644 --- a/tests/UnitTests/simpletest/scorer.php +++ b/tests/test_tools/simpletest/scorer.php @@ -1,378 +1,378 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: scorer.php,v 1.4 2005/01/11 04:03:46 lastcraft Exp $
- */
-
- /**
- * Can recieve test events and display them. Display
- * is achieved by making display methods available
- * and visiting the incoming event.
- * @package SimpleTest
- * @subpackage UnitTester
- * @abstract
- */
- class SimpleScorer {
- protected $_passes;
- protected $_fails;
- protected $_exceptions;
- protected $_is_dry_run;
-
- /**
- * Starts the test run with no results.
- * @access public
- */
- function SimpleScorer() {
- $this->_passes = 0;
- $this->_fails = 0;
- $this->_exceptions = 0;
- $this->_is_dry_run = false;
- }
-
- /**
- * Signals that the next evaluation will be a dry
- * run. That is, the structure events will be
- * recorded, but no tests will be run.
- */
- function makeDry($is_dry = true) {
- $this->_is_dry_run = $is_dry;
- }
-
- /**
- * The reporter has a veto on what should be run.
- * @param string $test_case_name name of test case.
- * @param string $method Name of test method.
- * @access public
- */
- function shouldInvoke($test_case_name, $method) {
- return ! $this->_is_dry_run;
- }
-
- /**
- * Accessor for current status. Will be false
- * if there have been any failures or exceptions.
- * Used for command line tools.
- * @return boolean True if no failures.
- * @access public
- */
- function getStatus() {
- if ($this->_exceptions + $this->_fails > 0) {
- return false;
- }
- return true;
- }
-
- /**
- * Paints the start of a test method.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintMethodStart($test_name) {
- }
-
- /**
- * Paints the end of a test method.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintMethodEnd($test_name) {
- }
-
- /**
- * Paints the start of a test case.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintCaseStart($test_name) {
- }
-
- /**
- * Paints the end of a test case.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintCaseEnd($test_name) {
- }
-
- /**
- * Paints the start of a group test.
- * @param string $test_name Name of test or other label.
- * @param integer $size Number of test cases starting.
- * @access public
- */
- function paintGroupStart($test_name, $size) {
- }
-
- /**
- * Paints the end of a group test.
- * @param string $test_name Name of test or other label.
- * @access public
- */
- function paintGroupEnd($test_name) {
- }
-
- /**
- * Increments the pass count.
- * @param string $message Message is ignored.
- * @access public
- */
- function paintPass($message) {
- $this->_passes++;
- }
-
- /**
- * Increments the fail count.
- * @param string $message Message is ignored.
- * @access public
- */
- function paintFail($message) {
- $this->_fails++;
- }
-
- /**
- * Deals with PHP 4 throwing an error.
- * @param string $message Text of error formatted by
- * the test case.
- * @access public
- */
- function paintError($message) {
- $this->paintException($message);
- }
-
- /**
- * Deals with PHP 5 throwing an exception
- * This isn't really implemented yet.
- * @param Exception $exception Object thrown.
- * @access public
- */
- function paintException($exception) {
- $this->_exceptions++;
- }
-
- /**
- * Accessor for the number of passes so far.
- * @return integer Number of passes.
- * @access public
- */
- function getPassCount() {
- return $this->_passes;
- }
-
- /**
- * Accessor for the number of fails so far.
- * @return integer Number of fails.
- * @access public
- */
- function getFailCount() {
- return $this->_fails;
- }
-
- /**
- * Accessor for the number of untrapped errors
- * so far.
- * @return integer Number of exceptions.
- * @access public
- */
- function getExceptionCount() {
- return $this->_exceptions;
- }
-
- /**
- * Paints a simple supplementary message.
- * @param string $message Text to display.
- * @access public
- */
- function paintMessage($message) {
- }
-
- /**
- * Paints a formatted ASCII message such as a
- * variable dump.
- * @param string $message Text to display.
- * @access public
- */
- function paintFormattedMessage($message) {
- }
-
- /**
- * By default just ignores user generated events.
- * @param string $type Event type as text.
- * @param mixed $payload Message or object.
- * @access public
- */
- function paintSignal($type, $payload) {
- }
- }
-
- /**
- * Recipient of generated test messages that can display
- * page footers and headers. Also keeps track of the
- * test nesting. This is the main base class on which
- * to build the finished test (page based) displays.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleReporter extends SimpleScorer {
- protected $_test_stack;
- protected $_size;
- protected $_progress;
-
- /**
- * Starts the display with no results in.
- * @access public
- */
- function SimpleReporter() {
- $this->SimpleScorer();
- $this->_test_stack = array();
- $this->_size = null;
- $this->_progress = 0;
- }
-
- /**
- * Paints the start of a group test. Will also paint
- * the page header and footer if this is the
- * first test. Will stash the size if the first
- * start.
- * @param string $test_name Name of test that is starting.
- * @param integer $size Number of test cases starting.
- * @access public
- */
- function paintGroupStart($test_name, $size) {
- if (! isset($this->_size)) {
- $this->_size = $size;
- }
- if (count($this->_test_stack) == 0) {
- $this->paintHeader($test_name);
- }
- $this->_test_stack[] = $test_name;
- }
-
- /**
- * Paints the end of a group test. Will paint the page
- * footer if the stack of tests has unwound.
- * @param string $test_name Name of test that is ending.
- * @param integer $progress Number of test cases ending.
- * @access public
- */
- function paintGroupEnd($test_name) {
- array_pop($this->_test_stack);
- if (count($this->_test_stack) == 0) {
- $this->paintFooter($test_name);
- }
- }
-
- /**
- * Paints the start of a test case. Will also paint
- * the page header and footer if this is the
- * first test. Will stash the size if the first
- * start.
- * @param string $test_name Name of test that is starting.
- * @access public
- */
- function paintCaseStart($test_name) {
- if (! isset($this->_size)) {
- $this->_size = 1;
- }
- if (count($this->_test_stack) == 0) {
- $this->paintHeader($test_name);
- }
- $this->_test_stack[] = $test_name;
- }
-
- /**
- * Paints the end of a test case. Will paint the page
- * footer if the stack of tests has unwound.
- * @param string $test_name Name of test that is ending.
- * @access public
- */
- function paintCaseEnd($test_name) {
- $this->_progress++;
- array_pop($this->_test_stack);
- if (count($this->_test_stack) == 0) {
- $this->paintFooter($test_name);
- }
- }
-
- /**
- * Paints the start of a test method.
- * @param string $test_name Name of test that is starting.
- * @access public
- */
- function paintMethodStart($test_name) {
- $this->_test_stack[] = $test_name;
- }
-
- /**
- * Paints the end of a test method. Will paint the page
- * footer if the stack of tests has unwound.
- * @param string $test_name Name of test that is ending.
- * @access public
- */
- function paintMethodEnd($test_name) {
- array_pop($this->_test_stack);
- }
-
- /**
- * Paints the test document header.
- * @param string $test_name First test top level
- * to start.
- * @access public
- * @abstract
- */
- function paintHeader($test_name) {
- }
-
- /**
- * Paints the test document footer.
- * @param string $test_name The top level test.
- * @access public
- * @abstract
- */
- function paintFooter($test_name) {
- }
-
- /**
- * Accessor for internal test stack. For
- * subclasses that need to see the whole test
- * history for display purposes.
- * @return array List of methods in nesting order.
- * @access public
- */
- function getTestList() {
- return $this->_test_stack;
- }
-
- /**
- * Accessor for total test size in number
- * of test cases. Null until the first
- * test is started.
- * @return integer Total number of cases at start.
- * @access public
- */
- function getTestCaseCount() {
- return $this->_size;
- }
-
- /**
- * Accessor for the number of test cases
- * completed so far.
- * @return integer Number of ended cases.
- * @access public
- */
- function getTestCaseProgress() {
- return $this->_progress;
- }
-
- /**
- * Static check for running in the comand line.
- * @return boolean True if CLI.
- * @access public
- * @static
- */
- static function inCli() {
- return php_sapi_name() == 'cli';
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: scorer.php,v 1.4 2005/01/11 04:03:46 lastcraft Exp $ + */ + + /** + * Can recieve test events and display them. Display + * is achieved by making display methods available + * and visiting the incoming event. + * @package SimpleTest + * @subpackage UnitTester + * @abstract + */ + class SimpleScorer { + protected $_passes; + protected $_fails; + protected $_exceptions; + protected $_is_dry_run; + + /** + * Starts the test run with no results. + * @access public + */ + function SimpleScorer() { + $this->_passes = 0; + $this->_fails = 0; + $this->_exceptions = 0; + $this->_is_dry_run = false; + } + + /** + * Signals that the next evaluation will be a dry + * run. That is, the structure events will be + * recorded, but no tests will be run. + */ + function makeDry($is_dry = true) { + $this->_is_dry_run = $is_dry; + } + + /** + * The reporter has a veto on what should be run. + * @param string $test_case_name name of test case. + * @param string $method Name of test method. + * @access public + */ + function shouldInvoke($test_case_name, $method) { + return ! $this->_is_dry_run; + } + + /** + * Accessor for current status. Will be false + * if there have been any failures or exceptions. + * Used for command line tools. + * @return boolean True if no failures. + * @access public + */ + function getStatus() { + if ($this->_exceptions + $this->_fails > 0) { + return false; + } + return true; + } + + /** + * Paints the start of a test method. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintMethodStart($test_name) { + } + + /** + * Paints the end of a test method. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintMethodEnd($test_name) { + } + + /** + * Paints the start of a test case. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintCaseStart($test_name) { + } + + /** + * Paints the end of a test case. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintCaseEnd($test_name) { + } + + /** + * Paints the start of a group test. + * @param string $test_name Name of test or other label. + * @param integer $size Number of test cases starting. + * @access public + */ + function paintGroupStart($test_name, $size) { + } + + /** + * Paints the end of a group test. + * @param string $test_name Name of test or other label. + * @access public + */ + function paintGroupEnd($test_name) { + } + + /** + * Increments the pass count. + * @param string $message Message is ignored. + * @access public + */ + function paintPass($message) { + $this->_passes++; + } + + /** + * Increments the fail count. + * @param string $message Message is ignored. + * @access public + */ + function paintFail($message) { + $this->_fails++; + } + + /** + * Deals with PHP 4 throwing an error. + * @param string $message Text of error formatted by + * the test case. + * @access public + */ + function paintError($message) { + $this->paintException($message); + } + + /** + * Deals with PHP 5 throwing an exception + * This isn't really implemented yet. + * @param Exception $exception Object thrown. + * @access public + */ + function paintException($exception) { + $this->_exceptions++; + } + + /** + * Accessor for the number of passes so far. + * @return integer Number of passes. + * @access public + */ + function getPassCount() { + return $this->_passes; + } + + /** + * Accessor for the number of fails so far. + * @return integer Number of fails. + * @access public + */ + function getFailCount() { + return $this->_fails; + } + + /** + * Accessor for the number of untrapped errors + * so far. + * @return integer Number of exceptions. + * @access public + */ + function getExceptionCount() { + return $this->_exceptions; + } + + /** + * Paints a simple supplementary message. + * @param string $message Text to display. + * @access public + */ + function paintMessage($message) { + } + + /** + * Paints a formatted ASCII message such as a + * variable dump. + * @param string $message Text to display. + * @access public + */ + function paintFormattedMessage($message) { + } + + /** + * By default just ignores user generated events. + * @param string $type Event type as text. + * @param mixed $payload Message or object. + * @access public + */ + function paintSignal($type, $payload) { + } + } + + /** + * Recipient of generated test messages that can display + * page footers and headers. Also keeps track of the + * test nesting. This is the main base class on which + * to build the finished test (page based) displays. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleReporter extends SimpleScorer { + protected $_test_stack; + protected $_size; + protected $_progress; + + /** + * Starts the display with no results in. + * @access public + */ + function SimpleReporter() { + $this->SimpleScorer(); + $this->_test_stack = array(); + $this->_size = null; + $this->_progress = 0; + } + + /** + * Paints the start of a group test. Will also paint + * the page header and footer if this is the + * first test. Will stash the size if the first + * start. + * @param string $test_name Name of test that is starting. + * @param integer $size Number of test cases starting. + * @access public + */ + function paintGroupStart($test_name, $size) { + if (! isset($this->_size)) { + $this->_size = $size; + } + if (count($this->_test_stack) == 0) { + $this->paintHeader($test_name); + } + $this->_test_stack[] = $test_name; + } + + /** + * Paints the end of a group test. Will paint the page + * footer if the stack of tests has unwound. + * @param string $test_name Name of test that is ending. + * @param integer $progress Number of test cases ending. + * @access public + */ + function paintGroupEnd($test_name) { + array_pop($this->_test_stack); + if (count($this->_test_stack) == 0) { + $this->paintFooter($test_name); + } + } + + /** + * Paints the start of a test case. Will also paint + * the page header and footer if this is the + * first test. Will stash the size if the first + * start. + * @param string $test_name Name of test that is starting. + * @access public + */ + function paintCaseStart($test_name) { + if (! isset($this->_size)) { + $this->_size = 1; + } + if (count($this->_test_stack) == 0) { + $this->paintHeader($test_name); + } + $this->_test_stack[] = $test_name; + } + + /** + * Paints the end of a test case. Will paint the page + * footer if the stack of tests has unwound. + * @param string $test_name Name of test that is ending. + * @access public + */ + function paintCaseEnd($test_name) { + $this->_progress++; + array_pop($this->_test_stack); + if (count($this->_test_stack) == 0) { + $this->paintFooter($test_name); + } + } + + /** + * Paints the start of a test method. + * @param string $test_name Name of test that is starting. + * @access public + */ + function paintMethodStart($test_name) { + $this->_test_stack[] = $test_name; + } + + /** + * Paints the end of a test method. Will paint the page + * footer if the stack of tests has unwound. + * @param string $test_name Name of test that is ending. + * @access public + */ + function paintMethodEnd($test_name) { + array_pop($this->_test_stack); + } + + /** + * Paints the test document header. + * @param string $test_name First test top level + * to start. + * @access public + * @abstract + */ + function paintHeader($test_name) { + } + + /** + * Paints the test document footer. + * @param string $test_name The top level test. + * @access public + * @abstract + */ + function paintFooter($test_name) { + } + + /** + * Accessor for internal test stack. For + * subclasses that need to see the whole test + * history for display purposes. + * @return array List of methods in nesting order. + * @access public + */ + function getTestList() { + return $this->_test_stack; + } + + /** + * Accessor for total test size in number + * of test cases. Null until the first + * test is started. + * @return integer Total number of cases at start. + * @access public + */ + function getTestCaseCount() { + return $this->_size; + } + + /** + * Accessor for the number of test cases + * completed so far. + * @return integer Number of ended cases. + * @access public + */ + function getTestCaseProgress() { + return $this->_progress; + } + + /** + * Static check for running in the comand line. + * @return boolean True if CLI. + * @access public + * @static + */ + static function inCli() { + return php_sapi_name() == 'cli'; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/shell_tester.php b/tests/test_tools/simpletest/shell_tester.php index aeb7cac0..7bab8ce0 100644 --- a/tests/UnitTests/simpletest/shell_tester.php +++ b/tests/test_tools/simpletest/shell_tester.php @@ -1,271 +1,271 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: shell_tester.php,v 1.14 2004/08/17 18:18:32 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/simple_test.php');
- /**#@-*/
-
- /**
- * Wrapper for exec() functionality.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleShell {
- protected $_output;
-
- /**
- * Executes the shell comand and stashes the output.
- * @access public
- */
- function SimpleShell() {
- $this->_output = false;
- }
-
- /**
- * Actually runs the command. Does not trap the
- * error stream output as this need PHP 4.3+.
- * @param string $command The actual command line
- * to run.
- * @return integer Exit code.
- * @access public
- */
- function execute($command) {
- $this->_output = false;
- exec($command, $this->_output, $ret);
- return $ret;
- }
-
- /**
- * Accessor for the last output.
- * @return string Output as text.
- * @access public
- */
- function getOutput() {
- return implode("\n", $this->_output);
- }
-
- /**
- * Accessor for the last output.
- * @return array Output as array of lines.
- * @access public
- */
- function getOutputAsList() {
- return $this->_output;
- }
- }
-
- /**
- * Test case for testing of command line scripts and
- * utilities. Usually scripts taht are external to the
- * PHP code, but support it in some way.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class ShellTestCase extends SimpleTestCase {
- protected $_current_shell;
- protected $_last_status;
- protected $_last_command;
-
- /**
- * Creates an empty test case. Should be subclassed
- * with test methods for a functional test case.
- * @param string $label Name of test case. Will use
- * the class name if none specified.
- * @access public
- */
- function ShellTestCase($label = false) {
- $this->SimpleTestCase($label);
- $this->_current_shell = $this->_createShell();
- $this->_last_status = false;
- $this->_last_command = '';
- }
-
- /**
- * Executes a command and buffers the results.
- * @param string $command Command to run.
- * @return boolean True if zero exit code.
- * @access public
- */
- function execute($command) {
- $shell = $this->_getShell();
- $this->_last_status = $shell->execute($command);
- $this->_last_command = $command;
- return ($this->_last_status === 0);
- }
-
- /**
- * Dumps the output of the last command.
- * @access public
- */
- function dumpOutput() {
- $this->dump($this->getOutput());
- }
-
- /**
- * Accessor for the last output.
- * @return string Output as text.
- * @access public
- */
- function getOutput() {
- $shell = $this->_getShell();
- return $shell->getOutput();
- }
-
- /**
- * Accessor for the last output.
- * @return array Output as array of lines.
- * @access public
- */
- function getOutputAsList() {
- $shell = $this->_getShell();
- return $shell->getOutputAsList();
- }
-
- /**
- * Tests the last status code from the shell.
- * @param integer $status Expected status of last
- * command.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertExitCode($status, $message = "%s") {
- $message = sprintf($message, "Expected status code of [$status] from [" .
- $this->_last_command . "], but got [" .
- $this->_last_status . "]");
- return $this->assertTrue($status === $this->_last_status, $message);
- }
-
- /**
- * Attempt to exactly match the combined STDERR and
- * STDOUT output.
- * @param string $expected Expected output.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertOutput($expected, $message = "%s") {
- $shell = $this->_getShell();
- return $this->assertExpectation(
- new EqualExpectation($expected),
- $shell->getOutput(),
- $message);
- }
-
- /**
- * Scans the output for a Perl regex. If found
- * anywhere it passes, else it fails.
- * @param string $pattern Regex to search for.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertOutputPattern($pattern, $message = "%s") {
- $shell = $this->_getShell();
- return $this->assertExpectation(
- new WantedPatternExpectation($pattern),
- $shell->getOutput(),
- $message);
- }
-
- /**
- * If a Perl regex is found anywhere in the current
- * output then a failure is generated, else a pass.
- * @param string $pattern Regex to search for.
- * @param $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoOutputPattern($pattern, $message = "%s") {
- $shell = $this->_getShell();
- return $this->assertExpectation(
- new UnwantedPatternExpectation($pattern),
- $shell->getOutput(),
- $message);
- }
-
- /**
- * File existence check.
- * @param string $path Full filename and path.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertFileExists($path, $message = "%s") {
- $message = sprintf($message, "File [$path] should exist");
- return $this->assertTrue(file_exists($path), $message);
- }
-
- /**
- * File non-existence check.
- * @param string $path Full filename and path.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertFileNotExists($path, $message = "%s") {
- $message = sprintf($message, "File [$path] should not exist");
- return $this->assertFalse(file_exists($path), $message);
- }
-
- /**
- * Scans a file for a Perl regex. If found
- * anywhere it passes, else it fails.
- * @param string $pattern Regex to search for.
- * @param string $path Full filename and path.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertFilePattern($pattern, $path, $message = "%s") {
- $shell = $this->_getShell();
- return $this->assertExpectation(
- new WantedPatternExpectation($pattern),
- implode('', file($path)),
- $message);
- }
-
- /**
- * If a Perl regex is found anywhere in the named
- * file then a failure is generated, else a pass.
- * @param string $pattern Regex to search for.
- * @param string $path Full filename and path.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoFilePattern($pattern, $path, $message = "%s") {
- $shell = $this->_getShell();
- return $this->assertExpectation(
- new UnwantedPatternExpectation($pattern),
- implode('', file($path)),
- $message);
- }
-
- /**
- * Accessor for current shell. Used for testing the
- * the tester itself.
- * @return Shell Current shell.
- * @access protected
- */
- function _getShell() {
- return $this->_current_shell;
- }
-
- /**
- * Factory for the shell to run the command on.
- * @return Shell New shell object.
- * @access protected
- */
- function _createShell() {
- return new SimpleShell();
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: shell_tester.php,v 1.14 2004/08/17 18:18:32 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/simple_test.php'); + /**#@-*/ + + /** + * Wrapper for exec() functionality. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleShell { + protected $_output; + + /** + * Executes the shell comand and stashes the output. + * @access public + */ + function SimpleShell() { + $this->_output = false; + } + + /** + * Actually runs the command. Does not trap the + * error stream output as this need PHP 4.3+. + * @param string $command The actual command line + * to run. + * @return integer Exit code. + * @access public + */ + function execute($command) { + $this->_output = false; + exec($command, $this->_output, $ret); + return $ret; + } + + /** + * Accessor for the last output. + * @return string Output as text. + * @access public + */ + function getOutput() { + return implode("\n", $this->_output); + } + + /** + * Accessor for the last output. + * @return array Output as array of lines. + * @access public + */ + function getOutputAsList() { + return $this->_output; + } + } + + /** + * Test case for testing of command line scripts and + * utilities. Usually scripts taht are external to the + * PHP code, but support it in some way. + * @package SimpleTest + * @subpackage UnitTester + */ + class ShellTestCase extends SimpleTestCase { + protected $_current_shell; + protected $_last_status; + protected $_last_command; + + /** + * Creates an empty test case. Should be subclassed + * with test methods for a functional test case. + * @param string $label Name of test case. Will use + * the class name if none specified. + * @access public + */ + function ShellTestCase($label = false) { + $this->SimpleTestCase($label); + $this->_current_shell = $this->_createShell(); + $this->_last_status = false; + $this->_last_command = ''; + } + + /** + * Executes a command and buffers the results. + * @param string $command Command to run. + * @return boolean True if zero exit code. + * @access public + */ + function execute($command) { + $shell = $this->_getShell(); + $this->_last_status = $shell->execute($command); + $this->_last_command = $command; + return ($this->_last_status === 0); + } + + /** + * Dumps the output of the last command. + * @access public + */ + function dumpOutput() { + $this->dump($this->getOutput()); + } + + /** + * Accessor for the last output. + * @return string Output as text. + * @access public + */ + function getOutput() { + $shell = $this->_getShell(); + return $shell->getOutput(); + } + + /** + * Accessor for the last output. + * @return array Output as array of lines. + * @access public + */ + function getOutputAsList() { + $shell = $this->_getShell(); + return $shell->getOutputAsList(); + } + + /** + * Tests the last status code from the shell. + * @param integer $status Expected status of last + * command. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertExitCode($status, $message = "%s") { + $message = sprintf($message, "Expected status code of [$status] from [" . + $this->_last_command . "], but got [" . + $this->_last_status . "]"); + return $this->assertTrue($status === $this->_last_status, $message); + } + + /** + * Attempt to exactly match the combined STDERR and + * STDOUT output. + * @param string $expected Expected output. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertOutput($expected, $message = "%s") { + $shell = $this->_getShell(); + return $this->assertExpectation( + new EqualExpectation($expected), + $shell->getOutput(), + $message); + } + + /** + * Scans the output for a Perl regex. If found + * anywhere it passes, else it fails. + * @param string $pattern Regex to search for. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertOutputPattern($pattern, $message = "%s") { + $shell = $this->_getShell(); + return $this->assertExpectation( + new WantedPatternExpectation($pattern), + $shell->getOutput(), + $message); + } + + /** + * If a Perl regex is found anywhere in the current + * output then a failure is generated, else a pass. + * @param string $pattern Regex to search for. + * @param $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertNoOutputPattern($pattern, $message = "%s") { + $shell = $this->_getShell(); + return $this->assertExpectation( + new UnwantedPatternExpectation($pattern), + $shell->getOutput(), + $message); + } + + /** + * File existence check. + * @param string $path Full filename and path. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertFileExists($path, $message = "%s") { + $message = sprintf($message, "File [$path] should exist"); + return $this->assertTrue(file_exists($path), $message); + } + + /** + * File non-existence check. + * @param string $path Full filename and path. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertFileNotExists($path, $message = "%s") { + $message = sprintf($message, "File [$path] should not exist"); + return $this->assertFalse(file_exists($path), $message); + } + + /** + * Scans a file for a Perl regex. If found + * anywhere it passes, else it fails. + * @param string $pattern Regex to search for. + * @param string $path Full filename and path. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertFilePattern($pattern, $path, $message = "%s") { + $shell = $this->_getShell(); + return $this->assertExpectation( + new WantedPatternExpectation($pattern), + implode('', file($path)), + $message); + } + + /** + * If a Perl regex is found anywhere in the named + * file then a failure is generated, else a pass. + * @param string $pattern Regex to search for. + * @param string $path Full filename and path. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertNoFilePattern($pattern, $path, $message = "%s") { + $shell = $this->_getShell(); + return $this->assertExpectation( + new UnwantedPatternExpectation($pattern), + implode('', file($path)), + $message); + } + + /** + * Accessor for current shell. Used for testing the + * the tester itself. + * @return Shell Current shell. + * @access protected + */ + function _getShell() { + return $this->_current_shell; + } + + /** + * Factory for the shell to run the command on. + * @return Shell New shell object. + * @access protected + */ + function _createShell() { + return new SimpleShell(); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/simple_test.php b/tests/test_tools/simpletest/simple_test.php index 519bac09..f2204f42 100644 --- a/tests/UnitTests/simpletest/simple_test.php +++ b/tests/test_tools/simpletest/simple_test.php @@ -1,553 +1,553 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: simple_test.php,v 1.89 2005/02/18 19:25:05 lastcraft Exp $
- */
-
- /**#@+
- * Includes SimpleTest files and defined the root constant
- * for dependent libraries.
- */
- require_once(dirname(__FILE__) . '/errors.php');
- require_once(dirname(__FILE__) . '/options.php');
- require_once(dirname(__FILE__) . '/runner.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__) . '/');
- }
- /**#@-*/
-
- /**
- * Basic test case. This is the smallest unit of a test
- * suite. It searches for
- * all methods that start with the the string "test" and
- * runs them. Working test cases extend this class.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleTestCase {
- protected $_label;
- protected $_runner;
-
- /**
- * Sets up the test with no display.
- * @param string $label If no test name is given then
- * the class name is used.
- * @access public
- */
- function SimpleTestCase($label = false) {
- $this->_label = $label ? $label : get_class($this);
- $this->_runner = false;
- }
-
- /**
- * Accessor for the test name for subclasses.
- * @return string Name of the test.
- * @access public
- */
- function getLabel() {
- return $this->_label;
- }
-
- /**
- * Used to invoke the single tests.
- * @return SimpleInvoker Individual test runner.
- * @access public
- */
- function createInvoker() {
- return new SimpleErrorTrappingInvoker(new SimpleInvoker($this));
- }
-
- /**
- * Can modify the incoming reporter so as to run
- * the tests differently. This version simply
- * passes it straight through.
- * @param SimpleReporter $reporter Incoming observer.
- * @return SimpleReporter
- * @access protected
- */
- function _createRunner($reporter) {
- return new SimpleRunner($this, $reporter);
- }
-
- /**
- * Uses reflection to run every method within itself
- * starting with the string "test" unless a method
- * is specified.
- * @param SimpleReporter $reporter Current test reporter.
- * @access public
- */
- function run($reporter) {
- $reporter->paintCaseStart($this->getLabel());
- $this->_runner = $this->_createRunner($reporter);
- $this->_runner->run();
- $reporter->paintCaseEnd($this->getLabel());
- return $reporter->getStatus();
- }
-
- /**
- * Sets up unit test wide variables at the start
- * of each test method. To be overridden in
- * actual user test cases.
- * @access public
- */
- function setUp() {
- }
-
- /**
- * Clears the data set in the setUp() method call.
- * To be overridden by the user in actual user test cases.
- * @access public
- */
- function tearDown() {
- }
-
- /**
- * Sends a pass event with a message.
- * @param string $message Message to send.
- * @access public
- */
- function pass($message = "Pass") {
- $this->_runner->paintPass($message . $this->getAssertionLine(' at line [%d]'));
- }
-
- /**
- * Sends a fail event with a message.
- * @param string $message Message to send.
- * @access public
- */
- function fail($message = "Fail") {
- $this->_runner->paintFail($message . $this->getAssertionLine(' at line [%d]'));
- }
-
- /**
- * Formats a PHP error and dispatches it to the
- * runner.
- * @param integer $severity PHP error code.
- * @param string $message Text of error.
- * @param string $file File error occoured in.
- * @param integer $line Line number of error.
- * @param hash $globals PHP super global arrays.
- * @access public
- */
- function error($severity, $message, $file, $line, $globals) {
- $severity = SimpleErrorQueue::getSeverityAsString($severity);
- $this->_runner->paintError(
- "Unexpected PHP error [$message] severity [$severity] in [$file] line [$line]");
- }
-
- /**
- * Sends a user defined event to the test runner.
- * This is for small scale extension where
- * both the test case and either the runner or
- * display are subclassed.
- * @param string $type Type of event.
- * @param mixed $payload Object or message to deliver.
- * @access public
- */
- function signal($type, $payload) {
- $this->_runner->paintSignal($type, $payload);
- }
-
- /**
- * Cancels any outstanding errors.
- * @access public
- */
- function swallowErrors() {
- $queue = SimpleErrorQueue::instance();
- $queue->clear();
- }
-
- /**
- * Runs an expectation directly, for extending the
- * tests with new expectation classes.
- * @param SimpleExpectation $expectation Expectation subclass.
- * @param mixed $test_value Value to compare.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertExpectation($expectation, $test_value, $message = '%s') {
- return $this->assertTrue(
- $expectation->test($test_value),
- sprintf($message, $expectation->overlayMessage($test_value)));
- }
-
- /**
- * Called from within the test methods to register
- * passes and failures.
- * @param boolean $result Pass on true.
- * @param string $message Message to display describing
- * the test state.
- * @return boolean True on pass
- * @access public
- */
- function assertTrue($result, $message = false) {
- if (! $message) {
- $message = 'True assertion got ' . ($result ? 'True' : 'False');
- }
- if ($result) {
- $this->pass($message);
- return true;
- } else {
- $this->fail($message);
- return false;
- }
- }
-
- /**
- * Will be true on false and vice versa. False
- * is the PHP definition of false, so that null,
- * empty strings, zero and an empty array all count
- * as false.
- * @param boolean $result Pass on false.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertFalse($result, $message = false) {
- if (! $message) {
- $message = 'False assertion got ' . ($result ? 'True' : 'False');
- }
- return $this->assertTrue(! $result, $message);
- }
-
- /**
- * Uses a stack trace to find the line of an assertion.
- * @param string $format String formatting.
- * @param array $stack Stack frames top most first. Only
- * needed if not using the PHP
- * backtrace function.
- * @return string Line number of first assert*
- * method embedded in format string.
- * @access public
- */
- function getAssertionLine($format = '%d', $stack = false) {
- if ($stack === false) {
- $stack = SimpleTestCompatibility::getStackTrace();
- }
- return SimpleDumper::getFormattedAssertionLine($stack, $format);
- }
-
- /**
- * Sends a formatted dump of a variable to the
- * test suite for those emergency debugging
- * situations.
- * @param mixed $variable Variable to display.
- * @param string $message Message to display.
- * @return mixed The original variable.
- * @access public
- */
- function dump($variable, $message = false) {
- $formatted = SimpleDumper::dump($variable);
- if ($message) {
- $formatted = $message . "\n" . $formatted;
- }
- $this->_runner->paintFormattedMessage($formatted);
- return $variable;
- }
-
- /**
- * Dispatches a text message straight to the
- * test suite. Useful for status bar displays.
- * @param string $message Message to show.
- * @access public
- */
- function sendMessage($message) {
- $this->_runner->PaintMessage($message);
- }
-
- /**
- * Accessor for the number of subtests.
- * @return integer Number of test cases.
- * @access public
- * @static
- */
- function getSize() {
- return 1;
- }
- }
-
- /**
- * This is a composite test class for combining
- * test cases and other RunnableTest classes into
- * a group test.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class GroupTest {
- protected $_label;
- protected $_test_cases;
- protected $_old_track_errors;
- protected $_xdebug_is_enabled;
-
- /**
- * Sets the name of the test suite.
- * @param string $label Name sent at the start and end
- * of the test.
- * @access public
- */
- function GroupTest($label) {
- $this->_label = $label;
- $this->_test_cases = array();
- $this->_old_track_errors = ini_get('track_errors');
- $this->_xdebug_is_enabled = function_exists('xdebug_is_enabled') ?
- xdebug_is_enabled() : false;
- }
-
- /**
- * Accessor for the test name for subclasses.
- * @return string Name of the test.
- * @access public
- */
- function getLabel() {
- return $this->_label;
- }
-
- /**
- * Adds a test into the suite. Can be either a group
- * test or some other unit test.
- * @param SimpleTestCase $test_case Suite or individual test
- * case implementing the
- * runnable test interface.
- * @access public
- */
- function addTestCase($test_case) {
- $this->_test_cases[] = $test_case;
- }
-
- /**
- * Adds a test into the suite by class name. The class will
- * be instantiated as needed.
- * @param SimpleTestCase $test_case Suite or individual test
- * case implementing the
- * runnable test interface.
- * @access public
- */
- function addTestClass($class) {
- $this->_test_cases[] = $class;
- }
-
- /**
- * Builds a group test from a library of test cases.
- * The new group is composed into this one.
- * @param string $test_file File name of library with
- * test case classes.
- * @access public
- */
- function addTestFile($test_file) {
- $existing_classes = get_declared_classes();
- if ($error = $this->_requireWithError($test_file)) {
- $this->addTestCase(new BadGroupTest($test_file, $error));
- return;
- }
- $classes = $this->_selectRunnableTests($existing_classes, get_declared_classes());
- if (count($classes) == 0) {
- $this->addTestCase(new BadGroupTest($test_file, 'No new test cases'));
- return;
- }
- $this->addTestCase($this->_createGroupFromClasses($test_file, $classes));
- }
-
- /**
- * Requires a source file recording any syntax errors.
- * @param string $file File name to require in.
- * @return string/boolean An error message on failure or false
- * if no errors.
- * @access private
- */
- function _requireWithError($file) {
- $this->_enableErrorReporting();
- include($file);
- $error = isset($php_errormsg) ? $php_errormsg : false;
- $this->_disableErrorReporting();
- $self_inflicted = array(
- 'Assigning the return value of new by reference is deprecated',
- 'var: Deprecated. Please use the public/private/protected modifiers');
- if (in_array($error, $self_inflicted)) {
- return false;
- }
- return $error;
- }
-
- /**
- * Sets up detection of parse errors. Note that XDebug
- * interferes with this and has to be disabled. This is
- * to make sure the correct error code is returned
- * from unattended scripts.
- * @access private
- */
- function _enableErrorReporting() {
- if ($this->_xdebug_is_enabled) {
- xdebug_disable();
- }
- ini_set('track_errors', true);
- }
-
- /**
- * Resets detection of parse errors to their old values.
- * This is to make sure the correct error code is returned
- * from unattended scripts.
- * @access private
- */
- function _disableErrorReporting() {
- ini_set('track_errors', $this->_old_track_errors);
- if ($this->_xdebug_is_enabled) {
- xdebug_enable();
- }
- }
-
- /**
- * Calculates the incoming test cases from a before
- * and after list of loaded classes.
- * @param array $existing_classes Classes before require().
- * @param array $new_classes Classes after require().
- * @return array New classes which are test
- * cases that shouldn't be ignored.
- * @access private
- */
- function _selectRunnableTests($existing_classes, $new_classes) {
- $classes = array();
- foreach ($new_classes as $class) {
- if (in_array($class, $existing_classes)) {
- continue;
- }
- if (! $this->_isTestCase($class)) {
- continue;
- }
- $classes[] = $class;
- }
- return $classes;
- }
-
- /**
- * Builds a group test from a class list.
- * @param string $title Title of new group.
- * @param array $classes Test classes.
- * @return GroupTest Group loaded with the new
- * test cases.
- * @access private
- */
- function _createGroupFromClasses($title, $classes) {
- $group = new GroupTest($title);
- foreach ($classes as $class) {
- if (SimpleTestOptions::isIgnored($class)) {
- continue;
- }
- $group->addTestClass($class);
- }
- return $group;
- }
-
- /**
- * Test to see if a class is derived from the
- * TestCase class.
- * @param string $class Class name.
- * @access private
- */
- function _isTestCase($class) {
- while ($class = get_parent_class($class)) {
- $class = strtolower($class);
- if ($class == "simpletestcase" || $class == "grouptest") {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Invokes run() on all of the held test cases, instantiating
- * them if necessary.
- * @param SimpleReporter $reporter Current test reporter.
- * @access public
- */
- function run($reporter) {
- $reporter->paintGroupStart($this->getLabel(), $this->getSize());
- for ($i = 0, $count = count($this->_test_cases); $i < $count; $i++) {
- if (is_string($this->_test_cases[$i])) {
- $class = $this->_test_cases[$i];
- $test = new $class();
- $test->run($reporter);
- } else {
- $this->_test_cases[$i]->run($reporter);
- }
- }
- $reporter->paintGroupEnd($this->getLabel());
- return $reporter->getStatus();
- }
-
- /**
- * Number of contained test cases.
- * @return integer Total count of cases in the group.
- * @access public
- */
- function getSize() {
- $count = 0;
- foreach ($this->_test_cases as $case) {
- if (is_string($case)) {
- $count++;
- } else {
- $count += $case->getSize();
- }
- }
- return $count;
- }
- }
-
- /**
- * This is a failing group test for when a test suite hasn't
- * loaded properly.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class BadGroupTest {
- protected $_label;
- protected $_error;
-
- /**
- * Sets the name of the test suite and error message.
- * @param string $label Name sent at the start and end
- * of the test.
- * @access public
- */
- function BadGroupTest($label, $error) {
- $this->_label = $label;
- $this->_error = $error;
- }
-
- /**
- * Accessor for the test name for subclasses.
- * @return string Name of the test.
- * @access public
- */
- function getLabel() {
- return $this->_label;
- }
-
- /**
- * Sends a single error to the reporter.
- * @param SimpleReporter $reporter Current test reporter.
- * @access public
- */
- function run($reporter) {
- $reporter->paintGroupStart($this->getLabel(), $this->getSize());
- $reporter->paintFail('Bad GroupTest [' . $this->getLabel() .
- '] with error [' . $this->_error . ']');
- $reporter->paintGroupEnd($this->getLabel());
- return $reporter->getStatus();
- }
-
- /**
- * Number of contained test cases. Always zero.
- * @return integer Total count of cases in the group.
- * @access public
- */
- function getSize() {
- return 0;
- }
- }
-?>
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: simple_test.php,v 1.89 2005/02/18 19:25:05 lastcraft Exp $ + */ + + /**#@+ + * Includes SimpleTest files and defined the root constant + * for dependent libraries. + */ + require_once(dirname(__FILE__) . '/errors.php'); + require_once(dirname(__FILE__) . '/options.php'); + require_once(dirname(__FILE__) . '/runner.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__) . '/'); + } + /**#@-*/ + + /** + * Basic test case. This is the smallest unit of a test + * suite. It searches for + * all methods that start with the the string "test" and + * runs them. Working test cases extend this class. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleTestCase { + protected $_label; + protected $_runner; + + /** + * Sets up the test with no display. + * @param string $label If no test name is given then + * the class name is used. + * @access public + */ + function SimpleTestCase($label = false) { + $this->_label = $label ? $label : get_class($this); + $this->_runner = false; + } + + /** + * Accessor for the test name for subclasses. + * @return string Name of the test. + * @access public + */ + function getLabel() { + return $this->_label; + } + + /** + * Used to invoke the single tests. + * @return SimpleInvoker Individual test runner. + * @access public + */ + function createInvoker() { + return new SimpleErrorTrappingInvoker(new SimpleInvoker($this)); + } + + /** + * Can modify the incoming reporter so as to run + * the tests differently. This version simply + * passes it straight through. + * @param SimpleReporter $reporter Incoming observer. + * @return SimpleReporter + * @access protected + */ + function _createRunner($reporter) { + return new SimpleRunner($this, $reporter); + } + + /** + * Uses reflection to run every method within itself + * starting with the string "test" unless a method + * is specified. + * @param SimpleReporter $reporter Current test reporter. + * @access public + */ + function run($reporter) { + $reporter->paintCaseStart($this->getLabel()); + $this->_runner = $this->_createRunner($reporter); + $this->_runner->run(); + $reporter->paintCaseEnd($this->getLabel()); + return $reporter->getStatus(); + } + + /** + * Sets up unit test wide variables at the start + * of each test method. To be overridden in + * actual user test cases. + * @access public + */ + function setUp() { + } + + /** + * Clears the data set in the setUp() method call. + * To be overridden by the user in actual user test cases. + * @access public + */ + function tearDown() { + } + + /** + * Sends a pass event with a message. + * @param string $message Message to send. + * @access public + */ + function pass($message = "Pass") { + $this->_runner->paintPass($message . $this->getAssertionLine(' at line [%d]')); + } + + /** + * Sends a fail event with a message. + * @param string $message Message to send. + * @access public + */ + function fail($message = "Fail") { + $this->_runner->paintFail($message . $this->getAssertionLine(' at line [%d]')); + } + + /** + * Formats a PHP error and dispatches it to the + * runner. + * @param integer $severity PHP error code. + * @param string $message Text of error. + * @param string $file File error occoured in. + * @param integer $line Line number of error. + * @param hash $globals PHP super global arrays. + * @access public + */ + function error($severity, $message, $file, $line, $globals) { + $severity = SimpleErrorQueue::getSeverityAsString($severity); + $this->_runner->paintError( + "Unexpected PHP error [$message] severity [$severity] in [$file] line [$line]"); + } + + /** + * Sends a user defined event to the test runner. + * This is for small scale extension where + * both the test case and either the runner or + * display are subclassed. + * @param string $type Type of event. + * @param mixed $payload Object or message to deliver. + * @access public + */ + function signal($type, $payload) { + $this->_runner->paintSignal($type, $payload); + } + + /** + * Cancels any outstanding errors. + * @access public + */ + function swallowErrors() { + $queue = SimpleErrorQueue::instance(); + $queue->clear(); + } + + /** + * Runs an expectation directly, for extending the + * tests with new expectation classes. + * @param SimpleExpectation $expectation Expectation subclass. + * @param mixed $test_value Value to compare. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertExpectation($expectation, $test_value, $message = '%s') { + return $this->assertTrue( + $expectation->test($test_value), + sprintf($message, $expectation->overlayMessage($test_value))); + } + + /** + * Called from within the test methods to register + * passes and failures. + * @param boolean $result Pass on true. + * @param string $message Message to display describing + * the test state. + * @return boolean True on pass + * @access public + */ + function assertTrue($result, $message = false) { + if (! $message) { + $message = 'True assertion got ' . ($result ? 'True' : 'False'); + } + if ($result) { + $this->pass($message); + return true; + } else { + $this->fail($message); + return false; + } + } + + /** + * Will be true on false and vice versa. False + * is the PHP definition of false, so that null, + * empty strings, zero and an empty array all count + * as false. + * @param boolean $result Pass on false. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertFalse($result, $message = false) { + if (! $message) { + $message = 'False assertion got ' . ($result ? 'True' : 'False'); + } + return $this->assertTrue(! $result, $message); + } + + /** + * Uses a stack trace to find the line of an assertion. + * @param string $format String formatting. + * @param array $stack Stack frames top most first. Only + * needed if not using the PHP + * backtrace function. + * @return string Line number of first assert* + * method embedded in format string. + * @access public + */ + function getAssertionLine($format = '%d', $stack = false) { + if ($stack === false) { + $stack = SimpleTestCompatibility::getStackTrace(); + } + return SimpleDumper::getFormattedAssertionLine($stack, $format); + } + + /** + * Sends a formatted dump of a variable to the + * test suite for those emergency debugging + * situations. + * @param mixed $variable Variable to display. + * @param string $message Message to display. + * @return mixed The original variable. + * @access public + */ + function dump($variable, $message = false) { + $formatted = SimpleDumper::dump($variable); + if ($message) { + $formatted = $message . "\n" . $formatted; + } + $this->_runner->paintFormattedMessage($formatted); + return $variable; + } + + /** + * Dispatches a text message straight to the + * test suite. Useful for status bar displays. + * @param string $message Message to show. + * @access public + */ + function sendMessage($message) { + $this->_runner->PaintMessage($message); + } + + /** + * Accessor for the number of subtests. + * @return integer Number of test cases. + * @access public + * @static + */ + function getSize() { + return 1; + } + } + + /** + * This is a composite test class for combining + * test cases and other RunnableTest classes into + * a group test. + * @package SimpleTest + * @subpackage UnitTester + */ + class GroupTest { + protected $_label; + protected $_test_cases; + protected $_old_track_errors; + protected $_xdebug_is_enabled; + + /** + * Sets the name of the test suite. + * @param string $label Name sent at the start and end + * of the test. + * @access public + */ + function GroupTest($label) { + $this->_label = $label; + $this->_test_cases = array(); + $this->_old_track_errors = ini_get('track_errors'); + $this->_xdebug_is_enabled = function_exists('xdebug_is_enabled') ? + xdebug_is_enabled() : false; + } + + /** + * Accessor for the test name for subclasses. + * @return string Name of the test. + * @access public + */ + function getLabel() { + return $this->_label; + } + + /** + * Adds a test into the suite. Can be either a group + * test or some other unit test. + * @param SimpleTestCase $test_case Suite or individual test + * case implementing the + * runnable test interface. + * @access public + */ + function addTestCase($test_case) { + $this->_test_cases[] = $test_case; + } + + /** + * Adds a test into the suite by class name. The class will + * be instantiated as needed. + * @param SimpleTestCase $test_case Suite or individual test + * case implementing the + * runnable test interface. + * @access public + */ + function addTestClass($class) { + $this->_test_cases[] = $class; + } + + /** + * Builds a group test from a library of test cases. + * The new group is composed into this one. + * @param string $test_file File name of library with + * test case classes. + * @access public + */ + function addTestFile($test_file) { + $existing_classes = get_declared_classes(); + if ($error = $this->_requireWithError($test_file)) { + $this->addTestCase(new BadGroupTest($test_file, $error)); + return; + } + $classes = $this->_selectRunnableTests($existing_classes, get_declared_classes()); + if (count($classes) == 0) { + $this->addTestCase(new BadGroupTest($test_file, 'No new test cases')); + return; + } + $this->addTestCase($this->_createGroupFromClasses($test_file, $classes)); + } + + /** + * Requires a source file recording any syntax errors. + * @param string $file File name to require in. + * @return string/boolean An error message on failure or false + * if no errors. + * @access private + */ + function _requireWithError($file) { + $this->_enableErrorReporting(); + include($file); + $error = isset($php_errormsg) ? $php_errormsg : false; + $this->_disableErrorReporting(); + $self_inflicted = array( + 'Assigning the return value of new by reference is deprecated', + 'var: Deprecated. Please use the public/private/protected modifiers'); + if (in_array($error, $self_inflicted)) { + return false; + } + return $error; + } + + /** + * Sets up detection of parse errors. Note that XDebug + * interferes with this and has to be disabled. This is + * to make sure the correct error code is returned + * from unattended scripts. + * @access private + */ + function _enableErrorReporting() { + if ($this->_xdebug_is_enabled) { + xdebug_disable(); + } + ini_set('track_errors', true); + } + + /** + * Resets detection of parse errors to their old values. + * This is to make sure the correct error code is returned + * from unattended scripts. + * @access private + */ + function _disableErrorReporting() { + ini_set('track_errors', $this->_old_track_errors); + if ($this->_xdebug_is_enabled) { + xdebug_enable(); + } + } + + /** + * Calculates the incoming test cases from a before + * and after list of loaded classes. + * @param array $existing_classes Classes before require(). + * @param array $new_classes Classes after require(). + * @return array New classes which are test + * cases that shouldn't be ignored. + * @access private + */ + function _selectRunnableTests($existing_classes, $new_classes) { + $classes = array(); + foreach ($new_classes as $class) { + if (in_array($class, $existing_classes)) { + continue; + } + if (! $this->_isTestCase($class)) { + continue; + } + $classes[] = $class; + } + return $classes; + } + + /** + * Builds a group test from a class list. + * @param string $title Title of new group. + * @param array $classes Test classes. + * @return GroupTest Group loaded with the new + * test cases. + * @access private + */ + function _createGroupFromClasses($title, $classes) { + $group = new GroupTest($title); + foreach ($classes as $class) { + if (SimpleTestOptions::isIgnored($class)) { + continue; + } + $group->addTestClass($class); + } + return $group; + } + + /** + * Test to see if a class is derived from the + * TestCase class. + * @param string $class Class name. + * @access private + */ + function _isTestCase($class) { + while ($class = get_parent_class($class)) { + $class = strtolower($class); + if ($class == "simpletestcase" || $class == "grouptest") { + return true; + } + } + return false; + } + + /** + * Invokes run() on all of the held test cases, instantiating + * them if necessary. + * @param SimpleReporter $reporter Current test reporter. + * @access public + */ + function run($reporter) { + $reporter->paintGroupStart($this->getLabel(), $this->getSize()); + for ($i = 0, $count = count($this->_test_cases); $i < $count; $i++) { + if (is_string($this->_test_cases[$i])) { + $class = $this->_test_cases[$i]; + $test = new $class(); + $test->run($reporter); + } else { + $this->_test_cases[$i]->run($reporter); + } + } + $reporter->paintGroupEnd($this->getLabel()); + return $reporter->getStatus(); + } + + /** + * Number of contained test cases. + * @return integer Total count of cases in the group. + * @access public + */ + function getSize() { + $count = 0; + foreach ($this->_test_cases as $case) { + if (is_string($case)) { + $count++; + } else { + $count += $case->getSize(); + } + } + return $count; + } + } + + /** + * This is a failing group test for when a test suite hasn't + * loaded properly. + * @package SimpleTest + * @subpackage UnitTester + */ + class BadGroupTest { + protected $_label; + protected $_error; + + /** + * Sets the name of the test suite and error message. + * @param string $label Name sent at the start and end + * of the test. + * @access public + */ + function BadGroupTest($label, $error) { + $this->_label = $label; + $this->_error = $error; + } + + /** + * Accessor for the test name for subclasses. + * @return string Name of the test. + * @access public + */ + function getLabel() { + return $this->_label; + } + + /** + * Sends a single error to the reporter. + * @param SimpleReporter $reporter Current test reporter. + * @access public + */ + function run($reporter) { + $reporter->paintGroupStart($this->getLabel(), $this->getSize()); + $reporter->paintFail('Bad GroupTest [' . $this->getLabel() . + '] with error [' . $this->_error . ']'); + $reporter->paintGroupEnd($this->getLabel()); + return $reporter->getStatus(); + } + + /** + * Number of contained test cases. Always zero. + * @return integer Total count of cases in the group. + * @access public + */ + function getSize() { + return 0; + } + } +?> diff --git a/tests/UnitTests/simpletest/socket.php b/tests/test_tools/simpletest/socket.php index 77ee9c71..4c3c592d 100644 --- a/tests/UnitTests/simpletest/socket.php +++ b/tests/test_tools/simpletest/socket.php @@ -1,216 +1,216 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage MockObjects
- * @version $Id: socket.php,v 1.23 2004/09/30 16:46:31 lastcraft Exp $
- */
-
- /**#@+
- * include SimpleTest files
- */
- require_once(dirname(__FILE__) . '/options.php');
- /**#@-*/
-
- /**
- * Stashes an error for later. Useful for constructors
- * until PHP gets exceptions.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleStickyError {
- protected $_error = 'Constructor not chained';
-
- /**
- * Sets the error to empty.
- * @access public
- */
- function SimpleStickyError() {
- $this->_clearError();
- }
-
- /**
- * Test for an outstanding error.
- * @return boolean True if there is an error.
- * @access public
- */
- function isError() {
- return ($this->_error != '');
- }
-
- /**
- * Accessor for an outstanding error.
- * @return string Empty string if no error otherwise
- * the error message.
- * @access public
- */
- function getError() {
- return $this->_error;
- }
-
- /**
- * Sets the internal error.
- * @param string Error message to stash.
- * @access protected
- */
- function _setError($error) {
- $this->_error = $error;
- }
-
- /**
- * Resets the error state to no error.
- * @access protected
- */
- function _clearError() {
- $this->_setError('');
- }
- }
-
- /**
- * Wrapper for TCP/IP socket.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleSocket extends SimpleStickyError {
- protected $_handle;
- protected $_is_open;
- protected $_sent;
-
- /**
- * Opens a socket for reading and writing.
- * @param string $host Hostname to send request to.
- * @param integer $port Port on remote machine to open.
- * @param integer $timeout Connection timeout in seconds.
- * @access public
- */
- function SimpleSocket($host, $port, $timeout) {
- $this->SimpleStickyError();
- $this->_is_open = false;
- $this->_sent = '';
- if (! ($this->_handle = $this->_openSocket($host, $port, $error_number, $error, $timeout))) {
- $this->_setError("Cannot open [$host:$port] with [$error] within [$timeout] seconds");
- return;
- }
- $this->_is_open = true;
- SimpleTestCompatibility::setTimeout($this->_handle, $timeout);
- }
-
- /**
- * Writes some data to the socket and saves alocal copy.
- * @param string $message String to send to socket.
- * @return boolean True if successful.
- * @access public
- */
- function write($message) {
- if ($this->isError() || ! $this->isOpen()) {
- return false;
- }
- $count = fwrite($this->_handle, $message);
- if (! $count) {
- if ($count === false) {
- $this->_setError('Cannot write to socket');
- $this->close();
- }
- return false;
- }
- fflush($this->_handle);
- $this->_sent .= $message;
- return true;
- }
-
- /**
- * Reads data from the socket. The error suppresion
- * is a workaround for PHP4 always throwing a warning
- * with a secure socket.
- * @param integer $block_size Size of chunk to read.
- * @return integer Incoming bytes. False
- * on error.
- * @access public
- */
- function read($block_size = 255) {
- if ($this->isError() || ! $this->isOpen()) {
- return false;
- }
- $raw = @fread($this->_handle, $block_size);
- if ($raw === false) {
- $this->_setError('Cannot read from socket');
- $this->close();
- }
- return $raw;
- }
-
- /**
- * Accessor for socket open state.
- * @return boolean True if open.
- * @access public
- */
- function isOpen() {
- return $this->_is_open;
- }
-
- /**
- * Closes the socket preventing further reads.
- * Cannot be reopened once closed.
- * @return boolean True if successful.
- * @access public
- */
- function close() {
- $this->_is_open = false;
- return fclose($this->_handle);
- }
-
- /**
- * Accessor for content so far.
- * @return string Bytes sent only.
- * @access public
- */
- function getSent() {
- return $this->_sent;
- }
-
- /**
- * Actually opens the low level socket.
- * @param string $host Host to connect to.
- * @param integer $port Port on host.
- * @param integer $error_number Recipient of error code.
- * @param string $error Recipoent of error message.
- * @param integer $timeout Maximum time to wait for connection.
- * @access protected
- */
- function _openSocket($host, $port, $error_number, $error, $timeout) {
- return @fsockopen($host, $port, $error_number, $error, $timeout);
- }
- }
-
- /**
- * Wrapper for TCP/IP socket over TLS.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleSecureSocket extends SimpleSocket {
-
- /**
- * Opens a secure socket for reading and writing.
- * @param string $host Hostname to send request to.
- * @param integer $port Port on remote machine to open.
- * @param integer $timeout Connection timeout in seconds.
- * @access public
- */
- function SimpleSecureSocket($host, $port, $timeout) {
- $this->SimpleSocket($host, $port, $timeout);
- }
-
- /**
- * Actually opens the low level socket.
- * @param string $host Host to connect to.
- * @param integer $port Port on host.
- * @param integer $error_number Recipient of error code.
- * @param string $error Recipient of error message.
- * @param integer $timeout Maximum time to wait for connection.
- * @access protected
- */
- function _openSocket($host, $port, $error_number, $error, $timeout) {
- return parent::_openSocket("tls://$host", $port, $error_number, $error, $timeout);
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage MockObjects + * @version $Id: socket.php,v 1.23 2004/09/30 16:46:31 lastcraft Exp $ + */ + + /**#@+ + * include SimpleTest files + */ + require_once(dirname(__FILE__) . '/options.php'); + /**#@-*/ + + /** + * Stashes an error for later. Useful for constructors + * until PHP gets exceptions. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleStickyError { + protected $_error = 'Constructor not chained'; + + /** + * Sets the error to empty. + * @access public + */ + function SimpleStickyError() { + $this->_clearError(); + } + + /** + * Test for an outstanding error. + * @return boolean True if there is an error. + * @access public + */ + function isError() { + return ($this->_error != ''); + } + + /** + * Accessor for an outstanding error. + * @return string Empty string if no error otherwise + * the error message. + * @access public + */ + function getError() { + return $this->_error; + } + + /** + * Sets the internal error. + * @param string Error message to stash. + * @access protected + */ + function _setError($error) { + $this->_error = $error; + } + + /** + * Resets the error state to no error. + * @access protected + */ + function _clearError() { + $this->_setError(''); + } + } + + /** + * Wrapper for TCP/IP socket. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleSocket extends SimpleStickyError { + protected $_handle; + protected $_is_open; + protected $_sent; + + /** + * Opens a socket for reading and writing. + * @param string $host Hostname to send request to. + * @param integer $port Port on remote machine to open. + * @param integer $timeout Connection timeout in seconds. + * @access public + */ + function SimpleSocket($host, $port, $timeout) { + $this->SimpleStickyError(); + $this->_is_open = false; + $this->_sent = ''; + if (! ($this->_handle = $this->_openSocket($host, $port, $error_number, $error, $timeout))) { + $this->_setError("Cannot open [$host:$port] with [$error] within [$timeout] seconds"); + return; + } + $this->_is_open = true; + SimpleTestCompatibility::setTimeout($this->_handle, $timeout); + } + + /** + * Writes some data to the socket and saves alocal copy. + * @param string $message String to send to socket. + * @return boolean True if successful. + * @access public + */ + function write($message) { + if ($this->isError() || ! $this->isOpen()) { + return false; + } + $count = fwrite($this->_handle, $message); + if (! $count) { + if ($count === false) { + $this->_setError('Cannot write to socket'); + $this->close(); + } + return false; + } + fflush($this->_handle); + $this->_sent .= $message; + return true; + } + + /** + * Reads data from the socket. The error suppresion + * is a workaround for PHP4 always throwing a warning + * with a secure socket. + * @param integer $block_size Size of chunk to read. + * @return integer Incoming bytes. False + * on error. + * @access public + */ + function read($block_size = 255) { + if ($this->isError() || ! $this->isOpen()) { + return false; + } + $raw = @fread($this->_handle, $block_size); + if ($raw === false) { + $this->_setError('Cannot read from socket'); + $this->close(); + } + return $raw; + } + + /** + * Accessor for socket open state. + * @return boolean True if open. + * @access public + */ + function isOpen() { + return $this->_is_open; + } + + /** + * Closes the socket preventing further reads. + * Cannot be reopened once closed. + * @return boolean True if successful. + * @access public + */ + function close() { + $this->_is_open = false; + return fclose($this->_handle); + } + + /** + * Accessor for content so far. + * @return string Bytes sent only. + * @access public + */ + function getSent() { + return $this->_sent; + } + + /** + * Actually opens the low level socket. + * @param string $host Host to connect to. + * @param integer $port Port on host. + * @param integer $error_number Recipient of error code. + * @param string $error Recipoent of error message. + * @param integer $timeout Maximum time to wait for connection. + * @access protected + */ + function _openSocket($host, $port, $error_number, $error, $timeout) { + return @fsockopen($host, $port, $error_number, $error, $timeout); + } + } + + /** + * Wrapper for TCP/IP socket over TLS. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleSecureSocket extends SimpleSocket { + + /** + * Opens a secure socket for reading and writing. + * @param string $host Hostname to send request to. + * @param integer $port Port on remote machine to open. + * @param integer $timeout Connection timeout in seconds. + * @access public + */ + function SimpleSecureSocket($host, $port, $timeout) { + $this->SimpleSocket($host, $port, $timeout); + } + + /** + * Actually opens the low level socket. + * @param string $host Host to connect to. + * @param integer $port Port on host. + * @param integer $error_number Recipient of error code. + * @param string $error Recipient of error message. + * @param integer $timeout Maximum time to wait for connection. + * @access protected + */ + function _openSocket($host, $port, $error_number, $error, $timeout) { + return parent::_openSocket("tls://$host", $port, $error_number, $error, $timeout); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/tag.php b/tests/test_tools/simpletest/tag.php index dd674da2..9386712a 100644 --- a/tests/UnitTests/simpletest/tag.php +++ b/tests/test_tools/simpletest/tag.php @@ -1,1241 +1,1241 @@ -<?php
- /**
- * Base include file for SimpleTest.
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: tag.php,v 1.73 2005/02/02 22:49:36 lastcraft Exp $
- */
-
- /**#@+
- * include SimpleTest files
- */
- require_once(dirname(__FILE__) . '/parser.php');
- /**#@-*/
-
- /**
- * HTML or XML tag.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleTag {
- protected $_name;
- protected $_attributes;
- protected $_content;
-
- /**
- * Starts with a named tag with attributes only.
- * @param string $name Tag name.
- * @param hash $attributes Attribute names and
- * string values. Note that
- * the keys must have been
- * converted to lower case.
- */
- function SimpleTag($name, $attributes) {
- $this->_name = $name;
- $this->_attributes = $attributes;
- $this->_content = '';
- }
-
- /**
- * Check to see if the tag can have both start and
- * end tags with content in between.
- * @return boolean True if content allowed.
- * @access public
- */
- function expectEndTag() {
- return true;
- }
-
- /**
- * Appends string content to the current content.
- * @param string $content Additional text.
- * @access public
- */
- function addContent($content) {
- $this->_content .= (string)$content;
- }
-
- /**
- * Adds an enclosed tag to the content.
- * @param SimpleTag $tag New tag.
- * @access public
- */
- function addTag($tag) {
- }
-
- /**
- * Accessor for tag name.
- * @return string Name of tag.
- * @access public
- */
- function getTagName() {
- return $this->_name;
- }
-
- /**
- * List oflegal child elements.
- * @return array List of element names.
- * @access public
- */
- function getChildElements() {
- return array();
- }
-
- /**
- * Accessor for an attribute.
- * @param string $label Attribute name.
- * @return string Attribute value.
- * @access public
- */
- function getAttribute($label) {
- $label = strtolower($label);
- if (! isset($this->_attributes[$label])) {
- return false;
- }
- if ($this->_attributes[$label] === '') {
- return true;
- }
- return (string)$this->_attributes[$label];
- }
-
- /**
- * Sets an attribute.
- * @param string $label Attribute name.
- * @return string $value New attribute value.
- * @access protected
- */
- function _setAttribute($label, $value) {
- $this->_attributes[strtolower($label)] = $value;
- }
-
- /**
- * Accessor for the whole content so far.
- * @return string Content as big raw string.
- * @access public
- */
- function getContent() {
- return $this->_content;
- }
-
- /**
- * Accessor for content reduced to visible text. Acts
- * like a text mode browser, normalising space and
- * reducing images to their alt text.
- * @return string Content as plain text.
- * @access public
- */
- function getText() {
- return SimpleSaxParser::normalise($this->_content);
- }
-
- /**
- * Test to see if id attribute matches.
- * @param string $id ID to test against.
- * @return boolean True on match.
- * @access public
- */
- function isId($id) {
- return ($this->getAttribute('id') == $id);
- }
- }
-
- /**
- * Page title.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleTitleTag extends SimpleTag {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleTitleTag($attributes) {
- $this->SimpleTag('title', $attributes);
- }
- }
-
- /**
- * Link.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleAnchorTag extends SimpleTag {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleAnchorTag($attributes) {
- $this->SimpleTag('a', $attributes);
- }
-
- /**
- * Accessor for URL as string.
- * @return string Coerced as string.
- * @access public
- */
- function getHref() {
- $url = $this->getAttribute('href');
- if (is_bool($url)) {
- $url = '';
- }
- return $url;
- }
- }
-
- /**
- * Form element.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleWidget extends SimpleTag {
- protected $_value;
- protected $_is_set;
-
- /**
- * Starts with a named tag with attributes only.
- * @param string $name Tag name.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleWidget($name, $attributes) {
- $this->SimpleTag($name, $attributes);
- $this->_value = false;
- $this->_is_set = false;
- }
-
- /**
- * Accessor for name submitted as the key in
- * GET/POST variables hash.
- * @return string Parsed value.
- * @access public
- */
- function getName() {
- return $this->getAttribute('name');
- }
-
- /**
- * Accessor for default value parsed with the tag.
- * @return string Parsed value.
- * @access public
- */
- function getDefault() {
- $default = $this->getAttribute('value');
- if ($default === true) {
- $default = '';
- }
- if ($default === false) {
- $default = '';
- }
- return $default;
- }
-
- /**
- * Accessor for currently set value or default if
- * none.
- * @return string Value set by form or default
- * if none.
- * @access public
- */
- function getValue() {
- if (! $this->_is_set) {
- return $this->getDefault();
- }
- return $this->_value;
- }
-
- /**
- * Sets the current form element value.
- * @param string $value New value.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- $this->_value = $value;
- $this->_is_set = true;
- return true;
- }
-
- /**
- * Resets the form element value back to the
- * default.
- * @access public
- */
- function resetValue() {
- $this->_is_set = false;
- }
- }
-
- /**
- * Text, password and hidden field.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleTextTag extends SimpleWidget {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleTextTag($attributes) {
- $this->SimpleWidget('input', $attributes);
- if ($this->getAttribute('value') === false) {
- $this->_setAttribute('value', '');
- }
- }
-
- /**
- * Tag contains no content.
- * @return boolean False.
- * @access public
- */
- function expectEndTag() {
- return false;
- }
-
- /**
- * Sets the current form element value. Cannot
- * change the value of a hidden field.
- * @param string $value New value.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- if ($this->getAttribute('type') == 'hidden') {
- return false;
- }
- return parent::setValue($value);
- }
- }
-
- /**
- * Submit button as input tag.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleSubmitTag extends SimpleWidget {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleSubmitTag($attributes) {
- $this->SimpleWidget('input', $attributes);
- if ($this->getAttribute('name') === false) {
- $this->_setAttribute('name', 'submit');
- }
- if ($this->getAttribute('value') === false) {
- $this->_setAttribute('value', 'Submit');
- }
- }
-
- /**
- * Tag contains no end element.
- * @return boolean False.
- * @access public
- */
- function expectEndTag() {
- return false;
- }
-
- /**
- * Disables the setting of the button value.
- * @param string $value Ignored.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- return false;
- }
-
- /**
- * Value of browser visible text.
- * @return string Visible label.
- * @access public
- */
- function getLabel() {
- return $this->getValue();
- }
-
- /**
- * Gets the values submitted as a form.
- * @return array Hash of name and values.
- * @access public
- */
- function getSubmitValues() {
- return array($this->getName() => $this->getValue());
- }
- }
-
- /**
- * Image button as input tag.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleImageSubmitTag extends SimpleWidget {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleImageSubmitTag($attributes) {
- $this->SimpleWidget('input', $attributes);
- }
-
- /**
- * Tag contains no end element.
- * @return boolean False.
- * @access public
- */
- function expectEndTag() {
- return false;
- }
-
- /**
- * Disables the setting of the button value.
- * @param string $value Ignored.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- return false;
- }
-
- /**
- * Value of browser visible text.
- * @return string Visible label.
- * @access public
- */
- function getLabel() {
- if ($this->getAttribute('title')) {
- return $this->getAttribute('title');
- }
- return $this->getAttribute('alt');
- }
-
- /**
- * Gets the values submitted as a form.
- * @return array Hash of name and values.
- * @access public
- */
- function getSubmitValues($x, $y) {
- return array(
- $this->getName() . '.x' => $x,
- $this->getName() . '.y' => $y);
- }
- }
-
- /**
- * Submit button as button tag.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleButtonTag extends SimpleWidget {
-
- /**
- * Starts with a named tag with attributes only.
- * Defaults are very browser dependent.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleButtonTag($attributes) {
- $this->SimpleWidget('button', $attributes);
- }
-
- /**
- * Check to see if the tag can have both start and
- * end tags with content in between.
- * @return boolean True if content allowed.
- * @access public
- */
- function expectEndTag() {
- return true;
- }
-
- /**
- * Disables the setting of the button value.
- * @param string $value Ignored.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- return false;
- }
-
- /**
- * Value of browser visible text.
- * @return string Visible label.
- * @access public
- */
- function getLabel() {
- return $this->getContent();
- }
-
- /**
- * Gets the values submitted as a form. Gone
- * for the Mozilla defaults values.
- * @return array Hash of name and values.
- * @access public
- */
- function getSubmitValues() {
- if ($this->getAttribute('name') === false) {
- return array();
- }
- if ($this->getAttribute('value') === false) {
- return array($this->getName() => '');
- }
- return array($this->getName() => $this->getValue());
- }
- }
-
- /**
- * Content tag for text area.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleTextAreaTag extends SimpleWidget {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleTextAreaTag($attributes) {
- $this->SimpleWidget('textarea', $attributes);
- }
-
- /**
- * Accessor for starting value.
- * @return string Parsed value.
- * @access public
- */
- function getDefault() {
- if ($this->_wrapIsEnabled()) {
- return wordwrap(
- $this->getContent(),
- (integer)$this->getAttribute('cols'),
- "\n");
- }
- return $this->getContent();
- }
-
- /**
- * Applies word wrapping if needed.
- * @param string $value New value.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- if ($this->_wrapIsEnabled()) {
- $value = wordwrap(
- $value,
- (integer)$this->getAttribute('cols'),
- "\n");
- }
- return parent::setValue($value);
- }
-
- /**
- * Test to see if text should be wrapped.
- * @return boolean True if wrapping on.
- * @access private
- */
- function _wrapIsEnabled() {
- if ($this->getAttribute('cols')) {
- $wrap = $this->getAttribute('wrap');
- if (($wrap == 'physical') || ($wrap == 'hard')) {
- return true;
- }
- }
- return false;
- }
- }
-
- /**
- * Checkbox widget.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleCheckboxTag extends SimpleWidget {
-
- /**
- * Starts with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleCheckboxTag($attributes) {
- $this->SimpleWidget('input', $attributes);
- if ($this->getAttribute('value') === false) {
- $this->_setAttribute('value', 'on');
- }
- }
-
- /**
- * Tag contains no content.
- * @return boolean False.
- * @access public
- */
- function expectEndTag() {
- return false;
- }
-
- /**
- * The only allowed value in the one in the
- * "value" attribute. The default for this
- * attribute is "on".
- * @param string $value New value.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- if ($value === false) {
- return parent::setValue($value);
- }
- if ($value != $this->getAttribute('value')) {
- return false;
- }
- return parent::setValue($value);
- }
-
- /**
- * Accessor for starting value. The default
- * value is "on".
- * @return string Parsed value.
- * @access public
- */
- function getDefault() {
- if ($this->getAttribute('checked')) {
- return $this->getAttribute('value');
- }
- return false;
- }
- }
-
- /**
- * Drop down widget.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleSelectionTag extends SimpleWidget {
- protected $_options;
- protected $_choice;
-
- /**
- * Starts with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleSelectionTag($attributes) {
- $this->SimpleWidget('select', $attributes);
- $this->_options = array();
- $this->_choice = false;
- }
-
- /**
- * Adds an option tag to a selection field.
- * @param SimpleOptionTag $tag New option.
- * @access public
- */
- function addTag($tag) {
- if ($tag->getTagName() == 'option') {
- $this->_options[] = $tag;
- }
- }
-
- /**
- * Text within the selection element is ignored.
- * @param string $content Ignored.
- * @access public
- */
- function addContent($content) {
- }
-
- /**
- * Scans options for defaults. If none, then
- * the first option is selected.
- * @return string Selected field.
- * @access public
- */
- function getDefault() {
- for ($i = 0, $count = count($this->_options); $i < $count; $i++) {
- if ($this->_options[$i]->getAttribute('selected')) {
- return $this->_options[$i]->getDefault();
- }
- }
- if ($count > 0) {
- return $this->_options[0]->getDefault();
- }
- return '';
- }
-
- /**
- * Can only set allowed values.
- * @param string $value New choice.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- for ($i = 0, $count = count($this->_options); $i < $count; $i++) {
- if (trim($this->_options[$i]->getContent()) == trim($value)) {
- $this->_choice = $i;
- return true;
- }
- }
- return false;
- }
-
- /**
- * Accessor for current selection value.
- * @return string Value attribute or
- * content of opton.
- * @access public
- */
- function getValue() {
- if ($this->_choice === false) {
- return $this->getDefault();
- }
- return $this->_options[$this->_choice]->getValue();
- }
- }
-
- /**
- * Drop down widget.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class MultipleSelectionTag extends SimpleWidget {
- protected $_options;
- protected $_values;
-
- /**
- * Starts with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function MultipleSelectionTag($attributes) {
- $this->SimpleWidget('select', $attributes);
- $this->_options = array();
- $this->_values = false;
- }
-
- /**
- * Adds an option tag to a selection field.
- * @param SimpleOptionTag $tag New option.
- * @access public
- */
- function addTag($tag) {
- if ($tag->getTagName() == 'option') {
- $this->_options[] = $tag;
- }
- }
-
- /**
- * Text within the selection element is ignored.
- * @param string $content Ignored.
- * @access public
- */
- function addContent($content) {
- }
-
- /**
- * Scans options for defaults to populate the
- * value array().
- * @return array Selected fields.
- * @access public
- */
- function getDefault() {
- $default = array();
- for ($i = 0, $count = count($this->_options); $i < $count; $i++) {
- if ($this->_options[$i]->getAttribute('selected')) {
- $default[] = $this->_options[$i]->getDefault();
- }
- }
- return $default;
- }
-
- /**
- * Can only set allowed values.
- * @param array $values New choices.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($values) {
- foreach ($values as $value) {
- $is_option = false;
- for ($i = 0, $count = count($this->_options); $i < $count; $i++) {
- if (trim($this->_options[$i]->getContent()) == trim($value)) {
- $is_option = true;
- break;
- }
- }
- if (! $is_option) {
- return false;
- }
- }
- $this->_values = $values;
- return true;
- }
-
- /**
- * Accessor for current selection value.
- * @return array List of currently set options.
- * @access public
- */
- function getValue() {
- if ($this->_values === false) {
- return $this->getDefault();
- }
- return $this->_values;
- }
- }
-
- /**
- * Option for selection field.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleOptionTag extends SimpleWidget {
-
- /**
- * Stashes the attributes.
- */
- function SimpleOptionTag($attributes) {
- $this->SimpleWidget('option', $attributes);
- }
-
- /**
- * Does nothing.
- * @param string $value Ignored.
- * @return boolean Not allowed.
- * @access public
- */
- function setValue($value) {
- return false;
- }
-
- /**
- * Accessor for starting value. Will be set to
- * the option label if no value exists.
- * @return string Parsed value.
- * @access public
- */
- function getDefault() {
- if ($this->getAttribute('value') === false) {
- return $this->getContent();
- }
- return $this->getAttribute('value');
- }
- }
-
- /**
- * Radio button.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleRadioButtonTag extends SimpleWidget {
-
- /**
- * Stashes the attributes.
- * @param array $attributes Hash of attributes.
- */
- function SimpleRadioButtonTag($attributes) {
- $this->SimpleWidget('input', $attributes);
- if ($this->getAttribute('value') === false) {
- $this->_setAttribute('value', 'on');
- }
- }
-
- /**
- * Tag contains no content.
- * @return boolean False.
- * @access public
- */
- function expectEndTag() {
- return false;
- }
-
- /**
- * The only allowed value in the one in the
- * "value" attribute.
- * @param string $value New value.
- * @return boolean True if allowed.
- * @access public
- */
- function setValue($value) {
- if ($value === false) {
- return parent::setValue($value);
- }
- if ($value != $this->getAttribute('value')) {
- return false;
- }
- return parent::setValue($value);
- }
-
- /**
- * Accessor for starting value.
- * @return string Parsed value.
- * @access public
- */
- function getDefault() {
- if ($this->getAttribute('checked')) {
- return $this->getAttribute('value');
- }
- return false;
- }
- }
-
- /**
- * A group of tags with the same name within a form.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleCheckboxGroup {
- protected $_widgets;
-
- /**
- * Starts empty.
- * @access public
- */
- function SimpleCheckboxGroup() {
- $this->_widgets = array();
- }
-
- /**
- * Accessor for an attribute.
- * @param string $label Attribute name.
- * @return boolean Always false.
- * @access public
- */
- function getAttribute($label) {
- return false;
- }
-
- /**
- * Scans the checkboxes for one with the appropriate
- * ID field.
- * @param string $id ID value to try.
- * @return boolean True if matched.
- * @access public
- */
- function isId($id) {
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->isId($id)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Adds a tag to the group.
- * @param SimpleWidget $widget
- * @access public
- */
- function addWidget($widget) {
- $this->_widgets[] = $widget;
- }
-
- /**
- * Fetches the name for the widget from the first
- * member.
- * @return string Name of widget.
- * @access public
- */
- function getName() {
- if (count($this->_widgets) > 0) {
- return $this->_widgets[0]->getName();
- }
- }
-
- /**
- * Accessor for current selected widget or false
- * if none.
- * @return string/array Widget values or false if none.
- * @access public
- */
- function getValue() {
- $values = array();
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->getValue()) {
- $values[] = $this->_widgets[$i]->getValue();
- }
- }
- return $this->_coerceValues($values);
- }
-
- /**
- * Accessor for starting value that is active.
- * @return string/array Widget values or false if none.
- * @access public
- */
- function getDefault() {
- $values = array();
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->getDefault()) {
- $values[] = $this->_widgets[$i]->getDefault();
- }
- }
- return $this->_coerceValues($values);
- }
-
- /**
- * Accessor for current set values.
- * @param string/array/boolean $values Either a single string, a
- * hash or false for nothing set.
- * @return boolean True if all values can be set.
- * @access public
- */
- function setValue($values) {
- $values = $this->_makeArray($values);
- if (! $this->_valuesArePossible($values)) {
- return false;
- }
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- $possible = $this->_widgets[$i]->getAttribute('value');
- if (in_array($this->_widgets[$i]->getAttribute('value'), $values)) {
- $this->_widgets[$i]->setValue($possible);
- } else {
- $this->_widgets[$i]->setValue(false);
- }
- }
- return true;
- }
-
- /**
- * Tests to see if a possible value set is legal.
- * @param string/array/boolean $values Either a single string, a
- * hash or false for nothing set.
- * @return boolean False if trying to set a
- * missing value.
- * @access private
- */
- function _valuesArePossible($values) {
- $matches = array();
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- $possible = $this->_widgets[$i]->getAttribute('value');
- if (in_array($possible, $values)) {
- $matches[] = $possible;
- }
- }
- return ($values == $matches);
- }
-
- /**
- * Converts the output to an appropriate format. This means
- * that no values is false, a single value is just that
- * value and only two or more are contained in an array.
- * @param array $values List of values of widgets.
- * @return string/array/boolean Expected format for a tag.
- * @access private
- */
- function _coerceValues($values) {
- if (count($values) == 0) {
- return false;
- } elseif (count($values) == 1) {
- return $values[0];
- } else {
- return $values;
- }
- }
-
- /**
- * Converts false or string into array. The opposite of
- * the coercian method.
- * @param string/array/boolean $value A single item is converted
- * to a one item list. False
- * gives an empty list.
- * @return array List of values, possibly empty.
- * @access private
- */
- function _makeArray($value) {
- if ($value === false) {
- return array();
- }
- if (is_string($value)) {
- return array($value);
- }
- return $value;
- }
- }
-
- /**
- * A group of tags with the same name within a form.
- * Used for radio buttons.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleRadioGroup {
- protected $_widgets;
-
- /**
- * Starts empty.
- * @access public
- */
- function SimpleRadioGroup() {
- $this->_widgets = array();
- }
-
- /**
- * Accessor for an attribute.
- * @param string $label Attribute name.
- * @return boolean Always false.
- * @access public
- */
- function getAttribute($label) {
- return false;
- }
-
- /**
- * Scans the checkboxes for one with the appropriate
- * ID field.
- * @param string $id ID value to try.
- * @return boolean True if matched.
- * @access public
- */
- function isId($id) {
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->isId($id)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Adds a tag to the group.
- * @param SimpleWidget $widget
- * @access public
- */
- function addWidget($widget) {
- $this->_widgets[] = $widget;
- }
-
- /**
- * Fetches the name for the widget from the first
- * member.
- * @return string Name of widget.
- * @access public
- */
- function getName() {
- if (count($this->_widgets) > 0) {
- return $this->_widgets[0]->getName();
- }
- }
-
- /**
- * Each tag is tried in turn until one is
- * successfully set. The others will be
- * unchecked if successful.
- * @param string $value New value.
- * @return boolean True if any allowed.
- * @access public
- */
- function setValue($value) {
- if (! $this->_valueIsPossible($value)) {
- return false;
- }
- $index = false;
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if (! $this->_widgets[$i]->setValue($value)) {
- $this->_widgets[$i]->setValue(false);
- }
- }
- return true;
- }
-
- /**
- * Tests to see if a value is allowed.
- * @param string Attempted value.
- * @return boolean True if a valid value.
- * @access private
- */
- function _valueIsPossible($value) {
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->getAttribute('value') == $value) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Accessor for current selected widget or false
- * if none.
- * @return string/boolean Value attribute or
- * content of opton.
- * @access public
- */
- function getValue() {
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->getValue()) {
- return $this->_widgets[$i]->getValue();
- }
- }
- return false;
- }
-
- /**
- * Accessor for starting value that is active.
- * @return string/boolean Value of first checked
- * widget or false if none.
- * @access public
- */
- function getDefault() {
- for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) {
- if ($this->_widgets[$i]->getDefault()) {
- return $this->_widgets[$i]->getDefault();
- }
- }
- return false;
- }
- }
-
- /**
- * Tag to aid parsing the form.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleFormTag extends SimpleTag {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleFormTag($attributes) {
- $this->SimpleTag('form', $attributes);
- }
- }
-
- /**
- * Tag to aid parsing the frames in a page.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleFrameTag extends SimpleTag {
-
- /**
- * Starts with a named tag with attributes only.
- * @param hash $attributes Attribute names and
- * string values.
- */
- function SimpleFrameTag($attributes) {
- $this->SimpleTag('frame', $attributes);
- }
-
- /**
- * Tag contains no content.
- * @return boolean False.
- * @access public
- */
- function expectEndTag() {
- return false;
- }
- }
+<?php + /** + * Base include file for SimpleTest. + * @package SimpleTest + * @subpackage WebTester + * @version $Id: tag.php,v 1.73 2005/02/02 22:49:36 lastcraft Exp $ + */ + + /**#@+ + * include SimpleTest files + */ + require_once(dirname(__FILE__) . '/parser.php'); + /**#@-*/ + + /** + * HTML or XML tag. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleTag { + protected $_name; + protected $_attributes; + protected $_content; + + /** + * Starts with a named tag with attributes only. + * @param string $name Tag name. + * @param hash $attributes Attribute names and + * string values. Note that + * the keys must have been + * converted to lower case. + */ + function SimpleTag($name, $attributes) { + $this->_name = $name; + $this->_attributes = $attributes; + $this->_content = ''; + } + + /** + * Check to see if the tag can have both start and + * end tags with content in between. + * @return boolean True if content allowed. + * @access public + */ + function expectEndTag() { + return true; + } + + /** + * Appends string content to the current content. + * @param string $content Additional text. + * @access public + */ + function addContent($content) { + $this->_content .= (string)$content; + } + + /** + * Adds an enclosed tag to the content. + * @param SimpleTag $tag New tag. + * @access public + */ + function addTag($tag) { + } + + /** + * Accessor for tag name. + * @return string Name of tag. + * @access public + */ + function getTagName() { + return $this->_name; + } + + /** + * List oflegal child elements. + * @return array List of element names. + * @access public + */ + function getChildElements() { + return array(); + } + + /** + * Accessor for an attribute. + * @param string $label Attribute name. + * @return string Attribute value. + * @access public + */ + function getAttribute($label) { + $label = strtolower($label); + if (! isset($this->_attributes[$label])) { + return false; + } + if ($this->_attributes[$label] === '') { + return true; + } + return (string)$this->_attributes[$label]; + } + + /** + * Sets an attribute. + * @param string $label Attribute name. + * @return string $value New attribute value. + * @access protected + */ + function _setAttribute($label, $value) { + $this->_attributes[strtolower($label)] = $value; + } + + /** + * Accessor for the whole content so far. + * @return string Content as big raw string. + * @access public + */ + function getContent() { + return $this->_content; + } + + /** + * Accessor for content reduced to visible text. Acts + * like a text mode browser, normalising space and + * reducing images to their alt text. + * @return string Content as plain text. + * @access public + */ + function getText() { + return SimpleSaxParser::normalise($this->_content); + } + + /** + * Test to see if id attribute matches. + * @param string $id ID to test against. + * @return boolean True on match. + * @access public + */ + function isId($id) { + return ($this->getAttribute('id') == $id); + } + } + + /** + * Page title. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleTitleTag extends SimpleTag { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleTitleTag($attributes) { + $this->SimpleTag('title', $attributes); + } + } + + /** + * Link. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleAnchorTag extends SimpleTag { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleAnchorTag($attributes) { + $this->SimpleTag('a', $attributes); + } + + /** + * Accessor for URL as string. + * @return string Coerced as string. + * @access public + */ + function getHref() { + $url = $this->getAttribute('href'); + if (is_bool($url)) { + $url = ''; + } + return $url; + } + } + + /** + * Form element. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleWidget extends SimpleTag { + protected $_value; + protected $_is_set; + + /** + * Starts with a named tag with attributes only. + * @param string $name Tag name. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleWidget($name, $attributes) { + $this->SimpleTag($name, $attributes); + $this->_value = false; + $this->_is_set = false; + } + + /** + * Accessor for name submitted as the key in + * GET/POST variables hash. + * @return string Parsed value. + * @access public + */ + function getName() { + return $this->getAttribute('name'); + } + + /** + * Accessor for default value parsed with the tag. + * @return string Parsed value. + * @access public + */ + function getDefault() { + $default = $this->getAttribute('value'); + if ($default === true) { + $default = ''; + } + if ($default === false) { + $default = ''; + } + return $default; + } + + /** + * Accessor for currently set value or default if + * none. + * @return string Value set by form or default + * if none. + * @access public + */ + function getValue() { + if (! $this->_is_set) { + return $this->getDefault(); + } + return $this->_value; + } + + /** + * Sets the current form element value. + * @param string $value New value. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + $this->_value = $value; + $this->_is_set = true; + return true; + } + + /** + * Resets the form element value back to the + * default. + * @access public + */ + function resetValue() { + $this->_is_set = false; + } + } + + /** + * Text, password and hidden field. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleTextTag extends SimpleWidget { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleTextTag($attributes) { + $this->SimpleWidget('input', $attributes); + if ($this->getAttribute('value') === false) { + $this->_setAttribute('value', ''); + } + } + + /** + * Tag contains no content. + * @return boolean False. + * @access public + */ + function expectEndTag() { + return false; + } + + /** + * Sets the current form element value. Cannot + * change the value of a hidden field. + * @param string $value New value. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + if ($this->getAttribute('type') == 'hidden') { + return false; + } + return parent::setValue($value); + } + } + + /** + * Submit button as input tag. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleSubmitTag extends SimpleWidget { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleSubmitTag($attributes) { + $this->SimpleWidget('input', $attributes); + if ($this->getAttribute('name') === false) { + $this->_setAttribute('name', 'submit'); + } + if ($this->getAttribute('value') === false) { + $this->_setAttribute('value', 'Submit'); + } + } + + /** + * Tag contains no end element. + * @return boolean False. + * @access public + */ + function expectEndTag() { + return false; + } + + /** + * Disables the setting of the button value. + * @param string $value Ignored. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + return false; + } + + /** + * Value of browser visible text. + * @return string Visible label. + * @access public + */ + function getLabel() { + return $this->getValue(); + } + + /** + * Gets the values submitted as a form. + * @return array Hash of name and values. + * @access public + */ + function getSubmitValues() { + return array($this->getName() => $this->getValue()); + } + } + + /** + * Image button as input tag. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleImageSubmitTag extends SimpleWidget { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleImageSubmitTag($attributes) { + $this->SimpleWidget('input', $attributes); + } + + /** + * Tag contains no end element. + * @return boolean False. + * @access public + */ + function expectEndTag() { + return false; + } + + /** + * Disables the setting of the button value. + * @param string $value Ignored. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + return false; + } + + /** + * Value of browser visible text. + * @return string Visible label. + * @access public + */ + function getLabel() { + if ($this->getAttribute('title')) { + return $this->getAttribute('title'); + } + return $this->getAttribute('alt'); + } + + /** + * Gets the values submitted as a form. + * @return array Hash of name and values. + * @access public + */ + function getSubmitValues($x, $y) { + return array( + $this->getName() . '.x' => $x, + $this->getName() . '.y' => $y); + } + } + + /** + * Submit button as button tag. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleButtonTag extends SimpleWidget { + + /** + * Starts with a named tag with attributes only. + * Defaults are very browser dependent. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleButtonTag($attributes) { + $this->SimpleWidget('button', $attributes); + } + + /** + * Check to see if the tag can have both start and + * end tags with content in between. + * @return boolean True if content allowed. + * @access public + */ + function expectEndTag() { + return true; + } + + /** + * Disables the setting of the button value. + * @param string $value Ignored. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + return false; + } + + /** + * Value of browser visible text. + * @return string Visible label. + * @access public + */ + function getLabel() { + return $this->getContent(); + } + + /** + * Gets the values submitted as a form. Gone + * for the Mozilla defaults values. + * @return array Hash of name and values. + * @access public + */ + function getSubmitValues() { + if ($this->getAttribute('name') === false) { + return array(); + } + if ($this->getAttribute('value') === false) { + return array($this->getName() => ''); + } + return array($this->getName() => $this->getValue()); + } + } + + /** + * Content tag for text area. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleTextAreaTag extends SimpleWidget { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleTextAreaTag($attributes) { + $this->SimpleWidget('textarea', $attributes); + } + + /** + * Accessor for starting value. + * @return string Parsed value. + * @access public + */ + function getDefault() { + if ($this->_wrapIsEnabled()) { + return wordwrap( + $this->getContent(), + (integer)$this->getAttribute('cols'), + "\n"); + } + return $this->getContent(); + } + + /** + * Applies word wrapping if needed. + * @param string $value New value. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + if ($this->_wrapIsEnabled()) { + $value = wordwrap( + $value, + (integer)$this->getAttribute('cols'), + "\n"); + } + return parent::setValue($value); + } + + /** + * Test to see if text should be wrapped. + * @return boolean True if wrapping on. + * @access private + */ + function _wrapIsEnabled() { + if ($this->getAttribute('cols')) { + $wrap = $this->getAttribute('wrap'); + if (($wrap == 'physical') || ($wrap == 'hard')) { + return true; + } + } + return false; + } + } + + /** + * Checkbox widget. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleCheckboxTag extends SimpleWidget { + + /** + * Starts with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleCheckboxTag($attributes) { + $this->SimpleWidget('input', $attributes); + if ($this->getAttribute('value') === false) { + $this->_setAttribute('value', 'on'); + } + } + + /** + * Tag contains no content. + * @return boolean False. + * @access public + */ + function expectEndTag() { + return false; + } + + /** + * The only allowed value in the one in the + * "value" attribute. The default for this + * attribute is "on". + * @param string $value New value. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + if ($value === false) { + return parent::setValue($value); + } + if ($value != $this->getAttribute('value')) { + return false; + } + return parent::setValue($value); + } + + /** + * Accessor for starting value. The default + * value is "on". + * @return string Parsed value. + * @access public + */ + function getDefault() { + if ($this->getAttribute('checked')) { + return $this->getAttribute('value'); + } + return false; + } + } + + /** + * Drop down widget. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleSelectionTag extends SimpleWidget { + protected $_options; + protected $_choice; + + /** + * Starts with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleSelectionTag($attributes) { + $this->SimpleWidget('select', $attributes); + $this->_options = array(); + $this->_choice = false; + } + + /** + * Adds an option tag to a selection field. + * @param SimpleOptionTag $tag New option. + * @access public + */ + function addTag($tag) { + if ($tag->getTagName() == 'option') { + $this->_options[] = $tag; + } + } + + /** + * Text within the selection element is ignored. + * @param string $content Ignored. + * @access public + */ + function addContent($content) { + } + + /** + * Scans options for defaults. If none, then + * the first option is selected. + * @return string Selected field. + * @access public + */ + function getDefault() { + for ($i = 0, $count = count($this->_options); $i < $count; $i++) { + if ($this->_options[$i]->getAttribute('selected')) { + return $this->_options[$i]->getDefault(); + } + } + if ($count > 0) { + return $this->_options[0]->getDefault(); + } + return ''; + } + + /** + * Can only set allowed values. + * @param string $value New choice. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + for ($i = 0, $count = count($this->_options); $i < $count; $i++) { + if (trim($this->_options[$i]->getContent()) == trim($value)) { + $this->_choice = $i; + return true; + } + } + return false; + } + + /** + * Accessor for current selection value. + * @return string Value attribute or + * content of opton. + * @access public + */ + function getValue() { + if ($this->_choice === false) { + return $this->getDefault(); + } + return $this->_options[$this->_choice]->getValue(); + } + } + + /** + * Drop down widget. + * @package SimpleTest + * @subpackage WebTester + */ + class MultipleSelectionTag extends SimpleWidget { + protected $_options; + protected $_values; + + /** + * Starts with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function MultipleSelectionTag($attributes) { + $this->SimpleWidget('select', $attributes); + $this->_options = array(); + $this->_values = false; + } + + /** + * Adds an option tag to a selection field. + * @param SimpleOptionTag $tag New option. + * @access public + */ + function addTag($tag) { + if ($tag->getTagName() == 'option') { + $this->_options[] = $tag; + } + } + + /** + * Text within the selection element is ignored. + * @param string $content Ignored. + * @access public + */ + function addContent($content) { + } + + /** + * Scans options for defaults to populate the + * value array(). + * @return array Selected fields. + * @access public + */ + function getDefault() { + $default = array(); + for ($i = 0, $count = count($this->_options); $i < $count; $i++) { + if ($this->_options[$i]->getAttribute('selected')) { + $default[] = $this->_options[$i]->getDefault(); + } + } + return $default; + } + + /** + * Can only set allowed values. + * @param array $values New choices. + * @return boolean True if allowed. + * @access public + */ + function setValue($values) { + foreach ($values as $value) { + $is_option = false; + for ($i = 0, $count = count($this->_options); $i < $count; $i++) { + if (trim($this->_options[$i]->getContent()) == trim($value)) { + $is_option = true; + break; + } + } + if (! $is_option) { + return false; + } + } + $this->_values = $values; + return true; + } + + /** + * Accessor for current selection value. + * @return array List of currently set options. + * @access public + */ + function getValue() { + if ($this->_values === false) { + return $this->getDefault(); + } + return $this->_values; + } + } + + /** + * Option for selection field. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleOptionTag extends SimpleWidget { + + /** + * Stashes the attributes. + */ + function SimpleOptionTag($attributes) { + $this->SimpleWidget('option', $attributes); + } + + /** + * Does nothing. + * @param string $value Ignored. + * @return boolean Not allowed. + * @access public + */ + function setValue($value) { + return false; + } + + /** + * Accessor for starting value. Will be set to + * the option label if no value exists. + * @return string Parsed value. + * @access public + */ + function getDefault() { + if ($this->getAttribute('value') === false) { + return $this->getContent(); + } + return $this->getAttribute('value'); + } + } + + /** + * Radio button. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleRadioButtonTag extends SimpleWidget { + + /** + * Stashes the attributes. + * @param array $attributes Hash of attributes. + */ + function SimpleRadioButtonTag($attributes) { + $this->SimpleWidget('input', $attributes); + if ($this->getAttribute('value') === false) { + $this->_setAttribute('value', 'on'); + } + } + + /** + * Tag contains no content. + * @return boolean False. + * @access public + */ + function expectEndTag() { + return false; + } + + /** + * The only allowed value in the one in the + * "value" attribute. + * @param string $value New value. + * @return boolean True if allowed. + * @access public + */ + function setValue($value) { + if ($value === false) { + return parent::setValue($value); + } + if ($value != $this->getAttribute('value')) { + return false; + } + return parent::setValue($value); + } + + /** + * Accessor for starting value. + * @return string Parsed value. + * @access public + */ + function getDefault() { + if ($this->getAttribute('checked')) { + return $this->getAttribute('value'); + } + return false; + } + } + + /** + * A group of tags with the same name within a form. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleCheckboxGroup { + protected $_widgets; + + /** + * Starts empty. + * @access public + */ + function SimpleCheckboxGroup() { + $this->_widgets = array(); + } + + /** + * Accessor for an attribute. + * @param string $label Attribute name. + * @return boolean Always false. + * @access public + */ + function getAttribute($label) { + return false; + } + + /** + * Scans the checkboxes for one with the appropriate + * ID field. + * @param string $id ID value to try. + * @return boolean True if matched. + * @access public + */ + function isId($id) { + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->isId($id)) { + return true; + } + } + return false; + } + + /** + * Adds a tag to the group. + * @param SimpleWidget $widget + * @access public + */ + function addWidget($widget) { + $this->_widgets[] = $widget; + } + + /** + * Fetches the name for the widget from the first + * member. + * @return string Name of widget. + * @access public + */ + function getName() { + if (count($this->_widgets) > 0) { + return $this->_widgets[0]->getName(); + } + } + + /** + * Accessor for current selected widget or false + * if none. + * @return string/array Widget values or false if none. + * @access public + */ + function getValue() { + $values = array(); + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->getValue()) { + $values[] = $this->_widgets[$i]->getValue(); + } + } + return $this->_coerceValues($values); + } + + /** + * Accessor for starting value that is active. + * @return string/array Widget values or false if none. + * @access public + */ + function getDefault() { + $values = array(); + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->getDefault()) { + $values[] = $this->_widgets[$i]->getDefault(); + } + } + return $this->_coerceValues($values); + } + + /** + * Accessor for current set values. + * @param string/array/boolean $values Either a single string, a + * hash or false for nothing set. + * @return boolean True if all values can be set. + * @access public + */ + function setValue($values) { + $values = $this->_makeArray($values); + if (! $this->_valuesArePossible($values)) { + return false; + } + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + $possible = $this->_widgets[$i]->getAttribute('value'); + if (in_array($this->_widgets[$i]->getAttribute('value'), $values)) { + $this->_widgets[$i]->setValue($possible); + } else { + $this->_widgets[$i]->setValue(false); + } + } + return true; + } + + /** + * Tests to see if a possible value set is legal. + * @param string/array/boolean $values Either a single string, a + * hash or false for nothing set. + * @return boolean False if trying to set a + * missing value. + * @access private + */ + function _valuesArePossible($values) { + $matches = array(); + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + $possible = $this->_widgets[$i]->getAttribute('value'); + if (in_array($possible, $values)) { + $matches[] = $possible; + } + } + return ($values == $matches); + } + + /** + * Converts the output to an appropriate format. This means + * that no values is false, a single value is just that + * value and only two or more are contained in an array. + * @param array $values List of values of widgets. + * @return string/array/boolean Expected format for a tag. + * @access private + */ + function _coerceValues($values) { + if (count($values) == 0) { + return false; + } elseif (count($values) == 1) { + return $values[0]; + } else { + return $values; + } + } + + /** + * Converts false or string into array. The opposite of + * the coercian method. + * @param string/array/boolean $value A single item is converted + * to a one item list. False + * gives an empty list. + * @return array List of values, possibly empty. + * @access private + */ + function _makeArray($value) { + if ($value === false) { + return array(); + } + if (is_string($value)) { + return array($value); + } + return $value; + } + } + + /** + * A group of tags with the same name within a form. + * Used for radio buttons. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleRadioGroup { + protected $_widgets; + + /** + * Starts empty. + * @access public + */ + function SimpleRadioGroup() { + $this->_widgets = array(); + } + + /** + * Accessor for an attribute. + * @param string $label Attribute name. + * @return boolean Always false. + * @access public + */ + function getAttribute($label) { + return false; + } + + /** + * Scans the checkboxes for one with the appropriate + * ID field. + * @param string $id ID value to try. + * @return boolean True if matched. + * @access public + */ + function isId($id) { + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->isId($id)) { + return true; + } + } + return false; + } + + /** + * Adds a tag to the group. + * @param SimpleWidget $widget + * @access public + */ + function addWidget($widget) { + $this->_widgets[] = $widget; + } + + /** + * Fetches the name for the widget from the first + * member. + * @return string Name of widget. + * @access public + */ + function getName() { + if (count($this->_widgets) > 0) { + return $this->_widgets[0]->getName(); + } + } + + /** + * Each tag is tried in turn until one is + * successfully set. The others will be + * unchecked if successful. + * @param string $value New value. + * @return boolean True if any allowed. + * @access public + */ + function setValue($value) { + if (! $this->_valueIsPossible($value)) { + return false; + } + $index = false; + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if (! $this->_widgets[$i]->setValue($value)) { + $this->_widgets[$i]->setValue(false); + } + } + return true; + } + + /** + * Tests to see if a value is allowed. + * @param string Attempted value. + * @return boolean True if a valid value. + * @access private + */ + function _valueIsPossible($value) { + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->getAttribute('value') == $value) { + return true; + } + } + return false; + } + + /** + * Accessor for current selected widget or false + * if none. + * @return string/boolean Value attribute or + * content of opton. + * @access public + */ + function getValue() { + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->getValue()) { + return $this->_widgets[$i]->getValue(); + } + } + return false; + } + + /** + * Accessor for starting value that is active. + * @return string/boolean Value of first checked + * widget or false if none. + * @access public + */ + function getDefault() { + for ($i = 0, $count = count($this->_widgets); $i < $count; $i++) { + if ($this->_widgets[$i]->getDefault()) { + return $this->_widgets[$i]->getDefault(); + } + } + return false; + } + } + + /** + * Tag to aid parsing the form. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleFormTag extends SimpleTag { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleFormTag($attributes) { + $this->SimpleTag('form', $attributes); + } + } + + /** + * Tag to aid parsing the frames in a page. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleFrameTag extends SimpleTag { + + /** + * Starts with a named tag with attributes only. + * @param hash $attributes Attribute names and + * string values. + */ + function SimpleFrameTag($attributes) { + $this->SimpleTag('frame', $attributes); + } + + /** + * Tag contains no content. + * @return boolean False. + * @access public + */ + function expectEndTag() { + return false; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/unit_tester.php b/tests/test_tools/simpletest/unit_tester.php index a8d4e9db..fa5e28b4 100644 --- a/tests/UnitTests/simpletest/unit_tester.php +++ b/tests/test_tools/simpletest/unit_tester.php @@ -1,303 +1,303 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: unit_tester.php,v 1.24 2005/01/13 01:31:53 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/simple_test.php');
- require_once(dirname(__FILE__) . '/errors.php');
- require_once(dirname(__FILE__) . '/dumper.php');
- /**#@-*/
-
- /**
- * Standard unit test class for day to day testing
- * of PHP code XP style. Adds some useful standard
- * assertions.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class UnitTestCase extends SimpleTestCase {
-
- /**
- * Creates an empty test case. Should be subclassed
- * with test methods for a functional test case.
- * @param string $label Name of test case. Will use
- * the class name if none specified.
- * @access public
- */
- function UnitTestCase($label = false) {
- if (! $label) {
- $label = get_class($this);
- }
- $this->SimpleTestCase($label);
- }
-
- /**
- * Will be true if the value is null.
- * @param null $value Supposedly null value.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertNull($value, $message = "%s") {
- $dumper = new SimpleDumper();
- $message = sprintf(
- $message,
- "[" . $dumper->describeValue($value) . "] should be null");
- return $this->assertTrue(! isset($value), $message);
- }
-
- /**
- * Will be true if the value is set.
- * @param mixed $value Supposedly set value.
- * @param string $message Message to display.
- * @return boolean True on pass.
- * @access public
- */
- function assertNotNull($value, $message = "%s") {
- $dumper = new SimpleDumper();
- $message = sprintf(
- $message,
- "[" . $dumper->describeValue($value) . "] should not be null");
- return $this->assertTrue(isset($value), $message);
- }
-
- /**
- * Type and class test. Will pass if class
- * matches the type name or is a subclass or
- * if not an object, but the type is correct.
- * @param mixed $object Object to test.
- * @param string $type Type name as string.
- * @param string $message Message to display.
- * @return boolean True on pass.
- * @access public
- */
- function assertIsA($object, $type, $message = "%s") {
- return $this->assertExpectation(
- new IsAExpectation($type),
- $object,
- $message);
- }
-
- /**
- * Type and class mismatch test. Will pass if class
- * name or underling type does not match the one
- * specified.
- * @param mixed $object Object to test.
- * @param string $type Type name as string.
- * @param string $message Message to display.
- * @return boolean True on pass.
- * @access public
- */
- function assertNotA($object, $type, $message = "%s") {
- return $this->assertExpectation(
- new NotAExpectation($type),
- $object,
- $message);
- }
-
- /**
- * Will trigger a pass if the two parameters have
- * the same value only. Otherwise a fail.
- * @param mixed $first Value to compare.
- * @param mixed $second Value to compare.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertEqual($first, $second, $message = "%s") {
- return $this->assertExpectation(
- new EqualExpectation($first),
- $second,
- $message);
- }
-
- /**
- * Will trigger a pass if the two parameters have
- * a different value. Otherwise a fail.
- * @param mixed $first Value to compare.
- * @param mixed $second Value to compare.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertNotEqual($first, $second, $message = "%s") {
- return $this->assertExpectation(
- new NotEqualExpectation($first),
- $second,
- $message);
- }
-
- /**
- * Will trigger a pass if the two parameters have
- * the same value and same type. Otherwise a fail.
- * @param mixed $first Value to compare.
- * @param mixed $second Value to compare.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertIdentical($first, $second, $message = "%s") {
- return $this->assertExpectation(
- new IdenticalExpectation($first),
- $second,
- $message);
- }
-
- /**
- * Will trigger a pass if the two parameters have
- * the different value or different type.
- * @param mixed $first Value to compare.
- * @param mixed $second Value to compare.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertNotIdentical($first, $second, $message = "%s") {
- return $this->assertExpectation(
- new NotIdenticalExpectation($first),
- $second,
- $message);
- }
-
- /**
- * Will trigger a pass if both parameters refer
- * to the same object. Fail otherwise.
- * @param mixed $first Object reference to check.
- * @param mixed $second Hopefully the same object.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertReference($first, $second, $message = "%s") {
- $dumper = new SimpleDumper();
- $message = sprintf(
- $message,
- "[" . $dumper->describeValue($first) .
- "] and [" . $dumper->describeValue($second) .
- "] should reference the same object");
- return $this->assertTrue(
- SimpleTestCompatibility::isReference($first, $second),
- $message);
- }
-
- /**
- * Will trigger a pass if both parameters refer
- * to different objects. Fail otherwise.
- * @param mixed $first Object reference to check.
- * @param mixed $second Hopefully not the same object.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertCopy($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->assertFalse(
- SimpleTestCompatibility::isReference($first, $second),
- $message);
- }
-
- /**
- * Will trigger a pass if the Perl regex pattern
- * is found in the subject. Fail otherwise.
- * @param string $pattern Perl regex to look for including
- * the regex delimiters.
- * @param string $subject String to search in.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertWantedPattern($pattern, $subject, $message = "%s") {
- return $this->assertExpectation(
- new WantedPatternExpectation($pattern),
- $subject,
- $message);
- }
-
- /**
- * Will trigger a pass if the perl regex pattern
- * is not present in subject. Fail if found.
- * @param string $pattern Perl regex to look for including
- * the regex delimiters.
- * @param string $subject String to search in.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertNoUnwantedPattern($pattern, $subject, $message = "%s") {
- return $this->assertExpectation(
- new UnwantedPatternExpectation($pattern),
- $subject,
- $message);
- }
-
- /**
- * Confirms that no errors have occoured so
- * far in the test method.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertNoErrors($message = "%s") {
- $queue =SimpleErrorQueue::instance();
- return $this->assertTrue(
- $queue->isEmpty(),
- sprintf($message, "Should be no errors"));
- }
-
- /**
- * Confirms that an error has occoured and
- * optionally that the error text matches exactly.
- * @param string $expected Expected error text or
- * false for no check.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertError($expected = false, $message = "%s") {
- $queue =SimpleErrorQueue::instance();
- if ($queue->isEmpty()) {
- $this->fail(sprintf($message, "Expected error not found"));
- return;
- }
- list($severity, $content, $file, $line, $globals) = $queue->extract();
- $severity = SimpleErrorQueue::getSeverityAsString($severity);
- return $this->assertTrue(
- ! $expected || ($expected == $content),
- "Expected [$expected] in PHP error [$content] severity [$severity] in [$file] line [$line]");
- }
-
- /**
- * Confirms that an error has occoured and
- * that the error text matches a Perl regular
- * expression.
- * @param string $pattern Perl regular expresion to
- * match against.
- * @param string $message Message to display.
- * @return boolean True on pass
- * @access public
- */
- function assertErrorPattern($pattern, $message = "%s") {
- $queue =SimpleErrorQueue::instance();
- if ($queue->isEmpty()) {
- $this->fail(sprintf($message, "Expected error not found"));
- return;
- }
- list($severity, $content, $file, $line, $globals) = $queue->extract();
- $severity = SimpleErrorQueue::getSeverityAsString($severity);
- return $this->assertTrue(
- (boolean)preg_match($pattern, $content),
- "Expected pattern match [$pattern] in PHP error [$content] severity [$severity] in [$file] line [$line]");
- }
- }
-?>
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: unit_tester.php,v 1.24 2005/01/13 01:31:53 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/simple_test.php'); + require_once(dirname(__FILE__) . '/errors.php'); + require_once(dirname(__FILE__) . '/dumper.php'); + /**#@-*/ + + /** + * Standard unit test class for day to day testing + * of PHP code XP style. Adds some useful standard + * assertions. + * @package SimpleTest + * @subpackage UnitTester + */ + class UnitTestCase extends SimpleTestCase { + + /** + * Creates an empty test case. Should be subclassed + * with test methods for a functional test case. + * @param string $label Name of test case. Will use + * the class name if none specified. + * @access public + */ + function UnitTestCase($label = false) { + if (! $label) { + $label = get_class($this); + } + $this->SimpleTestCase($label); + } + + /** + * Will be true if the value is null. + * @param null $value Supposedly null value. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertNull($value, $message = "%s") { + $dumper = new SimpleDumper(); + $message = sprintf( + $message, + "[" . $dumper->describeValue($value) . "] should be null"); + return $this->assertTrue(! isset($value), $message); + } + + /** + * Will be true if the value is set. + * @param mixed $value Supposedly set value. + * @param string $message Message to display. + * @return boolean True on pass. + * @access public + */ + function assertNotNull($value, $message = "%s") { + $dumper = new SimpleDumper(); + $message = sprintf( + $message, + "[" . $dumper->describeValue($value) . "] should not be null"); + return $this->assertTrue(isset($value), $message); + } + + /** + * Type and class test. Will pass if class + * matches the type name or is a subclass or + * if not an object, but the type is correct. + * @param mixed $object Object to test. + * @param string $type Type name as string. + * @param string $message Message to display. + * @return boolean True on pass. + * @access public + */ + function assertIsA($object, $type, $message = "%s") { + return $this->assertExpectation( + new IsAExpectation($type), + $object, + $message); + } + + /** + * Type and class mismatch test. Will pass if class + * name or underling type does not match the one + * specified. + * @param mixed $object Object to test. + * @param string $type Type name as string. + * @param string $message Message to display. + * @return boolean True on pass. + * @access public + */ + function assertNotA($object, $type, $message = "%s") { + return $this->assertExpectation( + new NotAExpectation($type), + $object, + $message); + } + + /** + * Will trigger a pass if the two parameters have + * the same value only. Otherwise a fail. + * @param mixed $first Value to compare. + * @param mixed $second Value to compare. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertEqual($first, $second, $message = "%s") { + return $this->assertExpectation( + new EqualExpectation($first), + $second, + $message); + } + + /** + * Will trigger a pass if the two parameters have + * a different value. Otherwise a fail. + * @param mixed $first Value to compare. + * @param mixed $second Value to compare. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertNotEqual($first, $second, $message = "%s") { + return $this->assertExpectation( + new NotEqualExpectation($first), + $second, + $message); + } + + /** + * Will trigger a pass if the two parameters have + * the same value and same type. Otherwise a fail. + * @param mixed $first Value to compare. + * @param mixed $second Value to compare. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertIdentical($first, $second, $message = "%s") { + return $this->assertExpectation( + new IdenticalExpectation($first), + $second, + $message); + } + + /** + * Will trigger a pass if the two parameters have + * the different value or different type. + * @param mixed $first Value to compare. + * @param mixed $second Value to compare. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertNotIdentical($first, $second, $message = "%s") { + return $this->assertExpectation( + new NotIdenticalExpectation($first), + $second, + $message); + } + + /** + * Will trigger a pass if both parameters refer + * to the same object. Fail otherwise. + * @param mixed $first Object reference to check. + * @param mixed $second Hopefully the same object. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertReference($first, $second, $message = "%s") { + $dumper = new SimpleDumper(); + $message = sprintf( + $message, + "[" . $dumper->describeValue($first) . + "] and [" . $dumper->describeValue($second) . + "] should reference the same object"); + return $this->assertTrue( + SimpleTestCompatibility::isReference($first, $second), + $message); + } + + /** + * Will trigger a pass if both parameters refer + * to different objects. Fail otherwise. + * @param mixed $first Object reference to check. + * @param mixed $second Hopefully not the same object. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertCopy($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->assertFalse( + SimpleTestCompatibility::isReference($first, $second), + $message); + } + + /** + * Will trigger a pass if the Perl regex pattern + * is found in the subject. Fail otherwise. + * @param string $pattern Perl regex to look for including + * the regex delimiters. + * @param string $subject String to search in. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertWantedPattern($pattern, $subject, $message = "%s") { + return $this->assertExpectation( + new WantedPatternExpectation($pattern), + $subject, + $message); + } + + /** + * Will trigger a pass if the perl regex pattern + * is not present in subject. Fail if found. + * @param string $pattern Perl regex to look for including + * the regex delimiters. + * @param string $subject String to search in. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertNoUnwantedPattern($pattern, $subject, $message = "%s") { + return $this->assertExpectation( + new UnwantedPatternExpectation($pattern), + $subject, + $message); + } + + /** + * Confirms that no errors have occoured so + * far in the test method. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertNoErrors($message = "%s") { + $queue =SimpleErrorQueue::instance(); + return $this->assertTrue( + $queue->isEmpty(), + sprintf($message, "Should be no errors")); + } + + /** + * Confirms that an error has occoured and + * optionally that the error text matches exactly. + * @param string $expected Expected error text or + * false for no check. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertError($expected = false, $message = "%s") { + $queue =SimpleErrorQueue::instance(); + if ($queue->isEmpty()) { + $this->fail(sprintf($message, "Expected error not found")); + return; + } + list($severity, $content, $file, $line, $globals) = $queue->extract(); + $severity = SimpleErrorQueue::getSeverityAsString($severity); + return $this->assertTrue( + ! $expected || ($expected == $content), + "Expected [$expected] in PHP error [$content] severity [$severity] in [$file] line [$line]"); + } + + /** + * Confirms that an error has occoured and + * that the error text matches a Perl regular + * expression. + * @param string $pattern Perl regular expresion to + * match against. + * @param string $message Message to display. + * @return boolean True on pass + * @access public + */ + function assertErrorPattern($pattern, $message = "%s") { + $queue =SimpleErrorQueue::instance(); + if ($queue->isEmpty()) { + $this->fail(sprintf($message, "Expected error not found")); + return; + } + list($severity, $content, $file, $line, $globals) = $queue->extract(); + $severity = SimpleErrorQueue::getSeverityAsString($severity); + return $this->assertTrue( + (boolean)preg_match($pattern, $content), + "Expected pattern match [$pattern] in PHP error [$content] severity [$severity] in [$file] line [$line]"); + } + } +?> diff --git a/tests/UnitTests/simpletest/url.php b/tests/test_tools/simpletest/url.php index 50a0b1aa..03902ed0 100644 --- a/tests/UnitTests/simpletest/url.php +++ b/tests/test_tools/simpletest/url.php @@ -1,508 +1,508 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: url.php,v 1.22 2005/02/02 23:25:23 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/encoding.php');
- /**#@-*/
-
- /**
- * URL parser to replace parse_url() PHP function which
- * got broken in PHP 4.3.0. Adds some browser specific
- * functionality such as expandomatics.
- * Guesses a bit trying to separate the host from
- * the path.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleUrl {
- protected $_scheme;
- protected $_username;
- protected $_password;
- protected $_host;
- protected $_port;
- protected $_path;
- protected $_request;
- protected $_fragment;
- protected $_target;
-
- /**
- * Constructor. Parses URL into sections.
- * @param string $url Incoming URL.
- * @access public
- */
- function SimpleUrl($url) {
- list($x, $y) = $this->_chompCoordinates($url);
- $this->_scheme = $this->_chompScheme($url);
- list($this->_username, $this->_password) = $this->_chompLogin($url);
- $this->_host = $this->_chompHost($url);
- $this->_port = false;
- if (preg_match('/(.*?):(.*)/', $this->_host, $host_parts)) {
- $this->_host = $host_parts[1];
- $this->_port = (integer)$host_parts[2];
- }
- $this->_path = $this->_chompPath($url);
- $this->_request = $this->_parseRequest($this->_chompRequest($url));
- $this->_request->setCoordinates($x, $y);
- $this->_fragment = (strncmp($url, "#", 1) == 0 ? substr($url, 1) : false);
- $this->_target = false;
- }
-
- /**
- * Extracts the X, Y coordinate pair from an image map.
- * @param string $url URL so far. The coordinates will be
- * removed.
- * @return array X, Y as a pair of integers.
- * @access private
- */
- function _chompCoordinates($url) {
- if (preg_match('/(.*)\?(\d+),(\d+)$/', $url, $matches)) {
- $url = $matches[1];
- return array((integer)$matches[2], (integer)$matches[3]);
- }
- return array(false, false);
- }
-
- /**
- * Extracts the scheme part of an incoming URL.
- * @param string $url URL so far. The scheme will be
- * removed.
- * @return string Scheme part or false.
- * @access private
- */
- function _chompScheme($url) {
- if (preg_match('/(.*?):(\/\/)(.*)/', $url, $matches)) {
- $url = $matches[2] . $matches[3];
- return $matches[1];
- }
- return false;
- }
-
- /**
- * Extracts the username and password from the
- * incoming URL. The // prefix will be reattached
- * to the URL after the doublet is extracted.
- * @param string $url URL so far. The username and
- * password are removed.
- * @return array Two item list of username and
- * password. Will urldecode() them.
- * @access private
- */
- function _chompLogin($url) {
- $prefix = '';
- if (preg_match('/(\/\/)(.*)/', $url, $matches)) {
- $prefix = $matches[1];
- $url = $matches[2];
- }
- if (preg_match('/(.*?)@(.*)/', $url, $matches)) {
- $url = $prefix . $matches[2];
- $parts = split(":", $matches[1]);
- return array(
- urldecode($parts[0]),
- isset($parts[1]) ? urldecode($parts[1]) : false);
- }
- $url = $prefix . $url;
- return array(false, false);
- }
-
- /**
- * Extracts the host part of an incoming URL.
- * Includes the port number part. Will extract
- * the host if it starts with // or it has
- * a top level domain or it has at least two
- * dots.
- * @param string $url URL so far. The host will be
- * removed.
- * @return string Host part guess or false.
- * @access private
- */
- function _chompHost($url) {
- if (preg_match('/(\/\/)(.*?)(\/.*|\?.*|#.*|$)/', $url, $matches)) {
- $url = $matches[3];
- return $matches[2];
- }
- if (preg_match('/(.*?)(\.\.\/|\.\/|\/|\?|#|$)(.*)/', $url, $matches)) {
- $tlds = SimpleUrl::getAllTopLevelDomains();
- if (preg_match('/[a-z0-9\-]+\.(' . $tlds . ')/i', $matches[1])) {
- $url = $matches[2] . $matches[3];
- return $matches[1];
- } elseif (preg_match('/[a-z0-9\-]+\.[a-z0-9\-]+\.[a-z0-9\-]+/i', $matches[1])) {
- $url = $matches[2] . $matches[3];
- return $matches[1];
- }
- }
- return false;
- }
-
- /**
- * Extracts the path information from the incoming
- * URL. Strips this path from the URL.
- * @param string $url URL so far. The host will be
- * removed.
- * @return string Path part or '/'.
- * @access private
- */
- function _chompPath($url) {
- if (preg_match('/(.*?)(\?|#|$)(.*)/', $url, $matches)) {
- $url = $matches[2] . $matches[3];
- return ($matches[1] ? $matches[1] : '');
- }
- return '';
- }
-
- /**
- * Strips off the request data.
- * @param string $url URL so far. The request will be
- * removed.
- * @return string Raw request part.
- * @access private
- */
- function _chompRequest($url) {
- if (preg_match('/\?(.*?)(#|$)(.*)/', $url, $matches)) {
- $url = $matches[2] . $matches[3];
- return $matches[1];
- }
- return '';
- }
-
- /**
- * Breaks the request down into an object.
- * @param string $raw Raw request.
- * @return SimpleFormEncoding Parsed data.
- * @access private
- */
- function _parseRequest($raw) {
- $request = new SimpleFormEncoding();
- foreach (split("&", $raw) as $pair) {
- if (preg_match('/(.*?)=(.*)/', $pair, $matches)) {
- $request->add($matches[1], urldecode($matches[2]));
- } elseif ($pair) {
- $request->add($pair, '');
- }
- }
- return $request;
- }
-
- /**
- * Accessor for protocol part.
- * @param string $default Value to use if not present.
- * @return string Scheme name, e.g "http".
- * @access public
- */
- function getScheme($default = false) {
- return $this->_scheme ? $this->_scheme : $default;
- }
-
- /**
- * Accessor for user name.
- * @return string Username preceding host.
- * @access public
- */
- function getUsername() {
- return $this->_username;
- }
-
- /**
- * Accessor for password.
- * @return string Password preceding host.
- * @access public
- */
- function getPassword() {
- return $this->_password;
- }
-
- /**
- * Accessor for hostname and port.
- * @param string $default Value to use if not present.
- * @return string Hostname only.
- * @access public
- */
- function getHost($default = false) {
- return $this->_host ? $this->_host : $default;
- }
-
- /**
- * Accessor for top level domain.
- * @return string Last part of host.
- * @access public
- */
- function getTld() {
- $path_parts = pathinfo($this->getHost());
- return (isset($path_parts['extension']) ? $path_parts['extension'] : false);
- }
-
- /**
- * Accessor for port number.
- * @return integer TCP/IP port number.
- * @access public
- */
- function getPort() {
- return $this->_port;
- }
-
- /**
- * Accessor for path.
- * @return string Full path including leading slash if implied.
- * @access public
- */
- function getPath() {
- if (! $this->_path && $this->_host) {
- return '/';
- }
- return $this->_path;
- }
-
- /**
- * Accessor for page if any. This may be a
- * directory name if ambiguious.
- * @return Page name.
- * @access public
- */
- function getPage() {
- if (! preg_match('/([^\/]*?)$/', $this->getPath(), $matches)) {
- return false;
- }
- return $matches[1];
- }
-
- /**
- * Gets the path to the page.
- * @return string Path less the page.
- * @access public
- */
- function getBasePath() {
- if (! preg_match('/(.*\/)[^\/]*?$/', $this->getPath(), $matches)) {
- return false;
- }
- return $matches[1];
- }
-
- /**
- * Accessor for fragment at end of URL after the "#".
- * @return string Part after "#".
- * @access public
- */
- function getFragment() {
- return $this->_fragment;
- }
-
- /**
- * Accessor for horizontal image coordinate.
- * @return integer X value.
- * @access public
- */
- function getX() {
- return $this->_request->getX();
- }
-
- /**
- * Accessor for vertical image coordinate.
- * @return integer Y value.
- * @access public
- */
- function getY() {
- return $this->_request->getY();
- }
-
- /**
- * Accessor for current request parameters
- * in URL string form
- * @return string Form is string "?a=1&b=2", etc.
- * @access public
- */
- function getEncodedRequest() {
- $encoded = $this->_request->asString();
- if ($encoded) {
- return '?' . preg_replace('/^\?/', '', $encoded);
- }
- return '';
- }
-
- /**
- * Adds an additional parameter to the request.
- * @param string $key Name of parameter.
- * @param string $value Value as string.
- * @access public
- */
- function addRequestParameter($key, $value) {
- $this->_request->add($key, $value);
- }
-
- /**
- * Adds additional parameters to the request.
- * @param hash/SimpleFormEncoding $parameters Additional
- * parameters.
- * @access public
- */
- function addRequestParameters($parameters) {
- $this->_request->merge($parameters);
- }
-
- /**
- * Clears down all parameters.
- * @access public
- */
- function clearRequest() {
- $this->_request = new SimpleFormEncoding();
- }
-
- /**
- * Sets image coordinates. Set to flase to clear
- * them.
- * @param integer $x Horizontal position.
- * @param integer $y Vertical position.
- * @access public
- */
- function setCoordinates($x = false, $y = false) {
- $this->_request->setCoordinates($x, $y);
- }
-
- /**
- * Gets the frame target if present. Although
- * not strictly part of the URL specification it
- * acts as similarily to the browser.
- * @return boolean/string Frame name or false if none.
- * @access public
- */
- function getTarget() {
- return $this->_target;
- }
-
- /**
- * Attaches a frame target.
- * @param string $frame Name of frame.
- * @access public
- */
- function setTarget($frame) {
- $this->_target = $frame;
- }
-
- /**
- * Renders the URL back into a string.
- * @return string URL in canonical form.
- * @access public
- */
- function asString() {
- $scheme = $identity = $host = $path = $encoded = $fragment = '';
- if ($this->_username && $this->_password) {
- $identity = $this->_username . ':' . $this->_password . '@';
- }
- if ($this->getHost()) {
- $scheme = $this->getScheme() ? $this->getScheme() : 'http';
- $host = $this->getHost();
- }
- if (substr($this->_path, 0, 1) == '/') {
- $path = $this->normalisePath($this->_path);
- }
- $encoded = $this->getEncodedRequest();
- $fragment = $this->getFragment() ? '#'. $this->getFragment() : '';
- return "$scheme://$identity$host$path$encoded$fragment";
- }
-
- /**
- * Replaces unknown sections to turn a relative
- * URL into an absolute one. The base URL can
- * be either a string or a SimpleUrl object.
- * @param string/SimpleUrl $base Base URL.
- * @access public
- */
- function makeAbsolute($base) {
- if (! is_object($base)) {
- $base = new SimpleUrl($base);
- }
- $scheme = $this->getScheme() ? $this->getScheme() : $base->getScheme();
- $host = $this->getHost() ? $this->getHost() : $base->getHost();
- $port = $this->_extractAbsolutePort($base);
- $path = $this->normalisePath($this->_extractAbsolutePath($base));
- $identity = $this->_getIdentity() ? $this->_getIdentity() . '@' : '';
- $encoded = $this->getEncodedRequest();
- $fragment = $this->getFragment() ? '#'. $this->getFragment() : '';
- return new SimpleUrl("$scheme://$identity$host$port$path$encoded$fragment");
- }
-
- /**
- * Extracts the port from the base URL if it's needed, but
- * not present, in the current URL.
- * @param string/SimpleUrl $base Base URL.
- * @param string Absolute port number.
- * @access private
- */
- function _extractAbsolutePort($base) {
- if ($this->getHost()) {
- return ($this->getPort() ? ':' . $this->getPort() : '');
- }
- return ($base->getPort() ? ':' . $base->getPort() : '');
- }
-
- /**
- * Replaces unknown sections of the path with base parts
- * to return a complete absolute one.
- * @param string/SimpleUrl $base Base URL.
- * @param string Absolute path.
- * @access private
- */
- function _extractAbsolutePath($base) {
- if ($this->getHost()) {
- return $this->_path;
- }
- if (! $this->_isRelativePath($this->_path)) {
- return $this->_path;
- }
- if ($this->_path) {
- return $base->getBasePath() . $this->_path;
- }
- return $base->getPath();
- }
-
- /**
- * Simple test to see if a path part is relative.
- * @param string $path Path to test.
- * @return boolean True if starts with a "/".
- * @access private
- */
- function _isRelativePath($path) {
- return (substr($path, 0, 1) != '/');
- }
-
- /**
- * Extracts the username and password for use in rendering
- * a URL.
- * @return string/boolean Form of username:password@ or false.
- * @access private
- */
- function _getIdentity() {
- if ($this->_username && $this->_password) {
- return $this->_username . ':' . $this->_password;
- }
- return false;
- }
-
- /**
- * Replaces . and .. sections of the path.
- * @param string $path Unoptimised path.
- * @return string Path with dots removed if possible.
- * @access public
- */
- function normalisePath($path) {
- $path = preg_replace('|/[^/]+/\.\./|', '/', $path);
- return preg_replace('|/\./|', '/', $path);
- }
-
- /**
- * A pipe seperated list of all TLDs that result in two part
- * domain names.
- * @return string Pipe separated list.
- * @access public
- * @static
- */
- function getAllTopLevelDomains() {
- return 'com|edu|net|org|gov|mil|int|biz|info|name|pro|aero|coop|museum';
- }
- }
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: url.php,v 1.22 2005/02/02 23:25:23 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/encoding.php'); + /**#@-*/ + + /** + * URL parser to replace parse_url() PHP function which + * got broken in PHP 4.3.0. Adds some browser specific + * functionality such as expandomatics. + * Guesses a bit trying to separate the host from + * the path. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleUrl { + protected $_scheme; + protected $_username; + protected $_password; + protected $_host; + protected $_port; + protected $_path; + protected $_request; + protected $_fragment; + protected $_target; + + /** + * Constructor. Parses URL into sections. + * @param string $url Incoming URL. + * @access public + */ + function SimpleUrl($url) { + list($x, $y) = $this->_chompCoordinates($url); + $this->_scheme = $this->_chompScheme($url); + list($this->_username, $this->_password) = $this->_chompLogin($url); + $this->_host = $this->_chompHost($url); + $this->_port = false; + if (preg_match('/(.*?):(.*)/', $this->_host, $host_parts)) { + $this->_host = $host_parts[1]; + $this->_port = (integer)$host_parts[2]; + } + $this->_path = $this->_chompPath($url); + $this->_request = $this->_parseRequest($this->_chompRequest($url)); + $this->_request->setCoordinates($x, $y); + $this->_fragment = (strncmp($url, "#", 1) == 0 ? substr($url, 1) : false); + $this->_target = false; + } + + /** + * Extracts the X, Y coordinate pair from an image map. + * @param string $url URL so far. The coordinates will be + * removed. + * @return array X, Y as a pair of integers. + * @access private + */ + function _chompCoordinates($url) { + if (preg_match('/(.*)\?(\d+),(\d+)$/', $url, $matches)) { + $url = $matches[1]; + return array((integer)$matches[2], (integer)$matches[3]); + } + return array(false, false); + } + + /** + * Extracts the scheme part of an incoming URL. + * @param string $url URL so far. The scheme will be + * removed. + * @return string Scheme part or false. + * @access private + */ + function _chompScheme($url) { + if (preg_match('/(.*?):(\/\/)(.*)/', $url, $matches)) { + $url = $matches[2] . $matches[3]; + return $matches[1]; + } + return false; + } + + /** + * Extracts the username and password from the + * incoming URL. The // prefix will be reattached + * to the URL after the doublet is extracted. + * @param string $url URL so far. The username and + * password are removed. + * @return array Two item list of username and + * password. Will urldecode() them. + * @access private + */ + function _chompLogin($url) { + $prefix = ''; + if (preg_match('/(\/\/)(.*)/', $url, $matches)) { + $prefix = $matches[1]; + $url = $matches[2]; + } + if (preg_match('/(.*?)@(.*)/', $url, $matches)) { + $url = $prefix . $matches[2]; + $parts = split(":", $matches[1]); + return array( + urldecode($parts[0]), + isset($parts[1]) ? urldecode($parts[1]) : false); + } + $url = $prefix . $url; + return array(false, false); + } + + /** + * Extracts the host part of an incoming URL. + * Includes the port number part. Will extract + * the host if it starts with // or it has + * a top level domain or it has at least two + * dots. + * @param string $url URL so far. The host will be + * removed. + * @return string Host part guess or false. + * @access private + */ + function _chompHost($url) { + if (preg_match('/(\/\/)(.*?)(\/.*|\?.*|#.*|$)/', $url, $matches)) { + $url = $matches[3]; + return $matches[2]; + } + if (preg_match('/(.*?)(\.\.\/|\.\/|\/|\?|#|$)(.*)/', $url, $matches)) { + $tlds = SimpleUrl::getAllTopLevelDomains(); + if (preg_match('/[a-z0-9\-]+\.(' . $tlds . ')/i', $matches[1])) { + $url = $matches[2] . $matches[3]; + return $matches[1]; + } elseif (preg_match('/[a-z0-9\-]+\.[a-z0-9\-]+\.[a-z0-9\-]+/i', $matches[1])) { + $url = $matches[2] . $matches[3]; + return $matches[1]; + } + } + return false; + } + + /** + * Extracts the path information from the incoming + * URL. Strips this path from the URL. + * @param string $url URL so far. The host will be + * removed. + * @return string Path part or '/'. + * @access private + */ + function _chompPath($url) { + if (preg_match('/(.*?)(\?|#|$)(.*)/', $url, $matches)) { + $url = $matches[2] . $matches[3]; + return ($matches[1] ? $matches[1] : ''); + } + return ''; + } + + /** + * Strips off the request data. + * @param string $url URL so far. The request will be + * removed. + * @return string Raw request part. + * @access private + */ + function _chompRequest($url) { + if (preg_match('/\?(.*?)(#|$)(.*)/', $url, $matches)) { + $url = $matches[2] . $matches[3]; + return $matches[1]; + } + return ''; + } + + /** + * Breaks the request down into an object. + * @param string $raw Raw request. + * @return SimpleFormEncoding Parsed data. + * @access private + */ + function _parseRequest($raw) { + $request = new SimpleFormEncoding(); + foreach (split("&", $raw) as $pair) { + if (preg_match('/(.*?)=(.*)/', $pair, $matches)) { + $request->add($matches[1], urldecode($matches[2])); + } elseif ($pair) { + $request->add($pair, ''); + } + } + return $request; + } + + /** + * Accessor for protocol part. + * @param string $default Value to use if not present. + * @return string Scheme name, e.g "http". + * @access public + */ + function getScheme($default = false) { + return $this->_scheme ? $this->_scheme : $default; + } + + /** + * Accessor for user name. + * @return string Username preceding host. + * @access public + */ + function getUsername() { + return $this->_username; + } + + /** + * Accessor for password. + * @return string Password preceding host. + * @access public + */ + function getPassword() { + return $this->_password; + } + + /** + * Accessor for hostname and port. + * @param string $default Value to use if not present. + * @return string Hostname only. + * @access public + */ + function getHost($default = false) { + return $this->_host ? $this->_host : $default; + } + + /** + * Accessor for top level domain. + * @return string Last part of host. + * @access public + */ + function getTld() { + $path_parts = pathinfo($this->getHost()); + return (isset($path_parts['extension']) ? $path_parts['extension'] : false); + } + + /** + * Accessor for port number. + * @return integer TCP/IP port number. + * @access public + */ + function getPort() { + return $this->_port; + } + + /** + * Accessor for path. + * @return string Full path including leading slash if implied. + * @access public + */ + function getPath() { + if (! $this->_path && $this->_host) { + return '/'; + } + return $this->_path; + } + + /** + * Accessor for page if any. This may be a + * directory name if ambiguious. + * @return Page name. + * @access public + */ + function getPage() { + if (! preg_match('/([^\/]*?)$/', $this->getPath(), $matches)) { + return false; + } + return $matches[1]; + } + + /** + * Gets the path to the page. + * @return string Path less the page. + * @access public + */ + function getBasePath() { + if (! preg_match('/(.*\/)[^\/]*?$/', $this->getPath(), $matches)) { + return false; + } + return $matches[1]; + } + + /** + * Accessor for fragment at end of URL after the "#". + * @return string Part after "#". + * @access public + */ + function getFragment() { + return $this->_fragment; + } + + /** + * Accessor for horizontal image coordinate. + * @return integer X value. + * @access public + */ + function getX() { + return $this->_request->getX(); + } + + /** + * Accessor for vertical image coordinate. + * @return integer Y value. + * @access public + */ + function getY() { + return $this->_request->getY(); + } + + /** + * Accessor for current request parameters + * in URL string form + * @return string Form is string "?a=1&b=2", etc. + * @access public + */ + function getEncodedRequest() { + $encoded = $this->_request->asString(); + if ($encoded) { + return '?' . preg_replace('/^\?/', '', $encoded); + } + return ''; + } + + /** + * Adds an additional parameter to the request. + * @param string $key Name of parameter. + * @param string $value Value as string. + * @access public + */ + function addRequestParameter($key, $value) { + $this->_request->add($key, $value); + } + + /** + * Adds additional parameters to the request. + * @param hash/SimpleFormEncoding $parameters Additional + * parameters. + * @access public + */ + function addRequestParameters($parameters) { + $this->_request->merge($parameters); + } + + /** + * Clears down all parameters. + * @access public + */ + function clearRequest() { + $this->_request = new SimpleFormEncoding(); + } + + /** + * Sets image coordinates. Set to flase to clear + * them. + * @param integer $x Horizontal position. + * @param integer $y Vertical position. + * @access public + */ + function setCoordinates($x = false, $y = false) { + $this->_request->setCoordinates($x, $y); + } + + /** + * Gets the frame target if present. Although + * not strictly part of the URL specification it + * acts as similarily to the browser. + * @return boolean/string Frame name or false if none. + * @access public + */ + function getTarget() { + return $this->_target; + } + + /** + * Attaches a frame target. + * @param string $frame Name of frame. + * @access public + */ + function setTarget($frame) { + $this->_target = $frame; + } + + /** + * Renders the URL back into a string. + * @return string URL in canonical form. + * @access public + */ + function asString() { + $scheme = $identity = $host = $path = $encoded = $fragment = ''; + if ($this->_username && $this->_password) { + $identity = $this->_username . ':' . $this->_password . '@'; + } + if ($this->getHost()) { + $scheme = $this->getScheme() ? $this->getScheme() : 'http'; + $host = $this->getHost(); + } + if (substr($this->_path, 0, 1) == '/') { + $path = $this->normalisePath($this->_path); + } + $encoded = $this->getEncodedRequest(); + $fragment = $this->getFragment() ? '#'. $this->getFragment() : ''; + return "$scheme://$identity$host$path$encoded$fragment"; + } + + /** + * Replaces unknown sections to turn a relative + * URL into an absolute one. The base URL can + * be either a string or a SimpleUrl object. + * @param string/SimpleUrl $base Base URL. + * @access public + */ + function makeAbsolute($base) { + if (! is_object($base)) { + $base = new SimpleUrl($base); + } + $scheme = $this->getScheme() ? $this->getScheme() : $base->getScheme(); + $host = $this->getHost() ? $this->getHost() : $base->getHost(); + $port = $this->_extractAbsolutePort($base); + $path = $this->normalisePath($this->_extractAbsolutePath($base)); + $identity = $this->_getIdentity() ? $this->_getIdentity() . '@' : ''; + $encoded = $this->getEncodedRequest(); + $fragment = $this->getFragment() ? '#'. $this->getFragment() : ''; + return new SimpleUrl("$scheme://$identity$host$port$path$encoded$fragment"); + } + + /** + * Extracts the port from the base URL if it's needed, but + * not present, in the current URL. + * @param string/SimpleUrl $base Base URL. + * @param string Absolute port number. + * @access private + */ + function _extractAbsolutePort($base) { + if ($this->getHost()) { + return ($this->getPort() ? ':' . $this->getPort() : ''); + } + return ($base->getPort() ? ':' . $base->getPort() : ''); + } + + /** + * Replaces unknown sections of the path with base parts + * to return a complete absolute one. + * @param string/SimpleUrl $base Base URL. + * @param string Absolute path. + * @access private + */ + function _extractAbsolutePath($base) { + if ($this->getHost()) { + return $this->_path; + } + if (! $this->_isRelativePath($this->_path)) { + return $this->_path; + } + if ($this->_path) { + return $base->getBasePath() . $this->_path; + } + return $base->getPath(); + } + + /** + * Simple test to see if a path part is relative. + * @param string $path Path to test. + * @return boolean True if starts with a "/". + * @access private + */ + function _isRelativePath($path) { + return (substr($path, 0, 1) != '/'); + } + + /** + * Extracts the username and password for use in rendering + * a URL. + * @return string/boolean Form of username:password@ or false. + * @access private + */ + function _getIdentity() { + if ($this->_username && $this->_password) { + return $this->_username . ':' . $this->_password; + } + return false; + } + + /** + * Replaces . and .. sections of the path. + * @param string $path Unoptimised path. + * @return string Path with dots removed if possible. + * @access public + */ + function normalisePath($path) { + $path = preg_replace('|/[^/]+/\.\./|', '/', $path); + return preg_replace('|/\./|', '/', $path); + } + + /** + * A pipe seperated list of all TLDs that result in two part + * domain names. + * @return string Pipe separated list. + * @access public + * @static + */ + function getAllTopLevelDomains() { + return 'com|edu|net|org|gov|mil|int|biz|info|name|pro|aero|coop|museum'; + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/user_agent.php b/tests/test_tools/simpletest/user_agent.php index f3cacfea..c65d5110 100644 --- a/tests/UnitTests/simpletest/user_agent.php +++ b/tests/test_tools/simpletest/user_agent.php @@ -1,490 +1,490 @@ -<?php
- /**
- * Base include file for SimpleTest
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: user_agent.php,v 1.43 2005/01/02 22:46:08 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/http.php');
- require_once(dirname(__FILE__) . '/encoding.php');
- require_once(dirname(__FILE__) . '/authentication.php');
- /**#@-*/
-
- define('DEFAULT_MAX_REDIRECTS', 3);
- define('DEFAULT_CONNECTION_TIMEOUT', 15);
-
- /**
- * Repository for cookies. This stuff is a
- * tiny bit browser dependent.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleCookieJar {
- protected $_cookies;
-
- /**
- * Constructor. Jar starts empty.
- * @access public
- */
- function SimpleCookieJar() {
- $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);
- }
- }
-
- /**
- * Adds a cookie to the jar. This will overwrite
- * cookies with matching host, paths and keys.
- * @param SimpleCookie $cookie New cookie.
- * @access public
- */
- function setCookie($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) {
- $this->_cookies[$i] = $cookie;
- return;
- }
- }
- $this->_cookies[] = $cookie;
- }
-
- /**
- * Fetches a hash of all valid cookies filtered
- * by host, path and keyed by name
- * Any cookies with missing categories will not
- * be filtered out by that category. Expired
- * cookies must be cleared by restarting the session.
- * @param string $host Host name requirement.
- * @param string $path Path encompassing cookies.
- * @return hash Valid cookie objects keyed
- * on the cookie name.
- * @access public
- */
- function getValidCookies($host = false, $path = "/") {
- $valid_cookies = array();
- foreach ($this->_cookies as $cookie) {
- if ($this->_isMatch($cookie, $host, $path, $cookie->getName())) {
- $valid_cookies[] = $cookie;
- }
- }
- return $valid_cookies;
- }
-
- /**
- * 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
- */
- 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;
- }
-
- /**
- * Adds the current cookies to a request.
- * @param SimpleHttpRequest $request Request to modify.
- * @param SimpleUrl $url Cookie selector.
- * @access private
- */
- function addHeaders($request, $url) {
- $cookies = $this->getValidCookies($url->getHost(), $url->getPath());
- foreach ($cookies as $cookie) {
- $request->setCookie($cookie);
- }
- }
- }
-
- /**
- * Fetches web pages whilst keeping track of
- * cookies and authentication.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class SimpleUserAgent {
- protected $_cookie_jar;
- protected $_authenticator;
- protected $_max_redirects;
- protected $_proxy;
- protected $_proxy_username;
- protected $_proxy_password;
- protected $_connection_timeout;
- protected $_additional_headers;
-
- /**
- * Starts with no cookies, realms or proxies.
- * @access public
- */
- function SimpleUserAgent() {
- $this->_cookie_jar = new SimpleCookieJar();
- $this->_authenticator = new SimpleAuthenticator();
- $this->setMaximumRedirects(DEFAULT_MAX_REDIRECTS);
- $this->_proxy = false;
- $this->_proxy_username = false;
- $this->_proxy_password = false;
- $this->setConnectionTimeout(DEFAULT_CONNECTION_TIMEOUT);
- $this->_additional_headers = array();
- }
-
- /**
- * Removes expired and temporary cookies as if
- * the browser was closed and re-opened. Authorisation
- * has to be obtained again as well.
- * @param string/integer $date Time when session restarted.
- * If omitted then all persistent
- * cookies are kept.
- * @access public
- */
- function restart($date = false) {
- $this->_cookie_jar->restartSession($date);
- $this->_authenticator->restartSession();
- }
-
- /**
- * Adds a header to every fetch.
- * @param string $header Header line to add to every
- * request until cleared.
- * @access public
- */
- function addHeader($header) {
- $this->_additional_headers[] = $header;
- }
-
- /**
- * Ages the cookies by the specified time.
- * @param integer $interval Amount in seconds.
- * @access public
- */
- function ageCookies($interval) {
- $this->_cookie_jar->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->_cookie_jar->setCookie($cookie);
- }
-
- /**
- * Reads the most specific cookie value from the
- * browser cookies.
- * @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->_cookie_jar->getValidCookies($host, $path) as $cookie) {
- if ($name == $cookie->getName()) {
- if (strlen($cookie->getPath()) > strlen($longest_path)) {
- $value = $cookie->getValue();
- $longest_path = $cookie->getPath();
- }
- }
- }
- return (isset($value) ? $value : false);
- }
-
- /**
- * Reads the current cookies within the base URL.
- * @param string $name Key of cookie to find.
- * @param SimpleUrl $base Base URL to search from.
- * @return string Null if there is no base URL, false
- * if the cookie is not set.
- * @access public
- */
- function getBaseCookieValue($name, $base) {
- if (! $base) {
- return null;
- }
- return $this->getCookieValue($base->getHost(), $base->getPath(), $name);
- }
-
- /**
- * Sets the socket timeout for opening a connection.
- * @param integer $timeout Maximum time in seconds.
- * @access public
- */
- function setConnectionTimeout($timeout) {
- $this->_connection_timeout = $timeout;
- }
-
- /**
- * Sets the maximum number of redirects before
- * a page will be loaded anyway.
- * @param integer $max Most hops allowed.
- * @access public
- */
- function setMaximumRedirects($max) {
- $this->_max_redirects = $max;
- }
-
- /**
- * Sets proxy to use on all requests for when
- * testing from behind a firewall. Set URL
- * to false to disable.
- * @param string $proxy Proxy URL.
- * @param string $username Proxy username for authentication.
- * @param string $password Proxy password for authentication.
- * @access public
- */
- function useProxy($proxy, $username, $password) {
- if (! $proxy) {
- $this->_proxy = false;
- return;
- }
- if (strncmp($proxy, 'http://', 7) != 0) {
- $proxy = 'http://'. $proxy;
- }
- $this->_proxy = new SimpleUrl($proxy);
- $this->_proxy_username = $username;
- $this->_proxy_password = $password;
- }
-
- /**
- * Test to see if the redirect limit is passed.
- * @param integer $redirects Count so far.
- * @return boolean True if over.
- * @access private
- */
- function _isTooManyRedirects($redirects) {
- return ($redirects > $this->_max_redirects);
- }
-
- /**
- * Sets the identity for the current realm.
- * @param string $host Host to which realm applies.
- * @param string $realm Full name of realm.
- * @param string $username Username for realm.
- * @param string $password Password for realm.
- * @access public
- */
- function setIdentity($host, $realm, $username, $password) {
- $this->_authenticator->setIdentityForRealm($host, $realm, $username, $password);
- }
-
- /**
- * Fetches a URL as a response object. Will keep trying if redirected.
- * It will also collect authentication realm information.
- * @param string $method GET, POST, etc.
- * @param string/SimpleUrl $url Target to fetch.
- * @param SimpleFormEncoding $parameters Additional parameters for request.
- * @return SimpleHttpResponse Hopefully the target page.
- * @access public
- */
- function fetchResponse($method, $url, $parameters = false) {
- if ($method != 'POST') {
- $url->addRequestParameters($parameters);
- $parameters = false;
- }
- $response = $this->_fetchWhileRedirected($method, $url, $parameters);
- if ($headers = $response->getHeaders()) {
- if ($headers->isChallenge()) {
- $this->_authenticator->addRealm(
- $url,
- $headers->getAuthentication(),
- $headers->getRealm());
- }
- }
- return $response;
- }
-
- /**
- * Fetches the page until no longer redirected or
- * until the redirect limit runs out.
- * @param string $method GET, POST, etc.
- * @param SimpleUrl $url Target to fetch.
- * @param SimpelFormEncoding $parameters Additional parameters for request.
- * @return SimpleHttpResponse Hopefully the target page.
- * @access private
- */
- function _fetchWhileRedirected($method, $url, $parameters) {
- $redirects = 0;
- do {
- $response = $this->_fetch($method, $url, $parameters);
- if ($response->isError()) {
- return $response;
- }
- $headers = $response->getHeaders();
- $location = new SimpleUrl($headers->getLocation());
- $url = $location->makeAbsolute($url);
- $this->_addCookiesToJar($url, $headers->getNewCookies());
- if (! $headers->isRedirect()) {
- break;
- }
- $method = 'GET';
- $parameters = false;
- } while (! $this->_isTooManyRedirects(++$redirects));
- return $response;
- }
-
- /**
- * Actually make the web request.
- * @param string $method GET, POST, etc.
- * @param SimpleUrl $url Target to fetch.
- * @param SimpleFormEncoding $parameters Additional parameters for request.
- * @return SimpleHttpResponse Headers and hopefully content.
- * @access protected
- */
- function _fetch($method, $url, $parameters) {
- if (! $parameters) {
- $parameters = new SimpleFormEncoding();
- }
- $request = $this->_createRequest($method, $url, $parameters);
- return $request->fetch($this->_connection_timeout);
- }
-
- /**
- * Creates a full page request.
- * @param string $method Fetching method.
- * @param SimpleUrl $url Target to fetch as url object.
- * @param SimpleFormEncoding $parameters POST/GET parameters.
- * @return SimpleHttpRequest New request.
- * @access private
- */
- function _createRequest($method, $url, $parameters) {
- $request = $this->_createHttpRequest($method, $url, $parameters);
- $this->_addAdditionalHeaders($request);
- $this->_cookie_jar->addHeaders($request, $url);
- $this->_authenticator->addHeaders($request, $url);
- return $request;
- }
-
- /**
- * Builds the appropriate HTTP request object.
- * @param string $method Fetching method.
- * @param SimpleUrl $url Target to fetch as url object.
- * @param SimpleFormEncoding $parameters POST/GET parameters.
- * @return SimpleHttpRequest New request object.
- * @access protected
- */
- function _createHttpRequest($method, $url, $parameters) {
- if ($method == 'POST') {
- $request = new SimpleHttpRequest(
- $this->_createRoute($url),
- 'POST',
- $parameters);
- return $request;
- }
- if ($parameters) {
- $url->addRequestParameters($parameters);
- }
- return new SimpleHttpRequest($this->_createRoute($url), $method);
- }
-
- /**
- * Sets up either a direct route or via a proxy.
- * @param SimpleUrl $url Target to fetch as url object.
- * @return SimpleRoute Route to take to fetch URL.
- * @access protected
- */
- function _createRoute($url) {
- if ($this->_proxy) {
- return new SimpleProxyRoute(
- $url,
- $this->_proxy,
- $this->_proxy_username,
- $this->_proxy_password);
- }
- return new SimpleRoute($url);
- }
-
- /**
- * Adds additional manual headers.
- * @param SimpleHttpRequest $request Outgoing request.
- * @access private
- */
- function _addAdditionalHeaders($request) {
- foreach ($this->_additional_headers as $header) {
- $request->addHeaderLine($header);
- }
- }
-
- /**
- * Extracts new cookies into the cookie jar.
- * @param SimpleUrl $url Target to fetch as url object.
- * @param array $cookies New cookies.
- * @access private
- */
- function _addCookiesToJar($url, $cookies) {
- foreach ($cookies as $cookie) {
- if ($url->getHost()) {
- $cookie->setHost($url->getHost());
- }
- $this->_cookie_jar->setCookie($cookie);
- }
- }
- }
+<?php + /** + * Base include file for SimpleTest + * @package SimpleTest + * @subpackage WebTester + * @version $Id: user_agent.php,v 1.43 2005/01/02 22:46:08 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/http.php'); + require_once(dirname(__FILE__) . '/encoding.php'); + require_once(dirname(__FILE__) . '/authentication.php'); + /**#@-*/ + + define('DEFAULT_MAX_REDIRECTS', 3); + define('DEFAULT_CONNECTION_TIMEOUT', 15); + + /** + * Repository for cookies. This stuff is a + * tiny bit browser dependent. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleCookieJar { + protected $_cookies; + + /** + * Constructor. Jar starts empty. + * @access public + */ + function SimpleCookieJar() { + $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); + } + } + + /** + * Adds a cookie to the jar. This will overwrite + * cookies with matching host, paths and keys. + * @param SimpleCookie $cookie New cookie. + * @access public + */ + function setCookie($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) { + $this->_cookies[$i] = $cookie; + return; + } + } + $this->_cookies[] = $cookie; + } + + /** + * Fetches a hash of all valid cookies filtered + * by host, path and keyed by name + * Any cookies with missing categories will not + * be filtered out by that category. Expired + * cookies must be cleared by restarting the session. + * @param string $host Host name requirement. + * @param string $path Path encompassing cookies. + * @return hash Valid cookie objects keyed + * on the cookie name. + * @access public + */ + function getValidCookies($host = false, $path = "/") { + $valid_cookies = array(); + foreach ($this->_cookies as $cookie) { + if ($this->_isMatch($cookie, $host, $path, $cookie->getName())) { + $valid_cookies[] = $cookie; + } + } + return $valid_cookies; + } + + /** + * 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 + */ + 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; + } + + /** + * Adds the current cookies to a request. + * @param SimpleHttpRequest $request Request to modify. + * @param SimpleUrl $url Cookie selector. + * @access private + */ + function addHeaders($request, $url) { + $cookies = $this->getValidCookies($url->getHost(), $url->getPath()); + foreach ($cookies as $cookie) { + $request->setCookie($cookie); + } + } + } + + /** + * Fetches web pages whilst keeping track of + * cookies and authentication. + * @package SimpleTest + * @subpackage WebTester + */ + class SimpleUserAgent { + protected $_cookie_jar; + protected $_authenticator; + protected $_max_redirects; + protected $_proxy; + protected $_proxy_username; + protected $_proxy_password; + protected $_connection_timeout; + protected $_additional_headers; + + /** + * Starts with no cookies, realms or proxies. + * @access public + */ + function SimpleUserAgent() { + $this->_cookie_jar = new SimpleCookieJar(); + $this->_authenticator = new SimpleAuthenticator(); + $this->setMaximumRedirects(DEFAULT_MAX_REDIRECTS); + $this->_proxy = false; + $this->_proxy_username = false; + $this->_proxy_password = false; + $this->setConnectionTimeout(DEFAULT_CONNECTION_TIMEOUT); + $this->_additional_headers = array(); + } + + /** + * Removes expired and temporary cookies as if + * the browser was closed and re-opened. Authorisation + * has to be obtained again as well. + * @param string/integer $date Time when session restarted. + * If omitted then all persistent + * cookies are kept. + * @access public + */ + function restart($date = false) { + $this->_cookie_jar->restartSession($date); + $this->_authenticator->restartSession(); + } + + /** + * Adds a header to every fetch. + * @param string $header Header line to add to every + * request until cleared. + * @access public + */ + function addHeader($header) { + $this->_additional_headers[] = $header; + } + + /** + * Ages the cookies by the specified time. + * @param integer $interval Amount in seconds. + * @access public + */ + function ageCookies($interval) { + $this->_cookie_jar->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->_cookie_jar->setCookie($cookie); + } + + /** + * Reads the most specific cookie value from the + * browser cookies. + * @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->_cookie_jar->getValidCookies($host, $path) as $cookie) { + if ($name == $cookie->getName()) { + if (strlen($cookie->getPath()) > strlen($longest_path)) { + $value = $cookie->getValue(); + $longest_path = $cookie->getPath(); + } + } + } + return (isset($value) ? $value : false); + } + + /** + * Reads the current cookies within the base URL. + * @param string $name Key of cookie to find. + * @param SimpleUrl $base Base URL to search from. + * @return string Null if there is no base URL, false + * if the cookie is not set. + * @access public + */ + function getBaseCookieValue($name, $base) { + if (! $base) { + return null; + } + return $this->getCookieValue($base->getHost(), $base->getPath(), $name); + } + + /** + * Sets the socket timeout for opening a connection. + * @param integer $timeout Maximum time in seconds. + * @access public + */ + function setConnectionTimeout($timeout) { + $this->_connection_timeout = $timeout; + } + + /** + * Sets the maximum number of redirects before + * a page will be loaded anyway. + * @param integer $max Most hops allowed. + * @access public + */ + function setMaximumRedirects($max) { + $this->_max_redirects = $max; + } + + /** + * Sets proxy to use on all requests for when + * testing from behind a firewall. Set URL + * to false to disable. + * @param string $proxy Proxy URL. + * @param string $username Proxy username for authentication. + * @param string $password Proxy password for authentication. + * @access public + */ + function useProxy($proxy, $username, $password) { + if (! $proxy) { + $this->_proxy = false; + return; + } + if (strncmp($proxy, 'http://', 7) != 0) { + $proxy = 'http://'. $proxy; + } + $this->_proxy = new SimpleUrl($proxy); + $this->_proxy_username = $username; + $this->_proxy_password = $password; + } + + /** + * Test to see if the redirect limit is passed. + * @param integer $redirects Count so far. + * @return boolean True if over. + * @access private + */ + function _isTooManyRedirects($redirects) { + return ($redirects > $this->_max_redirects); + } + + /** + * Sets the identity for the current realm. + * @param string $host Host to which realm applies. + * @param string $realm Full name of realm. + * @param string $username Username for realm. + * @param string $password Password for realm. + * @access public + */ + function setIdentity($host, $realm, $username, $password) { + $this->_authenticator->setIdentityForRealm($host, $realm, $username, $password); + } + + /** + * Fetches a URL as a response object. Will keep trying if redirected. + * It will also collect authentication realm information. + * @param string $method GET, POST, etc. + * @param string/SimpleUrl $url Target to fetch. + * @param SimpleFormEncoding $parameters Additional parameters for request. + * @return SimpleHttpResponse Hopefully the target page. + * @access public + */ + function fetchResponse($method, $url, $parameters = false) { + if ($method != 'POST') { + $url->addRequestParameters($parameters); + $parameters = false; + } + $response = $this->_fetchWhileRedirected($method, $url, $parameters); + if ($headers = $response->getHeaders()) { + if ($headers->isChallenge()) { + $this->_authenticator->addRealm( + $url, + $headers->getAuthentication(), + $headers->getRealm()); + } + } + return $response; + } + + /** + * Fetches the page until no longer redirected or + * until the redirect limit runs out. + * @param string $method GET, POST, etc. + * @param SimpleUrl $url Target to fetch. + * @param SimpelFormEncoding $parameters Additional parameters for request. + * @return SimpleHttpResponse Hopefully the target page. + * @access private + */ + function _fetchWhileRedirected($method, $url, $parameters) { + $redirects = 0; + do { + $response = $this->_fetch($method, $url, $parameters); + if ($response->isError()) { + return $response; + } + $headers = $response->getHeaders(); + $location = new SimpleUrl($headers->getLocation()); + $url = $location->makeAbsolute($url); + $this->_addCookiesToJar($url, $headers->getNewCookies()); + if (! $headers->isRedirect()) { + break; + } + $method = 'GET'; + $parameters = false; + } while (! $this->_isTooManyRedirects(++$redirects)); + return $response; + } + + /** + * Actually make the web request. + * @param string $method GET, POST, etc. + * @param SimpleUrl $url Target to fetch. + * @param SimpleFormEncoding $parameters Additional parameters for request. + * @return SimpleHttpResponse Headers and hopefully content. + * @access protected + */ + function _fetch($method, $url, $parameters) { + if (! $parameters) { + $parameters = new SimpleFormEncoding(); + } + $request = $this->_createRequest($method, $url, $parameters); + return $request->fetch($this->_connection_timeout); + } + + /** + * Creates a full page request. + * @param string $method Fetching method. + * @param SimpleUrl $url Target to fetch as url object. + * @param SimpleFormEncoding $parameters POST/GET parameters. + * @return SimpleHttpRequest New request. + * @access private + */ + function _createRequest($method, $url, $parameters) { + $request = $this->_createHttpRequest($method, $url, $parameters); + $this->_addAdditionalHeaders($request); + $this->_cookie_jar->addHeaders($request, $url); + $this->_authenticator->addHeaders($request, $url); + return $request; + } + + /** + * Builds the appropriate HTTP request object. + * @param string $method Fetching method. + * @param SimpleUrl $url Target to fetch as url object. + * @param SimpleFormEncoding $parameters POST/GET parameters. + * @return SimpleHttpRequest New request object. + * @access protected + */ + function _createHttpRequest($method, $url, $parameters) { + if ($method == 'POST') { + $request = new SimpleHttpRequest( + $this->_createRoute($url), + 'POST', + $parameters); + return $request; + } + if ($parameters) { + $url->addRequestParameters($parameters); + } + return new SimpleHttpRequest($this->_createRoute($url), $method); + } + + /** + * Sets up either a direct route or via a proxy. + * @param SimpleUrl $url Target to fetch as url object. + * @return SimpleRoute Route to take to fetch URL. + * @access protected + */ + function _createRoute($url) { + if ($this->_proxy) { + return new SimpleProxyRoute( + $url, + $this->_proxy, + $this->_proxy_username, + $this->_proxy_password); + } + return new SimpleRoute($url); + } + + /** + * Adds additional manual headers. + * @param SimpleHttpRequest $request Outgoing request. + * @access private + */ + function _addAdditionalHeaders($request) { + foreach ($this->_additional_headers as $header) { + $request->addHeaderLine($header); + } + } + + /** + * Extracts new cookies into the cookie jar. + * @param SimpleUrl $url Target to fetch as url object. + * @param array $cookies New cookies. + * @access private + */ + function _addCookiesToJar($url, $cookies) { + foreach ($cookies as $cookie) { + if ($url->getHost()) { + $cookie->setHost($url->getHost()); + } + $this->_cookie_jar->setCookie($cookie); + } + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/web_tester.php b/tests/test_tools/simpletest/web_tester.php index 315da35a..4981d25a 100644 --- a/tests/UnitTests/simpletest/web_tester.php +++ b/tests/test_tools/simpletest/web_tester.php @@ -1,1330 +1,1330 @@ -<?php
- /**
- * Base include file for SimpleTest.
- * @package SimpleTest
- * @subpackage WebTester
- * @version $Id: web_tester.php,v 1.92 2005/02/22 02:39:22 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/simple_test.php');
- require_once(dirname(__FILE__) . '/browser.php');
- require_once(dirname(__FILE__) . '/page.php');
- require_once(dirname(__FILE__) . '/expectation.php');
- /**#@-*/
-
- /**
- * Test for an HTML widget value match.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class FieldExpectation extends SimpleExpectation {
- protected $_value;
-
- /**
- * Sets the field value to compare against.
- * @param mixed $value Test value to match.
- * @access public
- */
- function FieldExpectation($value) {
- $this->SimpleExpectation();
- if (is_array($value)) {
- sort($value);
- }
- $this->_value = $value;
- }
-
- /**
- * Tests the expectation. True if it matches
- * a string value or an array value in any order.
- * @param mixed $compare Comparison value. False for
- * an unset field.
- * @return boolean True if correct.
- * @access public
- */
- function test($compare) {
- if ($this->_value === false) {
- return ($compare === false);
- }
- if ($this->_isSingle($this->_value)) {
- return $this->_testSingle($compare);
- }
- if (is_array($this->_value)) {
- return $this->_testMultiple($compare);
- }
- return false;
- }
-
- /**
- * Tests for valid field comparisons with a single option.
- * @param mixed $value Value to type check.
- * @return boolean True if integer, string or float.
- * @access private
- */
- function _isSingle($value) {
- return is_string($value) || is_integer($value) || is_float($value);
- }
-
- /**
- * String comparison for simple field with a single option.
- * @param mixed $compare String to test against.
- * @returns boolean True if matching.
- * @access private
- */
- function _testSingle($compare) {
- if (is_array($compare) && count($compare) == 1) {
- $compare = $compare[0];
- }
- if (! $this->_isSingle($compare)) {
- return false;
- }
- return ($this->_value == $compare);
- }
-
- /**
- * List comparison for multivalue field.
- * @param mixed $compare List in any order to test against.
- * @returns boolean True if matching.
- * @access private
- */
- function _testMultiple($compare) {
- if (is_string($compare)) {
- $compare = array($compare);
- }
- if (! is_array($compare)) {
- return false;
- }
- sort($compare);
- return ($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) {
- $dumper = $this->_getDumper();
- if (is_array($compare)) {
- sort($compare);
- }
- if ($this->test($compare)) {
- return "Field expectation [" . $dumper->describeValue($this->_value) . "]";
- } else {
- return "Field expectation [" . $dumper->describeValue($this->_value) .
- "] fails with [" .
- $this->_dumper->describeValue($compare) . "] " .
- $this->_dumper->describeDifference($this->_value, $compare);
- }
- }
- }
-
- /**
- * Test for a specific HTTP header within a header block.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class HttpHeaderExpectation extends SimpleExpectation {
- protected $_expected_header;
- protected $_expected_value;
-
- /**
- * Sets the field and value to compare against.
- * @param string $header Case insenstive trimmed header name.
- * @param string $value Optional value to compare. If not
- * given then any value will match.
- */
- function HttpHeaderExpectation($header, $value = false) {
- $this->_expected_header = $this->_normaliseHeader($header);
- $this->_expected_value = $value;
- }
-
- /**
- * Accessor for subclases.
- * @return mixed Expectation set in constructor.
- * @access protected
- */
- function _getExpectation() {
- return $this->_expected_value;
- }
-
- /**
- * Removes whitespace at ends and case variations.
- * @param string $header Name of header.
- * @param string Trimmed and lowecased header
- * name.
- * @access private
- */
- function _normaliseHeader($header) {
- return strtolower(trim($header));
- }
-
- /**
- * Tests the expectation. True if it matches
- * a string value or an array value in any order.
- * @param mixed $compare Raw header block to search.
- * @return boolean True if header present.
- * @access public
- */
- function test($compare) {
- return is_string($this->_findHeader($compare));
- }
-
- /**
- * Searches the incoming result. Will extract the matching
- * line as text.
- * @param mixed $compare Raw header block to search.
- * @return string Matching header line.
- * @access protected
- */
- function _findHeader($compare) {
- $lines = split("\r\n", $compare);
- foreach ($lines as $line) {
- if ($this->_testHeaderLine($line)) {
- return $line;
- }
- }
- return false;
- }
-
- /**
- * Compares a single header line against the expectation.
- * @param string $line A single line to compare.
- * @return boolean True if matched.
- * @access private
- */
- function _testHeaderLine($line) {
- if (count($parsed = split(':', $line)) < 2) {
- return false;
- }
- list($header, $value) = $parsed;
- if ($this->_normaliseHeader($header) != $this->_expected_header) {
- return false;
- }
- return $this->_testHeaderValue($value, $this->_expected_value);
- }
-
- /**
- * Tests the value part of the header.
- * @param string $value Value to test.
- * @param mixed $expected Value to test against.
- * @return boolean True if matched.
- * @access protected
- */
- function _testHeaderValue($value, $expected) {
- if ($expected === false) {
- return true;
- }
- return (trim($value) == trim($expected));
- }
-
- /**
- * Returns a human readable test message.
- * @param mixed $compare Raw header block to search.
- * @return string Description of success
- * or failure.
- * @access public
- */
- function testMessage($compare) {
- $expectation = $this->_expected_header;
- if ($this->_expected_value) {
- $expectation .= ': ' . $this->_expected_header;
- }
- if (is_string($line = $this->_findHeader($compare))) {
- return "Searching for header [$expectation] found [$line]";
- } else {
- return "Failed to find header [$expectation]";
- }
- }
- }
-
- /**
- * Test for a specific HTTP header within a header block that
- * should not be found.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class HttpUnwantedHeaderExpectation extends HttpHeaderExpectation {
- protected $_expected_header;
- protected $_expected_value;
-
- /**
- * Sets the field and value to compare against.
- * @param string $unwanted Case insenstive trimmed header name.
- */
- function HttpUnwantedHeaderExpectation($unwanted) {
- $this->HttpHeaderExpectation($unwanted);
- }
-
- /**
- * Tests that the unwanted header is not found.
- * @param mixed $compare Raw header block to search.
- * @return boolean True if header present.
- * @access public
- */
- function test($compare) {
- return ($this->_findHeader($compare) === false);
- }
-
- /**
- * Returns a human readable test message.
- * @param mixed $compare Raw header block to search.
- * @return string Description of success
- * or failure.
- * @access public
- */
- function testMessage($compare) {
- $expectation = $this->_getExpectation();
- if (is_string($line = $this->_findHeader($compare))) {
- return "Found unwanted header [$expectation] with [$line]";
- } else {
- return "Did not find unwanted header [$expectation]";
- }
- }
- }
-
- /**
- * Test for a specific HTTP header within a header block.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class HttpHeaderPatternExpectation extends HttpHeaderExpectation {
-
- /**
- * Sets the field and value to compare against.
- * @param string $header Case insenstive header name.
- * @param string $pattern Pattern to compare value against.
- * @access public
- */
- function HttpHeaderPatternExpectation($header, $pattern) {
- $this->HttpHeaderExpectation($header, $pattern);
- }
-
- /**
- * Tests the value part of the header.
- * @param string $value Value to test.
- * @param mixed $pattern Pattern to test against.
- * @return boolean True if matched.
- * @access protected
- */
- function _testHeaderValue($value, $expected) {
- return (boolean)preg_match($expected, trim($value));
- }
- }
-
- /**
- * Test for a text substring.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class WantedTextExpectation extends SimpleExpectation {
- protected $_substring;
-
- /**
- * Sets the value to compare against.
- * @param string $substring Text to search for.
- * @param string $message Customised message on failure.
- * @access public
- */
- function WantedTextExpectation($substring, $message = '%s') {
- $this->SimpleExpectation($message);
- $this->_substring = $substring;
- }
-
- /**
- * Accessor for the substring.
- * @return string Text to match.
- * @access protected
- */
- function _getSubstring() {
- return $this->_substring;
- }
-
- /**
- * Tests the expectation. True if the text contains the
- * substring.
- * @param string $compare Comparison value.
- * @return boolean True if correct.
- * @access public
- */
- function test($compare) {
- return (strpos($compare, $this->_substring) !== false);
- }
-
- /**
- * 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->_describeTextMatch($this->_getSubstring(), $compare);
- } else {
- $dumper = $this->_getDumper();
- return "Text [" . $this->_getSubstring() .
- "] not detected in [" .
- $dumper->describeValue($compare) . "]";
- }
- }
-
- /**
- * Describes a pattern match including the string
- * found and it's position.
- * @param string $substring Text to search for.
- * @param string $subject Subject to search.
- * @access protected
- */
- function _describeTextMatch($substring, $subject) {
- $position = strpos($subject, $substring);
- $dumper = $this->_getDumper();
- return "Text [$substring] detected at character [$position] in [" .
- $dumper->describeValue($subject) . "] in region [" .
- $dumper->clipString($subject, 100, $position) . "]";
- }
- }
-
- /**
- * Fail if a substring is detected within the
- * comparison text.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class UnwantedTextExpectation extends WantedTextExpectation {
-
- /**
- * Sets the reject pattern
- * @param string $substring Text to search for.
- * @param string $message Customised message on failure.
- * @access public
- */
- function UnwantedTextExpectation($substring, $message = '%s') {
- $this->WantedTextExpectation($substring, $message);
- }
-
- /**
- * Tests the expectation. False if the substring appears
- * in the text.
- * @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 "Text [" . $this->_getSubstring() .
- "] not detected in [" .
- $dumper->describeValue($compare) . "]";
- } else {
- return $this->_describeTextMatch($this->_getSubstring(), $compare);
- }
- }
- }
-
- /**
- * Extension that builds a web browser at the start of each
- * test.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class WebTestCaseInvoker extends SimpleInvokerDecorator {
-
- /**
- * Takes in the test case and reporter to mediate between.
- * @param SimpleTestCase $test_case Test case to run.
- * @param SimpleScorer $scorer Reporter to receive events.
- */
- function WebTestCaseInvoker($invoker) {
- $this->SimpleInvokerDecorator($invoker);
- }
-
- /**
- * Builds the browser and runs the test.
- * @param string $method Test method to call.
- * @access public
- */
- function invoke($method) {
- $test = $this->getTestCase();
- $test->setBrowser($test->createBrowser());
- parent::invoke($method);
- $test->unsetBrowser();
- }
- }
-
- /**
- * Test case for testing of web pages. Allows
- * fetching of pages, parsing of HTML and
- * submitting forms.
- * @package SimpleTest
- * @subpackage WebTester
- */
- class WebTestCase extends SimpleTestCase {
- protected $_browser;
-
- /**
- * Creates an empty test case. Should be subclassed
- * with test methods for a functional test case.
- * @param string $label Name of test case. Will use
- * the class name if none specified.
- * @access public
- */
- function WebTestCase($label = false) {
- $this->SimpleTestCase($label);
- }
-
- /**
- * Sets the invoker to one that restarts the browser on
- * each request.
- * @return SimpleInvoker Invoker for each method.
- * @access public
- */
- function createInvoker() {
- return new WebTestCaseInvoker(parent::createInvoker());
- }
-
- /**
- * Gets a current browser reference for setting
- * special expectations or for detailed
- * examination of page fetches.
- * @return SimpleBrowser Current test browser object.
- * @access public
- */
- function getBrowser() {
- return $this->_browser;
- }
-
- /**
- * Gets a current browser reference for setting
- * special expectations or for detailed
- * examination of page fetches.
- * @param SimpleBrowser $browser New test browser object.
- * @access public
- */
- function setBrowser($browser) {
- return $this->_browser = $browser;
- }
-
- /**
- * Clears the current browser reference to help the
- * PHP garbage collector.
- * @access public
- */
- function unsetBrowser() {
- unset($this->_browser);
- }
-
- /**
- * Creates a new default web browser object.
- * Will be cleared at the end of the test method.
- * @return TestBrowser New browser.
- * @access public
- */
- function createBrowser() {
- return new SimpleBrowser();
- }
-
- /**
- * Gets the last response error.
- * @return string Last low level HTTP error.
- * @access public
- */
- function getTransportError() {
- return $this->_browser->getTransportError();
- }
-
- /**
- * Accessor for the currently selected URL.
- * @return string Current location or false if
- * no page yet fetched.
- * @access public
- */
- function getUrl() {
- return $this->_browser->getUrl();
- }
-
- /**
- * Dumps the current request for debugging.
- * @access public
- */
- function showRequest() {
- $this->dump($this->_browser->getRequest());
- }
-
- /**
- * Dumps the current HTTP headers for debugging.
- * @access public
- */
- function showHeaders() {
- $this->dump($this->_browser->getHeaders());
- }
-
- /**
- * Dumps the current HTML source for debugging.
- * @access public
- */
- function showSource() {
- $this->dump($this->_browser->getContent());
- }
-
- /**
- * Simulates the closing and reopening of the browser.
- * Temporary cookies will be discarded and timed
- * cookies will be expired if later than the
- * specified time.
- * @param string/integer $date Time when session restarted.
- * If ommitted then all persistent
- * cookies are kept. Time is either
- * Cookie format string or timestamp.
- * @access public
- */
- function restart($date = false) {
- if ($date === false) {
- $date = time();
- }
- $this->_browser->restart($date);
- }
-
- /**
- * Moves cookie expiry times back into the past.
- * Useful for testing timeouts and expiries.
- * @param integer $interval Amount to age in seconds.
- * @access public
- */
- function ageCookies($interval) {
- $this->_browser->ageCookies($interval);
- }
-
- /**
- * Disables frames support. Frames will not be fetched
- * and the frameset page will be used instead.
- * @access public
- */
- function ignoreFrames() {
- $this->_browser->ignoreFrames();
- }
-
- /**
- * Adds a header to every fetch.
- * @param string $header Header line to add to every
- * request until cleared.
- * @access public
- */
- function addHeader($header) {
- $this->_browser->addHeader($header);
- }
-
- /**
- * Sets the maximum number of redirects before
- * the web page is loaded regardless.
- * @param integer $max Maximum hops.
- * @access public
- */
- function setMaximumRedirects($max) {
- if (! $this->_browser) {
- trigger_error(
- 'Can only set maximum redirects in a test method, setUp() or tearDown()');
- }
- $this->_browser->setMaximumRedirects($max);
- }
-
- /**
- * Sets the socket timeout for opening a connection and
- * receiving at least one byte of information.
- * @param integer $timeout Maximum time in seconds.
- * @access public
- */
- function setConnectionTimeout($timeout) {
- $this->_browser->setConnectionTimeout($timeout);
- }
-
- /**
- * Sets proxy to use on all requests for when
- * testing from behind a firewall. Set URL
- * to false to disable.
- * @param string $proxy Proxy URL.
- * @param string $username Proxy username for authentication.
- * @param string $password Proxy password for authentication.
- * @access public
- */
- function useProxy($proxy, $username = false, $password = false) {
- $this->_browser->useProxy($proxy, $username, $password);
- }
-
- /**
- * Fetches a page into the page buffer. If
- * there is no base for the URL then the
- * current base URL is used. After the fetch
- * the base URL reflects the new location.
- * @param string $url URL to fetch.
- * @param hash $parameters Optional additional GET data.
- * @return boolean True on success.
- * @access public
- */
- function get($url, $parameters = false) {
- $content = $this->_browser->get($url, $parameters);
- if ($content === false) {
- return false;
- }
- return true;
- }
-
- /**
- * Fetches a page by POST into the page buffer.
- * If there is no base for the URL then the
- * current base URL is used. After the fetch
- * the base URL reflects the new location.
- * @param string $url URL to fetch.
- * @param hash $parameters Optional additional GET data.
- * @return boolean True on success.
- * @access public
- */
- function post($url, $parameters = false) {
- $content = $this->_browser->post($url, $parameters);
- if ($content === false) {
- return false;
- }
- return true;
- }
-
- /**
- * Does a HTTP HEAD fetch, fetching only the page
- * headers. The current base URL is unchanged by this.
- * @param string $url URL to fetch.
- * @param hash $parameters Optional additional GET data.
- * @return boolean True on success.
- * @access public
- */
- function head($url, $parameters = false) {
- return $this->_browser->head($url, $parameters);
- }
-
- /**
- * Equivalent to hitting the retry button on the
- * browser. Will attempt to repeat the page fetch.
- * @return boolean True if fetch succeeded.
- * @access public
- */
- function retry() {
- return $this->_browser->retry();
- }
-
- /**
- * Equivalent to hitting the back button on the
- * browser.
- * @return boolean True if history entry and
- * fetch succeeded.
- * @access public
- */
- function back() {
- return $this->_browser->back();
- }
-
- /**
- * Equivalent to hitting the forward button on the
- * browser.
- * @return boolean True if history entry and
- * fetch succeeded.
- * @access public
- */
- function forward() {
- return $this->_browser->forward();
- }
-
- /**
- * Retries a request after setting the authentication
- * for the current realm.
- * @param string $username Username for realm.
- * @param string $password Password for realm.
- * @return boolean True if successful fetch. Note
- * that authentication may still have
- * failed.
- * @access public
- */
- function authenticate($username, $password) {
- return $this->_browser->authenticate($username, $password);
- }
-
- /**
- * Gets the cookie value for the current browser context.
- * @param string $name Name of cookie.
- * @return string Value of cookie or false if unset.
- * @access public
- */
- function getCookie($name) {
- return $this->_browser->getCurrentCookieValue($name);
- }
-
- /**
- * Sets a cookie in the current browser.
- * @param string $name Name of cookie.
- * @param string $value Cookie value.
- * @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) {
- $this->_browser->setCookie($name, $value, $host, $path, $expiry);
- }
-
- /**
- * Accessor for current frame focus. Will be
- * false if no frame has focus.
- * @return integer/string/boolean Label if any, otherwise
- * the position in the frameset
- * or false if none.
- * @access public
- */
- function getFrameFocus() {
- return $this->_browser->getFrameFocus();
- }
-
- /**
- * Sets the focus by index. The integer index starts from 1.
- * @param integer $choice Chosen frame.
- * @return boolean True if frame exists.
- * @access public
- */
- function setFrameFocusByIndex($choice) {
- return $this->_browser->setFrameFocusByIndex($choice);
- }
-
- /**
- * Sets the focus by name.
- * @param string $name Chosen frame.
- * @return boolean True if frame exists.
- * @access public
- */
- function setFrameFocus($name) {
- return $this->_browser->setFrameFocus($name);
- }
-
- /**
- * Clears the frame focus. All frames will be searched
- * for content.
- * @access public
- */
- function clearFrameFocus() {
- return $this->_browser->clearFrameFocus();
- }
-
- /**
- * Clicks the submit button by label. The owning
- * form will be submitted by this.
- * @param string $label Button label. An unlabeled
- * button can be triggered by 'Submit'.
- * @param hash $additional Additional form values.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickSubmit($label = 'Submit', $additional = false) {
- return $this->_browser->clickSubmit($label, $additional);
- }
-
- /**
- * Clicks the submit button by name attribute. The owning
- * form will be submitted by this.
- * @param string $name Name attribute of button.
- * @param hash $additional Additional form values.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickSubmitByName($name, $additional = false) {
- return $this->_browser->clickSubmitByName($name, $additional);
- }
-
- /**
- * Clicks the submit button by ID attribute. The owning
- * form will be submitted by this.
- * @param string $id ID attribute of button.
- * @param hash $additional Additional form values.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickSubmitById($id, $additional = false) {
- return $this->_browser->clickSubmitById($id, $additional);
- }
-
- /**
- * Clicks the submit image by some kind of label. Usually
- * the alt tag or the nearest equivalent. The owning
- * form will be submitted by this. Clicking outside of
- * the boundary of the coordinates will result in
- * a failure.
- * @param string $label Alt attribute of button.
- * @param integer $x X-coordinate of imaginary click.
- * @param integer $y Y-coordinate of imaginary click.
- * @param hash $additional Additional form values.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickImage($label, $x = 1, $y = 1, $additional = false) {
- return $this->_browser->clickImage($label, $x, $y, $additional);
- }
-
- /**
- * Clicks the submit image by the name. Usually
- * the alt tag or the nearest equivalent. The owning
- * form will be submitted by this. Clicking outside of
- * the boundary of the coordinates will result in
- * a failure.
- * @param string $name Name attribute of button.
- * @param integer $x X-coordinate of imaginary click.
- * @param integer $y Y-coordinate of imaginary click.
- * @param hash $additional Additional form values.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickImageByName($name, $x = 1, $y = 1, $additional = false) {
- return $this->_browser->clickImageByName($name, $x, $y, $additional);
- }
-
- /**
- * Clicks the submit image by ID attribute. The owning
- * form will be submitted by this. Clicking outside of
- * the boundary of the coordinates will result in
- * a failure.
- * @param integer/string $id ID attribute of button.
- * @param integer $x X-coordinate of imaginary click.
- * @param integer $y Y-coordinate of imaginary click.
- * @param hash $additional Additional form values.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickImageById($id, $x = 1, $y = 1, $additional = false) {
- return $this->_browser->clickImageById($id, $x, $y, $additional);
- }
-
- /**
- * Submits a form by the ID.
- * @param string $id Form ID. No button information
- * is submitted this way.
- * @return boolean/string Page on success.
- * @access public
- */
- function submitFormById($id) {
- return $this->_browser->submitFormById($id);
- }
-
- /**
- * Follows a link by name. Will click the first link
- * found with this link text by default, or a later
- * one if an index is given. Match is case insensitive
- * with normalised space.
- * @param string $label Text between the anchor tags.
- * @param integer $index Link position counting from zero.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickLink($label, $index = 0) {
- return $this->_browser->clickLink($label, $index);
- }
-
- /**
- * Follows a link by id attribute.
- * @param string $id ID attribute value.
- * @return boolean/string Page on success.
- * @access public
- */
- function clickLinkById($id) {
- return $this->_browser->clickLinkById($id);
- }
-
- /**
- * Tests for the presence of a link label. Match is
- * case insensitive with normalised space.
- * @param string $label Text between the anchor tags.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if link present.
- * @access public
- */
- function assertLink($label, $message = "%s") {
- return $this->assertTrue(
- $this->_browser->isLink($label),
- sprintf($message, "Link [$label] should exist"));
- }
-
- /**
- * Tests for the non-presence of a link label. Match is
- * case insensitive with normalised space.
- * @param string/integer $label Text between the anchor tags
- * or ID attribute.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if link missing.
- * @access public
- */
- function assertNoLink($label, $message = "%s") {
- return $this->assertFalse(
- $this->_browser->isLink($label),
- sprintf($message, "Link [$label] should not exist"));
- }
-
- /**
- * Tests for the presence of a link id attribute.
- * @param string $id Id attribute value.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if link present.
- * @access public
- */
- function assertLinkById($id, $message = "%s") {
- return $this->assertTrue(
- $this->_browser->isLinkById($id),
- sprintf($message, "Link ID [$id] should exist"));
- }
-
- /**
- * Tests for the non-presence of a link label. Match is
- * case insensitive with normalised space.
- * @param string $id Id attribute value.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if link missing.
- * @access public
- */
- function assertNoLinkById($id, $message = "%s") {
- return $this->assertFalse(
- $this->_browser->isLinkById($id),
- sprintf($message, "Link ID [$id] should not exist"));
- }
-
- /**
- * Sets all form fields with that name.
- * @param string $name Name of field in forms.
- * @param string $value New value of field.
- * @return boolean True if field exists, otherwise false.
- * @access public
- */
- function setField($name, $value) {
- return $this->_browser->setField($name, $value);
- }
-
- /**
- * Sets all form fields with that name.
- * @param string/integer $id Id of field in forms.
- * @param string $value New value of field.
- * @return boolean True if field exists, otherwise false.
- * @access public
- */
- function setFieldById($id, $value) {
- return $this->_browser->setFieldById($id, $value);
- }
-
- /**
- * Confirms that the form element is currently set
- * to the expected value. A missing form will always
- * fail. If no value is given then only the existence
- * of the field is checked.
- * @param string $name Name of field in forms.
- * @param mixed $expected Expected string/array value or
- * false for unset fields.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if pass.
- * @access public
- */
- function assertField($name, $expected = true, $message = "%s") {
- $value = $this->_browser->getField($name);
- if ($expected === true) {
- return $this->assertTrue(
- isset($value),
- sprintf($message, "Field [$name] should exist"));
- } else {
- return $this->assertExpectation(
- new FieldExpectation($expected),
- $value,
- sprintf($message, "Field [$name] should match with [%s]"));
- }
- }
-
- /**
- * Confirms that the form element is currently set
- * to the expected value. A missing form will always
- * fail. If no ID is given then only the existence
- * of the field is checked.
- * @param string/integer $id Name of field in forms.
- * @param mixed $expected Expected string/array value or
- * false for unset fields.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if pass.
- * @access public
- */
- function assertFieldById($id, $expected = true, $message = "%s") {
- $value = $this->_browser->getFieldById($id);
- if ($expected === true) {
- return $this->assertTrue(
- isset($value),
- sprintf($message, "Field of ID [$id] should exist"));
- } else {
- return $this->assertExpectation(
- new FieldExpectation($expected),
- $value,
- sprintf($message, "Field of ID [$id] should match with [%s]"));
- }
- }
-
- /**
- * Checks the response code against a list
- * of possible values.
- * @param array $responses Possible responses for a pass.
- * @param string $message Message to display. Default
- * can be embedded with %s.
- * @return boolean True if pass.
- * @access public
- */
- function assertResponse($responses, $message = '%s') {
- $responses = (is_array($responses) ? $responses : array($responses));
- $code = $this->_browser->getResponseCode();
- $message = sprintf($message, "Expecting response in [" .
- implode(", ", $responses) . "] got [$code]");
- return $this->assertTrue(in_array($code, $responses), $message);
- }
-
- /**
- * Checks the mime type against a list
- * of possible values.
- * @param array $types Possible mime types for a pass.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertMime($types, $message = '%s') {
- $types = (is_array($types) ? $types : array($types));
- $type = $this->_browser->getMimeType();
- $message = sprintf($message, "Expecting mime type in [" .
- implode(", ", $types) . "] got [$type]");
- return $this->assertTrue(in_array($type, $types), $message);
- }
-
- /**
- * Attempt to match the authentication type within
- * the security realm we are currently matching.
- * @param string $authentication Usually basic.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertAuthentication($authentication = false, $message = '%s') {
- if (! $authentication) {
- $message = sprintf($message, "Expected any authentication type, got [" .
- $this->_browser->getAuthentication() . "]");
- return $this->assertTrue(
- $this->_browser->getAuthentication(),
- $message);
- } else {
- $message = sprintf($message, "Expected authentication [$authentication] got [" .
- $this->_browser->getAuthentication() . "]");
- return $this->assertTrue(
- strtolower($this->_browser->getAuthentication()) == strtolower($authentication),
- $message);
- }
- }
-
- /**
- * Checks that no authentication is necessary to view
- * the desired page.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoAuthentication($message = '%s') {
- $message = sprintf($message, "Expected no authentication type, got [" .
- $this->_browser->getAuthentication() . "]");
- return $this->assertFalse($this->_browser->getAuthentication(), $message);
- }
-
- /**
- * Attempts to match the current security realm.
- * @param string $realm Name of security realm.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertRealm($realm, $message = '%s') {
- $message = sprintf($message, "Expected realm [$realm] got [" .
- $this->_browser->getRealm() . "]");
- return $this->assertTrue(
- strtolower($this->_browser->getRealm()) == strtolower($realm),
- $message);
- }
-
- /**
- * Checks each header line for the required value. If no
- * value is given then only an existence check is made.
- * @param string $header Case insensitive header name.
- * @param string $value Case sensitive trimmed string to
- * match against.
- * @return boolean True if pass.
- * @access public
- */
- function assertHeader($header, $value = false, $message = '%s') {
- return $this->assertExpectation(
- new HttpHeaderExpectation($header, $value),
- $this->_browser->getHeaders(),
- $message);
- }
-
- /**
- * Checks each header line for the required pattern.
- * @param string $header Case insensitive header name.
- * @param string $pattern Pattern to match value against.
- * @return boolean True if pass.
- * @access public
- */
- function assertHeaderPattern($header, $pattern, $message = '%s') {
- return $this->assertExpectation(
- new HttpHeaderPatternExpectation($header, $pattern),
- $this->_browser->getHeaders(),
- $message);
- }
-
- /**
- * Confirms that the header type has not been received.
- * Only the landing page is checked. If you want to check
- * redirect pages, then you should limit redirects so
- * as to capture the page you want.
- * @param string $header Case insensitive header name.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoUnwantedHeader($header, $message = '%s') {
- return $this->assertExpectation(
- new HttpUnwantedHeaderExpectation($header),
- $this->_browser->getHeaders(),
- $message);
- }
-
- /**
- * Tests the text between the title tags.
- * @param string $title Expected title or empty
- * if expecting no title.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertTitle($title = false, $message = '%s') {
- return $this->assertTrue(
- $title === $this->_browser->getTitle(),
- sprintf($message, "Expecting title [$title] got [" .
- $this->_browser->getTitle() . "]"));
- }
-
- /**
- * Will trigger a pass if the text is found in the plain
- * text form of the page.
- * @param string $text Text to look for.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertWantedText($text, $message = '%s') {
- return $this->assertExpectation(
- new WantedTextExpectation($text),
- $this->_browser->getContentAsText(),
- $message);
- }
-
- /**
- * Will trigger a pass if the text is not found in the plain
- * text form of the page.
- * @param string $text Text to look for.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoUnwantedText($text, $message = '%s') {
- return $this->assertExpectation(
- new UnwantedTextExpectation($text),
- $this->_browser->getContentAsText(),
- $message);
- }
-
- /**
- * Will trigger a pass if the Perl regex pattern
- * is found in the raw content.
- * @param string $pattern Perl regex to look for including
- * the regex delimiters.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertWantedPattern($pattern, $message = '%s') {
- return $this->assertExpectation(
- new WantedPatternExpectation($pattern),
- $this->_browser->getContent(),
- $message);
- }
-
- /**
- * Will trigger a pass if the perl regex pattern
- * is not present in raw content.
- * @param string $pattern Perl regex to look for including
- * the regex delimiters.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoUnwantedPattern($pattern, $message = '%s') {
- return $this->assertExpectation(
- new UnwantedPatternExpectation($pattern),
- $this->_browser->getContent(),
- $message);
- }
-
- /**
- * Checks that a cookie is set for the current page
- * and optionally checks the value.
- * @param string $name Name of cookie to test.
- * @param string $expected Expected value as a string or
- * false if any value will do.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertCookie($name, $expected = false, $message = '%s') {
- $value = $this->getCookie($name);
- if ($expected) {
- return $this->assertTrue($value === $expected, sprintf(
- $message,
- "Expecting cookie [$name] value [$expected], got [$value]"));
- } else {
- return $this->assertTrue(
- $value,
- sprintf($message, "Expecting cookie [$name]"));
- }
- }
-
- /**
- * Checks that no cookie is present or that it has
- * been successfully cleared.
- * @param string $name Name of cookie to test.
- * @param string $message Message to display.
- * @return boolean True if pass.
- * @access public
- */
- function assertNoCookie($name, $message = '%s') {
- return $this->assertTrue(
- $this->getCookie($name) === false,
- sprintf($message, "Not expecting cookie [$name]"));
- }
- }
+<?php + /** + * Base include file for SimpleTest. + * @package SimpleTest + * @subpackage WebTester + * @version $Id: web_tester.php,v 1.92 2005/02/22 02:39:22 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/simple_test.php'); + require_once(dirname(__FILE__) . '/browser.php'); + require_once(dirname(__FILE__) . '/page.php'); + require_once(dirname(__FILE__) . '/expectation.php'); + /**#@-*/ + + /** + * Test for an HTML widget value match. + * @package SimpleTest + * @subpackage WebTester + */ + class FieldExpectation extends SimpleExpectation { + protected $_value; + + /** + * Sets the field value to compare against. + * @param mixed $value Test value to match. + * @access public + */ + function FieldExpectation($value) { + $this->SimpleExpectation(); + if (is_array($value)) { + sort($value); + } + $this->_value = $value; + } + + /** + * Tests the expectation. True if it matches + * a string value or an array value in any order. + * @param mixed $compare Comparison value. False for + * an unset field. + * @return boolean True if correct. + * @access public + */ + function test($compare) { + if ($this->_value === false) { + return ($compare === false); + } + if ($this->_isSingle($this->_value)) { + return $this->_testSingle($compare); + } + if (is_array($this->_value)) { + return $this->_testMultiple($compare); + } + return false; + } + + /** + * Tests for valid field comparisons with a single option. + * @param mixed $value Value to type check. + * @return boolean True if integer, string or float. + * @access private + */ + function _isSingle($value) { + return is_string($value) || is_integer($value) || is_float($value); + } + + /** + * String comparison for simple field with a single option. + * @param mixed $compare String to test against. + * @returns boolean True if matching. + * @access private + */ + function _testSingle($compare) { + if (is_array($compare) && count($compare) == 1) { + $compare = $compare[0]; + } + if (! $this->_isSingle($compare)) { + return false; + } + return ($this->_value == $compare); + } + + /** + * List comparison for multivalue field. + * @param mixed $compare List in any order to test against. + * @returns boolean True if matching. + * @access private + */ + function _testMultiple($compare) { + if (is_string($compare)) { + $compare = array($compare); + } + if (! is_array($compare)) { + return false; + } + sort($compare); + return ($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) { + $dumper = $this->_getDumper(); + if (is_array($compare)) { + sort($compare); + } + if ($this->test($compare)) { + return "Field expectation [" . $dumper->describeValue($this->_value) . "]"; + } else { + return "Field expectation [" . $dumper->describeValue($this->_value) . + "] fails with [" . + $this->_dumper->describeValue($compare) . "] " . + $this->_dumper->describeDifference($this->_value, $compare); + } + } + } + + /** + * Test for a specific HTTP header within a header block. + * @package SimpleTest + * @subpackage WebTester + */ + class HttpHeaderExpectation extends SimpleExpectation { + protected $_expected_header; + protected $_expected_value; + + /** + * Sets the field and value to compare against. + * @param string $header Case insenstive trimmed header name. + * @param string $value Optional value to compare. If not + * given then any value will match. + */ + function HttpHeaderExpectation($header, $value = false) { + $this->_expected_header = $this->_normaliseHeader($header); + $this->_expected_value = $value; + } + + /** + * Accessor for subclases. + * @return mixed Expectation set in constructor. + * @access protected + */ + function _getExpectation() { + return $this->_expected_value; + } + + /** + * Removes whitespace at ends and case variations. + * @param string $header Name of header. + * @param string Trimmed and lowecased header + * name. + * @access private + */ + function _normaliseHeader($header) { + return strtolower(trim($header)); + } + + /** + * Tests the expectation. True if it matches + * a string value or an array value in any order. + * @param mixed $compare Raw header block to search. + * @return boolean True if header present. + * @access public + */ + function test($compare) { + return is_string($this->_findHeader($compare)); + } + + /** + * Searches the incoming result. Will extract the matching + * line as text. + * @param mixed $compare Raw header block to search. + * @return string Matching header line. + * @access protected + */ + function _findHeader($compare) { + $lines = split("\r\n", $compare); + foreach ($lines as $line) { + if ($this->_testHeaderLine($line)) { + return $line; + } + } + return false; + } + + /** + * Compares a single header line against the expectation. + * @param string $line A single line to compare. + * @return boolean True if matched. + * @access private + */ + function _testHeaderLine($line) { + if (count($parsed = split(':', $line)) < 2) { + return false; + } + list($header, $value) = $parsed; + if ($this->_normaliseHeader($header) != $this->_expected_header) { + return false; + } + return $this->_testHeaderValue($value, $this->_expected_value); + } + + /** + * Tests the value part of the header. + * @param string $value Value to test. + * @param mixed $expected Value to test against. + * @return boolean True if matched. + * @access protected + */ + function _testHeaderValue($value, $expected) { + if ($expected === false) { + return true; + } + return (trim($value) == trim($expected)); + } + + /** + * Returns a human readable test message. + * @param mixed $compare Raw header block to search. + * @return string Description of success + * or failure. + * @access public + */ + function testMessage($compare) { + $expectation = $this->_expected_header; + if ($this->_expected_value) { + $expectation .= ': ' . $this->_expected_header; + } + if (is_string($line = $this->_findHeader($compare))) { + return "Searching for header [$expectation] found [$line]"; + } else { + return "Failed to find header [$expectation]"; + } + } + } + + /** + * Test for a specific HTTP header within a header block that + * should not be found. + * @package SimpleTest + * @subpackage WebTester + */ + class HttpUnwantedHeaderExpectation extends HttpHeaderExpectation { + protected $_expected_header; + protected $_expected_value; + + /** + * Sets the field and value to compare against. + * @param string $unwanted Case insenstive trimmed header name. + */ + function HttpUnwantedHeaderExpectation($unwanted) { + $this->HttpHeaderExpectation($unwanted); + } + + /** + * Tests that the unwanted header is not found. + * @param mixed $compare Raw header block to search. + * @return boolean True if header present. + * @access public + */ + function test($compare) { + return ($this->_findHeader($compare) === false); + } + + /** + * Returns a human readable test message. + * @param mixed $compare Raw header block to search. + * @return string Description of success + * or failure. + * @access public + */ + function testMessage($compare) { + $expectation = $this->_getExpectation(); + if (is_string($line = $this->_findHeader($compare))) { + return "Found unwanted header [$expectation] with [$line]"; + } else { + return "Did not find unwanted header [$expectation]"; + } + } + } + + /** + * Test for a specific HTTP header within a header block. + * @package SimpleTest + * @subpackage WebTester + */ + class HttpHeaderPatternExpectation extends HttpHeaderExpectation { + + /** + * Sets the field and value to compare against. + * @param string $header Case insenstive header name. + * @param string $pattern Pattern to compare value against. + * @access public + */ + function HttpHeaderPatternExpectation($header, $pattern) { + $this->HttpHeaderExpectation($header, $pattern); + } + + /** + * Tests the value part of the header. + * @param string $value Value to test. + * @param mixed $pattern Pattern to test against. + * @return boolean True if matched. + * @access protected + */ + function _testHeaderValue($value, $expected) { + return (boolean)preg_match($expected, trim($value)); + } + } + + /** + * Test for a text substring. + * @package SimpleTest + * @subpackage UnitTester + */ + class WantedTextExpectation extends SimpleExpectation { + protected $_substring; + + /** + * Sets the value to compare against. + * @param string $substring Text to search for. + * @param string $message Customised message on failure. + * @access public + */ + function WantedTextExpectation($substring, $message = '%s') { + $this->SimpleExpectation($message); + $this->_substring = $substring; + } + + /** + * Accessor for the substring. + * @return string Text to match. + * @access protected + */ + function _getSubstring() { + return $this->_substring; + } + + /** + * Tests the expectation. True if the text contains the + * substring. + * @param string $compare Comparison value. + * @return boolean True if correct. + * @access public + */ + function test($compare) { + return (strpos($compare, $this->_substring) !== false); + } + + /** + * 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->_describeTextMatch($this->_getSubstring(), $compare); + } else { + $dumper = $this->_getDumper(); + return "Text [" . $this->_getSubstring() . + "] not detected in [" . + $dumper->describeValue($compare) . "]"; + } + } + + /** + * Describes a pattern match including the string + * found and it's position. + * @param string $substring Text to search for. + * @param string $subject Subject to search. + * @access protected + */ + function _describeTextMatch($substring, $subject) { + $position = strpos($subject, $substring); + $dumper = $this->_getDumper(); + return "Text [$substring] detected at character [$position] in [" . + $dumper->describeValue($subject) . "] in region [" . + $dumper->clipString($subject, 100, $position) . "]"; + } + } + + /** + * Fail if a substring is detected within the + * comparison text. + * @package SimpleTest + * @subpackage UnitTester + */ + class UnwantedTextExpectation extends WantedTextExpectation { + + /** + * Sets the reject pattern + * @param string $substring Text to search for. + * @param string $message Customised message on failure. + * @access public + */ + function UnwantedTextExpectation($substring, $message = '%s') { + $this->WantedTextExpectation($substring, $message); + } + + /** + * Tests the expectation. False if the substring appears + * in the text. + * @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 "Text [" . $this->_getSubstring() . + "] not detected in [" . + $dumper->describeValue($compare) . "]"; + } else { + return $this->_describeTextMatch($this->_getSubstring(), $compare); + } + } + } + + /** + * Extension that builds a web browser at the start of each + * test. + * @package SimpleTest + * @subpackage WebTester + */ + class WebTestCaseInvoker extends SimpleInvokerDecorator { + + /** + * Takes in the test case and reporter to mediate between. + * @param SimpleTestCase $test_case Test case to run. + * @param SimpleScorer $scorer Reporter to receive events. + */ + function WebTestCaseInvoker($invoker) { + $this->SimpleInvokerDecorator($invoker); + } + + /** + * Builds the browser and runs the test. + * @param string $method Test method to call. + * @access public + */ + function invoke($method) { + $test = $this->getTestCase(); + $test->setBrowser($test->createBrowser()); + parent::invoke($method); + $test->unsetBrowser(); + } + } + + /** + * Test case for testing of web pages. Allows + * fetching of pages, parsing of HTML and + * submitting forms. + * @package SimpleTest + * @subpackage WebTester + */ + class WebTestCase extends SimpleTestCase { + protected $_browser; + + /** + * Creates an empty test case. Should be subclassed + * with test methods for a functional test case. + * @param string $label Name of test case. Will use + * the class name if none specified. + * @access public + */ + function WebTestCase($label = false) { + $this->SimpleTestCase($label); + } + + /** + * Sets the invoker to one that restarts the browser on + * each request. + * @return SimpleInvoker Invoker for each method. + * @access public + */ + function createInvoker() { + return new WebTestCaseInvoker(parent::createInvoker()); + } + + /** + * Gets a current browser reference for setting + * special expectations or for detailed + * examination of page fetches. + * @return SimpleBrowser Current test browser object. + * @access public + */ + function getBrowser() { + return $this->_browser; + } + + /** + * Gets a current browser reference for setting + * special expectations or for detailed + * examination of page fetches. + * @param SimpleBrowser $browser New test browser object. + * @access public + */ + function setBrowser($browser) { + return $this->_browser = $browser; + } + + /** + * Clears the current browser reference to help the + * PHP garbage collector. + * @access public + */ + function unsetBrowser() { + unset($this->_browser); + } + + /** + * Creates a new default web browser object. + * Will be cleared at the end of the test method. + * @return TestBrowser New browser. + * @access public + */ + function createBrowser() { + return new SimpleBrowser(); + } + + /** + * Gets the last response error. + * @return string Last low level HTTP error. + * @access public + */ + function getTransportError() { + return $this->_browser->getTransportError(); + } + + /** + * Accessor for the currently selected URL. + * @return string Current location or false if + * no page yet fetched. + * @access public + */ + function getUrl() { + return $this->_browser->getUrl(); + } + + /** + * Dumps the current request for debugging. + * @access public + */ + function showRequest() { + $this->dump($this->_browser->getRequest()); + } + + /** + * Dumps the current HTTP headers for debugging. + * @access public + */ + function showHeaders() { + $this->dump($this->_browser->getHeaders()); + } + + /** + * Dumps the current HTML source for debugging. + * @access public + */ + function showSource() { + $this->dump($this->_browser->getContent()); + } + + /** + * Simulates the closing and reopening of the browser. + * Temporary cookies will be discarded and timed + * cookies will be expired if later than the + * specified time. + * @param string/integer $date Time when session restarted. + * If ommitted then all persistent + * cookies are kept. Time is either + * Cookie format string or timestamp. + * @access public + */ + function restart($date = false) { + if ($date === false) { + $date = time(); + } + $this->_browser->restart($date); + } + + /** + * Moves cookie expiry times back into the past. + * Useful for testing timeouts and expiries. + * @param integer $interval Amount to age in seconds. + * @access public + */ + function ageCookies($interval) { + $this->_browser->ageCookies($interval); + } + + /** + * Disables frames support. Frames will not be fetched + * and the frameset page will be used instead. + * @access public + */ + function ignoreFrames() { + $this->_browser->ignoreFrames(); + } + + /** + * Adds a header to every fetch. + * @param string $header Header line to add to every + * request until cleared. + * @access public + */ + function addHeader($header) { + $this->_browser->addHeader($header); + } + + /** + * Sets the maximum number of redirects before + * the web page is loaded regardless. + * @param integer $max Maximum hops. + * @access public + */ + function setMaximumRedirects($max) { + if (! $this->_browser) { + trigger_error( + 'Can only set maximum redirects in a test method, setUp() or tearDown()'); + } + $this->_browser->setMaximumRedirects($max); + } + + /** + * Sets the socket timeout for opening a connection and + * receiving at least one byte of information. + * @param integer $timeout Maximum time in seconds. + * @access public + */ + function setConnectionTimeout($timeout) { + $this->_browser->setConnectionTimeout($timeout); + } + + /** + * Sets proxy to use on all requests for when + * testing from behind a firewall. Set URL + * to false to disable. + * @param string $proxy Proxy URL. + * @param string $username Proxy username for authentication. + * @param string $password Proxy password for authentication. + * @access public + */ + function useProxy($proxy, $username = false, $password = false) { + $this->_browser->useProxy($proxy, $username, $password); + } + + /** + * Fetches a page into the page buffer. If + * there is no base for the URL then the + * current base URL is used. After the fetch + * the base URL reflects the new location. + * @param string $url URL to fetch. + * @param hash $parameters Optional additional GET data. + * @return boolean True on success. + * @access public + */ + function get($url, $parameters = false) { + $content = $this->_browser->get($url, $parameters); + if ($content === false) { + return false; + } + return true; + } + + /** + * Fetches a page by POST into the page buffer. + * If there is no base for the URL then the + * current base URL is used. After the fetch + * the base URL reflects the new location. + * @param string $url URL to fetch. + * @param hash $parameters Optional additional GET data. + * @return boolean True on success. + * @access public + */ + function post($url, $parameters = false) { + $content = $this->_browser->post($url, $parameters); + if ($content === false) { + return false; + } + return true; + } + + /** + * Does a HTTP HEAD fetch, fetching only the page + * headers. The current base URL is unchanged by this. + * @param string $url URL to fetch. + * @param hash $parameters Optional additional GET data. + * @return boolean True on success. + * @access public + */ + function head($url, $parameters = false) { + return $this->_browser->head($url, $parameters); + } + + /** + * Equivalent to hitting the retry button on the + * browser. Will attempt to repeat the page fetch. + * @return boolean True if fetch succeeded. + * @access public + */ + function retry() { + return $this->_browser->retry(); + } + + /** + * Equivalent to hitting the back button on the + * browser. + * @return boolean True if history entry and + * fetch succeeded. + * @access public + */ + function back() { + return $this->_browser->back(); + } + + /** + * Equivalent to hitting the forward button on the + * browser. + * @return boolean True if history entry and + * fetch succeeded. + * @access public + */ + function forward() { + return $this->_browser->forward(); + } + + /** + * Retries a request after setting the authentication + * for the current realm. + * @param string $username Username for realm. + * @param string $password Password for realm. + * @return boolean True if successful fetch. Note + * that authentication may still have + * failed. + * @access public + */ + function authenticate($username, $password) { + return $this->_browser->authenticate($username, $password); + } + + /** + * Gets the cookie value for the current browser context. + * @param string $name Name of cookie. + * @return string Value of cookie or false if unset. + * @access public + */ + function getCookie($name) { + return $this->_browser->getCurrentCookieValue($name); + } + + /** + * Sets a cookie in the current browser. + * @param string $name Name of cookie. + * @param string $value Cookie value. + * @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) { + $this->_browser->setCookie($name, $value, $host, $path, $expiry); + } + + /** + * Accessor for current frame focus. Will be + * false if no frame has focus. + * @return integer/string/boolean Label if any, otherwise + * the position in the frameset + * or false if none. + * @access public + */ + function getFrameFocus() { + return $this->_browser->getFrameFocus(); + } + + /** + * Sets the focus by index. The integer index starts from 1. + * @param integer $choice Chosen frame. + * @return boolean True if frame exists. + * @access public + */ + function setFrameFocusByIndex($choice) { + return $this->_browser->setFrameFocusByIndex($choice); + } + + /** + * Sets the focus by name. + * @param string $name Chosen frame. + * @return boolean True if frame exists. + * @access public + */ + function setFrameFocus($name) { + return $this->_browser->setFrameFocus($name); + } + + /** + * Clears the frame focus. All frames will be searched + * for content. + * @access public + */ + function clearFrameFocus() { + return $this->_browser->clearFrameFocus(); + } + + /** + * Clicks the submit button by label. The owning + * form will be submitted by this. + * @param string $label Button label. An unlabeled + * button can be triggered by 'Submit'. + * @param hash $additional Additional form values. + * @return boolean/string Page on success. + * @access public + */ + function clickSubmit($label = 'Submit', $additional = false) { + return $this->_browser->clickSubmit($label, $additional); + } + + /** + * Clicks the submit button by name attribute. The owning + * form will be submitted by this. + * @param string $name Name attribute of button. + * @param hash $additional Additional form values. + * @return boolean/string Page on success. + * @access public + */ + function clickSubmitByName($name, $additional = false) { + return $this->_browser->clickSubmitByName($name, $additional); + } + + /** + * Clicks the submit button by ID attribute. The owning + * form will be submitted by this. + * @param string $id ID attribute of button. + * @param hash $additional Additional form values. + * @return boolean/string Page on success. + * @access public + */ + function clickSubmitById($id, $additional = false) { + return $this->_browser->clickSubmitById($id, $additional); + } + + /** + * Clicks the submit image by some kind of label. Usually + * the alt tag or the nearest equivalent. The owning + * form will be submitted by this. Clicking outside of + * the boundary of the coordinates will result in + * a failure. + * @param string $label Alt attribute of button. + * @param integer $x X-coordinate of imaginary click. + * @param integer $y Y-coordinate of imaginary click. + * @param hash $additional Additional form values. + * @return boolean/string Page on success. + * @access public + */ + function clickImage($label, $x = 1, $y = 1, $additional = false) { + return $this->_browser->clickImage($label, $x, $y, $additional); + } + + /** + * Clicks the submit image by the name. Usually + * the alt tag or the nearest equivalent. The owning + * form will be submitted by this. Clicking outside of + * the boundary of the coordinates will result in + * a failure. + * @param string $name Name attribute of button. + * @param integer $x X-coordinate of imaginary click. + * @param integer $y Y-coordinate of imaginary click. + * @param hash $additional Additional form values. + * @return boolean/string Page on success. + * @access public + */ + function clickImageByName($name, $x = 1, $y = 1, $additional = false) { + return $this->_browser->clickImageByName($name, $x, $y, $additional); + } + + /** + * Clicks the submit image by ID attribute. The owning + * form will be submitted by this. Clicking outside of + * the boundary of the coordinates will result in + * a failure. + * @param integer/string $id ID attribute of button. + * @param integer $x X-coordinate of imaginary click. + * @param integer $y Y-coordinate of imaginary click. + * @param hash $additional Additional form values. + * @return boolean/string Page on success. + * @access public + */ + function clickImageById($id, $x = 1, $y = 1, $additional = false) { + return $this->_browser->clickImageById($id, $x, $y, $additional); + } + + /** + * Submits a form by the ID. + * @param string $id Form ID. No button information + * is submitted this way. + * @return boolean/string Page on success. + * @access public + */ + function submitFormById($id) { + return $this->_browser->submitFormById($id); + } + + /** + * Follows a link by name. Will click the first link + * found with this link text by default, or a later + * one if an index is given. Match is case insensitive + * with normalised space. + * @param string $label Text between the anchor tags. + * @param integer $index Link position counting from zero. + * @return boolean/string Page on success. + * @access public + */ + function clickLink($label, $index = 0) { + return $this->_browser->clickLink($label, $index); + } + + /** + * Follows a link by id attribute. + * @param string $id ID attribute value. + * @return boolean/string Page on success. + * @access public + */ + function clickLinkById($id) { + return $this->_browser->clickLinkById($id); + } + + /** + * Tests for the presence of a link label. Match is + * case insensitive with normalised space. + * @param string $label Text between the anchor tags. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if link present. + * @access public + */ + function assertLink($label, $message = "%s") { + return $this->assertTrue( + $this->_browser->isLink($label), + sprintf($message, "Link [$label] should exist")); + } + + /** + * Tests for the non-presence of a link label. Match is + * case insensitive with normalised space. + * @param string/integer $label Text between the anchor tags + * or ID attribute. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if link missing. + * @access public + */ + function assertNoLink($label, $message = "%s") { + return $this->assertFalse( + $this->_browser->isLink($label), + sprintf($message, "Link [$label] should not exist")); + } + + /** + * Tests for the presence of a link id attribute. + * @param string $id Id attribute value. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if link present. + * @access public + */ + function assertLinkById($id, $message = "%s") { + return $this->assertTrue( + $this->_browser->isLinkById($id), + sprintf($message, "Link ID [$id] should exist")); + } + + /** + * Tests for the non-presence of a link label. Match is + * case insensitive with normalised space. + * @param string $id Id attribute value. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if link missing. + * @access public + */ + function assertNoLinkById($id, $message = "%s") { + return $this->assertFalse( + $this->_browser->isLinkById($id), + sprintf($message, "Link ID [$id] should not exist")); + } + + /** + * Sets all form fields with that name. + * @param string $name Name of field in forms. + * @param string $value New value of field. + * @return boolean True if field exists, otherwise false. + * @access public + */ + function setField($name, $value) { + return $this->_browser->setField($name, $value); + } + + /** + * Sets all form fields with that name. + * @param string/integer $id Id of field in forms. + * @param string $value New value of field. + * @return boolean True if field exists, otherwise false. + * @access public + */ + function setFieldById($id, $value) { + return $this->_browser->setFieldById($id, $value); + } + + /** + * Confirms that the form element is currently set + * to the expected value. A missing form will always + * fail. If no value is given then only the existence + * of the field is checked. + * @param string $name Name of field in forms. + * @param mixed $expected Expected string/array value or + * false for unset fields. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if pass. + * @access public + */ + function assertField($name, $expected = true, $message = "%s") { + $value = $this->_browser->getField($name); + if ($expected === true) { + return $this->assertTrue( + isset($value), + sprintf($message, "Field [$name] should exist")); + } else { + return $this->assertExpectation( + new FieldExpectation($expected), + $value, + sprintf($message, "Field [$name] should match with [%s]")); + } + } + + /** + * Confirms that the form element is currently set + * to the expected value. A missing form will always + * fail. If no ID is given then only the existence + * of the field is checked. + * @param string/integer $id Name of field in forms. + * @param mixed $expected Expected string/array value or + * false for unset fields. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if pass. + * @access public + */ + function assertFieldById($id, $expected = true, $message = "%s") { + $value = $this->_browser->getFieldById($id); + if ($expected === true) { + return $this->assertTrue( + isset($value), + sprintf($message, "Field of ID [$id] should exist")); + } else { + return $this->assertExpectation( + new FieldExpectation($expected), + $value, + sprintf($message, "Field of ID [$id] should match with [%s]")); + } + } + + /** + * Checks the response code against a list + * of possible values. + * @param array $responses Possible responses for a pass. + * @param string $message Message to display. Default + * can be embedded with %s. + * @return boolean True if pass. + * @access public + */ + function assertResponse($responses, $message = '%s') { + $responses = (is_array($responses) ? $responses : array($responses)); + $code = $this->_browser->getResponseCode(); + $message = sprintf($message, "Expecting response in [" . + implode(", ", $responses) . "] got [$code]"); + return $this->assertTrue(in_array($code, $responses), $message); + } + + /** + * Checks the mime type against a list + * of possible values. + * @param array $types Possible mime types for a pass. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertMime($types, $message = '%s') { + $types = (is_array($types) ? $types : array($types)); + $type = $this->_browser->getMimeType(); + $message = sprintf($message, "Expecting mime type in [" . + implode(", ", $types) . "] got [$type]"); + return $this->assertTrue(in_array($type, $types), $message); + } + + /** + * Attempt to match the authentication type within + * the security realm we are currently matching. + * @param string $authentication Usually basic. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertAuthentication($authentication = false, $message = '%s') { + if (! $authentication) { + $message = sprintf($message, "Expected any authentication type, got [" . + $this->_browser->getAuthentication() . "]"); + return $this->assertTrue( + $this->_browser->getAuthentication(), + $message); + } else { + $message = sprintf($message, "Expected authentication [$authentication] got [" . + $this->_browser->getAuthentication() . "]"); + return $this->assertTrue( + strtolower($this->_browser->getAuthentication()) == strtolower($authentication), + $message); + } + } + + /** + * Checks that no authentication is necessary to view + * the desired page. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertNoAuthentication($message = '%s') { + $message = sprintf($message, "Expected no authentication type, got [" . + $this->_browser->getAuthentication() . "]"); + return $this->assertFalse($this->_browser->getAuthentication(), $message); + } + + /** + * Attempts to match the current security realm. + * @param string $realm Name of security realm. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertRealm($realm, $message = '%s') { + $message = sprintf($message, "Expected realm [$realm] got [" . + $this->_browser->getRealm() . "]"); + return $this->assertTrue( + strtolower($this->_browser->getRealm()) == strtolower($realm), + $message); + } + + /** + * Checks each header line for the required value. If no + * value is given then only an existence check is made. + * @param string $header Case insensitive header name. + * @param string $value Case sensitive trimmed string to + * match against. + * @return boolean True if pass. + * @access public + */ + function assertHeader($header, $value = false, $message = '%s') { + return $this->assertExpectation( + new HttpHeaderExpectation($header, $value), + $this->_browser->getHeaders(), + $message); + } + + /** + * Checks each header line for the required pattern. + * @param string $header Case insensitive header name. + * @param string $pattern Pattern to match value against. + * @return boolean True if pass. + * @access public + */ + function assertHeaderPattern($header, $pattern, $message = '%s') { + return $this->assertExpectation( + new HttpHeaderPatternExpectation($header, $pattern), + $this->_browser->getHeaders(), + $message); + } + + /** + * Confirms that the header type has not been received. + * Only the landing page is checked. If you want to check + * redirect pages, then you should limit redirects so + * as to capture the page you want. + * @param string $header Case insensitive header name. + * @return boolean True if pass. + * @access public + */ + function assertNoUnwantedHeader($header, $message = '%s') { + return $this->assertExpectation( + new HttpUnwantedHeaderExpectation($header), + $this->_browser->getHeaders(), + $message); + } + + /** + * Tests the text between the title tags. + * @param string $title Expected title or empty + * if expecting no title. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertTitle($title = false, $message = '%s') { + return $this->assertTrue( + $title === $this->_browser->getTitle(), + sprintf($message, "Expecting title [$title] got [" . + $this->_browser->getTitle() . "]")); + } + + /** + * Will trigger a pass if the text is found in the plain + * text form of the page. + * @param string $text Text to look for. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertWantedText($text, $message = '%s') { + return $this->assertExpectation( + new WantedTextExpectation($text), + $this->_browser->getContentAsText(), + $message); + } + + /** + * Will trigger a pass if the text is not found in the plain + * text form of the page. + * @param string $text Text to look for. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertNoUnwantedText($text, $message = '%s') { + return $this->assertExpectation( + new UnwantedTextExpectation($text), + $this->_browser->getContentAsText(), + $message); + } + + /** + * Will trigger a pass if the Perl regex pattern + * is found in the raw content. + * @param string $pattern Perl regex to look for including + * the regex delimiters. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertWantedPattern($pattern, $message = '%s') { + return $this->assertExpectation( + new WantedPatternExpectation($pattern), + $this->_browser->getContent(), + $message); + } + + /** + * Will trigger a pass if the perl regex pattern + * is not present in raw content. + * @param string $pattern Perl regex to look for including + * the regex delimiters. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertNoUnwantedPattern($pattern, $message = '%s') { + return $this->assertExpectation( + new UnwantedPatternExpectation($pattern), + $this->_browser->getContent(), + $message); + } + + /** + * Checks that a cookie is set for the current page + * and optionally checks the value. + * @param string $name Name of cookie to test. + * @param string $expected Expected value as a string or + * false if any value will do. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertCookie($name, $expected = false, $message = '%s') { + $value = $this->getCookie($name); + if ($expected) { + return $this->assertTrue($value === $expected, sprintf( + $message, + "Expecting cookie [$name] value [$expected], got [$value]")); + } else { + return $this->assertTrue( + $value, + sprintf($message, "Expecting cookie [$name]")); + } + } + + /** + * Checks that no cookie is present or that it has + * been successfully cleared. + * @param string $name Name of cookie to test. + * @param string $message Message to display. + * @return boolean True if pass. + * @access public + */ + function assertNoCookie($name, $message = '%s') { + return $this->assertTrue( + $this->getCookie($name) === false, + sprintf($message, "Not expecting cookie [$name]")); + } + } ?>
\ No newline at end of file diff --git a/tests/UnitTests/simpletest/xml.php b/tests/test_tools/simpletest/xml.php index a842860c..dd007d41 100644 --- a/tests/UnitTests/simpletest/xml.php +++ b/tests/test_tools/simpletest/xml.php @@ -1,615 +1,615 @@ -<?php
- /**
- * base include file for SimpleTest
- * @package SimpleTest
- * @subpackage UnitTester
- * @version $Id: xml.php,v 1.20 2004/08/04 22:09:39 lastcraft Exp $
- */
-
- /**#@+
- * include other SimpleTest class files
- */
- require_once(dirname(__FILE__) . '/scorer.php');
- /**#@-*/
-
- /**
- * Creates the XML needed for remote communication
- * by SimpleTest.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class XmlReporter extends SimpleReporter {
- protected $_indent;
- protected $_namespace;
-
- /**
- * Does nothing yet.
- * @access public
- */
- function XmlReporter($namespace = false, $indent = ' ') {
- $this->SimpleReporter();
- $this->_namespace = ($namespace ? $namespace . ':' : '');
- $this->_indent = $indent;
- }
-
- /**
- * Calculates the pretty printing indent level
- * from the current level of nesting.
- * @param integer $offset Extra indenting level.
- * @return string Leading space.
- * @access protected
- */
- function _getIndent($offset = 0) {
- return str_repeat(
- $this->_indent,
- count($this->getTestList()) + $offset);
- }
-
- /**
- * Converts character string to parsed XML
- * entities string.
- * @param string text Unparsed character data.
- * @return string Parsed character data.
- * @access public
- */
- function toParsedXml($text) {
- return str_replace(
- array('&', '<', '>', '"', '\''),
- array('&', '<', '>', '"', '''),
- $text);
- }
-
- /**
- * Paints the start of a group test.
- * @param string $test_name Name of test that is starting.
- * @param integer $size Number of test cases starting.
- * @access public
- */
- function paintGroupStart($test_name, $size) {
- parent::paintGroupStart($test_name, $size);
- print $this->_getIndent();
- print "<" . $this->_namespace . "group size=\"$size\">\n";
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "name>" .
- $this->toParsedXml($test_name) .
- "</" . $this->_namespace . "name>\n";
- }
-
- /**
- * Paints the end of a group test.
- * @param string $test_name Name of test that is ending.
- * @access public
- */
- function paintGroupEnd($test_name) {
- print $this->_getIndent();
- print "</" . $this->_namespace . "group>\n";
- parent::paintGroupEnd($test_name);
- }
-
- /**
- * Paints the start of a test case.
- * @param string $test_name Name of test that is starting.
- * @access public
- */
- function paintCaseStart($test_name) {
- parent::paintCaseStart($test_name);
- print $this->_getIndent();
- print "<" . $this->_namespace . "case>\n";
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "name>" .
- $this->toParsedXml($test_name) .
- "</" . $this->_namespace . "name>\n";
- }
-
- /**
- * Paints the end of a test case.
- * @param string $test_name Name of test that is ending.
- * @access public
- */
- function paintCaseEnd($test_name) {
- print $this->_getIndent();
- print "</" . $this->_namespace . "case>\n";
- parent::paintCaseEnd($test_name);
- }
-
- /**
- * Paints the start of a test method.
- * @param string $test_name Name of test that is starting.
- * @access public
- */
- function paintMethodStart($test_name) {
- parent::paintMethodStart($test_name);
- print $this->_getIndent();
- print "<" . $this->_namespace . "test>\n";
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "name>" .
- $this->toParsedXml($test_name) .
- "</" . $this->_namespace . "name>\n";
- }
-
- /**
- * Paints the end of a test method.
- * @param string $test_name Name of test that is ending.
- * @param integer $progress Number of test cases ending.
- * @access public
- */
- function paintMethodEnd($test_name) {
- print $this->_getIndent();
- print "</" . $this->_namespace . "test>\n";
- parent::paintMethodEnd($test_name);
- }
-
- /**
- * Increments the pass count.
- * @param string $message Message is ignored.
- * @access public
- */
- function paintPass($message) {
- parent::paintPass($message);
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "pass>";
- print $this->toParsedXml($message);
- print "</" . $this->_namespace . "pass>\n";
- }
-
- /**
- * Increments the fail count.
- * @param string $message Message is ignored.
- * @access public
- */
- function paintFail($message) {
- parent::paintFail($message);
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "fail>";
- print $this->toParsedXml($message);
- print "</" . $this->_namespace . "fail>\n";
- }
-
- /**
- * Paints a PHP error or exception.
- * @param string $message Message is ignored.
- * @access public
- * @abstract
- */
- function paintException($message) {
- parent::paintException($message);
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "exception>";
- print $this->toParsedXml($message);
- print "</" . $this->_namespace . "exception>\n";
- }
-
- /**
- * Paints a simple supplementary message.
- * @param string $message Text to display.
- * @access public
- */
- function paintMessage($message) {
- parent::paintMessage($message);
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "message>";
- print $this->toParsedXml($message);
- print "</" . $this->_namespace . "message>\n";
- }
-
- /**
- * Paints a formatted ASCII message such as a
- * variable dump.
- * @param string $message Text to display.
- * @access public
- */
- function paintFormattedMessage($message) {
- parent::paintFormattedMessage($message);
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "formatted>";
- print "<![CDATA[$message]]>";
- print "</" . $this->_namespace . "formatted>\n";
- }
-
- /**
- * Serialises the event object.
- * @param string $type Event type as text.
- * @param mixed $payload Message or object.
- * @access public
- */
- function paintSignal($type, $payload) {
- parent::paintSignal($type, $payload);
- print $this->_getIndent(1);
- print "<" . $this->_namespace . "signal type=\"$type\">";
- print "<![CDATA[" . serialize($payload) . "]]>";
- print "</" . $this->_namespace . "signal>\n";
- }
-
- /**
- * Paints the test document header.
- * @param string $test_name First test top level
- * to start.
- * @access public
- * @abstract
- */
- function paintHeader($test_name) {
- if (! SimpleReporter::inCli()) {
- header('Content-type: text/xml');
- }
- print "<?xml version=\"1.0\"";
- if ($this->_namespace) {
- print " xmlns:" . $this->_namespace .
- "=\"www.lastcraft.com/SimpleTest/Beta3/Report\"";
- }
- print "?>\n";
- print "<" . $this->_namespace . "run>\n";
- }
-
- /**
- * Paints the test document footer.
- * @param string $test_name The top level test.
- * @access public
- * @abstract
- */
- function paintFooter($test_name) {
- print "</" . $this->_namespace . "run>\n";
- }
- }
-
- /**
- * Accumulator for incoming tag. Holds the
- * incoming test structure information for
- * later dispatch to the reporter.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class NestingXmlTag {
- protected $_name;
- protected $_attributes;
-
- /**
- * Sets the basic test information except
- * the name.
- * @param hash $attributes Name value pairs.
- * @access public
- */
- function NestingXmlTag($attributes) {
- $this->_name = false;
- $this->_attributes = $attributes;
- }
-
- /**
- * Sets the test case/method name.
- * @param string $name Name of test.
- * @access public
- */
- function setName($name) {
- $this->_name = $name;
- }
-
- /**
- * Accessor for name.
- * @return string Name of test.
- * @access public
- */
- function getName() {
- return $this->_name;
- }
-
- /**
- * Accessor for attributes.
- * @return hash All attributes.
- * @access protected
- */
- function _getAttributes() {
- return $this->_attributes;
- }
- }
-
- /**
- * Accumulator for incoming method tag. Holds the
- * incoming test structure information for
- * later dispatch to the reporter.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class NestingMethodTag extends NestingXmlTag {
-
- /**
- * Sets the basic test information except
- * the name.
- * @param hash $attributes Name value pairs.
- * @access public
- */
- function NestingMethodTag($attributes) {
- $this->NestingXmlTag($attributes);
- }
-
- /**
- * Signals the appropriate start event on the
- * listener.
- * @param SimpleReporter $listener Target for events.
- * @access public
- */
- function paintStart($listener) {
- $listener->paintMethodStart($this->getName());
- }
-
- /**
- * Signals the appropriate end event on the
- * listener.
- * @param SimpleReporter $listener Target for events.
- * @access public
- */
- function paintEnd($listener) {
- $listener->paintMethodEnd($this->getName());
- }
- }
-
- /**
- * Accumulator for incoming case tag. Holds the
- * incoming test structure information for
- * later dispatch to the reporter.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class NestingCaseTag extends NestingXmlTag {
-
- /**
- * Sets the basic test information except
- * the name.
- * @param hash $attributes Name value pairs.
- * @access public
- */
- function NestingCaseTag($attributes) {
- $this->NestingXmlTag($attributes);
- }
-
- /**
- * Signals the appropriate start event on the
- * listener.
- * @param SimpleReporter $listener Target for events.
- * @access public
- */
- function paintStart($listener) {
- $listener->paintCaseStart($this->getName());
- }
-
- /**
- * Signals the appropriate end event on the
- * listener.
- * @param SimpleReporter $listener Target for events.
- * @access public
- */
- function paintEnd($listener) {
- $listener->paintCaseEnd($this->getName());
- }
- }
-
- /**
- * Accumulator for incoming group tag. Holds the
- * incoming test structure information for
- * later dispatch to the reporter.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class NestingGroupTag extends NestingXmlTag {
-
- /**
- * Sets the basic test information except
- * the name.
- * @param hash $attributes Name value pairs.
- * @access public
- */
- function NestingGroupTag($attributes) {
- $this->NestingXmlTag($attributes);
- }
-
- /**
- * Signals the appropriate start event on the
- * listener.
- * @param SimpleReporter $listener Target for events.
- * @access public
- */
- function paintStart($listener) {
- $listener->paintGroupStart($this->getName(), $this->getSize());
- }
-
- /**
- * Signals the appropriate end event on the
- * listener.
- * @param SimpleReporter $listener Target for events.
- * @access public
- */
- function paintEnd($listener) {
- $listener->paintGroupEnd($this->getName());
- }
-
- /**
- * The size in the attributes.
- * @return integer Value of size attribute or zero.
- * @access public
- */
- function getSize() {
- $attributes = $this->_getAttributes();
- if (isset($attributes['SIZE'])) {
- return (integer)$attributes['SIZE'];
- }
- return 0;
- }
- }
-
- /**
- * Parser for importing the output of the XmlReporter.
- * Dispatches that output to another reporter.
- * @package SimpleTest
- * @subpackage UnitTester
- */
- class SimpleTestXmlParser {
- protected $_listener;
- protected $_expat;
- protected $_tag_stack;
- protected $_in_content_tag;
- protected $_content;
- protected $_attributes;
-
- /**
- * Loads a listener with the SimpleReporter
- * interface.
- * @param SimpleReporter $listener Listener of tag events.
- * @access public
- */
- function SimpleTestXmlParser($listener) {
- $this->_listener = $listener;
- $this->_expat = $this->_createParser();
- $this->_tag_stack = array();
- $this->_in_content_tag = false;
- $this->_content = '';
- $this->_attributes = array();
- }
-
- /**
- * Parses a block of XML sending the results to
- * the listener.
- * @param string $chunk Block of text to read.
- * @return boolean True if valid XML.
- * @access public
- */
- function parse($chunk) {
- if (! xml_parse($this->_expat, $chunk)) {
- trigger_error('XML parse error with ' .
- xml_error_string(xml_get_error_code($this->_expat)));
- return false;
- }
- return true;
- }
-
- /**
- * Sets up expat as the XML parser.
- * @return resource Expat handle.
- * @access protected
- */
- function _createParser() {
- $expat = xml_parser_create();
- xml_set_object($expat, $this);
- xml_set_element_handler($expat, '_startElement', '_endElement');
- xml_set_character_data_handler($expat, '_addContent');
- xml_set_default_handler($expat, '_default');
- return $expat;
- }
-
- /**
- * Opens a new test nesting level.
- * @return NestedXmlTag The group, case or method tag
- * to start.
- * @access private
- */
- function _pushNestingTag($nested) {
- array_unshift($this->_tag_stack, $nested);
- }
-
- /**
- * Accessor for current test structure tag.
- * @return NestedXmlTag The group, case or method tag
- * being parsed.
- * @access private
- */
- function _getCurrentNestingTag() {
- return $this->_tag_stack[0];
- }
-
- /**
- * Ends a nesting tag.
- * @return NestedXmlTag The group, case or method tag
- * just finished.
- * @access private
- */
- function _popNestingTag() {
- return array_shift($this->_tag_stack);
- }
-
- /**
- * Test if tag is a leaf node with only text content.
- * @param string $tag XML tag name.
- * @return @boolean True if leaf, false if nesting.
- * @private
- */
- function _isLeaf($tag) {
- return in_array(
- $tag,
- array('NAME', 'PASS', 'FAIL', 'EXCEPTION', 'MESSAGE', 'FORMATTED', 'SIGNAL'));
- }
-
- /**
- * Handler for start of event element.
- * @param resource $expat Parser handle.
- * @param string $tag Element name.
- * @param hash $attributes Name value pairs.
- * Attributes without content
- * are marked as true.
- * @access protected
- */
- function _startElement($expat, $tag, $attributes) {
- $this->_attributes = $attributes;
- if ($tag == 'GROUP') {
- $this->_pushNestingTag(new NestingGroupTag($attributes));
- } elseif ($tag == 'CASE') {
- $this->_pushNestingTag(new NestingCaseTag($attributes));
- } elseif ($tag == 'TEST') {
- $this->_pushNestingTag(new NestingMethodTag($attributes));
- } elseif ($this->_isLeaf($tag)) {
- $this->_in_content_tag = true;
- $this->_content = '';
- }
- }
-
- /**
- * End of element event.
- * @param resource $expat Parser handle.
- * @param string $tag Element name.
- * @access protected
- */
- function _endElement($expat, $tag) {
- $this->_in_content_tag = false;
- if (in_array($tag, array('GROUP', 'CASE', 'TEST'))) {
- $nesting_tag = $this->_popNestingTag();
- $nesting_tag->paintEnd($this->_listener);
- } elseif ($tag == 'NAME') {
- $nesting_tag = $this->_getCurrentNestingTag();
- $nesting_tag->setName($this->_content);
- $nesting_tag->paintStart($this->_listener);
- } elseif ($tag == 'PASS') {
- $this->_listener->paintPass($this->_content);
- } elseif ($tag == 'FAIL') {
- $this->_listener->paintFail($this->_content);
- } elseif ($tag == 'EXCEPTION') {
- $this->_listener->paintException($this->_content);
- } elseif ($tag == 'SIGNAL') {
- $this->_listener->paintSignal(
- $this->_attributes['TYPE'],
- unserialize($this->_content));
- } elseif ($tag == 'MESSAGE') {
- $this->_listener->paintMessage($this->_content);
- } elseif ($tag == 'FORMATTED') {
- $this->_listener->paintFormattedMessage($this->_content);
- }
- }
-
- /**
- * Content between start and end elements.
- * @param resource $expat Parser handle.
- * @param string $text Usually output messages.
- * @access protected
- */
- function _addContent($expat, $text) {
- if ($this->_in_content_tag) {
- $this->_content .= $text;
- }
- return true;
- }
-
- /**
- * XML and Doctype handler. Discards all such content.
- * @param resource $expat Parser handle.
- * @param string $default Text of default content.
- * @access protected
- */
- function _default($expat, $default) {
- }
- }
-?>
+<?php + /** + * base include file for SimpleTest + * @package SimpleTest + * @subpackage UnitTester + * @version $Id: xml.php,v 1.20 2004/08/04 22:09:39 lastcraft Exp $ + */ + + /**#@+ + * include other SimpleTest class files + */ + require_once(dirname(__FILE__) . '/scorer.php'); + /**#@-*/ + + /** + * Creates the XML needed for remote communication + * by SimpleTest. + * @package SimpleTest + * @subpackage UnitTester + */ + class XmlReporter extends SimpleReporter { + protected $_indent; + protected $_namespace; + + /** + * Does nothing yet. + * @access public + */ + function XmlReporter($namespace = false, $indent = ' ') { + $this->SimpleReporter(); + $this->_namespace = ($namespace ? $namespace . ':' : ''); + $this->_indent = $indent; + } + + /** + * Calculates the pretty printing indent level + * from the current level of nesting. + * @param integer $offset Extra indenting level. + * @return string Leading space. + * @access protected + */ + function _getIndent($offset = 0) { + return str_repeat( + $this->_indent, + count($this->getTestList()) + $offset); + } + + /** + * Converts character string to parsed XML + * entities string. + * @param string text Unparsed character data. + * @return string Parsed character data. + * @access public + */ + function toParsedXml($text) { + return str_replace( + array('&', '<', '>', '"', '\''), + array('&', '<', '>', '"', '''), + $text); + } + + /** + * Paints the start of a group test. + * @param string $test_name Name of test that is starting. + * @param integer $size Number of test cases starting. + * @access public + */ + function paintGroupStart($test_name, $size) { + parent::paintGroupStart($test_name, $size); + print $this->_getIndent(); + print "<" . $this->_namespace . "group size=\"$size\">\n"; + print $this->_getIndent(1); + print "<" . $this->_namespace . "name>" . + $this->toParsedXml($test_name) . + "</" . $this->_namespace . "name>\n"; + } + + /** + * Paints the end of a group test. + * @param string $test_name Name of test that is ending. + * @access public + */ + function paintGroupEnd($test_name) { + print $this->_getIndent(); + print "</" . $this->_namespace . "group>\n"; + parent::paintGroupEnd($test_name); + } + + /** + * Paints the start of a test case. + * @param string $test_name Name of test that is starting. + * @access public + */ + function paintCaseStart($test_name) { + parent::paintCaseStart($test_name); + print $this->_getIndent(); + print "<" . $this->_namespace . "case>\n"; + print $this->_getIndent(1); + print "<" . $this->_namespace . "name>" . + $this->toParsedXml($test_name) . + "</" . $this->_namespace . "name>\n"; + } + + /** + * Paints the end of a test case. + * @param string $test_name Name of test that is ending. + * @access public + */ + function paintCaseEnd($test_name) { + print $this->_getIndent(); + print "</" . $this->_namespace . "case>\n"; + parent::paintCaseEnd($test_name); + } + + /** + * Paints the start of a test method. + * @param string $test_name Name of test that is starting. + * @access public + */ + function paintMethodStart($test_name) { + parent::paintMethodStart($test_name); + print $this->_getIndent(); + print "<" . $this->_namespace . "test>\n"; + print $this->_getIndent(1); + print "<" . $this->_namespace . "name>" . + $this->toParsedXml($test_name) . + "</" . $this->_namespace . "name>\n"; + } + + /** + * Paints the end of a test method. + * @param string $test_name Name of test that is ending. + * @param integer $progress Number of test cases ending. + * @access public + */ + function paintMethodEnd($test_name) { + print $this->_getIndent(); + print "</" . $this->_namespace . "test>\n"; + parent::paintMethodEnd($test_name); + } + + /** + * Increments the pass count. + * @param string $message Message is ignored. + * @access public + */ + function paintPass($message) { + parent::paintPass($message); + print $this->_getIndent(1); + print "<" . $this->_namespace . "pass>"; + print $this->toParsedXml($message); + print "</" . $this->_namespace . "pass>\n"; + } + + /** + * Increments the fail count. + * @param string $message Message is ignored. + * @access public + */ + function paintFail($message) { + parent::paintFail($message); + print $this->_getIndent(1); + print "<" . $this->_namespace . "fail>"; + print $this->toParsedXml($message); + print "</" . $this->_namespace . "fail>\n"; + } + + /** + * Paints a PHP error or exception. + * @param string $message Message is ignored. + * @access public + * @abstract + */ + function paintException($message) { + parent::paintException($message); + print $this->_getIndent(1); + print "<" . $this->_namespace . "exception>"; + print $this->toParsedXml($message); + print "</" . $this->_namespace . "exception>\n"; + } + + /** + * Paints a simple supplementary message. + * @param string $message Text to display. + * @access public + */ + function paintMessage($message) { + parent::paintMessage($message); + print $this->_getIndent(1); + print "<" . $this->_namespace . "message>"; + print $this->toParsedXml($message); + print "</" . $this->_namespace . "message>\n"; + } + + /** + * Paints a formatted ASCII message such as a + * variable dump. + * @param string $message Text to display. + * @access public + */ + function paintFormattedMessage($message) { + parent::paintFormattedMessage($message); + print $this->_getIndent(1); + print "<" . $this->_namespace . "formatted>"; + print "<![CDATA[$message]]>"; + print "</" . $this->_namespace . "formatted>\n"; + } + + /** + * Serialises the event object. + * @param string $type Event type as text. + * @param mixed $payload Message or object. + * @access public + */ + function paintSignal($type, $payload) { + parent::paintSignal($type, $payload); + print $this->_getIndent(1); + print "<" . $this->_namespace . "signal type=\"$type\">"; + print "<![CDATA[" . serialize($payload) . "]]>"; + print "</" . $this->_namespace . "signal>\n"; + } + + /** + * Paints the test document header. + * @param string $test_name First test top level + * to start. + * @access public + * @abstract + */ + function paintHeader($test_name) { + if (! SimpleReporter::inCli()) { + header('Content-type: text/xml'); + } + print "<?xml version=\"1.0\""; + if ($this->_namespace) { + print " xmlns:" . $this->_namespace . + "=\"www.lastcraft.com/SimpleTest/Beta3/Report\""; + } + print "?>\n"; + print "<" . $this->_namespace . "run>\n"; + } + + /** + * Paints the test document footer. + * @param string $test_name The top level test. + * @access public + * @abstract + */ + function paintFooter($test_name) { + print "</" . $this->_namespace . "run>\n"; + } + } + + /** + * Accumulator for incoming tag. Holds the + * incoming test structure information for + * later dispatch to the reporter. + * @package SimpleTest + * @subpackage UnitTester + */ + class NestingXmlTag { + protected $_name; + protected $_attributes; + + /** + * Sets the basic test information except + * the name. + * @param hash $attributes Name value pairs. + * @access public + */ + function NestingXmlTag($attributes) { + $this->_name = false; + $this->_attributes = $attributes; + } + + /** + * Sets the test case/method name. + * @param string $name Name of test. + * @access public + */ + function setName($name) { + $this->_name = $name; + } + + /** + * Accessor for name. + * @return string Name of test. + * @access public + */ + function getName() { + return $this->_name; + } + + /** + * Accessor for attributes. + * @return hash All attributes. + * @access protected + */ + function _getAttributes() { + return $this->_attributes; + } + } + + /** + * Accumulator for incoming method tag. Holds the + * incoming test structure information for + * later dispatch to the reporter. + * @package SimpleTest + * @subpackage UnitTester + */ + class NestingMethodTag extends NestingXmlTag { + + /** + * Sets the basic test information except + * the name. + * @param hash $attributes Name value pairs. + * @access public + */ + function NestingMethodTag($attributes) { + $this->NestingXmlTag($attributes); + } + + /** + * Signals the appropriate start event on the + * listener. + * @param SimpleReporter $listener Target for events. + * @access public + */ + function paintStart($listener) { + $listener->paintMethodStart($this->getName()); + } + + /** + * Signals the appropriate end event on the + * listener. + * @param SimpleReporter $listener Target for events. + * @access public + */ + function paintEnd($listener) { + $listener->paintMethodEnd($this->getName()); + } + } + + /** + * Accumulator for incoming case tag. Holds the + * incoming test structure information for + * later dispatch to the reporter. + * @package SimpleTest + * @subpackage UnitTester + */ + class NestingCaseTag extends NestingXmlTag { + + /** + * Sets the basic test information except + * the name. + * @param hash $attributes Name value pairs. + * @access public + */ + function NestingCaseTag($attributes) { + $this->NestingXmlTag($attributes); + } + + /** + * Signals the appropriate start event on the + * listener. + * @param SimpleReporter $listener Target for events. + * @access public + */ + function paintStart($listener) { + $listener->paintCaseStart($this->getName()); + } + + /** + * Signals the appropriate end event on the + * listener. + * @param SimpleReporter $listener Target for events. + * @access public + */ + function paintEnd($listener) { + $listener->paintCaseEnd($this->getName()); + } + } + + /** + * Accumulator for incoming group tag. Holds the + * incoming test structure information for + * later dispatch to the reporter. + * @package SimpleTest + * @subpackage UnitTester + */ + class NestingGroupTag extends NestingXmlTag { + + /** + * Sets the basic test information except + * the name. + * @param hash $attributes Name value pairs. + * @access public + */ + function NestingGroupTag($attributes) { + $this->NestingXmlTag($attributes); + } + + /** + * Signals the appropriate start event on the + * listener. + * @param SimpleReporter $listener Target for events. + * @access public + */ + function paintStart($listener) { + $listener->paintGroupStart($this->getName(), $this->getSize()); + } + + /** + * Signals the appropriate end event on the + * listener. + * @param SimpleReporter $listener Target for events. + * @access public + */ + function paintEnd($listener) { + $listener->paintGroupEnd($this->getName()); + } + + /** + * The size in the attributes. + * @return integer Value of size attribute or zero. + * @access public + */ + function getSize() { + $attributes = $this->_getAttributes(); + if (isset($attributes['SIZE'])) { + return (integer)$attributes['SIZE']; + } + return 0; + } + } + + /** + * Parser for importing the output of the XmlReporter. + * Dispatches that output to another reporter. + * @package SimpleTest + * @subpackage UnitTester + */ + class SimpleTestXmlParser { + protected $_listener; + protected $_expat; + protected $_tag_stack; + protected $_in_content_tag; + protected $_content; + protected $_attributes; + + /** + * Loads a listener with the SimpleReporter + * interface. + * @param SimpleReporter $listener Listener of tag events. + * @access public + */ + function SimpleTestXmlParser($listener) { + $this->_listener = $listener; + $this->_expat = $this->_createParser(); + $this->_tag_stack = array(); + $this->_in_content_tag = false; + $this->_content = ''; + $this->_attributes = array(); + } + + /** + * Parses a block of XML sending the results to + * the listener. + * @param string $chunk Block of text to read. + * @return boolean True if valid XML. + * @access public + */ + function parse($chunk) { + if (! xml_parse($this->_expat, $chunk)) { + trigger_error('XML parse error with ' . + xml_error_string(xml_get_error_code($this->_expat))); + return false; + } + return true; + } + + /** + * Sets up expat as the XML parser. + * @return resource Expat handle. + * @access protected + */ + function _createParser() { + $expat = xml_parser_create(); + xml_set_object($expat, $this); + xml_set_element_handler($expat, '_startElement', '_endElement'); + xml_set_character_data_handler($expat, '_addContent'); + xml_set_default_handler($expat, '_default'); + return $expat; + } + + /** + * Opens a new test nesting level. + * @return NestedXmlTag The group, case or method tag + * to start. + * @access private + */ + function _pushNestingTag($nested) { + array_unshift($this->_tag_stack, $nested); + } + + /** + * Accessor for current test structure tag. + * @return NestedXmlTag The group, case or method tag + * being parsed. + * @access private + */ + function _getCurrentNestingTag() { + return $this->_tag_stack[0]; + } + + /** + * Ends a nesting tag. + * @return NestedXmlTag The group, case or method tag + * just finished. + * @access private + */ + function _popNestingTag() { + return array_shift($this->_tag_stack); + } + + /** + * Test if tag is a leaf node with only text content. + * @param string $tag XML tag name. + * @return @boolean True if leaf, false if nesting. + * @private + */ + function _isLeaf($tag) { + return in_array( + $tag, + array('NAME', 'PASS', 'FAIL', 'EXCEPTION', 'MESSAGE', 'FORMATTED', 'SIGNAL')); + } + + /** + * Handler for start of event element. + * @param resource $expat Parser handle. + * @param string $tag Element name. + * @param hash $attributes Name value pairs. + * Attributes without content + * are marked as true. + * @access protected + */ + function _startElement($expat, $tag, $attributes) { + $this->_attributes = $attributes; + if ($tag == 'GROUP') { + $this->_pushNestingTag(new NestingGroupTag($attributes)); + } elseif ($tag == 'CASE') { + $this->_pushNestingTag(new NestingCaseTag($attributes)); + } elseif ($tag == 'TEST') { + $this->_pushNestingTag(new NestingMethodTag($attributes)); + } elseif ($this->_isLeaf($tag)) { + $this->_in_content_tag = true; + $this->_content = ''; + } + } + + /** + * End of element event. + * @param resource $expat Parser handle. + * @param string $tag Element name. + * @access protected + */ + function _endElement($expat, $tag) { + $this->_in_content_tag = false; + if (in_array($tag, array('GROUP', 'CASE', 'TEST'))) { + $nesting_tag = $this->_popNestingTag(); + $nesting_tag->paintEnd($this->_listener); + } elseif ($tag == 'NAME') { + $nesting_tag = $this->_getCurrentNestingTag(); + $nesting_tag->setName($this->_content); + $nesting_tag->paintStart($this->_listener); + } elseif ($tag == 'PASS') { + $this->_listener->paintPass($this->_content); + } elseif ($tag == 'FAIL') { + $this->_listener->paintFail($this->_content); + } elseif ($tag == 'EXCEPTION') { + $this->_listener->paintException($this->_content); + } elseif ($tag == 'SIGNAL') { + $this->_listener->paintSignal( + $this->_attributes['TYPE'], + unserialize($this->_content)); + } elseif ($tag == 'MESSAGE') { + $this->_listener->paintMessage($this->_content); + } elseif ($tag == 'FORMATTED') { + $this->_listener->paintFormattedMessage($this->_content); + } + } + + /** + * Content between start and end elements. + * @param resource $expat Parser handle. + * @param string $text Usually output messages. + * @access protected + */ + function _addContent($expat, $text) { + if ($this->_in_content_tag) { + $this->_content .= $text; + } + return true; + } + + /** + * XML and Doctype handler. Discards all such content. + * @param resource $expat Parser handle. + * @param string $default Text of default content. + * @access protected + */ + function _default($expat, $default) { + } + } +?> diff --git a/tests/test_tools/unit_tests.php b/tests/test_tools/unit_tests.php new file mode 100644 index 00000000..732c6826 --- /dev/null +++ b/tests/test_tools/unit_tests.php @@ -0,0 +1,134 @@ +<?php + +if(!defined('PRADO_FRAMEWORK')) + define('PRADO_FRAMEWORK',realpath(dirname(__FILE__).'/../../framework')); + +$TEST_TOOLS = dirname(__FILE__); + +require_once($TEST_TOOLS.'/simpletest/unit_tester.php'); +require_once($TEST_TOOLS.'/simpletest/web_tester.php'); +require_once($TEST_TOOLS.'/simpletest/mock_objects.php'); +require_once($TEST_TOOLS.'/simpletest/reporter.php'); + +require_once(PRADO_FRAMEWORK.'/prado.php'); + +class TMockApplication extends TApplication +{ + public function run() + { + $this->initApplication(); + } +} + +class TestFolder +{ + public $name=''; + public $url=''; + public $subFolders=array(); + public $testFiles=array(); + + public function __construct($path,$rootPath,$rootUri) + { + $script = basename($_SERVER['SCRIPT_NAME']); + $this->url="$rootUri/$script?target=".strtr(substr($path,strlen($rootPath)+1),"\\",'/'); + $this->name=basename($path); + $dir=opendir($path); + while(($entry=readdir($dir))!==false) + { + $fullpath="$path/$entry"; + if($entry!=='.' && $entry!=='..' && $entry!=='.svn' && is_dir($fullpath)) + { + $folder=new TestFolder($fullpath,$rootPath,$rootUri); + if(!empty($folder->subFolders) || !empty($folder->testFiles)) + $this->subFolders[]=$folder; + } + else if(is_file($fullpath) && (strncmp($entry,'ut',2)===0 + || preg_match('/test.*\.php/', strtolower($entry)))) + { + $this->testFiles[$entry]="$rootUri/$script?target=".strtr(substr($fullpath,strlen($rootPath)+1),"\\",'/'); + } + } + closedir($dir); + } + + public function getHtml($level=0) + { + $str=str_repeat(' ',$level*4)."[ <a href=\"{$this->url}\">{$this->name}</a> ]<br/>\n"; + foreach($this->subFolders as $folder) + $str.=$folder->getHtml($level+1); + foreach($this->testFiles as $name=>$url) + $str.=str_repeat(' ',($level+1)*4)."<a href=\"$url\">$name</a><br/>\n"; + return $str; + } +} + +class PradoUnitTester +{ + private $_root; + + function __construct($root, $app_dir) + { + $this->_root = $root; + $app = new TMockApplication($app_dir); + $app->run(); + } + + function addTests($test,$path,$recursive) + { + $dir=opendir($path); + while(($entry=readdir($dir))!==false) + { + if(is_file($path.'/'.$entry) && (strncmp($entry,'ut',2)===0||preg_match('/test.*\.php/', strtolower($entry)))) + $test->addTestFile($path.'/'.$entry); + else if($entry!=='.' && $entry!=='..' && $entry!=='.svn' && is_dir($path.'/'.$entry) && $recursive) + $this->addTests($test,$path.'/'.$entry,$recursive); + } + closedir($dir); + } + + function run($reporter) + { + $rootPath=realpath($this->_root); + $rootUri=dirname($_SERVER['PHP_SELF']); + if(isset($_GET['target'])) + { + $target=$_GET['target']; + $recursive=true; + $fullpath=realpath("$rootPath/$target"); + if($fullpath===false || strpos($fullpath,$rootPath)!==0) + die('invalid test target'); + + if(is_dir($fullpath)) + { + + $test=new GroupTest(basename($rootPath)."/$target"); + $this->addTests($test,$fullpath,$recursive); + $test->run($reporter); + //$test->run(new HtmlReporterWithCoverage('index.php',$rootPath)); + } + else + { + $testClass=basename($fullpath,'.php'); + include_once($fullpath); + $test=new $testClass(basename($rootPath)."/$target"); + $test->run($reporter); + } + } + else + { + echo "<html> + <head> + <title>Prado Unit Tests</title> + <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"> + </head> + <body> + <h1>Prado Unit Tests</h1> + "; + $root=new TestFolder($rootPath,$rootPath,$rootUri); + echo $root->getHtml(); + echo "</body>\n</html>"; + } + } +} + +?>
\ No newline at end of file |
