Rajesh Taneja
52f3e060e4
1. getMock() 2. setExpectedException() 3. checkForUnintentionallyCoveredCode renamed to beStrictAboutCoversAnnotation 4. beStrictAboutTestSize renamed to enforceTimeLimit 5. UnitTestCase class is now fully removed.
141 lines
4.6 KiB
PHP
141 lines
4.6 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Unit tests for the XML-RPC web service.
|
|
*
|
|
* @package webservice_xmlrpc
|
|
* @category test
|
|
* @copyright 2015 Jun Pataleta <jun@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/webservice/xmlrpc/lib.php');
|
|
|
|
/**
|
|
* Unit tests for the XML-RPC web service.
|
|
*
|
|
* @package webservice_xmlrpc
|
|
* @category test
|
|
* @copyright 2015 Jun Pataleta <jun@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class webservice_xmlrpc_test extends advanced_testcase {
|
|
|
|
/**
|
|
* Setup.
|
|
*/
|
|
public function setUp() {
|
|
$this->resetAfterTest();
|
|
|
|
// All tests require xmlrpc. Skip tests, if xmlrpc is not installed.
|
|
if (!function_exists('xmlrpc_decode')) {
|
|
$this->markTestSkipped('XMLRPC is not installed.');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Test for array response.
|
|
*/
|
|
public function test_client_with_array_response() {
|
|
global $CFG;
|
|
|
|
$client = new webservice_xmlrpc_client_mock('/webservice/xmlrpc/server.php', 'anytoken');
|
|
$mockresponse = file_get_contents($CFG->dirroot . '/webservice/xmlrpc/tests/fixtures/array_response.xml');
|
|
$client->set_mock_response($mockresponse);
|
|
$result = $client->call('testfunction');
|
|
$this->assertEquals(xmlrpc_decode($mockresponse), $result);
|
|
}
|
|
|
|
/**
|
|
* Test for value response.
|
|
*/
|
|
public function test_client_with_value_response() {
|
|
global $CFG;
|
|
|
|
$client = new webservice_xmlrpc_client_mock('/webservice/xmlrpc/server.php', 'anytoken');
|
|
$mockresponse = file_get_contents($CFG->dirroot . '/webservice/xmlrpc/tests/fixtures/value_response.xml');
|
|
$client->set_mock_response($mockresponse);
|
|
$result = $client->call('testfunction');
|
|
$this->assertEquals(xmlrpc_decode($mockresponse), $result);
|
|
}
|
|
|
|
/**
|
|
* Test for fault response.
|
|
*/
|
|
public function test_client_with_fault_response() {
|
|
global $CFG;
|
|
|
|
$client = new webservice_xmlrpc_client_mock('/webservice/xmlrpc/server.php', 'anytoken');
|
|
$mockresponse = file_get_contents($CFG->dirroot . '/webservice/xmlrpc/tests/fixtures/fault_response.xml');
|
|
$client->set_mock_response($mockresponse);
|
|
$this->expectException('moodle_exception');
|
|
$client->call('testfunction');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class webservice_xmlrpc_client_mock.
|
|
*
|
|
* Mock class that returns the processed XML-RPC response.
|
|
*
|
|
* @package webservice_xmlrpc
|
|
* @category test
|
|
* @copyright 2015 Jun Pataleta <jun@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class webservice_xmlrpc_client_mock extends webservice_xmlrpc_client {
|
|
|
|
/** @var string The mock XML-RPC response string. */
|
|
private $mockresponse;
|
|
|
|
/**
|
|
* XML-RPC mock response setter.
|
|
*
|
|
* @param string $mockresponse
|
|
*/
|
|
public function set_mock_response($mockresponse) {
|
|
$this->mockresponse = $mockresponse;
|
|
}
|
|
|
|
/**
|
|
* Since the call method uses download_file_content and it is hard to make an actual call to a web service,
|
|
* we'll just have to simulate the receipt of the response from the server using the mock response so we
|
|
* can test the processing result of this method.
|
|
*
|
|
* @param string $functionname the function name
|
|
* @param array $params the parameters of the function
|
|
* @return mixed The decoded XML RPC response.
|
|
* @throws moodle_exception
|
|
*/
|
|
public function call($functionname, $params = array()) {
|
|
// Get the response.
|
|
$response = $this->mockresponse;
|
|
|
|
// This is the part of the code in webservice_xmlrpc_client::call() what we would like to test.
|
|
// Decode the response.
|
|
$result = xmlrpc_decode($response);
|
|
if (is_array($result) && xmlrpc_is_fault($result)) {
|
|
throw new moodle_exception($result['faultString']);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
}
|