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.

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(SBOMER-171): bugfixing operation handling #789

Merged
merged 2 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ public void adjust(PncBuildConfig config) {
public void adjust(OperationConfig config) {
log.debug("Adjusting operation configuration...");

// If we have not specified any products (for example when provided an empty config)
if (config.getProduct() == null) {
config.setProduct(ProductConfig.builder().build());
}

GeneratorConfig generatorConfig = config.getProduct().getGenerator();

// Generator configuration was not provided, will use defaults
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.SuperBuilder;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@Data
@SuperBuilder(setterPrefix = "with")
@AllArgsConstructor
Expand Down Expand Up @@ -115,6 +117,15 @@ public String toProcessorsCommand() {
}).collect(Collectors.joining(" "));
}

public static <T extends Config> T newInstance(Class<T> clazz) {
try {
return clazz.getConstructor().newInstance();
} catch (Exception e) {
log.warn("Unable to create a new default config of class '{}'", clazz, e);
return null;
}
}

public String toJson() {
try {
return ObjectMapperProvider.json().writerWithDefaultPrettyPrinter().writeValueAsString(this);
Expand Down
14 changes: 13 additions & 1 deletion core/src/main/resources/schemas/operation_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@
"description": "User-provided configuration file to instruct SBOM generation",
"type": "object",
"$defs": {
"processor-default": {
"$id": "/schemas/processors/default",
"type": "object",
"properties": {
"type": {
"const": "default"
}
}
},
"processor-redhat-product": {
"$id": "/schemas/processors/redhat-product",
"type": "object",
Expand Down Expand Up @@ -82,8 +91,11 @@
"type": "array",
"uniqueItems": true,
"minItems": 0,
"maxItems": 1,
"maxItems": 2,
"prefixItems": [
{
"$ref": "#/$defs/processor-default"
},
{
"$ref": "#/$defs/processor-redhat-product"
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package org.jboss.sbomer.core.test.unit.config;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.IOException;

Expand Down Expand Up @@ -53,9 +55,61 @@ void shouldConvertToPncBuildConfig() {
assertEquals(new PncBuildConfig(), Config.fromString("{\"type\": \"pnc-build\"}"));
}

@Nested
class DeliverableAnalysisConfigTest {

@Test
void shouldReturnDefault() {
DeliverableAnalysisConfig config = Config.newInstance(DeliverableAnalysisConfig.class);

assertEquals("sbomer.jboss.org/v1alpha1", config.getApiVersion());
assertNull(config.getDeliverableUrls());
assertNull(config.getErrata());
assertNull(config.getMilestoneId());
}
}

@Nested
class OperationConfigTest {

@Test
void shouldReturnDefault() {
OperationConfig config = Config.newInstance(OperationConfig.class);

assertEquals("sbomer.jboss.org/v1alpha1", config.getApiVersion());
assertNull(config.getDeliverableUrls());
assertNull(config.getOperationId());
assertNull(config.getProduct());
}
}

@Nested
class PncBuildConfigTest {

@Test
void shouldReturnDefault() {
PncBuildConfig config = Config.newInstance(PncBuildConfig.class);

assertEquals("sbomer.jboss.org/v1alpha1", config.getApiVersion());
assertNull(config.getBuildId());
assertNull(config.getEnvironment());
assertTrue(config.getProducts().isEmpty());
}
}

@Nested
class SyftImageConfigTest {

@Test
void shouldReturnNewInstance() {
SyftImageConfig config = Config.newInstance(SyftImageConfig.class);

assertEquals("sbomer.jboss.org/v1alpha1", config.getApiVersion());
assertTrue(config.getPaths().isEmpty());
assertFalse(config.isIncludeRpms());

}

@Test
void shouldAddDefaultProcessor() {
assertEquals("default", new SyftImageConfig().toProcessorsCommand());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,20 @@ public Config getConfig() {
}

@JsonIgnore
@Deprecated
public <T extends Config> T getConfig(Class<T> clazz) {
return getConfig(clazz, false);
}

@JsonIgnore
public <T extends Config> T getConfig(Class<T> clazz, boolean def) {
String configData = getData().get(KEY_CONFIG);
return Config.fromString(configData, clazz);
T config = Config.fromString(configData, clazz);

if (config == null && def) {
return Config.newInstance(clazz);
}
return config;
}

@JsonIgnore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ protected TaskRun desired(GenerationRequest generationRequest, Context<Generatio
labels.put(Labels.LABEL_PHASE, SbomGenerationPhase.OPERATIONINIT.name().toLowerCase());
labels.put(Labels.LABEL_GENERATION_REQUEST_ID, generationRequest.getId());

OperationConfig config = generationRequest.getConfig(OperationConfig.class);
OperationConfig config = generationRequest.getConfig(OperationConfig.class, true);

return new TaskRunBuilder().withNewMetadata()
.withNamespace(generationRequest.getMetadata().getNamespace())
Expand Down
Loading