@lowerdeck/testing-tools

Opinionated testing utilities for Vitest configuration, environment loading, Prisma test databases, factories, and HTTP helpers.

Installation

npm install @lowerdeck/testing-tools

yarn add @lowerdeck/testing-tools

bun add @lowerdeck/testing-tools

pnpm add @lowerdeck/testing-tools

Usage

Vitest config

import { createVitestConfig, loadTestEnv, withAliases } from '@lowerdeck/testing-tools';
// In CI, run Vitest with `--mode ci` to load `.env.ci` via loadTestEnv.

loadTestEnv();

const config = withAliases(createVitestConfig(), { '@': './src' });

export default config;

Prisma test database helpers

Use setupPrismaTestDb in setupFiles (runs before the Vitest runner), and withTestDb inside test files when you want hook-based cleanup.

// vitest.setup.ts (setupFiles)
import { setupPrismaTestDb } from '@lowerdeck/testing-tools';
import { PrismaClient } from '@prisma/client';

const db = await setupPrismaTestDb({
  prismaClientFactory: url => new PrismaClient({ datasourceUrl: url }),
  guard: 'test'
});

export const testDb = db.client;
export const cleanDatabase = db.clean;

Call db.disconnect() in an afterAll hook when the test process shuts down.

// inside a test file usage
import { withTestDb } from '@lowerdeck/testing-tools';
import { PrismaClient } from '@prisma/client';

const { client } = withTestDb({
  prismaClientFactory: url => new PrismaClient({ datasourceUrl: url }),
  guard: 'test',
  cleanBeforeEach: true
});

Factories

import { defineFactory } from '@lowerdeck/testing-tools';

type User = { name: string; email: string };

const userFactory = defineFactory<User>(
  () => ({ name: 'Ada', email: '[email protected]' }),
  {
    persist: async user => user
  }
);

HTTP test helpers

import { createTestServer } from '@lowerdeck/testing-tools';

const server = createTestServer({
  request: async path => new Response(`ok:${path}`)
});

await server.get('/health');

License

This project is licensed under the Apache License 2.0.