particle-os/particle-os-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: Generate correct image names based on user supplied arguments

Browse source
This commit is contained in:
Gerald Pinder 2024-09-07 01:47:37 -04:00
parent e6cce3d542
commit 2f3edeb1a5
7 changed files with 66 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

9
process/drivers.rs
View file

@ -5,6 +5,7 @@
//! labels for an image.
use std::{
borrow::Borrow,
collections::{hash_map::Entry, HashMap},
fmt::Debug,
process::{ExitStatus, Output},
@ -17,7 +18,7 @@ use log::{debug, info, trace};
use miette::{miette, Result};
use oci_distribution::Reference;
use once_cell::sync::Lazy;
use opts::GenerateTagsOpts;
use opts::{GenerateImageNameOpts, GenerateTagsOpts};
#[cfg(feature = "sigstore")]
use sigstore_driver::SigstoreDriver;
use typed_builder::TypedBuilder;
@ -402,10 +403,10 @@ impl CiDriver for Driver {
impl_ci_driver!(get_registry())
}
fn generate_image_name<S>(name: S) -> Result<Reference>
fn generate_image_name<'a, O>(opts: O) -> Result<Reference>
where
S: AsRef<str>,
O: Borrow<GenerateImageNameOpts<'a>>,
{
impl_ci_driver!(generate_image_name(name))
impl_ci_driver!(generate_image_name(opts))
}
}

18
process/drivers/local_driver.rs
View file

@ -1,7 +1,6 @@
use blue_build_utils::string_vec;
use log::trace;
use miette::{bail, Context, IntoDiagnostic};
use oci_distribution::Reference;
use miette::bail;
use super::{opts::GenerateTagsOpts, CiDriver, Driver};
@ -37,19 +36,6 @@ impl CiDriver for LocalDriver {
))
}
fn generate_image_name<S>(name: S) -> miette::Result<Reference>
where
S: AsRef<str>,
{
fn inner(name: &str) -> miette::Result<Reference> {
trace!("LocalDriver::generate_image_name({name})");
name.parse()
.into_diagnostic()
.with_context(|| format!("Unable to parse {name}"))
}
inner(&name.as_ref().trim().to_lowercase())
}
fn get_repo_url() -> miette::Result<String> {
trace!("LocalDriver::get_repo_url()");
Ok(String::new())
@ -57,6 +43,6 @@ impl CiDriver for LocalDriver {
fn get_registry() -> miette::Result<String> {
trace!("LocalDriver::get_registry()");
Ok(String::new())
Ok(String::from("localhost"))
}
}

12
process/drivers/opts/ci.rs
View file

@ -10,3 +10,15 @@ pub struct GenerateTagsOpts<'scope> {
#[builder(default, setter(into))]
pub alt_tags: Option<Vec<Cow<'scope, str>>>,
}
#[derive(Debug, Clone, TypedBuilder)]
pub struct GenerateImageNameOpts<'scope> {
#[builder(default, setter(into))]
pub name: Cow<'scope, str>,
#[builder(default, setter(into))]
pub registry: Option<Cow<'scope, str>>,
#[builder(default, setter(into))]
pub registry_namespace: Option<Cow<'scope, str>>,
}

32
process/drivers/traits.rs
View file

@ -1,4 +1,5 @@
use std::{
borrow::Borrow,
path::PathBuf,
process::{ExitStatus, Output},
};
@ -14,9 +15,9 @@ use crate::drivers::{functions::get_private_key, types::CiDriverType, Driver};
use super::{
image_metadata::ImageMetadata,
opts::{
BuildOpts, BuildTagPushOpts, CheckKeyPairOpts, GenerateKeyPairOpts, GenerateTagsOpts,
GetMetadataOpts, PushOpts, RunOpts, SignOpts, SignVerifyOpts, TagOpts, VerifyOpts,
VerifyType,
BuildOpts, BuildTagPushOpts, CheckKeyPairOpts, GenerateImageNameOpts, GenerateKeyPairOpts,
GenerateTagsOpts, GetMetadataOpts, PushOpts, RunOpts, SignOpts, SignVerifyOpts, TagOpts,
VerifyOpts, VerifyType,
},
};
@ -308,27 +309,34 @@ pub trait CiDriver {
///
/// # Errors
/// Will error if the environment variables aren't set.
fn generate_tags(oci_ref: &GenerateTagsOpts) -> Result<Vec<String>>;
fn generate_tags(opts: &GenerateTagsOpts) -> Result<Vec<String>>;
/// Generates the image name based on CI.
///
/// # Errors
/// Will error if the environment variables aren't set.
fn generate_image_name<S>(name: S) -> Result<Reference>
fn generate_image_name<'a, O>(opts: O) -> Result<Reference>
where
S: AsRef<str>,
O: Borrow<GenerateImageNameOpts<'a>>,
{
fn inner(name: &str, registry: &str) -> Result<Reference> {
let image = format!("{registry}/{name}");
fn inner(opts: &GenerateImageNameOpts, driver_registry: &str) -> Result<Reference> {
let image = match (&opts.registry, &opts.registry_namespace) {
(Some(registry), Some(registry_namespace)) => {
format!("{registry}/{registry_namespace}/{}", &opts.name)
}
(Some(registry), None) => {
format!("{registry}/{}", &opts.name)
}
_ => {
format!("{}/{}", driver_registry, &opts.name)
}
};
image
.parse()
.into_diagnostic()
.with_context(|| format!("Unable to parse image {image}"))
}
inner(
&name.as_ref().trim().to_lowercase(),
&Self::get_registry()?.to_lowercase(),
)
inner(opts.borrow(), &Self::get_registry()?)
}
/// Get the URL for the repository.

5
recipe/src/recipe.rs
View file

@ -126,10 +126,11 @@ impl<'a> Recipe<'a> {
/// # Errors
/// Will error if it fails to parse the `base_image`.
pub fn base_image_ref(&self) -> Result<Reference> {
self.base_image
let base_image = format!("{}:{}", self.base_image, self.image_version);
base_image
.parse()
.into_diagnostic()
.with_context(|| format!("Unable to parse base image {}", self.base_image))
.with_context(|| format!("Unable to parse base image {base_image}"))
}
#[must_use]

56
src/commands/build.rs
View file

@ -4,7 +4,10 @@ use std::{
};
use blue_build_process_management::drivers::{
opts::{BuildTagPushOpts, CheckKeyPairOpts, CompressionType, GenerateTagsOpts, SignVerifyOpts},
opts::{
BuildTagPushOpts, CheckKeyPairOpts, CompressionType, GenerateImageNameOpts,
GenerateTagsOpts, SignVerifyOpts,
},
BuildDriver, CiDriver, Driver, DriverArgs, SigningDriver,
};
use blue_build_recipe::Recipe;
@ -13,14 +16,14 @@ use blue_build_utils::{
ARCHIVE_SUFFIX, BB_REGISTRY_NAMESPACE, BUILD_ID_LABEL, CONFIG_PATH, CONTAINER_FILE,
GITIGNORE_PATH, LABELED_ERROR_MESSAGE, NO_LABEL_ERROR_MESSAGE, RECIPE_FILE, RECIPE_PATH,
},
cowstr,
credentials::{Credentials, CredentialsArgs},
string,
};
use clap::Args;
use colored::Colorize;
use log::{debug, info, trace, warn};
use log::{info, trace, warn};
use miette::{bail, Context, IntoDiagnostic, Result};
use oci_distribution::Reference;
use typed_builder::TypedBuilder;
use crate::commands::generate::GenerateCommand;
@ -280,52 +283,25 @@ impl BuildCommand {
}
fn image_name(&self, recipe: &Recipe) -> Result<String> {
let image_name = self.generate_full_image_name(recipe)?;
let image_name = Driver::generate_image_name(
GenerateImageNameOpts::builder()
.name(recipe.name.trim())
.registry(self.credentials.registry.as_ref().map(|r| cowstr!(r)))
.registry_namespace(self.registry_namespace.as_ref().map(|r| cowstr!(r)))
.build(),
)?;
let image_name = if image_name.registry().is_empty() {
string!(image_name.repository())
} else if image_name.registry() == "" {
image_name.repository().to_string()
} else {
format!(
"{}/{}",
image_name.resolve_registry(),
image_name.repository()
)
format!("{}/{}", image_name.registry(), image_name.repository())
};
Ok(image_name)
}
/// # Errors
///
/// Will return `Err` if the image name cannot be generated.
fn generate_full_image_name(&self, recipe: &Recipe) -> Result<Reference> {
trace!("BuildCommand::generate_full_image_name({recipe:#?})");
info!("Generating full image name");
let image_name = if let (Some(registry), Some(registry_path)) = (
self.credentials.registry.as_ref().map(|r| r.to_lowercase()),
self.registry_namespace.as_ref().map(|s| s.to_lowercase()),
) {
trace!("registry={registry}, registry_path={registry_path}");
let image = format!(
"{}/{}/{}",
registry.trim().trim_matches('/'),
registry_path.trim().trim_matches('/'),
recipe.name.trim(),
);
image
.parse()
.into_diagnostic()
.with_context(|| format!("Unable to parse {image}"))?
} else {
Driver::generate_image_name(&recipe.name)?
};
debug!("Using image name '{image_name}'");
Ok(image_name)
}
fn update_gitignore(&self) -> Result<()> {
// Check if the Containerfile exists
// - If doesn't => *Build*

9
src/commands/generate.rs
View file

@ -91,6 +91,13 @@ impl GenerateCommand {
legacy_path.join(RECIPE_FILE)
}
});
let registry = if let (Some(registry), Some(registry_namespace)) =
(&self.registry, &self.registry_namespace)
{
format!("{registry}/{registry_namespace}")
} else {
Driver::get_registry()?
};
debug!("Deserializing recipe");
let recipe = Recipe::parse(&recipe_path)?;
@ -113,7 +120,7 @@ impl GenerateCommand {
.build_id(Driver::get_build_id())
.recipe(&recipe)
.recipe_path(recipe_path.as_path())
.registry(Driver::get_registry()?)
.registry(registry)
.repo(Driver::get_repo_url()?)
.exports_tag({
#[allow(clippy::const_is_empty)]