test.js
Experimental test runner....
Features
XXX
Contents
- test.js
- Features
- Contents
- Architecture
- Installation
- Basic usage
- CLI
- Components
- Advanced components
- Utilities
- License
Architecture
This package implements two testing schemes:
- Combinational testing
Here the user sets up a set ofSetup,ModifierandTestfunctions and the system chains different combinations of the three and runs them. - Unit testing
Simple independent tests.
Combinational testing
In general the idea here is that you define three things:
Setupsthat build a test context and objects (the setup),Modifiersthat modify the setup in some way,Teststhat test some aspect of a setup.
The system builds chains in the form:
setup -> modifier* -> test
Where modifier can me either single or a chain of modifiers.
A setup and modifier can also include assertions/tests for direct testing and
sanity checks.
The system defines a blank pass-through modifier and test, to alleviate the requirement on the user to define at least one modifier and test, so in cases where it makes no sense only a setup is required.
Note that each element can reference and re-use other elements so for example a modifier can call (re-use) other modifiers to avoid code duplication.
This makes it simple to define procedural/generative tests.
Unit testing
This is the traditional self-contained test approach.
Installation
npm install -g ig-test
npm install -i ig-test
Basic usage
XXX script naming...
Create a test script
$ touch test.js
$ chmod +x test.js
The code:
#!/usr/bin/env node
var test = require('ig-test')
// XXX add assert examples...
test.Setups({
state: function(assert){
return {
a: 123,
b: 321,
} },
})
test.Modifiers({
inc: function(assert, state){
Object.keys(state)
.forEach(function(k){
state[k] += 1 })
return state },
})
test.Tests({
})
test.Cases({
})
// make the test runnable as a standalone script...
__filename == (require.main || {}).filename
&& tests.run()
Run the tests
$ node ./test.js
or
$ runtests
CLI
XXX help
XXX chains
XXX notes on coverage
Components
DEFAULT_TEST_FILES
glob pattern(s) used to find test files by default.
DEFAULT_TEST_FILES =
undefined
| <path>
| [ <path>, .. ]
Default value: "**/?(*-)test.js"
IGNORE_TEST_FILES
A list of glob patterns to ignore while searching for tests.
IGNORE_TEST_FILES =
undefined
| [ <path>, .. ]
Default value: ['node_modules/**']
Merged(..)
Implements a merged collection of instances (members).
Merged({ <key>: <func>, .. })
-> <member>
Merged(<key>, <func>)
-> <member>
On construction this will assign the input object / <key>-<func> into the resulting
<member>/instance object.
Each <member>/instance created is added to the constructor as a member (i.e.
added into .members)
Provides a set of methods and properties to access/introspect the merged
(hence the name) attributes of the members (i.e. .keys(..), .values(..),
.entries(..), .size/.usize and .members).
<merged>.members
List of members / instances of Merged in order of creation.
<merged>.size / <merged>.usize
Number of members including the "-" members and not including respectively.
<merged>.add(..) / <merged>.remove(..)
Add / remove a member.
<merged>.add(<member>)
-> <merged>
<merged>.remove(<member>)
-> <merged>
<merged>.clear()
Remove (clear) all the members.
<merged>.keys(..) / <merged>.values(..) / <merged>.entries(..)
<merged>.keys()
<merged>.keys(<merged>)
-> <list>
<merged>.values()
<merged>.values(<merged>)
-> <list>
<merged>.entries()
<merged>.entries(<merged>)
-> <list>
These are similar to Object.keys(..) / Object.values(..) / Object.entries(..)
but will also if called without arguments return a list of the callers member
keys/values/entries respectively.
Note that members' attributes can shadow previous member attributes, only one
value per key will be returned. <merged> will warn when adding a member of its
attributes will shadow already existing members' attributes (see:
<merged>.checkShadowing(..) and
<merged>.handleShadowing(..));
Also note that the check for shadowing is performed when the <member> is
created and not when new attributes are added manually.
<merged>.toObject(..)
Create an object containing all visible member attributes.
<merged>.toObject()
-> <object>
<merged>.checkShadowing(..)
Find all shadowed attributes within <merged>.
<merged>.checkShadowing()
Find all attributes in <merged> that will be shadowed by <member>
<merged>.checkShadowing(<member>)
-> <list>
<merged>.handleShadowing(..)
Will be called on <member> construction when attribute shadowing is detected.
`<merged>.handleShadowing(<attr>)`
-> <merged>
By default this will print a warning and continue, but can be overloaded by the user to react to shadowing in a different manner.
<member>.filename
The filename where the <member> was defined.
Setups(..) / Setup(..) (Merged)
XXX
A subclass or rather sub-constructor of Merged.
Note that Setups and Setup are references to the same object, they exists
for better readability in cases when we add a single element (<key>-<func>
pair) or a bunch of elements (object), for example:
// single element...
test.Setup('some-setup',
function(){
// ...
})
// arbitrary number of elements...
test.Setups({
'some-other-setup': function(){
// ...
},
// ...
})
Modifiers(..) / Modifier(..) (Merged)
XXX
A sub-constructor of Merged.
Tests(..) / Test(..) (Merged)
XXX
A sub-constructor of Merged.
Cases(..) / Case(..) (Merged)
XXX
A sub-constructor of Merged.
Assert(..)
XXX this may still change...
run(..)
Run the test system.
run()
run(<tests>)
run(<default-files>)
run(<default_files>, <tests>)
-> <parse-result>
This will:
- parse
process.argv - locate and run tests
- report basic stats
<tests> format:
{
setups: <stups>,
modifiers: <modifiers>,
tests: <tests>,
cases: <cases>,
}
Advanced components
runner(..)
The default test combinator and runner.
parser(..)
The default ig-argv parser setup.
Utilities
getCallerFilename()
Returns the filename of the module where getCallerFilename() is called.
License
Copyright (c) 2016-2020, Alex A. Naanou,
All rights reserved.