pact_broker 2.85.1 → 2.86.0

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

@@ -15,6 +15,10 @@ module PactBroker
         property :execution_date, as: :verificationDate
         property :build_url, as: :buildUrl
         property :test_results, as: :testResults
+        nested :verifiedBy do
+          property :verified_by_implementation, as: :implementation
+          property :verified_by_version, as: :version
+        end
 
         link :self do | options |
           {

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

@@ -1,4 +1,5 @@
 require_relative "base_decorator"
+require "pact_broker/domain/webhook_pacticipant"
 require "pact_broker/api/decorators/webhook_request_template_decorator"
 require "pact_broker/api/decorators/timestamps"
 require "pact_broker/webhooks/webhook_request_template"
@@ -19,12 +20,14 @@ module PactBroker
 
         property :description, getter: lambda { |context| context[:represented].display_description }
 
-        property :consumer, :class => PactBroker::Domain::Pacticipant, default: nil do
+        property :consumer, class: Domain::WebhookPacticipant, default: nil do
           property :name
+          property :label
         end
 
-        property :provider, :class => PactBroker::Domain::Pacticipant, default: nil do
+        property :provider, class: Domain::WebhookPacticipant, default: nil do
           property :name
+          property :label
         end
 
         property :enabled, default: true
@@ -50,7 +53,7 @@ module PactBroker
         end
 
         link :'pb:consumer' do | options |
-          if represented.consumer
+          if represented.consumer&.name
             {
               title: "Consumer",
               name: represented.consumer.name,
@@ -59,8 +62,18 @@ module PactBroker
           end
         end
 
+        link :'pb:consumers' do | options |
+          if represented.consumer&.label
+            {
+              title: "Consumers by label",
+              name: represented.consumer.label,
+              href: pacticipants_with_label_url(options.fetch(:base_url), represented.consumer.label)
+            }
+          end
+        end
+
         link :'pb:provider' do | options |
-          if represented.provider
+          if represented.provider&.name
             {
               title: "Provider",
               name: represented.provider.name,
@@ -69,6 +82,16 @@ module PactBroker
           end
         end
 
+        link :'pb:providers' do | options |
+          if represented.provider&.label
+            {
+              title: "Providers by label",
+              name: represented.provider.label,
+              href: pacticipants_with_label_url(options.fetch(:base_url), represented.provider.label)
+            }
+          end
+        end
+
         link :'pb:pact-webhooks' do | options |
           if represented.consumer && represented.provider
             {

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -22,6 +22,10 @@ module PactBroker
         "#{pacticipants_url(base_url)}/#{url_encode(pacticipant.name)}"
       end
 
+      def pacticipants_with_label_url base_url, label_name
+        "#{pacticipants_url(base_url)}/label/#{url_encode(label_name)}"
+      end
+
       def pacticipant_url_from_params params, base_url = ""
         [
           base_url,

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

@@ -70,11 +70,11 @@ module PactBroker
         end
 
         def consumer
-          webhook.consumer ? pacticipant_service.find_pacticipant_by_name(webhook.consumer.name) : nil
+          webhook.consumer&.name ? pacticipant_service.find_pacticipant_by_name(webhook.consumer.name) : nil
         end
 
         def provider
-          webhook.provider ? pacticipant_service.find_pacticipant_by_name(webhook.provider.name) : nil
+          webhook.provider&.name ? pacticipant_service.find_pacticipant_by_name(webhook.provider.name) : nil
         end
 
         def webhooks

data/lib/pact_broker/config/runtime_configuration.rb

@@ -166,6 +166,10 @@ module PactBroker
         super(value_to_string_array(webhook_host_whitelist, "webhook_host_whitelist"))
       end
 
+      def main_branch_candidates= main_branch_candidates
+        super(value_to_string_array(main_branch_candidates, "main_branch_candidates"))
+      end
+
       def features= features
         super(value_to_string_array(features, "features").collect(&:downcase))
       end

data/lib/pact_broker/config/runtime_configuration_database_methods.rb

@@ -27,7 +27,7 @@ module PactBroker
             validate_database_connection_config: true,
             database_statement_timeout: 15,
             metrics_sql_statement_timeout: 30,
-            database_connection_validation_timeout: -1
+            database_connection_validation_timeout: nil
           )
 
           def database_configuration

data/lib/pact_broker/db/clean.rb

@@ -1,6 +1,5 @@
 require "sequel"
 require "pact_broker/project_root"
-require "pact_broker/pacts/latest_tagged_pact_publications"
 require "pact_broker/logging"
 require "pact_broker/db/clean/selector"
 
@@ -50,7 +49,7 @@ module PactBroker
 
       def latest_tagged_pact_publications_ids_to_keep
         @latest_tagged_pact_publications_ids_to_keep ||= resolve_ids(keep.select(&:tag).select(&:latest).collect do | selector |
-          PactBroker::Pacts::LatestTaggedPactPublications.select(:id).for_selector(selector)
+          PactBroker::Pacts::PactPublication.select(:id).latest_by_consumer_tag_for_clean_selector(selector)
         end.reduce(&:union) || [])
       end
 

data/lib/pact_broker/doc/views/pacticipant/label.markdown

@@ -0,0 +1,12 @@
+
+# Pacticipant labels
+
+Allowed methods: `GET`, `PUT`, `DELETE`
+
+Path: `/pacticipants/{pacticipant}/labels/{label}`
+
+Get, create or delete pacticipant labels.
+
+Pacticipants can be queried by label with `/pacticipants/label/{label}`.
+
+Labels are also used to create generic webhooks that are triggered for subset of pacticipants with label.

data/lib/pact_broker/doc/views/webhooks.markdown

@@ -79,6 +79,23 @@ To specify an XML body, you will need to use a correctly escaped string (or use
 
 **BEWARE** While the basic auth password, and any header containing the word `authorization` or `token` will be redacted from the UI and the logs, the password could be reverse engineered from the database, so make a separate account for the Pact Broker to use in your webhooks. Don't use your personal account!
 
+#### Consumer or provider label matching
+
+Webhooks can be created to match events of certain set of [consumers or providers by label](/doc/label?context=pacticipant). Use `label` attribute for either `provider` or `consumer`. Both are optional, but they cannot be provided when `name` attribute is present. Following example would trigger a webhook when any contract with `async` labeled provider changed its content:
+
+        {
+          "provider": {
+            "label": "async"
+          },
+          "events": [{
+            "name": "contract_content_changed"
+          }],
+          "request": {
+            "method": "POST",
+            "url": "http://master.ci.my.domain:8085/rest/api/latest/queue/SOME-PROJECT"
+          }
+        }
+
 #### Event types
 
 `contract_published:` triggered every time a contract is published. It is not recommended to trigger your provider verification build every time a contract is published - see `contract_content_changed` below.

data/lib/pact_broker/domain/pacticipant.rb

@@ -76,6 +76,10 @@ module PactBroker
       def branch_head_for(branch_name)
         branch_heads.find{ | branch_head | branch_head.branch_name == branch_name }
       end
+
+      def label?(name)
+        labels.any? { |label| label.name == name }
+      end
     end
   end
 end

data/lib/pact_broker/domain/verification.rb

@@ -37,6 +37,22 @@ module PactBroker
           where(consumer: PactBroker::Domain::Pacticipant.find_by_name(consumer_name))
         end
 
+        # TODO optimise this
+        def from_provider_main_branch
+          providers_join = {
+            Sequel[:verifications][:provider_id] => Sequel[:providers][:id]
+          }
+
+          branch_versions_join = {
+            Sequel[:verifications][:provider_version_id] => Sequel[:branch_versions][:version_id],
+            Sequel[:providers][:main_branch] => Sequel[:branch_versions][:branch_name]
+          }
+
+          join(:pacticipants, providers_join, { table_alias: :providers })
+            .join(:branch_versions, branch_versions_join)
+        end
+
+        # TODO change this to a group by
         def latest_by_pact_version
           base_query = self
           base_join = {
@@ -116,10 +132,6 @@ module PactBroker
           join(:latest_pact_publication_ids_for_consumer_versions, { pact_version_id: :pact_version_id } )
         end
 
-        # Expects to be joined with AllPactPublications or subclass
-        # Beware that when columns with the same name exist in both datasets
-        # you may get the wrong column back in your model.
-
         def delete
           require "pact_broker/webhooks/triggered_webhook"
           PactBroker::Webhooks::TriggeredWebhook.where(verification: self).delete

data/lib/pact_broker/domain/webhook.rb

@@ -33,11 +33,11 @@ module PactBroker
 
       def scope_description
         if consumer && provider
-          "A webhook for the pact between #{consumer.name} and #{provider.name}"
+          "A webhook for the pact between #{consumer_name} and #{provider_name}"
         elsif provider
-          "A webhook for all pacts with provider #{provider.name}"
+          "A webhook for all pacts with provider #{provider_name}"
         elsif consumer
-          "A webhook for all pacts with consumer #{consumer.name}"
+          "A webhook for all pacts with consumer #{consumer_name}"
         else
           "A webhook for all pacts"
         end
@@ -63,11 +63,11 @@ module PactBroker
       end
 
       def consumer_name
-        consumer && consumer.name
+        consumer && (consumer.name || (consumer.label && "labeled '#{consumer.label}'"))
       end
 
       def provider_name
-        provider && provider.name
+        provider && (provider.name || (provider.label && "labeled '#{provider.label}'"))
       end
 
       def trigger_on_contract_content_changed?

data/lib/pact_broker/domain/webhook_pacticipant.rb

@@ -0,0 +1,6 @@
+
+module PactBroker
+  module Domain
+    WebhookPacticipant = Struct.new(:name, :label, keyword_init: true)
+  end
+end

data/lib/pact_broker/locale/en.yml

@@ -13,6 +13,7 @@ en:
     single_line?: "cannot contain multiple lines"
     no_spaces?: "cannot contain spaces"
     environment_with_name_exists?: "with name '%{value}' does not exist"
+    none?: "cannot be provided"
 
   pact_broker:
     messages:

data/lib/pact_broker/matrix/head_row.rb

@@ -38,7 +38,7 @@ module PactBroker
       # This will only work when using eager loading. The keys are just blanked out to avoid errors.
       # I don't understand how they work at all.
       # It would be nice to do this declaratively.
-      many_to_many :webhooks, :left_key => [], left_primary_key: [], :eager_loader=>(proc do |eo_opts|
+      many_to_many :webhooks, class: :'PactBroker::Webhooks::Webhook', :left_key => [], left_primary_key: [], :eager_loader=>(proc do |eo_opts|
         eo_opts[:rows].each do |row|
           row.associations[:webhooks] = []
         end

data/lib/pact_broker/matrix/quick_row.rb

@@ -1,4 +1,3 @@
-require "pact_broker/pacts/all_pact_publications"
 require "pact_broker/repositories/helpers"
 require "pact_broker/matrix/query_builder"
 require "sequel"

data/lib/pact_broker/matrix/repository.rb

@@ -11,7 +11,6 @@ require "pact_broker/matrix/query_results_with_deployment_status_summary"
 require "pact_broker/matrix/resolved_selector"
 require "pact_broker/matrix/unresolved_selector"
 require "pact_broker/verifications/latest_verification_id_for_pact_version_and_provider_version"
-require "pact_broker/pacts/latest_pact_publications_by_consumer_version"
 
 module PactBroker
   module Matrix

data/lib/pact_broker/matrix/row.rb

@@ -150,11 +150,11 @@ module PactBroker
       end
 
       def consumer
-        @consumer ||= OpenStruct.new(name: consumer_name, id: consumer_id)
+        @consumer ||= Domain::Pacticipant.new(name: consumer_name).tap { |pacticipant| pacticipant.id = consumer_id }
       end
 
       def provider
-        @provider ||= OpenStruct.new(name: provider_name, id: provider_id)
+        @provider ||= Domain::Pacticipant.new(name: provider_name).tap { |pacticipant| pacticipant.id = provider_id }
       end
 
       def consumer_version

data/lib/pact_broker/pacts/latest_pact_publication_id_for_consumer_version.rb

@@ -1,4 +1,3 @@
-require "pact_broker/pacts/all_pact_publications"
 require "pact_broker/repositories/helpers"
 
 module PactBroker

data/lib/pact_broker/pacts/pact_publication.rb

@@ -8,6 +8,8 @@ require "pact_broker/pacts/pact_publication_dataset_module"
 require "pact_broker/pacts/pact_publication_wip_dataset_module"
 require "pact_broker/pacts/eager_loaders"
 require "pact_broker/pacts/lazy_loaders"
+require "pact_broker/pacts/pact_publication_clean_selector_dataset_module"
+require "pact_broker/pacts/head_pact"
 
 module PactBroker
   module Pacts
@@ -77,6 +79,7 @@ module PactBroker
       dataset_module do
         include PactBroker::Repositories::Helpers
         include PactPublicationDatasetModule
+        include PactPublicationCleanSelectorDatasetModule
         include PactPublicationWipDatasetModule
       end
 
@@ -110,6 +113,10 @@ module PactBroker
         pact_version.latest_verification
       end
 
+      def latest_main_branch_verification
+        pact_version.latest_main_branch_verification
+      end
+
       def latest_for_branch?
         if !defined?(@latest_for_branch)
           if consumer_version.branch_versions.empty?

data/lib/pact_broker/pacts/pact_publication_clean_selector_dataset_module.rb

@@ -0,0 +1,19 @@
+module PactBroker
+  module Pacts
+    module PactPublicationCleanSelectorDatasetModule
+      # we've already done the latest_by_consumer_tag in the clean
+      def latest_by_consumer_tag_for_clean_selector(selector)
+        query = latest_by_consumer_tag
+        query = query.for_consumer_name(selector.pacticipant_name) if selector.pacticipant_name
+        query = query.for_consumer_version_tag(selector.tag) if selector.tag && selector.tag.is_a?(String)
+        query = query.where_age_less_than(selector.max_age) if selector.max_age
+        query
+      end
+
+      def where_age_less_than(days)
+        start_date = Date.today - days
+        where{ pact_publications[:created_at] >= start_date }
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/pact_publication_dataset_module.rb

@@ -27,6 +27,11 @@ module PactBroker
         where(consumer: consumer)
       end
 
+      def untagged
+        left_outer_join(:tags, { version_id: :consumer_version_id })
+          .where(Sequel.qualify(:tags, :name) => nil)
+      end
+
       def for_consumer_version_tag tag_name
         base_query = self
         if no_columns_selected?
@@ -38,6 +43,12 @@ module PactBroker
           .remove_overridden_revisions_from_complete_query
       end
 
+      def for_consumer_version_tag_all_revisions tag_name
+        join(:tags, { version_id: :consumer_version_id }) do
+          name_like(Sequel[:tags][:name], tag_name)
+        end
+      end
+
       def for_consumer_name_and_maybe_version_number(consumer_name, consumer_version_number)
         if consumer_version_number
           where(consumer_version: PactBroker::Domain::Version.where_pacticipant_name_and_version_number(consumer_name, consumer_version_number))
@@ -128,6 +139,7 @@ module PactBroker
           .remove_overridden_revisions_from_complete_query
       end
 
+      # The latest pact publication for each tag
       def latest_by_consumer_tag
         tags_join = {
           Sequel[:pact_publications][:consumer_version_id] => Sequel[:tags][:version_id]
@@ -234,7 +246,7 @@ module PactBroker
         deployed = base_query.join(:currently_deployed_version_ids, currently_deployed_join)
         released = base_query.join(:released_versions, released_join)
 
-        deployed.union(released)
+        deployed.union(released).remove_overridden_revisions_from_complete_query
       end
 
       def verified_before_date(date)
@@ -344,7 +356,19 @@ module PactBroker
       end
 
       def consumer_version_tag(tag)
-        where(Sequel[:ct][:name] => tag)
+        where(name_like(Sequel[:ct][:name],tag))
+      end
+
+      def consumer_version_order_before order
+        where(Sequel.lit("consumer_version_order < ?", order))
+      end
+
+      def consumer_version_order_after order
+        where(Sequel.lit("consumer_version_order > ?", order))
+      end
+
+      def latest_by_consumer_version_order
+        reverse_order(:consumer_version_order).limit(1)
       end
 
       def order_by_consumer_name
@@ -355,6 +379,10 @@ module PactBroker
         order_append(:consumer_version_order, :revision_number)
       end
 
+      def earliest
+        order(:consumer_version_order).limit(1)
+      end
+
       def latest
         order(:consumer_version_order, :revision_number).last
       end