Support live testing for developers

Author: aik099

CONTRIBUTING.md

@@ -35,6 +35,17 @@ Then run the unit tests as per normal.
 
 N.B. you can study the `.github/workflows/tests.yml` file to see how we run these tests on our build servers by way of example.
 
+### OPTIONAL: Creating a LIVE test locally
+
+1. copy `phpunit.xml.dist` file into `phpunit.xml` file
+2. in the `phpunit.xml` file:
+ * uncomment part, where `LIVE_TEST_ENDPOINT`, `LIVE_TEST_USERNAME` and `LIVE_TEST_PASSWORD` environment variables are defined
+ * populate them with the corresponding values
+3. write the desired LIVE test in the `ApiTest::testLive` method (e.g. `$api->addWorklog('JRA-12', '12m');`)
+4. run it using `vendor/bin/phpunit --filter testLive` command
+5. confirm, that results in your Jira instance are as expected
+6. rollback changes to the `ApiTest::testLive` method before sending a PR
+
 ### Running Test Suite
 
 Make sure that you don't break anything with your changes by running:

phpunit.xml.dist

@@ -14,15 +14,18 @@
 		</testsuite>
 	</testsuites>
 
-	<filter>
-		<whitelist>
-			<directory>src</directory>
-		</whitelist>
-	</filter>
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
 
-	<!--
-		<php>
+    <!--
+        <php>
 			<server name="REPO_URL" value="http://localhost/"/>
-		</php>
+			<server name="LIVE_TEST_ENDPOINT" value="https://site.atlassian.net/"/>
+			<server name="LIVE_TEST_USERNAME" value=""/>
+			<server name="LIVE_TEST_PASSWORD" value=""/>
+        </php>
 	-->
 </phpunit>

phpunit10.xml.dist

@@ -23,6 +23,9 @@
 	<!--
 		<php>
 			<server name="REPO_URL" value="http://localhost/"/>
+			<server name="LIVE_TEST_ENDPOINT" value="https://site.atlassian.net/"/>
+			<server name="LIVE_TEST_USERNAME" value=""/>
+			<server name="LIVE_TEST_PASSWORD" value=""/>
 		</php>
 	-->
 </phpunit>

phpunit7.xml.dist

@@ -22,6 +22,9 @@
 		<!--
 			<php>
 				<server name="REPO_URL" value="http://localhost/"/>
+				<server name="LIVE_TEST_ENDPOINT" value="https://site.atlassian.net/"/>
+				<server name="LIVE_TEST_USERNAME" value=""/>
+				<server name="LIVE_TEST_PASSWORD" value=""/>
 			</php>
 		-->
 </phpunit>

phpunit9.xml.dist

@@ -23,6 +23,9 @@
 	<!--
 		<php>
 			<server name="REPO_URL" value="http://localhost/"/>
+			<server name="LIVE_TEST_ENDPOINT" value="https://site.atlassian.net/"/>
+			<server name="LIVE_TEST_USERNAME" value=""/>
+			<server name="LIVE_TEST_PASSWORD" value=""/>
 		</php>
 	-->
 </phpunit>

tests/Jira/ApiTest.php

@@ -5,6 +5,7 @@
 
 use chobie\Jira\Api;
 use chobie\Jira\Api\Authentication\AuthenticationInterface;
+use chobie\Jira\Api\Authentication\Basic;
 use chobie\Jira\Api\Result;
 use chobie\Jira\IssueType;
 use Prophecy\Prophecy\ObjectProphecy;
@@ -392,6 +393,21 @@ public function testDeleteWorkLogWithCustomParams()
 		$this->assertEquals(json_decode($response, true), $actual, 'The response is json-decoded.');
 	}
 
+	public function testLive()
+	{
+		if ( empty($_SERVER['LIVE_TEST_ENDPOINT']) ) {
+			$this->markTestSkipped('The "LIVE_TEST_ENDPOINT" environment variable not set.');
+		}
+
+		$api = new Api(
+			$_SERVER['LIVE_TEST_ENDPOINT'],
+			new Basic($_SERVER['LIVE_TEST_USERNAME'], $_SERVER['LIVE_TEST_PASSWORD'])
+		);
+
+		// Write you test here, but don't commit.
+		$this->assertTrue(true);
+	}
+
 	/**
 	 * Expects a particular client call.
 	 *
@@ -407,7 +423,7 @@ public function testDeleteWorkLogWithCustomParams()
 	protected function expectClientCall(
 		$method,
 		$url,
-		$data = array(),
+		$data,
 		$return_value,
 		$is_file = false,
 		$debug = false