pact-provider-verifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7a5fd688d1159700ffd162bbd72100520e2bfc6
+  data.tar.gz: 4c21909a48dfffe600806b01375eef4f94bb42ad
+SHA512:
+  metadata.gz: a6967ba29737b5b2d2cba5f5033c9d358d43048c8e02cd690f88cc7abf1ef9461313021e95f23918b65cf385bfbd134a97433302fc3e6badd849287fe61e7df8
+  data.tar.gz: 79214d06a799bd5ad95d98c5fcd19e48ce7000113b45fa907a6e52bd7b24c17f902c4eef83b1f181295da0631ec964ca5d8ecb42732c5dbb2bfc2b521800708b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+Do this to generate your change history
+
+  git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
+
+### 0.0.1 (8 May 2016)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

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,84 @@
+# Pact Provider Verification
+
+This setup simplifies Pact Provider [verification](https://github.com/realestate-com-au/pact#2-tell-your-provider-that-it-needs-to-honour-the-pact-file-you-made-earlier)
+process in any language, wrapping the Ruby implementation into a cross-platform,
+binary-like CLI tool.
+
+**Features**:
+
+* Verify Pacts against Pacts published to an http endpoint, such as a [Pact Broker](https://github.com/bethesque/pact_broker)
+* Verify local `*.json` Pacts on the file system
+* Works with Pact [provider states](https://github.com/realestate-com-au/pact/wiki/Provider-states) should you need them
+
+## Installation
+
+### Native Installation
+
+Download the appropriate [release](https://github.com/pact-foundation/pact-provider-verifier/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-mock-service help` for command line options.
+
+## Examples
+
+See the [examples](examples) directory for a real working API example:
+
+```
+cd examples
+./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 flags:
+   * `--pact_urls` - a comma delimited list of pact file urls
+   * `--provider_base_url` - the base url of the pact provider (i.e. your API)
+1.
+
+### API with Provider States
+
+Execute pact provider verification against a provider which implements the following:
+
+* an http get endpoint which returns pact provider_states by consumer
+
+		{
+			"myConsumer": [
+				"customer is logged in",
+				"customer has a million dollars"
+			]
+		}
+
+* an http post endpoint which sets the active pact consumer and provider state
+
+		consumer=web&state=customer%20is%20logged%20in
+
+The following environment variables 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
+
+
+## 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

data/bin/pact-provider-verifier

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'pact/provider_verifier/cli'
+Pact::ProviderVerifier::CLI.start

data/lib/pact/provider_verifier.rb

@@ -0,0 +1 @@
+require 'pact/provider_verifier/app'

data/lib/pact/provider_verifier/Rakefile

@@ -0,0 +1,38 @@
+require 'pact/provider/proxy/tasks'
+require 'pact/provider_verifier/json_helper'
+
+# make sure that the required environment variables are sets
+required_environment_variables = ['pact_urls', 'provider_base_url']
+missing_environment_variables = required_environment_variables.select { |ev| ENV[ev].to_s == '' }
+if missing_environment_variables.count > 0 then
+  raise("ERROR: the following environment variables have not been specified: '#{missing_environment_variables}'")
+end
+
+# Non-mandatory, but probably useful environment variables
+other_environment_variables = ['provider_states_url', 'provider_states_setup_url']
+missing_environment_variables = other_environment_variables.select { |ev| ENV[ev].to_s == '' }
+if missing_environment_variables.count > 0 then
+  warn("WARN: the following non-mandatory environment variables have not been specified: '#{missing_environment_variables}'")
+end
+
+pacts = ENV['pact_urls'].split(',')
+# if you have duplicates in the pact_urls you will see more iterations than expected,
+# but that shouldn't be the case except when you're trying stuff out in dev
+
+def get_pact_consumer_name pact_url
+    json = get_json(pact_url)
+    json['consumer']['name']
+end
+
+task :verify_pacts do
+    pacts.each do |pact_url|
+        Pact::ProxyVerificationTask.new :"#{pact_url}" do | task |
+            ENV['pact_consumer'] = get_pact_consumer_name(pact_url)
+            task.pact_url pact_url, :pact_helper => './pact_helper'
+            task.provider_base_url ENV['provider_base_url']
+        end
+        task_name = "pact:verify:#{pact_url}"
+        Rake::Task[task_name].invoke
+        Rake::Task[task_name].reenable
+    end
+end

data/lib/pact/provider_verifier/app.rb

@@ -0,0 +1,78 @@
+require 'pact/provider/proxy/tasks'
+require 'pact/provider/proxy'
+require 'net/https'
+require 'faraday_middleware'
+require 'json'
+
+module Pact
+  module ProviderVerifier
+
+    def self.new *args
+      App.new(*args)
+    end
+
+    class App
+      def initialize options = {}
+        require 'pp'
+        pp options
+        @options = options
+      end
+
+      def call env
+        @app.call env
+      end
+
+      def to_s
+        "#{@name} #{super.to_s}"
+      end
+
+      def get_pact_consumer_name pact_url
+        json = get_json(pact_url)
+        json['consumer']['name']
+      end
+
+      def verify_pacts
+        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
+
+        pacts.each do |pact_url|
+            Pact::ProxyVerificationTask.new :"#{pact_url}" do | task |
+                ENV['pact_consumer'] = get_pact_consumer_name(pact_url)
+                task.pact_url pact_url, :pact_helper => proxy_pact_helper
+                task.provider_base_url @options.provider_base_url
+            end
+            task_name = "pact:verify:#{pact_url}"
+            Rake::Task[task_name].invoke
+            Rake::Task[task_name].reenable
+        end
+      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("http://#{url.host}:#{url.port}") do |c|
+    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

@@ -0,0 +1,21 @@
+require 'thor'
+require 'socket'
+require 'pact/provider_verifier/app'
+
+module Pact
+  module ProviderVerifier
+    class CLI < Thor
+      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
+
+      def verify
+        app = Pact::ProviderVerifier::App.new(options)
+      end
+
+      default_task :verify
+    end
+  end
+end

data/lib/pact/provider_verifier/pact_helper.rb

@@ -0,0 +1,41 @@
+require 'net/https'
+require 'faraday_middleware'
+require 'json'
+require_relative './app'
+
+# 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
+      puts "Setting up provider state '#{provider_state}' for consumer '#{ENV['pact_consumer']}' using provider state server at #{ENV['provider_states_setup_url']}"
+
+      conn = Faraday.new(:url => ENV['provider_states_setup_url']) do |faraday|
+        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
+end

data/lib/pact/provider_verifier/version.rb

@@ -0,0 +1,5 @@
+module Pact
+  module ProviderVerifier
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: pact-provider-verifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Fellows
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pact
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: pact-provider-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: |-
+  A cross-platform Pact verification tool to validate API Providers.
+                        Used in the pact-js-provider project to simplify development
+email:
+- m@onegeek.com.au
+executables:
+- pact-provider-verifier
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/pact-provider-verifier
+- lib/pact/provider_verifier.rb
+- lib/pact/provider_verifier/Rakefile
+- lib/pact/provider_verifier/app.rb
+- lib/pact/provider_verifier/cli.rb
+- lib/pact/provider_verifier/pact_helper.rb
+- lib/pact/provider_verifier/version.rb
+homepage: https://github.com/pact-foundation/pact-provider-verifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Provides a Pact verification service for use with Pact
+test_files: []