Skip to content
Open
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
11 changes: 3 additions & 8 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,6 @@ local-ip-address = "0.6.3"
log = "0.4.19"
lru = "0.18.0"
mac_address = "1.1"
md5 = "0.8"
metrics = "0.24"
metrics-exporter-prometheus = "0.18"
mime = "0.3"
Expand Down
195 changes: 192 additions & 3 deletions crates/api-model/src/firmware.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ use std::fmt::{Debug, Display};
use std::path::PathBuf;

use regex::Regex;
use serde::de::{self, Deserializer};
use serde::{Deserialize, Serialize};

use crate::site_explorer::EndpointExplorationReport;
Expand Down Expand Up @@ -205,13 +206,57 @@ pub struct FirmwareEntry {
pub scout: Option<ScoutConfig>,
}

#[derive(Clone, Debug, Deserialize, Serialize, Default)]
#[derive(Clone, Debug, Serialize, Default)]
pub struct FirmwareFileArtifact {
pub filename: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filename: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
pub sha256: String,
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

#[derive(Clone, Debug, Deserialize, Serialize, Default)]
#[derive(Deserialize)]
struct FirmwareFileArtifactWire {
#[serde(default)]
filename: Option<String>,
#[serde(default)]
url: Option<String>,
sha256: String,
}

// Transitional validation while firmware metadata supports both local artifacts
// and URL-based artifacts. Once metadata is fully URL-based, `url` should
// become required and `filename` can be removed (and this impl block too).
impl<'de> Deserialize<'de> for FirmwareFileArtifact {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let wire = FirmwareFileArtifactWire::deserialize(deserializer)?;
if !firmware_file_artifact_location_is_set(&wire.filename)
&& !firmware_file_artifact_location_is_set(&wire.url)
{
return Err(de::Error::custom(
"firmware files[] artifact must set filename or url",
));
}

Ok(Self {
filename: wire.filename,
url: wire.url,
sha256: wire.sha256,
})
}
}

fn firmware_file_artifact_location_is_set(value: &Option<String>) -> bool {
value
.as_deref()
.map(str::trim)
.is_some_and(|value| !value.is_empty())
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ScoutConfig {
/// Legacy script metadata accepted for backwards-compatible config parsing.
/// Scout script selection is inferred from the PXE script registry.
Expand Down Expand Up @@ -276,6 +321,18 @@ impl FirmwareEntry {
ret
}

pub fn artifact_count(&self) -> usize {
if !self.files.is_empty() {
self.files.len()
} else if !self.filenames.is_empty() {
self.filenames.len()
} else if self.filename.is_some() || self.url.is_some() {
1
} else {
0
}
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.

pub fn get_filename(&self, pos: u32) -> PathBuf {
let pos = pos.try_into().unwrap_or(usize::MAX);
let filename = if self.filenames.is_empty() {
Expand Down Expand Up @@ -326,3 +383,135 @@ impl Display for AgentUpgradePolicyChoice {
std::fmt::Debug::fmt(&self, f)
}
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn artifact_count_prefers_files_then_legacy_fields() {
let files_count = FirmwareEntry {
files: vec![
FirmwareFileArtifact {
filename: Some("first.bin".to_string()),
url: None,
sha256: "abc123".to_string(),
},
FirmwareFileArtifact {
filename: Some("second.bin".to_string()),
url: None,
sha256: "def456".to_string(),
},
],
filenames: vec!["legacy.bin".to_string()],
filename: Some("single-legacy.bin".to_string()),
..FirmwareEntry::default()
};
assert_eq!(files_count.artifact_count(), 2);

let filenames_count = FirmwareEntry {
filenames: vec!["first.bin".to_string(), "second.bin".to_string()],
filename: Some("single-legacy.bin".to_string()),
..FirmwareEntry::default()
};
assert_eq!(filenames_count.artifact_count(), 2);

let filename_count = FirmwareEntry {
filename: Some("single-legacy.bin".to_string()),
..FirmwareEntry::default()
};
assert_eq!(filename_count.artifact_count(), 1);

let url_count = FirmwareEntry {
url: Some("https://firmware.example.invalid/fw.bin".to_string()),
..FirmwareEntry::default()
};
assert_eq!(url_count.artifact_count(), 1);

assert_eq!(FirmwareEntry::default().artifact_count(), 0);
}

#[test]
fn firmware_file_artifact_deserializes_when_filename_or_url_is_set() {
let cases = [
(
r#"
filename = "/opt/nico/firmware/fw.bin"
sha256 = "abc123"
"#,
(Some("/opt/nico/firmware/fw.bin"), None),
),
(
r#"
url = "https://firmware.example.invalid/fw.bin"
sha256 = "def456"
"#,
(None, Some("https://firmware.example.invalid/fw.bin")),
),
];

for (input, (expected_filename, expected_url)) in cases {
let artifact = toml::from_str::<FirmwareFileArtifact>(input).unwrap();

assert_eq!(artifact.filename.as_deref(), expected_filename);
assert_eq!(artifact.url.as_deref(), expected_url);
}
}

#[test]
fn firmware_file_artifact_deserialization_requires_filename_or_url() {
let invalid_artifacts = [
r#"
sha256 = "abc123"
"#,
r#"
filename = ""
sha256 = "abc123"
"#,
r#"
url = " "
sha256 = "abc123"
"#,
r#"
filename = " "
url = ""
sha256 = "abc123"
"#,
];

for input in invalid_artifacts {
let error = toml::from_str::<FirmwareFileArtifact>(input).unwrap_err();

assert!(
error
.to_string()
.contains("firmware files[] artifact must set filename or url")
);
}
}

#[test]
fn firmware_deserialization_rejects_files_artifact_without_location() {
let input = r#"
model = "DGXH100"
vendor = "Nvidia"

[components.cx7]
current_version_reported_as = "^CX7_[0-9]+$"

[[components.cx7.known_firmware]]
version = "28.47.2682"

[[components.cx7.known_firmware.files]]
sha256 = "abc123"
"#;

let error = toml::from_str::<Firmware>(input).unwrap_err();

assert!(
error
.to_string()
.contains("firmware files[] artifact must set filename or url")
);
}
}
3 changes: 2 additions & 1 deletion crates/firmware/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ carbide-api-model = { path = "../api-model", default-features = false }
eyre = { workspace = true }
futures-util = { workspace = true }
hex = { workspace = true }
md5 = { workspace = true }
regex = { workspace = true, optional = true }
reqwest = { workspace = true }
serde = { workspace = true }
sha2 = { workspace = true }
temp-dir = { workspace = true, optional = true }
tokio = { workspace = true }
toml = { workspace = true }
tracing = { workspace = true }
url = { workspace = true }

[dev-dependencies]
carbide-test-support = { path = "../test-support" }
Expand Down
81 changes: 81 additions & 0 deletions crates/firmware/src/artifact_cache.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/*
* SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

use std::path::{Path, PathBuf};

use sha2::{Digest, Sha256};
use url::Url;

pub fn firmware_cache_filename(firmware_cache_directory: &Path, url: &str) -> Option<PathBuf> {
let url_hash = hex::encode(Sha256::digest(url.as_bytes()));
let filename = filename_from_url(url)?;

Some(firmware_cache_directory.join(url_hash).join(filename))
}

fn filename_from_url(raw_url: &str) -> Option<String> {
let url = Url::parse(raw_url).ok()?;
let filename = url.path_segments()?.next_back()?.trim();

if filename.is_empty() || filename == "." || filename == ".." {
None
} else {
Some(filename.to_owned())
}
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn firmware_cache_filename_is_under_cache_directory() {
let firmware_cache_directory = Path::new("/mnt/persistence/fw/download-cache");
let filename = firmware_cache_filename(
firmware_cache_directory,
"https://firmware.example.invalid/path/iDRAC-with-Lifecycle-Controller_Firmware_WN31M_LN64_7.20.60.50_A00.BIN?token=secret",
)
.unwrap();

assert!(filename.starts_with(firmware_cache_directory));
assert_eq!(
filename
.parent()
.unwrap()
.file_name()
.unwrap()
.to_string_lossy()
.len(),
64
);
assert_eq!(
filename.file_name().unwrap(),
"iDRAC-with-Lifecycle-Controller_Firmware_WN31M_LN64_7.20.60.50_A00.BIN"
);
}

#[test]
fn firmware_cache_filename_returns_none_without_filename() {
let firmware_cache_directory = Path::new("/mnt/persistence/fw/download-cache");
let filename = firmware_cache_filename(
firmware_cache_directory,
"https://firmware.example.invalid/",
);

assert_eq!(filename, None);
}
}
Loading
Loading