pact_broker 2.81.0 → 2.82.0

data/lib/pact_broker/webhooks/event_listener.rb

@@ -19,6 +19,9 @@ module PactBroker
 
       def contract_published(params)
         handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED, params)
+        if verification_service.calculate_required_verifications_for_pact(params.fetch(:pact)).any?
+          handle_event_for_webhook(PactBroker::Webhooks::WebhookEvent::CONTRACT_REQUIRING_VERIFICATION_PUBLISHED, params)
+        end
       end
 
       def contract_content_changed(params)

data/lib/pact_broker/webhooks/trigger_service.rb

@@ -47,19 +47,6 @@ module PactBroker
         end
       end
 
-      # private
-      def create_triggered_webhooks_for_webhooks webhooks, pact, verification, event_name, event_context
-        webhooks.flat_map do | webhook |
-          expanded_event_contexts = expand_events_for_currently_deployed_environments(webhook, pact, event_context)
-          expanded_event_contexts = expanded_event_contexts.flat_map { | ec | expand_events_for_verification_of_multiple_selected_pacts(ec) }
-
-          expanded_event_contexts.collect do | expanded_event_context |
-            pact_for_triggered_webhook = verification ? find_pact_for_verification_triggered_webhook(pact, expanded_event_context) : pact
-            webhook_repository.create_triggered_webhook(next_uuid, webhook, pact_for_triggered_webhook, verification, RESOURCE_CREATION, event_name, expanded_event_context)
-          end
-        end
-      end
-
       def schedule_webhooks(triggered_webhooks, options)
         triggered_webhooks.each_with_index do | triggered_webhook, i |
           logger.info "Scheduling job for webhook with uuid #{triggered_webhook.webhook.uuid}, context: #{triggered_webhook.event_context}"
@@ -76,7 +63,19 @@ module PactBroker
         end
       end
 
-      private
+      def create_triggered_webhooks_for_webhooks webhooks, pact, verification, event_name, event_context
+        webhooks.flat_map do | webhook |
+          expanded_event_contexts = expand_events_for_currently_deployed_environments(webhook, pact, event_context)
+          expanded_event_contexts = expand_events_for_required_verifications(event_name, pact, expanded_event_contexts)
+          expanded_event_contexts = expanded_event_contexts.flat_map { | ec | expand_events_for_verification_of_multiple_selected_pacts(ec) }
+
+          expanded_event_contexts.collect do | expanded_event_context |
+            pact_for_triggered_webhook = verification ? find_pact_for_verification_triggered_webhook(pact, expanded_event_context) : pact
+            webhook_repository.create_triggered_webhook(next_uuid, webhook, pact_for_triggered_webhook, verification, RESOURCE_CREATION, event_name, expanded_event_context)
+          end
+        end
+      end
+      private :create_triggered_webhooks_for_webhooks
 
       def merge_consumer_version_selectors(consumer_version_number, selectors, event_context)
         event_context.merge(
@@ -84,6 +83,7 @@ module PactBroker
           consumer_version_tags: selectors.collect{ | selector | selector[:tag] }.compact.uniq
         )
       end
+      private :merge_consumer_version_selectors
 
       # Now that we de-duplicate the pact contents when verifying though the 'pacts for verification' API,
       # we no longer get a webhook triggered for the verification results publication of each indiviual
@@ -103,6 +103,7 @@ module PactBroker
           [event_context]
         end
       end
+      private :expand_events_for_verification_of_multiple_selected_pacts
 
       def expand_events_for_currently_deployed_environments(webhook, pact, event_context)
         if PactBroker.feature_enabled?(:expand_currently_deployed_provider_versions) && webhook.expand_currently_deployed_provider_versions?
@@ -113,6 +114,7 @@ module PactBroker
           [event_context]
         end
       end
+      private :expand_events_for_currently_deployed_environments
 
       def find_pact_for_verification_triggered_webhook(pact, reconstituted_event_context)
         if reconstituted_event_context[:consumer_version_number]
@@ -126,6 +128,20 @@ module PactBroker
           pact
         end
       end
+      private :find_pact_for_verification_triggered_webhook
+
+      def expand_events_for_required_verifications(event_name, pact, event_contexts)
+        if event_name == PactBroker::Webhooks::WebhookEvent::CONTRACT_REQUIRING_VERIFICATION_PUBLISHED
+          required_verifications = verification_service.calculate_required_verifications_for_pact(pact)
+          event_contexts.flat_map do | event_context |
+            required_verifications.collect do | required_verification |
+              event_context.merge(provider_version_number: required_verification.provider_version.number, provider_version_descriptions: required_verification.provider_version_descriptions)
+            end
+          end
+        else
+          event_contexts
+        end
+      end
     end
   end
 end

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -136,6 +136,7 @@ end
 #  triggered_webhooks_provider_id_index         | btree (provider_id)
 #  triggered_webhooks_verification_id_index     | btree (verification_id)
 #  triggered_webhooks_webhook_id_index          | btree (webhook_id)
+#  triggered_webhooks_webhook_uuid_index        | btree (webhook_uuid)
 # Foreign key constraints:
 #  triggered_webhooks_consumer_id_fkey         | (consumer_id) REFERENCES pacticipants(id)
 #  triggered_webhooks_pact_publication_id_fkey | (pact_publication_id) REFERENCES pact_publications(id)

data/lib/pact_broker/webhooks/webhook.rb

@@ -153,7 +153,7 @@ end
 #  fk_webhooks_consumer | (consumer_id) REFERENCES pacticipants(id)
 #  fk_webhooks_provider | (provider_id) REFERENCES pacticipants(id)
 # Referenced By:
-#  webhook_headers    | fk_webhookheaders_webhooks         | (webhook_id) REFERENCES webhooks(id)
-#  webhook_executions | webhook_executions_webhook_id_fkey | (webhook_id) REFERENCES webhooks(id)
 #  triggered_webhooks | triggered_webhooks_webhook_id_fkey | (webhook_id) REFERENCES webhooks(id)
 #  webhook_events     | webhook_events_webhook_id_fkey     | (webhook_id) REFERENCES webhooks(id) ON DELETE CASCADE
+#  webhook_executions | webhook_executions_webhook_id_fkey | (webhook_id) REFERENCES webhooks(id)
+#  webhook_headers    | fk_webhookheaders_webhooks         | (webhook_id) REFERENCES webhooks(id)

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -12,8 +12,9 @@ module PactBroker
       VERIFICATION_SUCCEEDED = "provider_verification_succeeded"
       VERIFICATION_FAILED = "provider_verification_failed"
       DEFAULT_EVENT_NAME = CONTRACT_CONTENT_CHANGED
+      CONTRACT_REQUIRING_VERIFICATION_PUBLISHED = "contract_requiring_verification_published"
 
-      EVENT_NAMES = [CONTRACT_PUBLISHED, CONTRACT_CONTENT_CHANGED, VERIFICATION_PUBLISHED, VERIFICATION_SUCCEEDED, VERIFICATION_FAILED]
+      EVENT_NAMES = [CONTRACT_PUBLISHED, CONTRACT_CONTENT_CHANGED, VERIFICATION_PUBLISHED, VERIFICATION_SUCCEEDED, VERIFICATION_FAILED, CONTRACT_REQUIRING_VERIFICATION_PUBLISHED]
 
       dataset_module do
         include PactBroker::Repositories::Helpers
@@ -38,6 +39,10 @@ module PactBroker
       def provider_verification_failed?
         name == VERIFICATION_FAILED
       end
+
+      def contract_requiring_verification_published?
+        name == CONTRACT_REQUIRING_VERIFICATION_PUBLISHED
+      end
     end
   end
 end

data/lib/semantic_logger/formatters/short.rb

@@ -0,0 +1,29 @@
+require "semantic_logger/formatters/default"
+
+module SemanticLogger
+  module Formatters
+    class Short < SemanticLogger::Formatters::Default
+      TAGS_TO_REMOVE = [:pact_broker_git_sha, :tenant_id, :request_id, :pactflow_git_sha]
+
+      def call(log, logger)
+        self.log    = log
+        self.logger = logger
+
+        [time, level, tags, named_tags, duration, message, payload, exception].compact.join(" ")
+      end
+
+      def time
+        log.time.strftime("%H:%M:%S")
+      end
+
+      def named_tags
+        named_tags = log.named_tags.reject{ | k, _ | TAGS_TO_REMOVE.include?(k) }
+        return if named_tags.nil? || named_tags.empty?
+
+        list = []
+        named_tags.each_pair { |name, value| list << "#{name}: #{value}" }
+        "{#{list.join(', ')}}"
+      end
+    end
+  end
+end

data/pact_broker.gemspec

@@ -65,4 +65,5 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "semantic_logger", "~> 4.3"
   gem.add_runtime_dependency "sanitize", ">= 5.2.1", "~> 5.2"
   gem.add_runtime_dependency "wisper", "~> 2.0"
+  gem.add_runtime_dependency "anyway_config", "~> 2.1"
 end

data/script/data/auto-create-things-for-tags.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+begin
+
+  $LOAD_PATH << "#{Dir.pwd}/lib"
+  require "pact_broker/test/http_test_data_builder"
+  base_url = ENV["PACT_BROKER_BASE_URL"] || "http://localhost:9292"
+
+  td = PactBroker::Test::HttpTestDataBuilder.new(base_url)
+  td.delete_pacticipant("AutoDetectTestProvider")
+    .create_environment(name: "prod", production: true)
+    .create_pacticipant("AutoDetectTestProvider")
+    .create_tagged_pacticipant_version(pacticipant: "AutoDetectTestProvider", version: "1", tag: "main")
+    .deploy_to_prod(pacticipant: "AutoDetectTestProvider", version: "1")
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+end

data/script/data/contract-published-requiring-verification.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+begin
+
+  $LOAD_PATH << "#{Dir.pwd}/lib"
+  require "pact_broker/test/http_test_data_builder"
+  base_url = ENV["PACT_BROKER_BASE_URL"] || "http://localhost:9292"
+
+  td = PactBroker::Test::HttpTestDataBuilder.new(base_url)
+  td.create_global_webhook_for_event(uuid: "7a5da39c-8e50-4cc9-ae16-dfa5be043e8c", event_name: "contract_requiring_verification_published")
+    .delete_pacticipant("NewWebhookTestConsumer")
+    .delete_pacticipant("NewWebhookTestProvider")
+    .create_environment(name: "test")
+    .create_environment(name: "prod", production: true)
+    .create_pacticipant("NewWebhookTestConsumer")
+    .create_pacticipant("NewWebhookTestProvider")
+    .create_tagged_pacticipant_version(pacticipant: "NewWebhookTestProvider", version: "1", tag: "main")
+    .deploy_to_prod(pacticipant: "NewWebhookTestProvider")
+    .record_deployment(pacticipant: "NewWebhookTestProvider", version: "1", environment_name: "test")
+    .record_deployment(pacticipant: "NewWebhookTestProvider", version: "1", environment_name: "prod")
+    .create_version(pacticipant: "NewWebhookTestProvider", version: "2", branch: "main")
+    .publish_pact(consumer: "NewWebhookTestConsumer", consumer_version: "1", provider: "NewWebhookTestProvider", content_id: "111")
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+end

data/script/docs/generate-configuration-docs.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+require "yaml"
+
+$stream = StringIO.new
+
+def write string
+  $stream.puts string
+end
+
+def escape_backticks value
+  if value.is_a?(String)
+    value.gsub("`", "``")
+  else
+    value
+  end
+end
+
+def in_backticks value
+  if value =~ /\s\(.+\)/
+    "`#{escape_backticks(value)}".gsub(" (", "` (")
+  else
+    "`#{escape_backticks(value)}`"
+  end
+end
+
+docs_dir = File.expand_path("../../../docs", __FILE__)
+environment_variable_file = File.join(docs_dir, "configuration.yml")
+doc = YAML.load(File.read(environment_variable_file))
+
+write "# Pact Broker Configuration\n\n"
+# write "## Index"
+
+# doc["groups"].each do | group |
+#   write "* #{group['title']}\n"
+
+#   group['vars'].each do | name, metadata |
+#     next if metadata['hidden']
+#     write "    * [#{name}](##{name})\n"
+#   end
+# end
+
+write "\n"
+
+doc["groups"].each do | group |
+  write "<br/>\n\n"
+  write "## #{group["title"]}\n\n<hr/>\n"
+  if group["comments"]
+    write group["comments"]
+  end
+  write "\n\n"
+
+  group["vars"].each do | name, metadata |
+    next if metadata["hidden"]
+    write "### #{name}\n\n"
+    write "#{metadata["description"]}\n\n"
+
+    write "**Required:** #{metadata["required"] || "false"}<br/>" if metadata["required"]
+    write "**Format:** #{metadata["format"]}<br/>" if metadata["format"]
+    write "**Default:** #{in_backticks(metadata["default"])}<br/>" if !metadata["default"].nil?
+    if metadata["allowed_values"]
+      allowed_values = metadata["allowed_values"].collect{ |val| in_backticks(val) }.join(", ")
+      write "**Allowed values:** #{allowed_values}<br/>"
+    end
+    write "**Example:** #{in_backticks(metadata["example"]) }<br/>" if metadata["example"]
+    if metadata["examples"]
+      allowed_values = metadata["examples"].collect{ |val| in_backticks(val) }.join(", ")
+      write "**Examples:** #{allowed_values}<br/>"
+    end
+    write "**More information:** #{metadata["more_info"]}<br/>" if metadata["more_info"]
+    write "\n"
+  end
+end
+
+File.open(File.join(docs_dir, "CONFIGURATION.md"), "w") { |file| file << $stream.string }
+
+required_env_vars = []
+
+doc["groups"].each do | group |
+  group["vars"].each do | name, metadata |
+    required_env_vars << name if metadata["required"] && !metadata["default"]
+  end
+end
+
+puts "Required:"
+puts required_env_vars

data/spec/features/get_latest_pact_badge_spec.rb

@@ -4,6 +4,7 @@ describe "get latest pact badge" do
 
   before do
     PactBroker.configuration.enable_public_badge_access = true
+    PactBroker.configuration.badge_provider_mode = :proxy
     TestDataBuilder.new
       .create_consumer("consumer")
       .create_provider("provider")

data/spec/features/get_matrix_badge_spec.rb

@@ -4,6 +4,7 @@ describe "get latest matrix badge with tags" do
 
   before do
     PactBroker.configuration.enable_public_badge_access = true
+    PactBroker.configuration.badge_provider_mode = :proxy
     TestDataBuilder.new
       .create_consumer("consumer")
       .create_provider("provider")

data/spec/features/publish_pact_spec.rb

@@ -30,18 +30,32 @@ describe "Publishing a pact" do
 
     before do
       td.create_pact_with_hierarchy("A Consumer", "1.2.3", "A Provider").and_return(:pact)
+      allow(PactBroker.configuration).to receive(:allow_dangerous_contract_modification).and_return(allow_dangerous_contract_modification)
     end
 
-    it "returns a 200 Success" do
-      expect(subject.status).to be 200
-    end
+    context "when the content is different" do
+      context "when pact modification is allowed" do
+        let(:allow_dangerous_contract_modification) { true }
 
-    it "returns an application/json Content-Type" do
-      expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
+        it "returns a 200 Success" do
+          expect(subject.status).to be 200
+        end
+
+        it "returns an application/json Content-Type" do
+          expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
+        end
+
+        it "returns the pact in the response body" do
+          expect(response_body_json).to match_pact JSON.parse(pact_content)
+        end
+      end
     end
 
-    it "returns the pact in the response body" do
-      expect(response_body_json).to match_pact JSON.parse(pact_content)
+    context "when pact modification is not allowed" do
+      let(:allow_dangerous_contract_modification) { false }
+
+      its(:status) { is_expected.to eq 409 }
+      its(:body) { is_expected.to include "Cannot change the content of the pact for A Consumer version 1.2.3" }
     end
   end
 

data/spec/features/wip_pacts_spec.rb

@@ -43,7 +43,7 @@ RSpec.describe "the lifecycle of a WIP pact" do
 
   def publish_new_pact_with_master_tag_after_merging_in_feature_branch
     put("/pacts/provider/Bar/consumer/Foo/version/3", pact_content_2, request_headers)
-    put("/pacticipants/Foo/versions/2/tags/master", nil, request_headers)
+    put("/pacticipants/Foo/versions/3/tags/master", nil, request_headers)
   end
 
   def get_pacts_for_verification(request_body = nil)

data/spec/fixtures/approvals/matrix_integration_environment_spec.approved.json

@@ -0,0 +1,62 @@
+{
+  "PactBroker::Matrix::Service find with environments when there is a successful verification between the provider in test environment and the consumer to be deployed allows the consumer to be deployed": {
+    "deployable": true,
+    "reasons": [
+      "PactBroker::Matrix::Successful"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when there is an unsuccessful verification between the provider in test environment and the consumer to be deployed does not allow the consumer to be deployed": {
+    "deployable": false,
+    "reasons": [
+      "PactBroker::Matrix::VerificationFailed"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when the provider has not been deployed to the given environment does not allow the consumer to be deployed": {
+    "deployable": null,
+    "reasons": [
+      "PactBroker::Matrix::PactNotEverVerifiedByProvider"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when the consumer has not been deployed to the given environment allows the provider to be deployed": {
+    "deployable": true,
+    "reasons": [
+      "PactBroker::Matrix::NoDependenciesMissing"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when deploying a version of a provider with multiple versions of a consumer in production knows that there are multiple versions of the consumer in production": {
+    "deployable": null,
+    "reasons": [
+      "PactBroker::Matrix::PactNotEverVerifiedByProvider"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when deploying a version of a provider with multiple versions of a consumer in production when a verification for the latest prod version is missing does not allow the provider to be deployed": {
+    "deployable": null,
+    "reasons": [
+      "PactBroker::Matrix::PactNotEverVerifiedByProvider"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when deploying a version of a provider with multiple versions of a consumer in production when there is a successful verification for every prod version of the consumer does allow the provider to be deployed": {
+    "deployable": true,
+    "reasons": [
+      "PactBroker::Matrix::Successful"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when deploying a version of a consumer with multiple versions of a provider in production knows that there are multiple versions of the provider in production": {
+    "deployable": null,
+    "reasons": [
+      "PactBroker::Matrix::PactNotEverVerifiedByProvider"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when deploying a version of a consumer with multiple versions of a provider in production when a verification for the latest prod version is missing does not allow the consumer to be deployed": {
+    "deployable": null,
+    "reasons": [
+      "PactBroker::Matrix::PactNotEverVerifiedByProvider"
+    ]
+  },
+  "PactBroker::Matrix::Service find with environments when deploying a version of a consumer with multiple versions of a provider in production when there is a successful verification for every prod version of the consumer does allow the consumer to be deployed": {
+    "deployable": true,
+    "reasons": [
+      "PactBroker::Matrix::Successful"
+    ]
+  }
+}