object.js/test.js

943 lines
25 KiB
JavaScript
Raw Normal View History

#!/usr/bin/env node
/**********************************************************************
*
* This is an experimental test framework...
*
* The idea is that we can split the tests into:
* - setups
* Construct as set of testable things.
* On this stage the construction process can be tested.
* - modifiers
* Take a set of testable things as returned by a setup/modifier and
* modify them or produce new things based on the old ones.
* Here the modification process can be tested.
* - tests
* Take a set of things as returned by a setup/modifier and run a
* set of tests on them.
* This stage tests a specific state and interactions within it.
* - specific cases
* A specific manual construction of a thing, its modification and
* test.
*
* Testing is done by building/running a number chains, starting with a
* setup, then chaining the results through zero or more modifiers and
* finally into a test.
*
* The actual testing is dune via assert(..) functions and is not
* restricted to the test stage.
*
*
* NOTE: tests can be used as modifiers if they modify state and return
* the modified input.
*
*
* XXX thins to simplify:
* - would be nice if the actual code could be readable...
* - can we automate assert callas?
*
*
*
**********************************************************************/
((typeof define)[0]=='u'?function(f){module.exports=f(require)}:define)
(function(require){ var module={} // make module AMD/node compatible...
/*********************************************************************/
var colors = require('colors')
var argv = require('ig-argv')
var object = require('./object')
//---------------------------------------------------------------------
// NOTE: to test in verbose mode do:
// $ export VERBOSE=1 && npm test
// or
// $ export VERBOSE=1 && node test.js
// or set this manually after require('./test') but before running
// the runner(..)
// NOTE: this may change in the future...
module.VERBOSE = process ?
process.env.VERBOSE
: false
//---------------------------------------------------------------------
// helpers...
Object.defineProperty(String.prototype, 'raw', {
get: function(){
return this.replace(/\x1b\[..?m/g, '') }, })
// compare two arrays by items...
var arrayCmp = function(a, b){
var ka = Object.keys(a)
var kb = Object.keys(a)
return a === b
|| (a.length == b.length
&& ka
// keep only non matching stuff...
.filter(function(k){
return a[k] !== b[k]
&& a[k] != a[k] })
.length == 0) }
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// a constructor is a thing that starts with a capital and has a .prototype
var constructors = function(obj){
return Object.entries(obj)
.filter(function([k, o]){
return !k.startsWith('_')
&& k[0] == k[0].toUpperCase()
&& o.prototype }) }
// an instance is a thing that starts with a lowercase and has a .constructor
var instances = function(obj){
return Object.entries(obj)
.filter(function([k, o]){
return !k.startsWith('_')
&& k[0] == k[0].toLowerCase()
&& o.constructor }) }
//---------------------------------------------------------------------
// Tests...
var setups =
module.setups = {
// basic constructor and inheritance...
//
// X
// Y <- A <- B <- C
//
basic: function(assert){
var X, Y, A, B, C
return {
X: X = assert(object.Constructor('X'), `.Constructor(..)`),
Y: Y = assert(object.C('Y', {
method: function(){
var x
assert(
(x = object.parentCall(Y.prototype.method, this, ...arguments)) === undefined,
'y.method(..): expected:', undefined, 'got:', x)
return 'Y'
},
}), `.C(..)`),
A: A = assert(object.C('A', Y, {
method: function(){
var x
assert(
(x = object.parentCall(A.prototype.method, this, ...arguments)) == 'Y',
'a.method(..): expected:', 'Y', 'got:', x)
return 'A'
},
}), `inherit (gen1)`),
B: B = assert(object.C('B', A, {
// XXX constructor methods...
}, {
// XXX methods...
}), `inherit (gen2) with constructor mixin`),
C: C = assert(object.C('C', B, {
method: function(){
var x
assert(
(x = object.parentCall(C.prototype.method, this, ...arguments)) == 'A',
'c.method(..): expected:', 'A', 'got:', x)
return 'C'
},
}), `inherit (gen3)`),
} },
// initialization...
init: function(assert){
var A, B, C
return {
// init...
A: A = assert(object.C('A', {
msg: '.__init__()',
__init__: function(){
this.init_has_run = true },
test_init: function(){
this.__created_raw ?
assert(!this.init_has_run, this.msg+' did not run')
: assert(this.init_has_run, this.msg+' run') },
}), 'basic .__init__(..)'),
// new...
B: B = assert(object.C('B', {
__new__: function(){
var o = {}
o.new_has_run = true
return o
},
test_new: function(){
assert(this.new_has_run, '.__new__() run') },
}), 'basic .__new__(..)'),
// new + init...
C: C = assert(object.C('C', B, {
msg: '.__init__() after .__new__()',
__init__: function(){
this.init_has_run = true },
test_init: A.prototype.test_init,
}), `inherit .__new__()`),
// XXX
} },
// callable instances...
call: function(assert){
// constructors...
var A, B, C, D, F, G
var res = {
A: A = assert(object.C('A',
function(){
return 'A'
}), 'callable'),
B: B = assert(object.C('B', {
__non_function: true,
__call__: function(){
assert(
object.parentCall(B.prototype, '__call__', this, ...arguments) === undefined,
'call non-existent parent method', 'B')
return 'B'
},
}), 'callable'),
C: C = assert(object.C('C', A, {}), 'basic inherit'),
D: D = assert(object.C('D', B, {}), 'basic inherit'),
E: E = assert(object.C('E', A,
function(){
assert(
object.parentCall(E.prototype, '__call__', this, ...arguments) == 'A',
'parrent call')
return 'E'
}), 'call parent'),
F: F = assert(object.C('F', B, {
__call__: function(){
assert(
object.parentCall(F.prototype, '__call__', this, ...arguments) == 'B',
'parent call')
return 'F'
},
}), 'call parent\'s .__call__'),
}
// create instances...
var objs = tests.instance(assert, res)
// all instances must be callable...
// NOTE: not all instances are going to be instanceof Function...
Object.entries(objs)
.forEach(function([k, o]){
assert(typeof(o) == 'function', 'instance is callable', k) })
return Object.assign(res, objs) },
// inherit from native constructors...
native: function(assert){
return [
Object,
Array,
Number,
Map,
Set,
].reduce(function(res, type){
var n = type.name
// direct inherit...
var O = res[n] =
assert(object.C(n, type, {}), 'inherit from '+n)
return res
}, {}) },
// compatibility: native constructors...
js_constructors: function(assert){
var X, Y, Z, a, b, c, d
return {
Object,
Array,
Number,
Map,
Set,
}},
// compatibility: prototype tree...
js_prototype: function(assert){
var a, b, c, d
return {
a: a = {
x: 'a',
method: function(){
return 'a' },
},
b: b = {
__proto__: a,
x: 'b',
},
c: c = {
__proto__: b,
x: 'c',
method: function(){
var x, y
assert(arrayCmp(
x = object.values(c, 'x'),
y = ['c', 'a', 'b']),
'reach all values of attr: expected:', x, 'got:'.bold.yellow, y)
assert(arrayCmp(
x = object.values(c, 'x', function(v, o){
return v.toUpperCase() }),
y = ['C', 'A', 'B']),
'reach all values of attr: expected:', x, 'got:'.bold.yellow, y)
assert(arrayCmp(
x = object.sources(c, 'method'),
// NOTE: not passing an explicit list as we need
// to account for mixins...
y = object.sources(c)
.filter(function(s){
return s.hasOwnProperty('method') })),
'reach all values of method: expected:', y, 'got:'.bold.yellow, x)
assert(
(x = object.parent(c, 'x')) == 'b',
'reach parent attr: expected:', 'b', 'got:'.bold.yellow, x)
assert(
(x = object.parentCall(c.method, this)) == (y = a.method()),
'reach parent method: expected:', y, 'got:'.bold.yellow, x)
return 'c' },
},
d: d = {
__proto__: c,
method: function(){
assert(object.parentCall(d.method, this) == 'c', 'reach parent method', 'd')
return 'd' },
},
}},
// compatibility: class/instance...
js_class: function(assert){
var X, Y, Z
return {
X: X = class {
x = 'x'
method(){
return 'x' }
},
Y: Y = class extends X {
x = 'y'
},
Z: Z = class extends Y {
x = 'z'
method(){
// XXX this is almost the same as for js_prototype...
assert(arrayCmp(
object.values(c, 'x'),
['z', 'y', 'x']),
'reach all values of attr (class)')
assert(arrayCmp(
object.values(c, 'x', function(v, o){
return v.toUpperCase() }),
['C', 'A', 'B']),
'reach all values of attr (class)')
assert(arrayCmp(
object.sources(c, 'method'),
[Z.prototype, X.prototype]),
'reach all values of method (class)')
assert(
object.parent(c, 'x') == super.x,
'reach super attr (class)')
assert(
object.parentCall(c.method, this) == super.method(),
'reach super method (class)')
return 'c' }
},
}},
}
var modifiers =
module.modifiers = {
// default...
//
'as-is': function(assert, setup){
return setup },
// make gen2-3 constructors...
//
// NOTE: there is almost no need to test below gen3...
gen2: function(assert, setup, gen){
gen = gen || 2
return constructors(setup)
.reduce(function(res, [n, O]){
res[n+'g'+gen] = object.C(n+'g'+gen, O, {})
return res }, {}) },
gen3: function(assert, setup){
return this.gen2(assert, this.gen2(assert, setup), '3') },
// generate instances...
//
// NOTE: these are re-used as tests too...
instance: function(assert, setup, mode){
return constructors(setup)
.reduce(function(res, [k, O]){
// native JS constructors do not support no_new or raw modes...
if((mode == 'raw' || mode == 'no_new') && !O.__rawinstance__){
return res }
// create instance with lowercase name of constructor...
// NOTE: constructor is expected to be capitalized...
var o = res[k.toLowerCase()] =
mode == 'no_new' ?
assert(O(), `new:`, k)
: mode == 'raw' ?
assert(O.__rawinstance__(), `.__rawinstance__()`, k)
: assert(new O(), `new:`, k)
assert(o instanceof O, `instanceof:`, k)
O.__proto__ instanceof Function
// XXX need to test this for constructor mixins too...
&& !(O.__mixin_constructors && !O.__mixin_flat)
&& assert(o instanceof o.constructor.__proto__, `instanceof-nested:`, k)
assert(o.constructor === O, `.constructor:`, k)
assert(o.__proto__ === O.prototype, `.__proto__:`, k)
return res }, {}) },
instance_no_new: function(assert, setup){
return this.instance(assert, setup, 'no_new') },
// NOTE: here we mark the raw instances with .__created_raw, this is
// done to be able to distinguish them from fully initialized
// instances...
instance_raw: function(assert, setup){
var res = this.instance(assert, setup, 'raw')
Object.values(res)
.forEach(function(e){
Object.assign(
e,
{__created_raw: true}) })
return res },
// mixins...
// NOTE: running this in flat mode will have side-effects -- overwriting
// existing attributes and methods...
// XXX might be a good idea to get the method name from the context... how?
mixin_instance: function(assert, setup, flat, filter, get){
filter = filter || instances
var attr = '__mixin_' + filter.name
var mixin = setup[attr] = {
// NOTE: in the real world mixins should have no state, just
// methods...
__mixin: true,
[attr]: true,
__mixin_flat: !!flat,
method: function(){
var res = object.parent(mixin.method, this) !== undefined ?
assert(
object.parentCall(mixin.method, this, ...arguments),
'mixin method parent call')
: false
return res
|| 'mixin' },
mixinMethod: function(){
return 'mixin' },
}
mixin[attr] = mixin
filter(setup)
.forEach(function([n, o]){
o = get ? get(o) : o
// mixin once per chain...
if(!o || o[attr]){
return }
assert(!object.hasMixin(o, mixin), 'pre mixin test', n)
assert(flat ?
object.mixinFlat(o, mixin)
: object.mixin(o, mixin),
flat ?
'mixin (flat)'
:'mixin', n)
assert(object.hasMixin(o, mixin), 'mixin test', n)
assert(o.mixinMethod() == 'mixin', 'mixin method call')
})
return setup },
mixin_instance_flat: function(assert, setup){
return this.mixin_instance(assert, setup, true) },
mixin_constructor: function(assert, setup, flat){
return this.mixin_instance(assert, setup, false, constructors) },
mixin_constructor_proto: function(assert, setup, flat){
return this.mixin_instance(assert, setup, false, constructors,
function(o){
// skip mixing into Object.prototype...
return o !== Object
&& o.prototype }) },
mixin_constructor_flat: function(assert, setup){
return this.mixin_constructor_proto(assert, setup, true) },
/*/ XXX
mixout: function(assert, setup){
return {}
},
//*/
// sanity checks...
//
// NOTE: these should have no side-effects but since we can run
// them why not run them and verify ;)
get methods(){ return tests.methods },
get constructor_methods(){ return tests.constructor_methods },
get callables(){ return tests.callables },
}
var tests =
module.tests = {
// instance creation...
instance: modifiers.instance,
instance_no_new: modifiers.instance_no_new,
instance_raw: modifiers.instance_raw,
/*/ XXX
attributes: function(assert, setup){
return {} },
//*/
// methods...
methods: function(assert, setup){
instances(setup)
.forEach(function([k, o]){
object.deepKeys(o)
.forEach(function(m){
typeof(o[m]) == 'function'
// skip special methods...
&& !m.startsWith('__')
&& o[m]() }) })
return setup },
constructor_methods: function(assert, setup){
constructors(setup)
.forEach(function([k, O]){
object.deepKeys(O)
.forEach(function(m){
typeof(O[m]) == 'function'
// skip special methods...
&& !m.startsWith('__')
&& O[m]() }) })
return setup },
// callables...
callables: function(assert, setup){
// test special case .values(x, '__call__')
var test = function(obj, name){
var a, b
return assert(arrayCmp(
a = object.values(obj, '__call__')
.map(function(func){
return func.call(obj) })
.flat(),
// get all callables in prototype chain and call them...
b = object.sources(obj)
.filter(function(o){
return typeof(o) == 'function'
|| o.hasOwnProperty('__call__') })
.map(function(o){
return o.hasOwnProperty('__call__') ?
o.__call__.call(obj)
// NOTE: not all callables are instances of Function...
: Reflect.apply(Function.prototype, o, [obj]) })),
'values of .__call__ of '+ name +': got:', a, 'expected:', b) }
instances(setup)
.filter(function([_, o]){
// NOTE: not all callables are instances of Function...
return typeof(o) == 'function' })
.forEach(function([k, o]){
o.__non_function ?
assert(!(o instanceof Function), 'non-instanceof Function', k)
: assert(o instanceof Function, 'instanceof Function', k)
assert(o(), 'call', k)
test(o, k)
})
return setup },
}
// specific independent cases...
//
// NOTE: it is a good idea to migrate tests from here into the main
// framework so as to be able to use them on more setups...
var cases =
module.cases = {
'edge-cases': function(assert){
var x, y
// object.match(..)
assert(object.match(x = {a: 123, b: '333', c: []}, x) === true, 'match self')
assert(object.match(x, {a: x.a, b: x.b, c: []}) == false, 'strict mismatch')
assert(object.match(x, {a: 123, b: 333, c: x.c}, true) === true, 'non-strict match')
// object.matchPartial(..)
assert(object.matchPartial(x, {a: x.a}, true) === true, 'non-strict partial match')
assert(object.matchPartial(x, {a: x.a, b: x.b, c: x.c}) === true, 'strict partial match')
// object.parent(..)
assert(object.parent({}) === {}.__proto__, 'basic proto')
assert.error('.parent(..) of anonymous function', function(){
object.parent(function(){}, {}) })
},
'deepKeys': function(assert){
var a = {
a: true
}
var b = {
__proto__: a,
b: true,
}
var c = {
__proto__: b,
c: true,
}
assert(arrayCmp(object.deepKeys(c), ['a', 'b', 'c']), 'full')
assert(arrayCmp(object.deepKeys(c, a), ['a', 'b', 'c']), 'full 2')
// XXX these are wrong...
console.log('>>>>', object.deepKeys(c, a)) // -/-> ['a', 'b', 'c']
console.log('>>>>', object.deepKeys(c, b)) // -/-> ['b', 'c']
console.log('>>>>', object.deepKeys(c, c)) // -/-> ['c']
}
}
//---------------------------------------------------------------------
// Assert constructor...
//
// Create an assert callable...
// Assert()
// Assert(path[, stats[, verbose]])
// -> assert
//
// Create an assert with extended path...
// assert.push(path)
// -> assert
//
// Create an assert with shortened path...
// assert.pop(path)
// -> assert
//
//
// Assertions...
//
// value is truthy...
// assert(value, msg, ..)
// -> value
//
// Assert truth and catch exceptions...
// assert.assert(msg, test())
// -> value
//
// Assert if test does not throw...
// assert.error(msg, test())
// -> error
//
//
var Assert =
module.Assert =
object.Constructor('Assert', {
stats: null,
__verbose: null,
get verbose(){
return this.__verbose == null ?
module.VERBOSE
: this.__verbose },
set verbose(value){
value == null ?
(delete this.__verbose)
: (this.__verbose = value) },
// path API...
__str_path: null,
get strPath(){
return (this.__str_path =
this.__str_path
|| (this.path || []).join(':')) },
path: null,
push: function(path){
return this.constructor(
[
...(this.path || []),
...(path instanceof Array ?
path
: [path])
],
stats,
this.verbose) },
pop: function(){
return this.constructor(
(this.path || []).slice(0, -1),
this.stats,
this.verbose) },
// assertion API...
__call__: function(_, value, msg, ...args){
// stats...
var stats = this.stats
stats.assertions = (stats.assertions || 0) + 1
!value
&& (stats.failures = (stats.failures || 0) + 1)
// assertions...
this.verbose
&& console.log(this.strPath +': '+ msg.bold, ...args)
console.assert(value, this.strPath.bold +': '+ msg.bold.yellow, ...args)
return value },
istrue: function(msg, test){
try {
return this(test.call(this), msg)
} catch(err){
this(false, msg)
return err } },
error: function(msg, test){
try {
test.call(this)
return this(false, msg)
} catch(err){
this(true, msg)
return err } },
__init__: function(path, stats, verbose){
this.path = path instanceof Array ?
path
: [path]
this.stats = stats || {}
this.verbose = verbose
},
})
// Test runner...
//
// runner()
// runner('*')
// -> stats
//
// runner('case')
// runner('setup:test')
// runner('setup:mod:test')
// -> stats
//
//
// This will run
// test(modifier(setup))
// for each test in tests
// for each modifier in modifiers
// for each setup in setups
// case()
// for each case in cases
//
//
// NOTE: chaining more than one modifier is not yet supported (XXX)
var runner =
module.runner =
function(chain, stats){
// parse chain...
chain = (chain == '*' || chain == null) ?
[]
: chain
chain = chain instanceof Array ?
chain
: chain.split(/:/)
var chain_length = chain.length
var setup = chain.shift() || '*'
var test = chain.pop() || '*'
var mod = chain.pop() || '*'
mod = chain_length == 2 ?
'as-is'
: mod
// stats...
stats = stats || {}
Object.assign(stats, {
tests: stats.tests || 0,
assertions: stats.assertions || 0,
failures: stats.failures || 0,
time: stats.time || 0,
})
var started = Date.now()
// tests...
var assert = Assert('[TEST]', stats, module.VERBOSE)
chain_length != 1
&& Object.keys(tests)
.filter(function(t){
return test == '*' || test == t })
.forEach(function(t){
// modifiers...
Object.keys(modifiers)
.filter(function(m){
return mod == '*' || mod == m })
.forEach(function(m){
// setups...
Object.keys(setups)
.filter(function(s){
return setup == '*' || setup == s })
.forEach(function(s){
if(typeof(setups[s]) != 'function'){
return }
// run the test...
stats.tests += 1
var _assert = assert.push([s, m, t])
tests[t](_assert,
modifiers[m](_assert,
setups[s](_assert))) }) }) })
// cases...
var assert = Assert('[CASE]', stats, module.VERBOSE)
chain_length <= 1
&& Object.keys(cases)
.filter(function(s){
return setup == '*' || setup == s })
.forEach(function(c){
stats.tests += 1
cases[c]( assert.push(c) ) })
// runtime...
stats.time += Date.now() - started
return stats }
//---------------------------------------------------------------------
// we are run from command line -> test...
//
// NOTE: normally this would be require.main === module but we are
// overriding module in the compatibility wrapper so we have to do
// things differently...
//
// XXX update wrapper to make the condition simpler...
if(typeof(__filename) != 'undefined'
&& __filename == (require.main || {}).filename){
// parse args...
var chains =
argv.ArgvParser({
// doc...
__usage__: `$scriptname [OPTIONS] [CHAIN] ...`,
__doc__: object.normalizeTextIndent(
`Run tests on object.js module.
Tests run by $scriptname can be specified in one of the
following formats:
<case>
<setup>:<test>
<setup>:<modifier>:<test>
Each of the items in the test spec can be a "*" indicating
that all relevant items should be used, for example:
${ '$ ./$scriptname basic:*:*' }
Here $scriptname is instructed to run all tests and modifiers
only on the basic setup.
Zero or more sets of tests can be specified.
When no tests specified $scriptname will run all tests.
`),
__examples__: [
['$ ./$scriptname',
'run all tests.'.gray],
['$ ./$scriptname basic:*:*',
'run all tests and modifiers on "basic" setup.'.gray,
'(see $scriptname -l for more info)'.gray],
['$ ./$scriptname -v example',
'run "example" test in verbose mode.'.gray],
['$ ./$scriptname native:gen3:methods init:gen3:methods',
'run two tests/patterns.'.gray],
['$ export VERBOSE=1 && ./$scriptname',
'set verbose mode globally and run tests.'.gray],
],
// options...
'-l': '-list',
'-list': {
doc: 'list available tests.',
handler: function(){
console.log(object.normalizeTextIndent(
`Tests run by %s can be of the following forms:
<case>
<setup>:<test>
<setup>:<modifier>:<test>
Setups:
${ Object.keys(setups).join('\n\
') }
Modifiers:
${ Object.keys(modifiers).join('\n\
') }
Tests:
${ Object.keys(tests).join('\n\
') }
Standalone test cases:
${ Object.keys(cases).join('\n\
') }
`), this.scriptname)
process.exit() }},
'-v': '-verbose',
'-verbose': {
doc: 'verbose mode (defaults to: $VERBOSE).',
handler: function(){
module.VERBOSE = true }},
// XXX commands...
'-foo': 'moo',
'moo': 'moue',
'moue': Object.assign(
function(){
console.log('MOO!!!!!!')
process.exit() },
{
doc: 'test command...'
}),
// XXX need to make this nestable...
'nested': argv.ArgvParser({ }),
})(process.argv)
// run the tests...
var stats = {}
chains.length > 0 ?
chains
.forEach(function(chain){
runner(chain, stats) })
: runner('*', stats)
// print stats...
console.log('Tests run:', stats.tests,
' Assertions:', stats.assertions,
' Failures:', stats.failures,
` (${stats.time}ms)`.bold.black)
// report error status to the OS...
process.exit(stats.failures)
}
/**********************************************************************
* vim:set ts=4 sw=4 : */ return module })