vitest-environment-drizzle

Vitest testing module for drizzle push and teardown scripts. See ⚡️ Vitest Environment for more details.

Actions

Setup

Environment runs drizzle-kit push:{dialect} in your application to bootstrap test database.

:warning: Be aware that this can update your production database if you are not carefull. Use this only on development and always check your .env credentials

Teardown

Environment will drop your test database depending on your adapter

Adapters

Databases supported by now:

• mysql

Setup Environment

Example:

vite.config.ts

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    environment: 'drizzle', // Required
    environmentOptions: {
      adapter: 'mysql',
      envFile: '.env.test',
      databaseEnvName: 'DATABASE_URL'  // Optional
    }
  }
})

Environment Options

| Name | Description | Default | |:-----------------|:---------------------------------------------------------------|:---------------| | adapter | Name database adapter. See Adapters | mysql | | envFile | Name of the .env file for test suit | .env.test | | schemaPrefix | Prefix to attach on the database name | | | databaseEnvName | The environment variable used to store connection URL | DATABASE_URL |

Database Credentials

The following keys must be present on your .env.test file:

| Name | Description | Example | |:----------------|:----------------------------------|:-------------------------| | DATABASE_USER | Database user credential | root | | DATABASE_PASS | Database user password credential | root | | DATABASE_HOST | Database connection host | localhost, 127.0.0.1 | | DATABASE_PORT | Database connection port | 3306 | | DATABASE_NAME | Database name | mydb |