pact-provider-proxy 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2E2ZmE4NTgyMjYyMDMyZTA2ZGQ4YzFkYzMxYWY0MDBhMmI5ZGQxNQ==
+  data.tar.gz: !binary |-
+    MzEwOWRiYTc3ZWE3MDJiZTY1YTliNjdmNDVjYTc2NDQ0M2I1M2M3Zg==
+SHA512:
+  metadata.gz: !binary |-
+    YzQ1MjUyYzFjZGIyODhlYTk4Nzk3NGE4MjYxMmYxMTcwOWE3MjJhMjYzMWIx
+    MzZmOGI3Mzg4OGNmMWZmMThiNDY3ZmQ1MjUzZjhlZWM3MDkzYjkwZmQwYTg1
+    OWYxMmQ4ZGU0M2M1ZDM3YzIyZDRkMDA5YjI0ZjdjN2U0ODE1ZDU=
+  data.tar.gz: !binary |-
+    MmNjYTNjOGQ2NTE2NmE0MzAwMTdhY2ExMWYyNmYxNzM4MThlMzAwMmFiYmNj
+    MmU3MGQyZDY4NTA1NTQ0MmU1NTZlMzk1NmU5MjNmYTJmY2NiM2VlZjI1MDI3
+    OGE4NGUzZTlmMGE0ZTNjMzFkNzUwOGQ1YTAwZTFhZWVlN2NmMzg=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+reports
+log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pact-proxy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Beth
+
+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,77 @@
+# Pact::Proxy
+
+Allows pact verification against a running provider at a configurable base URL (normal pact verification is run against a code base using Rack::Test::Methods - no process is actually spawned).
+
+This allows testing against providers where you have access to a running instance of a provider, but you do not have access to its code base, or where the provider is not a ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pact-proxy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pact-proxy
+
+## Usage
+
+Usually, you would configure and run pact:verify in the provider code base.
+If you are using a pact-proxy to run your pact verify task, it is probably because you don't have access to the code base of the provider project, or it is not a ruby project, so it may make sense to include this task in your consumer project.
+
+Specifying a pact_helper is optional, and is only required if you are using provider states.
+
+```ruby
+require 'pact/provider/proxy/tasks'
+
+Pact::ProxyVerificationTask.new :monolith do | task |
+ task.pact_url './spec/pacts/my-consumer_my-monolith.json', :pact_helper => './spec/support/monolith_pact_helper'
+ task.provider_base_url 'http://my-monolith'
+end
+```
+
+Then run:
+
+    $ rake pact:verify:monolith
+
+If you have access to your provider code base, and are able to spawn an instance locally, you could add some rake tasks to start and stop your server. (Please note, I have actually run this code, I just think it should work...)
+
+```ruby
+
+Pact::ProxyVerificationTask.new :running_local_monolith do | task |
+ task.pact_url './spec/pacts/my-consumer_my-local-monolith.json'
+ task.provider_base_url 'http://localhost:8080'
+end
+
+task :start_provider do
+  system "./provider_start -p 8080"
+end
+
+task :stop_provider do
+  system "./provider_stop"
+end
+
+task 'pact:verify:local_monolith' do
+  begin
+    Rake::Task['start_provider'].execute
+    Rake::Task['pact:verify:running_local_monolith'].execute
+  ensure
+    Rake::Task['stop_provider'].execute
+  end
+end
+
+```
+
+If a ruby adapter to the underlying datastore cannot be used to set up provider states, shell scripts that invoke code in the native language might work. If you have access to the code base, another alternative could be to provide an endpoint on your app that sets up data inside itself, that is only mounted in test mode. eg 'http://localhost:8080/setUpProviderState?name=a%20thing%20exists' and 'http://localhost:8080/tearDownProviderState?name=a%20thing%20exists'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+
+Dir.glob("./spec/**/*.rake") { |file| load file  }

data/lib/pact/provider/proxy.rb

@@ -0,0 +1,9 @@
+require "pact/provider/proxy/version"
+
+module Pact
+  module Provider
+    module Proxy
+    # Your code goes here...
+    end
+  end
+end

data/lib/pact/provider/proxy/configure_service_provider.rb

@@ -0,0 +1,22 @@
+require 'pact/provider/rspec'
+require 'rack/reverse_proxy'
+
+module Pact
+  module Proxy
+
+    class ConfigureServiceProvider
+
+      def self.call provider_base_url
+
+        Pact.service_provider "Running Provider Application" do
+          app do
+            Rack::ReverseProxy.new do
+              reverse_proxy '/', provider_base_url
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/provider/proxy/pact_helper.rb

@@ -0,0 +1 @@
+# No op

data/lib/pact/provider/proxy/tasks.rb

@@ -0,0 +1 @@
+require 'pact/provider/proxy/tasks/proxy_verification_task'

data/lib/pact/provider/proxy/tasks/proxy_verification_task.rb

@@ -0,0 +1,57 @@
+require 'rake/tasklib'
+require 'pact/tasks/task_helper'
+
+module Pact
+  class ProxyVerificationTask < ::Rake::TaskLib
+
+    include Pact::TaskHelper
+
+    attr_reader :pact_spec_configs
+
+    def initialize(name)
+      @pact_spec_configs = []
+      @provider_base_url = nil
+      @name = name
+      yield self
+      rake_task
+    end
+
+
+    def pact_url(uri, options = {})
+      @pact_spec_configs << {uri: uri, pact_helper: options.fetch(:pact_helper, pact_helper_url)}
+    end
+
+    # For compatiblity with the normal VerificationTask, allow task.uri
+    alias_method :uri, :pact_url
+
+    def provider_base_url url
+      @provider_base_url = url
+    end
+
+    def pact_helper_url
+      File.expand_path('../../../pact_helper', __FILE__)
+    end
+
+    private
+
+    attr_reader :name
+
+    def rake_task
+      namespace :pact do
+        desc "Verify provider against the consumer pacts for #{name}"
+        task "verify:#{name}", :description, :provider_state do |t, args|
+
+          require 'pact/provider/pact_spec_runner'
+          require 'pact/provider/proxy/configure_service_provider'
+
+          Pact::Proxy::ConfigureServiceProvider.call @provider_base_url
+          options = {criteria: spec_criteria(args)}
+
+          handle_verification_failure do
+            Provider::PactSpecRunner.new(@pact_spec_configs, options).run
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/proxy/version.rb

@@ -0,0 +1,7 @@
+module Pact
+  module Provider
+    module Proxy
+      VERSION = "0.0.2"
+    end
+  end
+end

data/pact-provider-proxy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pact/provider/proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pact-provider-proxy"
+  spec.version       = Pact::Provider::Proxy::VERSION
+  spec.authors       = ["Beth"]
+  spec.email         = ["beth@bethesque.com"]
+  spec.description   = %q{See summary}
+  spec.summary       = %q{Allows verification of a pact against a running provider}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack-reverse-proxy"
+  spec.add_dependency "pact"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/support/pact.json

@@ -0,0 +1,18 @@
+{
+  "consumer" : { "name": "a consumer"},
+  "provider" : { "name": "a running provider"},
+  "interactions": [
+    {
+      "description": "a request for the index",
+      "provider_state": "some state",
+      "request" : {
+        "method" : "get", "path": "/"
+        },
+      "response": {
+        "status" : 200,
+        "body": "Monolith!"
+      }
+    }
+
+  ]
+}

data/spec/support/pact_helper.rb

@@ -0,0 +1,7 @@
+require 'pact/provider/rspec'
+
+Pact.provider_states_for "a consumer" do
+  provider_state "some state" do
+    no_op
+  end
+end

data/spec/tasks.rake

@@ -0,0 +1,21 @@
+require 'pact/provider/proxy/tasks'
+
+Pact::ProxyVerificationTask.new :monolith do | task |
+ task.pact_url './spec/support/pact.json', :pact_helper => './spec/support/pact_helper'
+ task.provider_base_url 'http://localhost:9292'
+end
+
+namespace :pact do
+  namespace :test do
+    task :spawn_test_monolith do
+      require 'pact/consumer/app_manager'
+      Pact::Consumer::AppManager.instance.register lambda { | env | [200, {}, ["Monolith!"]] }, 9292
+      Pact::Consumer::AppManager.instance.spawn_all
+    end
+  end
+end
+
+task 'pact:verify:monolith' => 'pact:test:spawn_test_monolith'
+
+task :spec => ['pact:verify:monolith']
+task :default => [:spec]

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: pact-provider-proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Beth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-reverse-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pact
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: See summary
+email:
+- beth@bethesque.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pact/provider/proxy.rb
+- lib/pact/provider/proxy/configure_service_provider.rb
+- lib/pact/provider/proxy/pact_helper.rb
+- lib/pact/provider/proxy/tasks.rb
+- lib/pact/provider/proxy/tasks/proxy_verification_task.rb
+- lib/pact/provider/proxy/version.rb
+- pact-provider-proxy.gemspec
+- spec/support/pact.json
+- spec/support/pact_helper.rb
+- spec/tasks.rake
+homepage: ''
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Allows verification of a pact against a running provider
+test_files:
+- spec/support/pact.json
+- spec/support/pact_helper.rb
+- spec/tasks.rake