Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rahmatagungj/owntest
Simple JavaScript Testing Framework with only one file and zero dependencies.
https://github.com/rahmatagungj/owntest
javascript testing
Last synced: about 2 months ago
JSON representation
Simple JavaScript Testing Framework with only one file and zero dependencies.
- Host: GitHub
- URL: https://github.com/rahmatagungj/owntest
- Owner: rahmatagungj
- Created: 2022-02-18T13:50:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-03-16T06:16:39.000Z (over 2 years ago)
- Last Synced: 2024-07-06T07:43:21.061Z (2 months ago)
- Topics: javascript, testing
- Language: JavaScript
- Homepage: https://rahmatagungj.github.io/owntest
- Size: 427 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-made-by-indonesian - OwnTest - `Simple JavaScript Testing Framework with only one file and zero dependencies.` *by [Rahmat Agung Julians](https://github.com/rahmatagungj)* (O)
- made-in-indonesia - OwnTest - `Simple JavaScript Testing Framework with only one file and zero dependencies.` *by [Rahmat Agung Julians](https://github.com/rahmatagungj)* (O)
README
# OwnTest
Simple JavaScript Testing Framework with only single file, zero dependencies and zero configuration.
```bash
Usage:
owntest [options]
Options:
init : initialize ownTest
--test : run a single test file
-h | --help : show help
-v | --version : show version
```
## To Use
1. Initialize your ownTest project:
```bash
node owntest.js init
```
2. Create test file with format `name.test.js`
> You can put file in any folder but recommended on `__test__`.
3. Write test code in test file.
4. Run your test file:
- Run `owntest.js` to run all test.
- Run `owntest.js --test=name.test.js` to run single test.
## Example Usage
You can see all example in `example` folder or see [Owntest Example](https://github.com/rahmatagungj/owntest/tree/master/example).
## Configuration
You can configure your ownTest by following steps:
1. create `owntest.config.json` file in your project root folder.
2. edit `owntest.config.json` file as following:
- `"testPath": "__test__"` - path to test folder.
- `"testIgnore": ["node_modules"]` - list of folder to ignore.
- `"mode": "production"` - mode of your ownTest.
- `"autoUpdate": true | false` - auto update your ownTest.
3. run `owntest.js` to run all test.
## Setup and Teardown
OwnTest provides function to handle setup and teardown, you can use it in your test file for setup work that needs to happen before each test and teardown work that needs to happen after each test.
### Repeating Setup
```js
beforeEach(() => {
/** put your function or variable here */
});
afterEach(() => {
/** put your function or variable here */
});
```
### One-Time Setup
```js
beforeAll(() => {
/** put your function or variable here */
});
afterAll(() => {
/** put your function or variable here */
});
```
## Expect
Expect to give you access to a number of "matches" that will allow you to validate things, including several methods.
### Methods
All of the methods below can be used with a negation format like `not()`, example:
```js
// normal
expect(1).toBe(1);
// negation
expect(1).not().toBe(2);
```
- `expect(actual).toExist()`
Expects that the actual value is not `undefined` or `null`.
- `expect(actual).toBe(expected)`
Expects that the actual value is equal to the expected value.
- `expect(actual).toEqual(expected)`
Expects that the actual value is equal to the expected value.
- `expect(actual).toStrictEqual(expected)`
Expects that the actual value is strictly equal to the expected value.
- `expect(actual).toBeType(expected)`
Expects that the actual value is of the same type as the expected value.
- `expect(actual).toBeTruthy()`
Expects that the actual value is truthy.
- `expect(actual).toBeFalsy()`
Expects that the actual value is falsy.
- `expect(actual).toBeGreaterThan(expected)`
Expects that the actual value is greater than the expected value.
- `expect(actual).toBeLessThan(expected)`
Expects that the actual value is less than the expected value.
- `expect(actual).toBeCloseTo(expected)`
Expects that the actual value is close to the expected value.
- `expect(actual).toBeInstanceOf(expected)`
Expects that the actual value is an instance of the expected value.
- `expect(actual).toBeOneOf(expected)`
Expects that the actual value is one of the expected values.
- `expect(actual).toBeBetween(expected, expected)`
Expects that the actual value is between the expected values.
- `expect(actual).toBeLessThanOrEqual(expected)`
Expects that the actual value is less than or equal to the expected value.
- `expect(actual).toBeGreaterThanOrEqual(expected)`
Expects that the actual value is greater than or equal to the expected value.
- `expect(actual).toThrowError()`
Expects that the actual value throws an error.
- `expect(actual).toBeNull()`
Expects that the actual value is `null`.
- `expect(actual).toBeUndefined()`
Expects that the actual value is `undefined`.
- `expect(actual).toBeNaN()`
Expects that the actual value is `NaN`.
- `expect(actual).toBeDefined()`
Expects that the actual value is defined.
- `expect(actual).toBeFinite()`
Expects that the actual value is `finite`.
- `expect(actual).toBePositive()`
Expects that the actual value is `positive`.
- `expect(actual).toBeNegative()`
Expects that the actual value is `negative`.
- `expect(actual).toBeZero()`
Expects that the actual value is `zero`.
- `expect(actual).toBeGreaterThanZero()`
Expects that the actual value is `greater than zero`.
- `expect(actual).toBeLessThanZero()`
Expects that the actual value is `less than zero`.
- `expect(actual).toBePositiveInfinity()`
Expects that the actual value is `positive infinity`.
- `expect(actual).toBeNegativeInfinity()`
Expects that the actual value is `negative infinity`.
- `expect(actual).toContain(expected)`
Expects that the actual value contains the expected value.
- `expect(actual).toThrow(expected)`
Expects that the actual value throws the expected value.
- `expect(actual).toHaveReturned(expected)`
Expects that the actual value has returned the expected value.
- `expect(actual).toHaveReturnedWith(expected)`
Expects that the actual value has returned the expected value.
- `expect(actual).toHaveLastReturnedWith(expected)`
Expects that the actual value has last returned the expected value.
- `expect(actual).toHaveLength(expected)`
Expects that the actual value has the expected length.
- `expect(actual).stringMatch(expected)`
Expects that the actual value matches the expected value.