Merge pull request #1372 from keboola/vb-CT-1670-validate-column-name…

…s-endpoint CT-1670 - test validate column names endpoint
keboola · Jul 29, 2024 · 10adaea · 10adaea
2 parents d4b5f42 + 3793dd7
commit 10adaea
Show file tree

Hide file tree

Showing 4 changed files with 143 additions and 0 deletions.
diff --git a/apiary.apib b/apiary.apib
@@ -9007,6 +9007,41 @@ Webalize strings. Do not validate if you can use them in database column names.
             ]
         }
 
+# Group Validate
+
+### Validate column names [POST /v2/storage/validate/column-names]
+Validate strings if they can be used as column names. Column names can be used for example:
+- [creating a table](https://keboola.docs.apiary.io/#reference/tables/create-table-definition/create-new-table-definition)
+- [adding a column](https://keboola.docs.apiary.io/#reference/tables/create-table-column/add-column-to-table)
+
++ Attributes
+    + columnNames (required, array[string])
+
++ Request (application/json)
+
+    + Body
+
+            {
+                "columnNames": [
+                    "First$$Column-Name",
+                    "Second Column-Name"
+                ]
+            }
+
++ Response 204
+If all columns are valid
+
++ Response 422
+
+    + Body
+
+        {
+            [
+                ""First$$Column-Name" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.",
+                ""Second Column-Name" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed."
+            ]
+        }
+
 # Group Development Branches
 
 **EXPERIMENTAL**

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -5223,3 +5223,8 @@ parameters:
 			message: "#^Method Keboola\\\\StorageApi\\\\Client\\:\\:webalizeColumnNames\\(\\) has no return type specified\\.$#"
 			count: 1
 			path: src/Keboola/StorageApi/Client.php
+
+		-
+			message: "#^Method Keboola\\\\StorageApi\\\\Client\\:\\:validateColumnNames\\(\\) has no return type specified\\.$#"
+			count: 1
+			path: src/Keboola/StorageApi/Client.php
diff --git a/src/Keboola/StorageApi/Client.php b/src/Keboola/StorageApi/Client.php
@@ -290,6 +290,14 @@ public function webalizeColumnNames(array $columnNames)
         );
     }
 
+    public function validateColumnNames(array $columnNames)
+    {
+        return $this->apiPostJson(
+            'validate/column-names',
+            ['columnNames' => $columnNames],
+        );
+    }
+
     /**
      * Get UserAgent name
      *

diff --git a/tests/Common/IndexTest.php b/tests/Common/IndexTest.php
@@ -13,6 +13,7 @@
 use Keboola\StorageApi\ClientException;
 use Keboola\StorageApi\Options\IndexOptions;
 use Keboola\Test\StorageApiTestCase;
+use const PHP_EOL;
 
 class IndexTest extends StorageApiTestCase
 {
@@ -140,6 +141,100 @@ public function validColumnNameData(): Generator
         ];
     }
 
+    /**
+     * @dataProvider validColumnNameDataForValidation
+     */
+    public function testSuccessfullyValidateColumnNames(array $webalizedInput): void
+    {
+        $response = $this->_client->validateColumnNames($webalizedInput);
+        $this->assertEmpty($response, 'When empty, everything is validated.');
+    }
+
+    public function validColumnNameDataForValidation(): Generator
+    {
+        yield 'all' => [
+            [
+                'currency_EUR',
+                'eEsScCrRzZyYaAiIeE',
+                'lorem_EUR_EUR_dD_lL_ss_IPsum',
+                'muj_Bucket',
+                'account_EUR',
+                'some_name',
+                'MujBucketicek',
+                'loremIpsumDolorSitAmetWhateverNextLoremIpsumDolorSitAmetloremIps',
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidColumnNameDataForValidation
+     */
+    public function testInvalidColumnNames(array $columnNames, array $validationErrorMessages): void
+    {
+        try {
+            $this->_client->validateColumnNames($columnNames);
+            $this->fail('Invalid columns should fail');
+        } catch (ClientException $exception) {
+            $expectedMessages = [];
+            $expectedErrorMessages = [];
+            foreach ($validationErrorMessages as $key => $errorMessage) {
+                $keyName = sprintf('columnNames[%d]', $key);
+                $expectedMessages[] = sprintf(' - %s: "%s"', $keyName, $errorMessage);
+                $expectedErrorMessages[] = [
+                    'key' => $keyName,
+                    'message' => $errorMessage,
+                ];
+            }
+            $expectedMessage = 'Invalid request:' . PHP_EOL . implode(PHP_EOL, $expectedMessages);
+            $this->assertEquals($expectedMessage, $exception->getMessage());
+            $this->assertEquals($expectedErrorMessages, $exception->getContextParams()['errors']);
+        }
+    }
+
+    public function invalidColumnNameDataForValidation(): Generator
+    {
+        yield 'all' => [
+            [
+                'oid',
+                'tableoid',
+                'xmin',
+                'cmin',
+                'xmax',
+                'cmax',
+                'ctid',
+                'currency €',
+                'ěĚšŠčČřŘžŽýÝáÁíÍéÉ',
+                'lorem &@€\\#˝´˙`˛°˘^ˇ~€||\đĐ[]łŁ}{{@@&##<>*$ß¤×÷¸¨ IPsum',
+                'muj Bucket',
+                'account € & $',
+                '$$ some name $$',
+                '_MůjBucketíček',
+                'loremIpsumDolorSitAmetWhateverNextLoremIpsumDolorSitAmetloremIpsumDolorSitAmetWhateverNextLoremIpsumDolorSitAmet',
+                base64_decode('AQIDBAUGBwgODxAREhMUFRYXGBkaGxwdHh9/'),
+                '----$$$$-----',
+            ],
+            [
+                '"oid" is a system column used by the database for internal purposes.',
+                '"tableoid" is a system column used by the database for internal purposes.',
+                '"xmin" is a system column used by the database for internal purposes.',
+                '"cmin" is a system column used by the database for internal purposes.',
+                '"xmax" is a system column used by the database for internal purposes.',
+                '"cmax" is a system column used by the database for internal purposes.',
+                '"ctid" is a system column used by the database for internal purposes.',
+                '"currency €" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"ěĚšŠčČřŘžŽýÝáÁíÍéÉ" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"lorem &@€\#˝´˙`˛°˘^ˇ~€||\đĐ[]łŁ}{{@@&##<>*$ß¤×÷¸¨ IPsum" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"muj Bucket" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"account € & $" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"$$ some name $$" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"_MůjBucketíček" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                'Column name cannot be longer than 64 characters.',
+                '"'.base64_decode('AQIDBAUGBwgODxAREhMUFRYXGBkaGxwdHh9/').'" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+                '"----$$$$-----" contains not allowed characters. Only alphanumeric characters dash and underscores are allowed.',
+            ],
+        ];
+    }
+
     /**
      * @dataProvider invalidColumnNameData
      */