Merge branch 'morefice/add-migration-extension-helpers' into 'master'

Add Migration::ExtensionHelpers

See merge request !103197



Merged-by: Etienne Baqué <ebaque@gitlab.com>
Approved-by: Dominic Bauer <dbauer@gitlab.com>
Approved-by: Krasimir Angelov <kangelov@gitlab.com>
Approved-by: Etienne Baqué <ebaque@gitlab.com>
Co-authored-by: Maxime Orefice <morefice@gitlab.com>

lib/gitlab/database/migration_helpers.rb

@@ -9,6 +9,7 @@ module MigrationHelpers
       include Migrations::LockRetriesHelpers
       include Migrations::TimeoutHelpers
       include Migrations::ConstraintsHelpers
+      include Migrations::ExtensionHelpers
       include DynamicModelHelpers
       include RenameTableHelpers
       include AsyncIndexes::MigrationHelpers
@@ -1136,63 +1137,6 @@ def backfill_iids(table)
         execute(sql)
       end
 
-      def create_extension(extension)
-        execute('CREATE EXTENSION IF NOT EXISTS %s' % extension)
-      rescue ActiveRecord::StatementInvalid => e
-        dbname = ApplicationRecord.database.database_name
-        user = ApplicationRecord.database.username
-
-        warn(<<~MSG) if e.to_s =~ /permission denied/
-          GitLab requires the PostgreSQL extension '#{extension}' installed in database '#{dbname}', but
-          the database user is not allowed to install the extension.
-
-          You can either install the extension manually using a database superuser:
-
-            CREATE EXTENSION IF NOT EXISTS #{extension}
-
-          Or, you can solve this by logging in to the GitLab
-          database (#{dbname}) using a superuser and running:
-
-              ALTER #{user} WITH SUPERUSER
-
-          This query will grant the user superuser permissions, ensuring any database extensions
-          can be installed through migrations.
-
-          For more information, refer to https://docs.gitlab.com/ee/install/postgresql_extensions.html.
-        MSG
-
-        raise
-      end
-
-      def drop_extension(extension)
-        execute('DROP EXTENSION IF EXISTS %s' % extension)
-      rescue ActiveRecord::StatementInvalid => e
-        dbname = ApplicationRecord.database.database_name
-        user = ApplicationRecord.database.username
-
-        warn(<<~MSG) if e.to_s =~ /permission denied/
-          This migration attempts to drop the PostgreSQL extension '#{extension}'
-          installed in database '#{dbname}', but the database user is not allowed
-          to drop the extension.
-
-          You can either drop the extension manually using a database superuser:
-
-            DROP EXTENSION IF EXISTS #{extension}
-
-          Or, you can solve this by logging in to the GitLab
-          database (#{dbname}) using a superuser and running:
-
-              ALTER #{user} WITH SUPERUSER
-
-          This query will grant the user superuser permissions, ensuring any database extensions
-          can be dropped through migrations.
-
-          For more information, refer to https://docs.gitlab.com/ee/install/postgresql_extensions.html.
-        MSG
-
-        raise
-      end
-
       def add_primary_key_using_index(table_name, pk_name, index_to_use)
         execute <<~SQL
           ALTER TABLE #{quote_table_name(table_name)} ADD CONSTRAINT #{quote_table_name(pk_name)} PRIMARY KEY USING INDEX #{quote_table_name(index_to_use)}

lib/gitlab/database/migrations/extension_helpers.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module Database
+    module Migrations
+      module ExtensionHelpers
+        def create_extension(extension)
+          execute("CREATE EXTENSION IF NOT EXISTS #{extension}")
+        rescue ActiveRecord::StatementInvalid => e
+          dbname = ApplicationRecord.database.database_name
+          user = ApplicationRecord.database.username
+
+          warn(<<~MSG) if e.to_s.include?('permission denied')
+            GitLab requires the PostgreSQL extension '#{extension}' installed in database '#{dbname}', but
+            the database user is not allowed to install the extension.
+
+            You can either install the extension manually using a database superuser:
+
+              CREATE EXTENSION IF NOT EXISTS #{extension}
+
+            Or, you can solve this by logging in to the GitLab
+            database (#{dbname}) using a superuser and running:
+
+                ALTER #{user} WITH SUPERUSER
+
+            This query will grant the user superuser permissions, ensuring any database extensions
+            can be installed through migrations.
+
+            For more information, refer to https://docs.gitlab.com/ee/install/postgresql_extensions.html.
+          MSG
+
+          raise
+        end
+
+        def drop_extension(extension)
+          execute("DROP EXTENSION IF EXISTS #{extension}")
+        rescue ActiveRecord::StatementInvalid => e
+          dbname = ApplicationRecord.database.database_name
+          user = ApplicationRecord.database.username
+
+          warn(<<~MSG) if e.to_s.include?('permission denied')
+            This migration attempts to drop the PostgreSQL extension '#{extension}'
+            installed in database '#{dbname}', but the database user is not allowed
+            to drop the extension.
+
+            You can either drop the extension manually using a database superuser:
+
+              DROP EXTENSION IF EXISTS #{extension}
+
+            Or, you can solve this by logging in to the GitLab
+            database (#{dbname}) using a superuser and running:
+
+                ALTER #{user} WITH SUPERUSER
+
+            This query will grant the user superuser permissions, ensuring any database extensions
+            can be dropped through migrations.
+
+            For more information, refer to https://docs.gitlab.com/ee/install/postgresql_extensions.html.
+          MSG
+
+          raise
+        end
+      end
+    end
+  end
+end

spec/lib/gitlab/database/migration_helpers_spec.rb

@@ -2866,58 +2866,6 @@ def setup
     end
   end
 
-  describe '#create_extension' do
-    subject { model.create_extension(extension) }
-
-    let(:extension) { :btree_gist }
-
-    it 'executes CREATE EXTENSION statement' do
-      expect(model).to receive(:execute).with(/CREATE EXTENSION IF NOT EXISTS #{extension}/)
-
-      subject
-    end
-
-    context 'without proper permissions' do
-      before do
-        allow(model).to receive(:execute)
-          .with(/CREATE EXTENSION IF NOT EXISTS #{extension}/)
-          .and_raise(ActiveRecord::StatementInvalid, 'InsufficientPrivilege: permission denied')
-      end
-
-      it 'raises an exception and prints an error message' do
-        expect { subject }
-          .to output(/user is not allowed/).to_stderr
-          .and raise_error(ActiveRecord::StatementInvalid, /InsufficientPrivilege/)
-      end
-    end
-  end
-
-  describe '#drop_extension' do
-    subject { model.drop_extension(extension) }
-
-    let(:extension) { 'btree_gist' }
-
-    it 'executes CREATE EXTENSION statement' do
-      expect(model).to receive(:execute).with(/DROP EXTENSION IF EXISTS #{extension}/)
-
-      subject
-    end
-
-    context 'without proper permissions' do
-      before do
-        allow(model).to receive(:execute)
-          .with(/DROP EXTENSION IF EXISTS #{extension}/)
-          .and_raise(ActiveRecord::StatementInvalid, 'InsufficientPrivilege: permission denied')
-      end
-
-      it 'raises an exception and prints an error message' do
-        expect { subject }
-          .to output(/user is not allowed/).to_stderr
-          .and raise_error(ActiveRecord::StatementInvalid, /InsufficientPrivilege/)
-      end
-    end
-  end
-
   describe '#add_primary_key_using_index' do
     it "executes the statement to add the primary key" do
       expect(model).to receive(:execute).with /ALTER TABLE "test_table" ADD CONSTRAINT "old_name" PRIMARY KEY USING INDEX "new_name"/

spec/lib/gitlab/database/migrations/extension_helpers_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::Database::Migrations::ExtensionHelpers do
+  let(:model) do
+    ActiveRecord::Migration.new.extend(described_class)
+  end
+
+  before do
+    allow(model).to receive(:puts)
+  end
+
+  describe '#create_extension' do
+    subject { model.create_extension(extension) }
+
+    let(:extension) { :btree_gist }
+
+    it 'executes CREATE EXTENSION statement' do
+      expect(model).to receive(:execute).with(/CREATE EXTENSION IF NOT EXISTS #{extension}/)
+
+      subject
+    end
+
+    context 'without proper permissions' do
+      before do
+        allow(model).to receive(:execute)
+          .with(/CREATE EXTENSION IF NOT EXISTS #{extension}/)
+          .and_raise(ActiveRecord::StatementInvalid, 'InsufficientPrivilege: permission denied')
+      end
+
+      it 'raises an exception and prints an error message' do
+        expect { subject }
+          .to output(/user is not allowed/).to_stderr
+          .and raise_error(ActiveRecord::StatementInvalid, /InsufficientPrivilege/)
+      end
+    end
+  end
+
+  describe '#drop_extension' do
+    subject { model.drop_extension(extension) }
+
+    let(:extension) { 'btree_gist' }
+
+    it 'executes CREATE EXTENSION statement' do
+      expect(model).to receive(:execute).with(/DROP EXTENSION IF EXISTS #{extension}/)
+
+      subject
+    end
+
+    context 'without proper permissions' do
+      before do
+        allow(model).to receive(:execute)
+          .with(/DROP EXTENSION IF EXISTS #{extension}/)
+          .and_raise(ActiveRecord::StatementInvalid, 'InsufficientPrivilege: permission denied')
+      end
+
+      it 'raises an exception and prints an error message' do
+        expect { subject }
+          .to output(/user is not allowed/).to_stderr
+          .and raise_error(ActiveRecord::StatementInvalid, /InsufficientPrivilege/)
+      end
+    end
+  end
+end