member_unique_identifier_field = Member::config()->unique_identifier_field; Member::config()->unique_identifier_field = 'Email'; parent::setUp(); } public function tearDown() { parent::tearDown(); // set old Member::config()->unique_identifier_field value if ($this->member_unique_identifier_field) { Member::config()->unique_identifier_field = $this->member_unique_identifier_field; } } /** * Check we can put slashes anywhere and it works */ public function testGetAbsoluteURLSlashes() { $urls = array( '/url/', 'url', '/url', 'url/', ); $restWithoutSlash = new RestfulService('http://example.com'); $restWithSlash = new RestfulService('http://example.com/'); foreach ($urls as $url) { $url = ltrim($url, '/'); $this->assertEquals("http://example.com/$url", $restWithoutSlash->getAbsoluteRequestURL($url)); $this->assertEquals("http://example.com/$url", $restWithSlash->getAbsoluteRequestURL($url)); $this->assertEquals($restWithoutSlash->getAbsoluteRequestURL($url), $restWithSlash->getAbsoluteRequestURL($url)); } } /** * Check we can add query strings all over the shop and it's ok */ public function testGetAbsoluteURLQueries() { $restWithoutSlash = new RestfulService('http://example.com?b=query2'); $restWithSlash = new RestfulService('http://example.com/?b=query2'); $restWithQuery = new RestfulService('http://example.com/?b=query2'); $restWithQuery->setQueryString(array( 'c' => 'query3', )); $this->assertEquals('http://example.com/url?b=query2&a=query1', $restWithoutSlash->getAbsoluteRequestURL('url?a=query1')); $this->assertEquals('http://example.com/url?b=query2&a=query1', $restWithSlash->getAbsoluteRequestURL('url?a=query1')); $this->assertEquals('http://example.com/url?b=query2&a=query1&c=query3', $restWithQuery->getAbsoluteRequestURL('url?a=query1')); $this->assertEquals('http://example.com/url?b=query2', $restWithoutSlash->getAbsoluteRequestURL('url')); $this->assertEquals('http://example.com/url?b=query2', $restWithSlash->getAbsoluteRequestURL('url')); $this->assertEquals('http://example.com/url?b=query2&c=query3', $restWithQuery->getAbsoluteRequestURL('url')); $restWithoutSlash = new RestfulService('http://example.com'); $restWithSlash = new RestfulService('http://example.com/'); $restWithQuery = new RestfulService('http://example.com/'); $restWithQuery->setQueryString(array( 'c' => 'query3', )); $this->assertEquals('http://example.com/url?a=query1', $restWithoutSlash->getAbsoluteRequestURL('url?a=query1')); $this->assertEquals('http://example.com/url?a=query1', $restWithSlash->getAbsoluteRequestURL('url?a=query1')); $this->assertEquals('http://example.com/url?a=query1&c=query3', $restWithQuery->getAbsoluteRequestURL('url?a=query1')); $this->assertEquals('http://example.com/url', $restWithoutSlash->getAbsoluteRequestURL('url')); $this->assertEquals('http://example.com/url', $restWithSlash->getAbsoluteRequestURL('url')); $this->assertEquals('http://example.com/url?c=query3', $restWithQuery->getAbsoluteRequestURL('url')); } /** * Check spaces are encoded */ public function testGetAbsoluteURLWithSpaces() { $rest = new RestfulService('http://example.com'); $this->assertEquals('http://example.com/query%20with%20spaces', $rest->getAbsoluteRequestURL('query with spaces')); } public function testSpecialCharacters() { $service = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL()); $url = 'RestfulServiceTest_Controller/'; $params = array( 'test1a' => 4352655636.76543, // number test 'test1b' => '$&+,/:;=?@#%', // special char test. These should all get encoded 'test1c' => 'And now for a string test' // string test ); $service->setQueryString($params); $responseBody = $service->request($url)->getBody(); foreach ($params as $key => $value) { $this->assertContains("$value", $responseBody); $this->assertContains("$value", $responseBody); } } public function testGetDataWithSetQueryString() { $service = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL()); $url = 'RestfulServiceTest_Controller/'; $params = array( 'test1a' => 'val1a', 'test1b' => 'val1b' ); $service->setQueryString($params); $responseBody = $service->request($url)->getBody(); foreach ($params as $key => $value) { $this->assertContains("$value", $responseBody); $this->assertContains("$value", $responseBody); } } public function testGetDataWithUrlParameters() { $service = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL()); $url = 'RestfulServiceTest_Controller/'; $params = array( 'test1a' => 'val1a', 'test1b' => 'val1b' ); $url .= '?' . http_build_query($params); $responseBody = $service->request($url)->getBody(); foreach ($params as $key => $value) { $this->assertContains("$value", $responseBody); $this->assertContains("$value", $responseBody); } } public function testPostData() { $service = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL(), 0); $params = array( 'test1a' => 'val1a', 'test1b' => 'val1b' ); $responseBody = $service->request('RestfulServiceTest_Controller/', 'POST', $params)->getBody(); foreach ($params as $key => $value) { $this->assertContains("$value", $responseBody); $this->assertContains("$value", $responseBody); } } public function testPutData() { $service = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL(), 0); $data = 'testPutData'; $responseBody = $service->request('RestfulServiceTest_Controller/', 'PUT', $data)->getBody(); $this->assertContains("$data", $responseBody); } public function testConnectionDoesntCacheWithDifferentUrl() { $service = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL()); $url = 'RestfulServiceTest_Controller/'; // First run $params = array( 'test1a' => 'first run', ); $service->setQueryString($params); $responseBody = $service->request($url)->getBody(); $this->assertContains("first run", $responseBody); // Second run $params = array( 'test1a' => 'second run', ); $service->setQueryString($params); $responseBody = $service->request($url)->getBody(); $this->assertContains("second run", $responseBody); } /** * @expectedException PHPUnit_Framework_Error */ public function testIncorrectData() { $connection = new RestfulService(Director::absoluteBaseURL(), 0); $test1 = $connection->request('RestfulServiceTest_Controller/invalid'); $test1->xpath("\\fail"); } public function testHttpErrorWithoutCache() { $connection = new RestfulServiceTest_MockRestfulService(Director::absoluteBaseURL(), 0); $response = $connection->request('RestfulServiceTest_Controller/httpErrorWithoutCache'); $this->assertEquals(400, $response->getStatusCode()); $this->assertFalse($response->getCachedBody()); $this->assertContains("HTTP Error", $response->getBody()); } public function testHttpErrorWithCache() { $subUrl = 'RestfulServiceTest_Controller/httpErrorWithCache'; $connection = new RestfulServiceTest_MockErrorService(Director::absoluteBaseURL(), 0); $this->createFakeCachedResponse($connection, $subUrl); $response = $connection->request($subUrl); $this->assertEquals(400, $response->getStatusCode()); $this->assertEquals("Cache response body",$response->getCachedBody()); $this->assertContains("HTTP Error", $response->getBody()); } /** * Simulate cached response file for testing error requests that are supposed to have cache files * * @todo Generate the cachepath without hardcoding the cache data */ private function createFakeCachedResponse($connection, $subUrl) { $fullUrl = $connection->getAbsoluteRequestURL($subUrl); //these are the defaul values that one would expect in the $basicAuthStringMethod = new ReflectionMethod('RestfulServiceTest_MockErrorService', 'getBasicAuthString'); $basicAuthStringMethod->setAccessible(true); $cachePathMethod = new ReflectionMethod('RestfulServiceTest_MockErrorService', 'getCachePath'); $cachePathMethod->setAccessible(true); $cache_path = $cachePathMethod->invokeArgs($connection, array(array( $fullUrl, 'GET', null, array(), array(), $basicAuthStringMethod->invoke($connection) ))); $cacheResponse = new RestfulService_Response("Cache response body"); $store = serialize($cacheResponse); file_put_contents($cache_path, $store); } public function testHttpHeaderParseing() { $headers = "content-type: text/html; charset=UTF-8\r\n". "Server: Funky/1.0\r\n". "X-BB-ExampleMANycaPS: test\r\n". "Set-Cookie: foo=bar\r\n". "Set-Cookie: baz=quux\r\n". "Set-Cookie: bar=foo\r\n"; $expected = array( 'Content-Type' => 'text/html; charset=UTF-8', 'Server' => 'Funky/1.0', 'X-BB-ExampleMANycaPS' => 'test', 'Set-Cookie' => array( 'foo=bar', 'baz=quux', 'bar=foo' ) ); $headerFunction = new ReflectionMethod('RestfulService', 'parseRawHeaders'); $headerFunction->setAccessible(true); $this->assertEquals( $expected, $headerFunction->invoke( new RestfulService(Director::absoluteBaseURL(),0), $headers ) ); } public function testExtractResponseRedirectionAndProxy() { // This is an example of real raw response for a request via a proxy that gets redirected. $rawHeaders = "HTTP/1.0 200 Connection established\r\n" . "\r\n" . "HTTP/1.1 301 Moved Permanently\r\n" . "Server: nginx\r\n" . "Date: Fri, 20 Sep 2013 01:53:07 GMT\r\n" . "Content-Type: text/html\r\n" . "Content-Length: 178\r\n" . "Connection: keep-alive\r\n" . "Location: https://www.foobar.org.nz/\r\n" . "\r\n" . "HTTP/1.0 200 Connection established\r\n" . "\r\n" . "HTTP/1.1 200 OK\r\n" . "Server: nginx\r\n" . "Date: Fri, 20 Sep 2013 01:53:08 GMT\r\n" . "Content-Type: text/html; charset=utf-8\r\n" . "Transfer-Encoding: chunked\r\n" . "Connection: keep-alive\r\n" . "X-Frame-Options: SAMEORIGIN\r\n" . "Cache-Control: no-cache, max-age=0, must-revalidate, no-transform\r\n" . "Vary: Accept-Encoding\r\n" . "\r\n" ; $headerFunction = new ReflectionMethod('RestfulService', 'extractResponse'); $headerFunction->setAccessible(true); $ch = curl_init(); $response = $headerFunction->invoke( new RestfulService(Director::absoluteBaseURL(),0), $ch, $rawHeaders, '' ); $this->assertEquals( $response->getHeaders(), array( 'Server' => "nginx", 'Date' => "Fri, 20 Sep 2013 01:53:08 GMT", 'Content-Type' => "text/html; charset=utf-8", 'Transfer-Encoding' => "chunked", 'Connection' => "keep-alive", 'X-Frame-Options' => "SAMEORIGIN", 'Cache-Control' => "no-cache, max-age=0, must-revalidate, no-transform", 'Vary' => "Accept-Encoding" ), 'Only last header is extracted and parsed.' ); } public function testExtractResponseNoHead() { $headerFunction = new ReflectionMethod('RestfulService', 'extractResponse'); $headerFunction->setAccessible(true); $ch = curl_init(); $response = $headerFunction->invoke( new RestfulService(Director::absoluteBaseURL(),0), $ch, '', '' ); $this->assertEquals($response->getHeaders(), array(), 'Headers are correctly extracted.'); } } class RestfulServiceTest_Controller extends Controller implements TestOnly { private static $allowed_actions = array( 'index', 'httpErrorWithoutCache', 'httpErrorWithCache' ); public function init() { $this->basicAuthEnabled = false; parent::init(); } public function index() { $request = ''; foreach ($this->getRequest()->requestVars() as $key=>$value) { $request .= "\t\t$value\n"; } $get = ''; foreach ($this->getRequest()->getVars() as $key => $value) { $get .= "\t\t$value\n"; } $post = ''; foreach ($this->getRequest()->postVars() as $key => $value) { $post .= "\t\t$value\n"; } $body = $this->getRequest()->getBody(); $out = << $request $get $post $body XML; $this->response->setBody($out); $this->response->addHeader('Content-type', 'text/xml'); return $this->response; } public function invalid() { $out = << XML; header('Content-type: text/xml'); echo $out; } public function httpErrorWithoutCache() { $out = << HTTP Error XML; $this->response->setBody($out); $this->response->setStatusCode(400); $this->response->addHeader('Content-type', 'text/xml'); return $this->response; } /** * The body of this method is the same as self::httpErrorWithoutCache() * but we need it for caching since caching using request url to determine path to cache file */ public function httpErrorWithCache() { return $this->httpErrorWithoutCache(); } } /** * Mock implementation of {@link RestfulService}, which uses {@link Director::test()} * instead of direct curl system calls. * * @todo Less overloading of request() * @todo Currently only works with relative (internal) URLs * * @package framework * @subpackage tests */ class RestfulServiceTest_MockRestfulService extends RestfulService { public $session = null; public function request($subURL = '', $method = "GET", $data = null, $headers = null, $curlOptions = array()) { if(!$this->session) { $this->session = Injector::inst()->create('Session', array()); } $url = $this->baseURL . $subURL; // Url for the request if($this->queryString) { if(strpos($url, '?') !== false) { $url .= '&' . $this->queryString; } else { $url .= '?' . $this->queryString; } } $url = str_replace(' ', '%20', $url); // Encode spaces // Custom for mock implementation: Director::test() doesn't cope with absolute URLs $url = Director::makeRelative($url); $method = strtoupper($method); assert(in_array($method, array('GET','POST','PUT','DELETE','HEAD','OPTIONS'))); // Add headers if($this->customHeaders) { $headers = array_merge((array)$this->customHeaders, (array)$headers); } // Add authentication if($this->authUsername) { $headers[] = "Authorization: Basic " . base64_encode( $this->authUsername.':'.$this->authPassword ); } // Custom for mock implementation: Use Director::test() $body = null; $postVars = null; if($method!='POST') $body = $data; else $postVars = $data; $responseFromDirector = Director::test($url, $postVars, $this->session, $method, $body, $headers); $response = new RestfulService_Response( $responseFromDirector->getBody(), $responseFromDirector->getStatusCode() ); return $response; } } /** * A mock service that returns a 400 error for requests. */ class RestfulServiceTest_MockErrorService extends RestfulService { public function curlRequest($url, $method, $data = null, $headers = null, $curlOptions = array()) { return new RestfulService_Response('HTTP Error', 400); } }