pact_broker 2.52.2 → 2.56.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd447b5cac167d4f764356d1c15c826a7de019d1871c684853ef602862cf387
-  data.tar.gz: '07328be4c8851d55e5a5834f69ce83e22df99c93cf83a21a657e1587f7afd8b3'
+  metadata.gz: 78ca82ae8d3f9574d9844689ebb3423e5a2c2966f5907253f82e996aa0dbdcd4
+  data.tar.gz: 64a1cec77d11ae9f82e4408736147afe69d294def7b07afa31bdab1c38947a72
 SHA512:
-  metadata.gz: 9b8420208b660677ba8f93373346ad39e80069ba282dd9ebd7206bf65ebdf05f7803c303c1e6e0a4ebc7f69d3ff6ea2b55ecfe4e56a2735975827bad26e10370
-  data.tar.gz: fecbcc5f5a4824d2dc3669d6bb4bb15456ad1434031dad96e71bd571e9f92fd73d1b90b142f0d0359d6943ab618768ba607f99119fa61ffb56f75f6fb8e29ef3
+  metadata.gz: c43133723319d295e3e3a9a818ef668e5f15b75b65589c90d77902737e807145e5647b92e4d7c80880e9886a4e75c20f23140716310f5c28dc77cd8a726e381c
+  data.tar.gz: 92cd37b6e992d89886fe7f9f6f9b220879b92c48f081c64ea344201229e45d8ca6a12fb676d0cecdba9d15da0ccd70163e54392acda943d4e66adea46706d9b6

data/CHANGELOG.md

@@ -1,3 +1,84 @@
+<a name="v2.56.1"></a>
+### v2.56.1 (2020-06-01)
+
+
+#### Bug Fixes
+
+* **matrix ui**
+  * fix home link	 ([67065b7d](/../../commit/67065b7d))
+
+
+<a name="v2.56.0"></a>
+### v2.56.0 (2020-06-01)
+
+
+#### Features
+
+* **database**
+  * log schema versions and migration info on startup	 ([b385e535](/../../commit/b385e535))
+  * allow options to be passed to Sequel migrate via the MigrationTask	 ([143613e7](/../../commit/143613e7))
+
+* allow Pactflow messages in logs to be hidden by setting PACT_BROKER_HIDE_PACTFLOW_MESSAGES=true	 ([a7550105](/../../commit/a7550105))
+
+* **can-i-deploy**
+  * experimental - add a warning message if there are interactions missing verification test results.	 ([f7ab8cc5](/../../commit/f7ab8cc5))
+
+
+#### Bug Fixes
+
+* use relative URLs when base_url not explictly set to ensure app is not vulnerable to host header attacks	 ([92c45a0a](/../../commit/92c45a0a))
+* raise PactBroker::Error when either pacticipant is not found in the business layer while attempting to delete an integration	 ([3c209a46](/../../commit/3c209a46))
+
+
+<a name="v2.55.0"></a>
+### v2.55.0 (2020-05-22)
+
+
+#### Features
+
+* support non root context (#344)	 ([dc480499](/../../commit/dc480499))
+
+
+<a name="v2.54.0"></a>
+### v2.54.0 (2020-05-13)
+
+
+#### Features
+
+* **hal browser**
+  * update to latest code	 ([a79ad290](/../../commit/a79ad290))
+
+
+#### Bug Fixes
+
+* update rack for CVE-2020-8161	 ([96c3386a](/../../commit/96c3386a))
+
+* **hal browser**
+  * fix xss vulnerability	 ([ac564412](/../../commit/ac564412))
+
+* **webhooks**
+  * add missing validation for event names when creating webhooks	 ([5fc0563c](/../../commit/5fc0563c))
+
+
+<a name="v2.53.0"></a>
+### v2.53.0 (2020-05-12)
+
+
+#### Features
+
+* **badge**
+  * include tag names in matrix badge	 ([cce7cd01](/../../commit/cce7cd01))
+
+
+#### Bug Fixes
+
+* **pacts for verification**
+  * ensure a separate pact URL is returned for each consumer when multiple consumers share the same pact json content	 ([13e7b640](/../../commit/13e7b640))
+
+* gracefully handle fetching matrix badge when specified pact does not exist	 ([e8ec4101](/../../commit/e8ec4101))
+* include the base URL in the link to the webhook docs	 ([5363ab2e](/../../commit/5363ab2e))
+
+
 <a name="v2.52.2"></a>
 ### v2.52.2 (2020-04-16)
 

data/README.md

@@ -64,8 +64,6 @@ If you don't have a [Pact Broker CI Nerf Gun][nerf], you'll probably want to rea
 
 #### Step 3. Back to the Consumer CI build
 
-The following funcationality is in beta release. Your feedback would be appreciated.
-
 1. The Consumer CI determines if the pact has been verified by running `pact-broker can-i-deploy --pacticipant CONSUMER_NAME --version CONSUMER_VERSION ...` (see documentation [here](https://github.com/pact-foundation/pact_broker-client#can-i-deploy))
 1. If the pact has been verified, the deployment can proceed.
 
@@ -123,8 +121,8 @@ Use the HAL browser to view documentation as you browse.
     * unix users just use your package manager
 * Run `git clone git@github.com:pact-foundation/pact_broker.git && cd pact_broker/example`
 * Run `bundle install`
-* Run `bundle exec rackup -p 8080` (this will use a Sqlite database. If you want to try it out with a Postgres database, see the [README](https://github.com/pact-foundation/pact_broker/tree/master/example) in the example directory.)
-* Open [http://localhost:8080](http://localhost:8080) and you should see a list containing the pact between the Zoo App and the Animal Service.
+* Run `bundle exec rackup -p 9292 -o 0.0.0.0` (this will use a Sqlite database. If you want to try it out with a Postgres database, see the [README](https://github.com/pact-foundation/pact_broker/tree/master/example) in the example directory.)
+* Open [http://localhost:9292](http://localhost:9292) and you should see a list containing the pact between the Zoo App and the Animal Service.
 * Click on the arrow to see the generated HTML documentation.
 * Click on either service to see an autogenerated network diagram.
 * Click on the HAL Browser link to have a poke around the API.

data/lib/pact_broker/api.rb

@@ -3,6 +3,14 @@ require 'webmachine/rack_adapter_monkey_patch'
 require 'pact_broker/api/resources'
 require 'pact_broker/feature_toggle'
 
+module Webmachine
+  class Request
+    def patch?
+      method == "PATCH"
+    end
+  end
+end
+
 module PactBroker
 
   API ||= begin

data/lib/pact_broker/api/contracts/webhook_contract.rb

@@ -2,6 +2,7 @@ require 'pact_broker/api/contracts/base_contract'
 require 'pact_broker/webhooks/check_host_whitelist'
 require 'pact_broker/webhooks/render'
 require 'pact_broker/pacticipants/service'
+require 'pact_broker/webhooks/webhook_event'
 
 module PactBroker
   module Api
@@ -13,11 +14,13 @@ module PactBroker
           # I just cannot seem to get the validation to stop on the first error.
           # If one rule fails, they all come back failed, and it's driving me nuts.
           # Why on earth would I want that behaviour?
-          new_errors = Reform::Contract::Errors.new
-          errors.messages.each do | key, value |
-            new_errors.add(key, value.first)
+          # I cannot believe I have to do this shit.
+          @first_errors = errors
+          @first_errors.messages.keys.each do | key |
+            @first_errors.messages[key] = @first_errors.messages[key][0...1]
           end
-          @errors = new_errors
+
+          def self.errors; @first_errors end
           result
         end
 
@@ -46,7 +49,6 @@ module PactBroker
 
             required(:name).filled(:pacticipant_exists?)
           end
-
         end
 
         property :provider do
@@ -155,7 +157,7 @@ module PactBroker
           property :name
 
           validation do
-            required(:name).filled
+            required(:name).filled(included_in?: PactBroker::Webhooks::WebhookEvent::EVENT_NAMES)
           end
         end
       end

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

@@ -1,20 +1,15 @@
 module PactBroker
   module Api
     module Decorators
-
       class DecoratorContext < Hash
 
-        attr_reader :base_url, :resource_url, :resource_title
+        attr_reader :base_url, :resource_url, :resource_title, :env
 
-        def initialize base_url, resource_url, options = {}
-          @base_url = base_url
-          self[:base_url] = base_url
-          @resource_url = resource_url
-          self[:resource_url] = resource_url
-          if options[:resource_title]
-            @resource_title = options[:resource_title]
-            self[:resource_title] = resource_title
-          end
+        def initialize base_url, resource_url, env, options = {}
+          @base_url = self[:base_url] = base_url
+          @resource_url = self[:resource_url]= resource_url
+          @resource_title = self[:resource_title] = options[:resource_title]
+          @env = self[:env] = env
           merge!(options)
         end
 

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

@@ -22,6 +22,11 @@ module PactBroker
             "There are no missing dependencies"
           when PactBroker::Matrix::Successful
             "All required verification results are published and successful"
+          when PactBroker::Matrix::InteractionsMissingVerifications
+            descriptions = reason.interactions.collect do | interaction |
+              interaction_description(interaction)
+            end.join('; ')
+            "WARNING: Although the verification was reported as successful, the results for #{reason.consumer_selector.description} and #{reason.provider_selector.description} may be missing tests for the following interactions: #{descriptions}"
           else
             reason
           end
@@ -44,6 +49,18 @@ module PactBroker
             ""
           end
         end
+
+        # TODO move this somewhere else
+        def interaction_description(interaction)
+          if interaction['providerState'] && interaction['providerState'] != ''
+            "#{interaction['description']} given #{interaction['providerState']}"
+          elsif interaction['providerStates'] && interaction['providerStates'].is_a?(Array) && interaction['providerStates'].any?
+            provider_states = interaction['providerStates'].collect{ |ps| ps['name'] }.compact.join(', ')
+            "#{interaction['description']} given #{provider_states}"
+          else
+            interaction['description']
+          end
+        end
       end
     end
   end

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

@@ -78,8 +78,13 @@ module PactBroker
           }
         end
 
+        def to_hash(options)
+          @to_hash_options = options
+          super
+        end
+
         def response_hidden_message
-          PactBroker::Messages.message('messages.response_body_hidden')
+          PactBroker::Messages.message('messages.response_body_hidden', base_url: @to_hash_options[:user_options][:base_url])
         end
       end
     end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -253,6 +253,10 @@ module PactBroker
         "/matrix/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
       end
 
+      def matrix_badge_url_for_selectors consumer_selector, provider_selector, base_url = ''
+        "#{base_url}/matrix/provider/#{url_encode(provider_selector.pacticipant_name)}/latest/#{url_encode(provider_selector.tag)}/consumer/#{url_encode(consumer_selector.pacticipant_name)}/latest/#{url_encode(consumer_selector.tag)}/badge.svg"
+      end
+
       def matrix_for_pacticipant_version_url(version, base_url = '')
         query = {
           q: [{ pacticipant: version.pacticipant.name, version: version.number }],
@@ -280,8 +284,8 @@ module PactBroker
         "#{base_url}/groups/#{pacticipant_name}"
       end
 
-      def hal_browser_url target_url
-        "/hal-browser/browser.html#" + target_url
+      def hal_browser_url target_url, base_url = ''
+        "#{base_url}/hal-browser/browser.html#" + target_url
       end
 
       def url_encode param

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -37,18 +37,18 @@ module PactBroker
 
         def head
          "<title>#{title}</title>
-          <link rel='stylesheet' type='text/css' href='/stylesheets/github.css'>
-          <link rel='stylesheet' type='text/css' href='/stylesheets/pact.css'>
-          <link rel='stylesheet' type='text/css' href='/stylesheets/github-json.css'>
-          <link rel='stylesheet' type='text/css' href='/css/bootstrap.min.css'>
-          <link rel='stylesheet' type='text/css' href='/stylesheets/material-menu.css'>
-          <link rel='stylesheet' type='text/css' href='/stylesheets/jquery-confirm.min.css'>
-          <script src='/javascripts/highlight.pack.js'></script>
-          <script src='/javascripts/jquery-3.3.1.min.js'></script>
-          <script src='/js/bootstrap.min.js'></script>
-          <script src='/javascripts/material-menu.js'></script>
-          <script src='/javascripts/pact.js'></script>
-          <script src='/javascripts/jquery-confirm.min.js'></script>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/github.css'>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/pact.css'>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/github-json.css'>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/css/bootstrap.min.css'>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/material-menu.css'>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/jquery-confirm.min.css'>
+          <script src='#{base_url}/javascripts/highlight.pack.js'></script>
+          <script src='#{base_url}/javascripts/jquery-3.3.1.min.js'></script>
+          <script src='#{base_url}/js/bootstrap.min.js'></script>
+          <script src='#{base_url}/javascripts/material-menu.js'></script>
+          <script src='#{base_url}/javascripts/pact.js'></script>
+          <script src='#{base_url}/javascripts/jquery-confirm.min.js'></script>
           <script>hljs.initHighlightingOnLoad();</script>"
         end
 
@@ -72,7 +72,7 @@ module PactBroker
                 <a href=\"#{matrix_url}\">View Matrix</a>
               </li>
               <li>
-                <a href=\"/\">Home</a>
+                <a href=\"#{base_url}\">Home</a>
               </li>
               <li>
                 <span data-consumer-name=\"#{@pact.consumer.name}\"
@@ -129,7 +129,7 @@ module PactBroker
         end
 
         def json_url
-          PactBroker::Api::PactBrokerUrls.hal_browser_url pact_url
+          PactBroker::Api::PactBrokerUrls.hal_browser_url pact_url, base_url
         end
 
         def pact_url

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

@@ -34,12 +34,12 @@ module PactBroker
 
         def to_svg
           response.headers['Cache-Control'] = 'no-cache'
-          comment + badge_service.pact_verification_badge(pact, label, initials, pseudo_branch_verification_status)
+          comment + badge_service.pact_verification_badge(pact, label, initials, pseudo_branch_verification_status, tags)
         end
 
         def moved_temporarily?
           response.headers['Cache-Control'] = 'no-cache'
-          badge_service.pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status)
+          badge_service.pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status, tags)
         end
 
         private
@@ -72,6 +72,10 @@ module PactBroker
           verification_number =  latest_verification ? latest_verification.number : "?"
           "<!-- #{identifier_from_path[:consumer_name]} version #{consumer_version_number} revision #{pact_revision} #{identifier_from_path[:provider_name]} version #{provider_version_number} number #{verification_number} -->\n"
         end
+
+        def tags
+          {}
+        end
       end
     end
   end

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

@@ -33,8 +33,8 @@ module PactBroker
           { 'Access-Control-Allow-Methods' => allowed_methods.join(", ")}
         end
 
-        def update_matrix_after_request?
-          false
+        def known_methods
+          super + ['PATCH']
         end
 
         def finish_request
@@ -62,6 +62,11 @@ module PactBroker
           PactBroker.configuration.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
+          PactBroker.configuration.base_url || ''
+        end
+
         def charsets_provided
           [['utf-8', :encode]]
         end
@@ -76,7 +81,7 @@ module PactBroker
         end
 
         def decorator_context options = {}
-          Decorators::DecoratorContext.new(base_url, resource_url, options)
+          Decorators::DecoratorContext.new(base_url, resource_url, request.env, options)
         end
 
         def handle_exception e

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

@@ -36,7 +36,7 @@ module PactBroker
         def to_html
           PactBroker.configuration.html_pact_renderer.call(
             pact, {
-              base_url: base_url,
+              base_url: ui_base_url,
               badge_url: "#{resource_url}/badge.svg"
           })
         end

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

@@ -7,7 +7,12 @@ module PactBroker
 
         private
 
+        def tags
+          { consumer_tag: identifier_from_path[:tag], provider_tag: identifier_from_path[:provider_tag] }
+        end
+
         def latest_verification
+          return nil unless pact
           @latest_verification ||= verification_service.find_latest_verification_for_tags(
             identifier_from_path[:consumer_name],
             identifier_from_path[:provider_name],

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

@@ -9,14 +9,6 @@ require 'pact_broker/api/contracts/put_pact_params_contract'
 require 'pact_broker/webhooks/execution_configuration'
 require 'pact_broker/api/resources/webhook_execution_methods'
 
-module Webmachine
-  class Request
-    def patch?
-      method == "PATCH"
-    end
-  end
-end
-
 module PactBroker
   module Api
     module Resources
@@ -41,10 +33,6 @@ module PactBroker
           ["GET", "PUT", "DELETE", "PATCH", "OPTIONS"]
         end
 
-        def known_methods
-          super + ['PATCH']
-        end
-
         def is_conflict?
           merge_conflict = request.patch? && resource_exists? &&
             Pacts::Merger.conflict?(pact.json_content, pact_params.json_content)
@@ -89,8 +77,8 @@ module PactBroker
         def to_html
           PactBroker.configuration.html_pact_renderer.call(
             pact, {
-              base_url: base_url,
-              badge_url: badge_url_for_latest_pact(pact, base_url)
+              base_url: ui_base_url,
+              badge_url: badge_url_for_latest_pact(pact, ui_base_url)
           })
         end
 
@@ -110,13 +98,9 @@ module PactBroker
           @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
         end
 
-        def update_matrix_after_request?
-          request.put? || request.patch?
-        end
-
         def set_post_deletion_response
           latest_pact = pact_service.find_latest_pact(pact_params)
-          response_body = { "_links" => {} }
+          response_body = { "_links" => { index: { href: base_url } } }
           if latest_pact
             response_body["_links"]["pb:latest-pact-version"] = {
               href: latest_pact_url(base_url, latest_pact),