NixOS/nixpkgs
1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 09:36:20 +09:00
Code Activity

doc: init Testing Hardware Features section with vwifi

Browse source
This commit is contained in:
Morgan Jones 2025-02-16 02:24:35 -08:00
parent a4371c50b3
commit 85fef808ad
No known key found for this signature in database
GPG key ID: 5C3EB94D198F1491
3 changed files with 171 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
nixos/doc/manual/development/nixos-tests.chapter.md
View file

@ -10,4 +10,5 @@ writing-nixos-tests.section.md
running-nixos-tests.section.md
running-nixos-tests-interactively.section.md
linking-nixos-tests-to-packages.section.md
testing-hardware-features.section.md
```

152
nixos/doc/manual/development/testing-hardware-features.section.md Normal file
View file

@ -0,0 +1,152 @@
# Testing Hardware Features {#sec-nixos-test-testing-hardware-features}
This section covers how to test various features using NixOS tests that would
normally only be possible with hardware. It is designed to showcase the NixOS test
framework's flexibility when combined with various hardware simulation libraries
or kernel modules.
## Wi-Fi {#sec-nixos-test-wifi}
Use `services.vwifi` to set up a virtual Wi-Fi physical layer. Create at least two nodes
for this kind of test: one with vwifi active, and either a station or an access point.
Give each a static IP address on the test network so they will never collide.
This module likely supports other topologies too; document them if you make one.
This NixOS module leverages [vwifi](https://github.com/Raizo62/vwifi). Read the
upstream repository's documentation for more information.
### vwifi server {#sec-nixos-test-wifi-vwifi-server}
This node runs the vwifi server, and otherwise does not interact with the network.
You can run `vwifi-ctrl` on this node to control characteristics of the simulated
physical layer.
```nix
airgap =
{ config, ... }:
{
networking.interfaces.eth1.ipv4.addresses = lib.mkForce [
{
address = "192.168.1.2";
prefixLength = 24;
}
];
services.vwifi = {
server = {
enable = true;
ports.tcp = 8212;
# uncomment if you want to enable monitor mode on another node
# ports.spy = 8213;
openFirewall = true;
};
};
};
```
### AP {#sec-nixos-test-wifi-ap}
A node like this will act as a wireless access point in infrastructure mode.
```nix
ap =
{ config, ... }:
{
networking.interfaces.eth1.ipv4.addresses = lib.mkForce [
{
address = "192.168.1.3";
prefixLength = 24;
}
];
services.hostapd = {
enable = true;
radios.wlan0 = {
channel = 1;
networks.wlan0 = {
ssid = "NixOS Test Wi-Fi Network";
authentication = {
mode = "wpa3-sae";
saePasswords = [ { password = "supersecret"; } ];
enableRecommendedPairwiseCiphers = true;
};
};
};
};
services.vwifi = {
module = {
enable = true;
macPrefix = "74:F8:F6:00:01";
};
client = {
enable = true;
serverAddress = "192.168.1.2";
};
};
};
```
### Station {#sec-nixos-test-wifi-station}
A node like this acts as a wireless client.
```nix
station =
{ config, ... }:
{
networking.interfaces.eth1.ipv4.addresses = lib.mkForce [
{
address = "192.168.1.3";
prefixLength = 24;
}
];
networking.wireless = {
# No, really, we want it enabled!
enable = lib.mkOverride 0 true;
interfaces = [ "wlan0" ];
networks = {
"NixOS Test Wi-Fi Network" = {
psk = "supersecret";
authProtocols = [ "SAE" ];
};
};
};
services.vwifi = {
module = {
enable = true;
macPrefix = "74:F8:F6:00:02";
};
client = {
enable = true;
serverAddress = "192.168.1.2";
};
};
};
```
### Monitor {#sec-nixos-test-wifi-monitor}
When the monitor mode interface is enabled, this node will receive
all packets broadcast by all other nodes through the spy interface.
```nix
monitor =
{ config, ... }:
{
networking.interfaces.eth1.ipv4.addresses = lib.mkForce [
{
address = "192.168.1.4";
prefixLength = 24;
}
];
services.vwifi = {
module = {
enable = true;
macPrefix = "74:F8:F6:00:03";
};
client = {
enable = true;
spy = true;
serverAddress = "192.168.1.2";
};
};
```

18
nixos/doc/manual/redirects.json
View file

@ -77,6 +77,21 @@
"sec-mattermost-plugins-build": [
"index.html#sec-mattermost-plugins-build"
],
"sec-nixos-test-wifi": [
"index.html#sec-nixos-test-wifi"
],
"sec-nixos-test-wifi-ap": [
"index.html#sec-nixos-test-wifi-ap"
],
"sec-nixos-test-wifi-monitor": [
"index.html#sec-nixos-test-wifi-monitor"
],
"sec-nixos-test-wifi-station": [
"index.html#sec-nixos-test-wifi-station"
],
"sec-nixos-test-wifi-vwifi-server": [
"index.html#sec-nixos-test-wifi-vwifi-server"
],
"sec-obtaining": [
"index.html#sec-obtaining"
],
@ -1895,6 +1910,9 @@
"sec-linking-nixos-tests-to-packages": [
"index.html#sec-linking-nixos-tests-to-packages"
],
"sec-nixos-test-testing-hardware-features": [
"index.html#sec-nixos-test-testing-hardware-features"
],
"chap-developing-the-test-driver": [
"index.html#chap-developing-the-test-driver"
],