1 files changed, 131 insertions, 0 deletions
diff --git a/spec/support/shared_examples/lib/gitlab/database/async_constraints_validation_shared_examples.rb b/spec/support/shared_examples/lib/gitlab/database/async_constraints_validation_shared_examples.rb
new file mode 100644
index 00000000000..b9d71183851
--- /dev/null
+++ b/spec/support/shared_examples/lib/gitlab/database/async_constraints_validation_shared_examples.rb
@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'async constraints validation' do
+  include ExclusiveLeaseHelpers
+
+  let!(:lease) { stub_exclusive_lease(lease_key, :uuid, timeout: lease_timeout) }
+  let(:lease_key) { "gitlab/database/asyncddl/actions/#{Gitlab::Database::PRIMARY_DATABASE_NAME}" }
+  let(:lease_timeout) { described_class::TIMEOUT_PER_ACTION }
+
+  let(:constraints_model) { Gitlab::Database::AsyncConstraints::PostgresAsyncConstraintValidation }
+  let(:table_name) { '_test_async_constraints' }
+  let(:constraint_name) { 'constraint_parent_id' }
+
+  let(:validation) do
+    create(:postgres_async_constraint_validation,
+      table_name: table_name,
+      name: constraint_name,
+      constraint_type: constraint_type)
+  end
+
+  let(:connection) { validation.connection }
+
+  subject { described_class.new(validation) }
+
+  it 'validates the constraint while controlling statement timeout' do
+    allow(connection).to receive(:execute).and_call_original
+    expect(connection).to receive(:execute)
+      .with("SET statement_timeout TO '43200s'").ordered.and_call_original
+    expect(connection).to receive(:execute)
+      .with(/ALTER TABLE "#{table_name}" VALIDATE CONSTRAINT "#{constraint_name}";/).ordered.and_call_original
+    expect(connection).to receive(:execute)
+      .with("RESET statement_timeout").ordered.and_call_original
+
+    subject.perform
+  end
+
+  it 'removes the constraint validation record from table' do
+    expect(validation).to receive(:destroy!).and_call_original
+
+    expect { subject.perform }.to change { constraints_model.count }.by(-1)
+  end
+
+  it 'skips logic if not able to acquire exclusive lease' do
+    expect(lease).to receive(:try_obtain).ordered.and_return(false)
+    expect(connection).not_to receive(:execute).with(/ALTER TABLE/)
+    expect(validation).not_to receive(:destroy!)
+
+    expect { subject.perform }.not_to change { constraints_model.count }
+  end
+
+  it 'logs messages around execution' do
+    allow(Gitlab::AppLogger).to receive(:info).and_call_original
+
+    subject.perform
+
+    expect(Gitlab::AppLogger)
+      .to have_received(:info)
+      .with(a_hash_including(message: 'Starting to validate constraint'))
+
+    expect(Gitlab::AppLogger)
+      .to have_received(:info)
+      .with(a_hash_including(message: 'Finished validating constraint'))
+  end
+
+  context 'when the constraint does not exist' do
+    before do
+      connection.create_table(table_name, force: true)
+    end
+
+    it 'skips validation and removes the record' do
+      expect(connection).not_to receive(:execute).with(/ALTER TABLE/)
+
+      expect { subject.perform }.to change { constraints_model.count }.by(-1)
+    end
+
+    it 'logs an appropriate message' do
+      expected_message = /Skipping #{constraint_name} validation since it does not exist/
+
+      allow(Gitlab::AppLogger).to receive(:info).and_call_original
+
+      subject.perform
+
+      expect(Gitlab::AppLogger)
+        .to have_received(:info)
+        .with(a_hash_including(message: expected_message))
+    end
+  end
+
+  context 'with error handling' do
+    before do
+      allow(connection).to receive(:execute).and_call_original
+
+      allow(connection).to receive(:execute)
+        .with(/ALTER TABLE "#{table_name}" VALIDATE CONSTRAINT "#{constraint_name}";/)
+        .and_raise(ActiveRecord::StatementInvalid)
+    end
+
+    context 'on production' do
+      before do
+        allow(Gitlab::ErrorTracking).to receive(:should_raise_for_dev?).and_return(false)
+      end
+
+      it 'increases execution attempts' do
+        expect { subject.perform }.to change { validation.attempts }.by(1)
+
+        expect(validation.last_error).to be_present
+        expect(validation).not_to be_destroyed
+      end
+
+      it 'logs an error message including the constraint_name' do
+        expect(Gitlab::AppLogger)
+          .to receive(:error)
+          .with(a_hash_including(:message, :constraint_name))
+          .and_call_original
+
+        subject.perform
+      end
+    end
+
+    context 'on development' do
+      it 'also raises errors' do
+        expect { subject.perform }
+          .to raise_error(ActiveRecord::StatementInvalid)
+          .and change { validation.attempts }.by(1)
+
+        expect(validation.last_error).to be_present
+        expect(validation).not_to be_destroyed
+      end
+    end
+  end
+end