pact_broker 2.75.0 → 2.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe978e58a9f4c7e3e190b8fd5b48ce70212bac2dcc4c0ea795565a00db6127e3
-  data.tar.gz: 551b0f07b25b75db367cb4a6d16ce114ab64b2541f1a452ab686145d3b5610ec
+  metadata.gz: d14eafba260b6b71dd75c725768863c0f923e167bdb37084606a0b51d110d363
+  data.tar.gz: 545dabeda5ede4c25508e8ca5135d94dacec61f9df1692207787bdc6e3227ec4
 SHA512:
-  metadata.gz: 87c8c396ed8dd5aaabd184a7a65a24c7ba641d11a257bfb17d3cf497e4cc9e3e33a2a761143f3c59d511e0d42c3440ea3117f186ee179aff095d917c228dd820
-  data.tar.gz: 5d4b9dfc5bab8f3f3671dc10011a11c925bbf2ff2edc8b3a8196c204c6bdace6bc09d8c004e3bbed438a111c202b99b01937163708da591375f8828ef02e81a4
+  metadata.gz: c8df83a6bf1588e8a9a96f915b0926d1a164ebd8f246d7ed831d83d43610bcbaf38875800bbd56ab792af3c9b2b6a9b2f415b6e3a581b6d8955e80248b25d67d
+  data.tar.gz: f1bb7162afee7913b9ac53fc523aa47d021f760350cca52758af1f626f3c440dd73bd02921254487820b1724b5a4c3e334283f728e7b279d92a69b29995de074

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="v2.76.0"></a>
+### v2.76.0 (2021-01-21)
+
+#### Features
+
+* **verification results**
+  * redirect requests for verification results to the HAL browser if requested in a web browser	 ([0f948de5](/../../commit/0f948de5))
+
 <a name="v2.75.0"></a>
 ### v2.75.0 (2021-01-18)
 

data/ISSUES.md

@@ -8,16 +8,16 @@ You can use it to easily reproduce issues.
 
 To use it:
 
-* Run the Pact Broker using the latest development code:
+* Run the Pact Broker using a specific Pact Broker Docker image by setting the required tag for the pact-broker service in the docker-compose-issue-repro-with-pact-broker-docker-image.yml file.
 
     ```
-    docker-compose -f docker-compose-issue-repro.yml up --build pact-broker
+    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up --build pact-broker
     ```
 
 * Run the reproduction script.
 
     ```
-    docker-compose -f docker-compose-issue-repro.yml up repro-issue
+    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up repro-issue
     ```
 
 You can modify `script/reproduce-issue.rb` and then re-run it with the change applied.

data/docker-compose-issue-repro-with-pact-broker-docker-image.yml

@@ -0,0 +1,33 @@
+version: "3"
+
+services:
+  postgres:
+    image: postgres
+    healthcheck:
+      test: psql postgres --command "select 1" -U postgres
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: postgres
+
+  pact-broker:
+    image: pactfoundation/pact-broker:2.73.0.0
+    ports:
+      - "9292:9292"
+    depends_on:
+      - postgres
+    environment:
+      PACT_BROKER_PORT: '9292'
+      PACT_BROKER_DATABASE_URL: "postgres://postgres:password@postgres/postgres"
+      PACT_BROKER_LOG_LEVEL: INFO
+      PACT_BROKER_SQL_LOG_LEVEL: DEBUG
+
+  repro-issue:
+    build: .
+    depends_on:
+      - pact-broker
+    command: dockerize -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb
+    environment:
+      - PACT_BROKER_BASE_URL=http://pact-broker:9292
+    volumes:
+      - $PWD:/home

data/lib/pact_broker/api/paths.rb

@@ -4,9 +4,14 @@ module PactBroker
       PACT_BADGE_PATH =         %r{^/pacts/provider/[^/]+/consumer/.*/badge(?:\.[A-Za-z]+)?$}.freeze
       MATRIX_BADGE_PATH =       %r{^/matrix/provider/[^/]+/latest/[^/]+/consumer/[^/]+/latest/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
       CAN_I_DEPLOY_BADGE_PATH = %r{^/pacticipants/[^/]+/latest-version/[^/]+/can-i-deploy/to/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
+      VERIFICATION_RESULTS =    %r{^/pacts/provider/[^/]+/consumer/[^/]+/pact-version/[^/]+/verification-results/[^/]+}
 
       extend self
 
+      def is_verification_results_path?(path)
+        path.start_with?('/pacts') && (path =~ VERIFICATION_RESULTS)
+      end
+
       def is_badge_path?(path)
         # Optimise by checking include? first - regexp slow
         path.include?('/badge') && (path =~ PACT_BADGE_PATH || path =~ MATRIX_BADGE_PATH || path =~ CAN_I_DEPLOY_BADGE_PATH)

data/lib/pact_broker/api/resources/default_base_resource.rb

@@ -68,12 +68,12 @@ module PactBroker
         alias_method :path_info, :identifier_from_path
 
         def base_url
-          request.env["pactbroker.base_url"] || PactBroker.configuration.base_url || request.base_uri.to_s.chomp('/')
+          request.env["pactbroker.base_url"] || request.base_uri.to_s.chomp('/')
         end
 
         # See comments for base_url in lib/pact_broker/doc/controllers/app.rb
         def ui_base_url
-          request.env["pactbroker.base_url"] || PactBroker.configuration.base_url || ''
+          request.env["pactbroker.base_url"] || ''
         end
 
         def charsets_provided

data/lib/pact_broker/app.rb

@@ -5,6 +5,8 @@ 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'
 require 'rack/pact_broker/database_transaction'
@@ -189,10 +191,13 @@ module PactBroker
       @app_builder.use Rack::Static, :urls => ["/stylesheets", "/css", "/fonts", "/js", "/javascripts", "/images"], :root => PactBroker.project_root.join("public")
       @app_builder.use Rack::Static, :urls => ["/favicon.ico"], :root => PactBroker.project_root.join("public/images"), header_rules: [[:all, {'Content-Type' => 'image/x-icon'}]]
       @app_builder.use Rack::PactBroker::ConvertFileExtensionToAcceptHeader
+      # Rack::PactBroker::SetBaseUrl needs to be before the Rack::PactBroker::HalBrowserRedirect
+      @app_builder.use Rack::PactBroker::SetBaseUrl, configuration.base_url
 
       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/doc/controllers/app.rb

@@ -51,7 +51,7 @@ module PactBroker
           # 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"] || PactBroker.configuration.base_url || ''
+          env["pactbroker.base_url"] || ''
         end
       end
     end

data/lib/pact_broker/test/http_test_data_builder.rb

@@ -10,7 +10,7 @@ module PactBroker
 
       attr_reader :client, :last_consumer_name, :last_provider_name, :last_consumer_version_number, :last_provider_version_number
 
-      def initialize(pact_broker_base_url, auth)
+      def initialize(pact_broker_base_url, auth = {})
         @client = Faraday.new(url: pact_broker_base_url) do |faraday|
           faraday.request :json
           faraday.response :json, :content_type => /\bjson$/
@@ -42,7 +42,7 @@ module PactBroker
 
       def create_tag(pacticipant:, version:, tag:)
         puts "Creating tag '#{tag}' for #{pacticipant} version #{version}"
-        client.put("/pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}/tags/#{encode(tag)}", {}).tap { |response| check_for_error(response) }
+        client.put("pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}/tags/#{encode(tag)}", {}).tap { |response| check_for_error(response) }
         self
       end
 
@@ -55,7 +55,7 @@ module PactBroker
 
       def create_pacticipant(name)
         puts "Creating pacticipant with name #{name}"
-        client.post("/pacticipants", { name: name}).tap { |response| check_for_error(response) }
+        client.post("pacticipants", { name: name}).tap { |response| check_for_error(response) }
         separate
         self
       end
@@ -72,7 +72,7 @@ module PactBroker
 
         content = generate_content(consumer, provider, content_id)
         puts "Publishing pact for consumer #{consumer} version #{consumer_version} and provider #{provider}"
-        pact_path = "/pacts/provider/#{encode(provider)}/consumer/#{encode(consumer)}/version/#{encode(consumer_version)}"
+        pact_path = "pacts/provider/#{encode(provider)}/consumer/#{encode(consumer)}/version/#{encode(consumer_version)}"
         @publish_pact_response = client.put(pact_path, content).tap { |response| check_for_error(response) }
         separate
         self
@@ -89,7 +89,7 @@ module PactBroker
         }.compact
         puts body.to_yaml
         puts ""
-        @pacts_for_verification_response = client.post("/pacts/provider/#{encode(provider)}/for-verification", body).tap { |response| check_for_error(response) }
+        @pacts_for_verification_response = client.post("pacts/provider/#{encode(provider)}/for-verification", body).tap { |response| check_for_error(response) }
 
         print_pacts_for_verification
         separate
@@ -150,7 +150,7 @@ module PactBroker
             "url" => url
           }
         }
-        path = "/webhooks/#{uuid}"
+        path = "webhooks/#{uuid}"
         response = client.put(path, request_body.to_json).tap { |response| check_for_error(response) }
         separate
         self
@@ -158,7 +158,7 @@ module PactBroker
 
       def delete_webhook(uuid:)
         puts "Deleting webhook with uuid #{uuid}"
-        path = "/webhooks/#{uuid}"
+        path = "webhooks/#{uuid}"
         response = client.delete(path).tap { |response| check_for_error(response) }
         separate
         self
@@ -170,7 +170,7 @@ module PactBroker
       end
 
       def can_i_deploy(pacticipant:, version:, to:)
-        can_i_deploy_response = client.get("/can-i-deploy", { pacticipant: pacticipant, version: version, to: to} ).tap { |response| check_for_error(response) }
+        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
@@ -180,14 +180,14 @@ module PactBroker
 
       def delete_integration(consumer:, provider:)
         puts "Deleting all data for the integration between #{consumer} and #{provider}"
-        client.delete("/integrations/provider/#{encode(provider)}/consumer/#{encode(consumer)}").tap { |response| check_for_error(response) }
+        client.delete("integrations/provider/#{encode(provider)}/consumer/#{encode(consumer)}").tap { |response| check_for_error(response) }
         separate
         self
       end
 
       def delete_pacticipant(name)
         puts "Deleting pacticipant #{name}"
-        @publish_pact_response = client.delete("/pacticipants/#{encode(name)}").tap { |response| check_for_error(response) }
+        @publish_pact_response = client.delete("pacticipants/#{encode(name)}").tap { |response| check_for_error(response) }
         separate
         self
       end

data/lib/pact_broker/version.rb

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

data/lib/rack/pact_broker/hal_browser_redirect.rb

@@ -0,0 +1,42 @@
+# 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/lib/rack/pact_broker/set_base_url.rb

@@ -0,0 +1,22 @@
+module Rack
+  module PactBroker
+    class SetBaseUrl
+      def initialize app, base_url
+        @app = app
+        @base_url = base_url
+      end
+
+      def call env
+        if env["pactbroker.base_url"]
+          app.call(env)
+        else
+          app.call(env.merge("pactbroker.base_url" => base_url))
+        end
+      end
+
+      private
+
+      attr_reader :app, :base_url
+    end
+  end
+end

data/script/reproduce-issue.rb

@@ -1,28 +1,31 @@
 #!/usr/bin/env ruby
-
-$LOAD_PATH << "#{Dir.pwd}/lib"
-
 begin
 
+  $LOAD_PATH << "#{Dir.pwd}/lib"
   require 'pact_broker/test/http_test_data_builder'
   base_url = ENV['PACT_BROKER_BASE_URL'] || 'http://localhost:9292'
 
-  td = PactBroker::Test::HttpTestDataBuilder.new(base_url, { })
-  td.delete_integration(consumer: "MyConsumer", provider: "MyProvider")
-    .create_pacticipant("MyConsumer")
-    .create_pacticipant("MyProvider")
-    .publish_pact(consumer: "MyConsumer", consumer_version: "1", provider: "MyProvider", content_id: "111", tag: "main")
-    .publish_pact(consumer: "MyConsumer", consumer_version: "2", provider: "MyProvider", content_id: "222", tag: "main")
-    .publish_pact(consumer: "MyConsumer", consumer_version: "3", provider: "MyProvider", content_id: "111", tag: "feat/a")
+  td = PactBroker::Test::HttpTestDataBuilder.new(base_url)
+  td.delete_integration(consumer: "foo-consumer", provider: "bar-provider")
+    .publish_pact(consumer: "foo-consumer", consumer_version: "1", provider: "bar-provider", content_id: "111", tag: "main")
     .get_pacts_for_verification(
+      enable_pending: true,
       provider_version_tag: "main",
-      consumer_version_selectors: [{ tag: "main" }, { tag: "feat/a", latest: true }])
-    .verify_pact(success: true, provider_version_tag: "main", provider_version: "2" )
-
+      include_wip_pacts_since: "2020-01-01",
+      consumer_version_selectors: [{ tag: "main", latest: true }])
+    .verify_pact(
+      index: 0,
+      provider_version_tag: "main",
+      provider_version: "1",
+      success: true
+    )
+    .can_i_deploy(pacticipant: "bar-provider", version: "1", to: "prod")
+    .deploy_to_prod(pacticipant: "bar-provider", version: "1")
+    .can_i_deploy(pacticipant: "foo-consumer", version: "1", to: "prod")
+    .deploy_to_prod(pacticipant: "foo-consumer", version: "1")
 
 rescue StandardError => e
   puts "#{e.class} #{e.message}"
   puts e.backtrace
   exit 1
 end
-

data/spec/lib/pact_broker/api/resources/default_base_resource_spec.rb

@@ -90,7 +90,6 @@ module PactBroker
         describe "base_url" do
           before do
             allow(env).to receive(:[]).with("pactbroker.base_url").and_return("http://rack")
-            allow(PactBroker.configuration).to receive(:base_url).and_return("http://foo")
           end
 
           context "when pactbroker.base_url is set on the env" do
@@ -99,20 +98,10 @@ module PactBroker
             end
           end
 
-          context "when PactBroker.configuration.base_url is not nil" do
+          context "when the rack env value is not set" do
             before do
               allow(env).to receive(:[]).with("pactbroker.base_url").and_return(nil)
             end
-            it "returns the configured base URL" do
-              expect(subject.base_url).to eq "http://foo"
-            end
-          end
-
-          context "when PactBroker.configuration.base_url is nil and the rack env value is not set" do
-            before do
-              allow(env).to receive(:[]).with("pactbroker.base_url").and_return(nil)
-              allow(PactBroker.configuration).to receive(:base_url).and_return(nil)
-            end
 
             it "returns the base URL from the request" do
               expect(subject.base_url).to eq "http://example.org"

data/spec/lib/pact_broker/doc/controllers/app_spec.rb

@@ -4,13 +4,13 @@ module PactBroker
   module Doc
     module Controllers
       describe App do
-
         describe "GET relation" do
 
           let(:app) { PactBroker::Doc::Controllers::App }
+          let(:rack_env) { {} }
 
           context "when the resource exists" do
-            subject { get "/webhooks" }
+            subject { get "/webhooks", nil, rack_env }
 
             it "returns a 200 status" do
               subject
@@ -34,9 +34,7 @@ module PactBroker
             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/css"

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

@@ -0,0 +1,27 @@
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.75.0
+  version: 2.76.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -565,6 +565,7 @@ files:
 - db/test/change_migration_strategy/before/Gemfile
 - docker-compose-ci-mysql.yml
 - docker-compose-dev-postgres.yml
+- docker-compose-issue-repro-with-pact-broker-docker-image.yml
 - docker-compose-issue-repro.yml
 - docker-compose-test.yml
 - docs/images/Pactflow logo - black small.png
@@ -970,10 +971,12 @@ 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
 - lib/rack/pact_broker/reset_thread_data.rb
+- lib/rack/pact_broker/set_base_url.rb
 - lib/rack/pact_broker/ui_authentication.rb
 - lib/rack/pact_broker/ui_request_filter.rb
 - lib/rack/pact_broker/use_when.rb
@@ -1380,6 +1383,7 @@ 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
@@ -1782,6 +1786,7 @@ 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