mirror of
https://github.com/rust-lang/cargo.git
synced 2025-09-28 11:20:36 +00:00
refactor(package): extract verification code
This commit is contained in:
Weihang Lo
parent
2f5788ae2e
commit
b033b977c6
@ -3,15 +3,16 @@ use std::fs::{self, File};
|
||||
use std::io::prelude::*;
|
||||
use std::io::SeekFrom;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::Arc;
|
||||
use std::task::Poll;
|
||||
|
||||
use crate::core::compiler::{BuildConfig, CompileMode, DefaultExecutor, Executor};
|
||||
use crate::core::dependency::DepKind;
|
||||
use crate::core::manifest::Target;
|
||||
use crate::core::resolver::CliFeatures;
|
||||
use crate::core::resolver::HasDevUnits;
|
||||
use crate::core::{Feature, PackageIdSpecQuery, Shell, Verbosity, Workspace};
|
||||
use crate::core::PackageIdSpecQuery;
|
||||
use crate::core::Shell;
|
||||
use crate::core::Verbosity;
|
||||
use crate::core::Workspace;
|
||||
use crate::core::{Package, PackageId, PackageSet, Resolve, SourceId};
|
||||
use crate::ops::lockfile::LOCKFILE_NAME;
|
||||
use crate::ops::registry::{infer_registry, RegistryOrIndex};
|
||||
@ -20,20 +21,23 @@ use crate::sources::{PathSource, CRATES_IO_REGISTRY};
|
||||
use crate::util::cache_lock::CacheLockMode;
|
||||
use crate::util::context::JobsConfig;
|
||||
use crate::util::errors::CargoResult;
|
||||
use crate::util::human_readable_bytes;
|
||||
use crate::util::restricted_names;
|
||||
use crate::util::toml::prepare_for_publish;
|
||||
use crate::util::{
|
||||
self, human_readable_bytes, restricted_names, FileLock, Filesystem, GlobalContext, Graph,
|
||||
};
|
||||
use crate::util::FileLock;
|
||||
use crate::util::Filesystem;
|
||||
use crate::util::GlobalContext;
|
||||
use crate::util::Graph;
|
||||
use crate::{drop_println, ops};
|
||||
use anyhow::{bail, Context as _};
|
||||
use cargo_util::paths;
|
||||
use flate2::read::GzDecoder;
|
||||
use flate2::{Compression, GzBuilder};
|
||||
use tar::{Archive, Builder, EntryType, Header, HeaderMode};
|
||||
use tar::{Builder, EntryType, Header, HeaderMode};
|
||||
use tracing::debug;
|
||||
use unicase::Ascii as UncasedAscii;
|
||||
|
||||
mod vcs;
|
||||
mod verify;
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct PackageOpts<'gctx> {
|
||||
@ -250,7 +254,7 @@ fn do_package<'a>(
|
||||
// are already all in the local registry overlay.
|
||||
if opts.verify {
|
||||
for (pkg, opts, tarball) in &outputs {
|
||||
run_verify(ws, pkg, tarball, local_reg.as_ref(), opts)
|
||||
verify::run_verify(ws, pkg, tarball, local_reg.as_ref(), opts)
|
||||
.context("failed to verify package tarball")?
|
||||
}
|
||||
}
|
||||
@ -926,160 +930,6 @@ pub fn check_yanked(
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn run_verify(
|
||||
ws: &Workspace<'_>,
|
||||
pkg: &Package,
|
||||
tar: &FileLock,
|
||||
local_reg: Option<&TmpRegistry<'_>>,
|
||||
opts: &PackageOpts<'_>,
|
||||
) -> CargoResult<()> {
|
||||
let gctx = ws.gctx();
|
||||
|
||||
gctx.shell().status("Verifying", pkg)?;
|
||||
|
||||
tar.file().seek(SeekFrom::Start(0))?;
|
||||
let f = GzDecoder::new(tar.file());
|
||||
let dst = tar
|
||||
.parent()
|
||||
.join(&format!("{}-{}", pkg.name(), pkg.version()));
|
||||
if dst.exists() {
|
||||
paths::remove_dir_all(&dst)?;
|
||||
}
|
||||
let mut archive = Archive::new(f);
|
||||
// We don't need to set the Modified Time, as it's not relevant to verification
|
||||
// and it errors on filesystems that don't support setting a modified timestamp
|
||||
archive.set_preserve_mtime(false);
|
||||
archive.unpack(dst.parent().unwrap())?;
|
||||
|
||||
// Manufacture an ephemeral workspace to ensure that even if the top-level
|
||||
// package has a workspace we can still build our new crate.
|
||||
let id = SourceId::for_path(&dst)?;
|
||||
let mut src = PathSource::new(&dst, id, ws.gctx());
|
||||
let new_pkg = src.root_package()?;
|
||||
let pkg_fingerprint = hash_all(&dst)?;
|
||||
let mut ws = Workspace::ephemeral(new_pkg, gctx, None, true)?;
|
||||
if let Some(local_reg) = local_reg {
|
||||
ws.add_local_overlay(
|
||||
local_reg.upstream,
|
||||
local_reg.root.as_path_unlocked().to_owned(),
|
||||
);
|
||||
}
|
||||
|
||||
let rustc_args = if pkg
|
||||
.manifest()
|
||||
.unstable_features()
|
||||
.require(Feature::public_dependency())
|
||||
.is_ok()
|
||||
|| ws.gctx().cli_unstable().public_dependency
|
||||
{
|
||||
// FIXME: Turn this on at some point in the future
|
||||
//Some(vec!["-D exported_private_dependencies".to_string()])
|
||||
Some(vec![])
|
||||
} else {
|
||||
None
|
||||
};
|
||||
|
||||
let exec: Arc<dyn Executor> = Arc::new(DefaultExecutor);
|
||||
ops::compile_with_exec(
|
||||
&ws,
|
||||
&ops::CompileOptions {
|
||||
build_config: BuildConfig::new(
|
||||
gctx,
|
||||
opts.jobs.clone(),
|
||||
opts.keep_going,
|
||||
&opts.targets,
|
||||
CompileMode::Build,
|
||||
)?,
|
||||
cli_features: opts.cli_features.clone(),
|
||||
spec: ops::Packages::Packages(Vec::new()),
|
||||
filter: ops::CompileFilter::Default {
|
||||
required_features_filterable: true,
|
||||
},
|
||||
target_rustdoc_args: None,
|
||||
target_rustc_args: rustc_args,
|
||||
target_rustc_crate_types: None,
|
||||
rustdoc_document_private_items: false,
|
||||
honor_rust_version: None,
|
||||
},
|
||||
&exec,
|
||||
)?;
|
||||
|
||||
// Check that `build.rs` didn't modify any files in the `src` directory.
|
||||
let ws_fingerprint = hash_all(&dst)?;
|
||||
if pkg_fingerprint != ws_fingerprint {
|
||||
let changes = report_hash_difference(&pkg_fingerprint, &ws_fingerprint);
|
||||
anyhow::bail!(
|
||||
"Source directory was modified by build.rs during cargo publish. \
|
||||
Build scripts should not modify anything outside of OUT_DIR.\n\
|
||||
{}\n\n\
|
||||
To proceed despite this, pass the `--no-verify` flag.",
|
||||
changes
|
||||
)
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn hash_all(path: &Path) -> CargoResult<HashMap<PathBuf, u64>> {
|
||||
fn wrap(path: &Path) -> CargoResult<HashMap<PathBuf, u64>> {
|
||||
let mut result = HashMap::new();
|
||||
let walker = walkdir::WalkDir::new(path).into_iter();
|
||||
for entry in walker.filter_entry(|e| !(e.depth() == 1 && e.file_name() == "target")) {
|
||||
let entry = entry?;
|
||||
let file_type = entry.file_type();
|
||||
if file_type.is_file() {
|
||||
let file = File::open(entry.path())?;
|
||||
let hash = util::hex::hash_u64_file(&file)?;
|
||||
result.insert(entry.path().to_path_buf(), hash);
|
||||
} else if file_type.is_symlink() {
|
||||
let hash = util::hex::hash_u64(&fs::read_link(entry.path())?);
|
||||
result.insert(entry.path().to_path_buf(), hash);
|
||||
} else if file_type.is_dir() {
|
||||
let hash = util::hex::hash_u64(&());
|
||||
result.insert(entry.path().to_path_buf(), hash);
|
||||
}
|
||||
}
|
||||
Ok(result)
|
||||
}
|
||||
let result = wrap(path).with_context(|| format!("failed to verify output at {:?}", path))?;
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
fn report_hash_difference(orig: &HashMap<PathBuf, u64>, after: &HashMap<PathBuf, u64>) -> String {
|
||||
let mut changed = Vec::new();
|
||||
let mut removed = Vec::new();
|
||||
for (key, value) in orig {
|
||||
match after.get(key) {
|
||||
Some(after_value) => {
|
||||
if value != after_value {
|
||||
changed.push(key.to_string_lossy());
|
||||
}
|
||||
}
|
||||
None => removed.push(key.to_string_lossy()),
|
||||
}
|
||||
}
|
||||
let mut added: Vec<_> = after
|
||||
.keys()
|
||||
.filter(|key| !orig.contains_key(*key))
|
||||
.map(|key| key.to_string_lossy())
|
||||
.collect();
|
||||
let mut result = Vec::new();
|
||||
if !changed.is_empty() {
|
||||
changed.sort_unstable();
|
||||
result.push(format!("Changed: {}", changed.join("\n\t")));
|
||||
}
|
||||
if !added.is_empty() {
|
||||
added.sort_unstable();
|
||||
result.push(format!("Added: {}", added.join("\n\t")));
|
||||
}
|
||||
if !removed.is_empty() {
|
||||
removed.sort_unstable();
|
||||
result.push(format!("Removed: {}", removed.join("\n\t")));
|
||||
}
|
||||
assert!(!result.is_empty(), "unexpected empty change detection");
|
||||
result.join("\n")
|
||||
}
|
||||
|
||||
// It can often be the case that files of a particular name on one platform
|
||||
// can't actually be created on another platform. For example files with colons
|
||||
// in the name are allowed on Unix but not on Windows.
|
||||
|
||||
184
src/cargo/ops/cargo_package/verify.rs
Normal file
184
src/cargo/ops/cargo_package/verify.rs
Normal file
@ -0,0 +1,184 @@
|
||||
use std::collections::HashMap;
|
||||
use std::fs;
|
||||
use std::fs::File;
|
||||
use std::io::prelude::*;
|
||||
use std::io::SeekFrom;
|
||||
use std::path::Path;
|
||||
use std::path::PathBuf;
|
||||
use std::sync::Arc;
|
||||
|
||||
use anyhow::Context as _;
|
||||
use cargo_util::paths;
|
||||
use flate2::read::GzDecoder;
|
||||
use tar::Archive;
|
||||
|
||||
use crate::core::compiler::BuildConfig;
|
||||
use crate::core::compiler::CompileMode;
|
||||
use crate::core::compiler::DefaultExecutor;
|
||||
use crate::core::compiler::Executor;
|
||||
use crate::core::Feature;
|
||||
use crate::core::Package;
|
||||
use crate::core::SourceId;
|
||||
use crate::core::Workspace;
|
||||
use crate::ops;
|
||||
use crate::sources::PathSource;
|
||||
use crate::util;
|
||||
use crate::util::FileLock;
|
||||
use crate::CargoResult;
|
||||
|
||||
use super::PackageOpts;
|
||||
use super::TmpRegistry;
|
||||
|
||||
pub fn run_verify(
|
||||
ws: &Workspace<'_>,
|
||||
pkg: &Package,
|
||||
tar: &FileLock,
|
||||
local_reg: Option<&TmpRegistry<'_>>,
|
||||
opts: &PackageOpts<'_>,
|
||||
) -> CargoResult<()> {
|
||||
let gctx = ws.gctx();
|
||||
|
||||
gctx.shell().status("Verifying", pkg)?;
|
||||
|
||||
tar.file().seek(SeekFrom::Start(0))?;
|
||||
let f = GzDecoder::new(tar.file());
|
||||
let dst = tar
|
||||
.parent()
|
||||
.join(&format!("{}-{}", pkg.name(), pkg.version()));
|
||||
if dst.exists() {
|
||||
paths::remove_dir_all(&dst)?;
|
||||
}
|
||||
let mut archive = Archive::new(f);
|
||||
// We don't need to set the Modified Time, as it's not relevant to verification
|
||||
// and it errors on filesystems that don't support setting a modified timestamp
|
||||
archive.set_preserve_mtime(false);
|
||||
archive.unpack(dst.parent().unwrap())?;
|
||||
|
||||
// Manufacture an ephemeral workspace to ensure that even if the top-level
|
||||
// package has a workspace we can still build our new crate.
|
||||
let id = SourceId::for_path(&dst)?;
|
||||
let mut src = PathSource::new(&dst, id, ws.gctx());
|
||||
let new_pkg = src.root_package()?;
|
||||
let pkg_fingerprint = hash_all(&dst)?;
|
||||
let mut ws = Workspace::ephemeral(new_pkg, gctx, None, true)?;
|
||||
if let Some(local_reg) = local_reg {
|
||||
ws.add_local_overlay(
|
||||
local_reg.upstream,
|
||||
local_reg.root.as_path_unlocked().to_owned(),
|
||||
);
|
||||
}
|
||||
|
||||
let rustc_args = if pkg
|
||||
.manifest()
|
||||
.unstable_features()
|
||||
.require(Feature::public_dependency())
|
||||
.is_ok()
|
||||
|| ws.gctx().cli_unstable().public_dependency
|
||||
{
|
||||
// FIXME: Turn this on at some point in the future
|
||||
//Some(vec!["-D exported_private_dependencies".to_string()])
|
||||
Some(vec![])
|
||||
} else {
|
||||
None
|
||||
};
|
||||
|
||||
let exec: Arc<dyn Executor> = Arc::new(DefaultExecutor);
|
||||
ops::compile_with_exec(
|
||||
&ws,
|
||||
&ops::CompileOptions {
|
||||
build_config: BuildConfig::new(
|
||||
gctx,
|
||||
opts.jobs.clone(),
|
||||
opts.keep_going,
|
||||
&opts.targets,
|
||||
CompileMode::Build,
|
||||
)?,
|
||||
cli_features: opts.cli_features.clone(),
|
||||
spec: ops::Packages::Packages(Vec::new()),
|
||||
filter: ops::CompileFilter::Default {
|
||||
required_features_filterable: true,
|
||||
},
|
||||
target_rustdoc_args: None,
|
||||
target_rustc_args: rustc_args,
|
||||
target_rustc_crate_types: None,
|
||||
rustdoc_document_private_items: false,
|
||||
honor_rust_version: None,
|
||||
},
|
||||
&exec,
|
||||
)?;
|
||||
|
||||
// Check that `build.rs` didn't modify any files in the `src` directory.
|
||||
let ws_fingerprint = hash_all(&dst)?;
|
||||
if pkg_fingerprint != ws_fingerprint {
|
||||
let changes = report_hash_difference(&pkg_fingerprint, &ws_fingerprint);
|
||||
anyhow::bail!(
|
||||
"Source directory was modified by build.rs during cargo publish. \
|
||||
Build scripts should not modify anything outside of OUT_DIR.\n\
|
||||
{}\n\n\
|
||||
To proceed despite this, pass the `--no-verify` flag.",
|
||||
changes
|
||||
)
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn hash_all(path: &Path) -> CargoResult<HashMap<PathBuf, u64>> {
|
||||
fn wrap(path: &Path) -> CargoResult<HashMap<PathBuf, u64>> {
|
||||
let mut result = HashMap::new();
|
||||
let walker = walkdir::WalkDir::new(path).into_iter();
|
||||
for entry in walker.filter_entry(|e| !(e.depth() == 1 && e.file_name() == "target")) {
|
||||
let entry = entry?;
|
||||
let file_type = entry.file_type();
|
||||
if file_type.is_file() {
|
||||
let file = File::open(entry.path())?;
|
||||
let hash = util::hex::hash_u64_file(&file)?;
|
||||
result.insert(entry.path().to_path_buf(), hash);
|
||||
} else if file_type.is_symlink() {
|
||||
let hash = util::hex::hash_u64(&fs::read_link(entry.path())?);
|
||||
result.insert(entry.path().to_path_buf(), hash);
|
||||
} else if file_type.is_dir() {
|
||||
let hash = util::hex::hash_u64(&());
|
||||
result.insert(entry.path().to_path_buf(), hash);
|
||||
}
|
||||
}
|
||||
Ok(result)
|
||||
}
|
||||
let result = wrap(path).with_context(|| format!("failed to verify output at {:?}", path))?;
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
fn report_hash_difference(orig: &HashMap<PathBuf, u64>, after: &HashMap<PathBuf, u64>) -> String {
|
||||
let mut changed = Vec::new();
|
||||
let mut removed = Vec::new();
|
||||
for (key, value) in orig {
|
||||
match after.get(key) {
|
||||
Some(after_value) => {
|
||||
if value != after_value {
|
||||
changed.push(key.to_string_lossy());
|
||||
}
|
||||
}
|
||||
None => removed.push(key.to_string_lossy()),
|
||||
}
|
||||
}
|
||||
let mut added: Vec<_> = after
|
||||
.keys()
|
||||
.filter(|key| !orig.contains_key(*key))
|
||||
.map(|key| key.to_string_lossy())
|
||||
.collect();
|
||||
let mut result = Vec::new();
|
||||
if !changed.is_empty() {
|
||||
changed.sort_unstable();
|
||||
result.push(format!("Changed: {}", changed.join("\n\t")));
|
||||
}
|
||||
if !added.is_empty() {
|
||||
added.sort_unstable();
|
||||
result.push(format!("Added: {}", added.join("\n\t")));
|
||||
}
|
||||
if !removed.is_empty() {
|
||||
removed.sort_unstable();
|
||||
result.push(format!("Removed: {}", removed.join("\n\t")));
|
||||
}
|
||||
assert!(!result.is_empty(), "unexpected empty change detection");
|
||||
result.join("\n")
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user