From 9cd9e240e09ad10dd22eb8a681983460a080bb80 Mon Sep 17 00:00:00 2001
From: Sander van der Burg <svanderburg@gmail.com>
Date: Thu, 4 Feb 2021 19:56:45 +0100
Subject: [PATCH] Introduce NIXPROC_PROCESS environment variable to more easily
 rebuild the same configuration

---
 tools/bsdrc/nixproc-bsdrc-switch.in             |  6 +++---
 tools/common/nixproc-build.in                   | 17 +++++++++++------
 tools/commonchecks                              | 13 ++++++++++++-
 tools/cygrunsrv/nixproc-cygrunsrv-switch.in     |  6 +++---
 tools/disnix/nixproc-disnix-switch.in           |  6 +++---
 tools/docker/nixproc-docker-switch.in           |  6 +++---
 tools/idassign/nixproc-id-assign.in             |  9 +++++++--
 tools/launchd/nixproc-launchd-switch.in         |  4 ++--
 tools/s6-rc/nixproc-s6-rc-switch.in             |  4 ++--
 .../nixproc-supervisord-deploy-stateless.in     |  6 ++++--
 tools/supervisord/nixproc-supervisord-switch.in |  4 ++--
 tools/systemd/nixproc-systemd-switch.in         |  4 ++--
 tools/sysvinit/nixproc-sysvinit-switch.in       |  6 +++---
 13 files changed, 57 insertions(+), 34 deletions(-)

diff --git a/tools/bsdrc/nixproc-bsdrc-switch.in b/tools/bsdrc/nixproc-bsdrc-switch.in
index 915ec0f..4a080a3 100644
--- a/tools/bsdrc/nixproc-bsdrc-switch.in
+++ b/tools/bsdrc/nixproc-bsdrc-switch.in
@@ -7,7 +7,7 @@ shopt -s nullglob
 showUsage()
 {
     cat <<EOF
-Usage: $0 [OPTION] PATH
+Usage: $0 [OPTION] [PATH]
   or: $0 --undeploy [OPTION]
   or: $0 --rollback [OPTION]
   or: $0 --switch-generation NUM [OPTION]
@@ -63,6 +63,7 @@ Environment:
   NIX_STATE_DIR        Overrides the location of the Nix state directory
   BSDRC_TARGET_DIR     Directory in which the BSD rc scripts reside (defaults to:
                        /usr/local/etc/rc.d)
+  NIXPROC_PROCESSES    Path to a processes model
   NIXPROC_STATE_DIR    Changes the directory in which the state of the
                        processes is stored
   NIXPROC_RUNTIME_DIR  Changes the directory in which the PID files are stored
@@ -158,12 +159,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/common/nixproc-build.in b/tools/common/nixproc-build.in
index fc42d6f..ab17c5d 100644
--- a/tools/common/nixproc-build.in
+++ b/tools/common/nixproc-build.in
@@ -5,7 +5,7 @@
 showUsage()
 {
     cat <<EOF
-Usage: $0 [OPTION] PATH
+Usage: $0 [OPTION] [PATH]
   or: $0 --undeploy [OPTION]
 
 This command builds a Nix profile containing multiple sysvinit scripts, and
@@ -32,6 +32,7 @@ Options:
   -h, --help          Shows the usage of this command
 
 Environment:
+  NIXPROC_PROCESSES    Path to a processes model
   NIXPROC_STATE_DIR    Changes the directory in which the state of the
                        processes is stored
   NIXPROC_RUNTIME_DIR  Changes the directory in which the PID files are stored
@@ -115,17 +116,21 @@ else
     processManagerArg="--argstr processManager $processManager"
 fi
 
-if [ "$1" = "" ]
+if [ "$undeploy" = "1" ]
 then
-    if [ "$undeploy" = "1" ]
+    exprFileArg="--arg exprFile null"
+else
+    if [ "$1" != "" ]
     then
-        exprFileArg="--arg exprFile null"
+        exprFile="$(@readlink@ -f "$1")"
+    elif [ "$NIXPROC_PROCESSES" != "" ]
+    then
+        exprFile="$(@readlink@ -f "$NIXPROC_PROCESSES")"
     else
         echo "No processes expression provided!" >&2
         exit 1
     fi
-else
-    exprFile="$(@readlink@ -f "$1")"
+
     exprFileArg="--argstr exprFile $exprFile"
 fi
 
diff --git a/tools/commonchecks b/tools/commonchecks
index 157b9c8..318383c 100644
--- a/tools/commonchecks
+++ b/tools/commonchecks
@@ -24,6 +24,17 @@ checkProfile()
     profile=${profile:-processes}
 }
 
+checkProcessesFile()
+{
+    if [ "$1" != "" ]
+    then
+        processesFile="$1"
+    elif [ "$NIXPROC_PROCESSES" != "" ]
+    then
+        processesFile="$NIXPROC_PROCESSES"
+    fi
+}
+
 buildProfile()
 {
     local processManager="$1"
@@ -32,7 +43,7 @@ buildProfile()
     then
         local deployArg="--undeploy"
     else
-        local deployArg="$path"
+        local deployArg="$processesFile"
     fi
 
     profilePath=$(nixproc-build --process-manager $processManager $stateDirArg $runtimeDirArg $logDirArg $tmpDirArg $cacheDirArg $forceDisableUserChangeArg $showTraceArg "${extraParamsArg[@]}" --no-out-link $deployArg)
diff --git a/tools/cygrunsrv/nixproc-cygrunsrv-switch.in b/tools/cygrunsrv/nixproc-cygrunsrv-switch.in
index 57dde39..77675a2 100644
--- a/tools/cygrunsrv/nixproc-cygrunsrv-switch.in
+++ b/tools/cygrunsrv/nixproc-cygrunsrv-switch.in
@@ -5,7 +5,7 @@ shopt -s nullglob
 showUsage()
 {
     cat <<EOF
-Usage: $0 [OPTION] PATH
+Usage: $0 [OPTION] [PATH]
   or: $0 --undeploy [OPTION]
   or: $0 --rollback [OPTION]
   or: $0 --switch-generation NUM [OPTION]
@@ -52,6 +52,7 @@ Options:
 
 Environment:
   NIX_STATE_DIR         Overrides the location of the Nix state directory
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -144,12 +145,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/disnix/nixproc-disnix-switch.in b/tools/disnix/nixproc-disnix-switch.in
index c63d3c4..2d03ef3 100644
--- a/tools/disnix/nixproc-disnix-switch.in
+++ b/tools/disnix/nixproc-disnix-switch.in
@@ -3,7 +3,7 @@
 showUsage()
 {
     cat <<EOF
-Usage: $0 [OPTION] PATH
+Usage: $0 [OPTION] [PATH]
   or: $0 --undeploy [OPTION]
   or: $0 --rollback [OPTION]
   or: $0 --switch-generation NUM [OPTION]
@@ -51,6 +51,7 @@ Options:
 
 Environment:
   NIX_STATE_DIR         Overrides the location of the Nix state directory
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -141,12 +142,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 
diff --git a/tools/docker/nixproc-docker-switch.in b/tools/docker/nixproc-docker-switch.in
index 9ff123d..6df0def 100644
--- a/tools/docker/nixproc-docker-switch.in
+++ b/tools/docker/nixproc-docker-switch.in
@@ -5,7 +5,7 @@ shopt -s nullglob
 showUsage()
 {
     cat <<EOF
-Usage: $0 [OPTION] PATH
+Usage: $0 [OPTION] [PATH]
   or: $0 --undeploy [OPTION]
   or: $0 --rollback [OPTION]
   or: $0 --switch-generation NUM [OPTION]
@@ -55,6 +55,7 @@ Environment:
   NIX_STATE_DIR         Overrides the location of the Nix state directory
   SYSTEMD_TARGET_DIR    Directory in which the unit configuration files are
                         managed (defaults to: /etc/systemd/system)
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -148,12 +149,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/idassign/nixproc-id-assign.in b/tools/idassign/nixproc-id-assign.in
index 3491f46..a9406cd 100644
--- a/tools/idassign/nixproc-id-assign.in
+++ b/tools/idassign/nixproc-id-assign.in
@@ -8,8 +8,9 @@ showUsage()
 Assigns unique IDs to process instances based on their ID requirements and ID
 resources configuration.
 
-Usage: $0 [OPTION] --id-resources id_resources_nix PATH
+Usage: $0 [OPTION] --id-resources id_resources_nix [PATH]
 
+Options:
       --id-resources=id_resources_nix
                       ID resources Nix expression defining numeric ID resources
       --ids=ids_nix   IDs Nix expression mapping services to unique IDs per
@@ -34,6 +35,7 @@ Usage: $0 [OPTION] --id-resources id_resources_nix PATH
   -h, --help          Shows the usage of this command to the user
 
 Environment:
+  NIXPROC_PROCESSES    Path to a processes model
   NIXPROC_STATE_DIR    Changes the directory in which the state of the
                        processes is stored
   NIXPROC_RUNTIME_DIR  Changes the directory in which the PID files are stored
@@ -111,13 +113,16 @@ processesFile="$1"
 
 # Validate the given options
 
+source @commonchecks@
+
+checkProcessesFile "$1"
+
 if [ "$idResourcesFile" = "" ]
 then
     echo "An ID resources configuration must be provided!" >&2
     exit 1
 fi
 
-
 if [ "$processesFile" = "" ]
 then
     echo "A processes Nix expression must be provided!" >&2
diff --git a/tools/launchd/nixproc-launchd-switch.in b/tools/launchd/nixproc-launchd-switch.in
index f34df54..4f70bd6 100644
--- a/tools/launchd/nixproc-launchd-switch.in
+++ b/tools/launchd/nixproc-launchd-switch.in
@@ -55,6 +55,7 @@ Environment:
   NIX_STATE_DIR         Overrides the location of the Nix state directory
   LAUNCHD_TARGET_DIR    Directory in which the plist configuration files are
                         managed (defaults to: /Library/LaunchDaemons)
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -147,12 +148,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/s6-rc/nixproc-s6-rc-switch.in b/tools/s6-rc/nixproc-s6-rc-switch.in
index 3f3998e..8b4bd34 100644
--- a/tools/s6-rc/nixproc-s6-rc-switch.in
+++ b/tools/s6-rc/nixproc-s6-rc-switch.in
@@ -50,6 +50,7 @@ Options:
 
 Environment:
   NIX_STATE_DIR         Overrides the location of the Nix state directory
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -142,12 +143,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/supervisord/nixproc-supervisord-deploy-stateless.in b/tools/supervisord/nixproc-supervisord-deploy-stateless.in
index 8c6f2ca..26440c3 100644
--- a/tools/supervisord/nixproc-supervisord-deploy-stateless.in
+++ b/tools/supervisord/nixproc-supervisord-deploy-stateless.in
@@ -93,10 +93,12 @@ done
 
 shift
 
-path="$1"
+source @commonchecks@
+
+checkProcessesFile "$1"
 
 # Build the environment with supervisord config files
-profilePath=$(nixproc-build --process-manager supervisord $stateDirArg $runtimeDirArg $logDirArg $tmpDirArg $cacheDirArg $forceDisableUserChangeArg $showTraceArg "${extraParamsArg[@]}" --no-out-link "$path")
+profilePath=$(nixproc-build --process-manager supervisord $stateDirArg $runtimeDirArg $logDirArg $tmpDirArg $cacheDirArg $forceDisableUserChangeArg $showTraceArg "${extraParamsArg[@]}" --no-out-link "$processesFile")
 
 # Initialize all state
 nixproc-init-state $stateDirArg $runtimeDirArg $logDirArg $tmpDirArg $cacheDirArg $forceDisableUserChangeArg
diff --git a/tools/supervisord/nixproc-supervisord-switch.in b/tools/supervisord/nixproc-supervisord-switch.in
index f0e024a..9a30c08 100644
--- a/tools/supervisord/nixproc-supervisord-switch.in
+++ b/tools/supervisord/nixproc-supervisord-switch.in
@@ -58,6 +58,7 @@ Options:
 Environment:
   NIX_STATE_DIR         Overrides the location of the Nix state directory
   SUPERVISORD_CONF_DIR  Directory if which the supervisord.conf resides
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -150,12 +151,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/systemd/nixproc-systemd-switch.in b/tools/systemd/nixproc-systemd-switch.in
index b41dab3..b448c58 100644
--- a/tools/systemd/nixproc-systemd-switch.in
+++ b/tools/systemd/nixproc-systemd-switch.in
@@ -57,6 +57,7 @@ Environment:
   SYSTEMD_TARGET_DIR    Directory in which the unit configuration files are
                         managed (defaults to: /etc/systemd/system or
                         ~/.config/systemd/user)
+  NIXPROC_PROCESSES     Path to a processes model
   NIXPROC_STATE_DIR     Changes the directory in which the state of the
                         processes is stored
   NIXPROC_RUNTIME_DIR   Changes the directory in which the PID files are stored
@@ -152,12 +153,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir
diff --git a/tools/sysvinit/nixproc-sysvinit-switch.in b/tools/sysvinit/nixproc-sysvinit-switch.in
index 3e03665..89623e0 100644
--- a/tools/sysvinit/nixproc-sysvinit-switch.in
+++ b/tools/sysvinit/nixproc-sysvinit-switch.in
@@ -7,7 +7,7 @@ shopt -s nullglob
 showUsage()
 {
     cat <<EOF
-Usage: $0 [OPTION] PATH
+Usage: $0 [OPTION] [PATH]
   or: $0 --undeploy [OPTION]
   or: $0 --rollback [OPTION]
   or: $0 --switch-generation NUM [OPTION]
@@ -61,6 +61,7 @@ Options:
 
 Environment:
   NIX_STATE_DIR        Overrides the location of the Nix state directory
+  NIXPROC_PROCESSES    Path to a processes model
   NIXPROC_STATE_DIR    Changes the directory in which the state of the
                        processes is stored
   NIXPROC_RUNTIME_DIR  Changes the directory in which the PID files are stored
@@ -155,12 +156,11 @@ done
 
 shift
 
-path="$1"
-
 # Validate the given options
 
 source @commonchecks@
 
+checkProcessesFile "$1"
 checkNixStateDir
 checkProfile
 composeProfileBaseDir