Registry / testing / haraka-test-fixtures

haraka-test-fixtures

JSON →
library1.4.1jsnpmunverified

The `haraka-test-fixtures` package provides a comprehensive set of mock objects and utilities specifically designed for testing Haraka SMTP server plugins and core components. It enables developers to create isolated test environments by simulating key Haraka abstractions such as `Connection`, `Transaction`, `Plugin`, `Logger`, and `Results` objects without the overhead of running a full Haraka server. This allows for focused unit and integration testing of plugin logic. The current stable version is 1.4.1, released with bug fixes and dependency updates. Releases follow an ad-hoc schedule, primarily driven by maintenance requirements, synchronization with the main Haraka project, and dependency bumps. Its key differentiator lies in its deep integration and direct analogy to Haraka's internal architecture, providing tailor-made testing primitives that generic mocking libraries cannot easily replicate. It helps abstract away the complexities of Haraka's lifecycle for efficient plugin development and testing.

testingcommunication
npm install haraka-test-fixtures
github ↗package ↗
INSTALL
IMPORT
SIG · HARAKA-TEST-FIXTUR
H
haraka-test-fixtures
testingjavascriptv1.4.1
Install
—
Import
—
Disk
—
Pass rate
0/ 6
Env Coverage0 / 6
glibc
18–22
musl
18–22
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–226 runs
build_error
glibc
node 18–226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

fixtures
✓ const fixtures = require('haraka-test-fixtures')
✗ import fixtures from 'haraka-test-fixtures'
The documentation primarily uses CommonJS `require()`. While Node.js 20+ supports ESM, direct default ESM imports might not function as expected for all fixtures or require specific `type: module` configuration.
plugin
✓ const { plugin } = require('haraka-test-fixtures'); // or const fixtures = require('haraka-test-fixtures'); new fixtures.plugin('my-plugin')
✗ import { plugin } from 'haraka-test-fixtures'
`plugin` is a named export available via the main module object. It should be instantiated to create a plugin fixture.
connection
✓ const { connection } = require('haraka-test-fixtures'); // or const fixtures = require('haraka-test-fixtures'); fixtures.connection.createConnection()
✗ import { connection } from 'haraka-test-fixtures'
`connection` is a named export providing static methods, most notably `createConnection()` to generate a connection fixture.

Demonstrates how to set up and use `haraka-test-fixtures` to test a Haraka plugin, including creating plugin and connection fixtures and invoking a hook.

const fixtures = require('haraka-test-fixtures'); describe('my-haraka-plugin', () => { let plugin; let connection; beforeEach(() => { plugin = new fixtures.plugin('my-plugin'); connection = fixtures.connection.createConnection(); connection.init_transaction(); // Initialize transaction for a connection }); it('registers the plugin', () => { plugin.register(); // Add assertions based on plugin registration side effects // e.g., expect(plugin.register_hook.calledWith('data', 'onData')).to.be.true; }); it('handles a connection event', async () => { // Simulate a connection hook being called const next = () => {}; // Mock the 'next' function await plugin.hook_connect(next, connection); // Assert on connection properties or plugin behavior // expect(connection.notes.myValue).to.equal('expected'); }); });
Debug
Known issues
breakingThe `vm_harness` fixture was removed in version 1.4.1 because it is no longer used by Haraka. Any tests relying on `vm_harness` will fail.
fix
Remove all references and usage of `vm_harness` from your test suite. If you had custom logic built around it, you will need to refactor those tests to use alternative fixtures or approaches.
affects: >=1.4.1
gotchaThe package specifies Node.js `>=20` in its engine requirements. Running tests with older Node.js versions might lead to unexpected behavior or runtime errors.
fix
Ensure your development and CI environments are using Node.js version 20 or higher to maintain compatibility and prevent runtime issues.
affects: >=1.4.0
gotchaWhile Node.js 20+ supports ES Modules, the documentation and common usage patterns for `haraka-test-fixtures` heavily rely on CommonJS `require()`. Attempting to use ESM `import` statements directly may lead to module resolution issues or require specific `package.json` configurations (`"type": "module"`).
fix
For consistent and documented behavior, use CommonJS `require()` statements (e.g., `const fixtures = require('haraka-test-fixtures')`). If ESM is strictly required, ensure your project's module resolution is correctly configured for CommonJS interop.
affects: >=1.0.0
Errors
Common errors & fixes
TypeError: fixtures.vm_harness is not a constructor
Attempting to instantiate or access the `vm_harness` fixture which was removed in `haraka-test-fixtures` v1.4.1.
fix
Update your tests to remove any usage or reference to `vm_harness`. This fixture is no longer part of the package.
TypeError: this.connection.init_transaction is not a function
A method is being called on a connection fixture that either hasn't been properly initialized or the method itself doesn't exist for the current state/version of the fixture.
fix
Ensure that `connection` objects are correctly created using `fixtures.connection.createConnection()` and that necessary initialization methods like `init_transaction()` are called before attempting to use transaction-related features.
Error: Cannot find module 'haraka-test-fixtures'
The `haraka-test-fixtures` package has not been installed or is not resolvable from the current project context.
fix
Install the package using npm: `npm install --save-dev haraka-test-fixtures`. Verify the module path if the error persists in a non-standard setup.
Upgrade
Version history
1.4.1latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
17 hits · last 30 days
node
16
OpenAI (training)
1
Resources
githubhttps://github.com/haraka/test-fixtures ↗
packagehttps://www.npmjs.com/package/haraka-test-fixtures ↗
haraka-test-fixtures — npm install haraka-test-fixtures · libregistry