archives/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2026-03-08 03:44:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

testers.testEqualContents: add checkMetadata option

Browse source 
Allows ignoring file metadata differences (permissions, ownership)
when comparing files.

This is especially useful on darwin, where we often run into subtle
issues like:

    -Device: 1,23 Access: (0444/-r--r--r--) Uid: ( 0/ root) Gid: ( 0/ wheel)
    +Device: 1,23 Access: (0444/-r--r--r--) Uid: ( 0/ root) Gid: ( 350/ nixbld)
This commit is contained in:
Matt Sturgeon 2025-10-17 16:09:51 +01:00
parent e62b610ac9
commit 237b3cb5ce
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/build-helpers/testers.chapter.md
View file

@ -421,6 +421,11 @@ Check that two paths have the same contents.
: A message that is printed last if the file system object contents at the two paths don't match exactly.
`checkMetadata` (boolean)
: Whether to fail on metadata differences, such as permissions or ownership.
Defaults to `true`.
:::{.example #ex-testEqualContents-toyexample}
# Check that two paths have the same contents

4
pkgs/build-support/testers/default.nix
View file

@ -57,6 +57,7 @@
actual,
expected,
postFailureMessage ? null,
checkMetadata ? true,
}:
runCommand "equal-contents-${lib.strings.toLower assertion}"
{
@ -66,12 +67,13 @@
expected
postFailureMessage
;
excludeMetadata = if checkMetadata then "no" else "yes";
nativeBuildInputs = [ diffoscopeMinimal ];
}
''
echo "Checking:"
printf '%s\n' "$assertion"
if ! diffoscope --no-progress --text-color=always --exclude-directory-metadata=no -- "$actual" "$expected"
if ! diffoscope --no-progress --text-color=always --exclude-directory-metadata="$excludeMetadata" -- "$actual" "$expected"
then
echo
echo 'Contents must be equal, but were not!'