wip: Add release selection to demo command

Techassi · Techassi · commit 26e387a55059 · 2024-12-05T10:53:40.000+01:00
Also removes the unused --offline flag. Feel free to ignore that.
diff --git a/docs/modules/stackablectl/partials/commands/cache.adoc b/docs/modules/stackablectl/partials/commands/cache.adoc
@@ -20,9 +20,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/completions.adoc b/docs/modules/stackablectl/partials/commands/completions.adoc
@@ -23,9 +23,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/demo.adoc b/docs/modules/stackablectl/partials/commands/demo.adoc
@@ -21,8 +21,8 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
+      --release <RELEASE>
+          Target a specific Stackable release
 
   -h, --help
           Print help (see a summary with '-h')
diff --git a/docs/modules/stackablectl/partials/commands/experimental-debug.adoc b/docs/modules/stackablectl/partials/commands/experimental-debug.adoc
@@ -37,9 +37,6 @@ Options:
 
           Defaults to the image of the target container if not specified.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/index.adoc b/docs/modules/stackablectl/partials/commands/index.adoc
@@ -26,9 +26,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/operator.adoc b/docs/modules/stackablectl/partials/commands/operator.adoc
@@ -23,9 +23,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/release.adoc b/docs/modules/stackablectl/partials/commands/release.adoc
@@ -22,9 +22,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/stack.adoc b/docs/modules/stackablectl/partials/commands/stack.adoc
@@ -21,9 +21,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/docs/modules/stackablectl/partials/commands/stacklet.adoc b/docs/modules/stackablectl/partials/commands/stacklet.adoc
@@ -25,9 +25,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/extra/completions/_stackablectl b/extra/completions/_stackablectl
diff --git a/extra/completions/stackablectl.bash b/extra/completions/stackablectl.bash
diff --git a/extra/completions/stackablectl.elv b/extra/completions/stackablectl.elv
diff --git a/extra/completions/stackablectl.fish b/extra/completions/stackablectl.fish
diff --git a/extra/completions/stackablectl.nu b/extra/completions/stackablectl.nu
diff --git a/extra/man/stackablectl.1 b/extra/man/stackablectl.1
diff --git a/rust/stackablectl/README.md b/rust/stackablectl/README.md
@@ -35,9 +35,6 @@ Options:
           Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
           '$HOME/.cache/stackablectl' when not explicitly set.
 
-      --offline
-          Do not request any remote files via the network
-
   -h, --help
           Print help (see a summary with '-h')
 
diff --git a/rust/stackablectl/src/cli/mod.rs b/rust/stackablectl/src/cli/mod.rs
@@ -8,18 +8,17 @@ use tracing::{debug, instrument, Level};
 use stackable_cockpit::{
     constants::{HELM_REPO_NAME_DEV, HELM_REPO_NAME_STABLE, HELM_REPO_NAME_TEST},
     helm,
-    platform::demo::List,
     utils::path::{
         IntoPathOrUrl, IntoPathsOrUrls, ParsePathsOrUrls, PathOrUrl, PathOrUrlParseError,
     },
-    xfer::{cache::Settings, Client},
+    xfer::cache::Settings,
 };
 
 use crate::{
     args::{CommonFileArgs, CommonRepoArgs},
     cmds::{cache, completions, debug, demo, operator, release, stack, stacklet},
     constants::{
-        ENV_KEY_DEMO_FILES, ENV_KEY_RELEASE_FILES, ENV_KEY_STACK_FILES, REMOTE_DEMO_FILE,
+        DEMOS_REPOSITORY_URL_BASE, ENV_KEY_DEMO_FILES, ENV_KEY_RELEASE_FILES, ENV_KEY_STACK_FILES,
         REMOTE_RELEASE_FILE, REMOTE_STACK_FILE, USER_DIR_APPLICATION_NAME,
         USER_DIR_ORGANIZATION_NAME, USER_DIR_QUALIFIER,
     },
@@ -74,10 +73,6 @@ Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
     )]
     pub no_cache: bool,
 
-    /// Do not request any remote files via the network
-    #[arg(long, global = true)]
-    pub offline: bool,
-
     #[command(flatten)]
     pub files: CommonFileArgs,
 
@@ -92,20 +87,20 @@ impl Cli {
     /// Returns a list of demo files, consisting of entries which are either a path or URL. The list of files combines
     /// the default demo file URL, [`REMOTE_DEMO_FILE`], files provided by the ENV variable [`ENV_KEY_DEMO_FILES`], and
     /// lastly, files provided by the CLI argument `--demo-file`.
-    pub fn get_demo_files(&self) -> Result<Vec<PathOrUrl>, PathOrUrlParseError> {
-        let mut files = get_files(REMOTE_DEMO_FILE, ENV_KEY_DEMO_FILES)?;
+    pub fn get_demo_files(&self, branch: &str) -> Result<Vec<PathOrUrl>, PathOrUrlParseError> {
+        let branch_url = format!(
+            "{base}/{branch}/demos/demos-v2.yaml",
+            base = DEMOS_REPOSITORY_URL_BASE
+        );
+
+        let mut files = get_files(&branch_url, ENV_KEY_DEMO_FILES)?;
 
         let arg_files = self.files.demo_files.clone().into_paths_or_urls()?;
         files.extend(arg_files);
 
         Ok(files)
     }
 
-    pub async fn get_demo_list(&self, transfer_client: &Client) -> List {
-        let files = self.get_demo_files().unwrap();
-        List::build(&files, transfer_client).await.unwrap()
-    }
-
     /// Returns a list of stack files, consisting of entries which are either a path or URL. The list of files combines
     /// the default stack file URL, [`REMOTE_STACK_FILE`], files provided by the ENV variable [`ENV_KEY_STACK_FILES`],
     /// and lastly, files provided by the CLI argument `--stack-file`.
diff --git a/rust/stackablectl/src/cmds/demo.rs b/rust/stackablectl/src/cmds/demo.rs
@@ -3,7 +3,7 @@ use comfy_table::{
     presets::{NOTHING, UTF8_FULL},
     ContentArrangement, Row, Table,
 };
-use snafu::{ResultExt, Snafu};
+use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::kvp::{LabelError, Labels};
 use tracing::{debug, info, instrument};
 
@@ -30,6 +30,10 @@ use crate::{
 pub struct DemoArgs {
     #[command(subcommand)]
     subcommand: DemoCommands,
+
+    /// Target a specific Stackable release
+    #[arg(long, global = true)]
+    release: Option<String>,
 }
 
 #[derive(Debug, Subcommand)]
@@ -126,6 +130,12 @@ pub enum CmdError {
     #[snafu(display("no stack with name '{name}'"))]
     NoSuchStack { name: String },
 
+    #[snafu(display("no release with name '{name}'"))]
+    NoSuchRelease { name: String },
+
+    #[snafu(display("empty release list"))]
+    EmptyReleaseList,
+
     #[snafu(display("failed to build demo/stack/release list"))]
     BuildList { source: list::Error },
 
@@ -155,11 +165,31 @@ impl DemoArgs {
 
         let transfer_client = xfer::Client::new_with(cache);
 
+        let release_files = cli.get_release_files().context(PathOrUrlParseSnafu)?;
+        let release_list = release::ReleaseList::build(&release_files, &transfer_client)
+            .await
+            .context(BuildListSnafu)?;
+
+        let release_branch = match &self.release {
+            Some(release) => format!("release-{release}"),
+            None => {
+                let release = release_list
+                    .inner()
+                    .first()
+                    .context(EmptyReleaseListSnafu)?
+                    .0;
+
+                format!("release-{release}")
+            }
+        };
+
         // Build demo list based on the (default) remote demo file, and additional files provided by the
         // STACKABLE_DEMO_FILES env variable or the --demo-files CLI argument.
-        let files = cli.get_demo_files().context(PathOrUrlParseSnafu)?;
+        let demo_files = cli
+            .get_demo_files(&release_branch)
+            .context(PathOrUrlParseSnafu)?;
 
-        let list = demo::List::build(&files, &transfer_client)
+        let list = demo::List::build(&demo_files, &transfer_client)
             .await
             .context(BuildListSnafu)?;
 
diff --git a/rust/stackablectl/src/constants.rs b/rust/stackablectl/src/constants.rs
@@ -2,6 +2,8 @@ pub const ENV_KEY_RELEASE_FILES: &str = "STACKABLE_RELEASE_FILES";
 pub const ENV_KEY_STACK_FILES: &str = "STACKABLE_STACK_FILES";
 pub const ENV_KEY_DEMO_FILES: &str = "STACKABLE_DEMO_FILES";
 
+pub const DEMOS_REPOSITORY_URL_BASE: &str = "https://raw.githubusercontent.com/stackabletech/demos";
+
 pub const REMOTE_DEMO_FILE: &str =
     "https://raw.githubusercontent.com/stackabletech/demos/main/demos/demos-v2.yaml";
 
diff --git a/rust/stackablectl/src/main.rs b/rust/stackablectl/src/main.rs
@@ -11,11 +11,6 @@ async fn main() -> Result<(), Error> {
     // Parse the CLI args and commands
     let app = Cli::parse();
 
-    // Catch if --offline is used for now
-    if app.offline {
-        todo!()
-    }
-
     // Construct the tracing subscriber
     let format = fmt::format()
         .with_ansi(true)
