Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pimm/bluster
Test both promises and callbacks in one go
https://github.com/pimm/bluster
async callback coverage javascript jest promise test
Last synced: 4 days ago
JSON representation
Test both promises and callbacks in one go
- Host: GitHub
- URL: https://github.com/pimm/bluster
- Owner: Pimm
- License: mit
- Created: 2019-08-20T11:06:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-13T08:54:25.000Z (over 1 year ago)
- Last Synced: 2024-11-09T17:45:28.974Z (5 days ago)
- Topics: async, callback, coverage, javascript, jest, promise, test
- Language: JavaScript
- Homepage:
- Size: 727 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme-nl.md
- License: copying.txt
Awesome Lists containing this project
README
# bluster · [](https://github.com/Pimm/bluster/blob/master/copying.txt) [](https://www.npmjs.com/package/bluster) [](https://github.com/Pimm/bluster/actions/workflows/test.yaml) [](https://coveralls.io/github/Pimm/bluster?branch=master)
Test promises én callbacks in één klap.
# Motivatie
Als jouw functie promise-achtig én continuation-passing-achtig kan worden aangeroepen, halveert `bluster` jouw tests.
Neem deze functie als voorbeeld:
```typescript
function getResource(name: string): Promise;
function getResource(name: string, callback: (error: Error, resource: Resource) => void): void;
```
(TypeScript types en overloading voor de duidelijkheid.)
Ontwikkelaars kunnen deze functie promise-achtig en continuation-passsing-achtig aanroepen (ofwel callback-achtig). Net wat zij prettig vinden en wat in het project past. Cool! Maar hoe zou je dit testen? `bluster` laat je beide aftakkingen testen voor de prijs van één.
# Met Jest
## Installatie
Installeer `jest-bluster` met npm of Yarn en voeg het toe aan je Jest-configuratie in package.json:
```json
{
…
"jest": {
"setupFilesAfterEnv": ["jest-bluster"]
},
…
}
```
## Gebruik
Wikkel je functie met `bluster`:
``` javascript
test('get-resource', () => {
return expect(
bluster(getResource)('example.gz')
).resolves.toMatchSnapshot();
});
```
Bovenstaande test faalt als:
* `const promise = getResource('example.gz')` ofwel `getResource('example.gz', callback)` een fout oplevert, of
* `const promise = getResource('example.gz')` en `getResource('example.gz', callback)` verschillende waarden opleveren, of
* de waarde die beide aftakkingen oplevert [niet overeenkomt met de snapshot][jest-snapshots].
Een slagende test bewijst dat de functie ‒ zowel wanneer deze promise-achtig als wanneer deze continuation-passing-achtig wordt aangeroepen ‒ correct werkt.
# Zonder Jest
## Installatie
Installeer `bluster` met npm of Yarn en importeer de functie in je tests:
```javascript
import bluster from 'bluster';
```
## Gebruik
Wikkel je functie met `bluster`:
```javascript
const resource = await bluster(getResource)('example.gz');
// Controleer hier of resource klopt.
```
Deze regel levert een fout op als:
* `const promise = getResource('example.gz')` ofwel `getResource('example.gz', callback)` een fout oplevert, of
* `const promise = getResource('example.gz')` en `getResource('example.gz', callback)` verschillende waarden opleveren.
Bij geen fout weet je zeker dat de functie hetzelfde werkt, onafhankelijk van of deze promise-achtig of continuation-passing-achtig wordt aangeroepen. Zoals altijd moet je nog controleren of de `resource` constante klopt.
# Licentie (X11/MIT)
Copyright (c) 2019, 2023 Pimm "de Chinchilla" Hogeling
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
**The Software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. in no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the Software.**
[jest-snapshots]: https://jestjs.io/docs/snapshot-testing