RubyGems - pact_broker - Versions diffs - 2.82.0 → 2.85.1 - Mend

pact_broker 2.82.0 → 2.85.1

Files changed (221) hide show

data/lib/pact_broker/api/pact_broker_urls.rb CHANGED Viewed

@@ -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
@@ -199,10 +203,18 @@ module PactBroker
         "#{tags_url(base_url, tag.version)}/#{url_encode(tag.name)}"
       end
+      def branch_version_url(branch_version, base_url = "")
+        "#{pacticipant_url(base_url, branch_version.pacticipant)}/branches/#{url_encode(branch_version.branch_name)}/versions/#{url_encode(branch_version.version_number)}"
+      end
       def templated_tag_url_for_pacticipant pacticipant_name, base_url = ""
         pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/versions/{version}/tags/{tag}"
       end
+      def templated_branch_version_url_for_pacticipant pacticipant_name, base_url = ""
+        pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/branches/{branch}/versions/{version}"
+      end
       def templated_version_url_for_pacticipant pacticipant_name, base_url = ""
         pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/versions/{version}"
       end
@@ -303,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 CHANGED Viewed

@@ -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/branch_version.rb ADDED Viewed

@@ -0,0 +1,48 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/decorators/branch_version_decorator"
+module PactBroker
+  module Api
+    module Resources
+      class BranchVersion < BaseResource
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+        def content_types_accepted
+          [["application/json", :from_json]]
+        end
+        def allowed_methods
+          ["GET", "PUT", "OPTIONS"]
+        end
+        def resource_exists?
+          !!branch_version
+        end
+        def to_json
+          decorator_class(:branch_version_decorator).new(branch_version).to_json(decorator_options)
+        end
+        def from_json
+          already_existed = !!branch_version
+          @branch_version = branch_service.find_or_create_branch_version(identifier_from_path)
+          # Make it return a 201 by setting the Location header
+          response.headers["Location"] = branch_version_url(branch_version, base_url) unless already_existed
+          response.body = to_json
+        end
+        def policy_name
+          :'versions::branch_version'
+        end
+        private
+        def branch_version
+          @branch_version ||= branch_service.find_branch_version(identifier_from_path)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/resources/index.rb CHANGED Viewed

@@ -116,6 +116,12 @@ module PactBroker
               title: "Get, create or delete a tag for a pacticipant version",
               templated: true
             },
+            "pb:pacticipant-branch-version" =>
+            {
+              href: base_url + "/pacticipants/{pacticipant}/branches/{branch}/versions/{version}",
+              title: "Get or add/create a pacticipant version for a branch",
+              templated: true
+            },
             "pb:pacticipant-version" =>
             {
               href: base_url + "/pacticipants/{pacticipant}/versions/{version}",

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

@@ -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/provider_pacts_for_verification.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 require "pact_broker/api/resources/provider_pacts"
 require "pact_broker/api/decorators/verifiable_pacts_decorator"
-require "pact_broker/api/contracts/verifiable_pacts_query_schema"
-require "pact_broker/api/decorators/verifiable_pacts_query_decorator"
-require "pact_broker/api/contracts/verifiable_pacts_json_query_schema"
+require "pact_broker/api/contracts/pacts_for_verification_query_string_schema"
+require "pact_broker/api/decorators/pacts_for_verification_query_decorator"
+require "pact_broker/api/contracts/pacts_for_verification_json_query_schema"
 require "pact_broker/hash_refinements"
 module PactBroker
@@ -69,14 +69,14 @@ module PactBroker
         def query_schema
           if request.get?
-            PactBroker::Api::Contracts::VerifiablePactsQuerySchema
+            PactBroker::Api::Contracts::PactsForVerificationQueryStringSchema
           else
-            PactBroker::Api::Contracts::VerifiablePactsJSONQuerySchema
+            PactBroker::Api::Contracts::PactsForVerificationJSONQuerySchema
           end
         end
         def parsed_query_params
-          @parsed_query_params ||= decorator_class(:verifiable_pacts_query_decorator).new(OpenStruct.new).from_hash(query)
+          @parsed_query_params ||= decorator_class(:pacts_for_verification_query_decorator).new(OpenStruct.new).from_hash(query)
         end
         def query

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

@@ -51,7 +51,8 @@ module PactBroker
         def from_json
           handle_webhook_events do
-            verification = verification_service.create(next_verification_number, verification_params, pact, event_context)
+            verified_pacts = pact_service.find_for_verification_publication(pact_params, event_context[:consumer_version_selectors])
+            verification = verification_service.create(next_verification_number, verification_params, verified_pacts, event_context)
             response.body = decorator_for(verification).to_json(decorator_options)
           end
           true
@@ -83,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/resources/version.rb CHANGED Viewed

@@ -21,14 +21,6 @@ module PactBroker
           ["GET", "PUT", "PATCH", "DELETE", "OPTIONS"]
         end
-        def is_conflict?
-          if (errors = version_service.conflict_errors(version, parsed_version, resource_url)).any?
-            set_json_validation_error_messages(errors)
-          else
-            false
-          end
-        end
         def resource_exists?
           !!version
         end

data/lib/pact_broker/api.rb CHANGED Viewed

@@ -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"}
@@ -87,6 +88,7 @@ module PactBroker
         add ["pacticipants", :pacticipant_name, "latest-version"], Api::Resources::LatestVersion, {resource_name: "latest_pacticipant_version"}
         add ["pacticipants", :pacticipant_name, "versions", :pacticipant_version_number, "tags", :tag_name], Api::Resources::Tag, {resource_name: "pacticipant_version_tag"}
         add ["pacticipants", :pacticipant_name, "labels", :label_name], Api::Resources::Label, {resource_name: "pacticipant_label"}
+        add ["pacticipants", :pacticipant_name, "branches", :branch_name, "versions", :version_number], Api::Resources::BranchVersion, { resource_name: "branch_version" }
         # Webhooks
         add ["webhooks", "provider", :provider_name, "consumer", :consumer_name ], Api::Resources::PacticipantWebhooks, {resource_name: "pacticipant_webhooks"}

data/lib/pact_broker/app.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/config/runtime_configuration.rb CHANGED Viewed

@@ -8,6 +8,18 @@ require "pact_broker/string_refinements"
 require "pact_broker/hash_refinements"
 require "pact_broker/error"
+module Anyway
+  module Tracing
+    class << self
+      # Override this method so that we get the real caller location, not the forwardable one from
+      # the `extend Forwardable` in the PactBroker::Configuration class.
+      def current_trace_source
+        source_stack.last || accessor_source(caller_locations(2, 2).find { | location | !location.path.end_with?("forwardable.rb") })
+      end
+    end
+  end
+end
 module PactBroker
   module Config
     class RuntimeConfiguration < Anyway::Config

data/lib/pact_broker/configuration.rb CHANGED Viewed

@@ -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