pact_broker 2.84.0 → 2.87.0

data/lib/pact_broker/webhooks/webhook_request_logger.rb

@@ -29,15 +29,17 @@ module PactBroker
         @options = options
       end
 
-      def log(uuid, webhook_request, http_response, error, webhook_context)
+      # rubocop: disable Metrics/ParameterLists
+      def log(uuid, webhook_request, http_response, success, error, webhook_context)
         safe_response = http_response ? HttpResponseWithUtf8SafeBody.new(http_response) : nil
         log_webhook_context(webhook_context)
         log_request(webhook_request)
         log_response(uuid, safe_response, webhook_context[:base_url]) if safe_response
         log_error(uuid, error, webhook_context[:base_url]) if error
-        log_completion_message(success?(safe_response))
+        log_completion_message(success)
         log_stream.string
       end
+      # rubocop: enable Metrics/ParameterLists
 
       private
 
@@ -115,16 +117,6 @@ module PactBroker
           execution_logger.error "Error executing webhook #{uuid}. #{response_body_hidden_message(base_url)}"
         end
       end
-
-      def success?(response)
-        if response
-          # Response HTTP Code must be in success list otherwise it is false
-          PactBroker.configuration.webhook_http_code_success.include? response.code.to_i
-        else
-          false
-        end
-      end
-
     end
   end
 end

data/lib/pact_broker/webhooks/webhook_request_template.rb

@@ -21,16 +21,13 @@ module PactBroker
       alias_method :http_method, :method
 
       def initialize attributes = {}
-        @method = attributes[:method]
-        @url = attributes[:url]
-        @username = attributes[:username]
-        @password = attributes[:password]
+        attributes.each do | (name, value) |
+          instance_variable_set("@#{name}", value) if respond_to?(name)
+        end
         @headers = Rack::Utils::HeaderHash.new(attributes[:headers] || {})
-        @body = attributes[:body]
-        @uuid = attributes[:uuid]
       end
 
-      def build(template_params)
+      def build(template_params, user_agent)
         attributes = {
           method: http_method,
           url: build_url(template_params),
@@ -38,7 +35,8 @@ module PactBroker
           username: build_string(username, template_params),
           password: build_string(password, template_params),
           uuid: uuid,
-          body: build_body(template_params)
+          body: build_body(template_params),
+          user_agent: user_agent
         }
         PactBroker::Domain::WebhookRequest.new(attributes)
       end

data/pact_broker.gemspec

@@ -48,6 +48,9 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "roar", "~> 1.1"
   gem.add_runtime_dependency "reform", "~> 2.3.3"
   gem.add_runtime_dependency "dry-validation", "~> 0.10.5"
+  # /usr/local/bundle/gems/dry-validation-0.10.7/lib/dry/validation/schema/class_interface.rb:7:in `<module:Validation>' [dry-configurable] default value as positional argument to settings is deprecated and will be removed in the next major version
+  # Provide a `default:` keyword argument instead
+  gem.add_runtime_dependency "dry-configurable", "0.12.1"
   gem.add_runtime_dependency "sequel", "~> 5.28"
   gem.add_runtime_dependency "webmachine", "1.6.0"
   gem.add_runtime_dependency "semver2", "~> 3.4.2"
@@ -66,4 +69,5 @@ Gem::Specification.new do |gem|
   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"
+  gem.add_runtime_dependency "request_store", "~> 1.5"
 end

data/public/javascripts/index.js

@@ -24,14 +24,15 @@ function createIntegrationDeletionConfirmationText(rowData) {
   }, and all associated data (pacts, verifications, application versions, tags and webhooks) that are not associated with other integrations. Do you wish to continue?`;
 }
 
-function createPactTagDeletionConfirmationText({
+function createPactTagOrBranchDeletionConfirmationText({
   providerName,
   consumerName,
-  pactTagName
+  refName,
+  scope
 }) {
   return `This will delete the pacts for provider ${providerName} and all versions of ${
     consumerName
-  } with tag ${pactTagName}. Do you wish to continue?`;
+  } ${scope} ${refName}. Do you wish to continue?`;
 }
 
 function handleDeletePactsSelected(clickedElement) {
@@ -50,24 +51,26 @@ function handleDeleteIntegrationsSelected(clickedElement) {
   handleDeleteResourcesSelected(tr, tr.data().integrationUrl, confirmationText);
 }
 
-function handleDeleteTagSelected({
+function handleDeleteTagOrBranchSelected({
   providerName,
   consumerName,
-  pactTagName,
-  deletionUrl
+  refName,
+  deletionUrl,
+  scope
 }) {
   return function(clickedElement) {
     const tr = $(clickedElement).closest("tr");
-    const confirmationText = createPactTagDeletionConfirmationText({
+    const confirmationText = createPactTagOrBranchDeletionConfirmationText({
       providerName,
       consumerName,
-      pactTagName
+      refName,
+      scope
     });
     handleDeleteResourcesSelected(
       tr,
       deletionUrl,
       confirmationText,
-      pactTagName
+      refName
     );
   };
 }
@@ -134,53 +137,32 @@ function handleDeleteResourcesSelected(
     rowData.providerName,
     tagName
   );
-  const isRefreshingThePage = !!tagName;
   const cancelled = function() {
-    unHighlightRows(rows);
+    unHighlightRows(row);
   };
   const confirmed = function() {
     deleteResources(
       deletionUrl,
-      function() {
-        handleDeletionSuccess(rows, isRefreshingThePage);
-      },
+      handleDeletionSuccess,
       function(response) {
-        handleDeletionFailure(rows, response);
+        handleDeletionFailure(row, response);
       }
     );
   };
 
-  if (!isRefreshingThePage) {
-    highlightRowsToBeDeleted(rows);
-  }
-  confirmDeleteResources(confirmationText, confirmed, cancelled);
-}
 
-function hideDeletedRows(rows) {
-  rows
-    .children("td, th")
-    .animate({ padding: 0 })
-    .wrapInner("<div />")
-    .children()
-    .slideUp(function() {
-      $(this)
-        .closest("tr")
-        .remove();
-    });
+  highlightRowsToBeDeleted(row);
+
+  confirmDeleteResources(confirmationText, confirmed, cancelled);
 }
 
 function refreshPage() {
   const url = new URL(window.location);
-  url.searchParams.delete("search");
   window.location = url.toString();
 }
 
-function handleDeletionSuccess(rows, isRefreshingThePage) {
-  if (isRefreshingThePage) {
-    return refreshPage();
-  }
-
-  hideDeletedRows(rows);
+function handleDeletionSuccess() {
+  return refreshPage();
 }
 
 function createErrorMessage(responseBody) {
@@ -228,37 +210,62 @@ function deleteResources(url, successCallback, errorCallback) {
 }
 
 function buildMaterialMenuItems(clickedElementData) {
-  const baseOptions = [
-    {
-      type: "normal",
-      text: "Delete pacts ...",
-      click: handleDeletePactsSelected
-    },
-    {
-      type: "normal",
-      text: "Delete integration...",
-      click: handleDeleteIntegrationsSelected
-    }
-  ];
-
-  const taggedPacts = clickedElementData.taggedPacts || [];
   const providerName = clickedElementData.providerName;
   const consumerName = clickedElementData.consumerName;
-  const taggedPactsOptions = taggedPacts.map(taggedPact => {
-    const taggedPactObject = JSON.parse(taggedPact);
-    const pactTagName = taggedPactObject.tag;
-    const taggedPactUrl = taggedPactObject.deletionUrl;
-    return {
-      type: "normal",
-      text: `Delete pacts for ${pactTagName}...`,
-      click: handleDeleteTagSelected({
-        providerName,
-        consumerName,
-        pactTagName,
-        deletionUrl: taggedPactUrl
-      })
-    };
-  });
 
-  return [...baseOptions, ...taggedPactsOptions];
+  const branchOptions = (clickedElementData.pactBranches || []).map(branch => {
+      const refName = branch.name;
+      const deletionUrl = branch.deletionUrl;
+      return {
+        type: "normal",
+        text: `Delete pacts from branch ${refName}...`,
+        click: handleDeleteTagOrBranchSelected({
+          providerName,
+          consumerName,
+          refName,
+          deletionUrl: deletionUrl,
+          scope: "for branch"
+        })
+      };
+    });
+
+  const tagOptions = (clickedElementData.pactTags || []).map(tag => {
+    const refName = tag.name;
+    const deletionUrl = tag.deletionUrl;
+      return {
+        type: "normal",
+        text: `Delete pacts for tag ${refName}...`,
+        click: handleDeleteTagOrBranchSelected({
+          providerName,
+          consumerName,
+          refName,
+          deletionUrl,
+          scope: "with tag"
+        })
+      };
+    });
+
+
+  if (clickedElementData.view === "branch") {
+    return branchOptions;
+  } else if (clickedElementData.view === "tag") {
+    return tagOptions;
+  } else if (clickedElementData.view === "all") {
+    return [...branchOptions, ...tagOptions];
+  } else if (clickedElementData.index) {
+    return [
+      {
+        type: "normal",
+        text: "Delete pacts ...",
+        click: handleDeletePactsSelected
+      },
+      {
+        type: "normal",
+        text: "Delete integration...",
+        click: handleDeleteIntegrationsSelected
+      }
+    ];
+  } else {
+    return []
+  }
 }

data/public/javascripts/pact.js

@@ -8,20 +8,20 @@ $(document).ready(function() {
       position: "overlay",
       animationSpeed: 1,
       items: [
-        // {
-        //   type: "normal",
-        //   text: "View in API Browser",
-        //   click: function(openMenuElement) {
-        //     window.location.href = openMenuElement.data().apiBrowserUrl;
-        //   }
-        // },
-        // {
-        //   type: "normal",
-        //   text: "View Matrix",
-        //   click: function(openMenuElement) {
-        //     window.location.href = openMenuElement.data().matrixUrl;
-        //   }
-        // },
+        {
+          type: "normal",
+          text: "View in API Browser",
+          click: function(openMenuElement) {
+            window.location.href = openMenuElement.data().apiBrowserUrl;
+          }
+        },
+        {
+          type: "normal",
+          text: "View Matrix",
+          click: function(openMenuElement) {
+            window.location.href = openMenuElement.data().matrixUrl;
+          }
+        },
         {
           type: "normal",
           text: "Delete ...",

data/public/stylesheets/index.css

@@ -233,12 +233,16 @@ span.copy-success-icon {
   height: 16px;
 }
 
-.field {
+.search-field {
   margin-top: 15px;
   margin-bottom: 15px;
 }
 
 div.top-of-group {
   margin-top: 20px;
-  margin-bottom: 20px;
+}
+
+
+div[data-toggle="tooltip"] {
+  cursor: pointer;
 }

data/public/stylesheets/pact.css

@@ -1,4 +1,5 @@
 div.pact-metadata {
+  margin-top: 40px;
   float: right;
 }
 
@@ -41,3 +42,13 @@ span.kebab-horizontal {
 span.more-options {
   float: right;
 }
+
+/* same as .page-header */
+h1 {
+  padding-bottom: 2rem;
+  margin: 40px 0 20px;
+}
+
+h3 {
+  margin-top: 2rem;
+}

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

@@ -11,6 +11,9 @@ begin
     .create_pacticipant("AutoDetectTestProvider")
     .create_tagged_pacticipant_version(pacticipant: "AutoDetectTestProvider", version: "1", tag: "main")
     .deploy_to_prod(pacticipant: "AutoDetectTestProvider", version: "1")
+    .publish_pact(consumer: "AutoDetectTestConsumer", provider: "AutoDetectTestProvider", consumer_version: "1", tag: "feat/x", content_id: "2111")
+    .publish_pact(consumer: "AutoDetectTestConsumer", provider: "AutoDetectTestProvider", consumer_version: "2", tag: "feat/y", content_id: "21asdfd")
+    .deploy_to_prod(pacticipant: "AutoDetectTestConsumer", version: "1")
 
 rescue StandardError => e
   puts "#{e.class} #{e.message}"

data/script/data/branches.rb

@@ -11,7 +11,7 @@ begin
     .publish_contract(consumer: "branch-consumer", provider: "branch-provider", consumer_version: "1", content_id: "1111", branch: "main")
     .publish_contract(consumer: "branch-consumer", provider: "branch-provider", consumer_version: "1", content_id: "1111", branch: "feat/x")
     .publish_contract(consumer: "branch-consumer", provider: "branch-provider", consumer_version: "2", content_id: "1111", branch: "feat/x")
-    .get_pacts_for_verification(provider: "branch-provider")
+    .get_pacts_for_verification(provider: "branch-provider", enable_pending: false)
     .verify_pact(
       provider_version_branch: "main",
       provider_version: "1",
@@ -25,7 +25,7 @@ begin
     .verify_pact(
       provider_version_branch: "feat/y",
       provider_version: "2",
-      success: true
+      success: false
     )
 
 rescue StandardError => e

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

@@ -14,7 +14,6 @@ begin
     .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")

data/script/data/pending.rb

@@ -0,0 +1,26 @@
+#!/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-demo-provider")
+    .delete_pacticipant("some-demo-consumer")
+    .publish_contract(consumer: "some-demo-consumer", provider: "some-demo-provider", consumer_version: "1", content_id: "1111", branch: "main")
+    .publish_contract(consumer: "some-demo-consumer", provider: "some-demo-provider", consumer_version: "1", content_id: "1111", branch: "feat/x")
+    .publish_contract(consumer: "some-demo-consumer", provider: "some-demo-provider", consumer_version: "2", content_id: "1111", branch: "feat/x")
+    .get_pacts_for_verification(provider: "some-demo-provider")
+    .verify_pact(
+      provider_version_branch: "main",
+      provider_version: "1",
+      success: false
+    )
+
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+end

data/script/data/tags.rb

@@ -0,0 +1,35 @@
+#!/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("tag-provider")
+    .delete_pacticipant("tag-consumer")
+    .publish_contract(consumer: "tag-consumer", provider: "tag-provider", consumer_version: "1", content_id: "1111", tag: "main")
+    .publish_contract(consumer: "tag-consumer", provider: "tag-provider", consumer_version: "1", content_id: "1111", tag: "feat/x")
+    .publish_contract(consumer: "tag-consumer", provider: "tag-provider", consumer_version: "2", content_id: "1111", tag: "feat/x")
+    .get_pacts_for_verification(provider: "tag-provider", consumer_version_selectors: [{ tag: "main", latest: true }])
+    .verify_pact(
+      provider_version_tag: "main",
+      provider_version: "1",
+      success: true
+    )
+    .verify_pact(
+      provider_version_tag: "feat/y",
+      provider_version: "1",
+      success: true
+    )
+    .verify_pact(
+      provider_version_tag: "feat/y",
+      provider_version: "2",
+      success: true
+    )
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+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/data/webhook.rb

@@ -0,0 +1,22 @@
+#!/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_webhook(uuid: "7a5da39c-8e50-4cc9-ae16-dfa5be043e8c")
+    .create_global_webhook_for_contract_changed(uuid: "7a5da39c-8e50-4cc9-ae16-dfa5be043e8c")
+    .delete_pacticipant("foo-consumer")
+    .delete_pacticipant("bar-provider")
+    .create_pacticipant("foo-consumer")
+    .create_pacticipant("bar-provider")
+    .publish_pact(consumer: "foo-consumer", consumer_version: "1", provider: "bar-provider", content_id: "111", tag: "main")
+
+
+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"`