feat: run command

These steps make possible run occ and bash commands as steps.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>

Author: vitormattos

README.md

@@ -51,6 +51,7 @@ vendor/bin/behat -dl
 Given as user :user
 Given user :user exists
 Given sending :verb to :url
+Given set the response to:
 Given the response should be a JSON array with the following mandatory values
 Given /^set the display name of user "([^"]*)" to "([^"]*)"$/
 Given /^set the email of user "([^"]*)" to "([^"]*)"$/
@@ -60,6 +61,9 @@ Given fetch field :path from previous JSON response
 Given the response should contain the initial state :name with the following values:
 Given the response should contain the initial state :name json that match with:
 Given the following :appId app config is set
+Given /^run the command "(?P<command>(?:[^"]|\\")*)"$/
+Given /^run the command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/
+Given /^run the bash command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/
 ```
 
 ## Tips
@@ -83,6 +87,15 @@ Given sending "post" to ocs "/apps/libresign/api/v1/request-signature"
   | file   | {"base64":""} |
 ```
 
+### Step: all steps that run commands
+
+Before the command be executd, will replace the follow placeholders:
+
+| Placeholder          | Value                  |
+| -------------------- | ---------------------- |
+| `<appRootDir>`       | your app root dir      |
+| `<nextcloudRootDir>` | The Nextcloud root dir |
+
 ### Step: `fetch field :path from previous JSON response`
 
 If the json response is an array, you can fetch specific values using this step. The fetched values is stored to be used by other steps.

features/test.feature

@@ -227,3 +227,21 @@ Feature: Test this extension
     Then the response should contain the initial state "appid-json-array" json that match with:
       | key      | value  |
       | (jq).[0] | orange |
+
+  Scenario: Test list app directory with success
+    When run the bash command "ls <appRootDir>" with result code 0
+
+  Scenario: Test list Nextcloud directory with success
+    When run the bash command "ls <nextcloudRootDir>" with result code 0
+
+  Scenario: Test run bash command with success
+    When run the bash command "true" with result code 0
+
+  Scenario: Test run bash command with error
+    When run the bash command "false" with result code 1
+
+  Scenario: Run occ command with success
+    When run the command "status" with result code 0
+
+  Scenario: Run occ command with success
+    When run the command "invalid-command" with result code 1

src/NextcloudApiContext.php

@@ -448,6 +448,79 @@ protected function parseText(string $text): string {
 		return $text;
 	}
 
+	#[Given('/^run the command "(?P<command>(?:[^"]|\\")*)"$/')]
+	public static function runCommand(string $command): array {
+		$console = self::findParentDirContainingFile('console.php');
+		$console .= '/console.php';
+		$fileOwnerUid = fileowner($console);
+		if (!is_int($fileOwnerUid)) {
+			throw new \Exception('The console file owner of ' . $console . ' is not an integer UID.');
+		}
+		$owner = posix_getpwuid($fileOwnerUid);
+		if ($owner === false) {
+			throw new \Exception('Could not retrieve owner information for UID ' . $fileOwnerUid);
+		}
+		$fullCommand = 'php ' . $console . ' ' . $command;
+		if (posix_getuid() !== $owner['uid']) {
+			$fullCommand = 'runuser -u ' . $owner['name'] . ' -- ' . $fullCommand;
+		}
+		$fullCommand .= '  2>&1';
+		return self::runBashCommand($fullCommand);
+	}
+
+	public static function findParentDirContainingFile(string $filename): string {
+		$dir = getcwd();
+		if (is_bool($dir)) {
+			throw new \Exception('Could not get current working directory (getcwd() returned false)');
+		}
+
+		while ($dir !== dirname($dir)) {
+			if (file_exists($dir . DIRECTORY_SEPARATOR . $filename)) {
+				return $dir;
+			}
+			$dir = dirname($dir);
+		}
+
+		throw new \Exception('The file ' . $filename . ' was not found in the parent directories of ' . $dir);
+	}
+
+	private static function runBashCommand(string $command): array {
+		$command = str_replace('\"', '"', $command);
+		$patterns = [];
+		$replacements = [];
+		$fields = [
+			'appRootDir' => self::findParentDirContainingFile('appinfo'),
+			'nextcloudRootDir' => self::findParentDirContainingFile('console.php'),
+		];
+		foreach ($fields as $key => $value) {
+			$patterns[] = '/<' . $key . '>/';
+			$replacements[] = $value;
+		}
+		$command = preg_replace($patterns, $replacements, $command);
+		if (!is_string($command)) {
+			throw new \Exception('The command is not a string after preg_replace: ' . print_r($command, true));
+		}
+
+		exec($command, $output, $resultCode);
+		return [
+			'command' => $command,
+			'output' => $output,
+			'resultCode' => $resultCode,
+		];
+	}
+
+	#[Given('/^run the command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/')]
+	public static function runCommandWithResultCode(string $command, int $resultCode = 0): void {
+		$return = self::runCommand($command);
+		Assert::assertEquals($resultCode, $return['resultCode'], print_r($return, true));
+	}
+
+	#[Given('/^run the bash command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/')]
+	public static function runBashCommandWithResultCode(string $command, int $resultCode = 0): void {
+		$return = self::runBashCommand($command);
+		Assert::assertEquals($resultCode, $return['resultCode'], print_r($return, true));
+	}
+
 	#[AfterScenario()]
 	public function tearDown(): void {
 		foreach ($this->createdUsers as $user) {