From e4f22f97697f415ae56d8d92bef705db98bd63ae Mon Sep 17 00:00:00 2001
From: Afnan Enayet <afnanenayet@users.noreply.github.com>
Date: Sat, 13 Jan 2024 19:13:21 -0500
Subject: [PATCH] chore(dev): Script to update cargo deps (#801)

Add a script that handles updating cargo dependencies, running tests,
and creating a commit since this is a relatively common operation.

If the script fails at any step the commit will not be created.
---
 dev_scripts/update_dependencies.bash | 40 ++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100755 dev_scripts/update_dependencies.bash

diff --git a/dev_scripts/update_dependencies.bash b/dev_scripts/update_dependencies.bash
new file mode 100755
index 00000000..7dec90a8
--- /dev/null
+++ b/dev_scripts/update_dependencies.bash
@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+# Updates Cargo dependencies and generates a commit if the operation is successful and tests pass.
+# This requires the user to have the following binaries available in their PATH:
+#
+# - cargo
+# - cargo-upgrade
+# - cargo-update
+# - cargo-nextest
+#
+# If these can't be found the script will exit with an error.
+
+required_binaries=("cargo" "cargo-upgrade" "cargo-update" "cargo-nextest")
+
+for cmd in "${required_binaries[@]}"
+do
+  if ! command -v "$cmd"
+  then
+    echo "$cmd was not found"
+    exit 1
+  fi
+done
+
+# Checks if the current branch is clean, we only want this script to run in a clean context so
+# we don't accidentally commit other changes.
+has_changes=$(git diff-files --quiet)
+
+if [ "$has_changes" -ne "0" ]; then
+  echo "ERROR: detected local changes. You must run this script with a clean git context."
+  exit 1
+fi
+
+set -ex
+
+cargo upgrade --incompatible
+cargo update
+cargo test --doc
+cargo nextest run
+git add Cargo.lock Cargo.toml
+git commit -m "chore(deps): Update cargo dependencies" \
+  -m "Done with \`dev_scripts/update_dependencies.bash\`"