GitHub
06/07/2023, 6:10 PMcurl -fsSL <https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh> | tag=2.0.2 bash
MacOS
x86_64
curl -LO <https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.0.2/pact-2.0.2-osx-x86_64.tar.gz>
tar xzf pact-2.0.2-osx-x86_64.tar.gz
arm64
curl -LO <https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.0.2/pact-2.0.2-osx-arm64.tar.gz>
tar xzf pact-2.0.2-osx-arm64.tar.gz
Linux
#### x86_64
curl -LO <https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.0.2/pact-2.0.2-linux-x86_64.tar.gz>
tar xzf pact-2.0.2-linux-x86_64.tar.gz
arm64
curl -LO <https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.0.2/pact-2.0.2-linux-arm64.tar.gz>
tar xzf pact-2.0.2-linux-arm64.tar.gz
Windows
x86_64
curl -LO <https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.0.2/pact-2.0.2-windows-x86_64.tar.gz>
unzip pact-2.0.2-windows-x86_64.tar.gz
x86
`
curl -LO <https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v2.0.2/pact-2.0.2-windows-x86.tar.gz>
unzip pact-2.0.2-windows-x86.tar.gz
```# Pact Ruby Standalone
[Build](<https://github.com/pact-foundation/pact-ruby-standalone/workflows/Build/badge.svg>)
Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby
## Package contents
This version (2.0.2) of the Pact standalone executables package contains:
* pact gem 1.63.0
* pact-mock_service gem 3.11.2
* pact-support gem 1.19.0
* pact-provider-verifier gem 1.36.1
* pact_broker-client gem 1.66.1
* 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
## Installation
See the [release page][releases].
[releases]: <https://github.com/pact-foundation/pact-ruby-standalone/releases>
## Supported Platforms
Ruby is not required on the host platform, Ruby 3.2.2 is provided in the distributable.
| OS | Ruby | Architecture | Supported |
| -------| ------- | ------------ | --------- |
| MacOS | 3.2.2 | x86_64 | ✅ |
| MacOS | 3.2.2 | aarch64 (arm64)| ✅ |
| Linux | 3.2.2 | x86_64 | ✅ |
| Linux | 3.2.2 | aarch64 (arm64)| ✅ |
| Windows| 3.2.2 | x86_64 | ✅ |
| Windows| 3.2.2 | x86 | ✅ |
| Windows| 3.2.2 | aarch64 (arm64)| 🚧 |
🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM
## Usage
<a name="pact-mock-service"></a>
### 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 ve...
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] # Use a self-signed SSL cert to run the service over HTTPS
[--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).
<a name="pact-stub-service"></a>
### 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] # Use a self-signed SSL cert to run the service over HTTPS
[--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.
<a name="pact-provider-verifier"></a>
### 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, [--brok…
pact-foundation/pact-ruby-standalone