pact-provider-verifier 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 762ad79284a2c03cfc8c22dcfb998cfaa483cbb7
-  data.tar.gz: 3ef07c9e456a922d8e8a0a588e8f22d593724dbb
+  metadata.gz: b360526fb17120efd9f9e2a54c0814a78a5b4b01
+  data.tar.gz: a143308b319b38f0e959916bcd224e5e3757ee50
 SHA512:
-  metadata.gz: e19d59dc991edb552e2fc704a4f3087afba8331ac066ca7ff974bfa34d6da422e3a3999b766b865630984bad965c8c2d2c47c68fedb3f3f1402bcce1f24fcb4b
-  data.tar.gz: 43188c58d84938b79bfdcdaf7a32f4a4989b23181777ef32f6d4b9ce4b6a40b3791ec5604882a629b5ba76b4eef6bcaa639c1566a265d5bbe144899307e138dd
+  metadata.gz: 3b3bc38d83093fcbc5d1c044dc8234b8e0dfd5a0522a210074f4139a6c7a8587408e9baf105dfd336f720baa9989336fa2518073a35a8df136c2d838d961197f
+  data.tar.gz: 82cae026c525577a538a347b2530e0c4a3fae57abd226a8f5ee09e0298e146e19e91144021dda6fbcfec2d0cef1664c6754194cb4dd5a79d94067cdbb01bf1ac

data/CHANGELOG.md

@@ -2,6 +2,12 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
+### 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)
 

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+if ENV['X_PACT_DEVELOPMENT']
+  gem "pact", path: '../pact'
+end

data/README.md

@@ -53,20 +53,7 @@ bundle install
 
 Execute pact provider verification against a provider which implements the following:
 
-* an http get endpoint which returns the available [Provider States](https://docs.pact.io/documentation/provider_states.html) by consumer
-
-		{
-			"SomeUI": [
-				"customer A is logged in",
-				"customer A has a million dollars"
-			],
-			"BackendAPI": [
-				"customer A is logged in",
-				"there are no customers"
-			]
-		}
-
-* an http post endpoint which sets the active pact consumer and provider state
+* 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.
 
 		consumer=web&state=customer%20is%20logged%20in
 
@@ -74,7 +61,6 @@ The following flags are required:
 
 * `--pact-urls` - a comma delimited list of pact file urls
 * `--provider-base-url` - the base url of the pact provider
-* `--provider-states-url` - the full url of the endpoint which returns provider states by consumer
 * `--provider-states-setup-url` - the full url of the endpoint which sets the active pact consumer and provider state
 
 ### Using the Pact Broker with Basic authentication
@@ -84,7 +70,7 @@ 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.
+NOTE: the `http://user:password@host` format for basic HTTP auth is not supported.
 
 ## Contributing
 

data/lib/pact/provider_verifier/app.rb

@@ -33,9 +33,9 @@ module Pact
       end
 
       def verify_pacts
+        print_deprecation_note
         pacts = @options.pact_urls.split(',')
         proxy_pact_helper = File.expand_path(File.join(File.dirname(__FILE__), "pact_helper.rb"))
-        ENV['provider_states_url'] = @options.provider_states_url
         ENV['provider_states_setup_url'] = @options.provider_states_setup_url
         ENV['PACT_BROKER_USERNAME'] = @options.broker_username if @options.broker_username
         ENV['PACT_BROKER_PASSWORD'] = @options.broker_password if @options.broker_password
@@ -62,8 +62,6 @@ module Pact
         require ENV['PACT_PROJECT_PACT_HELPER'] if ENV.fetch('PACT_PROJECT_PACT_HELPER','') != ''
 
         exit_statuses = pacts.collect do |pact_url|
-          ENV['pact_consumer'] = get_pact_consumer_name(pact_url)
-
           begin
             options = {
               :pact_helper => proxy_pact_helper,
@@ -82,34 +80,12 @@ module Pact
         # Return non-zero exit code if failures - increment for each Pact
         exit exit_statuses.count{ | status | status != 0 }
       end
-    end
-  end
-end
-
-def get_json(path)
-  case path
-  when URI::regexp
-    return get_json_from_server(path)
-  else
-    return get_json_from_local_file(path)
-  end
-end
 
-def get_json_from_server(path)
-  url = URI.parse(path)
-  conn = Faraday.new("#{url.scheme}://#{url.host}:#{url.port}") do |c|
-    if ENV['PACT_BROKER_USERNAME'] && ENV['PACT_BROKER_PASSWORD']
-      c.use Faraday::Request::BasicAuthentication, ENV['PACT_BROKER_USERNAME'], ENV['PACT_BROKER_PASSWORD']
+      def print_deprecation_note
+        if @options.provider_states_url
+          $stderr.puts "The --provider-states-url option is deprecated and the URL endpoint can be removed from the application"
+        end
+      end
     end
-    c.use FaradayMiddleware::ParseJson
-    c.use Faraday::Adapter::NetHttp
   end
-
-  response = conn.get(url.request_uri)
-  return response.body
-end
-
-def get_json_from_local_file(path)
-  file = File.read(path)
-  return JSON.parse(file)
 end

data/lib/pact/provider_verifier/cli.rb

@@ -8,13 +8,13 @@ module Pact
       desc 'verify', "Runs the Pact verification process"
       method_option :pact_urls, aliases: "-u", desc: "Comma-separated list of Pact file URIs. Supports local and networked (http-based) files", :required => true
       method_option :provider_base_url, aliases: "-h", desc: "Provide host URL", :required => true
-      method_option :provider_states_url, aliases: "-s", desc: "Base URL to retrieve the provider states from", :required => false
       method_option :provider_states_setup_url, aliases: "-c", desc: "Base URL to setup the provider states at", :required => false
       method_option :provider_app_version, aliases: "-a", desc: "The provider application version, required for publishing verification results", :required => false
       method_option :publish_verification_results, aliases: "-r", desc: "Publish verification results to the broker", required: false
       method_option :broker_username, aliases: "-n", desc: "Pact Broker username", :required => false
       method_option :broker_password, aliases: "-p", desc: "Pact Broker password", :required => false
       method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
+      method_option :provider_states_url, aliases: "-s", desc: "DEPRECATED", :required => false
 
       def verify
         app = Pact::ProviderVerifier::App.new(options)

data/lib/pact/provider_verifier/pact_helper.rb

@@ -2,45 +2,12 @@ require 'net/https'
 require 'faraday_middleware'
 require 'json'
 require_relative './app'
+require_relative 'set_up_provider_state'
+require 'pact/provider/configuration'
 
 # Responsible for making the call to the provider state server to set up the state
-if ENV['provider_states_url']
-  module ProviderStateServerClient
-    def set_up_state provider_state
-      if ENV['VERBOSE_LOGGING']
-        puts "Setting up provider state '#{provider_state}' for consumer '#{ENV['pact_consumer']}' using provider state server at #{ENV['provider_states_setup_url']}"
-      end
 
-      conn = Faraday.new(:url => ENV['provider_states_setup_url']) do |faraday|
-        if ENV['PACT_BROKER_USERNAME'] && ENV['PACT_BROKER_PASSWORD']
-          faraday.use Faraday::Request::BasicAuthentication, ENV['PACT_BROKER_USERNAME'], ENV['PACT_BROKER_PASSWORD']
-        end
-        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-      end
-      conn.post do |req|
-        req.headers["Content-Type"] = "application/json"
-        req.body = JSON.dump ({"consumer" => ENV['pact_consumer'], "state" => provider_state })
-      end
-    end
-  end
-
-  Pact.configure do | config |
-    config.include ProviderStateServerClient
-  end
-
-  # get the consumer provider states from the provider
-  provider_states = get_json(ENV['provider_states_url'])
-
-  # register the consumer provider states with pact
-  provider_states.keys.each do |consumer|
-    Pact.provider_states_for consumer do
-      provider_states[consumer].each do |state|
-        provider_state state do
-          set_up do
-            set_up_state state
-          end
-        end
-      end
-    end
-  end
+Pact.configure do | config |
+  config.provider_state_set_up = Pact::ProviderVerifier::SetUpProviderState
+  config.provider_state_tear_down = -> (*args){ }
 end

data/lib/pact/provider_verifier/set_up_provider_state.rb

@@ -0,0 +1,37 @@
+module Pact
+  module ProviderVerifier
+
+    class SetUpProviderStateError < StandardError; end
+
+    class SetUpProviderState
+
+      def self.call provider_state, consumer, options
+        if verbose?
+          puts "Setting up provider state '#{provider_state}' for consumer '#{consumer}' using provider state server at #{provider_states_setup_url}"
+        end
+
+        conn = Faraday.new(:url => provider_states_setup_url) do |faraday|
+          faraday.adapter  Faraday.default_adapter
+        end
+        response = conn.post do |req|
+          req.headers["Content-Type"] = "application/json"
+          req.body = {consumer: consumer, state: provider_state }.to_json
+        end
+
+        # Not sure about this?
+        # if response.status >= 300
+        #   raise SetUpProviderStateError.new("Error setting up provider state '#{provider_state}' for consumer '#{consumer}' at #{provider_states_setup_url}. response status=#{response.status} response.body=#{response.body}")
+        # end
+
+      end
+
+      def self.provider_states_setup_url
+        ENV['provider_states_setup_url']
+      end
+
+      def self.verbose?
+        ENV['VERBOSE_LOGGING']
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.0.2"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Fellows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: pact-provider-proxy
   requirement: !ruby/object:Gem::Requirement
@@ -86,34 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: pact-mock_service
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: pact-support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +153,7 @@ files:
 - lib/pact/provider_verifier/app.rb
 - lib/pact/provider_verifier/cli.rb
 - lib/pact/provider_verifier/pact_helper.rb
+- lib/pact/provider_verifier/set_up_provider_state.rb
 - lib/pact/provider_verifier/version.rb
 homepage: https://github.com/pact-foundation/pact-provider-verifier
 licenses:
@@ -202,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Provides a Pact verification service for use with Pact