pact_broker 2.79.1 → 2.80.0

data/lib/pact_broker/api/contracts/put_pact_params_contract.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/contracts/base_contract'
+require "pact_broker/api/contracts/base_contract"
 
 module PactBroker
   module Api

data/lib/pact_broker/api/contracts/request_validations.rb

@@ -1,5 +1,5 @@
-require 'net/http'
-require 'uri'
+require "net/http"
+require "uri"
 
 module PactBroker
   module Api

data/lib/pact_broker/api/contracts/verifiable_pacts_json_query_schema.rb

@@ -1,14 +1,17 @@
-require 'dry-validation'
-require 'pact_broker/hash_refinements'
-require 'pact_broker/string_refinements'
-require 'pact_broker/api/contracts/dry_validation_workarounds'
-require 'pact_broker/api/contracts/dry_validation_predicates'
+require "dry-validation"
+require "pact_broker/hash_refinements"
+require "pact_broker/string_refinements"
+require "pact_broker/api/contracts/dry_validation_workarounds"
+require "pact_broker/api/contracts/dry_validation_predicates"
+require "pact_broker/messages"
 
 module PactBroker
   module Api
     module Contracts
       class VerifiablePactsJSONQuerySchema
         extend DryValidationWorkarounds
+        extend PactBroker::Messages
+
         using PactBroker::HashRefinements
         using PactBroker::StringRefinements
 
@@ -27,9 +30,14 @@ module PactBroker
               # end
 
               optional(:tag).filled(:str?)
+              optional(:branch).filled(:str?)
               optional(:latest).filled(included_in?: [true, false])
               optional(:fallbackTag).filled(:str?)
+              optional(:fallbackBranch).filled(:str?)
               optional(:consumer).filled(:str?, :not_blank?)
+              optional(:deployed).filled(included_in?: [true])
+              optional(:released).filled(included_in?: [true])
+              optional(:environment).filled(:str?)
 
               # rule(fallbackTagMustBeForLatest: [:fallbackTag, :latest]) do | fallback_tag, latest |
               #   fallback_tag.filled?.then(latest.eql?(true))
@@ -50,16 +58,8 @@ module PactBroker
         def self.add_cross_field_validation_errors(params, results)
           # This is a ducking joke. Need to get rid of dry-validation
           if params[:consumerVersionSelectors].is_a?(Array)
-            errors = []
-            params[:consumerVersionSelectors].each_with_index do | selector, index |
-              if selector[:fallbackTag] && !selector[:latest]
-                errors << "fallbackTag can only be set if latest is true (at index #{index})"
-              end
-
-
-              if not_provided?(selector[:tag]) && selector[:latest] != true
-                errors << "latest must be true, or a tag must be provided (at index #{index})"
-              end
+            errors = params[:consumerVersionSelectors].each_with_index.flat_map do | selector, index |
+              validate_consumer_version_selector(selector, index)
             end
             if errors.any?
               results[:consumerVersionSelectors] ||= []
@@ -71,6 +71,61 @@ module PactBroker
         def self.not_provided?(value)
           value.nil? || value.blank?
         end
+
+        # when setting a tag, latest=true and latest=false are both valid
+        # when setting the branch, it doesn't make sense to verify all pacts for a branch,
+        # so latest is not required, but cannot be set to false
+        # rubocop: disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        def self.validate_consumer_version_selector(selector, index)
+          errors = []
+
+          if selector[:fallbackTag] && !selector[:latest]
+            errors << "fallbackTag can only be set if latest is true (at index #{index})"
+          end
+
+          if selector[:fallbackBranch] && selector[:latest] == false
+            errors << "fallbackBranch can only be set if latest is true (at index #{index})"
+          end
+
+          if not_provided?(selector[:tag]) &&
+              not_provided?(selector[:branch]) &&
+              not_provided?(selector[:environment]) &&
+              selector[:deployed] != true &&
+              selector[:released] != true &&
+              selector[:latest] != true
+            errors << "must specify a value for environment or tag, or specify latest=true, or specify deployed=true or released=true (at index #{index})"
+          end
+
+          if selector[:tag] && selector[:branch]
+            errors << "cannot specify both a tag and a branch (at index #{index})"
+          end
+
+          if selector[:fallbackBranch] && !selector[:branch]
+            errors << "a branch must be specified when a fallbackBranch is specified (at index #{index})"
+          end
+
+          if selector[:fallbackTag] && !selector[:tag]
+            errors << "a tag must be specified when a fallbackTag is specified (at index #{index})"
+          end
+
+          if selector[:branch] && selector[:latest] == false
+            errors << "cannot specify a branch with latest=false (at index #{index})"
+          end
+
+          if selector[:deployed] && selector[:released]
+            errors << "cannot specify both deployed=true and released=true (at index #{index})"
+          end
+
+          non_environment_fields = selector.slice(:latest, :tag, :fallbackTag, :branch, :fallbackBranch).keys.sort
+          environment_related_fields = selector.slice(:environment, :deployed, :released).keys.sort
+
+          if (non_environment_fields.any? && environment_related_fields.any?)
+            errors << "cannot specify the #{pluralize("field", non_environment_fields.count)} #{non_environment_fields.join("/")} with the #{pluralize("field", environment_related_fields.count)} #{environment_related_fields.join("/")} (at index #{index})"
+          end
+
+          errors
+        end
+        # rubocop: enable Metrics/CyclomaticComplexity, Metrics/MethodLength
       end
     end
   end

data/lib/pact_broker/api/contracts/verifiable_pacts_query_schema.rb

@@ -1,6 +1,6 @@
-require 'dry-validation'
-require 'pact_broker/api/contracts/dry_validation_workarounds'
-require 'pact_broker/api/contracts/dry_validation_predicates'
+require "dry-validation"
+require "pact_broker/api/contracts/dry_validation_workarounds"
+require "pact_broker/api/contracts/dry_validation_predicates"
 
 module PactBroker
   module Api

data/lib/pact_broker/api/contracts/verification_contract.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/api/contracts/base_contract'
-require 'uri'
+require "pact_broker/api/contracts/base_contract"
+require "uri"
 
 module PactBroker
   module Api

data/lib/pact_broker/api/contracts/webhook_contract.rb

@@ -1,8 +1,8 @@
-require 'pact_broker/api/contracts/base_contract'
-require 'pact_broker/webhooks/check_host_whitelist'
-require 'pact_broker/webhooks/render'
-require 'pact_broker/pacticipants/service'
-require 'pact_broker/webhooks/webhook_event'
+require "pact_broker/api/contracts/base_contract"
+require "pact_broker/webhooks/check_host_whitelist"
+require "pact_broker/webhooks/render"
+require "pact_broker/pacticipants/service"
+require "pact_broker/webhooks/webhook_event"
 
 module PactBroker
   module Api
@@ -20,7 +20,10 @@ module PactBroker
             @first_errors.messages[key] = @first_errors.messages[key][0...1]
           end
 
+          # rubocop: disable Lint/NestedMethodDefinition
           def self.errors; @first_errors end
+          # rubocop: enable Lint/NestedMethodDefinition
+
           result
         end
 
@@ -136,14 +139,14 @@ module PactBroker
               end
 
               def non_templated_host?(url)
-                parse_uri(url).host == parse_uri(url, 'differentplaceholder').host
+                parse_uri(url).host == parse_uri(url, "differentplaceholder").host
               end
 
               def host_whitelist
                 PactBroker.configuration.webhook_host_whitelist
               end
 
-              def parse_uri(uri_string, placeholder = 'placeholder')
+              def parse_uri(uri_string, placeholder = "placeholder")
                 URI(PactBroker::Webhooks::Render.render_with_placeholder(uri_string, placeholder))
               end
             end

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

@@ -1,9 +1,9 @@
-require 'roar/decorator'
-require 'roar/json/hal'
-require 'pact_broker/api/pact_broker_urls'
-require 'pact_broker/api/decorators/decorator_context'
-require 'pact_broker/api/decorators/format_date_time'
-require 'pact_broker/string_refinements'
+require "roar/decorator"
+require "roar/json/hal"
+require "pact_broker/api/pact_broker_urls"
+require "pact_broker/api/decorators/decorator_context"
+require "pact_broker/api/decorators/format_date_time"
+require "pact_broker/string_refinements"
 
 module PactBroker
   module Api
@@ -15,8 +15,12 @@ module PactBroker
         include FormatDateTime
         using PactBroker::StringRefinements
 
+        def self.camelize_property_names
+          @camelize = true
+        end
+
         def self.property(name, options={}, &block)
-          if options.delete(:camelize)
+          if options.delete(:camelize) || @camelize
             camelized_name = name.to_s.camelcase(false).to_sym
             super(name, { as: camelized_name }.merge(options), &block)
           else

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

@@ -1,4 +1,4 @@
-require_relative 'base_decorator'
+require_relative "base_decorator"
 
 module PactBroker
 

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

@@ -1,4 +1,4 @@
-require 'pact_broker/string_refinements'
+require "pact_broker/string_refinements"
 
 module PactBroker
   module Api
@@ -16,7 +16,7 @@ module PactBroker
           elsif overrides[name].is_a?(Class)
             overrides[name]
           else
-           Object.const_get("PactBroker::Api::Decorators::#{name.to_s.camelcase(true)}")
+            Object.const_get("PactBroker::Api::Decorators::#{name.to_s.camelcase(true)}")
           end
         end
 

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

@@ -1,6 +1,6 @@
-require 'ostruct'
-require 'pact_broker/api/pact_broker_urls'
-require 'pact_broker/api/decorators/format_date_time'
+require "ostruct"
+require "pact_broker/api/pact_broker_urls"
+require "pact_broker/api/decorators/format_date_time"
 
 module PactBroker
   module Api
@@ -27,7 +27,7 @@ module PactBroker
 
         attr_reader :index_items
 
-        def items(index_items, base_url)
+        def items(_index_items, base_url)
           sorted_index_items.collect do | index_item |
             index_item_hash(index_item.consumer, index_item.provider, index_item.consumer_version, index_item, base_url)
           end
@@ -53,7 +53,7 @@ module PactBroker
           }
         end
 
-        def consumer_hash(index_item, consumer, consumer_version, base_url)
+        def consumer_hash(index_item, _consumer, _consumer_version, base_url)
           {
             name: index_item.consumer_name,
             version: {
@@ -73,7 +73,7 @@ module PactBroker
           }
         end
 
-        def provider_hash(index_item, provider, base_url)
+        def provider_hash(index_item, _provider, base_url)
           hash = {
             name: index_item.provider_name,
             version: nil,
@@ -153,7 +153,7 @@ module PactBroker
           end
         end
 
-        def latest_webhook_execution(index_item, base_url)
+        def latest_webhook_execution(index_item, _base_url)
           if index_item.last_webhook_execution_date
             {
               triggeredAt: format_date_time(index_item.last_webhook_execution_date)
@@ -163,7 +163,7 @@ module PactBroker
 
         def links(index_item, base_url)
           {
-            'pb:webhook-status' => {
+            "pb:webhook-status" => {
               title: "Status of webhooks for #{index_item.consumer_name}/#{index_item.provider_name} pact",
               href: webhooks_status_url(index_item.consumer, index_item.provider, base_url)
             }

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

@@ -1,5 +1,5 @@
-require 'ostruct'
-require 'pact_broker/api/pact_broker_urls'
+require "ostruct"
+require "pact_broker/api/pact_broker_urls"
 
 module PactBroker
   module Api
@@ -27,7 +27,7 @@ module PactBroker
 
         attr_reader :index_items
 
-        def items(index_items, base_url)
+        def items(index_items, _base_url)
           index_items.collect do | index_item |
             index_item_object(index_item)
           end

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

@@ -9,7 +9,7 @@ module PactBroker
           @resource_url = self[:resource_url] = resource_url
           @resource_title = self[:resource_title] = options[:resource_title]
           @env = self[:env] = env
-          @query_string = self[:query_string] = (env['QUERY_STRING'] && !env['QUERY_STRING'].empty? ? env['QUERY_STRING'] : nil)
+          @query_string = self[:query_string] = (env["QUERY_STRING"] && !env["QUERY_STRING"].empty? ? env["QUERY_STRING"] : nil)
           merge!(options)
         end
 

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

@@ -1,4 +1,4 @@
-require 'pact_broker/api/decorators/decorator_context'
+require "pact_broker/api/decorators/decorator_context"
 
 module PactBroker
   module Api

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

@@ -0,0 +1,26 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/embedded_version_decorator"
+require "pact_broker/api/decorators/environment_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class DeployedVersionDecorator < BaseDecorator
+        property :uuid
+        property :currently_deployed, camelize: true
+        property :target, camelize: true
+        include Timestamps
+        property :undeployedAt, getter: lambda { |_|  undeployed_at ? FormatDateTime.call(undeployed_at) : nil }, writeable: false
+
+        property :version, :extend => EmbeddedVersionDecorator, writeable: false, embedded: true
+        property :environment, :extend => EnvironmentDecorator, writeable: false, embedded: true
+
+        link :self do | user_options |
+          {
+            href: deployed_version_url(represented, user_options.fetch(:base_url))
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/deployed_version_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class DeployedVersionsDecorator < BaseDecorator
+        collection :entries, as: :deployedVersions, embedded: true, :extend => PactBroker::Api::Decorators::DeployedVersionDecorator
+
+        link :self do | context |
+          href = append_query_if_present(context[:resource_url], context[:query_string])
+          {
+            href: href,
+            title: context.fetch(:title)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require_relative 'base_decorator'
+require_relative "base_decorator"
 
 module PactBroker
   module Api
@@ -9,7 +9,7 @@ module PactBroker
 
         link :self do | options |
           {
-            title: 'Label',
+            title: "Label",
             name: represented.name,
             href: label_url(represented, options[:base_url])
           }

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

@@ -0,0 +1,17 @@
+require_relative "base_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedPacticipantDecorator < BaseDecorator
+        camelize_property_names
+
+        property :name
+
+        link :self do | options |
+          pacticipant_url(options[:base_url], represented)
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
-require_relative 'base_decorator'
-require_relative 'pact_pacticipant_decorator'
-require_relative 'timestamps'
+require_relative "base_decorator"
+require_relative "pact_pacticipant_decorator"
+require_relative "timestamps"
 
 module PactBroker
 
@@ -14,7 +14,7 @@ module PactBroker
 
         link :self do | options |
           {
-            title: 'Tag',
+            title: "Tag",
             name: represented.name,
             href: tag_url(options[:base_url], represented)
           }

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

@@ -1,15 +1,20 @@
-require_relative 'base_decorator'
+require_relative "base_decorator"
 
 module PactBroker
   module Api
     module Decorators
       class EmbeddedVersionDecorator < BaseDecorator
+        camelize_property_names
 
         property :number
+        if PactBroker.feature_enabled?(:branches)
+          property :branch
+          property :build_url
+        end
 
         link :self do | options |
           {
-            title: 'Version',
+            title: "Version",
             name: represented.number,
             href: version_url(options.fetch(:base_url), represented)
           }