Add some basic tests for client classes

Author: Alexander Obuhovich

.gitignore

@@ -1,3 +1,4 @@
 vendor
+phpunit.xml
 composer.lock
 .idea

.travis.yml

@@ -17,5 +17,12 @@ php:
 install:
   - composer install --prefer-dist
 
+before_script:
+  - ~/.phpenv/versions/5.4/bin/php -S localhost:8000 -t $(pwd) > /dev/null 2> /tmp/webserver_output.txt &
+  - export REPO_URL=http://localhost:8000/
+
 script:
   - ./vendor/bin/phpunit
+
+after_failure:
+    - cat /tmp/webserver_output.txt

CONTRIBUTING.md

@@ -15,7 +15,13 @@ JIRA REST API Client is an open source, community-driven project. If you'd like
 7. Create Pull Request.
 
 ## Running the Tests
-Make sure that you don't break anything with your changes by running:
+
+1. make sure repository is located in web server document root (or it's sub-folder)
+2. copy `phpunit.xml.dist` file into `phpunit.xml` file
+3. in the `phpunit.xml` file:
+ * uncomment part, where `REPO_URL` environment variable is defined
+ * set `REPO_URL` environment variable value to URL, from where repository can be accessed (e.g. `http://localhost/path/to/repository/`)
+4. run following command to make sure that you don't break anything with your changes:
 
 ```bash
 $> phpunit

phpunit.xml.dist

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<phpunit backupGlobals="true"
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="true"
          backupStaticAttributes="false"
          colors="true"
          convertErrorsToExceptions="true"
@@ -13,13 +14,17 @@
          syntaxCheck="true"
          strict="true"
          verbose="true">
-    <php>
-        <ini name="date.timezone" value="Asia/Tokyo" />
-    </php>
+
     <testsuites>
         <testsuite name="Jira_Api Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
 
-</phpunit>
+    <!--
+        <php>
+            <server name="REPO_URL" value="http://localhost/"/>
+        </php>
+    -->
+
+</phpunit>

src/Jira/Api/Client/ClientInterface.php

@@ -42,6 +42,7 @@ interface ClientInterface
 	 * @param boolean                 $debug      Debug this request.
 	 *
 	 * @return array|string
+	 * @throws \InvalidArgumentException When data is not an array and http method is GET.
 	 */
 	public function sendRequest(
 		$method,

src/Jira/Api/Client/CurlClient.php

@@ -75,11 +75,11 @@ public function sendRequest(
 		$curl = curl_init();
 
 		if ( $method == 'GET' ) {
-			$url .= '?' . http_build_query($data);
-
 			if ( !is_array($data) ) {
 				throw new \InvalidArgumentException('Data must be an array.');
 			}
+
+			$url .= '?' . http_build_query($data);
 		}
 
 		curl_setopt($curl, CURLOPT_URL, $endpoint . $url);

src/Jira/Api/Client/PHPClient.php

@@ -76,6 +76,7 @@ protected function isHttpsSupported()
 	 *
 	 * @return array|string
 	 * @throws \Exception When non-supported implementation of AuthenticationInterface is given.
+	 * @throws \InvalidArgumentException When data is not an array and http method is GET.
 	 */
 	public function sendRequest(
 		$method,
@@ -130,6 +131,10 @@ public function sendRequest(
 			$context['http']['content'] = $__data;
 		}
 		else {
+			if ( !is_array($data) ) {
+				throw new \InvalidArgumentException('Data must be an array.');
+			}
+
 			$url .= '?' . http_build_query($data);
 		}
 

tests/Jira/Api/Client/AbstractClientTestCase.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Tests\chobie\Jira\Api\Client;
+
+
+use chobie\Jira\Api\Authentication\Anonymous;
+use chobie\Jira\Api\Client\ClientInterface;
+
+abstract class AbstractClientTestCase extends \PHPUnit_Framework_TestCase
+{
+
+	/**
+	 * Client.
+	 *
+	 * @var ClientInterface
+	 */
+	protected $client;
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		if ( empty($_SERVER['REPO_URL']) ) {
+			$this->markTestSkipped('The "REPO_URL" environment variable not set.');
+		}
+
+		$this->client = $this->createClient();
+	}
+
+	public function testGetRequestDataAsArray()
+	{
+		$query_params = array('param1' => 'value1', 'param2' => 'value2');
+		$trace_result = $this->traceRequest('GET', $query_params);
+
+		$this->assertEquals($query_params, $trace_result['_GET']);
+	}
+
+	/**
+	 * @expectedException \InvalidArgumentException
+	 * @expectedExceptionMessage Data must be an array.
+	 */
+	public function testGetRequestDataAsString()
+	{
+		$this->traceRequest('GET', 'param1=value1&param2=value2');
+	}
+
+	/**
+	 * Traces a request.
+	 *
+	 * @param string  $method  Request method.
+	 * @param array   $data    Request data.
+	 * @param boolean $is_file This is a file upload request.
+	 * @param boolean $debug   Debug this request.
+	 *
+	 * @return array
+	 */
+	protected function traceRequest($method, $data = array(), $is_file = false, $debug = false)
+	{
+		$result = $this->client->sendRequest(
+			$method,
+			'/tests/debug_response.php',
+			$data,
+			rtrim($_SERVER['REPO_URL'], '/'),
+			new Anonymous(),
+			$is_file,
+			$debug
+		);
+
+		return unserialize($result);
+	}
+
+	/**
+	 * Creates client.
+	 *
+	 * @return ClientInterface
+	 */
+	abstract protected function createClient();
+
+}

tests/Jira/Api/Client/CurlClientTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Tests\chobie\Jira\Api\Client;
+
+
+use chobie\Jira\Api\Client\ClientInterface;
+use chobie\Jira\Api\Client\CurlClient;
+
+class CurlClientTest extends AbstractClientTestCase
+{
+
+	/**
+	 * Creates client.
+	 *
+	 * @return ClientInterface
+	 */
+	protected function createClient()
+	{
+		return new CurlClient();
+	}
+
+}

tests/Jira/Api/Client/PHPClientTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Tests\chobie\Jira\Api\Client;
+
+
+use chobie\Jira\Api\Client\ClientInterface;
+use chobie\Jira\Api\Client\PHPClient;
+
+class PHPClientTest extends AbstractClientTestCase
+{
+
+	/**
+	 * Creates client.
+	 *
+	 * @return ClientInterface
+	 */
+	protected function createClient()
+	{
+		return new PHPClient();
+	}
+
+}