Skip to content

feat: implement flow mode for interactive commands in captain_utils.sh #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hamzabouissi wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: implement flow mode for interactive commands in captain_utils.sh #458

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63517fc
feat: implement flow mode for interactive commands in captain_utils.sh
hamzabouissi Apr 14, 2026
406a319
feat: add additional helm repositories to prerequisite commands
hamzabouissi Apr 14, 2026
92cc096
feat: install helm-diff plugin in prerequisite commands
hamzabouissi Apr 14, 2026
07640bf
feat: enhance flow mode error handling and ensure helm-diff plugin in…
hamzabouissi Apr 15, 2026
cf8218f
feat: add error handling for --flow argument and improve helm command…
hamzabouissi Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 129 additions & 15 deletions .devcontainer/tools/captain_utils.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,117 @@ set -e
set -u
set -o pipefail

# --- Flow mode infrastructure ---
FLOW_MODE=false
FLOW_QUEUE=()
# Use a temp file for FLOW_INDEX so it persists across subshells created by $()
FLOW_INDEX_FILE=$(mktemp)
echo 0 > "$FLOW_INDEX_FILE"
trap 'rm -f "$FLOW_INDEX_FILE"' EXIT
Comment on lines +12 to +15
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FLOW_INDEX_FILE is created unconditionally at startup even when --flow isn’t used. This adds needless temp-file churn and makes behavior less predictable if the script is sourced. Consider creating the temp file (and installing the trap) only when FLOW_MODE is enabled.

Copilot uses AI. Check for mistakes.

_flow_get_index() { cat "$FLOW_INDEX_FILE"; }
_flow_set_index() { echo "$1" > "$FLOW_INDEX_FILE"; }

while [[ $# -gt 0 ]]; do
case "$1" in
--flow)
if [[ $# -lt 2 ]] || [[ -z "$2" ]]; then
echo "Error: --flow requires a comma-separated queue argument" >&2
exit 1
fi
FLOW_MODE=true
IFS=',' read -r -a FLOW_QUEUE <<< "$2"
Comment thread
hamzabouissi marked this conversation as resolved.
shift 2
;;
Comment thread
hamzabouissi marked this conversation as resolved.
*)
echo "Unknown option: $1" >&2
Comment thread
hamzabouissi marked this conversation as resolved.
exit 1
;;
esac
done

# Wrapper for gum choose. In flow mode, consumes next queue value as 1-based index.
# In interactive mode, shows indexed options and strips index prefix from result.
flow_choose() {
local options=("$@")
if [ "$FLOW_MODE" = true ]; then
local flow_index=$(_flow_get_index)
if [ "$flow_index" -ge "${#FLOW_QUEUE[@]}" ]; then
echo "Flow complete." >&2
exit 1
fi
local idx="${FLOW_QUEUE[$flow_index]}"
_flow_set_index $((flow_index + 1))
if ! [[ "$idx" =~ ^[0-9]+$ ]] || [ "$idx" -lt 1 ] || [ "$idx" -gt "${#options[@]}" ]; then
echo "Invalid flow index '$idx'. Valid range: 1-${#options[@]} for options: ${options[*]}" >&2
exit 1
Comment on lines +46 to +52
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

flow_choose calls exit when the flow queue is exhausted/invalid. Because callers use command substitution (var=$(flow_choose ...)), exit will terminate the entire script immediately and bypass any caller-side handling like || exit 0. Prefer return 1 (and maybe echo an error to stderr) so the caller can decide whether to exit, retry, or go back.

Suggested change
exit 1
fi
local idx="${FLOW_QUEUE[$flow_index]}"
_flow_set_index $((flow_index + 1))
if ! [[ "$idx" =~ ^[0-9]+$ ]] || [ "$idx" -lt 1 ] || [ "$idx" -gt "${#options[@]}" ]; then
echo "Invalid flow index '$idx'. Valid range: 1-${#options[@]} for options: ${options[*]}" >&2
exit 1
return 1
fi
local idx="${FLOW_QUEUE[$flow_index]}"
_flow_set_index $((flow_index + 1))
if ! [[ "$idx" =~ ^[0-9]+$ ]] || [ "$idx" -lt 1 ] || [ "$idx" -gt "${#options[@]}" ]; then
echo "Invalid flow index '$idx'. Valid range: 1-${#options[@]} for options: ${options[*]}" >&2
return 1

Copilot uses AI. Check for mistakes.
fi
local selected="${options[$((idx - 1))]}"
echo "[flow] Selected: $selected" >&2
echo "$selected"
else
local indexed_options=()
for i in "${!options[@]}"; do
indexed_options+=("$((i + 1)). ${options[$i]}")
done
local choice
choice=$(gum choose "${indexed_options[@]}")
# Strip the "N. " prefix
echo "$choice" | sed 's/^[0-9]*\. //'
fi
}

# Wrapper for gum confirm. In flow mode, consumes next queue value (y/n).
flow_confirm() {
local prompt="$1"
if [ "$FLOW_MODE" = true ]; then
local flow_index=$(_flow_get_index)
if [ "$flow_index" -ge "${#FLOW_QUEUE[@]}" ]; then
echo "Flow complete." >&2
exit 0
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

flow_confirm exits the script (exit 0) when the flow queue is exhausted. This makes flow_confirm unsafe to use in conditionals (e.g. if ! flow_confirm ...) because it can terminate the whole script mid-function. Prefer returning a status (e.g. return 1/return 0) and let the caller decide what to do when the flow runs out.

Suggested change
exit 0
return 1

Copilot uses AI. Check for mistakes.
fi
local val="${FLOW_QUEUE[$flow_index]}"
_flow_set_index $((flow_index + 1))
echo "[flow] Confirm '$prompt': $val" >&2
if [ "$val" = "y" ] || [ "$val" = "Y" ]; then
return 0
else
return 1
fi
Comment thread
hamzabouissi marked this conversation as resolved.
else
gum confirm "$prompt"
fi
}

# Wrapper for gum pager. In flow mode, uses cat to avoid blocking.
flow_pager() {
if [ "$FLOW_MODE" = true ]; then
cat
else
gum pager
fi
}

run_prerequisite_commands(){
helm repo add argo https://argoproj.github.io/argo-helm
helm repo add glueops-platform https://helm.gpkg.io/platform
helm repo add glueops-service https://helm.gpkg.io/service
helm repo add glueops-project-template https://helm.gpkg.io/project-template
helm repo add incubating-glueops-platform https://incubating-helm.gpkg.io/platform
helm repo add incubating-glueops-service https://incubating-helm.gpkg.io/service
helm repo add incubating-glueops-project-template https://incubating-helm.gpkg.io/project-template
helm repo add projectcalico https://docs.tigera.io/calico/charts
helm repo update
if ! helm plugin list | grep -q '^diff'; then
helm plugin install https://github.com/databus23/helm-diff
fi
}

check_codespace_version_match(){
codespace_version=`yq '.versions[] | select(.name == "codespace_version") | .version' VERSIONS/glueops.yaml`
if [ "$codespace_version" != $VERSION ]; then
gum style --foreground 196 --bold "Current codespace version doesn't match with the desired: ${codespace_version}"
if ! gum confirm "Confirmation"; then
if ! flow_confirm "Confirmation"; then
return 1
fi
fi
Expand Down Expand Up @@ -60,7 +162,7 @@ handle_platform_upgrades() {
gum style --foreground 196 --bold "No Overrides.yaml detected"
overrides_file="platform.yaml"
fi
version=$(gum choose "${versions[@]}" "Back")
version=$(flow_choose "${versions[@]}" "Back") || exit 0

# Check if user wants to go back
if [ "$version" = "Back" ]; then
Expand All @@ -71,11 +173,11 @@ handle_platform_upgrades() {
helm_diff_cmd="helm diff --color upgrade \"$component\" \"$chart_name\" --version \"$version\" -f \"$target_file\" -f \"$overrides_file\" -n \"$namespace\" --allow-unreleased"

set -x
eval "$helm_diff_cmd | gum pager" # Execute the main helm diff command
eval "$helm_diff_cmd" | flow_pager # Execute the main helm diff command
Comment on lines 173 to +176
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still relies on eval to run the constructed helm_diff_cmd. Since version/other fields can come from external commands (yq, gh release list, etc.), eval can mis-handle quoting or allow unintended shell interpretation. Prefer building the command as an array and executing it directly (and then piping to flow_pager) to avoid injection/quoting bugs.

Copilot uses AI. Check for mistakes.
gum style --bold --foreground 212 "✅ Diff complete."
Comment thread
hamzabouissi marked this conversation as resolved.
set +x

if ! gum confirm "Apply upgrade"; then
if ! flow_confirm "Apply upgrade"; then
return
fi

Expand Down Expand Up @@ -105,7 +207,7 @@ handle_argocd() {
target_file="argocd.yaml"
namespace="glueops-core"
chart_name="argo/argo-cd"
version=$(gum choose "${versions[@]}" "Back")
version=$(flow_choose "${versions[@]}" "Back") || exit 0

# Check if user wants to go back
if [ "$version" = "Back" ]; then
Expand All @@ -122,19 +224,19 @@ handle_argocd() {
else
local argocd_crd_versions=`v($(helm search repo argo/argo-cd --versions -o json | jq --arg chart_helm_version "$version" -r '.[] | select(.version == $chart_helm_version).app_version' | sed 's/^v//'))`
fi
chosen_crd_version=$(gum choose "${argocd_crd_versions[@]}" "Back")
chosen_crd_version=$(flow_choose "${argocd_crd_versions[@]}" "Back") || exit 0
pre_commands="kubectl apply -k \"https://github.com/argoproj/argo-cd/manifests/crds?ref=$chosen_crd_version\" && helm repo update"
# Check if user wants to go back
if [ "$chosen_crd_version" = "Back" ]; then
return
fi

set -x
eval "$helm_diff_cmd | gum pager" # Execute the main helm diff command
eval "$helm_diff_cmd" | flow_pager # Execute the main helm diff command
gum style --bold --foreground 212 "✅ Diff complete."
set +x

if ! gum confirm "Apply upgrade"; then
if ! flow_confirm "Apply upgrade"; then
return
fi

Expand Down Expand Up @@ -164,16 +266,27 @@ handle_argocd() {

handle_calico_upgrades() {
calico_version=`yq '.versions[] | select(.name == "calico_helm_chart_version") | .version' VERSIONS/glueops.yaml`

helm repo add projectcalico https://docs.tigera.io/calico/charts
helm repo update
Comment on lines +270 to +271
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

handle_calico_upgrades re-runs helm repo add projectcalico + helm repo update even though run_prerequisite_commands already adds that repo and updates at script startup. This adds latency to every calico run; consider removing the duplicate update here or guarding it (e.g. only add if missing, and avoid an extra update unless needed).

Suggested change
helm repo add projectcalico https://docs.tigera.io/calico/charts
helm repo update
if ! helm repo list | awk '{print $1}' | grep -Fxq projectcalico; then
helm repo add projectcalico https://docs.tigera.io/calico/charts
helm repo update
fi

Copilot uses AI. Check for mistakes.

set -x
helm diff --color upgrade calico projectcalico/tigera-operator --version "${calico_version}" --namespace tigera-operator -f calico.yaml --allow-unreleased | flow_pager
gum style --bold --foreground 212 "✅ Diff complete."
Comment thread
hamzabouissi marked this conversation as resolved.
set +x

if ! flow_confirm "Apply calico upgrade"; then
return
fi

remove_daemonset='kubectl delete daemonset -n kube-system aws-node'
gum style --bold --foreground 196 "Removing eks daemonset"
set -x
${remove_daemonset} || true

gum style --bold --foreground 196 "Deploying calico helm chart ${calico_version}"

helm repo add projectcalico https://docs.tigera.io/calico/charts
helm repo update
helm upgrade --install calico projectcalico/tigera-operator --version ${calico_version} --namespace tigera-operator -f calico.yaml --create-namespace
helm upgrade --install calico projectcalico/tigera-operator --version "${calico_version}" --namespace tigera-operator -f calico.yaml --create-namespace

set +x

Expand All @@ -195,7 +308,8 @@ handle_kubernetes_version() {


handle_aws_options() {
local aws_component=$(gum choose "calico" "eks-addons" "upgrade-eks-nodepools" "upgrade-kubernetes" "Exit")
local aws_component
aws_component=$(flow_choose "calico" "eks-addons" "upgrade-eks-nodepools" "upgrade-kubernetes" "Exit") || exit 0
# Handle exit option
if [ "$aws_component" = "Exit" ]; then
echo "Goodbye!"
Expand Down Expand Up @@ -227,7 +341,7 @@ handle_inspect_pods() {

show_production(){
while true; do
component=$(gum choose "show_diff_table" "argocd" "glueops-platform" "aws" "inspect_pods" "Exit")
component=$(flow_choose "show_diff_table" "argocd" "glueops-platform" "aws" "inspect_pods" "Exit") || exit 0

# Handle exit option
if [ "$component" = "Exit" ]; then
Expand Down Expand Up @@ -261,7 +375,7 @@ show_production(){

show_dev(){
while true; do
component=$(gum choose "argocd" "glueops-platform" "aws" "Exit")
component=$(flow_choose "argocd" "glueops-platform" "aws" "Exit") || exit 0

# Handle exit option
if [ "$component" = "Exit" ]; then
Expand Down Expand Up @@ -290,7 +404,7 @@ run_prerequisite_commands

while true; do
# Show main menu
environment=$(gum choose "dev" "production" "Exit")
environment=$(flow_choose "dev" "production" "Exit") || exit 0

# Handle exit option
if [ "$environment" = "Exit" ]; then
Expand Down
Loading