pact_broker 2.85.1 → 2.86.0

data/lib/pact_broker/webhooks/webhook.rb

@@ -30,12 +30,14 @@ module PactBroker
         end
 
         def find_by_consumer_and_or_provider consumer, provider
+
           where(
             Sequel.|(
               { consumer_id: consumer.id, provider_id: provider.id },
-              { consumer_id: nil, provider_id: provider.id },
-              { consumer_id: consumer.id, provider_id: nil },
-              { consumer_id: nil, provider_id: nil}
+              { consumer_id: nil, provider_id: provider.id, consumer_label: nil },
+              { consumer_id: consumer.id, provider_id: nil, provider_label: nil },
+              { consumer_id: nil, provider_id: nil, consumer_label: nil, provider_label: nil },
+              *labels_criteria_for_consumer_or_provider(consumer, provider)
             )
           )
         end
@@ -51,6 +53,32 @@ module PactBroker
         def enabled
           where(enabled: true)
         end
+
+        private
+
+        def labels_criteria_for_consumer_or_provider(consumer, provider)
+          consumer_labels = consumer.labels.map(&:name)
+          provider_labels = provider.labels.map(&:name)
+
+          [].then do |criteria|
+            next criteria if consumer_labels.empty?
+            criteria + [
+              { consumer_label: consumer_labels, provider_label: nil, provider_id: nil },
+              { consumer_label: consumer_labels, provider_label: nil, provider_id: provider.id }
+            ]
+          end.then do |criteria|
+            next criteria if provider_labels.empty?
+            criteria + [
+              { provider_label: provider_labels, consumer_label: nil, consumer_id: nil },
+              { provider_label: provider_labels, consumer_label: nil, consumer_id: consumer.id }
+            ]
+          end.then do |criteria|
+            next criteria if consumer_labels.empty? || provider_labels.empty?
+            criteria + [
+              { consumer_label: consumer_labels, provider_label: provider_labels }
+            ]
+          end
+        end
       end
 
       def update_from_domain webhook
@@ -74,8 +102,8 @@ module PactBroker
         Domain::Webhook.new(
           uuid: uuid,
           description: description,
-          consumer: consumer,
-          provider: provider,
+          consumer: webhook_consumer,
+          provider: webhook_provider,
           events: events,
           request: Webhooks::WebhookRequestTemplate.new(request_attributes),
           enabled: enabled,
@@ -100,7 +128,15 @@ module PactBroker
       end
 
       def is_for? integration
-        (consumer_id == integration.consumer_id || !consumer_id) && (provider_id == integration.provider_id || !provider_id)
+        (
+          consumer_id == integration.consumer_id ||
+          match_label?(:consumer, integration) ||
+          match_all?(:consumer)
+        ) && (
+          provider_id == integration.provider_id ||
+          match_label?(:provider, integration) ||
+          match_all?(:provider)
+        )
       end
 
       # Keep the triggered webhooks after the webhook has been deleted
@@ -110,7 +146,6 @@ module PactBroker
         super
       end
 
-
       def self.properties_hash_from_domain webhook
         is_json_request_body = !(String === webhook.request.body || webhook.request.body.nil?) # Can't rely on people to set content type
         {
@@ -122,9 +157,32 @@ module PactBroker
           enabled: webhook.enabled.nil? ? true : webhook.enabled,
           body: (is_json_request_body ? webhook.request.body.to_json : webhook.request.body),
           is_json_request_body: is_json_request_body,
-          headers: webhook.request.headers
+          headers: webhook.request.headers,
+          consumer_label: webhook.consumer&.label,
+          provider_label: webhook.provider&.label
         }
       end
+
+      def webhook_consumer
+        return if consumer.nil? && consumer_label.nil?
+
+        Domain::WebhookPacticipant.new(name: consumer&.name, label: consumer_label)
+      end
+
+      def webhook_provider
+        return if provider.nil? && provider_label.nil?
+
+        Domain::WebhookPacticipant.new(name: provider&.name, label: provider_label)
+      end
+
+      def match_all?(name)
+        public_send(:"#{name}_id").nil? && public_send(:"#{name}_label").nil?
+      end
+
+      def match_label?(name, integration)
+        label = public_send(:"#{name}_label")
+        public_send(:"#{name}_id").nil? && integration.public_send(name).label?(label)
+      end
     end
   end
 end

data/script/data/verify-pact-for-multiple-selectors.rb

@@ -0,0 +1,30 @@
+#!/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("some-consumer")
+    .delete_pacticipant("some-provider")
+    .create_pacticipant("some-consumer")
+    .create_pacticipant("some-provider")
+    .publish_pact(consumer: "some-consumer", consumer_version: "1", provider: "some-provider", content_id: "111", branch: "main")
+    .publish_pact(consumer: "some-consumer", consumer_version: "2", provider: "some-provider", content_id: "111", branch: "feat/x")
+    .get_pacts_for_verification(
+      provider_version_tag: "main",
+      consumer_version_selectors: [{ branch: "main" }, { branch: "feat/x" }]
+    )
+    .verify_pact(
+      index: 0,
+      provider_version_tag: "main",
+      provider_version: "1",
+      success: true
+    )
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+end

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

@@ -1,7 +1,16 @@
 #!/usr/bin/env ruby
 
-require "yaml"
+INTRO = <<EOM
+<!-- This is a generated file. Please do not edit it directly. -->
+
+The Pact Broker supports configuration via environment variables or a YAML file.
 
+To configure the application using a YAML file, place it in the location `config/pact_broker.yml`,
+relative to the working directory of the application, or set the environment
+variable `PACT_BROKER_CONF` to the full path to the configuration file.
+EOM
+
+require "yaml"
 $stream = StringIO.new
 
 def write string
@@ -25,6 +34,7 @@ def in_backticks value
 end
 
 docs_dir = File.expand_path("../../../docs", __FILE__)
+configuration_doc_path = File.join(docs_dir, "CONFIGURATION.md")
 environment_variable_file = File.join(docs_dir, "configuration.yml")
 doc = YAML.load(File.read(environment_variable_file))
 
@@ -42,6 +52,8 @@ write "# Pact Broker Configuration\n\n"
 
 write "\n"
 
+write INTRO
+
 doc["groups"].each do | group |
   write "<br/>\n\n"
   write "## #{group["title"]}\n\n<hr/>\n"
@@ -55,9 +67,17 @@ doc["groups"].each do | group |
     write "### #{name}\n\n"
     write "#{metadata["description"]}\n\n"
 
+    write "**YAML configuration key name:** #{in_backticks(name)}<br/>"
+    write "**Environment variable name:** `PACT_BROKER_#{name.upcase}`<br/>"
+    write "**Supported versions:** #{metadata["supported_versions"]}<br/>" if metadata["supported_versions"]
     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?
+
+    write "**Default:** #{in_backticks(metadata["default_value"])}<br/>" if !metadata["default_value"].nil?
+    write "**Default:** #{metadata["default_description"]}<br/>" if !metadata["default_description"].nil?
+    if metadata["allowed_values_description"]
+      write "**Allowed values:** #{metadata["allowed_values_description"]}<br/>"
+    end
     if metadata["allowed_values"]
       allowed_values = metadata["allowed_values"].collect{ |val| in_backticks(val) }.join(", ")
       write "**Allowed values:** #{allowed_values}<br/>"
@@ -72,7 +92,7 @@ doc["groups"].each do | group |
   end
 end
 
-File.open(File.join(docs_dir, "CONFIGURATION.md"), "w") { |file| file << $stream.string }
+File.open(configuration_doc_path, "w") { |file| file << $stream.string }
 
 required_env_vars = []
 
@@ -84,3 +104,4 @@ end
 
 puts "Required:"
 puts required_env_vars
+puts configuration_doc_path

data/script/generate-erd

@@ -0,0 +1,55 @@
+#! /usr/bin/env ruby
+
+require "sequel"
+Sequel::Model.plugin :subclasses
+
+DATABASE_CREDENTIALS = {
+  adapter: "postgres",
+  database: ENV["DATABASE"] || "postgres",
+  username: ENV["DATABASE_USERNAME"] || "postgres",
+  password: ENV["DATABASE_PASSWORD"] || "postgres",
+  host: "localhost",
+  :encoding => "utf8"
+}
+Sequel.connect(DATABASE_CREDENTIALS)
+
+$LOAD_PATH.unshift "./lib"
+$LOAD_PATH.unshift "./tasks"
+ENV["RACK_ENV"] = "development"
+require "pact_broker/db/models"
+
+def generate_erd_graphviz()
+  associations = []
+  Sequel::Model.descendents.each do |model|
+    next if model.name.nil?
+    model.associations.each do |a|
+      ar = model.association_reflection(a)
+      associations << [model.name, ar[:type], ar.associated_class.name]
+    end
+  end
+  styles = {
+    :many_to_one=>:bold,
+    :one_to_many=>:solid,
+    :many_to_many=>:dashed,
+    :one_to_one=>:dotted
+  }
+
+  graph = "digraph G {\n"
+  graph += associations.uniq.map{|c, t, ac| "  \"#{c}\" -> \"#{ac}\" [style=#{styles[t]}];"}.sort.join("\n")
+  graph += "\n}"
+
+  graph
+end
+
+puts "Usage:"
+puts "generate-erd [erd-filename]"
+puts "CAUTION: Please make sure that you have graphviz installed"
+puts
+
+GRAPHVIZ_FILENAME = ARGV[0] || "erd"
+
+puts "Generating graphviz file ..."
+File.write("#{GRAPHVIZ_FILENAME}.dot", generate_erd_graphviz())
+
+puts "Converting graphviz file to a pdf"
+`dot -Tpdf "#{GRAPHVIZ_FILENAME}.dot" > "#{GRAPHVIZ_FILENAME}.pdf"`

data/spec/features/create_webhook_spec.rb

@@ -6,10 +6,14 @@ describe "Creating a webhook" do
   let(:headers) { {"CONTENT_TYPE" => "application/json"} }
   let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
   let(:webhook_json) { webhook_hash.to_json }
+  let(:provider) { nil }
+  let(:consumer) { nil }
   let(:webhook_hash) do
     {
       description: "trigger build",
       enabled: false,
+      provider: provider,
+      consumer: consumer,
       events: [{
         name: "contract_content_changed"
       }],
@@ -23,7 +27,7 @@ describe "Creating a webhook" do
           a: "body"
         }
       }
-    }
+    }.compact
   end
 
   subject { post(path, webhook_json, headers) }
@@ -64,33 +68,74 @@ describe "Creating a webhook" do
 
   context "for a provider" do
     let(:path) { "/webhooks" }
+    let(:provider) { { name: "Some Provider" } }
 
-    before do
-      webhook_hash[:provider] = { name: "Some Provider" }
-    end
-
-    its(:status) { is_expected.to be 201 }
+    its(:status) { is_expected.to eq 201 }
 
     it "creates a webhook without a consumer" do
       subject
       expect(PactBroker::Webhooks::Webhook.first.provider).to_not be nil
       expect(PactBroker::Webhooks::Webhook.first.consumer).to be nil
     end
+
+    context "with label" do
+      let(:provider) { { label: "my_label" } }
+
+      its(:status) { is_expected.to eq 201 }
+
+      it "creates a webhook without explicit consumer and provider with provider label" do
+        subject
+        expect(PactBroker::Webhooks::Webhook.first.provider).to be nil
+        expect(PactBroker::Webhooks::Webhook.first.consumer).to be nil
+        expect(PactBroker::Webhooks::Webhook.first.provider_label).to eq "my_label"
+      end
+    end
+
+    context "with both label and name" do
+      let(:provider) { { name: "Some Provider", label: "my_label" } }
+
+      its(:status) { is_expected.to eq 400 }
+
+      it "returns the validation errors" do
+        expect(response_body[:errors]).to_not be_empty
+      end
+    end
   end
 
   context "for a consumer" do
     let(:path) { "/webhooks" }
-    before do
-      webhook_hash[:consumer] = { name: "Some Consumer" }
-    end
+    let(:consumer) { { name: "Some Consumer" } }
 
-    its(:status) { is_expected.to be 201 }
+    its(:status) { is_expected.to eq 201 }
 
     it "creates a webhook without a provider" do
       subject
       expect(PactBroker::Webhooks::Webhook.first.consumer).to_not be nil
       expect(PactBroker::Webhooks::Webhook.first.provider).to be nil
     end
+
+    context "with label" do
+      let(:consumer) { { label: "my_label" } }
+
+      its(:status) { is_expected.to eq 201 }
+
+      it "creates a webhook without explicit consumer and provider with consumer label" do
+        subject
+        expect(PactBroker::Webhooks::Webhook.first.provider).to be nil
+        expect(PactBroker::Webhooks::Webhook.first.consumer).to be nil
+        expect(PactBroker::Webhooks::Webhook.first.consumer_label).to eq "my_label"
+      end
+    end
+
+    context "with both label and name" do
+      let(:consumer) { { name: "Some Consumer", label: "my_label" } }
+
+      its(:status) { is_expected.to eq 400 }
+
+      it "returns the validation errors" do
+        expect(response_body[:errors]).to_not be_empty
+      end
+    end
   end
 
   context "with no consumer or provider" do

data/spec/features/get_pact_spec.rb

@@ -6,7 +6,7 @@ describe "retrieving a pact" do
     let(:path) { "/pacts/provider/a%20provider/consumer/a%20consumer/version/1.2.3A" }
 
     before do
-      TestDataBuilder.new.create_pact_with_hierarchy("A Consumer", "1.2.3a", "A Provider").and_return(:pact)
+      td.create_pact_with_hierarchy("A Consumer", "1.2.3a", "A Provider").and_return(:pact)
     end
 
     context "when case sensitivity is turned on" do
@@ -35,8 +35,7 @@ describe "retrieving a pact" do
     let(:path) { "/pacts/provider/a%20provider/consumer/a%20consumer/latest/PROD" }
 
     before do
-      TestDataBuilder.new
-        .create_consumer("A Consumer")
+      td.create_consumer("A Consumer")
         .create_consumer_version("1.2.3")
         .create_consumer_version_tag("prod")
         .create_provider("A Provider")

data/spec/fixtures/verification.json

@@ -3,5 +3,9 @@
   "providerApplicationVersion": "4.5.6",
   "testResults": {
     "some": "results"
+  },
+  "verifiedBy": {
+    "implementation" : "Ruby",
+    "version": "1234"
   }
 }

data/spec/integration/webhooks/pact_publication_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe "triggering a webhook for a pact publication" do
+  before do
+    td.create_global_webhook(event_names: ["contract_published"], body: { "provider_version" => "${pactbroker.providerVersionNumber}"})
+  end
+
+  let(:pact_content) { td.random_json_content("Foo", "Bar") }
+
+  let!(:request) do
+    stub_request(:post, /http/).with(body: expected_webhook_body).to_return(:status => 200)
+  end
+
+  let(:database_connector) { ->(&block) { block.call } }
+
+  subject { put("/pacts/provider/Bar/consumer/Foo/version/2", pact_content, { "CONTENT_TYPE" => "application/json", "pactbroker.database_connector" => database_connector}) }
+
+  context "when there is a verification from the main branch of the provider" do
+    before do
+      td.create_consumer("Foo")
+        .create_provider("Bar", main_branch: "main")
+        .create_consumer_version("1")
+        .create_pact(json_content: pact_content)
+        .create_verification(provider_version: "1", branch: "main")
+        .create_verification(provider_version: "2", branch: "feat/x", number: 2)
+    end
+
+    let(:expected_webhook_body) { { provider_version: "1"}.to_json }
+
+    it "uses that in the webhook" do
+      subject
+      expect(request).to have_been_made
+    end
+  end
+
+  context "when there is not a verification from the main branch of the provider" do
+    before do
+      td.create_consumer("Foo")
+        .create_provider("Bar", main_branch: "main")
+        .create_consumer_version("1")
+        .create_pact(json_content: pact_content)
+        .create_verification(provider_version: "1", branch: "feat/y")
+        .create_verification(provider_version: "2", branch: "feat/x", number: 2)
+    end
+
+    let(:expected_webhook_body) { { provider_version: "2"}.to_json }
+
+    it "uses the latest verification in the webhook" do
+      subject
+      expect(request).to have_been_made
+    end
+  end
+end