1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
use crate::{load_metadata, Config, BINDINGS_CRATE_NAME};
use anyhow::{Context, Result};
use cargo_component_core::{command::CommonOptions, terminal::Colors};
use cargo_metadata::Metadata;
use clap::Args;
use semver::Version;
use std::{fs, path::PathBuf};
use toml_edit::{value, Document};
/// Install the latest version of cargo-component and upgrade to the
/// corresponding version of cargo-component-bindings.
#[derive(Args)]
#[clap(disable_version_flag = true)]
pub struct UpgradeCommand {
/// The common command options
#[clap(flatten)]
pub common: CommonOptions,
/// Don't actually write the Cargo.toml changes.
///
/// Note that this will not prevent installing a new version of cargo-component itself;
/// if you want to do that, you must also specify the '--no-install' flag.
#[clap(long = "dry-run")]
pub dry_run: bool,
/// Path to Cargo.toml
#[clap(long = "manifest-path", value_name = "PATH")]
pub manifest_path: Option<PathBuf>,
/// Skip installing the latest version of cargo-component;
/// instead just upgrade cargo-component-bindings to match
/// the version currently running.
#[clap(long = "no-install")]
pub no_install: bool,
}
impl UpgradeCommand {
/// Executes the command.
pub async fn exec(self) -> Result<()> {
log::debug!("executing upgrade command");
if !self.no_install {
// Do the self-upgrade first, and then _unconditionally_ delegate
// to whatever version of `cargo-component` is now at the same path as the
// current executable.
//
// This avoids needing to query crates.io ourselves, scrape the version
// from `cargo-component --version` etc.
//
// (We can't tell whether or not cargo-install actually installed anything
// without scraping its output; it considers "already installed" as success.)
upgrade_self()?;
run_cargo_component_and_exit();
}
let config = Config::new(self.common.new_terminal())?;
let metadata = load_metadata(config.terminal(), self.manifest_path.as_deref(), true)?;
upgrade_bindings(&config, &metadata, self.dry_run).await?;
Ok(())
}
}
fn upgrade_self() -> Result<()> {
log::debug!("running self-upgrade using cargo-install");
let mut command = std::process::Command::new("cargo");
command.args(["install", "cargo-component"]);
match command.status() {
Ok(status) => {
if !status.success() {
std::process::exit(status.code().unwrap_or(1));
}
Ok(())
}
Err(e) => {
anyhow::bail!("failed to execute `cargo install` command: {e}")
}
}
}
fn run_cargo_component_and_exit() -> ! {
log::debug!("running cargo-component from same path as this process");
let mut args = std::env::args();
// argv[0] cannot be relied up on as a path to the executable;
// skip it and use `current_exe` instead.
let _ = args.next();
let mut command = std::process::Command::new(
std::env::current_exe().expect("Failed to get path to current executable"),
);
command.args(args);
// Unconditionally specify '--no-install' to prevent infinite recursion.
command.arg("--no-install");
match command.status() {
Ok(status) => {
std::process::exit(status.code().unwrap_or(1));
}
Err(e) => {
log::error!("failed to delegate to `cargo-component` command: {e}");
std::process::exit(1);
}
}
}
async fn upgrade_bindings(config: &Config, metadata: &Metadata, dry_run: bool) -> Result<()> {
let this_version = Version::parse(env!("CARGO_PKG_VERSION"))
.context("Failed to parse current cargo-component version")?;
for package in metadata.workspace_packages() {
let Some(bindings_dep) = package
.dependencies
.iter()
.find(|dep| dep.name == "cargo-component-bindings")
else {
log::debug!(
"workspace package `{name}` doesn't depend on cargo-component-bindings",
name = package.name
);
continue;
};
let s = bindings_dep.req.to_string();
let version = match s.strip_prefix('^').unwrap_or(&s).parse::<Version>() {
Ok(v) => {
if this_version.major == v.major
&& (this_version.major > 0 || this_version.minor == v.minor)
{
config.terminal().status(
"Skipping",
format!(
"package `{name}` as it already uses a compatible bindings crate version",
name = package.name
),
)?;
continue;
}
if this_version.major > v.major
|| (this_version.major == v.major && this_version.minor > v.minor)
{
// cargo-component is newer, fall through to upgrade the project.
v
} else {
// cargo-component is older, warn about it
config.terminal().status_with_color(
"Skipping",
format!(
"package `{name}` is using bindings crate version {v} which is newer than cargo-component ({this_version})",
name = package.name
),
Colors::Yellow,
)?;
continue;
}
}
_ => continue,
};
let manifest_path = package.manifest_path.as_std_path();
let manifest = fs::read_to_string(manifest_path).with_context(|| {
format!(
"failed to read manifest file `{path}`",
path = manifest_path.display()
)
})?;
let mut doc: Document = manifest.parse().with_context(|| {
format!(
"failed to parse manifest file `{path}`",
path = manifest_path.display()
)
})?;
doc["dependencies"][BINDINGS_CRATE_NAME] = value(env!("CARGO_PKG_VERSION"));
// Do this fairly late, so we exercise as much of the real code as possible
// (encounter explosions that would happen if doing it for real)
// without actually writing back the file.
if dry_run {
config.terminal().status(
"Would update",
format!(
"{path} from {from} to {to}",
path = manifest_path.display(),
from = version,
to = env!("CARGO_PKG_VERSION")
),
)?;
continue;
}
fs::write(manifest_path, doc.to_string()).with_context(|| {
format!(
"failed to write manifest file `{path}`",
path = manifest_path.display()
)
})?;
config.terminal().status(
"Updated",
format!(
"{path} from {from} to {to}",
path = manifest_path.display(),
from = version,
to = env!("CARGO_PKG_VERSION")
),
)?;
}
Ok(())
}