mirror of
https://github.com/flynx/test.js.git
synced 2026-06-16 08:49:25 +00:00
...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
340d1ee867
commit
0c7d836857
14
README.md
14
README.md
@ -9,6 +9,8 @@ of a specific approach to testing, i.e. _combinational testing_
|
||||
Note, **this module is experimental** and can change quite allot within a short to mid
|
||||
time frame, use at your own risk, though ideas, feedback and suggestions are welcome.
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- Simple / minimalist implementation
|
||||
@ -23,6 +25,7 @@ time frame, use at your own risk, though ideas, feedback and suggestions are wel
|
||||
-
|
||||
|
||||
|
||||
|
||||
## Contents
|
||||
- [test.js](#testjs)
|
||||
- [Features](#features)
|
||||
@ -64,6 +67,7 @@ time frame, use at your own risk, though ideas, feedback and suggestions are wel
|
||||
- [License](#license)
|
||||
|
||||
|
||||
|
||||
## Architecture
|
||||
|
||||
This package implements two testing schemes:
|
||||
@ -87,7 +91,7 @@ The system builds chains in the form:
|
||||
setup -> modifier* -> test
|
||||
```
|
||||
|
||||
Where `modifier` can me either single or a chain of modifiers.
|
||||
Where `modifier` is optional and can be a chain of zero or more modifiers.
|
||||
|
||||
A `setup` and `modifier` can also include assertions/tests for direct testing and
|
||||
sanity checks.
|
||||
@ -107,6 +111,7 @@ This makes it simple to define procedural/generative tests.
|
||||
This is the traditional self-contained test approach.
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
```shell_session
|
||||
@ -119,6 +124,7 @@ $ npm install -g ig-test
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Basic usage
|
||||
|
||||
Create a test script
|
||||
@ -246,6 +252,7 @@ XXX chains
|
||||
XXX notes on coverage
|
||||
|
||||
|
||||
|
||||
## Components
|
||||
|
||||
### `DEFAULT_TEST_FILES`
|
||||
@ -496,6 +503,7 @@ This will:
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Advanced components
|
||||
|
||||
### `runner(..)`
|
||||
@ -508,12 +516,16 @@ The default test combinator and runner.
|
||||
The default [`ig-argv`][ig-argv] parser setup.
|
||||
|
||||
|
||||
|
||||
## Utilities
|
||||
|
||||
### `getCallerFilename()`
|
||||
|
||||
Returns the filename of the module where `getCallerFilename()` is called.
|
||||
|
||||
- Multiple modifier chaining
|
||||
|
||||
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user