feat: add more steps to works with commands

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

Author: vitormattos

README.md

@@ -62,8 +62,11 @@ When the response should contain the initial state :name with the following valu
 When the response should contain the initial state :name json that match with:
 When the following :appId app config is set
 When /^run the command "(?P<command>(?:[^"]|\\")*)"$/
+When the output of the last command should contain the following text:
+When the output of the last command should be empty
 When /^run the command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/
 When /^run the bash command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/
+When create an environment :name with value :value to be used by occ command
 ```
 
 ## Tips
@@ -89,7 +92,7 @@ When sending "post" to ocs "/apps/libresign/api/v1/request-signature"
 
 ### Step: all steps that run commands
 
-Before the command be executd, will replace the follow placeholders:
+Before the command is executed, the following placeholders will be replaced:
 
 | Placeholder          | Value                  |
 | -------------------- | ---------------------- |

features/test.feature

@@ -210,18 +210,35 @@ Feature: Test this extension
 
   Scenario: Test list app directory with success
     When run the bash command "ls <appRootDir>" with result code 0
+    Then the output of the last command should contain the following text:
+      """
+      appinfo
+      """
 
   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
+    Then the output of the last command should be empty
 
   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
+    Then the output of the last command should contain the following text:
+      """
+      version:
+      """
 
   Scenario: Run occ command with success
     When run the command "invalid-command" with result code 1
+
+  Scenario: Create an environment with value to be used by occ command
+    When create an environment "OC_PASS" with value "" to be used by occ command
+    And run the command "user:add --password-from-env test" with result code 1
+    Then the output of the last command should contain the following text:
+      """
+      --password-from-env given, but NC_PASS/OC_PASS is empty!
+      """

src/NextcloudApiContext.php

@@ -26,10 +26,13 @@ class NextcloudApiContext implements Context {
 	protected RunServerListener $server;
 	protected string $currentUser = '';
 	protected array $fields = [];
+	protected static array $environments = [];
+	protected static string $commandOutput = '';
+
 	/**
 	 * @var string[]
 	 */
-	protected array $createdUsers = [];
+	protected static array $createdUsers = [];
 	protected ResponseInterface $response;
 	/** @var CookieJar[] */
 	protected $cookieJars;
@@ -61,13 +64,15 @@ public static function beforeSuite(BeforeSuiteScope $scope):void {
 				"runuser -u %s -- %s\n\n",
 				get_current_user(), $whoami, get_current_user(), $command));
 		}
+		self::runCommand('config:system:set debug --value true --type boolean');
 	}
 
 	/**
 	 * @BeforeScenario
 	 */
-	public function setUp(): void {
-		$this->createdUsers = [];
+	public function beforeScenario(): void {
+		self::$createdUsers = [];
+		self::$environments = [];
 	}
 
 	/**
@@ -116,7 +121,7 @@ protected function createUser(string $user): void {
 		$this->sendOCSRequest('GET', '/cloud/users' . '/' . $user);
 		$this->assertStatusCode($this->response, 200, 'Failed to do first login');
 
-		$this->createdUsers[] = $user;
+		self::$createdUsers[] = $user;
 
 		$this->setCurrentUser($currentUser);
 	}
@@ -477,6 +482,9 @@ public static function runCommand(string $command): array {
 			throw new \Exception('Could not retrieve owner information for UID ' . $fileOwnerUid);
 		}
 		$fullCommand = 'php ' . $console . ' ' . $command;
+		if (!empty(self::$environments)) {
+			$fullCommand = http_build_query(self::$environments, '', ' ') . ' ' . $fullCommand;
+		}
 		if (posix_getuid() !== $owner['uid']) {
 			$fullCommand = 'runuser -u ' . $owner['name'] . ' -- ' . $fullCommand;
 		}
@@ -518,13 +526,28 @@ private static function runBashCommand(string $command): array {
 		}
 
 		exec($command, $output, $resultCode);
+		self::$commandOutput = implode("\n", $output);
 		return [
 			'command' => $command,
 			'output' => $output,
 			'resultCode' => $resultCode,
 		];
 	}
 
+	/**
+	 * @When the output of the last command should contain the following text:
+	 */
+	public static function theOutputOfTheLastCommandContains(PyStringNode $text): void {
+		Assert::assertStringContainsString((string) $text, self::$commandOutput, 'The output of the last command does not contain: ' . $text);
+	}
+
+	/**
+	 * @When the output of the last command should be empty
+	 */
+	public static function theOutputOfTheLastCommandShouldBeEmpty(): void {
+		Assert::assertEmpty(self::$commandOutput, 'The output of the last command should be empty, but got: ' . self::$commandOutput);
+	}
+
 	/**
 	 * @When /^run the command "(?P<command>(?:[^"]|\\")*)" with result code (\d+)$/
 	 */
@@ -541,11 +564,19 @@ public static function runBashCommandWithResultCode(string $command, int $result
 		Assert::assertEquals($resultCode, $return['resultCode'], print_r($return, true));
 	}
 
+	/**
+	 * @When create an environment :name with value :value to be used by occ command
+	 */
+	public static function createAnEnvironmentWithValueToBeUsedByOccCommand(string $name, string $value):void {
+		self::$environments[$name] = $value;
+	}
+
 	/**
 	 * @AfterScenario
 	 */
 	public function tearDown(): void {
-		foreach ($this->createdUsers as $user) {
+		self::$environments = [];
+		foreach (self::$createdUsers as $user) {
 			$this->deleteUser($user);
 		}
 	}
@@ -556,7 +587,7 @@ protected function deleteUser(string $user): ResponseInterface {
 		$this->sendOCSRequest('DELETE', '/cloud/users/' . $user);
 		$this->setCurrentUser($currentUser);
 
-		unset($this->createdUsers[array_search($user, $this->createdUsers, true)]);
+		unset(self::$createdUsers[array_search($user, self::$createdUsers, true)]);
 
 		return $this->response;
 	}