Features
PACT_PROVIDER_URLnpm i jest-pact --save-dev
OR
yarn add jest-pact --dev
pactWith({ consumer: 'MyConsumer', provider: 'MyProvider' }, provider => {
// regular pact tests go here
}
with supertest
pactWith({ consumer: 'MyConsumer', provider: 'MyProvider' }, (provider, client) => {
// regular pact tests go here
}
pactWith({PactOptions}, provider => {
// regular pact tests go here
}
export interface PactOptions {
provider: string;
consumer: string;
port?: number; // defaults to 8989 if not set
pactfileWriteMode?: PactFileWriteMode;
}
export declare type LogLevel = "trace" | "debug" | "info" | "warn" | "error" | "fatal";
export declare type PactFileWriteMode = "overwrite" | "update" | "merge";
You can use this with any http agent for sending your requests.
pactWith(
{ consumer: "MyConsumer", provider: "pactWith", port: pactPort },
async (provider: any) => {
test("should accept a valid get request to get a pet 1", async () => {
const postValidRequest: InteractionObject = {
state: "A pet 1845563262948980200 exists",
uponReceiving: "A get request to get a pet",
willRespondWith: {
status: 200
},
withRequest: {
method: "GET",
path: "/v2/pet/1845563262948980200",
headers: { api_key: "[]" }
}
};
await provider.addInteraction(postValidRequest);
const client = getClient(); // getClient calls your own http agent, the function is not shown here
await client // supertest options shown, other agents may differ
.get("/v2/pet/1845563262948980200")
.set("api_key", "[]")
.expect(200);
await provider.verify();
});
}
);
You can use superagent as your http agent, it has a great assertion engine and as we instantiate the pact mock and http agent at the same time, we can assign random ports and take advantage of jests parallel execution.
pactWithSuperTest(
{ consumer: "MyConsumer", provider: "pactWithSuperTest" },
async (provider: any, client: any) => {
test("should accept a valid get request to get a pet", async () => {
const postValidRequest: InteractionObject = {
state: "A pet 1 exists",
uponReceiving: "A get request to get a pet",
willRespondWith: {
status: 200
},
withRequest: {
method: "GET",
path: "/v2/pet/1",
headers: { api_key: "[]" }
}
};
await provider.addInteraction(postValidRequest);
await client
.get("/v2/pet/1")
.set("api_key", "[]")
.expect(200);
await provider.verify();
});
}
);
yarn installyarn run pact-testyarn run swagger-validate-specyarn run swagger-validate-pactpact-publishpact-tagdocker-compose up./postman/postman-pact.sh to generate postman collections in pact/postman/collections./postman/postman-replace-urls.sh to generate env configs for postman in pact/postman/env where the urls are replaced with $PACT_PROVIDER_URL./postman//postman-newman.sj to run the postman collection against your $PACT_PROVIDER_URLnpx jest -c jest.newman.jsNote:- There are no tests in the saved postman collections, so it will run the requests, but will not validate the responses are as per the pacts.
TODO
$PACT_PROVIDER_URL for all generated postman collections, add the ability to specify a provider name, and update the url accordingly.cd docker/pact-stub-service
Build the base pact image, change the name you54f to your own dockerhub username
The Base image resides at base.Dockerfile which will load the pact ruby standalone, plus a healthcheck endpoint /healthcheck on the containers for use in AWS and other Cloud providers.
make pact_build
docker build -t pact-base -f base.Dockerfile .
make pact_tag
docker tag pact-base you54f/pact-base
make pact_push
docker push you54f/pact-base
You can then copy your pact files generated with yarn run test into the docker/pact-stub-service/pacts folder that the Dockerfile will use.
copy_pacts
rm -rf pacts && cp -r ../../pact/pacts .
Look at the Dockerfile
FROM you54f/pact-base
ARG PACT_FILE
COPY ${PACT_FILE} /pact.json
See the docker/docker-compose.yml file for how to load your pacts into the docker container.
version: "3.1"
services:
pact-stub-server-json:
build:
context: pact-stub-service
args:
PACT_FILE: pacts/test-consumer-json-provider.json
ports:
- "8080:8080"
You can run it with cd docker && docker-compose up
FAQs
a pact adaptor for jest
The npm package jest-pact receives a total of 29,262 weekly downloads. As such, jest-pact popularity was classified as popular.
We found that jest-pact demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.