pact_broker 2.99.0 → 2.102.0

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/matrix_for_consumer_and_provider.rb

@@ -23,6 +23,16 @@ module PactBroker
           consumer && provider
         end
 
+        def malformed_request?
+          error_messages = matrix_service.validate_options(options)
+          if error_messages.any?
+            set_json_validation_error_messages error_messages
+            true
+          else
+            false
+          end
+        end
+
         def to_json
           decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
         end

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

@@ -36,18 +36,27 @@ module PactBroker
           ["GET", "PUT", "DELETE", "PATCH", "OPTIONS"]
         end
 
+        def request_body_required?
+          request.put? || request.patch?
+        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?) && any_request_body? && 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_resource_methods.rb

@@ -1,7 +1,6 @@
 module PactBroker
   module Api
     module Resources
-
       module PacticipantResourceMethods
 
         def potential_duplicate_pacticipants? pacticipant_names

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

@@ -2,7 +2,7 @@ require "pact_broker/api/resources/base_resource"
 require "pact_broker/api/decorators/pacticipant_decorator"
 require "pact_broker/domain/pacticipant"
 require "pact_broker/hash_refinements"
-require "pact_broker/api/contracts/pacticipant_schema"
+require "pact_broker/api/contracts/pacticipant_create_schema"
 
 module PactBroker
   module Api
@@ -23,10 +23,11 @@ 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 request_body_required?
+          request.post?
         end
 
         def post_is_create?
@@ -65,7 +66,7 @@ module PactBroker
         private
 
         def schema
-          PactBroker::Api::Contracts::PacticipantSchema
+          PactBroker::Api::Contracts::PacticipantCreateSchema
         end
 
         def pacticipants

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
 
@@ -100,7 +96,7 @@ module PactBroker
         end
 
         def conflict_notices
-          @conflict_notices ||= contract_service.conflict_notices(parsed_contracts)
+          @conflict_notices ||= contract_service.conflict_notices(parsed_contracts, base_url: base_url)
         end
 
         def base64_decode(content)

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
@@ -48,16 +47,29 @@ module PactBroker
         end
 
         def policy_name
-          :'versions::version'
+          :'versions::released_version'
+        end
+
+        def policy_record_context
+          {
+            pacticipant: released_version&.pacticipant
+          }
         end
 
         def policy_record
-          released_version&.version
+          released_version&.environment
         end
 
         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
@@ -45,7 +41,7 @@ module PactBroker
         end
 
         def policy_name
-          :'versions::released_version'
+          :'versions::released_versions'
         end
 
         def policy_record
@@ -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

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

@@ -85,7 +85,7 @@ module PactBroker
         use_first_tag_as_branch_time_limit: 10,
         auto_detect_main_branch: true,
         main_branch_candidates: ["develop", "main", "master"],
-        allow_dangerous_contract_modification: true,
+        allow_dangerous_contract_modification: false,
         semver_formats: ["%M.%m.%p%s%d", "%M.%m", "%M"],
         seed_example_data: true,
         features: []

data/lib/pact_broker/contracts/contract_to_publish.rb

@@ -14,6 +14,10 @@ module PactBroker
       def merge?
         on_conflict == "merge"
       end
+
+      def pacticipant_names
+        [consumer_name, provider_name]
+      end
     end
   end
 end

data/lib/pact_broker/contracts/contracts_to_publish.rb

@@ -6,6 +6,10 @@ module PactBroker
         new(pacticipant_name, pacticipant_version_number, tags, branch, build_url, contracts)
       end
       # rubocop: enable Metrics/ParameterLists
+
+      def pacticipant_names
+        contracts.flat_map(&:pacticipant_names).uniq
+      end
     end
   end
 end

data/lib/pact_broker/contracts/service.rb

@@ -43,19 +43,26 @@ module PactBroker
         )
       end
 
-      def conflict_notices(parsed_contracts)
+      def conflict_notices(parsed_contracts, base_url: )
         notices = []
+        add_pact_conflict_notices(notices, parsed_contracts)
+        add_pacticipant_conflict_notices(notices, parsed_contracts, base_url)
+        notices
+      end
+
+      def add_pact_conflict_notices(notices, parsed_contracts)
         parsed_contracts.contracts.collect do | contract_to_publish |
           pact_params = create_pact_params(parsed_contracts, contract_to_publish)
           existing_pact = pact_service.find_pact(pact_params)
           if existing_pact && pact_service.disallowed_modification?(existing_pact, contract_to_publish.decoded_content)
-            add_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_pact.json_content, contract_to_publish.decoded_content)
+            add_pact_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_pact.json_content, contract_to_publish.decoded_content)
           end
         end
-        notices
       end
 
-      def add_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_json_content, new_json_content)
+      private :add_pact_conflict_notices
+
+      def add_pact_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_json_content, new_json_content)
         message_params = {
           consumer_name: contract_to_publish.provider_name,
           consumer_version_number: parsed_contracts.pacticipant_version_number,
@@ -65,7 +72,18 @@ module PactBroker
         notices << Notice.info(PactBroker::Pacts::CreateFormattedDiff.call(new_json_content, existing_json_content))
       end
 
-      private :add_conflict_notice
+      private :add_pact_conflict_notice
+
+      def add_pacticipant_conflict_notices(notices, parsed_contracts, base_url)
+        if PactBroker.configuration.check_for_potential_duplicate_pacticipant_names
+          duplicate_pacticipant_messages = pacticipant_service.messages_for_potential_duplicate_pacticipants(parsed_contracts.pacticipant_names, base_url)
+          duplicate_pacticipant_messages.each do | message_text |
+            notices << Notice.error(message_text)
+          end
+        end
+      end
+
+      private :add_pacticipant_conflict_notices
 
       def create_version(parsed_contracts)
         version_params = {

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