Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bjoern-hempel/js-testing-framework
This is a small testing framework to make test driven development and unit testing easy.
https://github.com/bjoern-hempel/js-testing-framework
javascript test-driven-development unit-testing
Last synced: about 1 month ago
JSON representation
This is a small testing framework to make test driven development and unit testing easy.
- Host: GitHub
- URL: https://github.com/bjoern-hempel/js-testing-framework
- Owner: bjoern-hempel
- License: mit
- Created: 2018-06-03T23:17:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-01T14:48:44.000Z (over 6 years ago)
- Last Synced: 2024-11-07T03:44:22.444Z (3 months ago)
- Topics: javascript, test-driven-development, unit-testing
- Language: JavaScript
- Size: 39.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# A Javascript testing framework
This is a small testing framework to make test driven development and unit testing easy.
## 0. Introduction
### 0.1 Add this library as git submodule
```bash
user$ cd /your/root/project/path
user$ git submodule add https://github.com/bjoern-hempel/js-testing-framework.git vendor/js-testing-framework
user$ git commit -m "add the js-testing-framework library as submodule" .gitmodules vendor/js-testing-framework
user$ git push
```
### 0.2 Update submodule to the latest master version
```bash
user$ cd /your/root/project/path
user$ cd vendor/js-testing-framework
user$ git pull origin master
user$ cd ../..
user$ git add vendor/js-testing-framework
user$ git commit -m "update the js-testing-framework library submodule" vendor/js-testing-framework
user$ git push
```
## 1. Usage - Basic Examples
### 1.1 Set options (optional)
```javascript
JsTest.setOptions({
outputConsole: true,
outputDocument: true,
outputId: 'test-output',
outputEntryStyle: {
fontSize: '10px',
fontStyle: 'italic',
margin: 0
},
outputSectionStyle: {
border: '1px solid grey',
padding: '10px',
margin: '10px',
backgroundColor: '#f0f0f0'
}
});
```
### 1.2 Basic Test Example
```javascript
var test = new JsSuccessTest([
'check 1 + 2',
new JsTestTestFunction(function () {
var sum = 1 + 2;
return JsTest.equalInteger(sum, 3);
})
]);
JsTest.startTests('Simple tests.', test);
```
The test returns:
```javascript
──────────────────────────
Start test "Simple tests."
──────────────────────────
1) Running success test "check 1 + 2" .
→ Test succeeded (0.1 ms).
──────────────────────────────────────────────────────────────
RESULT
-> All test succeeded (0.7 ms) [success: 1; error: 0; all: 1].
──────────────────────────────────────────────────────────────
```
### 1.3 Multiple Test Example
```javascript
var tests = [
new JsSuccessTest(
'check 1 + 2',
new JsTestTestFunction(function () {
var sum = 1 + 2;
return JsTest.equalInteger(sum, 3);
})
),
new JsSuccessTest(
'check 10 - 2',
new JsTestTestFunction(function () {
var difference = 10 - 2;
return JsTest.equalInteger(difference, 8);
})
)
];
JsTest.startTests('Simple tests.', tests);
```
The test returns:
```javascript
──────────────────────────
Start test "Simple tests."
──────────────────────────
1) Running success test "check 1 + 2" .
→ Test succeeded (0.1 ms).
2) Running success test "check 10 - 2" .
→ Test succeeded (0.1 ms).
────────────────────────────────────────────────────────────
RESULT
-> All test succeeded (1 ms) [success: 2; error: 0; all: 2].
────────────────────────────────────────────────────────────
```
### 1.4 Error Test Example
Use the error test (JsErrorTest) if you expect an exception as a test result:
```javascript
var test = new JsErrorTest(
'check 1 + 2',
100,
new JsTestTestFunction(function () {
var sum = 1 + 2;
throw new Error('100 - Simple Error test');
return JsTest.equalInteger(sum, 3);
})
);
JsTest.startTests('Simple error test.', test);
```
The test returns
```javascript
───────────────────────────────
Start test "Simple error test."
───────────────────────────────
1) Running error test "check 1 + 2" (Code: 100).
→ Test succeeded (6 ms).
──────────────────────────────────────────────────────────────
RESULT
-> All test succeeded (6.8 ms) [success: 1; error: 0; all: 1].
──────────────────────────────────────────────────────────────
```
### 1.5 Summary of all tests within a function
Use a function container to summerize all tests within a function instead of a JsTest Array:
```javascript
var tests = function() {
new JsSuccessTest(
'check 1 + 2',
new JsTestTestFunction(function () {
var sum = 1 + 2;
return JsTest.equalInteger(sum, 3);
})
);
new JsSuccessTest(
'check 10 - 2',
new JsTestTestFunction(function () {
var difference = 10 - 2;
return JsTest.equalInteger(difference, 8);
})
);
};
JsTest.startTests('Simple tests.', tests);
```
The test returns:
```javascript
──────────────────────────
Start test "Simple tests."
──────────────────────────
1) Running success test "check 1 + 2" .
→ Test succeeded (0.1 ms).
2) Running success test "check 10 - 2" .
→ Test succeeded (0 ms).
──────────────────────────────────────────────────────────────
RESULT
-> All test succeeded (1.5 ms) [success: 2; error: 0; all: 2].
──────────────────────────────────────────────────────────────
```
### 1.6 Use your own exception class
```javascript
/**
* Own js test exception class.
*/
class MyOwnException {
constructor(code, message) {
this.code = code;
this.message = message;
}
}
/**
* Test function
*/
var test = new JsErrorTest(
new MyOwnException(100, 'check 10 - 11'),
new JsTestTestFunction(function () {
var minuend = 10;
var subtrahend = 11;
if (subtrahend > minuend) {
throw new MyOwnException(100, 'The subtrahend is bigger than the minuend.');
}
var difference = minuend - subtrahend;
return JsTest.equalInteger(difference, 8);
})
);
JsTest.startTests('Simple tests.', test);
```
The test returns:
```javascript
──────────────────────────
Start test "Simple tests."
──────────────────────────
1) Running error test "check 10 - 11" (Code: 100).
→ Test succeeded: "The subtrahend is bigger than the minuend." (0.1 ms).
──────────────────────────────────────────────────────────────
RESULT
-> All test succeeded (0.8 ms) [success: 1; error: 0; all: 1].
──────────────────────────────────────────────────────────────
```
### 1.7 Test different properties
```javascript
var test = new JsSuccessTest([
'vector add test',
new JsTestTestFunction(function () {
var vector1 = [1, 2];
var vector2 = [2, 3];
var addedVector = vector1.map(function (value, index) {
return value + vector2[index];
});
return (
JsTest.equalInteger(addedVector.length, 2) &&
JsTest.equalArrayValues(addedVector, [3, 5])
);
})
]);
JsTest.startTests('Simple tests.', test);
```
The test returns:
```javascript
──────────────────────────
Start test "Simple tests."
──────────────────────────
1) Running success test "vector add test" .
→ Test succeeded (3 ms).
──────────────────────────────────────────────────────────────
RESULT
-> All test succeeded (4.1 ms) [success: 1; error: 0; all: 1].
──────────────────────────────────────────────────────────────
```
#### 1.7.1 If one property check fails
```javascript
var test = new JsSuccessTest([
'vector add test',
new JsTestTestFunction(function () {
var vector1 = [1, 2];
var vector2 = [2, 3];
var addedVector = vector1.map(function (value, index) {
return value + vector2[index];
});
return (
JsTest.equalInteger(addedVector.length, 2) &&
JsTest.equalArrayValues(addedVector, [3, 6])
);
})
]);
JsTest.startTests('Simple tests.', test);
```
The test returns:
```javascript
──────────────────────────
Start test "Simple tests."
──────────────────────────
1) Running success test "vector add test" .
The 1. equalArrayValues test failed.
→ Test failed (0.6 ms).
─────────────────────────────────────────
RESULT
-> At least on test failed (1.6 ms) [1/1]
─────────────────────────────────────────
```
## A. Authors
* Björn Hempel - _Initial work_ - [https://github.com/bjoern-hempel](https://github.com/bjoern-hempel)
## B. Licence
This tutorial is licensed under the MIT License - see the [LICENSE.md](/LICENSE.md) file for details