Testing

Test a workflow before deployment so waits, retries, and code changes do not surprise you in production. Check the function's decisions and the paths that resume after a pause or failure.

Test the smallest useful path

Unit test business logic without running a workflow when possible. Then test the workflow's event input, step calls, outputs, and error paths. Mock external APIs so a test can assert the business decision without charging a card or sending a message. For TypeScript v4, @inngest/test uses InngestTestEngine to run a function or stop at a step. It works with Jest-compatible assertions. Mock steps that pause execution, including sleep and waitForEvent.

import { InngestTestEngine } from "@inngest/test";
import { helloWorld } from "./helloWorld";

const testEngine = new InngestTestEngine({ function: helloWorld });
const { result } = await testEngine.execute();
expect(result).toEqual("Hello World!");

Pass test events and mock step results for a function that needs them. Use executeStep("step-id") when you need to check one checkpoint. Check the platform and language reference for exact SDK test APIs.

Exercise durable behavior locally

Use the Dev Server to send a real test event and inspect the run. Test one success path, a transient failure that retries, a permanent failure, a wait that times out, and cancellation where applicable. For a version change, leave a run waiting, change the code, and inspect how the run resumes. See Versioning.

Check integrations before launch

In a test environment, verify event filters, function registration, credentials, provider timeouts, and external idempotency keys. Check that a duplicate event or a retry cannot repeat a payment or other one-time effect. See Idempotency. Use Local Development for local setup and the SDK reference for exact API details.