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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::BackgroundMigration::MigrateRemediationsForVulnerabilityFindings,
feature_category: :vulnerability_management do
let(:vulnerability_occurrences) { table(:vulnerability_occurrences) }
let(:vulnerability_findings_remediations) { table(:vulnerability_findings_remediations) }
let(:vulnerability_remediations) { table(:vulnerability_remediations) }
let(:remediation_hash) { { summary: 'summary', diff: "ZGlmZiAtLWdp" } }
let(:namespace1) { table(:namespaces).create!(name: 'namespace 1', path: 'namespace1') }
let(:project1) { table(:projects).create!(namespace_id: namespace1.id, project_namespace_id: namespace1.id) }
let(:user) { table(:users).create!(email: 'test1@example.com', projects_limit: 5) }
let(:scanner1) do
table(:vulnerability_scanners).create!(project_id: project1.id, external_id: 'test 1', name: 'test scanner 1')
end
let(:stating_id) { vulnerability_occurrences.pluck(:id).min }
let(:end_id) { vulnerability_occurrences.pluck(:id).max }
let(:migration) do
described_class.new(
start_id: stating_id,
end_id: end_id,
batch_table: :vulnerability_occurrences,
batch_column: :id,
sub_batch_size: 2,
pause_ms: 2,
connection: ApplicationRecord.connection
)
end
subject(:perform_migration) { migration.perform }
context 'without the presence of remediation key' do
before do
create_finding!(project1.id, scanner1.id, { other_keys: 'test' })
end
it 'does not create any remediation' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.not_to change { vulnerability_remediations.count }
end
end
context 'with remediation equals to an array of nil element' do
before do
create_finding!(project1.id, scanner1.id, { remediations: [nil] })
end
it 'does not create any remediation' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.not_to change { vulnerability_remediations.count }
end
end
context 'with remediation with empty string as the diff key' do
let!(:finding) do
create_finding!(project1.id, scanner1.id, { remediations: [{ summary: 'summary', diff: '' }] })
end
it 'does not create any remediation' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.not_to change { vulnerability_remediations.count }
end
end
context 'with remediation equals to an array of duplicated elements' do
let!(:finding) do
create_finding!(project1.id, scanner1.id, { remediations: [remediation_hash, remediation_hash] })
end
it 'creates new remediation' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.to change { vulnerability_remediations.count }.by(1)
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding.id).length).to eq(1)
end
end
context 'with existing remediations within raw_metadata' do
let!(:finding1) { create_finding!(project1.id, scanner1.id, { remediations: [remediation_hash] }) }
let!(:finding2) { create_finding!(project1.id, scanner1.id, { remediations: [remediation_hash] }) }
it 'creates new remediation' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.to change { vulnerability_remediations.count }.by(1)
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding1.id).length).to eq(1)
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding2.id).length).to eq(1)
end
context 'when create throws exception other than ActiveRecord::RecordNotUnique' do
before do
allow(migration).to receive(:create_finding_remediations).and_raise(StandardError)
end
it 'rolls back all related transactions' do
expect(Gitlab::AppLogger).to receive(:error).with({
class: described_class.name, message: StandardError.to_s, model_id: finding1.id
})
expect(Gitlab::AppLogger).to receive(:error).with({
class: described_class.name, message: StandardError.to_s, model_id: finding2.id
})
expect { perform_migration }.not_to change { vulnerability_remediations.count }
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding1.id).length).to eq(0)
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding2.id).length).to eq(0)
end
end
end
context 'with existing remediation records' do
let!(:finding) { create_finding!(project1.id, scanner1.id, { remediations: [remediation_hash] }) }
before do
vulnerability_remediations.create!(project_id: project1.id, summary: remediation_hash[:summary],
checksum: checksum(remediation_hash[:diff]), file: Tempfile.new.path)
end
it 'does not create new remediation' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.not_to change { vulnerability_remediations.count }
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding.id).length).to eq(1)
end
end
context 'with same raw_metadata for different projects' do
let(:namespace2) { table(:namespaces).create!(name: 'namespace 2', path: 'namespace2') }
let(:project2) { table(:projects).create!(namespace_id: namespace2.id, project_namespace_id: namespace2.id) }
let(:scanner2) do
table(:vulnerability_scanners).create!(project_id: project2.id, external_id: 'test 2', name: 'test scanner 2')
end
let!(:finding1) { create_finding!(project1.id, scanner1.id, { remediations: [remediation_hash] }) }
let!(:finding2) { create_finding!(project2.id, scanner2.id, { remediations: [remediation_hash] }) }
it 'creates new remediation for each project' do
expect(Gitlab::AppLogger).not_to receive(:error)
expect { perform_migration }.to change { vulnerability_remediations.count }.by(2)
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding1.id).length).to eq(1)
expect(vulnerability_findings_remediations.where(vulnerability_occurrence_id: finding2.id).length).to eq(1)
end
end
private
def create_finding!(project_id, scanner_id, raw_metadata)
vulnerability = table(:vulnerabilities).create!(project_id: project_id, author_id: user.id, title: 'test',
severity: 4, confidence: 4, report_type: 0)
identifier = table(:vulnerability_identifiers).create!(project_id: project_id, external_type: 'uuid-v5',
external_id: 'uuid-v5', fingerprint: OpenSSL::Digest::SHA256.hexdigest(vulnerability.id.to_s),
name: 'Identifier for UUIDv5 2 2')
table(:vulnerability_occurrences).create!(
vulnerability_id: vulnerability.id, project_id: project_id, scanner_id: scanner_id,
primary_identifier_id: identifier.id, name: 'test', severity: 4, confidence: 4, report_type: 0,
uuid: SecureRandom.uuid, project_fingerprint: '123qweasdzxc', location: { "image" => "alpine:3.4" },
location_fingerprint: 'test', metadata_version: 'test',
raw_metadata: raw_metadata.to_json)
end
def checksum(value)
sha = Digest::SHA256.hexdigest(value)
Gitlab::Database::ShaAttribute.new.serialize(sha)
end
end
|
