stow/oh-my-zsh/.oh-my-zsh/plugins/kube-ps1/kube-ps1.plugin.zsh

   1 #!/usr/bin/env bash
   2
   3 # Kubernetes prompt helper for bash/zsh
   4 # Displays current context and namespace
   5
   6 # Copyright 2021 Jon Mosco
   7 #
   8 #  Licensed under the Apache License, Version 2.0 (the "License");
   9 # you may not use this file except in compliance with the License.
  10 # You may obtain a copy of the License at
  11 #
  12 #     http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 # Unless required by applicable law or agreed to in writing, software
  15 # distributed under the License is distributed on an "AS IS" BASIS,
  16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 # See the License for the specific language governing permissions and
  18 # limitations under the License.
  19
  20 # Debug
  21 [[ -n $DEBUG ]] && set -x
  22
  23 # Default values for the prompt
  24 # Override these values in ~/.zshrc or ~/.bashrc
  25 KUBE_PS1_BINARY="${KUBE_PS1_BINARY:-kubectl}"
  26 KUBE_PS1_SYMBOL_ENABLE="${KUBE_PS1_SYMBOL_ENABLE:-true}"
  27 KUBE_PS1_SYMBOL_DEFAULT=${KUBE_PS1_SYMBOL_DEFAULT:-$'\u2388'}
  28 KUBE_PS1_SYMBOL_PADDING="${KUBE_PS1_SYMBOL_PADDING:-false}"
  29 KUBE_PS1_SYMBOL_USE_IMG="${KUBE_PS1_SYMBOL_USE_IMG:-false}"
  30 KUBE_PS1_NS_ENABLE="${KUBE_PS1_NS_ENABLE:-true}"
  31 KUBE_PS1_CONTEXT_ENABLE="${KUBE_PS1_CONTEXT_ENABLE:-true}"
  32 KUBE_PS1_PREFIX="${KUBE_PS1_PREFIX-(}"
  33 KUBE_PS1_SEPARATOR="${KUBE_PS1_SEPARATOR-|}"
  34 KUBE_PS1_DIVIDER="${KUBE_PS1_DIVIDER-:}"
  35 KUBE_PS1_SUFFIX="${KUBE_PS1_SUFFIX-)}"
  36
  37 KUBE_PS1_SYMBOL_COLOR="${KUBE_PS1_SYMBOL_COLOR-blue}"
  38 KUBE_PS1_CTX_COLOR="${KUBE_PS1_CTX_COLOR-red}"
  39 KUBE_PS1_NS_COLOR="${KUBE_PS1_NS_COLOR-cyan}"
  40 KUBE_PS1_BG_COLOR="${KUBE_PS1_BG_COLOR}"
  41
  42 KUBE_PS1_KUBECONFIG_CACHE="${KUBECONFIG}"
  43 KUBE_PS1_DISABLE_PATH="${HOME}/.kube/kube-ps1/disabled"
  44 KUBE_PS1_LAST_TIME=0
  45 KUBE_PS1_CLUSTER_FUNCTION="${KUBE_PS1_CLUSTER_FUNCTION}"
  46 KUBE_PS1_NAMESPACE_FUNCTION="${KUBE_PS1_NAMESPACE_FUNCTION}"
  47
  48 # Determine our shell
  49 if [ "${ZSH_VERSION-}" ]; then
  50   KUBE_PS1_SHELL="zsh"
  51 elif [ "${BASH_VERSION-}" ]; then
  52   KUBE_PS1_SHELL="bash"
  53 fi
  54
  55 _kube_ps1_init() {
  56   [[ -f "${KUBE_PS1_DISABLE_PATH}" ]] && KUBE_PS1_ENABLED=off
  57
  58   case "${KUBE_PS1_SHELL}" in
  59     "zsh")
  60       _KUBE_PS1_OPEN_ESC="%{"
  61       _KUBE_PS1_CLOSE_ESC="%}"
  62       _KUBE_PS1_DEFAULT_BG="%k"
  63       _KUBE_PS1_DEFAULT_FG="%f"
  64       setopt PROMPT_SUBST
  65       autoload -U add-zsh-hook
  66       add-zsh-hook precmd _kube_ps1_update_cache
  67       zmodload -F zsh/stat b:zstat
  68       zmodload zsh/datetime
  69       ;;
  70     "bash")
  71       _KUBE_PS1_OPEN_ESC=$'\001'
  72       _KUBE_PS1_CLOSE_ESC=$'\002'
  73       _KUBE_PS1_DEFAULT_BG=$'\033[49m'
  74       _KUBE_PS1_DEFAULT_FG=$'\033[39m'
  75       [[ $PROMPT_COMMAND =~ _kube_ps1_update_cache ]] || PROMPT_COMMAND="_kube_ps1_update_cache;${PROMPT_COMMAND:-:}"
  76       ;;
  77   esac
  78 }
  79
  80 _kube_ps1_color_fg() {
  81   local KUBE_PS1_FG_CODE
  82   case "${1}" in
  83     black) KUBE_PS1_FG_CODE=0;;
  84     red) KUBE_PS1_FG_CODE=1;;
  85     green) KUBE_PS1_FG_CODE=2;;
  86     yellow) KUBE_PS1_FG_CODE=3;;
  87     blue) KUBE_PS1_FG_CODE=4;;
  88     magenta) KUBE_PS1_FG_CODE=5;;
  89     cyan) KUBE_PS1_FG_CODE=6;;
  90     white) KUBE_PS1_FG_CODE=7;;
  91     # 256
  92     [0-9]|[1-9][0-9]|[1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-6]) KUBE_PS1_FG_CODE="${1}";;
  93     *) KUBE_PS1_FG_CODE=default
  94   esac
  95
  96   if [[ "${KUBE_PS1_FG_CODE}" == "default" ]]; then
  97     KUBE_PS1_FG_CODE="${_KUBE_PS1_DEFAULT_FG}"
  98     return
  99   elif [[ "${KUBE_PS1_SHELL}" == "zsh" ]]; then
 100     KUBE_PS1_FG_CODE="%F{$KUBE_PS1_FG_CODE}"
 101   elif [[ "${KUBE_PS1_SHELL}" == "bash" ]]; then
 102     if tput setaf 1 &> /dev/null; then
 103       KUBE_PS1_FG_CODE="$(tput setaf ${KUBE_PS1_FG_CODE})"
 104     elif [[ $KUBE_PS1_FG_CODE -ge 0 ]] && [[ $KUBE_PS1_FG_CODE -le 256 ]]; then
 105       KUBE_PS1_FG_CODE="\033[38;5;${KUBE_PS1_FG_CODE}m"
 106     else
 107       KUBE_PS1_FG_CODE="${_KUBE_PS1_DEFAULT_FG}"
 108     fi
 109   fi
 110   echo ${_KUBE_PS1_OPEN_ESC}${KUBE_PS1_FG_CODE}${_KUBE_PS1_CLOSE_ESC}
 111 }
 112
 113 _kube_ps1_color_bg() {
 114   local KUBE_PS1_BG_CODE
 115   case "${1}" in
 116     black) KUBE_PS1_BG_CODE=0;;
 117     red) KUBE_PS1_BG_CODE=1;;
 118     green) KUBE_PS1_BG_CODE=2;;
 119     yellow) KUBE_PS1_BG_CODE=3;;
 120     blue) KUBE_PS1_BG_CODE=4;;
 121     magenta) KUBE_PS1_BG_CODE=5;;
 122     cyan) KUBE_PS1_BG_CODE=6;;
 123     white) KUBE_PS1_BG_CODE=7;;
 124     # 256
 125     [0-9]|[1-9][0-9]|[1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-6]) KUBE_PS1_BG_CODE="${1}";;
 126     *) KUBE_PS1_BG_CODE=$'\033[0m';;
 127   esac
 128
 129   if [[ "${KUBE_PS1_BG_CODE}" == "default" ]]; then
 130     KUBE_PS1_FG_CODE="${_KUBE_PS1_DEFAULT_BG}"
 131     return
 132   elif [[ "${KUBE_PS1_SHELL}" == "zsh" ]]; then
 133     KUBE_PS1_BG_CODE="%K{$KUBE_PS1_BG_CODE}"
 134   elif [[ "${KUBE_PS1_SHELL}" == "bash" ]]; then
 135     if tput setaf 1 &> /dev/null; then
 136       KUBE_PS1_BG_CODE="$(tput setab ${KUBE_PS1_BG_CODE})"
 137     elif [[ $KUBE_PS1_BG_CODE -ge 0 ]] && [[ $KUBE_PS1_BG_CODE -le 256 ]]; then
 138       KUBE_PS1_BG_CODE="\033[48;5;${KUBE_PS1_BG_CODE}m"
 139     else
 140       KUBE_PS1_BG_CODE="${DEFAULT_BG}"
 141     fi
 142   fi
 143   echo ${OPEN_ESC}${KUBE_PS1_BG_CODE}${CLOSE_ESC}
 144 }
 145
 146 _kube_ps1_binary_check() {
 147   command -v $1 >/dev/null
 148 }
 149
 150 _kube_ps1_symbol() {
 151   [[ "${KUBE_PS1_SYMBOL_ENABLE}" == false ]] && return
 152
 153   case "${KUBE_PS1_SHELL}" in
 154     bash)
 155       if ((BASH_VERSINFO[0] >= 4)) && [[ $'\u2388' != "\\u2388" ]]; then
 156         KUBE_PS1_SYMBOL="${KUBE_PS1_SYMBOL_DEFAULT}"
 157         KUBE_PS1_SYMBOL_IMG=$'\u2638\ufe0f'
 158       else
 159         KUBE_PS1_SYMBOL=$'\xE2\x8E\x88'
 160         KUBE_PS1_SYMBOL_IMG=$'\xE2\x98\xB8'
 161       fi
 162       ;;
 163     zsh)
 164       KUBE_PS1_SYMBOL="${KUBE_PS1_SYMBOL_DEFAULT}"
 165       KUBE_PS1_SYMBOL_IMG="\u2638";;
 166     *)
 167       KUBE_PS1_SYMBOL="k8s"
 168   esac
 169
 170   if [[ "${KUBE_PS1_SYMBOL_USE_IMG}" == true ]]; then
 171     KUBE_PS1_SYMBOL="${KUBE_PS1_SYMBOL_IMG}"
 172   fi
 173
 174   if [[ "${KUBE_PS1_SYMBOL_PADDING}" == true ]]; then
 175     echo "${KUBE_PS1_SYMBOL} "
 176   else
 177     echo "${KUBE_PS1_SYMBOL}"
 178   fi
 179
 180 }
 181
 182 _kube_ps1_split() {
 183   type setopt >/dev/null 2>&1 && setopt SH_WORD_SPLIT
 184   local IFS=$1
 185   echo $2
 186 }
 187
 188 _kube_ps1_file_newer_than() {
 189   local mtime
 190   local file=$1
 191   local check_time=$2
 192
 193   if [[ "${KUBE_PS1_SHELL}" == "zsh" ]]; then
 194     mtime=$(zstat +mtime "${file}")
 195   elif stat -c "%s" /dev/null &> /dev/null; then
 196     # GNU stat
 197     mtime=$(stat -L -c %Y "${file}")
 198   else
 199     # BSD stat
 200     mtime=$(stat -L -f %m "$file")
 201   fi
 202
 203   [[ "${mtime}" -gt "${check_time}" ]]
 204 }
 205
 206 _kube_ps1_update_cache() {
 207   local return_code=$?
 208
 209   [[ "${KUBE_PS1_ENABLED}" == "off" ]] && return $return_code
 210
 211   if ! _kube_ps1_binary_check "${KUBE_PS1_BINARY}"; then
 212     # No ability to fetch context/namespace; display N/A.
 213     KUBE_PS1_CONTEXT="BINARY-N/A"
 214     KUBE_PS1_NAMESPACE="N/A"
 215     return
 216   fi
 217
 218   if [[ "${KUBECONFIG}" != "${KUBE_PS1_KUBECONFIG_CACHE}" ]]; then
 219     # User changed KUBECONFIG; unconditionally refetch.
 220     KUBE_PS1_KUBECONFIG_CACHE=${KUBECONFIG}
 221     _kube_ps1_get_context_ns
 222     return
 223   fi
 224
 225   # kubectl will read the environment variable $KUBECONFIG
 226   # otherwise set it to ~/.kube/config
 227   local conf
 228   for conf in $(_kube_ps1_split : "${KUBECONFIG:-${HOME}/.kube/config}"); do
 229     [[ -r "${conf}" ]] || continue
 230     if _kube_ps1_file_newer_than "${conf}" "${KUBE_PS1_LAST_TIME}"; then
 231       _kube_ps1_get_context_ns
 232       return
 233     fi
 234   done
 235
 236   return $return_code
 237 }
 238
 239 _kube_ps1_get_context() {
 240   if [[ "${KUBE_PS1_CONTEXT_ENABLE}" == true ]]; then
 241     KUBE_PS1_CONTEXT="$(${KUBE_PS1_BINARY} config current-context 2>/dev/null)"
 242     # Set namespace to 'N/A' if it is not defined
 243     KUBE_PS1_CONTEXT="${KUBE_PS1_CONTEXT:-N/A}"
 244
 245     if [[ ! -z "${KUBE_PS1_CLUSTER_FUNCTION}" ]]; then
 246       KUBE_PS1_CONTEXT=$($KUBE_PS1_CLUSTER_FUNCTION $KUBE_PS1_CONTEXT)
 247     fi
 248   fi
 249 }
 250
 251 _kube_ps1_get_ns() {
 252   if [[ "${KUBE_PS1_NS_ENABLE}" == true ]]; then
 253     KUBE_PS1_NAMESPACE="$(${KUBE_PS1_BINARY} config view --minify --output 'jsonpath={..namespace}' 2>/dev/null)"
 254     # Set namespace to 'default' if it is not defined
 255     KUBE_PS1_NAMESPACE="${KUBE_PS1_NAMESPACE:-default}"
 256
 257     if [[ ! -z "${KUBE_PS1_NAMESPACE_FUNCTION}" ]]; then
 258         KUBE_PS1_NAMESPACE=$($KUBE_PS1_NAMESPACE_FUNCTION $KUBE_PS1_NAMESPACE)
 259     fi
 260   fi
 261 }
 262
 263 _kube_ps1_get_context_ns() {
 264   # Set the command time
 265   if [[ "${KUBE_PS1_SHELL}" == "bash" ]]; then
 266     if ((BASH_VERSINFO[0] >= 4 && BASH_VERSINFO[1] >= 2)); then
 267       KUBE_PS1_LAST_TIME=$(printf '%(%s)T')
 268     else
 269       KUBE_PS1_LAST_TIME=$(date +%s)
 270     fi
 271   elif [[ "${KUBE_PS1_SHELL}" == "zsh" ]]; then
 272     KUBE_PS1_LAST_TIME=$EPOCHSECONDS
 273   fi
 274
 275   _kube_ps1_get_context
 276   _kube_ps1_get_ns
 277 }
 278
 279 # Set kube-ps1 shell defaults
 280 _kube_ps1_init
 281
 282 _kubeon_usage() {
 283   cat <<"EOF"
 284 Toggle kube-ps1 prompt on
 285
 286 Usage: kubeon [-g | --global] [-h | --help]
 287
 288 With no arguments, turn off kube-ps1 status for this shell instance (default).
 289
 290   -g --global  turn on kube-ps1 status globally
 291   -h --help    print this message
 292 EOF
 293 }
 294
 295 _kubeoff_usage() {
 296   cat <<"EOF"
 297 Toggle kube-ps1 prompt off
 298
 299 Usage: kubeoff [-g | --global] [-h | --help]
 300
 301 With no arguments, turn off kube-ps1 status for this shell instance (default).
 302
 303   -g --global turn off kube-ps1 status globally
 304   -h --help   print this message
 305 EOF
 306 }
 307
 308 kubeon() {
 309   if [[ "${1}" == '-h' || "${1}" == '--help' ]]; then
 310     _kubeon_usage
 311   elif [[ "${1}" == '-g' || "${1}" == '--global' ]]; then
 312     rm -f -- "${KUBE_PS1_DISABLE_PATH}"
 313   elif [[ "$#" -ne 0 ]]; then
 314     echo -e "error: unrecognized flag ${1}\\n"
 315     _kubeon_usage
 316     return
 317   fi
 318
 319   KUBE_PS1_ENABLED=on
 320 }
 321
 322 kubeoff() {
 323   if [[ "${1}" == '-h' || "${1}" == '--help' ]]; then
 324     _kubeoff_usage
 325   elif [[ "${1}" == '-g' || "${1}" == '--global' ]]; then
 326     mkdir -p -- "$(dirname "${KUBE_PS1_DISABLE_PATH}")"
 327     touch -- "${KUBE_PS1_DISABLE_PATH}"
 328   elif [[ $# -ne 0 ]]; then
 329     echo "error: unrecognized flag ${1}" >&2
 330     _kubeoff_usage
 331     return
 332   fi
 333
 334   KUBE_PS1_ENABLED=off
 335 }
 336
 337 # Build our prompt
 338 kube_ps1() {
 339   [[ "${KUBE_PS1_ENABLED}" == "off" ]] && return
 340   [[ -z "${KUBE_PS1_CONTEXT}" ]] && [[ "${KUBE_PS1_CONTEXT_ENABLE}" == true ]] && return
 341
 342   local KUBE_PS1
 343   local KUBE_PS1_RESET_COLOR="${_KUBE_PS1_OPEN_ESC}${_KUBE_PS1_DEFAULT_FG}${_KUBE_PS1_CLOSE_ESC}"
 344
 345   # Background Color
 346   [[ -n "${KUBE_PS1_BG_COLOR}" ]] && KUBE_PS1+="$(_kube_ps1_color_bg ${KUBE_PS1_BG_COLOR})"
 347
 348   # Prefix
 349   if [[ -z "${KUBE_PS1_PREFIX_COLOR:-}" ]] && [[ -n "${KUBE_PS1_PREFIX}" ]]; then
 350       KUBE_PS1+="${KUBE_PS1_PREFIX}"
 351   else
 352       KUBE_PS1+="$(_kube_ps1_color_fg $KUBE_PS1_PREFIX_COLOR)${KUBE_PS1_PREFIX}${KUBE_PS1_RESET_COLOR}"
 353   fi
 354
 355   # Symbol
 356   KUBE_PS1+="$(_kube_ps1_color_fg $KUBE_PS1_SYMBOL_COLOR)$(_kube_ps1_symbol)${KUBE_PS1_RESET_COLOR}"
 357
 358   if [[ -n "${KUBE_PS1_SEPARATOR}" ]] && [[ "${KUBE_PS1_SYMBOL_ENABLE}" == true ]]; then
 359     KUBE_PS1+="${KUBE_PS1_SEPARATOR}"
 360   fi
 361
 362   # Context
 363   if [[ "${KUBE_PS1_CONTEXT_ENABLE}" == true ]]; then
 364     KUBE_PS1+="$(_kube_ps1_color_fg $KUBE_PS1_CTX_COLOR)${KUBE_PS1_CONTEXT}${KUBE_PS1_RESET_COLOR}"
 365   fi
 366
 367   # Namespace
 368   if [[ "${KUBE_PS1_NS_ENABLE}" == true ]]; then
 369     if [[ -n "${KUBE_PS1_DIVIDER}" ]] && [[ "${KUBE_PS1_CONTEXT_ENABLE}" == true ]]; then
 370       KUBE_PS1+="${KUBE_PS1_DIVIDER}"
 371     fi
 372     KUBE_PS1+="$(_kube_ps1_color_fg ${KUBE_PS1_NS_COLOR})${KUBE_PS1_NAMESPACE}${KUBE_PS1_RESET_COLOR}"
 373   fi
 374
 375   # Suffix
 376   if [[ -z "${KUBE_PS1_SUFFIX_COLOR:-}" ]] && [[ -n "${KUBE_PS1_SUFFIX}" ]]; then
 377       KUBE_PS1+="${KUBE_PS1_SUFFIX}"
 378   else
 379       KUBE_PS1+="$(_kube_ps1_color_fg $KUBE_PS1_SUFFIX_COLOR)${KUBE_PS1_SUFFIX}${KUBE_PS1_RESET_COLOR}"
 380   fi
 381
 382   # Close Background color if defined
 383   [[ -n "${KUBE_PS1_BG_COLOR}" ]] && KUBE_PS1+="${_KUBE_PS1_OPEN_ESC}${_KUBE_PS1_DEFAULT_BG}${_KUBE_PS1_CLOSE_ESC}"
 384
 385   echo "${KUBE_PS1}"
 386 }