refactor: 'cast' -> 'build'

Author: cilki

.github/images/overview.png

@@ -17,23 +17,24 @@ There are currently four crates to know about:
 
 ## The metallurgy metaphor
 
-Although end-users could probably ignore it, the internals of `goldboot` use vocabulary
-taken from the field of metallurgy.
+Although end-users could probably ignore it, the internals of `goldboot` use
+vocabulary taken from the field of metallurgy.
 
 #### Foundry
 
-An image foundry is a configuration object that knows how to build goldboot images.
+An image foundry is a configuration object that knows how to build goldboot
+images.
 
 #### OS
 
 An image mold takes an image source and refines it according to built-in rules.
 For example, the `ArchLinux` mold knows how to take Arch Linux install media (in
 the form of an ISO) and install it in an automated manner.
 
-#### Casting
+#### Building
 
-Casting (or building) is the process that takes image sources and produces
-a final goldboot image containing all customizations.
+Building is the process that takes image sources and produces a final goldboot
+image containing all customizations.
 
 Under the hood, foundries cast images by spawning a Qemu virtual machine and
 running one or more image molds against it (via SSH or VNC). Once the virtual
@@ -51,18 +52,19 @@ fabricator runs shell commands on the image which can be useful in many cases.
 
 ## Adding new operating systems
 
-If `goldboot` doesn't already support your operating system, it should be possible
-to add it relatively easily.
+If `goldboot` doesn't already support your operating system, it should be
+possible to add it relatively easily.
 
 Start by finding an OS similar to yours in the `goldboot::foundry::os` module.
 
 TODO
 
 ## OS maintenance
 
-OS support often need constant maintenance as new upstream releases are made and old
-ones are retired. Typically this involves adding new versions and marking some
-as deprecated, but occasionally upstream changes may cause breakages for us.
+OS support often need constant maintenance as new upstream releases are made and
+old ones are retired. Typically this involves adding new versions and marking
+some as deprecated, but occasionally upstream changes may cause breakages for
+us.
 
 For example, we have a struct that tracks Alpine releases which needs to be
 updated about twice per year:
@@ -84,4 +86,5 @@ pub enum AlpineRelease {
 ```
 
 ## Testing
+
 TODO

CONTRIBUTING.md

@@ -241,7 +241,7 @@ be tweaked to suit your needs. For example:
 There are many ways to customize the image, but for now just build it:
 
 ```sh
-goldboot cast .
+goldboot build .
 ```
 
 Once the build succeeds, the image will be saved to the system's library

README.md

@@ -76,13 +76,13 @@ built = { version = "0.8.0", features = [
 ] }
 
 [features]
-default = ["cast", "include_ovmf"]
+default = ["build", "include_ovmf"]
 
 # Support for registry server
 registry = []
 
-# Support for casting images
-cast = [
+# Support for building images
+build = [
   "dep:fatfs",
   "dep:fscommon",
   "dep:png",

goldboot/Cargo.toml

@@ -5,7 +5,7 @@ use validator::Validate;
 
 pub fn run(cmd: super::Commands) -> ExitCode {
     match cmd {
-        super::Commands::Cast {
+        super::Commands::Build {
             record,
             debug,
             read_password,
@@ -57,7 +57,7 @@ pub fn run(cmd: super::Commands) -> ExitCode {
             // Run the build finally
             match foundry.run(output) {
                 Err(err) => {
-                    error!(error = ?err, "Failed to cast image");
+                    error!(error = ?err, "Failed to build image");
                     ExitCode::FAILURE
                 }
                 _ => ExitCode::SUCCESS,

goldboot/src/cli/cmd/cast.rs goldboot/src/cli/cmd/build.rsgoldboot/src/cli/cmd/cast.rs renamed to goldboot/src/cli/cmd/build.rs

@@ -1,6 +1,6 @@
-use crate::foundry::{os::Os, FoundryConfigPath};
+use crate::foundry::{FoundryConfigPath, os::Os};
 
-pub mod cast;
+pub mod build;
 pub mod deploy;
 pub mod image;
 pub mod init;
@@ -9,8 +9,8 @@ pub mod registry;
 
 #[derive(clap::Subcommand, Debug)]
 pub enum Commands {
-    /// Cast (build) a new image
-    Cast {
+    /// Build a new image
+    Build {
         /// Save a screenshot to ./screenshots after each boot command for
         /// debugging
         #[clap(long, num_args = 0)]

goldboot/src/cli/cmd/mod.rs

@@ -13,7 +13,7 @@ pub mod exe;
 pub mod shell;
 
 /// A `Fabricator` performs some custom operation on an image at the very end of
-/// the casting process.
+/// the build process.
 #[enum_dispatch(Fabricator)]
 pub trait Fabricate {
     fn run(&self, ssh: &mut SshConnection) -> Result<()>;

goldboot/src/foundry/fabricators/mod.rs

@@ -1,13 +1,13 @@
-use self::qemu::{detect_accel, Accel};
+use self::qemu::{Accel, detect_accel};
 use self::{fabricators::Fabricator, os::Os, sources::ImageSource};
-use crate::foundry::os::CastImage;
+use crate::foundry::os::BuildImage;
 use crate::{cli::progress::ProgressBar, library::ImageLibrary};
 
 use anyhow::Result;
 use byte_unit::Byte;
-use clap::{builder::PossibleValue, ValueEnum};
+use clap::{ValueEnum, builder::PossibleValue};
 use goldboot_image::ImageBuilder;
-use goldboot_image::{qcow::Qcow3, ImageArch, ImageHandle};
+use goldboot_image::{ImageArch, ImageHandle, qcow::Qcow3};
 use rand::Rng;
 use ron::ser::PrettyConfig;
 use serde::{Deserialize, Serialize};
@@ -240,7 +240,7 @@ impl Foundry {
     }
 }
 
-/// Manages the image casting process. Multiple workers can run in parallel
+/// Manages the image build process. Multiple workers can run in parallel
 /// to speed up multiboot configurations.
 pub struct FoundryWorker {
     pub arch: ImageArch,
@@ -277,12 +277,12 @@ pub struct FoundryWorker {
 }
 
 impl FoundryWorker {
-    /// Run the image casting/building process.
+    /// Run the image building process.
     pub fn run(&mut self) -> Result<()> {
         self.start_time = Some(SystemTime::now());
         Qcow3::create(&self.qcow_path, self.qcow_size)?;
 
-        self.element.os.cast(&self)?;
+        self.element.os.build(&self)?;
         info!(
             duration = ?self.start_time.unwrap().elapsed()?,
             "Build completed",

goldboot/src/foundry/mod.rs

@@ -10,15 +10,15 @@ use crate::{
     cli::prompt::{Prompt, PromptNew},
     enter,
     foundry::{
+        Foundry, FoundryWorker,
         options::{hostname::Hostname, unix_account::RootPassword},
         qemu::{OsCategory, QemuBuilder},
         sources::ImageSource,
-        Foundry, FoundryWorker,
     },
     wait, wait_screen_rect,
 };
 
-use super::{CastImage, DefaultSource};
+use super::{BuildImage, DefaultSource};
 
 /// Produces [Alpine Linux](https://www.alpinelinux.org) images.
 #[derive(Clone, Serialize, Deserialize, Validate, Debug, Default)]
@@ -47,8 +47,8 @@ impl Prompt for AlpineLinux {
     }
 }
 
-impl CastImage for AlpineLinux {
-    fn cast(&self, worker: &FoundryWorker) -> Result<()> {
+impl BuildImage for AlpineLinux {
+    fn build(&self, worker: &FoundryWorker) -> Result<()> {
         let mut qemu = QemuBuilder::new(&worker, OsCategory::Linux)
             .source(&worker.element.source)?
             .prepare_ssh()?

goldboot/src/foundry/os/alpine_linux/mod.rs

@@ -1,21 +1,21 @@
-use super::{CastImage, DefaultSource};
+use super::{BuildImage, DefaultSource};
 use crate::cli::prompt::Prompt;
 use crate::cli::prompt::PromptNew;
+use crate::foundry::Foundry;
 use crate::foundry::fabricators::Fabricate;
 use crate::foundry::http::HttpServer;
 use crate::foundry::options::hostname::Hostname;
 use crate::foundry::options::unix_account::RootPassword;
 use crate::foundry::os::arch_linux::archinstall::ArchinstallConfig;
 use crate::foundry::os::arch_linux::archinstall::ArchinstallCredentials;
 use crate::foundry::qemu::{OsCategory, QemuBuilder};
-use crate::foundry::Foundry;
 use crate::wait;
 use crate::{
-    foundry::{sources::ImageSource, FoundryWorker},
+    foundry::{FoundryWorker, sources::ImageSource},
     wait_screen_rect,
 };
-use anyhow::bail;
 use anyhow::Result;
+use anyhow::bail;
 use dialoguer::theme::Theme;
 use goldboot_image::ImageArch;
 use serde::{Deserialize, Serialize};
@@ -55,8 +55,8 @@ impl DefaultSource for ArchLinux {
     }
 }
 
-impl CastImage for ArchLinux {
-    fn cast(&self, worker: &FoundryWorker) -> Result<()> {
+impl BuildImage for ArchLinux {
+    fn build(&self, worker: &FoundryWorker) -> Result<()> {
         let mut qemu = QemuBuilder::new(&worker, OsCategory::Linux)
             .source(&worker.element.source)?
             .prepare_ssh()?