manta-cli 2.0.0-beta.68

//! `manta apply` subcommands — mutating operations that update an
//! existing resource or drive a workflow against the cluster.
//!
//! Leaves and their endpoints:
//!
//! - [`sat_file`] — `manta apply sat-file`: renders a SAT template,
//!   builds an in-memory plan, and POSTs one element at a time to
//!   `/v2/sat-file/{configurations,images,session-templates}`. See
//!   that module's docs for the plan/apply pattern.
//! - [`template`] — `manta apply template`: `POST
//!   /v2/sessiontemplates/{name}/session` to create a BOS session.
//! - [`boot_node`] / [`boot_group`] — `manta apply boot {nodes,group}`:
//!   `POST /v2/boot-config` against an explicit hosts expression
//!   (the `group` leaf resolves group members first).
//! - [`boot_parameters`] — `manta apply boot-parameters`: `PUT
//!   /v2/boot-parameters` to update an existing record.
//! - [`hardware_group`] — `manta apply hardware group`: `POST
//!   /v2/hardware-clusters/{target}` to pin or unpin
//!   pattern-selected components.
//! - [`kernel_parameters`] — `manta apply kernel-parameters`: full
//!   replace, rebooting affected nodes. See
//!   [`super::add::kernel_parameters`] for the additive variant.
//! - [`redfish_endpoint`] — `manta apply redfish-endpoint`: update an
//!   existing record.
//! - `ephemeral-environment` (handled inline below) — `POST
//!   /v2/ephemeral-env` to provision an ephemeral environment for
//!   an image; refuses to run if stdout is not a TTY.
//!
//! Most leaves accept `--dry-run`; whether that flows to the server or
//! short-circuits client-side depends on the endpoint and is
//! documented per-leaf.

pub mod boot_group;
pub mod boot_node;
pub mod boot_parameters;
pub mod hardware_group;
pub mod kernel_parameters;
pub mod redfish_endpoint;
pub mod runtime_configuration_group;
pub mod runtime_configuration_node;
pub mod sat_file;
pub mod template;

use crate::common::app_context::AppContext;
use crate::common::authentication::get_api_token;
use crate::common::clap_ext::ArgMatchesExt;
use crate::http_client::{MantaClient, OpenApiResultExt};
use anyhow::{Context, Error, bail};
use clap::ArgMatches;

/// Dispatch `manta apply` subcommands (hardware, sat-file, boot,
/// boot-parameters, redfish-endpoints, kernel-parameters,
/// ephemeral-environment, template).
///
/// # Errors
///
/// Returns an error when the auth token cannot be obtained, when
/// required clap arguments are missing or malformed (e.g. a non-UUID
/// `--boot-image` or a non-numeric `--ansible-verbosity`), when no
/// subcommand is provided or the name is unknown, when stdin is not a
/// terminal for `ephemeral-environment`, or when the leaf handler
/// returns an error.
pub async fn handle_apply(
  cli_apply: &ArgMatches,
  ctx: &AppContext<'_>,
) -> Result<(), Error> {
  let token = get_api_token(ctx).await?;

  match cli_apply.subcommand() {
    Some(("hardware", m)) => match m.subcommand() {
      Some(("group", m)) => {
        hardware_group::exec(m, ctx, &token).await?;
      }
      Some((other, _)) => bail!("Unknown 'apply hardware' subcommand: {other}"),
      None => bail!("No 'apply hardware' subcommand provided"),
    },

    Some(("sat-file", m)) => {
      let timestamp = chrono::Utc::now().format("%Y%m%d%H%M%S").to_string();

      let cli_value_vec_opt: Option<Vec<String>> =
        m.get_many("values").map(|value_vec| {
          value_vec
            .map(|value: &String| value.replace("__DATE__", &timestamp))
            .collect()
        });

      let cli_values_file_content_opt: Option<String> =
        if let Some(values_file_path) =
          m.get_one::<std::path::PathBuf>("values-file")
        {
          let content = std::fs::read_to_string(values_file_path)
            .with_context(|| {
              format!(
                "Failed to read values file '{}'",
                values_file_path.display()
              )
            })?;
          Some(content.replace("__DATE__", &timestamp))
        } else {
          None
        };

      let sat_template_file = m
        .get_one::<std::path::PathBuf>("sat-template-file")
        .context("SAT template file argument not provided")?;

      let sat_file_content: String = std::fs::read_to_string(sat_template_file)
        .with_context(|| {
          format!(
            "Could not read SAT file template '{}'",
            sat_template_file.display()
          )
        })?;

      let ansible_passthrough_env: Option<String> =
        ctx.settings.get("ansible-passthrough").ok();
      let ansible_passthrough_cli_arg = m.opt_string("ansible-passthrough");
      let ansible_passthrough =
        ansible_passthrough_env.or(ansible_passthrough_cli_arg);
      let ansible_verbosity: Option<u8> = m
        .get_one::<String>("ansible-verbosity")
        .map(|v| {
          v.parse::<u8>().with_context(|| {
            format!(
              "Could not parse ansible-verbosity '{v}' as a number (0-255)"
            )
          })
        })
        .transpose()?;

      let overwrite: bool = m.get_flag("overwrite-configuration");
      let create_bos_session: bool = m.get_flag("create-bos-session");
      let watch_logs: bool = m.get_flag("watch-logs");
      let timestamps: bool = m.get_flag("timestamps");
      let assume_yes: bool = m.get_flag("assume-yes");
      let dry_run: bool = m.get_flag("dry-run");
      let output_opt = m.opt_str("output");

      sat_file::exec::exec(
        ctx,
        &token,
        &sat_file::exec::SatApplyOptions {
          sat_file_content: sat_file_content.as_str(),
          values_file_content_opt: cli_values_file_content_opt.as_deref(),
          values_cli_opt: cli_value_vec_opt.as_deref(),
          ansible_verbosity_opt: ansible_verbosity,
          ansible_passthrough_opt: ansible_passthrough.as_deref(),
          create_bos_session,
          watch_logs,
          timestamps,
          prehook_opt: m.opt_str("pre-hook"),
          posthook_opt: m.opt_str("post-hook"),
          image_only: m.get_flag("image-only"),
          session_template_only: m.get_flag("sessiontemplate-only"),
          overwrite,
          dry_run,
          assume_yes,
          output_opt,
        },
      )
      .await?;
    }

    Some(("template", m)) => {
      let bos_session_name_opt = m.opt_str("name");
      let bos_sessiontemplate_name = m.req_str("template")?;
      let limit = m.req_str("limit")?;
      let bos_session_operation = m.req_str("operation")?;
      let include_disabled: bool = *m
        .get_one("include-disabled")
        .context("'include-disabled' must have a value")?;
      template::exec(
        ctx,
        &token,
        template::ExecParams {
          session_name: bos_session_name_opt,
          template_name: bos_sessiontemplate_name,
          operation: bos_session_operation,
          limit,
          include_disabled,
          dry_run: m.get_flag("dry-run"),
          output: m.opt_str("output"),
        },
      )
      .await?;
    }

    Some(("ephemeral-environment", m)) => {
      let image_id = m.req_str("image-id")?;
      let dry_run = m.get_flag("dry-run");
      let req = crate::openapi_client::types::CreateEphemeralEnvRequest {
        image_id: image_id.to_string(),
      };

      if dry_run {
        return crate::output::action_result::preview_request(
          "POST",
          "/ephemeral-env",
          &req,
          m.opt_str("output"),
        );
      }

      if !std::io::IsTerminal::is_terminal(&std::io::stdout()) {
        bail!("This command needs to run in interactive mode");
      }

      let client = MantaClient::from_app_ctx(ctx, Some(&token))?;
      let response = client
        .openapi
        .create_ephemeral_env(client.site_name(), &req)
        .await
        .into_anyhow()
        .await?;
      println!("{}", response.hostname);
    }

    Some(("boot-parameters", m)) => {
      let hosts = m.req_str("hosts")?;
      let params = m.opt_str("params");
      let kernel = m.opt_str("kernel");
      let initrd = m.opt_str("initrd");
      let output_opt = m.opt_str("output");
      boot_parameters::exec(
        ctx,
        &token,
        boot_parameters::ExecParams {
          xnames: hosts,
          nids: None,
          macs: None,
          boot_params: params,
          kernel,
          initrd,
          output: output_opt,
        },
      )
      .await?;
    }

    Some(("redfish-endpoints", m)) => {
      redfish_endpoint::exec(
        ctx,
        &token,
        redfish_endpoint::ExecParams {
          id: m.req_str("id")?,
          name: m.opt_str("name"),
          hostname: m.opt_str("hostname"),
          domain: m.opt_str("domain"),
          fqdn: m.opt_str("fqdn"),
          enabled: m.get_flag("enabled"),
          user: m.opt_str("user"),
          password: m.opt_str("password"),
          use_ssdp: m.get_flag("use-ssdp"),
          mac_required: m.get_flag("mac-required"),
          mac_addr: m.opt_str("macaddr"),
          ip_address: m.opt_str("ipaddress"),
          rediscover_on_update: m.get_flag("rediscover-on-update"),
          template_id: m.opt_str("template-id"),
          output: m.opt_str("output"),
          dry_run: m.get_flag("dry-run"),
        },
      )
      .await?;
    }

    Some(("kernel-parameters", m)) => {
      let hsm_group_name_arg_opt = m.opt_str("group");
      let nodes_opt = if hsm_group_name_arg_opt.is_none() {
        m.opt_str("nodes")
      } else {
        None
      };
      let dryrun = m.get_flag("dry-run");
      let kernel_parameters_val = m.req_str("VALUE")?;
      let output_opt = m.opt_str("output");
      kernel_parameters::exec(
        ctx,
        &token,
        kernel_parameters::ExecParams {
          kernel_params: kernel_parameters_val,
          hosts_expression: nodes_opt,
          hsm_group: hsm_group_name_arg_opt,
          dry_run: dryrun,
          output: output_opt,
        },
      )
      .await?;
    }

    Some(("boot", m)) => match m.subcommand() {
      Some(("nodes", m)) => {
        let hosts_string = m.req_str("VALUE")?;
        let new_boot_image_id_opt = m.opt_str("boot-image");
        if let Some(new_boot_image_id) = new_boot_image_id_opt
          && uuid::Uuid::parse_str(new_boot_image_id).is_err()
        {
          bail!("Image id is not a UUID");
        }
        boot_node::exec(
          ctx,
          &token,
          boot_node::ExecParams {
            boot_image: new_boot_image_id_opt,
            boot_image_configuration: m.opt_str("boot-image-configuration"),
            kernel_parameters: m.opt_str("kernel-parameters"),
            hosts_expression: hosts_string,
            dry_run: m.get_flag("dry-run"),
            output: m.opt_str("output"),
          },
        )
        .await?;
      }
      Some(("group", m)) => {
        boot_group::exec(
          ctx,
          &token,
          boot_group::ExecParams {
            boot_image: m.opt_str("boot-image"),
            boot_image_configuration: m.opt_str("boot-image-configuration"),
            kernel_parameters: m.opt_str("kernel-parameters"),
            hsm_group_name: m.req_str("GROUP_NAME")?,
            dry_run: m.get_flag("dry-run"),
            output: m.opt_str("output"),
          },
        )
        .await?;
      }
      Some((other, _)) => bail!("Unknown 'apply boot' subcommand: {other}"),
      None => bail!("No 'apply boot' subcommand provided"),
    },

    Some(("runtime-configuration", m)) => match m.subcommand() {
      Some(("nodes", m)) => {
        runtime_configuration_node::exec(
          ctx,
          &token,
          runtime_configuration_node::ExecParams {
            configuration_name: m.req_str("configuration-name")?,
            hosts_expression: m.req_str("VALUE")?,
            disable: m.get_flag("disable"),
            dry_run: m.get_flag("dry-run"),
          },
        )
        .await?;
      }
      Some(("group", m)) => {
        runtime_configuration_group::exec(
          ctx,
          &token,
          runtime_configuration_group::ExecParams {
            configuration_name: m.req_str("configuration-name")?,
            group_name: m.req_str("GROUP_NAME")?,
            disable: m.get_flag("disable"),
            dry_run: m.get_flag("dry-run"),
          },
        )
        .await?;
      }
      Some((other, _)) => {
        bail!("Unknown 'apply runtime-configuration' subcommand: {other}")
      }
      None => bail!("No 'apply runtime-configuration' subcommand provided"),
    },

    Some((other, _)) => bail!("Unknown 'apply' subcommand: {other}"),
    None => bail!("No 'apply' subcommand provided"),
  }
  Ok(())
}

#[cfg(test)]
mod tests {
  /// `--dry-run` parses on `manta apply ephemeral-environment` (long flag).
  #[test]
  fn ephemeral_env_accepts_dry_run() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "ephemeral-environment",
      "--image-id",
      "abc-123",
      "--dry-run",
    ]);
    assert!(
      result.is_ok(),
      "expected --dry-run to parse on `apply ephemeral-environment`: {result:?}"
    );
  }

  /// `-d` short alias also parses.
  #[test]
  fn ephemeral_env_accepts_dry_run_short_alias() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "ephemeral-environment",
      "--image-id",
      "abc-123",
      "-d",
    ]);
    assert!(
      result.is_ok(),
      "expected -d short alias to parse: {result:?}"
    );
  }

  /// `--dry-run -o json` parses — output flag is honored on the dry-run preview.
  #[test]
  fn ephemeral_env_accepts_dry_run_with_output_json() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "ephemeral-environment",
      "--image-id",
      "abc-123",
      "--dry-run",
      "-o",
      "json",
    ]);
    assert!(
      result.is_ok(),
      "expected `--dry-run -o json` to parse on `apply ephemeral-environment`: {result:?}"
    );
  }

  // ------------------------------------------------------------------
  // `apply runtime-configuration nodes` / `group` — happy paths
  // ------------------------------------------------------------------

  /// The `nodes` subcommand parses with the required `-n` flag and a
  /// positional hosts expression.
  #[test]
  fn apply_runtime_configuration_nodes_parses_min_args() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "nodes",
      "-n",
      "some-cfg",
      "x1000c0s0b0n0",
    ]);
    assert!(
      result.is_ok(),
      "expected `apply runtime-configuration nodes -n <cfg> <hosts>` to parse: {result:?}"
    );
  }

  /// `-D` (short `--disable`) and `-d` (short `--dry-run`) compose
  /// with `-n`. Guards against a short-flag collision if the two are
  /// ever swapped by accident.
  #[test]
  fn apply_runtime_configuration_nodes_accepts_disable_and_dry_run() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "nodes",
      "-n",
      "some-cfg",
      "-D",
      "-d",
      "x1000c0s0b0n0",
    ]);
    assert!(
      result.is_ok(),
      "expected `-D -d` to parse on `apply runtime-configuration nodes`: {result:?}"
    );
  }

  /// `--configuration-name` (long form) parses.
  #[test]
  fn apply_runtime_configuration_nodes_accepts_long_configuration_name() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "nodes",
      "--configuration-name",
      "some-cfg",
      "x1000c0s0b0n0",
    ]);
    assert!(
      result.is_ok(),
      "expected `--configuration-name` long form to parse: {result:?}"
    );
  }

  /// The `group` subcommand parses with `-n` and a positional group name.
  #[test]
  fn apply_runtime_configuration_group_parses_min_args() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "group",
      "-n",
      "some-cfg",
      "my-group",
    ]);
    assert!(
      result.is_ok(),
      "expected `apply runtime-configuration group -n <cfg> <group>` to parse: {result:?}"
    );
  }

  /// `-D` and `-d` compose on the `group` subcommand too.
  #[test]
  fn apply_runtime_configuration_group_accepts_disable_and_dry_run() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "group",
      "-n",
      "some-cfg",
      "-D",
      "-d",
      "my-group",
    ]);
    assert!(
      result.is_ok(),
      "expected `-D -d` to parse on `apply runtime-configuration group`: {result:?}"
    );
  }

  // ------------------------------------------------------------------
  // `apply runtime-configuration nodes` / `group` — negative parsing
  // ------------------------------------------------------------------

  /// Missing `-n` / `--configuration-name` must fail. Server-side
  /// validation would also catch an empty string, but clap should
  /// reject the missing flag before the request is built.
  #[test]
  fn apply_runtime_configuration_nodes_missing_configuration_name_fails() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "nodes",
      "x1000c0s0b0n0",
    ]);
    assert!(
      result.is_err(),
      "expected clap to reject `apply runtime-configuration nodes <hosts>` without `-n`"
    );
  }

  #[test]
  fn apply_runtime_configuration_group_missing_configuration_name_fails() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "runtime-configuration",
      "group",
      "my-group",
    ]);
    assert!(
      result.is_err(),
      "expected clap to reject `apply runtime-configuration group <group>` without `-n`"
    );
  }

  // ------------------------------------------------------------------
  // Regression guards for the removed `--runtime-configuration` and
  // `--disable` flags on `apply boot nodes` / `group`. Runtime CFS
  // config is now the dedicated `apply runtime-configuration` verb;
  // silently accepting the old flags would be a UX regression that
  // pretends to work but sends nothing on the wire.
  // ------------------------------------------------------------------

  #[test]
  fn apply_boot_nodes_rejects_removed_runtime_configuration_flag() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "boot",
      "nodes",
      "--runtime-configuration",
      "some-cfg",
      "x1000c0s0b0n0",
    ]);
    assert!(
      result.is_err(),
      "`apply boot nodes --runtime-configuration` must be rejected — the flag moved to `apply runtime-configuration nodes`"
    );
  }

  #[test]
  fn apply_boot_nodes_rejects_removed_disable_flag() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "boot",
      "nodes",
      "--disable",
      "x1000c0s0b0n0",
    ]);
    assert!(
      result.is_err(),
      "`apply boot nodes --disable` must be rejected — the flag moved to `apply runtime-configuration nodes -D`"
    );
  }

  #[test]
  fn apply_boot_group_rejects_removed_runtime_configuration_flag() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "boot",
      "group",
      "--runtime-configuration",
      "some-cfg",
      "my-group",
    ]);
    assert!(
      result.is_err(),
      "`apply boot group --runtime-configuration` must be rejected — the flag moved to `apply runtime-configuration group`"
    );
  }

  #[test]
  fn apply_boot_group_rejects_removed_disable_flag() {
    let result = crate::build::build_cli().try_get_matches_from([
      "manta",
      "apply",
      "boot",
      "group",
      "--disable",
      "my-group",
    ]);
    assert!(
      result.is_err(),
      "`apply boot group --disable` must be rejected — the flag moved to `apply runtime-configuration group -D`"
    );
  }
}