pact_broker 2.77.0 → 2.80.0

data/lib/pact_broker/versions/latest_version.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/domain/version'
+require "pact_broker/domain/version"
 
 module PactBroker
   module Versions

data/lib/pact_broker/versions/parse_semantic_version.rb

@@ -1,5 +1,5 @@
-require 'semver'
-require 'pact_broker/configuration'
+require "semver"
+require "pact_broker/configuration"
 
 module PactBroker
   module Versions

data/lib/pact_broker/versions/repository.rb

@@ -1,7 +1,7 @@
-require 'sequel'
-require 'pact_broker/logging'
-require 'pact_broker/domain/version'
-require 'pact_broker/tags/repository'
+require "sequel"
+require "pact_broker/logging"
+require "pact_broker/domain/version"
+require "pact_broker/tags/repository"
 
 module PactBroker
   module Versions
@@ -9,6 +9,7 @@ module PactBroker
 
       include PactBroker::Logging
       include PactBroker::Repositories::Helpers
+      include PactBroker::Repositories
 
       def find_by_pacticipant_id_and_number pacticipant_id, number
         PactBroker::Domain::Version.where(number: number, pacticipant_id: pacticipant_id).single_record
@@ -60,21 +61,54 @@ module PactBroker
         PactBroker::Domain::Version.new(version_params).upsert
       end
 
-      def create_or_update(pacticipant, version_number, version)
-        PactBroker::Domain::Version.new(
+      def create_or_update(pacticipant, version_number, open_struct_version)
+        saved_version = PactBroker::Domain::Version.where(pacticipant_id: pacticipant.id, number: version_number).single_record
+        params = open_struct_version.to_h
+        tags = params.delete(:tags)
+        if saved_version
+          saved_version.update(params)
+        else
+          # Upsert is only for race conditions
+          # Upsert blanks out any fields that are not provided
+          saved_version = PactBroker::Domain::Version.new(
+            params.merge(
+              pacticipant_id: pacticipant.id,
+              number: version_number
+            )
+          ).upsert
+        end
+
+        replace_tags(saved_version, tags) if tags
+        saved_version
+      end
+
+      def create_or_overwrite(pacticipant, version_number, open_struct_version)
+        saved_version = PactBroker::Domain::Version.new(
           number: version_number,
           pacticipant: pacticipant,
-          build_url: version.build_url,
-          branch: version.branch
+          build_url: open_struct_version.build_url,
+          branch: open_struct_version.branch
         ).upsert
+
+        if open_struct_version.tags
+          replace_tags(saved_version, open_struct_version.tags)
+        end
+
+        saved_version
       end
 
-      def find_by_pacticipant_id_and_number_or_create pacticipant_id, number
-        if version = find_by_pacticipant_id_and_number(pacticipant_id, number)
-          version
-        else
-          create(pacticipant_id: pacticipant_id, number: number)
+      def replace_tags(saved_version, open_struct_tags)
+        tag_repository.delete_by_version_id(saved_version.id)
+        open_struct_tags.collect do | open_struct_tag |
+          tag_repository.create(version: saved_version, name: open_struct_tag.name)
         end
+        saved_version.refresh
+      end
+
+      def find_by_pacticipant_id_and_number_or_create pacticipant_id, number
+        version = find_by_pacticipant_id_and_number(pacticipant_id, number)
+
+        version ? version : create(pacticipant_id: pacticipant_id, number: number)
       end
 
       def delete_by_id version_ids
@@ -85,8 +119,6 @@ module PactBroker
         version_ids_with_pact_publications = PactBroker::Pacts::PactPublication.where(consumer_id: [consumer.id, provider.id]).select(:consumer_version_id).collect{|r| r[:consumer_version_id]}
         version_ids_with_verifications = PactBroker::Domain::Verification.where(provider_id: [provider.id, consumer.id]).select(:provider_version_id).collect{|r| r[:provider_version_id]}
         # Hope we don't hit max parameter constraints here...
-        version_ids_to_keep = (version_ids_with_pact_publications + version_ids_with_verifications).uniq
-
         PactBroker::Domain::Version
           .where(Sequel[:versions][:pacticipant_id] => [consumer.id, provider.id])
           .exclude(id: (version_ids_with_pact_publications + version_ids_with_verifications).uniq)

data/lib/pact_broker/versions/sequence.rb

@@ -1,4 +1,4 @@
-require 'sequel'
+require "sequel"
 
 module PactBroker
   module Versions

data/lib/pact_broker/versions/service.rb

@@ -1,11 +1,29 @@
-require 'pact_broker/repositories'
+require "pact_broker/repositories"
+require "pact_broker/messages"
 
 module PactBroker
   module Versions
     class Service
-
+      extend PactBroker::Messages
       extend PactBroker::Repositories
 
+      def self.conflict_errors(_existing_version, _open_struct_version, _version_url)
+        # This validation is causing problems in the PF build when branches are merged
+        # TODO remove this properly when re-doing the version -> branch relationship
+        {}
+        # if existing_version&.branch && open_struct_version.to_h.key?(:branch) && existing_version.branch != open_struct_version.branch
+        #   message_params = {
+        #     old_branch: existing_version&.branch,
+        #     new_branch: open_struct_version.branch,
+        #     version_url: version_url
+        #   }
+        #   error_message = message("errors.validation.cannot_modify_version_branch", message_params)
+        #   { branch: [error_message] }
+        # else
+        #   {}
+        # end
+      end
+
       def self.find_latest_by_pacticpant_name params
         version_repository.find_latest_by_pacticpant_name params.fetch(:pacticipant_name)
       end
@@ -18,6 +36,11 @@ module PactBroker
         version_repository.find_by_pacticipant_name_and_latest_tag(pacticipant_name, tag)
       end
 
+      def self.create_or_overwrite(pacticipant_name, version_number, version)
+        pacticipant = pacticipant_repository.find_by_name_or_create(pacticipant_name)
+        version_repository.create_or_overwrite(pacticipant, version_number, version)
+      end
+
       def self.create_or_update(pacticipant_name, version_number, version)
         pacticipant = pacticipant_repository.find_by_name_or_create(pacticipant_name)
         version_repository.create_or_update(pacticipant, version_number, version)

data/lib/pact_broker/webhooks/check_host_whitelist.rb

@@ -1,4 +1,4 @@
-require 'openssl'
+require "openssl"
 
 module PactBroker
   module Webhooks

data/lib/pact_broker/webhooks/event_listener.rb

@@ -0,0 +1,86 @@
+require "pact_broker/services"
+require "pact_broker/events/event"
+require "pact_broker/logging"
+require "pact_broker/events/publisher"
+
+module PactBroker
+  module Webhooks
+    class EventListener
+      include PactBroker::Services
+      include PactBroker::Logging
+      include PactBroker::Events::Publisher
+
+      def initialize(webhook_options)
+        @webhook_options = webhook_options
+        # this has the base URL
+        @base_webhook_context = webhook_options[:webhook_execution_configuration].webhook_context
+        @detected_events = []
+      end
+
+      def contract_published(params)
+        handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED, params)
+      end
+
+      def contract_content_changed(params)
+        handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED, params)
+      end
+
+      def contract_content_unchanged(params)
+        detected_events << PactBroker::Events::Event.new(
+          "contract_content_unchanged",
+          params[:event_comment],
+          []
+        )
+        log_detected_event
+      end
+
+      def provider_verification_published(params)
+        handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::VERIFICATION_PUBLISHED, params)
+      end
+
+      def provider_verification_succeeded(params)
+        handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::VERIFICATION_SUCCEEDED, params)
+      end
+
+      def provider_verification_failed(params)
+        handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::VERIFICATION_FAILED, params)
+      end
+
+      def log_detected_event
+        event = detected_events.last
+        logger.info "Event detected", payload: { event_name: event.name, event_comment: event.comment }
+        if event.triggered_webhooks&.any?
+          triggered_webhook_descriptions = event.triggered_webhooks.collect{ |tw| { webhook_uuid: tw.webhook_uuid, triggered_webhook_uuid: tw.uuid, webhook_description: tw.webhook.description } }
+          logger.info "Triggered webhooks for #{event.name}", payload: { triggered_webhooks: triggered_webhook_descriptions }
+        else
+          logger.info "No enabled webhooks found for event #{event.name}"
+        end
+      end
+
+      def schedule_triggered_webhooks
+        webhook_trigger_service.schedule_webhooks(detected_events.flat_map(&:triggered_webhooks), webhook_options)
+      end
+
+      private
+
+      attr_reader :webhook_options, :base_webhook_context, :detected_events
+
+      def handle_event_for_webhook(event_name, params)
+        triggered_webhooks = webhook_trigger_service.create_triggered_webhooks_for_event(
+          params.fetch(:pact),
+          params[:verification],
+          event_name,
+          base_webhook_context.merge(params.fetch(:event_context))
+        )
+        event = PactBroker::Events::Event.new(
+          event_name,
+          params[:event_comment],
+          triggered_webhooks
+        )
+        detected_events << event
+        broadcast(:triggered_webhooks_created_for_event, event: event)
+        log_detected_event
+      end
+    end
+  end
+end

data/lib/pact_broker/webhooks/execution.rb

@@ -1,6 +1,6 @@
-require 'sequel'
-require 'pact_broker/db'
-require 'pact_broker/repositories/helpers'
+require "sequel"
+require "pact_broker/db"
+require "pact_broker/repositories/helpers"
 
 module PactBroker
   module Webhooks

data/lib/pact_broker/webhooks/execution_configuration.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/hash_refinements'
+require "pact_broker/hash_refinements"
 
 module PactBroker
   module Webhooks

data/lib/pact_broker/webhooks/execution_configuration_creator.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/configuration'
-require 'pact_broker/webhooks/execution_configuration'
+require "pact_broker/configuration"
+require "pact_broker/webhooks/execution_configuration"
 
 module PactBroker
   module Webhooks

data/lib/pact_broker/webhooks/http_request_with_redacted_headers.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/domain/webhook_request'
+require "pact_broker/domain/webhook_request"
 
 module PactBroker
   module Webhooks

data/lib/pact_broker/webhooks/http_response_with_utf_8_safe_body.rb

@@ -3,7 +3,7 @@ module PactBroker
     class HttpResponseWithUtf8SafeBody < SimpleDelegator
       def body
         if unsafe_body
-          unsafe_body.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+          unsafe_body.encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "")
         else
           unsafe_body
         end

data/lib/pact_broker/webhooks/job.rb

@@ -1,7 +1,7 @@
-require 'sucker_punch'
-require 'pact_broker/webhooks/service'
-require 'pact_broker/logging'
-require 'pact_broker/webhooks/execution_configuration'
+require "sucker_punch"
+require "pact_broker/webhooks/service"
+require "pact_broker/logging"
+require "pact_broker/webhooks/execution_configuration"
 
 module PactBroker
   module Webhooks
@@ -36,7 +36,7 @@ module PactBroker
       def perform_with_triggered_webhook
         @error_count = data[:error_count] || 0
         begin
-          webhook_execution_result = PactBroker::Webhooks::Service.execute_triggered_webhook_now(triggered_webhook, webhook_options(data))
+          webhook_execution_result = PactBroker::Webhooks::TriggerService.execute_triggered_webhook_now(triggered_webhook, webhook_options(data))
           if webhook_execution_result.success?
             handle_success
           else

data/lib/pact_broker/webhooks/latest_triggered_webhook.rb

@@ -1,9 +1,24 @@
-require 'pact_broker/webhooks/triggered_webhook'
+require "pact_broker/webhooks/triggered_webhook"
 
 module PactBroker
   module Webhooks
     class LatestTriggeredWebhook < TriggeredWebhook
-      set_dataset(:latest_triggered_webhooks)
+      SELF_JOIN = {
+        Sequel[:triggered_webhooks][:webhook_uuid] => Sequel[:triggered_webhooks_2][:webhook_uuid],
+        Sequel[:triggered_webhooks][:consumer_id] => Sequel[:triggered_webhooks_2][:consumer_id],
+        Sequel[:triggered_webhooks][:provider_id] => Sequel[:triggered_webhooks_2][:provider_id],
+        Sequel[:triggered_webhooks][:event_name] => Sequel[:triggered_webhooks_2][:event_name]
+      }
+
+      set_dataset(
+        Sequel::Model.db[:triggered_webhooks]
+          .select(Sequel[:triggered_webhooks].*)
+          .exclude(Sequel[:triggered_webhooks][:event_name] => nil)
+          .left_join(:triggered_webhooks, SELF_JOIN, { table_alias: :triggered_webhooks_2 }) do
+            Sequel[:triggered_webhooks_2][:id] > Sequel[:triggered_webhooks][:id]
+          end
+          .where(Sequel[:triggered_webhooks_2][:id] => nil)
+      )
     end
   end
 end

data/lib/pact_broker/webhooks/pact_and_verification_parameters.rb

@@ -1,19 +1,23 @@
 module PactBroker
   module Webhooks
     class PactAndVerificationParameters
-      PACT_URL = 'pactbroker.pactUrl'
-      VERIFICATION_RESULT_URL = 'pactbroker.verificationResultUrl'
-      CONSUMER_VERSION_NUMBER = 'pactbroker.consumerVersionNumber'
-      PROVIDER_VERSION_NUMBER = 'pactbroker.providerVersionNumber'
-      PROVIDER_VERSION_TAGS = 'pactbroker.providerVersionTags'
-      CONSUMER_VERSION_TAGS = 'pactbroker.consumerVersionTags'
-      CONSUMER_NAME = 'pactbroker.consumerName'
-      PROVIDER_NAME = 'pactbroker.providerName'
-      GITHUB_VERIFICATION_STATUS = 'pactbroker.githubVerificationStatus'
-      BITBUCKET_VERIFICATION_STATUS = 'pactbroker.bitbucketVerificationStatus'
-      CONSUMER_LABELS = 'pactbroker.consumerLabels'
-      PROVIDER_LABELS = 'pactbroker.providerLabels'
-      EVENT_NAME = 'pactbroker.eventName'
+      PACT_URL = "pactbroker.pactUrl"
+      VERIFICATION_RESULT_URL = "pactbroker.verificationResultUrl"
+      CONSUMER_VERSION_NUMBER = "pactbroker.consumerVersionNumber"
+      PROVIDER_VERSION_NUMBER = "pactbroker.providerVersionNumber"
+      PROVIDER_VERSION_TAGS = "pactbroker.providerVersionTags"
+      PROVIDER_VERSION_BRANCH = "pactbroker.providerVersionBranch"
+      CONSUMER_VERSION_TAGS = "pactbroker.consumerVersionTags"
+      CONSUMER_VERSION_BRANCH = "pactbroker.consumerVersionBranch"
+      CONSUMER_NAME = "pactbroker.consumerName"
+      PROVIDER_NAME = "pactbroker.providerName"
+      GITHUB_VERIFICATION_STATUS = "pactbroker.githubVerificationStatus"
+      BITBUCKET_VERIFICATION_STATUS = "pactbroker.bitbucketVerificationStatus"
+      AZURE_DEV_OPS_VERIFICATION_STATUS = "pactbroker.azureDevOpsVerificationStatus"
+      CONSUMER_LABELS = "pactbroker.consumerLabels"
+      PROVIDER_LABELS = "pactbroker.providerLabels"
+      EVENT_NAME = "pactbroker.eventName"
+      CURRENTLY_DEPLOYED_PROVIDER_VERSION_NUMBER = "pactbroker.currentlyDeployedProviderVersionNumber"
 
       ALL = [
         CONSUMER_NAME,
@@ -21,14 +25,18 @@ module PactBroker
         CONSUMER_VERSION_NUMBER,
         PROVIDER_VERSION_NUMBER,
         PROVIDER_VERSION_TAGS,
+        PROVIDER_VERSION_BRANCH,
         CONSUMER_VERSION_TAGS,
+        CONSUMER_VERSION_BRANCH,
         PACT_URL,
         VERIFICATION_RESULT_URL,
         GITHUB_VERIFICATION_STATUS,
         BITBUCKET_VERIFICATION_STATUS,
+        AZURE_DEV_OPS_VERIFICATION_STATUS,
         CONSUMER_LABELS,
         PROVIDER_LABELS,
-        EVENT_NAME
+        EVENT_NAME,
+        CURRENTLY_DEPLOYED_PROVIDER_VERSION_NUMBER
       ]
 
       def initialize(pact, trigger_verification, webhook_context)
@@ -38,6 +46,7 @@ module PactBroker
         @base_url = webhook_context.fetch(:base_url)
       end
 
+      # rubocop: disable Metrics/CyclomaticComplexity
       def to_hash
         @hash ||= {
           PACT_URL => pact ? PactBroker::Api::PactBrokerUrls.pact_version_url_with_webhook_metadata(pact, base_url) : "",
@@ -45,16 +54,21 @@ module PactBroker
           CONSUMER_VERSION_NUMBER => consumer_version_number,
           PROVIDER_VERSION_NUMBER => verification ? verification.provider_version_number : "",
           PROVIDER_VERSION_TAGS => provider_version_tags,
+          PROVIDER_VERSION_BRANCH => provider_version_branch,
           CONSUMER_VERSION_TAGS => consumer_version_tags,
+          CONSUMER_VERSION_BRANCH => consumer_version_branch,
           CONSUMER_NAME => pact ? pact.consumer_name : "",
           PROVIDER_NAME => pact ? pact.provider_name : "",
           GITHUB_VERIFICATION_STATUS => github_verification_status,
           BITBUCKET_VERIFICATION_STATUS => bitbucket_verification_status,
+          AZURE_DEV_OPS_VERIFICATION_STATUS => azure_dev_ops_verification_status,
           CONSUMER_LABELS => pacticipant_labels(pact && pact.consumer),
           PROVIDER_LABELS => pacticipant_labels(pact && pact.provider),
-          EVENT_NAME => event_name
+          EVENT_NAME => event_name,
+          CURRENTLY_DEPLOYED_PROVIDER_VERSION_NUMBER => currently_deployed_provider_version_number
         }
       end
+      # rubocop: enable Metrics/CyclomaticComplexity
 
       private
 
@@ -76,6 +90,14 @@ module PactBroker
         end
       end
 
+      def azure_dev_ops_verification_status
+        if verification
+          verification.success ? "succeeded" : "failed"
+        else
+          "pending"
+        end
+      end
+
       def verification_url
         if verification
           PactBroker::Api::PactBrokerUrls.verification_url(verification, base_url)
@@ -104,6 +126,14 @@ module PactBroker
         end
       end
 
+      def consumer_version_branch
+        if webhook_context[:consumer_version_branch]
+          webhook_context[:consumer_version_branch]
+        else
+          pact&.consumer_version&.branch || ""
+        end
+      end
+
       def provider_version_tags
         if webhook_context[:provider_version_tags]
           webhook_context[:provider_version_tags].join(", ")
@@ -116,6 +146,14 @@ module PactBroker
         end
       end
 
+      def provider_version_branch
+        if webhook_context[:provider_version_branch]
+          webhook_context[:provider_version_branch]
+        else
+          verification&.provider_version&.branch || ""
+        end
+      end
+
       def pacticipant_labels pacticipant
         pacticipant && pacticipant.labels ? pacticipant.labels.collect(&:name).join(", ") : ""
       end
@@ -123,6 +161,10 @@ module PactBroker
       def event_name
         webhook_context.fetch(:event_name)
       end
+
+      def currently_deployed_provider_version_number
+        webhook_context[:currently_deployed_provider_version_number] || ""
+      end
     end
   end
 end