pact_broker 2.83.0 → 2.84.0

data/lib/pact_broker/api.rb

@@ -87,6 +87,7 @@ module PactBroker
         add ["pacticipants", :pacticipant_name, "latest-version"], Api::Resources::LatestVersion, {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"}
+        add ["pacticipants", :pacticipant_name, "branches", :branch_name, "versions", :version_number], Api::Resources::BranchVersion, { resource_name: "branch_version" }
 
         # Webhooks
         add ["webhooks", "provider", :provider_name, "consumer", :consumer_name ], Api::Resources::PacticipantWebhooks, {resource_name: "pacticipant_webhooks"}

data/lib/pact_broker/config/runtime_configuration.rb

@@ -8,6 +8,18 @@ require "pact_broker/string_refinements"
 require "pact_broker/hash_refinements"
 require "pact_broker/error"
 
+module Anyway
+  module Tracing
+    class << self
+      # Override this method so that we get the real caller location, not the forwardable one from
+      # the `extend Forwardable` in the PactBroker::Configuration class.
+      def current_trace_source
+        source_stack.last || accessor_source(caller_locations(2, 2).find { | location | !location.path.end_with?("forwardable.rb") })
+      end
+    end
+  end
+end
+
 module PactBroker
   module Config
     class RuntimeConfiguration < Anyway::Config

data/lib/pact_broker/contracts/service.rb

@@ -76,7 +76,7 @@ module PactBroker
 
       def create_tags(parsed_contracts, version)
         (parsed_contracts.tags || []).collect do | tag_name |
-          tag_repository.create(version: version, name: tag_name)
+          tag_service.create(pacticipant_name: version.pacticipant.name, pacticipant_version_number: version.number, tag_name: tag_name)
         end
       end
 

data/lib/pact_broker/db/data_migrations/create_branches.rb

@@ -0,0 +1,97 @@
+require "pact_broker/db/data_migrations/helpers"
+
+module PactBroker
+  module DB
+    module DataMigrations
+      class CreateBranches
+        extend Helpers
+
+        def self.call connection
+          if required_columns_exist?(connection)
+            branch_ids = create_branch_versions(connection)
+            upsert_branch_heads(connection, branch_ids)
+          end
+        end
+
+        def self.required_columns_exist?(connection)
+          column_exists?(connection, :versions, :branch) &&
+            connection.table_exists?(:branches) &&
+            connection.table_exists?(:branch_versions) &&
+            connection.table_exists?(:branch_heads)
+        end
+
+        def self.create_branch_versions(connection)
+          versions_without_a_branch_version(connection).collect do | version |
+            create_branch_version(connection, version)
+          end.uniq
+        end
+
+        def self.upsert_branch_heads(connection, branch_ids)
+          branch_ids.each do | branch_id |
+            upsert_branch_head(connection, branch_id)
+          end
+        end
+
+        def self.versions_without_a_branch_version(connection)
+          branch_versions_join = {
+            Sequel[:versions][:id] => Sequel[:branch_versions][:version_id],
+            Sequel[:branch_versions][:branch_name] => Sequel[:versions][:branch]
+          }
+
+          connection[:versions]
+            .select(Sequel[:versions].*)
+            .exclude(branch: nil)
+            .left_outer_join(:branch_versions, branch_versions_join)
+            .where(Sequel[:branch_versions][:branch_name] => nil)
+            .order(:pacticipant_id, :order)
+        end
+
+        def self.create_branch_version(connection, version)
+          branch_values = {
+            name: version[:branch],
+            pacticipant_id: version[:pacticipant_id],
+            created_at: version[:created_at],
+            updated_at: version[:created_at]
+          }
+          connection[:branches].insert_ignore.insert(branch_values)
+          branch_id = connection[:branches].select(:id).where(pacticipant_id: version[:pacticipant_id], name: version[:branch]).single_record[:id]
+
+          branch_version_values = {
+            pacticipant_id: version[:pacticipant_id],
+            version_id: version[:id],
+            version_order: version[:order],
+            branch_id: branch_id,
+            branch_name: version[:branch],
+            created_at: version[:created_at],
+            updated_at: version[:created_at]
+          }
+
+          connection[:branch_versions].insert_ignore.insert(branch_version_values)
+          branch_id
+        end
+
+        def self.upsert_branch_head(connection, branch_id)
+          latest_branch_version = connection[:branch_versions].where(branch_id: branch_id).order(:version_order).last
+
+          if connection[:branch_heads].where(branch_id: branch_id).empty?
+            branch_head_values = {
+              pacticipant_id: latest_branch_version[:pacticipant_id],
+              branch_id: branch_id,
+              branch_version_id: latest_branch_version[:id],
+              version_id: latest_branch_version[:version_id],
+              branch_name: latest_branch_version[:branch_name]
+            }
+            connection[:branch_heads].insert(branch_head_values)
+          else
+            connection[:branch_heads]
+              .where(branch_id: branch_id)
+              .update(
+                branch_version_id: latest_branch_version[:id],
+                version_id: latest_branch_version[:version_id]
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/db/data_migrations/set_pacticipant_main_branch.rb

@@ -1,6 +1,8 @@
 require "pact_broker/db/data_migrations/helpers"
 require "pact_broker/logging"
 
+# Not required now we have the auto_detect_main_branch feature
+
 module PactBroker
   module DB
     module DataMigrations

data/lib/pact_broker/db/migrate_data.rb

@@ -23,10 +23,10 @@ module PactBroker
         DataMigrations::SetCreatedAtForLatestVerifications.call(database_connection)
         DataMigrations::SetExtraColumnsForTags.call(database_connection)
         DataMigrations::SetPacticipantDisplayName.call(database_connection)
-        DataMigrations::SetPacticipantMainBranch.call(database_connection)
         DataMigrations::SetWebhookUuid.call(database_connection)
         DataMigrations::SetConsumerVersionOrderForPactPublications.call(database_connection)
         DataMigrations::SetExtraColumnsForTags.call(database_connection)
+        DataMigrations::CreateBranches.call(database_connection)
       end
     end
   end

data/lib/pact_broker/db/models.rb

@@ -16,6 +16,9 @@ require "pact_broker/deployments/deployed_version"
 require "pact_broker/deployments/released_version"
 require "pact_broker/matrix/row"
 require "pact_broker/matrix/head_row"
+require "pact_broker/versions/branch"
+require "pact_broker/versions/branch_version"
+require "pact_broker/versions/branch_head"
 
 module PactBroker
   INTEGRATIONS_TABLES = [
@@ -30,6 +33,9 @@ module PactBroker
     PactBroker::Domain::Tag,
     PactBroker::Deployments::DeployedVersion,
     PactBroker::Deployments::ReleasedVersion,
+    PactBroker::Versions::BranchHead,
+    PactBroker::Versions::BranchVersion,
+    PactBroker::Versions::Branch,
     PactBroker::Domain::Version,
     PactBroker::Domain::Label,
     PactBroker::Domain::Pacticipant

data/lib/pact_broker/deployments/deployed_version.rb

@@ -15,6 +15,10 @@ module PactBroker
       dataset_module do
         include PactBroker::Repositories::Helpers
 
+        def user_created
+          where(auto_created: false)
+        end
+
         def last_deployed_version(pacticipant, environment)
           currently_deployed
             .where(pacticipant_id: pacticipant.id)

data/lib/pact_broker/deployments/deployed_version_service.rb

@@ -17,7 +17,7 @@ module PactBroker
         DeployedVersion.where(uuid: uuid).single_record
       end
 
-      def self.find_or_create(uuid, version, environment, target)
+      def self.find_or_create(uuid, version, environment, target, auto_created: false)
         if (deployed_version = find_currently_deployed_version_for_version_and_environment_and_target(version, environment, target))
           deployed_version
         else
@@ -27,7 +27,8 @@ module PactBroker
             version: version,
             pacticipant_id: version.pacticipant_id,
             environment: environment,
-            target: target
+            target: target,
+            auto_created: auto_created
           )
         end
       end
@@ -76,7 +77,7 @@ module PactBroker
         if PactBroker.configuration.create_deployed_versions_for_tags
           if (environment = environment_service.find_by_name(environment_name))
             logger.info("Creating deployed version for #{version.pacticipant.name} version #{version.number} in environment #{environment_name} (because create_deployed_versions_for_tags=true)")
-            find_or_create(next_uuid, version, environment, nil)
+            find_or_create(next_uuid, version, environment, nil, auto_created: true)
           end
         end
       end

data/lib/pact_broker/deployments/environment.rb

@@ -25,6 +25,10 @@ module PactBroker
         PactBroker::Deployments::ReleasedVersion.where(environment: self).delete
         super
       end
+
+      def production?
+        production
+      end
     end
   end
 end

data/lib/pact_broker/deployments/environment_service.rb

@@ -7,12 +7,17 @@ module PactBroker
   module Deployments
     module EnvironmentService
       using PactBroker::StringRefinements
+      extend self
 
-      def self.next_uuid
+      def self.included(base)
+        base.extend(self)
+      end
+
+      def next_uuid
         SecureRandom.uuid
       end
 
-      def self.create(uuid, environment)
+      def create(uuid, environment)
         environment.uuid = uuid
         if environment.display_name.blank?
           environment.display_name = PactBroker::Pacticipants::GenerateDisplayName.call(environment.name)
@@ -20,7 +25,7 @@ module PactBroker
         environment.save
       end
 
-      def self.update(uuid, environment)
+      def update(uuid, environment)
         environment.uuid = uuid
         if environment.display_name.blank?
           environment.display_name = PactBroker::Pacticipants::GenerateDisplayName.call(environment.name)
@@ -28,23 +33,23 @@ module PactBroker
         environment.upsert
       end
 
-      def self.find_all
+      def find_all
         PactBroker::Deployments::Environment.order(Sequel.function(:lower, :display_name)).all
       end
 
-      def self.find(uuid)
+      def find(uuid)
         PactBroker::Deployments::Environment.where(uuid: uuid).single_record
       end
 
-      def self.find_by_name(name)
+      def find_by_name(name)
         PactBroker::Deployments::Environment.where(name: name).single_record
       end
 
-      def self.delete(uuid)
+      def delete(uuid)
         PactBroker::Deployments::Environment.where(uuid: uuid).delete
       end
 
-      def self.find_for_pacticipant(_pacticipant)
+      def find_for_pacticipant(_pacticipant)
         find_all
       end
     end

data/lib/pact_broker/doc/views/index/pacticipant-branch-version.markdown

@@ -0,0 +1,14 @@
+# Pacticipant branch version
+
+Allowed methods: `GET`, `PUT`
+
+Path: `/pacticipants/{pacticipant}/branches/{branch}/versions/{version}`
+
+Get or add/create a pacticipant version for a branch.
+
+## Example
+
+Add a version to a branch. The pacticipant and branch are automatically created if they do not exist.
+
+    curl -XPUT http://broker/pacticipants/Bar/branches/main/versions/1e70030c6579915e5ff56b107a0fd25cf5df7464 \
+          -H "Content-Type: application/json" -d "{}"

data/lib/pact_broker/doc/views/webhooks.markdown

@@ -108,6 +108,7 @@ The following variables may be used in the request path, parameters or body, and
 * `${pactbroker.providerLabels}`: the list of labels for the provider associated with the pact content, separated by ", ".
 * `${pactbroker.githubVerificationStatus}`: the verification status using the correct keywords for posting to the the [Github commit status API](https://developer.github.com/v3/repos/statuses).
 * `${pactbroker.bitbucketVerificationStatus}`: the verification status using the correct keywords for posting to the the [Bitbucket commit status API](https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/).
+* `${pactbroker.gitlabVerificationStatus}`: the verification status using the correct keywords for posting to the the [Gitlab Commits API](https://docs.gitlab.com/ee/api/commits.html#post-the-build-status-to-a-commit).
 * `${pactbroker.verificationResultUrl}`: the URL to the relevant verification result.
 
 Example usage:

data/lib/pact_broker/domain/index_item.rb

@@ -5,23 +5,25 @@ module PactBroker
   module Domain
     class IndexItem
       attr_reader :consumer,
-        :provider,
-        :latest_pact,
-        :latest_verification,
-        :webhooks,
-        :triggered_webhooks,
-        :latest_verification_latest_tags
+                  :provider,
+                  :consumer_version,
+                  :latest_pact,
+                  :latest_verification,
+                  :webhooks,
+                  :triggered_webhooks,
+                  :latest_verification_latest_tags,
 
       # rubocop:disable Metrics/ParameterLists
-      def self.create(consumer, provider, latest_pact, latest, latest_verification, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = [], latest_for_branch = nil)
-        new(consumer, provider, latest_pact, latest, latest_verification, webhooks, triggered_webhooks, tags, latest_verification_latest_tags, latest_for_branch)
+      def self.create(consumer, provider, consumer_version, latest_pact, latest, latest_verification, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = [], latest_for_branch = nil)
+        new(consumer, provider, consumer_version, latest_pact, latest, latest_verification, webhooks, triggered_webhooks, tags, latest_verification_latest_tags, latest_for_branch)
       end
       # rubocop:enable Metrics/ParameterLists
 
       # rubocop:disable Metrics/ParameterLists
-      def initialize(consumer, provider, latest_pact = nil, latest = true, latest_verification = nil, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = [], latest_for_branch = nil)
+      def initialize(consumer, provider, consumer_version = nil, latest_pact = nil, latest = true, latest_verification = nil, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = [], latest_for_branch = nil)
         @consumer = consumer
         @provider = provider
+        @consumer_version = consumer_version
         @latest_pact = latest_pact
         @latest = latest
         @latest_verification = latest_verification
@@ -68,12 +70,8 @@ module PactBroker
         consumer_version.order
       end
 
-      def consumer_version
-        @latest_pact.consumer_version
-      end
-
-      def consumer_version_branch
-        consumer_version.branch
+      def consumer_version_branches
+        consumer_version.branch_heads.collect(&:branch_name)
       end
 
       def consumer_version_environment_names
@@ -92,8 +90,8 @@ module PactBroker
         @latest_verification ? @latest_verification.provider_version_number : nil
       end
 
-      def provider_version_branch
-        provider_version&.branch
+      def provider_version_branches
+        provider_version&.branch_heads&.collect(&:branch_name) || []
       end
 
       def provider_version_environment_names

data/lib/pact_broker/domain/pacticipant.rb

@@ -22,6 +22,8 @@ module PactBroker
       one_to_many :labels, :order => :name, :reciprocal => :pacticipant
       one_to_many :pacts
       one_to_one :latest_version, :class => "PactBroker::Versions::LatestVersion", primary_key: :id, key: :pacticipant_id
+      one_to_many :branch_heads, class: "PactBroker::Versions::BranchHead", primary_key: :id, key: :pacticipant_id
+      one_to_many :branches, class: "PactBroker::Versions::Branch", primary_key: :id, key: :pacticipant_id
 
       dataset_module do
         include PactBroker::Repositories::Helpers
@@ -38,6 +40,10 @@ module PactBroker
         def find_by_name(name)
           where(name_like(:name, name))
         end
+
+        def where_name(name)
+          where(name_like(:name, name))
+        end
       end
 
       def before_destroy
@@ -66,6 +72,10 @@ module PactBroker
       def any_versions?
         PactBroker::Domain::Version.where(pacticipant: self).any?
       end
+
+      def branch_head_for(branch_name)
+        branch_heads.find{ | branch_head | branch_head.branch_name == branch_name }
+      end
     end
   end
 end
@@ -87,6 +97,7 @@ end
 #  pacticipants_name_key | UNIQUE btree (name)
 #  ndx_ppt_name          | btree (name)
 # Referenced By:
+#  branches                                                     | branches_pacticipant_id_fkey                                    | (pacticipant_id) REFERENCES pacticipants(id) ON DELETE CASCADE
 #  currently_deployed_version_ids                               | currently_deployed_version_ids_pacticipant_id_fkey              | (pacticipant_id) REFERENCES pacticipants(id) ON DELETE CASCADE
 #  labels                                                       | labels_pacticipant_id_fkey                                      | (pacticipant_id) REFERENCES pacticipants(id)
 #  latest_pact_publication_ids_for_consumer_versions            | latest_pact_publication_ids_for_consumer_versi_consumer_id_fkey | (consumer_id) REFERENCES pacticipants(id) ON DELETE CASCADE

data/lib/pact_broker/domain/tag.rb

@@ -130,6 +130,7 @@ module PactBroker
 
       # rubocop: disable Metrics/CyclomaticComplexity
       def before_save
+        super
         if version
           if version.order && self.version_order.nil?
             self.version_order = version.order
@@ -146,8 +147,6 @@ module PactBroker
 
         if version_order.nil? || pacticipant_id.nil?
           raise PactBroker::Error.new("Need to set version_order and pacticipant_id for tags now")
-        else
-          super
         end
       end
       # rubocop: enable Metrics/CyclomaticComplexity

data/lib/pact_broker/domain/verification.rb

@@ -222,23 +222,26 @@ end
 
 # Table: verifications
 # Columns:
-#  id                  | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
-#  number              | integer                     |
-#  success             | boolean                     | NOT NULL
-#  provider_version    | text                        |
-#  build_url           | text                        |
-#  pact_version_id     | integer                     | NOT NULL
-#  execution_date      | timestamp without time zone | NOT NULL
-#  created_at          | timestamp without time zone | NOT NULL
-#  provider_version_id | integer                     |
-#  test_results        | text                        |
-#  consumer_id         | integer                     |
-#  provider_id         | integer                     |
-#  wip                 | boolean                     | NOT NULL DEFAULT false
+#  id                               | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  number                           | integer                     |
+#  success                          | boolean                     | NOT NULL
+#  provider_version                 | text                        |
+#  build_url                        | text                        |
+#  pact_version_id                  | integer                     | NOT NULL
+#  execution_date                   | timestamp without time zone | NOT NULL
+#  created_at                       | timestamp without time zone | NOT NULL
+#  provider_version_id              | integer                     |
+#  test_results                     | text                        |
+#  consumer_id                      | integer                     |
+#  provider_id                      | integer                     |
+#  wip                              | boolean                     | NOT NULL DEFAULT false
+#  consumer_version_selector_hashes | text                        |
+#  tag_names                        | text                        |
 # Indexes:
 #  verifications_pkey                          | PRIMARY KEY btree (id)
 #  verifications_pact_version_id_number_index  | UNIQUE btree (pact_version_id, number)
 #  verifications_consumer_id_index             | btree (consumer_id)
+#  verifications_pact_version_id_id_index      | btree (pact_version_id, id)
 #  verifications_provider_id_consumer_id_index | btree (provider_id, consumer_id)
 #  verifications_provider_id_index             | btree (provider_id)
 # Foreign key constraints: