fix: Respect the knexfile stub option while generating a migration (#…

…3337)

bin/cli.js

@@ -154,9 +154,15 @@ function invoke(env) {
       opts.client = opts.client || 'sqlite3'; // We don't really care about client when creating migrations
       const instance = initKnex(env, opts);
       const ext = getMigrationExtension(env, opts);
+      const configOverrides = { extension: ext };
+
       const stub = getStubPath(env, opts);
+      if (stub) {
+        configOverrides.stub = stub;
+      }
+
       pending = instance.migrate
-        .make(name, { extension: ext, stub })
+        .make(name, configOverrides)
         .then((name) => {
           success(color.green(`Created Migration: ${name}`));
         })

test/cli/cli-test-utils.js

@@ -2,6 +2,7 @@
 
 const path = require('path');
 const { FileTestHelper } = require('cli-testlab');
+const { expect } = require('chai');
 
 function migrationStubOptionSetup(fileHelper) {
   const migrationGlobPath = 'test/jake-util/knexfile_migrations/*_somename.js';
@@ -28,15 +29,15 @@ function migrationStubOptionSetup(fileHelper) {
   return { migrationGlobPath };
 }
 
-function migrationMatchesStub(stubPath, migrationGlobPath, fileHelper) {
+function expectMigrationMatchesStub(stubPath, migrationGlobPath, fileHelper) {
   // accepts full or relative stub path
   const relativeStubPath = stubPath.replace('test/jake-util/', '');
   const stubContent = fileHelper.getFileTextContent(relativeStubPath);
   const [migrationContent] = fileHelper.getFileGlobTextContent(
     migrationGlobPath
   );
 
-  return stubContent === migrationContent;
+  expect(migrationContent).equals(stubContent);
 }
 
 function setupFileHelper() {
@@ -50,7 +51,7 @@ function setupFileHelper() {
 }
 
 module.exports = {
+  expectMigrationMatchesStub,
   migrationStubOptionSetup,
-  migrationMatchesStub,
   setupFileHelper,
 };

test/cli/migrate-make.spec.js

@@ -2,12 +2,12 @@
 
 const path = require('path');
 const { execCommand } = require('cli-testlab');
-const expect = require('chai').expect;
+const { expect } = require('chai');
 
 const KNEX = path.normalize(__dirname + '/../../bin/cli.js');
 const {
   migrationStubOptionSetup,
-  migrationMatchesStub,
+  expectMigrationMatchesStub,
   setupFileHelper,
 } = require('./cli-test-utils');
 
@@ -252,9 +252,28 @@ development: {
         'test/jake-util/knexfile_migrations/*_somename.js'
       );
       expect(fileCount).to.equal(1);
-      expect(
-        migrationMatchesStub(stubPath, migrationGlobPath, fileHelper)
-      ).equal(true);
+      expectMigrationMatchesStub(stubPath, migrationGlobPath, fileHelper);
+    });
+
+    it('Create a new migration with stub parameter in knexfile', async () => {
+      const migrationGlobPath = 'test/jake-util/knexfile-stubs/*_somename.js';
+      fileHelper.registerGlobForCleanup(migrationGlobPath);
+
+      await execCommand(
+        `node ${KNEX} migrate:make somename --knexfile=test/jake-util/knexfile-stubs/knexfile.js --knexpath=../knex.js`,
+        {
+          expectedOutput: 'Created Migration',
+        }
+      );
+
+      const fileCount = fileHelper.fileGlobExists(
+        'test/jake-util/knexfile-stubs/*_somename.js'
+      );
+
+      const stubName = 'table.stub';
+      const stubPath = `test/jake-util/knexfile-stubs/${stubName}`;
+      expect(fileCount).to.equal(1);
+      expectMigrationMatchesStub(stubPath, migrationGlobPath, fileHelper);
     });
 
     it('Create a new migration with --stub <name> in config.migrations.directory', async () => {
@@ -274,9 +293,7 @@ development: {
         'test/jake-util/knexfile_migrations/*_somename.js'
       );
       expect(fileCount).to.equal(1);
-      expect(
-        migrationMatchesStub(stubPath, migrationGlobPath, fileHelper)
-      ).equal(true);
+      expectMigrationMatchesStub(stubPath, migrationGlobPath, fileHelper);
     });
 
     it('Create a new migration with --stub <name> when file does not exist', async () => {

test/jake-util/knexfile-stubs/knexfile.js

@@ -0,0 +1,10 @@
+module.exports = {
+  client: 'sqlite3',
+  connection: {
+    filename: __dirname + '/../test.sqlite3',
+  },
+  migrations: {
+    directory: __dirname + '/../knexfile-stubs',
+    stub: 'table.stub',
+  },
+};

test/jake-util/knexfile-stubs/table.stub

@@ -0,0 +1,11 @@
+exports.up = function (knex) {
+  return knex.schema.createTable("table_name", (table) => {
+    table.increments();
+
+    table.timestamps(true, true);
+  });
+};
+
+exports.down = function (knex) {
+  return knex.schema.dropTable("table_name");
+};