movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 19:13:26 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/test-driver: exit early if /dev/vhost-vsock isn't available

Browse source 
Right now it wrongly seems as if you can set
`sshBackdoor.enable = true;` for each test and not only for debugging
purposes.

This is wrong however since you'd need to pass /dev/vhost-vsock into the
sandbox for this (which is also a prerequisite for #392117).

To make that clear, two things were changed:

* add a warning to the manual to communicate this.
* exit both interactive and non-interactive driver early if
  /dev/vhost-vsock is missing and the ssh backdoor is enabled.

  If that's the case, we pass a CLI flag to the driver already in the
  interactive case. This change also sets the flag for the
  non-interactive case.

  That way we also get a better error if somebody tries to enable this
  on a system that doesn't support that.
This commit is contained in:
Maximilian Bosch 2025-05-12 15:27:24 +02:00
parent 079ead620a
commit c6978e8a58
No known key found for this signature in database
2 changed files with 28 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

11
nixos/doc/manual/development/running-nixos-tests-interactively.section.md
View file

@ -71,10 +71,19 @@ An SSH-based backdoor to log into machines can be enabled with
{ {
name = "…"; name = "…";
nodes.machines = { /* … */ }; nodes.machines = { /* … */ };
sshBackdoor.enable = true; interactive.sshBackdoor.enable = true;
} }
``` ```
::: {.warning}
Make sure to only enable the backdoor for interactive tests
(i.e. by using `interactive.sshBackdoor.enable`)! This is the only
supported configuration.
Running a test in a sandbox with this will fail because `/dev/vhost-vsock` isn't available
in the sandbox.
:::
This creates a [vsock socket](https://man7.org/linux/man-pages/man7/vsock.7.html) This creates a [vsock socket](https://man7.org/linux/man-pages/man7/vsock.7.html)
for each VM to log in with SSH. This configures root login with an empty password. for each VM to log in with SSH. This configures root login with an empty password.

33
nixos/lib/testing/run.nix
View file

@ -43,27 +43,30 @@ in
}; };
config = { config = {
rawTestDerivation = hostPkgs.stdenv.mkDerivation { rawTestDerivation =
name = "vm-test-run-${config.name}"; assert lib.assertMsg (!config.sshBackdoor.enable)
"The SSH backdoor is currently not supported for non-interactive testing! Please make sure to only set `interactive.sshBackdoor.enable = true;`!";
hostPkgs.stdenv.mkDerivation {
name = "vm-test-run-${config.name}";
requiredSystemFeatures = requiredSystemFeatures =
[ "nixos-test" ] [ "nixos-test" ]
++ lib.optionals hostPkgs.stdenv.hostPlatform.isLinux [ "kvm" ] ++ lib.optionals hostPkgs.stdenv.hostPlatform.isLinux [ "kvm" ]
++ lib.optionals hostPkgs.stdenv.hostPlatform.isDarwin [ "apple-virt" ]; ++ lib.optionals hostPkgs.stdenv.hostPlatform.isDarwin [ "apple-virt" ];
buildCommand = '' buildCommand = ''
mkdir -p $out mkdir -p $out
# effectively mute the XMLLogger # effectively mute the XMLLogger
export LOGFILE=/dev/null export LOGFILE=/dev/null
${config.driver}/bin/nixos-test-driver -o $out ${config.driver}/bin/nixos-test-driver -o $out
''; '';
passthru = config.passthru; passthru = config.passthru;
meta = config.meta; meta = config.meta;
}; };
test = lib.lazyDerivation { test = lib.lazyDerivation {
# lazyDerivation improves performance when only passthru items and/or meta are used. # lazyDerivation improves performance when only passthru items and/or meta are used.
derivation = config.rawTestDerivation; derivation = config.rawTestDerivation;