From 61bb16ee2e5f0a66234e1575242169a10fde47b5 Mon Sep 17 00:00:00 2001 From: xue <> Date: Fri, 7 Jul 2006 14:54:15 +0000 Subject: Merge from 3.0 branch till 1253. --- tests/test_tools/README.txt | 532 +++++ tests/test_tools/functional_tests.php | 66 + tests/test_tools/selenium/core/SeleniumLog.html | 78 + .../selenium/core/TestRunner-splash.html | 52 + .../selenium/core/scripts/find_matching_child.js | 69 + .../test_tools/selenium/core/scripts/htmlutils.js | 463 +++++ .../selenium/core/scripts/prototype-1.4.0.js | 1781 ++++++++++++++++ .../selenium/core/scripts/selenium-api.js | 1402 +++++++++++++ .../selenium/core/scripts/selenium-browserbot.js | 1114 ++++++++++ .../core/scripts/selenium-browserdetect.js | 115 ++ .../core/scripts/selenium-commandhandlers.js | 371 ++++ .../core/scripts/selenium-executionloop.js | 266 +++ .../selenium/core/scripts/selenium-logging.js | 112 + .../core/scripts/selenium-seleneserunner.js | 300 +++ .../selenium/core/scripts/selenium-testrunner.js | 748 +++++++ .../selenium/core/scripts/selenium-version.js | 5 + .../core/scripts/user-extensions.js.sample | 75 + .../test_tools/selenium/core/scripts/xmlextras.js | 153 ++ tests/test_tools/selenium/core/selenium.css | 211 ++ tests/test_tools/selenium/core/xpath/dom.js | 428 ++++ tests/test_tools/selenium/core/xpath/misc.js | 255 +++ tests/test_tools/selenium/core/xpath/xpath.js | 2182 ++++++++++++++++++++ tests/test_tools/selenium/php/TestRunner.php | 169 ++ tests/test_tools/selenium/php/results.php | 160 ++ tests/test_tools/selenium/php/selenium.php | 477 +++++ tests/test_tools/selenium/prado-functional-test.js | 247 +++ tests/test_tools/simpletest/CHANGELOG | 6 + .../simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE | 201 ++ .../simpletest/HtmlReporterWithCoverage.php | 268 +++ tests/test_tools/simpletest/LICENSE | 49 + tests/test_tools/simpletest/README | 110 + tests/test_tools/simpletest/VERSION | 1 + tests/test_tools/simpletest/authentication.php | 219 ++ tests/test_tools/simpletest/browser.php | 1016 +++++++++ .../docs/en/authentication_documentation.html | 320 +++ .../simpletest/docs/en/browser_documentation.html | 386 ++++ tests/test_tools/simpletest/docs/en/docs.css | 84 + .../docs/en/expectation_documentation.html | 356 ++++ .../docs/en/form_testing_documentation.html | 277 +++ .../docs/en/group_test_documentation.html | 357 ++++ tests/test_tools/simpletest/docs/en/index.html | 467 +++++ .../docs/en/mock_objects_documentation.html | 713 +++++++ tests/test_tools/simpletest/docs/en/overview.html | 422 ++++ .../docs/en/partial_mocks_documentation.html | 426 ++++ .../simpletest/docs/en/reporter_documentation.html | 515 +++++ .../docs/en/server_stubs_documentation.html | 388 ++++ .../docs/en/unit_test_documentation.html | 387 ++++ .../docs/en/web_tester_documentation.html | 508 +++++ .../docs/fr/authentication_documentation.html | 264 +++ .../simpletest/docs/fr/browser_documentation.html | 329 +++ tests/test_tools/simpletest/docs/fr/docs.css | 84 + .../docs/fr/expectation_documentation.html | 263 +++ .../docs/fr/form_testing_documentation.html | 235 +++ .../docs/fr/group_test_documentation.html | 288 +++ tests/test_tools/simpletest/docs/fr/index.html | 343 +++ .../docs/fr/mock_objects_documentation.html | 492 +++++ tests/test_tools/simpletest/docs/fr/overview.html | 294 +++ .../docs/fr/partial_mocks_documentation.html | 333 +++ .../simpletest/docs/fr/reporter_documentation.html | 386 ++++ .../docs/fr/server_stubs_documentation.html | 279 +++ .../docs/fr/unit_test_documentation.html | 306 +++ .../docs/fr/web_tester_documentation.html | 397 ++++ tests/test_tools/simpletest/dumper.php | 380 ++++ tests/test_tools/simpletest/encoding.php | 156 ++ tests/test_tools/simpletest/errors.php | 141 ++ tests/test_tools/simpletest/expectation.php | 568 +++++ .../simpletest/extensions/pear_test_case.php | 199 ++ .../simpletest/extensions/phpunit_test_case.php | 108 + tests/test_tools/simpletest/form.php | 619 ++++++ tests/test_tools/simpletest/frames.php | 673 ++++++ tests/test_tools/simpletest/http.php | 853 ++++++++ tests/test_tools/simpletest/mock_objects.php | 1323 ++++++++++++ tests/test_tools/simpletest/options.php | 366 ++++ tests/test_tools/simpletest/page.php | 961 +++++++++ tests/test_tools/simpletest/parser.php | 750 +++++++ tests/test_tools/simpletest/remote.php | 115 ++ tests/test_tools/simpletest/reporter.php | 241 +++ tests/test_tools/simpletest/runner.php | 300 +++ tests/test_tools/simpletest/scorer.php | 378 ++++ tests/test_tools/simpletest/shell_tester.php | 271 +++ tests/test_tools/simpletest/simple_test.php | 553 +++++ tests/test_tools/simpletest/socket.php | 216 ++ tests/test_tools/simpletest/tag.php | 1241 +++++++++++ tests/test_tools/simpletest/unit_tester.php | 303 +++ tests/test_tools/simpletest/url.php | 508 +++++ tests/test_tools/simpletest/user_agent.php | 490 +++++ tests/test_tools/simpletest/web_tester.php | 1330 ++++++++++++ tests/test_tools/simpletest/xml.php | 615 ++++++ tests/test_tools/unit_tests.php | 134 ++ 89 files changed, 37392 insertions(+) create mode 100644 tests/test_tools/README.txt create mode 100644 tests/test_tools/functional_tests.php create mode 100644 tests/test_tools/selenium/core/SeleniumLog.html create mode 100644 tests/test_tools/selenium/core/TestRunner-splash.html create mode 100644 tests/test_tools/selenium/core/scripts/find_matching_child.js create mode 100644 tests/test_tools/selenium/core/scripts/htmlutils.js create mode 100644 tests/test_tools/selenium/core/scripts/prototype-1.4.0.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-api.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-browserbot.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-browserdetect.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-commandhandlers.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-executionloop.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-logging.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-seleneserunner.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-testrunner.js create mode 100644 tests/test_tools/selenium/core/scripts/selenium-version.js create mode 100644 tests/test_tools/selenium/core/scripts/user-extensions.js.sample create mode 100644 tests/test_tools/selenium/core/scripts/xmlextras.js create mode 100644 tests/test_tools/selenium/core/selenium.css create mode 100644 tests/test_tools/selenium/core/xpath/dom.js create mode 100644 tests/test_tools/selenium/core/xpath/misc.js create mode 100644 tests/test_tools/selenium/core/xpath/xpath.js create mode 100644 tests/test_tools/selenium/php/TestRunner.php create mode 100644 tests/test_tools/selenium/php/results.php create mode 100644 tests/test_tools/selenium/php/selenium.php create mode 100644 tests/test_tools/selenium/prado-functional-test.js create mode 100755 tests/test_tools/simpletest/CHANGELOG create mode 100755 tests/test_tools/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE create mode 100644 tests/test_tools/simpletest/HtmlReporterWithCoverage.php create mode 100755 tests/test_tools/simpletest/LICENSE create mode 100755 tests/test_tools/simpletest/README create mode 100755 tests/test_tools/simpletest/VERSION create mode 100644 tests/test_tools/simpletest/authentication.php create mode 100644 tests/test_tools/simpletest/browser.php create mode 100755 tests/test_tools/simpletest/docs/en/authentication_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/browser_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/docs.css create mode 100755 tests/test_tools/simpletest/docs/en/expectation_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/form_testing_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/group_test_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/index.html create mode 100755 tests/test_tools/simpletest/docs/en/mock_objects_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/overview.html create mode 100755 tests/test_tools/simpletest/docs/en/partial_mocks_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/reporter_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/server_stubs_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/unit_test_documentation.html create mode 100755 tests/test_tools/simpletest/docs/en/web_tester_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/authentication_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/browser_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/docs.css create mode 100755 tests/test_tools/simpletest/docs/fr/expectation_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/form_testing_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/group_test_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/index.html create mode 100755 tests/test_tools/simpletest/docs/fr/mock_objects_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/overview.html create mode 100755 tests/test_tools/simpletest/docs/fr/partial_mocks_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/reporter_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/server_stubs_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/unit_test_documentation.html create mode 100755 tests/test_tools/simpletest/docs/fr/web_tester_documentation.html create mode 100644 tests/test_tools/simpletest/dumper.php create mode 100644 tests/test_tools/simpletest/encoding.php create mode 100644 tests/test_tools/simpletest/errors.php create mode 100644 tests/test_tools/simpletest/expectation.php create mode 100755 tests/test_tools/simpletest/extensions/pear_test_case.php create mode 100755 tests/test_tools/simpletest/extensions/phpunit_test_case.php create mode 100644 tests/test_tools/simpletest/form.php create mode 100644 tests/test_tools/simpletest/frames.php create mode 100644 tests/test_tools/simpletest/http.php create mode 100644 tests/test_tools/simpletest/mock_objects.php create mode 100644 tests/test_tools/simpletest/options.php create mode 100644 tests/test_tools/simpletest/page.php create mode 100644 tests/test_tools/simpletest/parser.php create mode 100644 tests/test_tools/simpletest/remote.php create mode 100644 tests/test_tools/simpletest/reporter.php create mode 100644 tests/test_tools/simpletest/runner.php create mode 100644 tests/test_tools/simpletest/scorer.php create mode 100644 tests/test_tools/simpletest/shell_tester.php create mode 100644 tests/test_tools/simpletest/simple_test.php create mode 100644 tests/test_tools/simpletest/socket.php create mode 100644 tests/test_tools/simpletest/tag.php create mode 100644 tests/test_tools/simpletest/unit_tester.php create mode 100644 tests/test_tools/simpletest/url.php create mode 100644 tests/test_tools/simpletest/user_agent.php create mode 100644 tests/test_tools/simpletest/web_tester.php create mode 100644 tests/test_tools/simpletest/xml.php create mode 100644 tests/test_tools/unit_tests.php (limited to 'tests/test_tools') diff --git a/tests/test_tools/README.txt b/tests/test_tools/README.txt new file mode 100644 index 00000000..cfa02abe --- /dev/null +++ b/tests/test_tools/README.txt @@ -0,0 +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 + + +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 + } +} +?> + + +=== 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 + +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!"]'); + } +} +?> + + +File: MyButtonExample.tpl + + +

My Button Example

+ +
+
+ +== 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 + + $this->[command]([target], [value]); + +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/test_tools/functional_tests.php b/tests/test_tools/functional_tests.php new file mode 100644 index 00000000..73bd6226 --- /dev/null +++ b/tests/test_tools/functional_tests.php @@ -0,0 +1,66 @@ +_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/test_tools/selenium/core/SeleniumLog.html b/tests/test_tools/selenium/core/SeleniumLog.html new file mode 100644 index 00000000..dfa0080a --- /dev/null +++ b/tests/test_tools/selenium/core/SeleniumLog.html @@ -0,0 +1,78 @@ + + + +Selenium Log Console + + + + + + + + + + + + diff --git a/tests/test_tools/selenium/core/TestRunner-splash.html b/tests/test_tools/selenium/core/TestRunner-splash.html new file mode 100644 index 00000000..205bb8ef --- /dev/null +++ b/tests/test_tools/selenium/core/TestRunner-splash.html @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + +
Test SuiteCurrent TestControl Panel
 
+ +

Selenium

+

by ThoughtWorks and friends

+ +

+For more information on Selenium, visit + +

+    http://selenium.openqa.org
+
+ +
+ + diff --git a/tests/test_tools/selenium/core/scripts/find_matching_child.js b/tests/test_tools/selenium/core/scripts/find_matching_child.js new file mode 100644 index 00000000..197d1032 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/find_matching_child.js @@ -0,0 +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= "1.5") + { + var dummyElement = element.cloneNode(true); + renderWhitespaceInTextContent(dummyElement); + text = dummyElement.textContent; + } else if (browserVersion.isOpera) { + var dummyElement = element.cloneNode(true); + renderWhitespaceInTextContent(dummyElement); + text = dummyElement.innerText; + text = xmlDecode(text); + } + else if(element.textContent) + { + text = element.textContent; + } + else if(element.innerText) + { + text = element.innerText; + } + + text = normalizeNewlines(text); + text = normalizeSpaces(text); + + return text.trim(); +} + +function renderWhitespaceInTextContent(element) { + // Remove non-visible newlines in text nodes + if (element.nodeType == Node.TEXT_NODE) + { + element.data = element.data.replace(/\n|\r|\t/g, " "); + return; + } + + if (element.nodeType == Node.COMMENT_NODE) + { + element.data = ""; + return; + } + + // Don't modify PRE elements + if (element.tagName == "PRE") + { + return; + } + + // Handle inline element that force newlines + if (tagIs(element, ["BR", "HR"])) + { + // Replace this element with a newline text element + element.parentNode.replaceChild(element.ownerDocument.createTextNode("\n"), element) + } + + for (var i = 0; i < element.childNodes.length; i++) + { + var child = element.childNodes.item(i) + renderWhitespaceInTextContent(child); + } + + // Handle block elements that introduce newlines +// -- From HTML spec: +// + if (tagIs(element, ["P", "DIV"])) + { + element.appendChild(element.ownerDocument.createTextNode("\n"), element) + } + +} + +function tagIs(element, tags) +{ + var tag = element.tagName; + for (var i = 0; i < tags.length; i++) + { + if (tags[i] == tag) + { + return true; + } + } + return false; +} + +/** + * Convert all newlines to \m + */ +function normalizeNewlines(text) +{ + return text.replace(/\r\n|\r/g, "\n"); +} + +/** + * Replace multiple sequential spaces with a single space, and then convert   to space. + */ +function normalizeSpaces(text) +{ + // IE has already done this conversion, so doing it again will remove multiple nbsp + if (browserVersion.isIE) + { + return text; + } + + // Replace multiple spaces with a single space + // TODO - this shouldn't occur inside PRE elements + text = text.replace(/\ +/g, " "); + + // Replace   with a space + var pat = String.fromCharCode(160); // Opera doesn't like /\240/g + var re = new RegExp(pat, "g"); + return text.replace(re, " "); +} + +function xmlDecode(text) { + text = text.replace(/"/g, '"'); + text = text.replace(/'/g, "'"); + text = text.replace(/</g, "<"); + text = text.replace(/>/g, ">"); + text = text.replace(/&/g, "&"); + return text; +} + +// Sets the text in this element +function setText(element, text) { + if(element.textContent) { + element.textContent = text; + } else if(element.innerText) { + element.innerText = text; + } +} + +// Get the value of an element +function getInputValue(inputElement) { + if (inputElement.type.toUpperCase() == 'CHECKBOX' || + inputElement.type.toUpperCase() == 'RADIO') + { + return (inputElement.checked ? 'on' : 'off'); + } + return inputElement.value; +} + +/* Fire an event in a browser-compatible manner */ +function triggerEvent(element, eventType, canBubble) { + canBubble = (typeof(canBubble) == undefined) ? true : canBubble; + if (element.fireEvent) { + element.fireEvent('on' + eventType); + } + else { + var evt = document.createEvent('HTMLEvents'); + evt.initEvent(eventType, canBubble, true); + element.dispatchEvent(evt); + } +} + +function triggerKeyEvent(element, eventType, keycode, canBubble) { + canBubble = (typeof(canBubble) == undefined) ? true : canBubble; + if (element.fireEvent) { + keyEvent = parent.frames['myiframe'].document.createEventObject(); + keyEvent.keyCode=keycode; + element.fireEvent('on' + eventType, keyEvent); + } + else { + var evt; + if( window.KeyEvent ) { + evt = document.createEvent('KeyEvents'); + evt.initKeyEvent(eventType, true, true, window, false, false, false, false, keycode, keycode); + } else { + evt = document.createEvent('UIEvents'); + evt.initUIEvent( eventType, true, true, window, 1 ); + evt.keyCode = keycode; + } + + element.dispatchEvent(evt); + } +} + +/* Fire a mouse event in a browser-compatible manner */ +function triggerMouseEvent(element, eventType, canBubble) { + canBubble = (typeof(canBubble) == undefined) ? true : canBubble; + if (element.fireEvent) { + element.fireEvent('on' + eventType); + } + else { + var evt = document.createEvent('MouseEvents'); + if (evt.initMouseEvent) + { + evt.initMouseEvent(eventType, canBubble, true, document.defaultView, 1, 0, 0, 0, 0, false, false, false, false, 0, null) + } + else + { + // Safari + // TODO we should be initialising other mouse-event related attributes here + evt.initEvent(eventType, canBubble, true); + } + element.dispatchEvent(evt); + } +} + +function removeLoadListener(element, command) { + if (window.removeEventListener) + element.removeEventListener("load", command, true); + else if (window.detachEvent) + element.detachEvent("onload", command); +} + +function addLoadListener(element, command) { + if (window.addEventListener && !browserVersion.isOpera) + element.addEventListener("load",command, true); + else if (window.attachEvent) + element.attachEvent("onload",command); +} + +function addUnloadListener(element, command) { + if (window.addEventListener) + element.addEventListener("unload",command, true); + else if (window.attachEvent) + element.attachEvent("onunload",command); +} + +/** + * Override the broken getFunctionName() method from JsUnit + * This file must be loaded _after_ the jsunitCore.js + */ +function getFunctionName(aFunction) { + var regexpResult = aFunction.toString().match(/function (\w*)/); + if (regexpResult && regexpResult[1]) { + return regexpResult[1]; + } + return 'anonymous'; +} + +function getDocumentBase(doc) { + var bases = document.getElementsByTagName("base"); + if (bases && bases.length && bases[0].href) { + return bases[0].href; + } + return ""; +} + +function describe(object, delimiter) { + var props = new Array(); + for (var prop in object) { + props.push(prop + " -> " + object[prop]); + } + return props.join(delimiter || '\n'); +} + +var PatternMatcher = function(pattern) { + this.selectStrategy(pattern); +}; +PatternMatcher.prototype = { + + selectStrategy: function(pattern) { + this.pattern = pattern; + var strategyName = 'glob'; // by default + if (/^([a-z-]+):(.*)/.test(pattern)) { + strategyName = RegExp.$1; + pattern = RegExp.$2; + } + var matchStrategy = PatternMatcher.strategies[strategyName]; + if (!matchStrategy) { + throw new SeleniumError("cannot find PatternMatcher.strategies." + strategyName); + } + this.strategy = matchStrategy; + this.matcher = new matchStrategy(pattern); + }, + + matches: function(actual) { + return this.matcher.matches(actual + ''); + // Note: appending an empty string avoids a Konqueror bug + } + +}; + +/** + * A "static" convenience method for easy matching + */ +PatternMatcher.matches = function(pattern, actual) { + return new PatternMatcher(pattern).matches(actual); +}; + +PatternMatcher.strategies = { + + /** + * Exact matching, e.g. "exact:***" + */ + exact: function(expected) { + this.expected = expected; + this.matches = function(actual) { + return actual == this.expected; + }; + }, + + /** + * Match by regular expression, e.g. "regexp:^[0-9]+$" + */ + regexp: function(regexpString) { + this.regexp = new RegExp(regexpString); + this.matches = function(actual) { + return this.regexp.test(actual); + }; + }, + + /** + * "globContains" (aka "wildmat") patterns, e.g. "glob:one,two,*", + * but don't require a perfect match; instead succeed if actual + * contains something that matches globString. + * Making this distinction is motivated by a bug in IE6 which + * leads to the browser hanging if we implement *TextPresent tests + * by just matching against a regular expression beginning and + * ending with ".*". The globcontains strategy allows us to satisfy + * the functional needs of the *TextPresent ops more efficiently + * and so avoid running into this IE6 freeze. + */ + globContains: function(globString) { + this.regexp = new RegExp(PatternMatcher.regexpFromGlobContains(globString)); + this.matches = function(actual) { + return this.regexp.test(actual); + }; + }, + + + /** + * "glob" (aka "wildmat") patterns, e.g. "glob:one,two,*" + */ + glob: function(globString) { + this.regexp = new RegExp(PatternMatcher.regexpFromGlob(globString)); + this.matches = function(actual) { + return this.regexp.test(actual); + }; + } + +}; + +PatternMatcher.convertGlobMetaCharsToRegexpMetaChars = function(glob) { + var re = glob; + re = re.replace(/([.^$+(){}\[\]\\|])/g, "\\$1"); + re = re.replace(/\?/g, "(.|[\r\n])"); + re = re.replace(/\*/g, "(.|[\r\n])*"); + return re; +}; + +PatternMatcher.regexpFromGlobContains = function(globContains) { + return PatternMatcher.convertGlobMetaCharsToRegexpMetaChars(globContains); +}; + +PatternMatcher.regexpFromGlob = function(glob) { + return "^" + PatternMatcher.convertGlobMetaCharsToRegexpMetaChars(glob) + "$"; +}; + +var Assert = { + + fail: function(message) { + throw new AssertionFailedError(message); + }, + + /* + * Assert.equals(comment?, expected, actual) + */ + equals: function() { + var args = new AssertionArguments(arguments); + if (args.expected === args.actual) { + return; + } + Assert.fail(args.comment + + "Expected '" + args.expected + + "' but was '" + args.actual + "'"); + }, + + /* + * Assert.matches(comment?, pattern, actual) + */ + matches: function() { + var args = new AssertionArguments(arguments); + if (PatternMatcher.matches(args.expected, args.actual)) { + return; + } + Assert.fail(args.comment + + "Actual value '" + args.actual + + "' did not match '" + args.expected + "'"); + }, + + /* + * Assert.notMtches(comment?, pattern, actual) + */ + notMatches: function() { + var args = new AssertionArguments(arguments); + if (!PatternMatcher.matches(args.expected, args.actual)) { + return; + } + Assert.fail(args.comment + + "Actual value '" + args.actual + + "' did match '" + args.expected + "'"); + } + +}; + +// Preprocess the arguments to allow for an optional comment. +function AssertionArguments(args) { + if (args.length == 2) { + this.comment = ""; + this.expected = args[0]; + this.actual = args[1]; + } else { + this.comment = args[0] + "; "; + this.expected = args[1]; + this.actual = args[2]; + } +} + + + +function AssertionFailedError(message) { + this.isAssertionFailedError = true; + this.isSeleniumError = true; + this.message = message; + this.failureMessage = message; +} + +function SeleniumError(message) { + var error = new Error(message); + error.isSeleniumError = true; + return error; +}; diff --git a/tests/test_tools/selenium/core/scripts/prototype-1.4.0.js b/tests/test_tools/selenium/core/scripts/prototype-1.4.0.js new file mode 100644 index 00000000..0e85338b --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/prototype-1.4.0.js @@ -0,0 +1,1781 @@ +/* Prototype JavaScript framework, version 1.4.0 + * (c) 2005 Sam Stephenson + * + * Prototype is freely distributable under the terms of an MIT-style license. + * For details, see the Prototype web site: http://prototype.conio.net/ + * +/*--------------------------------------------------------------------------*/ + +var Prototype = { + Version: '1.4.0', + ScriptFragment: '(?:)((\n|\r|.)*?)(?:<\/script>)', + + emptyFunction: function() {}, + K: function(x) {return x} +} + +var Class = { + create: function() { + return function() { + this.initialize.apply(this, arguments); + } + } +} + +var Abstract = new Object(); + +Object.extend = function(destination, source) { + for (property in source) { + destination[property] = source[property]; + } + return destination; +} + +Object.inspect = function(object) { + try { + if (object == undefined) return 'undefined'; + if (object == null) return 'null'; + return object.inspect ? object.inspect() : object.toString(); + } catch (e) { + if (e instanceof RangeError) return '...'; + throw e; + } +} + +Function.prototype.bind = function() { + var __method = this, args = $A(arguments), object = args.shift(); + return function() { + return __method.apply(object, args.concat($A(arguments))); + } +} + +Function.prototype.bindAsEventListener = function(object) { + var __method = this; + return function(event) { + return __method.call(object, event || window.event); + } +} + +Object.extend(Number.prototype, { + toColorPart: function() { + var digits = this.toString(16); + if (this < 16) return '0' + digits; + return digits; + }, + + succ: function() { + return this + 1; + }, + + times: function(iterator) { + $R(0, this, true).each(iterator); + return this; + } +}); + +var Try = { + these: function() { + var returnValue; + + for (var i = 0; i < arguments.length; i++) { + var lambda = arguments[i]; + try { + returnValue = lambda(); + break; + } catch (e) {} + } + + return returnValue; + } +} + +/*--------------------------------------------------------------------------*/ + +var PeriodicalExecuter = Class.create(); +PeriodicalExecuter.prototype = { + initialize: function(callback, frequency) { + this.callback = callback; + this.frequency = frequency; + this.currentlyExecuting = false; + + this.registerCallback(); + }, + + registerCallback: function() { + setInterval(this.onTimerEvent.bind(this), this.frequency * 1000); + }, + + onTimerEvent: function() { + if (!this.currentlyExecuting) { + try { + this.currentlyExecuting = true; + this.callback(); + } finally { + this.currentlyExecuting = false; + } + } + } +} + +/*--------------------------------------------------------------------------*/ + +function $() { + var elements = new Array(); + + for (var i = 0; i < arguments.length; i++) { + var element = arguments[i]; + if (typeof element == 'string') + element = document.getElementById(element); + + if (arguments.length == 1) + return element; + + elements.push(element); + } + + return elements; +} +Object.extend(String.prototype, { + stripTags: function() { + return this.replace(/<\/?[^>]+>/gi, ''); + }, + + stripScripts: function() { + return this.replace(new RegExp(Prototype.ScriptFragment, 'img'), ''); + }, + + extractScripts: function() { + var matchAll = new RegExp(Prototype.ScriptFragment, 'img'); + var matchOne = new RegExp(Prototype.ScriptFragment, 'im'); + return (this.match(matchAll) || []).map(function(scriptTag) { + return (scriptTag.match(matchOne) || ['', ''])[1]; + }); + }, + + evalScripts: function() { + return this.extractScripts().map(eval); + }, + + escapeHTML: function() { + var div = document.createElement('div'); + var text = document.createTextNode(this); + div.appendChild(text); + return div.innerHTML; + }, + + unescapeHTML: function() { + var div = document.createElement('div'); + div.innerHTML = this.stripTags(); + return div.childNodes[0] ? div.childNodes[0].nodeValue : ''; + }, + + toQueryParams: function() { + var pairs = this.match(/^\??(.*)$/)[1].split('&'); + return pairs.inject({}, function(params, pairString) { + var pair = pairString.split('='); + params[pair[0]] = pair[1]; + return params; + }); + }, + + toArray: function() { + return this.split(''); + }, + + camelize: function() { + var oStringList = this.split('-'); + if (oStringList.length == 1) return oStringList[0]; + + var camelizedString = this.indexOf('-') == 0 + ? oStringList[0].charAt(0).toUpperCase() + oStringList[0].substring(1) + : oStringList[0]; + + for (var i = 1, len = oStringList.length; i < len; i++) { + var s = oStringList[i]; + camelizedString += s.charAt(0).toUpperCase() + s.substring(1); + } + + return camelizedString; + }, + + inspect: function() { + return "'" + this.replace('\\', '\\\\').replace("'", '\\\'') + "'"; + } +}); + +String.prototype.parseQuery = String.prototype.toQueryParams; + +var $break = new Object(); +var $continue = new Object(); + +var Enumerable = { + each: function(iterator) { + var index = 0; + try { + this._each(function(value) { + try { + iterator(value, index++); + } catch (e) { + if (e != $continue) throw e; + } + }); + } catch (e) { + if (e != $break) throw e; + } + }, + + all: function(iterator) { + var result = true; + this.each(function(value, index) { + result = result && !!(iterator || Prototype.K)(value, index); + if (!result) throw $break; + }); + return result; + }, + + any: function(iterator) { + var result = true; + this.each(function(value, index) { + if (result = !!(iterator || Prototype.K)(value, index)) + throw $break; + }); + return result; + }, + + collect: function(iterator) { + var results = []; + this.each(function(value, index) { + results.push(iterator(value, index)); + }); + return results; + }, + + detect: function (iterator) { + var result; + this.each(function(value, index) { + if (iterator(value, index)) { + result = value; + throw $break; + } + }); + return result; + }, + + findAll: function(iterator) { + var results = []; + this.each(function(value, index) { + if (iterator(value, index)) + results.push(value); + }); + return results; + }, + + grep: function(pattern, iterator) { + var results = []; + this.each(function(value, index) { + var stringValue = value.toString(); + if (stringValue.match(pattern)) + results.push((iterator || Prototype.K)(value, index)); + }) + return results; + }, + + include: function(object) { + var found = false; + this.each(function(value) { + if (value == object) { + found = true; + throw $break; + } + }); + return found; + }, + + inject: function(memo, iterator) { + this.each(function(value, index) { + memo = iterator(memo, value, index); + }); + return memo; + }, + + invoke: function(method) { + var args = $A(arguments).slice(1); + return this.collect(function(value) { + return value[method].apply(value, args); + }); + }, + + max: function(iterator) { + var result; + this.each(function(value, index) { + value = (iterator || Prototype.K)(value, index); + if (value >= (result || value)) + result = value; + }); + return result; + }, + + min: function(iterator) { + var result; + this.each(function(value, index) { + value = (iterator || Prototype.K)(value, index); + if (value <= (result || value)) + result = value; + }); + return result; + }, + + partition: function(iterator) { + var trues = [], falses = []; + this.each(function(value, index) { + ((iterator || Prototype.K)(value, index) ? + trues : falses).push(value); + }); + return [trues, falses]; + }, + + pluck: function(property) { + var results = []; + this.each(function(value, index) { + results.push(value[property]); + }); + return results; + }, + + reject: function(iterator) { + var results = []; + this.each(function(value, index) { + if (!iterator(value, index)) + results.push(value); + }); + return results; + }, + + sortBy: function(iterator) { + return this.collect(function(value, index) { + return {value: value, criteria: iterator(value, index)}; + }).sort(function(left, right) { + var a = left.criteria, b = right.criteria; + return a < b ? -1 : a > b ? 1 : 0; + }).pluck('value'); + }, + + toArray: function() { + return this.collect(Prototype.K); + }, + + zip: function() { + var iterator = Prototype.K, args = $A(arguments); + if (typeof args.last() == 'function') + iterator = args.pop(); + + var collections = [this].concat(args).map($A); + return this.map(function(value, index) { + iterator(value = collections.pluck(index)); + return value; + }); + }, + + inspect: function() { + return '#'; + } +} + +Object.extend(Enumerable, { + map: Enumerable.collect, + find: Enumerable.detect, + select: Enumerable.findAll, + member: Enumerable.include, + entries: Enumerable.toArray +}); +var $A = Array.from = function(iterable) { + if (!iterable) return []; + if (iterable.toArray) { + return iterable.toArray(); + } else { + var results = []; + for (var i = 0; i < iterable.length; i++) + results.push(iterable[i]); + return results; + } +} + +Object.extend(Array.prototype, Enumerable); + +Array.prototype._reverse = Array.prototype.reverse; + +Object.extend(Array.prototype, { + _each: function(iterator) { + for (var i = 0; i < this.length; i++) + iterator(this[i]); + }, + + clear: function() { + this.length = 0; + return this; + }, + + first: function() { + return this[0]; + }, + + last: function() { + return this[this.length - 1]; + }, + + compact: function() { + return this.select(function(value) { + return value != undefined || value != null; + }); + }, + + flatten: function() { + return this.inject([], function(array, value) { + return array.concat(value.constructor == Array ? + value.flatten() : [value]); + }); + }, + + without: function() { + var values = $A(arguments); + return this.select(function(value) { + return !values.include(value); + }); + }, + + indexOf: function(object) { + for (var i = 0; i < this.length; i++) + if (this[i] == object) return i; + return -1; + }, + + reverse: function(inline) { + return (inline !== false ? this : this.toArray())._reverse(); + }, + + shift: function() { + var result = this[0]; + for (var i = 0; i < this.length - 1; i++) + this[i] = this[i + 1]; + this.length--; + return result; + }, + + inspect: function() { + return '[' + this.map(Object.inspect).join(', ') + ']'; + } +}); +var Hash = { + _each: function(iterator) { + for (key in this) { + var value = this[key]; + if (typeof value == 'function') continue; + + var pair = [key, value]; + pair.key = key; + pair.value = value; + iterator(pair); + } + }, + + keys: function() { + return this.pluck('key'); + }, + + values: function() { + return this.pluck('value'); + }, + + merge: function(hash) { + return $H(hash).inject($H(this), function(mergedHash, pair) { + mergedHash[pair.key] = pair.value; + return mergedHash; + }); + }, + + toQueryString: function() { + return this.map(function(pair) { + return pair.map(encodeURIComponent).join('='); + }).join('&'); + }, + + inspect: function() { + return '#'; + } +} + +function $H(object) { + var hash = Object.extend({}, object || {}); + Object.extend(hash, Enumerable); + Object.extend(hash, Hash); + return hash; +} +ObjectRange = Class.create(); +Object.extend(ObjectRange.prototype, Enumerable); +Object.extend(ObjectRange.prototype, { + initialize: function(start, end, exclusive) { + this.start = start; + this.end = end; + this.exclusive = exclusive; + }, + + _each: function(iterator) { + var value = this.start; + do { + iterator(value); + value = value.succ(); + } while (this.include(value)); + }, + + include: function(value) { + if (value < this.start) + return false; + if (this.exclusive) + return value < this.end; + return value <= this.end; + } +}); + +var $R = function(start, end, exclusive) { + return new ObjectRange(start, end, exclusive); +} + +var Ajax = { + getTransport: function() { + return Try.these( + function() {return new ActiveXObject('Msxml2.XMLHTTP')}, + function() {return new ActiveXObject('Microsoft.XMLHTTP')}, + function() {return new XMLHttpRequest()} + ) || false; + }, + + activeRequestCount: 0 +} + +Ajax.Responders = { + responders: [], + + _each: function(iterator) { + this.responders._each(iterator); + }, + + register: function(responderToAdd) { + if (!this.include(responderToAdd)) + this.responders.push(responderToAdd); + }, + + unregister: function(responderToRemove) { + this.responders = this.responders.without(responderToRemove); + }, + + dispatch: function(callback, request, transport, json) { + this.each(function(responder) { + if (responder[callback] && typeof responder[callback] == 'function') { + try { + responder[callback].apply(responder, [request, transport, json]); + } catch (e) {} + } + }); + } +}; + +Object.extend(Ajax.Responders, Enumerable); + +Ajax.Responders.register({ + onCreate: function() { + Ajax.activeRequestCount++; + }, + + onComplete: function() { + Ajax.activeRequestCount--; + } +}); + +Ajax.Base = function() {}; +Ajax.Base.prototype = { + setOptions: function(options) { + this.options = { + method: 'post', + asynchronous: true, + parameters: '' + } + Object.extend(this.options, options || {}); + }, + + responseIsSuccess: function() { + return this.transport.status == undefined + || this.transport.status == 0 + || (this.transport.status >= 200 && this.transport.status < 300); + }, + + responseIsFailure: function() { + return !this.responseIsSuccess(); + } +} + +Ajax.Request = Class.create(); +Ajax.Request.Events = + ['Uninitialized', 'Loading', 'Loaded', 'Interactive', 'Complete']; + +Ajax.Request.prototype = Object.extend(new Ajax.Base(), { + initialize: function(url, options) { + this.transport = Ajax.getTransport(); + this.setOptions(options); + this.request(url); + }, + + request: function(url) { + var parameters = this.options.parameters || ''; + if (parameters.length > 0) parameters += '&_='; + + try { + this.url = url; + if (this.options.method == 'get' && parameters.length > 0) + this.url += (this.url.match(/\?/) ? '&' : '?') + parameters; + + Ajax.Responders.dispatch('onCreate', this, this.transport); + + this.transport.open(this.options.method, this.url, + this.options.asynchronous); + + if (this.options.asynchronous) { + this.transport.onreadystatechange = this.onStateChange.bind(this); + setTimeout((function() {this.respondToReadyState(1)}).bind(this), 10); + } + + this.setRequestHeaders(); + + var body = this.options.postBody ? this.options.postBody : parameters; + this.transport.send(this.options.method == 'post' ? body : null); + + } catch (e) { + this.dispatchException(e); + } + }, + + setRequestHeaders: function() { + var requestHeaders = + ['X-Requested-With', 'XMLHttpRequest', + 'X-Prototype-Version', Prototype.Version]; + + if (this.options.method == 'post') { + requestHeaders.push('Content-type', + 'application/x-www-form-urlencoded'); + + /* Force "Connection: close" for Mozilla browsers to work around + * a bug where XMLHttpReqeuest sends an incorrect Content-length + * header. See Mozilla Bugzilla #246651. + */ + if (this.transport.overrideMimeType) + requestHeaders.push('Connection', 'close'); + } + + if (this.options.requestHeaders) + requestHeaders.push.apply(requestHeaders, this.options.requestHeaders); + + for (var i = 0; i < requestHeaders.length; i += 2) + this.transport.setRequestHeader(requestHeaders[i], requestHeaders[i+1]); + }, + + onStateChange: function() { + var readyState = this.transport.readyState; + if (readyState != 1) + this.respondToReadyState(this.transport.readyState); + }, + + header: function(name) { + try { + return this.transport.getResponseHeader(name); + } catch (e) {} + }, + + evalJSON: function() { + try { + return eval(this.header('X-JSON')); + } catch (e) {} + }, + + evalResponse: function() { + try { + return eval(this.transport.responseText); + } catch (e) { + this.dispatchException(e); + } + }, + + respondToReadyState: function(readyState) { + var event = Ajax.Request.Events[readyState]; + var transport = this.transport, json = this.evalJSON(); + + if (event == 'Complete') { + try { + (this.options['on' + this.transport.status] + || this.options['on' + (this.responseIsSuccess() ? 'Success' : 'Failure')] + || Prototype.emptyFunction)(transport, json); + } catch (e) { + this.dispatchException(e); + } + + if ((this.header('Content-type') || '').match(/^text\/javascript/i)) + this.evalResponse(); + } + + try { + (this.options['on' + event] || Prototype.emptyFunction)(transport, json); + Ajax.Responders.dispatch('on' + event, this, transport, json); + } catch (e) { + this.dispatchException(e); + } + + /* Avoid memory leak in MSIE: clean up the oncomplete event handler */ + if (event == 'Complete') + this.transport.onreadystatechange = Prototype.emptyFunction; + }, + + dispatchException: function(exception) { + (this.options.onException || Prototype.emptyFunction)(this, exception); + Ajax.Responders.dispatch('onException', this, exception); + } +}); + +Ajax.Updater = Class.create(); + +Object.extend(Object.extend(Ajax.Updater.prototype, Ajax.Request.prototype), { + initialize: function(container, url, options) { + this.containers = { + success: container.success ? $(container.success) : $(container), + failure: container.failure ? $(container.failure) : + (container.success ? null : $(container)) + } + + this.transport = Ajax.getTransport(); + this.setOptions(options); + + var onComplete = this.options.onComplete || Prototype.emptyFunction; + this.options.onComplete = (function(transport, object) { + this.updateContent(); + onComplete(transport, object); + }).bind(this); + + this.request(url); + }, + + updateContent: function() { + var receiver = this.responseIsSuccess() ? + this.containers.success : this.containers.failure; + var response = this.transport.responseText; + + if (!this.options.evalScripts) + response = response.stripScripts(); + + if (receiver) { + if (this.options.insertion) { + new this.options.insertion(receiver, response); + } else { + Element.update(receiver, response); + } + } + + if (this.responseIsSuccess()) { + if (this.onComplete) + setTimeout(this.onComplete.bind(this), 10); + } + } +}); + +Ajax.PeriodicalUpdater = Class.create(); +Ajax.PeriodicalUpdater.prototype = Object.extend(new Ajax.Base(), { + initialize: function(container, url, options) { + this.setOptions(options); + this.onComplete = this.options.onComplete; + + this.frequency = (this.options.frequency || 2); + this.decay = (this.options.decay || 1); + + this.updater = {}; + this.container = container; + this.url = url; + + this.start(); + }, + + start: function() { + this.options.onComplete = this.updateComplete.bind(this); + this.onTimerEvent(); + }, + + stop: function() { + this.updater.onComplete = undefined; + clearTimeout(this.timer); + (this.onComplete || Prototype.emptyFunction).apply(this, arguments); + }, + + updateComplete: function(request) { + if (this.options.decay) { + this.decay = (request.responseText == this.lastText ? + this.decay * this.options.decay : 1); + + this.lastText = request.responseText; + } + this.timer = setTimeout(this.onTimerEvent.bind(this), + this.decay * this.frequency * 1000); + }, + + onTimerEvent: function() { + this.updater = new Ajax.Updater(this.container, this.url, this.options); + } +}); +document.getElementsByClassName = function(className, parentElement) { + var children = ($(parentElement) || document.body).getElementsByTagName('*'); + return $A(children).inject([], function(elements, child) { + if (child.className.match(new RegExp("(^|\\s)" + className + "(\\s|$)"))) + elements.push(child); + return elements; + }); +} + +/*--------------------------------------------------------------------------*/ + +if (!window.Element) { + var Element = new Object(); +} + +Object.extend(Element, { + visible: function(element) { + return $(element).style.display != 'none'; + }, + + toggle: function() { + for (var i = 0; i < arguments.length; i++) { + var element = $(arguments[i]); + Element[Element.visible(element) ? 'hide' : 'show'](element); + } + }, + + hide: function() { + for (var i = 0; i < arguments.length; i++) { + var element = $(arguments[i]); + element.style.display = 'none'; + } + }, + + show: function() { + for (var i = 0; i < arguments.length; i++) { + var element = $(arguments[i]); + element.style.display = ''; + } + }, + + remove: function(element) { + element = $(element); + element.parentNode.removeChild(element); + }, + + update: function(element, html) { + $(element).innerHTML = html.stripScripts(); + setTimeout(function() {html.evalScripts()}, 10); + }, + + getHeight: function(element) { + element = $(element); + return element.offsetHeight; + }, + + classNames: function(element) { + return new Element.ClassNames(element); + }, + + hasClassName: function(element, className) { + if (!(element = $(element))) return; + return Element.classNames(element).include(className); + }, + + addClassName: function(element, className) { + if (!(element = $(element))) return; + return Element.classNames(element).add(className); + }, + + removeClassName: function(element, className) { + if (!(element = $(element))) return; + return Element.classNames(element).remove(className); + }, + + // removes whitespace-only text node children + cleanWhitespace: function(element) { + element = $(element); + for (var i = 0; i < element.childNodes.length; i++) { + var node = element.childNodes[i]; + if (node.nodeType == 3 && !/\S/.test(node.nodeValue)) + Element.remove(node); + } + }, + + empty: function(element) { + return $(element).innerHTML.match(/^\s*$/); + }, + + scrollTo: function(element) { + element = $(element); + var x = element.x ? element.x : element.offsetLeft, + y = element.y ? element.y : element.offsetTop; + window.scrollTo(x, y); + }, + + getStyle: function(element, style) { + element = $(element); + var value = element.style[style.camelize()]; + if (!value) { + if (document.defaultView && document.defaultView.getComputedStyle) { + var css = document.defaultView.getComputedStyle(element, null); + value = css ? css.getPropertyValue(style) : null; + } else if (element.currentStyle) { + value = element.currentStyle[style.camelize()]; + } + } + + if (window.opera && ['left', 'top', 'right', 'bottom'].include(style)) + if (Element.getStyle(element, 'position') == 'static') value = 'auto'; + + return value == 'auto' ? null : value; + }, + + setStyle: function(element, style) { + element = $(element); + for (name in style) + element.style[name.camelize()] = style[name]; + }, + + getDimensions: function(element) { + element = $(element); + if (Element.getStyle(element, 'display') != 'none') + return {width: element.offsetWidth, height: element.offsetHeight}; + + // All *Width and *Height properties give 0 on elements with display none, + // so enable the element temporarily + var els = element.style; + var originalVisibility = els.visibility; + var originalPosition = els.position; + els.visibility = 'hidden'; + els.position = 'absolute'; + els.display = ''; + var originalWidth = element.clientWidth; + var originalHeight = element.clientHeight; + els.display = 'none'; + els.position = originalPosition; + els.visibility = originalVisibility; + return {width: originalWidth, height: originalHeight}; + }, + + makePositioned: function(element) { + element = $(element); + var pos = Element.getStyle(element, 'position'); + if (pos == 'static' || !pos) { + element._madePositioned = true; + element.style.position = 'relative'; + // Opera returns the offset relative to the positioning context, when an + // element is position relative but top and left have not been defined + if (window.opera) { + element.style.top = 0; + element.style.left = 0; + } + } + }, + + undoPositioned: function(element) { + element = $(element); + if (element._madePositioned) { + element._madePositioned = undefined; + element.style.position = + element.style.top = + element.style.left = + element.style.bottom = + element.style.right = ''; + } + }, + + makeClipping: function(element) { + element = $(element); + if (element._overflow) return; + element._overflow = element.style.overflow; + if ((Element.getStyle(element, 'overflow') || 'visible') != 'hidden') + element.style.overflow = 'hidden'; + }, + + undoClipping: function(element) { + element = $(element); + if (element._overflow) return; + element.style.overflow = element._overflow; + element._overflow = undefined; + } +}); + +var Toggle = new Object(); +Toggle.display = Element.toggle; + +/*--------------------------------------------------------------------------*/ + +Abstract.Insertion = function(adjacency) { + this.adjacency = adjacency; +} + +Abstract.Insertion.prototype = { + initialize: function(element, content) { + this.element = $(element); + this.content = content.stripScripts(); + + if (this.adjacency && this.element.insertAdjacentHTML) { + try { + this.element.insertAdjacentHTML(this.adjacency, this.content); + } catch (e) { + if (this.element.tagName.toLowerCase() == 'tbody') { + this.insertContent(this.contentFromAnonymousTable()); + } else { + throw e; + } + } + } else { + this.range = this.element.ownerDocument.createRange(); + if (this.initializeRange) this.initializeRange(); + this.insertContent([this.range.createContextualFragment(this.content)]); + } + + setTimeout(function() {content.evalScripts()}, 10); + }, + + contentFromAnonymousTable: function() { + var div = document.createElement('div'); + div.innerHTML = '' + this.content + '
'; + return $A(div.childNodes[0].childNodes[0].childNodes); + } +} + +var Insertion = new Object(); + +Insertion.Before = Class.create(); +Insertion.Before.prototype = Object.extend(new Abstract.Insertion('beforeBegin'), { + initializeRange: function() { + this.range.setStartBefore(this.element); + }, + + insertContent: function(fragments) { + fragments.each((function(fragment) { + this.element.parentNode.insertBefore(fragment, this.element); + }).bind(this)); + } +}); + +Insertion.Top = Class.create(); +Insertion.Top.prototype = Object.extend(new Abstract.Insertion('afterBegin'), { + initializeRange: function() { + this.range.selectNodeContents(this.element); + this.range.collapse(true); + }, + + insertContent: function(fragments) { + fragments.reverse(false).each((function(fragment) { + this.element.insertBefore(fragment, this.element.firstChild); + }).bind(this)); + } +}); + +Insertion.Bottom = Class.create(); +Insertion.Bottom.prototype = Object.extend(new Abstract.Insertion('beforeEnd'), { + initializeRange: function() { + this.range.selectNodeContents(this.element); + this.range.collapse(this.element); + }, + + insertContent: function(fragments) { + fragments.each((function(fragment) { + this.element.appendChild(fragment); + }).bind(this)); + } +}); + +Insertion.After = Class.create(); +Insertion.After.prototype = Object.extend(new Abstract.Insertion('afterEnd'), { + initializeRange: function() { + this.range.setStartAfter(this.element); + }, + + insertContent: function(fragments) { + fragments.each((function(fragment) { + this.element.parentNode.insertBefore(fragment, + this.element.nextSibling); + }).bind(this)); + } +}); + +/*--------------------------------------------------------------------------*/ + +Element.ClassNames = Class.create(); +Element.ClassNames.prototype = { + initialize: function(element) { + this.element = $(element); + }, + + _each: function(iterator) { + this.element.className.split(/\s+/).select(function(name) { + return name.length > 0; + })._each(iterator); + }, + + set: function(className) { + this.element.className = className; + }, + + add: function(classNameToAdd) { + if (this.include(classNameToAdd)) return; + this.set(this.toArray().concat(classNameToAdd).join(' ')); + }, + + remove: function(classNameToRemove) { + if (!this.include(classNameToRemove)) return; + this.set(this.select(function(className) { + return className != classNameToRemove; + }).join(' ')); + }, + + toString: function() { + return this.toArray().join(' '); + } +} + +Object.extend(Element.ClassNames.prototype, Enumerable); +var Field = { + clear: function() { + for (var i = 0; i < arguments.length; i++) + $(arguments[i]).value = ''; + }, + + focus: function(element) { + $(element).focus(); + }, + + present: function() { + for (var i = 0; i < arguments.length; i++) + if ($(arguments[i]).value == '') return false; + return true; + }, + + select: function(element) { + $(element).select(); + }, + + activate: function(element) { + element = $(element); + element.focus(); + if (element.select) + element.select(); + } +} + +/*--------------------------------------------------------------------------*/ + +var Form = { + serialize: function(form) { + var elements = Form.getElements($(form)); + var queryComponents = new Array(); + + for (var i = 0; i < elements.length; i++) { + var queryComponent = Form.Element.serialize(elements[i]); + if (queryComponent) + queryComponents.push(queryComponent); + } + + return queryComponents.join('&'); + }, + + getElements: function(form) { + form = $(form); + var elements = new Array(); + + for (tagName in Form.Element.Serializers) { + var tagElements = form.getElementsByTagName(tagName); + for (var j = 0; j < tagElements.length; j++) + elements.push(tagElements[j]); + } + return elements; + }, + + getInputs: function(form, typeName, name) { + form = $(form); + var inputs = form.getElementsByTagName('input'); + + if (!typeName && !name) + return inputs; + + var matchingInputs = new Array(); + for (var i = 0; i < inputs.length; i++) { + var input = inputs[i]; + if ((typeName && input.type != typeName) || + (name && input.name != name)) + continue; + matchingInputs.push(input); + } + + return matchingInputs; + }, + + disable: function(form) { + var elements = Form.getElements(form); + for (var i = 0; i < elements.length; i++) { + var element = elements[i]; + element.blur(); + element.disabled = 'true'; + } + }, + + enable: function(form) { + var elements = Form.getElements(form); + for (var i = 0; i < elements.length; i++) { + var element = elements[i]; + element.disabled = ''; + } + }, + + findFirstElement: function(form) { + return Form.getElements(form).find(function(element) { + return element.type != 'hidden' && !element.disabled && + ['input', 'select', 'textarea'].include(element.tagName.toLowerCase()); + }); + }, + + focusFirstElement: function(form) { + Field.activate(Form.findFirstElement(form)); + }, + + reset: function(form) { + $(form).reset(); + } +} + +Form.Element = { + serialize: function(element) { + element = $(element); + var method = element.tagName.toLowerCase(); + var parameter = Form.Element.Serializers[method](element); + + if (parameter) { + var key = encodeURIComponent(parameter[0]); + if (key.length == 0) return; + + if (parameter[1].constructor != Array) + parameter[1] = [parameter[1]]; + + return parameter[1].map(function(value) { + return key + '=' + encodeURIComponent(value); + }).join('&'); + } + }, + + getValue: function(element) { + element = $(element); + var method = element.tagName.toLowerCase(); + var parameter = Form.Element.Serializers[method](element); + + if (parameter) + return parameter[1]; + } +} + +Form.Element.Serializers = { + input: function(element) { + switch (element.type.toLowerCase()) { + case 'submit': + case 'hidden': + case 'password': + case 'text': + return Form.Element.Serializers.textarea(element); + case 'checkbox': + case 'radio': + return Form.Element.Serializers.inputSelector(element); + } + return false; + }, + + inputSelector: function(element) { + if (element.checked) + return [element.name, element.value]; + }, + + textarea: function(element) { + return [element.name, element.value]; + }, + + select: function(element) { + return Form.Element.Serializers[element.type == 'select-one' ? + 'selectOne' : 'selectMany'](element); + }, + + selectOne: function(element) { + var value = '', opt, index = element.selectedIndex; + if (index >= 0) { + opt = element.options[index]; + value = opt.value; + if (!value && !('value' in opt)) + value = opt.text; + } + return [element.name, value]; + }, + + selectMany: function(element) { + var value = new Array(); + for (var i = 0; i < element.length; i++) { + var opt = element.options[i]; + if (opt.selected) { + var optValue = opt.value; + if (!optValue && !('value' in opt)) + optValue = opt.text; + value.push(optValue); + } + } + return [element.name, value]; + } +} + +/*--------------------------------------------------------------------------*/ + +var $F = Form.Element.getValue; + +/*--------------------------------------------------------------------------*/ + +Abstract.TimedObserver = function() {} +Abstract.TimedObserver.prototype = { + initialize: function(element, frequency, callback) { + this.frequency = frequency; + this.element = $(element); + this.callback = callback; + + this.lastValue = this.getValue(); + this.registerCallback(); + }, + + registerCallback: function() { + setInterval(this.onTimerEvent.bind(this), this.frequency * 1000); + }, + + onTimerEvent: function() { + var value = this.getValue(); + if (this.lastValue != value) { + this.callback(this.element, value); + this.lastValue = value; + } + } +} + +Form.Element.Observer = Class.create(); +Form.Element.Observer.prototype = Object.extend(new Abstract.TimedObserver(), { + getValue: function() { + return Form.Element.getValue(this.element); + } +}); + +Form.Observer = Class.create(); +Form.Observer.prototype = Object.extend(new Abstract.TimedObserver(), { + getValue: function() { + return Form.serialize(this.element); + } +}); + +/*--------------------------------------------------------------------------*/ + +Abstract.EventObserver = function() {} +Abstract.EventObserver.prototype = { + initialize: function(element, callback) { + this.element = $(element); + this.callback = callback; + + this.lastValue = this.getValue(); + if (this.element.tagName.toLowerCase() == 'form') + this.registerFormCallbacks(); + else + this.registerCallback(this.element); + }, + + onElementEvent: function() { + var value = this.getValue(); + if (this.lastValue != value) { + this.callback(this.element, value); + this.lastValue = value; + } + }, + + registerFormCallbacks: function() { + var elements = Form.getElements(this.element); + for (var i = 0; i < elements.length; i++) + this.registerCallback(elements[i]); + }, + + registerCallback: function(element) { + if (element.type) { + switch (element.type.toLowerCase()) { + case 'checkbox': + case 'radio': + Event.observe(element, 'click', this.onElementEvent.bind(this)); + break; + case 'password': + case 'text': + case 'textarea': + case 'select-one': + case 'select-multiple': + Event.observe(element, 'change', this.onElementEvent.bind(this)); + break; + } + } + } +} + +Form.Element.EventObserver = Class.create(); +Form.Element.EventObserver.prototype = Object.extend(new Abstract.EventObserver(), { + getValue: function() { + return Form.Element.getValue(this.element); + } +}); + +Form.EventObserver = Class.create(); +Form.EventObserver.prototype = Object.extend(new Abstract.EventObserver(), { + getValue: function() { + return Form.serialize(this.element); + } +}); +if (!window.Event) { + var Event = new Object(); +} + +Object.extend(Event, { + KEY_BACKSPACE: 8, + KEY_TAB: 9, + KEY_RETURN: 13, + KEY_ESC: 27, + KEY_LEFT: 37, + KEY_UP: 38, + KEY_RIGHT: 39, + KEY_DOWN: 40, + KEY_DELETE: 46, + + element: function(event) { + return event.target || event.srcElement; + }, + + isLeftClick: function(event) { + return (((event.which) && (event.which == 1)) || + ((event.button) && (event.button == 1))); + }, + + pointerX: function(event) { + return event.pageX || (event.clientX + + (document.documentElement.scrollLeft || document.body.scrollLeft)); + }, + + pointerY: function(event) { + return event.pageY || (event.clientY + + (document.documentElement.scrollTop || document.body.scrollTop)); + }, + + stop: function(event) { + if (event.preventDefault) { + event.preventDefault(); + event.stopPropagation(); + } else { + event.returnValue = false; + event.cancelBubble = true; + } + }, + + // find the first node with the given tagName, starting from the + // node the event was triggered on; traverses the DOM upwards + findElement: function(event, tagName) { + var element = Event.element(event); + while (element.parentNode && (!element.tagName || + (element.tagName.toUpperCase() != tagName.toUpperCase()))) + element = element.parentNode; + return element; + }, + + observers: false, + + _observeAndCache: function(element, name, observer, useCapture) { + if (!this.observers) this.observers = []; + if (element.addEventListener) { + this.observers.push([element, name, observer, useCapture]); + element.addEventListener(name, observer, useCapture); + } else if (element.attachEvent) { + this.observers.push([element, name, observer, useCapture]); + element.attachEvent('on' + name, observer); + } + }, + + unloadCache: function() { + if (!Event.observers) return; + for (var i = 0; i < Event.observers.length; i++) { + Event.stopObserving.apply(this, Event.observers[i]); + Event.observers[i][0] = null; + } + Event.observers = false; + }, + + observe: function(element, name, observer, useCapture) { + var element = $(element); + useCapture = useCapture || false; + + if (name == 'keypress' && + (navigator.appVersion.match(/Konqueror|Safari|KHTML/) + || element.attachEvent)) + name = 'keydown'; + + this._observeAndCache(element, name, observer, useCapture); + }, + + stopObserving: function(element, name, observer, useCapture) { + var element = $(element); + useCapture = useCapture || false; + + if (name == 'keypress' && + (navigator.appVersion.match(/Konqueror|Safari|KHTML/) + || element.detachEvent)) + name = 'keydown'; + + if (element.removeEventListener) { + element.removeEventListener(name, observer, useCapture); + } else if (element.detachEvent) { + element.detachEvent('on' + name, observer); + } + } +}); + +/* prevent memory leaks in IE */ +Event.observe(window, 'unload', Event.unloadCache, false); +var Position = { + // set to true if needed, warning: firefox performance problems + // NOT neeeded for page scrolling, only if draggable contained in + // scrollable elements + includeScrollOffsets: false, + + // must be called before calling withinIncludingScrolloffset, every time the + // page is scrolled + prepare: function() { + this.deltaX = window.pageXOffset + || document.documentElement.scrollLeft + || document.body.scrollLeft + || 0; + this.deltaY = window.pageYOffset + || document.documentElement.scrollTop + || document.body.scrollTop + || 0; + }, + + realOffset: function(element) { + var valueT = 0, valueL = 0; + do { + valueT += element.scrollTop || 0; + valueL += element.scrollLeft || 0; + element = element.parentNode; + } while (element); + return [valueL, valueT]; + }, + + cumulativeOffset: function(element) { + var valueT = 0, valueL = 0; + do { + valueT += element.offsetTop || 0; + valueL += element.offsetLeft || 0; + element = element.offsetParent; + } while (element); + return [valueL, valueT]; + }, + + positionedOffset: function(element) { + var valueT = 0, valueL = 0; + do { + valueT += element.offsetTop || 0; + valueL += element.offsetLeft || 0; + element = element.offsetParent; + if (element) { + p = Element.getStyle(element, 'position'); + if (p == 'relative' || p == 'absolute') break; + } + } while (element); + return [valueL, valueT]; + }, + + offsetParent: function(element) { + if (element.offsetParent) return element.offsetParent; + if (element == document.body) return element; + + while ((element = element.parentNode) && element != document.body) + if (Element.getStyle(element, 'position') != 'static') + return element; + + return document.body; + }, + + // caches x/y coordinate pair to use with overlap + within: function(element, x, y) { + if (this.includeScrollOffsets) + return this.withinIncludingScrolloffsets(element, x, y); + this.xcomp = x; + this.ycomp = y; + this.offset = this.cumulativeOffset(element); + + return (y >= this.offset[1] && + y < this.offset[1] + element.offsetHeight && + x >= this.offset[0] && + x < this.offset[0] + element.offsetWidth); + }, + + withinIncludingScrolloffsets: function(element, x, y) { + var offsetcache = this.realOffset(element); + + this.xcomp = x + offsetcache[0] - this.deltaX; + this.ycomp = y + offsetcache[1] - this.deltaY; + this.offset = this.cumulativeOffset(element); + + return (this.ycomp >= this.offset[1] && + this.ycomp < this.offset[1] + element.offsetHeight && + this.xcomp >= this.offset[0] && + this.xcomp < this.offset[0] + element.offsetWidth); + }, + + // within must be called directly before + overlap: function(mode, element) { + if (!mode) return 0; + if (mode == 'vertical') + return ((this.offset[1] + element.offsetHeight) - this.ycomp) / + element.offsetHeight; + if (mode == 'horizontal') + return ((this.offset[0] + element.offsetWidth) - this.xcomp) / + element.offsetWidth; + }, + + clone: function(source, target) { + source = $(source); + target = $(target); + target.style.position = 'absolute'; + var offsets = this.cumulativeOffset(source); + target.style.top = offsets[1] + 'px'; + target.style.left = offsets[0] + 'px'; + target.style.width = source.offsetWidth + 'px'; + target.style.height = source.offsetHeight + 'px'; + }, + + page: function(forElement) { + var valueT = 0, valueL = 0; + + var element = forElement; + do { + valueT += element.offsetTop || 0; + valueL += element.offsetLeft || 0; + + // Safari fix + if (element.offsetParent==document.body) + if (Element.getStyle(element,'position')=='absolute') break; + + } while (element = element.offsetParent); + + element = forElement; + do { + valueT -= element.scrollTop || 0; + valueL -= element.scrollLeft || 0; + } while (element = element.parentNode); + + return [valueL, valueT]; + }, + + clone: function(source, target) { + var options = Object.extend({ + setLeft: true, + setTop: true, + setWidth: true, + setHeight: true, + offsetTop: 0, + offsetLeft: 0 + }, arguments[2] || {}) + + // find page position of source + source = $(source); + var p = Position.page(source); + + // find coordinate system to use + target = $(target); + var delta = [0, 0]; + var parent = null; + // delta [0,0] will do fine with position: fixed elements, + // position:absolute needs offsetParent deltas + if (Element.getStyle(target,'position') == 'absolute') { + parent = Position.offsetParent(target); + delta = Position.page(parent); + } + + // correct by body offsets (fixes Safari) + if (parent == document.body) { + delta[0] -= document.body.offsetLeft; + delta[1] -= document.body.offsetTop; + } + + // set position + if(options.setLeft) target.style.left = (p[0] - delta[0] + options.offsetLeft) + 'px'; + if(options.setTop) target.style.top = (p[1] - delta[1] + options.offsetTop) + 'px'; + if(options.setWidth) target.style.width = source.offsetWidth + 'px'; + if(options.setHeight) target.style.height = source.offsetHeight + 'px'; + }, + + absolutize: function(element) { + element = $(element); + if (element.style.position == 'absolute') return; + Position.prepare(); + + var offsets = Position.positionedOffset(element); + var top = offsets[1]; + var left = offsets[0]; + var width = element.clientWidth; + var height = element.clientHeight; + + element._originalLeft = left - parseFloat(element.style.left || 0); + element._originalTop = top - parseFloat(element.style.top || 0); + element._originalWidth = element.style.width; + element._originalHeight = element.style.height; + + element.style.position = 'absolute'; + element.style.top = top + 'px';; + element.style.left = left + 'px';; + element.style.width = width + 'px';; + element.style.height = height + 'px';; + }, + + relativize: function(element) { + element = $(element); + if (element.style.position == 'relative') return; + Position.prepare(); + + element.style.position = 'relative'; + var top = parseFloat(element.style.top || 0) - (element._originalTop || 0); + var left = parseFloat(element.style.left || 0) - (element._originalLeft || 0); + + element.style.top = top + 'px'; + element.style.left = left + 'px'; + element.style.height = element._originalHeight; + element.style.width = element._originalWidth; + } +} + +// Safari returns margins on body which is incorrect if the child is absolutely +// positioned. For performance reasons, redefine Position.cumulativeOffset for +// KHTML/WebKit only. +if (/Konqueror|Safari|KHTML/.test(navigator.userAgent)) { + Position.cumulativeOffset = function(element) { + var valueT = 0, valueL = 0; + do { + valueT += element.offsetTop || 0; + valueL += element.offsetLeft || 0; + if (element.offsetParent == document.body) + if (Element.getStyle(element, 'position') == 'absolute') break; + + element = element.offsetParent; + } while (element); + + return [valueL, valueT]; + } +} \ No newline at end of file diff --git a/tests/test_tools/selenium/core/scripts/selenium-api.js b/tests/test_tools/selenium/core/scripts/selenium-api.js new file mode 100644 index 00000000..ad0509ee --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-api.js @@ -0,0 +1,1402 @@ +/* + * 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. + * + */ + +var storedVars = new Object(); + +function Selenium(browserbot) { + /** + * Defines an object that runs Selenium commands. + * + *

Element Locators

+ *

+ * Element Locators tell Selenium which HTML element a command refers to. + * The format of a locator is:

+ *
+ * locatorType=argument + *
+ * + *

+ * We support the following strategies for locating elements: + *

+ *
+ *
+ *
identifier=id
+ *
Select the element with the specified @id attribute. If no match is + * found, select the first element whose @name attribute is id. + * (This is normally the default; see below.)
+ *
id=id
+ *
Select the element with the specified @id attribute.
+ * + *
name=name
+ *
Select the first element with the specified @name attribute.
+ *
    + *
  • username
  • + *
  • name=username
  • + *
+ *
+ *
The name may optionally be followed by one or more element-filters, separated from the name by whitespace. If the filterType is not specified, value is assumed.
+ * + *
    + *
  • name=flavour value=chocolate
  • + *
+ *
+ *
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=//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 an explicit locator prefix, Selenium uses the following default + * strategies: + *

+ * + *
    + *
  • dom, for locators starting with "document."
  • + *
  • xpath, for locators starting with "//"
  • + *
  • identifier, otherwise
  • + *
+ * + *

Element Filters

+ *
+ *

Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.

+ *

Filters look much like locators, ie.

+ *
+ * filterType=argument
+ * + *

Supported element-filters are:

+ *

value=valuePattern

+ *
+ * Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.
+ *

index=index

+ *
+ * Selects a single element based on its position in the list (offset from zero).
+ *
+ * + *

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. + *

+ */ + this.browserbot = browserbot; + this.optionLocatorFactory = new OptionLocatorFactory(); + this.page = function() { + return browserbot.getCurrentPage(); + }; +} + +Selenium.createForFrame = function(frame) { + return new Selenium(BrowserBot.createForFrame(frame)); +}; + +Selenium.prototype.reset = function() { + /** + * Clear out all stored variables and select the null (starting) window + */ + storedVars = new Object(); + this.browserbot.selectWindow("null"); +}; + +Selenium.prototype.doClick = function(locator) { + /** + * Clicks on a link, button, checkbox or radio button. If the click action + * causes a new page to load (like a link usually does), call + * waitForPageToLoad. + * + * @param locator an element locator + * + */ + var element = this.page().findElement(locator); + this.page().clickElement(element); +}; + +Selenium.prototype.doFireEvent = function(locator, eventName) { + /** + * Explicitly simulate an event, to trigger the corresponding "onevent" + * handler. + * + * @param locator an element locator + * @param eventName the event name, e.g. "focus" or "blur" + */ + var element = this.page().findElement(locator); + triggerEvent(element, eventName, false); +}; + +Selenium.prototype.doKeyPress = function(locator, keycode) { + /** + * Simulates a user pressing and releasing a key. + * + * @param locator an element locator + * @param keycode the numeric keycode of the key to be pressed, normally the + * ASCII value of that key. + */ + var element = this.page().findElement(locator); + triggerKeyEvent(element, 'keypress', keycode, true); +}; + +Selenium.prototype.doKeyDown = function(locator, keycode) { + /** + * Simulates a user pressing a key (without releasing it yet). + * + * @param locator an element locator + * @param keycode the numeric keycode of the key to be pressed, normally the + * ASCII value of that key. + */ + var element = this.page().findElement(locator); + triggerKeyEvent(element, 'keydown', keycode, true); +}; + +Selenium.prototype.doKeyUp = function(locator, keycode) { + /** + * Simulates a user releasing a key. + * + * @param locator an element locator + * @param keycode the numeric keycode of the key to be released, normally the + * ASCII value of that key. + */ + var element = this.page().findElement(locator); + triggerKeyEvent(element, 'keyup', keycode, true); +}; + +Selenium.prototype.doMouseOver = function(locator) { + /** + * Simulates a user hovering a mouse over the specified element. + * + * @param locator an element locator + */ + var element = this.page().findElement(locator); + triggerMouseEvent(element, 'mouseover', true); +}; + +Selenium.prototype.doMouseDown = function(locator) { + /** + * Simulates a user pressing the mouse button (without releasing it yet) on + * the specified element. + * + * @param locator an element locator + */ + var element = this.page().findElement(locator); + triggerMouseEvent(element, 'mousedown', true); +}; + +Selenium.prototype.doType = function(locator, 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.

+ * + * @param locator an element locator + * @param value the value to type + */ + // TODO fail if it can't be typed into. + var element = this.page().findElement(locator); + this.page().replaceText(element, value); +}; + +Selenium.prototype.findToggleButton = function(locator) { + var element = this.page().findElement(locator); + if (element.checked == null) { + Assert.fail("Element " + locator + " is not a toggle-button."); + } + return element; +} + +Selenium.prototype.doCheck = function(locator) { + /** + * Check a toggle-button (checkbox/radio) + * + * @param locator an element locator + */ + this.findToggleButton(locator).checked = true; +}; + +Selenium.prototype.doUncheck = function(locator) { + /** + * Uncheck a toggle-button (checkbox/radio) + * + * @param locator an element locator + */ + this.findToggleButton(locator).checked = false; +}; + +Selenium.prototype.doSelect = function(selectLocator, optionLocator) { + /** + * Select an option from a drop-down using an option locator. + * + *

+ * Option locators 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 Locator. + *

+ *
+ *
label=labelPattern
+ *
matches options based on their labels, i.e. the visible text. (This + * is the default.) + *
    + *
  • 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
  • + *
+ *
+ *
+ *

+ * If no option locator prefix is provided, the default behaviour is to match on label. + *

+ * + * + * @param selectLocator an element locator identifying a drop-down menu + * @param optionLocator an option locator (a label by default) + */ + var element = this.page().findElement(selectLocator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + var option = locator.findOption(element); + this.page().selectOption(element, option); +}; + +Selenium.prototype.doAddSelection = function(locator, optionLocator) { + /** + * Add a selection to the set of selected options in a multi-select element using an option locator. + * + * @see #doSelect for details of option locators + * + * @param locator an element locator identifying a multi-select box + * @param optionLocator an option locator (a label by default) + */ + var element = this.page().findElement(locator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + var option = locator.findOption(element); + this.page().addSelection(element, option); +}; + +Selenium.prototype.doRemoveSelection = function(locator, optionLocator) { + /** + * Remove a selection from the set of selected options in a multi-select element using an option locator. + * + * @see #doSelect for details of option locators + * + * @param locator an element locator identifying a multi-select box + * @param optionLocator an option locator (a label by default) + */ + + var element = this.page().findElement(locator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + var option = locator.findOption(element); + this.page().removeSelection(element, option); +}; + +Selenium.prototype.doSubmit = function(formLocator) { + /** + * Submit the specified form. This is particularly useful for forms without + * submit buttons, e.g. single-input "Search" forms. + * + * @param formLocator an element locator for the form you want to submit + */ + var form = this.page().findElement(formLocator); + var actuallySubmit = true; + if (form.onsubmit) { + // apply this to the correct window so alerts are properly handled, even in IE HTA mode + actuallySubmit = form.onsubmit.apply(this.browserbot.getContentWindow()); + } + if (actuallySubmit) { + form.submit(); + } + +}; + +Selenium.prototype.doOpen = function(url) { + /** + * Opens an URL in the test frame. This accepts both relative and absolute + * URLs. + * + * The "open" command waits for the page to load before proceeding, + * ie. the "AndWait" suffix is implicit. + * + * Note: The URL must be on the same domain as the runner HTML + * due to security restrictions in the browser (Same Origin Policy). If you + * need to open an URL on another domain, use the Selenium Server to start a + * new browser session on that domain. + * + * @param url the URL to open; may be relative or absolute + */ + this.browserbot.openLocation(url); + return SELENIUM_PROCESS_WAIT; +}; + +Selenium.prototype.doSelectWindow = function(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. + * + * @param windowID the JavaScript window ID of the window to select + */ + this.browserbot.selectWindow(windowID); +}; + +Selenium.prototype.doWaitForPopUp = function(windowID, timeout) { + /** + * Waits for a popup window to appear and load up. + * + * @param windowID the JavaScript window ID of the window that will appear + * @param timeout a timeout in milliseconds, after which the action will return with an error + */ + if (isNaN(timeout)) { + throw new SeleniumError("Timeout is not a number: " + timeout); + } + + testLoop.waitForCondition = function () { + var targetWindow = selenium.browserbot.getTargetWindow(windowID); + if (!targetWindow) return false; + if (!targetWindow.location) return false; + if ("about:blank" == targetWindow.location) return false; + if (!targetWindow.document) return false; + if (!targetWindow.document.readyState) return true; + if ('complete' != targetWindow.document.readyState) return false; + return true; + }; + + testLoop.waitForConditionStart = new Date().getTime(); + testLoop.waitForConditionTimeout = timeout; + +} + +Selenium.prototype.doWaitForPopUp.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.doChooseCancelOnNextConfirmation = function() { + /** + * By default, Selenium's overridden window.confirm() function will + * return true, as if the user had manually clicked OK. After running + * this command, the next call to confirm() will return false, as if + * the user had clicked Cancel. + * + */ + this.browserbot.cancelNextConfirmation(); +}; + + +Selenium.prototype.doAnswerOnNextPrompt = function(answer) { + /** + * Instructs Selenium to return the specified answer string in response to + * the next JavaScript prompt [window.prompt()]. + * + * + * @param answer the answer to give in response to the prompt pop-up + */ + this.browserbot.setNextPromptResult(answer); +}; + +Selenium.prototype.doGoBack = function() { + /** + * Simulates the user clicking the "back" button on their browser. + * + */ + this.page().goBack(); +}; + +Selenium.prototype.doRefresh = function() { + /** + * Simulates the user clicking the "Refresh" button on their browser. + * + */ + this.page().refresh(); +}; + +Selenium.prototype.doClose = function() { + /** + * Simulates the user clicking the "close" button in the titlebar of a popup + * window or tab. + */ + this.page().close(); +}; + +Selenium.prototype.isAlertPresent = function() { + /** + * Has an alert occurred? + * + *

+ * This function never throws an exception + *

+ * @return boolean true if there is an alert + */ + return this.browserbot.hasAlerts(); +}; +Selenium.prototype.isPromptPresent = function() { + /** + * Has a prompt occurred? + * + *

+ * This function never throws an exception + *

+ * @return boolean true if there is a pending prompt + */ + return this.browserbot.hasPrompts(); +}; +Selenium.prototype.isConfirmationPresent = function() { + /** + * Has confirm() been called? + * + *

+ * This function never throws an exception + *

+ * @return boolean true if there is a pending confirmation + */ + return this.browserbot.hasConfirmations(); +}; +Selenium.prototype.getAlert = function() { + /** + * Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts. + * + *

Getting an alert has the same effect as manually clicking OK. If an + * alert is generated but you do not get/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 someone manually clicks OK.

+ * @return string The message of the most recent JavaScript alert + */ + if (!this.browserbot.hasAlerts()) { + Assert.fail("There were no alerts"); + } + return this.browserbot.getNextAlert(); +}; +Selenium.prototype.getAlert.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.getConfirmation = function() { + /** + * Retrieves the message of a JavaScript confirmation dialog generated during + * the previous action. + * + *

+ * 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. If an confirmation is generated + * but you do not get/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. + *

+ * + * @return string the message of the most recent JavaScript confirmation dialog + */ + if (!this.browserbot.hasConfirmations()) { + Assert.fail("There were no confirmations"); + } + return this.browserbot.getNextConfirmation(); +}; +Selenium.prototype.getConfirmation.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.getPrompt = function() { + /** + * Retrieves the message of a JavaScript question prompt dialog generated during + * the previous action. + * + *

Successful handling of the prompt requires prior execution of the + * answerOnNextPrompt command. If a prompt is generated but you + * do not get/verify it, the next Selenium action will fail.

+ * + *

NOTE: under Selenium, JavaScript prompts will NOT pop up a visible + * dialog.

+ * + *

NOTE: Selenium does NOT support JavaScript prompts that are generated in a + * page's onload() event handler. In this case a visible dialog WILL be + * generated and Selenium will hang until someone manually clicks OK.

+ * @return string the message of the most recent JavaScript question prompt + */ + if (! this.browserbot.hasPrompts()) { + Assert.fail("There were no prompts"); + } + return this.browserbot.getNextPrompt(); +}; + +Selenium.prototype.getLocation = function() { + /** Gets the absolute URL of the current page. + * + * @return string the absolute URL of the current page + */ + return this.page().location; +}; + +Selenium.prototype.getTitle = function() { + /** Gets the title of the current page. + * + * @return string the title of the current page + */ + return this.page().title(); +}; + + +Selenium.prototype.getBodyText = function() { + /** + * Gets the entire text of the page. + * @return string the entire text of the page + */ + return this.page().bodyText(); +}; + + +Selenium.prototype.getValue = function(locator) { + /** + * Gets the (whitespace-trimmed) 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. + * + * @param locator an element locator + * @return string the element value, or "on/off" for checkbox/radio elements + */ + var element = this.page().findElement(locator) + return getInputValue(element).trim(); +} + +Selenium.prototype.getText = function(locator) { + /** + * Gets 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. + * + * @param locator an element locator + * @return string the text of the element + */ + var element = this.page().findElement(locator); + return getText(element).trim(); +}; + +Selenium.prototype.getEval = function(script) { + /** Gets the result of evaluating the specified JavaScript snippet. The snippet may + * have multiple lines, but only the result of the last line will be returned. + * + *

Note that, by default, the snippet will run in the context of the "selenium" + * object itself, so this will refer to the Selenium object, and window will + * refer to the top-level runner test window, not the window of your application.

+ * + *

If you need a reference to the window of your application, you can refer + * to this.browserbot.getCurrentWindow() and if you need to use + * a locator to refer to a single element in your application page, you can + * use this.page().findElement("foo") where "foo" is your locator.

+ * + * @param script the JavaScript snippet to run + * @return string the results of evaluating the snippet + */ + try { + var result = eval(script); + // Selenium RC doesn't allow returning null + if (null == result) return "null"; + return result; + } catch (e) { + throw new SeleniumError("Threw an exception: " + e.message); + } +}; + +Selenium.prototype.isChecked = function(locator) { + /** + * Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. + * @param locator an element locator pointing to a checkbox or radio button + * @return string either "true" or "false" depending on whether the checkbox is checked + */ + var element = this.page().findElement(locator); + if (element.checked == null) { + throw new SeleniumError("Element " + locator + " is not a toggle-button."); + } + return element.checked; +}; + +Selenium.prototype.getTable = function(tableCellAddress) { + /** + * Gets the text from a cell of a table. The cellAddress syntax + * tableLocator.row.column, where row and column start at 0. + * + * @param tableCellAddress a cell address, e.g. "foo.1.4" + * @return string the text from the specified cell + */ + // This regular expression matches "tableName.row.column" + // For example, "mytable.3.4" + pattern = /(.*)\.(\d+)\.(\d+)/; + + if(!pattern.test(tableCellAddress)) { + throw new SeleniumError("Invalid target format. Correct format is tableName.rowNum.columnNum"); + } + + pieces = tableCellAddress.match(pattern); + + tableName = pieces[1]; + row = pieces[2]; + col = pieces[3]; + + var table = this.page().findElement(tableName); + if (row > table.rows.length) { + Assert.fail("Cannot access row " + row + " - table has " + table.rows.length + " rows"); + } + else if (col > table.rows[row].cells.length) { + Assert.fail("Cannot access column " + col + " - table row has " + table.rows[row].cells.length + " columns"); + } + else { + actualContent = getText(table.rows[row].cells[col]); + return actualContent.trim(); + } + return null; +}; + +Selenium.prototype.assertSelected = function(selectLocator, optionLocator) { + /** + * Verifies that the selected option of a drop-down satisfies the optionSpecifier. + * + *

See the select command for more information about option locators.

+ * + * @param selectLocator an element locator identifying a drop-down menu + * @param optionLocator an option locator, typically just an option label (e.g. "John Smith") + */ + var element = this.page().findElement(selectLocator); + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + if (element.selectedIndex == -1) + { + Assert.fail("No option selected"); + } + locator.assertSelected(element); +}; + +Selenium.prototype.getSelectedLabels = function(selectLocator) { + /** Gets all option labels (visible text) for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option labels in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "text").join(","); +} + +Selenium.prototype.getSelectedLabel = function(selectLocator) { + /** Gets option label (visible text) for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option label in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "text"); +} + +Selenium.prototype.getSelectedValues = function(selectLocator) { + /** Gets all option values (value attributes) for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option values in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "value").join(","); +} + +Selenium.prototype.getSelectedValue = function(selectLocator) { + /** Gets option value (value attribute) for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option value in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "value"); +} + +Selenium.prototype.getSelectedIndexes = function(selectLocator) { + /** Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option indexes in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "index").join(","); +} + +Selenium.prototype.getSelectedIndex = function(selectLocator) { + /** Gets option index (option number, starting at 0) for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option index in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "index"); +} + +Selenium.prototype.getSelectedIds = function(selectLocator) { + /** Gets all option element IDs for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option IDs in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "id").join(","); +} + +Selenium.prototype.getSelectedId = function(selectLocator) { + /** Gets option element ID for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option ID in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "id"); +} + +Selenium.prototype.isSomethingSelected = function(selectLocator) { + /** Determines whether some option in a drop-down menu is selected. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return boolean true if some option has been selected, false otherwise + */ + var element = this.page().findElement(selectLocator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + + var selectedOptions = []; + + for (var i = 0; i < element.options.length; i++) { + if (element.options[i].selected) + { + return true; + } + } + return false; +} + +Selenium.prototype.findSelectedOptionProperties = function(locator, property) { + var element = this.page().findElement(locator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + + var selectedOptions = []; + + for (var i = 0; i < element.options.length; i++) { + if (element.options[i].selected) + { + var propVal = element.options[i][property]; + if (propVal.replace) { + propVal.replace(/,/g, "\\,"); + } + selectedOptions.push(propVal); + } + } + if (selectedOptions.length == 0) Assert.fail("No option selected"); + return selectedOptions; +} + +Selenium.prototype.findSelectedOptionProperty = function(locator, property) { + var selectedOptions = this.findSelectedOptionProperties(locator, property); + if (selectedOptions.length > 1) { + Assert.fail("More than one selected option!"); + } + return selectedOptions[0]; +} + +Selenium.prototype.getSelectOptions = function(selectLocator) { + /** Gets all option labels in the specified select drop-down. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all option labels in the specified select drop-down + */ + var element = this.page().findElement(selectLocator); + + var selectOptions = []; + + for (var i = 0; i < element.options.length; i++) { + var option = element.options[i].text.replace(/,/g, "\\,"); + selectOptions.push(option); + } + + return selectOptions.join(","); +}; + + +Selenium.prototype.getAttribute = function(attributeLocator) { + /** + * Gets the value of an element attribute. + * @param attributeLocator an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar" + * @return string the value of the specified attribute + */ + var result = this.page().findAttribute(attributeLocator); + if (result == null) { + throw new SeleniumError("Could not find element attribute: " + attributeLocator); + } + return result; +}; + +Selenium.prototype.isTextPresent = function(pattern) { + /** + * Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. + * @param pattern a pattern to match with the text of the page + * @return boolean true if the pattern matches the text, false otherwise + */ + var allText = this.page().bodyText(); + + if(allText == "") { + Assert.fail("Page text not found"); + } else { + var patternMatcher = new PatternMatcher(pattern); + if (patternMatcher.strategy == PatternMatcher.strategies.glob) { + patternMatcher.matcher = new PatternMatcher.strategies.globContains(pattern); + } + return patternMatcher.matches(allText); + } +}; + +Selenium.prototype.isElementPresent = function(locator) { + /** + * Verifies that the specified element is somewhere on the page. + * @param locator an element locator + * @return boolean true if the element is present, false otherwise + */ + try { + this.page().findElement(locator); + } catch (e) { + return false; + } + return true; +}; + +Selenium.prototype.isVisible = function(locator) { + /** + * Determines if the specified element is 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. This method will fail if + * the element is not present. + * + * @param locator an element locator + * @return boolean true if the specified element is visible, false otherwise + */ + var element; + element = this.page().findElement(locator); + + if(/Konqueror|Safari|KHTML/.test(navigator.userAgent)) + var visibility = element.style["visibility"]; + else + var visibility = this.findEffectiveStyleProperty(element, "visibility"); + + var _isDisplayed = this._isDisplayed(element); + return (visibility != "hidden" && _isDisplayed); +}; + +Selenium.prototype.findEffectiveStyleProperty = function(element, property) { + var effectiveStyle = this.findEffectiveStyle(element); + var propertyValue = effectiveStyle[property]; + if (propertyValue == 'inherit' && element.parentNode.style) { + return this.findEffectiveStyleProperty(element.parentNode, property); + } + return propertyValue; +}; + +Selenium.prototype._isDisplayed = function(element) { + if(/Konqueror|Safari|KHTML/.test(navigator.userAgent)) + var display = element.style["display"]; + else + var display = this.findEffectiveStyleProperty(element, "display"); + if (display == "none") return false; + if (element.parentNode.style) { + return this._isDisplayed(element.parentNode); + } + return true; +}; + +Selenium.prototype.findEffectiveStyle = function(element) { + if (element.style == undefined) { + return undefined; // not a styled element + } + var window = this.browserbot.getContentWindow(); + if (window.getComputedStyle) { + // DOM-Level-2-CSS + return window.getComputedStyle(element, null); + } + if (element.currentStyle) { + // non-standard IE alternative + return element.currentStyle; + // TODO: this won't really work in a general sense, as + // currentStyle is not identical to getComputedStyle() + // ... but it's good enough for "visibility" + } + throw new SeleniumError("cannot determine effective stylesheet in this browser"); +}; + +Selenium.prototype.isEditable = function(locator) { + /** + * Determines whether the specified input element is editable, ie hasn't been disabled. + * This method will fail if the specified element isn't an input element. + * + * @param locator an element locator + * @return boolean true if the input element is editable, false otherwise + */ + var element = this.page().findElement(locator); + if (element.value == undefined) { + Assert.fail("Element " + locator + " is not an input."); + } + return !element.disabled; +}; + +Selenium.prototype.getAllButtons = function() { + /** Returns the IDs of all buttons on the page. + * + *

If a given button has no ID, it will appear as "" in this array.

+ * + * @return string[] the IDs of all buttons on the page + */ + return this.page().getAllButtons(); +}; + +Selenium.prototype.getAllLinks = function() { + /** Returns the IDs of all links on the page. + * + *

If a given link has no ID, it will appear as "" in this array.

+ * + * @return string[] the IDs of all links on the page + */ + return this.page().getAllLinks(); +}; + +Selenium.prototype.getAllFields = function() { + /** Returns the IDs of all input fields on the page. + * + *

If a given field has no ID, it will appear as "" in this array.

+ * + * @return string[] the IDs of all field on the page + */ + return this.page().getAllFields(); +}; + +Selenium.prototype.getHtmlSource = function() { + /** Returns the entire HTML source between the opening and + * closing "html" tags. + * + * @return string the entire HTML source + */ + return this.page().currentDocument.getElementsByTagName("html")[0].innerHTML; +}; + +Selenium.prototype.doSetCursorPosition = function(locator, position) { + /** + * Moves the text cursor to the specified position in the given input element or textarea. + * This method will fail if the specified element isn't an input element or textarea. + * + * @param locator an element locator pointing to an input element or textarea + * @param position the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field. + */ + var element = this.page().findElement(locator); + if (element.value == undefined) { + Assert.fail("Element " + locator + " is not an input."); + } + if (position == -1) { + position = element.value.length; + } + + if( element.setSelectionRange && !browserVersion.isOpera) { + element.focus(); + element.setSelectionRange(/*start*/position,/*end*/position); + } + else if( element.createTextRange ) { + triggerEvent(element, 'focus', false); + var range = element.createTextRange(); + range.collapse(true); + range.moveEnd('character',position); + range.moveStart('character',position); + range.select(); + } +} + +Selenium.prototype.getCursorPosition = function(locator) { + /** + * Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers. + * + *

Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to + * return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.

+ * This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element. + * + * @param locator an element locator pointing to an input element or textarea + * @return number the numerical position of the cursor in the field + */ + var element = this.page().findElement(locator); + var doc = this.page().currentDocument; + var win = this.browserbot.getCurrentWindow(); + if( doc.selection && !browserVersion.isOpera){ + + var selectRange = doc.selection.createRange().duplicate(); + var elementRange = element.createTextRange(); + selectRange.move("character",0); + elementRange.move("character",0); + var inRange1 = selectRange.inRange(elementRange); + var inRange2 = elementRange.inRange(selectRange); + try { + elementRange.setEndPoint("EndToEnd", selectRange); + } catch (e) { + Assert.fail("There is no cursor on this page!"); + } + var answer = String(elementRange.text).replace(/\r/g,"").length; + return answer; + } else { + if (typeof(element.selectionStart) != undefined) { + if (win.getSelection && typeof(win.getSelection().rangeCount) != undefined && win.getSelection().rangeCount == 0) { + Assert.fail("There is no cursor on this page!"); + } + return element.selectionStart; + } + } + throw new Error("Couldn't detect cursor position on this browser!"); +} + + +Selenium.prototype.doSetContext = function(context, logLevelThreshold) { + /** + * Writes a message to the status bar and adds a note to the browser-side + * log. + * + *

If logLevelThreshold is specified, set the threshold for logging + * to that level (debug, info, warn, error).

+ * + *

(Note that the browser-side logs will not be sent back to the + * server, and are invisible to the Client Driver.)

+ * + * @param context + * the message to be sent to the browser + * @param logLevelThreshold one of "debug", "info", "warn", "error", sets the threshold for browser-side logging + */ + if (logLevelThreshold==null || logLevelThreshold=="") { + return this.page().setContext(context); + } + return this.page().setContext(context, logLevelThreshold); +}; + +Selenium.prototype.getExpression = function(expression) { + /** + * Returns the specified expression. + * + *

This is useful because of JavaScript preprocessing. + * It is used to generate commands like assertExpression and storeExpression.

+ * + * @param expression the value to return + * @return string the value passed in + */ + return expression; +} + +Selenium.prototype.doWaitForCondition = function(script, timeout) { + /** + * Runs the specified JavaScript snippet repeatedly until it evaluates to "true". + * The snippet may have multiple lines, but only the result of the last line + * will be considered. + * + *

Note that, by default, the snippet will be run in the runner's test window, not in the window + * of your application. To get the window of your application, you can use + * the JavaScript snippet selenium.browserbot.getCurrentWindow(), and then + * run your JavaScript in there

+ * @param script the JavaScript snippet to run + * @param timeout a timeout in milliseconds, after which this command will return with an error + */ + if (isNaN(timeout)) { + throw new SeleniumError("Timeout is not a number: " + timeout); + } + + testLoop.waitForCondition = function () { + return eval(script); + }; + + testLoop.waitForConditionStart = new Date().getTime(); + testLoop.waitForConditionTimeout = timeout; +}; + +Selenium.prototype.doWaitForCondition.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.doSetTimeout = function(timeout) { + /** + * Specifies the amount of time that Selenium will wait for actions to complete. + * + *

Actions that require waiting include "open" and the "waitFor*" actions.

+ * The default timeout is 30 seconds. + * @param timeout a timeout in milliseconds, after which the action will return with an error + */ + testLoop.waitForConditionTimeout = timeout; +} + +Selenium.prototype.doWaitForPageToLoad = function(timeout) { + /** + * Waits for a new page to load. + * + *

You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. + * (which are only available in the JS API).

+ * + *

Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded" + * flag when it first notices a page load. Running any other Selenium command after + * turns the flag to false. Hence, if you want to wait for a page to load, you must + * wait immediately after a Selenium command that caused a page-load.

+ * @param timeout a timeout in milliseconds, after which this command will return with an error + */ + this.doWaitForCondition("selenium.browserbot.isNewPageLoaded()", timeout); +}; + +Selenium.prototype.doWaitForPageToLoad.dontCheckAlertsAndConfirms = true; + +/** + * Evaluate a parameter, performing JavaScript evaluation and variable substitution. + * If the string matches the pattern "javascript{ ... }", evaluate the string between the braces. + */ +Selenium.prototype.preprocessParameter = function(value) { + var match = value.match(/^javascript\{((.|\r?\n)+)\}$/); + if (match && match[1]) { + return eval(match[1]).toString(); + } + return this.replaceVariables(value); +}; + +/* + * Search through str and replace all variable references ${varName} with their + * value in storedVars. + */ +Selenium.prototype.replaceVariables = function(str) { + var stringResult = str; + + // Find all of the matching variable references + var match = stringResult.match(/\$\{\w+\}/g); + if (!match) { + return stringResult; + } + + // For each match, lookup the variable value, and replace if found + for (var i = 0; match && i < match.length; i++) { + var variable = match[i]; // The replacement variable, with ${} + var name = variable.substring(2, variable.length - 1); // The replacement variable without ${} + var replacement = storedVars[name]; + if (replacement != undefined) { + stringResult = stringResult.replace(variable, replacement); + } + } + return stringResult; +}; + + +/** + * Factory for creating "Option Locators". + * An OptionLocator is an object for dealing with Select options (e.g. for + * finding a specified option, or asserting that the selected option of + * Select element matches some condition. + * The type of locator returned by the factory depends on the locator string: + * label= (OptionLocatorByLabel) + * value= (OptionLocatorByValue) + * index= (OptionLocatorByIndex) + * id= (OptionLocatorById) + * (default is OptionLocatorByLabel). + */ +function OptionLocatorFactory() { +} + +OptionLocatorFactory.prototype.fromLocatorString = function(locatorString) { + var locatorType = 'label'; + var locatorValue = locatorString; + // If there is a locator prefix, use the specified strategy + var result = locatorString.match(/^([a-zA-Z]+)=(.*)/); + if (result) { + locatorType = result[1]; + locatorValue = result[2]; + } + if (this.optionLocators == undefined) { + this.registerOptionLocators(); + } + if (this.optionLocators[locatorType]) { + return new this.optionLocators[locatorType](locatorValue); + } + throw new SeleniumError("Unkown option locator type: " + locatorType); +}; + +/** + * To allow for easy extension, all of the option locators are found by + * searching for all methods of OptionLocatorFactory.prototype that start + * with "OptionLocatorBy". + * TODO: Consider using the term "Option Specifier" instead of "Option Locator". + */ +OptionLocatorFactory.prototype.registerOptionLocators = function() { + this.optionLocators={}; + for (var functionName in this) { + var result = /OptionLocatorBy([A-Z].+)$/.exec(functionName); + if (result != null) { + var locatorName = result[1].lcfirst(); + this.optionLocators[locatorName] = this[functionName]; + } + } +}; + +/** + * OptionLocator for options identified by their labels. + */ +OptionLocatorFactory.prototype.OptionLocatorByLabel = function(label) { + this.label = label; + this.labelMatcher = new PatternMatcher(this.label); + this.findOption = function(element) { + for (var i = 0; i < element.options.length; i++) { + if (this.labelMatcher.matches(element.options[i].text)) { + return element.options[i]; + } + } + throw new SeleniumError("Option with label '" + this.label + "' not found"); + }; + + this.assertSelected = function(element) { + var selectedLabel = element.options[element.selectedIndex].text; + Assert.matches(this.label, selectedLabel) + }; +}; + +/** + * OptionLocator for options identified by their values. + */ +OptionLocatorFactory.prototype.OptionLocatorByValue = function(value) { + this.value = value; + this.valueMatcher = new PatternMatcher(this.value); + this.findOption = function(element) { + for (var i = 0; i < element.options.length; i++) { + if (this.valueMatcher.matches(element.options[i].value)) { + return element.options[i]; + } + } + throw new SeleniumError("Option with value '" + this.value + "' not found"); + }; + + this.assertSelected = function(element) { + var selectedValue = element.options[element.selectedIndex].value; + Assert.matches(this.value, selectedValue) + }; +}; + +/** + * OptionLocator for options identified by their index. + */ +OptionLocatorFactory.prototype.OptionLocatorByIndex = function(index) { + this.index = Number(index); + if (isNaN(this.index) || this.index < 0) { + throw new SeleniumError("Illegal Index: " + index); + } + + this.findOption = function(element) { + if (element.options.length <= this.index) { + throw new SeleniumError("Index out of range. Only " + element.options.length + " options available"); + } + return element.options[this.index]; + }; + + this.assertSelected = function(element) { + Assert.equals(this.index, element.selectedIndex); + }; +}; + +/** + * OptionLocator for options identified by their id. + */ +OptionLocatorFactory.prototype.OptionLocatorById = function(id) { + this.id = id; + this.idMatcher = new PatternMatcher(this.id); + this.findOption = function(element) { + for (var i = 0; i < element.options.length; i++) { + if (this.idMatcher.matches(element.options[i].id)) { + return element.options[i]; + } + } + throw new SeleniumError("Option with id '" + this.id + "' not found"); + }; + + this.assertSelected = function(element) { + var selectedId = element.options[element.selectedIndex].id; + Assert.matches(this.id, selectedId) + }; +}; + + diff --git a/tests/test_tools/selenium/core/scripts/selenium-browserbot.js b/tests/test_tools/selenium/core/scripts/selenium-browserbot.js new file mode 100644 index 00000000..8df46865 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-browserbot.js @@ -0,0 +1,1114 @@ +/* +* 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. +* +*/ + +/* +* This script provides the Javascript API to drive the test application contained within +* a Browser Window. +* TODO: +* Add support for more events (keyboard and mouse) +* Allow to switch "user-entry" mode from mouse-based to keyboard-based, firing different +* events in different modes. +*/ + +// The window to which the commands will be sent. For example, to click on a +// popup window, first select that window, and then do a normal click command. + +var BrowserBot = function(frame) { + this.frame = frame; + this.currentPage = null; + this.currentWindowName = null; + + this.modalDialogTest = null; + this.recordedAlerts = new Array(); + this.recordedConfirmations = new Array(); + this.recordedPrompts = new Array(); + this.openedWindows = {}; + this.nextConfirmResult = true; + this.nextPromptResult = ''; + this.newPageLoaded = false; + this.pageLoadError = null; + + var self = this; + this.recordPageLoad = function() { + LOG.debug("Page load detected"); + try { + LOG.debug("Page load location=" + self.getCurrentWindow().location); + } catch (e) { + self.pageLoadError = e; + return; + } + self.currentPage = null; + self.newPageLoaded = true; + }; + + this.isNewPageLoaded = function() { + if (this.pageLoadError) throw this.pageLoadError; + return self.newPageLoaded; + }; +}; + +BrowserBot.createForFrame = function(frame) { + var browserbot; + LOG.debug("browserName: " + browserVersion.name); + LOG.debug("userAgent: " + navigator.userAgent); + if (browserVersion.isIE) { + browserbot = new IEBrowserBot(frame); + } + else if (browserVersion.isKonqueror) { + browserbot = new KonquerorBrowserBot(frame); + } + else if (browserVersion.isSafari) { + browserbot = new SafariBrowserBot(frame); + } + else { + LOG.info("Using MozillaBrowserBot") + // Use mozilla by default + browserbot = new MozillaBrowserBot(frame); + } + + // Modify the test IFrame so that page loads are detected. + addLoadListener(browserbot.getFrame(), browserbot.recordPageLoad); + return browserbot; +}; + +BrowserBot.prototype.doModalDialogTest = function(test) { + this.modalDialogTest = test; +}; + +BrowserBot.prototype.cancelNextConfirmation = function() { + this.nextConfirmResult = false; +}; + +BrowserBot.prototype.setNextPromptResult = function(result) { + this.nextPromptResult = result; +}; + +BrowserBot.prototype.hasAlerts = function() { + return (this.recordedAlerts.length > 0) ; +}; + +BrowserBot.prototype.getNextAlert = function() { + return this.recordedAlerts.shift(); +}; + +BrowserBot.prototype.hasConfirmations = function() { + return (this.recordedConfirmations.length > 0) ; +}; + +BrowserBot.prototype.getNextConfirmation = function() { + return this.recordedConfirmations.shift(); +}; + +BrowserBot.prototype.hasPrompts = function() { + return (this.recordedPrompts.length > 0) ; +}; + +BrowserBot.prototype.getNextPrompt = function() { + return this.recordedPrompts.shift(); +}; + +BrowserBot.prototype.getFrame = function() { + return this.frame; +}; + +BrowserBot.prototype.selectWindow = function(target) { + // we've moved to a new page - clear the current one + this.currentPage = null; + this.currentWindowName = null; + if (target && target != "null") { + // If window exists + if (this.getTargetWindow(target)) { + this.currentWindowName = target; + } + } +}; + +BrowserBot.prototype.openLocation = function(target) { + // We're moving to a new page - clear the current one + this.currentPage = null; + this.newPageLoaded = false; + + this.setOpenLocation(target); +}; + +BrowserBot.prototype.setIFrameLocation = function(iframe, location) { + iframe.src = location; +}; + +BrowserBot.prototype.setOpenLocation = function(location) { + this.getCurrentWindow().location.href = location; +}; + +BrowserBot.prototype.getCurrentPage = function() { + if (this.currentPage == null) { + var testWindow = this.getCurrentWindow(); + this.modifyWindowToRecordPopUpDialogs(testWindow, this); + this.modifySeparateTestWindowToDetectPageLoads(testWindow); + this.currentPage = PageBot.createForWindow(testWindow); + this.newPageLoaded = false; + } + + return this.currentPage; +}; + +BrowserBot.prototype.modifyWindowToRecordPopUpDialogs = function(windowToModify, browserBot) { + windowToModify.alert = function(alert) { + browserBot.recordedAlerts.push(alert); + }; + + windowToModify.confirm = function(message) { + browserBot.recordedConfirmations.push(message); + var result = browserBot.nextConfirmResult; + browserBot.nextConfirmResult = true; + return result; + }; + + windowToModify.prompt = function(message) { + browserBot.recordedPrompts.push(message); + var result = !browserBot.nextConfirmResult ? null : browserBot.nextPromptResult; + browserBot.nextConfirmResult = true; + browserBot.nextPromptResult = ''; + return result; + }; + + // Keep a reference to all popup windows by name + // note that in IE the "windowName" argument must be a valid javascript identifier, it seems. + var originalOpen = windowToModify.open; + windowToModify.open = function(url, windowName, windowFeatures, replaceFlag) { + var openedWindow = originalOpen(url, windowName, windowFeatures, replaceFlag); + selenium.browserbot.openedWindows[windowName] = openedWindow; + return openedWindow; + }; +}; + +/** + * The main IFrame has a single, long-lived onload handler that clears + * Browserbot.currentPage and sets the "newPageLoaded" flag. For separate + * windows, we need to attach a handler each time. This uses the + * "callOnWindowPageTransition" mechanism, which is implemented differently + * for different browsers. + */ +BrowserBot.prototype.modifySeparateTestWindowToDetectPageLoads = function(windowToModify) { + if (this.currentWindowName != null) { + this.callOnWindowPageTransition(this.recordPageLoad, windowToModify); + } +}; + +/** + * Call the supplied function when a the current page unloads and a new one loads. + * This is done by polling continuously until the document changes and is fully loaded. + */ +BrowserBot.prototype.callOnWindowPageTransition = function(loadFunction, windowObject) { + // Since the unload event doesn't fire in Safari 1.3, we start polling immediately + if (windowObject && !windowObject.closed) { + LOG.debug("Starting pollForLoad: " + windowObject.document.location); + this.pollingForLoad = true; + this.pollForLoad(loadFunction, windowObject, windowObject.location, windowObject.location.href); + } +}; + +/** + * Set up a polling timer that will keep checking the readyState of the document until it's complete. + * Since we might call this before the original page is unloaded, we first check to see that the current location + * or href is different from the original one. + */ +BrowserBot.prototype.pollForLoad = function(loadFunction, windowObject, originalLocation, originalHref) { + var windowClosed = true; + try { + windowClosed = windowObject.closed; + } catch (e) { + LOG.debug("exception detecting closed window (I guess it must be closed)"); + LOG.exception(e); + // swallow exceptions which may occur in HTA mode when the window is closed + } + if (null == windowClosed) windowClosed = true; + if (windowClosed) { + this.pollingForLoad = false; + return; + } + + LOG.debug("pollForLoad original: " + originalHref); + try { + + var currentLocation = windowObject.location; + var currentHref = currentLocation.href + + var sameLoc = (originalLocation === currentLocation); + var sameHref = (originalHref === currentHref); + var rs = windowObject.document.readyState; + + if (rs == null) rs = 'complete'; + + if (!(sameLoc && sameHref) && rs == 'complete') { + LOG.debug("pollForLoad complete: " + rs + " (" + currentHref + ")"); + loadFunction(); + this.pollingForLoad = false; + return; + } + var self = this; + LOG.debug("pollForLoad continue: " + currentHref); + window.setTimeout(function() {self.pollForLoad(loadFunction, windowObject, originalLocation, originalHref);}, 500); + } catch (e) { + LOG.error("Exception during pollForLoad; this should get noticed soon!"); + LOG.exception(e); + this.pageLoadError = e; + } +}; + + +BrowserBot.prototype.getContentWindow = function() { + return this.getFrame().contentWindow || frames[this.getFrame().id]; +}; + +BrowserBot.prototype.getTargetWindow = function(windowName) { + LOG.debug("getTargetWindow(" + windowName + ")"); + // First look in the map of opened windows + var targetWindow = this.openedWindows[windowName]; + if (!targetWindow) { + var evalString = "this.getContentWindow().window." + windowName; + targetWindow = eval(evalString); + } + if (!targetWindow) { + throw new SeleniumError("Window does not exist"); + } + return targetWindow; +}; + +BrowserBot.prototype.getCurrentWindow = function() { + var testWindow = this.getContentWindow().window; + if (this.currentWindowName != null) { + testWindow = this.getTargetWindow(this.currentWindowName); + } + return testWindow; +}; + +function MozillaBrowserBot(frame) { + BrowserBot.call(this, frame); +} +MozillaBrowserBot.prototype = new BrowserBot; + +function KonquerorBrowserBot(frame) { + BrowserBot.call(this, frame); +} +KonquerorBrowserBot.prototype = new BrowserBot; + +KonquerorBrowserBot.prototype.setIFrameLocation = function(iframe, location) { + // Window doesn't fire onload event when setting src to the current value, + // so we set it to blank first. + iframe.src = "about:blank"; + iframe.src = location; +}; + +KonquerorBrowserBot.prototype.setOpenLocation = function(location) { + // Window doesn't fire onload event when setting src to the current value, + // so we set it to blank first. + this.getCurrentWindow().location.href = "about:blank"; + this.getCurrentWindow().location.href = location; +}; + +function SafariBrowserBot(frame) { + BrowserBot.call(this, frame); +} +SafariBrowserBot.prototype = new BrowserBot; + +SafariBrowserBot.prototype.setIFrameLocation = KonquerorBrowserBot.prototype.setIFrameLocation; + +function IEBrowserBot(frame) { + BrowserBot.call(this, frame); +} +IEBrowserBot.prototype = new BrowserBot; + +IEBrowserBot.prototype.modifyWindowToRecordPopUpDialogs = function(windowToModify, browserBot) { + BrowserBot.prototype.modifyWindowToRecordPopUpDialogs(windowToModify, browserBot); + + // we will call the previous version of this method from within our own interception + oldShowModalDialog = windowToModify.showModalDialog; + + windowToModify.showModalDialog = function(url, args, features) { + // Get relative directory to where TestRunner.html lives + // A risky assumption is that the user's TestRunner is named TestRunner.html + var doc_location = document.location.toString(); + var end_of_base_ref = doc_location.indexOf('TestRunner.html'); + var base_ref = doc_location.substring(0, end_of_base_ref); + + var fullURL = base_ref + "TestRunner.html?singletest=" + escape(browserBot.modalDialogTest) + "&autoURL=" + escape(url) + "&runInterval=" + runInterval; + browserBot.modalDialogTest = null; + + var returnValue = oldShowModalDialog(fullURL, args, features); + return returnValue; + }; +}; + +SafariBrowserBot.prototype.modifyWindowToRecordPopUpDialogs = function(windowToModify, browserBot) { + BrowserBot.prototype.modifyWindowToRecordPopUpDialogs(windowToModify, browserBot); + + var originalOpen = windowToModify.open; + /* + * Safari seems to be broken, so that when we manually trigger the onclick method + * of a button/href, any window.open calls aren't resolved relative to the app location. + * So here we replace the open() method with one that does resolve the url correctly. + */ + windowToModify.open = function(url, windowName, windowFeatures, replaceFlag) { + + if (url.startsWith("http://") || url.startsWith("https://") || url.startsWith("/")) { + return originalOpen(url, windowName, windowFeatures, replaceFlag); + } + + // Reduce the current path to the directory + var currentPath = windowToModify.location.pathname || "/"; + currentPath = currentPath.replace(/\/[^\/]*$/, "/"); + + // Remove any leading "./" from the new url. + url = url.replace(/^\.\//, ""); + + newUrl = currentPath + url; + + return originalOpen(newUrl, windowName, windowFeatures, replaceFlag); + }; +}; + +var PageBot = function(pageWindow) { + if (pageWindow) { + this.currentWindow = pageWindow; + this.currentDocument = pageWindow.document; + this.location = pageWindow.location; + this.title = function() {return this.currentDocument.title;}; + } + + // Register all locateElementBy* functions + // TODO - don't do this in the constructor - only needed once ever + this.locationStrategies = {}; + for (var functionName in this) { + var result = /^locateElementBy([A-Z].+)$/.exec(functionName); + if (result != null) { + var locatorFunction = this[functionName]; + if (typeof(locatorFunction) != 'function') { + continue; + } + // Use a specified prefix in preference to one generated from + // the function name + var locatorPrefix = locatorFunction.prefix || result[1].toLowerCase(); + this.locationStrategies[locatorPrefix] = locatorFunction; + } + } + + /** + * Find a locator based on a prefix. + */ + this.findElementBy = function(locatorType, locator, inDocument) { + var locatorFunction = this.locationStrategies[locatorType]; + if (! locatorFunction) { + throw new SeleniumError("Unrecognised locator type: '" + locatorType + "'"); + } + return locatorFunction.call(this, locator, inDocument); + }; + + /** + * The implicit locator, that is used when no prefix is supplied. + */ + this.locationStrategies['implicit'] = function(locator, inDocument) { + if (locator.startsWith('//')) { + return this.locateElementByXPath(locator, inDocument); + } + if (locator.startsWith('document.')) { + return this.locateElementByDomTraversal(locator, inDocument); + } + return this.locateElementByIdentifier(locator, inDocument); + }; + +}; + +PageBot.createForWindow = function(windowObject) { + if (browserVersion.isIE) { + return new IEPageBot(windowObject); + } + else if (browserVersion.isKonqueror) { + return new KonquerorPageBot(windowObject); + } + else if (browserVersion.isSafari) { + return new SafariPageBot(windowObject); + } + else if (browserVersion.isOpera) { + return new OperaPageBot(windowObject); + } + else { + LOG.info("Using MozillaPageBot") + // Use mozilla by default + return new MozillaPageBot(windowObject); + } +}; + +var MozillaPageBot = function(pageWindow) { + PageBot.call(this, pageWindow); +}; +MozillaPageBot.prototype = new PageBot(); + +var KonquerorPageBot = function(pageWindow) { + PageBot.call(this, pageWindow); +}; +KonquerorPageBot.prototype = new PageBot(); + +var SafariPageBot = function(pageWindow) { + PageBot.call(this, pageWindow); +}; +SafariPageBot.prototype = new PageBot(); + +var IEPageBot = function(pageWindow) { + PageBot.call(this, pageWindow); +}; +IEPageBot.prototype = new PageBot(); + +OperaPageBot = function(pageWindow) { + PageBot.call(this, pageWindow); +}; +OperaPageBot.prototype = new PageBot(); + +/* +* Finds an element on the current page, using various lookup protocols +*/ +PageBot.prototype.findElement = function(locator) { + var locatorType = 'implicit'; + var locatorString = locator; + + // If there is a locator prefix, use the specified strategy + var result = locator.match(/^([A-Za-z]+)=(.+)/); + if (result) { + locatorType = result[1].toLowerCase(); + locatorString = result[2]; + } + + var element = this.findElementBy(locatorType, locatorString, this.currentDocument); + if (element != null) { + return element; + } + for (var i = 0; i < this.currentWindow.frames.length; i++) { + element = this.findElementBy(locatorType, locatorString, this.currentWindow.frames[i].document); + if (element != null) { + return element; + } + } + + // Element was not found by any locator function. + throw new SeleniumError("Element " + locator + " not found"); +}; + +/** + * In non-IE browsers, getElementById() does not search by name. Instead, we + * we search separately by id and name. + */ +PageBot.prototype.locateElementByIdentifier = function(identifier, inDocument) { + return PageBot.prototype.locateElementById(identifier, inDocument) + || PageBot.prototype.locateElementByName(identifier, inDocument) + || null; +}; + +/** + * In IE, getElementById() also searches by name - this is an optimisation for IE. + */ +IEPageBot.prototype.locateElementByIdentifer = function(identifier, inDocument) { + return inDocument.getElementById(identifier); +}; + +/** + * Find the element with id - can't rely on getElementById, coz it returns by name as well in IE.. + */ +PageBot.prototype.locateElementById = function(identifier, inDocument) { + var element = inDocument.getElementById(identifier); + if (element && element.id === identifier) { + return element; + } + else { + return null; + } +}; + +/** + * Find an element by name, refined by (optional) element-filter + * expressions. + */ +PageBot.prototype.locateElementByName = function(locator, document) { + var elements = document.getElementsByTagName("*"); + + var filters = locator.split(' '); + filters[0] = 'name=' + filters[0]; + + while (filters.length) { + var filter = filters.shift(); + elements = this.selectElements(filter, elements, 'value'); + } + + if (elements.length > 0) { + return elements[0]; + } + return null; +}; + +/** +* Finds an element using by evaluating the "document.*" string against the +* current document object. Dom expressions must begin with "document." +*/ +PageBot.prototype.locateElementByDomTraversal = function(domTraversal, inDocument) { + if (domTraversal.indexOf("document.") != 0) { + return null; + } + + // Trim the leading 'document' + domTraversal = domTraversal.substr(9); + var locatorScript = "inDocument." + domTraversal; + var element = eval(locatorScript); + + if (!element) { + return null; + } + + return element; +}; +PageBot.prototype.locateElementByDomTraversal.prefix = "dom"; + +/** +* Finds an element identified by the xpath expression. Expressions _must_ +* begin with "//". +*/ +PageBot.prototype.locateElementByXPath = function(xpath, inDocument) { + + // Trim any trailing "/": not valid xpath, and remains from attribute + // locator. + if (xpath.charAt(xpath.length - 1) == '/') { + xpath = xpath.slice(0, -1); + } + + // Handle //tag + var match = xpath.match(/^\/\/(\w+|\*)$/); + if (match) { + var elements = inDocument.getElementsByTagName(match[1].toUpperCase()); + if (elements == null) return null; + return elements[0]; + } + + // Handle //tag[@attr='value'] + var match = xpath.match(/^\/\/(\w+|\*)\[@(\w+)=('([^\']+)'|"([^\"]+)")\]$/); + if (match) { + return this.findElementByTagNameAndAttributeValue( + inDocument, + match[1].toUpperCase(), + match[2].toLowerCase(), + match[3].slice(1, -1) + ); + } + + // Handle //tag[text()='value'] + var match = xpath.match(/^\/\/(\w+|\*)\[text\(\)=('([^\']+)'|"([^\"]+)")\]$/); + if (match) { + return this.findElementByTagNameAndText( + inDocument, + match[1].toUpperCase(), + match[2].slice(1, -1) + ); + } + + return this.findElementUsingFullXPath(xpath, inDocument); +}; + +PageBot.prototype.findElementByTagNameAndAttributeValue = function( + inDocument, tagName, attributeName, attributeValue +) { + if (browserVersion.isIE && attributeName == "class") { + attributeName = "className"; + } + var elements = inDocument.getElementsByTagName(tagName); + for (var i = 0; i < elements.length; i++) { + var elementAttr = elements[i].getAttribute(attributeName); + if (elementAttr == attributeValue) { + return elements[i]; + } + } + return null; +}; + +PageBot.prototype.findElementByTagNameAndText = function( + inDocument, tagName, text +) { + var elements = inDocument.getElementsByTagName(tagName); + for (var i = 0; i < elements.length; i++) { + if (getText(elements[i]) == text) { + return elements[i]; + } + } + return null; +}; + +PageBot.prototype.findElementUsingFullXPath = function(xpath, inDocument) { + // Use document.evaluate() if it's available + if (inDocument.evaluate) { + return inDocument.evaluate(xpath, inDocument, null, 0, null).iterateNext(); + } + + // If not, fall back to slower JavaScript implementation + var context = new ExprContext(inDocument); + var xpathObj = xpathParse(xpath); + var xpathResult = xpathObj.evaluate(context); + if (xpathResult && xpathResult.value) { + return xpathResult.value[0]; + } + return null; +}; + +/** +* Finds a link element with text matching the expression supplied. Expressions must +* begin with "link:". +*/ +PageBot.prototype.locateElementByLinkText = function(linkText, inDocument) { + var links = inDocument.getElementsByTagName('a'); + for (var i = 0; i < links.length; i++) { + var element = links[i]; + if (PatternMatcher.matches(linkText, getText(element))) { + return element; + } + } + return null; +}; +PageBot.prototype.locateElementByLinkText.prefix = "link"; + +/** +* Returns an attribute based on an attribute locator. This is made up of an element locator +* suffixed with @attribute-name. +*/ +PageBot.prototype.findAttribute = function(locator) { + // Split into locator + attributeName + var attributePos = locator.lastIndexOf("@"); + var elementLocator = locator.slice(0, attributePos); + var attributeName = locator.slice(attributePos + 1); + + // Find the element. + var element = this.findElement(elementLocator); + + // Handle missing "class" attribute in IE. + if (browserVersion.isIE && attributeName == "class") { + attributeName = "className"; + } + + // Get the attribute value. + var attributeValue = element.getAttribute(attributeName); + + return attributeValue ? attributeValue.toString() : null; +}; + +/* +* Select the specified option and trigger the relevant events of the element. +*/ +PageBot.prototype.selectOption = function(element, optionToSelect) { + triggerEvent(element, 'focus', false); + var changed = false; + for (var i = 0; i < element.options.length; i++) { + var option = element.options[i]; + if (option.selected && option != optionToSelect) { + option.selected = false; + changed = true; + } + else if (!option.selected && option == optionToSelect) { + option.selected = true; + changed = true; + } + } + + if (changed) { + triggerEvent(element, 'change', true); + } + triggerEvent(element, 'blur', false); +}; + +/* +* Select the specified option and trigger the relevant events of the element. +*/ +PageBot.prototype.addSelection = function(element, option) { + this.checkMultiselect(element); + triggerEvent(element, 'focus', false); + if (!option.selected) { + option.selected = true; + triggerEvent(element, 'change', true); + } + triggerEvent(element, 'blur', false); +}; + +/* +* Select the specified option and trigger the relevant events of the element. +*/ +PageBot.prototype.removeSelection = function(element, option) { + this.checkMultiselect(element); + triggerEvent(element, 'focus', false); + if (option.selected) { + option.selected = false; + triggerEvent(element, 'change', true); + } + triggerEvent(element, 'blur', false); +}; + +PageBot.prototype.checkMultiselect = function(element) { + if (!element.multiple) + { + throw new SeleniumError("Not a multi-select"); + } + +}; + +PageBot.prototype.replaceText = function(element, stringValue) { + triggerEvent(element, 'focus', false); + triggerEvent(element, 'select', true); + element.value=stringValue; + if (!browserVersion.isChrome) { + // In chrome URL, The change event is already fired by setting the value. + triggerEvent(element, 'change', true); + } + triggerEvent(element, 'blur', false); +}; + +MozillaPageBot.prototype.clickElement = function(element) { + + triggerEvent(element, 'focus', false); + + // Add an event listener that detects if the default action has been prevented. + // (This is caused by a javascript onclick handler returning false) + var preventDefault = false; + + element.addEventListener("click", function(evt) {preventDefault = evt.getPreventDefault();}, false); + + // Trigger the click event. + triggerMouseEvent(element, 'click', true); + + // Perform the link action if preventDefault was set. + // In chrome URL, the link action is already executed by triggerMouseEvent. + if (!browserVersion.isChrome && !preventDefault) { + // Try the element itself, as well as it's parent - this handles clicking images inside links. + if (element.href) { + this.currentWindow.location.href = element.href; + } + else if (element.parentNode && element.parentNode.href) { + this.currentWindow.location.href = element.parentNode.href; + } + } + + if (this.windowClosed()) { + return; + } + + triggerEvent(element, 'blur', false); +}; + +OperaPageBot.prototype.clickElement = function(element) { + + triggerEvent(element, 'focus', false); + + // Trigger the click event. + triggerMouseEvent(element, 'click', true); + + if (isDefined(element.checked)) { + // In Opera, clicking won't check/uncheck + if (element.type == "checkbox") { + element.checked = !element.checked; + } else { + element.checked = true; + } + } + + if (this.windowClosed()) { + return; + } + + triggerEvent(element, 'blur', false); +}; + + +KonquerorPageBot.prototype.clickElement = function(element) { + + triggerEvent(element, 'focus', false); + + if (element.click) { + element.click(); + } + else { + triggerMouseEvent(element, 'click', true); + } + + if (this.windowClosed()) { + return; + } + + triggerEvent(element, 'blur', false); +}; + +SafariPageBot.prototype.clickElement = function(element) { + + triggerEvent(element, 'focus', false); + + var wasChecked = element.checked; + + // For form element it is simple. + if (element.click) { + element.click(); + } + // For links and other elements, event emulation is required. + else { + triggerMouseEvent(element, 'click', true); + + // Unfortunately, triggering the event doesn't seem to activate onclick handlers. + // We currently call onclick for the link, but I'm guessing that the onclick for containing + // elements is not being called. + var success = true; + if (element.onclick) { + var evt = document.createEvent('HTMLEvents'); + evt.initEvent('click', true, true); + var onclickResult = element.onclick(evt); + if (onclickResult === false) { + success = false; + } + } + + if (success) { + // Try the element itself, as well as it's parent - this handles clicking images inside links. + if (element.href) { + this.currentWindow.location.href = element.href; + } + else if (element.parentNode.href) { + this.currentWindow.location.href = element.parentNode.href; + } else { + // This is true for buttons outside of forms, and maybe others. + LOG.warn("Ignoring 'click' call for button outside form, or link without href." + + "Using buttons without an enclosing form can cause wierd problems with URL resolution in Safari." ); + // I implemented special handling for window.open, but unfortunately this behaviour is also displayed + // when we have a button without an enclosing form that sets document.location in the onclick handler. + // The solution is to always use an enclosing form for a button. + } + } + } + + if (this.windowClosed()) { + return; + } + + triggerEvent(element, 'blur', false); +}; + +IEPageBot.prototype.clickElement = function(element) { + + triggerEvent(element, 'focus', false); + + var wasChecked = element.checked; + + // Set a flag that records if the page will unload - this isn't always accurate, because + // triggers the onbeforeunload event, even thought the page won't unload + var pageUnloading = false; + var pageUnloadDetector = function() {pageUnloading = true;}; + this.currentWindow.attachEvent("onbeforeunload", pageUnloadDetector); + + element.click(); + + // If the page is going to unload - still attempt to fire any subsequent events. + // However, we can't guarantee that the page won't unload half way through, so we need to handle exceptions. + try { + this.currentWindow.detachEvent("onbeforeunload", pageUnloadDetector); + + if (this.windowClosed()) { + return; + } + + // Onchange event is not triggered automatically in IE. + if (isDefined(element.checked) && wasChecked != element.checked) { + triggerEvent(element, 'change', true); + } + + triggerEvent(element, 'blur', false); + } + catch (e) { + // If the page is unloading, we may get a "Permission denied" or "Unspecified error". + // Just ignore it, because the document may have unloaded. + if (pageUnloading) { + LOG.warn("Caught exception when firing events on unloading page: " + e.message); + return; + } + throw e; + } +}; + +PageBot.prototype.windowClosed = function(element) { + return this.currentWindow.closed; +}; + +PageBot.prototype.bodyText = function() { + return getText(this.currentDocument.body); +}; + +PageBot.prototype.getAllButtons = function() { + var elements = this.currentDocument.getElementsByTagName('input'); + var result = ''; + + for (var i = 0; i < elements.length; i++) { + if (elements[i].type == 'button' || elements[i].type == 'submit' || elements[i].type == 'reset') { + result += elements[i].id; + + result += ','; + } + } + + return result; +}; + + +PageBot.prototype.getAllFields = function() { + var elements = this.currentDocument.getElementsByTagName('input'); + var result = ''; + + for (var i = 0; i < elements.length; i++) { + if (elements[i].type == 'text') { + result += elements[i].id; + + result += ','; + } + } + + return result; +}; + +PageBot.prototype.getAllLinks = function() { + var elements = this.currentDocument.getElementsByTagName('a'); + var result = ''; + + for (var i = 0; i < elements.length; i++) { + result += elements[i].id; + + result += ','; + } + + return result; +}; + +PageBot.prototype.setContext = function(strContext, logLevel) { + //set the current test title + document.getElementById("context").innerHTML=strContext; + if (logLevel!=null) { + LOG.setLogLevelThreshold(logLevel); + } +}; + +function isDefined(value) { + return typeof(value) != undefined; +} + +PageBot.prototype.goBack = function() { + this.currentWindow.history.back(); + if (browserVersion.isOpera && !selenium.browserbot.pollingForLoad) { + // DGF On Opera, goBack doesn't re-trigger a load event, so we have to poll for it + selenium.browserbot.callOnWindowPageTransition(selenium.browserbot.recordPageLoad, this.currentWindow); + } +}; + +PageBot.prototype.goForward = function() { + this.currentWindow.history.forward(); +}; + +PageBot.prototype.close = function() { + if (browserVersion.isChrome) { + this.currentWindow.close(); + } else { + this.currentWindow.eval("window.close();"); + } +}; + +PageBot.prototype.refresh = function() { + this.currentWindow.location.reload(true); +}; + +/** + * Refine a list of elements using a filter. + */ +PageBot.prototype.selectElementsBy = function(filterType, filter, elements) { + var filterFunction = PageBot.filterFunctions[filterType]; + if (! filterFunction) { + throw new SeleniumError("Unrecognised element-filter type: '" + filterType + "'"); + } + + return filterFunction(filter, elements); +}; + +PageBot.filterFunctions = {}; + +PageBot.filterFunctions.name = function(name, elements) { + var selectedElements = []; + for (var i = 0; i < elements.length; i++) { + if (elements[i].name === name) { + selectedElements.push(elements[i]); + } + } + return selectedElements; +}; + +PageBot.filterFunctions.value = function(value, elements) { + var selectedElements = []; + for (var i = 0; i < elements.length; i++) { + if (elements[i].value === value) { + selectedElements.push(elements[i]); + } + } + return selectedElements; +}; + +PageBot.filterFunctions.index = function(index, elements) { + index = Number(index); + if (isNaN(index) || index < 0) { + throw new SeleniumError("Illegal Index: " + index); + } + if (elements.length <= index) { + throw new SeleniumError("Index out of range: " + index); + } + return [elements[index]]; +}; + +PageBot.prototype.selectElements = function(filterExpr, elements, defaultFilterType) { + + var filterType = (defaultFilterType || 'value'); + + // If there is a filter prefix, use the specified strategy + var result = filterExpr.match(/^([A-Za-z]+)=(.+)/); + if (result) { + filterType = result[1].toLowerCase(); + filterExpr = result[2]; + } + + return this.selectElementsBy(filterType, filterExpr, elements); +}; + +/** + * Find an element by class + */ +PageBot.prototype.locateElementByClass = function(locator, document) { + return Element.findFirstMatchingChild(document, + function(element) { + return element.className == locator + } + ); +} + +/** + * Find an element by alt + */ +PageBot.prototype.locateElementByAlt = function(locator, document) { + return Element.findFirstMatchingChild(document, + function(element) { + return element.alt == locator + } + ); +} + diff --git a/tests/test_tools/selenium/core/scripts/selenium-browserdetect.js b/tests/test_tools/selenium/core/scripts/selenium-browserdetect.js new file mode 100644 index 00000000..137a1518 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-browserdetect.js @@ -0,0 +1,115 @@ +/* +* 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. +* +*/ + +// Although it's generally better web development practice not to use browser-detection +// (feature detection is better), the subtle browser differences that Selenium has to +// work around seem to make it necessary. Maybe as we learn more about what we need, +// we can do this in a more "feature-centric" rather than "browser-centric" way. + +BrowserVersion = function() { + this.name = navigator.appName; + + if (window.opera != null) + { + this.browser = BrowserVersion.OPERA; + this.isOpera = true; + return; + } + + var self = this; + + var checkChrome = function() { + var loc = window.document.location.href; + try { + loc = window.top.document.location.href; + } catch (e) { + // can't see the top (that means we might be chrome, but it's impossible to be sure) + self.isChromeDetectable = "no, top location couldn't be read in this window"; + } + + if (/^chrome:\/\//.test(loc)) { + self.isChrome = true; + } else { + self.isChrome = false; + } + } + + if (this.name == "Microsoft Internet Explorer") + { + this.browser = BrowserVersion.IE; + this.isIE = true; + if (window.top.SeleniumHTARunner && window.top.document.location.pathname.match(/.hta$/i)) { + this.isHTA = true; + } + if ("0" == navigator.appMinorVersion) { + this.preSV1 = true; + } + return; + } + + if (navigator.userAgent.indexOf('Safari') != -1) + { + this.browser = BrowserVersion.SAFARI; + this.isSafari = true; + this.khtml = true; + return; + } + + if (navigator.userAgent.indexOf('Konqueror') != -1) + { + this.browser = BrowserVersion.KONQUEROR; + this.isKonqueror = true; + this.khtml = true; + return; + } + + if (navigator.userAgent.indexOf('Firefox') != -1) + { + this.browser = BrowserVersion.FIREFOX; + this.isFirefox = true; + this.isGecko = true; + var result = /.*Firefox\/([\d\.]+).*/.exec(navigator.userAgent); + if (result) + { + this.firefoxVersion = result[1]; + } + checkChrome(); + return; + } + + if (navigator.userAgent.indexOf('Gecko') != -1) + { + this.browser = BrowserVersion.MOZILLA; + this.isMozilla = true; + this.isGecko = true; + checkChrome(); + return; + } + + this.browser = BrowserVersion.UNKNOWN; +} + +BrowserVersion.OPERA = "Opera"; +BrowserVersion.IE = "IE"; +BrowserVersion.KONQUEROR = "Konqueror"; +BrowserVersion.SAFARI = "Safari"; +BrowserVersion.FIREFOX = "Firefox"; +BrowserVersion.MOZILLA = "Mozilla"; +BrowserVersion.UNKNOWN = "Unknown"; + +browserVersion = new BrowserVersion(); + diff --git a/tests/test_tools/selenium/core/scripts/selenium-commandhandlers.js b/tests/test_tools/selenium/core/scripts/selenium-commandhandlers.js new file mode 100644 index 00000000..ee01ea76 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-commandhandlers.js @@ -0,0 +1,371 @@ +/* +* 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. +* +*/ +function CommandHandlerFactory() { + this.actions = {}; + this.asserts = {}; + this.accessors = {}; + + var self = this; + + this.registerAction = function(name, action, wait, dontCheckAlertsAndConfirms) { + var handler = new ActionHandler(action, wait, dontCheckAlertsAndConfirms); + this.actions[name] = handler; + }; + + this.registerAccessor = function(name, accessor) { + var handler = new AccessorHandler(accessor); + this.accessors[name] = handler; + }; + + this.registerAssert = function(name, assertion, haltOnFailure) { + var handler = new AssertHandler(assertion, haltOnFailure); + this.asserts[name] = handler; + }; + + this.getCommandHandler = function(name) { + return this.actions[name] || this.accessors[name] || this.asserts[name] || null; + }; + + this.registerAll = function(commandObject) { + registerAllAccessors(commandObject); + registerAllActions(commandObject); + registerAllAsserts(commandObject); + }; + + var registerAllActions = function(commandObject) { + for (var functionName in commandObject) { + var result = /^do([A-Z].+)$/.exec(functionName); + if (result != null) { + var actionName = result[1].lcfirst(); + + // Register the action without the wait flag. + var action = commandObject[functionName]; + self.registerAction(actionName, action, false, action.dontCheckAlertsAndConfirms); + + // Register actionName + "AndWait" with the wait flag; + var waitActionName = actionName + "AndWait"; + self.registerAction(waitActionName, action, true, action.dontCheckAlertsAndConfirms); + } + } + }; + + + var registerAllAsserts = function(commandObject) { + for (var functionName in commandObject) { + var result = /^assert([A-Z].+)$/.exec(functionName); + if (result != null) { + var assert = commandObject[functionName]; + + // Register the assert with the "assert" prefix, and halt on failure. + var assertName = functionName; + self.registerAssert(assertName, assert, true); + + // Register the assert with the "verify" prefix, and do not halt on failure. + var verifyName = "verify" + result[1]; + self.registerAssert(verifyName, assert, false); + } + } + }; + + + // Given an accessor function getBlah(target), + // return a "predicate" equivalient to isBlah(target, value) that + // is true when the value returned by the accessor matches the specified value. + this.createPredicateFromSingleArgAccessor = function(accessor) { + return function(target, value) { + var accessorResult = accessor.call(this, target); + if (PatternMatcher.matches(value, accessorResult)) { + return new PredicateResult(true, "Actual value '" + accessorResult + "' did match '" + value + "'"); + } else { + return new PredicateResult(false, "Actual value '" + accessorResult + "' did not match '" + value + "'"); + } + }; + }; + + // Given a (no-arg) accessor function getBlah(), + // return a "predicate" equivalient to isBlah(value) that + // is true when the value returned by the accessor matches the specified value. + this.createPredicateFromNoArgAccessor = function(accessor) { + return function(value) { + var accessorResult = accessor.call(this); + if (PatternMatcher.matches(value, accessorResult)) { + return new PredicateResult(true, "Actual value '" + accessorResult + "' did match '" + value + "'"); + } else { + return new PredicateResult(false, "Actual value '" + accessorResult + "' did not match '" + value + "'"); + } + }; + }; + + // Given a boolean accessor function isBlah(), + // return a "predicate" equivalient to isBlah() that + // returns an appropriate PredicateResult value. + this.createPredicateFromBooleanAccessor = function(accessor) { + return function() { + var accessorResult; + if (arguments.length > 2) throw new SeleniumError("Too many arguments! " + arguments.length); + if (arguments.length == 2) { + accessorResult = accessor.call(this, arguments[0], arguments[1]); + } else if (arguments.length == 1) { + accessorResult = accessor.call(this, arguments[0]); + } else { + accessorResult = accessor.call(this); + } + if (accessorResult) { + return new PredicateResult(true, "true"); + } else { + return new PredicateResult(false, "false"); + } + }; + }; + + // Given an accessor fuction getBlah([target]) (target is optional) + // return a predicate equivalent to isBlah([target,] value) that + // is true when the value returned by the accessor matches the specified value. + this.createPredicateFromAccessor = function(accessor) { + if (accessor.length == 0) { + return self.createPredicateFromNoArgAccessor(accessor); + } + return self.createPredicateFromSingleArgAccessor(accessor); + }; + + // Given a predicate, return the negation of that predicate. + // Leaves the message unchanged. + // Used to create assertNot, verifyNot, and waitForNot commands. + this.invertPredicate = function(predicate) { + return function(target, value) { + var result = predicate.call(this, target, value); + result.isTrue = ! result.isTrue; + return result; + }; + }; + + // Convert an isBlahBlah(target, value) function into an assertBlahBlah(target, value) function. + this.createAssertionFromPredicate = function(predicate) { + return function(target, value) { + var result = predicate.call(this, target, value); + if (!result.isTrue) { + Assert.fail(result.message); + } + }; + }; + + // Register an assertion, a verification, a negative assertion, + // and a negative verification based on the specified accessor. + this.registerAssertionsBasedOnAccessor = function(accessor, baseName, predicate) { + if (predicate==null) { + predicate = self.createPredicateFromAccessor(accessor); + } + var assertion = self.createAssertionFromPredicate(predicate); + // Register an assert with the "assert" prefix, and halt on failure. + self.registerAssert("assert" + baseName, assertion, true); + // Register a verify with the "verify" prefix, and do not halt on failure. + self.registerAssert("verify" + baseName, assertion, false); + + var invertedPredicate = self.invertPredicate(predicate); + var negativeAssertion = self.createAssertionFromPredicate(invertedPredicate); + + var result = /^(.*)Present$/.exec(baseName); + if (result==null) { + // Register an assertNot with the "assertNot" prefix, and halt on failure. + self.registerAssert("assertNot"+baseName, negativeAssertion, true); + // Register a verifyNot with the "verifyNot" prefix, and do not halt on failure. + self.registerAssert("verifyNot"+baseName, negativeAssertion, false); + } + else { + var invertedBaseName = result[1] + "NotPresent"; + + // Register an assertNot ending w/ "NotPresent", and halt on failure. + self.registerAssert("assert"+invertedBaseName, negativeAssertion, true); + // Register an assertNot ending w/ "NotPresent", and do not halt on failure. + self.registerAssert("verify"+invertedBaseName, negativeAssertion, false); + } + }; + + + // Convert an isBlahBlah(target, value) function into a waitForBlahBlah(target, value) function. + this.createWaitForActionFromPredicate = function(predicate) { + var action = function(target, value) { + var seleniumApi = this; + testLoop.waitForCondition = function () { + try { + return predicate.call(seleniumApi, target, value).isTrue; + } catch (e) { + // Treat exceptions as meaning the condition is not yet met. + // Useful, for example, for waitForValue when the element has + // not even been created yet. + // TODO: possibly should rethrow some types of exception. + return false; + } + }; + }; + return action; + }; + + // Register a waitForBlahBlah and waitForNotBlahBlah based on the specified accessor. + this.registerWaitForCommandsBasedOnAccessor = function(accessor, baseName, predicate) { + if (predicate==null) { + predicate = self.createPredicateFromAccessor(accessor); + } + var waitForAction = self.createWaitForActionFromPredicate(predicate); + self.registerAction("waitFor"+baseName, waitForAction, false, true); + var invertedPredicate = self.invertPredicate(predicate); + var waitForNotAction = self.createWaitForActionFromPredicate(invertedPredicate); + self.registerAction("waitForNot"+baseName, waitForNotAction, false, true); + } + + // Register a storeBlahBlah based on the specified accessor. + this.registerStoreCommandBasedOnAccessor = function(accessor, baseName) { + var action; + if (accessor.length == 1) { + action = function(target, varName) { + storedVars[varName] = accessor.call(this, target); + }; + } else { + action = function(varName) { + storedVars[varName] = accessor.call(this); + }; + } + self.registerAction("store"+baseName, action, false, accessor.dontCheckAlertsAndConfirms); + }; + + // Methods of the form getFoo(target) result in commands: + // getFoo, assertFoo, verifyFoo, assertNotFoo, verifyNotFoo + // storeFoo, waitForFoo, and waitForNotFoo. + var registerAllAccessors = function(commandObject) { + for (var functionName in commandObject) { + var match = /^get([A-Z].+)$/.exec(functionName); + if (match != null) { + var accessor = commandObject[functionName]; + var baseName = match[1]; + self.registerAccessor(functionName, accessor); + self.registerAssertionsBasedOnAccessor(accessor, baseName); + self.registerStoreCommandBasedOnAccessor(accessor, baseName); + self.registerWaitForCommandsBasedOnAccessor(accessor, baseName); + } + var match = /^is([A-Z].+)$/.exec(functionName); + if (match != null) { + var accessor = commandObject[functionName]; + var baseName = match[1]; + var predicate = self.createPredicateFromBooleanAccessor(accessor); + self.registerAccessor(functionName, accessor); + self.registerAssertionsBasedOnAccessor(accessor, baseName, predicate); + self.registerStoreCommandBasedOnAccessor(accessor, baseName); + self.registerWaitForCommandsBasedOnAccessor(accessor, baseName, predicate); + } + } + }; + + +} + +function PredicateResult(isTrue, message) { + this.isTrue = isTrue; + this.message = message; +} + +// NOTE: The CommandHandler is effectively an abstract base for +// various handlers including ActionHandler, AccessorHandler and AssertHandler. +// Subclasses need to implement an execute(seleniumApi, command) function, +// where seleniumApi is the Selenium object, and command a SeleniumCommand object. +function CommandHandler(type, haltOnFailure, executor) { + this.type = type; + this.haltOnFailure = haltOnFailure; + this.executor = executor; +} + +// An ActionHandler is a command handler that executes the sepcified action, +// possibly checking for alerts and confirmations (if checkAlerts is set), and +// possibly waiting for a page load if wait is set. +function ActionHandler(action, wait, dontCheckAlerts) { + CommandHandler.call(this, "action", true, action); + if (wait) { + this.wait = true; + } + // note that dontCheckAlerts could be undefined!!! + this.checkAlerts = (dontCheckAlerts) ? false : true; +} +ActionHandler.prototype = new CommandHandler; +ActionHandler.prototype.execute = function(seleniumApi, command) { + if (this.checkAlerts && (null==/(Alert|Confirmation)(Not)?Present/.exec(command.command))) { + this.checkForAlerts(seleniumApi); + } + var processState = this.executor.call(seleniumApi, command.target, command.value); + // If the handler didn't return a wait flag, check to see if the + // handler was registered with the wait flag. + if (processState == undefined && this.wait) { + processState = SELENIUM_PROCESS_WAIT; + } + return new CommandResult(processState); +}; +ActionHandler.prototype.checkForAlerts = function(seleniumApi) { + if ( seleniumApi.browserbot.hasAlerts() ) { + throw new SeleniumError("There was an unexpected Alert! [" + seleniumApi.browserbot.getNextAlert() + "]"); + } + if ( seleniumApi.browserbot.hasConfirmations() ) { + throw new SeleniumError("There was an unexpected Confirmation! [" + seleniumApi.browserbot.getNextConfirmation() + "]"); + } +}; + +function AccessorHandler(accessor) { + CommandHandler.call(this, "accessor", true, accessor); +} +AccessorHandler.prototype = new CommandHandler; +AccessorHandler.prototype.execute = function(seleniumApi, command) { + var returnValue = this.executor.call(seleniumApi, command.target, command.value); + var result = new CommandResult(); + result.result = returnValue; + return result; +}; + +/** + * Handler for assertions and verifications. + */ +function AssertHandler(assertion, haltOnFailure) { + CommandHandler.call(this, "assert", haltOnFailure || false, assertion); +} +AssertHandler.prototype = new CommandHandler; +AssertHandler.prototype.execute = function(seleniumApi, command) { + var result = new CommandResult(); + try { + this.executor.call(seleniumApi, command.target, command.value); + result.passed = true; + } catch (e) { + // If this is not a AssertionFailedError, or we should haltOnFailure, rethrow. + if (!e.isAssertionFailedError) { + throw e; + } + if (this.haltOnFailure) { + var error = new SeleniumError(e.failureMessage); + throw error; + } + result.failed = true; + result.failureMessage = e.failureMessage; + } + return result; +}; + + +function CommandResult(processState) { + this.processState = processState; + this.result = null; +} + +function SeleniumCommand(command, target, value) { + this.command = command; + this.target = target; + this.value = value; +} diff --git a/tests/test_tools/selenium/core/scripts/selenium-executionloop.js b/tests/test_tools/selenium/core/scripts/selenium-executionloop.js new file mode 100644 index 00000000..14c1a07a --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-executionloop.js @@ -0,0 +1,266 @@ +/* +* 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. +*/ + +SELENIUM_PROCESS_WAIT = "wait"; + +function TestLoop(commandFactory) { + + this.commandFactory = commandFactory; + this.waitForConditionTimeout = 30 * 1000; // 30 seconds + + this.start = function() { + selenium.reset(); + LOG.debug("testLoop.start()"); + this.continueTest(); + }; + + /** + * Select the next command and continue the test. + */ + this.continueTest = function() { + LOG.debug("testLoop.continueTest() - acquire the next command"); + if (! this.aborted) { + this.currentCommand = this.nextCommand(); + } + if (! this.requiresCallBack) { + this.beginNextTest(); + } // otherwise, just finish and let the callback invoke beginNextTest() + }; + + this.beginNextTest = function() { + LOG.debug("testLoop.beginNextTest()"); + if (this.currentCommand) { + // TODO: rename commandStarted to commandSelected, OR roll it into nextCommand + this.commandStarted(this.currentCommand); + this.resumeAfterDelay(); + } else { + this.testComplete(); + } + } + + /** + * Pause, then execute the current command. + */ + this.resumeAfterDelay = function() { + + // Get the command delay. If a pauseInterval is set, use it once + // and reset it. Otherwise, use the defined command-interval. + var delay = this.pauseInterval || this.getCommandInterval(); + this.pauseInterval = undefined; + + if (delay < 0) { + // Pause: enable the "next/continue" button + this.pause(); + } else { + window.setTimeout("testLoop.resume()", delay); + } + }; + + /** + * Select the next command and continue the test. + */ + this.resume = function() { + LOG.debug("testLoop.resume() - actually execute"); + try { + this.executeCurrentCommand(); + this.waitForConditionStart = new Date().getTime(); + this.continueTestWhenConditionIsTrue(); + } catch (e) { + this.handleCommandError(e); + this.testComplete(); + return; + } + }; + + /** + * Execute the current command. + * + * The return value, if not null, should be a function which will be + * used to determine when execution can continue. + */ + this.executeCurrentCommand = function() { + + var command = this.currentCommand; + LOG.info("Executing: |" + command.command + " | " + command.target + " | " + command.value + " |"); + + var handler = this.commandFactory.getCommandHandler(command.command); + if (handler == null) { + throw new SeleniumError("Unknown command: '" + command.command + "'"); + } + + command.target = selenium.preprocessParameter(command.target); + command.value = selenium.preprocessParameter(command.value); + LOG.debug("Command found, going to execute " + command.command); + var result = handler.execute(selenium, command); + LOG.debug("Command complete"); + this.commandComplete(result); + + if (result.processState == SELENIUM_PROCESS_WAIT) { + this.waitForCondition = function() { + LOG.debug("Checking condition: isNewPageLoaded?"); + return selenium.browserbot.isNewPageLoaded(); + }; + } + }; + + this.handleCommandError = function(e) { + if (!e.isSeleniumError) { + LOG.exception(e); + var msg = "Selenium failure. Please report to selenium-dev@openqa.org, with error details from the log window."; + if (e.message) { + msg += " The error message is: " + e.message; + } + this.commandError(msg); + } else { + LOG.error(e.message); + this.commandError(e.message); + } + }; + + /** + * Busy wait for waitForCondition() to become true, and then carry on + * with test. Fail the current test if there's a timeout or an exception. + */ + this.continueTestWhenConditionIsTrue = function () { + LOG.debug("testLoop.continueTestWhenConditionIsTrue()"); + try { + if (this.waitForCondition == null || this.waitForCondition()) { + LOG.debug("condition satisfied; let's continueTest()"); + this.waitForCondition = null; + this.waitForConditionStart = null; + this.continueTest(); + } else { + LOG.debug("waitForCondition was false; keep waiting!"); + if (this.waitForConditionTimeout != null) { + var now = new Date(); + if ((now - this.waitForConditionStart) > this.waitForConditionTimeout) { + throw new SeleniumError("Timed out after " + this.waitForConditionTimeout + "ms"); + } + } + window.setTimeout("testLoop.continueTestWhenConditionIsTrue()", 10); + } + } catch (e) { + var lastResult = new CommandResult(); + lastResult.failed = true; + lastResult.failureMessage = e.message; + this.commandComplete(lastResult); + this.testComplete(); + } + }; + +} + +/** The default is not to have any interval between commands. */ +TestLoop.prototype.getCommandInterval = function() { + return 0; +}; + +TestLoop.prototype.nextCommand = noop; + +TestLoop.prototype.commandStarted = noop; + +TestLoop.prototype.commandError = noop; + +TestLoop.prototype.commandComplete = noop; + +TestLoop.prototype.testComplete = noop; + +TestLoop.prototype.pause = noop; + +function noop() { + +}; + +/** + * Tell Selenium to expect a failure on the next command execution. This + * command temporarily installs a CommandFactory that generates + * CommandHandlers that expect a failure. + */ +Selenium.prototype.assertFailureOnNext = function(message) { + if (!message) { + throw new Error("Message must be provided"); + } + + var expectFailureCommandFactory = + new ExpectFailureCommandFactory(testLoop.commandFactory, message, "failure"); + expectFailureCommandFactory.baseExecutor = executeCommandAndReturnFailureMessage; + testLoop.commandFactory = expectFailureCommandFactory; +}; + +/** + * Tell Selenium to expect an error on the next command execution. This + * command temporarily installs a CommandFactory that generates + * CommandHandlers that expect a failure. + */ +Selenium.prototype.assertErrorOnNext = function(message) { + if (!message) { + throw new Error("Message must be provided"); + } + + var expectFailureCommandFactory = + new ExpectFailureCommandFactory(testLoop.commandFactory, message, "error"); + expectFailureCommandFactory.baseExecutor = executeCommandAndReturnErrorMessage; + testLoop.commandFactory = expectFailureCommandFactory; +}; + +function ExpectFailureCommandFactory(originalCommandFactory, expectedErrorMessage, errorType) { + this.getCommandHandler = function(name) { + var baseHandler = originalCommandFactory.getCommandHandler(name); + var baseExecutor = this.baseExecutor; + var expectFailureCommand = {}; + expectFailureCommand.execute = function() { + var baseFailureMessage = baseExecutor(baseHandler, arguments); + var result = new CommandResult(); + if (!baseFailureMessage) { + result.failed = true; + result.failureMessage = "Expected " + errorType + " did not occur."; + } + else { + if (! PatternMatcher.matches(expectedErrorMessage, baseFailureMessage)) { + result.failed = true; + result.failureMessage = "Expected " + errorType + " message '" + expectedErrorMessage + + "' but was '" + baseFailureMessage + "'"; + } + else { + result.passed = true; + result.result = baseFailureMessage; + } + } + testLoop.commandFactory = originalCommandFactory; + return result; + }; + return expectFailureCommand; + }; +}; + +function executeCommandAndReturnFailureMessage(baseHandler, originalArguments) { + var baseResult = baseHandler.execute.apply(baseHandler, originalArguments); + if (baseResult.passed) { + return null; + } + return baseResult.failureMessage; +}; + +function executeCommandAndReturnErrorMessage(baseHandler, originalArguments) { + try { + baseHandler.execute.apply(baseHandler, originalArguments); + return null; + } + catch (expected) { + return expected.message; + } +}; + diff --git a/tests/test_tools/selenium/core/scripts/selenium-logging.js b/tests/test_tools/selenium/core/scripts/selenium-logging.js new file mode 100644 index 00000000..b0fc67e4 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-logging.js @@ -0,0 +1,112 @@ +/* +* 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. +*/ + +var Logger = function() { + this.logWindow = null; +} +Logger.prototype = { + + setLogLevelThreshold: function(logLevel) { + this.pendingLogLevelThreshold = logLevel; + this.show(); + // + // The following message does not show up in the log -- _unless_ I step along w/ the debugger + // down to the append call. I believe this is because the new log window has not yet loaded, + // and therefore the log msg is discarded; but if I step through the debugger, this changes + // the scheduling so as to load that window and make it ready. + // this.info("Log level programmatically set to " + logLevel + " (presumably by driven-mode test code)"); + }, + + getLogWindow: function() { + if (this.logWindow && this.logWindow.closed) { + this.logWindow = null; + } + if (this.logWindow && this.pendingLogLevelThreshold && this.logWindow.setThresholdLevel) { + this.logWindow.setThresholdLevel(this.pendingLogLevelThreshold); + + // can't just directly log because that action would loop back to this code infinitely + this.pendingInfoMessage = "Log level programmatically set to " + this.pendingLogLevelThreshold + " (presumably by driven-mode test code)"; + + this.pendingLogLevelThreshold = null; // let's only go this way one time + } + + return this.logWindow; + }, + + openLogWindow: function() { + this.logWindow = window.open( + getDocumentBase(document) + "SeleniumLog.html", "SeleniumLog", + "width=600,height=250,bottom=0,right=0,status,scrollbars,resizable" + ); + return this.logWindow; + }, + + show: function() { + if (! this.getLogWindow()) { + this.openLogWindow(); + } + }, + + log: function(message, className) { + var logWindow = this.getLogWindow(); + if (logWindow) { + if (logWindow.append) { + if (this.pendingInfoMessage) { + logWindow.append("info: " + this.pendingInfoMessage, "info"); + this.pendingInfoMessage = null; + } + logWindow.append(className + ": " + message, className); + } + } + }, + + close: function(message) { + if (this.logWindow != null) { + try { + this.logWindow.close(); + } catch (e) { + // swallow exception + // the window is probably closed if we get an exception here + } + this.logWindow = null; + } + }, + + debug: function(message) { + this.log(message, "debug"); + }, + + info: function(message) { + this.log(message, "info"); + }, + + warn: function(message) { + this.log(message, "warn"); + }, + + error: function(message) { + this.log(message, "error"); + }, + + exception: function(exception) { + var msg = "Unexpected Exception: " + describe(exception, ', '); + this.error(msg); + } + +}; + +var LOG = new Logger(); + diff --git a/tests/test_tools/selenium/core/scripts/selenium-seleneserunner.js b/tests/test_tools/selenium/core/scripts/selenium-seleneserunner.js new file mode 100644 index 00000000..041b3bf9 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-seleneserunner.js @@ -0,0 +1,300 @@ +/* +* 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. +* +*/ + +passColor = "#cfffcf"; +failColor = "#ffcfcf"; +errorColor = "#ffffff"; +workingColor = "#DEE7EC"; +doneColor = "#FFFFCC"; + +slowMode = false; + +var cmd1 = document.createElement("div"); +var cmd2 = document.createElement("div"); +var cmd3 = document.createElement("div"); +var cmd4 = document.createElement("div"); + +var postResult = "START"; + +queryString = null; + +function runTest() { + var testAppFrame = document.getElementById('myiframe'); + selenium = Selenium.createForFrame(testAppFrame); + + commandFactory = new CommandHandlerFactory(); + commandFactory.registerAll(selenium); + + testLoop = new TestLoop(commandFactory); + + testLoop.nextCommand = nextCommand; + testLoop.commandStarted = commandStarted; + testLoop.commandComplete = commandComplete; + testLoop.commandError = commandError; + testLoop.requiresCallBack = true; + testLoop.testComplete = function() { + window.status = "Selenium Tests Complete, for this Test" + // Continue checking for new results + testLoop.continueTest(); + postResult = "START"; + }; + + document.getElementById("commandList").appendChild(cmd4); + document.getElementById("commandList").appendChild(cmd3); + document.getElementById("commandList").appendChild(cmd2); + document.getElementById("commandList").appendChild(cmd1); + + var doContinue = getQueryVariable("continue"); + if (doContinue != null) postResult = "OK"; + + testLoop.start(); +} + +function getQueryString() { + if (queryString != null) return queryString; + if (browserVersion.isHTA) { + var args = extractArgs(); + if (args.length < 2) return null; + queryString = args[1]; + return queryString; + } else { + return location.search.substr(1); + } +} + +function extractArgs() { + var str = SeleniumHTARunner.commandLine; + if (str == null || str == "") return new Array(); + var matches = str.match(/(?:"([^"]+)"|(?!"([^"]+)")(\S+))/g); + // We either want non quote stuff ([^"]+) surrounded by quotes + // or we want to look-ahead, see that the next character isn't + // a quoted argument, and then grab all the non-space stuff + // this will return for the line: "foo" bar + // the results "\"foo\"" and "bar" + + // So, let's unquote the quoted arguments: + var args = new Array; + for (var i = 0; i < matches.length; i++) { + args[i] = matches[i]; + args[i] = args[i].replace(/^"(.*)"$/, "$1"); + } + return args; +} + +function getQueryVariable(variable) { + var query = getQueryString(); + if (query == null) return null; + var vars = query.split("&"); + for (var i=0;i " + e[key] + "\n" + } + LOG.error(s); + return null; + } + return null; +} + + function handleHttpResponse() { + if (xmlHttp.readyState == 4) { + if (xmlHttp.status == 200) { + var command = extractCommand(xmlHttp); + testLoop.currentCommand = command; + testLoop.beginNextTest(); + } else { + var s = 'xmlHttp returned: ' + xmlHttp.status + ": " + xmlHttp.statusText; + LOG.error(s); + testLoop.currentCommand = null; + setTimeout("testLoop.beginNextTest();", 2000); + } + + } + } + + +function extractCommand(xmlHttp) { + if (slowMode) { + delay(2000); + } + + var command; + try { + command = xmlHttp.responseText; + } catch (e) { + alert('could not get responseText: ' + e.message); + } + if (command.substr(0,'|testComplete'.length)=='|testComplete') { + return null; + } + + return createCommandFromRequest(command); +} + +function commandStarted(command) { + commandNode = document.createElement("div"); + innerHTML = command.command + '('; + if (command.target != null && command.target != "") { + innerHTML += command.target; + if (command.value != null && command.value != "") { + innerHTML += ', ' + command.value; + } + } + innerHTML += ")"; + commandNode.innerHTML = innerHTML; + commandNode.style.backgroundColor = workingColor; + document.getElementById("commandList").removeChild(cmd1); + document.getElementById("commandList").removeChild(cmd2); + document.getElementById("commandList").removeChild(cmd3); + document.getElementById("commandList").removeChild(cmd4); + cmd4 = cmd3; + cmd3 = cmd2; + cmd2 = cmd1; + cmd1 = commandNode; + document.getElementById("commandList").appendChild(cmd4); + document.getElementById("commandList").appendChild(cmd3); + document.getElementById("commandList").appendChild(cmd2); + document.getElementById("commandList").appendChild(cmd1); +} + +function commandComplete(result) { + if (result.failed) { + if (postResult == "CONTINUATION") { + testLoop.aborted = true; + } + postResult = result.failureMessage; + commandNode.title = result.failureMessage; + commandNode.style.backgroundColor = failColor; + } else if (result.passed) { + postResult = "OK"; + commandNode.style.backgroundColor = passColor; + } else { + if (result.result == null) { + postResult = "OK"; + } else { + postResult = "OK," + result.result; + } + commandNode.style.backgroundColor = doneColor; + } +} + +function commandError(message) { + postResult = "ERROR: " + message; + commandNode.style.backgroundColor = errorColor; + commandNode.title = message; +} + +function slowClicked() { + slowMode = !slowMode; +} + +function delay(millis) { + startMillis = new Date(); + while (true) { + milli = new Date(); + if (milli-startMillis > millis) { + break; + } + } +} + +function getIframeDocument(iframe) { + if (iframe.contentDocument) { + return iframe.contentDocument; + } + else { + return iframe.contentWindow.document; + } +} + +// Parses a URI query string into a SeleniumCommand object +function createCommandFromRequest(commandRequest) { + //decodeURIComponent doesn't strip plus signs + var processed = commandRequest.replace(/\+/g, "%20"); + // strip trailing spaces + var processed = processed.replace(/\s+$/, ""); + var vars = processed.split("&"); + var cmdArgs = new Object(); + for (var i=0;i= 3) { + this.addCommandRow(candidateRows[j]); + } + } + } + }, + + addCommandRow: function(row) { + if (row.cells[2] && row.cells[2].originalHTML) { + row.cells[2].innerHTML = row.cells[2].originalHTML; + } + row.bgColor = ""; + this.commandRows.push(row); + }, + + nextCommand: function() { + if (this.commandRows.length > 0) { + this.currentRow = this.commandRows.shift(); + } else { + this.currentRow = null; + } + return this.currentRow; + } + +}; + +function startTestSuite() { + resetMetrics(); + currentRowInSuite = 0; + runAllTests = true; + suiteFailed = false; + + runNextTest(); +} + +function runNextTest() { + if (!runAllTests) + return; + + suiteTable = getIframeDocument(getSuiteFrame()).getElementsByTagName("table")[0]; + + // Do not change the row color of the first row + if (currentRowInSuite > 0) { + // Provide test-status feedback + if (testFailed) { + setCellColor(suiteTable.rows, currentRowInSuite, 0, failColor); + } else { + setCellColor(suiteTable.rows, currentRowInSuite, 0, passColor); + } + + // Set the results from the previous test run + setResultsData(suiteTable, currentRowInSuite); + } + + currentRowInSuite++; + + // If we are done with all of the tests, set the title bar as pass or fail + if (currentRowInSuite >= suiteTable.rows.length) { + if (suiteFailed) { + setCellColor(suiteTable.rows, 0, 0, failColor); + } else { + setCellColor(suiteTable.rows, 0, 0, passColor); + } + + // If this is an automated run (i.e., build script), then submit + // the test results by posting to a form + if (isAutomatedRun()) + postTestResults(suiteFailed, suiteTable); + } + + else { + // Make the current row blue + setCellColor(suiteTable.rows, currentRowInSuite, 0, workingColor); + + testLink = suiteTable.rows[currentRowInSuite].cells[0].getElementsByTagName("a")[0]; + testLink.focus(); + + var testFrame = getTestFrame(); + addLoadListener(testFrame, startTest); + + selenium.browserbot.setIFrameLocation(testFrame, testLink.href); + } +} + +function setCellColor(tableRows, row, col, colorStr) { + tableRows[row].cells[col].bgColor = colorStr; +} + +// Sets the results from a test into a hidden column on the suite table. So, +// for each tests, the second column is set to the HTML from the test table. +function setResultsData(suiteTable, row) { + // Create a text node of the test table + var resultTable = getIframeDocument(getTestFrame()).body.innerHTML; + if (!resultTable) return; + + var tableNode = suiteTable.ownerDocument.createElement("div"); + tableNode.innerHTML = resultTable; + + var new_column = suiteTable.ownerDocument.createElement("td"); + new_column.appendChild(tableNode); + + // Set the column to be invisible + new_column.style.display = "none"; + + // Add the invisible column + suiteTable.rows[row].appendChild(new_column); +} + +// Post the results to a servlet, CGI-script, etc. The URL of the +// results-handler defaults to "/postResults", but an alternative location +// can be specified by providing a "resultsUrl" query parameter. +// +// Parameters passed to the results-handler are: +// result: passed/failed depending on whether the suite passed or failed +// totalTime: the total running time in seconds for the suite. +// +// numTestPasses: the total number of tests which passed. +// numTestFailures: the total number of tests which failed. +// +// numCommandPasses: the total number of commands which passed. +// numCommandFailures: the total number of commands which failed. +// numCommandErrors: the total number of commands which errored. +// +// suite: the suite table, including the hidden column of test results +// testTable.1 to testTable.N: the individual test tables +// +function postTestResults(suiteFailed, suiteTable) { + + form = document.createElement("form"); + document.body.appendChild(form); + + form.id = "resultsForm"; + form.method="post"; + form.target="myiframe"; + + var resultsUrl = getQueryParameter("resultsUrl"); + if (!resultsUrl) { + resultsUrl = "./postResults"; + } + + var actionAndParameters = resultsUrl.split('?',2); + form.action = actionAndParameters[0]; + var resultsUrlQueryString = actionAndParameters[1]; + + form.createHiddenField = function(name, value) { + input = document.createElement("input"); + input.type = "hidden"; + input.name = name; + input.value = value; + this.appendChild(input); + }; + + if (resultsUrlQueryString) { + var clauses = resultsUrlQueryString.split('&'); + for (var i = 0; i < clauses.length; i++) { + var keyValuePair = clauses[i].split('=',2); + var key = unescape(keyValuePair[0]); + var value = unescape(keyValuePair[1]); + form.createHiddenField(key, value); + } + } + + form.createHiddenField("selenium.version", Selenium.version); + form.createHiddenField("selenium.revision", Selenium.revision); + + form.createHiddenField("result", suiteFailed == true ? "failed" : "passed"); + + form.createHiddenField("totalTime", Math.floor((currentTime - startTime) / 1000)); + form.createHiddenField("numTestPasses", numTestPasses); + form.createHiddenField("numTestFailures", numTestFailures); + form.createHiddenField("numCommandPasses", numCommandPasses); + form.createHiddenField("numCommandFailures", numCommandFailures); + form.createHiddenField("numCommandErrors", numCommandErrors); + + // Create an input for each test table. The inputs are named + // testTable.1, testTable.2, etc. + for (rowNum = 1; rowNum < suiteTable.rows.length;rowNum++) { + // If there is a second column, then add a new input + if (suiteTable.rows[rowNum].cells.length > 1) { + var resultCell = suiteTable.rows[rowNum].cells[1]; + form.createHiddenField("testTable." + rowNum, resultCell.innerHTML); + // remove the resultCell, so it's not included in the suite HTML + resultCell.parentNode.removeChild(resultCell); + } + } + + form.createHiddenField("numTestTotal", rowNum); + + // Add HTML for the suite itself + form.createHiddenField("suite", suiteTable.parentNode.innerHTML); + + if (isQueryParameterTrue("save")) { + saveToFile(resultsUrl, form); + } else { + form.submit(); + } + document.body.removeChild(form); + if (isQueryParameterTrue("close")) { + window.top.close(); + } +} + +function saveToFile(fileName, form) { + // This only works when run as an IE HTA + var inputs = new Object(); + for (var i = 0; i < form.elements.length; i++) { + inputs[form.elements[i].name] = form.elements[i].value; + } + var objFSO = new ActiveXObject("Scripting.FileSystemObject") + var scriptFile = objFSO.CreateTextFile(fileName); + scriptFile.WriteLine("\n

Test suite results

" + + "\n\n\n\n\n\n" + + "\n\n\n\n\n" + + "\n\n\n\n" + + "\n\n\n\n" + + "\n\n\n\n" + + "\n\n\n\n" + + "\n\n\n\n" + + "\n\n\n"); + var testNum = inputs["numTestTotal"]; + for (var rowNum = 1; rowNum < testNum; rowNum++) { + scriptFile.WriteLine("\n\n\n"); + } + scriptFile.WriteLine("
result:" + inputs["result"] + "
totalTime:" + inputs["totalTime"] + "
numTestPasses:" + inputs["numTestPasses"] + "
numTestFailures:" + inputs["numTestFailures"] + "
numCommandPasses:" + inputs["numCommandPasses"] + "
numCommandFailures:" + inputs["numCommandFailures"] + "
numCommandErrors:" + inputs["numCommandErrors"] + "
" + inputs["suite"] + " 
" + inputs["testTable." + rowNum] + " 
"); + scriptFile.Close(); +} + +function printMetrics() { + setText(document.getElementById("commandPasses"), numCommandPasses); + setText(document.getElementById("commandFailures"), numCommandFailures); + setText(document.getElementById("commandErrors"), numCommandErrors); + setText(document.getElementById("testRuns"), numTestPasses + numTestFailures); + setText(document.getElementById("testFailures"), numTestFailures); + + currentTime = new Date().getTime(); + + timeDiff = currentTime - startTime; + totalSecs = Math.floor(timeDiff / 1000); + + minutes = Math.floor(totalSecs / 60); + seconds = totalSecs % 60; + + setText(document.getElementById("elapsedTime"), pad(minutes)+":"+pad(seconds)); +} + +// Puts a leading 0 on num if it is less than 10 +function pad (num) { + return (num > 9) ? num : "0" + num; +} + +/* + * Register all of the built-in command handlers with the CommandHandlerFactory. + * TODO work out an easy way for people to register handlers without modifying the Selenium sources. + */ +function registerCommandHandlers() { + commandFactory = new CommandHandlerFactory(); + commandFactory.registerAll(selenium); + +} + +function initialiseTestLoop() { + testLoop = new TestLoop(commandFactory); + + testLoop.getCommandInterval = function() { return runInterval; }; + testLoop.nextCommand = nextCommand; + testLoop.commandStarted = commandStarted; + testLoop.commandComplete = commandComplete; + testLoop.commandError = commandError; + testLoop.testComplete = testComplete; + testLoop.pause = function() { + document.getElementById('continueTest').disabled = false; + }; + return testLoop; +} + +function nextCommand() { + var row = currentTest.nextCommand(); + if (row == null) { + return null; + } + row.cells[2].originalHTML = row.cells[2].innerHTML; + return new SeleniumCommand(getText(row.cells[0]), + getText(row.cells[1]), + getText(row.cells[2])); +} + +function removeNbsp(value) { + return value.replace(/\240/g, ""); +} + +function scrollIntoView(element) { + if (element.scrollIntoView) { + element.scrollIntoView(false); + return; + } + // TODO: work out how to scroll browsers that don't support + // scrollIntoView (like Konqueror) +} + +function commandStarted() { + currentTest.currentRow.bgColor = workingColor; + scrollIntoView(currentTest.currentRow.cells[0]); + printMetrics(); +} + +function commandComplete(result) { + if (result.failed) { + numCommandFailures += 1; + recordFailure(result.failureMessage); + } else if (result.passed) { + numCommandPasses += 1; + currentTest.currentRow.bgColor = passColor; + } else { + currentTest.currentRow.bgColor = doneColor; + } +} + +function commandError(errorMessage) { + numCommandErrors += 1; + recordFailure(errorMessage); +} + +function recordFailure(errorMsg) { + LOG.warn("recordFailure: " + errorMsg); + // Set cell background to red + currentTest.currentRow.bgColor = failColor; + + // Set error message + currentTest.currentRow.cells[2].innerHTML = errorMsg; + currentTest.currentRow.title = errorMsg; + testFailed = true; + suiteFailed = true; +} + +function testComplete() { + var resultColor = passColor; + if (testFailed) { + resultColor = failColor; + numTestFailures += 1; + } else { + numTestPasses += 1; + } + + if (currentTest.headerRow) { + currentTest.headerRow.bgColor = resultColor; + } + + printMetrics(); + + window.setTimeout("runNextTest()", 1); +} + +Selenium.prototype.doPause = function(waitTime) { + testLoop.pauseInterval = waitTime; +}; + +Selenium.prototype.doPause.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.doBreak = function() { + document.getElementById('modeStep').checked = true; + runInterval = -1; +}; + +/* + * Click on the located element, and attach a callback to notify + * when the page is reloaded. + */ +Selenium.prototype.doModalDialogTest = function(returnValue) { + this.browserbot.doModalDialogTest(returnValue); +}; + +/* + * Store the value of a form input in a variable + */ +Selenium.prototype.doStoreValue = function(target, varName) { + if (!varName) { + // Backward compatibility mode: read the ENTIRE text of the page + // and stores it in a variable with the name of the target + value = this.page().bodyText(); + storedVars[target] = value; + return; + } + var element = this.page().findElement(target); + storedVars[varName] = getInputValue(element); +}; + +/* + * Store the text of an element in a variable + */ +Selenium.prototype.doStoreText = function(target, varName) { + var element = this.page().findElement(target); + storedVars[varName] = getText(element); +}; + +/* + * Store the value of an element attribute in a variable + */ +Selenium.prototype.doStoreAttribute = function(target, varName) { + storedVars[varName] = this.page().findAttribute(target); +}; + +/* + * Store the result of a literal value + */ +Selenium.prototype.doStore = function(value, varName) { + storedVars[varName] = value; +}; + +Selenium.prototype.doEcho = function(msg) { + currentTest.currentRow.cells[2].innerHTML = msg; +} diff --git a/tests/test_tools/selenium/core/scripts/selenium-version.js b/tests/test_tools/selenium/core/scripts/selenium-version.js new file mode 100644 index 00000000..1fee837b --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/selenium-version.js @@ -0,0 +1,5 @@ +Selenium.version = "@VERSION@"; +Selenium.revision = "@REVISION@"; + +window.top.document.title += " v" + Selenium.version + " [" + Selenium.revision + "]"; + diff --git a/tests/test_tools/selenium/core/scripts/user-extensions.js.sample b/tests/test_tools/selenium/core/scripts/user-extensions.js.sample new file mode 100644 index 00000000..0f0ca840 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/user-extensions.js.sample @@ -0,0 +1,75 @@ +/* + * By default, Selenium looks for a file called "user-extensions.js", and loads and javascript + * code found in that file. This file is a sample of what that file could look like. + * + * user-extensions.js provides a convenient location for adding extensions to Selenium, like + * new actions, checks and locator-strategies. + * By default, this file does not exist. Users can create this file and place their extension code + * in this common location, removing the need to modify the Selenium sources, and hopefully assisting + * with the upgrade process. + * + * You can find contributed extensions at http://wiki.openqa.org/display/SEL/Contributed%20User-Extensions + */ + +// The following examples try to give an indication of how Selenium can be extended with javascript. + +// All do* methods on the Selenium prototype are added as actions. +// Eg add a typeRepeated action to Selenium, which types the text twice into a text box. +// The typeTwiceAndWait command will be available automatically +Selenium.prototype.doTypeRepeated = function(locator, text) { + // All locator-strategies are automatically handled by "findElement" + var element = this.page().findElement(locator); + + // Create the text to type + var valueToType = text + text; + + // Replace the element text with the new text + this.page().replaceText(element, valueToType); +}; + +// All assert* methods on the Selenium prototype are added as checks. +// Eg add a assertValueRepeated check, that makes sure that the element value +// consists of the supplied text repeated. +// The verify version will be available automatically. +Selenium.prototype.assertValueRepeated = function(locator, text) { + // All locator-strategies are automatically handled by "findElement" + var element = this.page().findElement(locator); + + // Create the text to verify + var expectedValue = text + text; + + // Get the actual element value + var actualValue = element.value; + + // Make sure the actual value matches the expected + Assert.matches(expectedValue, actualValue); +}; + +// All get* methods on the Selenium prototype result in +// store, assert, assertNot, verify, verifyNot, waitFor, and waitForNot commands. +// E.g. add a getTextLength method that returns the length of the text +// of a specified element. +// Will result in support for storeTextLength, assertTextLength, etc. +Selenium.prototype.getTextLength = function(locator) { + return this.getText(locator).length; +}; + +// All locateElementBy* methods are added as locator-strategies. +// Eg add a "valuerepeated=" locator, that finds the first element with the supplied value, repeated. +// The "inDocument" is a the document you are searching. +PageBot.prototype.locateElementByValueRepeated = function(text, inDocument) { + // Create the text to search for + var expectedValue = text + text; + + // Loop through all elements, looking for ones that have a value === our expected value + var allElements = inDocument.getElementsByTagName("*"); + for (var i = 0; i < allElements.length; i++) { + var testElement = allElements[i]; + if (testElement.value && testElement.value === expectedValue) { + return testElement; + } + } + return null; +}; + + diff --git a/tests/test_tools/selenium/core/scripts/xmlextras.js b/tests/test_tools/selenium/core/scripts/xmlextras.js new file mode 100644 index 00000000..267aa058 --- /dev/null +++ b/tests/test_tools/selenium/core/scripts/xmlextras.js @@ -0,0 +1,153 @@ +// This is a third party JavaScript library from +// http://webfx.eae.net/dhtml/xmlextras/xmlextras.html +// i.e. This has not been written by ThoughtWorks. + +// + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+

Selenium

+
+ +
+ Execute Tests + +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Elapsed:00.00
TestsCommands
0run0passed
0failed0failed
0incomplete
+ +
+
+ + + \ No newline at end of file diff --git a/tests/test_tools/selenium/php/results.php b/tests/test_tools/selenium/php/results.php new file mode 100644 index 00000000..77dab43b --- /dev/null +++ b/tests/test_tools/selenium/php/results.php @@ -0,0 +1,160 @@ +parse_data(); + $this->browser = $_SERVER['HTTP_USER_AGENT']; + $this->date = time(); + } + + protected function parse_data() + { + $this->result = $_POST['result']; // failed || passed + $this->totalTime = $_POST['totalTime']; + $this->numTestPasses = $_POST['numTestPasses']; + $this->numTestFailures = $_POST['numTestFailures']; + $this->numCommandPasses = $_POST['numCommandPasses']; + $this->numCommandFailures = $_POST['numCommandFailures']; + $this->numCommandErrors = $_POST['numCommandErrors']; + + foreach($_POST['tests'] as $test) + { + $case = new SeleniumTestCaseResult(); + $case->name = $test['testcase']; + $case->commands = $test['commands']; + for($i = 0; $i < count($case->commands); $i++) + { + //$trace = $case->commands[$i]['trace']; + //$trace = html_entity_decode($trace); + //$case->commands[$i]['trace'] = @unserialize($trace); + if($case->commands[$i]['result'] == 'failed') + { + $case->result = 'failed'; + array_push($case->failures, $case->commands[$i]); + } + } + + $this->suites[$case->name] = $case; + } + + } +} + +class SeleniumHtmlReporter +{ + protected $test; + + public function __construct($result) + { + $this->test = $result; + } + + protected function renderHeader() + { + $contents = << + +Functional Test Results + + + + +EOD; + return $contents; + } + + public function render() + { + echo $this->renderHeader(); + echo $this->renderBody(); + echo $this->renderFooter(); + } + + protected function renderBody() + { + /* SeleniumTestResult */ + $test = $this->test; + $total = count($test->suites); + $date = @strftime('%Y-%m-%d %H:%M',$test->date); +$contents = <<Functional Test Results +
+ {$total} test cases completed, + {$test->numTestPasses} passes + ({$test->numCommandPasses} commands), and + {$test->numTestFailures} fails + ({$test->numCommandErrors} commands). +
+
+ {$date}, {$test->browser} +
+EOD; + $count = 1; + foreach($test->suites as $suite) + { + foreach($suite->failures as $error) + $contents .= $this->getErrorMsg($suite, $error, $count++); + } + + return $contents; + } + + + protected function getErrorMsg($suite, $info, $count) + { + $parity = $count%2==0 ? 'even' : 'odd'; + $command = explode("|",$info['command']); +$msg = << + #{$count}. + "{$info['msg']}" in + + {$suite->name}::{$command[1]}('{$command[2]}'); + + +EOD; + + return $msg; + } + + protected function renderFooter() + { + return ""; + } +} + + +?> \ No newline at end of file diff --git a/tests/test_tools/selenium/php/selenium.php b/tests/test_tools/selenium/php/selenium.php new file mode 100644 index 00000000..9ad4955b --- /dev/null +++ b/tests/test_tools/selenium/php/selenium.php @@ -0,0 +1,477 @@ + + * @version $Revision: 1.66 $ $Date: Wed Nov 02 10:13:17 EST 2005 10:13:17 $ + * @package Prado.tests + */ + +/** + * Selenium automatic client runner, + * + * @author Wei Zhuo + * @version $Revision: 1.66 $ $Date: Fri Nov 04 13:20:12 EST 2005 13:20:12 $ + * @package Prado.tests + */ + +require_once(dirname(__FILE__).'/results.php'); + +class SeleniumTestRunner +{ + protected $driver; + protected $base_dir = ''; + + public function __construct($driver=null, $base_dir='../javascript/') + { + if(is_null($driver) && !(php_sapi_name() == 'cli')) + $driver = $_SERVER['SCRIPT_NAME']; + $this->driver = $driver; + $this->base_dir = $base_dir; + } + + public function render() + { + if((php_sapi_name() == 'cli')) return; + $file = dirname(__FILE__).'/TestRunner.php'; + $driver = $this->driver; + + //$base_dir = $this->base_dir; + $base_dir = $driver.'?sr='; + include($file); + } + + public function getDriver() + { + return $this->driver; + } +} + +class SeleniumTestStorage +{ + protected $outputs = array(); + protected $tests = array(); + + public function getTests() + { + return $this->tests; + } + + public function addCommand($test_case_id, $command) + { + $data = array($test_case_id, $command); + array_push($this->outputs, $data); + } + + public function getCommand() + { + return array_shift($this->outputs); + } + + public function addTestCase($command, $trace_details, $test_name, $test_suite) + { + $data = array(0, 0, $command, "", $trace_details, $test_name, $test_suite); + array_push($this->tests, $data); + } +} + +class SeleneseInterpreter +{ + protected $storage; + protected $tracer; + + public function __construct($storage, $tracer) + { + $this->storage = $storage; + $this->tracer = $tracer; + } + + public function getTests() + { + return $this->storage->getTests(); + } + + public function getCommand() + { + $command = $this->storage->getCommand(); + return empty($command) ? "|testComplete|||" : "{$command[1]}<{$command[0]}>"; + } + + public function __call($func, $args) + { + if($func{0} == '_') return; + + $ID = isset($args[0]) ? $args[0] : ""; + $value = isset($args[1]) ? $args[1] : ""; + if(strpos(strtolower($func),'htmlpresent') || strpos(strtolower($func),'htmlnotpresent')) + $ID = htmlspecialchars($ID); + $command = array($func, $ID, $value); + $trace = debug_backtrace(); + + if(is_int(strpos(strtolower($func), 'visible'))) + $this->addCommand(array('pause','500',''),$trace); + + return $this->addCommand($command, $trace); + } + + protected function addCommand($command, $trace) + { + list($trace, $test, $suite) = $this->tracer->getTrace($trace); + $test_id = $this->storage->addTestCase($command, $trace, $test, $suite); + $this->storage->addCommand($test_id, $command); + } +} + +class SeleniumTestTrace +{ + protected $root; + + public function __construct($root) + { + $this->root = $root; + } + + public function getTrace($trace) + { + $group = array_pop($trace); + $info = $trace[3]; + $test = $group['args'][0]->getTestList(); + $i = count($test); + $name = $test[$i-2].'::'.$test[$i-1]; + $suite = $test[0]; + unset($info['object']); + /* + for($i = 0; $i < count($info['args']); $i++) + { + if($info['args'][$i] instanceof TControl) + $info['args'][$i] = $info['args'][$i]->ClientID; + }*/ + $file = str_replace($this->root, '', $info['file']); + $info['file'] = substr($file, 1); + return array($info, $name, $suite); + } +} + +class SimpleSeleniumProxyServer +{ + protected $runner; + protected $int; + protected $result_file; + + public function __construct($runner, $int, $result_file) + { + $this->int = $int; + $this->runner = $runner; + $this->result_file = $result_file; + } + + public function proxy() + { + return $this->int; + } + + + public static function getInstance($root='/', $result_file='results.dat', $base_dir='selenium/') + { + static $instance; + if(!isset($instance)) + { + $storage = new SeleniumTestStorage(); + $tracer = new SeleniumTestTrace($root); + $interpreter = new SeleneseInterpreter($storage, $tracer); + $runner = new SeleniumTestRunner(null, $base_dir); + $instance = new SimpleSeleniumProxyServer($runner, $interpreter, $result_file); + } + $instance->serveResults(); + return $instance; + } + + public function handleRequest() + { + $client = new SeleniumTestRunnerServer($this->int, $this->runner); + $client->serve(); + return true; + } + + public function serveResults() + { + if(isset($_POST['result'])) + { + $result = new SeleniumTestResult(); + $reporter = new SeleniumHtmlReporter($result); + $reporter->render(); + exit(); + } + } + +} + +class SeleniumTestSuiteWriter +{ + protected $suites; + protected $name; + protected $runner; + + function __construct($suites, $name, $runner) + { + $this->suites = $suites; + $this->name = $name; + $this->runner = $runner; + + } + + protected function renderHeader() + { + $contents = << + + +Test Suite + + + + + + + + +EOD; + return $contents; + } + + public function render() + { + echo $this->renderHeader(); + foreach($this->suites as $name => $suite) + { + $file = $suite[0]['trace']['file']; + $file = strtr($file,'\\','/'); + $url = $this->runner->getDriver()."?case={$name}&file={$file}"; + echo "\n"; + echo "\n"; + echo "\n"; + } + echo $this->renderFooter(); + } + + protected function getJsTraceInfo() + { + $contents = "var prado_trace = {};\n"; + foreach($this->suites as $name => $suite) + { + $name = $name; + $contents .= "prado_trace['{$name}'] = ["; + $cases = array(); + foreach($suite as $testcase) + $cases[] = "'".addslashes(htmlspecialchars(serialize($testcase['trace'])))."'"; + $contents .= implode(",\n", $cases)."];\n\n"; + } + return $contents; + } + + protected function renderFooter() + { + $trace = '';//$this->getJsTraceInfo(); + $contents = << +
{$this->name}
{$name}
+ + + +EOD; + return $contents; + } +} + +class SeleniumTestCaseWriter +{ + protected $case; + protected $tests; + + function __construct($case, $tests) + { + $this->case = $case; + $this->tests = $tests; + } + + protected function renderHeader() + { + $contents = << + + +{$this->case} + + + + + + + + +EOD; + return $contents; + } + + public function render() + { + echo $this->renderHeader(); + foreach($this->tests as $test) + { + $t = $test['test']; + if($t[0] == "open") + $t[1] = "{$t[1]}"; + echo "\n"; + echo "\n"; + echo "\n"; + echo "\n"; + echo "\n"; + } + echo $this->renderFooter(); + } + + protected function renderFooter() + { + $contents = << +
{$this->case}
{$t[0]}{$t[1]}{$t[2]}
+ + +EOD; + return $contents; + } +} + +class SeleniumTestRunnerServer +{ + protected $cases = array(); + protected $trace = array(); + protected $name; + protected $runner; + + public function __construct($int, $runner) + { + $this->runner = $runner; + $this->initialize($int); + } + + protected function initialize($int) + { + foreach($int->getTests() as $command) + { + $case = $command[5]; + $this->cases[$case][] = + array('test' => $command[2], 'trace' => $command[4]); + if(is_null($this->name)) + $this->name = $command[6]; + } + } + + function serve() + { + if($this->isTestSuiteRequest()) + { + $testSuite = new SeleniumTestSuiteWriter($this->cases, + $this->name, $this->runner); + $testSuite->render(); + } + else if($this->isTestCaseRequest()) + { + if(($case = $this->getTestCaseRequest()) !== false) + { + + $testCase = new SeleniumTestCaseWriter($case, $this->getTestCase()); + $testCase->render(); + } + } + else + { + $this->runner->render(); + } + } + + protected function isTestSuiteRequest() + { + return isset($_GET['testSuites']); + } + + protected function isTestCaseRequest() + { + return isset($_GET['case']); + } + + public function isClientRequest() + { + return !$this->isTestSuiteRequest() && !$this->isTestCaseRequest(); + } + + protected function getTestCaseRequest() + { + $case = $_GET['case']; + if(isset($this->cases[$case])) + return $case; + else return false; + } + + protected function getTestCase() + { + $case = $_GET['case']; + if(isset($this->cases[$case])) + return $this->cases[$case]; + else + return array(); + } +} + + +class SeleniumTestCase extends UnitTestCase +{ + protected $selenium; + protected $Page; + + function __construct() + { + $server = SimpleSeleniumProxyServer::getInstance(); + if(!is_null($server)) + $this->selenium = $server->proxy(); + parent::__construct(); + } + + function getPage($class) + { + $info = new ReflectionClass($class); + return Prado::getApplication()->getTestPage($info->getFileName()); + } + + function __call($func, $args) + { + if(count($args) == 0) + return $this->selenium->{$func}(); + else if (count($args) == 1) + return $this->selenium->{$func}($args[0]); + else if (count($args) == 2) + return $this->selenium->{$func}($args[0], $args[1]); + } +} + +?> \ No newline at end of file diff --git a/tests/test_tools/selenium/prado-functional-test.js b/tests/test_tools/selenium/prado-functional-test.js new file mode 100644 index 00000000..306f6a74 --- /dev/null +++ b/tests/test_tools/selenium/prado-functional-test.js @@ -0,0 +1,247 @@ + +/** + * Override selenium implementation. + */ +Selenium.prototype.getAttribute = function(target) { + return this.page().findAttribute(target); +}; + + +/** + * Override selenium implementation. + */ +Selenium.prototype.isVisible = function(locator) { + var element; + element = this.page().findElement(locator); + + if(/Konqueror|Safari|KHTML/.test(navigator.userAgent)) + var visibility = element.style["visibility"]; + else + var visibility = this.findEffectiveStyleProperty(element, "visibility"); + + var _isDisplayed = this._isDisplayed(element); + return (visibility != "hidden" && _isDisplayed); +}; + + +/** + * Override selenium implementation. + */ +Selenium.prototype._isDisplayed = function(element) { + if(/Konqueror|Safari|KHTML/.test(navigator.userAgent)) + var display = element.style["display"]; + else + var display = this.findEffectiveStyleProperty(element, "display"); + if (display == "none") return false; + if (element.parentNode.style) { + return this._isDisplayed(element.parentNode); + } + return true; +}; + +Selenium.prototype.assertEmptySelection = function(selectLocator, optionLocator) +{ + /** + * Verifies that the selected option of a drop-down satisfies the optionSpecifier. + * + *

See the select command for more information about option locators.

+ * + * @param selectLocator an element locator identifying a drop-down menu + * @param optionLocator an option locator, typically just an option label (e.g. "John Smith") + */ + var element = this.page().findElement(selectLocator); + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + return element.selectedIndex == -1; +} + +function runNextTest() { + if (!runAllTests) + return; + + suiteTable = getIframeDocument(getSuiteFrame()).getElementsByTagName("table")[0]; + + // Do not change the row color of the first row + if (currentRowInSuite > 0) { + // Provide test-status feedback + if (testFailed) { + setCellColor(suiteTable.rows, currentRowInSuite, 0, failColor); + } else { + setCellColor(suiteTable.rows, currentRowInSuite, 0, passColor); + } + + // Set the results from the previous test run + setResultsData(suiteTable, currentRowInSuite); + } + + currentRowInSuite++; + + // If we are done with all of the tests, set the title bar as pass or fail + if (currentRowInSuite >= suiteTable.rows.length) { + if (suiteFailed) { + setCellColor(suiteTable.rows, 0, 0, failColor); + } else { + setCellColor(suiteTable.rows, 0, 0, passColor); + } + + LOG.warn("next? ", "warn"); + // If this is an automated run (i.e., build script), then submit + // the test results by posting to a form + + postTestResults(suiteFailed, suiteTable); + } + + else { + // Make the current row blue + setCellColor(suiteTable.rows, currentRowInSuite, 0, workingColor); + + testLink = suiteTable.rows[currentRowInSuite].cells[0].getElementsByTagName("a")[0]; + testLink.focus(); + + var testFrame = getTestFrame(); + addLoadListener(testFrame, startTest); + + selenium.browserbot.setIFrameLocation(testFrame, testLink.href); + } +} + +// Post the results to a servlet, CGI-script, etc. The URL of the +// results-handler defaults to "/postResults", but an alternative location +// can be specified by providing a "resultsUrl" query parameter. +// +// Parameters passed to the results-handler are: +// result: passed/failed depending on whether the suite passed or failed +// totalTime: the total running time in seconds for the suite. +// +// numTestPasses: the total number of tests which passed. +// numTestFailures: the total number of tests which failed. +// +// numCommandPasses: the total number of commands which passed. +// numCommandFailures: the total number of commands which failed. +// numCommandErrors: the total number of commands which errored. +// +// suite: the suite table, including the hidden column of test results +// testTable.1 to testTable.N: the individual test tables +// +function postTestResults(suiteFailed, suiteTable) { + + form = document.createElement("form"); + document.body.appendChild(form); + + form.id = "resultsForm"; + form.method="post"; + form.target="myiframe"; + + var resultsUrl = post_results_to; + if (!resultsUrl) { + resultsUrl = "./results.php"; + } + + var actionAndParameters = resultsUrl.split('?',2); + form.action = actionAndParameters[0]; + LOG.warn(form.action) + var resultsUrlQueryString = actionAndParameters[1]; + + form.createHiddenField = function(name, value) { + input = document.createElement("input"); + input.type = "hidden"; + input.name = name; + input.value = value; + this.appendChild(input); + }; + + if (resultsUrlQueryString) { + var clauses = resultsUrlQueryString.split('&'); + for (var i = 0; i < clauses.length; i++) { + var keyValuePair = clauses[i].split('=',2); + var key = unescape(keyValuePair[0]); + var value = unescape(keyValuePair[1]); + form.createHiddenField(key, value); + } + } + + form.createHiddenField("result", suiteFailed == true ? "failed" : "passed"); + + form.createHiddenField("totalTime", Math.floor((currentTime - startTime) / 1000)); + form.createHiddenField("numTestPasses", numTestPasses); + form.createHiddenField("numTestFailures", numTestFailures); + form.createHiddenField("numCommandPasses", numCommandPasses); + form.createHiddenField("numCommandFailures", numCommandFailures); + form.createHiddenField("numCommandErrors", numCommandErrors); + + // Create an input for each test table. The inputs are named + // testTable.1, testTable.2, etc. + for (rowNum = 1; rowNum < suiteTable.rows.length;rowNum++) { + // If there is a second column, then add a new input + if (suiteTable.rows[rowNum].cells.length > 1) { + var resultCell = suiteTable.rows[rowNum].cells[1]; + parse_resultCell(resultCell,rowNum,form); + //form.createHiddenField("tests[]", resultCell.innerHTML); + // remove the resultCell, so it's not included in the suite HTML + //resultCell.parentNode.removeChild(resultCell); + } + } + + // Add HTML for the suite itself + //form.createHiddenField("suite", suiteTable.parentNode.innerHTML); + + form.submit(); + document.body.removeChild(form); +} + +function parse_resultCell(resultCell,rowNum,form) +{ + var div = resultCell.childNodes[0]; + var table; + for(var i = 0; i= 0) + return; + Assert.fail("Unable to find '"+(expectedValue.replace(//g, ">").replace(/"/g, "\""))+"' in document.body"); +}; + +Selenium.prototype.assertHTMLNotPresent = function(expectedValue) { + var actualValue = this.page().currentDocument.body.innerHTML; + if(actualValue.indexOf(expectedValue) < 0) + return; + Assert.fail("'"+(expectedValue.replace(//g, ">").replace(/"/g, "\""))+"' was found in document.body"); +}; \ No newline at end of file diff --git a/tests/test_tools/simpletest/CHANGELOG b/tests/test_tools/simpletest/CHANGELOG new file mode 100755 index 00000000..961ce208 --- /dev/null +++ b/tests/test_tools/simpletest/CHANGELOG @@ -0,0 +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) {'. +- added HtmlReporterWithCoverage.php \ No newline at end of file diff --git a/tests/test_tools/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE b/tests/test_tools/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE new file mode 100755 index 00000000..99c3be2d --- /dev/null +++ b/tests/test_tools/simpletest/HELP_MY_TESTS_DONT_WORK_ANYMORE @@ -0,0 +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. diff --git a/tests/test_tools/simpletest/HtmlReporterWithCoverage.php b/tests/test_tools/simpletest/HtmlReporterWithCoverage.php new file mode 100644 index 00000000..abd10076 --- /dev/null +++ b/tests/test_tools/simpletest/HtmlReporterWithCoverage.php @@ -0,0 +1,268 @@ +painter = $painter; + $this->base_dir = $base_dir; + } + + function paintHeader($test_name, $charset="UTF-8") + { + $this->sendNoCacheHeaders(); + header('Content-Type: text/html; Charset='.$charset); + print "\n\n$test_name\n"; + print ""; + print "\n"; + print "\n\n"; + print "

$test_name

\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 "
"; + print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount(); + print " test cases complete:\n"; + print "" . $this->getPassCount() . " passes, "; + print "" . $this->getFailCount() . " fails and "; + print "" . $this->getExceptionCount() . " exceptions."; + print "
\n"; + $this->paintCoverage(); + print "\n\n"; + } + + function paintCoverage() + { + $dir = dirname(__FILE__); + if(count($this->coverage) > 0) + print '

Code Coverage

'; + + + 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 "
"; + print ""; + print ""; + print "$executed/$total\n"; + print "$percentage%\n"; + print "{$filename}\n"; + print "
\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 "
$num $line
\n"; + else + echo "$num $line
\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 "\n\nCode Coverage: $file\n"; + print ""; + print "\n"; + print "\n\n"; + print "

Code Coverage

\n"; + print "
$file
"; + print "
    Total code lines: {$total}
Total lines executed: {$executed} ({$percentage}%)
"; + flush(); + } + + function paintFooter($test_name) + { + print "\n\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/test_tools/simpletest/LICENSE b/tests/test_tools/simpletest/LICENSE new file mode 100755 index 00000000..93acab79 --- /dev/null +++ b/tests/test_tools/simpletest/LICENSE @@ -0,0 +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 diff --git a/tests/test_tools/simpletest/README b/tests/test_tools/simpletest/README new file mode 100755 index 00000000..50fa4aaa --- /dev/null +++ b/tests/test_tools/simpletest/README @@ -0,0 +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 diff --git a/tests/test_tools/simpletest/VERSION b/tests/test_tools/simpletest/VERSION new file mode 100755 index 00000000..d3827e75 --- /dev/null +++ b/tests/test_tools/simpletest/VERSION @@ -0,0 +1 @@ +1.0 diff --git a/tests/test_tools/simpletest/authentication.php b/tests/test_tools/simpletest/authentication.php new file mode 100644 index 00000000..7b6ed4ba --- /dev/null +++ b/tests/test_tools/simpletest/authentication.php @@ -0,0 +1,219 @@ +_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/test_tools/simpletest/browser.php b/tests/test_tools/simpletest/browser.php new file mode 100644 index 00000000..06e1b8d7 --- /dev/null +++ b/tests/test_tools/simpletest/browser.php @@ -0,0 +1,1016 @@ +_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/test_tools/simpletest/docs/en/authentication_documentation.html b/tests/test_tools/simpletest/docs/en/authentication_documentation.html new file mode 100755 index 00000000..0623023c --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/authentication_documentation.html @@ -0,0 +1,320 @@ + + + +SimpleTest documentation for testing log-in and authentication + + + + +

Authentication documentation

+
+ +

+ 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. +

+ +

+ +

Basic HTTP authentication

+ +

+

+ 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... +

+class AuthenticationTest extends WebTestCase {
+    function test401Header() {
+        $this->get('http://www.lastcraft.com/protected/');
+        $this->showHeaders();
+    }
+}
+
+ This allows us to see the challenge header... +
+

File test

+
+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
+
+
1/1 test cases complete. + 0 passes, 0 fails and 0 exceptions.
+
+ 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... +
+class AuthenticationTest extends WebTestCase {
+    function test401Header() {
+        $this->get('http://www.lastcraft.com/protected/');
+        $this->assertAuthentication('Basic');
+        $this->assertResponse(401);
+        $this->assertRealm('SimpleTest basic authentication');
+    }
+}
+
+ Any one of these tests would normally do on it's own depending + on the amount of detail you want to see. +

+

+ 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... +

+class AuthenticationTest extends WebTestCase {
+    function testAuthentication() {
+        $this->get('http://www.lastcraft.com/protected/');
+        $this->authenticate('Me', 'Secret');
+        $this->assertTitle(...);
+    }
+}
+
+ 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. +

+

+ You can shortcut this step further by encoding the log in + details straight into the URL... +

+class AuthenticationTest extends WebTestCase {
+    function testCanReadAuthenticatedPages() {
+        $this->get('http://Me:Secret@www.lastcraft.com/protected/');
+        $this->assertTitle(...);
+    }
+}
+
+ 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. +

+

+ 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. +

+ +

+ +

Cookies

+ +

+

+ 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. +

+

+ Starting with a simple log-in form... +

+<form>
+    Username:
+    <input type="text" name="u" value="" /><br />
+    Password:
+    <input type="password" name="p" value="" /><br />
+    <input type="submit" value="Log in" />
+</form>
+
+ Which looks like... +

+

+

+ Username: + +
+ Password: + +
+ +
+

+

+ 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... +

+class LogInTest extends WebTestCase {
+    function testSessionCookieSetBeforeForm() {
+        $this->get('http://www.my-site.com/login.php');
+        $this->assertCookie('SID');
+    }
+}
+
+ 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. +

+

+ 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... +

+class LogInTest extends WebTestCase {
+    ...
+    function testSessionCookieSameAfterLogIn() {
+        $this->get('http://www.my-site.com/login.php');
+        $session = $this->getCookie('SID');
+        $this->setField('u', 'Me');
+        $this->setField('p', 'Secret');
+        $this->clickSubmit('Log in');
+        $this->assertWantedPattern('/Welcome Me/');
+        $this->assertCookie('SID', $session);
+    }
+}
+
+ This confirms that the session identifier is maintained + afer log-in. +

+

+ We could even attempt to spoof our own system by setting + arbitrary cookies to gain access... +

+class LogInTest extends WebTestCase {
+    ...
+    function testSessionCookieSameAfterLogIn() {
+        $this->get('http://www.my-site.com/login.php');
+        $this->setCookie('SID', 'Some other session');
+        $this->get('http://www.my-site.com/restricted.php');
+        $this->assertWantedPattern('/Access denied/');
+    }
+}
+
+ Is your site protected from this attack? +

+ +

+ +

Browser sessions

+ +

+

+ 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... +

+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/');
+        
+        $this->restart();
+        $this->get('http://www.my-site.com/restricted.php');
+        $this->assertWantedPattern('/Access denied/');
+    }
+}
+
+ The WebTestCase::restart() 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. +

+

+ 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. +

+

+ To push the cookies over the hour limit you can age them + before you restart the session... +

+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/');
+        
+        $this->ageCookies(3600);
+        $this->restart();
+        $this->get('http://www.my-site.com/restricted.php');
+        $this->assertWantedPattern('/Access denied/');
+    }
+}
+
+ After the restart it will appear that cookies are an + hour older and any that pass their expiry will have + disappeared. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/browser_documentation.html b/tests/test_tools/simpletest/docs/en/browser_documentation.html new file mode 100755 index 00000000..ef54aaea --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/browser_documentation.html @@ -0,0 +1,386 @@ + + + +SimpleTest documentation for the scriptable web browser component + + + + +

PHP Scriptable Web Browser

+
+ +

+ SimpleTest's web browser component can be used not just + outside of the WebTestCase class, but also + independently of the SimpleTest framework itself. +

+ +

+ +

The Scriptable Browser

+ +

+

+ 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 PHP web site... +

+<?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];
+?>
+
+ There are simpler methods to do this particular example in PHP + of course. + For example you can just use the PHP file() + 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. +

+

+ All of the navigation methods used in the + WebTestCase + are present in the SimpleBrowser class, but + the assertions are replaced with simpler accessors. + Here is a full list of the page navigation methods... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
addHeader($header)Adds a header to every fetch
useProxy($proxy, $username, $password)Use this proxy from now on
head($url, $parameters)Perform a HEAD request
get($url, $parameters)Fetch a page with GET
post($url, $parameters)Fetch a page with POST
clickLink($label)Follows a link by label
isLink($label)See if a link is present by label
clickLinkById($id)Follows a link by attribute
isLinkById($id)See if a link is present by attribut
getUrl()Current URL of page or frame
getTitle()Page title
getContent()Raw page or frame
getContentAsText()HTML removed except for alt text
retry()Repeat the last request
back()Use the browser back button
forward()Use the browser forward button
authenticate($username, $password)Retry page or frame after a 401 response
restart($date)Restarts the browser for a new session
ageCookies($interval)Ages the cookies by the specified time
setCookie($name, $value)Sets an additional cookie
getCookieValue($host, $path, $name)Reads the most specific cookie
getCurrentCookieValue($name)Reads cookie for the current context
+ The methods SimpleBrowser::useProxy() and + SimpleBrowser::addHeader() are special. + Once called they continue to apply to all subsequent fetches. +

+

+ Navigating forms is similar to the + WebTestCase form navigation... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setField($name, $value)Sets all form fields with that name
setFieldById($id, $value)Sets all form fields with that id
getField($name)Accessor for a form element value
getFieldById($id)Accessor for a form element value
clickSubmit($label)Submits form by button label
clickSubmitByName($name)Submits form by button attribute
clickSubmitById($id)Submits form by button attribute
clickImage($label, $x, $y)Clicks the image by alt text
clickImageByName($name, $x, $y)Clicks the image by attribute
clickImageById($id, $x, $y)Clicks the image by attribute
submitFormById($id)Submits by the form tag attribute
+ At the moment there aren't any methods to list available forms + and fields. + This will probably be added to later versions of SimpleTest. +

+

+ 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. + + + + + + + + + + + + + + + + + + +
getFrames()A dump of the current frame structure
getFrameFocus()Current frame label or index
setFrameFocusByIndex($choice)Select a frame numbered from 1
setFrameFocus($name)Select frame by label
clearFrameFocus()Treat all the frames as a single page
+ When focused on a single frame, the content will come from + that frame only. + This includes links to click and forms to submit. +

+ +

+ +

What went wrong?

+ +

+

+ 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... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setConnectionTimeout($timeout)Close the socket on overrun
getRequest()Raw request header of page or frame
getHeaders()Raw response header of page or frame
getTransportError()Any socket level errors in the last fetch
getResponseCode()HTTP response of page or frame
getMimeType()Mime type of page or frame
getAuthentication()Authentication type in 401 challenge header
getRealm()Authentication realm in 401 challenge header
setMaximumRedirects($max)Number of redirects before page is loaded anyway
setMaximumNestedFrames($max)Protection against recursive framesets
ignoreFrames()Disables frames support
useFrames()Enables frames support
+ The methods SimpleBrowser::setConnectionTimeout() + SimpleBrowser::setMaximumRedirects(), + SimpleBrowser::setMaximumNestedFrames(), + SimpleBrowser::ignoreFrames() and + SimpleBrowser::useFrames() 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 SimpleBrowser::setFrameFocus() + and you can then use SimpleBrowser::getRequest(), etc to + see what happened. +

+ +

+ +

Complex unit tests with multiple browsers

+ +

+

+ Anything that could be done in a + WebTestCase can + now be done in a UnitTestCase. + This means that we can freely mix domain object testing with the + web interface... +

+
+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');
+    }
+}
+
+ 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. +

+

+ A more useful case of where using the browser directly can be helpful + is where the WebTestCase cannot cope. + An example is where two browsers are needed at the same time. +

+

+ For example, say we want to disallow multiple simultaneous + usage of a site with the same username. + This test case will do the job... +

+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');
+    }
+}
+
+ You can also use the SimpleBrowser class + directly when you want to write test cases using a different + test tool than SimpleTest. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/docs.css b/tests/test_tools/simpletest/docs/en/docs.css new file mode 100755 index 00000000..93226cd7 --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/docs.css @@ -0,0 +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%; +} diff --git a/tests/test_tools/simpletest/docs/en/expectation_documentation.html b/tests/test_tools/simpletest/docs/en/expectation_documentation.html new file mode 100755 index 00000000..0165988c --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/expectation_documentation.html @@ -0,0 +1,356 @@ + + + + + Extending the SimpleTest unit tester with additional expectation classes + + + + + +

Expectation documentation

+
+

+ +

More control over mock objects

+ +

+

+ The default behaviour of the + mock objects + in + SimpleTest + 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. +

+

+ 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. +

+

+ For example, suppose we have a news service that has failed + to connect to its remote source. +

+class NewsService {
+    ...
+    function publish(&$writer) {
+        if (! $this->isConnected()) {
+            $writer->write('Cannot connect to news service "' .
+                    $this->_name . '" at this time. ' .
+                    'Please try again later.');
+        }
+        ...
+    }
+}
+
+ Here it is sending its content to a + Writer class. + We could test this behaviour with a + MockWriter like so... +
+class TestOfNewsService extends UnitTestCase {
+    ...
+    function testConnectionFailure() {
+        $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();
+    }
+}
+
+ 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. +

+

+ To get around this, we would like to do a regular expression + test rather than an exact match. + We can actually do this with... +

+class TestOfNewsService extends UnitTestCase {
+    ...
+    function testConnectionFailure() {
+        $writer = &new MockWriter($this);
+        $writer->expectOnce(
+                'write',
+                array(new WantedPatternExpectation('/cannot connect/i')));
+        
+        $service = &new NewsService('BBC News');
+        $service->publish($writer);
+        
+        $writer->tally();
+    }
+}
+
+ Instead of passing in the expected parameter to the + MockWriter we pass an + expectation class called + WantedPatternExpectation. + 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. +

+

+ The WantedPatternExpectation takes + the regular expression to match in its constructor. + Whenever a comparison is made by the MockWriter + against this expectation class, it will do a + preg_match() 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. +

+

+ The possible expectation classes are... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualExpectationAn equality, rather than the stronger identity comparison
NotEqualExpectationAn inequality comparison
IndenticalExpectationThe default mock object check which must match exactly
NotIndenticalExpectationInverts the mock object logic
WantedPatternExpectationUses a Perl Regex to match a string
NoUnwantedPatternExpectationPasses only if failing a Perl Regex
IsAExpectationChecks the type or class name only
NotAExpectationOpposite of the IsAExpectation
MethodExistsExpectationChecks a method is available on an object
+ Most take the expected value in the constructor. + The exceptions are the pattern matchers, which take a regular expression, + and the IsAExpectation and NotAExpectation which takes a type + or class name as a string. +

+ +

+ +

Using expectations to control stubs

+ +

+

+ The expectation classes can be used not just for sending assertions + from mock objects, but also for selecting behaviour for either + the + mock objects + or the + server stubs. + Anywhere a list of arguments is given, a list of expectation objects + can be inserted instead. +

+

+ 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... +

+Stub::generate('Authorisation');
+
+$authorisation = new StubAuthorisation();
+$authorisation->setReturnValue(
+        'isAllowed',
+        true,
+        array(new IsAExpectation('Session', 'Must be a session')));
+$authorisation->setReturnValue('isAllowed', false);
+
+ We have set the default stub behaviour to return false when + isAllowed is called. + When we call the method with a single parameter that + is a Session 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. +

+

+ This kind of sophistication is rarely useful, but is included for + completeness. +

+ +

+ +

Creating your own expectations

+ +

+

+ The expectation classes have a very simple structure. + So simple that it is easy to create your own versions for + commonly used test logic. +

+

+ 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 + SimpleExpectation... +

+class ValidIp extends SimpleExpectation {
+    
+    function test($ip) {
+        return (ip2long($ip) != -1);
+    }
+    
+    function testMessage($ip) {
+        return "Address [$ip] should be a valid IP address";
+    }
+}
+
+ There are only two methods to implement. + The test() method should + evaluate to true if the expectation is to pass, and + false otherwise. + The testMessage() method + should simply return some helpful text explaining the test + that was carried out. +

+

+ This class can now be used in place of the earlier expectation + classes. +

+ +

+ +

Under the bonnet of the unit tester

+ +

+

+ The SimpleTest unit testing framework + also uses the expectation classes internally for the + UnitTestCase class. + We can also take advantage of these mechanisms to reuse our + homebrew expectation classes within the test suites directly. +

+

+ The most crude way of doing this is to use the + SimpleTest::assertExpectation() method to + test against it directly... +

+class TestOfNetworking extends UnitTestCase {
+    ...
+    function testGetValidIp() {
+        $server = &new Server();
+        $this->assertExpectation(
+                new ValidIp(),
+                $server->getIp(),
+                'Server IP address->%s');
+    }
+}
+
+ This is a little untidy compared with our usual + assert...() syntax. +

+

+ 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... +

+class TestOfNetworking extends UnitTestCase {
+    ...
+    function assertValidIp($ip, $message = '%s') {
+        $this->assertExpectation(new ValidIp(), $ip, $message);
+    }
+    
+    function testGetValidIp() {
+        $server = &new Server();
+        $this->assertValidIp(
+                $server->getIp(),
+                'Server IP address->%s');
+    }
+}
+
+ 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/form_testing_documentation.html b/tests/test_tools/simpletest/docs/en/form_testing_documentation.html new file mode 100755 index 00000000..b1e15b3d --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/form_testing_documentation.html @@ -0,0 +1,277 @@ + + + +Simple Test documentation for testing HTML forms + + + + +

Form testing documentation

+
+

+ +

Submitting a simple form

+ +

+

+ When a page is fetched by the WebTestCase + using get() or + post() 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... +

+<form>
+    <input type="text" name="a" value="A default" />
+    <input type="submit" value="Go" />
+</form>
+
+ Which looks like this... +

+

+

+ + +
+

+

+ We can navigate to this code, via the + LastCraft + site, with the following test... +

+class SimpleFormTests extends WebTestCase {
+    
+    function testDefaultValue() {
+        $this->get('http://www.lastcraft.com/form_testing_documentation.php');
+        $this->assertField('a', 'A default');
+    }
+}
+
+ 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" +

+

+ We could submit the form straight away, but first we'll change + the value of the text field and only then submit it... +

+class SimpleFormTests extends WebTestCase {
+
+    function testDefaultValue() {
+        $this->get('http://www.my-site.com/');
+        $this->assertField('a', 'A default');
+        $this->setField('a', 'New value');
+        $this->clickSubmit('Go');
+    }
+}
+
+ 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 GET + 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 + HTMLTidy should be used. +

+

+ If a field is not present in any form, or if an option is unavailable, + then WebTestCase::setField() will return + false. + For example, suppose we wish to verify that a "Superuser" + option is not present in this form... +

+<strong>Select type of user to add:</strong>
+<select name="type">
+    <option>Subscriber</option>
+    <option>Author</option>
+    <option>Administrator</option>
+</select>
+
+ Which looks like... +

+

+

+ Select type of user to add: + +
+

+

+ The following test will confirm it... +

+class SimpleFormTests extends WebTestCase {
+    ...
+    function testNoSuperuserChoiceAvailable() {
+        $this->get('http://www.lastcraft.com/form_testing_documentation.php');
+        $this->assertFalse($this->setField('type', 'Superuser'));
+    }
+}
+
+ The selection will not be changed on a failure to set + a widget value. +

+

+ Here is the full list of widgets currently supported... +

    +
  • Text fields, including hidden and password fields.
  • +
  • Submit buttons including the button tag, although not yet reset buttons
  • +
  • Text area. This includes text wrapping behaviour.
  • +
  • Checkboxes, including multiple checkboxes in the same form.
  • +
  • Drop down selections, including multiple selects.
  • +
  • Radio buttons.
  • +
  • Images.
  • +
+

+

+ Although most standard HTML widgets are catered for by SimpleTest's + built in parser, it is unlikely that JavaScript will be implemented + anytime soon. +

+ +

+ +

Fields with multiple values

+ +

+

+ 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... +

+<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>
+
+ Which renders as... +

+

+

+ Create privileges allowed: + +
+ Retrieve privileges allowed: + +
+ Update privileges allowed: + +
+ Destroy privileges allowed: + +
+ +
+

+

+ If we wish to disable all but the retrieval privileges and + submit this information we can do it like this... +

+class SimpleFormTests extends WebTestCase {
+    ...
+    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');
+    }
+}
+
+ 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. +

+

+ +

Raw posting

+ +

+

+ 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. +

+class SimpleFormTests extends WebTestCase {
+    ...    
+    function testAttemptedHack() {
+        $this->post(
+                'http://www.my-site.com/add_user.php',
+                array('type' => 'superuser'));
+        $this->assertNoUnwantedPattern('/user created/i');
+    }
+}
+
+ By adding data to the WebTestCase::post() + method, we are attempting to fetch the page as a form submission. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/group_test_documentation.html b/tests/test_tools/simpletest/docs/en/group_test_documentation.html new file mode 100755 index 00000000..adbc66ef --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/group_test_documentation.html @@ -0,0 +1,357 @@ + + + +SimpleTest for PHP group test documentation + + + + +

Group Test documentation

+
+

+ +

Grouping tests

+ +

+

+ To run test cases as part of a group the test cases should really + be placed in files without the runner code... +

+<?php
+    require_once('../classes/io.php');
+
+    class FileTester extends UnitTestCase {
+        ...
+    }
+
+    class SocketTester extends UnitTestCase {
+        ...
+    }
+?>
+
+ 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. +

+

+ If you have extended any test cases, you can include them + as well. +

+<?php
+    require_once('../classes/io.php');
+
+    class MyFileTestCase extends UnitTestCase {
+        ...
+    }
+    SimpleTestOptions::ignore('MyFileTestCase');
+
+    class FileTester extends MyFileTestCase {
+        ...
+    }
+
+    class SocketTester extends UnitTestCase {
+        ...
+    }
+?>
+
+ The FileTester class does + not contain any actual tests, but is a base class for other + test cases. + For this reason we use the + SimpleTestOptions::ignore() 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 file_test.php. +

+

+ Next we create a group test file, called say group_test.php. + You will think of a better name I am sure. + We will add the test file using a safe method... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('file_test.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestCase(new FileTestCase());
+    $test->run(new HtmlReporter());
+?>
+
+ 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... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('file_test.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestClass('FileTestCase');
+    $test->run(new HtmlReporter());
+?>
+
+ The problem with this method is that for every test case + that we add we will have + to require_once() the test code + file and manually instantiate each and every test case. + We can save a lot of typing with... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestFile('file_test.php');
+    $test->run(new HtmlReporter());
+?&gt;
+
+ What happens here is that the GroupTest + class has done the require_once() + 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. +

+

+ There are two things that could go wrong and which require care... +

    +
  1. + 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. +
  2. +
  3. + New test case extension classes that get included will be + placed in the group test and run also. + You will need to add a SimpleTestOptions::ignore() + directive for these classes or make sure that they are included + before the GroupTest::addTestFile() + line. +
  4. +
+

+ +

+ +

Higher groupings

+ +

+

+ 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. +

+

+ To get a more flexible group test we can subclass + GroupTest and then instantiate it as needed... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    
+    class FileGroupTest extends GroupTest {
+        function FileGroupTest() {
+            $this->GroupTest('All file tests');
+            $this->addTestFile('file_test.php');
+        }
+    }
+?>
+
+ 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... +
+<?php
+    require_once('file_group_test.php');
+    
+    $test = &new FileGroupTest();
+    $test->run(new HtmlReporter());
+?>
+
+ ...or we can group them into even larger group tests... +
+<?php
+    require_once('file_group_test.php');
+    
+    $test = &new BigGroupTest('Big group');
+    $test->addTestCase(new FileGroupTest());
+    $test->addTestCase(...);
+    $test->run(new HtmlReporter());
+?>
+
+ 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. +
+<?php
+    class FileGroupTest extends GroupTest {
+        function FileGroupTest() {
+            $this->GroupTest('All file tests');
+            $test->addTestFile('file_test.php');
+        }
+    }
+    
+    if (! defined('RUNNER')) {
+        define('RUNNER', true);
+        $test = &new FileGroupTest();
+        $test->run(new HtmlReporter());
+    }
+?>
+
+ 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 run() will run once only + from the top level script that has been invoked. +
+<?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());
+?>
+
+ As with the normal test cases, a GroupTest can + be loaded with the GroupTest::addTestFile() method. +
+<?php
+    define('RUNNER', true);
+
+    $test = &new BigGroupTest('Big group');
+    $test->addTestFile('file_group_test.php');
+    $test->addTestFile(...);
+    $test->run(new HtmlReporter());
+?>
+
+

+ +

+ +

Integrating legacy test cases

+ +

+

+ 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. +

+

+ Say we have the following + PhpUnit + test case in the file config_test.php... +

+class ConfigFileTest extends TestCase {
+    function ConfigFileTest() {
+        $this->TestCase('Config file test');
+    }
+    
+    function testContents() {
+        $config = new ConfigFile('test.conf');
+        $this->assertRegexp('/me/', $config->getValue('username'));
+    }
+}
+
+ The group test can recognise this as long as we include + the appropriate adapter class before we add the test + file... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('simpletest/adapters/phpunit_test_case.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestFile('config_test.php');
+    $test->run(new HtmlReporter());
+?>
+
+ There are only two adapters, the other is for the + PEAR + 1.0 unit tester... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('simpletest/adapters/pear_test_case.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestFile('some_pear_test_cases.php');
+    $test->run(new HtmlReporter());
+?>
+
+ 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/index.html b/tests/test_tools/simpletest/docs/en/index.html new file mode 100755 index 00000000..04797272 --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/index.html @@ -0,0 +1,467 @@ + + + + + Download the Simple Test testing framework - + Unit tests and mock objects for PHP + + + + + +

Simple Test for PHP

+
+ + +

+ 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 + SimpleTest. + For fuller documentation, especially if you are new + to unit testing see the ongoing + documentation, and for + example test cases see the + unit testing tutorial. +

+ +

+ +

Using the tester quickly

+ +

+

+ 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 + JUnit and the + PHPUnit + ports, but also adds + mock objects. + It has some JWebUnit + functionality as well. + This includes web page navigation, cookie testing and form submission. +

+

+ The quickest way to demonstrate is with an example. +

+

+ Let us suppose we are testing a simple file logging class called + Log in classes/log.php. + We start by creating a test script which we will call + tests/log_test.php and populate it as follows... +

+<?php
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/reporter.php');
+require_once('../classes/log.php');
+?>
+
+ Here the simpletest 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... +
+<?php
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/reporter.php');
+require_once('../classes/log.php');
+
+class TestOfLogging extends UnitTestCase {
+}
+?>
+
+ 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 Log class + takes the file name to write to in the constructor and we have + a temporary folder in which to place this file... +
+<?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'));
+    }
+}
+?>
+
+ When a test case runs it will search for any method that + starts with the string test + 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 + print statements can display + their content right next to the test case concerned. +

+

+ 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... +

+<?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'));
+    }
+}
+
+$test = &new TestOfLogging();
+$test->run(new HtmlReporter());
+?>
+
+

+

+ On failure the display looks like this... +

+

testoflogging

+ Fail: testcreatingnewfile->True assertion failed.
+
1/1 test cases complete. + 1 passes and 1 fails.
+
+ ...and if it passes like this... +
+

testoflogging

+
1/1 test cases complete. + 2 passes and 0 fails.
+
+ And if you get this... +
+ Fatal error: Failed opening required '../classes/log.php' (include_path='') in /home/marcus/projects/lastcraft/tutorial_tests/Log/tests/log_test.php on line 7 +
+ it means you're missing the classes/Log.php file that could look like... +
+<?php
+class Log {
+    
+        function Log($file_path) {
+        }
+
+		function message() {
+		}
+}
+?>;
+
+

+ +

+ +

Building group tests

+ +

+

+ 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. +

+

+ Our first step is to strip the includes and to undo our + previous hack... +

+<?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'));
+    }
+}
+?>
+
+ Next we create a new file called tests/all_tests.php + and insert the following code... +
+<?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());
+?>
+
+ The method GroupTest::addTestFile() + will include the test case file and read any new classes created + that are descended from SimpleTestCase, of which + UnitTestCase 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. +

+

+ 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 SimpleTestOptions::ignore() 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 GroupTest::addTestFile() + method will not detect them. +

+

+ To display the results it is necessary only to invoke + tests/all_tests.php from the web server. +

+ +

+ +

Using mock objects

+ +

+

+ Let's move further into the future. +

+

+ 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 + SessionPool. + We want to test a method that will probably end up looking + like this... +

+
+class SessionPool {
+    ...
+    function logIn($username) {
+        ...
+        $this->_log->message("User $username logged in.");
+        ...
+    }
+    ...
+}
+
+
+ In the spirit of reuse we are using our + Log class. + A conventional test case might look like this... +
+
+<?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");
+    }
+}
+?>
+
+ 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 Log class and + this test. + What if we don't use files any more, but use ths + syslog 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? +

+

+ 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. +

+

+ 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. +

+

+ Too good to be true? + Luckily we can create such an object easily... +
+<?php
+require_once('../classes/log.php');
+require_once('../classes/session_pool.php');
+Mock::generate('Log');
+
+class TestOfSessionLogging extends UnitTestCase {
+    
+    function testLogInIsLogged() {
+        $log = &new MockLog($this);
+        $log->expectOnce('message', array('User fred logged in.'));
+        $session_pool = &new SessionPool($log);
+        $session_pool->logIn('fred');
+        $log->tally();
+    }
+}
+?>
+
+ The tally() 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 + message() is invoked on the + MockLog 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. +

+

+ 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. +

+

+ For this test to run the mock objects library must have been + included in the test suite, say in all_tests.php. +

+ +

+ +

Web page testing

+ +

+

+ 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. +

+

+ 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. +

+<?php
+require_once('simpletest/web_tester.php');
+require_once('simpletest/reporter.php');
+
+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');
+    }
+}
+$test = &new TestOfAbout();
+$test->run(new HtmlReporter());
+?>
+
+ 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. +

+

+ SourceForge.net Logo +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/mock_objects_documentation.html b/tests/test_tools/simpletest/docs/en/mock_objects_documentation.html new file mode 100755 index 00000000..2f8a1f90 --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/mock_objects_documentation.html @@ -0,0 +1,713 @@ + + + +SimpleTest for PHP mock objects documentation + + + + +

Mock objects documentation

+
+

+ +

What are mock objects?

+ +

+

+ Mock objects have two roles during a test case: actor and critic. +

+

+ 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. +

+

+ If mock objects only behaved as actors they would simply be + known as server stubs. +

+

+ 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. +

+ +

+ +

Creating mock objects

+ +

+

+ In the same way that we create server stubs, all we need is an + existing class, say a database connection that looks like this... +

+class DatabaseConnection {
+    function DatabaseConnection() {
+    }
+    
+    function query() {
+    }
+    
+    function selectQuery() {
+    }
+}
+
+ 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... +
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+
+Mock::generate('DatabaseConnection');
+
+ This generates a clone class called + MockDatabaseConnection. + We can now create instances of the new class within + our test case... +
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+
+Mock::generate('DatabaseConnection');
+
+class MyTestCase extends UnitTestCase {
+    
+    function testSomething() {
+        $connection = &new MockDatabaseConnection($this);
+    }
+}
+
+ 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. +

+

+ +

Mocks as actors

+ +

+

+ The mock version of a class has all the methods of the original + so that operations like + $connection->query() are still + legal. + As with stubs we can replace the default null return values... +

+$connection->setReturnValue('query', 37);
+
+ Now every time we call + $connection->query() 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... +
+Mock::generate('DatabaseConnection', 'MyMockDatabaseConnection', array('setOptions'));
+
+ Here the mock will behave as if the setOptions() + existed in the original class. + This is handy if a class has used the PHP overload() + mechanism to add dynamic methods. + You can create a special mock to simulate this situation. +

+

+ All of the patterns available with server stubs are available + to mock objects... +

+class Iterator {
+    function Iterator() {
+    }
+    
+    function next() {
+    }
+}
+
+ Again, assuming that this iterator only returns text until it + reaches the end, when it returns false, we can simulate it + with... +
+Mock::generate('Iterator');
+
+class IteratorTest extends UnitTestCase() {
+    
+    function testASequence() {
+        $iterator = &new MockIterator($this);
+        $iterator->setReturnValue('next', false);
+        $iterator->setReturnValueAt(0, 'next', 'First string');
+        $iterator->setReturnValueAt(1, 'next', 'Second string');
+        ...
+    }
+}
+
+ When next() 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 false 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. +

+

+ A repeat of the stubbed information holder with name/value pairs... +

+class Configuration {
+    function Configuration() {
+    }
+    
+    function getValue($key) {
+    }
+}
+
+ 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 + getValue() method and yet + we want different results for different keys. + Luckily the mocks have a filter system... +
+$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'));
+
+ 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 + getValue() method invoked + like this... +
+$config->getValue('db_user')
+
+ ...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. +

+

+ 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... +

+class Thing {
+}
+
+class Vector {
+    function Vector() {
+    }
+    
+    function get($index) {
+    }
+}
+
+ In this case you can set a reference into the mock's + return list... +
+$thing = new Thing();
+$vector = &new MockVector($this);
+$vector->setReturnReference('get', $thing, array(12));
+
+ With this arrangement you know that every time + $vector->get(12) is + called it will return the same + $thing each time. +

+ +

+ +

Mocks as critics

+ +

+

+ 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. +

+

+ By way of example, suppose we have a + SessionPool 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 SessionPool code currently looks + like this... +

+class SessionPool {
+    function SessionPool() {
+        ...
+    }
+    
+    function &findSession($cookie) {
+        ...
+    }
+    ...
+}
+
+class Session {
+    ...
+}
+</php>
+                While our logging code looks like this...
+<php>
+class Log {
+    function Log() {
+        ...
+    }
+    
+    function message() {
+        ...
+    }
+}
+
+class LoggingSessionPool {
+    function LoggingSessionPool(&$session_pool, &$log) {
+        ...
+    }
+    
+    function &findSession(\$cookie) {
+        ...
+    }
+    ...
+}
+
+ Out of all of this, the only class we want to test here + is the LoggingSessionPool. + In particular we would like to check that the + findSession() method is + called with the correct session ID in the cookie and that + it sent the message "Starting session $cookie" + to the logger. +

+

+ 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: +

    +
  1. Create a log object.
  2. +
  3. Set a directory to place the log file.
  4. +
  5. Set the directory permissions so we can write the log.
  6. +
  7. Create a SessionPool object.
  8. +
  9. Hand start a session, which probably does lot's of things.
  10. +
  11. Invoke findSession().
  12. +
  13. Read the new Session ID (hope there is an accessor!).
  14. +
  15. Raise a test assertion to confirm that the ID matches the cookie.
  16. +
  17. Read the last line of the log file.
  18. +
  19. Pattern match out the extra logging timestamps, etc.
  20. +
  21. Assert that the session message is contained in the text.
  22. +
+ 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. +

+

+ Instead, here is the complete test method using mock object magic... +

+Mock::generate('Session');
+Mock::generate('SessionPool');
+Mock::generate('Log');
+
+class LoggingSessionPoolTest extends UnitTestCase {
+    ...
+    function testFindSessionLogging() {
+        $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();
+    }
+}
+
+ 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. +

+

+ findSession() is a factory + method the simulation of which is described above. + The point of departure comes with the first + expectOnce() call. + This line states that whenever + findSession() 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. +

+

+ 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 + tally() call at the end of + the test. +

+

+ We use the same pattern to set up the mock logger. + We tell it that it should have + message() 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. +

+

+ We start to run our tests when we create the new + LoggingSessionPool and feed + it our preset mock objects. + Everything is now under our control. + Finally we confirm that the + $session we gave our decorator + is the one that we get back and tell the mocks to run their + internal call count tests with the + tally() calls. +

+

+ 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 + setUp() method. +

+

+ Here is the full list of expectations you can set on a mock object + in SimpleTest... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ExpectationNeeds tally()
expectArguments($method, $args)No
expectArgumentsAt($timing, $method, $args)No
expectCallCount($method, $count)Yes
expectMaximumCallCount($method, $count)No
expectMinimumCallCount($method, $count)Yes
expectNever($method)No
expectOnce($method, $args)Yes
expectAtLeastOnce($method, $args)Yes
+ Where the parameters are... +

+
$method
+
The method name, as a string, to apply the condition to.
+
$args
+
+ The arguments as a list. Wildcards can be included in the same + manner as for setReturn(). + This argument is optional for expectOnce() + and expectAtLeastOnce(). +
+
$timing
+
+ The only point in time to test the condition. + The first call starts at zero. +
+
$count
+
The number of calls expected.
+
+ The method expectMaximumCallCount() + is slightly different in that it will only ever generate a failure. + It is silent if the limit is never reached. +

+

+ 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". +

+ +

+ +

Other approaches

+ +

+

+ 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. +

+

+ Mock objects generated with SimpleTest + are dynamic. + They are created at run time in memory, using + eval(), 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. +

+

+ 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. +

+

+ 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 mocks/connection.php for a + database connection, create a mock and inherit to override + special methods or add presets... +

+<?php
+    require_once('simpletest/mock_objects.php');
+    require_once('../classes/connection.php');
+
+    Mock::generate('Connection', 'BasicMockConnection');
+    class MockConnection extends BasicMockConnection {
+        function MockConnection(&$test, $wildcard = '*') {
+            $this->BasicMockConnection($test, $wildcard);
+            $this->setReturn('query', false);
+        }
+    }
+?>
+
+ The generate call tells the class generator to create + a class called BasicMockConnection + rather than the usual MockConnection. + We then inherit from this to get our version of + MockConnection. + By intercepting in this way we can add behaviour, here setting + the default value of query() 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 MockConnection 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. +

+

+ 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. +

+ +

+ +

I think SimpleTest stinks!

+ +

+

+ But at the time of writing it is the only one with mock objects, + so are you stuck with it? +

+

+ No, not at all. + SimpleTest 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... +

+class PHPUnit {
+    function PHPUnit() {
+    }
+    
+    function assertion($message, $assertion) {
+    }
+    ...
+}
+
+ All the assertion() 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... +
+$unit_test = new PHPUnit();
+$unit_test>assertion('I hope this file exists', file_exists('my_file'));
+
+ How do you use mocks with this? +

+

+ There is a protected method on the base mock class + SimpleMock called + _assertTrue() and + by overriding this method we can use our own assertion format. + We start with a subclass, in say my_mock.php... +

+<?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);
+        }
+    }
+?>
+
+ Now instantiating MyMock 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... +
+<?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);
+        }
+    }
+    SimpleTestOptions::setMockBaseClass('MyMock');
+?>
+
+ From now on you just include my_mock.php instead of the + default mock_objects.php version and you can introduce + mock objects into your existing test suite. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/overview.html b/tests/test_tools/simpletest/docs/en/overview.html new file mode 100755 index 00000000..d4965de3 --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/overview.html @@ -0,0 +1,422 @@ + + + + + Overview and feature list for the SimpleTest PHP unit tester and web tester + + + + + +

Overview of SimpleTest

+
+

+ +

What is SimpleTest?

+ +

+

+ 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 run() + 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 + assertEqual(). + 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. +

+

+ A test case looks like this... +

+<?php
+class MyTestCase extends UnitTestCase {
+    
+    function testLog() {
+        $log = &new Log('my.log');
+        $log->message('Hello');
+        $this->assertTrue(file_exists('my.log'));
+    }
+}
+?>
+
+

+

+ 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. +

+

+ The simplest type of test case is the + UnitTestCase. + 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. +

+

+ 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 WebTestCase 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. +

+

+ A WebTestCase looks like this... +

+<?php
+class MySiteTest extends WebTestCase {
+    
+    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/');
+    }
+}
+?>
+
+

+ +

+ +

Feature list

+ +

+

+ 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". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureDescriptionRelease
Unit test caseCore test case class and assertionsDone
Html displaySimplest possible displayDone
Autoloading of test cases + Reading a file with test cases and loading them into a + group test automatically + Done
Mock objects code generator + Objects capable of simulating other objects removing + test dependencies + Done
Server stubs + Mocks without expectations to be used outside of test cases, + e.g. for prototyping + Done
Integration of other unit testers + The ability to read and simulate test cases from PHPUnit + and PEAR::PhpUnit + Done
Web test caseBasic pattern matching of fetched pagesDone
HTML parsing of pagesAllows link following and title tag matchingDone
Partial mocks + Mocking parts of a class for testing less than a class + or for complex simulations + Done
Web cookie handlingCorrect handling of cookies when fetching pagesDone
Following redirectsPage fetching automatically follows 300 redirectsDone
Form parsingAbility to submit simple forms and read default form valuesDone
Command line interfaceTest display without the need of a web browserDone
Exposure of expectation classesCan create precise tests with mocks as well as test casesDone
XML output and parsing + Allows multi host testing and the integration of acceptance + testing extensions + Done
Command line test caseAllows testing of utilities and file handlingDone
PHP Documentor compatibilityFully generated class level documentationDone
Browser interface + Exposure of lower level web browser interface for more + detailed test cases + Done
HTTP authentication + Fetching protected web pages with basic authentication + only + Done
Browser navigation buttonsBack, forward and retryDone
SSL supportCan connect to https: pagesDone
Proxy supportCan connect via. common proxiesDone
Frames supportHandling of frames in web test casesDone
Improved displayBetter web GUI with tree display of test cases1.1
LocalisationMessages abstracted and code generated from XML1.1
File upload testingCan simulate the input type file tag1.1
Mocking interfacesCan generate mock objects to interfaces as well as classes2.0
Testing exceptionsSimilar to testing PHP errors2.0
XPath searching of elementsCan make use of HTML tidy for faster and more flexible content matching2.0
+ 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. +

+ +

+ +

Web resources for testing

+ +

+

+ 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 + Extreme Programming. + This is one of the + Agile Methodologies + which combine various practices to "flatten the cost curve" of software development. + More extreme still is Test Driven Development, + 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 + RUP approach. + I haven't tried it, but even I can see that you will need test tools (see figure 9). +

+

+ Most unit testers clone JUnit to some degree, + as far as the interface at least. There is a wealth of information on the + JUnit site including the + FAQ + which contains plenty of general advice on testing. + Once you get bitten by the bug you will certainly appreciate the phrase + test infected + coined by Eric Gamma. + If you are still reviewing which unit tester to use the main choices + are PHPUnit + and Pear PHP::PHPUnit. + They currently lack a lot of features found in + SimpleTest, but the PEAR + version at least has been upgraded for PHP5 and is recommended if you are porting + existing JUnit test cases. +

+

+ 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 + WACT and + PEAR::XML_HTMLSax. +

+

+ 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 original mock objects paper + 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 + Extreme Tuesday + or www.mockobjects.com + or the original C2 Wiki. + Injecting mocks into a class is the main area of debate for which this + paper on IBM + makes a good starting point. +

+

+ 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 + HTTPUnit, + HTMLUnit + or JWebUnit 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/partial_mocks_documentation.html b/tests/test_tools/simpletest/docs/en/partial_mocks_documentation.html new file mode 100755 index 00000000..20749415 --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/partial_mocks_documentation.html @@ -0,0 +1,426 @@ + + + +SimpleTest for PHP partial mocks documentation + + + + +

Partial mock objects documentation

+
+ +

+ 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. +

+ +

+ +

The mock injection problem

+ +

+

+ 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. +

+

+ 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... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect($ip, $port, $username, $password) {
+            $socket = &new Socket($ip, $port);
+            $socket->read( ... );
+            ...
+        }
+    }
+?>
+
+ We would really like to have a mock object version of the socket + here, what can we do? +

+

+ 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. +

+

+ Here this would be... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect(&$socket, $username, $password) {
+            $socket->read( ... );
+            ...
+        }
+    }
+?>
+
+ This means that the test code is typical for a test involving + mock objects. +
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new Telnet();
+        $telnet->connect($socket, 'Me', 'Secret');
+        ...
+    }
+}
+
+ 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. +

+

+ The next simplest compromise is to have the created object passed + in as an optional parameter... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect($ip, $port, $username, $password, $socket = false) {
+            if (!$socket) {
+                $socket = &new Socket($ip, $port);
+            }
+            $socket->read( ... );
+            ...
+            return $socket;
+        }
+    }
+?>
+
+ For a quick solution this is usually good enough. + The test now looks almost the same as if the parameter + was formally passed... +
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new Telnet();
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret', &$socket);
+        ...
+    }
+}
+
+ 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. +

+

+ The next method is to pass in a factory object to do the creation... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        function Telnet(&$network) {
+            $this->_network = &$network;
+        }
+        ...
+        function &connect($ip, $port, $username, $password) {
+            $socket = &$this->_network->createSocket($ip, $port);
+            $socket->read( ... );
+            ...
+            return $socket;
+        }
+    }
+?>
+
+ 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... +
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $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');
+        ...
+    }
+}
+
+ 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. +

+

+ Is there a middle ground? +

+ +

+ +

Protected factory method

+ +

+

+ 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... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect($ip, $port, $username, $password) {
+            $socket = &$this->_createSocket($ip, $port);
+            $socket->read( ... );
+            ...
+        }
+        
+        function &_createSocket($ip, $port) {
+            return new Socket($ip, $port);
+        }
+    }
+?>
+
+ This is the only change we make to the application code. +

+

+ For the test case we have to create a subclass so that + we can intercept the socket creation... +

+class TelnetTestVersion extends Telnet {
+    var $_mock;
+    
+    function TelnetTestVersion(&$mock) {
+        $this->_mock = &$mock;
+        $this->Telnet();
+    }
+    
+    function &_createSocket() {
+        return $this->_mock;
+    }
+}
+
+ 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 + connect(). + Otherwise it could get a null value from + _createSocket(). +

+

+ After the completion of all of this extra work the + actual test case is fairly easy. + We just test our new class instead... +

+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new TelnetTestVersion($socket);
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
+        ...
+    }
+}
+
+ 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? +

+ +

+ +

A partial mock

+ +

+

+ 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. +

+

+ Here is the partial mock version of the test... +

+Mock::generatePartial(
+        'Telnet',
+        'TelnetTestVersion',
+        array('_createSocket'));
+
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new TelnetTestVersion($this);
+        $telnet->setReturnReference('_createSocket', $socket);
+        $telnet->Telnet();
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
+        ...
+    }
+}
+
+ The partial mock is a subclass of the original with + selected methods "knocked out" with test + versions. + The generatePartial() call + takes three parameters: the class to be subclassed, + the new test class name and a list of methods to mock. +

+

+ 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. +

+

+ 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. +

+

+ 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... +

+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new TelnetTestVersion($this);
+        $telnet->setReturnReference('_createSocket', $socket);
+        $telnet->expectOnce('_createSocket', array('127.0.0.1', 21));
+        $telnet->Telnet();
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
+        ...
+        $telnet->tally();
+    }
+}
+
+

+ +

+ +

Testing less than a class

+ +

+

+ 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. +

+

+ 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. +

+

+ It's all going to come down to the coding standards of your + project to decide which mechanism you use. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/reporter_documentation.html b/tests/test_tools/simpletest/docs/en/reporter_documentation.html new file mode 100755 index 00000000..44be8b1e --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/reporter_documentation.html @@ -0,0 +1,515 @@ + + + +SimpleTest for PHP test runner and display documentation + + + + +

Test reporter documentation

+
+ +

+ 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. +

+ +

+ +

Reporting results in HTML

+ +

+

+ 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... +

+

File test

+ Fail: createnewfile->True assertion failed.
+
1/1 test cases complete. + 0 passes, 1 fails and 0 exceptions.
+
+ And here all tests passed... +
+

File test

+
1/1 test cases complete. + 1 passes, 0 fails and 0 exceptions.
+
+ The good news is that there are several points in the display + hiearchy for subclassing. +

+

+ For web page based displays there is the + HtmlReporter class with the following + signature... +

+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() { ... }
+}
+
+ Here is what some of these methods mean. First the display methods + that you will probably want to override... +
    +
  • + HtmlReporter(string $encoding) +
    + 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 html_entities() + function. +
  • +
  • + void paintHeader(string $test_name) +
    + 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 $test_name + comes from. + It paints the page titles, CSS, body tag, etc. + It returns nothing (void). +
  • +
  • + void paintFooter(string $test_name) +
    + 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. +
  • +
  • + void paintMethodStart(string $test_name) +
    + 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. +
  • +
  • + void paintMethodEnd(string $test_name) +
    + backs out of the test started with the same name. +
  • +
  • + void paintFail(string $message) +
    + 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. +
  • +
  • + void paintPass(string $message) +
    + by default does nothing. +
  • +
  • + string _getCss() +
    + 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. +
  • +
+ There are also some accessors to get information on the current + state of the test suite. + Use these to enrich the display... +
    +
  • + array getTestList() +
    + 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. +
  • +
  • + integer getPassCount() +
    + returns the number of passes chalked up so far. + Needed for the display at the end. +
  • +
  • + integer getFailCount() +
    + is likewise the number of fails so far. +
  • +
  • + integer getExceptionCount() +
    + is likewise the number of errors so far. +
  • +
  • + integer getTestCaseCount() +
    + is the total number of test cases in the test run. + This includes the grouping tests themselves. +
  • +
  • + integer getTestCaseProgress() +
    + is the number of test cases completed so far. +
  • +
+ One simple modification is to get the HtmlReporter to display + the passes as well as the failures and errors... +
+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; }';
+    }
+}
+
+

+

+ One method that was glossed over was the makeDry() + 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. +

+

+ 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. +

+ +

+ +

Extending the reporter

+ +

+

+ 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 + HtmlReporter we can take one + step up the class hiearchy to SimpleReporter + in the simple_test.php source file. +

+

+ A do nothing display, a blank canvas for your own creation, would + be... +

+require_once('simpletest/simple_test.php');
+
+class MyDisplay extends SimpleReporter {
+    
+    function paintHeader($test_name) {
+    }
+    
+    function paintFooter($test_name) {
+    }
+    
+    function paintStart($test_name, $size) {
+        parent::paintStart($test_name, $size);
+    }
+    
+    function paintEnd($test_name, $size) {
+        parent::paintEnd($test_name, $size);
+    }
+    
+    function paintPass($message) {
+        parent::paintPass($message);
+    }
+    
+    function paintFail($message) {
+        parent::paintFail($message);
+    }
+}
+
+ No output would come from this class until you add it. +

+ +

+ +

The command line reporter

+ +

+

+ 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... +

+<?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(new TextReporter());
+?>
+
+ Then invoke the test suite from the command line... +
+php file_test.php
+
+ You will need the command line version of PHP installed + of course. + A passing test suite looks like this... +
+File test
+OK
+Test cases run: 1/1, Failures: 0, Exceptions: 0
+
+ A failure triggers a display like this... +
+File test
+1) True assertion failed.
+	in createnewfile
+FAILURES!!!
+Test cases run: 1/1, Failures: 1, Exceptions: 0
+
+

+

+ 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 false + is returned from the SimpleTest::run() + method. + We can use that result to exit the script with the desired return + code... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+
+    $test = &new GroupTest('File test');
+    $test->addTestFile('tests/file_test.php');
+    exit ($test->run(new TextReporter()) ? 0 : 1);
+?>
+
+ 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... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+
+    $test = &new GroupTest('File test');
+    $test->addTestFile('tests/file_test.php');
+    if (TextReporter::inCli()) {
+        exit ($test->run(new TextReporter()) ? 0 : 1);
+    }
+    $test->run(new HtmlReporter());
+?>
+
+ This is the form used within SimpleTest itself. +

+ +

+ +

Remote testing

+ +

+

+ SimpleTest ships with an XmlReporter class + used for internal communication. + When run the output looks like... +

+<?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>
+
+ You can make use of this format with the parser + supplied as part of SimpleTest itself. + This is called SimpleTestXmlParser and + resides in xml.php within the SimpleTest package... +
+<?php
+    require_once('simpletest/xml.php');
+    
+    ...
+    $parser = &new SimpleTestXmlParser(new HtmlReporter());
+    $parser->parse($test_output);
+?>
+
+ The $test_output 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. +

+

+ 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. +

+

+ 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... +

+<?php
+    require_once('../remote.php');
+    require_once('../reporter.php');
+    
+    $test_url = ...;
+    $dry_url = ...;
+    
+    $test = &new GroupTest('Remote tests');
+    $test->addTestCase(new RemoteTestCase($test_url, $dry_url));
+    $test->run(new HtmlReporter());
+?>
+
+ The RemoteTestCase 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 RemoteTestCase can be added to test suites + just like any other group test. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/server_stubs_documentation.html b/tests/test_tools/simpletest/docs/en/server_stubs_documentation.html new file mode 100755 index 00000000..4b18bb0b --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/server_stubs_documentation.html @@ -0,0 +1,388 @@ + + + +SimpleTest for PHP server stubs documentation + + + + +

Server stubs documentation

+
+

+ +

What are server stubs?

+ +

+

+ 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. +

+ +

+ +

Creating server stubs

+ +

+

+ All we need is an existing class, say a database connection + that looks like this... +

+class DatabaseConnection {
+    function DatabaseConnection() {
+    }
+    
+    function query() {
+    }
+    
+    function selectQuery() {
+    }
+}
+
+ 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... +
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+Stub::generate('DatabaseConnection');
+
+ This generates a clone class called + StubDatabaseConnection. + We can now create instances of the new class within + our prototype script... +
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+Stub::generate('DatabaseConnection');
+
+$connection = new StubDatabaseConnection();
+
+
+ The stub version of a class has all the methods of the original + so that operations like + $connection->query() are still + legal. + The return value will be null, + but we can change that with... +
+$connection->setReturnValue('query', 37)
+
+ Now every time we call + $connection->query() 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. +

+ +

+ +

Simulation patterns

+ +

+

+ 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... +

+class Iterator {
+    function Iterator() {
+    }
+    
+    function next() {
+    }
+}
+
+ 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... +
+Stub::generate('Iterator');
+
+$iterator = new StubIterator();
+$iterator->setReturnValue('next', false);
+$iterator->setReturnValueAt(0, 'next', 'First string');
+$iterator->setReturnValueAt(1, 'next', 'Second string');
+
+ When next() 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 false 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. +

+

+ Another tricky situation is an overloaded + get() operation. + An example of this is an information holder with name/value pairs. + Say we have a configuration class like... +

+class Configuration {
+    function Configuration() {
+    }
+    
+    function getValue($key) {
+    }
+}
+
+ 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 + getValue() method and yet + we want different results for different keys. + Luckily the stubs have a filter system... +
+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'));
+
+ 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 + getValue() method invoked + like this... +
+$config->getValue('db_user');
+
+ ...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. +

+

+ You can set a default argument argument like so... +

+
+$config->setReturnValue('getValue', false, array('*'));
+
+ This is not the same as setting the return value without + any argument requirements like this... +
+
+$config->setReturnValue('getValue', false);
+
+ 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. +

+

+ 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... +

+class Thing {
+}
+
+class Vector {
+    function Vector() {
+    }
+    
+    function get($index) {
+    }
+}
+
+ In this case you can set a reference into the stub's + return list... +
+Stub::generate('Vector');
+
+$thing = new Thing();
+$vector = &new StubVector();
+$vector->setReturnReference('get', $thing, array(12));
+
+ With this arrangement you know that every time + $vector->get(12) is + called it will return the same + $thing each time. +

+

+ These three factors, timing, parameters and whether to copy, + can be combined orthogonally. + For example... +

+$complex = &new StubComplexThing();
+$stuff = new Stuff();
+$complex->setReturnReferenceAt(3, 'get', $stuff, array('*', 1));
+
+ This will return the $stuff 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. +

+

+ 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 next() giving + one row until false. + This sounds like a simulation nightmare, but in fact it can all + be stubbed using the mechanics above. +

+

+ Here's how... +

+Stub::generate('DatabaseConnection');
+Stub::generate('ResultIterator');
+
+class DatabaseTest extends UnitTestCase {
+    
+    function testUserFinder() {
+        $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'));
+                
+        $finder = &new UserFinder($connection);
+        $this->assertIdentical(
+                $finder->findNames(),
+                array('tom', 'dick', 'harry'));
+    }
+}
+
+ Now only if our + $connection is called with the correct + query() will the + $result be returned that is + itself exhausted after the third call to next(). + This should be enough + information for our UserFinder class, + the class actually + being tested here, to come up with goods. + A very precise test and not a real database in sight. +

+ +

+ +

Stub creation options

+ +

+

+ There are some additional options when creating stubs. + At the generation stage we can change the class name... +

+Stub::generate('Iterator', 'MyStubIterator');
+$iterator = &new MyStubIterator();
+
+
+ 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... +
+class Iterator {
+}
+Stub::generate('Iterator', 'PrototypeIterator', array('next', 'isError'));
+$iterator = &new PrototypeIterator();
+$iterator->setReturnValue('next', 0);
+
+
+ The next() and + isError() methods can now have + return values set just as if they existed in the original class. +

+

+ One other esoteric way of customising the stubs is to change + the default wildcard used for parameter matching. +

+Stub::generate('Connection');
+$iterator = &new StubConnection('wild');
+$iterator->setReturnValue('query', array('id' => 33), array('wild'));
+
+
+ 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". +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/unit_test_documentation.html b/tests/test_tools/simpletest/docs/en/unit_test_documentation.html new file mode 100755 index 00000000..6aa8d8a7 --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/unit_test_documentation.html @@ -0,0 +1,387 @@ + + + +SimpleTest for PHP regression test documentation + + + + +

PHP Unit Test documentation

+
+

+ +

Unit test cases

+ +

+

+ The core system is a regression testing framework built around + test cases. + A sample test case looks like this... +

+class FileTestCase extends UnitTestCase {
+}
+
+ 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. +

+

+ 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... +

+require_once('../classes/writer.php');
+
+class FileTestCase extends UnitTestCase {
+    function FileTestCase() {
+        $this->UnitTestCase('File test');
+    }
+    
+    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');
+    }
+}
+
+ The constructor is optional and usually omitted. + Without a name, the class name is taken as the name of the test case. +

+

+ Our only test method at the moment is testCreation() + where we check that a file has been created by our + Writer object. + We could have put the unlink() + code into this method as well, but by placing it in + setUp() and + tearDown() we can use it with + other test methods that we add. +

+

+ The setUp() method is run + just before each and every test method. + tearDown() is run just after + each and every test method. +

+

+ 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 setUp(), but + supplies additional hooks for library writers. +

+

+ The means of reporting test results (see below) are by a + visiting display class + that is notified by various assert...() + methods. + Here is the full list for the UnitTestCase + class, the default for SimpleTest... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
assertTrue($x)Fail if $x is false
assertFalse($x)Fail if $x is true
assertNull($x)Fail if $x is set
assertNotNull($x)Fail if $x not set
assertIsA($x, $t)Fail if $x is not the class or type $t
assertNotA($x, $t)Fail if $x is of the class or type $t
assertEqual($x, $y)Fail if $x == $y is false
assertNotEqual($x, $y)Fail if $x == $y is true
assertIdentical($x, $y)Fail if $x == $y is false or a type mismatch
assertNotIdentical($x, $y)Fail if $x == $y is true and types match
assertReference($x, $y)Fail unless $x and $y are the same variable
assertCopy($x, $y)Fail if $x and $y are the same variable
assertWantedPattern($p, $x)Fail unless the regex $p matches $x
assertNoUnwantedPattern($p, $x)Fail if the regex $p matches $x
assertNoErrors()Fail if any PHP error occoured
assertError($x)Fail if no PHP error or incorrect message
assertErrorPattern($p)Fail unless the error matches the regex $p
+ 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. +

+

+ Some examples... +

+$variable = null;
+$this->assertNull($variable, 'Should be cleared');
+
+ ...will pass and normally show no message. + If you have + set up the tester to display passes + as well then the message will be displayed as is. +
+$this->assertIdentical(0, false, 'Zero is not false [%s]');
+
+ 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. +
+$a = 1;
+$b = $a;
+$this->assertReference($a, $b);
+
+ Will fail as the variable $a is a copy of $b. +
+$this->assertWantedPattern('/hello/i', 'Hello world');
+
+ This will pass as using a case insensitive match the string + hello is contained in Hello world. +
+trigger_error('Disaster');
+trigger_error('Catastrophe');
+$this->assertError();
+$this->assertError('Catastrophe');
+$this->assertNoErrors();
+
+ This one takes some explanation as in fact they all pass! +

+

+ 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. +

+

+ The test cases also have some convenience methods for debugging + code or extending the suite... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setUp()Runs this before each test method
tearDown()Runs this after each test method
pass()Sends a test pass
fail()Sends a test failure
error()Sends an exception event
sendMessage()Sends a status message to those displays that support it
signal($type, $payload)Sends a user defined message to the test reporter
dump($var)Does a formatted print_r() for quick and dirty debugging
swallowErrors()Clears the error queue
+

+ +

+ +

Extending test cases

+ +

+

+ Of course additional test methods can be added to create + specific types of test case too so as to extend framework... +

+require_once('simpletest/unit_tester.php');
+
+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'));
+    }
+}
+
+ Here the SimpleTest library is held in a folder called + simpletest that is local. + Substitute your own path for this. +

+

+ This new case can be now be inherited just like + a normal test case... +

+class FileTestCase extends FileTester {
+    
+    function setUp() {
+        @unlink('../temp/test.txt');
+    }
+    
+    function tearDown() {
+        @unlink('../temp/test.txt');
+    }
+    
+    function testCreation() {
+        $writer = &new FileWriter('../temp/test.txt');
+        $writer->write('Hello');
+        $this->assertFileExists('../temp/test.txt');
+    }
+}
+
+

+

+ If you want a test case that does not have all of the + UnitTestCase assertions, + only your own and assertTrue(), + you need to extend the SimpleTestCase + class instead. + It is found in simple_test.php rather than + unit_tester.php. + See later if you + want to incorporate other unit tester's + test cases in your test suites. +

+ +

+ +

Running a single test case

+ +

+

+ 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... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('../classes/writer.php');
+
+    class FileTestCase extends UnitTestCase {
+        function FileTestCase() {
+            $this->UnitTestCase('File test');
+        }
+    }
+    
+    $test = &new FileTestCase();
+    $test->run(new HtmlReporter());
+?>
+
+ This script will run as is, but will output zero passes + and zero failures until test methods are added. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/en/web_tester_documentation.html b/tests/test_tools/simpletest/docs/en/web_tester_documentation.html new file mode 100755 index 00000000..51f604be --- /dev/null +++ b/tests/test_tools/simpletest/docs/en/web_tester_documentation.html @@ -0,0 +1,508 @@ + + + +Simple Test for PHP web script testing documentation + + + + +

Web tester documentation

+
+

+ +

Fetching a page

+ +

+

+ 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. +

+

+ 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. +

+

+ SimpleTest includes a special form of test case for the testing + of web page actions. + The WebTestCase includes facilities + for navigation, content and cookie checks and form handling. + Usage of these test cases is similar to the + UnitTestCase... +

+class TestOfLastcraft extends WebTestCase {
+}
+
+ Here we are about to test the + Last Craft site itself. + If this test case is in a file called lastcraft_test.php + then it can be loaded in a runner script just like unit tests... +
+<?php
+    require_once('simpletest/web_tester.php');
+    require_once('simpletest/reporter.php');
+    
+    $test = &new GroupTest('Web site tests');
+    $test->addTestFile('lastcraft_test.php');
+    exit ($test->run(new TextReporter()) ? 0 : 1);
+?>
+
+ I am using the text reporter here to more clearly + distinguish the web content from the test output. +

+

+ Nothing is being tested yet. + We can fetch the home page by using the + get() method... +

+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->assertTrue($this->get('http://www.lastcraft.com/'));
+    }
+}
+
+ The get() 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 get() method will still return true. +

+

+ Assuming that the web server for the Last Craft site is up + (sadly not always the case), we should see... +

+Web site tests
+OK
+Test cases run: 1/1, Failures: 0, Exceptions: 0
+
+ All we have really checked is that any kind of page was + returned. + We don't yet know if it was the right one. +

+ +

+ +

Testing page content

+ +

+

+ To confirm that the page we think we are on is actually the + page we are on, we need to verify the page content. +

+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->get('http://www.lastcraft.com/');
+        $this->assertWantedPattern('/why the last craft/i');
+    }
+}
+
+ 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. +

+

+ Here is the list of possible content assertions... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
assertTitle($title)Pass if title is an exact match
assertWantedPattern($pattern)A Perl pattern match against the page content
assertNoUnwantedPattern($pattern)A Perl pattern match to not find content
assertWantedText($text)Pass if matches visible and "alt" text
assertNoUnwantedText($text)Pass if doesn't match visible and "alt" text
assertLink($label)Pass if a link with this text is present
assertNoLink($label)Pass if no link with this text is present
assertLinkById($id)Pass if a link with this id attribute is present
assertNoLinkById($id)Pass if no link with this id attribute is present
assertField($name, $value)Pass if an input tag with this name has this value
assertFieldById($id, $value)Pass if an input tag with this id has this value
assertResponse($codes)Pass if HTTP response matches this list
assertMime($types)Pass if MIME type is in this list
assertAuthentication($protocol)Pass if the current challenge is this protocol
assertNoAuthentication()Pass if there is no current challenge
assertRealm($name)Pass if the current challenge realm matches
assertHeader($header, $content)Pass if a header was fetched matching this value
assertNoUnwantedHeader($header)Pass if a header was not fetched
assertHeaderPattern($header, $pattern)Pass if a header was fetched matching this Perl regex
assertCookie($name, $value)Pass if there is currently a matching cookie
assertNoCookie($name)Pass if there is currently no cookie of this name
+ 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. +

+

+ So now we could instead test against the title tag with... +

+$this->assertTitle('The Last Craft? Web developer tutorials on PHP, Extreme programming and Object Oriented development');
+
+ As well as the simple HTML content checks we can check + that the MIME type is in a list of allowed types with... +
+$this->assertMime(array('text/plain', 'text/html'));
+
+ 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... +
+class TestOfLastcraft extends WebTestCase {
+    
+    function testRedirects() {
+        $this->get('http://www.lastcraft.com/test/redirect.php');
+        $this->assertResponse(200);</strong>
+    }
+}
+
+ 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 WebTestCase 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... +
+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->setMaximumRedirects(0);
+        $this->get('http://www.lastcraft.com/test/redirect.php');
+        $this->assertResponse(200);
+    }
+}
+
+ The assertion now fails as expected... +
+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
+
+ We can modify the test to correctly assert redirects with... +
+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->setMaximumRedirects(0);
+        $this->get('http://www.lastcraft.com/test/redirect.php');
+        $this->assertResponse(array(301, 302, 303, 307));
+    }
+}
+
+ This now passes. +

+ +

+ +

Navigating a web site

+ +

+

+ 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... +

+class TestOfLastcraft extends WebTestCase {
+    ...
+    function testContact() {
+        $this->get('http://www.lastcraft.com/');
+        $this->clickLink('About');
+        $this->assertTitle('About Last Craft');
+    }
+}
+
+ The parameter is the text of the link. +

+

+ If the target is a button rather than an anchor tag, then + clickSubmit() should be used + with the button title... +

+$this->clickSubmit('Go!');
+
+

+

+ The list of navigation methods is... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
getUrl()The current location
get($url, $parameters)Send a GET request with these parameters
post($url, $parameters)Send a POST request with these parameters
head($url, $parameters)Send a HEAD request without replacing the page content
retry()Reload the last request
back()Like the browser back button
forward()Like the browser forward button
authenticate($name, $password)Retry after a challenge
restart()Restarts the browser as if a new session
getCookie($name)Gets the cookie value for the current context
ageCookies($interval)Ages current cookies prior to a restart
clearFrameFocus()Go back to treating all frames as one page
clickSubmit($label)Click the first button with this label
clickSubmitByName($name)Click the button with this name attribute
clickSubmitById($id)Click the button with this ID attribute
clickImage($label, $x, $y)Click an input tag of type image by title or alt text
clickImageByName($name, $x, $y)Click an input tag of type image by name
clickImageById($id, $x, $y)Click an input tag of type image by ID attribute
submitFormById($id)Submit a form without the submit value
clickLink($label, $index)Click an anchor by the visible label text
clickLinkById($id)Click an anchor by the ID attribute
getFrameFocus()The name of the currently selected frame
setFrameFocusByIndex($choice)Focus on a frame counting from 1
setFrameFocus($name)Focus on a frame by name
+

+

+ The parameters in the get(), post() or + head() 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. +

+

+ The retry(), back() and + forward() 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. +

+

+ 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. +

+

+ 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 + tools for testing web forms + as well. +

+ +

+ +

Modifying the request

+ +

+

+ 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... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
getTransportError()The last socket error
showRequest()Dump the outgoing request
showHeaders()Dump the incoming headers
showSource()Dump the raw HTML page content
ignoreFrames()Do not load framesets
setCookie($name, $value)Set a cookie from now on
addHeader($header)Always add this header to the request
setMaximumRedirects($max)Stop after this many redirects
setConnectionTimeout($timeout)Kill the connection after this time between bytes
useProxy($proxy, $name, $password)Make requests via this proxy URL
+ These methods are principally for debugging. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/authentication_documentation.html b/tests/test_tools/simpletest/docs/fr/authentication_documentation.html new file mode 100755 index 00000000..08cc2349 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/authentication_documentation.html @@ -0,0 +1,264 @@ + + + +Documentation Simple Test : tester l'authentification + + + + +

Documentation sur l'authentification

+
+ +

+ 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. +

+ +

+ +

Authentification HTTP basique

+ +

+

+ 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... +

+class AuthenticationTest extends WebTestCase {
+    function test401Header() {
+        $this->get('http://www.lastcraft.com/protected/');
+        $this->showHeaders();
+    }
+}
+
+ Ce qui nous permet de voir les entêtes reçues... +
+

File test

+
+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
+
+
1/1 test cases complete. + 0 passes, 0 fails and 0 exceptions.
+
+ 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... +
+class AuthenticationTest extends WebTestCase {
+    function test401Header() {
+        $this->get('http://www.lastcraft.com/protected/');
+        $this->assertAuthentication('Basic');
+        $this->assertResponse(401);
+        $this->assertRealm('SimpleTest basic authentication');
+    }
+}
+
+ N'importe laquelle de ces assertions suffirait, tout dépend de la masse de détails que vous souhaitez voir. +

+

+ 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 : +

+class AuthenticationTest extends WebTestCase {
+    function testAuthentication() {
+        $this->get('http://www.lastcraft.com/protected/');
+        $this->authenticate('Me', 'Secret');
+        $this->assertTitle(...);
+    }
+}
+
+ 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. +

+

+ Vous pouvez gagner une ligne en définissant l'authentification au niveau de l'URL... +

+class AuthenticationTest extends WebTestCase {
+    function testCanReadAuthenticatedPages() {
+        $this->get('http://Me:Secret@www.lastcraft.com/protected/');
+        $this->assertTitle(...);
+    }
+}
+
+ 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. +

+

+ 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. +

+ +

+ +

Cookies

+ +

+

+ 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. +

+

+ Commençons par un simple formulaire de connexion... +

+<form>
+    Username:
+    <input type="text" name="u" value="" /><br />
+    Password:
+    <input type="password" name="p" value="" /><br />
+    <input type="submit" value="Log in" />
+</form>
+
+ Lequel doit ressembler à... +

+

+

+ Username: + +
+ Password: + +
+ +
+

+

+ 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... +

+class LogInTest extends WebTestCase {
+    function testSessionCookieSetBeforeForm() {
+        $this->get('http://www.my-site.com/login.php');
+        $this->assertCookie('SID');
+    }
+}
+
+ 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. +

+

+ 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é : +

+class LogInTest extends WebTestCase {
+    ...
+    function testSessionCookieSameAfterLogIn() {
+        $this->get('http://www.my-site.com/login.php');
+        $session = $this->getCookie('SID');
+        $this->setField('u', 'Me');
+        $this->setField('p', 'Secret');
+        $this->clickSubmit('Log in');
+        $this->assertWantedPattern('/Welcome Me/');
+        $this->assertCookie('SID', $session);
+    }
+}
+
+ Ceci confirme que l'identifiant de session est identique avant et après la connexion. +

+

+ Nous pouvons même essayer de duper notre propre système en créant un cookie arbitraire pour se connecter... +

+class LogInTest extends WebTestCase {
+    ...
+    function testSessionCookieSameAfterLogIn() {
+        $this->get('http://www.my-site.com/login.php');
+        $this->setCookie('SID', 'Some other session');
+        $this->get('http://www.my-site.com/restricted.php');
+        $this->assertWantedPattern('/Access denied/');
+    }
+}
+
+ Votre site est-il protégé contre ce type d'attaque ? +

+ +

+ +

Sessions de navigateur

+ +

+

+ 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 : +

+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/');
+        
+        $this->restart();
+        $this->get('http://www.my-site.com/restricted.php');
+        $this->assertWantedPattern('/Access denied/');
+    }
+}
+
+ La méthode WebTestCase::restart() 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. +

+

+ 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... +

+

+ Afin de provoquer leur expiration, vous pouvez dater manuellement les cookies, avant le début de la session. +

+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/');
+        
+        $this->ageCookies(3600);
+        $this->restart();
+        $this->get('http://www.my-site.com/restricted.php');
+        $this->assertWantedPattern('/Access denied/');
+    }
+}
+
+ 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/browser_documentation.html b/tests/test_tools/simpletest/docs/fr/browser_documentation.html new file mode 100755 index 00000000..fa8ad1b6 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/browser_documentation.html @@ -0,0 +1,329 @@ + + + +Documentation SimpleTest : le composant de navigation web scriptable + + + + +

Documentation sur le navigateur scriptable

+
+ +

+ Le composant de navigation web de SimpleTest peut être utilisé non seulement à l'extérieur de la classe WebTestCase, mais aussi indépendamment du frameword SimpleTest lui-même. +

+ +

+ +

Le navigateur scriptable

+ +

+

+ 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 site web PHP... +

+<?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];
+?>
+
+ 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 file() 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. +

+

+ Toutes les méthode de navigation utilisées dans WebTestCase sont présente dans la classe SimpleBrowser, mais les assertions sont remplacées par de simples accesseurs. Voici une liste complète des méthodes de navigation de page à page... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
addHeader($header)Ajouter une entête à chaque téléchargement
useProxy($proxy, $username, $password)Utilise ce proxy à partir de maintenant
head($url, $parameters)Effectue une requête HEAD
get($url, $parameters)Télécharge une page avec un GET
post($url, $parameters)Télécharge une page avec un POST
clickLink($label)Suit un lien par son étiquette
isLink($label)Vérifie si un lien avec cette étiquette existe
clickLinkById($id)Suit un lien par son attribut d'identification
isLinkById($id)Vérifie si un lien avec cet attribut d'identification existe
getUrl()La page ou la fenêtre URL en cours
getTitle()Le titre de la page
getContent()Le page ou la fenêtre brute
getContentAsText()Sans code HTML à l'exception du text "alt"
retry()Répète la dernière requête
back()Utilise le bouton "précédent" du navigateur
forward()Utilise le bouton "suivant" du navigateur
authenticate($username, $password)Retente la page ou la fenêtre après une réponse 401
restart($date)Relance le navigateur pour une nouvelle session
ageCookies($interval)Change la date des cookies
setCookie($name, $value)Lance un nouveau cookie
getCookieValue($host, $path, $name)Lit le cookie le plus spécifique
getCurrentCookieValue($name)Lit le contenue du cookie en cours
+ Les méthode SimpleBrowser::useProxy() et SimpleBrowser::addHeader() sont spéciales. Une fois appellées, elles continuent à s'appliquer sur les téléchargements suivants. +

+

+ Naviguer dans les formulaires est similaire à la navigation des formulaires via WebTestCase... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setField($name, $value)Modifie tous les champs avec ce nom
setFieldById($id, $value)Modifie tous les champs avec cet identifiant
getField($name)Accesseur de la valeur d'un élément de formulaire
getFieldById($id)Accesseur de la valeur de l'élément de formulaire avec cet identifiant
clickSubmit($label)Transmet le formulaire avec l'étiquette de son bouton
clickSubmitByName($name)Transmet le formulaire avec l'attribut de son bouton
clickSubmitById($id)Transmet le formulaire avec l'identifiant de son bouton
clickImage($label, $x, $y)Clique sur l'image par son texte alternatif
clickImageByName($name, $x, $y)Clique sur l'image par son attribut
clickImageById($id, $x, $y)Clique sur l'image par son identifiant
submitFormById($id)Transmet le formulaire par son identifiant propre
+ 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. +

+

+ 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". + + + + + + + + + + + + + + + + + + +
getFrames()Un déchargement de la structure de la fenêtre courante
getFrameFocus()L'index ou l'étiquette de la fenêtre en courante
setFrameFocusByIndex($choice)Sélectionne la fenêtre numérotée à partir de 1
setFrameFocus($name)Sélectionne une fenêtre par son étiquette
clearFrameFocus()Traite toutes les fenêtres comme une seule page
+ 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. +

+ +

+ +

Où sont les erreurs ?

+ +

+

+ 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setConnectionTimeout($timeout)Ferme la socket avec un délai trop long
getRequest()L'entête de la requête brute de la page ou de la fenêtre
getHeaders()L'entête de réponse de la page ou de la fenêtre
getTransportError()N'importe quel erreur au niveau de la socket dans le dernier téléchargement
getResponseCode()La réponse HTTP de la page ou de la fenêtre
getMimeType()Le type Mime de la page our de la fenêtre
getAuthentication()Le type d'authenficiation dans l'entête d'une provocation 401
getRealm()Le realm d'authentification dans l'entête d'une provocation 401
setMaximumRedirects($max)Nombre de redirection avant que la page ne soit chargée automatiquement
setMaximumNestedFrames($max)Protection contre des framesets récursifs
ignoreFrames()Neutralise le support des fenêtres
useFrames()Autorise le support des fenêtres
+ Les méthodes SimpleBrowser::setConnectionTimeout(), SimpleBrowser::setMaximumRedirects(),SimpleBrowser::setMaximumNestedFrames(), SimpleBrowser::ignoreFrames() et SimpleBrowser::useFrames() 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 SimpleBrowser::setFrameFocus() : ensuite on utilisera SimpleBrowser::getRequest(), etc. pour voir ce qui se passe. +

+ +

+ +

Tests unitaires complexes avec des navigateurs multiples

+ +

+

+ Tout ce qui peut être fait dans WebTestCase peut maintenant être fait dans un UnitTestCase. Ce qui revient à dire que nous pouvons librement mélanger des tests sur des objets de domaine avec l'interface web... +

+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');
+    }
+}
+
+ 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. +

+

+ Un cas plus utile d'utilisation directe du navigateur est le moment où le WebTestCase ne peut plus suivre. Un exemple ? Quand deux navigateurs doivent être utilisés en même temps. +

+

+ 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... +

+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');
+    }
+}
+
+ Vous pouvez aussi utiliser la classe SimpleBrowser quand vous souhaitez écrire des scénarios de test en utilisant un autre outil que SimpleTest. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/docs.css b/tests/test_tools/simpletest/docs/fr/docs.css new file mode 100755 index 00000000..93226cd7 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/docs.css @@ -0,0 +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%; +} diff --git a/tests/test_tools/simpletest/docs/fr/expectation_documentation.html b/tests/test_tools/simpletest/docs/fr/expectation_documentation.html new file mode 100755 index 00000000..ab9ef606 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/expectation_documentation.html @@ -0,0 +1,263 @@ + + + +Documentation SimpleTest : étendre le testeur unitaire avec des classes d'attentes supplémentaires + + + + +

Documentation sur les attentes

+
+

+ +

Plus de contrôle sur les objets fantaisie

+ +

+

+ Le comportement par défaut des objets fantaisie dans SimpleTest 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. +

+

+ 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. +

+

+ Voici un cas concret, nous avons un service d'actualités qui a échoué dans sa tentative de connexion à sa source distante. +

+class NewsService {
+    ...
+    function publish(&$writer) {
+        if (! $this->isConnected()) {
+            $writer->write('Cannot connect to news service "' .
+                    $this->_name . '" at this time. ' .
+                    'Please try again later.');
+        }
+        ...
+    }
+}
+
+ Là il envoie son contenu vers un classe Writer. Nous pourrions tester ce comportement avec un MockWriter... +
+class TestOfNewsService extends UnitTestCase {
+    ...
+    function testConnectionFailure() {
+        $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();
+    }
+}
+
+ 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é. +

+

+ 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... +

+class TestOfNewsService extends UnitTestCase {
+    ...
+    function testConnectionFailure() {
+        $writer = &new MockWriter($this);
+        $writer->expectOnce(
+                'write',
+                array(new WantedPatternExpectation('/cannot connect/i')));
+        
+        $service = &new NewsService('BBC News');
+        $service->publish($writer);
+        
+        $writer->tally();
+    }
+}
+
+ Plutôt que de transmettre le paramètre attendu au MockWriter, nous envoyons une classe d'attente appelée WantedPatternExpectation. 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. +

+

+ WantedPatternExpectation utilise l'expression rationnelle pour la comparaison avec son constructeur. A chaque fois q'une comparaison est fait à travers MockWriter par rapport à cette classe attente, elle fera un preg_match() 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. +

+

+ Les classes attente possibles sont... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualExpectationUne égalité, plutôt que la plus forte comparaison à l'identique
NotEqualExpectationUne comparaison sur la non-égalité
IndenticalExpectationLa vérification par défaut de l'objet fantaisie qui doit correspondre exactement
NotIndenticalExpectationInverse la logique de l'objet fantaisie
WantedPatternExpectationUtilise une expression rationnelle Perl pour comparer une chaîne
NoUnwantedPatternExpectationPasse seulement si l'expression rationnelle Perl échoue
IsAExpectationVérifie le type ou le nom de la classe uniquement
NotAExpectationL'opposé de IsAExpectation
MethodExistsExpectationVérifie si la méthode est disponible sur un objet
+ La plupart utilisent la valeur attendue dans le constructeur. Les exceptions sont les vérifications sur motif, qui utilisent une expression rationnelle, ainsi que IsAExpectation et NotAExpectation, qui prennent un type ou un nom de classe comme chaîne. +

+ +

+ +

Utiliser les attentes pour contrôler les bouchons serveur

+ +

+

+ Les classes attente peuvent servir à autre chose que l'envoi d'assertions depuis les objets fantaisie, afin de choisir le comportement d'un objet fantaisie our celui d'un bouchon serveur. A chaque fois qu'une liste d'arguments est donnée, une liste d'objets attente peut être insérée à la place. +

+

+ 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... +

+Stub::generate('Authorisation');
+
+$authorisation = new StubAuthorisation();
+$authorisation->setReturnValue(
+        'isAllowed',
+        true,
+        array(new IsAExpectation('Session', 'Must be a session')));
+$authorisation->setReturnValue('isAllowed', false);
+
+ Le comportement par défaut du bouchon serveur est défini pour renvoyer false quand isAllowed est appelé. Lorsque nous appelons cette méthode avec un unique paramètre qui est un objet Session, il renverra true. 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. +

+

+ Ce niveau de sophistication est rarement utile : il n'est inclut que pour être complet. +

+ +

+ +

Créer vos propres attentes

+ +

+

+ 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. +

+

+ 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 SimpleExpectation... +

+class ValidIp extends SimpleExpectation {
+    
+    function test($ip) {
+        return (ip2long($ip) != -1);
+    }
+    
+    function testMessage($ip) {
+        return "Address [$ip] should be a valid IP address";
+    }
+}
+
+ Il n'y a véritablement que deux méthodes à mettre en place. La méthode test() devrait renvoyer un true si l'attente doit passer, et une erreur false dans le cas contraire. La méthode testMessage() ne devrait renvoyer que du texte utile à la compréhension du test en lui-même. +

+

+ Cette classe peut désormais être employée à la place des classes d'attente précédentes. +

+ +

+ +

Sous le capot du testeur unitaire

+ +

+

+ Le frameworkd de test unitaire SimpleTest utilise aussi dans son coeur des classes d'attente pour la classe UnitTestCase. 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. +

+

+ La méthode la plus directe est d'utiliser la méthode SimpleTest::assertExpectation() pour effectuer le test... +

+class TestOfNetworking extends UnitTestCase {
+    ...
+    function testGetValidIp() {
+        $server = &new Server();
+        $this->assertExpectation(
+                new ValidIp(),
+                $server->getIp(),
+                'Server IP address->%s');
+    }
+}
+
+ C'est plutôt sale par rapport à notre syntaxe habituelle du type assert...(). +

+

+ 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... +

+class TestOfNetworking extends UnitTestCase {
+    ...
+    function assertValidIp($ip, $message = '%s') {
+        $this->assertExpectation(new ValidIp(), $ip, $message);
+    }
+    
+    function testGetValidIp() {
+        $server = &new Server();
+        $this->assertValidIp(
+                $server->getIp(),
+                'Server IP address->%s');
+    }
+}
+
+ 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/form_testing_documentation.html b/tests/test_tools/simpletest/docs/fr/form_testing_documentation.html new file mode 100755 index 00000000..f9f5d0df --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/form_testing_documentation.html @@ -0,0 +1,235 @@ + + + +Documentation SimpleTest : tester des formulaires HTML + + + + +

Documentation sur les tests de formulaire

+
+

+ +

Valider un formulaire simple

+ +

+

+ Lorsqu'une page est téléchargée par WebTestCase en utilisant get() ou post() 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... +

+<form>
+    <input type="text" name="a" value="A default" />
+    <input type="submit" value="Go" />
+</form>
+
+ Il ressemble à... +

+

+

+ + +
+

+

+ Nous pouvons naviguer vers ce code, via le site LastCraft, avec le test suivant... +

+class SimpleFormTests extends WebTestCase {
+    
+    function testDefaultValue() {
+        $this->get('http://www.lastcraft.com/form_testing_documentation.php');
+        $this->assertField('a', 'A default');
+    }
+}
+
+ 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". +

+

+ 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... +

+class SimpleFormTests extends WebTestCase {
+
+    function testDefaultValue() {
+        $this->get('http://www.my-site.com/');
+        $this->assertField('a', 'A default');
+        $this->setField('a', 'New value');
+        $this->clickSubmit('Go');
+    }
+}
+
+ 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 GET 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 HTMLTidy devraient être employés. +

+

+ Si un champ manque dans n'importe que formulaire ou si une option est indisponible alors WebTestCase::setField() renverra false. Par exemple, supposons que nous souhaitons vérifier qu'une option "Superuser" n'est pas présente dans ce formulaire... +

+<strong>Select type of user to add:</strong>
+<select name="type">
+    <option>Subscriber</option>
+    <option>Author</option>
+    <option>Administrator</option>
+</select>
+
+ Qui ressemble à... +

+

+

+ Select type of user to add: + +
+

+

+ Le test suivant le confirmera... +

+class SimpleFormTests extends WebTestCase {
+    ...
+    function testNoSuperuserChoiceAvailable() {
+        $this->get('http://www.lastcraft.com/form_testing_documentation.php');
+        $this->assertFalse($this->setField('type', 'Superuser'));
+    }
+}
+
+ La sélection ne sera pas changée suite à un échec d'initialisation d'une valeur sur un objet. +

+

+ Voici la liste complète des objets supportés à aujourd'hui... +

    +
  • Champs texte, y compris les champs masqués (hidden) ou cryptés (password).
  • +
  • Boutons submit, en incluant aussi la balise button, mais pas encore les boutons reset
  • +
  • Aires texte (textarea) avec leur gestion des retours à la ligne (wrap).
  • +
  • Cases à cocher, y compris les cases à cocher multiples dans un même formulaire.
  • +
  • Listes à menu déroulant, y compris celles à sélections multiples.
  • +
  • Boutons radio.
  • +
  • Images.
  • +
+

+

+ Bien que la plupart des objets HTML standards soient couvert par le parseur de SimpleTest, il est peu probable que JavaScript soit implémenté dans un futur proche. +

+ +

+ +

Champs à valeurs multiples

+ +

+

+ 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... +

+<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>
+
+ Qui se traduit par... +

+

+

+ Create privileges allowed: + +
+ Retrieve privileges allowed: + +
+ Update privileges allowed: + +
+ Destroy privileges allowed: + +
+ +
+

+

+ 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... +

+class SimpleFormTests extends WebTestCase {
+    ...
+    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');
+    }
+}
+
+ 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. +

+

+ +

Envoi brut

+ +

+

+ 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. +

+class SimpleFormTests extends WebTestCase {
+    ...    
+    function testAttemptedHack() {
+        $this->post(
+                'http://www.my-site.com/add_user.php',
+                array('type' => 'superuser'));
+        $this->assertNoUnwantedPattern('/user created/i');
+    }
+}
+
+ En ajoutant des données à la méthode WebTestCase::post(), nous essayons de télécharger la page via la transmission d'un formulaire. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/group_test_documentation.html b/tests/test_tools/simpletest/docs/fr/group_test_documentation.html new file mode 100755 index 00000000..662f868e --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/group_test_documentation.html @@ -0,0 +1,288 @@ + + + +Documentation SimpleTest : Grouper des tests + + + + +

Documentation sur le groupement des tests

+
+

+ +

Grouper des tests

+ +

+

+ Pour lancer les scénarios de tests en tant que groupe, ils devraient être placés dans des fichiers sans le code du lanceur... +

+<?php
+    require_once('../classes/io.php');
+
+    class FileTester extends UnitTestCase {
+        ...
+    }
+
+    class SocketTester extends UnitTestCase {
+        ...
+    }
+?>
+
+ 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. +

+

+ Si vous avez étendu l'un ou l'autre des scénarios de test, vous pouvez aussi les inclure. +

+<?php
+    require_once('../classes/io.php');
+
+    class MyFileTestCase extends UnitTestCase {
+        ...
+    }
+    SimpleTestOptions::ignore('MyFileTestCase');
+
+    class FileTester extends MyFileTestCase {
+        ...
+    }
+
+    class SocketTester extends UnitTestCase {
+        ...
+    }
+?>
+
+ La classe FileTester 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 SimpleTestOptions::ignore() 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 file_test.php. +

+

+ Ensuite nous créons un fichier de groupe de test, disons group_test.php. Vous penserez à un nom plus convaincant, j'en suis sûr. Nous lui ajoutons le fichier de test avec une méthode sans risque... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('file_test.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestCase(new FileTestCase());
+    $test->run(new HtmlReporter());
+?>
+
+ 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... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('file_test.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestClass('FileTestCase');
+    $test->run(new HtmlReporter());
+?>
+
+ Le problème de cette technique est que pour chaque scénario de test supplémentaire nous aurons à require_once() le fichier de code de test et à manuellement instancier chaque scénario de test. Nous pouvons nous épargner beaucoup de dactylographie avec... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestFile('file_test.php');
+    $test->run(new HtmlReporter());
+?&gt;
+
+ Voici ce qui vient de se passer : la classe GroupTest a réalisé le require_once() 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. +

+

+ Il y a deux choses qui peuvent planter et qui demandent un minimum d'attention... +

    +
  1. + 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. +
  2. +
  3. + 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 SimpleTestOptions::ignore() pour ces classes ou alors pensez à les ajouter avant la ligne GroupTest::addTestFile(). +
  4. +
+

+ +

+ +

Groupements de plus haut niveau

+ +

+

+ 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. +

+

+ Pour obtenir un groupe de test plus souple nous pouvons sous classer GroupTest et ensuite l'instancier au cas par cas... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    
+    class FileGroupTest extends GroupTest {
+        function FileGroupTest() {
+            $this->GroupTest('All file tests');
+            $this->addTestFile('file_test.php');
+        }
+    }
+?>
+
+ 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... +
+<?php
+    require_once('file_group_test.php');
+    
+    $test = &new FileGroupTest();
+    $test->run(new HtmlReporter());
+?>
+
+ ...ou alors nous pouvons les grouper dans un groupe de tests encore plus grand... +
+<?php
+    require_once('file_group_test.php');
+    
+    $test = &new BigGroupTest('Big group');
+    $test->addTestCase(new FileGroupTest());
+    $test->addTestCase(...);
+    $test->run(new HtmlReporter());
+?>
+
+ 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. +
+<?php
+    class FileGroupTest extends GroupTest {
+        function FileGroupTest() {
+            $this->GroupTest('All file tests');
+            $test->addTestFile('file_test.php');
+        }
+    }
+    
+    if (! defined('RUNNER')) {
+        define('RUNNER', true);
+        $test = &new FileGroupTest();
+        $test->run(new HtmlReporter());
+    }
+?>
+
+ 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 run() ne sera lancé qu'une seule fois à partir du script de haut niveau qui l'a invoqué. +
+<?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());
+?>
+
+ Comme les scénarios de test normaux, un GroupTest peut être chargé avec la méthode GroupTest::addTestFile(). +
	
+<?php	
+    define('RUNNER', true);	
+ 	 	
+    $test = &new BigGroupTest('Big group');	
+    $test->addTestFile('file_group_test.php');	
+    $test->addTestFile(...);	
+    $test->run(new HtmlReporter());	
+?>	
+
+

+ +

+ +

Intégrer des scénarios de test hérités

+ +

+

+ 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. +

+

+ Par exemple, supposons que nous ayons ce scénario de test prévu pour PhpUnitdans le fichier config_test.php... +

+class ConfigFileTest extends TestCase {
+    function ConfigFileTest() {
+        $this->TestCase('Config file test');
+    }
+    
+    function testContents() {
+        $config = new ConfigFile('test.conf');
+        $this->assertRegexp('/me/', $config->getValue('username'));
+    }
+}
+
+ Le groupe de test peut le reconnaître à partir du moment où nous mettons l'adaptateur approprié avant d'ajouter le fichier de test... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('simpletest/adapters/phpunit_test_case.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestFile('config_test.php');
+    $test->run(new HtmlReporter());
+?>
+
+ Il n'y a que deux adaptateurs, l'autre est pour le paquet testeur unitaire de PEAR... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('simpletest/adapters/pear_test_case.php');
+
+    $test = &new GroupTest('All file tests');
+    $test->addTestFile('some_pear_test_cases.php');
+    $test->run(new HtmlReporter());
+?>
+
+ 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/index.html b/tests/test_tools/simpletest/docs/fr/index.html new file mode 100755 index 00000000..f4b2ad93 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/index.html @@ -0,0 +1,343 @@ + + + + + Télécharger le framework de tests Simple Test - Tests unitaire et objets fantaisie pour PHP + + + + + +

Simple Test pour PHP

+
+ +

+ 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 SimpleTest. Pour une documentation plus complète, particulièrement si vous découvrez les tests unitaires, consultez la documentation en cours, et pour des exemples de scénarios de test, consultez le tutorial sur les tests unitaires. +

+ +

+ +

Utiliser le testeur rapidement

+ +

+

+ 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 JUnit et des PHPUnit, mais elle inclut aussi les objets fantaisie ou "mock objects". Sans compter quelques fonctionnalités de JWebUnit : parmi celles-ci la navigation sur des pages web, les tests sur les cookies et l'envoi de formulaire. +

+

+ La démonstration la plus rapide : l'exemple +

+

+ Supposons que nous sommes en train de tester une simple classe de log dans un fichier : elle s'appelle Log dans classes/Log.php. Commençons par créer un script de test, appelé tests/log_test.php. Son contenu est le suivant... +

+<?php
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/reporter.php');
+require_once('../classes/log.php');
+?>
+
+ Ici le répertoire simpletest 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... +
+<?php
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/reporter.php');
+require_once('../classes/log.php');
+
+class TestOfLogging extends UnitTestCase {
+}
+?>
+
+ 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 Log prenne le nom du fichier à écrire dans le constructeur et que nous ayons un répertoire temporaire dans lequel placer ce fichier... +
+<?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'));
+    }
+}
+?>
+
+ Au lancement du scénario de test, toutes les méthodes qui commencent avec la chaîne test 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é. +

+

+ 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... +

+<?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'));
+    }
+}
+
+$test = &new TestOfLogging();
+$test->run(new HtmlReporter());
+?>
+
+

+

+ En cas échec, l'affichage ressemble à... +

+

testoflogging

+ Fail: testcreatingnewfile->True assertion failed.
+
1/1 test cases complete. + 1 passes and 1 fails.
+
+ ...et si ça passe, on obtient... +
+

testoflogging

+
1/1 test cases complete. + 2 passes and 0 fails.
+
+ Et si vous obtenez ça... +
+ Fatal error: Failed opening required '../classes/log.php' (include_path='') in /home/marcus/projects/lastcraft/tutorial_tests/Log/tests/log_test.php on line 7 +
+ c'est qu'il vous manque le fichier classes/Log.php qui pourrait ressembler à : +
+<?php
+class Log {
+    
+        function Log($file_path) {
+        }
+}
+?>;
+
+

+ +

+ +

Construire des groupes de tests

+ +

+

+ 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. +

+

+ Notre première étape est de supprimer les includes et de défaire notre hack précédent... +

+<?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'));
+    }
+}
+?>
+
+ Ensuite nous créons un nouveau fichier appelé tests/all_tests.php. On y insert le code suivant... +
+<?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());
+?>
+
+ Cette méthode GroupTest::addTestFile() va inclure le fichier de scénarios de test et lire parmi toutes les nouvelles classes créées celles qui sont issues de TestCase. 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. +

+

+ 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 SimpleTestOptions::ignore() 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 GroupTest::addTestFile() ne pourra pas les détecter. +

+

+ Pour afficher les résultats, il est seulement nécessaire d'invoquer tests/all_tests.php à partir du serveur web. +

+ +

+ +

Utiliser les objets fantaisie

+ +

+

+ Avançons un peu plus dans le futur. +

+

+ 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 SessionPool. Nous voulons tester une méthode qui ressemblera probablement à quelque chose comme... +

+
+class SessionPool {
+    ...
+    function logIn($username) {
+        ...
+        $this->_log->message('User $username logged in.');
+        ...
+    }
+    ...
+}
+
+
+ Avec le concept de "réutilisation de code" comme fil conducteur, nous utilisons notre class Log. Un scénario de test classique ressemblera peut-être à... +
+
+<?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");
+    }
+}
+?>
+
+ 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 Log et ce test. Que se passerait-il si nous n'utilisions plus de fichiers, mais la bibliothèque syslog à 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 ? +

+

+ 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. +

+

+ 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. +

+

+ Trop beau pour être vrai ? Par chance on peut créer un tel objet très facilement... +
+<?php
+require_once('../classes/log.php');
+require_once('../classes/session_pool.php');
+Mock::generate('Log');
+
+class TestOfSessionLogging extends UnitTestCase {
+    
+    function testLogInIsLogged() {
+        $log = &new MockLog($this);
+        $log->expectOnce('message', array('User fred logged in.'));
+        $session_pool = &new SessionPool($log);
+        $session_pool->logIn('fred');
+        $log->tally();
+    }
+}
+?>
+
+ L'appel tally() 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 à message() est invoqué sur l'objet MockLog. L'appel mock 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. +

+

+ 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. +

+

+ Pour que ce test fonctionne la librairie avec les objets fantaisie doit être incluse dans la suite de tests, par exemple dans all_tests.php. +

+ +

+ +

Tester une page web

+ +

+

+ 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. +

+

+ 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. +

+<?php
+require_once('simpletest/web_tester.php');
+require_once('simpletest/reporter.php');
+
+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');
+    }
+}
+$test = &new TestOfAbout();
+$test->run(new HtmlReporter());
+?>
+
+ 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. +

+

+ SourceForge.net Logo +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/mock_objects_documentation.html b/tests/test_tools/simpletest/docs/fr/mock_objects_documentation.html new file mode 100755 index 00000000..0ce48bc9 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/mock_objects_documentation.html @@ -0,0 +1,492 @@ + + + +Documentation SimpleTest : les objets fantaise + + + + +

Documentation sur les objets fantaisie

+
+

+ +

Que sont les objets fantaisie ?

+ +

+

+ Les objets fantaisie - ou "mock objects" en anglais - ont deux rôles pendant un scénario de test : acteur et critique. +

+

+ 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. +

+

+ Si les objets fantaisie ne se comportaient que comme des acteurs alors on les connaîtrait sous le nom de bouchons serveur. +

+

+ 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. +

+ +

+ +

Créer des objets fantaisie

+ +

+

+ 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 à... +

+class DatabaseConnection {
+    function DatabaseConnection() {
+    }
+    
+    function query() {
+    }
+    
+    function selectQuery() {
+    }
+}
+
+ 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... +
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+
+Mock::generate('DatabaseConnection');
+
+ Ceci génère une classe clone appelée MockDatabaseConnection. Nous pouvons désormais créer des instances de cette nouvelle classe à l'intérieur même de notre scénario de test... +
+require_once('simpletest/unit_tester.php');
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+
+Mock::generate('DatabaseConnection');
+
+class MyTestCase extends UnitTestCase {
+    
+    function testSomething() {
+        $connection = &new MockDatabaseConnection($this);
+    }
+}
+
+ 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. +

+

+ +

Objets fantaisie en action

+ +

+

+ La version fantaisie d'une classe contient toutes les méthodes de l'originale. De la sorte une opération comme $connection->query() est encore possible. Tout comme avec les bouchons, nous pouvons remplacer la valeur nulle renvoyée par défaut... +

+$connection->setReturnValue('query', 37);
+
+ Désormais à chaque appel de $connection->query() 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... +
+Mock::generate('DatabaseConnection', 'MyMockDatabaseConnection', array('setOptions'));
+
+ Ici l'objet fantaisie se comportera comme si setOptions() existait dans la classe originale. C'est pratique si une classe a utilisé le mécanisme overload() de PHP pour ajouter des méthodes dynamiques. Vous pouvez créer des fantaisies spéciales pour simuler cette situation. +

+

+ Tous les modèles disponibles avec les bouchons serveur le sont également avec les objets fantaisie... +

+class Iterator {
+    function Iterator() {
+    }
+    
+    function next() {
+    }
+}
+
+ Une nouvelle fois, supposons que cet itérateur ne retourne que du texte jusqu'au moment où il atteint son terme, quand il renvoie false. Nous pouvons le simuler avec... +
+Mock::generate('Iterator');
+
+class IteratorTest extends UnitTestCase() {
+    
+    function testASequence() {
+        $iterator = &new MockIterator($this);
+        $iterator->setReturnValue('next', false);
+        $iterator->setReturnValueAt(0, 'next', 'First string');
+        $iterator->setReturnValueAt(1, 'next', 'Second string');
+        ...
+    }
+}
+
+ Au moment du premier appel à next() 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 false 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. +

+

+ Reprenons aussi le conteneur d'information bouchonné avec des pairs clef / valeur... +

+class Configuration {
+    function Configuration() {
+    }
+    
+    function getValue($key) {
+    }
+}
+
+ 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 getValue() et que nous voulons des résultats différents pour des clefs différentes. Heureusement les objets fantaisie ont un système de filtrage... +
+$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'));
+
+ 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 getValue() est invoquée sur l'objet fantaisie... +
+$config->getValue('db_user')
+
+ ...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. +

+

+ 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... +

+class Thing {
+}
+
+class Vector {
+    function Vector() {
+    }
+    
+    function get($index) {
+    }
+}
+
+ Dans ce cas vous pouvez placer une référence dans la liste renvoyée par l'objet fantaisie... +
+$thing = new Thing();
+$vector = &new MockVector($this);
+$vector->setReturnReference('get', $thing, array(12));
+
+ Avec cet arrangement vous savez qu'à chaque appel de $vector->get(12) le même $thing sera renvoyé. +

+ +

+ +

Objets fantaisie en critique

+ +

+

+ 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. +

+

+ Pour l'exemple, prenons une classe SessionPool à 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 SessionPool ressemble à... +

+class SessionPool {
+    function SessionPool() {
+        ...
+    }
+    
+    function &findSession($cookie) {
+        ...
+    }
+    ...
+}
+
+class Session {
+    ...
+}
+
+
+ Alors que pour notre code de log, nous avons... +
+
+class Log {
+    function Log() {
+        ...
+    }
+    
+    function message() {
+        ...
+    }
+}
+
+class LoggingSessionPool {
+    function LoggingSessionPool(&$session_pool, &$log) {
+        ...
+    }
+    
+    function &findSession(\$cookie) {
+        ...
+    }
+    ...
+}
+
+ Dans tout ceci, la seule classe à tester est LoggingSessionPool. En particulier, nous voulons vérifier que la méthode findSession() 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. +

+

+ 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 : +

    +
  1. Créer un objet de log.
  2. +
  3. Indiquer le répertoire d'écriture du fichier de log.
  4. +
  5. Modifier les droits sur le répertoire pour pouvoir y écrire le fichier.
  6. +
  7. Créer un objet SessionPool.
  8. +
  9. Lancer une session, ce qui demande probablement pas mal de choses.
  10. +
  11. Invoquer findSession().
  12. +
  13. Lire le nouvel identifiant de sessions (en espérant qu'il existe un accesseur !).
  14. +
  15. Lever une assertion de test pour vérifier que cet identifiant correspond bien au cookie.
  16. +
  17. Lire la dernière ligne du fichier de log.
  18. +
  19. Supprimer avec une (ou plusieurs) expression rationnelle les timestamps de log en trop, etc.
  20. +
  21. Vérifier que le message de session est bien dans le texte.
  22. +
+ 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. +

+

+ A la place, voici la méthode complète pour le test avec un peu de magie via les objets fantaisie... +

+Mock::generate('Session');
+Mock::generate('SessionPool');
+Mock::generate('Log');
+
+class LoggingSessionPoolTest extends UnitTestCase {
+    ...
+    function testFindSessionLogging() {
+        $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();
+    }
+}
+
+ 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. +

+

+ findSession() est un méthode fabrique dont la simulation est décrite plus haut. Le point de départ vient avec le premier appel expectOnce(). Cette ligne indique qu'à chaque fois que findSession() 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. +

+

+ 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 tally() à la fin du test. +

+

+ Nous utilisons le même modèle pour mettre sur pied le loggueur fantaisie. Nous lui indiquons que message() 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. +

+

+ Nous commençons le lancement nos tests à la création du nouveau LoggingSessionPool et nous l'alimentons avec nos objets fantaisie juste créés. Désormais tout est sous contrôle. Au final nous confirmons que le $session 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 tally(). +

+

+ 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 setUp(). +

+

+ Voici la liste complète des attentes que vous pouvez placer sur un objet fantaisie avec SimpleTest... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttenteNécessite tally()
expectArguments($method, $args)Non
expectArgumentsAt($timing, $method, $args)Non
expectCallCount($method, $count)Oui
expectMaximumCallCount($method, $count)Non
expectMinimumCallCount($method, $count)Oui
expectNever($method)Non
expectOnce($method, $args)Oui
expectAtLeastOnce($method, $args)Oui
+ Où les paramètres sont... +

+
$method
+
Le nom de la méthode, sous la forme d'une chaîne, à laquelle la condition doit être appliquée.
+
$args
+
+ Les arguments sous la forme d'une liste. Les jokers peuvent être inclus de la même manière qu'avec setReturn(). Cet argument est optionel pour expectOnce() et expectAtLeastOnce(). +
+
$timing
+
+ Le seul point dans le temps pour tester la condition. Le premier appel commence à zéro. +
+
$count
+
Le nombre d'appels attendu.
+
+ La méthode expectMaximumCallCount() 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. +

+

+ 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". +

+ +

+ +

D'autres approches

+ +

+

+ 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. +

+

+ Les objets fantaisie générés avec SimpleTest sont dynamiques. Ils sont créés à l'exécution dans la mémoire, grâce à eval(), 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. +

+

+ 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. +

+

+ 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 mocks/connection.php 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... +

+<?php
+    require_once('simpletest/mock_objects.php');
+    require_once('../classes/connection.php');
+
+    Mock::generate('Connection', 'BasicMockConnection');
+    class MockConnection extends BasicMockConnection {
+        function MockConnection(&$test, $wildcard = '*') {
+            $this->BasicMockConnection($test, $wildcard);
+            $this->setReturn('query', false);
+        }
+    }
+?>
+
+ L'appel generate dit au générateur de classe d'en créer une appelée BasicMockConnection plutôt que la plus courante MockConnection. Ensuite nous héritons à partir de celle-ci pour obtenir notre version de MockConnection. En interceptant de cette manière nous pouvons ajouter un comportement, ici transformer la valeur par défaut de query() 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 MockConnection 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. +

+

+ 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. +

+ +

+ +

Je pense que SimpleTest pue !

+ +

+

+ Mais au moment d'écrire ces lignes c'est le seul à gérer les objets fantaisie, donc vous êtes bloqué avec lui ? +

+

+ Non, pas du tout. + SimpleTest 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 à... +

+class PHPUnit {
+    function PHPUnit() {
+    }
+    
+    function assertion($message, $assertion) {
+    }
+    ...
+}
+
+ La seule chose que la méthode assertion() 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... +
+$unit_test = new PHPUnit();
+$unit_test>assertion('I hope this file exists', file_exists('my_file'));
+
+ Comment utiliser les objets fantaisie avec ceci ? +

+

+ Il y a une méthode protégée sur la classe de base des objets fantaisie : elle s'appelle _assertTrue(). En surchargeant cette méthode nous pouvons utiliser notre propre format d'assertion. Nous commençons avec une sous-classe, dans my_mock.php... +

+<?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);
+        }
+    }
+?>
+
+ Maintenant une instance de MyMock 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... +
+<?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);
+        }
+    }
+    SimpleTestOptions::setMockBaseClass('MyMock');
+?>
+
+ A partir de maintenant vous avez juste à inclure my_mock.php à la place de la version par défaut simple_mock.php et vous pouvez introduire des objets fantaisie dans votre suite de tests existants. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/overview.html b/tests/test_tools/simpletest/docs/fr/overview.html new file mode 100755 index 00000000..b6965753 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/overview.html @@ -0,0 +1,294 @@ + + + + + Aperçu et liste des fonctionnalités des testeurs unitaires PHP et web de SimpleTest PHP + + + + + +

Apercu de SimpleTest

+
+

+ +

Qu'est-ce que SimpleTest ?

+ +

+

+ 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 run() à 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, assertEqual() 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. +

+

+ Un scénario de test ressemble à... +

+class MyTestCase extends UnitTestCase {
+    
+    function testLog() {
+        $log = &new Log('my.log');
+        $log->message('Hello');
+        $this->assertTrue(file_exists('my.log'));
+    }
+}
+
+

+

+ 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. +

+

+ Le type de scénario de test le plus simple est le UnitTestCase. 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. +

+

+ 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 WebTestCase 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. +

+

+ Un scénario de test web ressemble à... +

+class MySiteTest extends WebTestCase {
+    
+    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/');
+    }
+}
+
+

+ +

+ +

Liste des fonctionnalites

+ +

+

+ 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". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FonctionnalitéDescriptionPublication
Scénariot de test unitaireLes classes de test et assertions de baseFini
Affichage HTMLL'affichage le plus simple possibleFini
Autochargement des scénarios de testLire un fichier avec des scénarios de test et les charger dans un groupe de test automatiquementFini
Générateur de code d'objets fantaisieDes objets capable de simuler d'autres objets, supprimant les dépendances dans les testsFini
Bouchons serveurDes objets fantaisie sans résultat attendu à utiliser à l'extérieur des scénarios de test, pour le prototypage par exemple.Fini
Intégration d'autres testeurs unitaires + La capacité de lire et simuler d'autres scénarios de test en provenance de PHPUnit et de PEAR::Phpunit.Fini
Scénario de test webAppariement basique de motifs dans une page téléchargée.Fini
Analyse de page HTMLPermet de suivre les liens et de trouver la balise de titreFini
Simulacre partielSimuler des parties d'une classe pour tester moins qu'une classe ou dans des cas complexes.Fini
Gestion des cookies WebGestion correcte des cookies au téléchargement d'une page.Fini
Suivi des redirectionsLe téléchargement d'une page suit automatiquement une redirection 300.Fini
Analyse d'un formulaireLa capacité de valider un formulaire simple et d'en lire les valeurs par défaut.Fini
Interface en ligne de commandeAffiche le résultat des tests sans navigateur web.Fini
Mise à nu des attentes d'une classePeut créer des tests précis avec des simulacres ainsi que des scénarios de test.Fini
Sortie et analyse XMLPermet de tester sur plusieurs hôtes et d'intégrer des extensions d'acceptation de test.Fini
Scénario de test en ligne de commandePermet de tester des outils ou scripts en ligne de commande et de manier des fichiers.Fini
Compatibilité avec PHP DocumentorGénération automatique et complète de la documentation au niveau des classes.Fini
Interface navigateurMise à nu des niveaux bas de l'interface du navigateur web pour des scénarios de test plus précis.Fini
Authentification HTTPTéléchargement des pages web protégées avec une authentification basique seulement.Fini
Boutons de navigation d'un navigateurArrière, avant et recommencerFini
Support de SSLPeut se connecter à des pages de type https.Fini
Support de proxyPeut se connecter via des proxys communsFini
Support des cadresGère les cadres dans les scénarios de test web.Fini
Amélioration de l'affichage des testsUne meilleure interface graphique web, avec un arbre des scénarios de test.1.1
LocalisationAbstraction des messages et génration du code à partir de fichiers XML.1.1
Simulation d'interfacePeut générer des objets fantaisie tant vers des interfaces que vers des classes.2.0
Test sur es exceptionsDans le même esprit que sur les tests des erreurs PHP.2.0
Rercherche d'éléments avec XPathPeut utiliser Tidy HTML pour un appariement plus rapide et plus souple.2.0
Test de l'upload de fichierPeut simuler la balise input de type file2.0
+ 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. +

+ +

+ +

Ressources sur le web pour les tests

+ +

+

+ 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'Extreme Programming. Il s'agit là d'une des méthodes agiles qui combinent plusieurs pratiques pour "lisser la courbe de coût" du développement logiciel. La plus extrème reste le développement piloté par les tests, où vous devez adhérer à la règle du pas de code avant d'avoir un test. 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 RUP. Je ne l'ai pas testé mais je peux voir où vous aurez besoin d'outils de test (cf. illustration 9). +

+

+ La plupart des testeurs unitaires sont dans une certaine mesure un clone de JUnit, au moins dans l'interface. Il y a énormément d'information sur le site de JUnit, à commencer par la FAQ 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 infecté par les tests trouvée par Eric Gamma. Si vous êtes encore en train de tergiverser sur un testeur unitaire, sachez que les choix principaux sont PHPUnit et Pear PHP::PHPUnit. 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 JUnit. +

+

+ 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 WACT et PEAR::XML_HTMLSax. +

+

+ 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'article original sur les objets fantaisie 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 Extreme Tuesday ou www.mockobjects.comou the original C2 Wiki. Injecter des objets fantaisie dans une classe est un des champs principaux du débat : cet article chez IBM en est un bon point de départ. +

+

+ 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 HTTPUnit, HTMLUnit ou JWebUnit 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/partial_mocks_documentation.html b/tests/test_tools/simpletest/docs/fr/partial_mocks_documentation.html new file mode 100755 index 00000000..4098ab45 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/partial_mocks_documentation.html @@ -0,0 +1,333 @@ + + + +Documentation SimpleTest : les objets fantaisie partiels + + + + +

Documentation sur les objets fantaisie partiels

+
+ +

+ 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à. +

+ +

+ +

Le problème de l'injection dans un objet fantaisie

+ +

+

+ 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. +

+

+ 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... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect($ip, $port, $username, $password) {
+            $socket = &new Socket($ip, $port);
+            $socket->read( ... );
+            ...
+        }
+    }
+?>
+
+ Nous voudrions vraiment avoir une version fantaisie de l'objet socket, que pouvons nous faire ? +

+

+ 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. +

+

+ Voici ce que ça devrait être... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect(&$socket, $username, $password) {
+            $socket->read( ... );
+            ...
+        }
+    }
+?>
+
+ Sous-entendu, votre code de test est typique d'un cas de test avec un objet fantaisie. +
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new Telnet();
+        $telnet->connect($socket, 'Me', 'Secret');
+        ...
+    }
+}
+
+ 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. +

+

+ La solution suivante est de passer l'objet créé sous la forme d'un paramètre optionnel... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect($ip, $port, $username, $password, $socket = false) {
+            if (!$socket) {
+                $socket = &new Socket($ip, $port);
+            }
+            $socket->read( ... );
+            ...
+            return $socket;
+        }
+    }
+?>
+
+ 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... +
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new Telnet();
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret', &$socket);
+        ...
+    }
+}
+
+ 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. +

+

+ Une autre solution encore est de laisser un objet fabrique s'occuper de la création... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        function Telnet(&$network) {
+            $this->_network = &$network;
+        }
+        ...
+        function &connect($ip, $port, $username, $password) {
+            $socket = &$this->_network->createSocket($ip, $port);
+            $socket->read( ... );
+            ...
+            return $socket;
+        }
+    }
+?>
+
+ 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... +
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $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');
+        ...
+    }
+}
+
+ 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. +

+

+ Peut-on trouver un juste milieu ? +

+ +

+ +

Méthode fabrique protégée

+ +

+

+ 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... +

+<?php
+    require_once('socket.php');
+    
+    class Telnet {
+        ...
+        function &connect($ip, $port, $username, $password) {
+            $socket = &$this->_createSocket($ip, $port);
+            $socket->read( ... );
+            ...
+        }
+        
+        function &_createSocket($ip, $port) {
+            return new Socket($ip, $port);
+        }
+    }
+?>
+
+ Il s'agit là de la seule modification dans le code de l'application. +

+

+ Pour le scénario de test, nous devons créer une sous-classe de manière à intercepter la création de la socket... +

+class TelnetTestVersion extends Telnet {
+    var $_mock;
+    
+    function TelnetTestVersion(&$mock) {
+        $this->_mock = &$mock;
+        $this->Telnet();
+    }
+    
+    function &_createSocket() {
+        return $this->_mock;
+    }
+}
+
+ 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 connect(). Autrement il pourrait donner un valeur nulle à partir de _createSocket(). +

+

+ 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... +

+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new TelnetTestVersion($socket);
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
+        ...
+    }
+}
+
+ 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 ? +

+ +

+ +

Un objet fantaisie partiel

+ +

+

+ 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. +

+

+ Voici donc une version avec objet fantaisie partiel du test... +

+Mock::generatePartial(
+        'Telnet',
+        'TelnetTestVersion',
+        array('_createSocket'));
+
+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new TelnetTestVersion($this);
+        $telnet->setReturnReference('_createSocket', $socket);
+        $telnet->Telnet();
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
+        ...
+    }
+}
+
+ 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 à generatePartial() nécessite trois paramètres : la classe à sous classer, le nom de la nouvelle classe et une liste des méthodes à simuler. +

+

+ 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. +

+

+ 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. +

+

+ 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... +

+class TelnetTest extends UnitTestCase {
+    ...
+    function testConnection() {
+        $socket = &new MockSocket($this);
+        ...
+        $telnet = &new TelnetTestVersion($this);
+        $telnet->setReturnReference('_createSocket', $socket);
+        $telnet->expectOnce('_createSocket', array('127.0.0.1', 21));
+        $telnet->Telnet();
+        $telnet->connect('127.0.0.1', 21, 'Me', 'Secret');
+        ...
+        $telnet->tally();
+    }
+}
+
+

+ +

+ +

Tester moins qu'une classe

+ +

+

+ 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. +

+

+ 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. +

+

+ Pour choisir le mécanisme à utiliser, on en revient toujours aux standards de code de votre projet. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/reporter_documentation.html b/tests/test_tools/simpletest/docs/fr/reporter_documentation.html new file mode 100755 index 00000000..4f927781 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/reporter_documentation.html @@ -0,0 +1,386 @@ + + + +Documentation SimpleTest : le rapporteur de test + + + + +

Documentation sur le rapporteur de test

+
+ +

+ 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. +

+ +

+ +

Les résultats rapportés au format HTML

+ +

+

+ 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... +

+

File test

+ Fail: createnewfile->True assertion failed.
+
1/1 test cases complete. + 0 passes, 1 fails and 0 exceptions.
+
+ Alors qu'ici tous les tests passent... +
+

File test

+
1/1 test cases complete. + 1 passes, 0 fails and 0 exceptions.
+
+ 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. +

+

+ Pour l'affichage basé sur des pages web, il y a la classe HtmlReporter avec la signature suivante... +

+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() { ... }
+}
+
+ Voici ce que certaines de ces méthodes veulent dire. Premièrement les méthodes d'affichage que vous voudrez probablement surcharger... +
    +
  • + HtmlReporter(string $encoding) +
    + 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 html_entities(). +
  • +
  • + void paintHeader(string $test_name) +
    + 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 $test_name arrive. Il peint les titres de la page, CSS, la balise "body", etc. Il ne renvoie rien du tout (void). +
  • +
  • + void paintFooter(string $test_name) +
    + 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. +
  • +
  • + void paintMethodStart(string $test_name) +
    + 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. +
  • +
  • + void paintMethodEnd(string $test_name) +
    + clôt le test lancé avec le même nom. +
  • +
  • + void paintFail(string $message) +
    + 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. +
  • +
  • + void paintPass(string $message) +
    + ne fait rien, par défaut. +
  • +
  • + string _getCss() +
    + 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. +
  • +
+ 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... +
    +
  • + array getTestList() +
    + 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. +
  • +
  • + integer getPassCount() +
    + renvoie le nombre de succès atteint. Il est nécessaire pour l'affichage à la fin. +
  • +
  • + integer getFailCount() +
    + renvoie de la même manière le nombre d'échecs. +
  • +
  • + integer getExceptionCount() +
    + renvoie quant à lui le nombre d'erreurs. +
  • +
  • + integer getTestCaseCount() +
    + est le nombre total de scénarios lors de l'exécution des tests. Il comprend aussi les tests groupés. +
  • +
  • + integer getTestCaseProgress() +
    + est le nombre de scénarios réalisés jusqu'à présent. +
  • +
+ Une modification simple : demander à l'HtmlReporter d'afficher aussi bien les succès que les échecs et les erreurs... +
+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; }';
+    }
+}
+
+

+

+ Une méthode qui a beaucoup fait jaser reste la méthode makeDry(). 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é. +

+

+ 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. +

+ +

+ +

Etendre le rapporteur

+ +

+

+ 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 HtmlReporter nous pouvons nous rendre une étape plus haut dans la hiérarchie de classe vers SimpleReporter dans le fichier source simple_test.php. +

+

+ Un affichage sans rien, un canvas vierge pour votre propre création, serait... +

+require_once('simpletest/simple_test.php');
+
+class MyDisplay extends SimpleReporter {
+    
+    function paintHeader($test_name) {
+    }
+    
+    function paintFooter($test_name) {
+    }
+    
+    function paintStart($test_name, $size) {
+        parent::paintStart($test_name, $size);
+    }
+    
+    function paintEnd($test_name, $size) {
+        parent::paintEnd($test_name, $size);
+    }
+    
+    function paintPass($message) {
+        parent::paintPass($message);
+    }
+    
+    function paintFail($message) {
+        parent::paintFail($message);
+    }
+}
+
+ Aucune sortie ne viendrait de cette classe jusqu'à un ajout de votre part. +

+ +

+ +

Le rapporteur en ligne de commande

+ +

+

+ 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... +

+<?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(new TextReporter());
+?>
+
+ Et ensuite d'invoquer la suite de test à partir d'une ligne de commande... +
+php file_test.php
+
+ Bien sûr vous aurez besoin d'installer PHP en ligne de commande. Une suite de test qui passerait toutes ses assertions ressemble à... +
+File test
+OK
+Test cases run: 1/1, Failures: 0, Exceptions: 0
+
+ Un échec déclenche un affichage comme... +
+File test
+1) True assertion failed.
+	in createnewfile
+FAILURES!!!
+Test cases run: 1/1, Failures: 1, Exceptions: 0
+
+

+

+ 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 false est renvoyée par la méthode SimpleTest::run(). Nous pouvons utiliser ce résultat pour terminer le script avec la bonne valeur renvoyée... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+
+    $test = &new GroupTest('File test');
+    $test->addTestFile('tests/file_test.php');
+    exit ($test->run(new TextReporter()) ? 0 : 1);
+?>
+
+ 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... +
+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+
+    $test = &new GroupTest('File test');
+    $test->addTestFile('tests/file_test.php');
+    if (TextReporter::inCli()) {
+        exit ($test->run(new TextReporter()) ? 0 : 1);
+    }
+    $test->run(new HtmlReporter());
+?>
+
+ Il s'agit là de la forme utilisée par SimpleTest lui-même. +

+ +

+ +

Test distant

+ +

+

+ SimpleTest est livré avec une classe XmlReporter utilisée pour de la communication interne. Lors de son exécution, le résultat ressemble à... +

+<?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>
+
+ Vous pouvez utiliser ce format avec le parseur fourni dans SimpleTest lui-même. Il s'agit de SimpleTestXmlParser et se trouve xml.php à l'intérieur du paquet SimpleTest... +
+<?php
+    require_once('simpletest/xml.php');
+    
+    ...
+    $parser = &new SimpleTestXmlParser(new HtmlReporter());
+    $parser->parse($test_output);
+?>
+
+ $test_output 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. +

+

+ 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. +

+

+ 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... +

+<?php
+    require_once('../remote.php');
+    require_once('../reporter.php');
+    
+    $test_url = ...;
+    $dry_url = ...;
+    
+    $test = &new GroupTest('Remote tests');
+    $test->addTestCase(new RemoteTestCase($test_url, $dry_url));
+    $test->run(new HtmlReporter());
+?>
+
+ RemoteTestCase 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. RemoteTestCase peut être ajouté à une suite de test comme n'importe quel autre groupe de test. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/server_stubs_documentation.html b/tests/test_tools/simpletest/docs/fr/server_stubs_documentation.html new file mode 100755 index 00000000..59085795 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/server_stubs_documentation.html @@ -0,0 +1,279 @@ + + + +Documentation SimpleTest : les bouchons serveur + + + + +

Documentation sur les bouchons serveur

+
+

+ +

Que sont les bouchons serveur ?

+ +

+

+ 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. +

+ +

+ +

Créer des bouchons serveur

+ +

+

+ Nous avons juste besoin d'une classe préexistante, par exemple une connexion vers une base de données qui ressemblerait à... +

+class DatabaseConnection {
+    function DatabaseConnection() {
+    }
+    
+    function query() {
+    }
+    
+    function selectQuery() {
+    }
+}
+
+ 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... +
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+Stub::generate('DatabaseConnection');
+
+ Est généré un clone de la classe appelé StubDatabaseConnection. Nous pouvons alors créer des instances de cette nouvelle classe à l'intérieur de notre prototype de script... +
+require_once('simpletest/mock_objects.php');
+require_once('database_connection.php');
+Stub::generate('DatabaseConnection');
+
+$connection = new StubDatabaseConnection();
+
+
+ La version bouchonnée de la classe contient toutes les méthodes de l'original de telle sorte qu'une opération comme $connection->query() soit encore légale. La valeur retournée sera null, Mais nous pouvons y remédier avec... +
+$connection->setReturnValue('query', 37)
+
+ Désormais à chaque appel de $connection->query() 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. +

+ +

+ +

Modèles de simulation

+ +

+

+ 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 à... +

+class Iterator {
+    function Iterator() {
+    }
+    
+    function next() {
+    }
+}
+
+ 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 false. Une simulation est possible avec... +
+Stub::generate('Iterator');
+
+$iterator = new StubIterator();
+$iterator->setReturnValue('next', false);
+$iterator->setReturnValueAt(0, 'next', 'First string');
+$iterator->setReturnValueAt(1, 'next', 'Second string');
+
+ A l'appel de next() 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 false. Les valeurs renvoyées successivement ont priorité sur la valeur constante renvoyé. Cette dernière est un genre de valeur par défaut. +

+

+ Une autre situation délicate est une opération get() surchargée. Un exemple ? Un porteur d'information avec des pairs de clef / valeur. Prenons une classe de configuration... +

+class Configuration {
+    function Configuration() {
+    }
+    
+    function getValue($key) {
+    }
+}
+
+ 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 getValue() et que nous voulons des résultats différents suivant la clef. Par chance les bouchons ont un système de filtre... +
+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'));
+
+ 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 getValue() avec... +
+$config->getValue('db_user');
+
+ ...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. +

+

+ Vous pouvez définir un argument par défaut avec... +

+
+$config->setReturnValue('getValue', false, array('*'));
+
+ Attention ce n'est pas équivalent à initialiser la valeur retournée sans aucun argument. +
+
+$config->setReturnValue('getValue', false);
+
+ 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 catchall 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. +

+

+ 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... +

+class Thing {
+}
+
+class Vector {
+    function Vector() {
+    }
+    
+    function get($index) {
+    }
+}
+
+ Dans ce cas vous pouvez mettre une référence dans la liste renvoyée par le bouchon... +
+Stub::generate('Vector');
+
+$thing = new Thing();
+$vector = &new StubVector();
+$vector->setReturnReference('get', $thing, array(12));
+
+ Avec ce petit arrangement vous vous assurez qu'à chaque fois que $vector->get(12) est appelé il renverra le même $thing. +

+

+ Ces trois facteurs, ordre, paramètres et copie (ou référence), peuvent être combinés orthogonalement. Par exemple... +

+$complex = &new StubComplexThing();
+$stuff = new Stuff();
+$complex->setReturnReferenceAt(3, 'get', $stuff, array('*', 1));
+
+ Le $stuff 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 ? +

+

+ 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 à next() donnant un ligne et à la fin un false. + 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. +

+

+ Voici comment... +

+Stub::generate('DatabaseConnection');
+Stub::generate('ResultIterator');
+
+class DatabaseTest extends UnitTestCase {
+    
+    function testUserFinder() {
+        $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'));
+                
+        $finder = &new UserFinder($connection);
+        $this->assertIdentical(
+                $finder->findNames(),
+                array('tom', 'dick', 'harry'));
+    }
+}
+
+ Désormais ce n'est que si notre $connection est appelé avec la bonne query() que le $result sera renvoyé après le troisième appel à next(). Cela devrait être suffisant pour que notre classe UserFinder, 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. +

+ +

+ +

Options de création pour les bouchons

+ +

+

+ 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... +

+Stub::generate('Iterator', 'MyStubIterator');
+$iterator = &new MyStubIterator();
+
+
+ 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... +
+class Iterator {
+}
+Stub::generate('Iterator', 'PrototypeIterator', array('next', 'isError'));
+$iterator = &new PrototypeIterator();
+$iterator->setReturnValue('next', 0);
+
+
+ Les méthodes next() et isError() peuvent maintenant renvoyer des ensembles de valeurs exactement comme si elles existaient dans la classe originale. +

+

+ 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. +

+Stub::generate('Connection');
+$iterator = &new StubConnection('wild');
+$iterator->setReturnValue('query', array('id' => 33), array('wild'));
+
+
+ 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". +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/unit_test_documentation.html b/tests/test_tools/simpletest/docs/fr/unit_test_documentation.html new file mode 100755 index 00000000..3dcfeca5 --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/unit_test_documentation.html @@ -0,0 +1,306 @@ + + + +Documenation SimpleTest pour les tests de régression en PHP + + + + +

Documentation sur les tests unitaires en PHP

+
+

+ +

Scénarios de tests unitaires

+ +

+

+ 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 à... +

+class FileTestCase extends UnitTestCase {
+}
+
+ 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. +

+

+ 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... +

+require_once('../classes/writer.php');
+
+class FileTestCase extends UnitTestCase {
+    function FileTestCase() {
+        $this->UnitTestCase('File test');
+    }
+    
+    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');
+    }
+}
+
+ Le constructeur est optionnel et souvent omis. Sans nom, le nom de la classe est utilisé comme nom pour le scénario de test. +

+

+ Notre unique méthode de test pour le moment est testCreation() où nous vérifions qu'un fichier a bien été créé par notre objet Writer. Nous pourrions avoir mis le code unlink() dans cette méthode, mais en la plaçant dans setUp() et tearDown() nous pouvons l'utiliser pour nos autres méthodes de test que nous ajouterons. +

+

+ La méthode setUp() est lancé juste avant chaque méthode de test. tearDown() est lancé après chaque méthode de test. +

+

+ 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 setUp(), mais fournit aux codeurs de bibliothèque d'autres crochets. +

+

+ Pour rapporter les résultats de test, le passage par une classe d'affichage - notifiée par les différentes méthodes de type assert...() - est utilisée. En voici la liste complète pour la classe UnitTestCase, celle par défaut dans SimpleTest... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
assertTrue($x)Echoue si $x est faux
assertFalse($x)Echoue si $x est vrai
assertNull($x)Echoue si $x est initialisé
assertNotNull($x)Echoue si $x n'est pas initialisé
assertIsA($x, $t)Echoue si $x n'est pas de la classe ou du type $t
assertEqual($x, $y)Echoue si $x == $y est faux
assertNotEqual($x, $y)Echoue si $x == $y est vrai
assertIdentical($x, $y)Echoue si $x === $y est faux
assertNotIdentical($x, $y)Echoue si $x === $y est vrai
assertReference($x, $y)Echoue sauf si $x et $y sont la même variable
assertCopy($x, $y)Echoue si $x et $y sont la même variable
assertWantedPattern($p, $x)Echoue sauf si l'expression rationnelle $p capture $x
assertNoUnwantedPattern($p, $x)Echoue si l'expression rationnelle $p capture $x
assertNoErrors()Echoue si une erreur PHP arrive
assertError($x)Echoue si aucune erreur ou message incorrect de PHP n'arrive
+ 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. +

+

+ D'autres exemples... +

+$variable = null;
+$this->assertNull($variable, 'Should be cleared');
+
+ ...passera et normalement n'affichera aucun message. Si vous avez configuré le testeur pour afficher aussi les succès alors le message sera affiché comme tel. +
+$this->assertIdentical(0, false, 'Zero is not false [%s]');
+
+ 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. +
+$a = 1;
+$b = $a;
+$this->assertReference($a, $b);
+
+ Échouera étant donné que la variable $b est une copie de $a. +
+$this->assertWantedPattern('/hello/i', 'Hello world');
+
+ Là, ça passe puisque la recherche est insensible à la casse et que donc hello est bien repérable dans Hello world. +
+trigger_error('Disaster');
+trigger_error('Catastrophe');
+$this->assertError();
+$this->assertError('Catastrophe');
+$this->assertNoErrors();
+
+ Ici, il y a besoin d'une petite explication : toutes passent ! +

+

+ 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. +

+

+ Les scénarios de test peuvent utiliser des méthodes bien pratiques pour déboguer le code ou pour étendre la suite... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setUp()Est lancée avant chaque méthode de test
tearDown()Est lancée après chaque méthode de test
pass()Envoie un succès
fail()Envoie un échec
error()Envoi un évènement exception
sendMessage()Envoie un message d'état aux systèmes d'affichage qui le supporte
signal($type, $payload)Envoie un message défini par l'utilisateur au rapporteur du test
dump($var)Effectue un print_r() formaté pour du déboguage rapide et grossier
swallowErrors()Vide les erreurs de la queue
+

+ +

+ +

Etendre les scénarios de test

+ +

+

+ 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... +

+require_once('simpletest/unit_tester.php');
+
+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'));
+    }
+}
+
+ Ici la bibliothèque SimpleTest est localisée dans un répertoire local appelé simpletest. Pensez à le modifier pour votre propre environnement. +

+

+ Ce nouveau scénario peut être hérité exactement comme un scénario de test classique... +

+class FileTestCase extends FileTester {
+    
+    function setUp() {
+        @unlink('../temp/test.txt');
+    }
+    
+    function tearDown() {
+        @unlink('../temp/test.txt');
+    }
+    
+    function testCreation() {
+        $writer = &new FileWriter('../temp/test.txt');
+        $writer->write('Hello');
+        $this->assertFileExists('../temp/test.txt');
+    }
+}
+
+

+

+ Si vous souhaitez un scénario de test sans toutes les assertions de UnitTestCase mais uniquement avec les vôtres propres, vous aurez besoin d'étendre la classe SimpleTestCase à la place. Elle se trouve dans simple_test.php en lieu et place de unit_tester.php. A consulter plus tard si vous souhaitez incorporer les scénarios d'autres testeurs unitaires dans votre suite de test. +

+ +

+ +

Lancer un unique scénario de test

+ +

+

+ 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... +

+<?php
+    require_once('simpletest/unit_tester.php');
+    require_once('simpletest/reporter.php');
+    require_once('../classes/writer.php');
+
+    class FileTestCase extends UnitTestCase {
+        function FileTestCase() {
+            $this->UnitTestCase('File test');
+        }
+    }
+    
+    $test = &new FileTestCase();
+    $test->run(new HtmlReporter());
+?>
+
+ 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. +

+ +
+ + + diff --git a/tests/test_tools/simpletest/docs/fr/web_tester_documentation.html b/tests/test_tools/simpletest/docs/fr/web_tester_documentation.html new file mode 100755 index 00000000..86044e5e --- /dev/null +++ b/tests/test_tools/simpletest/docs/fr/web_tester_documentation.html @@ -0,0 +1,397 @@ + + + +Documentation SimpleTest : tester des scripts web + + + + +

Documentation sur le testeur web

+
+

+ +

Télécharger une page

+ +

+

+ 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. +

+

+ 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. +

+

+ SimpleTest comprend une forme spéciale de scénario de test pour tester les actions d'une page web. WebTestCase 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 à UnitTestCase... +

+class TestOfLastcraft extends WebTestCase {
+}
+
+ Ici nous sommes sur le point de tester le site de Last Craft. Si ce scénario de test est situé dans un fichier appelé lastcraft_test.php alors il peut être chargé dans un script de lancement tout comme des tests unitaires... +
+<?php
+    require_once('simpletest/web_tester.php');
+    require_once('simpletest/reporter.php');
+    
+    $test = &new GroupTest('Web site tests');
+    $test->addTestFile('lastcraft_test.php');
+    exit ($test->run(new TextReporter()) ? 0 : 1);
+?>
+
+ J'utilise ici le rapporteur en mode texte pour mieux distinguer le contenu au format HTML du résultat du test proprement dit. +

+

+ Rien n'est encore testé. Nous pouvons télécharger la page d'accueil en utilisant la méthode get()... +

+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->assertTrue($this->get('http://www.lastcraft.com/'));
+    }
+}
+
+ La méthode get() 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 get() renverrait encore un succès. +

+

+ 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... +

+Web site tests
+OK
+Test cases run: 1/1, Failures: 0, Exceptions: 0
+
+ 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. +

+ +

+ +

Tester le contenu d'une page

+ +

+

+ Pour obtenir la confirmation que la page téléchargée est bien celle que nous attendions, nous devons vérifier son contenu. +

+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->get('http://www.lastcraft.com/');
+        $this->assertWantedPattern('/why the last craft/i');
+    }
+}
+
+ 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. +

+

+ Voici une liste possible d'assertions sur le contenu... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
assertWantedPattern($pattern)Vérifier une correspondance sur le contenu via une expression rationnelle Perl
assertNoUnwantedPattern($pattern)Une expression rationnelle Perl pour vérifier une absence
assertTitle($title)Passe si le titre de la page correspond exactement
assertLink($label)Passe si un lien avec ce texte est présent
assertNoLink($label)Passe si aucun lien avec ce texte est présent
assertLinkById($id)Passe si un lien avec cet attribut d'identification est présent
assertField($name, $value)Passe si une balise input avec ce nom contient cette valeur
assertFieldById($id, $value)Passe si une balise input avec cet identifiant contient cette valeur
assertResponse($codes)Passe si la réponse HTTP trouve une correspondance dans la liste
assertMime($types)Passe si le type MIME se retrouve dans cette liste
assertAuthentication($protocol)Passe si l'authentification provoquée est de ce type de protocole
assertNoAuthentication()Passe s'il n'y pas d'authentification provoquée en cours
assertRealm($name)Passe si le domaine provoqué correspond
assertHeader($header, $content)Passe si une entête téléchargée correspond à cette valeur
assertNoUnwantedHeader($header)Passe si une entête n'a pas été téléchargé
assertHeaderPattern($header, $pattern)Passe si une entête téléchargée correspond à cette expression rationnelle Perl
assertCookie($name, $value)Passe s'il existe un cookie correspondant
assertNoCookie($name)Passe s'il n'y a pas de cookie avec un tel nom
+ 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". +

+

+ A présent nous pourrions effectué le test sur le titre uniquement... +

+$this->assertTitle('The Last Craft?');
+
+ 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... +
+$this->assertMime(array('text/plain', 'text/html'));
+
+ 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... +
+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->get('http://simpletest.sourceforge.net/');
+        $this->assertResponse(200);
+    }
+}
+
+ 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 http://simpletest.sourceforge.net/, à la place le serveur renverra une redirection vers http://www.lastcraft.com/simple_test.php. WebTestCase 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... +
+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->setMaximumRedirects(0);
+        $this->get('http://simpletest.sourceforge.net/');
+        $this->assertResponse(200);
+    }
+}
+
+ Alors l'assertion échoue comme prévue... +
+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
+
+ Nous pouvons modifier le test pour accepter les redirections... +
+class TestOfLastcraft extends WebTestCase {
+    
+    function testHomepage() {
+        $this->setMaximumRedirects(0);
+        $this->get('http://simpletest.sourceforge.net/');
+        $this->assertResponse(array(301, 302, 303, 307));
+    }
+}
+
+ Maitenant ça passe. +

+ +

+ +

Navigeur dans un site web

+ +

+

+ 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... +

+class TestOfLastcraft extends WebTestCase {
+    ...
+    function testContact() {
+        $this->get('http://www.lastcraft.com/');
+        $this->clickLink('About');
+        $this->assertTitle('About Last Craft');
+    }
+}
+
+ Le paramètre est le texte du lien. +

+

+ Il l'objectif est un bouton plutôt qu'une balise ancre, alors clickSubmit() doit être utilisé avec le titre du bouton... +

+$this->clickSubmit('Go!');
+
+

+

+ La liste des méthodes de navigation est... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
get($url, $parameters)Envoie une requête GET avec ces paramètres
post($url, $parameters)Envoie une requête POST avec ces paramètres
head($url, $parameters)Envoie une requête HEAD sans remplacer le contenu de la page
retry()Relance la dernière requête
back()Identique au bouton "Précédent" du navigateur
forward()Identique au bouton "Suivant" du navigateur
authenticate($name, $password)Re-essaye avec une tentative d'authentification
getFrameFocus()Le nom de la fenêtre en cours d'utilisation
setFrameFocusByIndex($choice)Change le focus d'une fenêtre en commençant par 1
setFrameFocus($name)Change le focus d'une fenêtre en utilisant son nom
clearFrameFocus()Revient à un traitement de toutes les fenêtres comme une seule
clickSubmit($label)Clique sur le premier bouton avec cette étiquette
clickSubmitByName($name)Clique sur le bouton avec cet attribut de nom
clickSubmitById($id)Clique sur le bouton avec cet attribut d'identification
clickImage($label, $x, $y)Clique sur une balise input de type image avec ce titre ou ce texte dans l'attribut alt
clickImageByName($name, $x, $y)Clique sur une balise input de type image avec ce nom
clickImageById($id, $x, $y)Clique sur une balise input de type image avec cet attribut d'identification
submitFormById($id)Soumet un formulaire sans valeur de soumission
clickLink($label, $index)Clique sur un ancre avec ce texte d'étiquette visible
clickLinkById($id)Clique sur une ancre avec cet attribut d'identification
+

+

+ Les paramètres dans les méthodes get(), post() et head() 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. +

+

+ Les commandes retry(), back() et forward() 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. +

+

+ 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é. +

+

+ 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 des outils pour tester des formulaires web. +

+ +

+ +

Modifier la requête

+ +

+

+ 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... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
getTransportError()La dernière erreur de socket
getUrl()La localisation courante
showRequest()Déverse la requête sortante
showHeaders()Déverse les entêtes d'entrée
showSource()Déverse le contenu brut de la page HTML
ignoreFrames()Ne recharge pas les framesets
setCookie($name, $value)Initie un cookie à partir de maintenant
addHeader($header)Ajoute toujours cette entête à la requête
setMaximumRedirects($max)S'arrête après autant de redirections
setConnectionTimeout($timeout)Termine la connexion après autant de temps entre les bytes
useProxy($proxy, $name, $password)Effectue les requêtes à travers ce proxy d'URL
+

+ +
+ + + diff --git a/tests/test_tools/simpletest/dumper.php b/tests/test_tools/simpletest/dumper.php new file mode 100644 index 00000000..f54140ca --- /dev/null +++ b/tests/test_tools/simpletest/dumper.php @@ -0,0 +1,380 @@ +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/test_tools/simpletest/encoding.php b/tests/test_tools/simpletest/encoding.php new file mode 100644 index 00000000..62ca2a1b --- /dev/null +++ b/tests/test_tools/simpletest/encoding.php @@ -0,0 +1,156 @@ +_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/test_tools/simpletest/errors.php b/tests/test_tools/simpletest/errors.php new file mode 100644 index 00000000..70c6c338 --- /dev/null +++ b/tests/test_tools/simpletest/errors.php @@ -0,0 +1,141 @@ +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/test_tools/simpletest/expectation.php b/tests/test_tools/simpletest/expectation.php new file mode 100644 index 00000000..355963b4 --- /dev/null +++ b/tests/test_tools/simpletest/expectation.php @@ -0,0 +1,568 @@ +_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/test_tools/simpletest/extensions/pear_test_case.php b/tests/test_tools/simpletest/extensions/pear_test_case.php new file mode 100755 index 00000000..51727345 --- /dev/null +++ b/tests/test_tools/simpletest/extensions/pear_test_case.php @@ -0,0 +1,199 @@ +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/test_tools/simpletest/extensions/phpunit_test_case.php b/tests/test_tools/simpletest/extensions/phpunit_test_case.php new file mode 100755 index 00000000..a0954d8b --- /dev/null +++ b/tests/test_tools/simpletest/extensions/phpunit_test_case.php @@ -0,0 +1,108 @@ +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/test_tools/simpletest/form.php b/tests/test_tools/simpletest/form.php new file mode 100644 index 00000000..89b4948a --- /dev/null +++ b/tests/test_tools/simpletest/form.php @@ -0,0 +1,619 @@ +_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/test_tools/simpletest/frames.php b/tests/test_tools/simpletest/frames.php new file mode 100644 index 00000000..75951476 --- /dev/null +++ b/tests/test_tools/simpletest/frames.php @@ -0,0 +1,673 @@ +_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/test_tools/simpletest/http.php b/tests/test_tools/simpletest/http.php new file mode 100644 index 00000000..fa27de9c --- /dev/null +++ b/tests/test_tools/simpletest/http.php @@ -0,0 +1,853 @@ +_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/test_tools/simpletest/mock_objects.php b/tests/test_tools/simpletest/mock_objects.php new file mode 100644 index 00000000..d39eb84e --- /dev/null +++ b/tests/test_tools/simpletest/mock_objects.php @@ -0,0 +1,1323 @@ +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/test_tools/simpletest/options.php b/tests/test_tools/simpletest/options.php new file mode 100644 index 00000000..51ec5353 --- /dev/null +++ b/tests/test_tools/simpletest/options.php @@ -0,0 +1,366 @@ + '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/test_tools/simpletest/page.php b/tests/test_tools/simpletest/page.php new file mode 100644 index 00000000..843dedf5 --- /dev/null +++ b/tests/test_tools/simpletest/page.php @@ -0,0 +1,961 @@ +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/test_tools/simpletest/parser.php b/tests/test_tools/simpletest/parser.php new file mode 100644 index 00000000..7dc56a58 --- /dev/null +++ b/tests/test_tools/simpletest/parser.php @@ -0,0 +1,750 @@ +_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('addExitPattern('', 'css'); + $lexer->mapHandler('js', 'ignore'); + $lexer->addEntryPattern('addExitPattern('', 'js'); + $lexer->mapHandler('comment', 'ignore'); + $lexer->addEntryPattern('', '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("", '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('||', ' \1 ', $html); + $text = preg_replace('||', ' \1 ', $text); + $text = preg_replace('||', ' \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/test_tools/simpletest/remote.php b/tests/test_tools/simpletest/remote.php new file mode 100644 index 00000000..5a5f2d32 --- /dev/null +++ b/tests/test_tools/simpletest/remote.php @@ -0,0 +1,115 @@ +_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/test_tools/simpletest/reporter.php b/tests/test_tools/simpletest/reporter.php new file mode 100644 index 00000000..32125c9b --- /dev/null +++ b/tests/test_tools/simpletest/reporter.php @@ -0,0 +1,241 @@ +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 "\n\n$test_name\n"; + print "\n"; + print "\n"; + print "\n\n"; + print "

$test_name

\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 "
"; + print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount(); + print " test cases complete:\n"; + print "" . $this->getPassCount() . " passes, "; + print "" . $this->getFailCount() . " fails and "; + print "" . $this->getExceptionCount() . " exceptions."; + print "
\n"; + print "\n\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 "Fail: "; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print implode(" -> ", $breadcrumb); + print " -> " . $this->_htmlEntities($message) . "
\n"; + } + + /** + * Paints a PHP error or exception. + * @param string $message Message is ignored. + * @access public + * @abstract + */ + function paintException($message) { + parent::paintException($message); + print "Exception: "; + $breadcrumb = $this->getTestList(); + array_shift($breadcrumb); + print implode(" -> ", $breadcrumb); + print " -> " . $this->_htmlEntities($message) . "
\n"; + } + + /** + * Paints formatted text such as dumped variables. + * @param string $message Text to show. + * @access public + */ + function paintFormattedMessage($message) { + print '
' . $this->_htmlEntities($message) . '
'; + } + + /** + * 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/test_tools/simpletest/runner.php b/tests/test_tools/simpletest/runner.php new file mode 100644 index 00000000..411efe7e --- /dev/null +++ b/tests/test_tools/simpletest/runner.php @@ -0,0 +1,300 @@ +_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/test_tools/simpletest/scorer.php b/tests/test_tools/simpletest/scorer.php new file mode 100644 index 00000000..6c321f8c --- /dev/null +++ b/tests/test_tools/simpletest/scorer.php @@ -0,0 +1,378 @@ +_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/test_tools/simpletest/shell_tester.php b/tests/test_tools/simpletest/shell_tester.php new file mode 100644 index 00000000..7bab8ce0 --- /dev/null +++ b/tests/test_tools/simpletest/shell_tester.php @@ -0,0 +1,271 @@ +_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/test_tools/simpletest/simple_test.php b/tests/test_tools/simpletest/simple_test.php new file mode 100644 index 00000000..f2204f42 --- /dev/null +++ b/tests/test_tools/simpletest/simple_test.php @@ -0,0 +1,553 @@ +_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/test_tools/simpletest/socket.php b/tests/test_tools/simpletest/socket.php new file mode 100644 index 00000000..4c3c592d --- /dev/null +++ b/tests/test_tools/simpletest/socket.php @@ -0,0 +1,216 @@ +_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/test_tools/simpletest/tag.php b/tests/test_tools/simpletest/tag.php new file mode 100644 index 00000000..9386712a --- /dev/null +++ b/tests/test_tools/simpletest/tag.php @@ -0,0 +1,1241 @@ +_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/test_tools/simpletest/unit_tester.php b/tests/test_tools/simpletest/unit_tester.php new file mode 100644 index 00000000..fa5e28b4 --- /dev/null +++ b/tests/test_tools/simpletest/unit_tester.php @@ -0,0 +1,303 @@ +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/test_tools/simpletest/url.php b/tests/test_tools/simpletest/url.php new file mode 100644 index 00000000..03902ed0 --- /dev/null +++ b/tests/test_tools/simpletest/url.php @@ -0,0 +1,508 @@ +_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/test_tools/simpletest/user_agent.php b/tests/test_tools/simpletest/user_agent.php new file mode 100644 index 00000000..c65d5110 --- /dev/null +++ b/tests/test_tools/simpletest/user_agent.php @@ -0,0 +1,490 @@ +_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/test_tools/simpletest/web_tester.php b/tests/test_tools/simpletest/web_tester.php new file mode 100644 index 00000000..4981d25a --- /dev/null +++ b/tests/test_tools/simpletest/web_tester.php @@ -0,0 +1,1330 @@ +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/test_tools/simpletest/xml.php b/tests/test_tools/simpletest/xml.php new file mode 100644 index 00000000..dd007d41 --- /dev/null +++ b/tests/test_tools/simpletest/xml.php @@ -0,0 +1,615 @@ +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) . + "_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 "_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) . + "_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 "_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) . + "_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 "_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 "_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 "_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 "_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 "_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 ""; + print "_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 ""; + print "_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 "_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 "_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 @@ +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)."[ url}\">{$this->name} ]
\n"; + foreach($this->subFolders as $folder) + $str.=$folder->getHtml($level+1); + foreach($this->testFiles as $name=>$url) + $str.=str_repeat(' ',($level+1)*4)."$name
\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 " + + Prado Unit Tests + + + +

Prado Unit Tests

+ "; + $root=new TestFolder($rootPath,$rootPath,$rootUri); + echo $root->getHtml(); + echo "\n"; + } + } +} + +?> \ No newline at end of file -- cgit v1.2.3