test: Add full coverage for runAll.js (#309)

* Add full coverage for runAll.js

* Add console mock to runAll

* Add required changes

* Fix the "no files" test

* Update listr

SamVerschueren/listr-verbose-renderer#4 (comment)

* Disable dates in console output

* Update snapshot

* Clear the console mock after the tests are run

* Remove clearing implementation after each test

* Refactor the no-files case

* Refactor the not-skip case

Author: Andrey Lozhkin

package.json

@@ -34,7 +34,7 @@
     "execa": "^0.8.0",
     "is-glob": "^4.0.0",
     "jest-validate": "^21.1.0",
-    "listr": "^0.12.0",
+    "listr": "^0.13.0",
     "lodash": "^4.17.4",
     "log-symbols": "^2.0.0",
     "minimatch": "^3.0.0",

src/runAll.js

@@ -38,6 +38,7 @@ module.exports = function runAll(scripts, config) {
           new Listr(runScript(task.commands, task.fileList, scripts, config), {
             // In sub-tasks we don't want to run concurrently
             // and we want to abort on errors
+            dateFormat: false,
             concurrent: false,
             exitOnError: true
           }),
@@ -51,6 +52,7 @@ module.exports = function runAll(scripts, config) {
 
       if (tasks.length) {
         return new Listr(tasks, {
+          dateFormat: false,
           concurrent,
           renderer,
           exitOnError: !concurrent // Wait for all errors when running concurrently

test/__snapshots__/runAll.spec.js.snap

@@ -1,5 +1,20 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`runAll should not skip tasks if there are files 1`] = `
+"
+LOG Running tasks for *.js [started]
+LOG echo \\"sample\\" [started]
+LOG echo \\"sample\\" [completed]
+LOG Running tasks for *.js [completed]"
+`;
+
+exports[`runAll should resolve the promise with no files 1`] = `
+"
+LOG Running tasks for *.js [started]
+LOG Running tasks for *.js [skipped]
+LOG → No staged files match *.js"
+`;
+
 exports[`runAll should throw when invalid config is provided 1`] = `"Invalid config provided to runAll! Use getConfig instead."`;
 
 exports[`runAll should throw when invalid config is provided 2`] = `"Invalid config provided to runAll! Use getConfig instead."`;

test/runAll.spec.js

@@ -1,3 +1,4 @@
+import { makeConsoleMock } from 'consolemock'
 import sgfMock from 'staged-git-files'
 import { getConfig } from '../src/getConfig'
 import runAll from '../src/runAll'
@@ -9,10 +10,14 @@ sgfMock.mockImplementation((params, callback) => {
 })
 
 const scripts = { mytask: 'echo "Running task"' }
+const globalConsoleTemp = global.console
 
 describe('runAll', () => {
-  afterEach(() => {
-    sgfMock.mockClear()
+  beforeEach(() => {
+    global.console = makeConsoleMock()
+  })
+  afterAll(() => {
+    global.console = globalConsoleTemp
   })
   it('should throw when invalid config is provided', () => {
     expect(() => runAll(scripts, {})).toThrowErrorMatchingSnapshot()
@@ -35,8 +40,21 @@ describe('runAll', () => {
     return expect(runAll(scripts, getConfig({}))).resolves.toEqual('No tasks to run.')
   })
 
+  it('should resolve the promise with no files', async () => {
+    await runAll(scripts, getConfig({ linters: { '*.js': ['echo "sample"'] } }))
+    expect(console.printHistory()).toMatchSnapshot()
+  })
+
+  it('should not skip tasks if there are files', async () => {
+    sgfMock.mockImplementationOnce((params, callback) => {
+      callback(null, [{ filename: 'sample.js', status: 'sample' }])
+    })
+    await runAll(scripts, getConfig({ linters: { '*.js': ['echo "sample"'] } }))
+    expect(console.printHistory()).toMatchSnapshot()
+  })
+
   it('should reject the promise when staged-git-files errors', () => {
-    sgfMock.mockImplementation((params, callback) => {
+    sgfMock.mockImplementationOnce((params, callback) => {
       callback('test', undefined)
     })
     expect.assertions(1)