Merge pull request #8292 from kenjis/feat-spark-db-table-dbgroup

feat: add `--dbgroup` option to `spark db:table`

Author: kenjis

system/Commands/Database/ShowTableInfo.php

@@ -17,6 +17,7 @@
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\Database\BaseConnection;
 use Config\Database;
+use InvalidArgumentException;
 
 /**
  * Get table data if it exists in the database.
@@ -83,14 +84,15 @@ class ShowTableInfo extends BaseCommand
         '--desc'              => 'Sorts the table rows in DESC order.',
         '--limit-rows'        => 'Limits the number of rows. Default: 10.',
         '--limit-field-value' => 'Limits the length of field values. Default: 15.',
+        '--dbgroup'           => 'Database group to show.',
     ];
 
     /**
      * @var list<list<int|string>> Table Data.
      */
     private array $tbody;
 
-    private BaseConnection $db;
+    private ?BaseConnection $db = null;
 
     /**
      * @var bool Sort the table rows in DESC order or not.
@@ -101,7 +103,16 @@ class ShowTableInfo extends BaseCommand
 
     public function run(array $params)
     {
-        $this->db       = Database::connect();
+        $dbGroup = $params['dbgroup'] ?? CLI::getOption('dbgroup');
+
+        try {
+            $this->db = Database::connect($dbGroup);
+        } catch (InvalidArgumentException $e) {
+            CLI::error($e->getMessage());
+
+            return EXIT_ERROR;
+        }
+
         $this->DBPrefix = $this->db->getPrefix();
 
         $this->showDBConfig();
@@ -116,13 +127,13 @@ public function run(array $params)
             CLI::error('Database has no tables!', 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         if (array_key_exists('show', $params)) {
             $this->showAllTables($tables);
 
-            return;
+            return EXIT_ERROR;
         }
 
         $tableName       = $params[0] ?? null;
@@ -143,10 +154,12 @@ public function run(array $params)
         if (array_key_exists('metadata', $params)) {
             $this->showFieldMetaData($tableName);
 
-            return;
+            return EXIT_SUCCESS;
         }
 
         $this->showDataOfTable($tableName, $limitRows, $limitFieldValue);
+
+        return EXIT_SUCCESS;
     }
 
     private function showDBConfig(): void

system/Database/Config.php

@@ -69,7 +69,7 @@ public static function connect($group = null, bool $getShared = true)
             assert(is_string($group));
 
             if (! isset($dbConfig->{$group})) {
-                throw new InvalidArgumentException($group . ' is not a valid database connection group.');
+                throw new InvalidArgumentException('"' . $group . '" is not a valid database connection group.');
             }
 
             $config = $dbConfig->{$group};

tests/system/Commands/Database/ShowTableInfoTest.php

@@ -66,6 +66,16 @@ public function testDbTable(): void
         $this->assertMatchesRegularExpression($expectedPattern, $result);
     }
 
+    public function testDbTableShowsWithInvalidDBGroup(): void
+    {
+        command('db:table --show --dbgroup invalid');
+
+        $result = $this->getNormalizedResult();
+
+        $expected = '"invalid" is not a valid database connection group.';
+        $this->assertStringContainsString($expected, $result);
+    }
+
     public function testDbTableShowsDBConfig(): void
     {
         command('db:table --show');

tests/system/Validation/StrictRules/DatabaseRelatedRulesTest.php

@@ -88,7 +88,7 @@ public function testIsUniqueTrue(): void
     public function testIsUniqueWithInvalidDBGroup(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('invalidGroup is not a valid database connection group');
+        $this->expectExceptionMessage('"invalidGroup" is not a valid database connection group');
 
         $this->validation->setRules(['email' => 'is_unique[user.email]']);
         $data = ['email' => '[email protected]'];