pact_broker 2.59.2 → 2.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1933f8f7902c43ed7d9db7c022a66f2569c6301dec2c8ac767e1da7b05f70b5
-  data.tar.gz: 40d82183c3a94b2bfc2bfa37a9aee12cc27729e1c3a1b3191df980c2ba3ad192
+  metadata.gz: 61338a93bd65ffa3ec70f4fdfd9b509a0d5c0608dce8cea3f779e3ac22151412
+  data.tar.gz: 99819023ba051657020d314fe6d3005a04660d70467a57c5b5369a08a5525e2a
 SHA512:
-  metadata.gz: 5078b560d3d0abe897572f35276b3aec1c6752026ba849a9b61517def382ea0d936731a6b2f59801b0101cab7bde636ef3e9e5e7afe9524e13c3def552f48ded
-  data.tar.gz: 6fc016ea9e10bcbad4f78d60b93a81b5d0aab2ffbfef9d222a094e0348f632680995bce488abe9fefe55cad745afafef323ce3c972db3e78a7e1f6759d222f6e
+  metadata.gz: 7da446c51346413782377eb409c2d3159fcb322147d675324126243bfb8b115ff042d210b3cf25ee46ebe73093611e4de85db03f243c5ffb06299239d6aff637
+  data.tar.gz: 6b191f39b782bf811d58e15d149fa5e786227e6a86d93c0f8888a6134b992d6f60ad58ff2b2b6cf84ba612b72368cf569471b9214b85f7ce173e18872e89ddec

data/CHANGELOG.md

@@ -1,3 +1,56 @@
+<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)
+
+#### Features
+
+* **pacts for verification**
+  * add deprecation title to beta:provider-pacts-for-verification relation	 ([47a61f69](/../../commit/47a61f69))
+  * do not require environment variable feature toggle to enable feature	 ([7d0fe1ea](/../../commit/7d0fe1ea))
+  * allow consumer to be specified with fallback tags, and overall latest to be specified with or without a consumer	 ([2d52d173](/../../commit/2d52d173))
+
+#### Bug Fixes
+
+* correctly handle new test results format when merging test results with pact contents	 ([b35ab71b](/../../commit/b35ab71b))
+
 <a name="v2.59.2"></a>
 ### v2.59.2 (2020-08-06)
 

data/README.md

@@ -6,7 +6,7 @@
  [![Code Climate](https://codeclimate.com/github/pact-foundation/pact_broker/badges/gpa.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)
  [![Test Coverage](https://codeclimate.com/github/pact-foundation/pact_broker/badges/coverage.svg)](https://codeclimate.com/github/pact-foundation/pact_broker/coverage)
 
-The Pact Broker is an application for sharing for consumer driven contracts and verification results. It is optimised for use with "pacts" (contracts created by the [Pact][pact-docs] framework), but can be used for any type of contract that can be serialized to JSON.
+The Pact Broker is an application for sharing of consumer driven contracts and verification results. It is optimised for use with "pacts" (contracts created by the [Pact][pact-docs] framework), but can be used for any type of contract that can be serialized to JSON.
 
 <br/>
 <a href="https:/pactflow.io/?utm_source=github&utm_campaign=pact_broker_intro"><img src="docs/images/Pactflow logo - black small.png"></a>

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,7 @@ 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, '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_json_query_schema.rb

@@ -1,5 +1,6 @@
 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'
 
@@ -9,6 +10,7 @@ module PactBroker
       class VerifiablePactsJSONQuerySchema
         extend DryValidationWorkarounds
         using PactBroker::HashRefinements
+        using PactBroker::StringRefinements
 
         SCHEMA = Dry::Validation.Schema do
           configure do
@@ -24,7 +26,7 @@ module PactBroker
               #   end
               # end
 
-              required(:tag).filled(:str?)
+              optional(:tag).filled(:str?)
               optional(:latest).filled(included_in?: [true, false])
               optional(:fallbackTag).filled(:str?)
               optional(:consumer).filled(:str?, :not_blank?)
@@ -54,8 +56,9 @@ module PactBroker
                 errors << "fallbackTag can only be set if latest is true (at index #{index})"
               end
 
-              if selector[:consumer] && selector[:latest]
-                errors << "specifying a consumer with latest == true is not yet supported (at index #{index})"
+
+              if not_provided?(selector[:tag]) && selector[:latest] != true
+                errors << "latest must be true, or a tag must be provided (at index #{index})"
               end
             end
             if errors.any?
@@ -64,6 +67,10 @@ module PactBroker
             end
           end
         end
+
+        def self.not_provided?(value)
+          value.nil? || value.blank?
+        end
       end
     end
   end

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

@@ -30,6 +30,7 @@ module PactBroker
         def self.call(params)
           select_first_message(flatten_indexed_messages(SCHEMA.call(params&.symbolize_keys).messages(full: true)))
         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,15 @@ 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_badge_url pacticipant_name, base_url = ""
+        pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/latest-version/{tag}/can-i-deploy/to/{environmentTag}/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(pacticipant_name, 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/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

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

@@ -121,6 +121,17 @@ module PactBroker
               title: "Determine if an application can be safely deployed to an environment identified by the given tag",
               templated: true
             },
+            'pb:provider-pacts-for-verification' => {
+              href: base_url + '/pacts/provider/{provider}/for-verification',
+              title: 'Pact versions to be verified for the specified provider',
+              templated: true
+            },
+            'beta:provider-pacts-for-verification' => {
+              name: 'beta',
+              href: base_url + '/pacts/provider/{provider}/for-verification',
+              title: 'DEPRECATED - please use pb:provider-pacts-for-verification',
+              templated: true
+            },
             'curies' =>
             [{
               name: 'pb',
@@ -133,14 +144,6 @@ module PactBroker
             }]
           }
 
-          if PactBroker.feature_enabled?(:pacts_for_verification)
-            links_hash['beta:provider-pacts-for-verification'] = {
-                href: base_url + '/pacts/provider/{provider}/for-verification',
-                title: 'Pact versions to be verified for the specified provider',
-                templated: true
-              }
-          end
-
           links_hash
         end