Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erickwendel/recreating-nodejs-test-runner
An crazy experiment recreating the Node.js test runner (with no libraries) using the same componentes of the original project
https://github.com/erickwendel/recreating-nodejs-test-runner
asynchooks asynclocalstorage docker javascript node-test-runner nodejs test test-runner
Last synced: about 1 month ago
JSON representation
An crazy experiment recreating the Node.js test runner (with no libraries) using the same componentes of the original project
- Host: GitHub
- URL: https://github.com/erickwendel/recreating-nodejs-test-runner
- Owner: ErickWendel
- Created: 2024-06-08T11:40:33.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-10T12:30:52.000Z (7 months ago)
- Last Synced: 2024-06-11T12:25:55.702Z (6 months ago)
- Topics: asynchooks, asynclocalstorage, docker, javascript, node-test-runner, nodejs, test, test-runner
- Language: JavaScript
- Homepage: https://erickwendel.github.io/recreating-nodejs-test-runner/
- Size: 639 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js Custom Test Runner Experiment
[](https://github.com/ErickWendel/recreating-nodejs-test-runner/actions)
## Introduction
This project is an experiment where I recreate the Node.js test runner using the same components. The primary goal is to understand and demonstrate the functionality of the test runner using:
- Parallelism with Child Processes
- AsyncHooks and Async LocalStorage for tracking the origin and retrieving the entire tree of tests.
- Testing API with hooks such as `describe`, `it`, `before`, `after`, `beforeEach`, `afterEach`
## Project Structure
- **[app](./app/)**: Contains a complete project which is an API with a comprehensive test suite. This suite tests each individual route and uses the custom test runner to prove the experiment's functionality.
## Test Runner Components
This custom test runner follows all the steps a test runner needs to have:
- **Executor**: Located at [./test-runner/bin/test-runner.js](./test-runner/bin/test-runner.js)
- **Formatter**: Located at [./test-runner/bin/reporter.js](./test-runner/bin/reporter.js)
- **JS API for Hooks**: Located at [./test-runner/module/testRunner.js](./test-runner/module/testRunner.js)
### Role of AsyncHooks
`AsyncHooks` are crucial for this project as they allow tracking the origin and retrieving the entire tree of tests. This helps in understanding which `describe` block all hooks belong to. Using `AsyncHooks`, the context of asynchronous operations is maintained, ensuring that hooks like `before`, `after`, `beforeEach`, and `afterEach` are correctly associated with their respective test cases.
## Getting Started
### Prerequisites
Ensure you have the following installed:
- Node.js (>=20.14)
- Docker and docker-compose (for executing [./app](./app/))
### Installation
```sh
git clone https://github.com/ErickWendel/recreating-nodejs-test-runner.git
```
## Complete app
```sh
cd recreating-nodejs-test-runner/app
docker-compose up -d
npm test
```
## Test runner Example
Clone the repository and install the dependencies:
```sh
cd recreating-nodejs-test-runner/test-runner
npm test
```
## Try at home!
See at [the example](./test-runner/tests/example.test.js) and execute one of your applications there :)
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any changes or improvements.
## License
This project is licensed under the MIT License.
---
## Todo
- add feature so before and beforeEach executes inside sub suites
- fix log