Merge branch 'MDL-29201_20' of git://github.com/timhunt/moodle into MOODLE_20_STABLE
[moodle.git] / lib / simpletestlib / remote.php
blob764e840a5c16067db08afc710013a84ff1350d19
1 <?php
2 /**
3 * base include file for SimpleTest
4 * @package SimpleTest
5 * @subpackage UnitTester
6 * @version $Id$
7 */
9 /**#@+
10 * include other SimpleTest class files
12 require_once(dirname(__FILE__) . '/browser.php');
13 require_once(dirname(__FILE__) . '/xml.php');
14 require_once(dirname(__FILE__) . '/test_case.php');
15 /**#@-*/
17 /**
18 * Runs an XML formated test on a remote server.
19 * @package SimpleTest
20 * @subpackage UnitTester
22 class RemoteTestCase {
23 var $_url;
24 var $_dry_url;
25 var $_size;
27 /**
28 * Sets the location of the remote test.
29 * @param string $url Test location.
30 * @param string $dry_url Location for dry run.
31 * @access public
33 function RemoteTestCase($url, $dry_url = false) {
34 $this->_url = $url;
35 $this->_dry_url = $dry_url ? $dry_url : $url;
36 $this->_size = false;
39 /**
40 * Accessor for the test name for subclasses.
41 * @return string Name of the test.
42 * @access public
44 function getLabel() {
45 return $this->_url;
48 /**
49 * Runs the top level test for this class. Currently
50 * reads the data as a single chunk. I'll fix this
51 * once I have added iteration to the browser.
52 * @param SimpleReporter $reporter Target of test results.
53 * @returns boolean True if no failures.
54 * @access public
56 function run(&$reporter) {
57 $browser = &$this->_createBrowser();
58 $xml = $browser->get($this->_url);
59 if (! $xml) {
60 trigger_error('Cannot read remote test URL [' . $this->_url . ']');
61 return false;
63 $parser = &$this->_createParser($reporter);
64 if (! $parser->parse($xml)) {
65 trigger_error('Cannot parse incoming XML from [' . $this->_url . ']');
66 return false;
68 return true;
71 /**
72 * Creates a new web browser object for fetching
73 * the XML report.
74 * @return SimpleBrowser New browser.
75 * @access protected
77 function &_createBrowser() {
78 $browser = new SimpleBrowser();
79 return $browser;
82 /**
83 * Creates the XML parser.
84 * @param SimpleReporter $reporter Target of test results.
85 * @return SimpleTestXmlListener XML reader.
86 * @access protected
88 function &_createParser(&$reporter) {
89 $parser = new SimpleTestXmlParser($reporter);
90 return $parser;
93 /**
94 * Accessor for the number of subtests.
95 * @return integer Number of test cases.
96 * @access public
98 function getSize() {
99 if ($this->_size === false) {
100 $browser = &$this->_createBrowser();
101 $xml = $browser->get($this->_dry_url);
102 if (! $xml) {
103 trigger_error('Cannot read remote test URL [' . $this->_dry_url . ']');
104 return false;
106 $reporter = new SimpleReporter();
107 $parser = &$this->_createParser($reporter);
108 if (! $parser->parse($xml)) {
109 trigger_error('Cannot parse incoming XML from [' . $this->_dry_url . ']');
110 return false;
112 $this->_size = $reporter->getTestCaseCount();
114 return $this->_size;