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

nixos/activation: improve preSwitchChecks #375961

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

r-vdp
Copy link
Contributor

@r-vdp r-vdp commented Jan 23, 2025

Things done

A couple of improvements:

  1. Avoid the generally discouraged apply argument to options, as it has quite weird semantics
  2. Avoid issues when a user calls a preSwitchCheck script, which would've been silently overridden by the existing implementation.
    Reliance on a special attribute name like that is bound to lead to a very-hard-to-debug problem for someone at some point
  3. Use writeShellApplication so that the preSwitchChecks are checked by shellcheck and and so that they run with basic bash guardrails
  4. Fix shellcheck issue (testing the value of $?)
  5. Add a positive preSwitchCheck to the nixos test, to make sure that that works as intended
  • 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.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Jan 23, 2025
@r-vdp r-vdp requested a review from jmbaur January 23, 2025 00:50
@r-vdp
Copy link
Contributor Author

r-vdp commented Jan 23, 2025

@ofborg test switchTest switchTestNg

A couple of improvements:

1. Avoid the generally discouraged apply argument to options, as it has
   quite weird semantics
2. Avoid issues when a user calls a preSwitchCheck `script`, which
   would've been silently overridden by the existing implementation.
   Reliance on a special attribute name like that is bound to lead to a
   very-hard-to-debug problem for someone at some point
3. Use writeShellApplication so that the preSwitchChecks are checked by
   shellcheck and and so that they run with basic bash guardrails
4. Fix shellcheck issue (testing the value of $?)
5. Add a positive preSwitchCheck to the nixos test, to make sure that
   that works as intended
@r-vdp r-vdp force-pushed the rvdp/pre-switch-checks branch from 5c21baa to c120205 Compare January 23, 2025 00:51
@r-vdp
Copy link
Contributor Author

r-vdp commented Jan 23, 2025

@ofborg test switchTest switchTestNg

Copy link
Contributor

@jmbaur jmbaur left a comment

Choose a reason for hiding this comment

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

Thank you! This is a great QOL improvement!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants