1 files changed, 222 insertions, 0 deletions
diff --git a/spec/support/shared_examples/ci/redis_shared_examples.rb b/spec/support/shared_examples/ci/redis_shared_examples.rb
new file mode 100644
index 00000000000..bc9826a8968
--- /dev/null
+++ b/spec/support/shared_examples/ci/redis_shared_examples.rb
@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'CI build trace chunk redis' do |redis_store|
+  describe '#data' do
+    subject { data_store.data(model) }
+
+    context 'when data exists' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'sample data in redis') }
+
+      it 'returns the data' do
+        is_expected.to eq('sample data in redis')
+      end
+    end
+
+    context 'when data does not exist' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_without_data) }
+
+      it 'returns nil' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  describe '#set_data' do
+    subject { data_store.set_data(model, data) }
+
+    let(:data) { 'abc123' }
+
+    context 'when data exists' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'sample data in redis') }
+
+      it 'overwrites data' do
+        expect(data_store.data(model)).to eq('sample data in redis')
+
+        subject
+
+        expect(data_store.data(model)).to eq('abc123')
+      end
+    end
+
+    context 'when data does not exist' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_without_data) }
+
+      it 'sets new data' do
+        expect(data_store.data(model)).to be_nil
+
+        subject
+
+        expect(data_store.data(model)).to eq('abc123')
+      end
+    end
+  end
+
+  describe '#append_data' do
+    context 'when valid offset is used with existing data' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'abcd') }
+
+      it 'appends data' do
+        expect(data_store.data(model)).to eq('abcd')
+
+        length = data_store.append_data(model, '12345', 4)
+
+        expect(length).to eq 9
+        expect(data_store.data(model)).to eq('abcd12345')
+      end
+    end
+
+    context 'when data does not exist yet' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_without_data) }
+
+      it 'sets new data' do
+        expect(data_store.data(model)).to be_nil
+
+        length = data_store.append_data(model, 'abc', 0)
+
+        expect(length).to eq 3
+        expect(data_store.data(model)).to eq('abc')
+      end
+    end
+
+    context 'when data needs to be truncated' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: '12345678') }
+
+      it 'appends data and truncates stored value' do
+        expect(data_store.data(model)).to eq('12345678')
+
+        length = data_store.append_data(model, 'ab', 4)
+
+        expect(length).to eq 6
+        expect(data_store.data(model)).to eq('1234ab')
+      end
+    end
+
+    context 'when invalid offset is provided' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'abc') }
+
+      it 'raises an exception' do
+        length = data_store.append_data(model, '12345', 4)
+
+        expect(length).to be_negative
+      end
+    end
+
+    context 'when trace contains multi-byte UTF8 characters' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'aüc') }
+
+      it 'appends data' do
+        length = data_store.append_data(model, '1234', 4)
+
+        data_store.data(model).then do |new_data|
+          expect(new_data.bytesize).to eq 8
+          expect(new_data).to eq 'aüc1234'
+        end
+
+        expect(length).to eq 8
+      end
+    end
+
+    context 'when trace contains non-UTF8 characters' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: "a\255c") }
+
+      it 'appends data' do
+        length = data_store.append_data(model, '1234', 3)
+
+        data_store.data(model).then do |new_data|
+          expect(new_data.bytesize).to eq 7
+        end
+
+        expect(length).to eq 7
+      end
+    end
+  end
+
+  describe '#delete_data' do
+    subject { data_store.delete_data(model) }
+
+    context 'when data exists' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'sample data in redis') }
+
+      it 'deletes data' do
+        expect(data_store.data(model)).to eq('sample data in redis')
+
+        subject
+
+        expect(data_store.data(model)).to be_nil
+      end
+    end
+
+    context 'when data does not exist' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_without_data) }
+
+      it 'does nothing' do
+        expect(data_store.data(model)).to be_nil
+
+        subject
+
+        expect(data_store.data(model)).to be_nil
+      end
+    end
+  end
+
+  describe '#size' do
+    context 'when data exists' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_with_data, initial_data: 'üabcd') }
+
+      it 'returns data bytesize correctly' do
+        expect(data_store.size(model)).to eq 6
+      end
+    end
+
+    context 'when data does not exist' do
+      let(:model) { create(:ci_build_trace_chunk, store_trait_without_data) }
+
+      it 'returns zero' do
+        expect(data_store.size(model)).to be_zero
+      end
+    end
+  end
+
+  describe '#keys' do
+    subject { data_store.keys(relation) }
+
+    let(:build) { create(:ci_build) }
+    let(:relation) { build.trace_chunks }
+
+    before do
+      create(:ci_build_trace_chunk, store_trait_with_data, chunk_index: 0, build: build)
+      create(:ci_build_trace_chunk, store_trait_with_data, chunk_index: 1, build: build)
+    end
+
+    it 'returns keys' do
+      is_expected.to eq([[build.id, 0], [build.id, 1]])
+    end
+  end
+
+  describe '#delete_keys' do
+    subject { data_store.delete_keys(keys) }
+
+    let(:build) { create(:ci_build) }
+    let(:relation) { build.trace_chunks }
+    let(:keys) { data_store.keys(relation) }
+
+    before do
+      create(:ci_build_trace_chunk, store_trait_with_data, chunk_index: 0, build: build)
+      create(:ci_build_trace_chunk, store_trait_with_data, chunk_index: 1, build: build)
+    end
+
+    it 'deletes multiple data' do
+      redis_store.with do |redis|
+        expect(redis.exists?("gitlab:ci:trace:#{build.id}:chunks:0")).to eq(true)
+        expect(redis.exists?("gitlab:ci:trace:#{build.id}:chunks:1")).to eq(true)
+      end
+
+      subject
+
+      redis_store.with do |redis|
+        expect(redis.exists?("gitlab:ci:trace:#{build.id}:chunks:0")).to eq(false)
+        expect(redis.exists?("gitlab:ci:trace:#{build.id}:chunks:1")).to eq(false)
+      end
+    end
+  end
+end