pact_broker 2.77.0 → 2.80.0

data/lib/pact_broker/pacts/sort_content.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/json'
-require 'pact_broker/pacts/order_hash_keys'
+require "pact_broker/json"
+require "pact_broker/pacts/order_hash_keys"
 
 module PactBroker
   module Pacts
@@ -20,18 +20,23 @@ module PactBroker
       end
 
       def self.verifiable_content_key_for pact_hash
-        if pact_hash['interactions']
-          'interactions'
-        elsif pact_hash['messages']
-          'messages'
+        if pact_hash["interactions"]
+          "interactions"
+        elsif pact_hash["messages"]
+          "messages"
         else
           nil
         end
       end
 
-      def self.order_verifiable_content array
-        array_with_ordered_hashes = order_hash_keys(array)
-        array_with_ordered_hashes.sort{ |a, b| a.to_json <=> b.to_json }
+      def self.order_verifiable_content probably_array
+        # You never can tell what people will do...
+        if probably_array.is_a?(Array)
+          array_with_ordered_hashes = order_hash_keys(probably_array)
+          array_with_ordered_hashes.sort{ |a, b| a.to_json <=> b.to_json }
+        else
+          probably_array
+        end
       end
     end
   end

data/lib/pact_broker/pacts/squash_pacts_for_verification.rb

@@ -10,7 +10,6 @@ module PactBroker
 
         if include_pending_status
           pending_provider_tags = []
-          non_pending_provider_tags = []
           pending = nil
           if provider_version_tags.any?
             pending_provider_tags = domain_pact.select_pending_provider_version_tags(provider_version_tags)

data/lib/pact_broker/pacts/verifiable_pact.rb

@@ -1,11 +1,12 @@
-require 'delegate'
-require 'pact_broker/error'
+require "delegate"
+require "pact_broker/error"
 
 module PactBroker
   module Pacts
     class VerifiablePact < SimpleDelegator
       attr_reader :selectors, :pending, :pending_provider_tags, :non_pending_provider_tags, :provider_branch, :wip
 
+      # rubocop: disable Metrics/ParameterLists
       # TODO refactor this constructor
       def initialize(pact, selectors, pending = nil, pending_provider_tags = [], non_pending_provider_tags = [], provider_branch = nil, wip = false)
         super(pact)
@@ -16,6 +17,7 @@ module PactBroker
         @provider_branch = provider_branch
         @wip = wip
       end
+      # rubocop: enable Metrics/ParameterLists
 
       def self.create_for_wip_for_provider_branch(pact, selectors, provider_branch)
         new(pact, selectors, true, [], [], provider_branch, true)
@@ -29,7 +31,7 @@ module PactBroker
         verifiable_pacts
           .group_by { | verifiable_pact | verifiable_pact.pact_version_sha }
           .values
-          .collect { | verifiable_pacts | verifiable_pacts.reduce(&:+) }
+          .collect { | verifiable_pact | verifiable_pact.reduce(&:+) }
       end
 
       def pending?

data/lib/pact_broker/pacts/verifiable_pact_messages.rb

@@ -1,12 +1,14 @@
-require 'forwardable'
+require "forwardable"
+require "pact_broker/messages"
 
 module PactBroker
   module Pacts
     class VerifiablePactMessages
       extend Forwardable
+      include PactBroker::Messages
 
-      READ_MORE_PENDING = "Read more at https://pact.io/pending"
-      READ_MORE_WIP = "Read more at https://pact.io/wip"
+      READ_MORE_PENDING = "Read more at https://docs.pact.io/go/pending"
+      READ_MORE_WIP = "Read more at https://docs.pact.io/go/wip"
 
       delegate [:consumer_name, :provider_name, :consumer_version_number, :pending_provider_tags, :non_pending_provider_tags, :provider_branch, :pending?, :wip?] => :verifiable_pact
 
@@ -17,10 +19,10 @@ module PactBroker
 
       def pact_description
         position_descs = if head_consumer_tags.empty? && branches.empty?
-          ["latest"]
-        else
-          head_consumer_tags.collect { |tag| "latest with tag #{tag}" } + branches.collect{ |branch| "latest from branch #{branch}" }
-        end
+                           ["latest"]
+                         else
+                           head_consumer_tags.collect { |tag| "latest with tag #{tag}" } + branches.collect{ |branch| "latest from branch #{branch}" }
+                         end
 
         "Pact between #{consumer_name} and #{provider_name}, consumer version #{consumer_version_number}, #{position_descs.join(", ")}"
       end
@@ -32,7 +34,8 @@ module PactBroker
           "The pact at #{pact_version_url} is being verified because it is a 'work in progress' pact (ie. it is the pact for the latest #{version_text} of #{consumer_name} #{joined_head_consumer_tags_and_branches} and is still in pending state). #{READ_MORE_WIP}"
         else
           criteria_or_criterion = selectors.size > 1 ? "criteria" : "criterion"
-          "The pact at #{pact_version_url} is being verified because it matches the following configured selection #{criteria_or_criterion}: #{selector_descriptions}#{same_content_note}"
+          version_or_versions = pluralize("the consumer version", selectors.size)
+          "The pact at #{pact_version_url} is being verified because the pact content belongs to #{version_or_versions} matching the following #{criteria_or_criterion}:\n#{selector_descriptions}"
         end
       end
 
@@ -75,9 +78,12 @@ module PactBroker
       attr_reader :verifiable_pact, :pact_version_url
 
       def join(list, last_joiner = " and ")
-        quoted_list = list.collect { | tag | "'#{tag}'" }
-        comma_joined = quoted_list[0..-3] || []
-        and_joined =  quoted_list[-2..-1] || quoted_list
+        join_unquoted(list.collect { | word | "'#{word}'" }, last_joiner)
+      end
+
+      def join_unquoted(list, last_joiner = " and ")
+        comma_joined = list[0..-3] || []
+        and_joined =  list[-2..-1] || list
         if comma_joined.any?
           "#{comma_joined.join(', ')}, #{and_joined.join(last_joiner)}"
         else
@@ -153,35 +159,70 @@ module PactBroker
       end
 
       def selector_descriptions
-        selectors.sort.collect do | selector |
-          selector_description(selector)
-        end.join(", ")
+        selectors.sort.group_by(&:type).values.flat_map do | selectors |
+          selectors_descriptions(selectors)
+        end.collect{ |description| "    * #{description}" }
+          .join("\n")
       end
 
-      def selector_description selector
-        if selector.overall_latest?
-          consumer_label = selector.consumer ? selector.consumer : 'a consumer'
-          "latest pact between #{consumer_label} and #{provider_name}"
-        elsif selector.latest_for_tag?
-          version_label = selector.consumer ? "version of #{selector.consumer}" : "consumer version"
-          if selector.fallback_tag?
-            "latest pact for a #{version_label} tagged '#{selector.fallback_tag}' (fallback tag used as no pact was found with tag '#{selector.tag}')"
-          else
-            "latest pact for a #{version_label} tagged '#{selector.tag}'"
-          end
-        elsif selector.latest_for_branch?
-          version_label = selector.consumer ? "version of #{selector.consumer}" : "consumer version"
-          if selector.fallback_branch?
-            "latest pact for a #{version_label} from branch '#{selector.fallback_branch}' (fallback branch used as no pact was found from branch '#{selector.branch}')"
-          else
-            "latest pact for a #{version_label} from branch '#{selector.branch}'"
-          end
-        elsif selector.all_for_tag_and_consumer?
-          "pacts for all #{selector.consumer} versions tagged '#{selector.tag}'"
-        elsif selector.all_for_tag?
-          "pacts for all consumer versions tagged '#{selector.tag}'"
+      def selectors_descriptions(selectors)
+        if selectors.first.currently_deployed?
+          currently_deployed_selectors_description(selectors)
+        elsif selectors.first.currently_supported?
+          currently_supported_selectors_description(selectors)
         else
-          selector.to_json
+          selectors.collect do | selector |
+            selector_description(selector)
+          end
+        end
+      end
+
+      # rubocop: disable Metrics/CyclomaticComplexity
+      def selector_description selector
+        description = if selector.overall_latest?
+                        consumer_label = selector.consumer ? selector.consumer : "a consumer"
+                        "latest version of #{consumer_label} that has a pact with #{provider_name}"
+                      elsif selector.latest_for_tag?
+                        version_label = selector.consumer ? "version of #{selector.consumer}" : "version"
+                        if selector.fallback_tag?
+                          "latest #{version_label} tagged '#{selector.fallback_tag}' (fallback tag used as no pact was found with tag '#{selector.tag}')"
+                        else
+                          "latest #{version_label} tagged '#{selector.tag}'"
+                        end
+                      elsif selector.latest_for_branch?
+                        version_label = selector.consumer ? "version of #{selector.consumer}" : "version"
+                        if selector.fallback_branch?
+                          "latest #{version_label} from branch '#{selector.fallback_branch}' (fallback branch used as no pact was found from branch '#{selector.branch}')"
+                        else
+                          "latest #{version_label} from branch '#{selector.branch}'"
+                        end
+                      elsif selector.all_for_tag_and_consumer?
+                        "all #{selector.consumer} versions tagged '#{selector.tag}'"
+                      elsif selector.all_for_tag?
+                        "all consumer versions tagged '#{selector.tag}'"
+                      elsif selector.in_environment?
+                        consumer_label = selector.consumer ? selector.consumer : "a consumer"
+                        "#{consumer_label} version in environment #{selector.environment.name}"
+                      else
+                        selector.to_json
+                      end
+        "#{description} (#{selector.consumer_version.number})"
+      end
+      # rubocop: enable Metrics/CyclomaticComplexity
+
+      def currently_deployed_selectors_description(selectors)
+        selectors.group_by(&:consumer).flat_map do | consumer_name, consumer_selectors |
+          display_name = consumer_name ? "version(s) of #{consumer_name}" : "consumer version(s)"
+          environments_and_versions = consumer_selectors.collect{ | selector | "#{selector.environment.name} (#{selector.consumer_version.number})" }
+          "#{display_name} currently deployed to #{join_unquoted(environments_and_versions)}"
+        end
+      end
+
+      def currently_supported_selectors_description(selectors)
+        selectors.group_by(&:consumer).flat_map do | consumer_name, consumer_selectors |
+          display_name = consumer_name ? "version(s) of #{consumer_name}" : "consumer version(s)"
+          environments_and_versions = consumer_selectors.collect{ | selector | "#{selector.environment.name} (#{selector.consumer_version.number})" }
+          "#{display_name} released and supported in #{join_unquoted(environments_and_versions)}"
         end
       end
 
@@ -189,6 +230,7 @@ module PactBroker
         selectors.collect{ | selector | short_selector_description(selector) }.join(", ")
       end
 
+      # rubocop: disable Metrics/CyclomaticComplexity
       # this is used by Pact Go to create the test method name, so needs to be concise
       def short_selector_description selector
         if selector.overall_latest?
@@ -209,10 +251,13 @@ module PactBroker
           "one of #{selector.consumer} #{selector.tag}"
         elsif selector.tag
           "one of #{selector.tag}"
+        elsif selector.currently_deployed?
+          "deployed to #{selector.environment.name}"
         else
           selector.to_json
         end
       end
+      # rubocop: enable Metrics/CyclomaticComplexity
 
       def selectors
         verifiable_pact.selectors

data/lib/pact_broker/policies.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/configuration'
+require "pact_broker/configuration"
 
 module PactBroker
   class DefaultPolicy

data/lib/pact_broker/project_root.rb

@@ -1,7 +1,7 @@
-require 'pathname'
+require "pathname"
 
 module PactBroker
   def self.project_root
-    @project_root ||= Pathname.new(File.expand_path('../../../',__FILE__)).freeze
+    @project_root ||= Pathname.new(File.expand_path("../../../",__FILE__)).freeze
   end
 end

data/lib/pact_broker/relationships/groupify.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/domain/group'
+require "pact_broker/domain/group"
 
 =begin
   Splits all index_items up into groups of non-connecting index_items.

data/lib/pact_broker/repositories.rb

@@ -1,15 +1,15 @@
-require 'pact_broker/domain'
-require 'pact_broker/pacts/repository'
+require "pact_broker/domain"
+require "pact_broker/pacts/repository"
 
 module PactBroker
   module Repositories
     def pacticipant_repository
-      require 'pact_broker/pacticipants/repository'
+      require "pact_broker/pacticipants/repository"
       Pacticipants::Repository.new
     end
 
     def version_repository
-      require 'pact_broker/versions/repository'
+      require "pact_broker/versions/repository"
       Versions::Repository.new
     end
 
@@ -18,27 +18,27 @@ module PactBroker
     end
 
     def tag_repository
-      require 'pact_broker/tags/repository'
+      require "pact_broker/tags/repository"
       Tags::Repository.new
     end
 
     def label_repository
-      require 'pact_broker/labels/repository'
+      require "pact_broker/labels/repository"
       Labels::Repository.new
     end
 
     def webhook_repository
-      require 'pact_broker/webhooks/repository'
+      require "pact_broker/webhooks/repository"
       Webhooks::Repository.new
     end
 
     def verification_repository
-      require 'pact_broker/verifications/repository'
+      require "pact_broker/verifications/repository"
       Verifications::Repository.new
     end
 
     def matrix_repository
-      require 'pact_broker/matrix/repository'
+      require "pact_broker/matrix/repository"
       Matrix::Repository.new
     end
 

data/lib/pact_broker/services.rb

@@ -73,82 +73,120 @@ module PactBroker
       get(:metrics_service)
     end
 
+    def environment_service
+      get(:environment_service)
+    end
+
+    def deployed_version_service
+      get(:deployed_version_service)
+    end
+
+    def released_version_service
+      get(:released_version_service)
+    end
+
+    def contract_service
+      get(:contract_service)
+    end
+
+    # rubocop: disable Metrics/MethodLength
     def register_default_services
       register_service(:index_service) do
-        require 'pact_broker/index/service'
+        require "pact_broker/index/service"
         Index::Service
       end
 
       register_service(:metrics_service) do
-        require 'pact_broker/metrics/service'
+        require "pact_broker/metrics/service"
         Metrics::Service
       end
 
       register_service(:matrix_service) do
-        require 'pact_broker/matrix/service'
+        require "pact_broker/matrix/service"
         Matrix::Service
       end
 
       register_service(:pact_service) do
-        require 'pact_broker/pacts/service'
+        require "pact_broker/pacts/service"
         Pacts::Service
       end
 
       register_service(:pacticipant_service) do
-        require 'pact_broker/pacticipants/service'
+        require "pact_broker/pacticipants/service"
         Pacticipants::Service
       end
 
       register_service(:tag_service) do
-        require 'pact_broker/tags/service'
+        require "pact_broker/tags/service"
         Tags::Service
       end
 
       register_service(:label_service) do
-        require 'pact_broker/labels/service'
+        require "pact_broker/labels/service"
         Labels::Service
       end
 
       register_service(:group_service) do
-        require 'pact_broker/groups/service'
+        require "pact_broker/groups/service"
         Groups::Service
       end
 
       register_service(:webhook_service) do
-        require 'pact_broker/webhooks/service'
+        require "pact_broker/webhooks/service"
         Webhooks::Service
       end
 
       register_service(:version_service) do
-        require 'pact_broker/versions/service'
+        require "pact_broker/versions/service"
         Versions::Service
       end
 
       register_service(:verification_service) do
-        require 'pact_broker/verifications/service'
+        require "pact_broker/verifications/service"
         Verifications::Service
       end
 
       register_service(:badge_service) do
-        require 'pact_broker/badges/service'
+        require "pact_broker/badges/service"
         Badges::Service
       end
 
       register_service(:certificate_service) do
-        require 'pact_broker/certificates/service'
+        require "pact_broker/certificates/service"
         Certificates::Service
       end
 
       register_service(:integration_service) do
-        require 'pact_broker/integrations/service'
+        require "pact_broker/integrations/service"
         Integrations::Service
       end
 
       register_service(:webhook_trigger_service) do
-        require 'pact_broker/webhooks/trigger_service'
+        require "pact_broker/webhooks/trigger_service"
         Webhooks::TriggerService
       end
+
+      register_service(:environment_service) do
+        require "pact_broker/deployments/environment_service"
+        Deployments::EnvironmentService
+      end
+
+      register_service(:deployed_version_service) do
+        require "pact_broker/deployments/deployed_version_service"
+        PactBroker::Deployments::DeployedVersionService
+      end
+
+      register_service(:released_version_service) do
+        require "pact_broker/deployments/released_version_service"
+        PactBroker::Deployments::ReleasedVersionService
+      end
+
+      register_service(:contract_service) do
+        require "pact_broker/contracts/service"
+        PactBroker::Contracts::Service
+      end
     end
+    # rubocop: enable Metrics/MethodLength
   end
 end