Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pact-foundation/pact-specification

Describes the pact format and verification specifications
https://github.com/pact-foundation/pact-specification

contract-testing pact smartbear-supported specification

Last synced: 2 days ago
JSON representation

Describes the pact format and verification specifications

Awesome Lists containing this project

README 

        



# How to get started writing a Pact implementation



* All new Pact implementations should wrap the Rust implementation using FFI calls, to allow us to roll out new features quickly and consistently across our 10+ Pact languages. Please do not start writing a new Pact implementation without talking to the current maintainers at slack.pact.io! 



# Introduction



["Pact"](https://github.com/pact-foundation/pact) is an implementation of "consumer driven contract" testing that allows mocking of responses in the consumer codebase, and verification of the interactions in the provider codebase. The initial implementation was written in Ruby for Rack apps, however a consumer and provider may be implemented in different programming languages, so the "mocking" and the "verifying" steps would be best supported by libraries in their respective project's native languages. Given that the pact file is written in JSON, it should be straightforward to implement a pact library in any language, however, to get the best experience and most reliability of out mixing pact libraries, the matching logic for the requests and responses needs to be identical. There is little confidence to be gained in having your pacts "pass" if the logic used to verify a "pass" is inconsistent between implementations.



To support consistency of matching logic, this specification has been developed as a benchmark that all pact libraries can check themselves against if they want to ensure consistency with other pact libraries.



### Pact Specificaton Philosophy



The Pact matching rules follow [Postel's Law][postel].



* Be as strict as we reasonably can with what we send out (requests). We should know and be able to control exactly what a consumer is sending out. Information should not be allowed to "leak" silently.

* Be as loose as we reasonably can with what we accept (responses). A provider should be able to send extra information that this particular consumer does not care about, without breaking this consumer.

* When writing the matching rules, err on the side of being more strict now, because it will break fewer things to be looser later, than to get stricter later.



Note: One implications of this philosophy is that you cannot verify, using pact, that a key or a header will _not_ be present in a response. You can only verify what _is_.



### Goals for implementing a pact library

* The DSLs should be as similar as possible, within the idioms of the language, to the original Ruby wording to help create a consistent Pact experience, and minimise overhead when switching between languages.

* The matching logic for the requests and responses should be the same so that we can have the same amount of confidence that the integrations will work in real life no matter what language the system was written and tested in.



#### Logging in a pact library



Since some pact implementations call others, it's helpful to have guidelines for the log levels.



* `Error`: Something has gone wrong or there were test failures

* `Warn`: We think you may be using something incorrectly, or you’ve turned off some safety switches.

* `Info`: You probably want to know this every time you run pact, and if tests are failing here is an explanation

* `Debug`: Information to help users know exactly what is happening during their tests (eg if they want to debug a failing test)

* `Trace`: Very detailled information to help maintainers debug pact



The default log level (if any) should be info.



# Index



* [JSON schemas](https://github.com/pactflow/pact-schemas) - Pact Specification as a series of JSON schemas. To see the key differences between versions, see https://github.com/pactflow/pact-schemas/blob/main/src/index.ts.



* [Version 1](https://github.com/pact-foundation/pact-specification/tree/version-1) - A spec that describes the existing matching in the ruby implementation, and provides test cases for implementations in other languages to ensure that matching is consistent.



* [Version 1.1](https://github.com/pact-foundation/pact-specification/tree/version-1.1) - Updated specification shared between Ruby, JVM and .Net versions.



* [Version 2](https://github.com/pact-foundation/pact-specification/tree/version-2) - Introduces non-language specific regular expression and type matching.



* [Version 3](https://github.com/pact-foundation/pact-specification/tree/version-3) - Introduces pact format for message queues and corrects some issues with V2.



* [Version 4](https://github.com/pact-foundation/pact-specification/tree/version-4) - Adds lots of new features, see RFC [#71](https://github.com/pact-foundation/pact-specification/issues/71) for details.



[postel]: http://en.wikipedia.org/wiki/Jon_Postel#Postel.27s_Law