pact_broker 2.80.0 → 2.81.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46291e7e974e823aee921175212537b972fea3789b7355526a0258903d6cc31c
-  data.tar.gz: fdf706a490c487fa1a7f442864bca233d3c8488cdd688575dcfca0932014c61e
+  metadata.gz: 264cb3fe694b76c1efc4ee585043f68957485f477ef60154357d72535741dc9e
+  data.tar.gz: 2081f35b9a33d5e8ebe9817f5fda62b35378f437a66e69c2611555dc0f78228b
 SHA512:
-  metadata.gz: 0fefcf924101d8e979e0ed1ccb96c7d771cb823e4f7c4d0ac527981414323a6bcddfa9b9cec68086e39da1ab261596e86c0ae808efe21aa621d1364b78be5cd0
-  data.tar.gz: 32c2af6c35ccba62a58273bc8b3f6882969f02ef23d7ada3b0e74054f8b0cdbc284837b96c9f01be6b954bcc1cd4300e0e88c13cc0886fdc88993d6cf865077e
+  metadata.gz: bf0de96a30b0893206130d39f9ae19d23eb411e81440d7a2099aa6dfe36cdb5ddd9d135f51d164f17b439d7a8db07ea060e5bc0a7e6b0a980e87b100f6e23cf1
+  data.tar.gz: de1636fa911c024295c7b6d94df91219f7a7fe9a8ed3d838cbad635477b4623b220a0493181bac49652994bd19fb7a40f330a8a9bfc8efc25ceb20727c2653bd

data/.rubocop.yml

@@ -209,9 +209,9 @@ Metrics/BlockNesting:
   Max: 4
 
 Metrics/ClassLength:
-  Description: 'Avoid classes longer than 250 lines of code.'
+  Description: 'Avoid classes longer than 260 lines of code.'
   Enabled: true
-  Max: 250
+  Max: 260
   Exclude:
     - lib/pact_broker/test/*.rb
 

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+<a name="v2.81.0"></a>
+### v2.81.0 (2021-07-17)
+
+#### Features
+
+* enable environments, deployed versions and released versions endpoints without a feature toggle required	 ([84a59c10](/../../commit/84a59c10))
+* add detailed debug logging for WIP pact calculations	 ([81290238](/../../commit/81290238))
+* add debug level logging for WIP pacts calculations	 ([a7c16833](/../../commit/a7c16833))
+* include deployed and released versions in index page when viewing latest tags	 ([655e9dd5](/../../commit/655e9dd5))
+* add interactions counts to metrics endpoint	 ([c765afe1](/../../commit/c765afe1))
+* automatically create a deployed version when a tag is created with the same name as an environment	 ([56a583af](/../../commit/56a583af))
+* support viewing all versions for branch in matrix UI	 ([12f92951](/../../commit/12f92951))
+* validate environment name in consumer version selector	 ([f1ad8f6b](/../../commit/f1ad8f6b))
+* support the deployedOrReleased: true consumer version selector	 ([042a1612](/../../commit/042a1612))
+* add interactions_count and messages_count to pact_versions table	 ([c17adbe6](/../../commit/c17adbe6))
+* shorten length of metadata in pact URLs by using the consumer version id instead of number	 ([27b34bc9](/../../commit/27b34bc9))
+
+#### Bug Fixes
+
+* Display pagination correctly in index page with tag (#469)	 ([cda9c15e](/../../commit/cda9c15e))
+
 <a name="v2.80.0"></a>
 ### v2.80.0 (2021-07-06)
 

data/db/ddl_statements/latest_verifications_for_pact_versions.rb

@@ -0,0 +1,28 @@
+def latest_verifications_for_pact_versions_v4(connection)
+  v = :verifications
+  connection.from(v)
+    .select(
+      Sequel[v][:id],
+      Sequel[v][:number],
+      Sequel[v][:success],
+      Sequel[v][:build_url],
+      Sequel[v][:pact_version_id],
+      Sequel[v][:execution_date],
+      Sequel[v][:created_at],
+      Sequel[v][:provider_version_id],
+      Sequel[:s][:number].as(:provider_version_number),
+      Sequel[:s][:order].as(:provider_version_order),
+      Sequel[v][:test_results],
+      Sequel[v][:consumer_id],
+      Sequel[v][:provider_id],
+    )
+    .join(:latest_verification_ids_for_pact_versions,
+      {
+        Sequel[v][:pact_version_id] => Sequel[:lv][:pact_version_id],
+        Sequel[v][:id] => Sequel[:lv][:latest_verification_id]
+      }, { table_alias: :lv })
+    .join(:versions,
+      {
+        Sequel[v][:provider_version_id] => Sequel[:s][:id]
+      }, { table_alias: :s })
+end

data/db/migrations/20210711_add_consumer_version_order_to_pact_publication.rb

@@ -0,0 +1,12 @@
+Sequel.migration do
+  change do
+    alter_table(:pact_publications) do
+      add_column(:consumer_version_order, Integer) # duplicate column, no need for referential integrity
+    end
+
+    # TODO
+    # alter_table(:pact_publications) do
+    #   set_column_not_null(:consumer_version_order)
+    # end
+  end
+end

data/db/migrations/20210712_add_interaction_count_to_pact_versions.rb

@@ -0,0 +1,8 @@
+Sequel.migration do
+  change do
+    alter_table(:pact_versions) do
+      add_column(:messages_count, Integer)
+      add_column(:interactions_count, Integer)
+    end
+  end
+end

data/lib/db.rb

@@ -63,6 +63,10 @@ module DB
     config.fetch(env).fetch(ENV.fetch("DATABASE_ADAPTER","default"))
   end
 
+  def self.sqlite?
+    !!(PACT_BROKER_DB.adapter_scheme.to_s =~ /sqlite/)
+  end
+
   def self.mysql?
     !!(PACT_BROKER_DB.adapter_scheme.to_s =~ /mysql/)
   end

data/lib/pact_broker/api.rb

@@ -117,16 +117,14 @@ module PactBroker
 
         add ["contracts", "publish"], Api::Resources::PublishContracts, { resource_name: "publish_contracts" }
 
-        if PactBroker.feature_enabled?(:environments)
-          add ["environments"], Api::Resources::Environments, { resource_name: "environments" }
-          add ["environments", :environment_uuid], Api::Resources::Environment, { resource_name: "environment" }
-          add ["environments", :environment_uuid, "deployed-versions", "currently-deployed"], Api::Resources::CurrentlyDeployedVersionsForEnvironment, { resource_name: "environment_currently_deployed_deployed_versions" }
-          add ["environments", :environment_uuid, "released-versions", "currently-supported"], Api::Resources::CurrentlySupportedVersionsForEnvironment, { resource_name: "environment_currently_supported_released_versions" }
-          add ["pacticipants", :pacticipant_name, "versions", :pacticipant_version_number, "deployed-versions", "environment", :environment_uuid], Api::Resources::DeployedVersionsForVersionAndEnvironment, { resource_name: "deployed_versions_for_version_and_environment" }
-          add ["pacticipants", :pacticipant_name, "versions", :pacticipant_version_number, "released-versions", "environment", :environment_uuid], Api::Resources::ReleasedVersionsForVersionAndEnvironment, { resource_name: "released_versions_for_version_and_environment" }
-          add ["released-versions", :uuid], Api::Resources::ReleasedVersion, { resource_name: "released_version" }
-          add ["deployed-versions", :uuid], Api::Resources::DeployedVersion, { resource_name: "deployed_version" }
-        end
+        add ["environments"], Api::Resources::Environments, { resource_name: "environments" }
+        add ["environments", :environment_uuid], Api::Resources::Environment, { resource_name: "environment" }
+        add ["environments", :environment_uuid, "deployed-versions", "currently-deployed"], Api::Resources::CurrentlyDeployedVersionsForEnvironment, { resource_name: "environment_currently_deployed_deployed_versions" }
+        add ["environments", :environment_uuid, "released-versions", "currently-supported"], Api::Resources::CurrentlySupportedVersionsForEnvironment, { resource_name: "environment_currently_supported_released_versions" }
+        add ["pacticipants", :pacticipant_name, "versions", :pacticipant_version_number, "deployed-versions", "environment", :environment_uuid], Api::Resources::DeployedVersionsForVersionAndEnvironment, { resource_name: "deployed_versions_for_version_and_environment" }
+        add ["pacticipants", :pacticipant_name, "versions", :pacticipant_version_number, "released-versions", "environment", :environment_uuid], Api::Resources::ReleasedVersionsForVersionAndEnvironment, { resource_name: "released_versions_for_version_and_environment" }
+        add ["released-versions", :uuid], Api::Resources::ReleasedVersion, { resource_name: "released_version" }
+        add ["deployed-versions", :uuid], Api::Resources::DeployedVersion, { resource_name: "deployed_version" }
 
         add ["integrations"], Api::Resources::Integrations, {resource_name: "integrations"}
         add ["integrations", "provider", :provider_name, "consumer", :consumer_name], Api::Resources::Integration, {resource_name: "integration"}

data/lib/pact_broker/api/contracts/verifiable_pacts_json_query_schema.rb

@@ -15,6 +15,10 @@ module PactBroker
         using PactBroker::HashRefinements
         using PactBroker::StringRefinements
 
+        BRANCH_KEYS = [:latest, :tag, :fallbackTag, :branch, :fallbackBranch]
+        ENVIRONMENT_KEYS = [:environment, :deployed, :released, :deployedOrReleased]
+        ALL_KEYS = BRANCH_KEYS + ENVIRONMENT_KEYS
+
         SCHEMA = Dry::Validation.Schema do
           configure do
             predicates(DryValidationPredicates)
@@ -29,6 +33,7 @@ module PactBroker
               #   end
               # end
 
+              optional(:mainBranch).filled(included_in?: [true])
               optional(:tag).filled(:str?)
               optional(:branch).filled(:str?)
               optional(:latest).filled(included_in?: [true, false])
@@ -37,7 +42,8 @@ module PactBroker
               optional(:consumer).filled(:str?, :not_blank?)
               optional(:deployed).filled(included_in?: [true])
               optional(:released).filled(included_in?: [true])
-              optional(:environment).filled(:str?)
+              optional(:deployedOrReleased).filled(included_in?: [true])
+              optional(:environment).filled(:str?, :environment_with_name_exists?)
 
               # rule(fallbackTagMustBeForLatest: [:fallbackTag, :latest]) do | fallback_tag, latest |
               #   fallback_tag.filled?.then(latest.eql?(true))
@@ -87,13 +93,19 @@ module PactBroker
             errors << "fallbackBranch can only be set if latest is true (at index #{index})"
           end
 
-          if not_provided?(selector[:tag]) &&
+          if not_provided?(selector[:mainBranch]) &&
+              not_provided?(selector[:tag]) &&
               not_provided?(selector[:branch]) &&
               not_provided?(selector[:environment]) &&
               selector[:deployed] != true &&
               selector[:released] != true &&
+              selector[:deployedOrReleased] != true &&
               selector[:latest] != true
-            errors << "must specify a value for environment or tag, or specify latest=true, or specify deployed=true or released=true (at index #{index})"
+            errors << "must specify a value for environment or tag or branch, or specify mainBranch=true, latest=true, deployed=true, released=true or deployedOrReleased=true (at index #{index})"
+          end
+
+          if selector[:mainBranch] && selector.slice(*ALL_KEYS - [:consumer, :mainBranch]).any?
+            errors << "cannot specify mainBranch=true with any other criteria apart from consumer (at index #{index})"
           end
 
           if selector[:tag] && selector[:branch]
@@ -116,8 +128,16 @@ module PactBroker
             errors << "cannot specify both deployed=true and released=true (at index #{index})"
           end
 
-          non_environment_fields = selector.slice(:latest, :tag, :fallbackTag, :branch, :fallbackBranch).keys.sort
-          environment_related_fields = selector.slice(:environment, :deployed, :released).keys.sort
+          if selector[:deployed] && selector[:deployedOrReleased]
+            errors << "cannot specify both deployed=true and deployedOrReleased=true (at index #{index})"
+          end
+
+          if selector[:released] && selector[:deployedOrReleased]
+            errors << "cannot specify both released=true and deployedOrReleased=true (at index #{index})"
+          end
+
+          non_environment_fields = selector.slice(*BRANCH_KEYS).keys.sort
+          environment_related_fields = selector.slice(*ENVIRONMENT_KEYS).keys.sort
 
           if (non_environment_fields.any? && environment_related_fields.any?)
             errors << "cannot specify the #{pluralize("field", non_environment_fields.count)} #{non_environment_fields.join("/")} with the #{pluralize("field", environment_related_fields.count)} #{environment_related_fields.join("/")} (at index #{index})"

data/lib/pact_broker/api/contracts/verifiable_pacts_query_schema.rb

@@ -30,7 +30,6 @@ module PactBroker
         def self.call(params)
           select_first_message(flatten_indexed_messages(SCHEMA.call(params&.symbolize_keys).messages(full: true)))
         end
-
       end
     end
   end

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

@@ -15,6 +15,7 @@ module PactBroker
         property :provider_version_branch
 
         collection :consumer_version_selectors, default: PactBroker::Pacts::Selectors.new, class: PactBroker::Pacts::Selector do
+          property :main_branch
           property :tag
           property :branch, setter: -> (fragment:, represented:, **) {
             represented.branch = fragment
@@ -30,6 +31,11 @@ module PactBroker
           property :environment_name, as: :environment
           property :currently_deployed, as: :deployed
           property :currently_supported, as: :released
+          property :deployed_or_released,
+            setter: ->(represented:, **) {
+              represented.currently_deployed = true
+              represented.currently_supported = true
+            }
         end
 
         property :include_pending_status, default: false,
@@ -45,11 +51,29 @@ module PactBroker
         def from_hash(hash)
           # This handles both the snakecase keys from the GET query and the camelcase JSON POST body
           result = super(hash&.snakecase_keys)
+
+          result.consumer_version_selectors = split_out_deployed_or_released_selectors(result.consumer_version_selectors)
+
           if result.consumer_version_selectors && !result.consumer_version_selectors.is_a?(PactBroker::Pacts::Selectors)
             result.consumer_version_selectors = PactBroker::Pacts::Selectors.new(result.consumer_version_selectors)
           end
           result
         end
+
+        private
+
+        def split_out_deployed_or_released_selectors(consumer_version_selectors)
+          consumer_version_selectors.flat_map do | selector |
+            if selector.currently_deployed && selector.currently_supported
+              [
+                PactBroker::Pacts::Selector.new(selector.to_hash.without(:currently_supported)),
+                PactBroker::Pacts::Selector.new(selector.to_hash.without(:currently_deployed))
+              ]
+            else
+              [selector]
+            end
+          end
+        end
       end
     end
   end

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

@@ -1,11 +1,14 @@
 require "pact_broker/api/resources/base_resource"
 require "pact_broker/api/decorators/dashboard_decorator"
 require "pact_broker/api/decorators/dashboard_text_decorator"
+require "pact_broker/api/resources/pagination_methods"
 
 module PactBroker
   module Api
     module Resources
       class Dashboard < BaseResource
+        include PaginationMethods
+
         def content_types_provided
           [
             ["application/hal+json", :to_json],
@@ -32,7 +35,7 @@ module PactBroker
         private
 
         def index_items
-          index_service.find_index_items_for_api(identifier_from_path)
+          index_service.find_index_items_for_api(identifier_from_path.merge(pagination_options))
         end
       end
     end

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

@@ -5,11 +5,6 @@ module PactBroker
   module Api
     module Resources
       class DeployedVersionsForVersionAndEnvironment < BaseResource
-        def initialize
-          super
-          @existing_deployed_version = version && environment && deployed_version_service.find_currently_deployed_version_for_version_and_environment_and_target(version, environment, target)
-        end
-
         def content_types_accepted
           [["application/json", :from_json]]
         end
@@ -31,11 +26,12 @@ module PactBroker
         end
 
         def create_path
-          deployed_version_url(existing_deployed_version || OpenStruct.new(uuid: deployed_version_uuid), base_url)
+          "dummy"
         end
 
         def from_json
-          @deployed_version = existing_deployed_version || deployed_version_service.create(deployed_version_uuid, version, environment, target)
+          @deployed_version = deployed_version_service.find_or_create(deployed_version_uuid, version, environment, target)
+          response.headers["Location"] = deployed_version_url(deployed_version, base_url)
           response.body = decorator_class(:deployed_version_decorator).new(deployed_version).to_json(decorator_options)
         end
 

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

@@ -156,19 +156,17 @@ module PactBroker
             }]
           }
 
-          if PactBroker.feature_enabled?(:environments)
-            links_hash["pb:environments"] = {
-              title: "Environments",
-              href: environments_url(base_url),
-              templated: false
-            }
+          links_hash["pb:environments"] = {
+            title: "Environments",
+            href: environments_url(base_url),
+            templated: false
+          }
 
-            links_hash["pb:environment"] = {
-              title: "Environment",
-              href: environments_url(base_url) + "/{uuid}",
-              templated: true
-            }
-          end
+          links_hash["pb:environment"] = {
+            title: "Environment",
+            href: environments_url(base_url) + "/{uuid}",
+            templated: true
+          }
 
           if PactBroker.feature_enabled?("disable_pacts_for_verification", true)
             links_hash.delete("pb:provider-pacts-for-verification")

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

@@ -9,7 +9,7 @@ module PactBroker
         private
 
         def pacts
-          pact_service.find_latest_pact_versions_for_provider provider_name, tag: identifier_from_path[:tag]
+          pact_service.find_latest_pacts_for_provider(provider_name, tag: identifier_from_path[:tag])
         end
 
         def resource_title

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

@@ -0,0 +1,14 @@
+module PactBroker
+  module Api
+    module Resources
+      module PaginationMethods
+        def pagination_options
+          {
+            page_number: request.query["pageNumber"]&.to_i,
+            page_size: request.query["pageSize"]&.to_i
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -23,6 +23,7 @@ module PactBroker
             # Make it return a 201 by setting the Location header
             response.headers["Location"] = tag_url(base_url, tag)
           end
+          create_deployed_version
           response.body = to_json
         end
 
@@ -46,6 +47,19 @@ module PactBroker
         def policy_name
           :'tags::tag'
         end
+
+        def create_deployed_version
+          if create_deployed_versions_for_tags?
+            if (environment = environment_service.find_by_name(identifier_from_path[:tag_name]))
+              deployed_version_service.find_or_create(deployed_version_service.next_uuid, tag.version, environment, nil)
+            end
+          end
+        end
+
+        # Come up with a cleaner way to abstract this for PF so it can be configured per tenant
+        def create_deployed_versions_for_tags?
+          PactBroker.configuration.create_deployed_versions_for_tags
+        end
       end
     end
   end

data/lib/pact_broker/configuration.rb

@@ -41,7 +41,8 @@ module PactBroker
       :allow_missing_migration_files,
       :auto_migrate_db_data,
       :use_rack_protection,
-      :metrics_sql_statement_timeout
+      :metrics_sql_statement_timeout,
+      :create_deployed_versions_for_tags
     ]
 
     attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :allow_missing_migration_files, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
@@ -61,6 +62,7 @@ module PactBroker
     attr_reader :custom_logger
     attr_accessor :policy_builder, :policy_scope_builder, :base_resource_class_factory
     attr_accessor :metrics_sql_statement_timeout
+    attr_accessor :create_deployed_versions_for_tags
 
     alias_method :policy_finder=, :policy_builder=
     alias_method :policy_scope_finder=, :policy_scope_builder=
@@ -133,6 +135,7 @@ module PactBroker
       }
       config.warning_error_class_names = ["Sequel::ForeignKeyConstraintViolation", "PG::QueryCanceled"]
       config.metrics_sql_statement_timeout = 30
+      config.create_deployed_versions_for_tags = true
       config
     end
     # rubocop: enable Metrics/MethodLength

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

@@ -0,0 +1,28 @@
+require "pact_broker/db/data_migrations/helpers"
+
+module PactBroker
+  module DB
+    module DataMigrations
+      class SetConsumerVersionOrderForPactPublications
+        extend Helpers
+
+        def self.call connection
+          if required_columns_exist?(connection)
+            connection.from(:pact_publications)
+              .where(consumer_version_order: nil)
+              .update(
+                consumer_version_order: connection.from(:versions)
+                  .select(:order)
+                  .where(Sequel[:versions][:id] => Sequel[:pact_publications][:consumer_version_id])
+              )
+          end
+        end
+
+        def self.required_columns_exist?(connection)
+          columns_exist?(connection, :pact_publications, [:consumer_version_id, :consumer_version_order]) &&
+            columns_exist?(connection, :versions, [:id, :order])
+        end
+      end
+    end
+  end
+end