Skip to content

Write metadata distribution constraints #986

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

Open
wleeaf wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −0
Open

Write metadata distribution constraints #986

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
4 changes: 4 additions & 0 deletions src/main/java/org/cyclonedx/util/serializer/MetadataSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ private void createMetadataInfo(
}
}

if (metadata.getDistributionConstraints() != null && shouldSerializeField(metadata, version, "distributionConstraints")) {
jsonGenerator.writeObjectField("distributionConstraints", metadata.getDistributionConstraints());
}

jsonGenerator.writeEndObject();
}

Expand Down
13 changes: 13 additions & 0 deletions src/test/java/org/cyclonedx/BomJsonGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,19 @@ public void schema12MultipleDependenciesJsonTest() throws Exception {
assertTrue(jsonParser.isValid(file, Version.VERSION_12));
}

@Test
public void schema17MetadataDistributionConstraintsJsonTest() throws Exception {
final byte[] bomBytes = Objects.requireNonNull(this.getClass().getResourceAsStream("/1.7/valid-metadata-distribution-1.7.json")).readAllBytes();
final Bom bom = new JsonParser().parse(bomBytes);

BomJsonGenerator generator = BomGeneratorFactory.createJson(Version.VERSION_17, bom);
JsonNode metadata = generator.toJsonNode().get("metadata");
assertEquals("RED", metadata.get("distributionConstraints").get("tlp").asText());

generator = BomGeneratorFactory.createJson(Version.VERSION_16, bom);
assertNull(generator.toJsonNode().get("metadata").get("distributionConstraints"));
}

@Test
public void schema13EmptyComponentsJsonTest() throws Exception {
final Bom bom = new Bom();
Expand Down
10 changes: 10 additions & 0 deletions src/test/java/org/cyclonedx/BomXmlGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1335,6 +1335,16 @@ private File writeToFile(String xmlString) throws Exception {
return tempFile;
}

@Test
public void schema17MetadataDistributionConstraintsGenerationTest() throws Exception {
BomXmlGenerator generator = BomGeneratorFactory.createXml(Version.VERSION_17, createCommonBomXml("/1.7/valid-metadata-distribution-1.7.xml"));
String xml = generator.toXmlString();
assertTrue(xml.contains("<tlp>RED</tlp>"), xml);
File file = writeToFile(xml);
XmlParser parser = new XmlParser();
assertTrue(parser.isValid(file, Version.VERSION_17));
}

private Bom createCommonBomXml(String resource) throws Exception {
final byte[] bomBytes = Objects.requireNonNull(this.getClass().getResourceAsStream(resource)).readAllBytes();
XmlParser parser = new XmlParser();
Expand Down