pact_broker 2.62.0 → 2.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d90410ba82c9f6ee8681073d1a9435660abf73045fa4ea08658294512771106
-  data.tar.gz: ff2c697fa385d574c26225ebf3aa6bb93276a749bfc6851685dc17728aa18fb0
+  metadata.gz: 2874fe6ca6f552e6cba4d848f56998d0473d860ec4aa47530ccf883d9f189cfe
+  data.tar.gz: b8e28ffebc86a0f28251489edb9cd92407a4f2758e4fdc519f1d47d7c32cbf2d
 SHA512:
-  metadata.gz: 95c87ab86bd54c472362e678a8fd6307637ad34059beb390baf59fa33456014ed47bd725940fe792ffd7151c80201baf9c063d670b7ed4c857708c22e60e352a
-  data.tar.gz: 3c101564948c497f80d286eccfd70cc92734c5a94b280825bd437c3a6ab4141caf7e98fefb6594b230d0021bba732c44704e9338df081c630d752f0bbb3140cc
+  metadata.gz: f6bae75159d6ed6b50e0c96f71cd0931d52b94e6fb251d21e31153d67ce892dfaecdf64932f0bca27f06418fb61c67b9348129a5f662590c528d401a2a2df27d
+  data.tar.gz: 31b4370cd7d1e4c9b4b7825f013a58c327a1b3766f62ce59380bd878160dde2725cee60a2401625772b88378cb258ca8d5ebfa927131cdaf66ac1636352e4cda

data/CHANGELOG.md

@@ -1,3 +1,63 @@
+<a name="v2.67.0"></a>
+### v2.67.0 (2020-10-16)
+
+#### Features
+
+* **wip pacts**
+  * if a pact was successfully verified because it was included as a WIP pact, keep it as WIP	 ([16cae55d](/../../commit/16cae55d))
+  * add 'wip' column to verification results	 ([34f98592](/../../commit/34f98592))
+
+#### Bug Fixes
+
+* typo when rendering created webhook for old webhooks path	 ([1e6a06a0](/../../commit/1e6a06a0))
+* include can-i-deploy badge in is_badge_path? logic	 ([31ea5f34](/../../commit/31ea5f34))
+
+* **pacts for verification**
+  * gracefully log empty request body	 ([0e48d13a](/../../commit/0e48d13a))
+
+* **can-i-deploy**
+  * gracefully handle pacticipant not found	 ([f6903b23](/../../commit/f6903b23))
+
+<a name="v2.66.0"></a>
+### v2.66.0 (2020-10-01)
+
+#### Features
+
+* paginate pacticipant versions	 ([f489ba7b](/../../commit/f489ba7b))
+
+* **webhooks**
+  * add event name to group by clause when selecting latest triggered webhooks	 ([134f12c8](/../../commit/134f12c8))
+
+#### Bug Fixes
+
+* maintain latest and tag params when submitting page after following link from can-i-deploy debug logs	 ([6e2f1a85](/../../commit/6e2f1a85))
+
+<a name="v2.65.0"></a>
+### v2.65.0 (2020-09-25)
+
+#### Features
+
+* **pacts for verification**
+  * allow API to be disabled by setting PACT_BROKER_FEATURES=disable_pacts_for_verification	 ([bab116b3](/../../commit/bab116b3))
+  * update wording for inclusion notice when selector has a consumer specified	 ([61370d1f](/../../commit/61370d1f))
+
+<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)
 

data/Gemfile

@@ -25,6 +25,7 @@ group :test do
   gem 'timecop', '~> 0.9'
   gem 'faraday', '~>0.15'
   gem 'docker-api', '~>1.34'
+  gem 'approvals', '~>0.0.1', '< 1'
 end
 
 if ENV['INSTALL_MYSQL'] == "true"

data/db/ddl_statements/latest_triggered_webhooks.rb

@@ -0,0 +1,66 @@
+# These views find the latest triggered webhook for each webhook/consumer/provider
+# by finding the latest execution date for each webhook
+# then taking the row with the max ID in case there there are two
+# triggered webhooks for the same UUID and same creation date
+# Not sure if this is strictly necessary to do the extra step, but better to be
+# safe than sorry.
+# I probably could just take the max ID for each webhook/consumer/provider, but
+# something in my head says that
+# relying on the primary key for order is not a good idea, even though
+# according to the SQL it should be fine.
+def latest_triggered_webhook_creation_dates_v2
+  "select webhook_uuid, consumer_id, provider_id, max(created_at) as latest_triggered_webhook_created_at
+  from triggered_webhooks
+  group by webhook_uuid, consumer_id, provider_id"
+end
+
+# Ignore ltwcd.latest_triggered_webhook_created_at, it's there because postgres doesn't allow you to modify
+# the names and types of columns in a view
+def latest_triggered_webhook_ids_v2
+  "select tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at, max(tw.id) as latest_triggered_webhook_id
+  from latest_triggered_webhook_creation_dates ltwcd
+  inner join triggered_webhooks tw
+  on tw.consumer_id = ltwcd.consumer_id
+  and tw.provider_id = ltwcd.provider_id
+  and tw.webhook_uuid = ltwcd.webhook_uuid
+  and tw.created_at = ltwcd.latest_triggered_webhook_created_at
+  group by tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at"
+end
+
+def latest_triggered_webhooks_v2
+  "select tw.*
+  from triggered_webhooks tw
+  inner join latest_triggered_webhook_ids ltwi
+  on tw.consumer_id = ltwi.consumer_id
+  and tw.provider_id = ltwi.provider_id
+  and tw.webhook_uuid = ltwi.webhook_uuid
+  and tw.id = ltwi.latest_triggered_webhook_id"
+end
+
+# use explicit columns - can't drop event_name in 20200922_add_event_to_triggered_webhook.rb
+# if tw.* is used because you can't remove columns from a view in postgres
+def latest_triggered_webhooks_v3_rollback(is_postgres)
+  if is_postgres
+    "select tw.id, tw.trigger_uuid, tw.trigger_type, tw.pact_publication_id, tw.webhook_id, tw.webhook_uuid, tw.consumer_id, tw.provider_id, tw.status, tw.created_at, tw.updated_at, tw.verification_id, ''::text as event_name
+    from triggered_webhooks tw
+    inner join latest_triggered_webhook_ids ltwi
+    on tw.consumer_id = ltwi.consumer_id
+    and tw.provider_id = ltwi.provider_id
+    and tw.webhook_uuid = ltwi.webhook_uuid
+    and tw.id = ltwi.latest_triggered_webhook_id"
+  else
+    latest_triggered_webhooks_v2
+  end
+end
+
+##### v3
+
+# screw dates, just use IDs.
+def latest_triggered_webhooks_v3
+  "select tw.id, tw.trigger_uuid, tw.trigger_type, tw.pact_publication_id, tw.webhook_id, tw.webhook_uuid, tw.consumer_id, tw.provider_id, tw.status, tw.created_at, tw.updated_at, tw.verification_id, tw.event_name
+  from triggered_webhooks tw
+  inner join (select max(id) as max_id
+    from triggered_webhooks
+    group by webhook_uuid, consumer_id, provider_id, event_name) latest_ids
+  on latest_ids.max_id = tw.id"
+end

data/db/migrations/20180119_update_latest_triggered_webhooks.rb

@@ -1,44 +1,10 @@
+require_relative '../ddl_statements/latest_triggered_webhooks'
+
 Sequel.migration do
   up do
-    # These views find the latest triggered webhook for each webhook/consumer/provider
-    # by finding the latest execution date for each webhook
-    # then taking the row with the max ID in case there there are two
-    # triggered webhooks for the same UUID and same creation date
-    # Not sure if this is strictly necessary to do the extra step, but better to be
-    # safe than sorry.
-    # I probably could just take the max ID for each webhook/consumer/provider, but
-    # something in my head says that
-    # relying on the primary key for order is not a good idea, even though
-    # according to the SQL it should be fine.
-
-    create_or_replace_view(:latest_triggered_webhook_creation_dates,
-      "select webhook_uuid, consumer_id, provider_id, max(created_at) as latest_triggered_webhook_created_at
-      from triggered_webhooks
-      group by webhook_uuid, consumer_id, provider_id"
-    )
-
-    # Ignore ltwcd.latest_triggered_webhook_created_at, it's there because postgres doesn't allow you to modify
-    # the names and types of columns in a view
-    create_or_replace_view(:latest_triggered_webhook_ids,
-      "select tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at, max(tw.id) as latest_triggered_webhook_id
-      from latest_triggered_webhook_creation_dates ltwcd
-      inner join triggered_webhooks tw
-      on tw.consumer_id = ltwcd.consumer_id
-      and tw.provider_id = ltwcd.provider_id
-      and tw.webhook_uuid = ltwcd.webhook_uuid
-      and tw.created_at = ltwcd.latest_triggered_webhook_created_at
-      group by tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at"
-    )
-
-    create_or_replace_view(:latest_triggered_webhooks,
-      "select tw.*
-      from triggered_webhooks tw
-      inner join latest_triggered_webhook_ids ltwi
-      on tw.consumer_id = ltwi.consumer_id
-      and tw.provider_id = ltwi.provider_id
-      and tw.webhook_uuid = ltwi.webhook_uuid
-      and tw.id = ltwi.latest_triggered_webhook_id"
-    )
+    create_or_replace_view(:latest_triggered_webhook_creation_dates, latest_triggered_webhook_creation_dates_v2)
+    create_or_replace_view(:latest_triggered_webhook_ids, latest_triggered_webhook_ids_v2)
+    create_or_replace_view(:latest_triggered_webhooks, latest_triggered_webhooks_v2)
   end
 
   down do

data/db/migrations/20200930_update_latest_triggered_webhooks.rb

@@ -0,0 +1,15 @@
+require_relative '../ddl_statements/latest_triggered_webhooks'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  up do
+    # TODO
+    # drop_view(:latest_triggered_webhook_ids)
+    # drop_view(:latest_triggered_webhook_creation_dates)
+    create_or_replace_view(:latest_triggered_webhooks, latest_triggered_webhooks_v3)
+  end
+
+  down do
+    create_or_replace_view(:latest_triggered_webhooks, latest_triggered_webhooks_v3_rollback(PactBroker::MigrationHelper.postgres?))
+  end
+end

data/db/migrations/20201006_add_wip_to_verification.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:verifications, :wip, TrueClass, default: false, null: false)
+  end
+end

data/db/migrations/migration_helper.rb

@@ -4,7 +4,7 @@ module PactBroker
     extend self
 
     def large_text_type
-      if adapter == 'postgres'
+      if postgres?
         :text
       else
         # Assume mysql
@@ -13,11 +13,19 @@ module PactBroker
     end
 
     def with_mysql
-      if adapter =~ /mysql/
+      if mysql?
         yield
       end
     end
 
+    def mysql?
+      adapter =~ /mysql/
+    end
+
+    def postgres?
+      adapter == 'postgres'
+    end
+
     def adapter
       Sequel::Model.db.adapter_scheme.to_s
     end

data/lib/db.rb

@@ -27,7 +27,9 @@ module DB
   def self.connect db_credentials
     # Keep this conifiguration in sync with lib/pact_broker/app.rb#configure_database_connection
     Sequel.datetime_class = DateTime
-    # logger = Logger.new($stdout)
+    if ENV['DEBUG'] == 'true'
+      logger = Logger.new($stdout)
+    end
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.extension(:pagination)

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/decorators/decorator_context.rb

@@ -2,14 +2,14 @@ module PactBroker
   module Api
     module Decorators
       class DecoratorContext < Hash
-
-        attr_reader :base_url, :resource_url, :resource_title, :env
+        attr_reader :base_url, :resource_url, :resource_title, :env, :query_string
 
         def initialize base_url, resource_url, env, options = {}
           @base_url = self[:base_url] = base_url
           @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)
           merge!(options)
         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/pagination_links.rb

@@ -0,0 +1,34 @@
+require 'roar/decorator'
+require 'roar/json/hal'
+
+module PactBroker
+  module Api
+    module Decorators
+      module PaginationLinks
+        include Roar::JSON::HAL
+        include Roar::JSON::HAL::Links
+
+        link :next do | context |
+          if represented.respond_to?(:current_page) &&
+              represented.respond_to?(:page_count) &&
+              represented.current_page < represented.page_count
+            {
+              href: context[:resource_url] + "?pageSize=#{represented.page_size}&pageNumber=#{represented.current_page + 1}",
+              title: "Next page"
+            }
+
+          end
+        end
+
+        link :previous do | context |
+          if represented.respond_to?(:first_page?) && !represented.first_page?
+            {
+              href: context[:resource_url] + "?pageSize=#{represented.page_size}&pageNumber=#{represented.current_page - 1}",
+              title: "Previous page"
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,14 +20,16 @@ module PactBroker
             getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
 
           def notices(user_options)
-            pact_url = pact_version_url(represented, user_options[:base_url])
+            metadata = represented.wip ? { wip: true } : nil
+            pact_url = pact_version_url_with_metadata(represented, metadata, user_options[:base_url])
             PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, user_options)
           end
         end
 
         link :self do | user_options |
+          metadata = represented.wip ? { wip: true } : nil
           {
-            href: pact_version_url(represented, user_options[:base_url]),
+            href: pact_version_url_with_metadata(represented, metadata, user_options[:base_url]),
             name: represented.name
           }
         end

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

@@ -1,5 +1,6 @@
 require_relative 'base_decorator'
 require_relative 'version_decorator'
+require_relative 'pagination_links'
 
 module PactBroker
   module Api
@@ -9,12 +10,15 @@ module PactBroker
         collection :entries, as: :versions, embedded: true, :extend => PactBroker::Api::Decorators::VersionDecorator
 
         link :self do | context |
+          href = append_query_if_present(context[:resource_url], context[:query_string])
           {
-            href: context[:resource_url],
+            href: href,
             title: "All application versions of #{context[:pacticipant_name]}"
           }
         end
 
+        include PaginationLinks
+
         link :'pb:pacticipant' do | context |
           {
             href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:pacticipant_name])),

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -58,19 +58,23 @@ module PactBroker
         "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}"
       end
 
-      def pact_version_url_with_metadata pact, base_url = ''
-        "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}/metadata/#{build_webhook_metadata(pact)}"
+      def pact_version_url_with_metadata pact, metadata, base_url = ''
+        if metadata && metadata.any?
+          "#{pact_version_url(pact, base_url)}/metadata/#{encode_metadata(metadata)}"
+        else
+          pact_version_url(pact, base_url)
+        end
       end
 
-      def build_webhook_metadata(pact)
-        encode_webhook_metadata(build_metadata_for_webhook_triggered_by_pact_publication(pact))
+      def pact_version_url_with_webhook_metadata pact, base_url = ''
+        pact_version_url_with_metadata(pact, build_metadata_for_webhook_triggered_by_pact_publication(pact), base_url)
       end
 
-      def encode_webhook_metadata(metadata)
+      def encode_metadata(metadata)
         Base64.strict_encode64(Rack::Utils.build_nested_query(metadata))
       end
 
-      def decode_webhook_metadata(metadata)
+      def decode_pact_metadata(metadata)
         if metadata
           begin
             Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
@@ -197,11 +201,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
@@ -299,6 +311,14 @@ module PactBroker
         ERB::Util.url_encode param
       end
 
+      def append_query_if_present(url, query)
+        if query && query.size > 0
+          url + "?#{query}"
+        else
+          url
+        end
+      end
+
       private
 
       def representable_pact pact