feat(test): allow per-module specific command, close #102

bahmutov · bahmutov · commit fa3b01042dd9 · 2017-06-24T23:17:42.000-04:00
diff --git a/README.md b/README.md
@@ -183,6 +183,29 @@ You can skip a list of modules by name using `config` property in the `package.j
 }
 ```
 
+### Custom test command per module
+
+Some modules are not really tested using the default `npm test` command or
+whatever is passed via `--test "..."` from CLI. For example a linter module
+should probably be tested using `npm run lint` command. You can set individual
+test commands for each module to override the default test command. In the
+`package.json` config object set "commands" object
+
+```json
+"config": {
+  "next-update": {
+    "commands": {
+      "git-issues": "npm run issues",
+      "standard": "npm run lint"
+    }
+  }
+}
+```
+
+Then when `git-issues` module is checked by itself, it will run
+`npm run issues` command; when module `standard` is tested by itself, the
+test will use `npm run lint` command.
+
 ### Misc
 
 * To see what has changed in the latest version of any module,
diff --git a/__snapshots__/command-spec.js.snap-shot b/__snapshots__/command-spec.js.snap-shot
@@ -0,0 +1,51 @@
+exports['sorts by version 1'] = [
+  {
+    "name": "lodash",
+    "version": "1.0.1",
+    "from": "1.0.0",
+    "works": true
+  },
+  {
+    "name": "lodash",
+    "version": "1.0.2",
+    "from": "1.0.0",
+    "works": true
+  },
+  {
+    "name": "lodash",
+    "version": "1.1.0",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.1.1",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.2.0",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.2.1",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.3.0",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.3.1",
+    "from": "1.0.0",
+    "works": false
+  }
+]
+
diff --git a/docs/use.md b/docs/use.md
@@ -153,6 +153,29 @@ You can skip a list of modules by name using `config` property in the `package.j
 }
 ```
 
+## Custom test command per module
+
+Some modules are not really tested using the default `npm test` command or
+whatever is passed via `--test "..."` from CLI. For example a linter module
+should probably be tested using `npm run lint` command. You can set individual
+test commands for each module to override the default test command. In the
+`package.json` config object set "commands" object
+
+```json
+"config": {
+  "next-update": {
+    "commands": {
+      "git-issues": "npm run issues",
+      "standard": "npm run lint"
+    }
+  }
+}
+```
+
+Then when `git-issues` module is checked by itself, it will run
+`npm run issues` command; when module `standard` is tested by itself, the
+test will use `npm run lint` command.
+
 ## Misc
 
 * To see what has changed in the latest version of any module,
diff --git a/src/test-module-version.js b/src/test-module-version.js
@@ -8,6 +8,9 @@ var quote = require('quote')
 var installModule = require('./module-install')
 var reportSuccess = require('./report').reportSuccess
 var reportFailure = require('./report').reportFailure
+const {getTestCommand} = require('./utils')
+const path = require('path')
+const debug = require('debug')('next-update')
 var stats = require('./stats')
 
 var cleanVersions = require('./registry').cleanVersions
@@ -106,8 +109,12 @@ function installEachTestRevert (listed, available, command, color, keep, tldr) {
   verify.object(listed, 'expected listed object')
   verify.array(available, 'expected array')
 
+  const packageFilename = path.resolve('./package.json')
+  const getCommand = _.partial(getTestCommand, packageFilename)
+
   var checkModulesFunctions = available.map(function (nameVersion) {
     var name = nameVersion.name
+    la(check.unemptyString(name), 'missing name', nameVersion)
     var currentVersion = listed[name].version
     la(check.string(currentVersion), 'cannot find current version for', name,
             'among current dependencies', listed)
@@ -120,10 +127,12 @@ function installEachTestRevert (listed, available, command, color, keep, tldr) {
     }
     var revertFunction = installModule.bind(null, installOptions)
 
+    const testCommand = getCommand(name) || command
+    debug('module %s should use test command "%s"', name, testCommand)
     var checkModuleFunction = testModuleVersions.bind(null, {
       moduleVersions: nameVersion,
       revertFunction: revertFunction,
-      command: command,
+      command: testCommand,
       color: color,
       currentVersion: currentVersion,
       keep: keep,
diff --git a/src/utils.js b/src/utils.js
@@ -28,8 +28,21 @@ function getSkippedModules (packageFilename) {
   return []
 }
 
+function getTestCommand (packageFilename, moduleName) {
+  la(is.unemptyString(moduleName), 'missing module name')
+  const config = getConfig(packageFilename)
+  if (!config) {
+    return
+  }
+  if (!config.commands) {
+    return
+  }
+  return config.commands[moduleName]
+}
+
 module.exports = {
   name,
   getConfig,
-  getSkippedModules
+  getSkippedModules,
+  getTestCommand
 }
diff --git a/test/command-spec.js b/test/command-spec.js
@@ -0,0 +1,58 @@
+const path = require('path')
+const chdir = require('chdir-promise')
+const nextUpdate = require('..')
+const execa = require('execa')
+const snapShot = require('snap-shot')
+const R = require('ramda')
+const TWO_MINUTES = 120000
+
+const testFolder = path.join(__dirname, 'test-command-map')
+
+function prune () {
+  return execa.shell('npm prune')
+}
+
+function install () {
+  return execa.shell('npm install')
+}
+
+const flatVersionSort = R.compose(
+  R.sortBy(R.prop('version')),
+  R.flatten
+)
+
+it('sorts by version', () => {
+  const results = [
+    [ { name: 'lodash', version: '1.0.1', from: '1.0.0', works: true },
+  { name: 'lodash', version: '1.1.0', from: '1.0.0', works: false },
+  { name: 'lodash', version: '1.1.1', from: '1.0.0', works: false },
+  { name: 'lodash', version: '1.2.0', from: '1.0.0', works: false },
+  { name: 'lodash', version: '1.2.1', from: '1.0.0', works: false },
+  { name: 'lodash', version: '1.3.0', from: '1.0.0', works: false },
+  { name: 'lodash', version: '1.3.1', from: '1.0.0', works: false },
+  { name: 'lodash', version: '1.0.2', from: '1.0.0', works: true } ]
+  ]
+  snapShot(flatVersionSort(results))
+})
+
+/* global describe, beforeEach, afterEach, it */
+describe('per-module configured command', () => {
+  beforeEach(function () {
+    this.timeout(TWO_MINUTES)
+    return chdir.to(testFolder)
+      .then(prune)
+      .then(install)
+  })
+
+  afterEach(chdir.back)
+
+  it('finds and uses module own test command', function () {
+    this.timeout(TWO_MINUTES)
+    const opts = {
+      module: 'lodash',
+      allow: 'minor'
+    }
+    return snapShot(nextUpdate(opts)
+      .then(flatVersionSort))
+  })
+})
diff --git a/test/revert-spec.js b/test/revert-spec.js
@@ -1,11 +1,7 @@
 const path = require('path')
 const fromFolder = path.join.bind(null, __dirname)
 const chdir = require('chdir-promise')
-const nextUpdate = require('..')
 const execa = require('execa')
-const snapShot = require('snap-shot')
-const _ = require('lodash')
-const is = require('check-more-types')
 const la = require('lazy-ass')
 const TWO_MINUTES = 120000
 
diff --git a/test/test-command-map/.npmrc b/test/test-command-map/.npmrc
@@ -0,0 +1 @@
+registry=http://registry.npmjs.org/
diff --git a/test/test-command-map/__snapshots__/command-spec.js.snap-shot b/test/test-command-map/__snapshots__/command-spec.js.snap-shot
@@ -0,0 +1,51 @@
+exports['finds and uses module own test command 1'] = [
+  {
+    "name": "lodash",
+    "version": "1.0.1",
+    "from": "1.0.0",
+    "works": true
+  },
+  {
+    "name": "lodash",
+    "version": "1.0.2",
+    "from": "1.0.0",
+    "works": true
+  },
+  {
+    "name": "lodash",
+    "version": "1.1.0",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.1.1",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.2.0",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.2.1",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.3.0",
+    "from": "1.0.0",
+    "works": false
+  },
+  {
+    "name": "lodash",
+    "version": "1.3.1",
+    "from": "1.0.0",
+    "works": false
+  }
+]
+
diff --git a/test/test-command-map/lodash-test.js b/test/test-command-map/lodash-test.js
@@ -0,0 +1,3 @@
+const _ = require('lodash')
+console.log('lodash test version %s', _.VERSION)
+process.exit(_.VERSION.startsWith('1.0') ? 0 : 1)
diff --git a/test/test-command-map/package.json b/test/test-command-map/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "test-next-updater",
+  "version": "0.0.1",
+  "description": "Simple NPM module with dependencies for testing",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo 'no test'",
+    "lodash-test": "node lodash-test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:bahmutov/test-next-updater.git"
+  },
+  "keywords": [
+    "test",
+    "versions",
+    "updater"
+  ],
+  "author": "Gleb Bahmutov <gleb.bahmutov@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "lodash": "1.0.0"
+  },
+  "config": {
+    "next-update": {
+      "commands": {
+        "lodash": "npm run lodash-test"
+      }
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+const _ = require('lodash')`
	`2`	`+console.log('lodash test version %s', _.VERSION)`
	`3`	`+process.exit(_.VERSION.startsWith('1.0') ? 0 : 1)`