Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suites-dev/suites
A meta-framework that focuses on helping developers build solid test suites, eliminates boilerplate code, and improves their unit testing process
https://github.com/suites-dev/suites
dependency-injection inversifyjs jest mock mocking nestjs sinon spec tdd testing typescript unit-test unit-testing
Last synced: about 2 months ago
JSON representation
A meta-framework that focuses on helping developers build solid test suites, eliminates boilerplate code, and improves their unit testing process
- Host: GitHub
- URL: https://github.com/suites-dev/suites
- Owner: suites-dev
- License: apache-2.0
- Created: 2021-11-18T15:13:37.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-27T17:11:57.000Z (about 2 months ago)
- Last Synced: 2024-07-29T11:37:03.211Z (about 2 months ago)
- Topics: dependency-injection, inversifyjs, jest, mock, mocking, nestjs, sinon, spec, tdd, testing, typescript, unit-test, unit-testing
- Language: TypeScript
- Homepage: https://suites.dev
- Size: 1.66 MB
- Stars: 334
- Watchers: 5
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Suites (formerly Automock)
Suites is an opinionated, flexible testing meta-framework aim at elevating the software testing experience within
backend systems. By integrating a wide array of testing tools into a cohesive framework, Suites simplifies the process
of creating reliable tests, thereby ensuring the development of high-quality software.
[](https://codecov.io/gh/suites-dev/suites)
[](https://github.com/suites-dev/suites/actions)
[](https://lerna.js.org/)
[](https://npmjs.org/package/@suites/unit "View this project on npm")
[↗️ Visit Documentation](https://suites.dev/docs) [↗️ API Reference](https://suites.dev/api-reference)
## Automock has been rebranded to Suites 🎉
**We are excited to announce that Automock has been rebranded to Suites**!
This change reflects our commitment to providing a comprehensive testing solution that caters to a broader range of
testing scenarios. The core features and functionality of the framework remain the same, but with a new name and a fresh
look.
[↗️ Change Log](https://suites.dev/docs/overview/migrating-from-automock)
## Core Features
🚀 **Zero-Setup Mocking** - Automatically generate mock objects, eliminate manual setup, reduce boilerplate code.
🔍 **Type-Safe Mocks** - Leverage TypeScript's power with mocks that retain the same type as real objects.
📄 **Consistent Tests Structure** - Test suites will follow a consistent syntax and structure, making them easier to
read and maintain.
📈 **Optimized Performance** - By bypassing the actual DI container, unit tests run significantly faster.
🌐 **Community & Support** - Join a growing community of developers.
## :computer: Quick Example
Suites suggest an alternative approach to writing unit tests for classes instead of using the traditional mocking
libraries and dependency injection frameworks.
Take a look at the following example:
Consider the following `UserService` and `Database` classes:
```typescript
export class Database {
async getUsers(): Promise { ... }
}
export class UserService {
constructor(private database: Database) {}
async getAllUsers(): Promise {
return this.database.getUsers();
}
}
```
Let's create a unit test for this class:
```typescript
import { TestBed, Mocked } from '@suites/unit';
import { Database, UserService } from './user.service';
describe('User Service Unit Spec', () => {
let userService: UserService; // 🧪 Declare the unit under test
let database: Mocked; // 🎭 Declare a mocked dependency
beforeAll(async () => {
// 🚀 Create an isolated test env for the unit (under test) + auto generated mock objects
const { unit, unitRef } = await TestBed.solitary(UserService).compile();
userService = unit;
// 🔍 Retreive a dependency (mock) from the unit reference
database = unitRef.get(Database);
});
// ✅ Test test test
test('should return users from the database', async () => {
const mockUsers: User[] = [{ id: 1, name: 'John' }, { id: 2, name: 'Jane' }];
database.getUsers.mockResolvedValue(mockUsers);
const users = await userService.getAllUsers();
expect(database.getUsers).toHaveBeenCalled();
expect(users).toEqual(mockUsers);
});
});
```
With the use of the `TestBed`, an instance of the `UserService` class can be created with mock objects automatically
generated for its dependencies. During the test, we have direct access to the automatically generated mock object for
the `Database` dependency (database).
↗️ For more comprehensive examples
## :package: Installation
First, install Suites' core package:
```bash
$ npm i -D @suites/unit
```
Then, to fully integrate Suites into your mocking and dependency injection frameworks, install the corresponding
adapters for your project. For example, to use Suites with Jest and NestJS you would run (alongside the core package):
```bash
$ npm i -D @suites/doubles.jest @suites/di.nestjs
````
Suites will automatically detect the installed adapters and configure itself accordingly.
### Supported DI Frameworks
| DI Framework | Package Name |
|--------------|------------------------|
| NestJS | `@suites/di.nestjs` |
| Inversify | `@suites/di.inversify` |
| TSyringe | Soon! |
### Supported Mocking Libraries
| DI Framework | Package Name |
|--------------|--------------------------|
| Jest | `@suites/doubles.jest` |
| Sinon | `@suites/doubles.sinon` |
| Vitest | `@suites/doubles.vitest` |
| Bun | Soon! |
| Deno | Soon! |
## :scroll: License
Distributed under the Apache (Apache-2.0) License. See `LICENSE` for more information.