Merge pull request #246 from aik099/test-refactoring

Use same custom assert method for checking array/Result API method responses

Author: aik099

tests/Jira/AbstractApiTestCase.php

@@ -52,14 +52,18 @@ protected function setUpTest()
 	/**
 	 * Checks, that response is correct.
 	 *
-	 * @param string       $expected_raw_response Expected raw response.
-	 * @param Result|false $actual_response       Actual response.
+	 * @param string             $expected_raw_response Expected raw response.
+	 * @param array|Result|false $actual_response       Actual response.
 	 *
 	 * @return void
 	 */
-	protected function assertApiResponse($expected_raw_response, $actual_response)
+	protected function assertApiResponse($expected_raw_response, $actual_response, $wrap_in_result = true)
 	{
-		$expected = new Result(json_decode($expected_raw_response, true));
+		$expected = json_decode($expected_raw_response, true);
+
+		if ( $wrap_in_result ) {
+			$expected = new Result($expected);
+		}
 
 		// You'll get "false", when unexpected API call was made.
 		if ( $actual_response !== false ) {

tests/Jira/ApiTest.php

@@ -476,9 +476,8 @@ public function testGetCreateMeta(
 
 		// Perform the API call.
 		$actual = $this->api->getCreateMeta($project_ids, $project_keys, $issue_type_ids, $issue_type_names, $expand);
-		$response_decoded = json_decode($response, true);
 
-		$this->assertEquals($response_decoded, $actual, 'The decoded response does not match the actual result.');
+		$this->assertApiResponse($response, $actual, false);
 	}
 
 	public static function getCreateMetaDataProvider()

tests/Jira/IssueAttachmentsApiTest.php

@@ -89,10 +89,7 @@ public function testGetAttachment()
 			$response
 		);
 
-		$this->assertEquals(
-			json_decode($response, true),
-			$this->api->getAttachment('18700')
-		);
+		$this->assertApiResponse($response, $this->api->getAttachment('18700'), false);
 	}
 
 }

tests/Jira/IssueWorklogsApiTest.php

@@ -43,9 +43,7 @@ public function testAddWorkLogWithoutCustomParams($time_spent, array $expected_r
 			$response
 		);
 
-		$actual = $this->api->addWorklog('JRA-15', $time_spent);
-
-		$this->assertEquals(json_decode($response, true), $actual, 'The response is json-decoded.');
+		$this->assertApiResponse($response, $this->api->addWorklog('JRA-15', $time_spent), false);
 	}
 
 	public static function addWorkLogWithoutCustomParamsDataProvider()
@@ -68,9 +66,11 @@ public function testAddWorklogWithCustomParams()
 			$response
 		);
 
-		$actual = $this->api->addWorklog('JRA-15', '12m', array('started' => $started));
-
-		$this->assertEquals(json_decode($response, true), $actual, 'The response is json-decoded.');
+		$this->assertApiResponse(
+			$response,
+			$this->api->addWorklog('JRA-15', '12m', array('started' => $started)),
+			false
+		);
 	}
 
 	public function testDeleteWorkLogWithoutCustomParams()
@@ -84,9 +84,7 @@ public function testDeleteWorkLogWithoutCustomParams()
 			$response
 		);
 
-		$actual = $this->api->deleteWorklog('JRA-15', 11256);
-
-		$this->assertEquals(json_decode($response, true), $actual, 'The response is json-decoded.');
+		$this->assertApiResponse($response, $this->api->deleteWorklog('JRA-15', 11256), false);
 	}
 
 	public function testDeleteWorkLogWithCustomParams()
@@ -100,9 +98,11 @@ public function testDeleteWorkLogWithCustomParams()
 			$response
 		);
 
-		$actual = $this->api->deleteWorklog('JRA-15', 11256, array('custom' => 'param'));
-
-		$this->assertEquals(json_decode($response, true), $actual, 'The response is json-decoded.');
+		$this->assertApiResponse(
+			$response,
+			$this->api->deleteWorklog('JRA-15', 11256, array('custom' => 'param')),
+			false
+		);
 	}
 
 }

tests/Jira/ProjectRolesApiTest.php

@@ -21,10 +21,7 @@ public function testGetProjectRoles()
 			$response
 		);
 
-		$actual = $this->api->getRoles($project_id);
-
-		$expected = json_decode($response, true);
-		$this->assertEquals($expected, $actual);
+		$this->assertApiResponse($response, $this->api->getRoles($project_id), false);
 	}
 
 	public function testGetProjectRoleDetails()
@@ -40,10 +37,7 @@ public function testGetProjectRoleDetails()
 			$response
 		);
 
-		$actual = $this->api->getRoleDetails($project_id, $role_id);
-
-		$expected = json_decode($response, true);
-		$this->assertEquals($expected, $actual);
+		$this->assertApiResponse($response, $this->api->getRoleDetails($project_id, $role_id), false);
 	}
 
 }

tests/Jira/ProjectVersionsApiTest.php

@@ -21,10 +21,7 @@ public function testGetVersions()
 			$response
 		);
 
-		$this->assertEquals(
-			json_decode($response, true),
-			$this->api->getVersions($project_key)
-		);
+		$this->assertApiResponse($response, $this->api->getVersions($project_key), false);
 	}
 
 	public function testCreateVersionWithoutCustomParams()

tests/Jira/ProjectsApiTest.php

@@ -33,10 +33,7 @@ public function testGetProject()
 			$response
 		);
 
-		$this->assertEquals(
-			json_decode($response, true),
-			$this->api->getProject('TST')
-		);
+		$this->assertApiResponse($response, $this->api->getProject('TST'), false);
 	}
 
 	public function testGetProjectComponents()
@@ -49,10 +46,7 @@ public function testGetProjectComponents()
 			$response
 		);
 
-		$this->assertEquals(
-			json_decode($response, true),
-			$this->api->getProjectComponents('TST')
-		);
+		$this->assertApiResponse($response, $this->api->getProjectComponents('TST'), false);
 	}
 
 	public function testGetProjectIssueTypes()
@@ -65,10 +59,7 @@ public function testGetProjectIssueTypes()
 			$response
 		);
 
-		$this->assertEquals(
-			json_decode($response, true),
-			$this->api->getProjectIssueTypes('TST')
-		);
+		$this->assertApiResponse($response, $this->api->getProjectIssueTypes('TST'), false);
 	}
 
 }