Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khezen/iotest
Javascript library to help with unit tests
https://github.com/khezen/iotest
chai library nodejs test
Last synced: 28 days ago
JSON representation
Javascript library to help with unit tests
- Host: GitHub
- URL: https://github.com/khezen/iotest
- Owner: khezen
- License: mit
- Created: 2017-02-27T15:30:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-14T18:29:02.000Z (almost 8 years ago)
- Last Synced: 2024-12-17T11:19:41.585Z (about 1 month ago)
- Topics: chai, library, nodejs, test
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.org/package/iotest)
# iotest
Javascript library which makes input/output testing a no-brainer.
# install
`npm install --save-dev iotest`
# example with mocha
```javascript
function f(x){
return x + 1;
}
```
Test cases are processed sequentially when testing multiple cases:
```javascript
const iotest = require('iotest');
describe('f', () => {
it('should pass i/o tests', (done) => {
const cases = [
{inputs: 41, return: 42},
{inputs: 0, return: 1}
];
iotest(cases, f).
then(outputs => {
console.log(outputs):
// => [42, 1]
done();
}).
reject(done);
});
});
```
Testing one case:
```javascript
const iotest = require('iotest');
describe('f', () => {
it('should pass i/o tests', (done) => {
const case = { inputs: 41, return: 42 };
iotest(case, f).
then(outputs => {
console.log(outputs):
// => [42]
done();
}).
reject(done);
});
});
```
# case
JSON object describing a test case.
## case.inputs
Given arguments of a function.
### single input
```javascript
function f(x){
return x + 1;
}
```
```javascript
const iotest = require('iotest');
const cases = [
{ inputs: 41, return: 42 }, // succeed
{ inputs: [41], return: 42 }, // succeed
];
iotest(cases, f).
then(outputs => { /* tests succeed */ }).
catch(err => { /* tests failed */ });
```
### multiple inputs
```javascript
function f(x, y){
return x + y;
}
```
```javascript
const iotest = require('iotest');
const case = { inputs: [10, 32], return: 42} // succeed
iotest(case, f).
then(outputs => { /* tests succeed */ }).
catch(err => { /* tests failed */ });
```
## case.return / case.error
Expected returned output of a function / Expected error thrown by a function.
```javascript
function f(x, y){
if(y === 0){
throw new Error("division by 0");
}
return x / y;
}
```
```javascript
const iotest = require('iotest');
const cases = [
{ inputs: [42, 0], error: {} }, // succeed
{ inputs: [42, 2], return: 21 }, // succeed
];
iotest(cases, f).
then(outputs => { /* tests succeed */ }).
catch(err => { /* tests failed */ });
```
## case.resolve / case.reject
Expected resolved value / Expected rejected error, of the promise returned by a function.
```javascript
function f(x, y){
return new Promise( (resolve, reject) => {
if(y === 0){
reject(new Error("division by 0"));
}else{
resolve(x / y);
}
});
}
```
```javascript
const iotest = require('iotest');
const cases = [
{ inputs: [42, 0], reject: {} }, // succeed
{ inputs: [42, 2], resolve: 21 }, // succeed
];
iotest(cases, f).
then(outputs => { /* tests succeed */ }).
catch(err => { /* tests failed */ });
```
## depth traversal
if `case.return`, `case.error`, `case.resolve` or `case.reject` is set with an *Object*, then it is deeply traversed to make sure each property exists with the right value in the `output`.
```javascript
function f(x){
return {
x: x,
y: x + 1
};
}
```
```javascript
const iotest = require('iotest');
const cases = [
{ inputs: 41, return: {x: 41} }, // succeed
{ inputs: 0, return: {y: 1} }, // succeed
{ inputs: 1000, return: {x: 1000, y: 1001} }, // succeed
{ inputs: 7, return: {} } // succeed
];
iotest(cases, f).
then(outputs => { /* tests succeed */ }).
catch(err => { /* tests failed */ });
```
if `case.return`, `case.error`, `case.resolve` or `case.reject` is set with an *Array*, then each item is deeply traversed.
```javascript
function f(x){
return [
{ x: x, y: x + 1 },
{ x: x, y: y - 1 }
];
}
```
```javascript
const iotest = require('iotest');
const case = {
inputs: 41,
return: [
{x: 41, y: 42},
{y: 40}
]
}; // succeed
iotest(case, f).
then(outputs => { /* tests succeed */ }).
catch(err => { /* tests failed */ });
```