From 75a75715a08111725153498769d25000bc885265 Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Mon, 29 Jul 2024 17:37:02 -0600 Subject: [PATCH 1/6] add optional tracing feature, trace which logic --- Cargo.toml | 5 +++++ src/checker.rs | 26 ++++++++++++++++++++------ src/finder.rs | 25 ++++++++++++++++++++++++- 3 files changed, 49 insertions(+), 7 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index beec5aa..2146ea5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,9 +12,14 @@ readme = "README.md" categories = ["os", "filesystem"] keywords = ["which", "which-rs", "unix", "command"] +[features] +regex = ["dep:regex"] +tracing = ["dep:tracing"] + [dependencies] either = "1.9.0" regex = { version = "1.10.2", optional = true } +tracing = { version = "0.1.40", optional = true } [target.'cfg(any(windows, unix, target_os = "redox"))'.dependencies] home = "0.5.9" diff --git a/src/checker.rs b/src/checker.rs index 9668443..0044d22 100644 --- a/src/checker.rs +++ b/src/checker.rs @@ -14,7 +14,10 @@ impl Checker for ExecutableChecker { #[cfg(any(unix, target_os = "wasi", target_os = "redox"))] fn is_valid(&self, path: &Path) -> bool { use rustix::fs as rfs; - rfs::access(path, rfs::Access::EXEC_OK).is_ok() + let ret = rfs::access(path, rfs::Access::EXEC_OK).is_ok(); + #[cfg(feature = "tracing")] + tracing::trace!("{} EXEC_OK = {ret}", path.display()); + ret } #[cfg(windows)] @@ -34,26 +37,37 @@ impl ExistedChecker { impl Checker for ExistedChecker { #[cfg(target_os = "windows")] fn is_valid(&self, path: &Path) -> bool { - fs::symlink_metadata(path) + let ret = fs::symlink_metadata(path) .map(|metadata| { let file_type = metadata.file_type(); + #[cfg(feature = "tracing")] + tracing::trace!("{} is_file() = {}, is_symlink() = {}", new_path.display(), file_type.is_file(), file_type.is_symlink()); file_type.is_file() || file_type.is_symlink() }) .unwrap_or(false) - && (path.extension().is_some() || matches_arch(path)) + && (path.extension().is_some() || matches_arch(path)); + #[cfg(feature = "tracing")] + tracing::trace!("{} has_extension = {}, ExistedChecker::is_valid() = {ret}", path.display(), path.extension().is_some()); + ret } #[cfg(not(target_os = "windows"))] fn is_valid(&self, path: &Path) -> bool { - fs::metadata(path) + let ret = fs::metadata(path) .map(|metadata| metadata.is_file()) - .unwrap_or(false) + .unwrap_or(false); + #[cfg(feature = "tracing")] + tracing::trace!("{} is_file() = {ret}", path.display()); + ret } } #[cfg(target_os = "windows")] fn matches_arch(path: &Path) -> bool { - winsafe::GetBinaryType(&path.display().to_string()).is_ok() + let ret = winsafe::GetBinaryType(&path.display().to_string()).is_ok(); + #[cfg(feature = "tracing")] + tracing::trace!("{} matches_arch() = {ret}", path.display()); + ret } pub struct CompositeChecker { diff --git a/src/finder.rs b/src/finder.rs index cd73968..9a1efa8 100644 --- a/src/finder.rs +++ b/src/finder.rs @@ -78,10 +78,17 @@ impl Finder { let binary_path_candidates = match cwd { Some(cwd) if path.has_separator() => { + #[cfg(feature = "tracing")] + tracing::trace!( + "{} has a path seperator, so only CWD will be searched.", + path.display() + ); // Search binary in cwd if the path have a path separator. Either::Left(Self::cwd_search_candidates(path, cwd).into_iter()) } _ => { + #[cfg(feature = "tracing")] + tracing::trace!("{} has no path seperators, so only paths in PATH environment variable will be searched.", path.display()); // Search binary in PATHs(defined in environment variable). let paths = env::split_paths(&paths.ok_or(Error::CannotGetCurrentDirAndPathListEmpty)?) @@ -201,8 +208,18 @@ impl Finder { }); // Check if path already have executable extension if has_executable_extension(&p, path_extensions) { + #[cfg(feature = "tracing")] + tracing::trace!( + "{} already has an executable extension, not modifying it further", + p.display() + ); Box::new(iter::once(p)) } else { + #[cfg(feature = "tracing")] + tracing::trace!( + "{} has no extension, using PATHEXT environment variable to infer one", + p.display() + ); // Appended paths with windows executable extensions. // e.g. path `c:/windows/bin[.ext]` will expand to: // [c:/windows/bin.ext] @@ -215,7 +232,8 @@ impl Finder { // Append the extension. let mut p = p.clone().into_os_string(); p.push(e); - + #[cfg(feature = "tracing")] + tracing::trace!("possible extension: {}", p.display()); PathBuf::from(p) })), ) @@ -230,6 +248,11 @@ fn tilde_expansion(p: &PathBuf) -> Cow<'_, PathBuf> { if o == "~" { let mut new_path = home_dir().unwrap_or_default(); new_path.extend(component_iter); + #[cfg(feature = "tracing")] + tracing::trace!( + "found tilde, substituting in user's home directory to get {}", + new_path.display() + ); Cow::Owned(new_path) } else { Cow::Borrowed(p) From d3c3c4d4dd159bc4e9149f9d50695429da8dbcd9 Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Mon, 29 Jul 2024 17:47:01 -0600 Subject: [PATCH 2/6] fix Windows code --- src/checker.rs | 13 +++++++++++-- src/finder.rs | 5 +++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/src/checker.rs b/src/checker.rs index 0044d22..a1c924d 100644 --- a/src/checker.rs +++ b/src/checker.rs @@ -41,13 +41,22 @@ impl Checker for ExistedChecker { .map(|metadata| { let file_type = metadata.file_type(); #[cfg(feature = "tracing")] - tracing::trace!("{} is_file() = {}, is_symlink() = {}", new_path.display(), file_type.is_file(), file_type.is_symlink()); + tracing::trace!( + "{} is_file() = {}, is_symlink() = {}", + path.display(), + file_type.is_file(), + file_type.is_symlink() + ); file_type.is_file() || file_type.is_symlink() }) .unwrap_or(false) && (path.extension().is_some() || matches_arch(path)); #[cfg(feature = "tracing")] - tracing::trace!("{} has_extension = {}, ExistedChecker::is_valid() = {ret}", path.display(), path.extension().is_some()); + tracing::trace!( + "{} has_extension = {}, ExistedChecker::is_valid() = {ret}", + path.display(), + path.extension().is_some() + ); ret } diff --git a/src/finder.rs b/src/finder.rs index 9a1efa8..4ae2d6a 100644 --- a/src/finder.rs +++ b/src/finder.rs @@ -232,9 +232,10 @@ impl Finder { // Append the extension. let mut p = p.clone().into_os_string(); p.push(e); + let ret = PathBuf::from(p); #[cfg(feature = "tracing")] - tracing::trace!("possible extension: {}", p.display()); - PathBuf::from(p) + tracing::trace!("possible extension: {}", ret.display()); + ret })), ) } From f095a2e76c73db03114f7a8bc55f52d2c6e87458 Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Mon, 29 Jul 2024 17:52:21 -0600 Subject: [PATCH 3/6] Turn off tracing default features --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 2146ea5..534ba41 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -19,7 +19,7 @@ tracing = ["dep:tracing"] [dependencies] either = "1.9.0" regex = { version = "1.10.2", optional = true } -tracing = { version = "0.1.40", optional = true } +tracing = { version = "0.1.40", default-features = false, optional = true } [target.'cfg(any(windows, unix, target_os = "redox"))'.dependencies] home = "0.5.9" From 88c70a88c2b0a8b49f08ea782df4193521a7a62a Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Mon, 29 Jul 2024 17:55:05 -0600 Subject: [PATCH 4/6] modernize deny.toml --- deny.toml | 98 ++++++++++++++++++------------------------------------- 1 file changed, 31 insertions(+), 67 deletions(-) diff --git a/deny.toml b/deny.toml index b38c180..7fccced 100644 --- a/deny.toml +++ b/deny.toml @@ -11,6 +11,9 @@ # Root options +# The graph table configures how the dependency graph is constructed and thus +# which crates the checks are performed against +[graph] # If 1 or more target triples (and optionally, target_features) are specified, # only the specified targets will be checked when running `cargo deny check`. # This means, if a particular package is only ever used as a target specific @@ -22,7 +25,7 @@ targets = [ # The triple can be any string, but only the target triples built in to # rustc (as of 1.40) can be checked against actual config expressions - #{ triple = "x86_64-unknown-linux-musl" }, + #"x86_64-unknown-linux-musl", # You can also specify which target_features you promise are enabled for a # particular target. target_features are currently not validated against # the actual valid features supported by the target architecture. @@ -46,6 +49,9 @@ no-default-features = false # If set, these feature will be enabled when collecting metadata. If `--features` # is specified on the cmd line they will take precedence over this option. #features = [] + +# The output table provides options for how/if diagnostics are outputted +[output] # When outputting inclusion graphs in diagnostics that include features, this # option can be used to specify the depth at which feature edges will be added. # This option is included since the graphs can be quite large and the addition @@ -57,35 +63,18 @@ feature-depth = 1 # More documentation for the advisories section can be found here: # https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html [advisories] -# The path where the advisory database is cloned/fetched into -db-path = "~/.cargo/advisory-db" +# The path where the advisory databases are cloned/fetched into +#db-path = "$CARGO_HOME/advisory-dbs" # The url(s) of the advisory databases to use -db-urls = ["https://github.com/rustsec/advisory-db"] -# The lint level for security vulnerabilities -vulnerability = "deny" -# The lint level for unmaintained crates -unmaintained = "warn" -# The lint level for crates that have been yanked from their source registry -yanked = "warn" -# The lint level for crates with security notices. Note that as of -# 2019-12-17 there are no security notice advisories in -# https://github.com/rustsec/advisory-db -notice = "warn" +#db-urls = ["https://github.com/rustsec/advisory-db"] # A list of advisory IDs to ignore. Note that ignored advisories will still # output a note when they are encountered. ignore = [ #"RUSTSEC-0000-0000", + #{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" }, + #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish + #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" }, ] -# Threshold for security vulnerabilities, any vulnerability with a CVSS score -# lower than the range specified will be ignored. Note that ignored advisories -# will still output a note when they are encountered. -# * None - CVSS Score 0.0 -# * Low - CVSS Score 0.1 - 3.9 -# * Medium - CVSS Score 4.0 - 6.9 -# * High - CVSS Score 7.0 - 8.9 -# * Critical - CVSS Score 9.0 - 10.0 -#severity-threshold = - # If this is true, then cargo deny will use the git executable to fetch advisory database. # If this is false, then it uses a built-in git library. # Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. @@ -96,8 +85,6 @@ ignore = [ # More documentation for the licenses section can be found here: # https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html [licenses] -# The lint level for crates which do not have a detectable license -unlicensed = "deny" # List of explicitly allowed licenses # See https://spdx.org/licenses/ for list of possible licenses # [possible values: any SPDX 3.11 short identifier (+ optional exception)]. @@ -105,28 +92,6 @@ allow = [ "MIT", "Apache-2.0", ] -# List of explicitly disallowed licenses -# See https://spdx.org/licenses/ for list of possible licenses -# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. -deny = [ - #"Nokia", -] -# Lint level for licenses considered copyleft -copyleft = "deny" -# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses -# * both - The license will be approved if it is both OSI-approved *AND* FSF -# * either - The license will be approved if it is either OSI-approved *OR* FSF -# * osi - The license will be approved if it is OSI approved -# * fsf - The license will be approved if it is FSF Free -# * osi-only - The license will be approved if it is OSI-approved *AND NOT* FSF -# * fsf-only - The license will be approved if it is FSF *AND NOT* OSI-approved -# * neither - This predicate is ignored and the default lint level is used -allow-osi-fsf-free = "neither" -# Lint level used when no other predicates are matched -# 1. License isn't in the allow or deny lists -# 2. License isn't copyleft -# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither" -default = "deny" # The confidence threshold for detecting a license from license text. # The higher the value, the more closely the license text must be to the # canonical license text of a valid SPDX license file. @@ -137,17 +102,15 @@ confidence-threshold = 0.8 exceptions = [ # Each entry is the crate and version constraint, and its specific allow # list - #{ allow = ["Zlib"], name = "adler32", version = "*" }, + #{ allow = ["Zlib"], crate = "adler32" }, ] # Some crates don't have (easily) machine readable licensing information, # adding a clarification entry for it allows you to manually specify the # licensing information #[[licenses.clarify]] -# The name of the crate the clarification applies to -#name = "ring" -# The optional version constraint for the crate -#version = "*" +# The package spec the clarification applies to +#crate = "ring" # The SPDX expression for the license requirements of the crate #expression = "MIT AND ISC AND OpenSSL" # One or more files in the crate's source used as the "source of truth" for @@ -156,8 +119,8 @@ exceptions = [ # and the crate will be checked normally, which may produce warnings or errors # depending on the rest of your configuration #license-files = [ - # Each entry is a crate relative path, and the (opaque) hash of its contents - #{ path = "LICENSE", hash = 0xbd0eed23 } +# Each entry is a crate relative path, and the (opaque) hash of its contents +#{ path = "LICENSE", hash = 0xbd0eed23 } #] [licenses.private] @@ -197,24 +160,23 @@ workspace-default-features = "allow" external-default-features = "allow" # List of crates that are allowed. Use with care! allow = [ - #{ name = "ansi_term", version = "=0.11.0" }, + #"ansi_term@0.11.0", + #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" }, ] # List of crates to deny deny = [ - # Each entry the name of a crate and a version range. If version is - # not specified, all versions will be matched. - #{ name = "ansi_term", version = "=0.11.0" }, - # + #"ansi_term@0.11.0", + #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" }, # Wrapper crates can optionally be specified to allow the crate when it # is a direct dependency of the otherwise banned crate - #{ name = "ansi_term", version = "=0.11.0", wrappers = [] }, + #{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] }, ] # List of features to allow/deny # Each entry the name of a crate and a version range. If version is # not specified, all versions will be matched. #[[bans.features]] -#name = "reqwest" +#crate = "reqwest" # Features to not allow #deny = ["json"] # Features to allow @@ -235,14 +197,16 @@ deny = [ # Certain crates/versions that will be skipped when doing duplicate detection. skip = [ - #{ name = "ansi_term", version = "=0.11.0" }, + #"ansi_term@0.11.0", + #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" }, ] # Similarly to `skip` allows you to skip certain crates during duplicate # detection. Unlike skip, it also includes the entire tree of transitive # dependencies starting at the specified crate, up to a certain depth, which is # by default infinite. skip-tree = [ - #{ name = "ansi_term", version = "=0.11.0", depth = 20 }, + #"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies + #{ crate = "ansi_term@0.11.0", depth = 20 }, ] # This section is considered when running `cargo deny check sources`. @@ -263,8 +227,8 @@ allow-git = [] [sources.allow-org] # 1 or more github.com organizations to allow git sources for -github = [] +github = [""] # 1 or more gitlab.com organizations to allow git sources for -gitlab = [] +gitlab = [""] # 1 or more bitbucket.org organizations to allow git sources for -bitbucket = [] +bitbucket = [""] From c5207da59f1bf02f2405c354bb55fca808209568 Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Mon, 29 Jul 2024 17:57:26 -0600 Subject: [PATCH 5/6] also run CI without features enabled --- .github/workflows/rust.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 8c5992b..edd3334 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -40,6 +40,8 @@ jobs: - name: Build | Lint run: cargo clippy --workspace --all-targets --all-features -- -Dwarnings + - name: Build | Lint (no features) + run: cargo clippy --workspace --all-targets -- -Dwarnings # Ensure that the project could be successfully compiled cargo_check: From 100b91701944188518af2be96756d46485c98c87 Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Mon, 29 Jul 2024 18:02:08 -0600 Subject: [PATCH 6/6] Bump version to 6.0.2 --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 534ba41..7e1486d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "which" -version = "6.0.1" +version = "6.0.2" edition = "2021" rust-version = "1.70" authors = ["Harry Fei "]