Fix knexfile resolution. Add missing test (#2923)

* Fix knexfile resolution. Add missing test

* Try fixing Jake test execution

* Avoid having non-test files in jake folder

* Fix test compatibility with Node 6

* Fix the fix

bin/cli.js

@@ -56,7 +56,7 @@ function mkConfigObj(opts) {
 function initKnex(env, opts) {
   checkLocalModule(env);
 
-  if (!env.pathToKnexFile) {
+  if (!opts.knexfile) {
     if (opts.client) {
       env.configuration = mkConfigObj(opts);
     } else {
@@ -67,7 +67,7 @@ function initKnex(env, opts) {
   }
   // If knexfile is specified
   else {
-    env.configuration = require(env.pathToKnexFile);
+    env.configuration = require(opts.knexfile);
   }
 
   if (process.cwd() !== env.cwd) {
@@ -97,7 +97,10 @@ function initKnex(env, opts) {
     process.exit(1);
   }
 
-  if (argv.debug !== undefined) config.debug = argv.debug;
+  if (argv.debug !== undefined) {
+    config.debug = argv.debug;
+  }
+
   const knex = require(env.modulePath);
   return knex(config);
 }
@@ -297,7 +300,6 @@ cli.on('requireFail', function(name) {
 cli.launch(
   {
     cwd: argv.cwd,
-    pathToKnexFile: argv.knexfile,
     require: argv.require,
     completion: argv.completion,
   },

package.json

@@ -43,6 +43,7 @@
     "chai": "^4.2.0",
     "chai-subset-in-order": "^2.1.2",
     "coveralls": "^3.0.2",
+    "cross-env": "^5.2.0",
     "eslint": "5.9.0",
     "eslint-config-prettier": "^3.3.0",
     "eslint-plugin-import": "^2.14.0",
@@ -86,7 +87,7 @@
     "plaintest": "mocha --exit -t 10000 -b -R spec test/index.js && npm run tape",
     "prepublish": "npm run babel",
     "pre_test": "npm run lint",
-    "bin_test": "jake -f test/jake/*",
+    "bin_test": "cross-env KNEX_PATH=../knex.js KNEX=bin/cli.js jake -f test/jake/*",
     "tape": "node test/tape/index.js | tap-spec",
     "debug_tape": "node --inspect-brk test/tape/index.js",
     "test": "npm run pre_test && nyc mocha --exit --check-leaks --globals __core-js_shared__ -t 10000 -R spec test/index.js && npm run tape && npm run bin_test",

test/jake-util/helpers/migrationtesthelper.js

@@ -0,0 +1,53 @@
+/* eslint-disable no-undef */
+/* eslint-disable no-console */
+
+const os = require('os');
+const fs = require('fs');
+const rimrafSync = require('rimraf').sync;
+
+function assertExec(cmd, desc) {
+  desc = desc || 'Run ' + cmd;
+  return new Promise((resolve, reject) => {
+    let stderr = '';
+    console.log(`Executing: ${cmd}`);
+    const bin = jake.createExec([cmd]);
+    bin.addListener('error', (msg, code) =>
+      reject(Error(desc + ' FAIL. ' + stderr))
+    );
+    bin.addListener('cmdEnd', resolve);
+    bin.addListener('stderr', (data) => (stderr += data.toString()));
+    bin.run();
+  });
+}
+
+function test(taskList, description, func) {
+  const tmpDirPath = os.tmpdir() + '/knex-test-';
+  rimrafSync(tmpDirPath);
+  const tempFolder = fs.mkdtempSync(tmpDirPath);
+  desc(description);
+  const taskName = description.replace(/[^a-z0-9]/g, '');
+  taskList.push(taskName);
+  task(taskName, { async: true }, () => {
+    let itFails = false;
+    func(tempFolder)
+      .then(() => {
+        console.log('☑ ' + description);
+      })
+      .catch((err) => {
+        console.log('☒ ' + err.message);
+        itFails = true;
+      })
+      .then(() => {
+        rimrafSync(tmpDirPath);
+        rimrafSync('test/jake/test.sqlite3');
+        if (itFails) {
+          process.exit(1);
+        }
+      });
+  });
+}
+
+module.exports = {
+  assertExec,
+  test,
+};

test/jake-util/knexfile/knexfile.js

@@ -0,0 +1,9 @@
+module.exports = {
+  client: 'sqlite3',
+  connection: {
+    filename: __dirname + '/../test.sqlite3',
+  },
+  migrations: {
+    directory: __dirname + '/../knexfile_migrations',
+  },
+};

test/jake-util/knexfile_migrations/simple_migration.js

@@ -0,0 +1,9 @@
+exports.up = (knex) => {
+  return knex.schema.createTable('rules', (table) => {
+    table.string('name');
+  });
+};
+
+exports.down = (knex) => {
+  return knex.schema.dropTable('rules');
+};

test/jake/knexfile.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env jake
+'use strict';
+/* eslint-disable no-undef */
+/* eslint-disable no-console */
+
+const path = require('path');
+const {
+  assertExec,
+  test,
+} = require('../jake-util/helpers/migrationtesthelper');
+
+const KNEX = path.normalize(__dirname + '/../../bin/cli.js');
+
+const taskList = [];
+/* * * TESTS * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+test(taskList, 'Run migrations with knexfile passed', (temp) => {
+  return assertExec(
+    `node ${KNEX} migrate:latest --knexfile=../test/jake-util/knexfile/knexfile.js`
+  );
+});
+
+task('default', taskList);