pact_broker 2.4.2 → 2.5.0

data/db/test/backwards_compatibility/gemfiles/head.gemfile.lock

@@ -0,0 +1,200 @@
+PATH
+  remote: ../../../..
+  specs:
+    pact_broker (2.4.2)
+      dry-types (~> 0.10.3)
+      dry-validation (~> 0.10.5)
+      haml (~> 4.0)
+      httparty (~> 0.14)
+      json (> 1.8, < 3.0)
+      pact (~> 1.14)
+      padrino-core (~> 0.14.1)
+      rack (~> 2.0)
+      rack-protection (~> 2.0)
+      redcarpet (~> 3.3, >= 3.3.2)
+      reform (~> 2.2)
+      roar (~> 1.1)
+      semver2 (~> 3.4.2)
+      sequel (~> 4.23)
+      sucker_punch (~> 2.0)
+      webmachine (= 1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    as-notifications (1.0.1)
+    awesome_print (1.8.0)
+    concurrent-ruby (1.0.5)
+    daemons (1.2.4)
+    declarative (0.0.9)
+    declarative-builder (0.1.0)
+      declarative-option (< 0.2.0)
+    declarative-option (0.1.0)
+    diff-lcs (1.3)
+    disposable (0.4.3)
+      declarative (>= 0.0.9, < 1.0.0)
+      declarative-builder (< 0.2.0)
+      declarative-option (< 0.2.0)
+      representable (>= 2.4.0, <= 3.1.0)
+      uber (< 0.2.0)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.3.3)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.0)
+    dry-logic (0.4.1)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.10.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.10.7)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.9, >= 0.9.0)
+    enumerable-lazy (0.0.2)
+    eventmachine (1.2.5)
+    find_a_port (1.0.1)
+    haml (4.0.7)
+      tilt
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    i18n (0.8.6)
+    inflecto (0.0.2)
+    json (2.1.0)
+    multi_json (1.12.2)
+    multi_xml (0.6.0)
+    mustermann (1.0.1)
+    mustermann19 (0.4.4)
+      enumerable-lazy
+    mysql2 (0.3.21)
+    pact (1.15.0)
+      json (> 1.8.5)
+      pact-mock_service (~> 2.0)
+      pact-support (~> 1.1)
+      rack-test (~> 0.6.2)
+      randexp (~> 0.1.7)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+      thor
+      webrick
+    pact-mock_service (2.1.0)
+      find_a_port (~> 1.0.1)
+      json
+      pact-support (~> 1.0)
+      rack
+      rack-test (~> 0.6.2)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+      thor
+      webrick
+    pact-support (1.1.6)
+      awesome_print (~> 1.1)
+      find_a_port (~> 1.0.1)
+      json
+      rack-test (~> 0.6.2)
+      randexp (~> 0.1.7)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+      thor
+    padrino-core (0.14.1.1)
+      mustermann19
+      padrino-support (= 0.14.1.1)
+      rack-protection (>= 1.5.0)
+      sinatra (>= 1.4.6)
+      thor (~> 0.18)
+    padrino-support (0.14.1.1)
+    pg (0.21.0)
+    rack (2.0.3)
+    rack-protection (2.0.0)
+      rack
+    rack-proxy (0.6.2)
+      rack
+    rack-reverse-proxy (0.12.0)
+      rack (>= 1.0.0)
+      rack-proxy (~> 0.6, >= 0.6.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (12.0.0)
+    randexp (0.1.7)
+    redcarpet (3.4.0)
+    reform (2.2.4)
+      disposable (>= 0.4.1)
+      representable (>= 2.4.0, < 3.1.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    roar (1.1.0)
+      representable (~> 3.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    semver2 (3.4.2)
+    sequel (4.49.0)
+    sinatra (2.0.0)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.0)
+      tilt (~> 2.0)
+    sqlite3 (1.3.13)
+    sucker_punch (2.0.3)
+      concurrent-ruby (~> 1.0.0)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thor (0.20.0)
+    tilt (2.0.8)
+    tins (1.15.0)
+    uber (0.1.0)
+    webmachine (1.5.0)
+      as-notifications (~> 1.0)
+      i18n (>= 0.4.0)
+      multi_json
+    webrick (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  mysql2 (~> 0.3.15)
+  pact_broker!
+  pg (~> 0.21)
+  rack-reverse-proxy (~> 0.12)
+  rake (~> 12.0)
+  rspec
+  sqlite3 (~> 1.3)
+  thin (~> 1.3)
+
+BUNDLED WITH
+   1.15.4

data/db/test/backwards_compatibility/spec/fixtures/foo-bar.json

@@ -0,0 +1,22 @@
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description" : "a request for something",
+      "providerState": null,
+      "request": {
+        "method": "get",
+        "path" : "/something"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    }
+  ]
+}

data/db/test/backwards_compatibility/spec/publish_pact_spec.rb

@@ -0,0 +1,72 @@
+require 'rack/reverse_proxy'
+require 'securerandom'
+
+CODE_VERSION = ENV.fetch('PACT_BROKER_CODE_VERSION')
+DATABASE_VERSION = ENV.fetch('PACT_BROKER_DATABASE_VERSION')
+CONSUMER_VERSION = CODE_VERSION == 'head' ? '100.100.100' : CODE_VERSION
+TAG = SecureRandom.hex
+
+describe "Code version #{CODE_VERSION} running against database version #{DATABASE_VERSION}" do
+
+  before do
+    wait_for_server_to_start
+  end
+
+  let(:path) { "/pacts/provider/Bar/consumer/Foo/version/#{CONSUMER_VERSION}" }
+  let(:response_body_json) { JSON.parse(subject.body) }
+  let(:pact_content) do
+    pact = load_json_fixture('foo-bar.json')
+    pact['interactions'][0]['providerState'] = "the code version is #{CODE_VERSION}"
+    pact.to_json
+  end
+
+  let(:app) do
+    Rack::ReverseProxy.new do
+      reverse_proxy_options preserve_host: true
+      reverse_proxy '/', "http://localhost:#{ENV.fetch('PORT')}/"
+    end
+  end
+
+  describe "tagging a consumer version" do
+    let(:path) { "/pacticipants/Foo/versions/#{CONSUMER_VERSION}/tags/#{TAG}"}
+    subject { put path, nil, {'CONTENT_TYPE' => 'application/json' }; last_response  }
+
+    it "returns a success status" do
+      expect(subject.status.to_s).to match /20\d/
+    end
+  end
+
+  describe "publishing a pact" do
+    subject { put path, pact_content, {'CONTENT_TYPE' => 'application/json' }; last_response  }
+
+    it "returns a success status" do
+      expect(subject.status.to_s).to match /20\d/
+    end
+  end
+
+  describe "retrieving a pact" do
+    subject { get path; last_response  }
+
+    it "returns the pact in the body" do
+      expect(response_body_json).to include JSON.parse(pact_content)
+    end
+  end
+
+  describe "retrieving the latest tagged pact" do
+    let(:path) { "/pacts/provider/Bar/consumer/Foo/latest" }
+    subject { get path; last_response  }
+
+    it "returns the latest pact" do
+      expect(subject.headers['X-Pact-Consumer-Version']).to eq '100.100.100'
+    end
+  end
+
+  describe "retrieving the latest tagged pact" do
+    let(:path) { "/pacts/provider/Bar/consumer/Foo/latest/#{TAG}" }
+    subject { get path; last_response  }
+
+    it "returns the pact in the body" do
+      expect(response_body_json).to include JSON.parse(pact_content)
+    end
+  end
+end

data/db/test/backwards_compatibility/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'support/fixture_helpers'
+require 'support/request_helpers'
+require 'rack/test'
+
+RSpec.configure do | config |
+
+  config.include Rack::Test::Methods
+  config.include RequestHelpers
+  config.include FixtureHelpers
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.after(:suite) do
+    puts "***************************************************************************"
+    puts "Pact Broker logs are in db/test/backwards_compatibility/log/pact_broker.log"
+    puts "***************************************************************************"
+  end
+end

data/db/test/backwards_compatibility/spec/support/fixture_helpers.rb

@@ -0,0 +1,12 @@
+require 'json'
+
+module FixtureHelpers
+  def load_fixture(file_name)
+    File.read(File.join("./spec/fixtures", file_name))
+  end
+
+  def load_json_fixture(file_name)
+    require 'json'
+    JSON.parse(load_fixture(file_name))
+  end
+end

data/db/test/backwards_compatibility/spec/support/request_helpers.rb

@@ -0,0 +1,20 @@
+module RequestHelpers
+
+  def wait_for_server_to_start
+    unless ENV['OK']
+      retries = 0
+      begin
+          get "/"
+          ENV['OK'] = 'true'
+      rescue Errno::ECONNREFUSED => error
+        if retries < 10
+          retries += 1
+          sleep 1
+          retry
+        else
+          raise error
+        end
+      end
+    end
+  end
+end

data/example/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'pact_broker'
-gem 'sqlite3' # Sqlite is just for testing, replace this with your choice of database driver
+gem 'sqlite3', '~>1.3' # Sqlite is just for testing, replace this with your choice of database driver
 # gem 'pg' # Recommended production gem for postgres
-gem 'thin' # Keep, or replace with your choice of web server
+gem 'thin', '~>1.7' # Keep, or replace with your choice of web server

data/lib/pact_broker/api/decorators/pact_collection_decorator.rb

@@ -29,8 +29,7 @@ module PactBroker
           represented.collect do | pact |
             {
               :href => latest_pact_url(options[:base_url], pact),
-              :name => "Latest pact between #{pact.consumer.name} and #{pact.provider.name}",
-              :title => "Pact"
+              :title => "Latest pact between #{pact.consumer.name} and #{pact.provider.name}",
             }
           end
         end

data/lib/pact_broker/api/decorators/pact_decorator.rb

@@ -56,25 +56,29 @@ module PactBroker
 
         link :'pb:latest-pact-version' do | options |
           {
-            title: "Pact",
-            name: "Latest version of this pact",
+            title: "Latest version of this pact",
             href: latest_pact_url(options.fetch(:base_url), represented)
 
           }
         end
 
+        link :'pb:all-pact-versions' do | options |
+          {
+            title: "All versions of this pact",
+            href: pact_versions_url(represented.consumer.name, represented.provider.name, options.fetch(:base_url))
+          }
+        end
+
         link :'pb:latest-untagged-pact-version' do | options |
           {
-            title: "Pact",
-            name: "Latest untagged version of this pact",
+            title: "Latest untagged version of this pact",
             href: latest_untagged_pact_url(represented, options.fetch(:base_url))
           }
         end
 
         link :'pb:latest-tagged-pact-version' do | options |
           {
-            title: "Pact",
-            name: "Latest tagged version of this pact",
+            title: "Latest tagged version of this pact",
             href: "#{latest_pact_url(options.fetch(:base_url), represented)}/{tag}",
             templated: true
           }
@@ -82,16 +86,14 @@ module PactBroker
 
         link :'pb:previous-distinct' do | options |
           {
-            title: "Pact",
-            name: "Previous distinct version of this pact",
+            title: "Previous distinct version of this pact",
             href: previous_distinct_pact_version_url(represented, options.fetch(:base_url))
           }
         end
 
         link :'pb:diff-previous-distinct' do | options |
           {
-            title: "Diff",
-            name: "Diff with previous distinct version of this pact",
+            title: "Diff with previous distinct version of this pact",
             href: previous_distinct_diff_url(represented, options.fetch(:base_url))
 
           }

data/lib/pact_broker/api/decorators/pact_versions_decorator.rb

@@ -11,8 +11,7 @@ module PactBroker
         link :self do | context |
           {
             href: context[:resource_url],
-            title: "Pact versions",
-            name: "All versions of the pact between #{context[:consumer_name]} and #{context[:provider_name]}"
+            title: "All versions of the pact between #{context[:consumer_name]} and #{context[:provider_name]}"
           }
         end
 

data/lib/pact_broker/api/decorators/pact_webhooks_status_decorator.rb

@@ -0,0 +1,123 @@
+require_relative 'base_decorator'
+require_relative 'timestamps'
+require_relative 'pact_version_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+
+      class TriggeredWebhookDecorator < BaseDecorator
+        property :request_description, as: :name
+        property :status
+        property :number_of_attempts_made, as: :attemptsMade
+        property :number_of_attempts_remaining, as: :attemptsRemaining
+        property :trigger_type, as: :triggerType
+
+        property :created_at, as: :triggeredAt
+
+        link :logs do | context |
+          {
+            href: triggered_webhook_logs_url(represented, context[:base_url]),
+            title: "Webhook execution logs",
+            name: represented.request_description
+          }
+        end
+
+        link :'pb:webhook' do | context |
+          {
+            href: webhook_url(represented.webhook_uuid, context[:base_url]),
+            title: "Webhook",
+            name: represented.request_description
+          }
+        end
+      end
+
+      class PactWebhooksStatusDecorator < BaseDecorator
+
+        property :summary, exec_context: :decorator do
+          property :success, as: :successful, default: 0
+          property :failure, as: :failed, default: 0
+          property :retrying
+          property :not_run, as: :notRun
+        end
+
+        collection :entries, as: :triggeredWebhooks, embedded: true, :extend => TriggeredWebhookDecorator
+
+        link :self do | context |
+          {
+            href: context[:resource_url],
+            title: "Webhooks status"
+          }
+        end
+
+        links :'pb:error-logs' do | context |
+          triggered_webhooks_with_error_logs.collect do | triggered_webhook |
+            {
+              href: triggered_webhook_logs_url(triggered_webhook, context[:base_url]),
+              title: "Error logs",
+              name: triggered_webhook.request_description
+            }
+          end
+        end
+
+        link :'pb:pact-webhooks' do | context |
+          {
+            title: "Webhooks for the pact between #{context[:consumer_name]} and #{context[:provider_name]}",
+            href: webhooks_for_pact_url(fake_consumer(context), fake_provider(context), context.fetch(:base_url))
+          }
+        end
+
+        link :'pb:pact-version' do | context |
+          if pact
+            {
+              href: pact_url(context[:base_url], pact),
+              title: "Pact",
+              name: pact.name
+            }
+          else
+            nil
+          end
+        end
+
+        link :'pb:consumer' do | context |
+          {
+            href: pacticipant_url(context[:base_url], fake_consumer(context)),
+            title: "Consumer",
+            name: context[:consumer_name]
+          }
+        end
+
+        link :'pb:provider' do | context |
+          {
+            href: pacticipant_url(context[:base_url], fake_provider(context)),
+            title: "Provider",
+            name: context[:provider_name]
+          }
+        end
+
+        def summary
+          counts = represented.group_by(&:status).each_with_object({}) do | (status, triggered_webhooks), counts |
+            counts[status] = triggered_webhooks.count
+          end
+          OpenStruct.new(counts)
+        end
+
+        def triggered_webhooks_with_error_logs
+          represented.select{|w| w.failure? || w.retrying? }
+        end
+
+        def pact
+          represented.any? ? represented.first.pact_publication : nil
+        end
+
+        def fake_consumer context
+          OpenStruct.new(name: context[:consumer_name])
+        end
+
+        def fake_provider context
+          OpenStruct.new(name: context[:provider_name])
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/versions_decorator.rb

@@ -2,12 +2,8 @@ require_relative 'base_decorator'
 require_relative 'version_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
-
       class VersionsDecorator < BaseDecorator
 
         collection :entries, as: :versions, embedded: true, :extend => PactBroker::Api::Decorators::VersionDecorator
@@ -19,14 +15,14 @@ module PactBroker
           }
         end
 
-        link :pacticipant do | context |
+        link :'pb:pacticipant' do | context |
           {
             href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:pacticipant_name])),
             title: context[:pacticipant_name]
           }
         end
 
-        links :'versions' do | context |
+        links :'pb:versions' do | context |
           represented.collect do | version |
             {
               :href => version_url(context[:base_url], version),
@@ -35,6 +31,21 @@ module PactBroker
           end
         end
 
+        link :pacticipant do | context |
+          {
+            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:pacticipant_name])),
+            title: 'Deprecated - please use pb:pacticipant'
+          }
+        end
+
+        links :'versions' do | context |
+          represented.collect do | version |
+            {
+              :href => version_url(context[:base_url], version),
+              :title => 'Deprecated - please use pb:versions'
+            }
+          end
+        end
       end
     end
   end

data/lib/pact_broker/api/decorators/webhook_decorator.rb

@@ -24,6 +24,13 @@ module PactBroker
 
         end
 
+        link :'pb:execute' do | options |
+          {
+            title: "Test the execution of the webhook by sending a POST request to this URL",
+            href: webhook_execution_url(represented, options[:base_url])
+          }
+        end
+
         link :'pb:pact-webhooks' do | options |
           {
             title: "All webhooks for the pact between #{represented.consumer.name} and #{represented.provider.name}",
@@ -37,16 +44,7 @@ module PactBroker
             href: webhooks_url(options[:base_url])
           }
         end
-
-        link :'pb:execute' do | options |
-          {
-            title: "Test the execution of the webhook by sending a POST request to this URL",
-            href: webhook_execution_url(represented, options[:base_url])
-          }
-
-        end
-
       end
     end
   end
-end
+end

data/lib/pact_broker/api/decorators/webhooks_decorator.rb

@@ -38,7 +38,6 @@ module PactBroker
             templated: true
           }]
         end
-
       end
     end
   end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -117,10 +117,22 @@ module PactBroker
         "#{base_url}/webhooks/#{webhook.uuid}/execute"
       end
 
-      def webhooks_for_pact_url consumer, provider, base_url
+      def webhooks_for_pact_url consumer, provider, base_url = ''
         "#{base_url}/webhooks/provider/#{url_encode(provider.name)}/consumer/#{url_encode(consumer.name)}"
       end
 
+      def webhooks_status_url consumer, provider, base_url = ''
+        "#{webhooks_for_pact_url(consumer, provider, base_url)}/status"
+      end
+
+      def triggered_webhook_logs_url triggered_webhook, base_url
+        "#{base_url}/webhooks/#{triggered_webhook.webhook_uuid}/trigger/#{triggered_webhook.trigger_uuid}/logs"
+      end
+
+     def badge_url_for_latest_pact pact, base_url = ''
+        "#{latest_pact_url(base_url, pact)}/badge.svg"
+      end
+
       def hal_browser_url target_url
         "/hal-browser/browser.html#" + target_url
       end