Skip to content

remove code to add artifacts incrementally #38

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

Merged
sunshowers merged 2 commits into from
Aug 22, 2025
Merged

remove code to add artifacts incrementally #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17788e9
[spr] initial version
sunshowers Aug 14, 2025
06a883b
clippy
sunshowers Aug 14, 2025
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
244 changes: 43 additions & 201 deletions bin/src/dispatch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,10 @@
use anyhow::{Context, Result, bail};
use camino::Utf8PathBuf;
use chrono::{DateTime, Utc};
use clap::{CommandFactory, Parser};
use semver::Version;
use tufaceous_artifact::{
ArtifactKind, ArtifactVersion, ArtifactsDocument, KnownArtifactKind,
};
use clap::Parser;
use tufaceous_artifact::{ArtifactsDocument, KnownArtifactKind};
use tufaceous_lib::assemble::{ArtifactManifest, OmicronRepoAssembler};
use tufaceous_lib::{AddArtifact, ArchiveExtractor, Key, OmicronRepo};
use tufaceous_lib::{ArchiveExtractor, Key, OmicronRepo};

#[derive(Debug, Parser)]
pub struct Args {
Expand All @@ -38,117 +35,44 @@ pub struct Args {
impl Args {
/// Executes these arguments.
pub async fn exec(self, log: &slog::Logger) -> Result<()> {
let repo_path = match self.repo {
Some(repo) => repo,
None => std::env::current_dir()?.try_into()?,
};

match self.command {
// TODO-cleanup: we no longer use the init and add commands in
// production. We should get rid of these options and direct users
// towards assemble. (If necessary, we should build tooling for
// making it easy to build up a manifest that can then be
// assembled.)
Command::Init { system_version, no_generate_key } => {
let keys = maybe_generate_keys(self.keys, no_generate_key)?;
let root =
tufaceous_lib::root::new_root(keys.clone(), self.expiry)
.await?;

let repo = OmicronRepo::initialize(
log,
&repo_path,
system_version,
keys,
root,
self.expiry,
true,
)
.await?;
slog::info!(
log,
"Initialized TUF repository in {}",
repo.repo_path()
);
Ok(())
}
Command::Add {
kind,
allow_unknown_kinds,
path,
name,
version,
Command::Assemble {
manifest_path,
output_path,
build_dir,
no_generate_key,
skip_all_present,
allow_non_semver,
no_installinator_document,
} => {
if !allow_unknown_kinds {
// Try converting kind to a known kind.
if kind.to_known().is_none() {
// Simulate a failure to parse (though ideally there would
// be a way to also specify the underlying error -- there
// doesn't appear to be a public API to do so in clap 4).
let mut error = clap::Error::new(
clap::error::ErrorKind::ValueValidation,
)
.with_cmd(&Args::command());
error.insert(
clap::error::ContextKind::InvalidArg,
clap::error::ContextValue::String(
"<KIND>".to_owned(),
),
);
error.insert(
clap::error::ContextKind::InvalidValue,
clap::error::ContextValue::String(kind.to_string()),
);
error.exit();
}
// The filename must end with "zip".
if output_path.extension() != Some("zip") {
bail!("output path `{output_path}` must end with .zip");
}

let manifest = ArtifactManifest::from_path(&manifest_path)
.context("error reading manifest")?;
if !allow_non_semver {
if let Err(error) = version.as_str().parse::<Version>() {
let error = Args::command().error(
clap::error::ErrorKind::ValueValidation,
format!(
"version `{version}` is not valid semver \
(pass in --allow-non-semver to override): {error}"
),
);
error.exit();
}
manifest.verify_all_semver()?;
}
if !skip_all_present {
manifest.verify_all_present()?;
}

let repo = OmicronRepo::load_untrusted_ignore_expiration(
log, &repo_path,
)
.await?;
let mut editor = repo.into_editor().await?;

let new_artifact =
AddArtifact::from_path(kind, name, version, path)?;

editor
.add_artifact(&new_artifact)
.context("error adding artifact")?;
editor.sign_and_finish(self.keys, self.expiry, true).await?;
println!(
"added {} {}, version {}",
new_artifact.kind(),
new_artifact.name(),
new_artifact.version()
let keys = maybe_generate_keys(self.keys, no_generate_key)?;
let mut assembler = OmicronRepoAssembler::new(
log,
manifest,
keys,
self.expiry,
!no_installinator_document,
output_path,
);
Ok(())
}
Command::Archive { output_path } => {
// The filename must end with "zip".
if output_path.extension() != Some("zip") {
bail!("output path `{output_path}` must end with .zip");
if let Some(dir) = build_dir {
assembler.set_build_dir(dir);
}

let repo = OmicronRepo::load_untrusted_ignore_expiration(
log, &repo_path,
)
.await?;
repo.archive(&output_path)?;
assembler.build().await?;

Ok(())
}
Expand All @@ -166,7 +90,7 @@ impl Args {
.with_context(|| {
format!(
"error loading extracted repository at `{dest}` \
(extracted files are still available)"
(extracted files are still available)"
)
})?;
let artifacts =
Expand Down Expand Up @@ -207,46 +131,6 @@ impl Args {
})?;
}

Ok(())
}
Command::Assemble {
manifest_path,
output_path,
build_dir,
no_generate_key,
skip_all_present,
allow_non_semver,
no_installinator_document,
} => {
// The filename must end with "zip".
if output_path.extension() != Some("zip") {
bail!("output path `{output_path}` must end with .zip");
}

let manifest = ArtifactManifest::from_path(&manifest_path)
.context("error reading manifest")?;
if !allow_non_semver {
manifest.verify_all_semver()?;
}
if !skip_all_present {
manifest.verify_all_present()?;
}

let keys = maybe_generate_keys(self.keys, no_generate_key)?;
let mut assembler = OmicronRepoAssembler::new(
log,
manifest,
keys,
self.expiry,
!no_installinator_document,
output_path,
);
if let Some(dir) = build_dir {
assembler.set_build_dir(dir);
}

assembler.build().await?;

Ok(())
}
}
Expand All @@ -255,60 +139,6 @@ impl Args {

#[derive(Debug, Parser)]
enum Command {
/// Create a new rack update TUF repository
Init {
/// The system version.
system_version: Version,

/// Disable random key generation and exit if no keys are provided
#[clap(long)]
no_generate_key: bool,
},
Add {
/// The kind of artifact this is.
kind: ArtifactKind,

/// Allow artifact kinds that aren't known to tufaceous
#[clap(long)]
allow_unknown_kinds: bool,

/// Path to the artifact.
path: Utf8PathBuf,

/// Override the name for this artifact (default: filename with extension stripped)
#[clap(long)]
name: Option<String>,

/// Artifact version.
///
/// This is required to be semver by default, but can be overridden with
/// --allow-non-semver.
version: ArtifactVersion,

/// Allow versions to be non-semver.
///
/// Transitional option for v13 -> v14. After v14, versions will be
/// allowed to be non-semver by default.
#[clap(long)]
allow_non_semver: bool,
},
/// Archives this repository to a zip file.
Archive {
/// The path to write the archive to (must end with .zip).
output_path: Utf8PathBuf,
},
/// Validates and extracts a repository created by the `archive` command.
Extract {
/// The file to extract.
archive_file: Utf8PathBuf,

/// The destination to extract the file to.
dest: Utf8PathBuf,

/// Indicate that the file does not contain an installinator document.
#[clap(long)]
no_installinator_document: bool,
},
/// Assembles a repository from a provided manifest.
Assemble {
/// Path to artifact manifest.
Expand Down Expand Up @@ -342,6 +172,18 @@ enum Command {
#[clap(long)]
no_installinator_document: bool,
},
/// Validates and extracts a repository created by the `assemble` command.
Extract {
/// The file to extract.
archive_file: Utf8PathBuf,

/// The destination to extract the file to.
dest: Utf8PathBuf,

/// Indicate that the file does not contain an installinator document.
#[clap(long)]
no_installinator_document: bool,
},
}

fn maybe_generate_keys(
Expand Down
Loading
Loading