workable-pact-provider-verifier 1.24.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99e33e7f43f9d975a4e2c725684e7e0134e391d9cd4869a587617916bc3ae10c
+  data.tar.gz: 1c53e57eb4de4101c925304f307276638da99ed8e26c0e11d70f9c63a2fce719
+SHA512:
+  metadata.gz: 6565535cdd4c3a097fdb35a3768b348b0f95452671bb9e83f4bfac2bfc08eeba62f383c53807f4b8f19aa275c43c442a44673a49599986008e8cf33ef3940806
+  data.tar.gz: '096493954612183631b334d4364f13c35faeebe00d56abb449aa175fa98189c089901f92449b7787891050ebb5049a2d93c56714319040ea399949529b028a98'

data/CHANGELOG.md

@@ -0,0 +1,296 @@
+<a name="v1.24.0-1"></a>
+### v1.24.0-1 (2019-09-26)
+
+
+#### Features
+
+* update pact version dependency to 1.42.0	 ([828deff](/../../commit/828deff))
+* use new 'pacts for verification' endpoint when PACT_BROKER_PACTS_FOR_VERIFICATION_ENABLED is set to 'true'	 ([6e6f45b](/../../commit/6e6f45b))
+* allow --provider-version-tag to be specified, which will be applied to the provider version when the verification results are published	 ([bf4bc93](/../../commit/bf4bc93))
+
+
+<a name="v1.23.1-1"></a>
+### v1.23.1-1 (2019-05-22)
+
+
+#### Bug Fixes
+
+* honour the --broker-token CLI param	 ([36bc88c](/../../commit/36bc88c))
+
+
+<a name="v1.23.0-1"></a>
+### v1.23.0-1 (2019-04-28)
+
+
+#### Features
+
+* allow a wait time to be specified to allow the provider to become available	 ([cec8d56](/../../commit/cec8d56))
+
+
+<a name="v1.22.0-1"></a>
+### v1.22.0-1 (2019-02-21)
+
+
+#### Features
+
+* add support for bearer token	 ([3a102c4](/../../commit/3a102c4))
+* add support for bearer token	 ([bc37817](/../../commit/bc37817))
+
+
+<a name="v1.21.0-1"></a>
+### v1.21.0-1 (2018-11-15)
+
+
+#### Features
+
+* pass verbose flag through to HAL client when fetching pacts	 ([d3acd1a](/../../commit/d3acd1a))
+
+
+<a name="v1.20.0-1"></a>
+### v1.20.0-1 (2018-10-04)
+
+
+#### Features
+
+* **pact specification v3**
+  * add support for multiple provider states and params	 ([556b957](/../../commit/556b957))
+
+
+<a name="v1.18.0-1"></a>
+### v1.18.0-1 (2018-09-11)
+
+
+#### Features
+
+* **pending pacts**
+  * allow pending pacts to be feature toggled	 ([5e8e15f](/../../commit/5e8e15f))
+
+* allow custom rack middleware to be specified	 ([ef857d4](/../../commit/ef857d4))
+
+* **custom-middleware**
+  * allow custom middleware to be configured via the command line	 ([217136d](/../../commit/217136d))
+
+
+<a name="v1.17.0-1"></a>
+### v1.17.0-1 (2018-09-06)
+
+
+#### Features
+
+* rename wip in CLI to ignore-failures and wip pacts to pending pacts	 ([bf9ed81](/../../commit/bf9ed81))
+
+
+<a name="v1.16.1-1"></a>
+### v1.16.1-1 (2018-09-05)
+
+
+#### Features
+
+* **cli**
+  * update help text	 ([740dc4b](/../../commit/740dc4b))
+
+
+<a name="v1.16.0-1"></a>
+### v1.16.0-1 (2018-07-24)
+
+
+#### Features
+
+* allow pacts to be fetched from a Pact Broker by provider name, including WIP pacts.	 ([0b80528](/../../commit/0b80528))
+* correct debug message regarding provider state URL	 ([d134ba6](/../../commit/d134ba6))
+
+
+<a name="v1.15.0-1"></a>
+### v1.15.0-1 (2018-07-13)
+
+
+#### Features
+
+* print a new line between JSON documents when using --format json	 ([dc90d8e](/../../commit/dc90d8e))
+
+
+<a name="v1.14.4-1"></a>
+### v1.14.4-1 (2018-07-10)
+
+
+#### Bug Fixes
+
+* ensure all json results are sent to stdout when multiple pacts are verified	 ([7662df0](/../../commit/7662df0))
+
+
+<a name="v1.14.1-1"></a>
+### v1.14.1-1 (2018-05-08)
+
+
+#### Bug Fixes
+
+* ensure headers with underscores are correctly replayed	 ([abb4b4a](/../../commit/abb4b4a))
+
+
+<a name="v1.14.0-1"></a>
+### v1.14.0-1 (2018-04-16)
+
+
+#### Features
+
+* add --out option to CLI to allow test results to be written to a file	 ([8be3367](/../../commit/8be3367))
+
+
+<a name="v1.13.0-1"></a>
+### v1.13.0-1 (2018-04-05)
+
+
+#### Bug Fixes
+
+* ensure v3 message matching rules are loaded correctly	 ([48f29a1](/../../commit/48f29a1))
+
+
+<a name="v1.12.0-1"></a>
+### v1.12.0-1 (2018-03-24)
+
+
+#### Features
+
+* add message pact verification support - alpha release only	 ([69cd7e9](/../../commit/69cd7e9))
+
+
+<a name="v1.11.0-1"></a>
+### v1.11.0-1 (2017-12-07)
+
+
+#### Features
+
+* maintain path portion of specified provider base URL	 ([b765b00](/../../commit/b765b00))
+
+
+<a name="v1.10.0-1"></a>
+### v1.10.0-1 (2017-11-11)
+
+
+#### Features
+
+* add support for --format RspecJunitFormatter	 ([2ba6439](/../../commit/2ba6439))
+
+
+<a name="v1.9.0-1"></a>
+### v1.9.0-1 (2017-11-07)
+
+
+#### Features
+
+* **monkeypatch**
+  * allow a ruby file to be loaded in order to perform at monkeypatch	 ([96bb549](/../../commit/96bb549))
+
+
+<a name="v1.8.0-1"></a>
+### v1.8.0-1 (2017-10-27)
+
+#### Features
+
+* **cli**
+  * allow --format json to be used to output spec results in json format to stdout	 ([aa7359a](/../../commit/aa7359a))
+
+<a name="v1.7.0-1"></a>
+### v1.7.0-1 (2017-10-18)
+
+#### Features
+
+* allow backtrace toggle to be configured via an environment variable	 ([298d791](/../../commit/298d791))
+
+<a name="v1.6.0-1"></a>
+### v1.6.0-1 (2017-10-01)
+
+#### Features
+
+* **cli**
+  * allow multiple --custom-provider-header to be specified	 ([6a8573a](/../../commit/6a8573a))
+
+<a name="v1.5.0-1"></a>
+### v1.5.0-1 (2017-10-01)
+
+#### Features
+
+* **cli**
+  * specify pact urls as the arguments to pact-provider-verifier instead of using --pact-urls option	 ([df78617](/../../commit/df78617))
+
+<a name="v1.4.1-1"></a>
+### v1.4.1-1 (2017-08-27)
+
+#### Bug Fixes
+
+* ensure Host header is correctly set	 ([9048744](/../../commit/9048744))
+
+<a name="v1.4.0-1"></a>
+### v1.4.0-1 (2017-08-11)
+
+#### Features
+
+* **run single interaction**
+  * allow env vars to be set to run a single interaction   ([3e39517](/../../commit/3e39517))
+
+#### Bug Fixes
+
+* Turn off SSL verification for provider states setup call.  ([744add2](/../../commit/744add2))
+
+<a name="v1.3.1"></a>
+### v1.3.1 (2017-08-08)
+
+#### Bug Fixes
+
+* **windows**
+  * Add retries for flakiness demonstrated on windows builds for pact-go	 ([198efef](/../../commit/198efef))
+
+<a name="v1.3.0-1"></a>
+# v1.3.0 (2017-08-08)
+
+#### Features
+
+* **custom provider header**
+  * Allow a --custom-provider-header to be specified   ([e3ea6fa](/../../commit/e3ea6fa))
+
+<a name="1.2.0"></a>
+# 1.2.0 (2017-08-05)
+
+* chore(gems): Change json version to allow >1.8 ([b91391a](https://github.com/pact-foundation/pact-provider-verifier/commit/b91391a))
+
+# 1.1.3 (02 June 2017)
+* 066fa60 - Add states list to state setup JSON body, to prepare for v3 pact spec which allows multiple provider states (Beth Skurrie, Fri Jun 2 15:01:28 2017 +1000)
+
+# 1.1.2 (02 June 2017)
+* da958c0 - Only set up state if a provider-states-setup-url is provided. Add tests for SetUpProviderState. (Beth Skurrie, Fri Jun 2 14:31:27 2017 +1000)
+* 36ef2eb - Remove .java, .class, .gitignore and .travis.yml files from package (Beth Skurrie, Fri Jun 2 10:32:55 2017 +1000)
+* 7902674 - Add rake tasks to generate and upload release notes. (Beth Skurrie, Fri Jun 2 10:12:17 2017 +1000)
+* 01e811e - Add integration specs for command (Beth Skurrie, Fri Jun 2 05:51:30 2017 +1000)
+
+# 1.1.0 (01 June 2017)
+* 7106832 - chore(docs): update docs for provider states URL (Matt Fellows, Fri May 26 22:45:09 2017 +1000)
+* 8f787e6 - Add deprecation warning for --provider-states-url (Beth Skurrie, Fri May 26 20:51:48 2017 +1000)
+* 982ba7c - Remove need for provider-states-url by dynamically calling the set up code during test execution (Beth Skurrie, Fri May 26 16:30:14 2017 +1000)
+* f055375 - Turn silent mode on for zip task in rake package (Beth Skurrie, Tue May 23 09:34:51 2017 +1000)
+
+# 1.0.2 (23 May 2017)
+* 33f0811 - Upgrade rspec version to ~>3.5 to fix #11 (Beth Skurrie, Tue May 23 09:01:07 2017 +1000)
+
+# 1.0.1 (9 May 2017)
+* 94597a0 - Updated pact gem to allow use of https for publishing verifications (Beth Skurrie, Tue May 9 14:27:19 2017 +1000)
+
+# 1.0.0 (9 May 2017)
+
+# 0.0.4 (15 May 2016)
+
+* c5dc292 - Added basic authentication support for Pact Broker URLs (Matt Fellows, Sun May 15 19:08:22 2016 +1000)
+
+# 0.0.3 (15 May 2016)
+
+* d36ae19 - Release v0.0.3 (Matt Fellows, Sun May 15 11:22:41 2016 +1000)
+
+# 0.0.2 (12 May 2016)
+
+* 0aca507 - Refactored to not use the Pact rake tasks. Traveling Ruby does not like shelling out to a Ruby process (where's my Gems?) (Matt Fellows, Thu May 12 21:55:29 2016 +1000)
+* 9feb60e - Verifier properly runs all Pacts provided and handles Pact CLI exit call (Matt Fellows, Sun May 15 11:22:12 2016 +1000)
+* a85903d - Release template (Matt Fellows, Thu May 12 21:53:22 2016 +1000)
+* 059b488 - Setting execute perms on wrapper script during package (Matt Fellows, Thu May 12 22:30:22 2016 +1000)
+
+# 0.0.1 (8 May 2016)
+
+* 39e75f3 - Pact provider verifier cross-platform CLI tool (Matt Fellows, Thu May 12 07:30:47 2016 +1000)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "pact-message", git: "https://github.com/ang3lkar/pact-message-ruby"
+
+if ENV['X_PACT_DEVELOPMENT']
+  gem "pact", path: '../pact'
+  gem "pact-message", path: '../pact-message-ruby'
+  gem "pact-support", path: '../pact-support'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Matt Fellows
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# Pact Provider Verification
+
+This setup simplifies Pact Provider [verification](https://docs.pact.io/documentation/verifying_pacts.html)
+process in any language, wrapping the Ruby implementation into a cross-platform,
+binary-like CLI tool.
+
+[![Build Status](https://travis-ci.org/pact-foundation/pact-provider-verifier.svg?branch=master)](https://travis-ci.org/pact-foundation/pact-provider-verifier)
+
+**Features**:
+
+* Verify Pacts against Pacts published to an http endpoint, such as a [Pact Broker](https://github.com/pact-foundation/pact_broker)
+* Verify local `*.json` Pacts on the file system
+* Works with Pact [provider states](https://docs.pact.io/documentation/provider_states.html) should you need them
+* Publishes the verification results back to the pact broker if the pact was retrieved from a broker.
+
+## Installation
+
+### Docker
+
+Take a look at https://github.com/DiUS/pact-provider-verifier-docker.
+
+### Native Installation
+
+Download the appropriate [release](https://github.com/pact-foundation/pact-ruby-standalone/releases)
+for your OS and put somewhere on your `PATH`.
+
+### With Ruby on Mac OSX and Linux
+
+```
+gem install pact-provider-verifier
+pact-provider-verifier <args>
+```
+
+Run `pact-provider-verifier help` for command line options.
+
+## Usage
+
+```
+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.
+  -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
+      [--provider=PROVIDER]
+      [--consumer-version-tag=TAG]                                           # Retrieve the latest pacts with   this consumer version tag. Used in conjunction with --provider. May be specified multiple times.
+      [--provider-version-tag=TAG]                                           # Tag to apply to the provider   application version. May be specified multiple times.
+  -a, [--provider-app-version=PROVIDER_APP_VERSION]                          # Provider application version,   required when publishing verification results
+  -r, [--publish-verification-results], [--no-publish-verification-results]  # Publish verification results to   the broker
+      [--custom-provider-header=CUSTOM_PROVIDER_HEADER]                      # Header to add to provider state   set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple   times.
+      [--custom-middleware=FILE]                                             # Ruby file containing a class   implementing Pact::ProviderVerifier::CustomMiddleware. This allows the response to be modified before   replaying. Use with caution!
+  -v, [--verbose=VERBOSE]                                                    # Verbose output
+  -f, [--format=FORMATTER]                                                   # RSpec formatter. Defaults to   custom Pact formatter. Other options are json and RspecJunitFormatter (which outputs xml).
+  -o, [--out=FILE]                                                           # Write output to a file instead   of $stdout.
+      [--wait=SECONDS]                                                       # The number of seconds to poll for the provider to become available before running the verification
+                                                                           # Default: 0
+```
+
+## Examples
+
+See the [example](examples) for a demonstration with a [Sinatra](http://www.sinatrarb.com/) API:
+
+```
+cd examples
+bundle install
+./test.sh
+```
+
+### Simple API
+
+*Steps*:
+
+1. Create an API and a corresponding Docker image for it
+1. Publish Pacts to the Pact broker (or create local ones)
+1. Run the CLI tool for your OS, passing the appropriate arguments:
+   * a space delimited list of local Pact file URLs or Pact Broker URLs.
+   * `--provider-base-url` - the base url of the provider (i.e. your API)
+
+eg.
+
+```
+pact-provider-verifier foo-bar.json --provider-base-url http://localhost:9292
+```
+
+### Setting a custom Authentication header
+
+If you need to set a valid Authentication header for your replayed requests and provider state setup calls, specify `--custom-provider-header "Authentication: Type VALUE"` in the command line options.
+
+Modification of the request headers is sometimes necessary, but be aware that any modification of the request before it is replayed lessens your confidence that the consumer and provider will work correctly in real life, so do it with caution.
+
+### API with Provider States
+
+Read the [Provider States section on docs.pact.io](https://docs.pact.io/documentation/provider_states.html) for an introduction to provider states.
+
+To allow the correct data to be set up before each interaction is replayed, you will need to create a dev/test only HTTP endpoint that accepts a JSON document that looks like:
+
+```json
+{
+  "consumer": "CONSUMER_NAME",
+  "state": "PROVIDER_STATE"
+}
+```
+
+The endpoint should set up the given provider state for the given consumer synchronously, and return an error if the provider state is not recognised. Namespacing your provider states within each consumer will avoid clashes if more than one consumer defines the same provider state with different data.
+
+The following flag is required when running the CLI:
+
+* `--provider-states-setup-url` - the full url of the endpoint which sets the active consumer and provider state.
+
+Rather than tearing down the specific test data created after each interaction, you should clear all the existing data at the start of each set up call. This is a more reliable method of ensuring that your test data does not leak from one test to another.
+
+Note that the HTTP endpoint does not have to actually be within your application - it just has to have access to the same data store. So if you cannot add "test only" endpoints during your verification, consider making a separate app which shares credentials to your app's datastore. It is highly recommended that you run your verifications against a locally running provider, rather than a deployed one, as this will make it much easier to stub any downstream calls, debug issues, and it will make your tests run as fast as possible.
+
+Ignore the `states` array that you will see if you happen to print out the live provider state set up request body - that was an attempt to make the set up call forwards compatible with the v3 pact specification, which allows multiple provider states. Unfortunately, this forwards compatibilty attempt failed, because the v3 provider states support a map of params, not just a name, so it should have been `{ "state": { "name": "PROVIDER_STATE, "params": {...} } }`. See the next section for the actual v3 support.
+
+#### Pact specification v3 provider state support
+
+The v3 Pact specification adds support for multiple provider states, and provider state params. If you are verifying a pact with multiple provider states, then set up URL will be invoked once for each state. The `params` hash from the pact will also be passed through in the JSON document with the key name `params`.
+
+### Using the Pact Broker with Basic authentication
+
+The following flags are required to use basic authentication with a Pact Broker:
+
+* `--broker-user` - the Username for Pact Broker basic authentication.
+* `--broker-password` - the Password for Pact Broker basic authentication.
+
+NOTE: the `http://user:password@host` format for basic HTTP auth is not supported.
+
+## Contributing
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md)
+
+[pact]: https://github.com/realestate-com-au/pact
+[releases]: https://github.com/bethesque/pact-mock_service/releases
+[javascript]: https://github.com/DiUS/pact-consumer-js-dsl
+[pact-dev]: https://groups.google.com/forum/#!forum/pact-dev
+[windows]: https://github.com/bethesque/pact-mock_service/wiki/Building-a-Windows-standalone-executable
+[install-windows]: https://github.com/bethesque/pact-mock_service/wiki/Installing-the-pact-mock_service-gem-on-Windows
+[why-generated]: https://github.com/realestate-com-au/pact/wiki/FAQ#why-are-the-pacts-generated-and-not-static