Merge branch 'fix-ci-test-schema-diverge-from-main' into 'master'

Ensure schemas are up-to-date after migration tests complete

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100455



Merged-by: Kerri Miller <kerrizor@kerrizor.com>
Approved-by: Stan Hu <stanhu@gmail.com>
Approved-by: Max Orefice <morefice@gitlab.com>
Approved-by: Mehmet Emin INAC <minac@gitlab.com>
Approved-by: Alper Akgun <aakgun@gitlab.com>
Approved-by: Kerri Miller <kerrizor@kerrizor.com>
Co-authored-by: Omar Qunsul <oqunsul@gitlab.com>

spec/migrations/change_public_projects_cost_factor_spec.rb

@@ -53,8 +53,6 @@
         expect(shared_2.public_projects_minutes_cost_factor).to eq(0)
         expect(shared_3.public_projects_minutes_cost_factor).to eq(1)
         expect(group_1.public_projects_minutes_cost_factor).to eq(0)
-
-        schema_migrate_up!
       end
     end
   end

spec/support/database/multiple_databases.rb

@@ -2,6 +2,15 @@
 
 module Database
   module MultipleDatabases
+    def run_and_cleanup(example)
+      # Each example may call `migrate!`, so we must ensure we are migrated down every time
+      schema_migrate_down!
+
+      example.run
+
+      delete_from_all_tables!(except: deletion_except_tables)
+    end
+
     def skip_if_multiple_databases_not_setup
       skip 'Skipping because multiple databases not set up' unless Gitlab::Database.has_config?(:ci)
     end
@@ -22,6 +31,21 @@ def reconfigure_db_connection(name: nil, config_hash: {}, model: ActiveRecord::B
       model.establish_connection(new_db_config)
     end
 
+    def ensure_schema_and_empty_tables
+      # Ensure all schemas for both databases are migrated back
+      Gitlab::Database.database_base_models.each do |_, base_model|
+        with_reestablished_active_record_base do
+          reconfigure_db_connection(
+            model: ActiveRecord::Base,
+            config_model: base_model
+          )
+
+          schema_migrate_up!
+          delete_from_all_tables!(except: deletion_except_tables)
+        end
+      end
+    end
+
     # The usage of this method switches temporarily used `connection_handler`
     # allowing full manipulation of ActiveRecord::Base connections without
     # having side effects like:
@@ -109,7 +133,15 @@ def establish_connection(*args)
     end
   end
 
+  config.append_after(:context, :migration) do
+    break if recreate_databases_and_seed_if_needed
+
+    ensure_schema_and_empty_tables
+  end
+
   config.around(:each, :migration) do |example|
+    self.class.use_transactional_tests = false
+
     migration_schema = example.metadata[:migration]
     migration_schema = :gitlab_main if migration_schema == true
     base_model = Gitlab::Database.schemas_to_base_models.fetch(migration_schema).first
@@ -122,11 +154,13 @@ def establish_connection(*args)
           config_model: base_model
         )
 
-        example.run
+        run_and_cleanup(example)
       end
     else
-      example.run
+      run_and_cleanup(example)
     end
+
+    self.class.use_transactional_tests = true
   end
 end
 

spec/support/database_cleaner.rb

@@ -13,19 +13,6 @@
     DatabaseCleaner.clean_with(:deletion)
   end
 
-  config.append_after(:context, :migration) do
-    delete_from_all_tables!(except: ['work_item_types'])
-
-    # Postgres maximum number of columns in a table is 1600 (https://github.com/postgres/postgres/blob/de41869b64d57160f58852eab20a27f248188135/src/include/access/htup_details.h#L23-L47).
-    # We drop and recreate the database if any table has more than 1200 columns, just to be safe.
-    if any_connection_class_with_more_than_allowed_columns?
-      recreate_all_databases!
-
-      # Seed required data as recreating DBs will delete it
-      TestEnv.seed_db
-    end
-  end
-
   config.around(:each, :delete) do |example|
     self.class.use_transactional_tests = false
 
@@ -35,14 +22,4 @@
 
     self.class.use_transactional_tests = true
   end
-
-  config.around(:each, :migration) do |example|
-    self.class.use_transactional_tests = false
-
-    example.run
-
-    delete_from_all_tables!(except: ['work_item_types'])
-
-    self.class.use_transactional_tests = true
-  end
 end

spec/support/db_cleaner.rb

@@ -78,6 +78,19 @@ def recreate_all_databases!
     puts "Databases re-creation done in #{Gitlab::Metrics::System.monotonic_time - start}"
   end
 
+  def recreate_databases_and_seed_if_needed
+    # Postgres maximum number of columns in a table is 1600 (https://github.com/postgres/postgres/blob/de41869b64d57160f58852eab20a27f248188135/src/include/access/htup_details.h#L23-L47).
+    # We drop and recreate the database if any table has more than 1200 columns, just to be safe.
+    return false unless any_connection_class_with_more_than_allowed_columns?
+
+    recreate_all_databases!
+
+    # Seed required data as recreating DBs will delete it
+    TestEnv.seed_db
+
+    true
+  end
+
   def force_disconnect_all_connections!
     cmd = <<~SQL
       SELECT pg_terminate_backend(pg_stat_activity.pid)

spec/support/migration.rb

@@ -19,13 +19,9 @@
   # Each example may call `migrate!`, so we must ensure we are migrated down every time
   config.before(:each, :migration) do
     use_fake_application_settings
-
-    schema_migrate_down!
   end
 
   config.after(:context, :migration) do
-    schema_migrate_up!
-
     Gitlab::CurrentSettings.clear_in_memory_application_settings!
   end
 end