Merge pull request #10680 from owncloud/remove-duplicated-method

[tests-only][full-ci]Remove duplicate function

Author: saw-jan

tests/acceptance/TestHelpers/Asserts/WebDav.php

@@ -32,31 +32,31 @@ class WebDav extends Assert {
 	 *
 	 * @param string|null $element exception|message|reason
 	 * @param string|null $expectedValue
-	 * @param array|null $responseXml
+	 * @param array|null $responseXmlArray
 	 * @param string|null $extraErrorText
 	 *
 	 * @return void
 	 */
 	public static function assertDavResponseElementIs(
 		?string $element,
 		?string $expectedValue,
-		?array $responseXml,
+		?array $responseXmlArray,
 		?string $extraErrorText = ''
 	):void {
 		if ($extraErrorText !== '') {
 			$extraErrorText = $extraErrorText . " ";
 		}
 		self::assertArrayHasKey(
 			'value',
-			$responseXml,
+			$responseXmlArray,
 			$extraErrorText . "responseXml does not have key 'value'"
 		);
 		if ($element === "exception") {
-			$result = $responseXml['value'][0]['value'];
+			$result = $responseXmlArray['value'][0]['value'];
 		} elseif ($element === "message") {
-			$result = $responseXml['value'][1]['value'];
+			$result = $responseXmlArray['value'][1]['value'];
 		} elseif ($element === "reason") {
-			$result = $responseXml['value'][3]['value'];
+			$result = $responseXmlArray['value'][3]['value'];
 		} else {
 			self::fail(__METHOD__ . " element must be one of exception, response or reason. But '$element' was passed in.");
 		}

tests/acceptance/bootstrap/CapabilitiesContext.php

@@ -29,6 +29,7 @@
 use PHPUnit\Framework\Assert;
 use TestHelpers\OcsApiHelper;
 use TestHelpers\BehatHelper;
+use TestHelpers\HttpRequestHelper;
 
 require_once 'bootstrap.php';
 
@@ -213,9 +214,10 @@ public function statusPhpRespondedShouldMatch(PyStringNode $jsonExpected): void
 
 		$response = $this->userGetsCapabilities($this->getAdminUsernameForCapabilitiesCheck());
 		$this->featureContext->theHTTPStatusCodeShouldBe(200, '', $response);
-		$responseXml = $this->featureContext->getResponseXml($response)->data->capabilities;
+
+		$responseXmlObject = HttpRequestHelper::getResponseXml($response, __METHOD__)->data->capabilities;
 		$edition = $this->getParameterValueFromXml(
-			$responseXml,
+			$responseXmlObject,
 			'core',
 			'status@@@edition'
 		);
@@ -227,7 +229,7 @@ public function statusPhpRespondedShouldMatch(PyStringNode $jsonExpected): void
 		}
 
 		$product = $this->getParameterValueFromXml(
-			$responseXml,
+			$responseXmlObject,
 			'core',
 			'status@@@product'
 		);
@@ -238,7 +240,7 @@ public function statusPhpRespondedShouldMatch(PyStringNode $jsonExpected): void
 		}
 
 		$productName = $this->getParameterValueFromXml(
-			$responseXml,
+			$responseXmlObject,
 			'core',
 			'status@@@productname'
 		);
@@ -256,7 +258,7 @@ public function statusPhpRespondedShouldMatch(PyStringNode $jsonExpected): void
 		// We are on oCIS or reva or some other implementation. We cannot do "occ status".
 		// So get the expected version values by looking in the capabilities response.
 		$version = $this->getParameterValueFromXml(
-			$responseXml,
+			$responseXmlObject,
 			'core',
 			'status@@@version'
 		);
@@ -268,7 +270,7 @@ public function statusPhpRespondedShouldMatch(PyStringNode $jsonExpected): void
 		}
 
 		$versionString = $this->getParameterValueFromXml(
-			$responseXml,
+			$responseXmlObject,
 			'core',
 			'status@@@versionstring'
 		);
@@ -322,7 +324,7 @@ public function statusPhpRespondedShouldMatch(PyStringNode $jsonExpected): void
 		Assert::assertStringStartsWith(
 			$majorMinorPatchVersion,
 			$versionString,
-			"versionstring should start with $majorMinorPatchVersion but is $versionString"
+			"version string should start with $majorMinorPatchVersion but is $versionString"
 		);
 	}
 }

tests/acceptance/bootstrap/CollaborationContext.php

@@ -148,23 +148,23 @@ public function userCreatesFileInsideFolderInSpaceUsingWopiEndpoint(string $user
 	 *
 	 * @return void
 	 * @throws GuzzleException
+	 * @throws Exception
 	 */
 	public function createFile(string $file, string $password, string $folder = ""): void {
 		$token = $this->featureContext->shareNgGetLastCreatedLinkShareToken();
 		$baseUrl = $this->featureContext->getBaseUrl();
 		$davPath = WebDavHelper::getDavPath(WebDavHelper::DAV_VERSION_NEW, $token, "public-files");
-		$response = HttpRequestHelper::sendRequest(
-			"$baseUrl/$davPath/$folder",
-			$this->featureContext->getStepLineRef(),
-			"PROPFIND",
-			"public",
-			$this->featureContext->getActualPassword($password)
-		);
-		$responseXml = HttpRequestHelper::getResponseXml(
-			$response,
-			__METHOD__
+
+		$responseXmlObject = HttpRequestHelper::getResponseXml(
+			HttpRequestHelper::sendRequest(
+				"$baseUrl/$davPath/$folder",
+				$this->featureContext->getStepLineRef(),
+				"PROPFIND",
+				"public",
+				$this->featureContext->getActualPassword($password)
+			)
 		);
-		$xmlPart = $responseXml->xpath("//d:prop/oc:fileid");
+		$xmlPart = $responseXmlObject->xpath("//d:prop/oc:fileid");
 		$parentContainerId = (string) $xmlPart[0];
 
 		$headers = [

tests/acceptance/bootstrap/FeatureContext.php

@@ -54,7 +54,6 @@
 use Swaggest\JsonSchema\Exception\ObjectException;
 use Swaggest\JsonSchema\Exception\StringException;
 use Swaggest\JsonSchema\Exception\TypeException;
-use Swaggest\JsonSchema\Exception\Error as JsonSchemaError;
 
 require_once 'bootstrap.php';
 
@@ -998,11 +997,6 @@ public function setResponse(
 		string             $username = ""
 	): void {
 		$this->response = $response;
-		//after a new response reset the response xml
-		$this->responseXml = [];
-		//after a new response reset the response xml object
-		$this->responseXmlObject = null;
-		// remember the user that received the response
 		$this->responseUser = $username;
 	}
 
@@ -1032,26 +1026,6 @@ public function usingServer(?string $server): string {
 		return $previousServer;
 	}
 
-	/**
-	 * Parses the response as XML
-	 *
-	 * @param ResponseInterface|null $response
-	 * @param string|null $exceptionText text to put at the front of exception messages
-	 *
-	 * @return SimpleXMLElement
-	 * @throws Exception
-	 */
-	public function getResponseXml(?ResponseInterface $response = null, ?string $exceptionText = ''): SimpleXMLElement {
-		if ($response === null) {
-			$response = $this->response;
-		}
-
-		if ($exceptionText === '') {
-			$exceptionText = __METHOD__;
-		}
-		return HttpRequestHelper::getResponseXml($response, $exceptionText);
-	}
-
 	/**
 	 * @param JsonSchema $schemaObj
 	 *
@@ -2611,30 +2585,6 @@ public function workStorageDirLocation(): string {
 		return $this->acceptanceTestsDirLocation() . $this->temporaryStorageSubfolderName() . "/";
 	}
 
-	/**
-	 * Parse list of config keys from the given XML response
-	 *
-	 * @param SimpleXMLElement $responseXml
-	 *
-	 * @return array
-	 */
-	public function parseConfigListFromResponseXml(SimpleXMLElement $responseXml): array {
-		$configkeyData = \json_decode(\json_encode($responseXml->data), true);
-		if (isset($configkeyData['element'])) {
-			$configkeyData = $configkeyData['element'];
-		} else {
-			// There are no keys for the app
-			return [];
-		}
-		if (isset($configkeyData[0])) {
-			$configkeyValues = $configkeyData;
-		} else {
-			// There is just 1 key for the app
-			$configkeyValues[0] = $configkeyData;
-		}
-		return $configkeyValues;
-	}
-
 	/**
 	 * This will run before EVERY scenario.
 	 * It will set the properties for this object.

tests/acceptance/bootstrap/FilesVersionsContext.php

@@ -219,11 +219,11 @@ public function restoreVersionIndexOfFile(string $user, int $versionIndex, strin
 		$fileId = $this->featureContext->getFileIdForPath($user, $path);
 		Assert::assertNotNull($fileId, __METHOD__ . " fileid of file $path user $user not found (the file may not exist)");
 		$response = $this->listVersionFolder($user, $fileId, 1);
-		$responseXml = HttpRequestHelper::getResponseXml(
+		$responseXmlObject = HttpRequestHelper::getResponseXml(
 			$response,
 			__METHOD__
 		);
-		$xmlPart = $responseXml->xpath("//d:response/d:href");
+		$xmlPart = $responseXmlObject->xpath("//d:response/d:href");
 		//restoring the version only works with DAV path v2
 		$destinationUrl = $this->featureContext->getBaseUrl() . "/" .
 			WebDavHelper::getDavPath(WebDavHelper::DAV_VERSION_NEW, $user) . \trim($path, "/");
@@ -281,18 +281,18 @@ public function userRestoresVersionIndexOfFile(string $user, int $versionIndex,
 	 */
 	public function assertFileVersionsCount(string $user, string $fileId, int $expectedCount):void {
 		$response = $this->listVersionFolder($user, $fileId, 1);
-		$responseXml = HttpRequestHelper::getResponseXml(
+		$responseXmlObject = HttpRequestHelper::getResponseXml(
 			$response,
 			__METHOD__
 		);
-		$actualCount = \count($responseXml->xpath("//d:prop/d:getetag")) - 1;
+		$actualCount = \count($responseXmlObject->xpath("//d:prop/d:getetag")) - 1;
 		if ($actualCount === -1) {
 			$actualCount = 0;
 		}
 		Assert::assertEquals(
 			$expectedCount,
 			$actualCount,
-			"Expected $expectedCount versions but found $actualCount in \n" . $responseXml->asXML()
+			"Expected $expectedCount versions but found $actualCount in \n" . $responseXmlObject->asXML()
 		);
 	}
 
@@ -356,11 +356,11 @@ public function theContentLengthOfFileForUserInVersionsFolderIs(
 		$fileId = $this->featureContext->getFileIdForPath($user, $path);
 		Assert::assertNotNull($fileId, __METHOD__ . " fileid of file $path user $user not found (the file may not exist)");
 		$response = $this->listVersionFolder($user, $fileId, 1, ['d:getcontentlength']);
-		$responseXml = HttpRequestHelper::getResponseXml(
+		$responseXmlObject = HttpRequestHelper::getResponseXml(
 			$response,
 			__METHOD__
 		);
-		$xmlPart = $responseXml->xpath("//d:prop/d:getcontentlength");
+		$xmlPart = $responseXmlObject->xpath("//d:prop/d:getcontentlength");
 		Assert::assertEquals(
 			$length,
 			(int) $xmlPart[$index],
@@ -422,8 +422,8 @@ public function downloadVersion(string $user, string $path, string $index, ?stri
 		if ($response->getStatusCode() === 403) {
 			return $response;
 		}
-		$responseXml = new SimpleXMLElement($response->getBody()->getContents());
-		$xmlPart = $responseXml->xpath("//d:response/d:href");
+		$responseXmlObject = new SimpleXMLElement($response->getBody()->getContents());
+		$xmlPart = $responseXmlObject->xpath("//d:response/d:href");
 		if (!isset($xmlPart[$index])) {
 			Assert::fail(
 				'could not find version of path "' . $path . '" with index "' . $index . '"'
@@ -519,11 +519,6 @@ public function userGetMetaInfo(string $user, string $fileOrFileId, string $path
 			null
 		);
 		$this->featureContext->setResponse($response);
-		$responseXml = HttpRequestHelper::getResponseXml(
-			$response,
-			__METHOD__
-		);
-		$this->featureContext->setResponseXmlObject($responseXml);
 	}
 
 	/**

tests/acceptance/bootstrap/OCSContext.php

@@ -26,6 +26,7 @@
 use Behat\Gherkin\Node\TableNode;
 use Psr\Http\Message\ResponseInterface;
 use PHPUnit\Framework\Assert;
+use TestHelpers\HttpRequestHelper;
 use TestHelpers\OcsApiHelper;
 use TestHelpers\TranslationHelper;
 use TestHelpers\BehatHelper;
@@ -564,13 +565,11 @@ public function getOCSResponseStatusCode(ResponseInterface $response):string {
 			return (string) $jsonResponse->ocs->meta->statuscode;
 		}
 		// go to xml response when json response is null (it means not formatted and get status code)
-		$responseXml = $this->featureContext->getResponseXml($response, __METHOD__);
-		if (isset($responseXml->meta[0], $responseXml->meta[0]->statuscode)) {
-			return (string) $responseXml->meta[0]->statuscode;
+		$responseXmlObject = HttpRequestHelper::getResponseXml($response, __METHOD__);
+		if (isset($responseXmlObject->meta[0], $responseXmlObject->meta[0]->statuscode)) {
+			return (string) $responseXmlObject->meta[0]->statuscode;
 		}
-		throw new Exception(
-			"No OCS status code found in response"
-		);
+		Assert::fail("No OCS status code found in response");
 	}
 
 	/**
@@ -582,13 +581,11 @@ public function getOCSResponseStatusCode(ResponseInterface $response):string {
 	 * @throws Exception
 	 */
 	public function getOCSResponseData(ResponseInterface $response): SimpleXMLElement {
-		$responseXml = $this->featureContext->getResponseXml($response, __METHOD__);
-		if (isset($responseXml->data)) {
-			return $responseXml->data;
+		$responseXmlObject = HttpRequestHelper::getResponseXml($response, __METHOD__);
+		if (isset($responseXmlObject->data)) {
+			return $responseXmlObject->data;
 		}
-		throw new Exception(
-			"No OCS data items found in responseXml"
-		);
+		Assert::fail("No OCS data items found in response");
 	}
 
 	/**
@@ -600,7 +597,7 @@ public function getOCSResponseData(ResponseInterface $response): SimpleXMLElemen
 	 * @return string
 	 */
 	public function getOCSResponseStatusMessage(ResponseInterface $response):string {
-		return (string) $this->featureContext->getResponseXml($response, __METHOD__)->meta[0]->message;
+		return (string) HttpRequestHelper::getResponseXml($response, __METHOD__)->meta[0]->message;
 	}
 
 	/**

tests/acceptance/bootstrap/Provisioning.php

@@ -1905,8 +1905,7 @@ function ($user) {
 	 * @throws Exception
 	 */
 	public function getArrayOfUsersResponded(ResponseInterface $resp):array {
-		$listCheckedElements
-			= $this->getResponseXml($resp, __METHOD__)->data[0]->users[0]->element;
+		$listCheckedElements = HttpRequestHelper::getResponseXml($resp, __METHOD__)->data[0]->users[0]->element;
 		return \json_decode(\json_encode($listCheckedElements), true);
 	}
 
@@ -1920,7 +1919,7 @@ public function getArrayOfUsersResponded(ResponseInterface $resp):array {
 	 */
 	public function getArrayOfGroupsResponded(ResponseInterface $resp):array {
 		$listCheckedElements
-			= $this->getResponseXml($resp, __METHOD__)->data[0]->groups[0]->element;
+			= HttpRequestHelper::getResponseXml($resp, __METHOD__)->data[0]->groups[0]->element;
 		return \json_decode(\json_encode($listCheckedElements), true);
 	}
 
@@ -1933,8 +1932,7 @@ public function getArrayOfGroupsResponded(ResponseInterface $resp):array {
 	 * @throws Exception
 	 */
 	public function getArrayOfAppsResponded(ResponseInterface $resp):array {
-		$listCheckedElements
-			= $this->getResponseXml($resp, __METHOD__)->data[0]->apps[0]->element;
+		$listCheckedElements = HttpRequestHelper::getResponseXml($resp, __METHOD__)->data[0]->apps[0]->element;
 		return \json_decode(\json_encode($listCheckedElements), true);
 	}
 
@@ -1945,7 +1943,7 @@ public function getArrayOfAppsResponded(ResponseInterface $resp):array {
 	 * @throws Exception
 	 */
 	public function theApiShouldNotReturnAnyData():void {
-		$responseData = $this->getResponseXml(null, __METHOD__)->data[0];
+		$responseData = HttpRequestHelper::getResponseXml($this->response, __METHOD__)->data[0];
 		Assert::assertEmpty(
 			$responseData,
 			"Response data is not empty but it should be empty"

tests/acceptance/bootstrap/ShareesContext.php

@@ -28,6 +28,7 @@
 use Psr\Http\Message\ResponseInterface;
 use PHPUnit\Framework\Assert;
 use TestHelpers\BehatHelper;
+use TestHelpers\HttpRequestHelper;
 
 require_once 'bootstrap.php';
 
@@ -155,7 +156,7 @@ public function getArrayOfShareesResponded(
 		ResponseInterface $response,
 		string $shareeType
 	):array {
-		$elements = $this->featureContext->getResponseXml($response, __METHOD__)->data;
+		$elements = HttpRequestHelper::getResponseXml($response, __METHOD__)->data;
 		$elements = \json_decode(\json_encode($elements), true);
 		if (\strpos($shareeType, 'exact ') === 0) {
 			$elements = $elements['exact'];