pact_broker 2.84.0 → 2.85.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d104329cabc691c2ec288acee11837621c8970181a6dddf7d4bf7e4c5d3f48fe
-  data.tar.gz: d7c5c2a75605aa5f947495670d995d5d5500f487dff86ae676da3bd883c55510
+  metadata.gz: 78ca6573c59b514f1527988079ebeecc19f3fc33b66c7abe7fc9bf00b099c7a1
+  data.tar.gz: 742f05a5b5348b22aa1efd10dfe2068d76d1259182cfd533442beec8c06e764f
 SHA512:
-  metadata.gz: 7a973402c0c004acd5f94cc0c04efec0ded2039f43dfd3e2ca7ba014b853f958345b2ada02c05af05748416dbe466596920d8112c34efd71a5533c212ab6002c
-  data.tar.gz: 9bf006fa32ad47353df1bb9704a8da05205de57da618273ca0c0cb3b487c570951caa1e0ab3624177aa82a12c329d63aeba11c07c87b1eaa1e368956edd72250
+  metadata.gz: af16f324d2022596b678ff7c53e1ab4bcae836e12cf376fd415e581fda38e874fbf33094a21bf04c6c8545c534edd78d181326e34d7865898c52bb1915df4d14
+  data.tar.gz: 1c33d08f629c7db7f2ef12589c0982a5e78a1896c24d400467e26bca8389912ecc305d67ca6ea174132ff8e7c03b67b0d4f3d14a241e3355e79e612cb8cb04c5

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+<a name="v2.85.0"></a>
+### v2.85.0 (2021-09-13)
+
+#### Features
+
+* show in the UI whether or not a pact was pending when verification failed	 ([326c068e](/../../commit/326c068e))
+* thread safe configuration overrides (#500)	 ([50900231](/../../commit/50900231))
+* allow dashboard pacts to be viewed by branch, tag, environment or all	 ([1ec8fc82](/../../commit/1ec8fc82))
+* support deleting pacts by branch in the UI	 ([bc8fef1d](/../../commit/bc8fef1d))
+* update UI	 ([0ba5eda3](/../../commit/0ba5eda3))
+
 <a name="v2.84.0"></a>
 ### v2.84.0 (2021-09-10)
 

data/db/migrations/20210913_add_pending_to_verifications.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:verifications) do
+      add_column(:pact_pending, TrueClass)
+    end
+  end
+end

data/lib/pact/doc/markdown/consumer_contract_renderer.rb

@@ -24,7 +24,7 @@ module Pact
         attr_reader :consumer_contract
 
         def title
-          "### A pact between #{consumer_name} and #{provider_name}\n\n"
+          "# A pact between #{consumer_name} and #{provider_name}\n\n"
         end
 
         def interaction_renderers
@@ -32,11 +32,11 @@ module Pact
         end
 
         def summaries_title
-          "#### Requests from #{consumer_name} to #{provider_name}\n\n"
+          "### Requests from #{consumer_name} to #{provider_name}\n\n"
         end
 
         def interactions_title
-          "#### Interactions\n\n"
+          "### Interactions\n\n"
         end
 
         def summaries

data/lib/pact_broker/api/decorators/reason_decorator.rb

@@ -45,9 +45,9 @@ module PactBroker
           when PactBroker::Matrix::IgnoreSelectorDoesNotExist
             "WARN: Cannot ignore #{reason.selector.description}"
           when PactBroker::Matrix::SelectorWithoutPacticipantVersionNumberSpecified
-            "WARN: For production use of can-i-deploy, it is recommended to specify the version number (rather than latest tag or branch) of each pacticipant to avoid race conditions."
+            "WARN: It is recommended to specify the version number (rather than the tag or branch) of the pacticipant you wish to deploy to avoid race conditions. Without a version number, this result will not be reliable."
           when PactBroker::Matrix::NoEnvironmentSpecified
-            "WARN: For production use of can-i-deploy, it is recommended to specify the environment into which you are deploying. Without the environment, this result will not be reliable."
+            "WARN: It is recommended to specify the environment into which you are deploying. Without the environment, this result will not be reliable."
           else
             reason
           end

data/lib/pact_broker/api/decorators/verification_summary_decorator.rb

@@ -6,9 +6,9 @@ require "ostruct"
 module PactBroker
   module Api
     module Decorators
-
       class VerificationSummaryDecorator < BaseDecorator
 
+        # TODO count pending failures?
         property :success
         property :provider_summary, as: :providerSummary do
           property :successful
@@ -30,7 +30,6 @@ module PactBroker
             successful: represented.select(&:success).collect(&:provider_name),
             failed: represented.select{|verification| !verification.success }.collect(&:provider_name))
         end
-
       end
     end
   end

data/lib/pact_broker/api/middleware/configuration.rb

@@ -0,0 +1,33 @@
+require "pact_broker/logging"
+
+module PactBroker
+  module Api
+    module Middleware
+      class Configuration
+        include PactBroker::Logging
+
+        def initialize(app, configuration)
+          @app = app
+          @configuration = configuration
+        end
+
+        def call(env)
+          if (overrides = env["pactbroker.configuration_overrides"])&.any?
+            dupped_configuration = configuration.dup
+            dupped_configuration.override_runtime_configuration!(overrides)
+            dupped_configuration.freeze
+            PactBroker.set_configuration(dupped_configuration)
+            app.call(env)
+          else
+            PactBroker.set_configuration(configuration)
+            app.call(env)
+          end
+        end
+
+        private
+
+        attr_reader :app, :configuration
+      end
+    end
+  end
+end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -115,6 +115,10 @@ module PactBroker
         "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/tag/#{url_encode(tag)}"
       end
 
+      def pact_versions_for_branch_url consumer_name, provider_name, branch_name, base_url = ""
+        "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/branch/#{url_encode(branch_name)}"
+      end
+
       def integration_url consumer_name, provider_name, base_url = ""
         "#{base_url}/integrations/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
       end
@@ -311,7 +315,7 @@ module PactBroker
       end
 
       def group_url(pacticipant_name, base_url = "")
-        "#{base_url}/groups/#{url_encode(pacticipant_name)}"
+        "#{base_url}/pacticipants/#{url_encode(pacticipant_name)}"
       end
 
       def environments_url(base_url = "")

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -29,7 +29,7 @@ module PactBroker
           "<html>
             <head>#{head}</head>
             <body>
-              #{pact_metadata}#{html}
+              #{breadcrumbs}#{pact_metadata}#{html}
             </body>
           </html>"
         end
@@ -39,10 +39,10 @@ module PactBroker
         def head
           "<title>#{title}</title>
           <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/github.css'>
-          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/pact.css'>
           <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/github-json.css'>
           <link rel='stylesheet' type='text/css' href='#{base_url}/css/bootstrap.min.css'>
           <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/material-menu.css'>
+          <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/pact.css'>
           <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/jquery-confirm.min.css'>
           <script src='#{base_url}/javascripts/highlight.pack.js'></script>
           <script src='#{base_url}/javascripts/jquery-3.5.1.min.js'></script>
@@ -53,6 +53,17 @@ module PactBroker
           <script>hljs.initHighlightingOnLoad();</script>"
         end
 
+        def breadcrumbs
+          "
+          <nav aria-label=\"breadcrumb\">
+            <ol class=\"breadcrumb\" style=\"margin:0; margin-bottom:1rem\">
+              <li class=\"breadcrumb-item\" style=\"margin:0;\"><a href=\"#{base_url}/\">Home</a></li>
+              <li class=\"breadcrumb-item active\" aria-current=\"page\" style=\"margin:0;\">Pact</li>
+            </ol>
+          </nav>
+          "
+        end
+
         def pact_metadata
           "<div class='pact-metadata'>
             <ul>
@@ -66,19 +77,12 @@ module PactBroker
                 <span class='name' title='#{published_date}'>Date published:</span>
                 <span class='value' title='#{published_date}'>#{published_date_in_words}</span>
               </li>
-              <li>
-                <a href=\"#{json_url}\">View in API Browser</a>
-              </li>
-              <li>
-                <a href=\"#{matrix_url}\">View Matrix</a>
-              </li>
-              <li>
-                <a href=\"#{base_url}/\">Home</a>
-              </li>
               <li>
                 <span data-consumer-name=\"#{consumer_name}\"
                       data-provider-name=\"#{provider_name}\"
                       data-consumer-version-number=\"#{consumer_version_number}\"
+                      data-api-browser-url=\"#{json_url}\"
+                      data-matrix-url=\"#{matrix_url}\"
                       data-pact-url=\"#{pact_url}\"
                       class='more-options kebab-horizontal'
                       aria-hidden='true'></span>

data/lib/pact_broker/api/resources/pact_versions_for_branch.rb

@@ -0,0 +1,40 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/configuration"
+require "pact_broker/api/decorators/tagged_pact_versions_decorator"
+require "pact_broker/api/resources/pact_resource_methods"
+
+module PactBroker
+  module Api
+    module Resources
+      class PactVersionsForBranch < BaseResource
+        include PactResourceMethods
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["DELETE", "OPTIONS"]
+        end
+
+        def resource_exists?
+          consumer && provider
+        end
+
+        def delete_resource
+          pact_service.delete_all_pact_publications_between consumer_name, and: provider_name, branch_name: identifier_from_path[:branch_name]
+          set_post_deletion_response
+          true
+        end
+
+        def policy_name
+          :'pacts::pacts'
+        end
+
+        def policy_pacticipant
+          consumer
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/resources/verifications.rb

@@ -84,12 +84,16 @@ module PactBroker
           metadata[:wip] == "true"
         end
 
+        def pending?
+          metadata[:pending]
+        end
+
         def event_context
           metadata
         end
 
         def verification_params
-          params(symbolize_names: false).merge("wip" => wip?)
+          params(symbolize_names: false).merge("wip" => wip?, "pending" => pending?)
         end
       end
     end

data/lib/pact_broker/api.rb

@@ -32,6 +32,7 @@ module PactBroker
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "versions"], Api::Resources::PactVersions, {resource_name: "pact_publications"}
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "versions", :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publication", deprecated: true} # Not the standard URL, but keep for backwards compatibility
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "tag", :tag], Api::Resources::TaggedPactVersions, {resource_name: "tagged_pact_publications"}
+        add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "branch", :branch_name], Api::Resources::PactVersionsForBranch, {resource_name: "pact_publications_for_branch"}
 
         # Pacts
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "version", :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publication"}

data/lib/pact_broker/app.rb

@@ -25,6 +25,7 @@ require "rack/pact_broker/reset_thread_data"
 require "rack/pact_broker/add_vary_header"
 require "rack/pact_broker/use_when"
 require "sucker_punch"
+require "pact_broker/api/middleware/configuration"
 require "pact_broker/api/middleware/basic_auth"
 require "pact_broker/config/basic_auth_configuration"
 require "pact_broker/api/authorization/resource_access_policy"
@@ -51,6 +52,7 @@ module PactBroker
       load_configuration_from_database
       seed_example_data
       print_startup_message
+      @configuration.freeze
     end
 
     # Allows middleware to be inserted at the bottom of the shared middlware stack

data/lib/pact_broker/badges/service.rb

@@ -87,6 +87,7 @@ module PactBroker
         case pseudo_branch_verification_status
           when :success then "verified"
           when :failed then "failed"
+          when :failed_pending then "failed (pending)"
           when :stale then "changed"
           else "unknown"
         end
@@ -96,6 +97,7 @@ module PactBroker
         case pseudo_branch_verification_status
           when :success then "brightgreen"
           when :failed then "red"
+          when :failed_pending then "red"
           when :stale then "orange"
           else "lightgrey"
         end
@@ -151,7 +153,7 @@ module PactBroker
       def static_svg pact, pseudo_branch_verification_status
         file_name = case pseudo_branch_verification_status
                     when :success then "pact-verified-brightgreen.svg"
-                    when :failed then "pact-failed-red.svg"
+                    when :failed, :failed_pending then "pact-failed-red.svg"
                     when :stale then "pact-changed-orange.svg"
                     else "pact-unknown-lightgrey.svg"
                     end

data/lib/pact_broker/configuration.rb

@@ -4,10 +4,15 @@ require "semantic_logger"
 require "forwardable"
 require "pact_broker/config/runtime_configuration"
 require "anyway/auto_cast"
+require "request_store"
 
 module PactBroker
   def self.configuration
-    @@configuration ||= Configuration.default_configuration
+    RequestStore.store[:pact_broker_configuration] ||= Configuration.default_configuration
+  end
+
+  def self.set_configuration(configuration)
+    RequestStore.store[:pact_broker_configuration] = configuration
   end
 
   def self.with_runtime_configuration_overrides(overrides, &block)
@@ -16,7 +21,7 @@ module PactBroker
 
   # @private, for testing only
   def self.reset_configuration
-    @@configuration = Configuration.default_configuration
+    RequestStore.store[:pact_broker_configuration] = Configuration.default_configuration
   end
 
   class Configuration
@@ -83,12 +88,36 @@ module PactBroker
 
     def with_runtime_configuration_overrides(overrides)
       original_runtime_configuration = runtime_configuration
-      self.runtime_configuration = override_runtime_configuration(overrides, original_runtime_configuration.dup)
+      self.runtime_configuration = override_runtime_configuration!(overrides)
       yield
     ensure
       self.runtime_configuration = original_runtime_configuration
     end
 
+    def override_runtime_configuration!(overrides)
+      new_runtime_configuration = runtime_configuration.dup
+      valid_overrides = {}
+      invalid_overrides = {}
+
+      overrides.each do | key, value |
+        if new_runtime_configuration.respond_to?("#{key}=")
+          valid_overrides[key] = Anyway::AutoCast.call(value)
+        else
+          invalid_overrides[key] = Anyway::AutoCast.call(value)
+        end
+      end
+
+      if logger.debug?
+        logger.debug("Overridding runtime configuration", payload: { overrides: valid_overrides, ignoring: invalid_overrides })
+      end
+
+      valid_overrides.each do | key, value |
+        new_runtime_configuration.public_send("#{key}=", value)
+      end
+
+      self.runtime_configuration = new_runtime_configuration
+    end
+
     def logger_from_runtime_configuration
       @logger_from_runtime_configuration ||= begin
         runtime_configuration.validate_logging_attributes!
@@ -193,7 +222,7 @@ module PactBroker
     end
 
     def show_webhook_response?
-      webhook_host_whitelist.any?
+      webhook_host_whitelist&.any?
     end
 
     def enable_badge_resources= enable_badge_resources
@@ -206,30 +235,5 @@ module PactBroker
       require "pact_broker/config/load"
       PactBroker::Config::Load.call(runtime_configuration)
     end
-
-    private
-
-    def override_runtime_configuration(overrides, new_runtime_configuration)
-      valid_overrides = {}
-      invalid_overrides = {}
-
-      overrides.each do | key, value |
-        if new_runtime_configuration.respond_to?("#{key}=")
-          valid_overrides[key] = Anyway::AutoCast.call(value)
-        else
-          invalid_overrides[key] = Anyway::AutoCast.call(value)
-        end
-      end
-
-      if logger.debug?
-        logger.debug("Overridding runtime configuration", payload: { overrides: valid_overrides, ignoring: invalid_overrides })
-      end
-
-      valid_overrides.each do | key, value |
-        new_runtime_configuration.public_send("#{key}=", value)
-      end
-
-      new_runtime_configuration
-    end
   end
 end

data/lib/pact_broker/domain/verification.rb

@@ -206,6 +206,15 @@ module PactBroker
         @pact_content_with_test_results = PactBroker::Pacts::Content.from_json(pact_version.content).with_test_results(test_results)
       end
 
+      # Whether the pact content was pending at the time the verification was run
+      def pact_pending?
+        pact_pending
+      end
+
+      def failed_and_pact_pending?
+        !success && pact_pending
+      end
+
       # So consumer_version_tag_name can be accessed by method name
       def method_missing(m, *args, &block)
         if values.key?(m) && args.size == 0

data/lib/pact_broker/domain/webhook.rb

@@ -50,17 +50,12 @@ module PactBroker
       def execute pact, verification, event_context, options
         logger.info "Executing #{self} event_context=#{event_context}"
         template_params = template_parameters(pact, verification, event_context, options)
-        webhook_request = request.build(template_params)
+        webhook_request = request.build(template_params, options.fetch(:user_agent))
         http_response, error = execute_request(webhook_request)
-
-        logs = generate_logs(webhook_request, http_response, error, event_context, options.fetch(:logging_options))
+        success = success?(http_response, options)
         http_request = webhook_request.http_request
-        PactBroker::Webhooks::WebhookExecutionResult.new(
-          http_request,
-          http_response,
-          logs,
-          error
-        )
+        logs = generate_logs(webhook_request, http_response, success, error, event_context, options.fetch(:logging_options))
+        result(http_request, http_response, success, logs, error)
       end
 
       def to_s
@@ -116,16 +111,33 @@ module PactBroker
         PactBroker::Webhooks::PactAndVerificationParameters.new(pact, verification, event_context).to_hash
       end
 
-      def generate_logs(webhook_request, http_response, error, event_context, logging_options)
+      def success?(http_response, options)
+        !http_response.nil? && options.fetch(:http_success_codes).include?(http_response.code.to_i)
+      end
+
+      # rubocop: disable Metrics/ParameterLists
+      def generate_logs(webhook_request, http_response, success, error, event_context, logging_options)
         webhook_request_logger = PactBroker::Webhooks::WebhookRequestLogger.new(logging_options)
         webhook_request_logger.log(
           uuid,
           webhook_request,
           http_response,
+          success,
           error,
           event_context
         )
       end
+      # robocop: enable Metrics/ParameterLists
+
+      def result(http_request, http_response, success, logs, error)
+        PactBroker::Webhooks::WebhookExecutionResult.new(
+          http_request,
+          http_response,
+          success,
+          logs,
+          error
+        )
+      end
     end
   end
 end