fix phpstan/phpcs, implement getTables action

keboola · Oct 30, 2023 · 5811506 · 5811506
1 parent f58a6d3
commit 5811506
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 184 deletions.
diff --git a/composer.json b/composer.json
@@ -35,9 +35,9 @@
     "tests": [
       "@tests-phpunit"
     ],
-    "phpcs": "phpcs -n --ignore=vendor --extensions=php .",
+    "phpcs": "phpcs -n --ignore=vendor,tests --extensions=php .",
     "phpcbf": "phpcbf -n --ignore=vendor --extensions=php .",
-    "phpstan": "phpstan analyse ./src ./tests --level=max --no-progress -c phpstan.neon",
+    "phpstan": "phpstan analyse ./src --level=max --no-progress -c phpstan.neon",
     "build": [
       "@phpstan",
       "@phpcs",
@@ -54,5 +54,10 @@
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer":  true
     }
+  },
+  "require-dev": {
+    "keboola/coding-standard": "^15.0",
+    "phpstan/phpstan": "^1.10",
+    "phpunit/phpunit": "^10.4"
   }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,2 @@
+parameters:
+    checkMissingIterableValueType: false
diff --git a/src/Application.php b/src/Application.php
@@ -74,7 +74,7 @@ public function getTablesInfoAction(): array
         $writerFactory = new WriterFactory($this->getConfig());
         $writer = $writerFactory->create($this->getLogger());
 
-        $tables = $writer->showTables(DatabaseConfig::fromArray($this->getConfig()->getParameters()['db']));
+        $tables = $writer->showTables();
 
         $tablesInfo = [];
         foreach ($tables as $tableName) {
@@ -131,17 +131,18 @@ private function getInputTablePath(string $tableId): string
         });
 
         if (count($filteredStorageInputMapping) === 0) {
-            throw new UserException(
-                sprintf('Table "%s" in storage input mapping cannot be found.', $tableId)
-            );
+            throw new UserException(sprintf(
+                'Table "%s" in storage input mapping cannot be found.',
+                $tableId,
+            ));
         }
 
         $tableFromInputMapping = current($filteredStorageInputMapping);
 
         return sprintf(
             '%s/in/tables/%s',
             $this->getDataDir(),
-            $tableFromInputMapping['destination']
+            $tableFromInputMapping['destination'],
         );
     }
 

diff --git a/src/Exception/InvalidDatabaseHostException.php b/src/Exception/InvalidDatabaseHostException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Keboola\DbWriter\Exception;
 
 use Exception;

diff --git a/src/Validator.php b/src/Validator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Keboola\DbWriter;
 
 use Keboola\CommonExceptions\UserExceptionInterface;
@@ -34,8 +36,8 @@ public function validateDatabaseHost(): void
                 sprintf(
                     'Hostname "%s" with port "%s" is not approved.',
                     $db['host'],
-                    $db['port']
-                )
+                    $db['port'],
+                ),
             );
         }
     }
@@ -48,10 +50,14 @@ public function validateTableItems(string $tablePath, array $items): array
         }
 
         $manifest = @json_decode((string) file_get_contents($manifestPath), true);
-        if (!$manifestPath) {
+        if (!is_array($manifest)) {
             throw new ApplicationException(sprintf('Manifest "%s" is not valid JSON.', $manifestPath));
         }
+        if (!isset($manifest['columns'])) {
+            throw new ApplicationException(sprintf('Manifest "%s" is missing "columns" key.', $manifestPath));
+        }
 
+        /** @var iterable $csvHeader */
         $csvHeader = $manifest['columns'];
         $reordered = [];
         foreach ($csvHeader as $csvCol) {
@@ -64,4 +70,4 @@ public function validateTableItems(string $tablePath, array $items): array
 
         return $reordered;
     }
-}
+}
diff --git a/src/Writer.php b/src/Writer.php
diff --git a/src/Writer/BaseWriter.php b/src/Writer/BaseWriter.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Keboola\DbWriter\Writer;
 
 use Keboola\DbWriter\Exception\SshException;
@@ -22,20 +24,16 @@ abstract class BaseWriter
      */
     public function __construct(
         DatabaseConfig $databaseConfig,
-        readonly protected LoggerInterface $logger
+        readonly protected LoggerInterface $logger,
     ) {
         $databaseConfig = $this->createSshTunnel($databaseConfig);
         $this->connection = $this->createConnection($databaseConfig);
         $this->adapter = $this->createWriteAdapter();
     }
 
-    abstract protected function createWriteAdapter(): WriteAdapter;
-
-    abstract public function getTableInfo(string $tableName): array;
-
     abstract protected function createConnection(DatabaseConfig $databaseConfig): Connection;
 
-    abstract protected static function getAllowedTypes(): array;
+    abstract protected function createWriteAdapter(): WriteAdapter;
 
     public function write(ExportConfig $exportConfig): void
     {
@@ -51,6 +49,16 @@ public function testConnection(): void
         $this->connection->testConnection();
     }
 
+    public function showTables(): array
+    {
+        return $this->adapter->showTables();
+    }
+
+    public function getTableInfo(string $tableName): array
+    {
+        return $this->adapter->getTableInfo($tableName);
+    }
+
     protected function writeIncremental(ExportConfig $exportConfig): void
     {
         // write to staging table
@@ -75,7 +83,6 @@ protected function writeFull(ExportConfig $exportConfig): void
         $this->adapter->drop($exportConfig->getDbName());
         $this->adapter->create($exportConfig->getDbName(), false, $exportConfig->getItems());
         $this->adapter->writeData($exportConfig->getDbName(), $exportConfig->getTableFilePath());
-        var_dump($this->adapter->tableExists($exportConfig->getDbName()));
     }
 
     /**
@@ -87,5 +94,4 @@ protected function createSshTunnel(DatabaseConfig $databaseConfig): DatabaseConf
         $sshTunnel = new SshTunnel($this->logger);
         return $sshTunnel->createSshTunnel($databaseConfig);
     }
-
-}
+}
diff --git a/src/Writer/Common.php b/src/Writer/Common.php
@@ -16,12 +16,8 @@
 
 class Common extends BaseWriter
 {
-    protected const ALLOWED_TYPES = [
-        'int', 'smallint', 'bigint',
-        'decimal', 'float', 'double',
-        'date', 'datetime', 'timestamp',
-        'char', 'varchar', 'text', 'blob',
-    ];
+    /** @var PdoConnection $connection */
+    protected Connection $connection;
 
     /**
      * @throws UserException|PropertyNotSetException
@@ -33,7 +29,7 @@ public function createConnection(DatabaseConfig $databaseConfig): Connection
             'mysql:host=%s;port=%s;dbname=%s;charset=utf8',
             $databaseConfig->getHost(),
             $port,
-            $databaseConfig->getDatabase()
+            $databaseConfig->getDatabase(),
         );
 
         return new PdoConnection(
@@ -45,7 +41,7 @@ public function createConnection(DatabaseConfig $databaseConfig): Connection
                 PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
                 PDO::MYSQL_ATTR_LOCAL_INFILE => true,
             ],
-            function (PDO $connection) use ($databaseConfig): void {
+            function (PDO $connection): void {
                 $connection->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);
                 $connection->exec('SET NAMES utf8;');
             },
@@ -59,14 +55,4 @@ protected function createWriteAdapter(): WriteAdapter
             new DefaultQueryBuilder(),
         );
     }
-
-    protected static function getAllowedTypes(): array
-    {
-        return self::ALLOWED_TYPES;
-    }
-
-    public function getTableInfo(string $tableName): array
-    {
-        // TODO: Implement getTableInfo() method.
-    }
 }