pact_broker 2.60.0 → 2.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbaaee53f1641458eb110582a96bf0be98d7078ef1fa681ffee934c6e8007347
-  data.tar.gz: 84a2f6e6785acc85cf7053b86a54574746cb06de917bd11a0dff23403046aff5
+  metadata.gz: 3fee7d96bde4fc04adb41fe041a124e81c9b371336f9308f92c918a2fb4ca914
+  data.tar.gz: 3706e5b3a8fbf6db31c748658a1b0f22713f872889757844c9506250b2cefa54
 SHA512:
-  metadata.gz: de93223c0a1d52af6563bf31b2ae733c41b6cec65afb4a61be741d78f47cf18484ee2fa292c9660b8db09cb3a1a66c549decb145a0b7a036477a9ac73b70f8c6
-  data.tar.gz: 04d3a59551f4fe9f46af8b65cd6c0dc3326ac86a594298eb22d529e33f6a98e39cdf6f9c682bd69bd9bbb85f4f290fe3e2f706d71cfa766b61def28c0dbd7bfc
+  metadata.gz: d1a1046845fb3832062d675ebfa1d49e0fa62ac6ea8acb8edb6c706b53e66888b72a243bc16e94842b89b4b349adf3ac22c3f35f043a75538f9dea7f3d28122a
+  data.tar.gz: fdad352fd207e05717eb127ec0ad0c35de8465b4dfed9a6cdcf862bc5d6f169bf15975a932c8cd355716b90ba3291552fadc35aab1768710179f330592fd5166

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+<a name="v2.64.0"></a>
+### v2.64.0 (2020-09-25)
+
+#### Features
+
+* add API endpoint for can-i-deploy for latest tagged pacticipant version	 ([88fdc60a](/../../commit/88fdc60a))
+* render matrix UI page for can-i-deploy endpoint	 ([463e9cfd](/../../commit/463e9cfd))
+* change text on can-i-deploy badge	 ([f9e183e9](/../../commit/f9e183e9))
+
+<a name="v2.63.0"></a>
+### v2.63.0 (2020-09-25)
+
+#### Features
+
+* allow label of can-i-deploy badge to be customised by setting the label query parameter	 ([ed544f94](/../../commit/ed544f94))
+* add badges for can-i-deploy	 ([887a9ca3](/../../commit/887a9ca3))
+
+<a name="v2.62.0"></a>
+### v2.62.0 (2020-09-23)
+
+#### Features
+
+* **webhooks**
+  * remove user-agent and accept-encoding headers which the Ruby HTTP library adds by default	 ([ef25b88c](/../../commit/ef25b88c))
+
+* add event name to triggered webhook	 ([ecce16fd](/../../commit/ecce16fd))
+
+#### Bug Fixes
+
+* **webhooks**
+  * use path to initialise http request, rather than full URL	 ([ecbac9a6](/../../commit/ecbac9a6))
+
+* gracefully handle corrupt webhook metadata in pact URL	 ([ba94c355](/../../commit/ba94c355))
+
+<a name="v2.61.0"></a>
+### v2.61.0 (2020-09-12)
+
+#### Features
+
+* add back support for GET requests to the 'pacts for verification' API with a deprecation notice in the response	 ([8f45cc9f](/../../commit/8f45cc9f))
+
+<a name="v2.60.1"></a>
+### v2.60.1 (2020-09-10)
+
+#### Bug Fixes
+
+* href for beta:provider-pacts-for-verification	 ([3949fdd1](/../../commit/3949fdd1))
+
 <a name="v2.60.0"></a>
 ### v2.60.0 (2020-09-08)
 

data/db/migrations/20200922_add_event_to_triggered_webhook.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:triggered_webhooks, :event_name, String)
+  end
+end

data/lib/pact_broker/api.rb

@@ -71,6 +71,8 @@ module PactBroker
         add ['pacticipants', :pacticipant_name, 'versions'], Api::Resources::Versions, {resource_name: "pacticipant_versions"}
         add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number], Api::Resources::Version, {resource_name: "pacticipant_version"}
         add ['pacticipants', :pacticipant_name, 'latest-version', :tag], Api::Resources::Version, {resource_name: "latest_tagged_pacticipant_version"}
+        add ['pacticipants', :pacticipant_name, 'latest-version', :tag, 'can-i-deploy', 'to', :to], Api::Resources::CanIDeployPacticipantVersion, { resource_name: "can_i_deploy_latest_tagged_version" }
+        add ['pacticipants', :pacticipant_name, 'latest-version', :tag, 'can-i-deploy', 'to', :to, 'badge'], Api::Resources::CanIDeployBadge, { resource_name: "can_i_deploy_badge" }
         add ['pacticipants', :pacticipant_name, 'latest-version'], Api::Resources::Version, {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"}

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

@@ -0,0 +1,37 @@
+require 'dry-validation'
+require 'pact_broker/api/contracts/dry_validation_workarounds'
+require 'pact_broker/api/contracts/dry_validation_predicates'
+
+module PactBroker
+  module Api
+    module Contracts
+      class VerifiablePactsQuerySchema
+        extend DryValidationWorkarounds
+        using PactBroker::HashRefinements
+
+        SCHEMA = Dry::Validation.Schema do
+          configure do
+            predicates(DryValidationPredicates)
+            config.messages_file = File.expand_path("../../../locale/en.yml", __FILE__)
+          end
+          optional(:provider_version_tags).maybe(:array?)
+          optional(:consumer_version_selectors).each do
+            schema do
+              required(:tag).filled(:str?)
+              optional(:latest).filled(included_in?: ["true", "false"])
+              optional(:fallback_tag).filled(:str?)
+              optional(:consumer).filled(:str?, :not_blank?)
+            end
+          end
+          optional(:include_pending_status).filled(included_in?: ["true", "false"])
+          optional(:include_wip_pacts_since).filled(:date?)
+        end
+
+        def self.call(params)
+          select_first_message(flatten_indexed_messages(SCHEMA.call(params&.symbolize_keys).messages(full: true)))
+        end
+
+      end
+    end
+  end
+end

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

@@ -58,6 +58,22 @@ module PactBroker
           }
         end
 
+        link :'pb:can-i-deploy-badge' do | options |
+          {
+            title: "Can I Deploy #{represented.name} badge",
+            href: templated_can_i_deploy_badge_url(represented.name, options[:base_url]),
+            templated: true
+          }
+        end
+
+        curies do | options |
+          [{
+            name: :pb,
+            href: options[:base_url] + '/doc/{rel}?context=pacticipant',
+            templated: true
+          }]
+        end
+
         def to_hash options
           h = super
           dasherized = DasherizedVersionDecorator.new(represented).to_hash(options)

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

@@ -9,6 +9,7 @@ module PactBroker
         property :number_of_attempts_made, as: :attemptsMade
         property :number_of_attempts_remaining, as: :attemptsRemaining
         property :trigger_type, as: :triggerType
+        property :event_name, as: :eventName
 
         property :created_at, as: :triggeredAt
 

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

@@ -14,14 +14,14 @@ module PactBroker
 
           property :pending,
             if: ->(context) { context[:options][:user_options][:include_pending_status] }
-          property :wip, if: -> (context) { context[:represented].wip }
-
-          property :notices, getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
-          property :noteToDevelopers, getter: -> (_) { "Please print out the text from the 'notices' rather than using the inclusionReason and the pendingReason fields. These will be removed when this API moves out of beta."}
+          property :wip,
+            if: -> (context) { context[:represented].wip }
+          property :notices,
+            getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
 
           def notices(user_options)
             pact_url = pact_version_url(represented, user_options[:base_url])
-            PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, include_pending_status: user_options[:include_pending_status])
+            PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, user_options)
           end
         end
 

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -1,11 +1,13 @@
 require 'erb'
 require 'pact_broker/pacts/metadata'
+require 'pact_broker/logging'
 
 module PactBroker
   module Api
     module PactBrokerUrls
 
       include PactBroker::Pacts::Metadata
+      include PactBroker::Logging
       # TODO make base_url the last and optional argument for all methods, defaulting to ''
 
       extend self
@@ -70,8 +72,13 @@ module PactBroker
 
       def decode_webhook_metadata(metadata)
         if metadata
-          Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
-            new_hash[k.to_sym] = v
+          begin
+            Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
+              new_hash[k.to_sym] = v
+            end
+          rescue StandardError => e
+            logger.warn("Exception parsing webhook metadata: #{metadata}", e)
+            {}
           end
         else
           {}
@@ -190,11 +197,19 @@ module PactBroker
       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}"
+        pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/versions/{version}/tags/{tag}"
       end
 
       def templated_label_url_for_pacticipant pacticipant_name, base_url = ""
-        pacticipant_url_from_params({pacticipant_name: pacticipant_name}, base_url) + "/labels/{label}"
+        pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/labels/{label}"
+      end
+
+      def templated_can_i_deploy_url pacticipant_name, base_url = ""
+        pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/latest-version/{tag}/can-i-deploy/to/{environmentTag}"
+      end
+
+      def templated_can_i_deploy_badge_url pacticipant_name, base_url = ""
+        templated_can_i_deploy_url(pacticipant_name, base_url) + "/badge"
       end
 
       def label_url label, base_url

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

@@ -46,12 +46,7 @@ module PactBroker
         end
 
         def policy_name
-          :'webhooks::webooks'
-        end
-
-        def policy_record
-          # Note: consumer and provider not yet set on new webhook
-          request.post? ? webhook : webhooks
+          :'webhooks::webhooks'
         end
 
         private

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

@@ -25,10 +25,6 @@ module PactBroker
           :'matrix::can_i_deploy'
         end
 
-        def policy_record
-          selectors
-        end
-
         private
 
         attr_reader :query_params, :selectors, :options

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

@@ -0,0 +1,85 @@
+require 'pact_broker/matrix/can_i_deploy_query_schema'
+require 'pact_broker/matrix/parse_can_i_deploy_query'
+
+module PactBroker
+  module Api
+    module Resources
+      class CanIDeployBadge < BaseResource
+        def initialize
+          super
+          selector = PactBroker::Matrix::UnresolvedSelector.new(pacticipant_name: pacticipant_name, latest: true, tag: identifier_from_path[:tag])
+          @options = {
+            latestby: 'cvp',
+            latest: true,
+            tag: identifier_from_path[:to]
+          }
+          @selectors = [selector]
+        end
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        def content_types_provided
+          [['image/svg+xml', :to_svg]]
+        end
+
+        def resource_exists?
+          false
+        end
+
+        # Only called if resource_exists? returns false
+        def previously_existed?
+          true
+        end
+
+        def is_authorized?(authorization_header)
+          super || PactBroker.configuration.enable_public_badge_access
+        end
+
+        def forbidden?
+          false
+        end
+
+        def moved_temporarily?
+          response.headers['Cache-Control'] = 'no-cache'
+          begin
+            if pacticipant
+              if version
+                badge_service.can_i_deploy_badge_url(identifier_from_path[:tag], identifier_from_path[:to], label, results.deployable?)
+              else
+                badge_service.error_badge_url("version", "not found")
+              end
+            else
+              badge_service.error_badge_url(selectors.first.pacticipant_name, "not found")
+            end
+          rescue StandardError => e
+            # Want to render a badge, even if there's an error
+            badge_service.error_badge_url("error", ErrorHandler.display_message(e, "reference: #{ErrorHandler.generate_error_reference}"))
+          end
+        end
+
+        def policy_name
+          :'badges::badge'
+        end
+
+        private
+
+        attr_reader :selectors, :options
+
+        def results
+          @results ||= matrix_service.find(selectors, options)
+        end
+
+        def version
+          @version ||= version_service.find_by_pacticipant_name_and_latest_tag(identifier_from_path[:pacticipant_name], identifier_from_path[:tag])
+        end
+
+        def label
+          lab = request.query['label']
+          lab && !lab.empty? ? lab : nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'pact_broker/api/resources/matrix'
+require 'pact_broker/matrix/can_i_deploy_query_schema'
+require 'pact_broker/matrix/parse_can_i_deploy_query'
+
+module PactBroker
+  module Api
+    module Resources
+      class CanIDeployPacticipantVersion < Matrix
+        def initialize
+          super
+          selector = PactBroker::Matrix::UnresolvedSelector.new(pacticipant_name: pacticipant_name, latest: true, tag: identifier_from_path[:tag])
+          @options = {
+            latestby: 'cvp',
+            latest: true,
+            tag: identifier_from_path[:to]
+          }
+          @selectors = [selector]
+        end
+
+        def resource_exists?
+          !!version
+        end
+
+        def policy_name
+          :'matrix::can_i_deploy'
+        end
+
+        private
+
+        def version
+          @version ||= version_service.find_by_pacticipant_name_and_latest_tag(identifier_from_path[:pacticipant_name], identifier_from_path[:tag])
+        end
+
+        def results
+          @results ||= matrix_service.find(selectors, options)
+        end
+      end
+    end
+  end
+end

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

@@ -202,6 +202,15 @@ module PactBroker
           @pact ||= pact_service.find_pact(pact_params)
         end
 
+        # Not necessarily an existing integration
+        def integration
+          if consumer_specified? && provider_specified?
+            OpenStruct.new(consumer: consumer, provider: provider)
+          else
+            nil
+          end
+        end
+
         def database_connector
           request.env["pactbroker.database_connector"]
         end

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

@@ -32,11 +32,11 @@ module PactBroker
           PactBroker.configuration.warning_error_classes.any? { |clazz| e.is_a?(clazz) }
         end
 
-        def self.display_message(e, error_reference)
+        def self.display_message(e, obfuscated_message)
           if PactBroker.configuration.show_backtrace_in_error_response?
-            e.message || obfuscated_error_message(error_reference)
+            e.message || obfuscated_message
           else
-           reportable?(e) ? obfuscated_error_message(error_reference) : e.message
+           reportable?(e) ? obfuscated_message : e.message
           end
         end
 
@@ -47,7 +47,7 @@ module PactBroker
         def self.response_body_hash e, error_reference
           response_body = {
             error: {
-              message: display_message(e, error_reference),
+              message: display_message(e, obfuscated_error_message(error_reference)),
               reference: error_reference
             }
           }

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

@@ -4,9 +4,7 @@ require 'pact_broker/error'
 module PactBroker
   module Api
     module Resources
-
       class ErrorTest < BaseResource
-
         def content_types_provided
           [
             ["application/hal+json", :to_json]
@@ -24,6 +22,10 @@ module PactBroker
         def process_post
           raise PactBroker::TestError.new("Don't panic. This is a test API error.")
         end
+
+        def policy_name
+          :'default'
+        end
       end
     end
   end

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

@@ -26,10 +26,6 @@ module PactBroker
           :'groups::group'
         end
 
-        def policy_record
-          pacticipant
-        end
-
         private
 
         def group