prism-contract-testing's Introduction

Contract Testing APIs with Prism & OpenAPI

If you got here by accident, this repository illustrates how to use and experimental Prism programmatic API & jest framework to perform contract testing with minimal amount of code.

You can read more about this stuff in an article I wrote but if you don't care and want to figure it out yourself here are some hints.

Using this code

Prerequisites

Install Docker
Run httpbin server locally docker run -p 80:80 kennethreitz/httpbin
Add httpbin alias to /etc/hosts (optional) sudo su -c 'echo "0.0.0.0 httpbin"' >> /etc/hosts

(Part of this code was inspired by the Prism source code, hence the use of httpbin).

Running tests

yarn # or `npm install`
yarn test

prism-contract-testing's People

Contributors

Stargazers

Watchers

prism-contract-testing's Issues

Update script to latest version of Prism

@chris-miaskowski

I'm really interesting in understanding the sample and use it for own contract testing of OpenApi specs.

I see that the "3.2.0-beta.11" version of Prism is used.

Currently the sample give the following error:

TypeScript diagnostics (customize using `[jest-config].globals.ts-jest.diagnostics` option):
    src/contract.test.ts:11:13 - error TS2352: Conversion of type '{ mock: false; checkSecurity: true; validateRequest: true; validateResponse: true; upstream: URL; }' to type 'IHttpConfig' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
      Property 'errors' is missing in type '{ mock: false; checkSecurity: true; validateRequest: true; validateResponse: true; upstream: URL; }' but required in type 'IHttpConfig'

I assume it is related to the prism-http-server

Any tips or pointers would be helpful.

Recommend Projects