spec/lib/gitlab/ci/trace/archive_spec.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Ci::Trace::Archive do
  let_it_be(:job) { create(:ci_build, :success, :trace_live) }
  let_it_be_with_reload(:trace_metadata) { create(:ci_build_trace_metadata, build: job) }
  let_it_be(:src_checksum) do
    job.trace.read { |stream| Digest::MD5.hexdigest(stream.raw) }
  end

  let(:metrics) { spy('metrics') }

  describe '#execute' do
    subject { described_class.new(job, trace_metadata, metrics) }

    it 'computes and assigns checksum' do
      Gitlab::Ci::Trace::ChunkedIO.new(job) do |stream|
        expect { subject.execute!(stream) }.to change { Ci::JobArtifact.count }.by(1)
      end

      expect(trace_metadata.checksum).to eq(src_checksum)
      expect(trace_metadata.trace_artifact).to eq(job.job_artifacts_trace)
    end

    context 'validating artifact checksum' do
      let(:trace) { 'abc' }
      let(:stream) { StringIO.new(trace, 'rb') }
      let(:src_checksum) { Digest::MD5.hexdigest(trace) }

      context 'when the object store is disabled' do
        before do
          stub_artifacts_object_storage(enabled: false)
        end

        it 'skips validation' do
          subject.execute!(stream)

          expect(trace_metadata.checksum).to eq(src_checksum)
          expect(trace_metadata.remote_checksum).to be_nil
          expect(metrics)
            .not_to have_received(:increment_error_counter)
            .with(type: :archive_invalid_checksum)
        end
      end

      context 'with background_upload enabled' do
        before do
          stub_artifacts_object_storage(background_upload: true)
        end

        it 'skips validation' do
          subject.execute!(stream)

          expect(trace_metadata.checksum).to eq(src_checksum)
          expect(trace_metadata.remote_checksum).to be_nil
          expect(metrics)
            .not_to have_received(:increment_error_counter)
            .with(type: :archive_invalid_checksum)
        end
      end

      context 'with direct_upload enabled' do
        before do
          stub_artifacts_object_storage(direct_upload: true)
        end

        it 'validates the archived trace' do
          subject.execute!(stream)

          expect(trace_metadata.checksum).to eq(src_checksum)
          expect(trace_metadata.remote_checksum).to eq(src_checksum)
          expect(metrics)
            .not_to have_received(:increment_error_counter)
            .with(type: :archive_invalid_checksum)
        end

        context 'when the checksum does not match' do
          let(:invalid_remote_checksum) { SecureRandom.hex }

          before do
            expect(::Gitlab::Ci::Trace::RemoteChecksum)
              .to receive(:new)
              .with(an_instance_of(Ci::JobArtifact))
              .and_return(double(md5_checksum: invalid_remote_checksum))
          end

          it 'validates the archived trace' do
            subject.execute!(stream)

            expect(trace_metadata.checksum).to eq(src_checksum)
            expect(trace_metadata.remote_checksum).to eq(invalid_remote_checksum)
            expect(metrics)
              .to have_received(:increment_error_counter)
              .with(type: :archive_invalid_checksum)
          end
        end
      end
    end
  end
end