pact_broker-client 0.0.1

data/spec/service_providers/pact_broker_client_spec.rb

@@ -0,0 +1,363 @@
+require_relative 'pact_helper'
+require 'pact_broker/client'
+
+def silence_warnings
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+ensure
+  $VERBOSE = old_verbose
+end
+
+module PactBroker::Client
+  describe PactBrokerClient, :pact => true do
+
+    before do
+      @backup_version = PactBroker::Client::VERSION
+      silence_warnings do
+        PactBroker::Client::VERSION = "2.0.0"
+      end
+    end
+
+    after do
+      silence_warnings do
+        PactBroker::Client::VERSION = @backup_version
+      end
+    end
+
+    let(:pact_hash) { {consumer: {name: 'Condor'}, provider: {name: 'Pricing Service'}, interactions: []} }
+    let(:consumer_contract) { Pact::ConsumerContract.from_hash pact_hash }
+    let(:pact_json) { pact_hash.to_json }
+    let(:pact_broker_client) { PactBrokerClient.new(base_url: 'http://localhost:1234') }
+    let(:consumer_version) { '1.3.0' }
+    let(:version) { '1.3.0' }
+    let(:pact_broker_version) { Pact::Term.new(:matcher => /\d+\.\d+\.\d+/, :generate => '1.0.0') }
+    let(:pact_broker_response_headers) { {} }
+    let(:default_request_headers) { { 'Content-Type' => 'application/json'} }
+    let(:patch_request_headers)   { { 'Content-Type' => 'application/json+patch'} }
+    let(:get_request_headers)     { { 'Accept' => 'application/json'} }
+
+    describe "publishing a pact" do
+
+      let(:options) { { pact: pact_json, consumer_version: consumer_version }}
+
+      context "when the provider already exists in the pact-broker" do
+        before do
+          pact_broker.
+          given("the 'Pricing Service' already exists in the pact-broker").
+          upon_receiving("a request to publish a pact").
+          with({
+              method: :put,
+              path: '/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service',
+              headers: default_request_headers,
+              body: pact_hash }).
+            will_respond_with( headers: pact_broker_response_headers,
+              status: 201
+            )
+        end
+        it "returns true" do
+            pact_broker_client.pacticipants.versions.pacts.publish options
+        end
+      end
+
+      context "when the provider, consumer, pact and version already exist in the pact-broker" do
+        before do
+          pact_broker.
+          given("the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0").
+          upon_receiving("a request to publish a pact").
+          with({
+              method: :put,
+              path: '/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service',
+              headers: default_request_headers,
+              body: pact_hash }).
+            will_respond_with( headers: pact_broker_response_headers,
+              status: 200
+            )
+        end
+        it "returns true" do
+            pact_broker_client.pacticipants.versions.pacts.publish options
+        end
+      end
+
+      context "when the provider does not exist, but the consumer, pact and version already exist in the pact-broker" do
+        before do
+          pact_broker.
+          given("'Condor' already exist in the pact-broker, but the 'Pricing Service' does not").
+          upon_receiving("a request to publish a pact").
+          with({
+              method: :put,
+              path: '/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service',
+              headers: default_request_headers,
+              body: pact_hash }).
+            will_respond_with( headers: pact_broker_response_headers,
+              status: 201
+            )
+        end
+        it "returns true" do
+            pact_broker_client.pacticipants.versions.pacts.publish options
+        end
+      end
+
+      context "when publishing is not successful" do
+        before do
+          pact_broker.
+          given("an error occurs while publishing a pact").
+          upon_receiving("a request to publish a pact").
+          with({
+              method: :put,
+              path: '/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service',
+              headers: default_request_headers,
+              body: pact_hash }).
+            will_respond_with({
+              status: 500,
+              headers: pact_broker_response_headers,
+              body: {
+                message: Pact::Term.new(matcher: /.*/, generate: 'An error occurred')
+              }
+            })
+        end
+        it "raises an error" do
+          expect { pact_broker_client.pacticipants.versions.pacts.publish options }.to raise_error /An error occurred/
+        end
+      end
+
+    end
+
+    let(:repository_url ) { "git@git.realestate.com.au:business-systems/condor.git" }
+
+    describe "registering a repository url" do
+      context "where the pacticipant does not already exist in the pact-broker" do
+        before do
+          pact_broker.
+          given("the 'Pricing Service' does not exist in the pact-broker").
+          upon_receiving("a request to register the repository URL of a pacticipant").
+          with(
+              method: :patch,
+              path: '/pacticipant/Pricing%20Service',
+              headers: patch_request_headers,
+              body: {repository_url: repository_url} ).
+            will_respond_with(
+              status: 201,
+              headers: pact_broker_response_headers
+            )
+        end
+        it "returns true" do
+          expect(pact_broker_client.pacticipants.update({:pacticipant => 'Pricing Service', :repository_url => repository_url})).to be_true
+        end
+      end
+      context "where the 'Pricing Service' exists in the pact-broker" do
+        before do
+          pact_broker.
+          given("the 'Pricing Service' already exists in the pact-broker").
+          upon_receiving("a request to register the repository URL of a pacticipant").
+          with(
+              method: :patch,
+              path: '/pacticipant/Pricing%20Service',
+              headers: patch_request_headers,
+              body: {repository_url: repository_url} ).
+            will_respond_with(
+              status: 200,
+              headers: pact_broker_response_headers
+            )
+        end
+        it "returns true" do
+          expect(pact_broker_client.pacticipants.update({:pacticipant => 'Pricing Service', :repository_url => repository_url})).to be_true
+        end
+      end
+    end
+
+    describe "retrieving a repository url" do
+      context "where the pacticipant does not already exist in the pact-broker" do
+        before do
+          pact_broker.
+          given("the 'Pricing Service' does not exist in the pact-broker").
+          upon_receiving("a request to retrieve the repository URL of the 'Pricing Service'").
+          with(
+              method: :get,
+              path: '/pacticipant/Pricing%20Service/repository_url',
+              headers: get_request_headers.merge({'Accept' => 'text/plain'})).
+            will_respond_with(
+              status: 404,
+              headers: pact_broker_response_headers
+            )
+        end
+        it "returns nil" do
+          expect(pact_broker_client.pacticipants.repository_url({:pacticipant => 'Pricing Service'})).to eq(nil)
+        end
+      end
+      context "where the 'Pricing Service' exists in the pact-broker" do
+        before do
+          pact_broker.
+          given("the 'Pricing Service' already exists in the pact-broker").
+          upon_receiving("a request to retrieve the repository URL of the 'Pricing Service'").
+          with(
+              method: :get,
+              path: '/pacticipant/Pricing%20Service/repository_url',
+              headers: get_request_headers.merge({'Accept' => 'text/plain'})).
+            will_respond_with(
+              status: 200,
+              headers: pact_broker_response_headers.merge({'Content-Type' => 'text/plain;charset=utf-8'}),
+              body: repository_url
+            )
+        end
+        it "returns the URL" do
+          expect(pact_broker_client.pacticipants.repository_url({:pacticipant => 'Pricing Service'})).to eq repository_url
+        end
+      end
+    end
+
+    describe "tagging a version with prod details" do
+      let(:repository_ref) { "packages/condor-#{version}" }
+
+      let(:tag_options) { {pacticipant: 'Condor', version: version, repository_ref: repository_ref, repository_url: repository_url, :tag => 'prod'} }
+      context "when the component exists" do
+        before do
+          pact_broker.
+          given("'Condor' exists in the pact-broker").
+          upon_receiving("a request to tag the production version of Condor").
+          with(
+              method: :patch,
+              path: '/pacticipant/Condor/versions/1.3.0',
+              headers: patch_request_headers,
+              body: {:tags => ['prod'], :repository_ref => repository_ref, :repository_url => repository_url} ).
+            will_respond_with(
+              status: 200,
+              headers: pact_broker_response_headers
+            )
+        end
+        it "returns true" do
+          expect(pact_broker_client.pacticipants.versions.update tag_options).to be_true
+        end
+      end
+      context "when the component does not exist" do
+        before do
+          pact_broker.
+          given("'Condor' does not exist in the pact-broker").
+          upon_receiving("a request to tag the production version of Condor").
+          with(
+              method: :patch,
+              path: '/pacticipant/Condor/versions/1.3.0',
+              headers: patch_request_headers,
+              body: {:tags => ['prod'], :repository_ref => repository_ref, :repository_url => repository_url} ).
+            will_respond_with(
+              status: 201,
+              headers: pact_broker_response_headers
+            )
+        end
+        it "returns true" do
+          expect(pact_broker_client.pacticipants.versions.update tag_options).to be_true
+        end
+      end
+    end
+
+    describe "retrieving a pact" do
+      describe "finding the latest version" do
+        context "when a pact is found" do
+
+          let(:response_headers) { pact_broker_response_headers.merge({'Content-Type' => 'application/json;charset=utf-8', 'X-Pact-Consumer-Version' => consumer_version}) }
+          before do
+            pact_broker.
+            given("a pact between Condor and the Pricing Service exists").
+            upon_receiving("a request to retrieve the latest pact between Condor and the Pricing Service").
+            with({
+                method: :get,
+                path: '/pacticipant/Condor/versions/last/pacts/Pricing%20Service',
+                headers: get_request_headers
+            }).
+            will_respond_with({
+              status: 200,
+              headers: response_headers,
+              body: pact_hash
+            })
+          end
+
+          it "returns the pact json" do
+            response = pact_broker_client.pacticipants.versions.pacts.last consumer: 'Condor', provider: 'Pricing Service'
+            expect(response).to eq(pact_json)
+          end
+
+        end
+        context "when no pact is found" do
+          before do
+            pact_broker.
+            given("no pact between Condor and the Pricing Service exists").
+            upon_receiving("a request to retrieve the latest pact between Condor and the Pricing Service").
+            with({
+                method: :get,
+                path: '/pacticipant/Condor/versions/last/pacts/Pricing%20Service',
+                headers: get_request_headers
+            }).
+            will_respond_with({
+              status: 404,
+              headers: pact_broker_response_headers
+            })
+          end
+          it "returns nil" do
+            response = pact_broker_client.pacticipants.versions.pacts.last consumer: 'Condor', provider: 'Pricing Service'
+            expect(response).to eq(nil)
+          end
+        end
+      end
+      describe "finding the latest production version" do
+        context "when a pact is found" do
+          before do
+            pact_broker.
+            given("a pact between Condor and the Pricing Service exists for the production version of Condor").
+            upon_receiving("a request to retrieve the pact between the production verison of Condor and the Pricing Service").
+            with({
+                method: :get,
+                path: '/pacticipant/Condor/versions/last/pacts/Pricing%20Service',
+                query: 'tag=prod',
+                headers: get_request_headers
+            }).
+            will_respond_with({
+              status: 200,
+              headers: {'Content-Type' => 'application/json;charset=utf-8', 'X-Pact-Consumer-Version' => consumer_version},
+              body: pact_hash,
+              headers: pact_broker_response_headers
+            })
+          end
+
+          it "returns the pact json" do
+            response = pact_broker_client.pacticipants.versions.pacts.last consumer: 'Condor', provider: 'Pricing Service', tag: 'prod'
+            expect(response).to eq(pact_json)
+          end
+        end
+      end
+    end
+
+    describe "retriving versions" do
+      context "when retrieving the production details of a version" do
+        context "when a version is found" do
+          let(:repository_url) { "git@git.realestate.com.au:business-systems/pricing-service.git" }
+          let(:repository_ref) { "package/pricing-service-1.2.3"}
+          let(:tags) { ['prod']}
+          let(:body) { { number: '1.2.3', repository_url: repository_url, repository_ref: repository_ref, tags: tags } }
+          before do
+            pact_broker.
+              given("a version with production details exists for the Pricing Service").
+              upon_receiving("a request for the latest version tagged with 'prod'").
+              with(method: :get, path: '/pacticipant/Pricing%20Service/versions/last', query: 'tag=prod', headers: get_request_headers).
+              will_respond_with( status: 200,
+                headers: pact_broker_response_headers.merge({'Content-Type' => 'application/json;charset=utf-8'}),
+                body: body )
+          end
+          it 'returns the version details' do
+            expect( pact_broker_client.pacticipants.versions.last pacticipant: 'Pricing Service', tag: 'prod' ).to eq body
+          end
+        end
+      end
+      context "when a version is not found" do
+        before do
+          pact_broker.
+            given("no version exists for the Pricing Service").
+            upon_receiving("a request for the latest version").
+            with(method: :get, path: '/pacticipant/Pricing%20Service/versions/last', headers: get_request_headers).
+            will_respond_with( status: 404, headers: pact_broker_response_headers )
+        end
+        it 'returns nil' do
+          expect( pact_broker_client.pacticipants.versions.last pacticipant: 'Pricing Service' ).to eq nil
+        end
+      end
+    end
+  end
+end

data/spec/service_providers/pact_helper.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'pact/consumer/rspec'
+
+
+Pact.service_consumer 'Pact Broker Client' do
+
+  has_pact_with "Pact Broker" do
+    mock_service :pact_broker do
+      port 1234
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec/fire'
+
+RSpec.configure do | config |
+  config.include RSpec::Fire
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: pact_broker-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bethany Skurrie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pact
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Publishes pacts to, and retrieves pacts from, the pact broker server.
+email:
+- bskurrie@dius.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- ci.sh
+- lib/pact_broker/client.rb
+- lib/pact_broker/client/base_client.rb
+- lib/pact_broker/client/pact_broker_client.rb
+- lib/pact_broker/client/pacticipants.rb
+- lib/pact_broker/client/pacts.rb
+- lib/pact_broker/client/publish_pacts.rb
+- lib/pact_broker/client/tasks.rb
+- lib/pact_broker/client/tasks/publication_task.rb
+- lib/pact_broker/client/version.rb
+- lib/pact_broker/client/versions.rb
+- lib/pact_broker_client.rb
+- pact-broker-client.gemspec
+- spec/lib/pact_broker/client/pact_broker_client_spec.rb
+- spec/lib/pact_broker/client/publish_pacts_spec.rb
+- spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/pacts/pact_broker_client-pact_broker.json
+- spec/service_providers/pact_broker_client_spec.rb
+- spec/service_providers/pact_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bethesque/pact_broker-client.git
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 26826033088449580
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 26826033088449580
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: See description
+test_files:
+- spec/lib/pact_broker/client/pact_broker_client_spec.rb
+- spec/lib/pact_broker/client/publish_pacts_spec.rb
+- spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/pacts/pact_broker_client-pact_broker.json
+- spec/service_providers/pact_broker_client_spec.rb
+- spec/service_providers/pact_helper.rb
+- spec/spec_helper.rb