assert: Add equalWithMargin for floating and other number comparison with error margin

README.md

@@ -111,9 +111,11 @@ $ eltro --watch my_watch_name --npm build
 
 Not only does eltro allow you to use any assertion library of your own choosing, it also comes with it's own assertion library based on node's default [assert](https://nodejs.org/api/assert.html) with a few extra methods:
 
+ * `assert.equalWithMargin(value, test, margin, [message])`: Check if number value is equal to test with error margin.
  * `assert.notOk(value, [message])`: Assert value is not ok.
  * `assert.match(value, test, [message])`: Check if value matches RegExp test.
  * `assert.notMatch(value, [message])`: Check if value does not match RegExp test.
+ * `assert.throwsAndCatch(fn, [message])`: Checks if function fn throws and returns the thrown error.
  * `assert.isFulfilled(promise, [message])`: Assert the promise resolves.
  * `assert.isRejected(promise, [message])`: Assert the promise gets rejects.
 

cli.mjs

@@ -27,15 +27,20 @@ function PrintHelp() {
   process.exit(1)
 }
 
-function showErrorAndExit(message = '', err = null, code = 1) {
+function showErrorAndExit(message = '', err = null, code = 1, clean = false) {
+  if (!clean) {
     console.log('')
+  }
 
   if (message) {
     console.error(`\x1b[31m${message}\x1b[0m`)
   }
 
   if (err) {
-    printError(err)
+    printError(err, '', clean)
+    if (err.inner) {
+      return showErrorAndExit(null, err.inner, code, true)
+    }
   } else {
     PrintHelp()
   }
@@ -54,7 +59,7 @@ cli.parseOptions(args)
 })
 .catch(function(err) { showErrorAndExit('Unknown error while processing arguments', err) })
 .then(function() {
-  if (!cli.files.length) {
+  if (!cli.files.length && cli.run === 'test') {
     showErrorAndExit('No files were found with pattern', cli.targets.join(','))
   }
 

lib/assert.mjs

@@ -57,6 +57,14 @@ assert.throwsAndCatch = (fn, message) => {
   return err
 }
 
+assert.equalWithMargin = (value, test, margin = 0.005, message) => {
+  assert.strictEqual(typeof value, 'number', 'Value should be number')
+  assert.strictEqual(typeof test, 'number', 'Test should be number')
+
+  let difference = Math.abs(value - test)
+  assert.ok(difference <= margin, message || `${value} ± ${margin} != ${test} (difference of ${difference} > ${margin})`)
+}
+
 assert.isFulfilled = (promise, message) => {
   return Promise.resolve(true)
     .then(() => promise)

lib/cli.mjs

@@ -3,6 +3,7 @@ import fs from 'fs'
 import fsPromise from 'fs/promises'
 import cluster from 'cluster'
 import child_process from 'child_process'
+import kill from './kill.mjs'
 import Watcher, { EVENT_REMOVE, EVENT_UPDATE } from './watch/index.mjs'
 
 export const MESSAGE_FILES_REQUEST = 'message_files_request'
@@ -41,6 +42,7 @@ export function CLI(e, overrides = {}) {
   this.logger = overrides.logger || console
   this.child_process = overrides.child_process || child_process
   this.process = overrides.process || process
+  this.kill = overrides.kill || kill
   this.importer = overrides.importer
   this.loadDefaults()
 }
@@ -287,7 +289,7 @@ CLI.prototype.runProgram = function() {
     if (runningTest) {
       return
     } else {
-      this.worker.kill()
+      this.kill(this.worker.pid)
     }
   }
 
@@ -438,9 +440,9 @@ export function getFilesFromTarget(files, match, insidePath, grabAll, insideStar
   })
 }
 
-export function printError(err, msg) {
+export function printError(err, msg, clean = false) {
   let before = msg || ''
-  console.error('')
+  if (!clean) console.error('')
   console.error('\x1b[31m    '
         + before + err.toString()
         + '\x1b[0m\n    \x1b[90m'

lib/eltro.mjs

@@ -117,6 +117,7 @@ process.on('uncaughtException', function(err) {
 })
 
 function Eltro() {
+  this.process = process
   this.__timeout = 2000
   this.hasExclusive = false
   this.reporter = 'list'
@@ -159,8 +160,8 @@ Eltro.prototype.begin = function() {
 }
 
 Eltro.prototype.__runTest = async function(stats, test, prefix = 'Test', child = null) {
-  if (this.reporter === 'list') {
+  if (this.reporter === 'list' && prefix === 'Test') {
-    process.stdout.write('    \x1b[90m? ' + test.name + '\x1b[0m')
+    this.process.stdout.write('    \x1b[90m? ' + test.name + '\x1b[0m')
   }
 
   let markRealTest = child || test
@@ -279,24 +280,24 @@ Eltro.prototype.__runTest = async function(stats, test, prefix = 'Test', child =
   this.captureOutsideExceptions = null
 
   if (this.reporter === 'list') {
-    readline.clearLine(process.stdout, 0)
+    readline.clearLine(this.process.stdout, 0)
-    readline.cursorTo(process.stdout, 0, null)
+    readline.cursorTo(this.process.stdout, 0, null)
     if (markRealTest.skipTest) {
-      process.stdout.write('    \x1b[94m- ' + markRealTest.name + '\x1b[0m\n')
+      this.process.stdout.write('    \x1b[94m- ' + markRealTest.name + '\x1b[0m\n')
     } else if (!markRealTest.error) {
       if (!test.name.startsWith('~')) {
-        process.stdout.write('    \x1b[32m√\x1b[90m ' + markRealTest.name + ' (' + markRealTest.totalTime + 'ms)\x1b[0m\n')
+        this.process.stdout.write('    \x1b[32m√\x1b[90m ' + markRealTest.name + ' (' + markRealTest.totalTime + 'ms)\x1b[0m\n')
       }
     } else if (prefix === 'Test') {
-      process.stdout.write('    \x1b[31m' + this.failedTests.length + ') ' + markRealTest.name + ' (' + markRealTest.totalTime + 'ms)\x1b[0m\n')
+      this.process.stdout.write('    \x1b[31m' + this.failedTests.length + ') ' + markRealTest.name + ' (' + markRealTest.totalTime + 'ms)\x1b[0m\n')
     }
   } else if (this.reporter === 'dot') {
     if (markRealTest.skipTest) {
-      process.stdout.write('\x1b[94m.\x1b[0m')
+      this.process.stdout.write('\x1b[94m.\x1b[0m')
-    } else if (!markRealTest.error) {
+    } else if (markRealTest.error) {
-      process.stdout.write('\x1b[32m.\x1b[0m')
+      this.process.stdout.write('\x1b[31m.\x1b[0m')
     } else if (prefix === 'Test') {
-      process.stdout.write('\x1b[31m.\x1b[0m')
+      this.process.stdout.write('\x1b[32m.\x1b[0m')
     }
   }
 }
@@ -304,7 +305,7 @@ Eltro.prototype.__runTest = async function(stats, test, prefix = 'Test', child =
 Eltro.prototype.__runGroup = async function(g, stats) {
   if (g.tests.length) {
     if (this.reporter === 'list') {
-      console.log('  ' + g.name)
+      this.process.stdout.write('  ' + g.name + '\n')
     }
   }
   if (g.before) {
@@ -351,8 +352,8 @@ Eltro.prototype.__runGroup = async function(g, stats) {
 
 Eltro.prototype.run = async function() {
   if (this.reporter && this.reporter !== 'test') {
-    console.log('')
+    this.process.stdout.write('' + '\n')
-    console.log('')
+    this.process.stdout.write('' + '\n')
   }
 
   captureUnknownErrors(this)
@@ -381,23 +382,23 @@ Eltro.prototype.run = async function() {
       }
     }
   } else if (this.reporter) {
-    console.log('')
+    this.process.stdout.write('' + '\n')
-    console.log('')
+    this.process.stdout.write('' + '\n')
     if (stats.passed) {
-      console.log('  \x1b[32m' + stats.passed + ' passing \x1b[90m(' + (end[0] * 1000 + Math.round(end[1] / 1000000)) + 'ms)\x1b[0m')
+      this.process.stdout.write('  \x1b[32m' + stats.passed + ' passing \x1b[90m(' + (end[0] * 1000 + Math.round(end[1] / 1000000)) + 'ms)\x1b[0m' + '\n')
     }
     if (stats.failed) {
-      console.log('  \x1b[31m' + stats.failed + ' failing\x1b[0m')
+      this.process.stdout.write('  \x1b[31m' + stats.failed + ' failing\x1b[0m' + '\n')
     }
     if (stats.skipped) {
-      console.log('  \x1b[94m' + stats.skipped + ' pending\x1b[0m')
+      this.process.stdout.write('  \x1b[94m' + stats.skipped + ' pending\x1b[0m' + '\n')
     }
-    console.log('')
+    this.process.stdout.write('' + '\n')
 
     if (this.failedTests.length) {
       for (let x = 0; x < this.failedTests.length; x++) {
         let test = this.failedTests[x];
-        console.log('  ' + (x + 1) + ') ' + test.name + ':')
+        this.process.stdout.write('  ' + (x + 1) + ') ' + test.name + ':' + '\n')
         printError(test.error)
       }
     }

lib/kill.mjs

@@ -0,0 +1,85 @@
+import { promisify } from 'util'
+import { spawn, exec } from 'child_process'
+
+const execPromise = promisify(exec)
+
+export default function kill(pid, signal) {
+  let pids = new Set([pid])
+  let getSpawn = null
+  let getPids = null
+
+  switch (process.platform) {
+    case 'win32':
+      return execPromise('taskkill /pid ' + pid + ' /T /F').then(() => pids)
+    case 'darwin':
+      getSpawn = function(parentPid) {
+        return spawn('pgrep', ['-P', parentPid])
+      }
+      getPids = function(data) {
+        return data.match(/\d+/g).map(Number)
+      }
+      break
+    default:
+      getSpawn = function (parentPid) {
+        return exec('ps -opid="" -oppid="" | grep ' + parentPid)
+      }
+      getPids = function(data, parentPid) {
+        let output = data.trim().split('\n')
+        return output.map(line => {
+          let [child, parent] = line.trim().split(/ +/)
+
+          if (Number(parent) === parentPid) {
+            return Number(child)
+          }
+
+          return 0
+        }).filter(x => x)
+      }
+      break
+  }
+
+  return buildTree(pids, getSpawn, getPids, pid)
+    .then(function() {
+      for (let pid of pids) {
+        try {
+          process.kill(pid, signal)
+        } catch (err) {
+          if (err.code !== 'ESRCH') throw err;
+        }
+      }
+      return pids
+    })
+}
+
+function buildTree(allPids, spawnGetChildren, spawnGetPids, parentPid) {
+  allPids.add(parentPid)
+
+  let ps = spawnGetChildren(parentPid)
+  let data = ''
+  let err = ''
+  ps.stdout.on('data', function(buf) {
+    data += buf.toString('ascii')
+  })
+  ps.stderr.on('data', function(buf) {
+    err += buf.toString('ascii')
+  })
+
+  return new Promise(function(res, rej) {
+    ps.on('close', function(code) {
+      // Check if ps errored out
+      if (code !== 0 && err.trim()) {
+        return rej(new Error('Error running ps to kill processes:\n\t' + err))
+      }
+
+      // Check if we otherwise got an error code (usually means empty results)
+      if (code !== 0 || !data.trim()) return res()
+
+      let pids = spawnGetPids(data, parentPid)
+
+      res(Promise.all(
+        pids.filter(pid => pid && !allPids.has(pid))
+          .map(buildTree.bind(this, allPids, spawnGetChildren, spawnGetPids))
+      ))
+    })
+  })
+}

lib/sinon.mjs

@@ -34,6 +34,7 @@ export function stub(returnFunc = null) {
   func.lastCall = null
   func.called = false
   func.callCount = 0
+  func.calls = calls
 
   func.findCall = function(fn) {
     for (let call of calls) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eltro",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Eltro is a tiny no-dependancy test framework for node",
   "main": "index.mjs",
   "scripts": {

test/assert.test.mjs

@@ -29,6 +29,41 @@ t.describe('#notOk()', function() {
   })
 })
 
+t.describe('#equalWithMargin()', function() {
+  t.test('should support default margin for floating point math', function() {
+    let check = 0.1 + 0.2
+
+    assertExtended.throws(function() {
+      assertExtended.strictEqual(check, 0.3)
+    }, assertExtended.AssertionError)
+
+    assertExtended.equalWithMargin(check, 0.3)
+  })
+
+  t.test('should support custom margin', function() {
+    assertExtended.equalWithMargin(1, 2, 1)
+  })
+
+  t.test('should fail if margin is too small', function() {
+    assertExtended.throws(function() {
+      assertExtended.equalWithMargin(1, 2, 0.9)
+    }, assertExtended.AssertionError)
+  })
+
+  t.test('should support custom message', function () {
+    const assertMessage = 'Hello world'
+    let error = null
+
+    try {
+      assertExtended.equalWithMargin(1, 2, 0, assertMessage)
+    } catch (err) {
+      error = err
+    }
+    assert.ok(error)
+    assert.match(error.message, new RegExp(assertMessage))
+  })
+})
+
 t.describe('#throwAndCatch()', function() {
   t.test('should work and return the original error', function() {
     const assertError = new Error('Speed')

test/cli.test.mjs

@@ -26,8 +26,9 @@ t.describe('CLI', function() {
       const cluster = { c: 3 }
       const process = { d: 4 }
       const importer = { e: 5 }
+      const kill = { f: 6 }
       
-      let cliTest = createSafeCli(eltro, { logger, cluster, process, importer })
+      let cliTest = createSafeCli(eltro, { logger, cluster, process, importer, kill })
       assert.strictEqual(cliTest.reporter, 'list')
       assert.strictEqual(cliTest.ignoreOnly, false)
       assert.strictEqual(cliTest.timeout, 2000)
@@ -43,6 +44,7 @@ t.describe('CLI', function() {
       assert.strictEqual(cliTest.cluster, cluster)
       assert.strictEqual(cliTest.process, process)
       assert.strictEqual(cliTest.importer, importer)
+      assert.strictEqual(cliTest.kill, kill)
     })
   
     t.test('should detect isSlave from cluster', function() {
@@ -913,14 +915,16 @@ t.describe('CLI', function() {
     let testCluster
     let testChildProcess
     let testWorker
+    let testKill
     let cli
 
     t.beforeEach(function() {
+      testKill = stub()
       testProcess = { stdout: { write: stub() }, stderr: { write: stub() } }
-      testWorker = { on: stub(), once: stub(), kill: stub(), send: stub(), stderr: { on: stub() }, stdout: { on: stub() } }
+      testWorker = { on: stub(), once: stub(),  send: stub(), stderr: { on: stub() }, stdout: { on: stub() } }
       testCluster = { fork: stub().returns(testWorker) }
       testChildProcess = { spawn: stub().returns(testWorker) }
-      cli = createSafeCli(null, { cluster: testCluster, child_process: testChildProcess, process: testProcess })
+      cli = createSafeCli(null, { cluster: testCluster, child_process: testChildProcess, process: testProcess, kill: testKill })
     })
 
     t.describe('in test mode', function() {
@@ -984,14 +988,14 @@ t.describe('CLI', function() {
       t.test('multiple calls should cancel', function() {
         cli.runProgram()
   
-        assert.notOk(testWorker.kill.called)
+        assert.notOk(testKill.called)
         assert.ok(testCluster.fork.called)
         testCluster.fork.reset()
   
         cli.runProgram()
   
         assert.notOk(testCluster.fork.called)
-        assert.notOk(testWorker.kill.called)
+        assert.notOk(testKill.called)
       })
     })
 
@@ -1063,16 +1067,19 @@ t.describe('CLI', function() {
       })
   
       t.test('multiple calls should kill', function() {
+        const assertPid = 12345235
+        testWorker.pid = assertPid
         cli.runProgram()
   
-        assert.notOk(testWorker.kill.called)
+        assert.notOk(testKill.called)
         assert.ok(testChildProcess.spawn.called)
         testChildProcess.spawn.reset().returns(testWorker)
   
         cli.runProgram()
   
         assert.ok(testChildProcess.spawn.called)
-        assert.ok(testWorker.kill.called)
+        assert.ok(testKill.called)
+        assert.strictEqual(testKill.firstCall[0], assertPid)
       })
     })
   })

test/eltro.flow.test.mjs

@@ -8,6 +8,9 @@ function CreateT() {
   t.logger = {
     log: stub()
   }
+  t.process = {
+    stdout: { write: stub() }
+  }
   return t
 }
 
@@ -284,6 +287,60 @@ e.describe('#beforeEach()', function() {
     assert.match(t.logger.log.getCallN(4)[0], /DDDD/)
     assert.match(t.logger.log.getCallN(4)[0], /BBBB/)
   })
+
+  e.describe('reporter', function() {
+    e.test('should not log before each with reporter list', async function() {
+      const t = CreateT()
+      t.reporter = 'list'
+      t.begin()
+      t.describe('BBBB', function() {
+        t.beforeEach(function() {})
+    
+        t.describe('CCCC', function() {
+          t.test('c1', function() { })
+          t.test('c2', function() { })
+        })
+    
+        t.describe('DDDD', function() {
+          t.test('d1', function() { })
+        })
+    
+        t.test('AAAA', function() { })
+      })
+      await t.run()
+      for (let row of t.process.stdout.write.calls) {
+        assert.notMatch(row.filter(x => x).join(' '), /before each/i)
+      }
+    })
+  
+    e.test('should not log success before each with reporter dot', async function() {
+      const t = CreateT()
+      t.reporter = 'dot'
+      t.begin()
+      t.describe('BBBB', function() {
+        t.beforeEach(function() {})
+    
+        t.describe('CCCC', function() {
+          t.test('c1', function() { })
+          t.test('c2', function() { })
+        })
+    
+        t.describe('DDDD', function() {
+          t.test('d1', function() { })
+        })
+    
+        t.test('AAAA', function() { })
+      })
+      await t.run()
+      let total = 0
+      for (let row of t.process.stdout.write.calls) {
+        if (row.filter(x => x).join(' ').match(/\[32m\./)) {
+          total++
+        }
+      }
+      assert.strictEqual(total, 4)
+    })
+  })
 })
 
 e.describe('#after()', function() {
@@ -679,6 +736,60 @@ e.describe('#afterEach()', function() {
     assert.match(t.logger.log.getCallN(5)[0], /JJJJ/)
     assert.match(t.logger.log.getCallN(5)[0], /YYYY/)
   })
+
+  e.describe('reporter', function() {
+    e.test('should not log before each with reporter list', async function() {
+      const t = CreateT()
+      t.reporter = 'list'
+      t.begin()
+      t.describe('BBBB', function() {
+        t.afterEach(function() {})
+    
+        t.describe('CCCC', function() {
+          t.test('c1', function() { })
+          t.test('c2', function() { })
+        })
+    
+        t.describe('DDDD', function() {
+          t.test('d1', function() { })
+        })
+    
+        t.test('AAAA', function() { })
+      })
+      await t.run()
+      for (let row of t.process.stdout.write.calls) {
+        assert.notMatch(row.filter(x => x).join(' '), /after each/i)
+      }
+    })
+  
+    e.test('should not log success before each with reporter dot', async function() {
+      const t = CreateT()
+      t.reporter = 'dot'
+      t.begin()
+      t.describe('BBBB', function() {
+        t.afterEach(function() {})
+    
+        t.describe('CCCC', function() {
+          t.test('c1', function() { })
+          t.test('c2', function() { })
+        })
+    
+        t.describe('DDDD', function() {
+          t.test('d1', function() { })
+        })
+    
+        t.test('AAAA', function() { })
+      })
+      await t.run()
+      let total = 0
+      for (let row of t.process.stdout.write.calls) {
+        if (row.filter(x => x).join(' ').match(/\[32m\./)) {
+          total++
+        }
+      }
+      assert.strictEqual(total, 4)
+    })
+  })
 })
 
 let commonBeforeTests = ['before', 'beforeEach']

test/eltro.test.mjs

@@ -234,7 +234,6 @@ e.test('Eltro should support capturing unknown errors outside scope', async func
   t.describe('', function() {
     t.test('', function(cb) {
       process.nextTick(function() {
-        console.log('throw')
         throw assertError
       })
     })

test/kill/kill.test.mjs

@@ -0,0 +1,41 @@
+import { spawn } from 'child_process'
+import t from '../../lib/eltro.mjs'
+import assert from '../../lib/assert.mjs'
+import kill from '../../lib/kill.mjs'
+
+t.describe('kill', function() {
+  let worker
+
+  t.afterEach(function() {
+    if (worker?.pid && !worker.killed) {
+      worker.kill()
+    }
+  })
+
+  t.test('should kill process correctly', function(done) {
+    worker = spawn('node', ['./test/kill/runner.mjs'])
+    assert.ok(worker.pid)
+
+    worker.on('exit', done.finish(function(code, signal) {
+      assert.ok(code || signal)
+    }))
+
+    kill(worker.pid)
+  })
+
+  t.test('should succeed in killing tree', async function() {
+    worker = spawn('node', ['./test/kill/runner.mjs'])
+    assert.ok(worker.pid)
+
+    // Give it some time to start
+    await new Promise(res => {
+      worker.stdout.on('data', function(data) {
+        if (data.toString().indexOf('secondary') >= 0) res()
+      })
+    })
+
+    return kill(worker.pid).then(function(pids) {
+      assert.strictEqual(pids.size, 2)
+    })
+  })
+})

test/kill/runner.mjs

@@ -0,0 +1,11 @@
+import { spawn } from 'child_process'
+
+console.log('primary', process.pid)
+
+let secondary = spawn('node', ['./test/kill/second_runner.mjs'])
+
+secondary.stdout.on('data', function(data) {
+  process.stdout.write(data)
+})
+
+setInterval(function() { console.log('primary', process.pid) }, 100)

test/kill/second_runner.mjs

@@ -0,0 +1,2 @@
+console.log('secondary', process.pid)
+setInterval(function() { console.log('secondary', process.pid) }, 100)

test/watch.test.mjs

@@ -28,7 +28,7 @@ t.afterEach(function(done) {
 
 t.after(function() {
   if (builder) {
-    builder.cleanup()
+    return builder.cleanup()
   }
 })
 

test/watch/builder.mjs

@@ -173,7 +173,7 @@ Builder.prototype.newRandomFiles = function(fpath, count) {
 }
 
 Builder.prototype.cleanup = function() {
-  return fs.rmdir(this.root)
+  return fs.rm(this.root, { recursive: true, force: true })
 }
 
 Builder.prototype.getAllDirectories = function() {