pact_broker 2.76.0 → 2.76.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d14eafba260b6b71dd75c725768863c0f923e167bdb37084606a0b51d110d363
-  data.tar.gz: 545dabeda5ede4c25508e8ca5135d94dacec61f9df1692207787bdc6e3227ec4
+  metadata.gz: a1ab8b654502c5bbc4d263c4bd14fdb0e6dc3771173cfdf21a01118143528bd4
+  data.tar.gz: b1d929d7bfe56369c5985b94ad88f9adf3abdb27e9177b6249ba7cd68d03c85d
 SHA512:
-  metadata.gz: c8df83a6bf1588e8a9a96f915b0926d1a164ebd8f246d7ed831d83d43610bcbaf38875800bbd56ab792af3c9b2b6a9b2f415b6e3a581b6d8955e80248b25d67d
-  data.tar.gz: f1bb7162afee7913b9ac53fc523aa47d021f760350cca52758af1f626f3c440dd73bd02921254487820b1724b5a4c3e334283f728e7b279d92a69b29995de074
+  metadata.gz: ca79f6928c69425d89d0fa179094d007f26d5f25f02ee7fc2be771bb4208d2ecaef136af5391feea4c92588876e7162d205774451d00f9175463f03b9f1cdcd9
+  data.tar.gz: febb82748bb5929d393af212797a3d9c484c9825a8c83bc44e4d52aa7cb6fbce93863decb305a7d6ed3160a3b447bed6368339a38322f6084fb34de97f3698cc

data/.github/workflows/test.yml

@@ -5,12 +5,18 @@ on: push
 jobs:
   sqlite:
     runs-on: "ubuntu-latest"
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
+      fail-fast: false
       matrix:
         ruby_version: ["2.7"]
+        experimental: [false]
+        include:
+          - ruby_version: "3.0"
+            experimental: true
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "bundle install"
@@ -34,7 +40,7 @@ jobs:
           - 5432:5432
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "gem install bundler && bundle install"

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<a name="v2.76.1"></a>
+### v2.76.1 (2021-01-28)
+
+#### Bug Fixes
+
+* deduplicate wip pacts by content	 ([0af90776](/../../commit/0af90776))
+* message when pending pact is verified successfully for the first time (#376)	 ([4fc69190](/../../commit/4fc69190))
+* use base URL from rack env in UI	 ([5bf21324](/../../commit/5bf21324))
+
 <a name="v2.76.0"></a>
 ### v2.76.0 (2021-01-21)
 

data/README.md

@@ -116,7 +116,7 @@ Use the HAL browser to view documentation as you browse.
 
 ### To have a play around on your local machine
 
-* Install ruby 2.2.0 or later and bundler >= 1.12.0
+* Install Ruby and Bundler (check the automated tests to find the most recent version of Ruby and Bundler that are supported)
     * Windows users: get a Rails/Ruby installer from [RailsInstaller](http://railsinstaller.org/) and run it
     * unix users just use your package manager
 * Run `git clone git@github.com:pact-foundation/pact_broker.git && cd pact_broker/example`

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

@@ -39,7 +39,7 @@ module PactBroker
           query_results_with_deployment_status_summary
             .deployment_status_summary
             .reasons
-            .collect{ | reason | ReasonDecorator.new(reason).to_s }
+            .collect{ | reason | reason_decorator_class.new(reason).to_s }
             .join("\n")
         end
 
@@ -47,6 +47,10 @@ module PactBroker
 
         attr_reader :query_results_with_deployment_status_summary
 
+        def reason_decorator_class
+          ReasonDecorator
+        end
+
         def matrix(base_url)
           query_results_with_deployment_status_summary.rows.collect do | line |
             provider = OpenStruct.new(name: line.provider_name)

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

@@ -14,8 +14,8 @@ module PactBroker
             "There is no verified pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description}"
           when PactBroker::Matrix::PactNotVerifiedByRequiredProviderVersion
             "There is no verified pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description}"
-          when PactBroker::Matrix::VerificationFailed
-            "The verification between #{reason.consumer_selector.description} and #{reason.provider_selector.description} failed"
+          # when PactBroker::Matrix::VerificationFailed
+          #   "The pact verification between #{reason.consumer_selector.description} and #{reason.provider_selector.description} failed"
           when PactBroker::Matrix::SpecifiedVersionDoesNotExist
             version_does_not_exist_description(reason.selector)
           when PactBroker::Matrix::VerificationFailed

data/lib/pact_broker/app.rb

@@ -5,7 +5,6 @@ require 'pact_broker/logging/default_formatter'
 require 'pact_broker/policies'
 require 'rack-protection'
 require 'rack/hal_browser'
-require 'rack/pact_broker/hal_browser_redirect'
 require 'rack/pact_broker/set_base_url'
 require 'rack/pact_broker/add_pact_broker_version_header'
 require 'rack/pact_broker/convert_file_extension_to_accept_header'
@@ -197,7 +196,6 @@ module PactBroker
       if configuration.use_hal_browser
         logger.info "Mounting HAL browser"
         @app_builder.use Rack::HalBrowser::Redirect
-        @app_builder.use Rack::PactBroker::HalBrowserRedirect
       else
         logger.info "Not mounting HAL browser"
       end

data/lib/pact_broker/pacts/repository.rb

@@ -218,7 +218,7 @@ module PactBroker
 
         provider_version_count = scope_for(PactBroker::Domain::Version).where(pacticipant: provider).count
 
-        wip_pacts.collect do | pact|
+        verifiable_pacts = wip_pacts.collect do | pact|
           pending_tag_names = find_provider_tags_for_which_pact_publication_id_is_pending(pact, successfully_verified_head_pact_publication_ids_for_each_provider_tag)
           pre_existing_tag_names = find_provider_tag_names_that_were_first_used_before_pact_published(pact, provider_tag_collection)
 
@@ -229,6 +229,8 @@ module PactBroker
             VerifiablePact.new(pact.to_domain, selectors, true, pre_existing_pending_tags, [], true)
           end
         end.compact.sort
+
+        deduplicate_verifiable_pacts(verifiable_pacts)
       end
 
       def find_pact_versions_for_provider provider_name, tag = nil
@@ -595,6 +597,13 @@ module PactBroker
           hash[provider_tag] = head_pacts
         end
       end
+
+      def deduplicate_verifiable_pacts(verifiable_pacts)
+        verifiable_pacts
+          .group_by { | verifiable_pact | verifiable_pact.pact_version_sha }
+          .values
+          .collect { | verifiable_pacts | verifiable_pacts.reduce(&:+) }
+      end
     end
   end
 end

data/lib/pact_broker/pacts/verifiable_pact.rb

@@ -1,4 +1,5 @@
 require 'delegate'
+require 'pact_broker/error'
 
 module PactBroker
   module Pacts
@@ -23,6 +24,23 @@ module PactBroker
         wip
       end
 
+      def + other
+        if pact_version_sha != other.pact_version_sha
+          raise PactBroker::Error.new("Can't merge two verifiable pacts with different pact content")
+        end
+
+        latest_pact = [self, other].sort_by(&:consumer_version_order).last.__getobj__()
+
+        VerifiablePact.new(
+          latest_pact,
+          selectors + other.selectors,
+          pending || other.pending,
+          pending_provider_tags + other.pending_provider_tags,
+          non_pending_provider_tags + other.non_pending_provider_tags,
+          wip || other.wip
+        )
+      end
+
       def <=> other
         if self.consumer_name != other.consumer_name
           return self.consumer_name <=> other.consumer_name
@@ -30,6 +48,10 @@ module PactBroker
           return self.consumer_version.order <=> other.consumer_version.order
         end
       end
+
+      def consumer_version_order
+        __getobj__().consumer_version.order
+      end
     end
   end
 end

data/lib/pact_broker/pacts/verifiable_pact_messages.rb

@@ -52,7 +52,7 @@ module PactBroker
 
       def verification_success_true_published_true
         if pending?
-          "This pact is no longer in pending state for #{pending_provider_tags_description}, as a successful verification result #{with_these_tags}has been published. If a verification for a version with  fails in the future, it will fail the build. #{READ_MORE_PENDING}"
+          "This pact is no longer in pending state for #{pending_provider_tags_description}, as a successful verification result #{with_these_tags}has been published. If a verification for a version of #{provider_name} #{with_these_tags}fails in the future, it will fail the build. #{READ_MORE_PENDING}"
         end
       end
 

data/lib/pact_broker/test/http_test_data_builder.rb

@@ -173,7 +173,12 @@ module PactBroker
         can_i_deploy_response = client.get("can-i-deploy", { pacticipant: pacticipant, version: version, to: to} ).tap { |response| check_for_error(response) }
         can = !!(can_i_deploy_response.body['summary'] || {})['deployable']
         puts "can-i-deploy #{pacticipant} version #{version} to #{to}: #{can ? 'yes' : 'no'}"
-        puts (can_i_deploy_response.body['summary'] || can_i_deploy_response.body).to_yaml
+        summary = can_i_deploy_response.body['summary']
+        verification_result_urls = (can_i_deploy_response.body['matrix'] || []).collect do | row |
+          row.dig("verificationResult", "_links", "self", "href")
+        end.compact
+        summary.merge!("verification_result_urls" => verification_result_urls)
+        puts summary.to_yaml
         separate
         self
       end

data/lib/pact_broker/ui/app.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/ui/controllers/index'
 require 'pact_broker/ui/controllers/groups'
+require 'pact_broker/ui/controllers/pacts'
 require 'pact_broker/ui/controllers/matrix'
 require 'pact_broker/ui/controllers/can_i_deploy'
 require 'pact_broker/ui/controllers/error_test'
@@ -47,6 +48,11 @@ module PactBroker
             run PactBroker::UI::Controllers::CanIDeploy
           end
 
+          map "/pacts/" do
+            use PathInfoFixer
+            run PactBroker::UI::Controllers::Pacts
+          end
+
           map "/test/error" do
             use PathInfoFixer
             run PactBroker::UI::Controllers::ErrorTest

data/lib/pact_broker/ui/controllers/base_controller.rb

@@ -12,7 +12,11 @@ module PactBroker
         set :dump_errors, false # The padrino logger logs these for us. If this is enabled we get duplicate logging.
 
         def base_url
-          PactBroker.configuration.base_url || ''
+          # Using the X-Forwarded headers in the UI can leave the app vulnerable
+          # https://www.acunetix.com/blog/articles/automated-detection-of-host-header-attacks/
+          # Either use the explicitly configured base url or an empty string,
+          # rather than request.base_url, which uses the X-Forwarded headers.
+          env["pactbroker.base_url"] || ''
         end
       end
     end

data/lib/pact_broker/ui/controllers/pacts.rb

@@ -0,0 +1,18 @@
+require 'pact_broker/ui/controllers/base_controller'
+
+module PactBroker
+  module UI
+    module Controllers
+      class Pacts < Base
+        include PactBroker::Services
+
+        get "/provider/:provider_name/consumer/:consumer_name/pact-version/:pact_version/verification-results/:number" do
+          url = URI.parse("#{env["pactbroker.base_url"]}/hal-browser/browser.html")
+          url.fragment = "#{env["pactbroker.base_url"]}#{env["SCRIPT_NAME"]}#{env["PATH_INFO"]}"
+          response.headers["Location"] = url.to_s
+          response.status = 302
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.76.0'
+  VERSION = '2.76.1'
 end

data/spec/integration/ui/index_spec.rb

@@ -14,7 +14,9 @@ describe "UI index" do
     get "/"
   end
 
-  subject { get("/", params, {}); last_response }
+  let(:rack_env) { {} }
+
+  subject { get("/", params, rack_env) }
 
   describe "GET" do
     it "returns a success response" do
@@ -40,9 +42,7 @@ describe "UI index" do
     end
 
     context "with the base_url set" do
-      before do
-        allow(PactBroker.configuration).to receive(:base_url).and_return('http://example.org/pact-broker')
-      end
+      let(:rack_env) { { "pactbroker.base_url" => "http://example.org/pact-broker"} }
 
       it "returns absolute links" do
         expect(subject.body).to include "href='http://example.org/pact-broker/stylesheets"

data/spec/lib/pact_broker/api/decorators/reason_decorator_spec.rb

@@ -5,17 +5,17 @@ module PactBroker
   module Api
     module Decorators
       describe ReasonDecorator do
-
-        REASON_CLASSES = ObjectSpace.each_object(Class).select { |klass| klass < PactBroker::Matrix::Reason }
+        REASON_CLASSES = ObjectSpace.each_object(Class).select { |klass| klass < PactBroker::Matrix::Reason && klass.name&.start_with?("PactBroker") }
 
         describe "the number of Reason classes" do
-          it "is 9 - add another spec here if a new Reason is added" do
-            expect(REASON_CLASSES.size).to eq 10
+          let(:expected_number_of_reason_classes) { 10 }
+
+          it "is 10 - add another spec here if a new Reason is added" do
+            expect(REASON_CLASSES.size).to eq expected_number_of_reason_classes
           end
         end
 
         describe "#to_s" do
-
           let(:consumer_selector) { double('consumer selector', description: "version 2 of Foo") }
           let(:provider_selector) { double('provider selector', description: "version 6 of Bar") }
           let(:selectors) { [consumer_selector, provider_selector] }
@@ -38,7 +38,7 @@ module PactBroker
           context "when the reason is PactBroker::Matrix::VerificationFailed" do
             let(:reason) { PactBroker::Matrix::VerificationFailed.new(*selectors) }
 
-            its(:to_s) { is_expected.to eq "The verification between version 2 of Foo and version 6 of Bar failed" }
+            its(:to_s) { is_expected.to eq "The verification for the pact between version 2 of Foo and version 6 of Bar failed" }
           end
 
           context "when the reason is PactBroker::Matrix::NoDependenciesMissing" do

data/spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb

@@ -54,6 +54,32 @@ module PactBroker
           end
         end
 
+        context "when there are multiple wip pacts with the same content" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333")
+              .create_provider_version_tag("dev")
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar", json_content)
+              .create_consumer_version_tag("feat-1")
+              .add_day
+              .create_pact_with_hierarchy("meep", "2", "bar", json_content)
+              .create_consumer_version_tag("feat-2")
+          end
+
+          let(:json_content) { { "interactions" => ["foo"] }.to_json }
+          let(:provider_tags) { %w[dev] }
+
+          it "de-duplicates them" do
+            expect(subject.size).to eq 1
+          end
+
+          it "merges the selectors" do
+            expect(subject.first.selectors.size).to eq 2
+            expect(subject.first.wip).to be true
+          end
+        end
+
         context "when the latest pact for a tag has been successfully verified by the given provider tag" do
           before do
             td.create_pact_with_hierarchy("foo", "1", "bar")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.76.0
+  version: 2.76.1
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -907,6 +907,7 @@ files:
 - lib/pact_broker/ui/controllers/groups.rb
 - lib/pact_broker/ui/controllers/index.rb
 - lib/pact_broker/ui/controllers/matrix.rb
+- lib/pact_broker/ui/controllers/pacts.rb
 - lib/pact_broker/ui/helpers/matrix_helper.rb
 - lib/pact_broker/ui/helpers/url_helper.rb
 - lib/pact_broker/ui/view_models/clusters.rb
@@ -971,7 +972,6 @@ files:
 - lib/rack/pact_broker/convert_404_to_hal.rb
 - lib/rack/pact_broker/convert_file_extension_to_accept_header.rb
 - lib/rack/pact_broker/database_transaction.rb
-- lib/rack/pact_broker/hal_browser_redirect.rb
 - lib/rack/pact_broker/invalid_uri_protection.rb
 - lib/rack/pact_broker/no_auth.rb
 - lib/rack/pact_broker/request_target.rb
@@ -1383,7 +1383,6 @@ files:
 - spec/lib/rack/hal_browser/redirect_spec.rb
 - spec/lib/rack/pact_broker/add_pact_broker_version_header_spec.rb
 - spec/lib/rack/pact_broker/database_transaction_spec.rb
-- spec/lib/rack/pact_broker/hal_browser_redirect_spec.rb
 - spec/lib/rack/pact_broker/invalid_uri_protection_spec.rb
 - spec/lib/rack/pact_broker/request_target_spec.rb
 - spec/lib/rack/pact_broker/use_when_spec.rb
@@ -1503,7 +1502,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.2.7
 signing_key: 
 specification_version: 4
 summary: See description
@@ -1786,7 +1785,6 @@ test_files:
 - spec/lib/rack/hal_browser/redirect_spec.rb
 - spec/lib/rack/pact_broker/add_pact_broker_version_header_spec.rb
 - spec/lib/rack/pact_broker/database_transaction_spec.rb
-- spec/lib/rack/pact_broker/hal_browser_redirect_spec.rb
 - spec/lib/rack/pact_broker/invalid_uri_protection_spec.rb
 - spec/lib/rack/pact_broker/request_target_spec.rb
 - spec/lib/rack/pact_broker/use_when_spec.rb

data/lib/rack/pact_broker/hal_browser_redirect.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require 'pact_broker/api/paths'
-require 'pact_broker/configuration'
-
-module Rack
-  module PactBroker
-    class HalBrowserRedirect
-      include ::PactBroker::Api::Paths
-
-      def initialize(app, options = {}, &block)
-        @app = app
-      end
-
-      def call(env)
-        if redirect?(env)
-          return [303, {'Location' => hal_browser_url_from_request(env)}, []]
-        else
-          app.call(env)
-        end
-      end
-
-      private
-
-      attr_reader :app
-
-      def redirect?(env)
-        is_get_for_html?(env) && is_verification_results_path?(env["PATH_INFO"])
-      end
-
-      def is_get_for_html?(env)
-        env["REQUEST_METHOD"] == "GET" && env["HTTP_ACCEPT"]&.include?("text/html")
-      end
-
-      # Doesn't support non root URLs currently
-      def hal_browser_url_from_request(env)
-        url = URI.parse("#{env["pactbroker.base_url"]}/hal-browser/browser.html")
-        url.fragment = "#{env["pactbroker.base_url"]}#{env["PATH_INFO"]}"
-        url.to_s
-      end
-    end
-  end
-end

data/spec/lib/rack/pact_broker/hal_browser_redirect_spec.rb

@@ -1,27 +0,0 @@
-require 'rack/pact_broker/hal_browser_redirect'
-
-module Rack
-  module PactBroker
-    describe HalBrowserRedirect do
-      let(:target_app) { ->(env){ [200, {}, []] } }
-      let(:app) { HalBrowserRedirect.new(target_app) }
-      let(:rack_env) do
-        {
-          "pactbroker.base_url" => "http://base/foo",
-          "HTTP_ACCEPT" => "text/html"
-        }
-      end
-
-      subject { get(path, nil, rack_env) }
-
-      context "when requesting verification results" do
-        let(:path) { "/pacts/provider/Bar/consumer/Foo/pact-version/a2456ade40d0e148e23fb3310ec56831fef6ce8e/verification-results/106" }
-
-        it "redirects to the HAL browser" do
-          expect(subject.status).to eq 303
-          expect(subject.headers["Location"]).to eq "http://base/foo/hal-browser/browser.html#http://base/foo/pacts/provider/Bar/consumer/Foo/pact-version/a2456ade40d0e148e23fb3310ec56831fef6ce8e/verification-results/106"
-        end
-      end
-    end
-  end
-end