pact-ruby

# Pact Ruby

`pact-ruby v2+` implements support for the latest versions of Pact specifications:

- It's based on pact-ffi and pact-ruby-ffi
- It provides a convenient DSL, simplifying the writing of contract tests in Ruby/RSpec
- Writing contract tests with HTTP transports
- Writing contract tests with non-HTTP transports (for example, gRPC)
- Writing contract tests for async messages (Kafka, etc.)
- Verifying contract tests for HTTP/non-HTTP/async message transport
  - V4 specification supports mixed pact interactions in a single file.

## Architecture

![Pact tests architecture](./documentation/pact-arch.png)

- DSL - implementation of RSpec-DSL for convenient writing of Pact tests
- Matchers - implementation of Pact matchers, which are convenient helpers used in consumer-DSL, encapsulating all the logic for serialization into Pact format
- Mock servers - mock servers that allow for correct execution of provider tests

## Installation

The `pact/v2` namespace was introduced in `pact-ruby` v1.67.0 and moved to `pact` in v2

It introduces a suite of new depedencies, including a reliance on the `pact-ffi` and `ffi` gems.

```rb
 gem "pact"
```

`pact-ffi` ships prebuilt binary gems, and does not support platforms outside of the released [pact_ffi](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_ffi) libraries

| Version   | Platform             |
|-----------|----------------------|
| 0.5.8.1  | x86_64-darwin        |
| 0.5.8.1  | arm64-darwin         |
| 0.5.8.1  | x86_64-linux         |
| 0.5.8.1  | aarch64-linux        |
| 0.5.8.1  | x86_64-linux-musl    |
| 0.5.8.1  | aarch64-linux-musl   |
| 0.5.8.1  | x64-mingw32          |
| 0.5.8.1  | x64-mingw-ucrt       |

If you require a pure ruby gem, you are advised to pin to v1.

## Usage

For each type of interaction (due to their specific features), a separate version of DSL has been implemented. However, the general principles remain the same for each type of interaction.

Place your consumer tests under

`spec/pact/providers/**`

**it's not an error: consumer tests contain `providers` subdirectory (because we're testing against different providers)**

```ruby

# Declaration of a consumer test, always include the :pact tag
# This is used in CI/CD pipelines to separate Pact tests from other RSpec tests
# Pact tests are not run as part of the general RSpec pipeline
RSpec.describe "SomePactConsumerTestForAnyTransport", :pact do
  # declaration of the type of interaction - here we determine which consumer and provider interact on which transport
  has_http_pact_between "CONSUMER-NAME", "PROVIDER-NAME"
  # or
  has_grpc_pact_between "CONSUMER-NAME", "PROVIDER-NAME"
  # or
  has_message_pact_between "CONSUMER-NAME", "PROVIDER-NAME"

  # the context for one of the interactions, for example GET /api/v2/stores
  context "with GET /api/v2/stores" do
      let(:interaction) do
        # creating a new interaction - within which we describe the contract
        new_interaction