pact_broker 2.83.0 → 2.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d8ba30424126875c015264b7ba7e8fd7feb281a019f3436b5c714c7c5ddd0a
-  data.tar.gz: 4858eeee386bb44f6d9880b79a92b71d3760b8307fb5faebe07efa8f773fb2ba
+  metadata.gz: d104329cabc691c2ec288acee11837621c8970181a6dddf7d4bf7e4c5d3f48fe
+  data.tar.gz: d7c5c2a75605aa5f947495670d995d5d5500f487dff86ae676da3bd883c55510
 SHA512:
-  metadata.gz: 23a3f387f860177de7cfdc7152127fd295aa124b415e0d1b7b66c657947c0b89ea06decff7bf2b840d75b690b844bd0fb2999ddb14deb4b269d21e9e5cc7d736
-  data.tar.gz: 98c2642b548b2b08ac71fe55a66c18981392ea575bc6c2ca389c19c1f283b134c814cf2479e03d7899bb70a8d244c1987fca10556833df5c3c506e45dfd5ee07
+  metadata.gz: 7a973402c0c004acd5f94cc0c04efec0ded2039f43dfd3e2ca7ba014b853f958345b2ada02c05af05748416dbe466596920d8112c34efd71a5533c212ab6002c
+  data.tar.gz: 9bf006fa32ad47353df1bb9704a8da05205de57da618273ca0c0cb3b487c570951caa1e0ab3624177aa82a12c329d63aeba11c07c87b1eaa1e368956edd72250

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+<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)
 

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/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/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/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_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/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/pact_broker_urls.rb

@@ -199,10 +199,18 @@ module PactBroker
         "#{tags_url(base_url, tag.version)}/#{url_encode(tag.name)}"
       end
 
+      def branch_version_url(branch_version, base_url = "")
+        "#{pacticipant_url(base_url, branch_version.pacticipant)}/branches/#{url_encode(branch_version.branch_name)}/versions/#{url_encode(branch_version.version_number)}"
+      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}"
       end
 
+      def templated_branch_version_url_for_pacticipant pacticipant_name, base_url = ""
+        pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/branches/{branch}/versions/{version}"
+      end
+
       def templated_version_url_for_pacticipant pacticipant_name, base_url = ""
         pacticipant_url_from_params({ pacticipant_name: pacticipant_name }, base_url) + "/versions/{version}"
       end

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

@@ -0,0 +1,48 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/decorators/branch_version_decorator"
+
+module PactBroker
+  module Api
+    module Resources
+      class BranchVersion < BaseResource
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def content_types_accepted
+          [["application/json", :from_json]]
+        end
+
+        def allowed_methods
+          ["GET", "PUT", "OPTIONS"]
+        end
+
+        def resource_exists?
+          !!branch_version
+        end
+
+        def to_json
+          decorator_class(:branch_version_decorator).new(branch_version).to_json(decorator_options)
+        end
+
+        def from_json
+          already_existed = !!branch_version
+          @branch_version = branch_service.find_or_create_branch_version(identifier_from_path)
+          # Make it return a 201 by setting the Location header
+          response.headers["Location"] = branch_version_url(branch_version, base_url) unless already_existed
+          response.body = to_json
+        end
+
+        def policy_name
+          :'versions::branch_version'
+        end
+
+        private
+
+        def branch_version
+          @branch_version ||= branch_service.find_branch_version(identifier_from_path)
+        end
+      end
+    end
+  end
+end

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

@@ -116,6 +116,12 @@ module PactBroker
               title: "Get, create or delete a tag for a pacticipant version",
               templated: true
             },
+            "pb:pacticipant-branch-version" =>
+            {
+              href: base_url + "/pacticipants/{pacticipant}/branches/{branch}/versions/{version}",
+              title: "Get or add/create a pacticipant version for a branch",
+              templated: true
+            },
             "pb:pacticipant-version" =>
             {
               href: base_url + "/pacticipants/{pacticipant}/versions/{version}",

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

@@ -1,8 +1,8 @@
 require "pact_broker/api/resources/provider_pacts"
 require "pact_broker/api/decorators/verifiable_pacts_decorator"
-require "pact_broker/api/contracts/verifiable_pacts_query_schema"
-require "pact_broker/api/decorators/verifiable_pacts_query_decorator"
-require "pact_broker/api/contracts/verifiable_pacts_json_query_schema"
+require "pact_broker/api/contracts/pacts_for_verification_query_string_schema"
+require "pact_broker/api/decorators/pacts_for_verification_query_decorator"
+require "pact_broker/api/contracts/pacts_for_verification_json_query_schema"
 require "pact_broker/hash_refinements"
 
 module PactBroker
@@ -69,14 +69,14 @@ module PactBroker
 
         def query_schema
           if request.get?
-            PactBroker::Api::Contracts::VerifiablePactsQuerySchema
+            PactBroker::Api::Contracts::PactsForVerificationQueryStringSchema
           else
-            PactBroker::Api::Contracts::VerifiablePactsJSONQuerySchema
+            PactBroker::Api::Contracts::PactsForVerificationJSONQuerySchema
           end
         end
 
         def parsed_query_params
-          @parsed_query_params ||= decorator_class(:verifiable_pacts_query_decorator).new(OpenStruct.new).from_hash(query)
+          @parsed_query_params ||= decorator_class(:pacts_for_verification_query_decorator).new(OpenStruct.new).from_hash(query)
         end
 
         def query

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

@@ -21,14 +21,6 @@ module PactBroker
           ["GET", "PUT", "PATCH", "DELETE", "OPTIONS"]
         end
 
-        def is_conflict?
-          if (errors = version_service.conflict_errors(version, parsed_version, resource_url)).any?
-            set_json_validation_error_messages(errors)
-          else
-            false
-          end
-        end
-
         def resource_exists?
           !!version
         end