Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.26

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.26 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.26/pact-2.4.26-osx-x86_64.tar.gz
tar xzf pact-2.4.26-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.26/pact-2.4.26-osx-arm64.tar.gz
tar xzf pact-2.4.26-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.26/pact-2.4.26-linux-x86_64.tar.gz
tar xzf pact-2.4.26-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.26/pact-2.4.26-linux-arm64.tar.gz
tar xzf pact-2.4.26-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.26/pact-2.4.26-windows-x86_64.zip
unzip pact-2.4.26-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.26/pact-2.4.26-windows-x86.zip
unzip pact-2.4.26-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.26) of the Pact standalone executables package contains:

pact gem 1.66.1
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.1
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.25

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.25 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.25/pact-2.4.25-osx-x86_64.tar.gz
tar xzf pact-2.4.25-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.25/pact-2.4.25-osx-arm64.tar.gz
tar xzf pact-2.4.25-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.25/pact-2.4.25-linux-x86_64.tar.gz
tar xzf pact-2.4.25-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.25/pact-2.4.25-linux-arm64.tar.gz
tar xzf pact-2.4.25-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.25/pact-2.4.25-windows-x86_64.zip
unzip pact-2.4.25-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.25/pact-2.4.25-windows-x86.zip
unzip pact-2.4.25-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.25) of the Pact standalone executables package contains:

pact gem 1.66.1
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.1
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.24

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.24 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.24/pact-2.4.24-osx-x86_64.tar.gz
tar xzf pact-2.4.24-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.24/pact-2.4.24-osx-arm64.tar.gz
tar xzf pact-2.4.24-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.24/pact-2.4.24-linux-x86_64.tar.gz
tar xzf pact-2.4.24-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.24/pact-2.4.24-linux-arm64.tar.gz
tar xzf pact-2.4.24-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.24/pact-2.4.24-windows-x86_64.zip
unzip pact-2.4.24-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.24/pact-2.4.24-windows-x86.zip
unzip pact-2.4.24-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.24) of the Pact standalone executables package contains:

pact gem 1.66.1
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.1
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.23

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.23 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.23/pact-2.4.23-osx-x86_64.tar.gz
tar xzf pact-2.4.23-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.23/pact-2.4.23-osx-arm64.tar.gz
tar xzf pact-2.4.23-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.23/pact-2.4.23-linux-x86_64.tar.gz
tar xzf pact-2.4.23-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.23/pact-2.4.23-linux-arm64.tar.gz
tar xzf pact-2.4.23-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.23/pact-2.4.23-windows-x86_64.zip
unzip pact-2.4.23-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.23/pact-2.4.23-windows-x86.zip
unzip pact-2.4.23-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.23) of the Pact standalone executables package contains:

pact gem 1.66.1
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.1
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.22

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.22 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.22/pact-2.4.22-osx-x86_64.tar.gz
tar xzf pact-2.4.22-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.22/pact-2.4.22-osx-arm64.tar.gz
tar xzf pact-2.4.22-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.22/pact-2.4.22-linux-x86_64.tar.gz
tar xzf pact-2.4.22-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.22/pact-2.4.22-linux-arm64.tar.gz
tar xzf pact-2.4.22-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.22/pact-2.4.22-windows-x86_64.zip
unzip pact-2.4.22-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.22/pact-2.4.22-windows-x86.zip
unzip pact-2.4.22-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.22) of the Pact standalone executables package contains:

pact gem 1.66.1
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.1
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.21

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.21 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.21/pact-2.4.21-osx-x86_64.tar.gz
tar xzf pact-2.4.21-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.21/pact-2.4.21-osx-arm64.tar.gz
tar xzf pact-2.4.21-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.21/pact-2.4.21-linux-x86_64.tar.gz
tar xzf pact-2.4.21-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.21/pact-2.4.21-linux-arm64.tar.gz
tar xzf pact-2.4.21-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.21/pact-2.4.21-windows-x86_64.zip
unzip pact-2.4.21-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.21/pact-2.4.21-windows-x86.zip
unzip pact-2.4.21-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.21) of the Pact standalone executables package contains:

pact gem 1.66.1
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.0
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.20

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.20 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.20/pact-2.4.20-osx-x86_64.tar.gz
tar xzf pact-2.4.20-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.20/pact-2.4.20-osx-arm64.tar.gz
tar xzf pact-2.4.20-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.20/pact-2.4.20-linux-x86_64.tar.gz
tar xzf pact-2.4.20-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.20/pact-2.4.20-linux-arm64.tar.gz
tar xzf pact-2.4.20-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.20/pact-2.4.20-windows-x86_64.zip
unzip pact-2.4.20-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.20/pact-2.4.20-windows-x86.zip
unzip pact-2.4.20-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.20) of the Pact standalone executables package contains:

pact gem 1.66.0
pact-mock_service gem 3.12.3
pact-support gem 1.21.2
pact-provider-verifier gem 1.39.0
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.19

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.19 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.19/pact-2.4.19-osx-x86_64.tar.gz
tar xzf pact-2.4.19-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.19/pact-2.4.19-osx-arm64.tar.gz
tar xzf pact-2.4.19-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.19/pact-2.4.19-linux-x86_64.tar.gz
tar xzf pact-2.4.19-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.19/pact-2.4.19-linux-arm64.tar.gz
tar xzf pact-2.4.19-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.19/pact-2.4.19-windows-x86_64.zip
unzip pact-2.4.19-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.19/pact-2.4.19-windows-x86.zip
unzip pact-2.4.19-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.19) of the Pact standalone executables package contains:

pact gem 1.66.0
pact-mock_service gem 3.12.3
pact-support gem 1.21.1
pact-provider-verifier gem 1.39.0
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.18

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.18 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.18/pact-2.4.18-osx-x86_64.tar.gz
tar xzf pact-2.4.18-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.18/pact-2.4.18-osx-arm64.tar.gz
tar xzf pact-2.4.18-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.18/pact-2.4.18-linux-x86_64.tar.gz
tar xzf pact-2.4.18-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.18/pact-2.4.18-linux-arm64.tar.gz
tar xzf pact-2.4.18-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.18/pact-2.4.18-windows-x86_64.zip
unzip pact-2.4.18-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.18/pact-2.4.18-windows-x86.zip
unzip pact-2.4.18-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.18) of the Pact standalone executables package contains:

pact gem 1.66.0
pact-mock_service gem 3.12.3
pact-support gem 1.21.1
pact-provider-verifier gem 1.39.0
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Pact standalone executables

This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.

Installation of 2.4.16

Linux and MacOS

curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.16 bash

MacOS

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.16/pact-2.4.16-osx-x86_64.tar.gz
tar xzf pact-2.4.16-osx-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.16/pact-2.4.16-osx-arm64.tar.gz
tar xzf pact-2.4.16-osx-arm64.tar.gz

Linux

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.16/pact-2.4.16-linux-x86_64.tar.gz
tar xzf pact-2.4.16-linux-x86_64.tar.gz

arm64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.16/pact-2.4.16-linux-arm64.tar.gz
tar xzf pact-2.4.16-linux-arm64.tar.gz

Windows

x86_64

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.16/pact-2.4.16-windows-x86_64.zip
unzip pact-2.4.16-windows-x86_64.zip

x86

curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.4.16/pact-2.4.16-windows-x86.zip
unzip pact-2.4.16-windows-x86.zip

Pact Ruby Standalone

Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby

Package contents

This version (2.4.16) of the Pact standalone executables package contains:

pact gem 1.65.2
pact-mock_service gem 3.11.2
pact-support gem 1.20.2
pact-provider-verifier gem 1.38.1
pact_broker-client gem 1.77.0
pact-message gem 0.11.1

Binaries will be extracted into pact/bin:

./pact/bin/
├── pact
├── pact-broker
├── pactflow
├── pact-message
├── pact-mock-service
├── pact-provider-verifier
└── pact-stub-service

Windows Users

Please append .bat to any of the provided binaries

eg.

  .\pact\bin\pact-broker.bat

Installation

See the release page.

Supported Platforms

Ruby is not required on the host platform, Ruby 3.3.5 is provided in the distributable.

OS	Ruby	Architecture	Supported
MacOS	3.3.5	x86_64	✅
MacOS	3.3.5	aarch64 (arm64)	✅
Linux	3.3.5	x86_64	✅
Linux	3.3.5	aarch64 (arm64)	✅
Windows	3.3.5	x86_64	✅
Windows	3.3.5	x86	✅
Windows	3.3.5	aarch64 (arm64)	🚧

🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM

Usage

pact-mock-service

Commands:
  pact-mock-service control               # Run a Pact mock service control s...
  pact-mock-service control-restart       # Start a Pact mock service control...
  pact-mock-service control-start         # Start a Pact mock service control...
  pact-mock-service control-stop          # Stop a Pact mock service control ...
  pact-mock-service help [COMMAND]        # Describe available commands or on...
  pact-mock-service restart               # Start or restart a mock service. ...
  pact-mock-service service               # Start a mock service. If the cons...
  pact-mock-service start                 # Start a mock service. If the cons...
  pact-mock-service stop -p, --port=PORT  # Stop a Pact mock service
  pact-mock-service version               # Show the pact-mock-service gem version
Usage:
  pact-mock-service service
Options:
      [--consumer=CONSUMER]                                      # Consumer name
      [--provider=PROVIDER]                                      # Provider name
  -p, [--port=PORT]                                              # Port on which to run the service
  -h, [--host=HOST]                                              # Host on which to bind the service
                                                                 # Default: localhost
  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair. Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file.
                                                                 # Default: overwrite
  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.
                                                                 # Default: 2
  -l, [--log=LOG]                                                # File to which to log output
      [--log-level=LOG_LEVEL]                                    # Log level. Options are DEBUG INFO WARN ERROR
                                                                 # Default: DEBUG
  -o, [--cors=CORS]                                              # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]                          # Use a self-signed SSL cert to run the service over HTTPS
                                                                 # Default: false
      [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).

pact-stub-service

Usage:
  pact-stub-service PACT_URI ...
Options:
  -p, [--port=PORT]                        # Port on which to run the service
  -h, [--host=HOST]                        # Host on which to bind the service
                                           # Default: localhost
  -l, [--log=LOG]                          # File to which to log output
  -n, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token (can also be set using the PACT_BROKER_TOKEN environment variable)
      [--log-level=LOG_LEVEL]              # Log level. Options are DEBUG INFO WARN ERROR
                                           # Default: DEBUG
  -o, [--cors=CORS]                        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
      [--ssl], [--no-ssl], [--skip-ssl]    # Use a self-signed SSL cert to run the service over HTTPS
                                           # Default: false
      [--sslcert=SSLCERT]                  # Specify the path to the SSL cert to use when running the service over HTTPS
      [--sslkey=SSLKEY]                    # Specify the path to the SSL key to use when running the service over HTTPS
Description:
  Start a stub service with the given pact file(s) or directories. Pact URIs
  may be local file or directory paths, or HTTP. Include any basic auth details
  in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
  matching interactions are found, the interactions will be sorted by response
  status, and the first one will be returned. This may lead to some
  non-deterministic behaviour. If you are having problems with this, please
  raise it on the pact-dev google group, and we can discuss some potential
  enhancements. Note that only versions 1 and 2 of the pact specification are
  currently fully supported. Pacts using the v3 format may be used, however,
  any matching features added in v3 will currently be ignored.

pact-provider-verifier

To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable $SSL_CERT_FILE or $SSL_CERT_DIR to a path that contains the appropriate certificate.

Usage:
  pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
Options:
  -h, --provider-base-url=PROVIDER_BASE_URL                                                                         # Provider host URL
  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                                                       # Base URL to setup the provider states at
      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                                                                 # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set using the environment variable PACT_BROKER_BASE_URL.
  -n, [--broker-username=BROKER_USERNAME]                                                                           # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
  -p, [--broker-password=BROKER_PASSWORD]                                                                           # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
  -k, [--broker-token=BROKER_TOKEN]                         ...

Releases: pact-foundation/pact-ruby-standalone

pact-2.4.26

Pact standalone executables

Installation of 2.4.26

Linux and MacOS

MacOS

x86_64

arm64

Linux

x86_64

arm64

Windows

x86_64

x86

Pact Ruby Standalone

Package contents

Windows Users

Installation

Supported Platforms

Usage

pact-mock-service

pact-stub-service

pact-provider-verifier

Uh oh!

pact-2.4.25

Pact standalone executables

Installation of 2.4.25

Linux and MacOS

MacOS

x86_64

arm64

Linux

x86_64

arm64

Windows

x86_64

x86

Pact Ruby Standalone

Package contents

Windows Users

Installation

Supported Platforms

Usage

pact-mock-service

pact-stub-service

pact-provider-verifier

Uh oh!

pact-2.4.24

Pact standalone executables

Installation of 2.4.24

Linux and MacOS

MacOS

x86_64

arm64

Linux

x86_64

arm64

Windows

x86_64

x86

Pact Ruby Standalone

Package contents

Windows Users

Installation

Supported Platforms

Usage

pact-mock-service

pact-stub-service

pact-provider-verifier

Uh oh!

pact-2.4.23

Pact standalone executables

Installation of 2.4.23

Linux and MacOS

MacOS

x86_64

arm64

Linux

x86_64

arm64