@edd-kernel/testing
v0.2.0-alpha.1
Published
Reusable contract tests for EDD Kernel providers.
Maintainers
Readme
@edd-kernel/testing
Reusable contract tests and integration-test helpers for EDD Kernel providers.
This package belongs to the EDD Kernel testing layer. It owns shared provider conformance tests and test utilities. It should be used by provider packages and custom provider implementations, not by normal application runtime code.
Repository: brunnofoggia/edd-kernel-js
Install
npm install --save-dev @edd-kernel/testing vitestThe suite registers its tests in your own vitest run, which has to be vitest 5. Vitest 5
runs on Node ^22.12.0 || ^24.0.0 || >=26.0.0.
Provider packages under the EDD Kernel monorepo use it as a workspace dependency.
Usage
Use defineProviderContractTests in a provider test suite:
import { defineProviderContractTests } from '@edd-kernel/testing';
import { createInMemoryClient } from './index.js';
defineProviderContractTests({
providerName: 'in-memory',
createClient: createInMemoryClient,
target: (name) => ({ queueName: name }),
queue: (name) => ({ queueName: name }),
});The shared contract covers JSON/raw serialization, automatic idempotency keys, acknowledgement behavior, queue creation and multi-queue consumption fairness.
The suite waits for consume() setup before sending messages to that consumer.
This is intentional for providers such as GCP Pub/Sub, where subscriptions must
exist before messages are published.
Integration Helpers
The package also exports helpers for provider integration tests:
integrationDescriberequiredIntegrationEnvoptionalIntegrationEnvshouldKeepIntegrationResourcesuniqueIntegrationNamecreateDeferred
integrationDescribe reads .env.tests and skips a suite unless its enabled
flag is set. shouldKeepIntegrationResources uses
EDD_KERNEL_INTEGRATION_KEEP_RESOURCES so cleanup remains the default behavior unless
resource preservation is explicitly requested.
