pact_broker 2.100.0 → 2.101.0

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

@@ -22,15 +22,16 @@ module PactBroker
           ["GET", "PUT", "DELETE", "OPTIONS"]
         end
 
+        def put_can_create?
+          true
+        end
+
         def resource_exists?
           !!webhook
         end
 
         def malformed_request?
-          if request.put?
-            return invalid_json? || webhook_validation_errors?(parsed_webhook, uuid)
-          end
-          false
+          super || (request.put? && webhook_validation_errors?(parsed_webhook, uuid))
         end
 
         def from_json

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

@@ -13,10 +13,6 @@ module PactBroker
         include WebhookResourceMethods
         include WebhookExecutionMethods
 
-        def content_types_accepted
-          [["application/json"]]
-        end
-
         def content_types_provided
           [["application/hal+json"]]
         end
@@ -37,14 +33,16 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
+          if super
+            true
+          elsif request.post?
             if uuid
               false
             else
               webhook_validation_errors?(webhook)
             end
           else
-            super
+            false
           end
         end
 

data/lib/pact_broker/doc/views/index/pacticipant-branch-version.markdown

@@ -1,14 +1,25 @@
 # Pacticipant branch version
 
-Allowed methods: `GET`, `PUT`
+Allowed methods: `GET`, `PUT`, `DELETE`
 
 Path: `/pacticipants/{pacticipant}/branches/{branch}/versions/{version}`
 
 Get or add/create a pacticipant version for a branch.
 
-## Example
+## Create
+
+### Example
 
 Add a version to a branch. The pacticipant and branch are automatically created if they do not exist.
 
     curl -XPUT http://broker/pacticipants/Bar/branches/main/versions/1e70030c6579915e5ff56b107a0fd25cf5df7464 \
           -H "Content-Type: application/json" -d "{}"
+
+
+## Delete
+
+Removes a pacticipant version from a branch. Does not delete the actual pacticipant version.
+
+Send a `DELETE` request to the branch version resource.
+
+    curl -XDELETE http://broker/pacticipants/Bar/branches/main/versions/1e70030c6579915e5ff56b107a0fd25cf5df7464

data/lib/pact_broker/doc/views/provider-pacts-for-verification.markdown

@@ -48,7 +48,7 @@ Example: This data structure represents the way a user might specify "I want to
 
 `consumerVersionSelectors.tag`: the tag name(s) of the consumer versions to get the pacts for. *This field is still supported but it is recommended to use the `branch` in preference now.*
 
-`consumerVersionSelectors.fallbackTag`: the name of the tag to fallback to if the specified `tag` does not exist. This is useful when the consumer and provider use matching branch names to coordinate the development of new features. *This field is still supported but it is recommended to use the `fallbackBranch` in preference now.*
+`consumerVersionSelectors.fallbackTag`: the name of the tag to fallback to if the specified `tag` does not exist. This is useful when the consumer and provider use matching branch names to coordinate the development of new features. *This field is still supported but it is recommended to use two separate selectors - one with the main branch name and one with the feature branch name.*
 
 `providerVersionBranch`: the repository branch name for the provider application version that will be published with the verification results. This is used by the Broker to determine whether or not a particular pact is in pending state or not.
 

data/lib/pact_broker/domain/pacticipant.rb

@@ -44,6 +44,7 @@ module PactBroker
       using PactBroker::StringRefinements
 
       plugin :insert_ignore, identifying_columns: [:name]
+      plugin :upsert, identifying_columns: [:name]
       plugin :timestamps, update_on_create: true
 
       set_primary_key :id

data/lib/pact_broker/locale/en.yml

@@ -107,6 +107,7 @@ en:
         To disable this check, set `check_for_potential_duplicate_pacticipant_names` to false in the configuration.
       new_line_in_url_path: URL path cannot contain a new line character.
       tab_in_url_path: URL path cannot contain a tab character.
+      non_utf_8_char_in_request_body: "Request body has a non UTF-8 character at char %{char_number} and cannot be parsed as JSON. Fragment preceding invalid character is: '%{fragment}'"
 
       "400":
         title: 400 Malformed Request

data/lib/pact_broker/pacticipants/repository.rb

@@ -59,22 +59,23 @@ module PactBroker
           repository_name: params[:repository_name],
           repository_namespace: params[:repository_namespace],
           main_branch: params[:main_branch]
-        ).insert_ignore
+        ).insert_ignore.refresh
       end
 
       def update(pacticipant_name, pacticipant)
         pacticipant.name = pacticipant_name
-        pacticipant.save
+        pacticipant.save.refresh
       end
 
-      def replace(_pacticipant_name, open_struct_pacticipant)
+      def replace(pacticipant_name, open_struct_pacticipant)
         PactBroker::Domain::Pacticipant.new(
+          name: pacticipant_name,
           display_name: open_struct_pacticipant.display_name,
           repository_url: open_struct_pacticipant.repository_url,
           repository_name: open_struct_pacticipant.repository_name,
           repository_namespace: open_struct_pacticipant.repository_namespace,
           main_branch: open_struct_pacticipant.main_branch
-        ).save
+        ).upsert
       end
 
       def delete(pacticipant)

data/lib/pact_broker/pacts/generate_sha.rb

@@ -7,6 +7,7 @@ require "pact_broker/pacts/content"
 module PactBroker
   module Pacts
     class GenerateSha
+      # @param [String] json_content
       def self.call json_content, _options = {}
         content_for_sha = if PactBroker.configuration.base_equality_only_on_content_that_affects_verification_results
                             extract_verifiable_content_for_sha(json_content)

data/lib/pact_broker/pacts/verifiable_pact_messages.rb

@@ -31,7 +31,7 @@ module PactBroker
         version_text = head_consumer_tags.size == 1 || branches.size == 1 ? "version" : "versions"
         if wip?
           # WIP pacts will always have tags, because it is part of the definition of being a WIP pact
-          "The pact at #{pact_version_url} is being verified because it is a 'work in progress' pact (ie. it is the pact for the latest #{version_text} of #{consumer_name} #{joined_head_consumer_tags_and_branches} and it has not yet been successfully verified by #{pending_provider_branch_or_tags_description("a")} when the pact's application version was explicitly specified in the consumer version selectors). #{READ_MORE_WIP}".tap { |it| puts it }
+          "The pact at #{pact_version_url} is being verified because it is a 'work in progress' pact (ie. it is the pact for the latest #{version_text} of #{consumer_name} #{joined_head_consumer_tags_and_branches} and it has not yet been successfully verified by #{pending_provider_branch_or_tags_description("a")} when the pact's application version was explicitly specified in the consumer version selectors). #{READ_MORE_WIP}"
         else
           criteria_or_criterion = selectors.size > 1 ? "criteria" : "criterion"
           version_or_versions = pluralize("the consumer version", selectors.size)

data/lib/pact_broker/test/test_data_builder.rb

@@ -572,6 +572,26 @@ module PactBroker
          }.to_json
       end
 
+      def fixed_json_content(consumer_name, provider_name, differentiator)
+        {
+          "consumer" => {
+             "name" => consumer_name
+           },
+           "provider" => {
+             "name" => provider_name
+           },
+           "interactions" => [{
+              "request" => {
+                "method" => "GET",
+                "path" => "/things/#{differentiator}"
+              },
+              "response" => {
+                "status" => 200
+              }
+           }],
+         }.to_json
+      end
+
       private
 
       def create_pacticipant_version(version_number, pacticipant, params = {})

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.100.0"
+  VERSION = "2.101.0"
 end

data/lib/pact_broker/versions/branch_service.rb

@@ -1,12 +1,19 @@
 require "pact_broker/logging"
 require "pact_broker/repositories"
 require "pact_broker/messages"
+require "forwardable"
 
 module PactBroker
   module Versions
     class BranchService
       extend PactBroker::Repositories
 
+      class << self
+        extend Forwardable
+        delegate [:delete_branch_version] => :branch_version_repository
+      end
+
+
       def self.find_branch_version(pacticipant_name:, branch_name:, version_number:, **)
         BranchVersion.where(
           version: PactBroker::Domain::Version.where_pacticipant_name_and_version_number(pacticipant_name, version_number),

data/lib/pact_broker/versions/branch_version_repository.rb

@@ -16,6 +16,23 @@ module PactBroker
         branch_version
       end
 
+      # Deletes a branch version - that is, removes a version from a branch.
+      # Updates the branch head if the deleted branch version was the latest for the branch.
+      #
+      # @param [PactBroker::Versions::BranchVersion] the branch version to delete
+      def delete_branch_version(branch_version)
+        latest = branch_version.latest?
+        branch = branch_version.latest? ? branch_version.branch : nil
+        deleted = branch_version.delete
+        if latest
+          new_head_branch_version = BranchVersion.find_latest_for_branch(branch)
+          if new_head_branch_version
+            PactBroker::Versions::BranchHead.new(branch: branch, branch_version: new_head_branch_version).upsert
+          end
+        end
+        deleted
+      end
+
       private
 
       def find_or_create_branch(pacticipant, branch_name)

data/lib/rack/pact_broker/cascade.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# This is a modified version of the Rack::Cascade class from https://github.com/rack/rack/blob/2833813/lib/rack/cascade.rb
+# that short circuts the cascade if a response body is provided for a 404/403 response.
+# This is to allow the UI and API to be in a cascade, but allows the UI
+# to return a 404 page when the route matches, but there is no domain object found.
+# If we don't do this, then the 404 from the UI causes an API response to be returned.
+
+
+# This does not work. Do not use it. Have not yet worked out why.
+
+module Rack
+  # Rack::Cascade tries a request on several apps, and returns the
+  # first response that is not 404 or 405 (or in a list of configured
+  # status codes).  If all applications tried return one of the configured
+  # status codes, return the last response.
+
+  module PactBroker
+    class Cascade
+      # deprecated, no longer used
+      NotFound = [404, { CONTENT_TYPE => "text/plain" }, []]
+
+      # An array of applications to try in order.
+      attr_reader :apps
+
+      # Set the apps to send requests to, and what statuses result in
+      # cascading.  Arguments:
+      #
+      # apps: An enumerable of rack applications.
+      # cascade_for: The statuses to use cascading for.  If a response is received
+      #              from an app, the next app is tried.
+      def initialize(apps, cascade_for = [404, 405])
+        @apps = []
+        apps.each { |app| add app }
+
+        @cascade_for = {}
+        [*cascade_for].each { |status| @cascade_for[status] = true }
+      end
+
+      # Call each app in order.  If the responses uses a status that requires
+      # cascading, try the next app.  If all responses require cascading,
+      # return the response from the last app.
+      def call(env)
+        return [404, { CONTENT_TYPE => "text/plain" }, []] if @apps.empty?
+        result = nil
+        last_body = nil
+
+        @apps.each_with_index do |app, i|
+          # The SPEC says that the body must be closed after it has been iterated
+          # by the server, or if it is replaced by a middleware action. Cascade
+          # replaces the body each time a cascade happens. It is assumed that nil
+          # does not respond to close, otherwise the previous application body
+          # will be closed. The final application body will not be closed, as it
+          # will be passed to the server as a result.
+          last_body.close if last_body.respond_to? :close
+          result = app.call(env)
+
+          puts result.last
+
+          # If it is a 404/403 AND the response body is empty, then try the next app
+          if @cascade_for.include?(result[0].to_i) && result[2].respond_to?(:empty?) && result[2].empty?
+            last_body = result[2]
+          else
+            puts "returned from #{i} of #{@apps.size}"
+            # otherwise, return the result
+            return result
+          end
+        end
+
+        result
+      end
+
+      # Append an app to the list of apps to cascade.  This app will
+      # be tried last.
+      def add(app)
+        @apps << app
+      end
+
+      # Whether the given app is one of the apps to cascade to.
+      def include?(app)
+        @apps.include?(app)
+      end
+
+      alias_method :<<, :add
+    end
+  end
+end

data/lib/webmachine/describe_routes.rb

@@ -5,6 +5,7 @@ module Webmachine
 
     Route = Struct.new(
         :path,
+        :path_spec,
         :resource_class,
         :resource_name,
         :resource_class_location,
@@ -23,6 +24,38 @@ module Webmachine
       def path_include?(component)
         path.include?(component)
       end
+
+      def route_param_names
+        path_spec.select { | component | component.is_a?(Symbol) }
+      end
+
+      # Creates a Webmachine Resource for the given route for use in tests.
+      # @param [Hash] env the rack env from which to build the request
+      # @param [PactBroker::ApplicationContext] application_context the application context
+      # @param [Hash] path_param_values concrete parameter values from which to construct the path
+      # @return [Webmachine::Resource] the webmachine resource for the request
+      def build_resource(env, application_context, path_param_values)
+        path = "/" + path_spec.collect{ | part | part.is_a?(Symbol) ? (path_param_values[part] || "missing-param") : part }.join("/")
+
+        path_params = route_param_names.each_with_object({}){ | name, new_params | new_params[name] = path_param_values[name] }
+        path_info = {
+          application_context: application_context,
+          resource_name: resource_name
+        }.merge(path_params)
+
+        rack_req = ::Rack::Request.new({ "REQUEST_METHOD" => "GET", "rack.input" => StringIO.new("") }.merge(env) )
+        dummy_request = Webmachine::Adapters::Rack::RackRequest.new(
+          rack_req.env["REQUEST_METHOD"],
+          path,
+          Webmachine::Headers.from_cgi({"HTTP_HOST" => "example.org"}.merge(env)),
+          Webmachine::Adapters::Rack::RequestBody.new(rack_req),
+          {},
+          {},
+          rack_req.env
+        )
+        dummy_request.path_info = path_info
+        resource_class.new(dummy_request, Webmachine::Response.new)
+      end
     end
 
     def self.call(webmachine_applications, search_term: nil)
@@ -36,24 +69,25 @@ module Webmachine
     end
 
     def self.paths_to_resource_class_mappings(webmachine_application)
-      webmachine_application.routes.collect do | route |
-        resource_path_absolute = Pathname.new(source_location_for(route.resource))
+      webmachine_application.routes.collect do | webmachine_route |
+        resource_path_absolute = Pathname.new(source_location_for(webmachine_route.resource))
         Route.new({
-          path: "/" + route.path_spec.collect{ |part| part.is_a?(Symbol) ? ":#{part}" : part  }.join("/"),
-          resource_class: route.resource,
-          resource_name: route.instance_variable_get(:@bindings)[:resource_name],
+          path: "/" + webmachine_route.path_spec.collect{ |part| part.is_a?(Symbol) ? ":#{part}" : part  }.join("/"),
+          path_spec: webmachine_route.path_spec,
+          resource_class: webmachine_route.resource,
+          resource_name: webmachine_route.instance_variable_get(:@bindings)[:resource_name],
           resource_class_location: resource_path_absolute.relative_path_from(Pathname.pwd).to_s
-        }.merge(info_from_resource_instance(route)))
-      end
+        }.merge(info_from_resource_instance(webmachine_route)))
+      end.reject{ | route | route.resource_class == Webmachine::Trace::TraceResource }
     end
 
-    def self.info_from_resource_instance(route)
+    def self.info_from_resource_instance(webmachine_route)
       with_no_logging do
         path_info = { application_context: OpenStruct.new, pacticipant_name: "foo", pacticipant_version_number: "1", resource_name: "foo" }
         path_info.default = "1"
         dummy_request = Webmachine::Adapters::Rack::RackRequest.new("GET", "/", Webmachine::Headers["host" => "example.org"], nil, {}, {}, { "REQUEST_METHOD" => "GET" })
         dummy_request.path_info = path_info
-        dummy_resource = route.resource.new(dummy_request, Webmachine::Response.new)
+        dummy_resource = webmachine_route.resource.new(dummy_request, Webmachine::Response.new)
         if dummy_resource
           {
             allowed_methods: dummy_resource.allowed_methods,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.100.0
+  version: 2.101.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -586,6 +586,7 @@ files:
 - db/migrations/20220303_increase_consumer_version_selector_hashes_column_size.rb
 - db/migrations/migration_helper.rb
 - docs/CONFIGURATION.md
+- docs/api/PACTICIPANTS.md
 - docs/api/WEBHOOKS.md
 - lib/db.rb
 - lib/pact/doc/README.md
@@ -705,7 +706,6 @@ files:
 - lib/pact_broker/api/resources/currently_deployed_versions_for_environment.rb
 - lib/pact_broker/api/resources/currently_supported_versions_for_environment.rb
 - lib/pact_broker/api/resources/dashboard.rb
-- lib/pact_broker/api/resources/default_base_resource.rb
 - lib/pact_broker/api/resources/deployed_version.rb
 - lib/pact_broker/api/resources/deployed_versions_for_version_and_environment.rb
 - lib/pact_broker/api/resources/environment.rb
@@ -1076,6 +1076,7 @@ files:
 - lib/rack/hal_browser/redirect.rb
 - lib/rack/pact_broker/add_pact_broker_version_header.rb
 - lib/rack/pact_broker/add_vary_header.rb
+- lib/rack/pact_broker/cascade.rb
 - lib/rack/pact_broker/configurable_make_it_later.rb
 - lib/rack/pact_broker/convert_404_to_hal.rb
 - lib/rack/pact_broker/convert_file_extension_to_accept_header.rb
@@ -1222,7 +1223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: See description