dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

tests.nixpkgs-check-by-name: Intermediate SearchPath error

Browse Source
This commit is contained in:
Silvan Mosberger 2023-10-19 02:32:09 +02:00
parent ed56d74c08
commit a755aa7d02
2 changed files with 46 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
pkgs/test/nixpkgs-check-by-name/src/check_result.rs
View File

@ -5,6 +5,12 @@ use std::io;
use std::path::PathBuf;
pub enum CheckError {
SearchPath {
relative_package_dir: PathBuf,
subpath: PathBuf,
line: usize,
text: String,
},
OutsidePathReference {
relative_package_dir: PathBuf,
subpath: PathBuf,
@ -29,6 +35,14 @@ impl CheckError {
impl fmt::Display for CheckError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
CheckError::SearchPath { relative_package_dir, subpath, line, text } =>
write!(
f,
"{}: File {} at line {line} contains the nix search path expression \"{}\" which may point outside the directory of that package.",
relative_package_dir.display(),
subpath.display(),
text
),
CheckError::OutsidePathReference { relative_package_dir, subpath, line, text } =>
write!(
f,

64
pkgs/test/nixpkgs-check-by-name/src/references.rs
View File

@ -144,43 +144,43 @@ fn check_nix_file<W: io::Write>(
}
// Filters out search paths like <nixpkgs>
if text.starts_with('<') {
context.error_writer.write(&format!(
"{}: File {} at line {line} contains the nix search path expression \"{}\" which may point outside the directory of that package.",
context.relative_package_dir.display(),
subpath.display(),
text
))?;
continue;
}
// Resolves the reference of the Nix path
// turning `../baz` inside `/foo/bar/default.nix` to `/foo/baz`
let check_result = match parent_dir.join(Path::new(&text)).canonicalize() {
Ok(target) => {
// Then checking if it's still in the package directory
// No need to handle the case of it being inside the directory, since we scan through the
// entire directory recursively anyways
if let Err(_prefix_error) = target.strip_prefix(context.absolute_package_dir) {
CheckError::OutsidePathReference {
relative_package_dir: context.relative_package_dir.clone(),
subpath: subpath.to_path_buf(),
line,
text,
}
.into_result()
} else {
pass(())
}
}
Err(e) => CheckError::UnresolvablePathReference {
let check_result = if text.starts_with('<') {
CheckError::SearchPath {
relative_package_dir: context.relative_package_dir.clone(),
subpath: subpath.to_path_buf(),
line,
text,
io_error: e,
}
.into_result(),
.into_result()
} else {
// Resolves the reference of the Nix path
// turning `../baz` inside `/foo/bar/default.nix` to `/foo/baz`
match parent_dir.join(Path::new(&text)).canonicalize() {
Ok(target) => {
// Then checking if it's still in the package directory
// No need to handle the case of it being inside the directory, since we scan through the
// entire directory recursively anyways
if let Err(_prefix_error) = target.strip_prefix(context.absolute_package_dir) {
CheckError::OutsidePathReference {
relative_package_dir: context.relative_package_dir.clone(),
subpath: subpath.to_path_buf(),
line,
text,
}
.into_result()
} else {
pass(())
}
}
Err(e) => CheckError::UnresolvablePathReference {
relative_package_dir: context.relative_package_dir.clone(),
subpath: subpath.to_path_buf(),
line,
text,
io_error: e,
}
.into_result(),
}
};
write_check_result(context.error_writer, check_result)?;