refactor(boil)!: Refactor internal code structure (#1451)

* refactor(boil)!: Refactor internal code structure

This also restructures the CLI interface slightly:

- `boil show images` is now `boil image list`
- `boil images` is an alias for `boil image list`

This is done in preparation for an upcoming `boil image check` command.

* chore: Add dev comment about commented out unit tests

* chore: Add dev comment linking to upstream PR

* chore: Add doc comment to ImageSelector struct

Author: Techassi

rust/boil/README.md

@@ -26,11 +26,8 @@ boil build airflow opa
 
 # Display a list of all images and their declared versions as structured JSON
 # output
-boil show images
+boil image list
 
 # Display a list of versions of the image located in the 'airflow' folder
-boil show images airflow
-
-# Soon (hopefully) implemented
-boil show graph
+boil image list airflow
 ```

rust/boil/src/build/cli.rs rust/boil/src/cli/build.rsrust/boil/src/build/cli.rs renamed to rust/boil/src/cli/build.rs

@@ -10,17 +10,17 @@ use snafu::{ResultExt, Snafu, ensure};
 use strum::EnumDiscriminants;
 use url::Host;
 
-use crate::build::{
+use crate::core::{
     docker::BuildArgument,
-    image::Image,
+    image::ImageSelector,
     platform::{Architecture, TargetPlatform},
 };
 
 #[derive(Debug, Args)]
 pub struct BuildArguments {
     /// The image(s) which should be build. The format is name[=version,...].
     #[arg(help_heading = "Image Options", required = true)]
-    pub images: Vec<Image>,
+    pub images: Vec<ImageSelector>,
 
     // NOTE (@Techassi): Should this maybe be renamed to vendor_version?
     /// The image version being built.

rust/boil/src/cli/completions.rs

@@ -0,0 +1,26 @@
+use clap::{Args, ValueEnum};
+
+#[derive(Debug, Args)]
+pub struct CompletionsArguments {
+    /// Shell to generate completions for.
+    #[arg(value_enum)]
+    pub shell: Shell,
+}
+
+#[derive(Clone, Debug, ValueEnum)]
+pub enum Shell {
+    /// Bourne Again SHell
+    Bash,
+
+    /// Elvish shell
+    Elvish,
+
+    /// Friendly Interactive SHell
+    Fish,
+
+    /// Z SHell
+    Zsh,
+
+    /// Nushell
+    Nushell,
+}

rust/boil/src/show/images/cli.rs rust/boil/src/cli/image.rsrust/boil/src/show/images/cli.rs renamed to rust/boil/src/cli/image.rs

@@ -1,11 +1,22 @@
-use clap::{Args, ValueEnum};
+use clap::{Args, Subcommand, ValueEnum};
 
-use crate::build::image::Image;
+use crate::core::image::ImageSelector;
 
 #[derive(Debug, Args)]
-pub struct ShowImagesArguments {
+pub struct ImageArguments {
+    #[command(subcommand)]
+    pub command: ImageCommand,
+}
+
+#[derive(Debug, Subcommand)]
+pub enum ImageCommand {
+    List(ImageListArguments),
+}
+
+#[derive(Debug, Args)]
+pub struct ImageListArguments {
     /// Optionally specify one or more images to display.
-    pub image: Vec<Image>,
+    pub image: Vec<ImageSelector>,
 
     /// Pretty print the structured output.
     #[arg(long, value_enum, default_value_t = Pretty::default())]

rust/boil/src/cli.rs rust/boil/src/cli/mod.rsrust/boil/src/cli.rs renamed to rust/boil/src/cli/mod.rs

@@ -2,7 +2,13 @@ use std::path::PathBuf;
 
 use clap::{Parser, Subcommand};
 
-use crate::{build::cli::BuildArguments, completions::CompletionsArguments, show::ShowArguments};
+mod build;
+mod completions;
+mod image;
+
+pub use build::*;
+pub use completions::*;
+pub use image::*;
 
 #[derive(Debug, Parser)]
 #[command(author, version, about)]
@@ -30,7 +36,10 @@ pub enum Command {
     Build(Box<BuildArguments>),
 
     /// Display various structured outputs in JSON format.
-    Show(ShowArguments),
+    Image(ImageArguments),
+
+    /// Alias for `image list`.
+    Images(ImageListArguments),
 
     /// Generate shell completions.
     Completions(CompletionsArguments),

rust/boil/src/build/mod.rs rust/boil/src/cmd/build.rsrust/boil/src/build/mod.rs renamed to rust/boil/src/cmd/build.rs

@@ -6,17 +6,12 @@ use std::{
 use snafu::{OptionExt, ResultExt, Snafu, ensure};
 
 use crate::{
-    build::{bakefile::Bakefile, cli::BuildArguments},
+    cli::BuildArguments,
     config::Config,
+    core::bakefile::{self, Bakefile},
     utils::CommandExt,
 };
 
-pub mod bakefile;
-pub mod cli;
-pub mod docker;
-pub mod image;
-pub mod platform;
-
 #[derive(Debug, Snafu)]
 pub enum Error {
     #[snafu(display("failed to create bakefile"))]

rust/boil/src/completions/mod.rs rust/boil/src/cmd/completions.rsrust/boil/src/completions/mod.rs renamed to rust/boil/src/cmd/completions.rs

@@ -1,36 +1,11 @@
-use clap::{Args, Command, CommandFactory, ValueEnum};
+use clap::{Command, CommandFactory};
 use clap_complete::{
     Generator,
     Shell::{Bash, Elvish, Fish, Zsh},
 };
 use clap_complete_nushell::Nushell;
 
-use crate::cli::Cli;
-
-#[derive(Debug, Args)]
-pub struct CompletionsArguments {
-    /// Shell to generate completions for.
-    #[arg(value_enum)]
-    pub shell: Shell,
-}
-
-#[derive(Clone, Debug, ValueEnum)]
-pub enum Shell {
-    /// Bourne Again SHell
-    Bash,
-
-    /// Elvish shell
-    Elvish,
-
-    /// Friendly Interactive SHell
-    Fish,
-
-    /// Z SHell
-    Zsh,
-
-    /// Nushell
-    Nushell,
-}
+use crate::cli::{Cli, CompletionsArguments, Shell};
 
 /// This is the `boil completions` command handler function.
 pub fn run_command(arguments: CompletionsArguments) {

rust/boil/src/show/images/mod.rs rust/boil/src/cmd/image.rsrust/boil/src/show/images/mod.rs renamed to rust/boil/src/cmd/image.rs

@@ -3,23 +3,21 @@ use std::{collections::BTreeMap, io::IsTerminal};
 use snafu::{ResultExt, Snafu};
 
 use crate::{
-    build::bakefile::{Targets, TargetsError, TargetsOptions},
-    show::images::cli::{Pretty, ShowImagesArguments},
+    cli::{ImageListArguments, Pretty},
+    core::bakefile::{self, Targets, TargetsOptions},
 };
 
-pub mod cli;
-
 #[derive(Debug, Snafu)]
 pub enum Error {
     #[snafu(display("failed to serialize list as JSON"))]
     SerializeList { source: serde_json::Error },
 
     #[snafu(display("failed to build list of targets"))]
-    BuildTargets { source: TargetsError },
+    BuildTargets { source: bakefile::TargetsError },
 }
 
 /// This is the `boil show images` command handler function.
-pub fn run_command(arguments: ShowImagesArguments) -> Result<(), Error> {
+pub fn list_images(arguments: ImageListArguments) -> Result<(), Error> {
     let list: BTreeMap<_, _> = if arguments.image.is_empty() {
         Targets::all(TargetsOptions { only_entry: true })
             .context(BuildTargetsSnafu)?

rust/boil/src/cmd/mod.rs

@@ -0,0 +1,3 @@
+pub mod build;
+pub mod completions;
+pub mod image;

rust/boil/src/config.rs

@@ -4,7 +4,7 @@ use serde::Deserialize;
 use snafu::{ResultExt, Snafu};
 use url::Url;
 
-use crate::build::docker::BuildArguments;
+use crate::core::docker;
 
 #[derive(Debug, Snafu)]
 pub enum ConfigError {
@@ -16,7 +16,7 @@ pub enum ConfigError {
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub struct Config {
-    pub build_arguments: BuildArguments,
+    pub build_arguments: docker::BuildArguments,
     pub metadata: Metadata,
 }