Merge pull request 'feat(ci): shell-customization' (#32) from lbailly/liminix:shell-customization into main

Reviewed-on: #32

.forgejo/workflows/build.yaml

@@ -17,4 +17,34 @@ jobs:
       - name: Build VM QEMU MIPS
         run: |
           # Enter the shell
-          nix-build -I liminix-config=./examples/hello-from-qemu.nix --arg device "import ./devices/qemu" -A outputs.default
+          nix-build ci.nix -A qemu
+
+  build_zyxel-nwa50ax_mips:
+    runs-on: nix
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build VM QEMU MIPS
+        run: |
+          # Enter the shell
+          nix-build ci.nix -A qemu
+
+  test_hostapd:
+    runs-on: nix
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build VM QEMU MIPS
+        run: |
+          # Enter the shell
+          nix-build ci.nix -A wlan
+
+  test_shell_customization:
+    runs-on: nix
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build VM QEMU MIPS
+        run: |
+          # Enter the shell
+          nix-build ci.nix -A custom-shell

ci.nix

@@ -7,7 +7,7 @@
 let
   pkgs = (import nixpkgs { });
   borderVmConf =  ./bordervm.conf-example.nix;
-  inherit (pkgs.lib.attrsets) genAttrs;
+  inherit (pkgs.lib.attrsets) genAttrs mapAttrs;
   devices = [
     "qemu"
     "zyxel-nwa50ax"
@@ -19,7 +19,7 @@ let
       device = import (liminix + "/devices/${name}");
       liminix-config = vanilla;
     }).outputs.default;
-  tests = import ./tests/ci.nix;
+  tests = mapAttrs (_: v: v { inherit liminix nixpkgs; }) (import ./tests/ci.nix);
   jobs =
     (genAttrs devices for-device) //
     tests //

default.nix

@@ -26,9 +26,13 @@ let
   eval = evalModules {
     modules = [
       {
-        nixpkgs.overlays = [
-          overlay
-        ];
+        nixpkgs = {
+          source = nixpkgs;
+          overlays = [ overlay ];
+          config.permittedInsecurePackages = [
+            "python-2.7.18.8"
+          ];
+        };
       }
       device.module
       liminix-config

modules/base.nix

@@ -4,11 +4,13 @@
 
 { lib, pkgs, config, ...}:
 let
-  inherit (lib) mkEnableOption mkOption types isDerivation hasAttr ;
+  inherit (lib) mkEnableOption mkOption types isDerivation hasAttr concatStringsSep mapAttrsToList;
   inherit (pkgs.pseudofile) dir symlink;
   inherit (pkgs.liminix.networking) address interface;
   inherit (pkgs.liminix.services) bundle;
 
+  # TODO: escape shell argument.
+  exportVar = name: value: "export ${name}=\"${value}\"";
   type_service = pkgs.liminix.lib.types.service;
 
 in {
@@ -22,6 +24,24 @@ in {
           /run/current-system, we just add the paths in /etc/profile
         '';
       };
+
+      environmentVariables = mkOption {
+        type = types.attrsOf types.str;
+        description = ''
+          Attribute set of environment variables to make available
+          in a login shell.
+
+          The value is assumed to be escaped and the name to be valid.
+        '';
+      };
+
+      prompt = mkOption {
+        type = types.str;
+        default = "$(whoami)@$(hostname) # ";
+        description = ''
+          Prompt string (PS1) for the shell.
+        '';
+      };
     };
     services = mkOption {
       type = types.attrsOf type_service;
@@ -111,6 +131,8 @@ in {
 
     defaultProfile.packages = with pkgs;
       [ s6 s6-init-bin execline s6-linux-init s6-rc ];
+    # Set the useful PS1 prompt by default.
+    defaultProfile.environmentVariables.PS1 = lib.mkDefault config.defaultProfile.prompt;
 
     boot.commandLine = [
       "panic=10 oops=panic init=/bin/init loglevel=8"
@@ -181,9 +203,10 @@ in {
       etc = let
         profile = symlink
           (pkgs.writeScript ".profile" ''
-           PATH=${lib.makeBinPath config.defaultProfile.packages}:/bin
+            PATH=${lib.makeBinPath config.defaultProfile.packages}:/bin
             export PATH
-            '');
+            ${concatStringsSep "\n" (mapAttrsToList exportVar config.defaultProfile.environmentVariables)}
+          '');
       in dir {
         inherit profile;
         ashrc = profile;

modules/hostname.nix

@@ -1,7 +1,6 @@
 { lib, pkgs, config, ...}:
 let
   inherit (lib) mkOption types;
-  inherit (pkgs.liminix.services) oneshot;
 in {
   options = {
     hostname = mkOption {
@@ -12,12 +11,21 @@ in {
       default = "liminix";
       type = types.nonEmptyStr;
     };
-  };
-  config = {
-    services.hostname = oneshot {
-      name = "hostname-${builtins.substring 0 12 (builtins.hashString "sha256" config.hostname)}";
-      up = "echo ${config.hostname} > /proc/sys/kernel/hostname";
-      down = "true";
+    hostname-script = mkOption {
+      description = ''
+        Script that outputs the system hostname on stdin.
+      '';
+      default = pkgs.writeScript "hostname-gen" ''
+        #!/bin/sh
+        echo ${config.hostname}
+      '';
+      defaultText = ''
+        pkgs.writeScript "hostname-gen" '''
+        #!/bin/sh
+        echo ''${config.hostname}
+      '''
+      '';
+      type = types.package;
     };
   };
 }

modules/s6/default.nix

@@ -30,6 +30,8 @@ let
     installPhase = ''
       mkdir $out
       cp -r $src $out/scripts
+      substituteInPlace $out/scripts/rc.init \
+        --replace-fail 'config.hostname' "${config.hostname-script}"
       chmod -R +w $out
     '';
   };

modules/s6/scripts/rc.init

@@ -36,6 +36,7 @@ fi
 ### (replace /run/service with your scandir)
 s6-rc-init -d -c /etc/s6-rc/compiled /run/service
 
+config.hostname > /proc/sys/kernel/hostname
 
 ### 2. Starting the wanted set of services
 ### This is also called every time you change runlevels with telinit.

overlay.nix

@@ -194,7 +194,11 @@ extraPkgs // {
     });
   in h.override { openssl = null; sqlite = null; };
 
-
+  wpa_supplicant = prev.wpa_supplicant.override {
+    dbusSupport = false;
+    withPcsclite = false;
+    wpa_supplicant_gui = null;
+  };
 
   kexec-tools-static = prev.kexec-tools.overrideAttrs(o: {
     # For kexecboot we copy kexec into a ramdisk on the system being

tests/ci.nix

@@ -10,4 +10,5 @@
   tftpboot = import ./tftpboot/test.nix;
   updown = import ./updown/test.nix;
   inout = import ./inout/test.nix;
+  custom-shell = import ./custom-shell/test.nix;
 }

tests/custom-shell/check-prompt.expect

@@ -0,0 +1,7 @@
+set timeout 60
+
+spawn socat unix-connect:vm/console -
+expect {
+  "root@liminix blah blah > " { exit 0 }
+  timeout { exit 1 }
+}

tests/custom-shell/configuration.nix

@@ -0,0 +1,13 @@
+{ config, pkgs, lib, ... } :
+let
+  inherit (pkgs.liminix.networking) interface address hostapd route dnsmasq;
+  inherit (pkgs.liminix.services) oneshot longrun bundle target;
+in rec {
+  imports = [
+    ../../modules/network
+  ];
+
+  defaultProfile.prompt = "$(whoami)@$(hostname) blah blah > ";
+
+  defaultProfile.packages = with pkgs; [ ];
+}

tests/custom-shell/test.nix

@@ -0,0 +1,21 @@
+{
+  liminix
+, nixpkgs
+}:
+let img = (import liminix {
+      inherit nixpkgs;
+      device = import "${liminix}/devices/qemu/";
+      liminix-config = ./configuration.nix;
+    }).outputs.default;
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
+in pkgs.runCommand "check" {
+  nativeBuildInputs = with pkgs; [
+    expect socat
+  ] ;
+} ''
+. ${../test-helpers.sh}
+
+mkdir vm
+${img}/run.sh --background ./vm
+expect ${./check-prompt.expect} |tee output && mv output $out
+''

tests/ext4/test.nix

@@ -6,7 +6,7 @@ let img = (import liminix {
       device = import "${liminix}/devices/qemu/";
       liminix-config = ./configuration.nix;
     }).outputs.vmroot;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [
     expect

tests/fennel/test.nix

@@ -4,7 +4,7 @@
 }:
 let
   overlay = import "${liminix}/overlay.nix";
-  pkgs = import <nixpkgs> { overlays = [overlay]; };
+  pkgs = import nixpkgs { overlays = [overlay]; };
   script = pkgs.writeFennelScript "foo" [] ./hello.fnl;
   inherit (pkgs.lua.pkgs) fifo;
   netlink = pkgs.netlink-lua;

tests/inout/test.nix

@@ -6,7 +6,7 @@ let img = (import liminix {
       device = import "${liminix}/devices/qemu/";
       liminix-config = ./configuration.nix;
     }).outputs.vmroot;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [
     expect

tests/jffs2/configuration.nix

@@ -5,7 +5,6 @@ in {
   imports = [
     ../../vanilla-configuration.nix
     ../../modules/squashfs.nix
-    ../../modules/outputs/jffs2.nix
   ];
   config.rootfsType = "jffs2";
   config.filesystem = dir {

tests/jffs2/test.nix

@@ -6,7 +6,7 @@ let img = (import liminix {
       device = import "${liminix}/devices/qemu/";
       liminix-config = ./configuration.nix;
     }).outputs.vmroot;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [
     expect

tests/min-copy-closure/configuration.nix

@@ -13,7 +13,6 @@ let
 in {
   imports = [
     ../../vanilla-configuration.nix
-    ../../modules/outputs/jffs2.nix
   ];
   config =  {
     services.sshd = longrun {

tests/min-copy-closure/test.nix

@@ -8,7 +8,7 @@ let lmx = (import liminix {
     });
     rogue = lmx.pkgs.rogue;
     img = lmx.outputs.vmroot;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [
     expect

tests/pppoe/test.nix

@@ -6,7 +6,7 @@ let img = (import liminix {
       device = import "${liminix}/devices/qemu";
       liminix-config = ./configuration.nix;
     }).outputs.default;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
     inherit (pkgs.pkgsBuildBuild) routeros;
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [

tests/tftpboot/test.nix

@@ -1,5 +1,6 @@
 {
-  liminix
+  liminix,
+  ...
 }:
 let check = deviceName  : config :
 let derivation = (import liminix {

tests/updown/test.nix

@@ -6,7 +6,7 @@ let img = (import liminix {
       device = import "${liminix}/devices/qemu/";
       liminix-config = ./configuration.nix;
     }).outputs.vmroot;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [
     expect

tests/wlan/configuration.nix

@@ -7,6 +7,7 @@ in rec {
     ../../modules/wlan.nix
     ../../modules/hostapd
     ../../modules/network
+    ./wpa_supplicant.nix
   ];
 
   services.hostap = config.system.service.hostapd.build {
@@ -27,5 +28,21 @@ in rec {
     };
   };
 
-  defaultProfile.packages = with pkgs;  [ tcpdump ] ;
+  services.wpa_supplicant = config.system.service.wpa_supplicant.build {
+    interface = "wlan1";
+    driver = "nl80211";
+    config-file = pkgs.writeText "wpa_supplicant.conf" ''
+      country=us
+      update_config=1
+      ctrl_interface=/run/wpa_supplicant
+
+      network={
+       scan_ssid=1
+       ssid="liminix"
+       psk="colourless green ideas"
+      }
+    '';
+  };
+
+  defaultProfile.packages = with pkgs; [ tcpdump wpa_supplicant ];
 }

tests/wlan/test.nix

@@ -3,10 +3,11 @@
 , nixpkgs
 }:
 let img = (import liminix {
-      device = import "${liminix}/devices/qemu-armv7l/";
+      inherit nixpkgs;
+      device = import "${liminix}/devices/qemu/";
       liminix-config = ./configuration.nix;
     }).outputs.default;
-    pkgs = import <nixpkgs> { overlays = [(import ../../overlay.nix)]; };
+    pkgs = import nixpkgs { overlays = [(import ../../overlay.nix)]; };
 in pkgs.runCommand "check" {
   nativeBuildInputs = with pkgs; [
     expect socat

tests/wlan/wait-for-wlan.expect

@@ -14,10 +14,10 @@ expect {
 }
 expect "#"
 while { $FINISHED < 10 } {
-  send "date && grep AP-ENABLED /run/uncaught-logs/* || echo \$NOT\r\n"
+  send "date && grep CTRL-EVENT-CONNECTED /run/uncaught-logs/* || echo \$NOT\r\n"
   
   expect {
-    "wlan0: AP-ENABLED" { set FINISHED 999; set EXIT 0; }
+    "wlan1: CTRL-EVENT-CONNECTED" { set FINISHED 999; set EXIT 0; }
     "not_present" { send_user "waiting ...\n" ; sleep 5 }
   }
   set FINISHED [ expr $FINISHED + 1 ]

tests/wlan/wpa_service.nix

@@ -0,0 +1,21 @@
+{
+  liminix,
+  wpa_supplicant,
+  lib,
+}:
+{
+  interface,
+  driver,
+  config-file,
+}:
+let
+  inherit (liminix.services) longrun;
+  inherit (lib.strings) escapeShellArg;
+in
+longrun {
+  name = "wpa_supplicant";
+  run =
+  ''
+    ${wpa_supplicant}/bin/wpa_supplicant -D${driver} -i${interface} -c ${config-file}
+  '';
+}

tests/wlan/wpa_supplicant.nix

@@ -0,0 +1,15 @@
+{ config, lib, pkgs, ... }:
+with lib; {
+  options.system.service.wpa_supplicant = mkOption { type = pkgs.liminix.lib.types.serviceDefn; };
+  config.system.service.wpa_supplicant = config.system.callService ./wpa_service.nix {
+    interface = mkOption {
+      type = types.str;
+    };
+    driver = mkOption {
+      type = types.str;
+    };
+    config-file = mkOption {
+      type = types.package;
+    };
+  };
+}