Initial support for bi-directional contracts (OAS/Swagger)

Question

Initial support for bi-directional contracts (OAS/Swagger)

mefellows opened this issue 4 years ago · comments

Matt Fellows commented 4 years ago

Enable support for a bi-directional contract testing workflow with Open API Spec as the initial provider contract.

The initial workflow will support:

A general provider-driven workflow
Publishing of a valid OpenAPI spec (v3) from the provider, along with verification results to show the provider is compatible with the spec
Consumer publishing Pact tests for a provider that has an OAS
Pactflow will provide schema compatibility checks (e.g. during the can-i-deploy phase)

TODO

support publishing of an arbitrary "contract" file, specifying the specific type
support publication of provider self verification results from non-pact tools along with the provider contract
modify can-i-deploy to allow OAS/pact verification to be taken into account when calculating results
modify can-i-deploy to allow user to view pact/oas mismatches when can-i-deploy returns false

Deferred
* [ ] provide an endpoint to allow pact/OAS verification to be done before publishing a pact

Follow up:

Rendering of the OAS and verification results in the Pactflow UI

See also https://pactflow.io/blog/the-curious-case-for-the-provider-driven-contract/ and pact-foundation/pact-specification#76 for some background.

Beth Skurrie · Answer 1 · Tue Jan 19 2021 10:06:10 GMT+0800 (China Standard Time)

Potential "evidence" to support:

Results of verifying a static OAS document against a running server
- Dredd
- Optic
- https://rest-assured.io/
Auto generated OAS from the code
- https://github.com/OpenAPITools/openapi-generator
Runtime OAS monitoring?
- https://connexion.readthedocs.io/en/latest/response.html#response-validation

Matt Fellows · Answer 2 · Tue Feb 02 2021 07:19:59 GMT+0800 (China Standard Time)

provide an endpoint to allow pact/OAS verification to be done before publishing a pact

We're going to defer this until after feedback from our developer preview group.

Beth Skurrie · Answer 3 · Wed Feb 17 2021 10:50:43 GMT+0800 (China Standard Time)

Note to self: Current oas verifiers say "We've seen no evidence that this spec is wrong" rather than "the code fully implements what is described in the spec"

Antonio · Answer 4 · Fri Jan 28 2022 04:50:36 GMT+0800 (China Standard Time)

Any update on this?

Matt Fellows · Answer 5 · Fri Jan 28 2022 08:47:20 GMT+0800 (China Standard Time)

It's currently in developer preview, and you can use it now. You can see the docs for this: https://docs.pactflow.io/docs/workshops/bi-directional/

We're progressively rolling the UI support out for this over the next little while, so this has been kept as open whilst we are still in preview.