mirror of
https://github.com/cargo-bins/cargo-binstall.git
synced 2025-05-11 14:30:03 +00:00
Refactor: Extract new mod binstall/resolve.rs
Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
This commit is contained in:
Jiahao XU
parent
921774b8f9
commit
5e35604012
2 changed files with 236 additions and 227 deletions
234
src/binstall.rs
234
src/binstall.rs
|
|
@ -1,21 +1,14 @@
|
||||||
use std::{
|
use std::{collections::BTreeSet, path::PathBuf, process, sync::Arc};
|
||||||
collections::BTreeSet,
|
|
||||||
path::{Path, PathBuf},
|
|
||||||
process,
|
|
||||||
sync::Arc,
|
|
||||||
};
|
|
||||||
|
|
||||||
use cargo_toml::{Package, Product};
|
use cargo_toml::Package;
|
||||||
use log::{debug, error, info, warn};
|
use log::{debug, error, info};
|
||||||
use miette::{miette, IntoDiagnostic, Result, WrapErr};
|
use miette::{miette, IntoDiagnostic, Result, WrapErr};
|
||||||
use reqwest::Client;
|
|
||||||
use tokio::{process::Command, task::block_in_place};
|
use tokio::{process::Command, task::block_in_place};
|
||||||
|
|
||||||
use super::{
|
use super::{bins, fetchers::Fetcher, *};
|
||||||
bins,
|
|
||||||
fetchers::{Data, Fetcher, GhCrateMeta, MultiFetcher, QuickInstall},
|
mod resolve;
|
||||||
*,
|
pub use resolve::*;
|
||||||
};
|
|
||||||
|
|
||||||
pub struct Options {
|
pub struct Options {
|
||||||
pub no_symlinks: bool,
|
pub no_symlinks: bool,
|
||||||
|
|
@ -24,219 +17,6 @@ pub struct Options {
|
||||||
pub manifest_path: Option<PathBuf>,
|
pub manifest_path: Option<PathBuf>,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub enum Resolution {
|
|
||||||
Fetch {
|
|
||||||
fetcher: Arc<dyn Fetcher>,
|
|
||||||
package: Package<Meta>,
|
|
||||||
name: String,
|
|
||||||
version: String,
|
|
||||||
bin_path: PathBuf,
|
|
||||||
bin_files: Vec<bins::BinFile>,
|
|
||||||
},
|
|
||||||
InstallFromSource {
|
|
||||||
package: Package<Meta>,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
impl Resolution {
|
|
||||||
fn print(&self, opts: &Options) {
|
|
||||||
match self {
|
|
||||||
Resolution::Fetch {
|
|
||||||
fetcher, bin_files, ..
|
|
||||||
} => {
|
|
||||||
let fetcher_target = fetcher.target();
|
|
||||||
// Prompt user for confirmation
|
|
||||||
debug!(
|
|
||||||
"Found a binary install source: {} ({fetcher_target})",
|
|
||||||
fetcher.source_name()
|
|
||||||
);
|
|
||||||
|
|
||||||
if fetcher.is_third_party() {
|
|
||||||
warn!(
|
|
||||||
"The package will be downloaded from third-party source {}",
|
|
||||||
fetcher.source_name()
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
info!(
|
|
||||||
"The package will be downloaded from {}",
|
|
||||||
fetcher.source_name()
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
info!("This will install the following binaries:");
|
|
||||||
for file in bin_files {
|
|
||||||
info!(" - {}", file.preview_bin());
|
|
||||||
}
|
|
||||||
|
|
||||||
if !opts.no_symlinks {
|
|
||||||
info!("And create (or update) the following symlinks:");
|
|
||||||
for file in bin_files {
|
|
||||||
info!(" - {}", file.preview_link());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Resolution::InstallFromSource { .. } => {
|
|
||||||
warn!("The package will be installed from source (with cargo)",)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub async fn resolve(
|
|
||||||
opts: Arc<Options>,
|
|
||||||
crate_name: CrateName,
|
|
||||||
desired_targets: DesiredTargets,
|
|
||||||
cli_overrides: Arc<PkgOverride>,
|
|
||||||
temp_dir: Arc<Path>,
|
|
||||||
install_path: Arc<Path>,
|
|
||||||
client: Client,
|
|
||||||
) -> Result<Resolution> {
|
|
||||||
info!("Installing package: '{}'", crate_name);
|
|
||||||
|
|
||||||
let mut version = match (&crate_name.version, &opts.version) {
|
|
||||||
(Some(version), None) => version.to_string(),
|
|
||||||
(None, Some(version)) => version.to_string(),
|
|
||||||
(Some(_), Some(_)) => Err(BinstallError::DuplicateVersionReq)?,
|
|
||||||
(None, None) => "*".to_string(),
|
|
||||||
};
|
|
||||||
|
|
||||||
if version
|
|
||||||
.chars()
|
|
||||||
.next()
|
|
||||||
.map(|ch| ch.is_ascii_digit())
|
|
||||||
.unwrap_or(false)
|
|
||||||
{
|
|
||||||
version.insert(0, '=');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch crate via crates.io, git, or use a local manifest path
|
|
||||||
// TODO: work out which of these to do based on `opts.name`
|
|
||||||
// TODO: support git-based fetches (whole repo name rather than just crate name)
|
|
||||||
let manifest = match opts.manifest_path.clone() {
|
|
||||||
Some(manifest_path) => load_manifest_path(manifest_path.join("Cargo.toml"))?,
|
|
||||||
None => fetch_crate_cratesio(&client, &crate_name.name, &version).await?,
|
|
||||||
};
|
|
||||||
|
|
||||||
let package = manifest.package.unwrap();
|
|
||||||
|
|
||||||
let (mut meta, binaries) = (
|
|
||||||
package
|
|
||||||
.metadata
|
|
||||||
.as_ref()
|
|
||||||
.and_then(|m| m.binstall.clone())
|
|
||||||
.unwrap_or_default(),
|
|
||||||
manifest.bin,
|
|
||||||
);
|
|
||||||
|
|
||||||
let mut fetchers = MultiFetcher::default();
|
|
||||||
|
|
||||||
let desired_targets = desired_targets.get().await;
|
|
||||||
|
|
||||||
for target in desired_targets {
|
|
||||||
debug!("Building metadata for target: {target}");
|
|
||||||
let mut target_meta = meta.clone();
|
|
||||||
|
|
||||||
// Merge any overrides
|
|
||||||
if let Some(o) = target_meta.overrides.get(target).cloned() {
|
|
||||||
target_meta.merge(&o);
|
|
||||||
}
|
|
||||||
|
|
||||||
target_meta.merge(&cli_overrides);
|
|
||||||
debug!("Found metadata: {target_meta:?}");
|
|
||||||
|
|
||||||
let fetcher_data = Data {
|
|
||||||
name: package.name.clone(),
|
|
||||||
target: target.clone(),
|
|
||||||
version: package.version.clone(),
|
|
||||||
repo: package.repository.clone(),
|
|
||||||
meta: target_meta,
|
|
||||||
};
|
|
||||||
|
|
||||||
fetchers.add(GhCrateMeta::new(&client, &fetcher_data).await);
|
|
||||||
fetchers.add(QuickInstall::new(&client, &fetcher_data).await);
|
|
||||||
}
|
|
||||||
|
|
||||||
let resolution = match fetchers.first_available().await {
|
|
||||||
Some(fetcher) => {
|
|
||||||
// Build final metadata
|
|
||||||
let fetcher_target = fetcher.target();
|
|
||||||
if let Some(o) = meta.overrides.get(&fetcher_target.to_owned()).cloned() {
|
|
||||||
meta.merge(&o);
|
|
||||||
}
|
|
||||||
meta.merge(&cli_overrides);
|
|
||||||
|
|
||||||
// Generate temporary binary path
|
|
||||||
let bin_path = temp_dir.join(format!("bin-{}", crate_name.name));
|
|
||||||
debug!("Using temporary binary path: {}", bin_path.display());
|
|
||||||
|
|
||||||
let bin_files = collect_bin_files(
|
|
||||||
fetcher.as_ref(),
|
|
||||||
&package,
|
|
||||||
meta,
|
|
||||||
binaries,
|
|
||||||
bin_path.clone(),
|
|
||||||
install_path.to_path_buf(),
|
|
||||||
)?;
|
|
||||||
|
|
||||||
Resolution::Fetch {
|
|
||||||
fetcher,
|
|
||||||
package,
|
|
||||||
name: crate_name.name,
|
|
||||||
version,
|
|
||||||
bin_path,
|
|
||||||
bin_files,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
None => Resolution::InstallFromSource { package },
|
|
||||||
};
|
|
||||||
|
|
||||||
resolution.print(&opts);
|
|
||||||
|
|
||||||
Ok(resolution)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn collect_bin_files(
|
|
||||||
fetcher: &dyn Fetcher,
|
|
||||||
package: &Package<Meta>,
|
|
||||||
mut meta: PkgMeta,
|
|
||||||
binaries: Vec<Product>,
|
|
||||||
bin_path: PathBuf,
|
|
||||||
install_path: PathBuf,
|
|
||||||
) -> Result<Vec<bins::BinFile>> {
|
|
||||||
// Update meta
|
|
||||||
if fetcher.source_name() == "QuickInstall" {
|
|
||||||
// TODO: less of a hack?
|
|
||||||
meta.bin_dir = "{ bin }{ binary-ext }".to_string();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check binaries
|
|
||||||
if binaries.is_empty() {
|
|
||||||
error!("No binaries specified (or inferred from file system)");
|
|
||||||
return Err(miette!(
|
|
||||||
"No binaries specified (or inferred from file system)"
|
|
||||||
));
|
|
||||||
}
|
|
||||||
|
|
||||||
// List files to be installed
|
|
||||||
// based on those found via Cargo.toml
|
|
||||||
let bin_data = bins::Data {
|
|
||||||
name: package.name.clone(),
|
|
||||||
target: fetcher.target().to_string(),
|
|
||||||
version: package.version.clone(),
|
|
||||||
repo: package.repository.clone(),
|
|
||||||
meta,
|
|
||||||
bin_path,
|
|
||||||
install_path,
|
|
||||||
};
|
|
||||||
|
|
||||||
// Create bin_files
|
|
||||||
let bin_files = binaries
|
|
||||||
.iter()
|
|
||||||
.map(|p| bins::BinFile::from_product(&bin_data, p))
|
|
||||||
.collect::<Result<Vec<_>, BinstallError>>()?;
|
|
||||||
|
|
||||||
Ok(bin_files)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub async fn install(
|
pub async fn install(
|
||||||
resolution: Resolution,
|
resolution: Resolution,
|
||||||
opts: Arc<Options>,
|
opts: Arc<Options>,
|
||||||
|
|
|
||||||
229
src/binstall/resolve.rs
Normal file
229
src/binstall/resolve.rs
Normal file
|
|
@ -0,0 +1,229 @@
|
||||||
|
use std::{
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
sync::Arc,
|
||||||
|
};
|
||||||
|
|
||||||
|
use cargo_toml::{Package, Product};
|
||||||
|
use log::{debug, error, info, warn};
|
||||||
|
use miette::{miette, Result};
|
||||||
|
use reqwest::Client;
|
||||||
|
|
||||||
|
use super::Options;
|
||||||
|
use crate::{
|
||||||
|
bins,
|
||||||
|
fetchers::{Data, Fetcher, GhCrateMeta, MultiFetcher, QuickInstall},
|
||||||
|
*,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub enum Resolution {
|
||||||
|
Fetch {
|
||||||
|
fetcher: Arc<dyn Fetcher>,
|
||||||
|
package: Package<Meta>,
|
||||||
|
name: String,
|
||||||
|
version: String,
|
||||||
|
bin_path: PathBuf,
|
||||||
|
bin_files: Vec<bins::BinFile>,
|
||||||
|
},
|
||||||
|
InstallFromSource {
|
||||||
|
package: Package<Meta>,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
impl Resolution {
|
||||||
|
fn print(&self, opts: &Options) {
|
||||||
|
match self {
|
||||||
|
Resolution::Fetch {
|
||||||
|
fetcher, bin_files, ..
|
||||||
|
} => {
|
||||||
|
let fetcher_target = fetcher.target();
|
||||||
|
// Prompt user for confirmation
|
||||||
|
debug!(
|
||||||
|
"Found a binary install source: {} ({fetcher_target})",
|
||||||
|
fetcher.source_name()
|
||||||
|
);
|
||||||
|
|
||||||
|
if fetcher.is_third_party() {
|
||||||
|
warn!(
|
||||||
|
"The package will be downloaded from third-party source {}",
|
||||||
|
fetcher.source_name()
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
info!(
|
||||||
|
"The package will be downloaded from {}",
|
||||||
|
fetcher.source_name()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
info!("This will install the following binaries:");
|
||||||
|
for file in bin_files {
|
||||||
|
info!(" - {}", file.preview_bin());
|
||||||
|
}
|
||||||
|
|
||||||
|
if !opts.no_symlinks {
|
||||||
|
info!("And create (or update) the following symlinks:");
|
||||||
|
for file in bin_files {
|
||||||
|
info!(" - {}", file.preview_link());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Resolution::InstallFromSource { .. } => {
|
||||||
|
warn!("The package will be installed from source (with cargo)",)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn resolve(
|
||||||
|
opts: Arc<Options>,
|
||||||
|
crate_name: CrateName,
|
||||||
|
desired_targets: DesiredTargets,
|
||||||
|
cli_overrides: Arc<PkgOverride>,
|
||||||
|
temp_dir: Arc<Path>,
|
||||||
|
install_path: Arc<Path>,
|
||||||
|
client: Client,
|
||||||
|
) -> Result<Resolution> {
|
||||||
|
info!("Installing package: '{}'", crate_name);
|
||||||
|
|
||||||
|
let mut version = match (&crate_name.version, &opts.version) {
|
||||||
|
(Some(version), None) => version.to_string(),
|
||||||
|
(None, Some(version)) => version.to_string(),
|
||||||
|
(Some(_), Some(_)) => Err(BinstallError::DuplicateVersionReq)?,
|
||||||
|
(None, None) => "*".to_string(),
|
||||||
|
};
|
||||||
|
|
||||||
|
if version
|
||||||
|
.chars()
|
||||||
|
.next()
|
||||||
|
.map(|ch| ch.is_ascii_digit())
|
||||||
|
.unwrap_or(false)
|
||||||
|
{
|
||||||
|
version.insert(0, '=');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fetch crate via crates.io, git, or use a local manifest path
|
||||||
|
// TODO: work out which of these to do based on `opts.name`
|
||||||
|
// TODO: support git-based fetches (whole repo name rather than just crate name)
|
||||||
|
let manifest = match opts.manifest_path.clone() {
|
||||||
|
Some(manifest_path) => load_manifest_path(manifest_path.join("Cargo.toml"))?,
|
||||||
|
None => fetch_crate_cratesio(&client, &crate_name.name, &version).await?,
|
||||||
|
};
|
||||||
|
|
||||||
|
let package = manifest.package.unwrap();
|
||||||
|
|
||||||
|
let (mut meta, binaries) = (
|
||||||
|
package
|
||||||
|
.metadata
|
||||||
|
.as_ref()
|
||||||
|
.and_then(|m| m.binstall.clone())
|
||||||
|
.unwrap_or_default(),
|
||||||
|
manifest.bin,
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut fetchers = MultiFetcher::default();
|
||||||
|
|
||||||
|
let desired_targets = desired_targets.get().await;
|
||||||
|
|
||||||
|
for target in desired_targets {
|
||||||
|
debug!("Building metadata for target: {target}");
|
||||||
|
let mut target_meta = meta.clone();
|
||||||
|
|
||||||
|
// Merge any overrides
|
||||||
|
if let Some(o) = target_meta.overrides.get(target).cloned() {
|
||||||
|
target_meta.merge(&o);
|
||||||
|
}
|
||||||
|
|
||||||
|
target_meta.merge(&cli_overrides);
|
||||||
|
debug!("Found metadata: {target_meta:?}");
|
||||||
|
|
||||||
|
let fetcher_data = Data {
|
||||||
|
name: package.name.clone(),
|
||||||
|
target: target.clone(),
|
||||||
|
version: package.version.clone(),
|
||||||
|
repo: package.repository.clone(),
|
||||||
|
meta: target_meta,
|
||||||
|
};
|
||||||
|
|
||||||
|
fetchers.add(GhCrateMeta::new(&client, &fetcher_data).await);
|
||||||
|
fetchers.add(QuickInstall::new(&client, &fetcher_data).await);
|
||||||
|
}
|
||||||
|
|
||||||
|
let resolution = match fetchers.first_available().await {
|
||||||
|
Some(fetcher) => {
|
||||||
|
// Build final metadata
|
||||||
|
let fetcher_target = fetcher.target();
|
||||||
|
if let Some(o) = meta.overrides.get(&fetcher_target.to_owned()).cloned() {
|
||||||
|
meta.merge(&o);
|
||||||
|
}
|
||||||
|
meta.merge(&cli_overrides);
|
||||||
|
|
||||||
|
// Generate temporary binary path
|
||||||
|
let bin_path = temp_dir.join(format!("bin-{}", crate_name.name));
|
||||||
|
debug!("Using temporary binary path: {}", bin_path.display());
|
||||||
|
|
||||||
|
let bin_files = collect_bin_files(
|
||||||
|
fetcher.as_ref(),
|
||||||
|
&package,
|
||||||
|
meta,
|
||||||
|
binaries,
|
||||||
|
bin_path.clone(),
|
||||||
|
install_path.to_path_buf(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
Resolution::Fetch {
|
||||||
|
fetcher,
|
||||||
|
package,
|
||||||
|
name: crate_name.name,
|
||||||
|
version,
|
||||||
|
bin_path,
|
||||||
|
bin_files,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => Resolution::InstallFromSource { package },
|
||||||
|
};
|
||||||
|
|
||||||
|
resolution.print(&opts);
|
||||||
|
|
||||||
|
Ok(resolution)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn collect_bin_files(
|
||||||
|
fetcher: &dyn Fetcher,
|
||||||
|
package: &Package<Meta>,
|
||||||
|
mut meta: PkgMeta,
|
||||||
|
binaries: Vec<Product>,
|
||||||
|
bin_path: PathBuf,
|
||||||
|
install_path: PathBuf,
|
||||||
|
) -> Result<Vec<bins::BinFile>> {
|
||||||
|
// Update meta
|
||||||
|
if fetcher.source_name() == "QuickInstall" {
|
||||||
|
// TODO: less of a hack?
|
||||||
|
meta.bin_dir = "{ bin }{ binary-ext }".to_string();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check binaries
|
||||||
|
if binaries.is_empty() {
|
||||||
|
error!("No binaries specified (or inferred from file system)");
|
||||||
|
return Err(miette!(
|
||||||
|
"No binaries specified (or inferred from file system)"
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
// List files to be installed
|
||||||
|
// based on those found via Cargo.toml
|
||||||
|
let bin_data = bins::Data {
|
||||||
|
name: package.name.clone(),
|
||||||
|
target: fetcher.target().to_string(),
|
||||||
|
version: package.version.clone(),
|
||||||
|
repo: package.repository.clone(),
|
||||||
|
meta,
|
||||||
|
bin_path,
|
||||||
|
install_path,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Create bin_files
|
||||||
|
let bin_files = binaries
|
||||||
|
.iter()
|
||||||
|
.map(|p| bins::BinFile::from_product(&bin_data, p))
|
||||||
|
.collect::<Result<Vec<_>, BinstallError>>()?;
|
||||||
|
|
||||||
|
Ok(bin_files)
|
||||||
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue