pact_broker 2.100.0 → 2.101.0

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

@@ -15,6 +15,7 @@ module PactBroker
   module Api
     module Resources
       class InvalidJsonError < PactBroker::Error ; end
+      class NonUTF8CharacterFound < PactBroker::Error ; end
 
       class BaseResource < Webmachine::Resource
         include PactBroker::Services
@@ -39,6 +40,10 @@ module PactBroker
           super + ["PATCH"]
         end
 
+        def malformed_request?
+          content_type_is_json_but_invalid_json_provided?
+        end
+
         def finish_request
           application_context.after_resource&.call(self)
           PactBroker.configuration.after_resource.call(self)
@@ -125,17 +130,32 @@ module PactBroker
           else
             @params_with_string_keys ||= JSON.parse(request_body, { symbolize_names: false }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
           end
-        rescue JSON::JSONError => e
-          raise InvalidJsonError.new("Error parsing JSON - #{e.message}")
+        rescue StandardError => e
+          fragment = fragment_before_invalid_utf_8_char
+
+          if fragment
+            raise NonUTF8CharacterFound.new(message("errors.non_utf_8_char_in_request_body", char_number: fragment.length + 1, fragment: fragment))
+          else
+            raise InvalidJsonError.new(e.message)
+          end
         end
         # rubocop: enable Metrics/CyclomaticComplexity
 
+        def fragment_before_invalid_utf_8_char
+          request_body.each_char.with_index do | char, index |
+            if !char.valid_encoding?
+              return index < 100 ? request_body[0...index] : request_body[index-100...index]
+            end
+          end
+          nil
+        end
+
         def params_with_string_keys
           params(symbolize_names: false)
         end
 
         def pact_params
-          @pact_params ||= PactBroker::Pacts::PactParams.from_request request, identifier_from_path
+          @pact_params ||= PactBroker::Pacts::PactParams.from_request(request, identifier_from_path)
         end
 
         def set_json_error_message message
@@ -192,9 +212,15 @@ module PactBroker
           begin
             params
             false
+          rescue NonUTF8CharacterFound => e
+            logger.info(e.message) # Don't use the default SemanticLogger error logging method because it will try and print out the cause which will contain non UTF-8 chars in the message
+            set_json_error_message(e.message)
+            response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
+            true
           rescue StandardError => e
-            logger.info "Error parsing JSON #{e} - #{request_body}"
-            set_json_error_message "Error parsing JSON - #{e.message}"
+            message = "#{e.cause ? e.cause.class.name : e.class.name} - #{e.message}"
+            logger.info(message)
+            set_json_error_message(message)
             response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
             true
           end
@@ -279,6 +305,26 @@ module PactBroker
         def malformed_request_for_json_with_schema?(schema_to_use = schema, params_to_validate = params)
           invalid_json? || validation_errors_for_schema?(schema_to_use, params_to_validate)
         end
+
+        def content_type_is_json_but_invalid_json_provided?
+          content_type_json? && any_request_body? && invalid_json?
+        end
+
+        def content_type_json?
+          request.content_type&.include?("json")
+        end
+
+        # Not a Webmachine method. This is used by security policy code to identify whether
+        # a PUT to a non existing resource can create a new object.
+        def put_can_create?
+          false
+        end
+
+        # Not a Webmachine method. This is used by security policy code to identify whether
+        # a PATCH to a non existing resource can create a new object.
+        def patch_can_create?
+          false
+        end
       end
     end
   end

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

@@ -14,7 +14,11 @@ module PactBroker
         end
 
         def allowed_methods
-          ["GET", "PUT", "OPTIONS"]
+          ["GET", "PUT", "DELETE", "OPTIONS"]
+        end
+
+        def put_can_create?
+          true
         end
 
         def resource_exists?
@@ -25,6 +29,11 @@ module PactBroker
           decorator_class(:branch_version_decorator).new(branch_version).to_json(decorator_options)
         end
 
+        def delete_resource
+          branch_service.delete_branch_version(branch_version)
+          true
+        end
+
         def from_json
           already_existed = !!branch_version
           @branch_version = branch_service.find_or_create_branch_version(identifier_from_path)

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

@@ -2,14 +2,12 @@ require "pact_broker/api/resources/base_resource"
 require "pact_broker/db/clean"
 require "pact_broker/matrix/unresolved_selector"
 
+# Not exposed yet as we'd need to support administrator auth first
+
 module PactBroker
   module Api
     module Resources
       class Clean < BaseResource
-        def content_types_accepted
-          [["application/json"]]
-        end
-
         def content_types_provided
           [["application/hal+json"]]
         end
@@ -19,12 +17,16 @@ module PactBroker
         end
 
         def process_post
-          keep_selectors = (params[:keep] || []).collect do | hash |
-            PactBroker::Matrix::UnresolvedSelector.new(hash)
-          end
+          if content_type_json?
+            keep_selectors = (params[:keep] || []).collect do | hash |
+              PactBroker::Matrix::UnresolvedSelector.new(hash)
+            end
 
-          result = PactBroker::DB::Clean.call(Sequel::Model.db, { keep: keep_selectors })
-          response.body = result.to_json
+            result = PactBroker::DB::Clean.call(Sequel::Model.db, { keep: keep_selectors })
+            response.body = result.to_json
+          else
+            415
+          end
         end
 
         def policy_name

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

@@ -8,10 +8,6 @@ module PactBroker
       class CurrentlyDeployedVersionsForEnvironment < BaseResource
         using PactBroker::StringRefinements
 
-        def content_types_accepted
-          [["application/json", :from_json]]
-        end
-
         def content_types_provided
           [["application/hal+json", :to_json]]
         end

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

@@ -8,10 +8,6 @@ module PactBroker
       class CurrentlySupportedVersionsForEnvironment < BaseResource
         using PactBroker::StringRefinements
 
-        def content_types_accepted
-          [["application/json", :from_json]]
-        end
-
         def content_types_provided
           [["application/hal+json", :to_json]]
         end

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

@@ -8,11 +8,6 @@ module PactBroker
       class DeployedVersion < BaseResource
         include PactBroker::Messages
 
-        def initialize
-          super
-          @currently_deployed_param = params(default: {})[:currentlyDeployed]
-        end
-
         def content_types_provided
           [
             ["application/hal+json", :to_json]
@@ -29,16 +24,12 @@ module PactBroker
           ["GET", "PATCH", "OPTIONS"]
         end
 
-        def resource_exists?
-          !!deployed_version
+        def patch_can_create?
+          false
         end
 
-        def malformed_request?
-          if request.patch?
-            return invalid_json?
-          else
-            false
-          end
+        def resource_exists?
+          !!deployed_version
         end
 
         def to_json
@@ -73,7 +64,14 @@ module PactBroker
 
         private
 
-        attr_reader :currently_deployed_param
+        # can't use ||= with a potentially nil value
+        def currently_deployed_param
+          if defined?(@currently_deployed_param)
+            @currently_deployed_param
+          else
+            @currently_deployed_param = params(default: {})[:currentlyDeployed]
+          end
+        end
 
         def process_currently_deployed_param
           if currently_deployed_param == false

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

@@ -43,6 +43,10 @@ module PactBroker
           :'versions::deployed_versions'
         end
 
+        def policy_record
+          environment
+        end
+
         private
 
         attr_reader :deployed_version, :existing_deployed_version

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

@@ -17,16 +17,16 @@ module PactBroker
           ["GET", "PUT", "DELETE", "OPTIONS"]
         end
 
+        def put_can_create?
+          false
+        end
+
         def resource_exists?
           !!environment
         end
 
         def malformed_request?
-          if request.put? && environment
-            invalid_json? || validation_errors_for_schema?(schema, params.merge(uuid: uuid))
-          else
-            false
-          end
+          super || (request.put? && environment && validation_errors_for_schema?(schema, params.merge(uuid: uuid)))
         end
 
         def from_json

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

@@ -27,11 +27,7 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
-            invalid_json? || validation_errors_for_schema?(schema, params.merge(uuid: uuid))
-          else
-            false
-          end
+          super || (request.post? && validation_errors_for_schema?(schema, params.merge(uuid: uuid)))
         end
 
         def create_path

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

@@ -17,6 +17,10 @@ module PactBroker
           ["GET", "PUT", "DELETE", "OPTIONS"]
         end
 
+        def put_can_create?
+          true
+        end
+
         def from_json
           unless label
             @label = label_service.create(identifier_from_path)

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

@@ -36,18 +36,23 @@ module PactBroker
           ["GET", "PUT", "DELETE", "PATCH", "OPTIONS"]
         end
 
+        def put_can_create?
+          true
+        end
+
+        def patch_can_create?
+          true
+        end
+
         def is_conflict?
           merge_conflict = request.patch? && resource_exists? && Pacts::Merger.conflict?(pact.json_content, pact_params.json_content)
 
           potential_duplicate_pacticipants?(pact_params.pacticipant_names) || merge_conflict || disallowed_modification?
         end
 
+
         def malformed_request?
-          if request.patch? || request.put?
-            invalid_json? || contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params), pact_params)
-          else
-            false
-          end
+          super || ((request.patch? || request.really_put?) && contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params), pact_params))
         end
 
         def resource_exists?

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

@@ -25,10 +25,7 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
-            return invalid_json? || validation_errors?(webhook)
-          end
-          false
+          super || (request.post? && validation_errors?(webhook))
         end
 
         def validation_errors? webhook

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

@@ -21,18 +21,23 @@ module PactBroker
           ["GET", "PUT", "PATCH", "DELETE", "OPTIONS"]
         end
 
+        def put_can_create?
+          false
+        end
+
+        def patch_can_create?
+          true
+        end
+
         def known_methods
           super + ["PATCH"]
         end
 
         def malformed_request?
-          if request.patch? || request.put?
-            invalid_json? || validation_errors_for_schema?
-          else
-            false
-          end
+          super || ((request.patch? || request.really_put?) && validation_errors_for_schema?)
         end
 
+        # PUT or PATCH with content-type application/json
         def from_json
           if pacticipant
             @pacticipant = update_existing_pacticipant
@@ -47,6 +52,7 @@ module PactBroker
           response.body = to_json
         end
 
+        # PUT or PATCH with content-type application/merge-patch+json
         def from_merge_patch_json
           if request.patch?
             from_json

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

@@ -27,10 +27,7 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
-            return invalid_json? || webhook_validation_errors?(webhook)
-          end
-          false
+          super || (request.post? && webhook_validation_errors?(webhook))
         end
 
         def create_path

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

@@ -23,10 +23,7 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
-            return invalid_json? || validation_errors_for_schema?
-          end
-          false
+          super || (request.post? && validation_errors_for_schema?)
         end
 
         def post_is_create?

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

@@ -11,28 +11,27 @@ module PactBroker
       class ProviderPactsForVerification < ProviderPacts
         using PactBroker::HashRefinements
 
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
         def allowed_methods
           ["GET", "POST", "OPTIONS"]
         end
 
-        def content_types_accepted
-          [["application/json"]]
+        def malformed_request?
+          super || ((request.get? || (request.post? && content_type_json?)) && schema_validation_errors?)
         end
 
-        def malformed_request?
-          if (errors = query_schema.call(query)).any?
-            set_json_validation_error_messages(errors)
+        def process_post
+          if content_type_json?
+            response.body = to_json
             true
           else
-            false
+            415
           end
         end
 
-        def process_post
-          response.body = to_json
-          true
-        end
-
         def read_methods
           super + %w{POST}
         end
@@ -96,6 +95,15 @@ module PactBroker
         def nested_query
           @nested_query ||= Rack::Utils.parse_nested_query(request.uri.query)
         end
+
+        def schema_validation_errors?
+          if (errors = query_schema.call(query)).any?
+            set_json_validation_error_messages(errors)
+            true
+          else
+            false
+          end
+        end
       end
     end
   end

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

@@ -11,11 +11,7 @@ module PactBroker
         include WebhookExecutionMethods
 
         def content_types_provided
-          [["application/hal+json", :to_json]]
-        end
-
-        def content_types_accepted
-          [["application/json"]]
+          [["application/hal+json"]]
         end
 
         def allowed_methods
@@ -23,20 +19,20 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
-            invalid_json? || validation_errors_for_schema?
-          else
-            false
-          end
+          super || (request.post? && content_type_json? && validation_errors_for_schema?)
         end
 
         def process_post
-          if conflict_notices.any?
-            set_conflict_response
-            409
+          if content_type_json?
+            if conflict_notices.any?
+              set_conflict_response
+              409
+            else
+              publish_contracts
+              true
+            end
           else
-            publish_contracts
-            true
+            415
           end
         end
 

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

@@ -8,11 +8,6 @@ module PactBroker
       class ReleasedVersion < BaseResource
         include PactBroker::Messages
 
-        def initialize
-          super
-          @currently_supported_param = params(default: {})[:currentlySupported]
-        end
-
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
@@ -27,6 +22,10 @@ module PactBroker
           ["GET", "PATCH", "OPTIONS"]
         end
 
+        def patch_can_create?
+          false
+        end
+
         def resource_exists?
           !!released_version
         end
@@ -63,7 +62,14 @@ module PactBroker
 
         private
 
-        attr_reader :currently_supported_param
+        # can't use ||= with a potentially nil value
+        def currently_supported_param
+          if defined?(@currently_deployed_param)
+            @currently_supported_param
+          else
+            @currently_supported_param = params(default: {})[:currentlySupported]
+          end
+        end
 
         def process_currently_supported_param
           if currently_supported_param == false

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

@@ -5,11 +5,6 @@ module PactBroker
   module Api
     module Resources
       class ReleasedVersionsForVersionAndEnvironment < BaseResource
-        def initialize
-          super
-          @existing_released_version = version && environment && released_version_service.find_released_version_for_version_and_environment(version, environment)
-        end
-
         def content_types_accepted
           [["application/json", :from_json]]
         end
@@ -35,6 +30,7 @@ module PactBroker
         end
 
         def from_json
+          existing_released_version # make sure we have this before we update the database
           @released_version = released_version_service.create_or_update(next_released_version_uuid, version, environment)
           response.body = decorator_class(:released_version_decorator).new(released_version).to_json(decorator_options)
           true
@@ -61,7 +57,15 @@ module PactBroker
 
         private
 
-        attr_reader :released_version, :existing_released_version
+        attr_reader :released_version
+
+        def existing_released_version
+          if defined?(@existing_released_version)
+            @existing_released_version
+          else
+            @existing_released_version = version && environment && released_version_service.find_released_version_for_version_and_environment(version, environment)
+          end
+        end
 
         def version
           @version ||= version_service.find_by_pacticipant_name_and_number(identifier_from_path)

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

@@ -17,9 +17,13 @@ module PactBroker
           ["GET","PUT","DELETE", "OPTIONS"]
         end
 
+        def put_can_create?
+          true
+        end
+
         def from_json
           unless tag
-            @tag = tag_service.create identifier_from_path
+            @tag = tag_service.create(identifier_from_path)
             # Make it return a 201 by setting the Location header
             response.headers["Location"] = tag_url(base_url, tag)
           end
@@ -36,11 +40,11 @@ module PactBroker
         end
 
         def tag
-          @tag ||= tag_service.find identifier_from_path
+          @tag ||= tag_service.find(identifier_from_path)
         end
 
         def delete_resource
-          tag_service.delete identifier_from_path
+          tag_service.delete(identifier_from_path)
           true
         end
 

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

@@ -34,15 +34,7 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.post?
-            return true if invalid_json?
-            errors = verification_service.errors(params)
-            if !errors.empty?
-              set_json_validation_error_messages(errors.messages)
-              return true
-            end
-          end
-          false
+          super || (request.post? && any_validation_errors?)
         end
 
         def create_path
@@ -91,6 +83,12 @@ module PactBroker
         def verification_params
           params(symbolize_names: false).merge("wip" => wip?, "pending" => pending?)
         end
+
+        def any_validation_errors?
+          errors = verification_service.errors(params)
+          set_json_validation_error_messages(errors.messages) if !errors.empty?
+          !errors.empty?
+        end
       end
     end
   end

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

@@ -21,16 +21,16 @@ module PactBroker
           ["GET", "PUT", "PATCH", "DELETE", "OPTIONS"]
         end
 
-        def resource_exists?
-          !!version
+        def put_can_create?
+          true
         end
 
-        def malformed_request?
-          if request.put? && any_request_body?
-            invalid_json?
-          else
-            false
-          end
+        def patch_can_create?
+          true
+        end
+
+        def resource_exists?
+          !!version
         end
 
         def from_json