-
-
Notifications
You must be signed in to change notification settings - Fork 607
/
Copy pathBomUploadProcessingTaskTest.java
341 lines (296 loc) · 16.1 KB
/
BomUploadProcessingTaskTest.java
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
/*
* This file is part of Dependency-Track.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* Copyright (c) Steve Springett. All Rights Reserved.
*/
package org.dependencytrack.tasks;
import alpine.event.framework.EventService;
import alpine.notification.Notification;
import alpine.notification.NotificationLevel;
import alpine.notification.NotificationService;
import alpine.notification.Subscriber;
import alpine.notification.Subscription;
import net.jcip.annotations.NotThreadSafe;
import org.apache.commons.io.IOUtils;
import org.dependencytrack.PersistenceCapableTest;
import org.dependencytrack.event.BomUploadEvent;
import org.dependencytrack.event.NewVulnerableDependencyAnalysisEvent;
import org.dependencytrack.event.VulnerabilityAnalysisEvent;
import org.dependencytrack.model.Bom;
import org.dependencytrack.model.Classifier;
import org.dependencytrack.model.Component;
import org.dependencytrack.model.ConfigPropertyConstants;
import org.dependencytrack.model.License;
import org.dependencytrack.model.Project;
import org.dependencytrack.model.Severity;
import org.dependencytrack.model.Vulnerability;
import org.dependencytrack.model.VulnerabilityAnalysisLevel;
import org.dependencytrack.model.VulnerableSoftware;
import org.dependencytrack.notification.NotificationGroup;
import org.dependencytrack.notification.NotificationScope;
import org.dependencytrack.notification.vo.BomProcessingFailed;
import org.dependencytrack.notification.vo.NewVulnerabilityIdentified;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.ConcurrentLinkedQueue;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.dependencytrack.assertion.Assertions.assertConditionWithTimeout;
@NotThreadSafe
public class BomUploadProcessingTaskTest extends PersistenceCapableTest {
public static class NotificationSubscriber implements Subscriber {
@Override
public void inform(final Notification notification) {
NOTIFICATIONS.add(notification);
}
}
private static final ConcurrentLinkedQueue<Notification> NOTIFICATIONS = new ConcurrentLinkedQueue<>();
@Before
public void setUp() {
NotificationService.getInstance().subscribe(new Subscription(NotificationSubscriber.class));
// Enable processing of CycloneDX BOMs
qm.createConfigProperty(ConfigPropertyConstants.ACCEPT_ARTIFACT_CYCLONEDX.getGroupName(),
ConfigPropertyConstants.ACCEPT_ARTIFACT_CYCLONEDX.getPropertyName(), "true",
ConfigPropertyConstants.ACCEPT_ARTIFACT_CYCLONEDX.getPropertyType(),
ConfigPropertyConstants.ACCEPT_ARTIFACT_CYCLONEDX.getDescription());
// Enable internal vulnerability analyzer
qm.createConfigProperty(ConfigPropertyConstants.SCANNER_INTERNAL_ENABLED.getGroupName(),
ConfigPropertyConstants.SCANNER_INTERNAL_ENABLED.getPropertyName(), "true",
ConfigPropertyConstants.SCANNER_INTERNAL_ENABLED.getPropertyType(),
ConfigPropertyConstants.SCANNER_INTERNAL_ENABLED.getDescription());
}
@After
public void tearDown() {
NOTIFICATIONS.clear();
EventService.getInstance().unsubscribe(VulnerabilityAnalysisTask.class);
EventService.getInstance().unsubscribe(NewVulnerableDependencyAnalysisTask.class);
NotificationService.getInstance().unsubscribe(new Subscription(NotificationSubscriber.class));
}
@Test
public void informTest() throws Exception {
EventService.getInstance().subscribe(VulnerabilityAnalysisEvent.class, VulnerabilityAnalysisTask.class);
EventService.getInstance().subscribe(NewVulnerableDependencyAnalysisEvent.class, NewVulnerableDependencyAnalysisTask.class);
Project project = qm.createProject("Acme Example", null, "1.0", null, null, null, true, false);
final VulnerableSoftware vs = new VulnerableSoftware();
vs.setPurlType("maven");
vs.setPurlNamespace("com.example");
vs.setPurlName("xmlutil");
vs.setVersion("1.0.0");
vs.setVulnerable(true);
final var vulnerability1 = new Vulnerability();
vulnerability1.setVulnId("INT-001");
vulnerability1.setSource(Vulnerability.Source.INTERNAL);
vulnerability1.setSeverity(Severity.HIGH);
vulnerability1.setVulnerableSoftware(List.of(vs));
qm.createVulnerability(vulnerability1, false);
final var vulnerability2 = new Vulnerability();
vulnerability2.setVulnId("INT-002");
vulnerability2.setSource(Vulnerability.Source.INTERNAL);
vulnerability2.setSeverity(Severity.HIGH);
vulnerability2.setVulnerableSoftware(List.of(vs));
qm.createVulnerability(vulnerability2, false);
final byte[] bomBytes = Files.readAllBytes(Paths.get(getClass().getClassLoader().getResource("bom-1.xml").toURI()));
new BomUploadProcessingTask().inform(new BomUploadEvent(project.getUuid(), bomBytes));
assertConditionWithTimeout(() -> NOTIFICATIONS.size() >= 6, Duration.ofSeconds(5));
qm.getPersistenceManager().refresh(project);
assertThat(project.getClassifier()).isEqualTo(Classifier.APPLICATION);
assertThat(project.getLastBomImport()).isNotNull();
assertThat(project.getExternalReferences()).isNotNull();
assertThat(project.getExternalReferences()).hasSize(4);
final List<Component> components = qm.getAllComponents(project);
assertThat(components).hasSize(1);
final Component component = components.get(0);
assertThat(component.getAuthor()).isEqualTo("Sometimes this field is long because it is composed of a list of authors......................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................");
assertThat(component.getPublisher()).isEqualTo("Example Incorporated");
assertThat(component.getGroup()).isEqualTo("com.example");
assertThat(component.getName()).isEqualTo("xmlutil");
assertThat(component.getVersion()).isEqualTo("1.0.0");
assertThat(component.getDescription()).isEqualTo("A makebelieve XML utility library");
assertThat(component.getCpe()).isEqualTo("cpe:/a:example:xmlutil:1.0.0");
assertThat(component.getPurl().canonicalize()).isEqualTo("pkg:maven/com.example/[email protected]?packaging=jar");
assertThat(component.getLicenseUrl()).isEqualTo("https://www.apache.org/licenses/LICENSE-2.0.txt");
assertThat(qm.getAllVulnerabilities(component)).hasSize(2);
assertThat(NOTIFICATIONS).satisfiesExactly(
n -> assertThat(n.getGroup()).isEqualTo(NotificationGroup.PROJECT_CREATED.name()),
n -> assertThat(n.getGroup()).isEqualTo(NotificationGroup.BOM_CONSUMED.name()),
n -> assertThat(n.getGroup()).isEqualTo(NotificationGroup.BOM_PROCESSED.name()),
n -> {
assertThat(n.getGroup()).isEqualTo(NotificationGroup.NEW_VULNERABILITY.name());
NewVulnerabilityIdentified nvi = (NewVulnerabilityIdentified) n.getSubject();
assertThat(nvi.getVulnerabilityAnalysisLevel().equals(VulnerabilityAnalysisLevel.BOM_UPLOAD_ANALYSIS));
},
n -> {
assertThat(n.getGroup()).isEqualTo(NotificationGroup.NEW_VULNERABILITY.name());
NewVulnerabilityIdentified nvi = (NewVulnerabilityIdentified) n.getSubject();
assertThat(nvi.getVulnerabilityAnalysisLevel().toString().equals(VulnerabilityAnalysisLevel.BOM_UPLOAD_ANALYSIS));
},
n -> assertThat(n.getGroup()).isEqualTo(NotificationGroup.NEW_VULNERABLE_DEPENDENCY.name())
);
}
@Test
public void informWithInvalidCycloneDxBomTest() throws Exception {
final Project project = qm.createProject("Acme Example", null, "1.0", null, null, null, true, false);
final byte[] bomBytes = """
{
"bomFormat": "CycloneDX",
""".getBytes(StandardCharsets.UTF_8);
new BomUploadProcessingTask().inform(new BomUploadEvent(project.getUuid(), bomBytes));
assertConditionWithTimeout(() -> NOTIFICATIONS.size() >= 2, Duration.ofSeconds(5));
assertThat(NOTIFICATIONS).satisfiesExactly(
notification -> assertThat(notification.getGroup()).isEqualTo(NotificationGroup.PROJECT_CREATED.name()),
notification -> {
assertThat(notification.getScope()).isEqualTo(NotificationScope.PORTFOLIO.name());
assertThat(notification.getGroup()).isEqualTo(NotificationGroup.BOM_PROCESSING_FAILED.name());
assertThat(notification.getLevel()).isEqualTo(NotificationLevel.ERROR);
assertThat(notification.getTitle()).isNotBlank();
assertThat(notification.getContent()).isNotBlank();
assertThat(notification.getSubject()).isInstanceOf(BomProcessingFailed.class);
final var subject = (BomProcessingFailed) notification.getSubject();
assertThat(subject.getProject().getUuid()).isEqualTo(project.getUuid());
assertThat(subject.getBom()).isEqualTo("ewogICJib21Gb3JtYXQiOiAiQ3ljbG9uZURYIiwK");
assertThat(subject.getFormat()).isEqualTo(Bom.Format.CYCLONEDX);
assertThat(subject.getSpecVersion()).isNull();
assertThat(subject.getCause()).isEqualTo("Unable to parse BOM from byte array");
}
);
qm.getPersistenceManager().refresh(project);
assertThat(project.getClassifier()).isNull();
assertThat(project.getLastBomImport()).isNull();
}
@Test // https://github.com/DependencyTrack/dependency-track/issues/2859
public void informIssue2859Test() throws Exception {
final Project project = qm.createProject("Acme Example", null, "1.0", null, null, null, true, false);
final byte[] bomBytes = IOUtils.resourceToByteArray("/unit/bom-issue2859.xml");
assertThatNoException()
.isThrownBy(() -> new BomUploadProcessingTask().inform(new BomUploadEvent(project.getUuid(), bomBytes)));
}
@Test
public void informWithBomContainingLicenseExpressionTest() throws Exception {
final var project = new Project();
project.setName("acme-app");
qm.persist(project);
final byte[] bomBytes = """
{
"bomFormat": "CycloneDX",
"specVersion": "1.4",
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"version": 1,
"components": [
{
"type": "library",
"publisher": "Acme Inc",
"group": "com.acme",
"name": "tomcat-catalina",
"version": "9.0.14",
"licenses": [
{
"expression": "EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0"
}
]
}
]
}
""".getBytes(StandardCharsets.UTF_8);
new BomUploadProcessingTask().inform(new BomUploadEvent(project.getUuid(), bomBytes));
assertConditionWithTimeout(() -> NOTIFICATIONS.size() >= 2, Duration.ofSeconds(5));
assertThat(qm.getAllComponents(project)).satisfiesExactly(component -> {
assertThat(component.getLicense()).isNull();
assertThat(component.getLicenseExpression()).isEqualTo("EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0");
assertThat(component.getResolvedLicense()).isNull();
});
}
@Test
public void informWithBomContainingLicenseExpressionWithSingleIdTest() throws Exception {
final var license = new License();
license.setLicenseId("EPL-2.0");
license.setName("Eclipse Public License 2.0");
qm.persist(license);
final var project = new Project();
project.setName("acme-app");
qm.persist(project);
final byte[] bomBytes = """
{
"bomFormat": "CycloneDX",
"specVersion": "1.4",
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"version": 1,
"components": [
{
"type": "library",
"publisher": "Acme Inc",
"group": "com.acme",
"name": "tomcat-catalina",
"version": "9.0.14",
"licenses": [
{
"expression": "EPL-2.0"
}
]
}
]
}
""".getBytes(StandardCharsets.UTF_8);
new BomUploadProcessingTask().inform(new BomUploadEvent(project.getUuid(), bomBytes));
assertConditionWithTimeout(() -> NOTIFICATIONS.size() >= 2, Duration.ofSeconds(5));
assertThat(qm.getAllComponents(project)).satisfiesExactly(component -> {
assertThat(component.getResolvedLicense()).isNotNull();
assertThat(component.getResolvedLicense().getLicenseId()).isEqualTo("EPL-2.0");
assertThat(component.getLicense()).isNull();
assertThat(component.getLicenseExpression()).isEqualTo("EPL-2.0");
});
}
@Test
public void informWithBomContainingInvalidLicenseExpressionTest() throws Exception {
final var project = new Project();
project.setName("acme-app");
qm.persist(project);
final byte[] bomBytes = """
{
"bomFormat": "CycloneDX",
"specVersion": "1.4",
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"version": 1,
"components": [
{
"type": "library",
"publisher": "Acme Inc",
"group": "com.acme",
"name": "tomcat-catalina",
"version": "9.0.14",
"licenses": [
{
"expression": "(invalid"
}
]
}
]
}
""".getBytes(StandardCharsets.UTF_8);
new BomUploadProcessingTask().inform(new BomUploadEvent(project.getUuid(), bomBytes));
assertConditionWithTimeout(() -> NOTIFICATIONS.size() >= 2, Duration.ofSeconds(5));
assertThat(qm.getAllComponents(project)).satisfiesExactly(component -> {
assertThat(component.getLicense()).isNull();
assertThat(component.getLicenseExpression()).isNull();
assertThat(component.getResolvedLicense()).isNull();
});
}
}