feat: fetch data from response using jq

Signed-off-by: Vitor Mattos <[email protected]>

Author: vitormattos

README.md

@@ -118,6 +118,16 @@ The alias `price` could be used in a path or body of a request:
     | field | <data.0.foo> |
 ```
 
+#### Fetch field using jq
+
+You can assign the return of a jq to your field using a jq like as the follow pattern:
+
+```gherkin
+And fetch field "(foo)(jq).value" from prevous JSON response
+```
+
+This will retrieve a specific value from json response and assign this to your desided field.
+
 ## Parse response using jq
 
 You can use [jq](https://jqlang.github.io/jq/manual/) expression casting to check a value in a json response body of a request. To do this you will need to install the jq command.

features/test.feature

@@ -86,6 +86,26 @@ Feature: Test this extension
       | key  | value             |
       | data | [{"foo":"<FIELD_FOO>"}] |
 
+  Scenario: Test get field from json response using jq
+    When set the response to:
+      """
+      {
+        "data": [
+          {
+            "foo":"bar"
+          }
+        ]
+      }
+      """
+    And sending "POST" to "/"
+    And fetch field "(FIELD_FOO)(jq).data[0].foo" from prevous JSON response
+    # After fetch the field, you can use the value of field like this:
+    And sending "POST" to "/?foo=<FIELD_FOO>"
+      | field | <data.0.foo> |
+    Then the response should be a JSON array with the following mandatory values
+      | key  | value             |
+      | data | [{"foo":"<FIELD_FOO>"}] |
+
   Scenario: Test initial state with string
     When set the response to:
       """

src/NextcloudApiContext.php

@@ -340,16 +340,25 @@ private function validateAsJsonQuery(string $expected, string $actual): void {
 	 */
 	public function fetchFieldFromPreviousJsonResponse(string $path): void {
 		$this->response->getBody()->seek(0);
-		$responseArray = json_decode($this->response->getBody()->getContents(), true);
-		if (preg_match('/(?<alias>\([^)]*\))(?<patch>.*)/', $path, $matches)) {
+		$body = $this->response->getBody()->getContents();
+
+		// Is json query
+		if (preg_match('/(?<alias>\([^)]*\))\(jq\)(?<path>.*)/', $path, $matches)) {
+			$this->fields[$matches['alias']] = $this->testAndGetActualValue(
+				['key' => '(jq)' . $matches['path']],
+				$body
+			);
+			return;
+		}
+
+		// Is array with alias
+		if (preg_match('/(?<alias>\([^)]*\)){1,}(?<path>.*)/', $path, $matches)) {
 			$alias = $matches['alias'];
-			$path = $matches['patch'];
+			$path = $matches['path'];
 		}
 		$keys = explode('.', $path);
-		$value = $responseArray;
+		$value = json_decode($body, true);
 		foreach ($keys as $key) {
-			$body = json_encode($responseArray);
-			Assert::assertIsString($body);
 			Assert::assertArrayHasKey($key, $value, 'Key [' . $key . '] of path [' . $path . '] not found at body: ' . $body);
 			$value = $value[$key];
 		}