Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

no-broken-symlinks: restrict checks to symlinks pointing inside the store #376261

Conversation

ConnorBaker
Copy link
Contributor

@ConnorBaker ConnorBaker commented Jan 24, 2025

Followup for #370750.

Given some packages purposefully create symlinks which point out of the store, it makes sense to skip them in the check rather than error or warn because the hooks is limited to sandbox.

The two additional tests I've added succeed, and systemdMinimal succeeds without disabling the hook (like in #376218, which I have closed).

This PR additionally fixes the flags passed to ln when the absolute option is provided in the tests -- previously, passing a value of true for absolute would create a relative symlink! Thank you @emilazy for spotting that!

This issue wasn't caught by the tests because they would need to build with NIX_DEBUG set to a high value and grep for a logging statement, since the hook canonicalizes relative symlinks to absolute paths when evaluating them, and the only difference in code-path is a single logging statement.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

Copy link
Member

@emilazy emilazy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo comments. Are there any fixes for this we should revert after?

pkgs/test/stdenv/no-broken-symlinks.nix Outdated Show resolved Hide resolved
@ConnorBaker
Copy link
Contributor Author

LGTM modulo comments. Are there any fixes for this we should revert after?

No fixes that I'm aware of; nothing has been merged except the main PR introducing the hook, so no quick hacks to revert yet :)

Copy link
Member

@emilazy emilazy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

One fix would have been to rename absolute to relative with no other changes 😂

@ConnorBaker ConnorBaker merged commit b52c272 into NixOS:staging Jan 25, 2025
41 of 43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants