pact_broker 2.82.0 → 2.85.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a0cf4f6c970fd0fa0535eca1d44605e3e40d79407e6edf5e06f6ceea7160ece
-  data.tar.gz: bb6533b81dd28846a3ccda8d3fe2479c1621cd2117814ee63d5f6cf55f500079
+  metadata.gz: 274321ebbf970f7e282a64933d9d89522323c82d48b40b29b7c3921dec918e81
+  data.tar.gz: 89e6686d83aa69c88292675c4530adfbd48eff00b2c0f59ed901a13cbd14db2c
 SHA512:
-  metadata.gz: c5f7da8fe0a477ee49d54a3d2e034be142d3af6b7a942b47818e2809ae34c1d3add710ba316871d41001e4a1ec708769d51de176b37a47b4785b81778c729a0c
-  data.tar.gz: cd91ad22fb076907f240deb3322701f272b802839f2c1a6c3f44e232a452eb17fa5d5f61fe6ef0cfab3ac912d2b9700c5f33e30b918ba6bd1125735ace3af743
+  metadata.gz: 1cb98e0a974f7c440d803a47cd947579351573eeaa232e7768d012dc3b74ed9255e1520e585c56cf25eb856c43ba593cb9bceb890afb21bc61431c15ca193224
+  data.tar.gz: 893d6548ae9080919eeee2fbaee934c422da2a070b1f1ce32bb494a311a5d6f72db5b89652a683af23a1ddc14af09e1859bec47ebe3492644d612a656c171586

data/.gitignore

@@ -42,3 +42,4 @@ db/test/backwards_compatibility/pact_broker_database.sqlite3
 spec/examples.txt
 .approvals
 regression/fixtures/approvals
+config/pact_broker.local.yml

data/CHANGELOG.md

@@ -1,3 +1,56 @@
+<a name="v2.85.1"></a>
+### v2.85.1 (2021-09-14)
+
+#### Bug Fixes
+
+* fix bug identifying latest verification for tagged pact	 ([43ac4b03](/../../commit/43ac4b03))
+
+<a name="v2.85.0"></a>
+### v2.85.0 (2021-09-13)
+
+#### Features
+
+* show in the UI whether or not a pact was pending when verification failed	 ([326c068e](/../../commit/326c068e))
+* thread safe configuration overrides (#500)	 ([50900231](/../../commit/50900231))
+* allow dashboard pacts to be viewed by branch, tag, environment or all	 ([1ec8fc82](/../../commit/1ec8fc82))
+* support deleting pacts by branch in the UI	 ([bc8fef1d](/../../commit/bc8fef1d))
+* update UI	 ([0ba5eda3](/../../commit/0ba5eda3))
+
+<a name="v2.84.0"></a>
+### v2.84.0 (2021-09-10)
+
+#### Features
+
+* use the first tag as the branch when publishing pacts using the contracts/publish endpoint	 ([7b903c1d](/../../commit/7b903c1d))
+* support multiple branches per version (#495)	 ([acff2fcc](/../../commit/acff2fcc))
+* Support deleting all pacts for a specific tag in the UI (#480)	 ([10dda8ae](/../../commit/10dda8ae))
+* add webhook template parameter for GItlab verification statuses (#493)	 ([390ae0d8](/../../commit/390ae0d8))
+
+* **pacts for verification**
+  * include pending status for responses by default when includePendingStatus is not specified	 ([748d3b87](/../../commit/748d3b87))
+
+#### Bug Fixes
+
+* when the latest version for a tag does not have a pact, do not return a pact for the 'latest tag' selector	 ([374c77ce](/../../commit/374c77ce))
+* issue-reproduction/Dockerfile-pact-broker to reduce vulnerabilities (#491)	 ([9692b465](/../../commit/9692b465))
+* Dockerfile to reduce vulnerabilities (#496)	 ([57c190ef](/../../commit/57c190ef))
+
+<a name="v2.83.0"></a>
+### v2.83.0 (2021-08-19)
+
+#### Features
+
+* **clean**
+  * update default selectors for clean task to include deployed, released and branch head versions	 ([aaffe71f](/../../commit/aaffe71f))
+  * support keeping currently deployed and released versions, and the latest version for each branch	 ([e4fbd766](/../../commit/e4fbd766))
+
+* add index to verifications table to improve performance of 'latest verification' query	 ([02eeb424](/../../commit/02eeb424))
+
+#### Bug Fixes
+
+* use provider_version_number from webhook context	 ([3cf421ac](/../../commit/3cf421ac))
+* validate matrix query limit	 ([ac5e0890](/../../commit/ac5e0890))
+
 <a name="v2.82.0"></a>
 ### v2.82.0 (2021-08-14)
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.7.3-alpine3.13
+FROM ruby:2.7.4-alpine3.13
 
 WORKDIR /home
 

data/db/migrations/20210815_add_provider_version_id_index_to_verifications.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:verifications) do
+      add_index([:pact_version_id, :id], name: "verifications_pact_version_id_id_index")
+    end
+  end
+end

data/db/migrations/20210816_create_branches_tables.rb

@@ -0,0 +1,40 @@
+Sequel.migration do
+  change do
+    create_table(:branches, charset: "utf8") do
+      primary_key :id
+      String :name
+      foreign_key :pacticipant_id, :pacticipants, null: false, on_delete: :cascade
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+      index [:pacticipant_id, :name], unique: true, name: :branches_pacticipant_id_name_index
+    end
+
+    create_table(:branch_versions, charset: "utf8") do
+      primary_key :id
+      foreign_key :branch_id, :branches, null: false, foreign_key_constraint_name: :branch_versions_branches_fk, on_delete: :cascade
+      foreign_key :version_id, :versions, null: false, foreign_key_constraint_name: :branch_versions_versions_fk, on_delete: :cascade
+      Integer :version_order, null: false
+      Integer :pacticipant_id, null: false
+      String :branch_name, null: false
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+      index [:branch_id, :version_id], unique: true, name: :branch_versions_branch_id_version_id_index
+      index [:version_id], name: :branch_versions_version_id_index
+      index [:branch_name], name: :branch_versions_branch_name_index
+      # Can probably drop this index when the "latest pact" logic changes
+      index [:pacticipant_id, :branch_id, :version_order], name: :branch_versions_pacticipant_id_branch_id_version_order_index
+    end
+
+    create_table(:branch_heads) do
+      foreign_key :branch_id, :branches, null: false, on_delete: :cascade
+      foreign_key :branch_version_id, :branch_versions, null: false, on_delete: :cascade
+      Integer :version_id, null: false
+      Integer :pacticipant_id, null: false
+      String :branch_name, null: false
+      index [:branch_id], unique: true, name: :branch_heads_branch_id_index
+      index [:branch_name], name: :branch_heads_branch_name_index
+      index [:pacticipant_id], name: :branch_heads_pacticipant_id_index
+      index [:version_id], name: :branch_heads_version_id_index
+    end
+  end
+end

data/db/migrations/20210818_add_consumer_version_selectors_to_verification.rb

@@ -0,0 +1,8 @@
+Sequel.migration do
+  change do
+    alter_table(:verifications) do
+      add_column(:consumer_version_selector_hashes, String)
+      add_column(:tag_names, String)
+    end
+  end
+end

data/db/migrations/20210831_add_index_to_pact_publications.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:pact_publications) do
+      add_index [:consumer_id, :provider_id, :consumer_version_order], name: :pact_publications_cid_pid_cvo_index
+    end
+  end
+end

data/db/migrations/20210908_add_auto_created.rb

@@ -0,0 +1,24 @@
+Sequel.migration do
+  up do
+    alter_table(:branch_versions) do
+      add_column(:auto_created, TrueClass, default: false)
+    end
+
+    alter_table(:deployed_versions) do
+      add_column(:auto_created, TrueClass, default: false)
+    end
+
+    from(:branch_versions).update(auto_created: true)
+    from(:deployed_versions).update(auto_created: true)
+  end
+
+  down do
+    alter_table(:branch_versions) do
+      drop_column(:auto_created)
+    end
+
+    alter_table(:deployed_versions) do
+      drop_column(:auto_created)
+    end
+  end
+end

data/db/migrations/20210913_add_pending_to_verifications.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:verifications) do
+      add_column(:pact_pending, TrueClass)
+    end
+  end
+end

data/issue-reproduction/Dockerfile-pact-broker

@@ -1,4 +1,4 @@
-FROM ruby:2.7.3-alpine
+FROM ruby:2.7-alpine
 
 RUN apk update \
     && apk --no-cache add \

data/lib/pact/doc/markdown/consumer_contract_renderer.rb

@@ -24,7 +24,7 @@ module Pact
         attr_reader :consumer_contract
 
         def title
-          "### A pact between #{consumer_name} and #{provider_name}\n\n"
+          "# A pact between #{consumer_name} and #{provider_name}\n\n"
         end
 
         def interaction_renderers
@@ -32,11 +32,11 @@ module Pact
         end
 
         def summaries_title
-          "#### Requests from #{consumer_name} to #{provider_name}\n\n"
+          "### Requests from #{consumer_name} to #{provider_name}\n\n"
         end
 
         def interactions_title
-          "#### Interactions\n\n"
+          "### Interactions\n\n"
         end
 
         def summaries

data/lib/pact_broker/api/contracts/{verifiable_pacts_json_query_schema.rb → pacts_for_verification_json_query_schema.rb}

@@ -8,7 +8,7 @@ require "pact_broker/messages"
 module PactBroker
   module Api
     module Contracts
-      class VerifiablePactsJSONQuerySchema
+      class PactsForVerificationJSONQuerySchema
         extend DryValidationWorkarounds
         extend PactBroker::Messages
 

data/lib/pact_broker/api/contracts/{verifiable_pacts_query_schema.rb → pacts_for_verification_query_string_schema.rb}

@@ -5,7 +5,7 @@ require "pact_broker/api/contracts/dry_validation_predicates"
 module PactBroker
   module Api
     module Contracts
-      class VerifiablePactsQuerySchema
+      class PactsForVerificationQueryStringSchema
         extend DryValidationWorkarounds
         using PactBroker::HashRefinements
 

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

@@ -0,0 +1,20 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/timestamps"
+
+module PactBroker
+  module Api
+    module Decorators
+      class BranchVersionDecorator < BaseDecorator
+
+        link :self do | user_options |
+          {
+            title: "Branch version",
+            href: branch_version_url(represented, user_options.fetch(:base_url))
+          }
+        end
+
+        include Timestamps
+      end
+    end
+  end
+end

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

@@ -58,7 +58,8 @@ module PactBroker
             name: index_item.consumer_name,
             version: {
               number: index_item.consumer_version_number,
-              branch: index_item.consumer_version_branch,
+              branch: index_item.consumer_version_branches.last,
+              headBranchNames: index_item.consumer_version_branches,
               _links: {
                 self: {
                   href: version_url(base_url, index_item.consumer_version)
@@ -87,7 +88,8 @@ module PactBroker
           if index_item.latest_verification
             hash[:version] = {
               number: index_item.provider_version_number,
-              branch: index_item.provider_version_branch
+              branch: index_item.provider_version_branches.last,
+              headBranchNames: index_item.provider_version_branches
             }
           end
 

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

@@ -0,0 +1,21 @@
+require_relative "base_decorator"
+require_relative "timestamps"
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedBranchVersionDecorator < BaseDecorator
+        property :branch_name, as: :name
+        property :latest?, as: :latest
+
+        link :self do | options |
+          {
+            title: "Version branch",
+            name: represented.branch_name,
+            href: branch_version_url(represented, options[:base_url])
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -1,15 +1,10 @@
 require_relative "base_decorator"
-require_relative "pact_pacticipant_decorator"
 require_relative "timestamps"
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class EmbeddedTagDecorator < BaseDecorator
-
         property :name
 
         link :self do | options |

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

@@ -2,6 +2,7 @@ require "ostruct"
 require "pact_broker/api/pact_broker_urls"
 require "pact_broker/api/decorators/reason_decorator"
 require "pact_broker/api/decorators/format_date_time"
+require "pact_broker/api/decorators/embedded_branch_version_decorator"
 
 module PactBroker
   module Api
@@ -83,7 +84,8 @@ module PactBroker
             name: line.consumer_name,
             version: {
               number: line.consumer_version_number,
-              branch: line.consumer_version_branch,
+              branch: line.consumer_version_branch_versions.last&.branch_name,
+              branches: branches(line.consumer_version_branch_versions, base_url),
               _links: {
                 self: {
                   href: version_url(base_url, consumer_version)
@@ -99,6 +101,12 @@ module PactBroker
           }
         end
 
+        def branches(branch_versions, base_url)
+          branch_versions.collect do | branch_version |
+            PactBroker::Api::Decorators::EmbeddedBranchVersionDecorator.new(branch_version).to_hash(user_options: { base_url: base_url })
+          end
+        end
+
         def tags(tags, base_url)
           tags.sort_by(&:created_at).collect do | tag |
             {
@@ -127,7 +135,8 @@ module PactBroker
           if !line.provider_version_number.nil?
             hash[:version] = {
               number: line.provider_version_number,
-              branch: line.provider_version_branch,
+              branch: line.provider_version_branch_versions.last&.branch_name,
+              branches: branches(line.provider_version_branch_versions, base_url),
               _links: {
                 self: {
                   href: version_url(base_url, provider_version)

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

@@ -49,6 +49,14 @@ module PactBroker
           }
         end
 
+        link :'pb:branch-version' do | options |
+          {
+            title: "Get or add/create a version for a branch of #{represented.name}",
+            href: templated_branch_version_url_for_pacticipant(represented.name, options[:base_url]),
+            templated: true
+          }
+        end
+
         link :'pb:label' do | options |
           {
             title: "Get, create or delete a label for #{represented.name}",

data/lib/pact_broker/api/decorators/{verifiable_pacts_query_decorator.rb → pacts_for_verification_query_decorator.rb}

@@ -8,7 +8,7 @@ require "pact_broker/pacts/selectors"
 module PactBroker
   module Api
     module Decorators
-      class VerifiablePactsQueryDecorator < BaseDecorator
+      class PactsForVerificationQueryDecorator < BaseDecorator
         using PactBroker::HashRefinements
 
         collection :provider_version_tags, default: []
@@ -38,7 +38,7 @@ module PactBroker
             }
         end
 
-        property :include_pending_status, default: false,
+        property :include_pending_status, default: true,
           setter: ->(fragment:, represented:, **) {
             represented.include_pending_status = (fragment == "true" || fragment == true)
           }

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

@@ -45,9 +45,9 @@ module PactBroker
           when PactBroker::Matrix::IgnoreSelectorDoesNotExist
             "WARN: Cannot ignore #{reason.selector.description}"
           when PactBroker::Matrix::SelectorWithoutPacticipantVersionNumberSpecified
-            "WARN: For production use of can-i-deploy, it is recommended to specify the version number (rather than latest tag or branch) of each pacticipant to avoid race conditions."
+            "WARN: It is recommended to specify the version number (rather than the tag or branch) of the pacticipant you wish to deploy to avoid race conditions. Without a version number, this result will not be reliable."
           when PactBroker::Matrix::NoEnvironmentSpecified
-            "WARN: For production use of can-i-deploy, it is recommended to specify the environment into which you are deploying. Without the environment, this result will not be reliable."
+            "WARN: It is recommended to specify the environment into which you are deploying. Without the environment, this result will not be reliable."
           else
             reason
           end

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

@@ -6,9 +6,9 @@ require "ostruct"
 module PactBroker
   module Api
     module Decorators
-
       class VerificationSummaryDecorator < BaseDecorator
 
+        # TODO count pending failures?
         property :success
         property :provider_summary, as: :providerSummary do
           property :successful
@@ -30,7 +30,6 @@ module PactBroker
             successful: represented.select(&:success).collect(&:provider_name),
             failed: represented.select{|verification| !verification.success }.collect(&:provider_name))
         end
-
       end
     end
   end

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

@@ -7,7 +7,7 @@ module PactBroker
       class VersionDecorator < BaseDecorator
 
         property :number, writeable: false
-        property :branch
+        collection :branch_versions, as: :branches, embedded: true, writeable: false, extend: PactBroker::Api::Decorators::EmbeddedBranchVersionDecorator
         property :build_url, as: :buildUrl
 
         collection :tags, embedded: true, :extend => PactBroker::Api::Decorators::EmbeddedTagDecorator, class: OpenStruct

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

@@ -0,0 +1,33 @@
+require "pact_broker/logging"
+
+module PactBroker
+  module Api
+    module Middleware
+      class Configuration
+        include PactBroker::Logging
+
+        def initialize(app, configuration)
+          @app = app
+          @configuration = configuration
+        end
+
+        def call(env)
+          if (overrides = env["pactbroker.configuration_overrides"])&.any?
+            dupped_configuration = configuration.dup
+            dupped_configuration.override_runtime_configuration!(overrides)
+            dupped_configuration.freeze
+            PactBroker.set_configuration(dupped_configuration)
+            app.call(env)
+          else
+            PactBroker.set_configuration(configuration)
+            app.call(env)
+          end
+        end
+
+        private
+
+        attr_reader :app, :configuration
+      end
+    end
+  end
+end