Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmsa/bleed-guard
A collection of test reporters dedicated ot helping track, and stop, test bleed.
https://github.com/jmsa/bleed-guard
bleed jest reporter test
Last synced: 15 days ago
JSON representation
A collection of test reporters dedicated ot helping track, and stop, test bleed.
- Host: GitHub
- URL: https://github.com/jmsa/bleed-guard
- Owner: Jmsa
- License: mit
- Created: 2024-09-11T03:55:04.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T18:55:50.000Z (about 1 month ago)
- Last Synced: 2024-10-04T18:40:11.515Z (about 1 month ago)
- Topics: bleed, jest, reporter, test
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/bleed-guard
- Size: 334 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Bleed Guard
[](https://badge.fury.io/js/bleed-guard) 
[](https://codeclimate.com/github/Jmsa/bleed-guard/maintainability) [](https://codeclimate.com/github/Jmsa/bleed-guard/test_coverage)
**Bleed Guard** is a set of test reporters designed to help ensure clean test environments across various testing frameworks. It tracks potential issues like leftover DOM content, global window pollution, and incomplete network requests, making sure your tests are isolated and reliable.
*Note: some test runners, like Jest, already have options like `resetMocks` and `resetModules` which do a great job at isolating tests and cleaning up. If that's all you're after you probably don't need these reporters. If on the otherhand you want to find and tix those places where you have bleed, either in your tests or your source, then read on.*
## Features
- **Framework Support**
Bleed Guard supports popular testing frameworks like:
- [Jest](https://jestjs.io/)
- [Vitest](https://vitest.dev/)
- **Issue Tracking**
Each reporter can track and report the following issues:
- **DOM Cleanup**: Detects if any DOM elements were left behind after tests run.
- **Global State Changes**: Ensures no changes persist in the global `window` object that might bleed into subsequent tests.
- **(WIP) Incomplete Network Requests**: Identifies if there are any ongoing or incomplete network requests when a test completes.
## Installation
| NPM | Yarn |
| ----------------------------------------- | -------------------------------------- |
| `npm install -D bleed-guard` | `yarn add -D bleed-guard` |
## Usage
Simply add the relevant Bleed Guard reporter to your test configuration and call the `setup` method from the reporter once you have a test environment. Below are some examples:
### Jest
In your `jest.config.js`:
```js
module.exports = {
testEnvironment: 'jsdom', // A browser-like environment is required if you want to enable dom checking
reporters: [
'default',
['bleed-guard/jest', {
domCheck: true,
globalWindowCheck: true,
shouldThrow: false
}]
],
setupFilesAfterEnv: ["./examples/jest/setup"] // Your setup file which will call the setup() from the reporter
};
```
Then in a test setup file where you have access to the environment before tests start running, usually provided via `setupFilesAfterEnv`:
```js
require("bleed-guard/reporters/jest/jest").setup(beforeAll, afterEach, afterAll);
```
An example of this setup can be seen in [`examples/jest`](https://github.com/Jmsa/bleed-guard/tree/main/examples/);
### Vitest
In your `vitest.config.js`:
```js
import { defineConfig } from 'vitest/config';
import BleedReporter from './../../reporters/vitest/vitest';
export default defineConfig({
test: {
environment: "jsdom", // A browser-like environment is required if you want to enable dom checking
reporters: ['default', new BleedReporter()],
setupFiles: ["./examples/vitest/setup"] // Your setup file which will call the setup() from the reporter
},
})
```
Then in a test setup file where you have access to the environment before tests start running:
```js
require("bleed-guard/reporters/vitest/vitest").setup(beforeAll, afterEach, afterAll);
```
An example of this setup can be seen in [`examples/vitest`](https://github.com/Jmsa/bleed-guard/tree/main/examples/);
## Reporter Options
Each reporter is a wrapper around more generic detection options you can customize to fit your testing setup. For example:
```typescript
interface DetectionOptions {
domCheck?: boolean;
globalWindowCheck?: boolean;
shouldThrow?: boolean;
logLevel?: LogLevel; // "none" | "info" | "verbose"
library?: "Jest" | "Vitest";
}
```
| Option | Default | Usage |
| --- | --- | --- |
| domCheck | true | Enables or disables tracking of leftover DOM elements |
| globalWindowCheck | true | Monitors changes in the global window object |
| shouldThrow | false | Will throw an error if any bleed is detected. |
| logLevel | "info" | Determines how much output will be logged to the console from the reporter. |
| Library | "" | Used to include the reporter name while logging. |
## Contributing
First off, thank you for considering contributing. We are always happy to accept contributions and will do our best to ensure they receive the appropriate feedback.
Things to know:
- Commits are required to follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/).
- There is no planned/automated cadence for releases. Because of this once changes are merged they will be manually published, at least for the time being.
## License
Bleed Guard is licensed under the MIT License. See the LICENSE file for details.