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

Jump to bottom

Use jsonschema only as a dev-dependency #750

Merged
merged 8 commits into from
Aug 6, 2024
Merged

Use jsonschema only as a dev-dependency #750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d41b8c8
Make SpecVersion enum exhaustive
Shnatsel Jul 17, 2024
607a43f
Drop obsolete comments
Shnatsel Jul 17, 2024
46cdbb1
Move test-only schema stuff to a separate crate, which is only includ…
Shnatsel Jul 17, 2024
1e66664
Merge branch 'exhaustive-enum' into test-only-schema
Shnatsel Jul 17, 2024
6d2b9f4
Convert integration tests to using the test crate
Shnatsel Jul 17, 2024
4e4a8fd
Do not publish all our test data to crates.io. It is useless when cyc…
Shnatsel Jul 17, 2024
edee7b6
cargo fmt
Shnatsel Jul 17, 2024
1a9b29b
Merge branch 'main' into test-only-schema
Shnatsel Jul 17, 2024
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
596 changes: 78 additions & 518 deletions Cargo.lock
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion cyclonedx-bom/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description = "CycloneDX Software Bill of Materials Library"
categories = ["encoding", "parser-implementations"]
keywords = ["sbom", "bom", "components", "dependencies", "owasp"]
readme = "README.md"
exclude = ["tests/", "test-utils/"]

authors.workspace = true
edition.workspace = true
Expand All @@ -17,7 +18,6 @@ rust-version.workspace = true
base64 = "0.21.2"
fluent-uri = "0.1.4"
indexmap = "2.2.2"
jsonschema = "0.17.1"
once_cell = "1.18.0"
ordered-float = { version = "4.2.0", default-features = false }
purl = { version = "0.1.3", default-features = false }
Expand All @@ -35,3 +35,4 @@ strum = { version = "0.26.2", features = ["derive"] }
[dev-dependencies]
insta = { version = "1.33.0", features = ["glob", "json"] }
pretty_assertions = "1.4.0"
test-utils = {path = "test-utils"}
1 change: 0 additions & 1 deletion cyclonedx-bom/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ pub mod errors;
pub mod external_models;
pub mod models;
pub mod prelude;
pub mod schema;
pub mod validation;

mod specs;
Expand Down
13 changes: 0 additions & 13 deletions cyclonedx-bom/src/models/bom.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ use super::vulnerability::Vulnerability;

/// Represents the spec version of a BOM.
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone, Copy, PartialOrd, strum::Display)]
#[repr(u16)]
#[non_exhaustive]
pub enum SpecVersion {
#[strum(to_string = "1.3")]
#[serde(rename = "1.3")]
Expand Down Expand Up @@ -155,11 +153,6 @@ impl Bom {
reader: R,
version: SpecVersion,
) -> Result<Self, crate::errors::JsonReadError> {
// While the SpecVersion enum is non-exhaustive in the public API
// (and it probably shouldn't be!), we can match exhaustively here
// which avoids issues which crop up when the API user has to match:
// https://github.com/CycloneDX/cyclonedx-rust-cargo/pull/722
// https://github.com/CycloneDX/cyclonedx-rust-cargo/pull/723
match version {
SpecVersion::V1_3 => Self::parse_from_json_v1_3(reader),
SpecVersion::V1_4 => Self::parse_from_json_v1_4(reader),
Expand All @@ -173,8 +166,6 @@ impl Bom {
writer: &mut W,
version: SpecVersion,
) -> Result<(), crate::errors::JsonWriteError> {
// See `parse_from_json_with_version` for an explanation
// why we do this match here and why API users shouldn't do it
match version {
SpecVersion::V1_3 => self.output_as_json_v1_3(writer),
SpecVersion::V1_4 => self.output_as_json_v1_4(writer),
Expand All @@ -187,8 +178,6 @@ impl Bom {
reader: R,
version: SpecVersion,
) -> Result<Self, crate::errors::XmlReadError> {
// See `parse_from_json_with_version` for an explanation
// why we do this match here and why API users shouldn't do it
match version {
SpecVersion::V1_3 => Self::parse_from_xml_v1_3(reader),
SpecVersion::V1_4 => Self::parse_from_xml_v1_4(reader),
Expand All @@ -202,8 +191,6 @@ impl Bom {
writer: &mut W,
version: SpecVersion,
) -> Result<(), crate::errors::XmlWriteError> {
// See `parse_from_json_with_version` for an explanation
// why we do this match here and why API users shouldn't do it
match version {
SpecVersion::V1_3 => self.output_as_xml_v1_3(writer),
SpecVersion::V1_4 => self.output_as_xml_v1_4(writer),
Expand Down
10 changes: 10 additions & 0 deletions cyclonedx-bom/test-utils/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[package]
name = "test-utils"
version = "0.1.0"
edition = "2021"
publish = false

[dependencies]
jsonschema = { version = "0.17.1", default-features = false }
cyclonedx-bom = { path = ".." }
serde_json = "1.0.108"
0 cyclonedx-bom/schema/bom-1.3.schema.json → ...bom/test-utils/schema/bom-1.3.schema.json
View file
Open in desktop
File renamed without changes.
0 cyclonedx-bom/schema/bom-1.4.schema.json → ...bom/test-utils/schema/bom-1.4.schema.json
View file
Open in desktop
File renamed without changes.
0 cyclonedx-bom/schema/bom-1.5.schema.json → ...bom/test-utils/schema/bom-1.5.schema.json
View file
Open in desktop
File renamed without changes.
0 cyclonedx-bom/schema/jsf-0.82.schema.json → ...om/test-utils/schema/jsf-0.82.schema.json
View file
Open in desktop
File renamed without changes.
0 cyclonedx-bom/schema/spdx.schema.json → ...dx-bom/test-utils/schema/spdx.schema.json
View file
Open in desktop
File renamed without changes.
67 changes: 34 additions & 33 deletions cyclonedx-bom/src/schema.rs → cyclonedx-bom/test-utils/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

use jsonschema::{error::ValidationErrorKind, paths::JSONPointer, JSONSchema};

use crate::models::bom::SpecVersion;
use cyclonedx_bom::models::bom::SpecVersion;

#[derive(Debug)]
pub struct ValidationError {
Expand Down Expand Up @@ -51,7 +51,7 @@ impl ValidationError {
///
/// ```rust
/// use cyclonedx_bom::prelude::*;
/// use cyclonedx_bom::schema::validate_json_with_schema;
/// use test_utils::validate_json_with_schema;
///
/// let bom_json = r#"{
/// "bomFormat": "CycloneDX",
Expand Down Expand Up @@ -116,41 +116,42 @@ fn with_idn_email(_s: &str) -> bool {

#[cfg(test)]
mod test {
use crate::{models::bom::SpecVersion, schema::validate_json_with_schema};
use super::validate_json_with_schema;
use cyclonedx_bom::models::bom::SpecVersion;

#[test]
fn it_should_validate_version_13() {
let input = r#"
{
"bomFormat": "CycloneDX",
"specVersion": "1.3",
"version": 1,
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"components": [
{
"type": "library",
"name": "acme-library-a",
"version": "1.0.0",
"components": [
{
"type": "library",
"name": "acme-library-b",
"version": "2.0.0"
}
]
}
],
"services": [
{
"name": "acme-service-a",
"services": [
{
"name": "acme-service-b"
}
]
}
]
}"#;
{
"bomFormat": "CycloneDX",
"specVersion": "1.3",
"version": 1,
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"components": [
{
"type": "library",
"name": "acme-library-a",
"version": "1.0.0",
"components": [
{
"type": "library",
"name": "acme-library-b",
"version": "2.0.0"
}
]
}
],
"services": [
{
"name": "acme-service-a",
"services": [
{
"name": "acme-service-b"
}
]
}
]
}"#;
let json = serde_json::from_str(input).expect("Failed to parse JSON");
assert!(validate_json_with_schema(&json, SpecVersion::V1_3).is_ok());
}
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx-bom/tests/specification_tests_v1_3.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
mod v1_3 {
use cyclonedx_bom::models::bom::{Bom, SpecVersion};
use cyclonedx_bom::schema::validate_json_with_schema;
use cyclonedx_bom::validation::Validate;
use test_utils::validate_json_with_schema;

#[test]
fn it_should_parse_all_of_the_valid_xml_specifications() {
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx-bom/tests/specification_tests_v1_4.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
mod v1_4 {
use cyclonedx_bom::models::bom::{Bom, SpecVersion};
use cyclonedx_bom::schema::validate_json_with_schema;
use cyclonedx_bom::validation::Validate;
use test_utils::validate_json_with_schema;

#[test]
fn it_should_parse_all_of_the_valid_xml_specifications() {
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx-bom/tests/specification_tests_v1_5.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
mod v1_5 {
use cyclonedx_bom::models::bom::{Bom, SpecVersion};
use cyclonedx_bom::schema::validate_json_with_schema;
use cyclonedx_bom::validation::Validate;
use test_utils::validate_json_with_schema;

#[test]
fn it_should_parse_all_of_the_valid_xml_specifications() {
Expand Down
Loading