Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aiji42/vitest-environment-vprisma
Vitest environment for testing with prisma.
https://github.com/aiji42/vitest-environment-vprisma
Last synced: 1 day ago
JSON representation
Vitest environment for testing with prisma.
- Host: GitHub
- URL: https://github.com/aiji42/vitest-environment-vprisma
- Owner: aiji42
- License: mit
- Created: 2022-11-18T13:56:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-08T01:33:17.000Z (about 1 year ago)
- Last Synced: 2024-12-18T04:08:18.161Z (9 days ago)
- Language: TypeScript
- Size: 240 KB
- Stars: 75
- Watchers: 1
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/aiji42/vitest-environment-vprisma/actions/workflows/release.yml)
[](https://badge.fury.io/js/vitest-environment-vprisma)
# vitest-environment-vprisma
This library improves the experience of testing with vitest and @prisma/client. It allows you to isolate each test case with a transaction and rollback after completion, giving you a safe and clean testing environment.
## Install
```bash
$ npm install -D vitest-environment-vprisma
```
## Setup
```ts
// vitest.config.ts
import { defineConfig } from "vite";
export default defineConfig({
test: {
globals: true, // Don't forget!
environment: "vprisma",
setupFiles: ["vitest-environment-vprisma/setup"]
},
});
```
```ts
// tsconfig.json
{
"compilerOptions": {
"types": ["vitest/globals", "vitest-environment-vprisma"]
}
}
```
## How to use
If you are using an instance of `PrismaClient` in your test file to issue queries, use `vPrisma.client` instead. If setup is correct, it will be provided as a global object.
```ts
// example.test.ts
// Use `vPrisma.client` instead of `const prisma = new PrismaClient()`.
const prisma = vPrisma.client;
test("Add user", async () => {
const createdUser = await prisma.user.create({
data: {
nickname: "user1",
email: "[email protected]",
},
});
expect(
await prisma.user.findFirst({
where: {
id: createdUser.id,
},
})
).toStrictEqual(createdUser);
expect(await prisma.user.count()).toBe(1);
});
// Each test case is isolated in a transaction and also rolled back, so it is not affected by another test result.
test("Count user", async () => {
expect(await prisma.user.count()).toBe(0);
});
```
Please check [this sample](https://github.com/aiji42/vitest-environment-vprisma/blob/main/example/src/__tests__/prisma.test.ts).
### Singleton
If you are using an instance of `PrismaClient` as a singleton, such as:
```ts
// libs/client.ts
import { PrismaClient } from "@prisma/client";
export const client = new PrismaClient();
```
```ts
// libs/user.ts
import { client } from "./client";
export const createUser = (nickname: string, email: string) => {
return client.user.create({
data: {
nickname,
email,
},
});
};
```
It is easier to test if it is mocked up in the vitest setup file.
```ts
// vitest.config.ts
import { defineConfig } from "vite";
export default defineConfig({
test: {
globals: true,
environment: "vprisma",
setupFiles: ["vitest-environment-vprisma/setup", "vitest.setup.ts"] // add vitest.setup.ts
},
});
```
```ts
// vitest.setup.ts
import { vi } from "vitest";
vi.mock("./libs/client", () => ({
client: vPrisma.client,
}));
```
## Options
It is possible to pass option values using `environmentOptions`. This affects the entire test.
```ts
// vitest.config.ts
import { defineConfig } from "vite";
export default defineConfig({
test: {
globals: true,
environment: "vprisma",
setupFiles: ["vitest-environment-vprisma/setup"],
environmentOptions: {
vprisma: {
// Selectable a base environment "node" | "jsdom" | "happy-dom" | "edge-runtime" (default: "node")
baseEnv: "jsdom",
// Display the query in the log. (default: false)
verboseQuery: true,
// Commit without rolling back the transaction. (default: false)
disableRollback: true,
// Override the database connection URL. (default: process.env.DATABASE_URL)
databaseUrl: "postgresql://postgres:password@localhost:5432/test?schema=public"
}
},
},
});
```
It is also possible to specify these option values for each test file.
Use the format `// @vitest-environment-options { "key": "value" }`. Option values are in JSON format.
```ts
// example.test.ts
// @vitest-environment-options { "verboseQuery": true }
test("Add user", async () => {
/* ... */
});
```
Note that any `environmentOptions` set in `vitest.config.ts` will be overwritten.
## Tips
### hooks (beforeEach and beforeAll)
You cannot use vPrisma.client within a top-level `beforeEach`. This is because it is executed before the `vPrisma` initialization is complete.
If you want to use `beforeEach` to perform data preparation or other operations, please write them within `describe`.
```ts
const prisma = vPrisma.client;
beforeEach(async () => {
// ❌ vPrisma.client is not available for top-level beforeEach.
});
describe(" ... ", () => {
beforeEach(async () => {
// ✅ You can use vPrisma.client.
await prisma.user.create({
data: {
nickname: "userX",
email: "[email protected]",
},
});
});
test(" ... ", () => {
/* ... */
});
});
```
Unfortunately, it is not possible to use `vPrisma.client` within `beforeAll` (either at the top level or within `describe`).
This is because the transaction is initiated in `beforeEach` and rolled back in `afterEach`. `beforeAll` is executed outside of its life cycle.
## Acknowledgments
This library is based on [`@quramy/jest-prisma`](https://github.com/Quramy/jest-prisma). We would like to express our great appreciation to [`@quramy/jest-prisma`](https://github.com/Quramy/jest-prisma)'s owner, [@Quramy](https://github.com/Quramy), and contributors.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/aiji42/vitest-environment-vprisma/blob/main/LICENSE) file for details