pact_broker 2.27.6 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e90caf2f7b3f95a72409e71d887025c4af961ca
-  data.tar.gz: c7e7ffdac02f644178308f80420500dc5729e77a
+  metadata.gz: d618dcd0c7582bad7822bac6bf8b32db26a25cea
+  data.tar.gz: 2a0d1f85dbdb9d2291308e483d60422431fe4013
 SHA512:
-  metadata.gz: 334d5d897be6dd5886cdf761d4d6cbad10ab46f23acca55e05736b91e9ba651c40347b99e051a04451380135572c868bf829afd099362e30a066c72fc8ca17d3
-  data.tar.gz: e92686f872dc74ab1ded642e4a76c63eb39520bd77549d543416c8e3dce7e84ba7703beacf52f798ab306d7f5ce95cca7f965f9e7999df2f9aedf67372db6776
+  metadata.gz: f7ee32711c4be853ccfb0d0eefd62c87ec9aad7407c2344a0d12c9537aeaa88483e0fce93c33e1ed51389c98f41dae1125f11ce47869e5b73a11e866473c03aa
+  data.tar.gz: 3b8217e5d02bff7be409a8dbfa51a4caf8ca1f6dfb2132b470926100efa7aa5c2dd9c85525ae4bd54c8997091c2c2495ebce785342dc4341c41b7562b093edf8

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle
@@ -6,6 +7,7 @@ coverage
 InstalledFiles
 lib/bundler/man
 log
+*.log
 pkg
 rdoc
 spec/reports
@@ -25,11 +27,12 @@ _yardoc
 *.swp
 .idea
 
-*.sqlite
+*.sqlite3
 Gemfile.lock
 
 bethtest/
 *bethtest*
+*bethtemp*
 *dogfood*
 bin/
 db/test/change_migration_strategy/pact_broker_database.sqlite3

data/.travis.yml

@@ -26,5 +26,4 @@ before_script:
 script:
   - bundle exec rake
   - if [ "$DATABASE_ADAPTER" == "postgres" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || true; fi
-  # - if [ ! -z "$(ruby --version | grep '2\.4\.')" ]; then ./script/db-spec.sh; fi
-  - bundle exec bundle-audit update && bundle exec bundle-audit
+  # - if [ ! -z "$(ruby --version | grep '2\.4\.')" ]; then ./script/db-spec.sh; fi

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+<a name="v2.29.0"></a>
+### v2.29.0 (2019-03-15)
+
+
+#### Features
+
+* **matrix**
+  * improve reasons in response when pacticipant cannot be deployed	 ([e96544f6](/../../commit/e96544f6))
+  * allow provider to be deployed to an environment without the consumer having to be deployed there already	 ([475a4010](/../../commit/475a4010))
+
+* change webhook execution failure log to info	 ([7238bc49](/../../commit/7238bc49))
+* remove db/pact_broker_database.sqlite3 so we don't have conflicts in fork	 ([f68fce8b](/../../commit/f68fce8b))
+* change error logs to info logs	 ([700f6992](/../../commit/700f6992))
+* lock dry-logic to version that works	 ([28769040](/../../commit/28769040))
+* allow a custom UI to be configured	 ([23695b08](/../../commit/23695b08))
+
+
+#### Bug Fixes
+
+* gracefully handle race conditions when publishing a new revision of a pact	 ([012c54f0](/../../commit/012c54f0))
+
+
+<a name="v2.28.0"></a>
+### v2.28.0 (2019-01-15)
+
+
+#### Features
+
+* enable file list in gemspec to work without git	 ([6dd27e26](/../../commit/6dd27e26))
+* allow the database connection to be configured for async jobs	 ([6a745d4b](/../../commit/6a745d4b))
+* add error reference to API error response and ensure potentially sensitive details from the exception message are not exposed	 ([e7bb4a01](/../../commit/e7bb4a01))
+
+
+#### Bug Fixes
+
+* show consumer/provider/global webhooks in webhook column on index page	 ([35f8bfc1](/../../commit/35f8bfc1))
+
+
 <a name="v2.27.6"></a>
 ### v2.27.6 (2018-11-23)
 

data/MATRIX.md

@@ -0,0 +1,4 @@
+# Interpreting the Matrix results
+
+* If there is a row with a blank provider version, it's because the pact for that consumer version hasn't been verified by that provider (the result of a left outer join).
+* If there is no row, it's because it has been verified, but not by the provider version you've specified.

data/README.md

@@ -1,9 +1,10 @@
 # Pact Broker
 [![Gem Version](https://badge.fury.io/rb/pact_broker.svg)](http://badge.fury.io/rb/pact_broker)
- [![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker) [![Join the chat at https://gitter.im/pact-foundation/pact_broker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pact-foundation/pact_broker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+ [![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker)
+ [![Join the chat at https://pact-foundation.slack.com/](https://img.shields.io/badge/chat-on%20slack-blue.svg?logo=slack)](https://slack.pact.io)
+ [![security](https://hakiri.io/github/pact-foundation/pact_broker/master.svg)](https://hakiri.io/github/pact-foundation/pact_broker/master)
  [![Code Climate](https://codeclimate.com/github/pact-foundation/pact_broker/badges/gpa.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)
  [![Test Coverage](https://codeclimate.com/github/pact-foundation/pact_broker/badges/coverage.svg)](https://codeclimate.com/github/pact-foundation/pact_broker/coverage)
- [![Issue Count](https://codeclimate.com/github/pact-foundation/pact_broker/badges/issue_count.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)
 
 The Pact Broker is an application for sharing for consumer driven contracts and verification results. It is optimised for use with "pacts" (contracts created by the [Pact][pact-docs] framework), but can be used for any type of contract that can be serialized to JSON.
 

data/Rakefile

@@ -14,9 +14,8 @@ end
 FileList['lib/tasks/**/*.rake'].each { |task| load "#{Dir.pwd}/#{task}" }
 FileList['tasks/**/*.rake'].each { |task| load "#{Dir.pwd}/#{task}" }
 
-task :default => ['db:prepare:test', :boot, :spec, 'pact:verify']
+task :default => ['db:prepare:test', :boot, :spec, 'pact:verify', 'bundle:audit']
 
 task :boot do
   require File.join(File.dirname(__FILE__), 'config/boot')
 end
-

data/config/database.yml

@@ -16,6 +16,11 @@ test:
     adapter: postgres
     host: "127.0.0.1"
     port: "5433"
+  docker_compose_postgres:
+    <<: *default
+    adapter: postgres
+    host: postgres
+    port: "5432"
   mysql:
     <<: *default
     adapter: mysql2

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

@@ -1,5 +1,6 @@
 require 'ostruct'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/api/decorators/reason_decorator'
 
 module PactBroker
   module Api
@@ -33,7 +34,11 @@ module PactBroker
         end
 
         def reason
-          query_results_with_deployment_status_summary.deployment_status_summary.reasons.join("\n")
+          query_results_with_deployment_status_summary
+            .deployment_status_summary
+            .reasons
+            .collect{ | reason | ReasonDecorator.new(reason).to_s }
+            .join("\n")
         end
 
         private
@@ -130,3 +135,4 @@ module PactBroker
     end
   end
 end
+

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

@@ -0,0 +1,50 @@
+module PactBroker
+  module Api
+    module Decorators
+      class ReasonDecorator
+        def initialize(reason)
+          @reason = reason
+        end
+
+        def to_s
+          case reason
+          when PactBroker::Matrix::PactNotEverVerifiedByProvider
+            "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::SpecifiedVersionDoesNotExist
+            version_does_not_exist_description(reason.selector)
+          when PactBroker::Matrix::VerificationFailed
+            "The verification for the pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description} failed"
+          when PactBroker::Matrix::NoDependenciesMissing
+            "There are no missing dependencies"
+          when PactBroker::Matrix::Successful
+            "All required verification results are published and successful"
+          else
+            reason
+          end
+        end
+
+        private
+
+        attr_reader :reason
+
+        def version_does_not_exist_description selector
+          if selector.version_does_not_exist?
+            if selector.tag
+              "No version with tag #{selector.tag} exists for #{selector.pacticipant_name}"
+            elsif selector.pacticipant_version_number
+              "No pacts or verifications have been published for version #{selector.pacticipant_version_number} of #{selector.pacticipant_name}"
+            else
+              "No pacts or verifications have been published for #{selector.pacticipant_name}"
+            end
+          else
+            ""
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -127,7 +127,7 @@ module PactBroker
             JSON.parse(request_body, PACT_PARSING_OPTIONS) #Not load! Otherwise it will try to load Ruby classes.
             false
           rescue StandardError => e
-            logger.error "Error parsing JSON #{e} - #{request_body}"
+            logger.info "Error parsing JSON #{e} - #{request_body}"
             set_json_error_message "Error parsing JSON - #{e.message}"
             response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
             true

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

@@ -1,5 +1,6 @@
 require 'webmachine/convert_request_to_rack_env'
 require 'pact_broker/configuration'
+require 'securerandom'
 
 module PactBroker
   module Api
@@ -10,24 +11,46 @@ module PactBroker
         include PactBroker::Logging
 
         def self.call e, request, response
-          logger.error e
+          error_reference = SecureRandom.urlsafe_base64.gsub(/[^a-z]/i, '')[0,10]
+          logger.error "#{e.message} - error reference #{error_reference}"
           logger.error e.backtrace
-          response_body = { error: { :message => e.message } }
-          if PactBroker.configuration.show_backtrace_in_error_response?
-            response_body[:error][:backtrace] = e.backtrace
-          end
-          response.body = response_body.to_json
-          report(e, request) if reportable?(e)
+          response.body = response_body_hash(e, error_reference).to_json
+          report(e, error_reference, request) if reportable?(e)
         end
 
         def self.reportable? e
           !e.is_a?(PactBroker::Error)
         end
 
-        def self.report e, request
+        def self.display_message(e, error_reference)
+          if PactBroker.configuration.show_backtrace_in_error_response?
+            e.message
+          else
+           reportable?(e) ? obfuscated_error_message(error_reference) : e.message
+          end
+        end
+
+        def self.obfuscated_error_message error_reference
+          "An error has occurred. The details have been logged with the reference #{error_reference}"
+        end
+
+        def self.response_body_hash e, error_reference
+          response_body = {
+            error: {
+              message: display_message(e, error_reference),
+              reference: error_reference
+            }
+          }
+          if PactBroker.configuration.show_backtrace_in_error_response?
+            response_body[:error][:backtrace] = e.backtrace
+          end
+          response_body
+        end
+
+        def self.report e, error_reference, request
           PactBroker.configuration.api_error_reporters.each do | error_notifier |
             begin
-              error_notifier.call(e, env: Webmachine::ConvertRequestToRackEnv.call(request))
+              error_notifier.call(e, env: Webmachine::ConvertRequestToRackEnv.call(request), error_reference: error_reference)
             rescue StandardError => e
               log_error(e, "Error executing api_error_reporter")
             end

data/lib/pact_broker/app.rb

@@ -32,7 +32,6 @@ module PactBroker
       yield configuration
       post_configure
       prepare_database
-      prepare_app
     end
 
     # Allows middleware to be inserted at the bottom of the shared middlware stack
@@ -54,12 +53,18 @@ module PactBroker
       @make_it_later_ui_auth.make_it_later(middleware)
     end
 
+    def use_custom_ui custom_ui
+      @custom_ui = custom_ui
+    end
+
     def call env
       running_app.call env
     end
 
     private
 
+    attr_reader :custom_ui
+
     def post_configure
       configure_logger
       SuckerPunch.logger = configuration.custom_logger || SemanticLogger['SuckerPunch']
@@ -101,6 +106,7 @@ module PactBroker
       configure_middleware
 
       # need this first so UI login logic is performed before API login logic
+      @cascade_apps << build_custom_ui if custom_ui
       @cascade_apps << build_ui
 
       if configuration.enable_diagnostic_endpoints
@@ -139,6 +145,14 @@ module PactBroker
       builder
     end
 
+    def build_custom_ui
+      logger.info "Mounting Custom UI"
+      builder = ::Rack::Builder.new
+      builder.use Rack::PactBroker::AcceptsHtmlFilter
+      builder.run @custom_ui
+      builder
+    end
+
     def build_api
       logger.info "Mounting PactBroker::API"
       require 'pact_broker/api'
@@ -174,6 +188,7 @@ module PactBroker
 
     def running_app
       @running_app ||= begin
+        prepare_app
         apps = @cascade_apps
         @app_builder.map "/" do
           run Rack::Cascade.new(apps)

data/lib/pact_broker/domain/webhook_request.rb

@@ -196,7 +196,7 @@ module PactBroker
       end
 
       def log_error e
-        logger.error "Error executing webhook #{uuid} #{e.class.name} - #{e.message} #{e.backtrace.join("\n")}"
+        logger.info "Error executing webhook #{uuid} #{e.class.name} - #{e.message} #{e.backtrace.join("\n")}"
 
         if options[:show_response]
           execution_logger.error "Error executing webhook #{uuid} #{e.class.name} - #{e.message}"

data/lib/pact_broker/matrix/deployment_status_summary.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/logging'
+require 'pact_broker/matrix/reason'
 
 module PactBroker
   module Matrix
@@ -11,89 +12,167 @@ module PactBroker
         @rows = rows
         @resolved_selectors = resolved_selectors
         @integrations = integrations
+        @dummy_selectors = create_dummy_selectors
       end
 
       def counts
         {
           success: rows.count{ |row| row.success },
           failed: rows.count { |row| row.success == false },
-          unknown: integrations_without_a_row.count + rows.count { |row| row.success.nil? }
+          unknown: required_integrations_without_a_row.count + rows.count { |row| row.success.nil? }
         }
       end
 
       def deployable?
-        return nil if rows.empty?
+        return false if specified_selectors_that_do_not_exist.any?
         return nil if rows.any?{ |row| row.success.nil? }
-        return nil if integrations_without_a_row.any?
-        rows.all?{ |row| row.success }
+        return nil if required_integrations_without_a_row.any?
+        rows.all?{ |row| row.success } # true if rows is empty
       end
 
       def reasons
-        @reasons ||= begin
-          reasons = []
-          if rows.empty?
-            reasons << "No results matched the given query"
-          else
-            reasons.concat(missing_reasons)
-            reasons.concat(failure_messages)
-            reasons.concat(unverified_messages)
-            reasons.concat(success_messages)
+        error_messages.any? ? error_messages : success_messages
+      end
+
+      private
+
+      attr_reader :dummy_selectors
+
+      def error_messages
+        @error_messages ||= begin
+          messages = []
+          messages.concat(specified_selectors_do_not_exist_messages)
+          if messages.empty?
+            messages.concat(missing_reasons)
+            messages.concat(failure_messages)
+            messages.concat(not_ever_verified_reasons)
           end
-          reasons
+          messages.uniq
         end
       end
 
-      def unverified_messages
-        if rows.any?{ |row| row.success.nil? }
-          ["Missing one or more verification results"]
-        else
-          []
+      def specified_selectors_that_do_not_exist
+        resolved_selectors.select(&:specified_version_that_does_not_exist?)
+      end
+
+      def specified_selectors_do_not_exist_messages
+        specified_selectors_that_do_not_exist.collect do | selector |
+          SpecifiedVersionDoesNotExist.new(selector)
         end
       end
 
+      def not_ever_verified_reasons
+        rows.select{ | row | row.success.nil? }.collect{ |row | pact_not_ever_verified_by_provider(row) }
+      end
+
       def failure_messages
-        if rows.any?{ |row| row.success == false }
-          ["One or more verifications have failed"]
-        else
-          []
+        rows.select{ |row| row.success == false }.collect do | row |
+          VerificationFailed.new(*selectors_for(row))
         end
       end
 
       def success_messages
-        if rows.all?{ |row| row.success } && integrations_without_a_row.empty?
-          ["All verification results are published and successful"]
+        if rows.all?{ |row| row.success } && required_integrations_without_a_row.empty?
+          if rows.any?
+            [Successful.new]
+          else
+            [NoDependenciesMissing.new]
+          end
         else
           []
-        end
+        end.flatten.uniq
       end
 
-      def integrations_without_a_row
-        @integrations_without_a_row ||= begin
-          integrations.select do | relationship |
-            !rows.find do | row |
-              row.consumer_id == relationship.consumer_id && row.provider_id == relationship.provider_id
-            end
+      # For deployment, the consumer requires the provider,
+      # but the provider does not require the consumer
+      # This method tells us which providers are missing.
+      # Technically, it tells us which integrations do not have a row
+      # because the pact that belongs to the consumer version has
+      # in fact been verified, but not by the provider version specified
+      # in the query (because left outer join)
+      #
+      # Imagine query for deploying Foo v3 to prod with the following matrix:
+      # Foo v2 -> Bar v1 (latest prod) [this line not included because CV doesn't match]
+      # Foo v3 -> Bar v2               [this line not included because PV doesn't match]
+      #
+      # No matrix rows would be returned. This method identifies that we have no row for
+      # the Foo -> Bar integration, and therefore cannot deploy Foo.
+      # However, if we were to try and deploy the provider, Bar, that would be ok
+      # as Bar does not rely on Foo, so this method would not return that integration.
+      def required_integrations_without_a_row
+        @required_integrations_without_a_row ||= begin
+          integrations.select(&:required?).select do | integration |
+            !row_exists_for_integration(integration)
           end
         end
       end
 
+      def row_exists_for_integration(integration)
+        rows.find { | row | integration == row }
+      end
+
       def missing_reasons
-        integrations_without_a_row.collect do | missing_relationship|
-          consumer_version_desc = "#{missing_relationship.consumer_name} (#{resolved_version_for(missing_relationship.consumer_id)})"
-          provider_version_desc = "#{missing_relationship.provider_name} (#{resolved_version_for(missing_relationship.provider_id)})"
-          "There is no verified pact between #{consumer_version_desc} and #{provider_version_desc}"
-        end
+        required_integrations_without_a_row.collect do | integration |
+            pact_not_verified_by_required_provider_version(integration)
+        end.flatten
       end
 
-      def resolved_version_for(pacticipant_id)
-        resolved_selector = resolved_selectors.find{ | s| s[:pacticipant_id] == pacticipant_id }
-        if resolved_selector
-          resolved_selector[:pacticipant_version_number]
-        else
-          logger.warn "Could not find the resolved version for pacticipant_id #{pacticipant_id} from integrations #{integrations.collect(&:to_s).join(", ")} in resolved selectors #{resolved_selectors.inspect}"
-          "unresolved version"
+      def selectors_without_a_version_for(integration)
+        selectors_with_non_existing_versions.select do | selector |
+          integration.involves_pacticipant_with_name?(selector.pacticipant_name)
         end
       end
+
+      def selectors_with_non_existing_versions
+        @selectors_with_non_existing_versions ||= resolved_selectors.select(&:latest_tagged_version_that_does_not_exist?)
+      end
+
+      def missing_specified_version_reasons(selectors)
+        selectors.collect(&:version_does_not_exist_description)
+      end
+
+      def pact_not_verified_by_required_provider_version(integration)
+        PactNotVerifiedByRequiredProviderVersion.new(*selectors_for(integration))
+      end
+
+      def pact_not_ever_verified_by_provider(row)
+        PactNotEverVerifiedByProvider.new(*selectors_for(row))
+      end
+
+      def selector_for(pacticipant_name)
+        resolved_selectors.find{ | s| s.pacticipant_name == pacticipant_name } ||
+        dummy_selectors.find{ | s| s.pacticipant_name == pacticipant_name }
+      end
+
+      def selectors_for(row)
+        [selector_for(row.consumer_name), selector_for(row.provider_name)]
+      end
+
+      # When the user has not specified a version of the provider (eg no 'latest' and/or 'tag')
+      # so the "add inferred selectors" code in the Matrix::Repository has not run,
+      # we may end up with rows for which we do not have a selector.
+      # To solve this, create dummy selectors from the row and integration data.
+      def create_dummy_selectors
+        (dummy_selectors_from_rows + dummy_selectors_from_integrations).uniq
+      end
+
+      def dummy_selectors_from_integrations
+        integrations.collect do | row |
+          dummy_consumer_selector = ResolvedSelector.for_pacticipant(row.consumer, :inferred)
+          dummy_provider_selector = ResolvedSelector.for_pacticipant(row.provider, :inferred)
+          [dummy_consumer_selector, dummy_provider_selector]
+        end.flatten
+      end
+
+      def dummy_selectors_from_rows
+        rows.collect do | row |
+          dummy_consumer_selector = ResolvedSelector.for_pacticipant_and_version(row.consumer, row.consumer_version, {}, :inferred)
+          dummy_provider_selector = row.provider_version ?
+            ResolvedSelector.for_pacticipant_and_version(row.provider, row.provider_version, {}, :inferred) :
+            ResolvedSelector.for_pacticipant(row.provider, :inferred)
+          [dummy_consumer_selector, dummy_provider_selector]
+        end.flatten
+      end
     end
   end
 end