owncloud · phil-davis · Sep 2, 2020 · Aug 31, 2020
diff --git a/tests/TestHelpers/AppConfigHelper.php b/tests/TestHelpers/AppConfigHelper.php
@@ -204,7 +204,7 @@ public static function wasCapabilitySet(
 	 * @return string
 	 */
 	public static function getOCSResponse($response) {
-		return HttpRequestHelper::getResponseXml($response)->meta[0]->statuscode;
+		return HttpRequestHelper::getResponseXml($response, __METHOD__)->meta[0]->statuscode;
 	}
 
 	/**
@@ -225,7 +225,15 @@ public static function getCapabilities($baseUrl, $user, $password) {
 			'/cloud/capabilities',
 			null
 		);
-		self::assertEquals(200, $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		return $response;
 	}
 
@@ -235,7 +243,7 @@ public static function getCapabilities($baseUrl, $user, $password) {
 	 * @return string retrieved capabilities in XML format
 	 */
 	public static function getCapabilitiesXml($response) {
-		return HttpRequestHelper::getResponseXml($response)->data->capabilities;
+		return HttpRequestHelper::getResponseXml($response, __METHOD__)->data->capabilities;
 	}
 
 	/**
@@ -264,10 +272,22 @@ public static function modifyAppConfig(
 			$body,
 			$ocsApiVersion
 		);
-		self::assertEquals("200", $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		if ($ocsApiVersion === 1) {
+			$expectedOcsStatus = "100";
+			$actualOcsStatus = self::getOCSResponse($response);
 			self::assertEquals(
-				"100", self::getOCSResponse($response)
+				$expectedOcsStatus,
+				$actualOcsStatus,
+				__METHOD__ . " expected OCS status $expectedOcsStatus but got $actualOcsStatus"
 			);
 		}
 	}
@@ -303,10 +323,22 @@ public static function modifyAppConfigs(
 			$body,
 			$ocsApiVersion
 		);
-		self::assertEquals("200", $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		if ($ocsApiVersion === 1) {
+			$expectedOcsStatus = "100";
+			$actualOcsStatus = self::getOCSResponse($response);
 			self::assertEquals(
-				"100", self::getOCSResponse($response)
+				$expectedOcsStatus,
+				$actualOcsStatus,
+				__METHOD__ . " expected OCS status $expectedOcsStatus but got $actualOcsStatus"
 			);
 		}
 	}
@@ -334,10 +366,22 @@ public static function deleteAppConfig(
 			$body,
 			$ocsApiVersion
 		);
-		self::assertEquals("200", $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		if ($ocsApiVersion === 1) {
+			$expectedOcsStatus = "100";
+			$actualOcsStatus = self::getOCSResponse($response);
 			self::assertEquals(
-				"100", self::getOCSResponse($response)
+				$expectedOcsStatus,
+				$actualOcsStatus,
+				__METHOD__ . " expected OCS status $expectedOcsStatus but got $actualOcsStatus"
 			);
 		}
 	}
@@ -364,10 +408,22 @@ public static function deleteAppConfigs(
 			$body,
 			$ocsApiVersion
 		);
-		self::assertEquals("200", $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		if ($ocsApiVersion === 1) {
+			$expectedOcsStatus = "100";
+			$actualOcsStatus = self::getOCSResponse($response);
 			self::assertEquals(
-				"100", self::getOCSResponse($response)
+				$expectedOcsStatus,
+				$actualOcsStatus,
+				__METHOD__ . " expected OCS status $expectedOcsStatus but got $actualOcsStatus"
 			);
 		}
 	}
@@ -393,14 +449,26 @@ public static function getAppConfigs(
 			null,
 			$ocsApiVersion
 		);
-		self::assertEquals("200", $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		if ($ocsApiVersion === 1) {
+			$expectedOcsStatus = "100";
+			$actualOcsStatus = self::getOCSResponse($response);
 			self::assertEquals(
-				"100", self::getOCSResponse($response)
+				$expectedOcsStatus,
+				$actualOcsStatus,
+				__METHOD__ . " expected OCS status $expectedOcsStatus but got $actualOcsStatus"
 			);
 		}
 
-		$responseXml = HttpRequestHelper::getResponseXml($response)->data[0];
+		$responseXml = HttpRequestHelper::getResponseXml($response, __METHOD__)->data[0];
 		$response = \json_decode(\json_encode($responseXml), true)['element'];
 		return $response;
 	}
@@ -427,14 +495,26 @@ public static function getAppConfig(
 			null,
 			$ocsApiVersion
 		);
-		self::assertEquals("200", $response->getStatusCode());
+
+		$expectedHttpStatus = 200;
+		$actualHttpStatus = $response->getStatusCode();
+
+		self::assertEquals(
+			$expectedHttpStatus,
+			$actualHttpStatus,
+			__METHOD__ . " expected HTTP status $expectedHttpStatus but got $actualHttpStatus"
+		);
 		if ($ocsApiVersion === 1) {
+			$expectedOcsStatus = "100";
+			$actualOcsStatus = self::getOCSResponse($response);
 			self::assertEquals(
-				"100", self::getOCSResponse($response)
+				$expectedOcsStatus,
+				$actualOcsStatus,
+				__METHOD__ . " expected OCS status $expectedOcsStatus but got $actualOcsStatus"
 			);
 		}
 
-		$responseXml = HttpRequestHelper::getResponseXml($response)->data[0];
+		$responseXml = HttpRequestHelper::getResponseXml($response, __METHOD__)->data[0];
 		$response = \json_decode(\json_encode($responseXml), true)['element'];
 		return $response;
 	}

diff --git a/tests/TestHelpers/Asserts/WebDav.php b/tests/TestHelpers/Asserts/WebDav.php
@@ -34,15 +34,20 @@ class WebDav extends \PHPUnit\Framework\Assert {
 	 * @param string $element exception|message|reason
 	 * @param string $expectedValue
 	 * @param array $responseXml
+	 * @param string $extraErrorText
 	 *
 	 * @return void
-	 * @throws \Exception
 	 */
 	public static function assertDavResponseElementIs(
-		$element, $expectedValue, $responseXml
+		$element, $expectedValue, $responseXml, $extraErrorText = ''
 	) {
+		if ($extraErrorText !== '') {
+			$extraErrorText = $extraErrorText . " ";
+		}
 		self::assertArrayHasKey(
-			'value', $responseXml, '$responseXml seems not to be a valid array'
+			'value',
+			$responseXml,
+			$extraErrorText . "responseXml does not have key 'value'"
 		);
 		if ($element === "exception") {
 			$result = $responseXml['value'][0]['value'];
@@ -54,7 +59,7 @@ public static function assertDavResponseElementIs(
 
 		self::assertEquals(
 			$expectedValue, $result,
-			"Expected '$expectedValue' in element $element got '$result'"
+			__METHOD__ . " " . $extraErrorText . "Expected '$expectedValue' in element $element got '$result'"
 		);
 	}
 

diff --git a/tests/TestHelpers/HttpRequestHelper.php b/tests/TestHelpers/HttpRequestHelper.php
@@ -333,11 +333,12 @@ public static function delete(
 	 *  | ocs    | http://open-collaboration-services.org/ns |
 	 *
 	 * @param ResponseInterface $response
+	 * @param string $exceptionText text to put at the front of exception messages
 	 *
 	 * @return SimpleXMLElement
 	 * @throws \Exception
 	 */
-	public static function getResponseXml($response) {
+	public static function getResponseXml($response, $exceptionText = '') {
 		// rewind just to make sure we can re-parse it in case it was parsed already...
 		$response->getBody()->rewind();
 		$contents = $response->getBody()->getContents();
@@ -354,10 +355,13 @@ public static function getResponseXml($response) {
 			);
 			return $responseXmlObject;
 		} catch (\Exception $e) {
+			if ($exceptionText !== '') {
+				$exceptionText = $exceptionText . ' ';
+			}
 			if ($contents === '') {
-				throw new \Exception("Received empty response where XML was expected");
+				throw new \Exception($exceptionText . "Received empty response where XML was expected");
 			}
-			$message = "Exception parsing response body: \"" . $contents . "\"";
+			$message = $exceptionText . "Exception parsing response body: \"" . $contents . "\"";
 			throw new \Exception($message, 0, $e);
 		}
 	}

diff --git a/tests/TestHelpers/LoggingHelper.php b/tests/TestHelpers/LoggingHelper.php
@@ -90,7 +90,7 @@ public static function getLogFileContent(
 				"could not get logfile content " . $result->getReasonPhrase()
 			);
 		}
-		return HttpRequestHelper::getResponseXml($result)->data->element;
+		return HttpRequestHelper::getResponseXml($result, __METHOD__)->data->element;
 	}
 
 	/**

diff --git a/tests/TestHelpers/SetupHelper.php b/tests/TestHelpers/SetupHelper.php
@@ -251,7 +251,7 @@ public static function getSysInfo(
 				"could not get sysinfo " . $result->getReasonPhrase()
 			);
 		}
-		return HttpRequestHelper::getResponseXml($result)->data;
+		return HttpRequestHelper::getResponseXml($result, __METHOD__)->data;
 	}
 
 	/**
@@ -505,7 +505,7 @@ public static function readFileFromServer(
 			$response->getStatusCode(),
 			"Failed to read the file {$fileInCore}"
 		);
-		$localContent = HttpRequestHelper::getResponseXml($response);
+		$localContent = HttpRequestHelper::getResponseXml($response, __METHOD__);
 		$localContent = (string)$localContent->data->element->contentUrlEncoded;
 		return \urldecode($localContent);
 	}
@@ -561,7 +561,7 @@ public static function readSkeletonFile(
 			$response->getStatusCode(),
 			"Failed to read the file {$fileInSkeletonFolder}"
 		);
-		$localContent = HttpRequestHelper::getResponseXml($response);
+		$localContent = HttpRequestHelper::getResponseXml($response, __METHOD__);
 		$localContent = (string)$localContent->data->element->contentUrlEncoded;
 		$localContent = \urldecode($localContent);
 		return $localContent;

diff --git a/tests/TestHelpers/TagsHelper.php b/tests/TestHelpers/TagsHelper.php
@@ -140,7 +140,7 @@ public static function requestTagsForUser(
 		$response = WebDavHelper::propfind(
 			$baseUrl, $user, $password, '/systemtags/', $properties, 1, "systemtags"
 		);
-		return HttpRequestHelper::getResponseXml($response);
+		return HttpRequestHelper::getResponseXml($response, __METHOD__);
 	}
 
 	/**

diff --git a/tests/TestHelpers/UserHelper.php b/tests/TestHelpers/UserHelper.php
@@ -266,7 +266,7 @@ public static function getGroupsAsArray(
 		$baseUrl, $adminUser, $adminPassword, $search =""
 	) {
 		$result = self::getGroups($baseUrl, $adminUser, $adminPassword, $search);
-		$groups = HttpRequestHelper::getResponseXml($result)->xpath(".//groups")[0];
+		$groups = HttpRequestHelper::getResponseXml($result, __METHOD__)->xpath(".//groups")[0];
 		$return = [];
 		foreach ($groups as $group) {
 			$return[] = $group->__toString();

diff --git a/tests/TestHelpers/WebDavHelper.php b/tests/TestHelpers/WebDavHelper.php
@@ -513,7 +513,10 @@ public static function getMtimeOfFileinPublicLinkShare(
 			null,
 			$davVersionToUse
 		);
-		$responseXmlObject = HttpRequestHelper::getResponseXml($response);
+		$responseXmlObject = HttpRequestHelper::getResponseXml(
+			$response,
+			__METHOD__
+		);
 		$xmlPart = $responseXmlObject->xpath("//d:getlastmodified");
 
 		return $xmlPart[0]->__toString();
@@ -538,7 +541,10 @@ public static function getMtimeOfResource($user,
 		$response = self::propfind(
 			$baseUrl, $user, $password, $resource, ["getlastmodified"]
 		);
-		$responseXmlObject = HttpRequestHelper::getResponseXml($response);
+		$responseXmlObject = HttpRequestHelper::getResponseXml(
+			$response,
+			__METHOD__
+		);
 		$xmlpart = $responseXmlObject->xpath("//d:getlastmodified");
 		$mtime = new DateTime($xmlpart[0]->__toString());
 		return $mtime->format('U');

diff --git a/tests/acceptance/features/bootstrap/AppConfigurationContext.php b/tests/acceptance/features/bootstrap/AppConfigurationContext.php
@@ -105,7 +105,7 @@ public function theCapabilitiesSettingOfAppParameterShouldBe(
 	 */
 	public function getAppParameter($capabilitiesApp, $capabilitiesPath) {
 		$answeredValue = $this->getParameterValueFromXml(
-			$this->getCapabilitiesXml(),
+			$this->getCapabilitiesXml(__METHOD__),
 			$capabilitiesApp,
 			$capabilitiesPath
 		);
@@ -189,10 +189,15 @@ public function theAdministratorGetsCapabilitiesCheckResponse() {
 	}
 
 	/**
+	 * @param string $exceptionText text to put at the front of exception messages
+	 *
 	 * @return string latest retrieved capabilities in XML format
 	 */
-	public function getCapabilitiesXml() {
-		return $this->featureContext->getResponseXml()->data->capabilities;
+	public function getCapabilitiesXml($exceptionText = '') {
+		if ($exceptionText === '') {
+			$exceptionText = __METHOD__;
+		}
+		return $this->featureContext->getResponseXml(null, $exceptionText)->data->capabilities;
 	}
 
 	/**
-Original file line number
+Diff line change
@@ Expand Up / @@ -90,7 +90,7 @@ public static function getLogFileContent( @@
     				"could not get logfile content " . $result->getReasonPhrase()
     			);
     		}
-    		return HttpRequestHelper::getResponseXml($result)->data->element;
+    		return HttpRequestHelper::getResponseXml($result, __METHOD__)->data->element;
     	}
     	/**
@@ Expand Down @@