Issue #113: open dbeaver app up and focus on it

Author: gthomas2

src/Command/Behat.php

@@ -4,7 +4,7 @@
 
 use App\Exceptions\ExecFailed;
 use App\Service\Docker;
-use App\Service\Main;
+use App\Service\Moodle;
 use App\Service\Plugins;
 use App\StaticVars;
 use App\Traits\ExecTrait;
@@ -20,6 +20,7 @@ final class Behat extends AbstractCommand {
     // Service dependencies.
     protected Plugins $pluginsService;
     protected Docker $dockerService;
+    protected Moodle $moodleService;
 
     // Constants.
     const COMMAND_NAME = 'behat';
@@ -113,7 +114,8 @@ public function execute(Options $options): void {
 
         $this->cli->notice('Initializing behat');
         $moodleContainer = $this->mainService->getDockerMoodleContainerName($instanceName);
-        $cmd = 'docker exec -it '.$moodleContainer.' php /var/www/html/moodle/admin/tool/behat/cli/init.php --axe';
+        $publicFolder = $this->moodleService->shouldUsePublicFolder($recipe) ? 'public' . DIRECTORY_SEPARATOR: '';
+        $cmd = 'docker exec -it '.$moodleContainer.' php /var/www/html/moodle/'.$publicFolder.'admin/tool/behat/cli/init.php --axe';
         $this->execStream($cmd, 'Failed to initialize behat');
         // !NOTE AWFUL, AWFUL BUG FIX!
         // Have to do it twice because execStream only returns last line which can end up being performance information as opposed

src/Command/Database.php

@@ -6,6 +6,7 @@
 use App\Database\Mysql;
 use App\Database\Postgres;
 use App\Database\Mariadb;
+use App\Helpers\OS;
 use App\Model\Recipe;
 use App\Model\RegistryInstance;
 use App\StaticVars;
@@ -50,7 +51,7 @@ function() {
 
     private function openDatabaseClient(?string $client): void {
         $cmd = match ($client) {
-            'dbeaver' => $this->database->dbeaverConnectionString(),
+            'dbeaver' => $this->database->dbeaverConnectCommand(),
             'pgadmin' => $this->getPgAdminCommand(),
             'mysql workbench' => $this->getMysqlWorkbenchCommand(),
             'psql (cli)', 'psql' => $this->getPsqlCommand(),
@@ -59,7 +60,17 @@ private function openDatabaseClient(?string $client): void {
         };
 
         if (is_string($cmd)) {
-            $this->exec($cmd);
+            // GUI applications need detached execution for proper focus
+            if (in_array($client, ['dbeaver', 'pgadmin', 'mysql workbench'])) {
+                $this->execDetached($cmd);
+
+                if (OS::isMac() && $client === 'dbeaver') {
+                    $applescript = 'tell application "DBeaver" to activate';
+                    $this->execDetached('sleep 1 && osascript -e ' . escapeshellarg($applescript));
+                }
+            } else {
+                $this->exec($cmd);
+            }
         } else if (is_array($cmd)) {
             $this->execInteractive($cmd[0], $cmd[1]);
         }

src/Command/PHPUnit.php

@@ -3,6 +3,7 @@
 namespace App\Command;
 
 use App\Service\Main;
+use App\Service\Moodle;
 use App\Service\Plugins;
 use App\StaticVars;
 use App\Traits\ExecTrait;
@@ -15,6 +16,9 @@ final class PHPUnit extends AbstractCommand {
     use SingletonTrait;
     use ExecTrait;
 
+    // Service dependencies.
+    protected Moodle $moodleService;
+
     const COMMAND_NAME = 'phpunit';
 
     public static function instance(): PHPUnit {
@@ -37,7 +41,8 @@ public function execute(Options $options): void {
 
         $this->cli->notice('Initializing PHPUnit');
 
-        $cmd = 'docker exec -it '.$moodleContainer.' php /var/www/html/moodle/admin/tool/phpunit/cli/init.php';
+        $publicFolder = $this->moodleService->shouldUsePublicFolder($recipe) ? 'public' . DIRECTORY_SEPARATOR: '';
+        $cmd = 'docker exec -it '.$moodleContainer.' php /var/www/html/moodle/'.$publicFolder.'admin/tool/phpunit/cli/init.php';
         $this->execStream($cmd, 'Failed to initialize phpunit');
         $runCode = 'bash -c "cd /var/www/html/moodle && vendor/bin/phpunit';
 

src/Database/AbstractDatabase.php

@@ -6,8 +6,11 @@
 use App\MChefCLI;
 use App\Model\Recipe;
 use App\Helpers\OS;
+use App\Traits\ExecTrait;
 
 abstract class AbstractDatabase implements DatabaseInterface {
+    use ExecTrait;
+
     public function __construct(protected Recipe $recipe, protected MChefCLI $cli) {
     }
 
@@ -19,10 +22,35 @@ public function dropAllTables(): void {
         throw new NotImplementedException(__METHOD__);
     }
 
-    public function dbeaverConnectionString(): string {
+    protected function dbeaverConnectBaseCommand(): string {
         throw new NotImplementedException(__METHOD__);
     }
 
+    public function dbeaverConnectCommand(): string {
+        if (empty($this->recipe->dbHostPort)) {
+            throw new \Error('The recipe must have dbHostPort specified in order to generate a connection string');
+        }
+
+        $baseConnStr = $this->dbeaverConnectBaseCommand();
+
+        // Execute command to create connection first.
+        // NOTE - this didn't work with just one command, hence - to create you need open -na and to open you need open -a.
+        if (OS::isWindows()) {
+            $dbeaverBaseCmd = 'start dbeaverc.exe';
+           
+        } else if (OS::isMac()) {
+            $dbeaverBaseCmd = 'open -na "DBeaver" --args';
+        } else if (OS::isLinux()) {
+            $dbeaverBaseCmd = 'xdg-open dbeaverc';
+        } else {
+            throw new \RuntimeException('Unsupported OS for DBeaver connection');
+        }
+
+        $cmd = $dbeaverBaseCmd . ' -con ' . escapeshellarg($baseConnStr . '|connect=true|name=' . $this->getDbName());
+
+        return $cmd;
+    }
+
     public function buildDBQueryDockerCommand(string $query, bool $isCheck = false): string {
         throw new NotImplementedException(__METHOD__);
     }

src/Database/DatabaseInterface.php

@@ -14,7 +14,7 @@ public function dropAllTables(): void;
      * Return a dbeaver connection string.
      * @return string
      */
-    public function dbeaverConnectionString(): string;
+    public function dbeaverConnectCommand(): string;
 
     /**
      * Build a docker command (docker exec ...) to run a database query.

src/Database/Mysql.php

@@ -45,22 +45,14 @@ public function dropAllTables(): void {
         }
     }
 
-    public function dbeaverConnectionString(): string {
-        if (empty($this->recipe->dbHostPort)) {
-            throw new \Error('The recipe must have dbHostPort specified in order to generate a connection string');
-        }
-        $dbeavercmd = OS::isWindows() ? 'dbeaver.exe' : 'open -na "DBeaver" --args';
-        $conString = sprintf(
+    protected function dbeaverConnectBaseCommand(): string {
+        return sprintf(
             'driver=mysql|host=localhost|port=%s|database=%s|user=%s|password=%s',
             $this->recipe->dbHostPort,
             $this->getDbName(),
             $this->recipe->dbUser,
             $this->recipe->dbPassword
         );
-
-        // Escape the *whole thing once*
-        $cmd = $dbeavercmd . ' -con ' . escapeshellarg($conString);
-        return $cmd;
     }
 
     /**

src/Database/Postgres.php

@@ -8,6 +8,7 @@
 use App\Service\Main;
 
 class Postgres extends AbstractDatabase implements DatabaseInterface {
+
     public function dropAllTables(): void {
         $mainService   = Main::instance($this->cli);
         $dbContainer   = $mainService->getDockerDatabaseContainerName();
@@ -57,22 +58,14 @@ public function dropAllTables(): void {
         }
     }
 
-    public function dbeaverConnectionString(): string {
-        if (empty($this->recipe->dbHostPort)) {
-            throw new \Error('The recipe must have dbHostPort specified in order to generate a connection string');
-        }
-        $dbeavercmd = OS::isWindows() ? 'dbeaver.exe' : 'open -na "DBeaver" --args';
-        $conString = sprintf(
+    protected function dbeaverConnectBaseCommand(): string {
+        return sprintf(
             'driver=postgresql|host=localhost|port=%s|database=%s|user=%s|password=%s',
             $this->recipe->dbHostPort,
             $this->getDbName(),
             $this->recipe->dbUser,
             $this->recipe->dbPassword
         );
-
-        // Escape the *whole thing once*
-        $cmd = $dbeavercmd . ' -con ' . escapeshellarg($conString);
-        return $cmd;
     }
 
     /**

src/Tests/DatabaseConnectionStringsTest.php

@@ -24,7 +24,7 @@ public function testMysqlConnectionStringMethods(): void {
         $mysql = new Mysql($recipe, StaticVars::$cli);
 
         // Test DBeaver connection string
-        $dbeaverCmd = $mysql->dbeaverConnectionString();
+        $dbeaverCmd = $mysql->dbeaverConnectCommand();
         $this->assertStringContainsString('driver=mysql', $dbeaverCmd);
         $this->assertStringContainsString('port=3306', $dbeaverCmd);
         $this->assertStringContainsString('testuser', $dbeaverCmd);
@@ -78,7 +78,7 @@ public function testPostgresConnectionStringMethods(): void {
         $postgres = new Postgres($recipe, StaticVars::$cli);
 
         // Test DBeaver connection string
-        $dbeaverCmd = $postgres->dbeaverConnectionString();
+        $dbeaverCmd = $postgres->dbeaverConnectCommand();
         $this->assertStringContainsString('driver=postgresql', $dbeaverCmd);
         $this->assertStringContainsString('port=5432', $dbeaverCmd);
         $this->assertStringContainsString('testuser', $dbeaverCmd);
@@ -135,6 +135,6 @@ public function testMissingDbHostPortThrowsError(): void {
 
         $this->expectException(\Error::class);
         $this->expectExceptionMessage('The recipe must have dbHostPort specified');
-        $mysql->dbeaverConnectionString();
+        $mysql->dbeaverConnectCommand();
     }
 }

src/Traits/ExecTrait.php

@@ -58,6 +58,15 @@ protected function execStream(string $cmd, ?string $errorMsg = null): string {
         return $output;
     }
 
+    protected function execDetached(string $cmd): void {
+        if ($this->verbose && !empty($this->cli)) {
+            $this->cli->info($cmd);
+        }
+        // Execute command in background to detach from PHP process
+        // This allows GUI applications to get proper focus
+        exec($cmd . ' &');
+    }
+
     protected function execPassthru(string $cmd, ?string $errorMsg = null): void {
         if ($this->verbose && !empty($this->cli)) {
             $this->cli->info($cmd);