=====================================================================
Big day! V4 is finally live. This INCLUDES some BREAKING CHANGES to ZSH
TYPE scwrypts! Please refer to the readme for upgrade details
(more specifically docs/upgrade/v3-to-v4.md)
Upgrade is SUPER EASY, so please take the time to do so.
--- New Features ----------------------------------------------------
- zsh type scwrypts have an upgraded runstring to improve context setup
and simplicity to the scwrypt-writer
- scwrypts now publishes the package (scwrypts) to PyPi; this provides a
simple way to invoke scwrypts from python-based environments as well
as the entire scwrypts python library suite
pip install scwrypts
- scwrypts now publishes the package (scwrypts) to npm; this provides a
simple way to invoke scwrypts from nodesjs environments
npm install scwrypts
--- Bug Fixes -------------------------------------------------------
- scwrypts runner prompts which use the zshbuiltin "read" now
appropriately read input from tty, pipe, files, and user input
- virtualenv refresh now loads and prepares the scwrypts virtual
environments correctly
--- Changes ---------------------------------------------------------
- created the (-v, --log-level) scwrypts arguments as improvements of
and replacements to the --verbose and --no-log flags
- (-n) is now an alias for (--log-level 0)
- (--no-log) is the same as (-n) for compatibility, but will be removed in 4.2
- zsh/lib/utils/io print functions now *interact with log-level* various
log levels will now only display the appropriate console prints for
the specified log level
- zsh/lib/utils/io:INFO has been renamed to DEBUG to align with
log-level output; please use DEBUG for debug messages and REMINDER for
important user messages
- created zsh/lib/utils/io:FZF_USER_INPUT as a *drop-in replacement* for
the confusing FZF_HEAD and FZF_TAIL commands. Update by literally
changing any instances of FZF_HEAD or FZF_TAIL with FZF_USER_INPUT
- FZF_HEAD and FZF_TAIL will be removed in 4.2
- zsh/lib/utils/io:READ (and other zshbuiltin/read-based prompts) now
accept a --force-user-input flag in case important checks should
require an admin's approval. This flag will ensure that piped input
and the `scwrypts -y` flag are ignored for the single prompt.
- zsh/lib/utils/color has been updated to use color names which match
the ANSI color names
- zsh/hello-world has been reduced to a minimal example; this is to
emphasize ease-of-use with v4
- zsh/sanity-check is a scwrypts/run testing helper and detailed
starting reference (helpful since hello-world is now minimal)
- various refactor, updates, and improvements to the scwrypts runner
- migrated all zsh scwrypts and plugins to use v4 runner syntax
- zsh
- plugins/kubectl
- plugins/ci
- refactored py/lib into py/lib/scwrypts (PyPi)
170 lines
4.3 KiB
Bash
170 lines
4.3 KiB
Bash
#####################################################################
|
|
|
|
DEPENDENCIES+=()
|
|
REQUIRED_ENV+=()
|
|
|
|
use utils
|
|
|
|
#####################################################################
|
|
|
|
AVAILABLE_VIRTUALENVS=(py zx)
|
|
|
|
REFRESH_VIRTUALENV() {
|
|
local GROUP="$1"
|
|
local TYPE="$2"
|
|
local VIRTUALENV_PATH="$(_VIRTUALENV__GET_PATH)"
|
|
|
|
[ ! $TYPE ] && { ERROR 'no virtualenv type specified'; return 1; }
|
|
|
|
STATUS "refreshing $GROUP/$TYPE virtualenv"
|
|
DELETE_VIRTUALENV $GROUP $TYPE \
|
|
&& UPDATE_VIRTUALENV $GROUP $TYPE \
|
|
&& SUCCESS 'successfully refreshed virtualenv' \
|
|
|| { ERROR 'something went wrong during refresh (see above)'; return 1; } \
|
|
;
|
|
}
|
|
|
|
UPDATE_VIRTUALENV() {
|
|
local GROUP="$1"
|
|
local TYPE="$2"
|
|
local VIRTUALENV_PATH="$(_VIRTUALENV__GET_PATH)"
|
|
|
|
[ ! $TYPE ] && { ERROR 'no virtualenv type specified'; return 1; }
|
|
|
|
: \
|
|
&& which CREATE_VIRTUALENV__${GROUP}__${TYPE} >/dev/null 2>&1 \
|
|
&& which ACTIVATE_VIRTUALENV__${GROUP}__${TYPE} >/dev/null 2>&1 \
|
|
&& which UPDATE_VIRTUALENV__${GROUP}__${TYPE} >/dev/null 2>&1 \
|
|
&& which DEACTIVATE_VIRTUALENV__${GROUP}__${TYPE} >/dev/null 2>&1 \
|
|
|| { STATUS "no virtualenv available for $GROUP/$TYPE; skipping"; return 0; }
|
|
|
|
STATUS "updating $GROUP/$TYPE virtualenv" \
|
|
&& CREATE_VIRTUALENV__${GROUP}__${TYPE} \
|
|
&& ACTIVATE_VIRTUALENV__${GROUP}__${TYPE} \
|
|
&& UPDATE_VIRTUALENV__${GROUP}__${TYPE} \
|
|
&& DEACTIVATE_VIRTUALENV__${GROUP}__${TYPE} \
|
|
&& SUCCESS "$GROUP/$TYPE virtualenv up-to-date" \
|
|
|| { ERROR "failed to update $GROUP/$TYPE virtualenv (see errors above)"; return 2; }
|
|
}
|
|
|
|
DELETE_VIRTUALENV() {
|
|
[ $CI ] && return 0
|
|
|
|
local GROUP="$1"
|
|
local TYPE="$2"
|
|
local VIRTUALENV_PATH="$(_VIRTUALENV__GET_PATH)"
|
|
|
|
[ ! $TYPE ] && { ERROR 'no virtualenv type specified'; return 1; }
|
|
|
|
STATUS "dropping $GROUP/$TYPE virtualenv artifacts"
|
|
|
|
[ ! -d $VIRTUALENV_PATH ] && {
|
|
SUCCESS "no $GROUP/$TYPE environment detected"
|
|
return 0
|
|
}
|
|
|
|
rm -rf $VIRTUALENV_PATH \
|
|
&& SUCCESS "succesfully cleaned up $GROUP/$TYPE virtualenv" \
|
|
|| { ERROR "unabled to remove '$VIRTUALENV_PATH'"; return 1; }
|
|
}
|
|
|
|
#####################################################################
|
|
|
|
_VIRTUALENV__GET_PATH() {
|
|
local ENV_PATH="$(eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$GROUP 2>/dev/null)"
|
|
[ ! $ENV_PATH ] && ENV_PATH="$SCWRYPTS_VIRTUALENV_PATH__scwrypts"
|
|
|
|
echo $ENV_PATH/$TYPE
|
|
}
|
|
|
|
#####################################################################
|
|
|
|
CREATE_VIRTUALENV__scwrypts__py() {
|
|
[ $CI ] && return 0
|
|
[ -d $VIRTUALENV_PATH ] && return 0
|
|
|
|
DEPENDENCIES=(virtualenv) CHECK_ENVIRONMENT || return 1
|
|
|
|
STATUS 'creating python virtualenv'
|
|
local PY PYTHON
|
|
for PY in $(echo $SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts)
|
|
do
|
|
which python$PY >/dev/null 2>&1 && {
|
|
PYTHON=$(which python$PY)
|
|
break
|
|
}
|
|
done
|
|
[ ! $PYTHON ] && {
|
|
ERROR 'python>=3.9 not available; skipping python env'
|
|
return 1
|
|
}
|
|
|
|
STATUS 'setting up virtualenv'
|
|
virtualenv $VIRTUALENV_PATH --python="$PYTHON" \
|
|
&& SUCCESS 'python virtualenv created' \
|
|
|| {
|
|
ERROR "unable to create '$VIRTUALENV_PATH' with '$PYTHON'"
|
|
return 2
|
|
}
|
|
}
|
|
|
|
ACTIVATE_VIRTUALENV__scwrypts__py() {
|
|
[ $CI ] && return 0
|
|
source $VIRTUALENV_PATH/bin/activate || {
|
|
ERROR "failed to activate virtualenv $GROUP/$TYPE; did create fail?"
|
|
return 1
|
|
}
|
|
}
|
|
|
|
UPDATE_VIRTUALENV__scwrypts__py() {
|
|
local PIP_INSTALL_ARGS=()
|
|
|
|
PIP_INSTALL_ARGS+=(--no-cache-dir)
|
|
PIP_INSTALL_ARGS+=(-r requirements.txt)
|
|
|
|
cd "$SCWRYPTS_ROOT/py"
|
|
pip install ${PIP_INSTALL_ARGS[@]}
|
|
}
|
|
|
|
DEACTIVATE_VIRTUALENV__scwrypts__py() {
|
|
deactivate >/dev/null 2>&1
|
|
return 0
|
|
}
|
|
|
|
##########################################
|
|
|
|
CREATE_VIRTUALENV__scwrypts__zx() {
|
|
[ $CI ] && return 0
|
|
[ -d $VIRTUALENV_PATH ] && return 0
|
|
|
|
DEPENDENCIES=(nodeenv) CHECK_ENVIRONMENT || return 1
|
|
|
|
STATUS 'setting up nodeenv'
|
|
nodeenv $VIRTUALENV_PATH --node=$SCWRYPTS_NODE_VERSION__scwrypts \
|
|
&& SUCCESS 'node virtualenv created' \
|
|
|| {
|
|
ERROR "unable to create '$VIRTUALENV_PATH' with '$SCWRYPTS_NODE_VERSION__scwrypts'"
|
|
return 2
|
|
}
|
|
}
|
|
|
|
ACTIVATE_VIRTUALENV__scwrypts__zx() {
|
|
[ $CI ] && return 0
|
|
source $VIRTUALENV_PATH/bin/activate || {
|
|
ERROR "failed to activate virtualenv $GROUP/$TYPE; did create fail?"
|
|
return 1
|
|
}
|
|
}
|
|
|
|
UPDATE_VIRTUALENV__scwrypts__zx() {
|
|
local NPM_INSTALL_ARGS=()
|
|
|
|
cd "$SCWRYPTS_ROOT/zx"
|
|
npm install ${NPM_INSTALL_ARGS[@]}
|
|
}
|
|
|
|
DEACTIVATE_VIRTUALENV__scwrypts__zx() {
|
|
deactivate_node >/dev/null 2>&1
|
|
return 0
|
|
}
|