pact-provider-verifier 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 710449d3f7377b9c94bf10e484ad2540b94573e91809fe9778dc708c5bdfd3bf
-  data.tar.gz: f974cf92df85aad57883557f468b5661fbd0790d5a9e2df3ba4d6472ac4c5761
+  metadata.gz: 92bf234cf9e7a504348192720df8de381b66fadfc53c871c6ec24f009b084b03
+  data.tar.gz: c9fb9ee424d70abedb986251beb4adb1caddd0acef2edeef1a662b2fc4013a3a
 SHA512:
-  metadata.gz: 865383b20a0d8f6d173f6578365c533aeebdbaa238447d67d1861e3f9115580c223c793af6e246b2a071fd972699c6a6d7f8ff576a6892cc7b3249910a34cc26
-  data.tar.gz: ce53d41c5e87c91f50804e9bf56e22d07c955b67f87de22a3b9da0aa7bbe9c80d656ca98ad90409133faaaf2bb2ebeb92efb6800ca26a311b8aa13f275978c23
+  metadata.gz: 3ef9c0d39e8bc82e710df3b9fc57f68d37cca7f3a95c61c38ee760461dbf41d3fab65e744984f3f5a9b2186e88d4cdeed8f606909dccde82ba850347d73c6aeb
+  data.tar.gz: fc1265d71177994ca48f88c270ab9a5fc7f671f7a1b6be4a667c23c131b545c682258e5681f63c3c596760f45be935dcfc5246700386e31ffb26d246d881a7ff

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<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)
 

data/README.md

@@ -11,6 +11,7 @@ binary-like CLI tool.
 * 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
 
@@ -20,7 +21,7 @@ Take a look at https://github.com/DiUS/pact-provider-verifier-docker.
 
 ### Native Installation
 
-Download the appropriate [release](https://github.com/pact-foundation/pact-provider-verifier/releases)
+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
@@ -32,6 +33,27 @@ 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
+  -a, [--provider-app-version=PROVIDER_APP_VERSION]                  # Provider application version, required when publishing verification results
+  -r, [--publish-verification-results=PUBLISH_VERIFICATION_RESULTS]  # Publish verification results to the broker
+  -n, [--broker-username=BROKER_USERNAME]                            # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]                            # Pact Broker basic auth password
+      [--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.
+  -v, [--verbose=VERBOSE]                                            # Verbose output
+  -f, [--format=FORMATTER]                                           # RSpec formatter. Defaults to custom Pact formatter. json and RspecJunitFormatter may also be used.
+  -u, [--pact-urls=PACT_URLS]                                        # DEPRECATED. Please provide as space separated arguments.
+
+Verify pact(s) against a provider. Supports local and networked (http-based) files.
+```
+
 ## Examples
 
 See the [example](examples) for a demonstration with a [Sinatra](http://www.sinatrarb.com/) API:
@@ -48,10 +70,15 @@ bundle install
 
 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 flags:
-   * `--pact_urls` - a comma delimited list of local Pact file urls or Pact Broker URLs.
-   * `--provider_base_url` - the base url of the pact provider (i.e. your API)
-1.
+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
 
@@ -61,17 +88,26 @@ Modification of the request headers is sometimes necessary, but be aware that an
 
 ### API with Provider States
 
-Execute pact provider verification against a provider which implements the following:
+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.
 
-* an http POST endpoint (`--provider-states-setup-url`) which sets the active pact consumer and provider state accepting two parameters: `consumer` and `state` and returns an HTTP `200` eg.
+The following flag is required when running the CLI:
 
-		consumer=web&state=customer%20is%20logged%20in
+* `--provider-states-setup-url` - the full url of the endpoint which sets the active consumer and provider state.
 
-The following flags are required:
+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.
 
-* `--pact-urls` - a comma delimited list of pact file urls
-* `--provider-base-url` - the base url of the pact provider
-* `--provider-states-setup-url` - the full url of the endpoint which sets the active pact consumer and provider state
+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.
 
 ### Using the Pact Broker with Basic authentication
 

data/lib/pact/provider_verifier/app.rb

@@ -79,7 +79,7 @@ module Pact
             preserve_host: true,
             x_forwarded_headers: false
           )
-          reverse_proxy '/', provider_base_url
+          reverse_proxy /(.*)/, "#{provider_base_url}$1"
         end
       end
 

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.10.0"
+    VERSION = "1.11.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Matt Fellows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -303,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Provides a Pact verification service for use with Pact