Function format_upgrade_message

atomic-cli/src/commands/update.rs:356–446

Produce the multi-line outdated message for a given source. Pure so the unit tests can match on substrings.

(
    source: &InstallSource,
    current: &str,
    latest: &str,
    drift_manifest_version: Option<&str>,
    env: &dyn EnvLookup,
)

/// Produce the multi-line outdated message for a given source. Pure so
/// the unit tests can match on substrings.
pub fn format_upgrade_message(
    source: &InstallSource,
    current: &str,
    latest: &str,
    drift_manifest_version: Option<&str>,
    env: &dyn EnvLookup,
) -> String {
    let mut out = String::new();
    out.push_str(&format!(
        "A new version is available: {current} -> {latest}.\n\n"
    ));

    match source {
        InstallSource::OfficialInstaller {
            manifest_path,
            recorded_install_path,
            ..
        } => {
            let is_default = recorded_install_path == &PathBuf::from(DEFAULT_INSTALL_PATH);
            if is_default {
                out.push_str("Source: official installer\n");
                out.push_str(&format!("        manifest: {}\n", manifest_path.display()));
                out.push_str(&format!(
                    "        binary:   {}\n\n",
                    recorded_install_path.display()
                ));
                out.push_str("To upgrade, re-run the installer:\n\n");
                out.push_str(&format!("    curl -sSf {INSTALLER_URL} | sh\n"));
            } else {
                let install_dir = recorded_install_path
                    .parent()
                    .map(PathBuf::from)
                    .unwrap_or_else(|| PathBuf::from("/usr/local/bin"));
                let value = render_atomic_install_value(&install_dir, env.var("HOME").as_deref());
                out.push_str("Source: official installer (custom install dir)\n");
                out.push_str(&format!("        manifest: {}\n", manifest_path.display()));
                out.push_str(&format!(
                    "        binary:   {}\n\n",
                    recorded_install_path.display()
                ));
                out.push_str("To upgrade, re-run the installer with the same install dir:\n\n");
                out.push_str(&format!(
                    "    curl -sSf {INSTALLER_URL} | ATOMIC_INSTALL={value} sh\n"
                ));
            }
        }

        InstallSource::Homebrew { prefix } => {
            out.push_str(&format!(
                "Source: Homebrew (prefix: {})\n\n",
                prefix.display()
            ));
            out.push_str("To upgrade:\n\n");
            out.push_str(&format!("    brew upgrade {TAP_FORMULA}\n"));
        }

        InstallSource::Cargo => {
            out.push_str("Source: Cargo install\n\n");