Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lironhazan/qutilz
Opinionated specs gen for quick unit-tests setup including dependencies mocking
https://github.com/lironhazan/qutilz
jest mocking testing-tools typescript
Last synced: 3 months ago
JSON representation
Opinionated specs gen for quick unit-tests setup including dependencies mocking
- Host: GitHub
- URL: https://github.com/lironhazan/qutilz
- Owner: LironHazan
- License: mit
- Created: 2021-09-21T09:32:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-23T07:38:33.000Z (over 2 years ago)
- Last Synced: 2024-11-11T01:35:18.282Z (3 months ago)
- Topics: jest, mocking, testing-tools, typescript
- Language: TypeScript
- Homepage:
- Size: 523 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/qutilz)
CLI tool
for generating opinionated specs templates for a quick unit-tests setup.
Supports:
- Dependencies mocking with the [ts-mockito](https://github.com/NagRock/ts-mockito) mocking library.
Run
``npx qutilz --specs`` from a local folder to generate a new spec template for local class-based components/services
(Jest + ts-mockito) and for exported functions.
``npx qutilz --report`` from the local tests' folder to print a report of all existing suites/tests.
Resources: [background-blog-post](https://itnext.io/qutilz-for-a-quicker-unit-testing-development-55cc614c3964)
Examples:
- For class methods testing:
```ts
export class AAA {
constructor(private bbb: BBB) {}
applyGreet() {
this.bbb.greet();
}
}
export class BBB {
constructor() {}
greet() {
return 'hello!';
}
static help() {
return 'help!';
}
}
```
Qutilz will produce the following:
```ts
import { instance, mock, when } from 'ts-mockito';import { BBB } from './example-b';
describe('AAA', () => {
// Mocked dependencies:
const bbbMock = mock(BBB);
const bbbInstance = instance(bbbMock);
// Tested target:
const aAA = new AAA(bbbInstance);
it('instance is truthy', () => {
expect(aAA).toBeTruthy();
});
it('should test applyGreat', () => {
expect(aAA.applyGreat).toBeTruthy();
});
});
describe('BBB', () => {
const bBB = new BBB();
it('instance is truthy', () => {
expect(bBB).toBeTruthy();
});
it('should test greet', () => {
expect(bBB.greet).toBeTruthy();
});
it('should test help', () => {
expect(BBB.help).toBeTruthy();
});
});
```
- For any file containing function declarations
```ts
export function foo() {
return 'foo';
}
```
Qutilz will produce the following:
```ts
describe('Testing', () => {
it('should test foo', () => {
expect(foo).toBeTruthy();
});
});
```