pact_broker 2.24.0 → 2.25.0

data/lib/pact_broker/config/setting.rb

@@ -6,3 +6,15 @@ module PactBroker
     Setting.plugin :timestamps, update_on_create: true
   end
 end
+
+# Table: config
+# Columns:
+#  id         | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  name       | text                        | NOT NULL
+#  type       | text                        | NOT NULL
+#  value      | text                        |
+#  created_at | timestamp without time zone | NOT NULL
+#  updated_at | timestamp without time zone | NOT NULL
+# Indexes:
+#  config_pkey     | PRIMARY KEY btree (id)
+#  unq_config_name | UNIQUE btree (name)

data/lib/pact_broker/configuration.rb

@@ -31,7 +31,7 @@ module PactBroker
       :base_equality_only_on_content_that_affects_verification_results
     ]
 
-    attr_accessor :log_dir, :database_connection, :auto_migrate_db, :use_hal_browser, :html_pact_renderer
+    attr_accessor :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :use_hal_browser, :html_pact_renderer
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser, :sha_generator
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_accessor :check_for_potential_duplicate_pacticipant_names
@@ -63,6 +63,7 @@ module PactBroker
       config = Configuration.new
       config.log_dir = File.expand_path("./log")
       config.auto_migrate_db = true
+      config.auto_migrate_db_data = true
       config.use_hal_browser = true
       config.validate_database_connection_config = true
       config.enable_diagnostic_endpoints = true

data/lib/pact_broker/db.rb

@@ -1,5 +1,7 @@
 require 'sequel'
 require 'pact_broker/db/validate_encoding'
+require 'pact_broker/db/migrate'
+require 'pact_broker/db/migrate_data'
 
 Sequel.datetime_class = DateTime
 
@@ -21,6 +23,10 @@ module PactBroker
       Sequel::TimestampMigrator.new(database_connection, PactBroker::DB::MIGRATIONS_DIR).run
     end
 
+    def self.run_data_migrations database_connection
+      PactBroker::DB::MigrateData.(connection)
+    end
+
     def self.validate_connection_config
       PactBroker::DB::ValidateEncoding.(connection)
     end

data/lib/pact_broker/db/clean.rb

@@ -14,8 +14,8 @@ module PactBroker
       end
 
       def call
-        db[:verifications].where(id: db[:materialized_head_matrix].select(:verification_id)).invert.delete
-        pp_ids = db[:materialized_head_matrix].select(:pact_publication_id)
+        db[:verifications].where(id: db[:head_matrix].select(:verification_id)).invert.delete
+        pp_ids = db[:head_matrix].select(:pact_publication_id)
 
         triggered_webhook_ids = db[:triggered_webhooks].where(pact_publication_id: pp_ids).invert.select(:id)
         db[:webhook_executions].where(triggered_webhook_id: triggered_webhook_ids).delete
@@ -33,11 +33,6 @@ module PactBroker
 
         db[:tags].where(version_id: referenced_version_ids).invert.delete
         db[:versions].where(id: referenced_version_ids).invert.delete
-
-        db[:materialized_matrix].delete
-        db[:materialized_matrix].insert(db[:matrix].select_all)
-        db[:materialized_head_matrix].delete
-        db[:materialized_head_matrix].insert(db[:head_matrix].select_all)
       end
 
       private

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

@@ -0,0 +1,29 @@
+module PactBroker
+  module DB
+    module DataMigrations
+      class SetConsumerIdsForPactPublications
+        def self.call connection
+          if columns_exist?(connection)
+            query = "UPDATE pact_publications
+                    SET consumer_id = (SELECT pacticipant_id
+                      FROM versions
+                      WHERE id = pact_publications.consumer_version_id)
+                    WHERE consumer_id is null"
+            connection.run(query)
+          end
+        end
+
+        def self.columns_exist?(connection)
+          column_exists?(connection, :pact_publications, :consumer_id) &&
+            column_exists?(connection, :pact_publications, :id) &&
+            column_exists?(connection, :versions, :id) &&
+            column_exists?(connection, :versions, :pacticipant_id)
+        end
+
+        def self.column_exists?(connection, table, column)
+          connection.table_exists?(table) && connection.schema(table).find{|col| col.first == column }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module PactBroker
+  module DB
+    module DataMigrations
+      class SetPacticipantIdsForVerifications
+        def self.call connection
+          if columns_exist?(connection)
+            query = "UPDATE verifications
+                    SET consumer_id = (SELECT consumer_id
+                      FROM pact_versions
+                      WHERE id = verifications.pact_version_id),
+                     provider_id = (SELECT provider_id
+                      FROM pact_versions
+                      WHERE id = verifications.pact_version_id)
+                    WHERE consumer_id is null
+                    OR provider_id is null"
+            connection.run(query)
+          end
+        end
+
+        def self.columns_exist?(connection)
+          column_exists?(connection, :verifications, :provider_id) &&
+            column_exists?(connection, :verifications, :consumer_id) &&
+            column_exists?(connection, :verifications, :provider_version_id) &&
+            column_exists?(connection, :pact_versions, :provider_id) &&
+            column_exists?(connection, :pact_versions, :consumer_id) &&
+            column_exists?(connection, :pact_versions, :id)
+        end
+
+        def self.column_exists?(connection, table, column)
+          connection.table_exists?(table) && connection.schema(table).find{|col| col.first == column }
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/db/migrate_data.rb

@@ -0,0 +1,14 @@
+Dir.glob(File.expand_path(File.join(__FILE__, "..", "data_migrations", "*.rb"))).sort.each do | path |
+  require path
+end
+
+module PactBroker
+  module DB
+    class MigrateData
+      def self.call database_connection, options = {}
+        DataMigrations::SetPacticipantIdsForVerifications.call(database_connection)
+        DataMigrations::SetConsumerIdsForPactPublications.call(database_connection)
+      end
+    end
+  end
+end

data/lib/pact_broker/doc/views/wip-provider-pacts.markdown

@@ -0,0 +1,3 @@
+# Work In Progress Pacts
+
+This feature is in beta. It allows WIP pacts (pacts that have not yet been succesfully verified) to run against a provider without failing the build.

data/lib/pact_broker/domain/label.rb

@@ -17,3 +17,15 @@ module PactBroker
     Label.plugin :timestamps, update_on_create: true
   end
 end
+
+# Table: labels
+# Primary Key: (name, pacticipant_id)
+# Columns:
+#  name           | text                        |
+#  pacticipant_id | integer                     |
+#  created_at     | timestamp without time zone | NOT NULL
+#  updated_at     | timestamp without time zone | NOT NULL
+# Indexes:
+#  labels_pk | PRIMARY KEY btree (pacticipant_id, name)
+# Foreign key constraints:
+#  labels_pacticipant_id_fkey | (pacticipant_id) REFERENCES pacticipants(id)

data/lib/pact_broker/domain/pacticipant.rb

@@ -42,4 +42,35 @@ module PactBroker
 
     Pacticipant.plugin :timestamps, update_on_create: true
   end
-end
+end
+
+# Table: pacticipants
+# Columns:
+#  id             | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  name           | text                        |
+#  repository_url | text                        |
+#  created_at     | timestamp without time zone | NOT NULL
+#  updated_at     | timestamp without time zone | NOT NULL
+# Indexes:
+#  pacticipants_pkey     | PRIMARY KEY btree (id)
+#  pacticipants_name_key | UNIQUE btree (name)
+#  ndx_ppt_name          | btree (name)
+# Referenced By:
+#  versions                                                     | versions_pacticipant_id_fkey                                    | (pacticipant_id) REFERENCES pacticipants(id)
+#  webhooks                                                     | fk_webhooks_consumer                                            | (consumer_id) REFERENCES pacticipants(id)
+#  webhooks                                                     | fk_webhooks_provider                                            | (provider_id) REFERENCES pacticipants(id)
+#  pact_versions                                                | pact_versions_consumer_id_fkey                                  | (consumer_id) REFERENCES pacticipants(id)
+#  pact_versions                                                | pact_versions_provider_id_fkey                                  | (provider_id) REFERENCES pacticipants(id)
+#  pact_publications                                            | pact_publications_consumer_id_fkey                              | (consumer_id) REFERENCES pacticipants(id)
+#  pact_publications                                            | pact_publications_provider_id_fkey                              | (provider_id) REFERENCES pacticipants(id)
+#  verifications                                                | verifications_consumer_id_fkey                                  | (consumer_id) REFERENCES pacticipants(id)
+#  verifications                                                | verifications_provider_id_fkey                                  | (provider_id) REFERENCES pacticipants(id)
+#  webhook_executions                                           | webhook_executions_consumer_id_fkey                             | (consumer_id) REFERENCES pacticipants(id)
+#  webhook_executions                                           | webhook_executions_provider_id_fkey                             | (provider_id) REFERENCES pacticipants(id)
+#  labels                                                       | labels_pacticipant_id_fkey                                      | (pacticipant_id) REFERENCES pacticipants(id)
+#  triggered_webhooks                                           | triggered_webhooks_consumer_id_fkey                             | (consumer_id) REFERENCES pacticipants(id)
+#  triggered_webhooks                                           | triggered_webhooks_provider_id_fkey                             | (provider_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
+#  latest_pact_publication_ids_for_consumer_versions            | latest_pact_publication_ids_for_consumer_versi_provider_id_fkey | (provider_id) REFERENCES pacticipants(id) ON DELETE CASCADE
+#  latest_verification_id_for_pact_version_and_provider_version | latest_v_id_for_pv_and_pv_consumer_id_fk                        | (consumer_id) REFERENCES pacticipants(id) ON DELETE CASCADE
+#  latest_verification_id_for_pact_version_and_provider_version | latest_v_id_for_pv_and_pv_provider_id_fk                        | (provider_id) REFERENCES pacticipants(id) ON DELETE CASCADE

data/lib/pact_broker/domain/tag.rb

@@ -22,4 +22,17 @@ module PactBroker
 
     Tag.plugin :timestamps, :update_on_create=>true
   end
-end
+end
+
+# Table: tags
+# Primary Key: (name, version_id)
+# Columns:
+#  name       | text                        |
+#  version_id | integer                     |
+#  created_at | timestamp without time zone | NOT NULL
+#  updated_at | timestamp without time zone | NOT NULL
+# Indexes:
+#  tags_pk      | PRIMARY KEY btree (version_id, name)
+#  ndx_tag_name | btree (name)
+# Foreign key constraints:
+#  tags_version_id_fkey | (version_id) REFERENCES versions(id)

data/lib/pact_broker/domain/verification.rb

@@ -98,3 +98,32 @@ module PactBroker
     Verification.plugin :timestamps
   end
 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                     |
+# 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_provider_id_consumer_id_index | btree (provider_id, consumer_id)
+#  verifications_provider_id_index             | btree (provider_id)
+# Foreign key constraints:
+#  fk_verifications_versions          | (provider_version_id) REFERENCES versions(id)
+#  verifications_consumer_id_fkey     | (consumer_id) REFERENCES pacticipants(id)
+#  verifications_pact_version_id_fkey | (pact_version_id) REFERENCES pact_versions(id)
+#  verifications_provider_id_fkey     | (provider_id) REFERENCES pacticipants(id)
+# Referenced By:
+#  triggered_webhooks                                           | triggered_webhooks_verification_id_fkey      | (verification_id) REFERENCES verifications(id)
+#  latest_verification_id_for_pact_version_and_provider_version | latest_v_id_for_pv_and_pv_verification_id_fk | (verification_id) REFERENCES verifications(id) ON DELETE CASCADE

data/lib/pact_broker/domain/version.rb

@@ -37,4 +37,28 @@ module PactBroker
 
     Version.plugin :timestamps, :update_on_create=>true
   end
-end
+end
+
+# Table: versions
+# Columns:
+#  id             | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  number         | text                        |
+#  repository_ref | text                        |
+#  pacticipant_id | integer                     | NOT NULL
+#  order          | integer                     |
+#  created_at     | timestamp without time zone | NOT NULL
+#  updated_at     | timestamp without time zone | NOT NULL
+# Indexes:
+#  versions_pkey                        | PRIMARY KEY btree (id)
+#  uq_ver_ppt_ord                       | UNIQUE btree (pacticipant_id, "order")
+#  versions_pacticipant_id_number_index | UNIQUE btree (pacticipant_id, number)
+#  ndx_ver_num                          | btree (number)
+#  ndx_ver_ord                          | btree ("order")
+# Foreign key constraints:
+#  versions_pacticipant_id_fkey | (pacticipant_id) REFERENCES pacticipants(id)
+# Referenced By:
+#  tags                                                         | tags_version_id_fkey                                            | (version_id) REFERENCES versions(id)
+#  pact_publications                                            | pact_publications_consumer_version_id_fkey                      | (consumer_version_id) REFERENCES versions(id)
+#  verifications                                                | fk_verifications_versions                                       | (provider_version_id) REFERENCES versions(id)
+#  latest_pact_publication_ids_for_consumer_versions            | latest_pact_publication_ids_for_consum_consumer_version_id_fkey | (consumer_version_id) REFERENCES versions(id) ON DELETE CASCADE
+#  latest_verification_id_for_pact_version_and_provider_version | latest_v_id_for_pv_and_pv_provider_version_id_fk                | (provider_version_id) REFERENCES versions(id) ON DELETE CASCADE

data/lib/pact_broker/feature_toggle.rb

@@ -0,0 +1,23 @@
+module PactBroker
+  class FeatureToggle
+    def self.enabled?(feature)
+      not_production? || feature_in_env_var?(feature)
+    end
+
+    def self.not_production?
+      ENV['RACK_ENV'] != 'production'
+    end
+
+    def self.feature_in_env_var?(feature)
+      (features =~ /\b#{feature}\b/i) != nil
+    end
+
+    def self.features
+      ENV['PACT_BROKER_FEATURES'] || ""
+    end
+  end
+
+  def self.feature_enabled?(feature)
+    FeatureToggle.enabled?(feature)
+  end
+end

data/lib/pact_broker/index/service.rb

@@ -28,6 +28,7 @@ module PactBroker
           rows = rows.eager(:consumer_version_tags)
                 .eager(:provider_version_tags)
                 .eager(:latest_verification_for_consumer_version_tag)
+                .eager(:latest_verification_for_consumer_and_provider)
         end
         rows = rows.all.group_by(&:pact_publication_id).values.collect{ | rows| Matrix::AggregatedRow.new(rows) }
 

data/lib/pact_broker/matrix/head_row.rb

@@ -5,7 +5,7 @@ module PactBroker
     # A row for each of the overall latest pacts, and a row for each of the latest tagged pacts
     # Rows with a nil consumer_tag_name are the overall latest
     class HeadRow < Row
-      set_dataset(:materialized_head_matrix)
+      set_dataset(:head_matrix)
 
       # one_to_one :latest_verification_for_consumer_version_tag,
       #   :class => "PactBroker::Verifications::LatestVerificationForConsumerVersionTag",
@@ -29,25 +29,30 @@ module PactBroker
           end
         end
       end)
-
-      dataset_module do
-        include PactBroker::Repositories::Helpers
-        include PactBroker::Logging
-
-        def refresh ids
-          return super unless ids[:tag_name]
-
-          logger.debug("Refreshing #{model.table_name} for #{ids}")
-          db = model.db
-          table_name = model.table_name
-          criteria = { consumer_id: ids[:pacticipant_id], consumer_version_tag_name: ids[:tag_name] }
-          db.transaction do
-            db[table_name].where(criteria).delete
-            new_rows = db[source_view_name].where(criteria)
-            db[table_name].insert(new_rows)
-          end
-        end
-      end
     end
   end
 end
+
+# Table: head_matrix
+# Columns:
+#  consumer_id               | integer                     |
+#  consumer_name             | text                        |
+#  consumer_version_id       | integer                     |
+#  consumer_version_number   | text                        |
+#  consumer_version_order    | integer                     |
+#  pact_publication_id       | integer                     |
+#  pact_version_id           | integer                     |
+#  pact_version_sha          | text                        |
+#  pact_revision_number      | integer                     |
+#  pact_created_at           | timestamp without time zone |
+#  provider_id               | integer                     |
+#  provider_name             | text                        |
+#  provider_version_id       | integer                     |
+#  provider_version_number   | text                        |
+#  provider_version_order    | integer                     |
+#  verification_id           | integer                     |
+#  success                   | boolean                     |
+#  verification_number       | integer                     |
+#  verification_executed_at  | timestamp without time zone |
+#  verification_build_url    | text                        |
+#  consumer_version_tag_name | text                        |

data/lib/pact_broker/matrix/repository.rb

@@ -23,24 +23,6 @@ module PactBroker
       GROUP_BY_PROVIDER = [:consumer_name, :consumer_version_number, :provider_name]
       GROUP_BY_PACT = [:consumer_name, :provider_name]
 
-      # Use a block when the refresh is caused by a resource deletion
-      # This allows us to store the correct object ids for use afterwards
-      def refresh params
-        criteria = find_ids_for_pacticipant_names(params)
-        yield if block_given?
-        PactBroker::Matrix::Row.refresh(criteria)
-        PactBroker::Matrix::HeadRow.refresh(criteria)
-      end
-
-      # Only need to update the HeadRow table when tags change
-      # because it only changes which rows are the latest tagged ones -
-      # it doesn't change the actual values in the underlying matrix.
-      def refresh_tags params
-        criteria = find_ids_for_pacticipant_names(params)
-        yield if block_given?
-        PactBroker::Matrix::HeadRow.refresh(criteria)
-      end
-
       def find_ids_for_pacticipant_names params
         criteria  = {}
 

data/lib/pact_broker/matrix/row.rb

@@ -8,7 +8,7 @@ require 'pact_broker/verifications/latest_verification_for_consumer_and_provider
 module PactBroker
   module Matrix
 
-    class Row < Sequel::Model(:materialized_matrix)
+    class Row < Sequel::Model(:matrix)
 
       # Used when using table_print to output query results
       TP_COLS = [ :consumer_version_number, :pact_revision_number, :provider_version_number, :verification_number]
@@ -26,32 +26,6 @@ module PactBroker
         include PactBroker::Repositories::Helpers
         include PactBroker::Logging
 
-        def refresh ids
-          logger.debug("Refreshing #{model.table_name} for #{ids}")
-
-          db = model.db
-          table_name = model.table_name
-
-          if ids[:pacticipant_id]
-            db.transaction do
-              db[table_name].where(consumer_id: ids[:pacticipant_id]).or(provider_id: ids[:pacticipant_id]).delete
-              new_rows = db[source_view_name].where(consumer_id: ids[:pacticipant_id]).or(provider_id: ids[:pacticipant_id]).distinct
-              db[table_name].insert(new_rows)
-            end
-          elsif ids.any?
-            accepted_columns = [:consumer_id, :consumer_name, :provider_id, :provider_name]
-            criteria = ids.reject{ |k, v| !accepted_columns.include?(k) }
-            db.transaction do
-              db[table_name].where(criteria).delete
-              db[table_name].insert(db[source_view_name].where(criteria))
-            end
-          end
-        end
-
-        def source_view_name
-          model.table_name.to_s.gsub('materialized_', '').to_sym
-        end
-
         def matching_selectors selectors
           if selectors.size == 1
             where_consumer_or_provider_is(selectors.first)
@@ -227,3 +201,26 @@ module PactBroker
     end
   end
 end
+
+# Table: matrix
+# Columns:
+#  consumer_id              | integer                     |
+#  consumer_name            | text                        |
+#  consumer_version_id      | integer                     |
+#  consumer_version_number  | text                        |
+#  consumer_version_order   | integer                     |
+#  pact_publication_id      | integer                     |
+#  pact_version_id          | integer                     |
+#  pact_version_sha         | text                        |
+#  pact_revision_number     | integer                     |
+#  pact_created_at          | timestamp without time zone |
+#  provider_id              | integer                     |
+#  provider_name            | text                        |
+#  provider_version_id      | integer                     |
+#  provider_version_number  | text                        |
+#  provider_version_order   | integer                     |
+#  verification_id          | integer                     |
+#  success                  | boolean                     |
+#  verification_number      | integer                     |
+#  verification_executed_at | timestamp without time zone |
+#  verification_build_url   | text                        |