pact_broker 2.59.1 → 2.62.0

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

@@ -6,7 +6,6 @@ module PactBroker
   module Api
     module Resources
       class Versions < BaseResource
-
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
@@ -24,7 +23,11 @@ module PactBroker
         end
 
         def versions
-          pacticipant_service.find_all_pacticipant_versions_in_reverse_order pacticipant_name
+          @versions ||= pacticipant_service.find_all_pacticipant_versions_in_reverse_order pacticipant_name
+        end
+
+        def policy_name
+          :'versions::versions'
         end
       end
     end

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

@@ -57,6 +57,10 @@ module PactBroker
           true
         end
 
+        def policy_name
+          :'webhooks::webhook'
+        end
+
         private
 
         def webhook

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

@@ -48,6 +48,10 @@ module PactBroker
           end
         end
 
+        def policy_name
+          :'webhooks::webhook'
+        end
+
         private
 
         def post_response_body webhook_execution_result

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

@@ -50,10 +50,14 @@ module PactBroker
           Decorators::WebhooksDecorator.new(webhooks).to_json(decorator_options(resource_title: 'Pact webhooks'))
         end
 
+        def policy_name
+          :'webhooks::webhooks'
+        end
+
         private
 
         def webhooks
-          webhook_service.find_by_consumer_and_provider consumer, provider
+          webhook_service.find_by_consumer_and_provider(consumer, provider)
         end
 
         def webhook

data/lib/pact_broker/app.rb

@@ -227,7 +227,7 @@ module PactBroker
 
     def configure_sucker_punch
       SuckerPunch.exception_handler = -> (ex, klass, args) do
-        PactBroker.log_error(ex, "Unhandled Suckerpunch error for #{klass}.perform(#{args.inspect})")
+        PactBroker.logger.warn("Unhandled Suckerpunch error for #{klass}.perform(#{args.inspect})", ex)
       end
     end
 

data/lib/pact_broker/badges/service.rb

@@ -100,7 +100,7 @@ module PactBroker
           logger.warn "Timeout retrieving badge from #{uri} #{e.class} - #{e.message}"
           nil
         rescue StandardError => e
-          log_error e, "Error retrieving badge from #{uri}"
+          logger.warn("Error retrieving badge from #{uri}", e)
           nil
         end
       end

data/lib/pact_broker/certificates/service.rb

@@ -18,7 +18,7 @@ module PactBroker
             logger.debug("Loading certificate #{certificate.subject} in to cert store")
             cert_store.add_cert(certificate)
           rescue StandardError => e
-            log_error e, "Error adding certificate object #{certificate.to_s} to store"
+            logger.warn("Error adding certificate object #{certificate.to_s} to store", e)
           end
         end
         cert_store
@@ -31,7 +31,7 @@ module PactBroker
             begin
               OpenSSL::X509::Certificate.new(c)
             rescue StandardError => e
-              log_error e, "Error creating certificate object from certificate #{certificate.uuid} '#{certificate.description}'"
+              logger.warn("Error creating certificate object from certificate #{certificate.uuid} '#{certificate.description}'", e)
               nil
             end
           end

data/lib/pact_broker/configuration.rb

@@ -31,12 +31,19 @@ module PactBroker
       :webhook_host_whitelist,
       :base_equality_only_on_content_that_affects_verification_results,
       :seed_example_data,
-      :badge_provider_mode
+      :badge_provider_mode,
+      :warning_error_class_names,
+      :base_url,
+      :log_dir,
+      :allow_missing_migration_files,
+      :auto_migrate_db_data,
+      :use_rack_protection
     ]
 
     attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :allow_missing_migration_files, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser, :sha_generator
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
+    attr_accessor :warning_error_class_names
     attr_accessor :check_for_potential_duplicate_pacticipant_names
     attr_accessor :webhook_retry_schedule
     attr_reader :webhook_http_method_whitelist, :webhook_scheme_whitelist, :webhook_host_whitelist
@@ -115,6 +122,7 @@ module PactBroker
         require 'pact_broker/api/resources/default_base_resource'
         PactBroker::Api::Resources::DefaultBaseResource
       }
+      config.warning_error_class_names = ['Sequel::ForeignKeyConstraintViolation']
       config
     end
 
@@ -126,6 +134,12 @@ module PactBroker
       @custom_logger = logger
     end
 
+    def log_configuration
+      SAVABLE_SETTING_NAMES.sort.each do | setting |
+        logger.info "PactBroker.configuration.#{setting}=#{PactBroker.configuration.send(setting).inspect}"
+      end
+    end
+
     def self.default_html_pact_render
       lambda { |pact, options|
         require 'pact_broker/api/renderers/html_pact_renderer'
@@ -228,6 +242,12 @@ module PactBroker
       @webhook_host_whitelist = parse_space_delimited_string_list_property('webhook_host_whitelist', webhook_host_whitelist)
     end
 
+    def warning_error_classes
+      warning_error_class_names.collect do | class_name |
+        Object.const_get(class_name)
+      end
+    end
+
     private
 
     def parse_space_delimited_string_list_property property_name, property_value

data/lib/pact_broker/db.rb

@@ -3,6 +3,7 @@ require 'pact_broker/db/validate_encoding'
 require 'pact_broker/db/migrate'
 require 'pact_broker/db/migrate_data'
 require 'pact_broker/db/version'
+require 'pact_broker/db/table_dependency_calculator'
 
 Sequel.datetime_class = DateTime
 
@@ -31,6 +32,19 @@ module PactBroker
       Sequel::TimestampMigrator.is_current?(database_connection, PactBroker::DB::MIGRATIONS_DIR, options)
     end
 
+    def self.truncate database_connection, options = {}
+      exceptions = options[:except] || []
+      TableDependencyCalculator.call(database_connection).each do | table_name |
+        if !exceptions.include?(table_name)
+          begin
+            database_connection[table_name].truncate
+          rescue StandardError => e
+            puts "Could not truncate table #{table_name}"
+          end
+        end
+      end
+    end
+
     def self.version database_connection
       PactBroker::DB::Version.call(database_connection)
     end

data/lib/pact_broker/db/table_dependency_calculator.rb

@@ -0,0 +1,45 @@
+module PactBroker
+  module DB
+
+    # Returns a list of the tables in the database in the order in which
+    # they can be truncated or dropped
+    class TableDependencyCalculator
+
+      def self.call connection
+        new(connection).call
+      end
+
+      def initialize connection
+        @connection = connection
+      end
+
+      def call
+        ordered_table_names = []
+        dependencies = @connection
+          .tables
+          .collect{|it| @connection.foreign_key_list(it)
+          .collect{|fk| {from: it, to: fk[:table]} } }
+          .flatten
+          .uniq
+        table_names = @connection.tables - [:schema_migrations, :schema_info]
+        check(table_names, dependencies, ordered_table_names)
+        ordered_table_names
+      end
+
+      def deps_on table_name, deps
+        deps.select{ | d| d[:to] == table_name }.collect{ |d| d[:from] }
+      end
+
+      def check table_names, deps, ordered_table_names
+        return if table_names.size == 0
+        remaining_dependencies = deps_on(table_names.first, deps) - ordered_table_names
+        if remaining_dependencies.size == 0
+          ordered_table_names << table_names.first
+          check(table_names[1..-1], deps, ordered_table_names)
+        else
+          check((remaining_dependencies + table_names).uniq, deps, ordered_table_names)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/doc/views/provider-pacts-for-verification.markdown

@@ -0,0 +1,78 @@
+# Provider pacts for verification
+
+Path: `/pacts/provider/{provider}/for-verification`
+
+Allowed methods: `POST`
+
+Content type: `application/hal+json`
+
+Returns a deduplicated list of pacts to be verified by the specified provider.
+
+### Body
+
+Example: This data structure represents the way a user might specify "I want to verify the latest 'master' pact, all 'prod' pacts, and when I publish the verification results, I'm going to tag the provider version with 'master'"
+
+    {
+      "consumerVersionSelectors": [
+        {
+          "tag": "master",
+          "latest": true
+        },{
+          "tag": "prod"
+        }
+      ],
+      "providerVersionTags": ["master"],
+      "includePendingStatus": true,
+      "includeWipPactsSince": "2020-01-01"
+    }
+
+
+`consumerVersionSelectors.tag`: the tag name(s) of the consumer versions to get the pacts for.
+
+`consumerVersionSelectors.fallbackTag`: the name of the tag to fallback to if the specified `tag` does not exist. This is useful when the consumer and provider use matching branch names to coordinate the development of new features.
+
+`consumerVersionSelectors.latest`: true. If the latest flag is omitted, *all* the pacts with the specified tag will be returned. (This might seem a bit weird, but it's done this way to match the syntax used for the matrix query params. See https://docs.pact.io/selectors)
+
+`consumerVersionSelectors.consumer`: allows a selector to only be applied to a certain consumer. This is used when there is an API that has multiple consumers, one of which is a deployed service, and one of which is a mobile consumer. The deployed service only needs the latest production pact verified, where as the mobile consumer may want all the production pacts verified.
+
+`providerVersionTags`: the tag name(s) for the provider application version that will be published with the verification results. This is used by the Broker to determine whether or not a particular pact is in pending state or not. This parameter can be specified multiple times.
+
+`includePendingStatus`: true|false (default false). When true, a pending boolean will be added to the verificationProperties in the response, and an extra message will appear in the notices array to indicate why this pact is/is not in pending state. This will allow your code to handle the response based on only what is present in the response, and not have to do ifs based on the user's options together with the response. As requested in the "pacts for verification" issue, please print out these messages in the tests if possible. If not possible, perhaps create a separate task which will list the pact URLs and messages for debugging purposes.
+
+`includeWipPactsSince`: Date string. The date from which to include the "work in progress" pacts. See https://docs.pact.io/wip for more information on work in progress pacts.
+
+### Response body
+
+`pending` flag and  the "pending reason" notice will only be included if `includePendingStatus` is set to true.
+
+
+    {
+      "_embedded": {
+        "pacts": [
+          {
+            "verificationProperties": {
+              "notices": [
+                {
+                  "text": "This pact is being verified because it is the pact for the latest version of Foo tagged with 'dev'",
+                  "when": "before_verification"
+                }
+              ],
+              "pending": false
+            },
+            "_links": {
+              "self": {
+                "href": "http://localhost:9292/pacts/provider/Bar/consumer/Foo/pact-version/0e3369199f4008231946e0245474537443ccda2a",
+                "name": "Pact between Foo (v1.0.0) and Bar"
+              }
+            }
+          }
+        ]
+      },
+      "_links": {
+        "self": {
+          "href": "http://localhost:9292/pacts/provider/Bar/for-verification",
+          "title": "Pacts to be verified"
+        }
+      }
+    }
+

data/lib/pact_broker/domain/pact.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/db'
 require 'pact_broker/json'
+require 'pact_broker/pacts/content'
 
 =begin
 This class most accurately represents a PactPublication
@@ -76,6 +77,14 @@ module PactBroker
         JSON.parse(json_content, PACT_PARSING_OPTIONS)
       end
 
+      def content_object
+        @content_object ||= begin
+          PactBroker::Pacts::Content.from_json(json_content)
+        rescue
+          PactBroker::Pacts::Content.new
+        end
+      end
+
       def pact_publication_id
         id
       end

data/lib/pact_broker/domain/webhook_request.rb

@@ -59,7 +59,9 @@ module PactBroker
 
       def http_request
         @http_request ||= begin
-          req = Net::HTTP.const_get(method.capitalize).new(url)
+          req = Net::HTTP.const_get(method.capitalize).new(uri.request_uri)
+          req.delete("accept-encoding")
+          req.delete("user-agent")
           headers.each_pair { | name, value | req[name] = value }
           req.basic_auth(username, password) if username && username.size > 0
           req.body = body unless body.nil?

data/lib/pact_broker/matrix/deployment_status_summary.rb

@@ -195,7 +195,7 @@ module PactBroker
               InteractionsMissingVerifications.new(selector_for(row.consumer_name), selector_for(row.provider_name), row.verification.interactions_missing_test_results)
             end
           rescue StandardError => e
-            log_error(e, "Error determining if there were missing interaction verifications")
+            logger.warn("Error determining if there were missing interaction verifications", e)
             nil
           end
         end.compact.tap { |it| report_missing_interaction_verifications(it) if it.any? }

data/lib/pact_broker/pacts/build_verifiable_pact_notices.rb

@@ -7,10 +7,13 @@ module PactBroker
       def self.call(verifiable_pact, pact_url, options)
         messages = VerifiablePactMessages.new(verifiable_pact, pact_url)
 
-        notices = [{
-          when: 'before_verification',
-          text: messages.inclusion_reason
-        }]
+        notices = []
+
+        if options[:deprecated]
+          append_notice(notices, 'before_verification', 'WARNING - this version of the Pact library uses a beta version of the API which will be removed in the future. Please upgrade your Pact library. See https://docs.pact.io/pact_broker/advanced_topics/provider_verification_results/#pacts-for-verification for minimum required versions.')
+        end
+
+        append_notice(notices, 'before_verification', messages.inclusion_reason)
 
         if options[:include_pending_status]
           append_notice(notices, 'before_verification', messages.pending_reason)

data/lib/pact_broker/pacts/content.rb

@@ -32,15 +32,22 @@ module PactBroker
       end
 
       def interactions_missing_test_results
-        interactions.reject do | interaction |
+        return [] unless messages_or_interactions
+        messages_or_interactions.reject do | interaction |
           interaction['tests']&.any?
         end
       end
 
       def with_test_results(test_results)
-        tests = test_results && test_results['tests']
-        if tests.nil? || !tests.is_a?(Array) || tests.empty?
-          tests = []
+        # new format
+        if test_results.is_a?(Array)
+          tests = test_results
+        else
+          # old format
+          tests = test_results && test_results['tests']
+          if tests.nil? || !tests.is_a?(Array) || tests.empty?
+            tests = []
+          end
         end
 
         new_pact_hash = pact_hash.dup
@@ -66,6 +73,12 @@ module PactBroker
         Content.from_hash(new_pact_hash)
       end
 
+      def interaction_ids
+        messages_or_interaction_or_empty_array.collect do | interaction |
+          interaction['_id']
+        end.compact
+      end
+
       # Half thinking this belongs in GenerateSha
       def content_that_affects_verification_results
         if interactions || messages
@@ -91,6 +104,10 @@ module PactBroker
         messages || interactions
       end
 
+      def messages_or_interaction_or_empty_array
+        messages_or_interactions || []
+      end
+
       def pact_specification_version
         maybe_pact_specification_version_1 = pact_hash['metadata']['pactSpecification']['version'] rescue nil
         maybe_pact_specification_version_2 = pact_hash['metadata']['pact-specification']['version'] rescue nil
@@ -129,7 +146,15 @@ module PactBroker
       end
 
       def test_is_for_interaction(interaction, test)
-        test.is_a?(Hash) && interaction.is_a?(Hash) && test['interactionDescription'] == interaction['description'] && test['interactionProviderState'] == interaction['providerState']
+        test.is_a?(Hash) && interaction.is_a?(Hash) && ( interaction_ids_match(interaction, test) || description_and_state_match(interaction, test))
+      end
+
+      def interaction_ids_match(interaction, test)
+        interaction['_id'] && interaction['_id'] == test['interactionId']
+      end
+
+      def description_and_state_match(interaction, test)
+        test['interactionDescription'] && test['interactionDescription'] == interaction['description'] && test['interactionProviderState'] == interaction['providerState']
       end
     end
   end

data/lib/pact_broker/pacts/repository.rb

@@ -405,42 +405,37 @@ module PactBroker
               SelectedPact.new(pact_publication.to_domain, Selectors.create_for_overall_latest)
             end
         else
-          []
+          selectors_for_overall_latest = consumer_version_selectors.select(&:overall_latest?)
+          selectors_for_overall_latest.flat_map do | selector |
+            query = scope_for(LatestPactPublications).provider(provider_name)
+            query = query.consumer(selector.consumer) if selector.consumer
+            query.collect do | latest_pact_publication |
+              pact_publication = PactPublication.find(id: latest_pact_publication.id)
+              resolved_selector = selector.consumer ? Selector.latest_for_consumer(selector.consumer) : Selector.overall_latest
+              SelectedPact.new(pact_publication.to_domain, Selectors.new(resolved_selector))
+            end
+          end
         end
       end
 
       def find_pacts_for_which_the_latest_version_for_the_tag_is_required(provider_name, consumer_version_selectors)
         # The tags for which only the latest version is specified
-        tag_names = consumer_version_selectors.tag_names_of_selectors_for_latest_pacts
+        selectors = consumer_version_selectors.select(&:latest_for_tag?)
 
-        # TODO make this an efficient query!
-        # These are not yet de-duped. Should make the behaviour consistent between this and find_pacts_for_which_all_versions_for_the_tag_are_required ?
-        if tag_names.any?
-          scope_for(LatestTaggedPactPublications)
-            .provider(provider_name)
-            .where(tag_name: tag_names)
-            .all
-            .group_by(&:pact_version_id)
-            .values
-            .collect do | pact_publications |
-              create_selected_pact(pact_publications)
-            end
-        else
-          []
+        selectors.flat_map do | selector |
+          query = scope_for(LatestTaggedPactPublications).where(tag_name: selector.tag).provider(provider_name)
+          query = query.consumer(selector.consumer) if selector.consumer
+          query.all.collect do | latest_tagged_pact_publication |
+            pact_publication = PactPublication.find(id: latest_tagged_pact_publication.id)
+            resolved_pact = selector.consumer ? Selector.latest_for_tag_and_consumer(selector.tag, selector.consumer) : Selector.latest_for_tag(selector.tag)
+            SelectedPact.new(
+              pact_publication.to_domain,
+              Selectors.new(resolved_pact)
+            )
+          end
         end
       end
 
-      def create_selected_pact(pact_publications)
-        selector_tag_names = pact_publications.collect(&:tag_name)
-        selectors = Selectors.create_for_latest_of_each_tag(selector_tag_names)
-        last_pact_publication = pact_publications.sort_by(&:consumer_version_order).last
-        pact_publication = scope_for(PactPublication).find(id: last_pact_publication.id)
-        SelectedPact.new(
-          pact_publication.to_domain,
-          selectors
-        )
-      end
-
       def create_fallback_selected_pact(pact_publications, consumer_version_selectors)
         selector_tag_names = pact_publications.collect(&:tag_name)
         selectors = Selectors.create_for_latest_fallback_of_each_tag(selector_tag_names)
@@ -454,10 +449,9 @@ module PactBroker
 
       def find_pacts_for_which_the_latest_version_for_the_fallback_tag_is_required(provider_name, selectors)
         selectors.collect do | selector |
-          scope_for(LatestTaggedPactPublications)
-            .provider(provider_name)
-            .where(tag_name: selector.fallback_tag)
-            .all
+          query = scope_for(LatestTaggedPactPublications).provider(provider_name).where(tag_name: selector.fallback_tag)
+          query = query.consumer(selector.consumer) if selector.consumer
+          query.all
             .collect do | latest_tagged_pact_publication |
               pact_publication = unscoped(PactPublication).find(id: latest_tagged_pact_publication.id)
               SelectedPact.new(