Skip to content

ChocPanda/ava-env

Repository files navigation

AVA-ENV

Quick and dirty boilerplate to set and reset process.env variables when running tests in ava

Contents

Installation

  • Install using yarn: yarn add ava ava-env -D
  • Install using npm: npm install ava ava-env --dev

Usage

The tests should be run serially to ensure they aren't run on parallel processes or concurrently (as may be the case asynchronous tests) which could cause them to share a process.env.

Using ava-env means the process.env will be cleaned up after each test and returned to the state before the test started, meaning the process can be recycled for the next test without carrying over any global state/shared environment variables

const test = require('ava-env')(require('ava'));

test.serial('My test', t => {
	t.is(process.env.testEnvVar, undefined) // Not required...
	t.context.env({ testEnvVar: 'testValue' });

	// ... test code that requires environment variable to be set

	t.is(process.env.testEnvVar, 'testValue');
});

test.serial('My other test', t => {
	t.is(process.env.testEnvVar, undefined) // Not required...
	t.context.env({ testEnvVar: 'different test value' });

	// ... test code that requires environment variable to be set

	t.is(process.env.testEnvVar, 'different test value');
})