File name validation (#19)

Author: Shpota

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "podil",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Lightweight and secure database migration tool",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package.json

@@ -18,6 +18,13 @@ export class Podil {
       const appliedScripts: Script[] = await migration.fetchAppliedMigrations()
       const migrationsAbsolutePath = path.resolve(migrationsDir)
       const files = fs.readdirSync(migrationsAbsolutePath)
+      for (const file of files) {
+        if (!file.toLowerCase().endsWith('.sql')) {
+          throw new Error(
+            `File '${file}' cannot be executed. Make sure the directory with migrations contains only '.sql' files.`
+          )
+        }
+      }
       const fsScripts = files.sort((a, b) => a.localeCompare(b))
       if (fsScripts.length < appliedScripts.length) {
         throw new Error(`Migrations mismatch: the database has ${appliedScripts.length}` +

src/Podil.ts

@@ -199,4 +199,18 @@ describe('Podil', async () => {
     const nameFromDb = result.rows[0].test
     assert.strictEqual(nameFromDb, 'value from the second script')
   })
+
+  it('should fail to apply migration given wrong script extension', async () => {
+    try {
+      // given, when
+      await podil.migrate(connectionString, { migrationsDir: './test/PodilTest/wrong_extensions' })
+      assert.fail('migration is expected to fail because the second script has wrong extension')
+    } catch (e) {
+      // then
+      assert.strictEqual(
+        (e as Error).toString(),
+        'Error: File \'002__wrong_extension.xls\' cannot be executed. Make sure the directory with migrations contains only \'.sql\' files.'
+      )
+    }
+  })
 })

test/PodilTest.ts

@@ -0,0 +1 @@
+CREATE TABLE test_table (name VARCHAR(255) PRIMARY KEY);

test/PodilTest/wrong_extensions/001__valid_script.sql

@@ -0,0 +1 @@
+wrong extension