From e74407c674ef6e7d93166e5e2f0d956db1c3e2c9 Mon Sep 17 00:00:00 2001
From: Andre <andre@8bitbuddhism.com>
Date: Mon, 30 Sep 2024 09:33:15 -0400
Subject: [PATCH] Chore: logic improvements for nixos-rebuild script

---
 bin/nixos-upgrade-script.sh | 56 ++++++++++++++++++++++++-------------
 1 file changed, 37 insertions(+), 19 deletions(-)

diff --git a/bin/nixos-upgrade-script.sh b/bin/nixos-upgrade-script.sh
index 9e9f9dc..53cae22 100755
--- a/bin/nixos-upgrade-script.sh
+++ b/bin/nixos-upgrade-script.sh
@@ -4,23 +4,36 @@
 # Configuration parameters
 operation="switch"		# The nixos-rebuild operation to use
 hostname=$(hostname)	# The name of the host to build
-flakeDir="."			# Path to the flake file (and optionally the hostname)
+flakeDir="${FLAKE_DIR}"	# Path to the flake file (and optionally the hostname). Defaults to the FLAKE_DIR environment variable.
 remainingArgs=""		# All remaining arguments that haven't been processed
-commit=true				# Whether to update git (true by default)
+update=true				# Whether to update git (true by default)
+user=$(whoami)		    # Which user account to use for git commands.
 
 function usage() {
-	echo "Usage: nixos-upgrade-script.sh [-o|--operation operation] [-f|--flake path-to-flake-file] [extra nixos-rebuild parameters]"
+	echo "nixos-rebuild Operations Script (NOS) updates your system and your flake.lock file by pulling the latest versions."
+	echo ""
+	echo "Running the script with no parameters performs the following operations:"
+	echo "  1. Pull the latest version of the config"
+	echo "  2. Update your flake.lock file"
+	echo "  3. Commit any changes back to the repository"
+	echo "  4. Run 'nixos-rebuild switch'."
+	echo ""
+	echo "Advanced usage: nixos-upgrade-script.sh [-o|--operation operation] [-f|--flake path-to-flake] [extra nixos-rebuild parameters]"
 	echo "Options:"
-	echo "	-h | --help	Show this help screen."
-	echo "	-o | --operation	The nixos-rebuild operation to perform."
-	echo "  -f | --flake <path>	The path to the flake file."
-	echo "  -n | --no-commit Don't update and commit the lock file."
+	echo " -h, --help          Show this help screen."
+	echo " -o, --operation     The nixos-rebuild operation to perform."
+	echo " -f, --flake <path>  The path to your flake.nix file (and optionally, the hostname to build)."
+	echo " -n, --no-update     Don't update and commit the lock file."
+	echo " -u, --user          Which user account to run git commands under."
+	echo ""
 	exit 2
 }
 
 function run_operation {
-	echo "Running this operation: nixos-rebuild $1 --flake $flakeDir $remainingArgs --use-remote-sudo"
-	nixos-rebuild $operation --flake $flakeDir $remainingArgs --use-remote-sudo --log-format multiline-with-logs
+	options="--flake $flakeDir $remainingArgs --use-remote-sudo --log-format multiline-with-logs"
+	
+	echo "Running this operation: nixos-rebuild $1 $options"
+	nixos-rebuild $operation $options
 } 
 
 # Argument processing logic shamelessly stolen from https://stackoverflow.com/questions/192249/how-do-i-parse-command-line-arguments-in-bash
@@ -32,8 +45,8 @@ while [[ $# -gt 0 ]]; do
 		shift
 		shift
 		;;
-	--no-commit|-n)
-		commit=false
+	--no-update|-n)
+		update=false
 		shift
 		shift
 		;;
@@ -42,6 +55,11 @@ while [[ $# -gt 0 ]]; do
 		shift
 		shift
 		;;
+	--user|-u)
+		user="$2"
+		shift
+		shift
+		;;
 	--help|-h)
 		usage
 		shift
@@ -55,22 +73,22 @@ done
 remainingArgs=${POSITIONAL_ARGS[@]}
 set -- "${POSITIONAL_ARGS[@]}" # restore positional parameters
 
-if [ -z "${FLAKE_DIR}" ]; then
-	echo "Flake directory not specified. Use '--flake [directory]' or set the $FLAKE_DIR environment variable."
+if [ -z "${flakeDir}" ]; then
+	echo "Flake directory not specified. Use '--flake <path>' or set \$FLAKE_DIR."
 	exit 1
-else
-	flakeDir=$FLAKE_DIR 
 fi
 
 cd $flakeDir
 
 echo "Pulling the latest version of the repository..."
-git pull
+sudo -u $user git pull
 
-if [ $commit = true ]; then
+if [ $update = true ]; then
 	echo "Checking for updates..."
-	nix flake update --commit-lock-file
-	git push
+	sudo -u $user nix flake update --commit-lock-file
+	sudo -u $user git push
+else
+	echo "Skipping 'nix flake update'..."
 fi
 
 run_operation $operation