@deployagram/core
v1.0.0
Published
The framework-neutral part of the Deployagram test helpers: start or reuse the environment, post proxy configuration, and mark each test's end. Test framework adapters, such as @deployagram/vitest, build on it.
Readme
@deployagram/core
The part of the Deployagram test helpers that does not depend on a test framework:
- starting, or finding, the Collector and the HTTP Proxy (
@deployagram/environment) - posting the Proxy configuration (
postProxyConfig) - marking the end of each test on the Collector, as
<suite>.<test> - stopping only the containers the suite started
A test framework adapter wires these into its own hooks. @deployagram/vitest is one such adapter. The
Jest, Mocha and node:test adapters are planned on the same core.
import { createDeployagramSuite } from '@deployagram/core';
const suite = createDeployagramSuite({
name: 'ReceiveEmailTest',
proxyConfig: { 'proxy.namesOfSourceApps.Emailer/email': 'EmailClient' },
});
beforeAll(() => suite.beforeAll());
beforeEach(() => suite.beforeEach());
afterEach(() => suite.afterEach(currentTestName));
afterAll(() => suite.stop());The adapter supplies the hooks and the current test's name. The core does the rest.
Collector-only tests
For a test that stubs HTTP inside the test process, such as with MSW or Nock, there is no Proxy to
configure. Start the environment with proxy: false, so no Proxy container is found or started:
const suite = createDeployagramSuite({
name: 'MswSuite',
environment: { proxy: false },
});The suite then has no proxyUrl. Reading it is an error, and proxy configuration with proxy: false
fails in beforeAll.
