Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fail fast on NVD API JSON object mapping/binding errors #168

Merged
merged 1 commit into from
Jun 29, 2024
Merged

fix: Fail fast on NVD API JSON object mapping/binding errors #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion ...clients/src/main/java/io/github/jeremylong/openvulnerability/client/nvd/NvdCveClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.github.jeremylong.openvulnerability.client.nvd;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import io.github.jeremylong.openvulnerability.client.HttpAsyncClientSupplier;
Expand Down Expand Up @@ -337,9 +338,13 @@ public Collection<DefCveItem> next() {
try {
current = objectMapper.readValue(json, CveApiJson20.class);
this.indexesToRetrieve.remove(call.getStartIndex());
} catch (JsonMappingException e) {
LOG.debug("Error parsing NVD data", e);
// Fail fast on JSON parsing errors
throw new NvdApiException("Failed to parse NVD data", e);
} catch (JsonProcessingException e) {
LOG.debug("Error processing NVD data", e);
// really re-fetch the same data?
// Re-try on what might be temporarily streaming errors
return next();
}
this.totalAvailable = current.getTotalResults();
Expand Down
25 changes: 12 additions & 13 deletions ...lnerability/client/nvd/NvdCveApiTest.java → ...ient/nvd/NvdCveClientIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,17 @@

import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.junit.jupiter.api.Timeout;

import java.time.ZoneOffset;
import java.time.ZonedDateTime;
import java.util.Collection;
import java.util.concurrent.TimeUnit;

class NvdCveApiTest {
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

private static final Logger LOG = LoggerFactory.getLogger(NvdCveApiTest.class);
class NvdCveClientIntegrationTest {

ZonedDateTime retrieveLastUpdated() {
// TODO implement a storage/retrieval mechanism.
Expand All @@ -39,6 +40,7 @@ void storeLasUpdated(ZonedDateTime lastUpdated) {
}

@Test
@Timeout(value = 2, unit = TimeUnit.MINUTES)
public void update() {
String apiKey = System.getenv("NVD_API_KEY");
if (apiKey != null) {
Expand All @@ -54,20 +56,17 @@ public void update() {
}
// TODO add any additional filters via the builder's `withfilter()`

// TODO add API key with builder's `withApiKey()`

try (NvdCveClient api = builder.build()) {
try (NvdCveClient api = builder.withApiKey(apiKey).withMaxPageCount(1).build()) {
// in a real world case - `while` would be used instead of `if`
if (api.hasNext()) {
Collection<DefCveItem> items = api.next();
// TODO do something with the items
for (DefCveItem i : items) {
System.out.println("Retrieved " + i.getCve().getId());
}

assertFalse(items::isEmpty, "Should receive at least 1 item from first API call");

items.stream().findFirst()
.ifPresent(i -> assertTrue(() -> i.getCve().getId() != null, "CVE ID should not be null"));
}
lastModifiedRequest = api.getLastUpdated();
} catch (Exception e) {
e.printStackTrace();
}
storeLasUpdated(lastModifiedRequest);
}
Expand Down
Loading