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

Support parsing of empty XML string tags #761

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Support parsing of empty XML string tags #761

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
31 changes: 24 additions & 7 deletions cyclonedx-bom/src/xml.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,20 +442,37 @@ impl FromXmlType for f32 {
}
}

/// Reads a simple String tag.
///
/// ```xml
/// <description>Content</description>
/// ```
/// &
/// ```xml
/// <description />
/// ```
///
/// are valid XML tags. The first returns the string "Content", the latter is an empty string.
pub(crate) fn read_simple_tag<R: Read>(
event_reader: &mut EventReader<R>,
element: &OwnedName,
) -> Result<String, XmlReadError> {
let element_display = element.to_string();
let content = event_reader
.next()
.map_err(to_xml_read_error(&element_display))
.and_then(inner_text_or_error(&element_display))?;

event_reader
.next()
.map_err(to_xml_read_error(&element_display))
.and_then(closing_tag_or_error(element))?;
.map_err(to_xml_read_error(&element_display))?;

let content = match content {
reader::XmlEvent::EndElement { .. } => String::new(),
reader::XmlEvent::Characters(content) | reader::XmlEvent::CData(content) => {
event_reader
.next()
.map_err(to_xml_read_error(&element_display))
.and_then(closing_tag_or_error(element))?;
content
}
unexpected => return Err(unexpected_element_error(element, unexpected)),
};

Ok(content)
}
Expand Down
48 changes: 48 additions & 0 deletions cyclonedx-bom/tests/spec/1.3/valid-service-empty-description-1.3.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?xml version="1.0"?>
<bom serialNumber="urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79" version="1" xmlns="http://cyclonedx.org/schema/bom/1.3">
<components>
<component type="library" bom-ref="pkg:maven/com.acme/[email protected]">
<group>com.acme</group>
<name>stock-java-client</name>
<version>1.0.12</version>
<hashes>
<hash alg="SHA-1">e6b1000b94e835ffd37f4c6dcbdad43f4b48a02a</hash>
</hashes>
<licenses>
<license>
<id>Apache-2.0</id>
</license>
</licenses>
<purl>pkg:maven/com.acme/[email protected]</purl>
</component>
</components>
<services>
<service bom-ref="b2a46a4b-8367-4bae-9820-95557cfe03a8">
<provider>
<name>Partner Org</name>
<url>https://partner.org</url>
<contact>
<name>Support</name>
<email>support@partner</email>
<phone>800-555-1212</phone>
</contact>
</provider>
<group>org.partner</group>
<name>Stock ticker service</name>
<version>2020-Q2</version>
<description />
<authenticated>true</authenticated>
<x-trust-boundary>true</x-trust-boundary>
<licenses>
<license>
<name>Partner license</name>
</license>
</licenses>
</service>
</services>
<dependencies>
<dependency ref="pkg:maven/com.acme/[email protected]">
<dependency ref="b2a46a4b-8367-4bae-9820-95557cfe03a8"/>
</dependency>
</dependencies>
</bom>
54 changes: 54 additions & 0 deletions ...ld_parse_all_of_the_valid_xml_specifications@valid-service-empty-description-1.3.xml.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
source: cyclonedx-bom/tests/specification_tests_v1_3.rs
assertion_line: 27
expression: bom_output
input_file: cyclonedx-bom/tests/spec/1.3/valid-service-empty-description-1.3.xml
---
<?xml version="1.0" encoding="utf-8"?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.3" serialNumber="urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79" version="1">
<components>
<component type="library" bom-ref="pkg:maven/com.acme/[email protected]">
<group>com.acme</group>
<name>stock-java-client</name>
<version>1.0.12</version>
<hashes>
<hash alg="SHA-1">e6b1000b94e835ffd37f4c6dcbdad43f4b48a02a</hash>
</hashes>
<licenses>
<license>
<id>Apache-2.0</id>
</license>
</licenses>
<purl>pkg:maven/com.acme/[email protected]</purl>
</component>
</components>
<services>
<service bom-ref="b2a46a4b-8367-4bae-9820-95557cfe03a8">
<provider>
<name>Partner Org</name>
<url>https://partner.org</url>
<contact>
<name>Support</name>
<email>support@partner</email>
<phone>800-555-1212</phone>
</contact>
</provider>
<group>org.partner</group>
<name>Stock ticker service</name>
<version>2020-Q2</version>
<description></description>
<authenticated>true</authenticated>
<x-trust-boundary>true</x-trust-boundary>
<licenses>
<license>
<name>Partner license</name>
</license>
</licenses>
</service>
</services>
<dependencies>
<dependency ref="pkg:maven/com.acme/[email protected]">
<dependency ref="b2a46a4b-8367-4bae-9820-95557cfe03a8" />
</dependency>
</dependencies>
</bom>