Setup tool v2 (#20)

* adding setup helper script

* renaming setup helper script

* fixing welcome

* fixing for zsh compatibility

* fixing read command

* cleanup

* getting rid of missing commands

* fixing install

* adding email validation

* fixing werf helm compat. GOBIN config for pre-installed go too

* commenting out werf

* installing only binaries when necessary. using the latest release of helmfile

* refactoring

* fixing missing go command in go bin dir

* fixing missing brew

* removing options that weren't working

* fixing unable to write file. no such dir

* more docs and error handling for brew installation

* brew install script errors unecessarily

* adding support for testing connection to private hosts

* updating helmfile to the latest version

* protecting against zshrc failures

* making setup_tools the default command

* setting up user friendly commands

* using tls in dev-serve. improving ux

* adding logs

* logging positive test connection

* using kubelogin

* fixing missing email in jwt token

* fixing docs

* fixing logs

* adding final log

* fixing log

* better machine architecture handling

setup-helper.sh

@@ -0,0 +1,305 @@
+DOC_BASE="
+It will do the following:
+- Print this message and wait for confirmation
+"
+
+DOC_TOOLS="
+- Install the following tools if not already installed (might make changes to .zshrc/.bashrc/...)
+    - brew (if not available, will need sudo access to install)
+    - kubectl (Kubernetes Cli)
+    - helmfile
+    - werf
+    - devspace (v5.18.5 not latest)
+    - kubelogin (int128/kubelogin/kubelogin)
+
+    NOTE: If you don't have brew (homebrew) installed (i.e. running brew --version gives 'command not found'), use razorpay self-serve app to make yourself admin before running this script again.
+"
+
+DOC_ACCESS="
+- Configure these tools with kubernetes cluster info
+- Configure these tools to use your razorpay email to login to the kubernetes cluster
+- [Needs VPN] [Spinnaker Pipeline Trigger] Provision access to the kubernetes cluster for your razorpay email
+"
+
+DEV_SHRC_FILE="${HOME}/.devstack/shrc"
+
+BIN_DIR="${HOME}/.devstack/bin"
+BIN_DIR_EXPR="\${HOME}/.devstack/bin"
+
+OS="$(uname | tr '[:upper:]' '[:lower:]')"
+ARCH="$(uname -m)"
+case "$ARCH" in
+    i?86) ARCH="386" ;;
+    x86_64) ARCH="amd64" ;;
+esac
+
+test_private_connection() {
+    declare url="$1"
+
+    echo "Checking if ${url} is reachable..."
+
+    declare status=$(curl -s -I -o /dev/null -w '%{http_code}' --connect-timeout 10 "$url")
+    declare errMsg="Please check if you're connected to VPN and ${url} is reachable in browser"
+
+    [[ $status > 199 && $status < 400 ]] && echo 'ok' || abort "$errMsg"
+}
+
+add_dev_shrc_to_user_shrc() {
+    declare shellType="$(printf '%s' "$SHELL" | rev | cut -d'/' -f1 | rev)"
+    declare userShrcFile="${HOME}/.${shellType}rc"
+
+    declare sourceCmd="source ${DEV_SHRC_FILE}"
+
+    idempotent_file_append "$sourceCmd" "$userShrcFile"
+}
+
+append_line_to_file() {
+    declare line="$1"
+    declare file="$2"
+
+    mkdir -p "$(dirname $file)"
+    [[ -e $file ]] || touch "$file"
+
+    echo "$line" >> "$file"
+}
+
+idempotent_file_append() {
+    declare line="$1"
+    declare file="$2"
+
+    grep -qsxF -- "$line" "$file" || append_line_to_file "$line" "$file"
+}
+
+add_cmd_to_shrc() {
+    declare cmd="$1"
+
+    idempotent_file_append "$cmd" "$DEV_SHRC_FILE"
+    source "$DEV_SHRC_FILE"
+}
+
+check_path_contains() {
+    declare dir="$1"
+
+    [[ "$PATH" = *":${dir}:"* ]] || [[ "$PATH" = *":${dir}" ]] || [[ "$PATH" = "${dir}:"* ]]
+}
+
+add_dir_to_path() {
+    declare pathExpression="$1"
+    declare exepectedPathComponent="$2"
+    declare pathAppendCmd="export PATH=\"${pathExpression}:\${PATH}\""
+
+    check_path_contains "$exepectedPathComponent" || add_cmd_to_shrc "$pathAppendCmd"
+}
+
+install_binary() {
+    declare url="$1"
+    declare dir="$2"
+    declare bin="$3"
+
+    mkdir -p "$dir"
+    curl -L "$url" > "${dir}/${bin}"
+    chmod +x "${dir}/${bin}"
+}
+
+install() {
+    declare cmdName="$1"
+    declare installCmd="${2-}"
+    declare versionCmd="${3-}"
+
+    echo "looking for ${cmdName}"
+    declare path="$(which $cmdName)" || true
+    if [[ -z "$path" ]]; then
+        echo "couldn't find ${cmdName}. installing..."
+        if [[ -z "$installCmd" ]]; then
+            # default for installation
+            brew install "$cmdName"
+        else
+            "$installCmd"
+        fi
+    else
+        echo "found ${cmdName} at ${path}"
+    fi
+
+    if [[ -z "$versionCmd" ]]; then
+        # default for version check
+        "$cmdName" --version
+    else
+        "$versionCmd"
+    fi
+}
+
+abort() {
+    declare message="$1"
+
+    echo "$message"
+    exit 1
+}
+
+read_email() {
+    declare target="$1"
+
+    read -p "Enter your (razorpay) email address:" "$target"
+    is_rzp_email ${!target} || abort "Not a valid razorpay email address"
+}
+
+confirm() {
+    declare prompt="$1"
+
+    read -p "${prompt}Press enter to continue. Press any other key to stop." -n 1
+
+    [[ -z $REPLY ]]
+}
+
+spinnaker_webhook() {
+    declare spinnaker="$1"
+    declare webhook="$2"
+    declare parameters="$3"
+
+    curl -X POST "https://${spinnaker}/webhooks/webhook/${webhook}" \
+        -H "content-type: application/json" \
+        -d "{\"parameters\":${parameters}}"
+}
+
+is_rzp_email() {
+    declare input="$1"
+
+    [[ "$input" =~ ^[a-zA-Z0-9.!\#$%\&\'*+/=?^_\`{|}~-]+@razorpay\.com$ ]]
+}
+
+oidc_exists() {
+    declare email="$1"
+
+    declare template="{{\$res := 0}}{{if .users}}{{range .users}}{{if eq .name \"${email}\" }}{{\$res = 1}}{{end}}{{end}}{{end}}{{\$res}}"
+
+    [[ $(kubectl config view -o=go-template --template="${template}") == 1 ]]
+}
+
+install_devspace() {
+    declare tag="${OS}-${ARCH}"
+    declare version="v5.18.5"
+    declare url="https://github.com/loft-sh/devspace/releases/download/${version}/devspace-${tag}"
+
+    install_binary "$url" "${BIN_DIR}" "devspace"
+}
+
+install_brew() {
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    add_cmd_to_shrc 'eval "$(/opt/homebrew/bin/brew shellenv)"'
+}
+
+version_brew() {
+    brew config
+}
+
+version_kubectl() {
+    kubectl version --client --output yaml
+}
+
+install_werf() {
+    declare tag="${OS}-${ARCH}"
+    declare version="1.2.174"
+    declare url="https://tuf.werf.io/targets/releases/${version}/${tag}/bin/werf"
+
+    install_binary "$url" "${BIN_DIR}" "werf"
+}
+
+version_werf() {
+    echo "werf version: $(werf version)"
+}
+
+configure_helmfile_for_werf() {
+    add_cmd_to_shrc "export WERF_HELM3_MODE=1"
+    add_cmd_to_shrc "alias helmfile='helmfile --enable-live-output -b werf'"
+}
+
+install_kubelogin() {
+    brew install int128/kubelogin/kubelogin
+}
+
+cluster_config() {
+    declare contextName="$1"
+    declare clusterName="$2"
+    declare server="$3"
+    declare cadata="$4"
+    declare user="$5"
+
+    kubectl config set-cluster "$clusterName" --server="$server"
+    kubectl config set "clusters.${clusterName}.certificate-authority-data" "$cadata"
+
+    kubectl config set-context "$contextName" --cluster="$clusterName" --user="$user"
+    kubectl config use-context "$contextName"
+
+    echo "kubectl config current-context : $(kubectl config current-context)"
+}
+
+oidc_config() {
+    declare email="$1"
+    declare oidcIssuerUrl="$2"
+    declare oidcClientId="$3"
+    declare oidcClientSecret="$4"
+
+    oidc_exists "$email" && return 0
+
+    kubectl config set-credentials "$email" \
+        --exec-api-version=client.authentication.k8s.io/v1beta1 \
+        --exec-command=kubectl \
+        --exec-arg=oidc-login \
+        --exec-arg=get-token \
+        --exec-arg=--oidc-issuer-url="$oidcIssuerUrl" \
+        --exec-arg=--oidc-client-id="$oidcClientId" \
+        --exec-arg=--oidc-client-secret="$oidcClientSecret" \
+        --exec-arg=--oidc-extra-scope=email
+}
+
+setup_tools() {
+    install "brew" "install_brew" "version_brew"
+    install "kubectl" "" "version_kubectl"
+    install "helmfile"
+
+    add_dir_to_path "${BIN_DIR_EXPR}" "${BIN_DIR}"
+    install "werf" "install_werf" "version_werf"
+    install "devspace" "install_devspace"
+
+    # updates the helmfile version to the latest
+    brew install helmfile
+    configure_helmfile_for_werf
+
+    install "kubelogin" "install_kubelogin"
+
+    add_dev_shrc_to_user_shrc
+}
+
+final() {
+    echo "Done. Now, remember to open new terminal for these commands to be available"
+}
+
+setup_tools_only() {
+    confirm "Starting setup for devstack tools:${DOC_BASE}${DOC_TOOLS}"
+    setup_tools
+    final
+}
+
+e2e() {
+    declare oidcIssuerUrl="$1"
+    declare oidcClientId="$2"
+    declare oidcClientSecret="$3"
+    declare contextName="$4"
+    declare clusterName="$5"
+    declare clusterUrl="$6"
+    declare cadata="$7"
+    declare spinnakerHost="$8"
+    declare accessWebhook="$9"
+
+    confirm "Starting setup for devstack:${DOC_BASE}${DOC_TOOLS}${DOC_ACCESS}"
+
+    test_private_connection "https://${spinnakerHost}"
+    read_email email
+
+    setup_tools
+
+    oidc_config "$email" "$oidcIssuerUrl" "$oidcClientId" "$oidcClientSecret"
+    cluster_config "$contextName" "$clusterName" "$clusterUrl" "$cadata" "$email"
+    spinnaker_webhook "$spinnakerHost" "$accessWebhook" "{\"user_email\": \"${email}\"}"
+
+    final
+}