pact_broker 2.77.0 → 2.80.0

data/lib/pact_broker/string_refinements.rb

@@ -1,5 +1,11 @@
 module PactBroker
   module StringRefinements
+    refine NilClass do
+      def blank?
+        true
+      end
+    end
+
     refine String do
       def not_blank?
         !blank?
@@ -13,9 +19,9 @@ module PactBroker
       def snakecase
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
         .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-        .tr('-', '_')
-        .gsub(/\s/, '_')
-        .gsub(/__+/, '_')
+        .tr("-", "_")
+        .gsub(/\s/, "_")
+        .gsub(/__+/, "_")
         .downcase
       end
 
@@ -26,7 +32,7 @@ module PactBroker
           first_letter = separators.shift
         end
 
-        separators = ['_', '\s'] if separators.empty?
+        separators = ["_", '\s'] if separators.empty?
 
         str = self.dup
 

data/lib/pact_broker/tags/eager_loaders.rb

@@ -12,8 +12,8 @@ module PactBroker
         end
 
         def self.populate_associations(tags)
-          group_by_pacticipant_id(tags).each do | pacticipant_id, tags |
-            populate_associations_by_pacticipant(pacticipant_id, tags)
+          group_by_pacticipant_id(tags).each do | pacticipant_id, participant_tags |
+            populate_associations_by_pacticipant(pacticipant_id, participant_tags)
           end
         end
 

data/lib/pact_broker/tags/head_pact_tags.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/db'
-require 'pact_broker/repositories/helpers'
+require "pact_broker/db"
+require "pact_broker/repositories/helpers"
 
 module PactBroker
   module Tags

data/lib/pact_broker/tags/repository.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/domain/tag'
-require 'pact_broker/repositories/helpers'
+require "pact_broker/domain/tag"
+require "pact_broker/repositories/helpers"
 
 module PactBroker
   module Tags

data/lib/pact_broker/tags/service.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/repositories'
+require "pact_broker/repositories"
 
 module PactBroker
   module Tags

data/lib/pact_broker/tags/tag_with_latest_flag.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/db'
-require 'pact_broker/repositories/helpers'
+require "pact_broker/db"
+require "pact_broker/repositories/helpers"
 
 module PactBroker
   module Tags

data/lib/pact_broker/tasks.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/tasks/migration_task'
-require 'pact_broker/tasks/data_migration_task'
-require 'pact_broker/tasks/delete_overwritten_data_task'
-require 'pact_broker/tasks/version_task'
-require 'pact_broker/tasks/clean_task'
+require "pact_broker/tasks/migration_task"
+require "pact_broker/tasks/data_migration_task"
+require "pact_broker/tasks/delete_overwritten_data_task"
+require "pact_broker/tasks/version_task"
+require "pact_broker/tasks/clean_task"

data/lib/pact_broker/tasks/clean_task.rb

@@ -9,15 +9,15 @@ module PactBroker
       attr_accessor :dry_run
 
       def initialize &block
-        require 'pact_broker/db/clean_incremental'
+        require "pact_broker/db/clean_incremental"
         @version_deletion_limit = 1000
         @dry_run = false
         @keep_version_selectors = PactBroker::DB::CleanIncremental::DEFAULT_KEEP_SELECTORS
-        rake_task &block
+        rake_task(&block)
       end
 
       def keep_version_selectors=(keep_version_selectors)
-        require 'pact_broker/matrix/unresolved_selector'
+        require "pact_broker/matrix/unresolved_selector"
         @keep_version_selectors = [*keep_version_selectors].collect do | hash |
           PactBroker::Matrix::UnresolvedSelector.from_hash(hash)
         end
@@ -27,14 +27,14 @@ module PactBroker
         namespace :pact_broker do
           namespace :db do
             desc "Clean unnecessary pacts and verifications from database"
-            task :clean do | t, args |
+            task :clean do | _t, _args |
 
               instance_eval(&block)
 
-              require 'pact_broker/db/clean_incremental'
-              require 'pact_broker/error'
-              require 'yaml'
-              require 'benchmark'
+              require "pact_broker/db/clean_incremental"
+              require "pact_broker/error"
+              require "yaml"
+              require "benchmark"
 
               raise PactBroker::Error.new("You must specify the version_deletion_limit") unless version_deletion_limit
 
@@ -57,13 +57,13 @@ module PactBroker
               elapsed_seconds = (end_time - start_time).to_i
               output "Results (#{elapsed_seconds} seconds)", results
             end
-
-            def output string, payload = {}
-              logger ? logger.info(string, payload: payload) : puts("#{string} #{payload.to_json}")
-            end
           end
         end
       end
+
+      def output string, payload = {}
+        logger ? logger.info(string, payload: payload) : puts("#{string} #{payload.to_json}")
+      end
     end
   end
 end

data/lib/pact_broker/tasks/data_migration_task.rb

@@ -1,4 +1,4 @@
-require 'rake/tasklib'
+require "rake/tasklib"
 
 =begin
 
@@ -18,15 +18,15 @@ module PactBroker
       attr_accessor :database_connection
 
       def initialize &block
-        rake_task &block
+        rake_task(&block)
       end
 
       def rake_task &block
         namespace :pact_broker do
           namespace :db do
             desc "Run data migrations for pact broker database"
-            task :migrate_data do | t, args |
-              require 'pact_broker/db'
+            task :migrate_data do | _t, _args |
+              require "pact_broker/db"
               instance_eval(&block)
               PactBroker::DB.run_data_migrations database_connection
             end

data/lib/pact_broker/tasks/delete_overwritten_data_task.rb

@@ -9,16 +9,16 @@ module PactBroker
 
       def initialize &block
         @max_age = 7
-        rake_task &block
+        rake_task(&block)
       end
 
       def rake_task &block
         namespace :pact_broker do
           namespace :db do
             desc "Delete overwritten pacts and verifications from database"
-            task :delete_overwritten_data do | t, args |
-              require 'pact_broker/db/delete_overwritten_data'
-              require 'yaml'
+            task :delete_overwritten_data do | _t, _args |
+              require "pact_broker/db/delete_overwritten_data"
+              require "yaml"
 
               instance_eval(&block)
               options = {}
@@ -41,13 +41,13 @@ module PactBroker
               elapsed_seconds = (end_time - start_time).to_i
               output "Results (#{elapsed_seconds} seconds)", results
             end
-
-            def output string, payload = {}
-              logger ? logger.info(string, payload: payload) : puts("#{string} #{payload.to_json}")
-            end
           end
         end
       end
+
+      def output string, payload = {}
+        logger ? logger.info(string, payload: payload) : puts("#{string} #{payload.to_json}")
+      end
     end
   end
 end

data/lib/pact_broker/tasks/migration_task.rb

@@ -1,4 +1,4 @@
-require 'rake/tasklib'
+require "rake/tasklib"
 
 =begin
 
@@ -20,16 +20,16 @@ module PactBroker
 
       def initialize &block
         @options = {}
-        rake_task &block
+        rake_task(&block)
       end
 
       def rake_task &block
         namespace :pact_broker do
           namespace :db do
             desc "Run sequel migrations for pact broker database"
-            task :migrate, [:target] do | t, args |
-              require 'pact_broker/db/migrate'
-              require 'pact_broker/db/version'
+            task :migrate, [:target] do | _t, args |
+              require "pact_broker/db/migrate"
+              require "pact_broker/db/version"
 
               instance_eval(&block)
 

data/lib/pact_broker/tasks/version_task.rb

@@ -1,4 +1,4 @@
-require 'rake/tasklib'
+require "rake/tasklib"
 
 =begin
 
@@ -18,7 +18,7 @@ module PactBroker
       attr_accessor :database_connection
 
       def initialize &block
-        rake_task &block
+        rake_task(&block)
       end
 
       def rake_task &block
@@ -27,7 +27,7 @@ module PactBroker
             desc "Display the current database migration version"
             task :version do
               instance_eval(&block)
-              require 'pact_broker/db/version'
+              require "pact_broker/db/version"
               puts PactBroker::DB::Version.call(database_connection)
             end
           end

data/lib/pact_broker/test/http_test_data_builder.rb

@@ -1,8 +1,8 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'logger'
-require 'erb'
-require 'yaml'
+require "faraday"
+require "faraday_middleware"
+require "logger"
+require "erb"
+require "yaml"
 
 module PactBroker
   module Test
@@ -14,13 +14,13 @@ module PactBroker
         @client = Faraday.new(url: pact_broker_base_url) do |faraday|
           faraday.request :json
           faraday.response :json, :content_type => /\bjson$/
-          if ENV['DEBUG'] == 'true'
-            faraday.response :logger, ::Logger.new($stdout), headers: false do | logger |
+          if ENV["DEBUG"] == "true"
+            faraday.response :logger, ::Logger.new($stdout), headers: false, body: true do | logger |
               logger.filter(/(Authorization: ).*/,'\1[REMOVED]')
             end
           end
-          faraday.headers['Authorization'] = "Bearer #{auth[:token]}" if auth[:token]
-          faraday.adapter  Faraday.default_adapter
+          faraday.headers["Authorization"] = "Bearer #{auth[:token]}" if auth[:token]
+          faraday.adapter Faraday.default_adapter
         end
       end
 
@@ -33,9 +33,16 @@ module PactBroker
         puts "\n=============================================================\n\n"
       end
 
+      def comment string
+        puts "**********************************************************"
+        puts string
+        puts "**********************************************************\n\n"
+        self
+      end
+
       def create_tagged_pacticipant_version(pacticipant:, version:, tag:)
-        [*tag].each do | tag |
-          create_tag(pacticipant: pacticipant, version: version, tag: tag)
+        [*tag].each do | t |
+          create_tag(pacticipant: pacticipant, version: version, tag: t)
         end
         self
       end
@@ -51,6 +58,7 @@ module PactBroker
           branch: branch
         }
         client.put("pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}", request_body).tap { |response| check_for_error(response) }
+        self
       end
 
       def deploy_to_prod(pacticipant:, version:)
@@ -60,9 +68,34 @@ module PactBroker
         self
       end
 
-      def create_pacticipant(name)
+      def record_deployment(pacticipant:, version:, environment_name:)
+        puts "Recording deployment of #{pacticipant} version #{version} to #{environment_name}"
+        version_body = client.get("/pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}").tap { |response| check_for_error(response) }.body
+        environment_relation = version_body["_links"]["pb:record-deployment"].find { |relation| relation["name"] == environment_name }
+        client.post(environment_relation["href"], { replacedPreviousDeployedVersion: true }).tap { |response| check_for_error(response) }
+        separate
+        self
+      end
+
+      def record_release(pacticipant:, version:, environment_name:)
+        puts "Recording release of #{pacticipant} version #{version} to #{environment_name}"
+        version_body = client.get("/pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}").tap { |response| check_for_error(response) }.body
+        environment_relation = version_body["_links"]["pb:record-release"].find { |relation| relation["name"] == environment_name }
+        client.post(environment_relation["href"], { replacedPreviousDeployedVersion: true }).tap { |response| check_for_error(response) }
+        separate
+        self
+      end
+
+      def create_environment(name:, production: false)
+        puts "Creating environment #{name}"
+        client.post("/environments", { name: name, displayName: name, production: production }).tap { |response| check_for_error(response) }
+        separate
+        self
+      end
+
+      def create_pacticipant(name, main_branch: nil)
         puts "Creating pacticipant with name #{name}"
-        client.post("pacticipants", { name: name}).tap { |response| check_for_error(response) }
+        client.post("pacticipants", { name: name, mainBranch: main_branch }).tap { |response| check_for_error(response) }
         separate
         self
       end
@@ -74,8 +107,8 @@ module PactBroker
 
         create_version(pacticipant: consumer, version: consumer_version, branch: branch) if branch
 
-        [*tag].each do | tag |
-          create_tag(pacticipant: consumer, version: consumer_version, tag: tag)
+        [*tag].each do | t |
+          create_tag(pacticipant: consumer, version: consumer_version, tag: t)
         end
         puts "" if [*tag].any?
 
@@ -123,12 +156,12 @@ module PactBroker
         self
       end
 
-      def verify_latest_pact_for_tag(success: true, provider: last_provider_name, consumer: last_consumer_name, consumer_version_tag: , provider_version:, provider_version_tag: nil)
+      def verify_latest_pact_for_tag(success: true, provider: last_provider_name, consumer: last_consumer_name, consumer_version_tag: , provider_version:, provider_version_tag: nil, provider_version_branch: nil)
         @last_provider_name = provider
         @last_consumer_name = consumer
 
         url_of_pact_to_verify = "pacts/provider/#{encode(provider)}/consumer/#{encode(consumer)}/latest/#{encode(consumer_version_tag)}"
-        publish_verification_results(url_of_pact_to_verify, provider, provider_version, provider_version_tag, success)
+        publish_verification_results(url_of_pact_to_verify, provider, provider_version, provider_version_tag, provider_version_branch, success)
         separate
         self
       end
@@ -142,14 +175,18 @@ module PactBroker
         raise "No pact found to verify at index #{index}" unless pact_to_verify
         url_of_pact_to_verify = pact_to_verify["_links"]["self"]["href"]
 
-        publish_verification_results(url_of_pact_to_verify, provider, provider_version, provider_version_tag, success)
+        publish_verification_results(url_of_pact_to_verify, provider, provider_version, provider_version_tag, provider_version_branch, success)
         separate
         self
       end
 
-      def create_global_webhook_for_contract_changed(uuid: nil, url: "https://postman-echo.com/post")
+      def create_global_webhook_for_contract_changed(uuid: nil, url: "https://postman-echo.com/post", body: nil)
         puts "Creating global webhook for contract changed event with uuid #{uuid}"
         uuid ||= SecureRandom.uuid
+        default_body = {
+          "deployedProviderVersion" => "${pactbroker.currentlyDeployedProviderVersionNumber}",
+          "consumerVersionBranch" => "${pactbroker.consumerVersionBranch}"
+        }
         request_body = {
           "description" => "A webhook for all consumers and providers",
           "events" => [{
@@ -157,16 +194,17 @@ module PactBroker
           }],
           "request" => {
             "method" => "POST",
-            "url" => url
+            "url" => url,
+            "body" => body || default_body
           }
         }
         path = "webhooks/#{uuid}"
-        response = client.put(path, request_body.to_json).tap { |response| check_for_error(response) }
+        client.put(path, request_body.to_json).tap { |response| check_for_error(response) }
         separate
         self
       end
 
-      def create_global_webhook_for_verification_published(uuid: nil, url: "https://postman-echo.com/post")
+      def create_global_webhook_for_anything_published(uuid: nil, url: "https://postman-echo.com/post")
         puts "Creating global webhook for contract changed event with uuid #{uuid}"
         uuid ||= SecureRandom.uuid
         request_body = {
@@ -186,12 +224,13 @@ module PactBroker
               "consumerVersionTags" => "${pactbroker.consumerVersionTags}",
               "githubVerificationStatus" => "${pactbroker.githubVerificationStatus}",
               "providerVersionNumber" => "${pactbroker.providerVersionNumber}",
-              "providerVersionTags" => "${pactbroker.providerVersionTags}"
+              "providerVersionTags" => "${pactbroker.providerVersionTags}",
+              "canIMerge" => "${pactbroker.providerMainBranchGithubVerificationStatus}"
             }
           }
         }
         path = "webhooks/#{uuid}"
-        response = client.put(path, request_body.to_json).tap { |response| check_for_error(response) }
+        client.put(path, request_body.to_json).tap { |response| check_for_error(response) }
         separate
         self
       end
@@ -199,7 +238,7 @@ module PactBroker
       def delete_webhook(uuid:)
         puts "Deleting webhook with uuid #{uuid}"
         path = "webhooks/#{uuid}"
-        response = client.delete(path).tap { |response| check_for_error(response) }
+        client.delete(path).tap { |response| check_for_error(response) }
         separate
         self
       end
@@ -211,10 +250,10 @@ module PactBroker
 
       def can_i_deploy(pacticipant:, version:, to:)
         can_i_deploy_response = client.get("can-i-deploy", { pacticipant: pacticipant, version: version, to: to} ).tap { |response| check_for_error(response) }
-        can = !!(can_i_deploy_response.body['summary'] || {})['deployable']
+        can = !!(can_i_deploy_response.body["summary"] || {})["deployable"]
         puts "can-i-deploy #{pacticipant} version #{version} to #{to}: #{can ? 'yes' : 'no'}"
-        summary = can_i_deploy_response.body['summary']
-        verification_result_urls = (can_i_deploy_response.body['matrix'] || []).collect do | row |
+        summary = can_i_deploy_response.body["summary"]
+        verification_result_urls = (can_i_deploy_response.body["matrix"] || []).collect do | row |
           row.dig("verificationResult", "_links", "self", "href")
         end.compact
         summary.merge!("verification_result_urls" => verification_result_urls)
@@ -262,12 +301,14 @@ module PactBroker
 
       private
 
-      def publish_verification_results(url_of_pact_to_verify, provider, provider_version, provider_version_tag, success)
+      def publish_verification_results(url_of_pact_to_verify, provider, provider_version, provider_version_tag, provider_version_branch, success)
         [*provider_version_tag].each do | tag |
           create_tag(pacticipant: provider, version: provider_version, tag: tag)
         end
         puts "" if [*provider_version_tag].any?
 
+        create_version(pacticipant: provider, version: provider_version, branch: provider_version_branch) if provider_version_branch
+
         pact_response = client.get(url_of_pact_to_verify).tap { |response| check_for_error(response) }
         verification_results_url = pact_response.body["_links"]["pb:publish-verification-results"]["href"]
 
@@ -278,7 +319,7 @@ module PactBroker
         }
         puts "Publishing verification"
         puts results.to_yaml
-        response = client.post(verification_results_url, results.to_json).tap { |response| check_for_error(response) }
+        client.post(verification_results_url, results.to_json).tap { |response| check_for_error(response) }
       end
 
       def encode string
@@ -293,4 +334,4 @@ module PactBroker
       end
     end
   end
-end
+end