pact_broker 2.79.1 → 2.80.0

data/lib/pact_broker/integrations/integration.rb

@@ -1,8 +1,8 @@
-require 'pact_broker/db'
-require 'pact_broker/verifications/pseudo_branch_status'
-require 'pact_broker/domain/verification'
-require 'pact_broker/webhooks/latest_triggered_webhook'
-require 'pact_broker/webhooks/webhook'
+require "pact_broker/db"
+require "pact_broker/verifications/pseudo_branch_status"
+require "pact_broker/domain/verification"
+require "pact_broker/webhooks/latest_triggered_webhook"
+require "pact_broker/webhooks/webhook"
 
 module PactBroker
   module Integrations

data/lib/pact_broker/integrations/service.rb

@@ -1,9 +1,9 @@
-require 'pact_broker/services'
-require 'pact_broker/repositories'
-require 'pact_broker/logging'
-require 'pact_broker/integrations/integration'
-require 'pact_broker/db/models'
-require 'pact_broker/repositories/helpers'
+require "pact_broker/services"
+require "pact_broker/repositories"
+require "pact_broker/logging"
+require "pact_broker/integrations/integration"
+require "pact_broker/db/models"
+require "pact_broker/repositories/helpers"
 
 module PactBroker
   module Integrations
@@ -21,7 +21,7 @@ module PactBroker
         # so it would be better to create a Verification::PactStatus class
         # that doesn't have the 'stale' logic in it.
         # Then we can remove the eager loading of the pact_version
-        PactBroker::Integrations::Integration
+        scope_for(PactBroker::Integrations::Integration)
           .eager(:consumer)
           .eager(:provider)
           .eager(latest_pact: [:latest_verification, :pact_version])
@@ -59,6 +59,10 @@ module PactBroker
           end
         end
       end
+
+      def self.scope_for(scope)
+        PactBroker.policy_scope!(scope)
+      end
     end
   end
 end

data/lib/pact_broker/labels/repository.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/domain/label'
-require 'pact_broker/repositories/helpers'
+require "pact_broker/domain/label"
+require "pact_broker/repositories/helpers"
 
 module PactBroker
   module Labels

data/lib/pact_broker/labels/service.rb

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

data/lib/pact_broker/locale/en.yml

@@ -4,6 +4,7 @@ en:
     filled?: "can't be blank"
     valid_method?: "is not a recognised HTTP method"
     valid_url?: "is not a valid URL eg. http://example.org"
+    base64?: "is not valid Base64"
     valid_version_number?: "Version number '%{value}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
     name_in_path_matches_name_in_pact?: "does not match %{left} name in path ('%{right}')."
     valid_consumer_version_number?: "Consumer version number '%{value}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
@@ -11,28 +12,55 @@ en:
     pacticipant_exists?: "does not match an existing pacticipant"
     single_line?: "cannot contain multiple lines"
     no_spaces?: "cannot contain spaces"
+    environment_with_name_exists?: "with name '%{value}' does not exist"
 
   pact_broker:
     messages:
       response_body_hidden: For security purposes, the response details are not logged. To enable response logging, configure the webhook_host_whitelist property. See %{base_url}/doc/webhooks#whitelist for more information.
+      index:
+        title: Pacts
       matrix:
         pre_verified: This pact was "pre-verified" as it has identical content to a previously verified pact.
       webhooks:
         parameters:
           pactbroker:
-            consumerName: the consumer name
-            providerName: the provider name
-            consumerVersionNumber: the version number of the most recent consumer version associated with the pact content.
-            providerVersionNumber: the provider version number for the verification result
-            consumerVersionTags: the list of tag names for the most recent consumer version associated with the pact content, separated by ", "
-            providerVersionTags: the list of tag names for the provider version associated with the verification result, separated by ", ".
-            consumerLabels: the list of labels for the consumer associated with the pact content, separated by ", ".
-            providerLabels: the list of labels for the provider associated with the pact content, separated by ", ".
-            pactUrl: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.
-            verificationResultUrl: the URL to the relevant verification result.
-            githubVerificationStatus: the verification status using the correct keywords for posting to the Github commit status API. See https://developer.github.com/v3/repos/statuses.
-            bitbucketVerificationStatus: the verification status using the correct keywords for posting to the Bitbucket commit status API. See https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/.
-
+            consumerName: The consumer name
+            providerName: The provider name
+            consumerVersionNumber: The version number of the most recent consumer version associated with the pact content.
+            providerVersionNumber: The provider version number for the verification result
+            consumerVersionTags: The list of tag names for the most recent consumer version associated with the pact content, separated by ", "
+            consumerVersionBranch: The repository branch associated with the consumer version
+            providerVersionTags: The list of tag names for the provider version associated with the verification result, separated by ", ".
+            providerVersionBranch: The repository branch associated with the provider version
+            consumerLabels: The list of labels for the consumer associated with the pact content, separated by ", ".
+            providerLabels: The list of labels for the provider associated with the pact content, separated by ", ".
+            pactUrl: The "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.
+            verificationResultUrl: The URL to the relevant verification result.
+            githubVerificationStatus: The verification status using the correct keywords for posting to the Github commit status API. See https://developer.github.com/v3/repos/statuses
+            bitbucketVerificationStatus: The verification status using the correct keywords for posting to the Bitbucket commit status API. See https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/
+            azureDevOpsVerificationStatus: The verification status using the correct keywords for posting to the Azure DevOps GitStatusState API. See https://docs.microsoft.com/en-us/rest/api/azure/devops/git/statuses/create?view=azure-devops-rest-6.0
+            eventName: The name of the event that triggered the webhook
+            currentlyDeployedProviderVersionNumber: The version number of the currently deployed provider version (when used in a template, the webhook will be triggered once for each currently deployed provider version)
+        no_webhooks_enabled_for_event: No enabled webhooks found for the detected events
+        webhook_triggered_for_event: Webhook %{webhook_description} triggered for event %{event_name}.
+        triggered_webhook_see_logs: View logs at %{url}
+      version:
+        created: "%{action} %{pacticipant_name} version %{pacticipant_version_number}"
+        created_for_branch: "%{action} %{pacticipant_name} version %{pacticipant_version_number} with branch %{branch}"
+        created_for_branch_with_tags: "%{action} %{pacticipant_name} version %{pacticipant_version_number} with branch %{branch} and tags %{tags}"
+        created_with_tags: "%{action} %{pacticipant_name} version %{pacticipant_version_number} with tags %{tags}"
+      contract:
+        pact_published: Pact successfully published for %{consumer_name} version %{consumer_version_number} and provider %{provider_name}.
+        same_pact_content_published: Pact successfully republished for %{consumer_name} version %{consumer_version_number} and provider %{provider_name} with no content changes.
+        pact_modified_for_same_version: Pact with changed content published over existing content for %{consumer_name} version %{consumer_version_number} and provider %{provider_name}. This is not recommended in normal cicumstances and may indicate that you have not configured your Pact pipeline correctly. For more information see https://docs.pact.io/go/versioning
+        pact_merged: Pact content merged with existing content for %{consumer_name} version %{consumer_version_number} and provider %{provider_name}.
+      events:
+        pact_published_unchanged_with_single_tag: pact content is the same as previous version with tag %{tag_name} and no new tags were applied
+        pact_published_unchanged_with_multiple_tags: pact content is the same as previous versions with tags %{tag_names} and no new tags were applied
+      next_steps:
+        verifications: Add Pact verification tests to the %{provider_name} build. See https://docs.pact.io/go/provider_verification
+        webhooks: Configure separate %{provider_name} pact verification build and webhook to trigger it when the pact content changes. See https://docs.pact.io/go/webhooks
+        version_branch: Configure the version branch to be the value of your repository branch.
     errors:
       validation:
         blank: "cannot be blank."
@@ -44,10 +72,20 @@ en:
         consumer_version_number_header_invalid: "X-Pact-Consumer-Version '%{consumer_version_number}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
         consumer_version_number_invalid: "Consumer version number '%{consumer_version_number}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
         pacticipant_name_mismatch: "in pact ('%{name_in_pact}') does not match %{pacticipant} name in path ('%{name}')."
+        consumer_name_in_content_mismatch_pacticipant_name: "consumer name in contract content ('%{consumer_name_in_content}') must match pacticipantName ('%{pacticipant_name}')"
+        consumer_name_in_contract_mismatch_pacticipant_name: "consumerName ('%{consumer_name_in_contract}') must match pacticipantName ('%{pacticipant_name}')"
+        provider_name_in_content_mismatch: "provider name in contract content ('%{provider_name_in_content}') must match providerName ('%{provider_name}') in contracts"
         connection_encoding_not_utf8: "The Sequel connection encoding (%{encoding}) is strongly recommended to be \"utf8\". If you need to set it to %{encoding} for some particular reason, then disable this check by setting config.validate_database_connection_config = false"
         invalid_webhook_uuid: The UUID can only contain the characters A-Z, a-z, 0-9, _ and -, and must be 16 or more characters.
         pacticipant_not_found: No pacticipant with name '%{name}' found
         environment_name_must_be_unique: Another environment with name '%{name}' already exists.
+        cannot_specify_tag_and_environment: Cannot specify both a 'to' tag and an environment.
+        cannot_specify_latest_and_environment: Cannot specify both latest=true and an environment.
+        environment_with_name_not_found: "Environment with name '%{name}' does not exist"
+        cannot_modify_version_branch: "The branch for a pacticipant version cannot be changed once set (currently '%{old_branch}', proposed value '%{new_branch}'). Your pact publication/verification publication configurations may be in conflict with each other if you are seeing this error. If the current branch value is incorrect, you must delete the pacticipant version resource at %{version_url} and publish the pacts/verification results again with a consistent branch name."
+        invalid_content_for_content_type: "The content could not be parsed as %{content_type}"
+        cannot_set_currently_deployed_true: The currentlyDeployed property cannot be set back to true. Please record a new deployment.
+        cannot_set_currently_supported_true: The currentlySupported property cannot be set back to true. Please record a new deployment.
       duplicate_pacticipant: |
         This is the first time a pact has been published for "%{new_name}".
         The name "%{new_name}" is very similar to the following existing consumers/providers:

data/lib/pact_broker/logging.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'semantic_logger'
+require "semantic_logger"
 
 module PactBroker
   module Logging
@@ -10,7 +10,7 @@ module PactBroker
       base.class_eval do
         # Returns [SemanticLogger::Logger] class level logger
         def self.logger
-          require 'pact_broker/configuration'
+          require "pact_broker/configuration"
           @logger ||= PactBroker.configuration.custom_logger || SemanticLogger[self]
         end
 
@@ -43,7 +43,7 @@ module PactBroker
         message = "#{description} - #{message}" if description
         logger.error message
       end
-      if ENV['PACT_BROKER_HIDE_PACTFLOW_MESSAGES'] != 'true'
+      if ENV["PACT_BROKER_HIDE_PACTFLOW_MESSAGES"] != "true"
         logger.info "\n\n#{'*' * 80}\n\nPrefer it was someone else's job to deal with this error? Check out https://pactflow.io/oss for a hardened, fully supported SaaS version of the Pact Broker with an improved UI  + more.\n\n#{'*' * 80}\n"
       end
     end

data/lib/pact_broker/logging/default_formatter.rb

@@ -1,5 +1,5 @@
-require 'logger'
-require 'semantic_logger'
+require "logger"
+require "semantic_logger"
 
 module PactBroker
   module Logging
@@ -8,7 +8,7 @@ module PactBroker
         @formatter = ::Logger::Formatter.new
       end
 
-      def call(log, output)
+      def call(log, _output)
         self.log    = log
         self.logger = logger
         @formatter.call(log.level.upcase, log.time, nil, [tags, named_tags, duration, message, payload, exception].compact.join(" "))

data/lib/pact_broker/matrix/aggregated_row.rb

@@ -1,5 +1,5 @@
-require 'forwardable'
-require 'pact_broker/verifications/repository'
+require "forwardable"
+require "pact_broker/verifications/repository"
 
 # A collection of matrix rows with the same pact publication id
 # It's basically a normalised view of a denormalised view :(
@@ -33,8 +33,8 @@ module PactBroker
       def latest_verification_for_pseudo_branch
         @latest_verification ||= begin
           verification = matrix_rows.collect do | row|
-              row.verification || latest_verification_for_consumer_version_tag(row)
-            end.compact.sort_by(&:id).last
+            row.verification || latest_verification_for_consumer_version_tag(row)
+          end.compact.sort_by(&:id).last
 
           if !verification && overall_latest?
             overall_latest_verification

data/lib/pact_broker/matrix/can_i_deploy_query_schema.rb

@@ -1,17 +1,32 @@
-require 'dry-validation'
+require "dry-validation"
+require "pact_broker/messages"
+require "pact_broker/api/contracts/dry_validation_predicates"
+require "pact_broker/project_root"
 
 module PactBroker
   module Api
     module Contracts
       class CanIDeployQuerySchema
+        extend PactBroker::Messages
+
         SCHEMA = Dry::Validation.Schema do
+          configure do
+            predicates(DryValidationPredicates)
+            config.messages_file = PactBroker.project_root.join("lib", "pact_broker", "locale", "en.yml")
+          end
           required(:pacticipant).filled(:str?)
           required(:version).filled(:str?)
           optional(:to).filled(:str?)
+          optional(:environment).filled(:str?, :environment_with_name_exists?)
         end
 
         def self.call(params)
-          select_first_message(SCHEMA.call(params).messages(full: true))
+          result = select_first_message(SCHEMA.call(params).messages(full: true))
+          if params[:to] && params[:environment]
+            result[:to] ||= []
+            result[:to] << message("errors.validation.cannot_specify_tag_and_environment")
+          end
+          result
         end
 
         def self.select_first_message(messages)

data/lib/pact_broker/matrix/deployment_status_summary.rb

@@ -1,37 +1,40 @@
-require 'pact_broker/logging'
-require 'pact_broker/matrix/reason'
+require "pact_broker/logging"
+require "pact_broker/matrix/reason"
+require "forwardable"
 
 module PactBroker
   module Matrix
     class DeploymentStatusSummary
       include PactBroker::Logging
+      extend Forwardable
 
-      attr_reader :rows, :resolved_selectors, :integrations
+      attr_reader :query_results, :all_rows
+      delegate [:considered_rows, :ignored_rows, :resolved_selectors, :resolved_ignore_selectors, :integrations] => :query_results
 
-      def initialize(rows, resolved_selectors, integrations)
-        @rows = rows
-        @resolved_selectors = resolved_selectors
-        @integrations = integrations
+      def initialize(query_results)
+        @query_results = query_results
+        @all_rows = query_results.rows
         @dummy_selectors = create_dummy_selectors
       end
 
       def counts
         {
-          success: rows.count(&:success),
-          failed: rows.count { |row| row.success == false },
-          unknown: required_integrations_without_a_row.count + rows.count { |row| row.success.nil? }
-        }
+          success: considered_rows.count(&:success),
+          failed: considered_rows.count { |row| row.success == false },
+          unknown: required_integrations_without_a_row.count + considered_rows.count { |row| row.success.nil? },
+          ignored: resolved_ignore_selectors.any? ? ignored_rows.count : nil
+        }.compact
       end
 
       def deployable?
-        return false if specified_selectors_that_do_not_exist.any?
-        return nil if rows.any?{ |row| row.success.nil? }
+        return false if considered_specified_selectors_that_do_not_exist.any?
+        return nil if considered_rows.any?{ |row| row.success.nil? }
         return nil if required_integrations_without_a_row.any?
-        rows.all?(&:success) # true if rows is empty
+        considered_rows.all?(&:success) # true if considered_rows is empty
       end
 
       def reasons
-        error_messages.any? ? error_messages + warning_messages : success_messages + warning_messages
+        error_messages.any? ? warning_messages + error_messages  : warning_messages + success_messages
       end
 
       private
@@ -52,7 +55,48 @@ module PactBroker
       end
 
       def warning_messages
-        []
+        resolved_ignore_selectors.select(&:pacticipant_or_version_does_not_exist?).collect { | s | IgnoreSelectorDoesNotExist.new(s) } +
+          bad_practice_warnings
+      end
+
+      def bad_practice_warnings
+        warnings = []
+
+        if no_to_tag_or_environment_specified?
+          warnings << NoEnvironmentSpecified.new
+        end
+
+        if selector_without_pacticipant_version_number_specified?
+          warnings << SelectorWithoutPacticipantVersionNumberSpecified.new
+        end
+
+        warnings
+      end
+
+      def selector_without_pacticipant_version_number_specified?
+        # If only the pacticipant name is specified, it can't be a can-i-deploy query, must be a matrix UI query
+        resolved_selectors
+          .select(&:specified?)
+          .reject(&:only_pacticipant_name_specified?)
+          .reject(&:pacticipant_version_specified_in_original_selector?)
+          .any?
+      end
+
+
+      def more_than_one_selector_specified?
+        # If only the pacticipant name is specified, it can't be a can-i-deploy query, must be a matrix UI query
+        resolved_selectors
+          .select(&:specified?)
+          .reject(&:only_pacticipant_name_specified?)
+          .any?
+      end
+
+      def no_to_tag_or_environment_specified?
+        !(query_results.options[:tag] || query_results.options[:environment_name])
+      end
+
+      def considered_specified_selectors_that_do_not_exist
+        resolved_selectors.select(&:consider?).select(&:specified_version_that_does_not_exist?)
       end
 
       def specified_selectors_that_do_not_exist
@@ -60,24 +104,20 @@ module PactBroker
       end
 
       def specified_selectors_do_not_exist_messages
-        specified_selectors_that_do_not_exist.collect do | selector |
-          SpecifiedVersionDoesNotExist.new(selector)
-        end
+        specified_selectors_that_do_not_exist.select(&:consider?).collect { | selector | SpecifiedVersionDoesNotExist.new(selector) }
       end
 
       def not_ever_verified_reasons
-        rows.select{ | row | row.success.nil? }.collect{ |row | pact_not_ever_verified_by_provider(row) }
+        considered_rows.select{ | row | row.success.nil? }.collect{ |row | pact_not_ever_verified_by_provider(row) }
       end
 
       def failure_messages
-        rows.select{ |row| row.success == false }.collect do | row |
-          VerificationFailed.new(*selectors_for(row))
-        end
+        considered_rows.select{ |row| row.success == false }.collect { | row | VerificationFailed.new(*selectors_for(row)) }
       end
 
       def success_messages
-        if rows.all?(&:success) && required_integrations_without_a_row.empty?
-          if rows.any?
+        if considered_rows.all?(&:success) && required_integrations_without_a_row.empty?
+          if considered_rows.any?
             [Successful.new]
           else
             [NoDependenciesMissing.new]
@@ -99,7 +139,7 @@ module PactBroker
       # 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
+      # No matrix considered_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.
@@ -117,11 +157,11 @@ module PactBroker
       end
 
       def log_required_integrations_without_a_row_occurred integrations
-        logger.info("required_integrations_without_a_row returned non empty", payload: { integrations: integrations, rows: rows })
+        logger.info("required_integrations_without_a_row returned non empty", payload: { integrations: integrations, considered_rows: considered_rows })
       end
 
       def row_exists_for_integration(integration)
-        rows.find { | row | integration == row }
+        all_rows.find { | row | integration.matches_pacticipant_ids?(row) }
       end
 
       def missing_reasons
@@ -163,33 +203,33 @@ module PactBroker
 
       # When the user has not specified a version of the provider (eg no 'latest' and/or 'tag', which means 'all versions')
       # 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.
+      # we may end up with considered_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
+        (dummy_selectors_from_considered_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 = ResolvedSelector.for_pacticipant(row.consumer, {}, :inferred, false)
+          dummy_provider_selector = ResolvedSelector.for_pacticipant(row.provider, {}, :inferred, false)
           [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)
+      def dummy_selectors_from_considered_rows
+        considered_rows.collect do | row |
+          dummy_consumer_selector = ResolvedSelector.for_pacticipant_and_version(row.consumer, row.consumer_version, {}, :inferred, false)
           dummy_provider_selector = row.provider_version ?
-            ResolvedSelector.for_pacticipant_and_version(row.provider, row.provider_version, {}, :inferred) :
-            ResolvedSelector.for_pacticipant(row.provider, :inferred)
+            ResolvedSelector.for_pacticipant_and_version(row.provider, row.provider_version, {}, :inferred, false) :
+            ResolvedSelector.for_pacticipant(row.provider, {}, :inferred, false)
           [dummy_consumer_selector, dummy_provider_selector]
         end.flatten
       end
 
       # experimental
       def warnings_for_missing_interactions
-        rows.select(&:success).collect do | row |
+        considered_rows.select(&:success).collect do | row |
           begin
             if row.verification.interactions_missing_test_results.any? && !row.verification.all_interactions_missing_test_results?
               InteractionsMissingVerifications.new(selector_for(row.consumer_name), selector_for(row.provider_name), row.verification.interactions_missing_test_results)