Compare commits
15 Commits
v4.4.1
...
fb8bfa6a9c
Author | SHA1 | Date | |
---|---|---|---|
fb8bfa6a9c | |||
79adf18d9a | |||
7ce71dfca8 | |||
3bcd4f3f6d | |||
d4ef1c70e0 | |||
c9e107d2fd | |||
b6b4f2e5b8 | |||
432593a0f3 | |||
6629caf459 | |||
8bcc99b898 | |||
05694ed022 | |||
67bd712590 | |||
a90482de8c | |||
261bbee1a4 | |||
fcf492c661 |
@ -1,292 +0,0 @@
|
|||||||
---
|
|
||||||
version: 2.1
|
|
||||||
|
|
||||||
orbs:
|
|
||||||
python: circleci/python@2.1.1
|
|
||||||
|
|
||||||
|
|
||||||
executors:
|
|
||||||
archlinux:
|
|
||||||
docker:
|
|
||||||
- image: archlinux:base-devel
|
|
||||||
resource_class: small
|
|
||||||
working_directory: /
|
|
||||||
|
|
||||||
python:
|
|
||||||
docker:
|
|
||||||
- image: cimg/python:3.11
|
|
||||||
resource_class: small
|
|
||||||
|
|
||||||
nodejs:
|
|
||||||
docker:
|
|
||||||
- image: node:18
|
|
||||||
resource_class: medium
|
|
||||||
|
|
||||||
|
|
||||||
commands:
|
|
||||||
archlinux-run:
|
|
||||||
description: execute command steps in the archlinux container from the CI user
|
|
||||||
parameters:
|
|
||||||
_name:
|
|
||||||
type: string
|
|
||||||
command:
|
|
||||||
type: string
|
|
||||||
working_directory:
|
|
||||||
type: string
|
|
||||||
default: /home/ci
|
|
||||||
steps:
|
|
||||||
- run:
|
|
||||||
name: << parameters._name >>
|
|
||||||
working_directory: << parameters.working_directory >>
|
|
||||||
command: su ci -c '<< parameters.command >>'
|
|
||||||
|
|
||||||
|
|
||||||
custom:
|
|
||||||
archlinux:
|
|
||||||
prepare:
|
|
||||||
- &archlinux-prepare
|
|
||||||
run:
|
|
||||||
name: prepare archlinux dependencies
|
|
||||||
command: |
|
|
||||||
pacman --noconfirm -Syu git openssh ca-certificates-utils
|
|
||||||
useradd -m ci
|
|
||||||
echo "ci ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
|
|
||||||
|
|
||||||
clone-aur:
|
|
||||||
- &archlinux-clone-aur
|
|
||||||
archlinux-run:
|
|
||||||
_name: clone aur/scwrypts
|
|
||||||
command: git clone https://aur.archlinux.org/scwrypts.git aur
|
|
||||||
|
|
||||||
clone-scwrypts:
|
|
||||||
- &archlinux-clone-scwrypts
|
|
||||||
run:
|
|
||||||
name: clone wrynegade/scwrypts
|
|
||||||
working_directory: /home/ci
|
|
||||||
command: |
|
|
||||||
GIT_SSH_COMMAND="ssh -o StrictHostKeyChecking=no" git clone -b "$(echo $CIRCLE_BRANCH | grep . || echo $CIRCLE_TAG)" "$CIRCLE_REPOSITORY_URL" scwrypts
|
|
||||||
chown -R ci:ci ./scwrypts
|
|
||||||
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
require-full-semver:
|
|
||||||
executor: python
|
|
||||||
steps:
|
|
||||||
- run:
|
|
||||||
name: check CIRCLE_TAG for full semantic version
|
|
||||||
command: |
|
|
||||||
: \
|
|
||||||
&& [ $CIRCLE_TAG ] \
|
|
||||||
&& [[ $CIRCLE_TAG =~ ^v[0-9]*.[0-9]*.[0-9]*$ ]] \
|
|
||||||
;
|
|
||||||
|
|
||||||
aur-test:
|
|
||||||
executor: archlinux
|
|
||||||
steps:
|
|
||||||
- *archlinux-prepare
|
|
||||||
- *archlinux-clone-aur
|
|
||||||
- *archlinux-clone-scwrypts
|
|
||||||
- archlinux-run:
|
|
||||||
_name: test aur build on current source
|
|
||||||
working_directory: /home/ci/aur
|
|
||||||
command: >-
|
|
||||||
:
|
|
||||||
&& PKGVER=$(sed -n "s/^pkgver=//p" ./PKGBUILD)
|
|
||||||
&& cp -r ../scwrypts ../scwrypts-$PKGVER
|
|
||||||
&& rm -rf ../scwrypts-$PKGVER/.circleci
|
|
||||||
&& rm -rf ../scwrypts-$PKGVER/.git
|
|
||||||
&& rm -rf ../scwrypts-$PKGVER/.gitattributes
|
|
||||||
&& rm -rf ../scwrypts-$PKGVER/.gitignore
|
|
||||||
&& rm -rf ../scwrypts-$PKGVER/.github
|
|
||||||
&& tar -czf scwrypts.tar.gz ../scwrypts-$PKGVER
|
|
||||||
&& echo "source=(scwrypts.tar.gz)" >> PKGBUILD
|
|
||||||
&& echo "sha256sums=(SKIP)" >> PKGBUILD
|
|
||||||
&& makepkg --noconfirm -si
|
|
||||||
&& echo validating scwrypts version
|
|
||||||
&& scwrypts --version | grep "^scwrypts v$PKGVER$"
|
|
||||||
;
|
|
||||||
|
|
||||||
aur-publish:
|
|
||||||
executor: archlinux
|
|
||||||
steps:
|
|
||||||
- *archlinux-prepare
|
|
||||||
- *archlinux-clone-aur
|
|
||||||
- archlinux-run:
|
|
||||||
_name: update PKGBUILD and .SRCINFO
|
|
||||||
working_directory: /home/ci/aur
|
|
||||||
command: >-
|
|
||||||
:
|
|
||||||
&& NEW_VERSION=$(echo $CIRCLE_TAG | sed 's/^v//')
|
|
||||||
&& sed "s/pkgver=.*/pkgver=$NEW_VERSION/; s/^pkgrel=.*/pkgrel=1/; /sha256sums/d" PKGBUILD -i
|
|
||||||
&& makepkg -g >> PKGBUILD
|
|
||||||
&& makepkg --printsrcinfo > .SRCINFO
|
|
||||||
;
|
|
||||||
- archlinux-run:
|
|
||||||
_name: sanity check for version build
|
|
||||||
working_directory: /home/ci/aur
|
|
||||||
command: >-
|
|
||||||
:
|
|
||||||
&& makepkg --noconfirm -si
|
|
||||||
&& scwrypts --version
|
|
||||||
&& scwrypts --version | grep -q "^scwrypts $CIRCLE_TAG\$"
|
|
||||||
;
|
|
||||||
- archlinux-run:
|
|
||||||
_name: publish new version
|
|
||||||
working_directory: /home/ci/aur
|
|
||||||
command: >-
|
|
||||||
:
|
|
||||||
&& git add PKGBUILD .SRCINFO
|
|
||||||
&& git -c user.email=yage@yage.io -c user.name=yage commit -am "$CIRCLE_TAG"
|
|
||||||
&& eval $(ssh-agent)
|
|
||||||
&& echo -e $SSH_KEY_PRIVATE__AUR | ssh-add -
|
|
||||||
&& git remote add upstream ssh://aur@aur.archlinux.org/scwrypts.git
|
|
||||||
&& GIT_SSH_COMMAND="ssh -o StrictHostKeyChecking=no" git push upstream
|
|
||||||
;
|
|
||||||
|
|
||||||
nodejs-test:
|
|
||||||
executor: nodejs
|
|
||||||
working_directory: ~/scwrypts/zx/lib
|
|
||||||
steps:
|
|
||||||
- checkout:
|
|
||||||
path: ~/scwrypts
|
|
||||||
|
|
||||||
- restore_cache:
|
|
||||||
name: restore pnpm cache
|
|
||||||
keys:
|
|
||||||
- pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: pnpm install
|
|
||||||
command: |
|
|
||||||
corepack enable
|
|
||||||
corepack prepare pnpm@latest-8 --activate
|
|
||||||
pnpm config set store-dir .pnpm-store
|
|
||||||
pnpm install
|
|
||||||
|
|
||||||
- save_cache:
|
|
||||||
name: save pnpm cache
|
|
||||||
key: pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
|
|
||||||
paths:
|
|
||||||
- .pnpm-store
|
|
||||||
|
|
||||||
- run: pnpm test
|
|
||||||
- run: pnpm lint
|
|
||||||
- run: pnpm build
|
|
||||||
|
|
||||||
nodejs-publish:
|
|
||||||
executor: nodejs
|
|
||||||
working_directory: ~/scwrypts/zx/lib
|
|
||||||
steps:
|
|
||||||
- checkout:
|
|
||||||
path: ~/scwrypts
|
|
||||||
|
|
||||||
- restore_cache:
|
|
||||||
name: restore pnpm cache
|
|
||||||
keys:
|
|
||||||
- pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: pnpm install
|
|
||||||
command: |
|
|
||||||
corepack enable
|
|
||||||
corepack prepare pnpm@latest-8 --activate
|
|
||||||
pnpm config set store-dir .pnpm-store
|
|
||||||
pnpm install
|
|
||||||
|
|
||||||
- save_cache:
|
|
||||||
name: save pnpm cache
|
|
||||||
key: pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
|
|
||||||
paths:
|
|
||||||
- .pnpm-store
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: publish
|
|
||||||
command: |
|
|
||||||
: \
|
|
||||||
&& [ $CIRCLE_TAG ] \
|
|
||||||
&& pnpm build \
|
|
||||||
&& pnpm version $CIRCLE_TAG \
|
|
||||||
&& pnpm set //registry.npmjs.org/:_authToken=$NPM_TOKEN \
|
|
||||||
&& pnpm publish --no-git-checks \
|
|
||||||
;
|
|
||||||
|
|
||||||
python-test:
|
|
||||||
executor: python
|
|
||||||
working_directory: ~/scwrypts/py/lib
|
|
||||||
steps:
|
|
||||||
- checkout:
|
|
||||||
path: ~/scwrypts
|
|
||||||
- run:
|
|
||||||
name: pytest
|
|
||||||
command: |
|
|
||||||
: \
|
|
||||||
&& pip install . .[test] \
|
|
||||||
&& pytest \
|
|
||||||
;
|
|
||||||
- run: pip install build && python -m build
|
|
||||||
|
|
||||||
python-publish:
|
|
||||||
executor: python
|
|
||||||
working_directory: ~/scwrypts/py/lib
|
|
||||||
steps:
|
|
||||||
- checkout:
|
|
||||||
path: ~/scwrypts
|
|
||||||
- run: pip install build && python -m build
|
|
||||||
- run: pip install twine && twine upload dist/*
|
|
||||||
|
|
||||||
|
|
||||||
workflows:
|
|
||||||
test:
|
|
||||||
jobs:
|
|
||||||
- aur-test:
|
|
||||||
&dev-filters
|
|
||||||
filters:
|
|
||||||
branches:
|
|
||||||
ignore: /^main$/
|
|
||||||
|
|
||||||
- python-test: *dev-filters
|
|
||||||
- nodejs-test: *dev-filters
|
|
||||||
|
|
||||||
publish:
|
|
||||||
jobs:
|
|
||||||
- require-full-semver:
|
|
||||||
filters:
|
|
||||||
&only-run-on-full-semver-tag-filters
|
|
||||||
tags:
|
|
||||||
only: /^v\d+\.\d+\.\d+.*$/
|
|
||||||
branches:
|
|
||||||
ignore: /^.*$/
|
|
||||||
|
|
||||||
- aur-test:
|
|
||||||
&only-publish-for-full-semver
|
|
||||||
filters: *only-run-on-full-semver-tag-filters
|
|
||||||
requires:
|
|
||||||
- require-full-semver
|
|
||||||
- aur-publish:
|
|
||||||
#
|
|
||||||
# there's a crazy-low-chance race-condition between this job and the GH Action '../.github/workflows/automatic-release.yaml'
|
|
||||||
# - automatic-release creates the release artifact, but takes no more than 15-30 seconds (current avg:16s max:26s)
|
|
||||||
# - this publish step requires the release artifact, but waits for all language-repository publishes to complete first (a few minutes at least)
|
|
||||||
#
|
|
||||||
# if something goes wrong, this step can be safely rerun after fixing the release artifact :)
|
|
||||||
#
|
|
||||||
filters: *only-run-on-full-semver-tag-filters
|
|
||||||
context: [aur-yage]
|
|
||||||
requires:
|
|
||||||
- aur-test
|
|
||||||
- python-publish
|
|
||||||
- nodejs-publish
|
|
||||||
|
|
||||||
- python-test: *only-publish-for-full-semver
|
|
||||||
- python-publish:
|
|
||||||
filters: *only-run-on-full-semver-tag-filters
|
|
||||||
context: [pypi-yage]
|
|
||||||
requires:
|
|
||||||
- python-test
|
|
||||||
|
|
||||||
- nodejs-test: *only-publish-for-full-semver
|
|
||||||
- nodejs-publish:
|
|
||||||
filters: *only-run-on-full-semver-tag-filters
|
|
||||||
context: [npm-wrynegade]
|
|
||||||
requires:
|
|
||||||
- nodejs-test
|
|
@ -12,9 +12,13 @@ export DISCORD__DEFAULT_AVATAR_URL=
|
|||||||
export DISCORD__DEFAULT_CHANNEL_ID=
|
export DISCORD__DEFAULT_CHANNEL_ID=
|
||||||
export DISCORD__DEFAULT_USERNAME=
|
export DISCORD__DEFAULT_USERNAME=
|
||||||
export DISCORD__DEFAULT_WEBHOOK=
|
export DISCORD__DEFAULT_WEBHOOK=
|
||||||
|
export I3__BORDER_PIXEL_SIZE=
|
||||||
|
export I3__DMENU_FONT_SIZE=
|
||||||
|
export I3__GLOBAL_FONT_SIZE=
|
||||||
|
export I3__MODEL_CONFIG=
|
||||||
export LINEAR__API_TOKEN=
|
export LINEAR__API_TOKEN=
|
||||||
export MEDIA_SYNC__S3_BUCKET=
|
export MEDIA_SYNC__S3_BUCKET
|
||||||
export MEDIA_SYNC__TARGETS=
|
export MEDIA_SYNC__TARGETS
|
||||||
export REDIS_AUTH=
|
export REDIS_AUTH=
|
||||||
export REDIS_HOST=
|
export REDIS_HOST=
|
||||||
export REDIS_PORT=
|
export REDIS_PORT=
|
||||||
|
@ -15,6 +15,11 @@ DISCORD__DEFAULT_CHANNEL_ID |
|
|||||||
DISCORD__DEFAULT_USERNAME |
|
DISCORD__DEFAULT_USERNAME |
|
||||||
DISCORD__DEFAULT_WEBHOOK |
|
DISCORD__DEFAULT_WEBHOOK |
|
||||||
|
|
||||||
|
I3__BORDER_PIXEL_SIZE | custom i3 configuration settings
|
||||||
|
I3__DMENU_FONT_SIZE |
|
||||||
|
I3__GLOBAL_FONT_SIZE |
|
||||||
|
I3__MODEL_CONFIG |
|
||||||
|
|
||||||
LINEAR__API_TOKEN | linear.app project management configuration
|
LINEAR__API_TOKEN | linear.app project management configuration
|
||||||
|
|
||||||
MEDIA_SYNC__S3_BUCKET | s3 bucket name and filesystem targets for media backups
|
MEDIA_SYNC__S3_BUCKET | s3 bucket name and filesystem targets for media backups
|
||||||
|
19
.github/workflows/automatic-release.yaml
vendored
19
.github/workflows/automatic-release.yaml
vendored
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
name: Automatic Tag-release
|
|
||||||
|
|
||||||
on: # yamllint disable-line rule:truthy
|
|
||||||
push:
|
|
||||||
branches-ignore:
|
|
||||||
- '**'
|
|
||||||
tags:
|
|
||||||
- 'v*.*.*'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
automatic-tag-release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: marvinpinto/action-automatic-releases@latest
|
|
||||||
with:
|
|
||||||
repo_token: "${{ secrets.GITHUB_TOKEN }}"
|
|
||||||
prerelease: false
|
|
@ -29,7 +29,6 @@ runs:
|
|||||||
repository: wrynegade/scwrypts
|
repository: wrynegade/scwrypts
|
||||||
path: ./wrynegade/scwrypts
|
path: ./wrynegade/scwrypts
|
||||||
ref: ${{ inputs.version }}
|
ref: ${{ inputs.version }}
|
||||||
fetch-tags: true
|
|
||||||
|
|
||||||
- name: check dependencies
|
- name: check dependencies
|
||||||
shell: bash
|
shell: bash
|
||||||
@ -52,7 +51,7 @@ runs:
|
|||||||
} > $HOME/.scwrypts.apt-get.log 2>&1
|
} > $HOME/.scwrypts.apt-get.log 2>&1
|
||||||
|
|
||||||
echo "updating virtual dependencies"
|
echo "updating virtual dependencies"
|
||||||
$GITHUB_WORKSPACE/wrynegade/scwrypts/scwrypts \
|
$GITHUB_WORKSPACE/wrynegade/scwrypts/scwrypts -n \
|
||||||
--name scwrypts/virtualenv/update-all \
|
--name scwrypts/virtualenv/update-all \
|
||||||
--group scwrypts \
|
--group scwrypts \
|
||||||
--type zsh \
|
--type zsh \
|
||||||
|
@ -1,10 +1,11 @@
|
|||||||
[[ $SCWRYPTS_KUBECTL_DRIVER_READY -eq 1 ]] && return 0
|
[[ $SCWRYPTS_KUBECTL_DRIVER_READY -eq 1 ]] && return 0
|
||||||
|
|
||||||
unalias k h f >/dev/null 2>&1
|
unalias k h >/dev/null 2>&1
|
||||||
k() { _SCWRYPTS_KUBECTL_DRIVER kubectl $@; }
|
k() { _SCWRYPTS_KUBECTL_DRIVER kubectl $@; }
|
||||||
h() { _SCWRYPTS_KUBECTL_DRIVER helm $@; }
|
h() { _SCWRYPTS_KUBECTL_DRIVER helm $@; }
|
||||||
f() { _SCWRYPTS_KUBECTL_DRIVER flux $@; }
|
f() { _SCWRYPTS_KUBECTL_DRIVER flux $@; }
|
||||||
|
|
||||||
|
|
||||||
_SCWRYPTS_KUBECTL_DRIVER() {
|
_SCWRYPTS_KUBECTL_DRIVER() {
|
||||||
[ ! $SCWRYPTS_ENV ] && {
|
[ ! $SCWRYPTS_ENV ] && {
|
||||||
ERROR "must set SCWRYPTS_ENV in order to use '$(echo $CLI | head -c1)'"
|
ERROR "must set SCWRYPTS_ENV in order to use '$(echo $CLI | head -c1)'"
|
||||||
@ -170,7 +171,7 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
|||||||
|
|
||||||
[ $NAMESPACE ] && CLI_ARGS+=(--namespace $NAMESPACE)
|
[ $NAMESPACE ] && CLI_ARGS+=(--namespace $NAMESPACE)
|
||||||
[[ $VERBOSE -eq 1 ]] && {
|
[[ $VERBOSE -eq 1 ]] && {
|
||||||
REMINDER "
|
INFO "
|
||||||
context '$CONTEXT'
|
context '$CONTEXT'
|
||||||
namespace '$NAMESPACE'
|
namespace '$NAMESPACE'
|
||||||
environment '$SCWRYPTS_ENV'
|
environment '$SCWRYPTS_ENV'
|
||||||
@ -179,7 +180,7 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
|||||||
STATUS "running $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
STATUS "running $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||||
} || {
|
} || {
|
||||||
[[ $(_SCWRYPTS_KUBECTL_SETTINGS get context) =~ ^show$ ]] && {
|
[[ $(_SCWRYPTS_KUBECTL_SETTINGS get context) =~ ^show$ ]] && {
|
||||||
REMINDER "$SCWRYPTS_ENV.$SUBSESSION : $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
INFO "$SCWRYPTS_ENV.$SUBSESSION : $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
$CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}
|
$CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}
|
||||||
|
@ -112,8 +112,8 @@ KUBECTL__SERVE() {
|
|||||||
SERVICE_PASSWORD="$(KUBECTL__GET_SERVICE_PASSWORD)"
|
SERVICE_PASSWORD="$(KUBECTL__GET_SERVICE_PASSWORD)"
|
||||||
KUBECTL__SERVICE_PARSE
|
KUBECTL__SERVICE_PARSE
|
||||||
|
|
||||||
REMINDER "attempting to serve ${NAMESPACE}/${SERVICE_NAME}:${SERVICE_PORT}"
|
INFO "attempting to serve ${NAMESPACE}/${SERVICE_NAME}:${SERVICE_PORT}"
|
||||||
[ $SERVICE_PASSWORD ] && REMINDER "password : $SERVICE_PASSWORD"
|
[ $SERVICE_PASSWORD ] && INFO "password : $SERVICE_PASSWORD"
|
||||||
|
|
||||||
KUBECTL port-forward service/$SERVICE_NAME $SERVICE_PORT
|
KUBECTL port-forward service/$SERVICE_NAME $SERVICE_PORT
|
||||||
}
|
}
|
||||||
|
3
py/lib/.gitignore
vendored
3
py/lib/.gitignore
vendored
@ -1,4 +1 @@
|
|||||||
dist/
|
dist/
|
||||||
__pycache__/
|
|
||||||
*.py[cod]
|
|
||||||
*.so
|
|
||||||
|
@ -55,5 +55,6 @@ source = 'versioningit'
|
|||||||
[tool.hatch.build.targets.wheel]
|
[tool.hatch.build.targets.wheel]
|
||||||
packages = ['./']
|
packages = ['./']
|
||||||
|
|
||||||
[tool.versioningit.vcs]
|
[tool.versioningit]
|
||||||
match = ['v[0-9]*.[0-9]*.[0-9]*']
|
match = ['v*']
|
||||||
|
|
||||||
|
@ -4,10 +4,6 @@ scwrypts
|
|||||||
python library functions and invoker for scwrypts
|
python library functions and invoker for scwrypts
|
||||||
'''
|
'''
|
||||||
|
|
||||||
__all__ = [
|
from .scwrypts.execute import execute
|
||||||
'scwrypts',
|
from .scwrypts.interactive import interactive
|
||||||
'execute',
|
from .scwrypts.scwrypts import scwrypts
|
||||||
'interactive',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .scwrypts import scwrypts, execute, interactive
|
|
||||||
|
@ -1,4 +1,6 @@
|
|||||||
from io import StringIO
|
from io import StringIO
|
||||||
|
#from string import ascii_letters, digits
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
from pytest import raises
|
from pytest import raises
|
||||||
|
|
||||||
@ -54,7 +56,7 @@ def test_convert_to_yaml():
|
|||||||
|
|
||||||
|
|
||||||
def test_convert_deep_json_to_yaml():
|
def test_convert_deep_json_to_yaml():
|
||||||
input_stream = generate('json', {**GENERATE_OPTIONS, 'depth': 4})
|
input_stream = StringIO(generate('json', {**GENERATE_OPTIONS, 'depth': 4}))
|
||||||
convert(input_stream, 'json', StringIO(), 'yaml')
|
convert(input_stream, 'json', StringIO(), 'yaml')
|
||||||
|
|
||||||
def test_convert_deep_yaml_to_json():
|
def test_convert_deep_yaml_to_json():
|
||||||
|
@ -4,7 +4,7 @@ from .scwrypts.exceptions import MissingVariableError
|
|||||||
|
|
||||||
|
|
||||||
def getenv(name, required=True):
|
def getenv(name, required=True):
|
||||||
value = os_getenv(f'{name}__override', os_getenv(name))
|
value = os_getenv(name, None)
|
||||||
|
|
||||||
if required and not value:
|
if required and not value:
|
||||||
raise MissingVariableError(name)
|
raise MissingVariableError(name)
|
||||||
|
@ -1,14 +1,11 @@
|
|||||||
from requests import request
|
from requests import request
|
||||||
|
|
||||||
|
|
||||||
CLIENTS = {}
|
|
||||||
|
|
||||||
def get_request_client(base_url, headers=None):
|
def get_request_client(base_url, headers=None):
|
||||||
if CLIENTS.get(base_url, None) is None:
|
|
||||||
if headers is None:
|
if headers is None:
|
||||||
headers = {}
|
headers = {}
|
||||||
|
|
||||||
CLIENTS[base_url] = lambda method, endpoint, **kwargs: request(
|
return lambda method, endpoint, **kwargs: request(
|
||||||
method = method,
|
method = method,
|
||||||
url = f'{base_url}/{endpoint}',
|
url = f'{base_url}/{endpoint}',
|
||||||
headers = {
|
headers = {
|
||||||
@ -21,5 +18,3 @@ def get_request_client(base_url, headers=None):
|
|||||||
if key != 'headers'
|
if key != 'headers'
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
return CLIENTS[base_url]
|
|
||||||
|
@ -1,40 +0,0 @@
|
|||||||
from types import SimpleNamespace
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from scwrypts.test import get_generator
|
|
||||||
from scwrypts.test.character_set import uri
|
|
||||||
|
|
||||||
generate = get_generator({
|
|
||||||
'str_length_minimum': 8,
|
|
||||||
'str_length_maximum': 128,
|
|
||||||
'uuid_output_type': str,
|
|
||||||
})
|
|
||||||
|
|
||||||
def get_request_client_sample_data():
|
|
||||||
return {
|
|
||||||
'base_url' : generate(str, {'character_set': uri}),
|
|
||||||
'endpoint' : generate(str, {'character_set': uri}),
|
|
||||||
'method' : generate(str),
|
|
||||||
'response' : generate('requests_Response', {'depth': 4}),
|
|
||||||
'payload' : generate(dict, {
|
|
||||||
'depth': 1,
|
|
||||||
'data_types': { str, 'uuid' },
|
|
||||||
}),
|
|
||||||
}
|
|
||||||
|
|
||||||
@fixture(name='sample')
|
|
||||||
def fixture_sample():
|
|
||||||
return SimpleNamespace(
|
|
||||||
**get_request_client_sample_data(),
|
|
||||||
|
|
||||||
headers = generate(dict, {
|
|
||||||
'depth': 1,
|
|
||||||
'data_types': { str, 'uuid' },
|
|
||||||
}),
|
|
||||||
|
|
||||||
payload_headers = generate(dict, {
|
|
||||||
'depth': 1,
|
|
||||||
'data_types': { str, 'uuid' },
|
|
||||||
}),
|
|
||||||
)
|
|
@ -1,22 +1,4 @@
|
|||||||
'''
|
from .client import *
|
||||||
basic scwrypts.http client for directus
|
|
||||||
|
|
||||||
configured by setting DIRECTUS__BASE_URL and DIRECTUS__API_TOKEN in
|
|
||||||
scwrypts environment
|
|
||||||
'''
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
'request',
|
|
||||||
'graphql',
|
|
||||||
'get_collections',
|
|
||||||
'get_fields',
|
|
||||||
'FILTER_OPERATORS',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .client import request
|
|
||||||
from .graphql import graphql
|
|
||||||
from .collections import get_collections
|
|
||||||
from .fields import get_fields
|
|
||||||
|
|
||||||
FILTER_OPERATORS = {
|
FILTER_OPERATORS = {
|
||||||
'_eq',
|
'_eq',
|
||||||
|
@ -3,10 +3,55 @@ from scwrypts.env import getenv
|
|||||||
from .. import get_request_client
|
from .. import get_request_client
|
||||||
|
|
||||||
|
|
||||||
|
REQUEST = None
|
||||||
|
COLLECTIONS = None
|
||||||
|
FIELDS = {}
|
||||||
|
|
||||||
|
|
||||||
def request(method, endpoint, **kwargs):
|
def request(method, endpoint, **kwargs):
|
||||||
return get_request_client(
|
global REQUEST # pylint: disable=global-statement
|
||||||
|
|
||||||
|
if REQUEST is None:
|
||||||
|
REQUEST = get_request_client(
|
||||||
base_url = getenv("DIRECTUS__BASE_URL"),
|
base_url = getenv("DIRECTUS__BASE_URL"),
|
||||||
headers = {
|
headers = {
|
||||||
'Authorization': f'bearer {getenv("DIRECTUS__API_TOKEN")}',
|
'Authorization': f'bearer {getenv("DIRECTUS__API_TOKEN")}',
|
||||||
}
|
}
|
||||||
)(method, endpoint, **kwargs)
|
)
|
||||||
|
|
||||||
|
return REQUEST(method, endpoint, **kwargs)
|
||||||
|
|
||||||
|
def graphql(query, system=False):
|
||||||
|
return request(
|
||||||
|
'POST',
|
||||||
|
'graphql' if system is True else 'graphql/system',
|
||||||
|
json={'query': query},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_collections():
|
||||||
|
global COLLECTIONS # pylint: disable=global-statement
|
||||||
|
|
||||||
|
if COLLECTIONS is None:
|
||||||
|
COLLECTIONS = [
|
||||||
|
item['collection']
|
||||||
|
for item in request(
|
||||||
|
'GET',
|
||||||
|
'collections?limit=-1&fields[]=collection',
|
||||||
|
).json()['data']
|
||||||
|
]
|
||||||
|
|
||||||
|
return COLLECTIONS
|
||||||
|
|
||||||
|
|
||||||
|
def get_fields(collection):
|
||||||
|
if FIELDS.get(collection) is None:
|
||||||
|
FIELDS[collection] = [
|
||||||
|
item['field']
|
||||||
|
for item in request(
|
||||||
|
'GET',
|
||||||
|
f'fields/{collection}?limit=-1&fields[]=field',
|
||||||
|
).json()['data']
|
||||||
|
]
|
||||||
|
|
||||||
|
return FIELDS[collection]
|
||||||
|
@ -1,18 +0,0 @@
|
|||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
COLLECTIONS = None
|
|
||||||
|
|
||||||
def get_collections():
|
|
||||||
global COLLECTIONS # pylint: disable=global-statement
|
|
||||||
|
|
||||||
if COLLECTIONS is None:
|
|
||||||
COLLECTIONS = [
|
|
||||||
item['collection']
|
|
||||||
for item in request(
|
|
||||||
'GET',
|
|
||||||
'collections?limit=-1&fields[]=collection',
|
|
||||||
).json()['data']
|
|
||||||
]
|
|
||||||
|
|
||||||
return COLLECTIONS
|
|
@ -1,15 +0,0 @@
|
|||||||
from types import SimpleNamespace
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from scwrypts.test.character_set import uri
|
|
||||||
from ..conftest import generate, get_request_client_sample_data
|
|
||||||
|
|
||||||
|
|
||||||
@fixture(name='sample')
|
|
||||||
def fixture_sample():
|
|
||||||
return SimpleNamespace(
|
|
||||||
**get_request_client_sample_data(),
|
|
||||||
api_token = generate(str, {'character_set': uri}),
|
|
||||||
query = generate(str),
|
|
||||||
)
|
|
@ -1,16 +0,0 @@
|
|||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
FIELDS = {}
|
|
||||||
|
|
||||||
def get_fields(collection):
|
|
||||||
if FIELDS.get(collection) is None:
|
|
||||||
FIELDS[collection] = [
|
|
||||||
item['field']
|
|
||||||
for item in request(
|
|
||||||
'GET',
|
|
||||||
f'fields/{collection}?limit=-1&fields[]=field',
|
|
||||||
).json()['data']
|
|
||||||
]
|
|
||||||
|
|
||||||
return FIELDS[collection]
|
|
@ -1,9 +0,0 @@
|
|||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
def graphql(query, system=False):
|
|
||||||
return request(
|
|
||||||
'POST',
|
|
||||||
'graphql' if system is False else 'graphql/system',
|
|
||||||
json={'query': query},
|
|
||||||
)
|
|
@ -1,43 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
def test_directus_request(sample, _response):
|
|
||||||
assert _response == sample.response
|
|
||||||
|
|
||||||
def test_directus_request_client_setup(sample, _response, mock_get_request_client):
|
|
||||||
mock_get_request_client.assert_called_once_with(
|
|
||||||
base_url = sample.base_url,
|
|
||||||
headers = { 'Authorization': f'bearer {sample.api_token}' },
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_response')
|
|
||||||
def fixture_response(sample):
|
|
||||||
return request(
|
|
||||||
method = sample.method,
|
|
||||||
endpoint = sample.endpoint,
|
|
||||||
**sample.payload,
|
|
||||||
)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='mock_getenv', autouse=True)
|
|
||||||
def fixture_mock_getenv(sample):
|
|
||||||
with patch('scwrypts.http.directus.client.getenv',) as mock:
|
|
||||||
mock.side_effect = lambda name: {
|
|
||||||
'DIRECTUS__BASE_URL': sample.base_url,
|
|
||||||
'DIRECTUS__API_TOKEN': sample.api_token,
|
|
||||||
}[name]
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='mock_get_request_client', autouse=True)
|
|
||||||
def fixture_mock_get_request_client(sample):
|
|
||||||
with patch('scwrypts.http.directus.client.get_request_client') as mock:
|
|
||||||
mock.return_value = lambda method, endpoint, **kwargs: sample.response
|
|
||||||
yield mock
|
|
@ -1,45 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from .graphql import graphql
|
|
||||||
|
|
||||||
|
|
||||||
def test_directus_graphql(sample, _response, _mock_request):
|
|
||||||
assert _response == sample.response
|
|
||||||
|
|
||||||
def test_directus_graphql_request_payload(sample, _response, _mock_request):
|
|
||||||
_mock_request.assert_called_once_with(
|
|
||||||
'POST',
|
|
||||||
'graphql',
|
|
||||||
json = {'query': sample.query},
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_directus_graphql_system(sample, _response_system):
|
|
||||||
assert _response_system == sample.response
|
|
||||||
|
|
||||||
def test_directus_graphql_system_request_payload(sample, _response_system, _mock_request):
|
|
||||||
_mock_request.assert_called_once_with(
|
|
||||||
'POST',
|
|
||||||
'graphql/system',
|
|
||||||
json = {'query': sample.query},
|
|
||||||
)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_response')
|
|
||||||
def fixture_response(sample, _mock_request):
|
|
||||||
return graphql(sample.query)
|
|
||||||
|
|
||||||
|
|
||||||
@fixture(name='_response_system')
|
|
||||||
def fixture_response_system(sample, _mock_request):
|
|
||||||
return graphql(sample.query, system=True)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_mock_request')
|
|
||||||
def fixture_mock_request(sample):
|
|
||||||
with patch('scwrypts.http.directus.graphql.request') as mock:
|
|
||||||
mock.return_value = sample.response
|
|
||||||
yield mock
|
|
@ -1,14 +1,2 @@
|
|||||||
'''
|
from .client import *
|
||||||
basic scwrypts.http client for discord
|
from .send_message import *
|
||||||
|
|
||||||
configured by setting various DISCORD__* options in the
|
|
||||||
scwrypts environment
|
|
||||||
'''
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
'request',
|
|
||||||
'send_message',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .client import request
|
|
||||||
from .send_message import send_message
|
|
||||||
|
@ -1,15 +1,20 @@
|
|||||||
from scwrypts.env import getenv
|
from scwrypts.env import getenv
|
||||||
|
from scwrypts.http import get_request_client
|
||||||
|
|
||||||
from .. import get_request_client
|
REQUEST = None
|
||||||
|
|
||||||
|
|
||||||
def request(method, endpoint, **kwargs):
|
def request(method, endpoint, **kwargs):
|
||||||
|
global REQUEST # pylint: disable=global-statement
|
||||||
|
|
||||||
|
if REQUEST is None:
|
||||||
headers = {}
|
headers = {}
|
||||||
|
|
||||||
if (token := getenv("DISCORD__BOT_TOKEN", required = False)) is not None:
|
if (token := getenv("DISCORD__BOT_TOKEN", required = False)) is not None:
|
||||||
headers['Authorization'] = f'Bot {token}'
|
headers['Authorization'] = f'Bot {token}'
|
||||||
|
|
||||||
return get_request_client(
|
REQUEST = get_request_client(
|
||||||
base_url = 'https://discord.com/api',
|
base_url = 'https://discord.com/api',
|
||||||
headers = headers,
|
headers = headers,
|
||||||
)(method, endpoint, **kwargs)
|
)
|
||||||
|
|
||||||
|
return REQUEST(method, endpoint, **kwargs)
|
||||||
|
@ -1,24 +0,0 @@
|
|||||||
from string import ascii_letters, digits
|
|
||||||
from types import SimpleNamespace
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from scwrypts.test.character_set import uri
|
|
||||||
from ..conftest import generate, get_request_client_sample_data
|
|
||||||
|
|
||||||
@fixture(name='sample')
|
|
||||||
def fixture_sample():
|
|
||||||
return SimpleNamespace(
|
|
||||||
**{
|
|
||||||
**get_request_client_sample_data(),
|
|
||||||
'base_url': 'https://discord.com/api',
|
|
||||||
},
|
|
||||||
bot_token = generate(str, {'character_set': uri}),
|
|
||||||
username = generate(str, {'character_set': ascii_letters + digits}),
|
|
||||||
avatar_url = generate(str, {'character_set': uri}),
|
|
||||||
webhook = generate(str, {'character_set': uri}),
|
|
||||||
channel_id = generate(str, {'character_set': uri}),
|
|
||||||
content_header = generate(str),
|
|
||||||
content_footer = generate(str),
|
|
||||||
content = generate(str),
|
|
||||||
)
|
|
@ -1,54 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
def test_discord_request(sample, _response):
|
|
||||||
assert _response == sample.response
|
|
||||||
|
|
||||||
def test_discord_request_client_setup(sample, mock_get_request_client, _mock_getenv, _response):
|
|
||||||
mock_get_request_client.assert_called_once_with(
|
|
||||||
base_url = sample.base_url,
|
|
||||||
headers = { 'Authorization': f'Bot {sample.bot_token}' },
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_discord_request_client_setup_public(sample, mock_get_request_client, _mock_getenv_optional, _response):
|
|
||||||
mock_get_request_client.assert_called_once_with(
|
|
||||||
base_url = sample.base_url,
|
|
||||||
headers = {},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_response')
|
|
||||||
def fixture_response(sample):
|
|
||||||
return request(
|
|
||||||
method = sample.method,
|
|
||||||
endpoint = sample.endpoint,
|
|
||||||
**sample.payload,
|
|
||||||
)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='mock_get_request_client', autouse=True)
|
|
||||||
def fixture_mock_get_request_client(sample):
|
|
||||||
with patch('scwrypts.http.discord.client.get_request_client') as mock:
|
|
||||||
mock.return_value = lambda method, endpoint, **kwargs: sample.response
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='_mock_getenv')
|
|
||||||
def fixture_mock_getenv(sample):
|
|
||||||
with patch('scwrypts.http.discord.client.getenv',) as mock:
|
|
||||||
mock.side_effect = lambda name, **kwargs: {
|
|
||||||
'DISCORD__BOT_TOKEN': sample.bot_token,
|
|
||||||
}[name]
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='_mock_getenv_optional')
|
|
||||||
def fixture_mock_getenv_optional():
|
|
||||||
with patch('scwrypts.http.discord.client.getenv',) as mock:
|
|
||||||
mock.side_effect = lambda name, **kwargs: None
|
|
||||||
yield mock
|
|
@ -1,91 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture, raises
|
|
||||||
|
|
||||||
from .send_message import send_message
|
|
||||||
|
|
||||||
|
|
||||||
def test_discord_send_message(sample, mock_request, _mock_getenv):
|
|
||||||
expected = get_default_called_with(sample)
|
|
||||||
|
|
||||||
assert send_message(sample.content) == sample.response
|
|
||||||
mock_request.assert_called_once_with(**expected)
|
|
||||||
|
|
||||||
def test_discord_send_message_without_username(sample, mock_request, _mock_getenv):
|
|
||||||
sample.username = None
|
|
||||||
expected = get_default_called_with(sample)
|
|
||||||
del expected['json']['username']
|
|
||||||
|
|
||||||
assert send_message(sample.content) == sample.response
|
|
||||||
mock_request.assert_called_once_with(**expected)
|
|
||||||
|
|
||||||
def test_discord_send_message_without_avatar_url(sample, mock_request, _mock_getenv):
|
|
||||||
sample.avatar_url = None
|
|
||||||
expected = get_default_called_with(sample)
|
|
||||||
del expected['json']['avatar_url']
|
|
||||||
|
|
||||||
assert send_message(sample.content) == sample.response
|
|
||||||
mock_request.assert_called_once_with(**expected)
|
|
||||||
|
|
||||||
def test_discord_send_message_to_channel_id(sample, mock_request, _mock_getenv):
|
|
||||||
sample.webhook = None
|
|
||||||
expected = get_default_called_with(sample)
|
|
||||||
expected['endpoint'] = f'channels/{sample.channel_id}/messages'
|
|
||||||
|
|
||||||
assert send_message(sample.content) == sample.response
|
|
||||||
mock_request.assert_called_once_with(**expected)
|
|
||||||
|
|
||||||
def test_discord_send_message_without_content_header(sample, mock_request, _mock_getenv):
|
|
||||||
sample.content_header = None
|
|
||||||
expected = get_default_called_with(sample)
|
|
||||||
expected['json']['content'] = f'{sample.content}{sample.content_footer}'
|
|
||||||
|
|
||||||
assert send_message(sample.content) == sample.response
|
|
||||||
mock_request.assert_called_once_with(**expected)
|
|
||||||
|
|
||||||
def test_discord_send_message_without_content_footer(sample, mock_request, _mock_getenv):
|
|
||||||
sample.content_footer = None
|
|
||||||
expected = get_default_called_with(sample)
|
|
||||||
expected['json']['content'] = f'{sample.content_header}{sample.content}'
|
|
||||||
|
|
||||||
assert send_message(sample.content) == sample.response
|
|
||||||
mock_request.assert_called_once_with(**expected)
|
|
||||||
|
|
||||||
def test_discord_send_message_error(sample, mock_request, _mock_getenv):
|
|
||||||
with raises(ValueError):
|
|
||||||
sample.webhook = None
|
|
||||||
sample.channel_id = None
|
|
||||||
|
|
||||||
send_message(sample.content)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
def get_default_called_with(sample):
|
|
||||||
return {
|
|
||||||
'method': 'POST',
|
|
||||||
'endpoint': f'webhooks/{sample.webhook}',
|
|
||||||
'json': {
|
|
||||||
'content': f'{sample.content_header}{sample.content}{sample.content_footer}',
|
|
||||||
'username': sample.username,
|
|
||||||
'avatar_url': sample.avatar_url,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
@fixture(name='mock_request', autouse=True)
|
|
||||||
def fixture_mock_request(sample):
|
|
||||||
with patch('scwrypts.http.discord.send_message.request') as mock:
|
|
||||||
mock.return_value = sample.response
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='_mock_getenv')
|
|
||||||
def fixture_mock_getenv(sample):
|
|
||||||
with patch('scwrypts.http.discord.send_message.getenv',) as mock:
|
|
||||||
mock.side_effect = lambda name, **kwargs: {
|
|
||||||
'DISCORD__DEFAULT_USERNAME': sample.username,
|
|
||||||
'DISCORD__DEFAULT_AVATAR_URL': sample.avatar_url,
|
|
||||||
'DISCORD__DEFAULT_WEBHOOK': sample.webhook,
|
|
||||||
'DISCORD__DEFAULT_CHANNEL_ID': sample.channel_id,
|
|
||||||
'DISCORD__CONTENT_HEADER': sample.content_header,
|
|
||||||
'DISCORD__CONTENT_FOOTER': sample.content_footer,
|
|
||||||
}[name]
|
|
||||||
yield mock
|
|
@ -1,14 +1 @@
|
|||||||
'''
|
from .client import *
|
||||||
basic scwrypts.http client for linear
|
|
||||||
|
|
||||||
configured by setting the LINEAR__API_TOKEN option in the
|
|
||||||
scwrypts environment
|
|
||||||
'''
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
'request',
|
|
||||||
'graphql',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .client import request
|
|
||||||
from .graphql import graphql
|
|
||||||
|
@ -2,11 +2,20 @@ from scwrypts.env import getenv
|
|||||||
|
|
||||||
from .. import get_request_client
|
from .. import get_request_client
|
||||||
|
|
||||||
|
REQUEST = None
|
||||||
|
|
||||||
def request(method, endpoint, **kwargs):
|
def request(method, endpoint, **kwargs):
|
||||||
return get_request_client(
|
global REQUEST # pylint: disable=global-statement
|
||||||
|
|
||||||
|
if REQUEST is None:
|
||||||
|
REQUEST = get_request_client(
|
||||||
base_url = 'https://api.linear.app',
|
base_url = 'https://api.linear.app',
|
||||||
headers = {
|
headers = {
|
||||||
'Authorization': f'bearer {getenv("LINEAR__API_TOKEN")}',
|
'Authorization': f'bearer {getenv("LINEAR__API_TOKEN")}',
|
||||||
},
|
}
|
||||||
)(method, endpoint, **kwargs)
|
)
|
||||||
|
|
||||||
|
return REQUEST(method, endpoint, **kwargs)
|
||||||
|
|
||||||
|
def graphql(query):
|
||||||
|
return request('POST', 'graphql', json={'query': query})
|
||||||
|
@ -1,18 +0,0 @@
|
|||||||
from string import ascii_letters, digits
|
|
||||||
from types import SimpleNamespace
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from scwrypts.test.character_set import uri
|
|
||||||
from ..conftest import generate, get_request_client_sample_data
|
|
||||||
|
|
||||||
@fixture(name='sample')
|
|
||||||
def fixture_sample():
|
|
||||||
return SimpleNamespace(
|
|
||||||
**{
|
|
||||||
**get_request_client_sample_data(),
|
|
||||||
'base_url': 'https://api.linear.app',
|
|
||||||
},
|
|
||||||
api_token = generate(str, {'character_set': uri}),
|
|
||||||
query = generate(str),
|
|
||||||
)
|
|
@ -1,5 +0,0 @@
|
|||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
def graphql(query):
|
|
||||||
return request('POST', 'graphql', json={'query': query})
|
|
@ -1,42 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from .client import request
|
|
||||||
|
|
||||||
|
|
||||||
def test_discord_request(sample, _response):
|
|
||||||
assert _response == sample.response
|
|
||||||
|
|
||||||
def test_discord_request_client_setup(sample, mock_get_request_client, _response):
|
|
||||||
mock_get_request_client.assert_called_once_with(
|
|
||||||
base_url = sample.base_url,
|
|
||||||
headers = { 'Authorization': f'bearer {sample.api_token}' },
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_response')
|
|
||||||
def fixture_response(sample):
|
|
||||||
return request(
|
|
||||||
method = sample.method,
|
|
||||||
endpoint = sample.endpoint,
|
|
||||||
**sample.payload,
|
|
||||||
)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='mock_get_request_client', autouse=True)
|
|
||||||
def fixture_mock_get_request_client(sample):
|
|
||||||
with patch('scwrypts.http.linear.client.get_request_client') as mock:
|
|
||||||
mock.return_value = lambda method, endpoint, **kwargs: sample.response
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='mock_getenv', autouse=True)
|
|
||||||
def fixture_mock_getenv(sample):
|
|
||||||
with patch('scwrypts.http.linear.client.getenv',) as mock:
|
|
||||||
mock.side_effect = lambda name, **kwargs: {
|
|
||||||
'LINEAR__API_TOKEN': sample.api_token,
|
|
||||||
}[name]
|
|
||||||
yield mock
|
|
@ -1,35 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from .graphql import graphql
|
|
||||||
|
|
||||||
|
|
||||||
def test_directus_graphql(sample, _response, _mock_request):
|
|
||||||
assert _response == sample.response
|
|
||||||
|
|
||||||
def test_directus_graphql_request_payload(sample, _response, _mock_request):
|
|
||||||
_mock_request.assert_called_once_with(
|
|
||||||
'POST',
|
|
||||||
'graphql',
|
|
||||||
json = {'query': sample.query},
|
|
||||||
)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_response')
|
|
||||||
def fixture_response(sample, _mock_request):
|
|
||||||
return graphql(sample.query)
|
|
||||||
|
|
||||||
|
|
||||||
@fixture(name='_response_system')
|
|
||||||
def fixture_response_system(sample, _mock_request):
|
|
||||||
return graphql(sample.query)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_mock_request')
|
|
||||||
def fixture_mock_request(sample):
|
|
||||||
with patch('scwrypts.http.linear.graphql.request') as mock:
|
|
||||||
mock.return_value = sample.response
|
|
||||||
yield mock
|
|
@ -1,55 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture
|
|
||||||
|
|
||||||
from .client import get_request_client
|
|
||||||
|
|
||||||
|
|
||||||
def test_request_client(sample, _response_basic):
|
|
||||||
assert _response_basic == sample.response
|
|
||||||
|
|
||||||
def test_request_client_forwards_default_headers(sample, mock_request, _response_basic):
|
|
||||||
mock_request.assert_called_once_with(
|
|
||||||
method = sample.method,
|
|
||||||
url = f'{sample.base_url}/{sample.endpoint}',
|
|
||||||
headers = sample.headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_get_request_client_payload(sample, _response_payload):
|
|
||||||
assert _response_payload == sample.response
|
|
||||||
|
|
||||||
def test_request_client_forwards_payload_headers(sample, mock_request, _response_payload):
|
|
||||||
assert mock_request.call_args.kwargs['headers'] == sample.headers | sample.payload_headers
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='mock_request', autouse=True)
|
|
||||||
def fixture_mock_request(sample):
|
|
||||||
with patch('scwrypts.http.client.request') as mock:
|
|
||||||
mock.return_value = sample.response
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='request_client', autouse=True)
|
|
||||||
def fixture_request_client(sample):
|
|
||||||
return get_request_client(sample.base_url, sample.headers)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_response_basic')
|
|
||||||
def fixture_response_basic(sample, request_client):
|
|
||||||
return request_client(
|
|
||||||
method = sample.method,
|
|
||||||
endpoint = sample.endpoint,
|
|
||||||
)
|
|
||||||
|
|
||||||
@fixture(name='_response_payload')
|
|
||||||
def fixture_response_payload(sample, request_client):
|
|
||||||
return request_client(
|
|
||||||
method = sample.method,
|
|
||||||
endpoint = sample.endpoint,
|
|
||||||
**{
|
|
||||||
**sample.payload,
|
|
||||||
'headers': sample.payload_headers,
|
|
||||||
},
|
|
||||||
)
|
|
@ -5,46 +5,6 @@ from sys import stdin, stdout, stderr
|
|||||||
from scwrypts.env import getenv
|
from scwrypts.env import getenv
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def get_combined_stream(input_file=None, output_file=None):
|
|
||||||
'''
|
|
||||||
context manager to open an "input_file" and "output_file"
|
|
||||||
|
|
||||||
But the "files" can be pipe-streams, stdin/stdout, or even
|
|
||||||
actual files! Helpful when trying to write CLI scwrypts
|
|
||||||
which would like to accept all kinds of input and output
|
|
||||||
configurations.
|
|
||||||
'''
|
|
||||||
with get_stream(input_file, 'r') as input_stream, get_stream(output_file, 'w+') as output_stream:
|
|
||||||
yield CombinedStream(input_stream, output_stream)
|
|
||||||
|
|
||||||
def add_io_arguments(parser, allow_input=True, allow_output=True):
|
|
||||||
'''
|
|
||||||
slap these puppies onto your argparse.ArgumentParser to
|
|
||||||
allow easy use of the get_combined_stream at the command line
|
|
||||||
'''
|
|
||||||
if allow_input:
|
|
||||||
parser.add_argument(
|
|
||||||
'-i', '--input-file',
|
|
||||||
dest = 'input_file',
|
|
||||||
default = None,
|
|
||||||
help = 'path to input file; omit for stdin',
|
|
||||||
required = False,
|
|
||||||
)
|
|
||||||
|
|
||||||
if allow_output:
|
|
||||||
parser.add_argument(
|
|
||||||
'-o', '--output-file',
|
|
||||||
dest = 'output_file',
|
|
||||||
default = None,
|
|
||||||
help = 'path to output file; omit for stdout',
|
|
||||||
required = False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def get_stream(filename=None, mode='r', encoding='utf-8', verbose=False, **kwargs):
|
def get_stream(filename=None, mode='r', encoding='utf-8', verbose=False, **kwargs):
|
||||||
allowed_modes = {'r', 'w', 'w+'}
|
allowed_modes = {'r', 'w', 'w+'}
|
||||||
@ -74,6 +34,32 @@ def get_stream(filename=None, mode='r', encoding='utf-8', verbose=False, **kwarg
|
|||||||
stdout.flush()
|
stdout.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def add_io_arguments(parser, allow_input=True, allow_output=True):
|
||||||
|
if allow_input:
|
||||||
|
parser.add_argument(
|
||||||
|
'-i', '--input-file',
|
||||||
|
dest = 'input_file',
|
||||||
|
default = None,
|
||||||
|
help = 'path to input file; omit for stdin',
|
||||||
|
required = False,
|
||||||
|
)
|
||||||
|
|
||||||
|
if allow_output:
|
||||||
|
parser.add_argument(
|
||||||
|
'-o', '--output-file',
|
||||||
|
dest = 'output_file',
|
||||||
|
default = None,
|
||||||
|
help = 'path to output file; omit for stdout',
|
||||||
|
required = False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def get_combined_stream(input_file=None, output_file=None):
|
||||||
|
with get_stream(input_file, 'r') as input_stream, get_stream(output_file, 'w+') as output_stream:
|
||||||
|
yield CombinedStream(input_stream, output_stream)
|
||||||
|
|
||||||
|
|
||||||
class CombinedStream:
|
class CombinedStream:
|
||||||
def __init__(self, input_stream, output_stream):
|
def __init__(self, input_stream, output_stream):
|
||||||
self.input = input_stream
|
self.input = input_stream
|
||||||
|
@ -1,23 +0,0 @@
|
|||||||
'''
|
|
||||||
scwrypts meta-configuration
|
|
||||||
|
|
||||||
provides a helpful three ways to run "scwrypts"
|
|
||||||
|
|
||||||
'scwrypts' is an agnostic, top-level executor allowing any scwrypt to be called from python workflows
|
|
||||||
|
|
||||||
'execute' is the default context set-up for python-based scwrypts
|
|
||||||
|
|
||||||
'interactive' is a context set-up for interactive, python-based scwrypts
|
|
||||||
after execution, you are dropped in a bpython shell with all the variables
|
|
||||||
configured during main() execution
|
|
||||||
'''
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
'scwrypts',
|
|
||||||
'execute',
|
|
||||||
'interactive',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .scwrypts import scwrypts
|
|
||||||
from .execute import execute
|
|
||||||
from .interactive import interactive
|
|
||||||
|
@ -13,14 +13,4 @@ class MissingFlagAndEnvironmentVariableError(EnvironmentError, ArgumentError):
|
|||||||
|
|
||||||
class MissingScwryptsExecutableError(EnvironmentError):
|
class MissingScwryptsExecutableError(EnvironmentError):
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
super().__init__('scwrypts must be installed and available on your PATH')
|
super().__init__(f'scwrypts must be installed and available on your PATH')
|
||||||
|
|
||||||
|
|
||||||
class BadScwryptsLookupError(ValueError):
|
|
||||||
def __init__(self):
|
|
||||||
super().__init__('must provide name/group/type or scwrypt lookup patterns')
|
|
||||||
|
|
||||||
|
|
||||||
class MissingScwryptsGroupOrTypeError(ValueError):
|
|
||||||
def __init__(self, group, _type):
|
|
||||||
super().__init__(f'missing required group or type (group={group} | type={_type}')
|
|
||||||
|
@ -2,57 +2,29 @@ from os import getenv
|
|||||||
from shutil import which
|
from shutil import which
|
||||||
from subprocess import run
|
from subprocess import run
|
||||||
|
|
||||||
from .exceptions import MissingScwryptsExecutableError, BadScwryptsLookupError, MissingScwryptsGroupOrTypeError
|
from .exceptions import MissingScwryptsExecutableError
|
||||||
|
|
||||||
|
|
||||||
def scwrypts(patterns=None, args=None, executable_args=None, name=None, group=None, _type=None):
|
def scwrypts(name, group, _type, *args, log_level=None):
|
||||||
'''
|
'''
|
||||||
top-level scwrypts invoker from python
|
invoke non-python scwrypts from python
|
||||||
|
|
||||||
patterns str / list pattern-based scwrypt lookup
|
|
||||||
args str / list arguments forwarded to the invoked scwrypt
|
|
||||||
executable_args str / list arguments for the 'scwrypts' executable
|
|
||||||
(str above assumes space-delimited values)
|
|
||||||
|
|
||||||
name str exact scwrypt lookup name (requires group and _type)
|
|
||||||
group str exact scwrypt lookup group
|
|
||||||
_type str exact scwrypt lookup type
|
|
||||||
|
|
||||||
SCWRYPTS_EXECUTABLE configuration variable which defines the full path to scwrypts executable
|
|
||||||
|
|
||||||
see 'scwrypts --help' for more information
|
|
||||||
'''
|
'''
|
||||||
if patterns is None and name is None:
|
executable = which('scwrypts')
|
||||||
raise BadScwryptsLookupError()
|
|
||||||
|
|
||||||
if name is not None and (group is None or _type is None):
|
|
||||||
raise MissingScwryptsGroupOrTypeError(group, _type)
|
|
||||||
|
|
||||||
executable = which(getenv('SCWRYPTS_EXECUTABLE', 'scwrypts'))
|
|
||||||
|
|
||||||
if executable is None:
|
if executable is None:
|
||||||
raise MissingScwryptsExecutableError()
|
raise MissingScwryptsExecutableError()
|
||||||
|
|
||||||
lookup = _parse(patterns) if name is None else f'--name {name} --group {group} --type {_type}'
|
pre_args = ''
|
||||||
|
|
||||||
|
if log_level is not None:
|
||||||
|
pre_args += '--log-level {log_level}'
|
||||||
|
|
||||||
depth = getenv('SUBSCWRYPT', '')
|
depth = getenv('SUBSCWRYPT', '')
|
||||||
if depth != '':
|
if depth != '':
|
||||||
depth = int(depth) + 1
|
depth = int(depth) + 1
|
||||||
|
|
||||||
return run(
|
return run(
|
||||||
f'SUBSCWRYPT={depth} {executable} {_parse(executable_args)} {lookup} -- {_parse(args)}',
|
f'SUBSCWRYPT={depth} {executable} --name {name} --group {group} --type {_type} {pre_args} -- {" ".join(args)}',
|
||||||
shell=True,
|
shell=True,
|
||||||
executable='/bin/zsh',
|
executable='/bin/zsh',
|
||||||
check=False,
|
check=False,
|
||||||
capture_output=True,
|
|
||||||
text=True,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
def _parse(string_or_list_args):
|
|
||||||
if string_or_list_args is None:
|
|
||||||
return ''
|
|
||||||
|
|
||||||
if isinstance(string_or_list_args, list):
|
|
||||||
return ' '.join(string_or_list_args)
|
|
||||||
|
|
||||||
return str(string_or_list_args)
|
|
||||||
|
@ -1,184 +0,0 @@
|
|||||||
from random import choice
|
|
||||||
from re import search
|
|
||||||
from string import ascii_letters, digits
|
|
||||||
from types import SimpleNamespace
|
|
||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from pytest import fixture, raises
|
|
||||||
|
|
||||||
from scwrypts.test import get_generator
|
|
||||||
|
|
||||||
from .exceptions import MissingScwryptsExecutableError, BadScwryptsLookupError, MissingScwryptsGroupOrTypeError
|
|
||||||
from .scwrypts import scwrypts
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
def test_scwrypts(sample, _scwrypts):
|
|
||||||
assert validate_scwrypts_output(sample, _scwrypts)
|
|
||||||
|
|
||||||
def test_scwrypts_finds_system_executable(sample, _scwrypts, mock_which):
|
|
||||||
mock_which.assert_called_once_with(sample.env['SCWRYPTS_EXECUTABLE'])
|
|
||||||
|
|
||||||
def test_scwrypts_uses_configured_executable_path(_scwrypts, mock_getenv):
|
|
||||||
mock_getenv.assert_any_call('SCWRYPTS_EXECUTABLE', 'scwrypts')
|
|
||||||
|
|
||||||
def test_scwrypts_uses_correct_depth(_scwrypts, mock_getenv):
|
|
||||||
mock_getenv.assert_any_call('SUBSCWRYPT', '')
|
|
||||||
|
|
||||||
def test_scwrypts_runs_subprocess(_scwrypts, mock_run):
|
|
||||||
mock_run.assert_called_once()
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
def test_scwrypts_omit_optionals(sample, _scwrypts_omit_optionals):
|
|
||||||
assert validate_scwrypts_output(sample, _scwrypts_omit_optionals)
|
|
||||||
|
|
||||||
def test_scwrypts_omit_optionals_finds_system_executable(sample, _scwrypts_omit_optionals, mock_which):
|
|
||||||
mock_which.assert_called_once_with('scwrypts')
|
|
||||||
|
|
||||||
def test_scwrypts_omit_optionals_uses_configured_executable_path(_scwrypts_omit_optionals, mock_getenv):
|
|
||||||
mock_getenv.assert_any_call('SCWRYPTS_EXECUTABLE', 'scwrypts')
|
|
||||||
|
|
||||||
def test_scwrypts_omit_optionals_uses_correct_depth(_scwrypts_omit_optionals, mock_getenv):
|
|
||||||
mock_getenv.assert_any_call('SUBSCWRYPT', '')
|
|
||||||
|
|
||||||
def test_scwrypts_omit_optionals_runs_subprocess(_scwrypts_omit_optionals, mock_run):
|
|
||||||
mock_run.assert_called_once()
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
def test_invalid_lookup_missing_patterns_and_name(sample):
|
|
||||||
sample.patterns = None
|
|
||||||
sample.name = None
|
|
||||||
with raises(BadScwryptsLookupError):
|
|
||||||
scwrypts(**get_scwrypts_args(sample))
|
|
||||||
|
|
||||||
def test_invalid_name_lookup_missing_group(sample):
|
|
||||||
sample.group = None
|
|
||||||
with raises(MissingScwryptsGroupOrTypeError):
|
|
||||||
scwrypts(**get_scwrypts_args(sample))
|
|
||||||
|
|
||||||
def test_invalid_name_lookup_missing_type(sample):
|
|
||||||
sample._type = None # pylint: disable=protected-access
|
|
||||||
with raises(MissingScwryptsGroupOrTypeError):
|
|
||||||
scwrypts(**get_scwrypts_args(sample))
|
|
||||||
|
|
||||||
def test_invalid_scwrypts_installation(sample, mock_which):
|
|
||||||
mock_which.return_value = None
|
|
||||||
with raises(MissingScwryptsExecutableError):
|
|
||||||
scwrypts(**get_scwrypts_args(sample))
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
generate = get_generator({
|
|
||||||
'str_length_minimum': 8,
|
|
||||||
'str_length_maximum': 128,
|
|
||||||
'character_set': ascii_letters + digits + '/-_'
|
|
||||||
})
|
|
||||||
|
|
||||||
def _generate_str_or_list_arg():
|
|
||||||
random_arg = generate(list, {'data_types': {str}})
|
|
||||||
return random_arg if choice([str, list]) == list else ' '.join(random_arg)
|
|
||||||
|
|
||||||
@fixture(name='sample')
|
|
||||||
def fixture_sample():
|
|
||||||
sample = SimpleNamespace(
|
|
||||||
patterns = _generate_str_or_list_arg(),
|
|
||||||
args = _generate_str_or_list_arg(),
|
|
||||||
executable_args = _generate_str_or_list_arg(),
|
|
||||||
|
|
||||||
name = generate(str),
|
|
||||||
group = generate(str),
|
|
||||||
_type = generate(str),
|
|
||||||
|
|
||||||
executable = generate(str),
|
|
||||||
|
|
||||||
env = {
|
|
||||||
'SCWRYPTS_EXECUTABLE': generate(str),
|
|
||||||
'SUBSCWRYPT': str(generate(int, {'minimum': 1, 'maximum': 99})),
|
|
||||||
},
|
|
||||||
|
|
||||||
returncode = generate(int),
|
|
||||||
stdout = generate(str),
|
|
||||||
stderr = generate(str),
|
|
||||||
)
|
|
||||||
|
|
||||||
return sample
|
|
||||||
|
|
||||||
def get_scwrypts_args(sample):
|
|
||||||
return {
|
|
||||||
key: getattr(sample, key)
|
|
||||||
for key in [
|
|
||||||
'patterns',
|
|
||||||
'args',
|
|
||||||
'executable_args',
|
|
||||||
'name',
|
|
||||||
'group',
|
|
||||||
'_type',
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='mock_which', autouse=True)
|
|
||||||
def fixture_mock_which(sample):
|
|
||||||
with patch('scwrypts.scwrypts.scwrypts.which') as mock:
|
|
||||||
mock.return_value = sample.executable
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='mock_getenv', autouse=True)
|
|
||||||
def fixture_mock_getenv(sample):
|
|
||||||
with patch('scwrypts.scwrypts.scwrypts.getenv') as mock:
|
|
||||||
mock.side_effect = sample.env.get
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
@fixture(name='mock_run', autouse=True)
|
|
||||||
def fixture_mock_run(sample):
|
|
||||||
with patch('scwrypts.scwrypts.scwrypts.run') as mock:
|
|
||||||
mock.side_effect = lambda *args, **_kwargs: SimpleNamespace(
|
|
||||||
args = args,
|
|
||||||
returncode = sample.returncode,
|
|
||||||
stdout = sample.stdout,
|
|
||||||
stderr = sample.stderr,
|
|
||||||
)
|
|
||||||
yield mock
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@fixture(name='_scwrypts')
|
|
||||||
def fixture_scwrypts(sample):
|
|
||||||
return scwrypts(**get_scwrypts_args(sample))
|
|
||||||
|
|
||||||
@fixture(name='_scwrypts_omit_optionals')
|
|
||||||
def fixture_scwrypts_omit_optionals(sample):
|
|
||||||
sample.args = None
|
|
||||||
sample.executable_args = None
|
|
||||||
|
|
||||||
del sample.env['SCWRYPTS_EXECUTABLE']
|
|
||||||
del sample.env['SUBSCWRYPT']
|
|
||||||
|
|
||||||
return scwrypts(**get_scwrypts_args(sample))
|
|
||||||
|
|
||||||
def validate_scwrypts_output(sample, output):
|
|
||||||
#
|
|
||||||
# I would love to use 'assert _scwrypts == SimpleNamespace(...expected...)'
|
|
||||||
# but the output.args is difficult to recreate without copying all the
|
|
||||||
# processing logic over from the scwrypts function
|
|
||||||
#
|
|
||||||
# opting for a bit of a strange equality test here, checking the args
|
|
||||||
# as closely as possible without copying parsing logic
|
|
||||||
#
|
|
||||||
run_args_reduced_to_a_single_string = len(output.args) == 1
|
|
||||||
run_args_follow_expected_form = search(
|
|
||||||
fr'^SUBSCWRYPT=.* {sample.executable} .*-- .*$',
|
|
||||||
output.args[0],
|
|
||||||
)
|
|
||||||
|
|
||||||
return all([
|
|
||||||
run_args_reduced_to_a_single_string,
|
|
||||||
run_args_follow_expected_form,
|
|
||||||
output.returncode == sample.returncode,
|
|
||||||
output.stdout == sample.stdout,
|
|
||||||
output.stderr == sample.stderr,
|
|
||||||
])
|
|
@ -1,10 +1 @@
|
|||||||
'''
|
from .random_generator import generate
|
||||||
automated testing utilties, but primarily a random data generator
|
|
||||||
'''
|
|
||||||
__all__ = [
|
|
||||||
'generate',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .generate import generate, get_generator
|
|
||||||
|
|
||||||
from .character_set import *
|
|
||||||
|
@ -1,13 +0,0 @@
|
|||||||
'''
|
|
||||||
string constants typically used for randomly generated data
|
|
||||||
|
|
||||||
the 'string' standard library already contains many character sets,
|
|
||||||
but not these :)
|
|
||||||
'''
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
'uri',
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
uri = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$&\'()*+,;='
|
|
@ -1,387 +0,0 @@
|
|||||||
from csv import writer, QUOTE_NONNUMERIC
|
|
||||||
from io import StringIO
|
|
||||||
from json import dumps, loads
|
|
||||||
from random import randint, uniform, choice
|
|
||||||
from re import sub
|
|
||||||
from string import printable
|
|
||||||
from typing import Hashable, Callable
|
|
||||||
from uuid import uuid4
|
|
||||||
|
|
||||||
from requests import Response, status_codes
|
|
||||||
from yaml import safe_dump
|
|
||||||
|
|
||||||
from .exceptions import NoDataTypeError, BadGeneratorTypeError
|
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_OPTIONS = {
|
|
||||||
'data_types': None,
|
|
||||||
'minimum': 0,
|
|
||||||
'maximum': 64,
|
|
||||||
'depth': 1,
|
|
||||||
'character_set': None,
|
|
||||||
'bool_nullable': False,
|
|
||||||
'str_length': None,
|
|
||||||
'str_length_minimum': 0,
|
|
||||||
'str_length_maximum': 64,
|
|
||||||
'uuid_output_type': 'uuid', # str or 'uuid'
|
|
||||||
'list_length': 8,
|
|
||||||
'set_length': 8,
|
|
||||||
'dict_length': 8,
|
|
||||||
'csv_bool_nullable': True,
|
|
||||||
'csv_columns': None,
|
|
||||||
'csv_columns_minimum': 1,
|
|
||||||
'csv_columns_maximum': 16,
|
|
||||||
'csv_rows': None,
|
|
||||||
'csv_rows_minimum': 2,
|
|
||||||
'csv_rows_maximum': 16,
|
|
||||||
'csv_output_type': 'stringio', # str or 'stringio'
|
|
||||||
'json_initial_type': dict, # typically dict or list
|
|
||||||
'json_bool_nullable': True,
|
|
||||||
'json_output_type': 'stringio', # str or 'stringio'
|
|
||||||
'yaml_initial_type': dict, # typically dict or list
|
|
||||||
'yaml_bool_nullable': True,
|
|
||||||
'yaml_use_default_flow_style': False,
|
|
||||||
'yaml_output_type': 'stringio', # str or 'stringio'
|
|
||||||
'requests_response_status_code': status_codes.codes[200],
|
|
||||||
}
|
|
||||||
|
|
||||||
def get_generator(default_options=None):
|
|
||||||
if default_options is None:
|
|
||||||
default_options = {}
|
|
||||||
|
|
||||||
def generator_function(data_type=None, options_overrides=None):
|
|
||||||
if options_overrides is None:
|
|
||||||
options_overrides = {}
|
|
||||||
|
|
||||||
return generate(
|
|
||||||
data_type = data_type,
|
|
||||||
options = default_options | options_overrides,
|
|
||||||
)
|
|
||||||
|
|
||||||
return generator_function
|
|
||||||
|
|
||||||
def generate(data_type=None, options=None):
|
|
||||||
'''
|
|
||||||
generate random data with the call of a function
|
|
||||||
use data_type to generate a single value
|
|
||||||
|
|
||||||
use options to set generation options (key = type, value = kwargs)
|
|
||||||
|
|
||||||
use options.data_types and omit data_type to generate a random type
|
|
||||||
'''
|
|
||||||
if options is None:
|
|
||||||
options = {}
|
|
||||||
|
|
||||||
options = DEFAULT_OPTIONS | options
|
|
||||||
|
|
||||||
if data_type is None:
|
|
||||||
if options['data_types'] is None or len(options['data_types']) == 0:
|
|
||||||
raise NoDataTypeError()
|
|
||||||
|
|
||||||
return generate(
|
|
||||||
data_type=choice(list(options['data_types'])),
|
|
||||||
options=options,
|
|
||||||
)
|
|
||||||
|
|
||||||
if not isinstance(data_type, str):
|
|
||||||
data_type = data_type.__name__
|
|
||||||
|
|
||||||
if data_type not in Generator.get_supported_data_types():
|
|
||||||
raise BadGeneratorTypeError(data_type)
|
|
||||||
|
|
||||||
return getattr(Generator, f'_{data_type}')(options)
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
SUPPORTED_DATA_TYPES = None
|
|
||||||
|
|
||||||
class Generator:
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def get_supported_data_types(cls):
|
|
||||||
global SUPPORTED_DATA_TYPES # pylint: disable=global-statement
|
|
||||||
|
|
||||||
if SUPPORTED_DATA_TYPES is None:
|
|
||||||
SUPPORTED_DATA_TYPES = {
|
|
||||||
sub('^_', '', data_type)
|
|
||||||
for data_type, method in Generator.__dict__.items()
|
|
||||||
if isinstance(method, staticmethod)
|
|
||||||
}
|
|
||||||
|
|
||||||
return SUPPORTED_DATA_TYPES
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def filter_data_types(cls, options, filters=None):
|
|
||||||
'''
|
|
||||||
returns an options dict with appropriately filtered data_types
|
|
||||||
|
|
||||||
if data_types are not yet defined, starts with all supported data_types
|
|
||||||
'''
|
|
||||||
if options['data_types'] is None:
|
|
||||||
options['data_types'] = Generator.get_supported_data_types()
|
|
||||||
|
|
||||||
if filters is None or len(filters) == 0:
|
|
||||||
return options
|
|
||||||
|
|
||||||
return {
|
|
||||||
**options,
|
|
||||||
'data_types': set(filter(
|
|
||||||
lambda data_type: all(( f(data_type, options) for f in filters )),
|
|
||||||
options['data_types'],
|
|
||||||
)),
|
|
||||||
}
|
|
||||||
|
|
||||||
class Filters:
|
|
||||||
@staticmethod
|
|
||||||
def hashable(data_type, _options):
|
|
||||||
if isinstance(data_type, Callable):
|
|
||||||
return isinstance(data_type(), Hashable)
|
|
||||||
if not isinstance(data_type, str):
|
|
||||||
data_type = data_type.__name__
|
|
||||||
return data_type in { 'bool', 'int', 'float', 'chr', 'str', 'uuid' }
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def filelike(data_type, _options):
|
|
||||||
return data_type in { 'csv', 'json', 'yaml' }
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def complex(data_type, _options):
|
|
||||||
return data_type in { 'requests_Response' }
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def basic(data_type, options):
|
|
||||||
return all([
|
|
||||||
not Generator.Filters.filelike(data_type, options),
|
|
||||||
not Generator.Filters.complex(data_type, options),
|
|
||||||
])
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def pythonset(data_type, _options):
|
|
||||||
if not isinstance(data_type, str):
|
|
||||||
data_type = data_type.__name__
|
|
||||||
return data_type == 'set'
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def csvsafe(data_type, options):
|
|
||||||
options['depth'] = max(1, options['depth'])
|
|
||||||
return all([
|
|
||||||
Generator.Filters.basic(data_type, options),
|
|
||||||
not Generator.Filters.pythonset(data_type, options),
|
|
||||||
])
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def jsonsafe(data_type, options):
|
|
||||||
return all([
|
|
||||||
Generator.Filters.basic(data_type, options),
|
|
||||||
not Generator.Filters.pythonset(data_type, options),
|
|
||||||
])
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def yamlsafe(data_type, options):
|
|
||||||
return all([
|
|
||||||
Generator.Filters.basic(data_type, options),
|
|
||||||
not Generator.Filters.pythonset(data_type, options),
|
|
||||||
])
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def get_option_with_range(cls, options, option_key, data_type=int):
|
|
||||||
'''
|
|
||||||
typically an integer range, allows both:
|
|
||||||
- setting a fixed configuration (e.g. 'str_length')
|
|
||||||
- allowing a configuration range (e.g. 'str_length_minimum' and 'str_length_maximum')
|
|
||||||
'''
|
|
||||||
fixed = options.get(option_key, None)
|
|
||||||
if fixed is not None:
|
|
||||||
return fixed
|
|
||||||
|
|
||||||
return generate(data_type, {
|
|
||||||
'minimum': options[f'{option_key}_minimum'],
|
|
||||||
'maximum': options[f'{option_key}_maximum'],
|
|
||||||
})
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _bool(options):
|
|
||||||
return choice([True, False, None]) if options['bool_nullable'] else choice([True, False])
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _int(options):
|
|
||||||
return randint(options['minimum'], options['maximum'])
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _float(options):
|
|
||||||
return uniform(options['minimum'], options['maximum'])
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _chr(options):
|
|
||||||
character_set = options['character_set']
|
|
||||||
return choice(character_set) if character_set is not None else chr(randint(0,65536))
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _str(options):
|
|
||||||
return ''.join((
|
|
||||||
generate(chr, options)
|
|
||||||
for _ in range(Generator.get_option_with_range(options, 'str_length'))
|
|
||||||
))
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _uuid(options):
|
|
||||||
'''
|
|
||||||
creates a UUID object or a str containing a uuid (v4)
|
|
||||||
'''
|
|
||||||
uuid = uuid4()
|
|
||||||
return str(uuid) if options['uuid_output_type'] == str else uuid
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _list(options):
|
|
||||||
if options['depth'] <= 0:
|
|
||||||
return []
|
|
||||||
|
|
||||||
options['depth'] -= 1
|
|
||||||
options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.basic,
|
|
||||||
])
|
|
||||||
|
|
||||||
return [ generate(None, {**options}) for _ in range(options['list_length']) ]
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _set(options):
|
|
||||||
if options['depth'] <= 0:
|
|
||||||
return set()
|
|
||||||
|
|
||||||
options['depth'] -= 1
|
|
||||||
options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.hashable,
|
|
||||||
])
|
|
||||||
|
|
||||||
return { generate(None, options) for _ in range(options['set_length']) }
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _dict(options):
|
|
||||||
if options['depth'] <= 0:
|
|
||||||
return {}
|
|
||||||
|
|
||||||
options['depth'] -= 1
|
|
||||||
options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.basic,
|
|
||||||
])
|
|
||||||
|
|
||||||
key_options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.hashable,
|
|
||||||
])
|
|
||||||
|
|
||||||
if len(options['data_types']) == 0 or len(key_options['data_types']) == 0:
|
|
||||||
return {}
|
|
||||||
|
|
||||||
return {
|
|
||||||
generate(None, key_options): generate(None, options)
|
|
||||||
for _ in range(options['dict_length'])
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _csv(options):
|
|
||||||
'''
|
|
||||||
creates a StringIO object containing csv data
|
|
||||||
'''
|
|
||||||
if options['character_set'] is None:
|
|
||||||
options['character_set'] = printable
|
|
||||||
|
|
||||||
options['bool_nullable'] = options['csv_bool_nullable']
|
|
||||||
options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.csvsafe,
|
|
||||||
])
|
|
||||||
|
|
||||||
columns = Generator.get_option_with_range(options, 'csv_columns')
|
|
||||||
rows = Generator.get_option_with_range(options, 'csv_rows')
|
|
||||||
|
|
||||||
|
|
||||||
csv = StringIO()
|
|
||||||
csv_writer = writer(csv, quoting=QUOTE_NONNUMERIC)
|
|
||||||
|
|
||||||
options['list_length'] = columns
|
|
||||||
|
|
||||||
[ # pylint: disable=expression-not-assigned
|
|
||||||
csv_writer.writerow(generate(list, options))
|
|
||||||
for _ in range(rows)
|
|
||||||
]
|
|
||||||
|
|
||||||
csv.seek(0)
|
|
||||||
return csv.getvalue() if options['csv_output_type'] == str else csv
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _json(options):
|
|
||||||
'''
|
|
||||||
creates a StringIO object or str containing json data
|
|
||||||
'''
|
|
||||||
|
|
||||||
if options['character_set'] is None:
|
|
||||||
options['character_set'] = printable
|
|
||||||
|
|
||||||
options['bool_nullable'] = options['json_bool_nullable']
|
|
||||||
options['uuid_output_type'] = str
|
|
||||||
options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.jsonsafe,
|
|
||||||
])
|
|
||||||
|
|
||||||
json = dumps(generate(
|
|
||||||
options['json_initial_type'],
|
|
||||||
{**options},
|
|
||||||
))
|
|
||||||
|
|
||||||
return json if options['json_output_type'] == str else StringIO(json)
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _yaml(options):
|
|
||||||
'''
|
|
||||||
creates a StringIO object or str containing yaml data
|
|
||||||
'''
|
|
||||||
if options['character_set'] is None:
|
|
||||||
options['character_set'] = printable
|
|
||||||
|
|
||||||
options['bool_nullable'] = options['yaml_bool_nullable']
|
|
||||||
options['uuid_output_type'] = str
|
|
||||||
options = Generator.filter_data_types(options, [
|
|
||||||
Generator.Filters.yamlsafe,
|
|
||||||
])
|
|
||||||
|
|
||||||
yaml = StringIO()
|
|
||||||
safe_dump(
|
|
||||||
generate(options['yaml_initial_type'], {**options}),
|
|
||||||
yaml,
|
|
||||||
default_flow_style=options['yaml_use_default_flow_style'],
|
|
||||||
)
|
|
||||||
yaml.seek(0)
|
|
||||||
|
|
||||||
return yaml.getvalue() if options['yaml_output_type'] == str else yaml
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _requests_Response(options):
|
|
||||||
'''
|
|
||||||
creates a requests.Response-like object containing json data
|
|
||||||
'''
|
|
||||||
|
|
||||||
options['json_output_type'] = str
|
|
||||||
|
|
||||||
response = Response()
|
|
||||||
response.status_code = options['requests_response_status_code']
|
|
||||||
json = loads(generate('json', options))
|
|
||||||
response.json = lambda: json
|
|
||||||
|
|
||||||
return response
|
|
240
py/lib/scwrypts/test/random_generator.py
Normal file
240
py/lib/scwrypts/test/random_generator.py
Normal file
@ -0,0 +1,240 @@
|
|||||||
|
from csv import writer, QUOTE_NONNUMERIC
|
||||||
|
from io import StringIO
|
||||||
|
from json import dumps
|
||||||
|
from random import randint, uniform, choice
|
||||||
|
from re import sub
|
||||||
|
from string import printable
|
||||||
|
from yaml import safe_dump
|
||||||
|
|
||||||
|
from .exceptions import NoDataTypeError, BadGeneratorTypeError
|
||||||
|
|
||||||
|
|
||||||
|
SUPPORTED_DATA_TYPES = None
|
||||||
|
|
||||||
|
DEFAULT_OPTIONS = {
|
||||||
|
'data_types': None,
|
||||||
|
'minimum': 0,
|
||||||
|
'maximum': 64,
|
||||||
|
'depth': 1,
|
||||||
|
'character_set': None,
|
||||||
|
'bool_nullable': False,
|
||||||
|
'str_length': None,
|
||||||
|
'str_minimum_length': 0,
|
||||||
|
'str_maximum_length': 32,
|
||||||
|
'list_length': 8,
|
||||||
|
'set_length': 8,
|
||||||
|
'dict_length': 8,
|
||||||
|
'dict_key_types': {int, float, chr, str},
|
||||||
|
'csv_columns': None,
|
||||||
|
'csv_columns_minimum': 1,
|
||||||
|
'csv_columns_maximum': 16,
|
||||||
|
'csv_rows': None,
|
||||||
|
'csv_rows_minimum': 2,
|
||||||
|
'csv_rows_maximum': 16,
|
||||||
|
'json_initial_type': dict,
|
||||||
|
'yaml_initial_type': dict,
|
||||||
|
}
|
||||||
|
|
||||||
|
def generate(data_type=None, options=None):
|
||||||
|
'''
|
||||||
|
generate random data with the call of a function
|
||||||
|
use data_type to generate a single value
|
||||||
|
|
||||||
|
use options to set generation options (key = type, value = kwargs)
|
||||||
|
|
||||||
|
use options.data_types and omit data_type to generate a random type
|
||||||
|
'''
|
||||||
|
if options is None:
|
||||||
|
options = {**DEFAULT_OPTIONS}
|
||||||
|
else:
|
||||||
|
options = DEFAULT_OPTIONS | options
|
||||||
|
|
||||||
|
if data_type is None and options['data_types'] is None:
|
||||||
|
raise NoDataTypeError()
|
||||||
|
|
||||||
|
if data_type is None and options['data_types'] is not None:
|
||||||
|
return generate(data_type=choice(list(options['data_types'])), options=options)
|
||||||
|
|
||||||
|
if not isinstance(data_type, str):
|
||||||
|
data_type = data_type.__name__
|
||||||
|
|
||||||
|
if data_type not in Generator.get_supported_data_types():
|
||||||
|
raise BadGeneratorTypeError(data_type)
|
||||||
|
|
||||||
|
return getattr(Generator, f'_{data_type}')(options)
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
class Generator:
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_supported_data_types(cls):
|
||||||
|
global SUPPORTED_DATA_TYPES # pylint: disable=global-statement
|
||||||
|
if SUPPORTED_DATA_TYPES is None:
|
||||||
|
SUPPORTED_DATA_TYPES = {
|
||||||
|
sub('^_', '', data_type)
|
||||||
|
for data_type, method in Generator.__dict__.items()
|
||||||
|
if isinstance(method, staticmethod)
|
||||||
|
}
|
||||||
|
|
||||||
|
return SUPPORTED_DATA_TYPES
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _bool(options):
|
||||||
|
return choice([True, False, None]) if options['bool_nullable'] else choice([True, False])
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _int(options):
|
||||||
|
return randint(options['minimum'], options['maximum'])
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _float(options):
|
||||||
|
return uniform(options['minimum'], options['maximum'])
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _chr(options):
|
||||||
|
character_set = options['character_set']
|
||||||
|
return choice(character_set) if character_set is not None else chr(randint(0,65536))
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _str(options):
|
||||||
|
length = options['str_length']
|
||||||
|
if length is None:
|
||||||
|
length = generate(int, {
|
||||||
|
'minimum': options['str_minimum_length'],
|
||||||
|
'maximum': options['str_maximum_length'],
|
||||||
|
})
|
||||||
|
return ''.join((generate(chr, options) for _ in range(length)))
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _list(options):
|
||||||
|
if options['depth'] <= 0:
|
||||||
|
return []
|
||||||
|
|
||||||
|
options['depth'] -= 1
|
||||||
|
|
||||||
|
if options['data_types'] is None:
|
||||||
|
options['data_types'] = {bool, int, float, chr, str}
|
||||||
|
|
||||||
|
return [ generate(None, options) for _ in range(options['list_length']) ]
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _set(options):
|
||||||
|
if options['depth'] <= 0:
|
||||||
|
return set()
|
||||||
|
|
||||||
|
options['depth'] -= 1
|
||||||
|
|
||||||
|
if options['data_types'] is None:
|
||||||
|
options['data_types'] = {bool, int, float, chr, str}
|
||||||
|
|
||||||
|
set_options = options | {'data_types': options['data_types'] - {list, dict, set}}
|
||||||
|
|
||||||
|
return { generate(None, set_options) for _ in range(options['set_length']) }
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _dict(options):
|
||||||
|
if options['depth'] <= 0:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
options['depth'] -= 1
|
||||||
|
|
||||||
|
if options['data_types'] is None:
|
||||||
|
options['data_types'] = {bool, int, float, chr, str, list, set, dict}
|
||||||
|
|
||||||
|
if len(options['data_types']) == 0:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
key_options = options | {'data_types': options['dict_key_types']}
|
||||||
|
return {
|
||||||
|
generate(None, key_options): generate(None, options)
|
||||||
|
for _ in range(options['dict_length'])
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _csv(options):
|
||||||
|
'''
|
||||||
|
creates a StringIO object containing csv data
|
||||||
|
'''
|
||||||
|
if options['data_types'] is None:
|
||||||
|
options['data_types'] = {int, float, str}
|
||||||
|
|
||||||
|
columns = options['csv_columns']
|
||||||
|
if columns is None:
|
||||||
|
columns = max(1, generate(int, {
|
||||||
|
'minimum': options['csv_columns_minimum'],
|
||||||
|
'maximum': options['csv_columns_maximum'],
|
||||||
|
}))
|
||||||
|
|
||||||
|
rows = options['csv_rows']
|
||||||
|
if rows is None:
|
||||||
|
rows = max(1, generate(int, {
|
||||||
|
'minimum': options['csv_rows_minimum'],
|
||||||
|
'maximum': options['csv_rows_maximum'],
|
||||||
|
}))
|
||||||
|
|
||||||
|
if options['character_set'] is None:
|
||||||
|
options['character_set'] = printable
|
||||||
|
|
||||||
|
csv = StringIO()
|
||||||
|
csv_writer = writer(csv, quoting=QUOTE_NONNUMERIC)
|
||||||
|
|
||||||
|
options['list_length'] = columns
|
||||||
|
|
||||||
|
for line in [ generate(list, options) for _ in range(rows) ]:
|
||||||
|
csv_writer.writerow(line)
|
||||||
|
|
||||||
|
csv.seek(0)
|
||||||
|
return csv
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _json(options):
|
||||||
|
'''
|
||||||
|
creates a str containing json data
|
||||||
|
'''
|
||||||
|
if options['data_types'] is None:
|
||||||
|
options['data_types'] = {bool, int, float, str, list, dict}
|
||||||
|
|
||||||
|
if options['character_set'] is None:
|
||||||
|
options['character_set'] = printable
|
||||||
|
|
||||||
|
options['dict_key_types'] = { int, float, str }
|
||||||
|
|
||||||
|
data = generate(options['json_initial_type'], options)
|
||||||
|
return dumps(data)
|
||||||
|
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _yaml(options):
|
||||||
|
'''
|
||||||
|
creates a StringIO object containing yaml data
|
||||||
|
'''
|
||||||
|
if options['data_types'] is None:
|
||||||
|
options['data_types'] = {bool, int, float, str, list, dict}
|
||||||
|
|
||||||
|
if options['character_set'] is None:
|
||||||
|
options['character_set'] = printable
|
||||||
|
|
||||||
|
options['dict_key_types'] = { int, float, str }
|
||||||
|
|
||||||
|
yaml = StringIO()
|
||||||
|
safe_dump(generate(options['yaml_initial_type'], options), yaml, default_flow_style=False)
|
||||||
|
|
||||||
|
yaml.seek(0)
|
||||||
|
return yaml
|
||||||
|
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
if __name__ == '__main__':
|
||||||
|
print(generate('json', {'depth': 3}))
|
@ -1,24 +1,14 @@
|
|||||||
from os import getenv
|
from os import getenv
|
||||||
from pprint import pprint
|
|
||||||
from random import randint
|
from random import randint
|
||||||
|
|
||||||
from .generate import generate, Generator
|
from .random_generator import generate, Generator
|
||||||
|
|
||||||
ITERATIONS = int(
|
|
||||||
getenv(
|
|
||||||
'PYTEST_ITERATIONS__scwrypts__test__generator',
|
|
||||||
getenv('PYTEST_ITERATIONS', '99'), # CI should use at least 999
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
FILE_LIKE_DATA_TYPES = { 'csv', 'json', 'yaml' }
|
ITERATIONS = int(getenv('PYTEST_ITERATIONS__scwrypts__test__random_generator', getenv('PYTEST_ITERATIONS', '999')))
|
||||||
|
|
||||||
|
|
||||||
def test_generate(): # generators should be quick and "just work" (no Exceptions)
|
def test_generate(): # generators should be quick and "just work" (no Exceptions)
|
||||||
print()
|
|
||||||
for data_type in Generator.get_supported_data_types():
|
for data_type in Generator.get_supported_data_types():
|
||||||
print(f'------- {data_type} -------')
|
|
||||||
sample = generate(data_type)
|
|
||||||
pprint(sample.getvalue() if data_type in {'csv', 'json', 'yaml'} else sample)
|
|
||||||
for _ in range(ITERATIONS):
|
for _ in range(ITERATIONS):
|
||||||
generate(data_type)
|
generate(data_type)
|
||||||
|
|
||||||
@ -51,4 +41,4 @@ def test_generate_range_negative():
|
|||||||
|
|
||||||
def test_generate_bool_nullable():
|
def test_generate_bool_nullable():
|
||||||
for data_type in Generator.get_supported_data_types():
|
for data_type in Generator.get_supported_data_types():
|
||||||
generate(data_type, {'bool_nullable': True})
|
generate(data_type, {'bool': {'nullable': True}})
|
@ -1,13 +1,2 @@
|
|||||||
'''
|
|
||||||
loads the twilio.rest.Client by referencing TWILIO__API_KEY,
|
|
||||||
TWILIO__API_SECRET, and TWILIO__ACCOUNT_SID in your scwrypts
|
|
||||||
environment
|
|
||||||
'''
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
'get_client',
|
|
||||||
'send_sms',
|
|
||||||
]
|
|
||||||
|
|
||||||
from .client import get_client
|
from .client import get_client
|
||||||
from .send_sms import send_sms
|
from .send_sms import send_sms
|
||||||
|
377
run
Executable file
377
run
Executable file
@ -0,0 +1,377 @@
|
|||||||
|
#!/bin/zsh
|
||||||
|
export EXECUTION_DIR=$(pwd)
|
||||||
|
source "${0:a:h}/zsh/lib/import.driver.zsh" || exit 42
|
||||||
|
#####################################################################
|
||||||
|
() {
|
||||||
|
cd "$SCWRYPTS_ROOT__scwrypts"
|
||||||
|
GIT_SCWRYPTS() { git -C "$SCWRYPTS_ROOT__scwrypts" $@; }
|
||||||
|
local ERRORS=0
|
||||||
|
local USAGE='
|
||||||
|
usage: scwrypts [...options...] [...patterns...] -- [...script options...]
|
||||||
|
|
||||||
|
options:
|
||||||
|
selection
|
||||||
|
-m, --name <scwrypt-name> only run the script if there is an exact match
|
||||||
|
(requires type and group)
|
||||||
|
-g, --group <group-name> only use scripts from the indicated group
|
||||||
|
-t, --type <type-name> only use scripts of the indicated type
|
||||||
|
|
||||||
|
runtime
|
||||||
|
-y, --yes auto-accept all [yn] prompts through current scwrypt
|
||||||
|
-e, --env <env-name> set environment; overwrites SCWRYPTS_ENV
|
||||||
|
-n shorthand for "--log-level 0"
|
||||||
|
-v, --log-level [0-4] set scwrypts log level to one of the following:
|
||||||
|
0 : only command output and critical failures; skips logfile
|
||||||
|
1 : add success / failure messages
|
||||||
|
2 : (default) include status update messages
|
||||||
|
3 : (CI default) include warning messages
|
||||||
|
4 : include debug messages
|
||||||
|
|
||||||
|
alternate commands
|
||||||
|
-h, --help display this message and exit
|
||||||
|
-l, --list print out command list and exit
|
||||||
|
--list-envs print out environment list and exit
|
||||||
|
--update update scwrypts library to latest version
|
||||||
|
--version print out scwrypts version and exit
|
||||||
|
|
||||||
|
patterns:
|
||||||
|
- a list of glob patterns to loose-match a scwrypt by name
|
||||||
|
|
||||||
|
script options:
|
||||||
|
- everything after "--" is forwarded to the scwrypt you run
|
||||||
|
("-- --help" will provide more information)
|
||||||
|
'
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
### cli argument parsing and global configuration ###################
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
local ENV_NAME="$SCWRYPTS_ENV"
|
||||||
|
local SEARCH_PATTERNS=()
|
||||||
|
|
||||||
|
local VARSPLIT SEARCH_GROUP SEARCH_TYPE SEARCH_NAME
|
||||||
|
|
||||||
|
[ ! $SCWRYPTS_LOG_LEVEL ] && {
|
||||||
|
local SCWRYPTS_LOG_LEVEL
|
||||||
|
[ $CI ] && SCWRYPTS_LOG_LEVEL=3 || SCWRYPTS_LOG_LEVEL=2
|
||||||
|
}
|
||||||
|
|
||||||
|
while [[ $# -gt 0 ]]
|
||||||
|
do
|
||||||
|
case $1 in
|
||||||
|
-[a-z][a-z]* )
|
||||||
|
VARSPLIT=$(echo "$1 " | sed 's/^\(-.\)\(.*\) /\1 -\2/')
|
||||||
|
set -- $(echo " $VARSPLIT ") ${@:2}
|
||||||
|
;;
|
||||||
|
|
||||||
|
### alternate commands ###################
|
||||||
|
|
||||||
|
-h | --help )
|
||||||
|
USAGE
|
||||||
|
return 0
|
||||||
|
;;
|
||||||
|
|
||||||
|
-l | --list )
|
||||||
|
SCWRYPTS__GET_AVAILABLE_SCWRYPTS
|
||||||
|
return 0
|
||||||
|
;;
|
||||||
|
|
||||||
|
--list-envs )
|
||||||
|
SCWRYPTS__GET_ENV_NAMES
|
||||||
|
return 0
|
||||||
|
;;
|
||||||
|
|
||||||
|
--version )
|
||||||
|
echo scwrypts $(GIT_SCWRYPTS describe --tags)
|
||||||
|
return 0
|
||||||
|
;;
|
||||||
|
|
||||||
|
--update )
|
||||||
|
GIT_SCWRYPTS fetch --quiet origin main
|
||||||
|
GIT_SCWRYPTS fetch --quiet origin main --tags
|
||||||
|
local SYNC_STATUS=$?
|
||||||
|
|
||||||
|
GIT_SCWRYPTS diff --exit-code origin/main -- . >/dev/null 2>&1
|
||||||
|
local DIFF_STATUS=$?
|
||||||
|
|
||||||
|
[[ $SYNC_STATUS -eq 0 ]] && [[ $DIFF_STATUS -eq 0 ]] && {
|
||||||
|
SUCCESS 'already up-to-date with origin/main'
|
||||||
|
} || {
|
||||||
|
GIT_SCWRYPTS rebase --autostash origin/main \
|
||||||
|
&& SUCCESS 'up-to-date with origin/main' \
|
||||||
|
&& GIT_SCWRYPTS log -n1 \
|
||||||
|
|| {
|
||||||
|
GIT_SCWRYPTS rebase --abort
|
||||||
|
ERROR 'unable to update scwrypts; please try manual upgrade'
|
||||||
|
REMINDER "installation in '$(pwd)'"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
;;
|
||||||
|
|
||||||
|
### scwrypts filters #####################
|
||||||
|
|
||||||
|
-m | --name )
|
||||||
|
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
||||||
|
SEARCH_NAME=$2
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
|
||||||
|
-g | --group )
|
||||||
|
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
||||||
|
SEARCH_GROUP=$2
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
|
||||||
|
-t | --type )
|
||||||
|
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
||||||
|
SEARCH_TYPE=$2
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
|
||||||
|
### runtime settings #####################
|
||||||
|
|
||||||
|
-y | --yes ) export __SCWRYPTS_YES=1 ;;
|
||||||
|
|
||||||
|
-n | --no-log )
|
||||||
|
SCWRYPTS_LOG_LEVEL=0
|
||||||
|
[[ $1 =~ ^--no-log$ ]] && WARNING 'the --no-log flag is deprecated and will be removed in scwrypts v4.2'
|
||||||
|
;;
|
||||||
|
|
||||||
|
-v | --log-level )
|
||||||
|
[[ $2 =~ ^[0-4]$ ]] || ERROR "invalid setting for log-level '$2'"
|
||||||
|
SCWRYPTS_LOG_LEVEL=$2
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
|
||||||
|
-e | --env )
|
||||||
|
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
||||||
|
|
||||||
|
[ $ENV_NAME ] && DEBUG 'overwriting session environment'
|
||||||
|
|
||||||
|
ENV_NAME="$2"
|
||||||
|
STATUS "using CLI environment '$ENV_NAME'"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
-- ) shift 1; break ;; # pass arguments after '--' to the scwrypt
|
||||||
|
--* ) ERROR "unrecognized argument '$1'" ;;
|
||||||
|
* ) SEARCH_PATTERNS+=($1) ;;
|
||||||
|
esac
|
||||||
|
shift 1
|
||||||
|
done
|
||||||
|
|
||||||
|
[ $SEARCH_NAME ] && {
|
||||||
|
[ $SEARCH_TYPE ] || ERROR '--name requires --type argument'
|
||||||
|
[ $SEARCH_GROUP ] || ERROR '--name requires --group argument'
|
||||||
|
}
|
||||||
|
|
||||||
|
CHECK_ERRORS
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
### scwrypts selection / filtering ##################################
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
local SCWRYPTS_AVAILABLE
|
||||||
|
SCWRYPTS_AVAILABLE=$(SCWRYPTS__GET_AVAILABLE_SCWRYPTS)
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
[ $SEARCH_NAME ] && SCWRYPTS_AVAILABLE=$({
|
||||||
|
echo $SCWRYPTS_AVAILABLE | head -n1
|
||||||
|
echo $SCWRYPTS_AVAILABLE | sed -e 's/\x1b\[[0-9;]*m//g' | grep "^$SEARCH_NAME *$SEARCH_TYPE *$SEARCH_GROUP\$"
|
||||||
|
}) || {
|
||||||
|
[ $SEARCH_TYPE ] && {
|
||||||
|
SCWRYPTS_AVAILABLE=$(\
|
||||||
|
{
|
||||||
|
echo $SCWRYPTS_AVAILABLE | head -n1
|
||||||
|
echo $SCWRYPTS_AVAILABLE | grep ' [^/]*'$SEARCH_TYPE'[^/]* '
|
||||||
|
} \
|
||||||
|
| awk '{$2=""; print $0;}' \
|
||||||
|
| sed 's/ \+$/'$(printf $__COLOR_RESET)'/; s/ \+/^/g' \
|
||||||
|
| column -ts '^'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
[ $SEARCH_GROUP ] && {
|
||||||
|
SCWRYPTS_AVAILABLE=$(
|
||||||
|
{
|
||||||
|
echo $SCWRYPTS_AVAILABLE | head -n1
|
||||||
|
echo $SCWRYPTS_AVAILABLE | grep "$SEARCH_GROUP"'[^/]*$'
|
||||||
|
} \
|
||||||
|
| awk '{$NF=""; print $0;}' \
|
||||||
|
| sed 's/ \+$/'$(printf $__COLOR_RESET)'/; s/ \+/^/g' \
|
||||||
|
| column -ts '^'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
[[ ${#SEARCH_PATTERNS[@]} -gt 0 ]] && {
|
||||||
|
POTENTIAL_ERROR+="\n PATTERNS : $SEARCH_PATTERNS"
|
||||||
|
local P
|
||||||
|
for P in ${SEARCH_PATTERNS[@]}
|
||||||
|
do
|
||||||
|
SCWRYPTS_AVAILABLE=$(
|
||||||
|
{
|
||||||
|
echo $SCWRYPTS_AVAILABLE | head -n1
|
||||||
|
echo $SCWRYPTS_AVAILABLE | grep $P
|
||||||
|
}
|
||||||
|
)
|
||||||
|
done
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
[[ $(echo $SCWRYPTS_AVAILABLE | wc -l) -lt 2 ]] && {
|
||||||
|
FAIL 1 "$(echo "
|
||||||
|
no such scwrypt exists
|
||||||
|
NAME : '$SEARCH_NAME'
|
||||||
|
TYPE : '$SEARCH_TYPE'
|
||||||
|
GROUP : '$SEARCH_GROUP'
|
||||||
|
PATTERNS : '$SEARCH_PATTERNS'
|
||||||
|
" | sed "1d; \$d; /''$/d")"
|
||||||
|
}
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
[[ $(echo $SCWRYPTS_AVAILABLE | wc -l) -eq 2 ]] \
|
||||||
|
&& SCWRYPT_SELECTION=$(echo $SCWRYPTS_AVAILABLE | tail -n1) \
|
||||||
|
|| SCWRYPT_SELECTION=$(echo $SCWRYPTS_AVAILABLE | FZF "select a script to run" --header-lines 1) \
|
||||||
|
;
|
||||||
|
|
||||||
|
[ $SCWRYPT_SELECTION ] || exit 2
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
local NAME TYPE GROUP
|
||||||
|
SCWRYPTS__SEPARATE_SCWRYPT_SELECTION $SCWRYPT_SELECTION
|
||||||
|
|
||||||
|
export SCWRYPT_NAME=$NAME
|
||||||
|
export SCWRYPT_TYPE=$TYPE
|
||||||
|
export SCWRYPT_GROUP=$GROUP
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
### environment variables and configuration validation ##############
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
local ENV_REQUIRED=true \
|
||||||
|
&& [ ! $CI ] \
|
||||||
|
&& [[ ! $SCWRYPT_NAME =~ scwrypts/logs ]] \
|
||||||
|
&& [[ ! $SCWRYPT_NAME =~ scwrypts/environment ]] \
|
||||||
|
|| ENV_REQUIRED=false
|
||||||
|
|
||||||
|
local REQUIRED_ENVIRONMENT_REGEX=$(eval echo '$SCWRYPTS_REQUIRED_ENVIRONMENT_REGEX__'$SCWRYPT_GROUP)
|
||||||
|
|
||||||
|
[[ $ENV_REQUIRED =~ true ]] && {
|
||||||
|
[ ! $ENV_NAME ] && ENV_NAME=$(SCWRYPTS__SELECT_ENV)
|
||||||
|
|
||||||
|
for GROUP in ${SCWRYPTS_GROUPS[@]}
|
||||||
|
do
|
||||||
|
local ENV_FILE=$(SCWRYPTS__GET_ENV_FILE "$ENV_NAME" "$GROUP")
|
||||||
|
source "$ENV_FILE" || FAIL 5 "missing or invalid environment '$GROUP/$ENV_NAME'"
|
||||||
|
|
||||||
|
for f in $(eval 'echo $SCWRYPTS_STATIC_CONFIG__'$GROUP)
|
||||||
|
do
|
||||||
|
source "$f" || FAIL 5 "invalid static config '$f'"
|
||||||
|
done
|
||||||
|
done
|
||||||
|
|
||||||
|
export ENV_NAME
|
||||||
|
}
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
[ $REQUIRED_ENVIRONMENT_REGEX ] && {
|
||||||
|
[[ $ENV_NAME =~ $REQUIRED_ENVIRONMENT_REGEX ]] \
|
||||||
|
|| FAIL 5 "group '$SCWRYPT_GROUP' requires current environment name to match '$REQUIRED_ENVIRONMENT_REGEX' (currently $ENV_NAME)"
|
||||||
|
}
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
[ ! $SUBSCWRYPT ] && [[ $ENV_NAME =~ prod ]] && {
|
||||||
|
STATUS "on '$ENV_NAME'; checking diff against origin/main"
|
||||||
|
|
||||||
|
GIT_SCWRYPTS fetch --quiet origin main
|
||||||
|
local SYNC_STATUS=$?
|
||||||
|
|
||||||
|
GIT_SCWRYPTS diff --exit-code origin/main -- . >&2
|
||||||
|
local DIFF_STATUS=$?
|
||||||
|
|
||||||
|
[[ $SYNC_STATUS -eq 0 ]] && [[ $DIFF_STATUS -eq 0 ]] && {
|
||||||
|
SUCCESS 'up-to-date with origin/main'
|
||||||
|
} || {
|
||||||
|
SCWRYPTS_LOG_LEVEL=3 WARNING "you are trying to run in ${__BRIGHT_RED}production${__YELLOW} but $([[ $SYNC_STATUS -ne 0 ]] && echo 'I am unable to verify your scwrypts version')$([[ $DIFF_STATUS -ne 0 ]] && echo 'your scwrypts is out-of-date (diff listed above)')"
|
||||||
|
|
||||||
|
yN 'continue?' || {
|
||||||
|
REMINDER "you can use 'scwrypts --update' to quickly update scwrypts to latest"
|
||||||
|
ABORT
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
##########################################
|
||||||
|
|
||||||
|
local RUN_STRING=$(SCWRYPTS__GET_RUNSTRING $SCWRYPT_NAME $SCWRYPT_TYPE $SCWRYPT_GROUP)
|
||||||
|
[ "$RUN_STRING" ] || return 42
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
### logging and pretty header/footer setup ##########################
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
local LOGFILE \
|
||||||
|
&& [[ $SCWRYPTS_LOG_LEVEL -gt 0 ]] \
|
||||||
|
&& [ ! $SUBSCWRYPT ] \
|
||||||
|
&& [[ ! $SCWRYPT_NAME =~ scwrypts/logs ]] \
|
||||||
|
&& [[ ! $SCWRYPT_NAME =~ interactive ]] \
|
||||||
|
&& LOGFILE="$SCWRYPTS_LOG_PATH/$(echo $GROUP/$TYPE/$NAME | sed 's/^\.\///; s/\//\%/g').log" \
|
||||||
|
|| LOGFILE='/dev/null' \
|
||||||
|
;
|
||||||
|
|
||||||
|
local HEADER FOOTER
|
||||||
|
|
||||||
|
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] && {
|
||||||
|
HEADER=$(
|
||||||
|
echo "
|
||||||
|
=====================================================================
|
||||||
|
script : $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME
|
||||||
|
run at : $(date)
|
||||||
|
config : $ENV_NAME
|
||||||
|
log level : $SCWRYPTS_LOG_LEVEL
|
||||||
|
\\033[1;33m--- SCWRYPT BEGIN ---------------------------------------------------\\033[0m
|
||||||
|
" | sed 's/^\s\+//; 1d'
|
||||||
|
)
|
||||||
|
|
||||||
|
FOOTER="\\033[1;33m--- SCWRYPT END ---------------------------------------------------\\033[0m"
|
||||||
|
}
|
||||||
|
|
||||||
|
[ $SUBSCWRYPT ] && {
|
||||||
|
HEADER="\\033[0;33m--- ($SUBSCWRYPT) BEGIN $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME ---"
|
||||||
|
FOOTER="\\033[0;33m--- ($SUBSCWRYPT) END $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME ---"
|
||||||
|
}
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
### run the scwrypt #################################################
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
[ ! $SUBSCWRYPT ] && export SUBSCWRYPT=0
|
||||||
|
|
||||||
|
set -o pipefail
|
||||||
|
{
|
||||||
|
[ $HEADER ] && echo $HEADER
|
||||||
|
[[ $LOGFILE =~ ^/dev/null$ ]] && {
|
||||||
|
eval "$RUN_STRING $(printf "%q " "$@")" </dev/tty >/dev/tty 2>&1
|
||||||
|
EXIT_CODE=$?
|
||||||
|
} || {
|
||||||
|
(eval "$RUN_STRING $(printf "%q " "$@")")
|
||||||
|
EXIT_CODE=$?
|
||||||
|
}
|
||||||
|
[ $FOOTER ] && echo $FOOTER
|
||||||
|
[[ $EXIT_CODE -eq 0 ]] && EXIT_COLOR='32m' || EXIT_COLOR='31m'
|
||||||
|
|
||||||
|
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] && [ ! $SUBSCWRYPT ] \
|
||||||
|
&& echo "terminated with\\033[1;$EXIT_COLOR code $EXIT_CODE\\033[0m"
|
||||||
|
|
||||||
|
return $EXIT_CODE
|
||||||
|
} 2>&1 | tee --append "$LOGFILE"
|
||||||
|
|
||||||
|
} $@
|
482
scwrypts
482
scwrypts
@ -1,482 +1,2 @@
|
|||||||
#!/bin/zsh
|
#!/bin/zsh
|
||||||
export EXECUTION_DIR=$(pwd)
|
source "${0:a:h}/run" $@
|
||||||
export SCWRYPTS_RUNTIME_ID=$(uuidgen)
|
|
||||||
source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
|
|
||||||
#####################################################################
|
|
||||||
() {
|
|
||||||
cd "$SCWRYPTS_ROOT__scwrypts"
|
|
||||||
GIT_SCWRYPTS() { git -C "$SCWRYPTS_ROOT__scwrypts" $@; }
|
|
||||||
|
|
||||||
|
|
||||||
local ERRORS=0
|
|
||||||
local USAGE='
|
|
||||||
usage: scwrypts [...options...] [...patterns...] -- [...script options...]
|
|
||||||
|
|
||||||
options:
|
|
||||||
selection
|
|
||||||
-m, --name <scwrypt-name> only run the script if there is an exact match
|
|
||||||
(requires type and group)
|
|
||||||
-g, --group <group-name> only use scripts from the indicated group
|
|
||||||
-t, --type <type-name> only use scripts of the indicated type
|
|
||||||
|
|
||||||
runtime
|
|
||||||
-y, --yes auto-accept all [yn] prompts through current scwrypt
|
|
||||||
-e, --env <env-name> set environment; overwrites SCWRYPTS_ENV
|
|
||||||
|
|
||||||
-n shorthand for "--log-level 0"
|
|
||||||
-v, --log-level <0-4> set incremental scwrypts log level to one of the following:
|
|
||||||
0 : only command output and critical failures; skips logfile
|
|
||||||
1 : include success / failure messages
|
|
||||||
2 : include status update messages
|
|
||||||
3 : (default) include warning messages
|
|
||||||
4 : include debug messages
|
|
||||||
|
|
||||||
-o, --output <format> specify output format; one of: pretty,json (default: pretty)
|
|
||||||
|
|
||||||
alternate commands
|
|
||||||
-h, --help display this message and exit
|
|
||||||
-l, --list print out command list and exit
|
|
||||||
--list-envs print out environment list and exit
|
|
||||||
--list-groups print out configured scwrypts groups and exit
|
|
||||||
--config "eval"-ed to enable config and "use" import in non-scwrypts environments
|
|
||||||
--root print out SCWRYPTS_ROOT__scwrypts and exit
|
|
||||||
--update update scwrypts library to latest version
|
|
||||||
--version print out scwrypts version and exit
|
|
||||||
|
|
||||||
patterns:
|
|
||||||
- a list of glob patterns to loose-match a scwrypt by name
|
|
||||||
|
|
||||||
script options:
|
|
||||||
- everything after "--" is forwarded to the scwrypt you run
|
|
||||||
("-- --help" will provide more information)
|
|
||||||
'
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
### cli argument parsing and global configuration ###################
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
local ENV_NAME="$SCWRYPTS_ENV"
|
|
||||||
local SEARCH_PATTERNS=()
|
|
||||||
|
|
||||||
local VARSPLIT SEARCH_GROUP SEARCH_TYPE SEARCH_NAME
|
|
||||||
|
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=3
|
|
||||||
|
|
||||||
local SHIFT_COUNT
|
|
||||||
while [[ $# -gt 0 ]]
|
|
||||||
do
|
|
||||||
SHIFT_COUNT=1
|
|
||||||
case $1 in
|
|
||||||
-[a-z][a-z]* )
|
|
||||||
VARSPLIT=$(echo "$1 " | sed 's/^\(-.\)\(.*\) /\1 -\2/')
|
|
||||||
set -- throw-away $(echo " $VARSPLIT ") ${@:2}
|
|
||||||
;;
|
|
||||||
|
|
||||||
### alternate commands ###################
|
|
||||||
|
|
||||||
-h | --help )
|
|
||||||
USAGE
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
-l | --list )
|
|
||||||
SCWRYPTS__GET_AVAILABLE_SCWRYPTS
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
--list-envs )
|
|
||||||
SCWRYPTS__GET_ENV_NAMES
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
--list-groups )
|
|
||||||
echo "${SCWRYPTS_GROUPS[@]}" | sed 's/\s\+/\n/g' | sort -u
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
--version )
|
|
||||||
case $SCWRYPTS_INSTALLATION_TYPE in
|
|
||||||
manual ) echo "scwrypts $(GIT_SCWRYPTS describe --tags) (via GIT)" ;;
|
|
||||||
* ) echo "scwrypts $(cat "$SCWRYPTS_ROOT__scwrypts/VERSION")" ;;
|
|
||||||
esac
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
--root )
|
|
||||||
echo "$SCWRYPTS_ROOT__scwrypts"
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
--config )
|
|
||||||
echo "source '$SCWRYPTS_ROOT__scwrypts/zsh/lib/import.driver.zsh'"
|
|
||||||
echo "CHECK_ENVIRONMENT --no-fail --no-usage"
|
|
||||||
echo "unset __SCWRYPT"
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
--update )
|
|
||||||
case $SCWRYPTS_INSTALLATION_TYPE in
|
|
||||||
aur )
|
|
||||||
SCWRYPTS_LOG_LEVEL=3 REMINDER "
|
|
||||||
This installation is built from the AUR. Update through 'makepkg' or use
|
|
||||||
your preferred AUR package management tool (e.g. 'yay -Syu scwrypts')
|
|
||||||
"
|
|
||||||
;;
|
|
||||||
|
|
||||||
homebrew )
|
|
||||||
SCWRYPTS_LOG_LEVEL=3 REMINDER "This installation is managed by homebrew. Update me with 'brew update'"
|
|
||||||
;;
|
|
||||||
|
|
||||||
manual )
|
|
||||||
GIT_SCWRYPTS fetch --quiet origin main
|
|
||||||
GIT_SCWRYPTS fetch --quiet origin main --tags
|
|
||||||
local SYNC_STATUS=$?
|
|
||||||
|
|
||||||
GIT_SCWRYPTS diff --exit-code origin/main -- . >/dev/null 2>&1
|
|
||||||
local DIFF_STATUS=$?
|
|
||||||
|
|
||||||
[[ $SYNC_STATUS -eq 0 ]] && [[ $DIFF_STATUS -eq 0 ]] && {
|
|
||||||
SUCCESS 'already up-to-date with origin/main'
|
|
||||||
} || {
|
|
||||||
GIT_SCWRYPTS rebase --autostash origin/main \
|
|
||||||
&& SUCCESS 'up-to-date with origin/main' \
|
|
||||||
&& GIT_SCWRYPTS log -n1 \
|
|
||||||
|| {
|
|
||||||
GIT_SCWRYPTS rebase --abort
|
|
||||||
ERROR 'unable to update scwrypts; please try manual upgrade'
|
|
||||||
REMINDER "installation in '$SCWRYPTS_ROOT__scwrypts'"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
;;
|
|
||||||
|
|
||||||
* )
|
|
||||||
SCWRYPTS_LOG_LEVEL=3 REMINDER "
|
|
||||||
This is a managed installation of scwrypts. Please update through your
|
|
||||||
system package manager.
|
|
||||||
"
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
|
|
||||||
### scwrypts filters #####################
|
|
||||||
|
|
||||||
-m | --name )
|
|
||||||
((SHIFT_COUNT+=1))
|
|
||||||
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
|
||||||
SEARCH_NAME=$2
|
|
||||||
;;
|
|
||||||
|
|
||||||
-g | --group )
|
|
||||||
((SHIFT_COUNT+=1))
|
|
||||||
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
|
||||||
SEARCH_GROUP=$2
|
|
||||||
GROUP=$2
|
|
||||||
;;
|
|
||||||
|
|
||||||
-t | --type )
|
|
||||||
((SHIFT_COUNT+=1))
|
|
||||||
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
|
||||||
SEARCH_TYPE=$2
|
|
||||||
TYPE=$2
|
|
||||||
;;
|
|
||||||
|
|
||||||
### runtime settings #####################
|
|
||||||
|
|
||||||
-y | --yes ) export __SCWRYPTS_YES=1 ;;
|
|
||||||
|
|
||||||
-n ) SCWRYPTS_LOG_LEVEL=0 ;;
|
|
||||||
|
|
||||||
-v | --log-level )
|
|
||||||
((SHIFT_COUNT+=1))
|
|
||||||
[[ $2 =~ ^[0-4]$ ]] || ERROR "invalid setting for log-level '$2'"
|
|
||||||
SCWRYPTS_LOG_LEVEL=$2
|
|
||||||
;;
|
|
||||||
|
|
||||||
-o | --output )
|
|
||||||
((SHIFT_COUNT+=1))
|
|
||||||
export SCWRYPTS_OUTPUT_FORMAT=$2
|
|
||||||
case $SCWRYPTS_OUTPUT_FORMAT in
|
|
||||||
pretty | json ) ;;
|
|
||||||
* ) ERROR "unsupported format '$SCWRYPTS_OUTPUT_FORMAT'" ;;
|
|
||||||
esac
|
|
||||||
;;
|
|
||||||
|
|
||||||
-e | --env )
|
|
||||||
((SHIFT_COUNT+=1))
|
|
||||||
[ $2 ] || { ERROR "missing value for argument $1"; break; }
|
|
||||||
|
|
||||||
[ $ENV_NAME ] && DEBUG 'overwriting session environment'
|
|
||||||
|
|
||||||
ENV_NAME="$2"
|
|
||||||
STATUS "using CLI environment '$ENV_NAME'"
|
|
||||||
;;
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
-- ) shift 1; break ;; # pass arguments after '--' to the scwrypt
|
|
||||||
--* ) ERROR "unrecognized argument '$1'" ;;
|
|
||||||
* ) SEARCH_PATTERNS+=($1) ;;
|
|
||||||
esac
|
|
||||||
shift $SHIFT_COUNT
|
|
||||||
done
|
|
||||||
|
|
||||||
[ $SCWRYPTS_OUTPUT_FORMAT ] || export SCWRYPTS_OUTPUT_FORMAT=pretty
|
|
||||||
|
|
||||||
[ $SEARCH_NAME ] && {
|
|
||||||
[ $SEARCH_TYPE ] || ERROR '--name requires --type argument'
|
|
||||||
[ $SEARCH_GROUP ] || ERROR '--name requires --group argument'
|
|
||||||
}
|
|
||||||
|
|
||||||
CHECK_ERRORS
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
### scwrypts selection / filtering ##################################
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
local SCWRYPTS_AVAILABLE
|
|
||||||
SCWRYPTS_AVAILABLE=$(SCWRYPTS__GET_AVAILABLE_SCWRYPTS)
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
[ $SEARCH_NAME ] && SCWRYPTS_AVAILABLE=$({
|
|
||||||
echo $SCWRYPTS_AVAILABLE | head -n1
|
|
||||||
echo $SCWRYPTS_AVAILABLE | sed -e 's/\x1b\[[0-9;]*m//g' | grep "^$SEARCH_NAME *$SEARCH_TYPE *$SEARCH_GROUP\$"
|
|
||||||
}) || {
|
|
||||||
[ $SEARCH_TYPE ] && {
|
|
||||||
SCWRYPTS_AVAILABLE=$(\
|
|
||||||
{
|
|
||||||
echo $SCWRYPTS_AVAILABLE | head -n1
|
|
||||||
echo $SCWRYPTS_AVAILABLE | grep ' [^/]*'$SEARCH_TYPE'[^/]* '
|
|
||||||
} \
|
|
||||||
| sed 's/ \+$/'$(printf $__COLOR_RESET)'/; s/ \+/^/g' \
|
|
||||||
| column -ts '^'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
[ $SEARCH_GROUP ] && {
|
|
||||||
SCWRYPTS_AVAILABLE=$(
|
|
||||||
{
|
|
||||||
echo $SCWRYPTS_AVAILABLE | head -n1
|
|
||||||
echo $SCWRYPTS_AVAILABLE | grep "$SEARCH_GROUP"'[^/ ]*$'
|
|
||||||
} \
|
|
||||||
| sed 's/ \+$/'$(printf $__COLOR_RESET)'/; s/ \+/^/g' \
|
|
||||||
| column -ts '^'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
[[ ${#SEARCH_PATTERNS[@]} -gt 0 ]] && {
|
|
||||||
POTENTIAL_ERROR+="\n PATTERNS : $SEARCH_PATTERNS"
|
|
||||||
local P
|
|
||||||
for P in ${SEARCH_PATTERNS[@]}
|
|
||||||
do
|
|
||||||
SCWRYPTS_AVAILABLE=$(
|
|
||||||
{
|
|
||||||
echo $SCWRYPTS_AVAILABLE | head -n1
|
|
||||||
echo $SCWRYPTS_AVAILABLE | grep $P
|
|
||||||
}
|
|
||||||
)
|
|
||||||
done
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[[ $(echo $SCWRYPTS_AVAILABLE | wc -l) -lt 2 ]] && {
|
|
||||||
FAIL 1 "$(echo "
|
|
||||||
no such scwrypt exists
|
|
||||||
NAME : '$SEARCH_NAME'
|
|
||||||
TYPE : '$SEARCH_TYPE'
|
|
||||||
GROUP : '$SEARCH_GROUP'
|
|
||||||
PATTERNS : '$SEARCH_PATTERNS'
|
|
||||||
" | sed "1d; \$d; /''$/d")"
|
|
||||||
}
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
[[ $(echo $SCWRYPTS_AVAILABLE | wc -l) -eq 2 ]] \
|
|
||||||
&& SCWRYPT_SELECTION=$(echo $SCWRYPTS_AVAILABLE | tail -n1) \
|
|
||||||
|| SCWRYPT_SELECTION=$(echo $SCWRYPTS_AVAILABLE | FZF "select a script to run" --header-lines 1) \
|
|
||||||
;
|
|
||||||
|
|
||||||
[ $SCWRYPT_SELECTION ] || exit 2
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
local NAME TYPE GROUP
|
|
||||||
SCWRYPTS__SEPARATE_SCWRYPT_SELECTION $SCWRYPT_SELECTION
|
|
||||||
|
|
||||||
export SCWRYPT_NAME=$NAME
|
|
||||||
export SCWRYPT_TYPE=$TYPE
|
|
||||||
export SCWRYPT_GROUP=$GROUP
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
### environment variables and configuration validation ##############
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
local ENV_REQUIRED=true \
|
|
||||||
&& [ ! $CI ] \
|
|
||||||
&& [[ ! $SCWRYPT_NAME =~ scwrypts/logs ]] \
|
|
||||||
&& [[ ! $SCWRYPT_NAME =~ scwrypts/environment ]] \
|
|
||||||
|| ENV_REQUIRED=false
|
|
||||||
|
|
||||||
local REQUIRED_ENVIRONMENT_REGEX=$(eval echo '$SCWRYPTS_REQUIRED_ENVIRONMENT_REGEX__'$SCWRYPT_GROUP)
|
|
||||||
|
|
||||||
[ $ENV_NAME ] && [ $REQUIRED_ENVIRONMENT_REGEX ] && {
|
|
||||||
[[ $ENV_NAME =~ $REQUIRED_ENVIRONMENT_REGEX ]] \
|
|
||||||
|| FAIL 5 "group '$SCWRYPT_GROUP' requires current environment name to match '$REQUIRED_ENVIRONMENT_REGEX' (currently $ENV_NAME)"
|
|
||||||
}
|
|
||||||
|
|
||||||
[[ $ENV_REQUIRED =~ true ]] && {
|
|
||||||
[ ! $ENV_NAME ] && ENV_NAME=$(SCWRYPTS__SELECT_ENV)
|
|
||||||
[ ! $ENV_NAME ] && ABORT
|
|
||||||
|
|
||||||
export ENV_NAME
|
|
||||||
export SCWRYPTS_ENV=$ENV_NAME
|
|
||||||
|
|
||||||
for GROUP in ${SCWRYPTS_GROUPS[@]}
|
|
||||||
do
|
|
||||||
local REQUIRED_REGEX=$(eval echo '$SCWRYPTS_REQUIRED_ENVIRONMENT_REGEX__'$GROUP)
|
|
||||||
[ $REQUIRED_REGEX ] && {
|
|
||||||
[[ $ENV_NAME =~ $REQUIRED_REGEX ]] || continue
|
|
||||||
}
|
|
||||||
local ENV_FILE=$(SCWRYPTS__GET_ENV_FILE "$ENV_NAME" "$GROUP")
|
|
||||||
source "$ENV_FILE" || FAIL 5 "missing or invalid environment '$GROUP/$ENV_NAME'"
|
|
||||||
|
|
||||||
for f in $(eval 'echo $SCWRYPTS_STATIC_CONFIG__'$GROUP)
|
|
||||||
do
|
|
||||||
source "$f" || FAIL 5 "invalid static config '$f'"
|
|
||||||
done
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
[ $REQUIRED_ENVIRONMENT_REGEX ] && {
|
|
||||||
[[ $ENV_NAME =~ $REQUIRED_ENVIRONMENT_REGEX ]] \
|
|
||||||
|| FAIL 5 "group '$SCWRYPT_GROUP' requires current environment name to match '$REQUIRED_ENVIRONMENT_REGEX' (currently $ENV_NAME)"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
[ ! $SUBSCWRYPT ] && export SUBSCWRYPT=0
|
|
||||||
|
|
||||||
[[ $SCWRYPTS_INSTALLATION_TYPE =~ ^manual$ ]] && {
|
|
||||||
[[ $SUBSCWRYPT -eq 0 ]] && [[ $ENV_NAME =~ prod ]] && [[ $SCWRYPTS_LOG_LEVEL -gt 0 ]] && {
|
|
||||||
STATUS "on '$ENV_NAME'; checking diff against origin/main"
|
|
||||||
|
|
||||||
local WARNING_MESSAGE
|
|
||||||
|
|
||||||
[ ! $WARNING_MESSAGE ] && {
|
|
||||||
GIT_SCWRYPTS fetch --quiet origin main \
|
|
||||||
|| WARNING_MESSAGE='I am unable to verify your scwrypts version'
|
|
||||||
}
|
|
||||||
|
|
||||||
[ ! $WARNING_MESSAGE ] && {
|
|
||||||
GIT_SCWRYPTS diff --exit-code origin/main -- . >/dev/null 2>&1 \
|
|
||||||
|| WARNING_MESSAGE='your scwrypts is currently out-of-date'
|
|
||||||
}
|
|
||||||
|
|
||||||
[ $WARNING_MESSAGE ] && {
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -lt 3 ]] && {
|
|
||||||
REMINDER "you are running in ${__BRIGHT_RED}production${__BRIGHT_MAGENTA} and $WARNING_MESSAGE"
|
|
||||||
} || {
|
|
||||||
GIT_SCWRYPTS diff --exit-code origin/main -- . >&2
|
|
||||||
WARNING "you are trying to run in ${__BRIGHT_RED}production${__YELLOW} but $WARNING_MESSAGE (relevant diffs and errors above)"
|
|
||||||
yN 'continue?' || {
|
|
||||||
REMINDER "you can use 'scwrypts --update' to quickly update scwrypts to latest"
|
|
||||||
ABORT
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
local RUN_STRING=$(SCWRYPTS__GET_RUNSTRING $SCWRYPT_NAME $SCWRYPT_TYPE $SCWRYPT_GROUP)
|
|
||||||
[ "$RUN_STRING" ] || return 42
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
### logging and pretty header/footer setup ##########################
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
local LOGFILE \
|
|
||||||
&& [[ $SCWRYPTS_LOG_LEVEL -gt 0 ]] \
|
|
||||||
&& [[ $SUBSCWRYPT -eq 0 ]] \
|
|
||||||
&& [[ ! $SCWRYPT_NAME =~ scwrypts/logs ]] \
|
|
||||||
&& [[ ! $SCWRYPT_NAME =~ interactive ]] \
|
|
||||||
&& LOGFILE="$SCWRYPTS_LOG_PATH/$(echo $GROUP/$TYPE/$NAME | sed 's/^\.\///; s/\//\%/g').log" \
|
|
||||||
|| LOGFILE='/dev/null' \
|
|
||||||
;
|
|
||||||
|
|
||||||
local RUN_MODE=normal
|
|
||||||
[[ $LOGFILE =~ ^/dev/null$ ]] && RUN_MODE=no-logfile
|
|
||||||
[[ $SCWRYPT_NAME =~ interactive ]] && RUN_MODE=interactive
|
|
||||||
|
|
||||||
local HEADER FOOTER
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] && {
|
|
||||||
case $SCWRYPTS_OUTPUT_FORMAT in
|
|
||||||
pretty )
|
|
||||||
HEADER=$(
|
|
||||||
echo "
|
|
||||||
=====================================================================
|
|
||||||
scwrypt : $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME
|
|
||||||
run at : $(date)
|
|
||||||
config : $ENV_NAME
|
|
||||||
log level : $SCWRYPTS_LOG_LEVEL
|
|
||||||
\\033[1;33m--- SCWRYPT BEGIN ---------------------------------------------------\\033[0m
|
|
||||||
" | sed 's/^\s\+//; 1d'
|
|
||||||
)
|
|
||||||
|
|
||||||
FOOTER="\\033[1;33m--- SCWRYPT END ---------------------------------------------------\\033[0m"
|
|
||||||
;;
|
|
||||||
json )
|
|
||||||
HEADER=$(echo '{}' | jq -c ".
|
|
||||||
| .timestamp = \"$(date +%s)\"
|
|
||||||
| .runtime = \"$SCWRYPTS_RUNTIME_ID\"
|
|
||||||
| .scwrypt = \"start of $SCWRYPT_NAME $SCWRYPT_GROUP $SCWRYPT_TYPE\"
|
|
||||||
| .config = \"$ENV_NAME\"
|
|
||||||
| .logLevel = \"$SCWRYPTS_LOG_LEVEL\"
|
|
||||||
| .subscwrypt = $SUBSCWRYPT
|
|
||||||
")
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
|
|
||||||
[[ $SUBSCWRYPT -eq 0 ]] || {
|
|
||||||
case $SCWRYPTS_OUTPUT_FORMAT in
|
|
||||||
pretty )
|
|
||||||
HEADER="\\033[0;33m--- ($SUBSCWRYPT) BEGIN $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME ---"
|
|
||||||
FOOTER="\\033[0;33m--- ($SUBSCWRYPT) END $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME ---"
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
### run the scwrypt #################################################
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
set -o pipefail
|
|
||||||
{
|
|
||||||
[ $HEADER ] && echo $HEADER
|
|
||||||
case $RUN_MODE in
|
|
||||||
normal )
|
|
||||||
(eval "$RUN_STRING $(printf "%q " "$@")")
|
|
||||||
EXIT_CODE=$?
|
|
||||||
;;
|
|
||||||
no-logfile )
|
|
||||||
eval "$RUN_STRING $(printf "%q " "$@")"
|
|
||||||
EXIT_CODE=$?
|
|
||||||
;;
|
|
||||||
interactive )
|
|
||||||
eval "$RUN_STRING $(printf "%q " "$@")" </dev/tty >/dev/tty 2>&1
|
|
||||||
EXIT_CODE=$?
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
[ $FOOTER ] && echo $FOOTER
|
|
||||||
[[ $EXIT_CODE -eq 0 ]] && EXIT_COLOR='32m' || EXIT_COLOR='31m'
|
|
||||||
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] && [ ! $SUBSCWRYPT ] \
|
|
||||||
&& echo "terminated with\\033[1;$EXIT_COLOR code $EXIT_CODE\\033[0m"
|
|
||||||
|
|
||||||
return $EXIT_CODE
|
|
||||||
} | tee --append "$LOGFILE"
|
|
||||||
} $@
|
|
||||||
|
@ -1,81 +1,59 @@
|
|||||||
#
|
NO_EXPORT_CONFIG=1 source "${0:a:h}/zsh/lib/import.driver.zsh" || return 42
|
||||||
# typically you do not need to reload this plugin in a single session;
|
|
||||||
# if for some reason you do, you can run the following command and
|
|
||||||
# source this file again
|
|
||||||
#
|
|
||||||
# unset __SCWRYPTS_PLUGIN_LOADED
|
|
||||||
#
|
|
||||||
[[ $__SCWRYPTS_PLUGIN_LOADED =~ true ]] && return 0
|
|
||||||
|
|
||||||
#####################################################################
|
#####################################################################
|
||||||
|
|
||||||
: \
|
|
||||||
&& command -v scwrypts &>/dev/null \
|
|
||||||
&& eval "$(scwrypts --config)" \
|
|
||||||
|| {
|
|
||||||
echo 'scwrypts must be in PATH and properly configured; skipping zsh plugin setup' >&2
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
__SCWRYPTS_PARSE() {
|
|
||||||
SCWRYPT_SELECTION=$(scwrypts --list | fzf --prompt 'select a script : ' --header-lines 1)
|
|
||||||
LBUFFER= RBUFFER=
|
|
||||||
[ $SCWRYPT_SELECTION ] || return 1
|
|
||||||
|
|
||||||
NAME=$(echo "$SCWRYPT_SELECTION" | awk '{print $1;}')
|
|
||||||
TYPE=$(echo "$SCWRYPT_SELECTION" | awk '{print $2;}')
|
|
||||||
GROUP=$(echo "$SCWRYPT_SELECTION" | awk '{print $3;}')
|
|
||||||
|
|
||||||
[ $NAME ] && [ $TYPE ] && [ $GROUP ]
|
|
||||||
}
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
[ $SCWRYPTS_SHORTCUT ] && {
|
|
||||||
SCWRYPTS__ZSH_PLUGIN() {
|
SCWRYPTS__ZSH_PLUGIN() {
|
||||||
local SCWRYPT_SELECTION NAME TYPE GROUP
|
local SCWRYPT_SELECTION=$(SCWRYPTS__GET_AVAILABLE_SCWRYPTS | FZF 'select a script' --header-lines 1)
|
||||||
__SCWRYPTS_PARSE || { zle accept-line; return 0; }
|
local NAME
|
||||||
|
local TYPE
|
||||||
|
local GROUP
|
||||||
|
LBUFFER= RBUFFER=
|
||||||
|
[ ! $SCWRYPT_SELECTION ] && { zle accept-line; return 0; }
|
||||||
|
|
||||||
RBUFFER="scwrypts --name $NAME --type $TYPE --group $GROUP"
|
SCWRYPTS__SEPARATE_SCWRYPT_SELECTION $SCWRYPT_SELECTION
|
||||||
|
|
||||||
|
which scwrypts >/dev/null 2>&1\
|
||||||
|
&& RBUFFER="scwrypts" || RBUFFER="$SCWRYPTS_ROOT/scwrypts"
|
||||||
|
|
||||||
|
RBUFFER+=" --name $NAME --group $GROUP --type $TYPE"
|
||||||
zle accept-line
|
zle accept-line
|
||||||
}
|
}
|
||||||
|
|
||||||
zle -N scwrypts SCWRYPTS__ZSH_PLUGIN
|
zle -N scwrypts SCWRYPTS__ZSH_PLUGIN
|
||||||
bindkey $SCWRYPTS_SHORTCUT scwrypts
|
bindkey $SCWRYPTS_SHORTCUT scwrypts
|
||||||
unset SCWRYPTS_SHORTCUT
|
|
||||||
}
|
|
||||||
|
|
||||||
#####################################################################
|
#####################################################################
|
||||||
|
|
||||||
[ $SCWRYPTS_BUILDER_SHORTCUT ] && {
|
|
||||||
SCWRYPTS__ZSH_BUILDER_PLUGIN() {
|
SCWRYPTS__ZSH_BUILDER_PLUGIN() {
|
||||||
local SCWRYPT_SELECTION NAME TYPE GROUP
|
local SCWRYPT_SELECTION=$(SCWRYPTS__GET_AVAILABLE_SCWRYPTS | FZF 'select a script' --header-lines 1)
|
||||||
__SCWRYPTS_PARSE || { echo >&2; zle accept-line; return 0; }
|
local NAME
|
||||||
echo $SCWRYPT_SELECTION >&2
|
local TYPE
|
||||||
|
local GROUP
|
||||||
|
LBUFFER= RBUFFER=
|
||||||
|
[ ! $SCWRYPT_SELECTION ] && { zle accept-line; return 0; }
|
||||||
|
|
||||||
scwrypts -n --name $NAME --group $GROUP --type $TYPE -- --help >&2 || {
|
SCWRYPTS__SEPARATE_SCWRYPT_SELECTION $SCWRYPT_SELECTION
|
||||||
|
|
||||||
|
scwrypts --name $NAME --group $GROUP --type $TYPE -- --help >&2 || {
|
||||||
zle accept-line
|
zle accept-line
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
echo
|
echo
|
||||||
|
|
||||||
zle reset-prompt
|
zle reset-prompt
|
||||||
LBUFFER="scwrypts --name $NAME --type $TYPE --group $GROUP -- "
|
which scwrypts >/dev/null 2>&1\
|
||||||
|
&& LBUFFER="scwrypts" || LBUFFER="$SCWRYPTS_ROOT/scwrypts"
|
||||||
|
|
||||||
|
LBUFFER+=" --name $NAME --group $GROUP --type $TYPE -- "
|
||||||
}
|
}
|
||||||
|
|
||||||
zle -N scwrypts-builder SCWRYPTS__ZSH_BUILDER_PLUGIN
|
zle -N scwrypts-builder SCWRYPTS__ZSH_BUILDER_PLUGIN
|
||||||
bindkey $SCWRYPTS_BUILDER_SHORTCUT scwrypts-builder
|
bindkey $SCWRYPTS_BUILDER_SHORTCUT scwrypts-builder
|
||||||
unset SCWRYPTS_BUILDER_SHORTCUT
|
|
||||||
}
|
|
||||||
|
|
||||||
#####################################################################
|
#####################################################################
|
||||||
|
|
||||||
[ $SCWRYPTS_ENV_SHORTCUT ] && {
|
|
||||||
SCWRYPTS__ZSH_PLUGIN_ENV() {
|
SCWRYPTS__ZSH_PLUGIN_ENV() {
|
||||||
local RESET='reset'
|
local RESET='reset'
|
||||||
local SELECTED=$(\
|
local SELECTED=$(\
|
||||||
{ [ $SCWRYPTS_ENV ] && echo $RESET; scwrypts --list-envs; } \
|
{ [ $SCWRYPTS_ENV ] && echo $RESET; SCWRYPTS__GET_ENV_NAMES; } \
|
||||||
| fzf --prompt 'select an environment : ' \
|
| FZF 'select an environment' \
|
||||||
)
|
)
|
||||||
|
|
||||||
zle clear-command-line
|
zle clear-command-line
|
||||||
@ -89,135 +67,3 @@ __SCWRYPTS_PARSE() {
|
|||||||
|
|
||||||
zle -N scwrypts-setenv SCWRYPTS__ZSH_PLUGIN_ENV
|
zle -N scwrypts-setenv SCWRYPTS__ZSH_PLUGIN_ENV
|
||||||
bindkey $SCWRYPTS_ENV_SHORTCUT scwrypts-setenv
|
bindkey $SCWRYPTS_ENV_SHORTCUT scwrypts-setenv
|
||||||
unset SCWRYPTS_ENV_SHORTCUT
|
|
||||||
}
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
# badass(/terrifying?) zsh autocompletion
|
|
||||||
command -v compdef &>/dev/null && {
|
|
||||||
_scwrypts() {
|
|
||||||
echo $words | grep -q "\s--\s" && _arguments && return 0
|
|
||||||
eval "_arguments $(
|
|
||||||
{
|
|
||||||
HELP=$(scwrypts --help 2>&1 | sed -n 's/^\s\+\(-.* .\)/\1/p' | sed 's/[[]/(/g; s/[]]/)/g')
|
|
||||||
echo $HELP \
|
|
||||||
| sed 's/^\(\(-[^-\s]\),*\s*\|\)\(\(--[-a-z0-9A-Z\]*\)\s\(<\([^>]*\)>\|\)\|\)\s\+\(.*\)/\2[\7]:\6:->\2/' \
|
|
||||||
| grep -v '^[[]' \
|
|
||||||
;
|
|
||||||
|
|
||||||
echo $HELP \
|
|
||||||
| sed 's/^\(\(-[^-\s]\),*\s*\|\)\(\(--[-a-z0-9A-Z\]*\)\s\(<\([^>]*\)>\|\)\|\)\s\+\(.*\)/\4[\7]:\6:->\4/' \
|
|
||||||
| grep -v '^[[]' \
|
|
||||||
;
|
|
||||||
|
|
||||||
echo ":pattern:->pattern"
|
|
||||||
echo ":pattern:->pattern"
|
|
||||||
echo ":pattern:->pattern"
|
|
||||||
echo ":pattern:->pattern"
|
|
||||||
echo ":pattern:->pattern"
|
|
||||||
|
|
||||||
} | sed 's/::->.*$//g' | sed "s/\\(^\\|$\\)/'/g" | tr '\n' ' '
|
|
||||||
)"
|
|
||||||
|
|
||||||
local _group=''
|
|
||||||
echo $words | grep -q ' -g [^\s]' \
|
|
||||||
&& _group=$(echo $words | sed 's/.*-g \([^ ]\+\)\s*.*/\1/')
|
|
||||||
echo $words | grep -q ' --group .' \
|
|
||||||
&& _group=$(echo $words | sed 's/.*--group \([^ ]\+\)\s*.*/\1/')
|
|
||||||
|
|
||||||
local _type=''
|
|
||||||
echo $words | grep -q ' -t [^\s]' \
|
|
||||||
&& _type=$(echo $words | sed 's/.*-t \([^ ]\+\)\s*.*/\1/')
|
|
||||||
echo $words | grep -q ' --type .' \
|
|
||||||
&& _type=$(echo $words | sed 's/.*--type \([^ ]\+\)\s*.*/\1/')
|
|
||||||
|
|
||||||
local _name=''
|
|
||||||
echo $words | grep -q ' -m [^\s]' \
|
|
||||||
&& _name=$(echo $words | sed 's/.*-m \([^ ]\+\)\s*.*/\1/')
|
|
||||||
echo $words | grep -q ' --name .' \
|
|
||||||
&& _name=$(echo $words | sed 's/.*--name \([^ ]\+\)\s*.*/\1/')
|
|
||||||
|
|
||||||
local _pattern _patterns=()
|
|
||||||
[ ! $_name ] \
|
|
||||||
&& _patterns=($(echo "${words[@]:1}" | sed 's/\s\+/\n/g' | grep -v '^-'))
|
|
||||||
|
|
||||||
_get_remaining_scwrypts() {
|
|
||||||
[ $_name ] || local _name='[^ ]\+'
|
|
||||||
[ $_type ] || local _type='[^ ]\+'
|
|
||||||
[ $_group ] || local _group='[^ ]\+'
|
|
||||||
|
|
||||||
local remaining=$(\
|
|
||||||
scwrypts --list \
|
|
||||||
| sed "1d; s,\x1B\[[0-9;]*[a-zA-Z],,g" \
|
|
||||||
| grep "^$_name\s" \
|
|
||||||
| grep "\s$_group$" \
|
|
||||||
| grep "\s$_type\s" \
|
|
||||||
)
|
|
||||||
|
|
||||||
for _pattern in ${_patterns[@]}
|
|
||||||
do
|
|
||||||
remaining=$(echo "$remaining" | grep "$_pattern")
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "$remaining"
|
|
||||||
}
|
|
||||||
|
|
||||||
case $state in
|
|
||||||
( -m | --name )
|
|
||||||
compadd $(_get_remaining_scwrypts | awk '{print $1;}' | sort -u)
|
|
||||||
;;
|
|
||||||
|
|
||||||
( -t | --type )
|
|
||||||
compadd $(_get_remaining_scwrypts | awk '{print $2;}' | sort -u)
|
|
||||||
;;
|
|
||||||
|
|
||||||
( -g | --group )
|
|
||||||
[[ $_name$_type$_group =~ ^$ ]] \
|
|
||||||
&& compadd $(scwrypts --list-groups) \
|
|
||||||
|| compadd $(_get_remaining_scwrypts | awk '{print $3;}' | sort -u) \
|
|
||||||
;;
|
|
||||||
|
|
||||||
( -e | --env )
|
|
||||||
compadd $(scwrypts --list-envs)
|
|
||||||
;;
|
|
||||||
|
|
||||||
( -v | --log-level )
|
|
||||||
local _help="$(\
|
|
||||||
scwrypts --help 2>&1 \
|
|
||||||
| sed -n '/-v, --log-level/,/^$/p' \
|
|
||||||
| sed -n 's/\s\+\([0-9]\) : \(.*\)/\1 -- \2/p' \
|
|
||||||
)"
|
|
||||||
|
|
||||||
eval "local _descriptions=($(echo "$_help" | sed "s/\\(^\|$\\)/'/g"))"
|
|
||||||
local _values=($(echo "$_help" | sed 's/ --.*//'))
|
|
||||||
compadd -d _descriptions -a _values
|
|
||||||
;;
|
|
||||||
|
|
||||||
( -o | --output )
|
|
||||||
compadd pretty json
|
|
||||||
;;
|
|
||||||
|
|
||||||
( pattern )
|
|
||||||
[[ $_name =~ ^$ ]] && {
|
|
||||||
local _remaining_scwrypts="$(_get_remaining_scwrypts)"
|
|
||||||
# stop providing suggestions if your pattern is sufficient
|
|
||||||
[[ $(echo $_remaining_scwrypts | wc -l) -le 1 ]] && return 0
|
|
||||||
|
|
||||||
local _remaining_patterns="$(echo "$_remaining_scwrypts" | sed 's/\s\+/\n/g; s|/|\n|g;' | sort -u)"
|
|
||||||
|
|
||||||
for _pattern in ${_patterns[@]}
|
|
||||||
do
|
|
||||||
_remaining_patterns="$(echo "$_remaining_patterns" | grep -v "^$_pattern$")"
|
|
||||||
done
|
|
||||||
compadd $(echo $_remaining_patterns)
|
|
||||||
}
|
|
||||||
;;
|
|
||||||
|
|
||||||
( * ) ;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
compdef _scwrypts scwrypts
|
|
||||||
}
|
|
||||||
|
|
||||||
__SCWRYPTS_PLUGIN_LOADED=true
|
|
||||||
|
@ -1,11 +0,0 @@
|
|||||||
SCWRYPTS_GROUPS+=(scwrypts)
|
|
||||||
|
|
||||||
export SCWRYPTS_ROOT__scwrypts="$SCWRYPTS_ROOT"
|
|
||||||
export SCWRYPTS_COLOR__scwrypts='\033[0;32m'
|
|
||||||
#export SCWRYPTS_TYPE__scwrypts=
|
|
||||||
#export SCWRYPTS_LIBRARY_ROOT__scwrypts=
|
|
||||||
|
|
||||||
export SCWRYPTS_VIRTUALENV_PATH__scwrypts="$SCWRYPTS_DATA_PATH/virtualenv"
|
|
||||||
|
|
||||||
export SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts=(3.12 3.11 3.10)
|
|
||||||
export SCWRYPTS_NODE_VERSION__scwrypts=18.0.0
|
|
@ -27,9 +27,6 @@ EKS() {
|
|||||||
|
|
||||||
local CONTEXT="arn:aws:eks:${AWS_REGION}:${AWS_ACCOUNT}:cluster/${CLUSTER_NAME}"
|
local CONTEXT="arn:aws:eks:${AWS_REGION}:${AWS_ACCOUNT}:cluster/${CLUSTER_NAME}"
|
||||||
|
|
||||||
kubectl config get-contexts | grep -q $CONTEXT \
|
|
||||||
|| EKS__CLUSTER_LOGIN -c $CLUSTER_NAME >/dev/null
|
|
||||||
|
|
||||||
local CONTEXT_ARGS=()
|
local CONTEXT_ARGS=()
|
||||||
case $1 in
|
case $1 in
|
||||||
helm ) CONTEXT_ARGS+=(--kube-context $CONTEXT) ;;
|
helm ) CONTEXT_ARGS+=(--kube-context $CONTEXT) ;;
|
||||||
@ -55,7 +52,6 @@ EKS__CLUSTER_LOGIN() {
|
|||||||
"
|
"
|
||||||
REQUIRED_ENV=(AWS_ACCOUNT AWS_REGION) CHECK_ENVIRONMENT || return 1
|
REQUIRED_ENV=(AWS_ACCOUNT AWS_REGION) CHECK_ENVIRONMENT || return 1
|
||||||
|
|
||||||
|
|
||||||
local CLUSTER_NAME
|
local CLUSTER_NAME
|
||||||
|
|
||||||
while [[ $# -gt 0 ]]
|
while [[ $# -gt 0 ]]
|
||||||
|
10
zsh/lib/config.group.zsh
Normal file
10
zsh/lib/config.group.zsh
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
export SCWRYPTS_ROOT__scwrypts="$SCWRYPTS_ROOT"
|
||||||
|
export SCWRYPTS_LIBRARY_ROOT__scwrypts="$SCWRYPTS_ROOT/zsh/lib"
|
||||||
|
export SCWRYPTS_COLOR__scwrypts='\033[0;32m'
|
||||||
|
|
||||||
|
|
||||||
|
export SCWRYPTS_VIRTUALENV_PATH__scwrypts="$SCWRYPTS_DATA_PATH/virtualenv"
|
||||||
|
[ ! -d "$SCWRYPTS_VIRTUALENV_PATH__scwrypts" ] && mkdir -p "$SCWRYPTS_VIRTUALENV_PATH__scwrypts"
|
||||||
|
|
||||||
|
export SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts=(3.11 3.10 3.9)
|
||||||
|
export SCWRYPTS_NODE_VERSION__scwrypts=18.0.0
|
@ -1,31 +1,12 @@
|
|||||||
[[ $__SCWRYPT -eq 1 ]] && return 0
|
[[ $__SCWRYPT -eq 1 ]] && return 0
|
||||||
#####################################################################
|
#####################################################################
|
||||||
|
|
||||||
# Apparently MacOS puts ALL of the homebrew stuff inside of a top level git repository
|
[ ! $SCWRYPTS_ROOT ] \
|
||||||
# with bizarre git ignores; so:
|
&& SCWRYPTS_ROOT="$(cd $(dirname "${0:a:h}"); git rev-parse --show-toplevel)"
|
||||||
# - USE the git root if it's a manual install...
|
|
||||||
# - UNLESS that git root is just the $(brew --prefix)
|
|
||||||
SCWRYPTS_ROOT="$(cd -- ${0:a:h}; git rev-parse --show-toplevel 2>/dev/null | grep -v "^$(brew --prefix 2>/dev/null)$")"
|
|
||||||
|
|
||||||
[ $SCWRYPTS_ROOT ] && [ -d "$SCWRYPTS_ROOT" ] \
|
|
||||||
|| SCWRYPTS_ROOT="$(echo "${0:a:h}" | sed -n 's|\(share/scwrypts\).*$|\1|p')"
|
|
||||||
|
|
||||||
[ $SCWRYPTS_ROOT ] && [ -d "$SCWRYPTS_ROOT" ] || {
|
|
||||||
echo "cannot determine scwrypts root path for current installation; aborting"
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
export SCWRYPTS_ROOT__scwrypts="$SCWRYPTS_ROOT"
|
|
||||||
|
|
||||||
[ -f "$SCWRYPTS_ROOT__scwrypts/MANAGED_BY" ] \
|
|
||||||
&& export SCWRYPTS_INSTALLATION_TYPE=$(cat "$SCWRYPTS_ROOT__scwrypts/MANAGED_BY") \
|
|
||||||
|| export SCWRYPTS_INSTALLATION_TYPE=manual \
|
|
||||||
;
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
#####################################################################
|
||||||
|
|
||||||
DEFAULT_CONFIG="$SCWRYPTS_ROOT__scwrypts/zsh/lib/config.user.zsh"
|
DEFAULT_CONFIG="$SCWRYPTS_ROOT/zsh/lib/config.user.zsh"
|
||||||
source "$DEFAULT_CONFIG"
|
source "$DEFAULT_CONFIG"
|
||||||
|
|
||||||
USER_CONFIG_OVERRIDES="$SCWRYPTS_CONFIG_PATH/config.zsh"
|
USER_CONFIG_OVERRIDES="$SCWRYPTS_CONFIG_PATH/config.zsh"
|
||||||
@ -35,13 +16,11 @@ USER_CONFIG_OVERRIDES="$SCWRYPTS_CONFIG_PATH/config.zsh"
|
|||||||
}
|
}
|
||||||
source "$USER_CONFIG_OVERRIDES"
|
source "$USER_CONFIG_OVERRIDES"
|
||||||
|
|
||||||
mkdir -p \
|
[ ! -d $SCWRYPTS_CONFIG_PATH ] && mkdir -p $SCWRYPTS_CONFIG_PATH
|
||||||
"$SCWRYPTS_CONFIG_PATH" \
|
[ ! -d $SCWRYPTS_DATA_PATH ] && mkdir -p $SCWRYPTS_DATA_PATH
|
||||||
"$SCWRYPTS_DATA_PATH" \
|
[ ! -d $SCWRYPTS_ENV_PATH ] && mkdir -p $SCWRYPTS_ENV_PATH
|
||||||
"$SCWRYPTS_ENV_PATH" \
|
[ ! -d $SCWRYPTS_LOG_PATH ] && mkdir -p $SCWRYPTS_LOG_PATH
|
||||||
"$SCWRYPTS_LOG_PATH" \
|
[ ! -d $SCWRYPTS_OUTPUT_PATH ] && mkdir -p $SCWRYPTS_OUTPUT_PATH
|
||||||
"$SCWRYPTS_OUTPUT_PATH" \
|
|
||||||
;
|
|
||||||
|
|
||||||
export \
|
export \
|
||||||
SCWRYPTS_GROUPS \
|
SCWRYPTS_GROUPS \
|
||||||
@ -53,10 +32,11 @@ export \
|
|||||||
SCWRYPTS_OUTPUT_PATH \
|
SCWRYPTS_OUTPUT_PATH \
|
||||||
;
|
;
|
||||||
|
|
||||||
source "$SCWRYPTS_ROOT/scwrypts.scwrypts.zsh" \
|
SCWRYPTS_GROUPS+=(scwrypts) # 'scwrypts' group is required!
|
||||||
|| FAIL 69 'failed to set up scwrypts group; aborting'
|
SCWRYPTS_GROUPS=($(echo $SCWRYPTS_GROUPS | sed 's/\s\+/\n/g' | sort -u))
|
||||||
|
|
||||||
SCWRYPTS_GROUPS=(scwrypts $(echo $SCWRYPTS_GROUPS | sed 's/\s\+/\n/g' | sort -u | grep -v '^scwrypts$'))
|
source "$SCWRYPTS_ROOT/zsh/lib/config.group.zsh" \
|
||||||
|
|| FAIL 69 'failed to set up scwrypts group; aborting'
|
||||||
|
|
||||||
#####################################################################
|
#####################################################################
|
||||||
|
|
||||||
@ -78,8 +58,7 @@ done
|
|||||||
&& [ ! "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] \
|
&& [ ! "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] \
|
||||||
&& [ $GITHUB_WORKSPACE ] \
|
&& [ $GITHUB_WORKSPACE ] \
|
||||||
&& [ ! $SCWRYPTS_GITHUB_NO_AUTOLOAD ] \
|
&& [ ! $SCWRYPTS_GITHUB_NO_AUTOLOAD ] \
|
||||||
&& SCWRYPTS_AUTODETECT_GROUP_BASEDIR="$GITHUB_WORKSPACE" \
|
&& SCWRYPTS_AUTODETECT_GROUP_BASEDIR="$GITHUB_WORKSPACE"
|
||||||
;
|
|
||||||
|
|
||||||
[ "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] && [ -d "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] && {
|
[ "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] && [ -d "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] && {
|
||||||
for GROUP_LOADER in $(find "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" -type f -name \*scwrypts.zsh)
|
for GROUP_LOADER in $(find "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" -type f -name \*scwrypts.zsh)
|
||||||
@ -89,4 +68,5 @@ done
|
|||||||
}
|
}
|
||||||
|
|
||||||
#####################################################################
|
#####################################################################
|
||||||
__SCWRYPT=1 # arbitrary; indicates currently inside a scwrypt
|
[ $NO_EXPORT_CONFIG ] || __SCWRYPT=1 # arbitrary; indicates currently inside a scwrypt
|
||||||
|
true
|
||||||
|
@ -34,7 +34,7 @@ source "${0:a:h}/config.zsh"
|
|||||||
|
|
||||||
use() {
|
use() {
|
||||||
local SCWRYPTS_LIBRARY SCWRYPTS_LIBRARY_ROOT SCWRYPTS_LIBRARY_GROUP
|
local SCWRYPTS_LIBRARY SCWRYPTS_LIBRARY_ROOT SCWRYPTS_LIBRARY_GROUP
|
||||||
local DEFER_ENVIRONMENT_CHECK=true
|
local DEFER_ENVIRONMENT_CHECK=1
|
||||||
|
|
||||||
while [[ $# -gt 0 ]]
|
while [[ $# -gt 0 ]]
|
||||||
do
|
do
|
||||||
@ -49,8 +49,8 @@ use() {
|
|||||||
SCWRYPTS_LIBRARY_ROOT=$2
|
SCWRYPTS_LIBRARY_ROOT=$2
|
||||||
shift 1
|
shift 1
|
||||||
;;
|
;;
|
||||||
-c | --check-environment )
|
--check-environment )
|
||||||
DEFER_ENVIRONMENT_CHECK=false
|
DEFER_ENVIRONMENT_CHECK=0
|
||||||
;;
|
;;
|
||||||
* )
|
* )
|
||||||
[ ! $SCWRYPTS_LIBRARY ] \
|
[ ! $SCWRYPTS_LIBRARY ] \
|
||||||
@ -106,7 +106,7 @@ use() {
|
|||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
[[ $DEFER_ENVIRONMENT_CHECK =~ false ]] && {
|
[[ $DEFER_ENVIRONMENT_CHECK -eq 0 ]] && {
|
||||||
CHECK_ENVIRONMENT || {
|
CHECK_ENVIRONMENT || {
|
||||||
((IMPORT_ERRORS+=1))
|
((IMPORT_ERRORS+=1))
|
||||||
ERROR "import error for '$SCWRYPTS_LIBRARY_GROUP/$SCWRYPTS_LIBRARY'"
|
ERROR "import error for '$SCWRYPTS_LIBRARY_GROUP/$SCWRYPTS_LIBRARY'"
|
||||||
|
@ -12,10 +12,7 @@ SCWRYPTS__RUN() { # context wrapper to run scwrypts within scwrypts
|
|||||||
local EXIT_CODE=0
|
local EXIT_CODE=0
|
||||||
((SUBSCWRYPT+=1))
|
((SUBSCWRYPT+=1))
|
||||||
|
|
||||||
SCWRYPTS_LOG_LEVEL=$SCWRYPTS_LOG_LEVEL \
|
SUBSCWRYPT=$SUBSCWRYPT $SCWRYPTS_ROOT/run $@
|
||||||
SUBSCWRYPT=$SUBSCWRYPT \
|
|
||||||
$SCWRYPTS_ROOT__scwrypts/scwrypts $@
|
|
||||||
|
|
||||||
EXIT_CODE=$?
|
EXIT_CODE=$?
|
||||||
|
|
||||||
((SUBSCWRYPT-=1))
|
((SUBSCWRYPT-=1))
|
||||||
|
@ -94,7 +94,7 @@ SCWRYPTS__GET_RUNSTRING() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
RUNSTRING="SCWRYPTS_ENV=$ENV_NAME; $RUNSTRING"
|
RUNSTRING="SCWRYPTS_ENV=$ENV_NAME; $RUNSTRING"
|
||||||
RUNSTRING="source $SCWRYPTS_ROOT__scwrypts/zsh/lib/import.driver.zsh; $RUNSTRING"
|
RUNSTRING="source $SCWRYPTS_ROOT/zsh/lib/import.driver.zsh; $RUNSTRING"
|
||||||
|
|
||||||
local _VIRTUALENV=$(eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$SCWRYPT_GROUP'/$SCWRYPT_TYPE/bin/activate')
|
local _VIRTUALENV=$(eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$SCWRYPT_GROUP'/$SCWRYPT_TYPE/bin/activate')
|
||||||
[ -f $_VIRTUALENV ] && RUNSTRING="source $_VIRTUALENV; $RUNSTRING"
|
[ -f $_VIRTUALENV ] && RUNSTRING="source $_VIRTUALENV; $RUNSTRING"
|
||||||
@ -119,27 +119,6 @@ SCWRYPTS__GET_RUNSTRING__zsh() {
|
|||||||
|| SCWRYPT_FILENAME="$GROUP_PATH/$SCWRYPT_TYPE/$SCWRYPT_NAME" \
|
|| SCWRYPT_FILENAME="$GROUP_PATH/$SCWRYPT_TYPE/$SCWRYPT_NAME" \
|
||||||
;
|
;
|
||||||
|
|
||||||
SCWRYPTS__GET_RUNSTRING__zsh__generic "$SCWRYPT_FILENAME"
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
SCWRYPTS__GET_RUNSTRING__zsh__generic() {
|
|
||||||
# boilerplate to allow
|
|
||||||
# - multiflag splitting (e.g. -abc = -a -b -c)
|
|
||||||
# - help flag injection (e.g. -h | --help)
|
|
||||||
# - default USAGE definition (allows USAGE__options style usage definition)
|
|
||||||
# - required MAIN() function wrapping
|
|
||||||
#
|
|
||||||
# this is available automatically in SCWRYPTS_GROUP declaration contexts
|
|
||||||
# (e.g. my-group.scwrypts.zsh)
|
|
||||||
local ZSH_FILENAME="$1"
|
|
||||||
[ $ZSH_FILENAME ] || {
|
|
||||||
ERROR '
|
|
||||||
to use SCWRYPTS__GET_RUNSTRING__zsh__generic, you must provide a
|
|
||||||
ZSH_FILENAME (arg $1) where the MAIN function is defined
|
|
||||||
'
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
printf "
|
printf "
|
||||||
source '$SCWRYPT_FILENAME'
|
source '$SCWRYPT_FILENAME'
|
||||||
CHECK_ENVIRONMENT
|
CHECK_ENVIRONMENT
|
||||||
@ -175,6 +154,22 @@ SCWRYPTS__GET_RUNSTRING__zsh__generic() {
|
|||||||
done
|
done
|
||||||
MAIN \${MAIN_ARGS[@]}
|
MAIN \${MAIN_ARGS[@]}
|
||||||
} "
|
} "
|
||||||
|
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
SCWRYPTS__GET_RUNSTRING__zsh_v3() {
|
||||||
|
WARNING "scwrypts zsh/v3 runstrings are now deprecated; please update to scwrypts v4 format"
|
||||||
|
|
||||||
|
__CHECK_DEPENDENCY zsh || return 1
|
||||||
|
|
||||||
|
[ $(eval echo '$SCWRYPTS_TYPE__'$SCWRYPT_GROUP) ] \
|
||||||
|
&& echo "source $GROUP_PATH/$SCWRYPT_NAME" \
|
||||||
|
|| echo "source $GROUP_PATH/$SCWRYPT_TYPE/$SCWRYPT_NAME" \
|
||||||
|
;
|
||||||
|
|
||||||
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
SCWRYPTS__GET_RUNSTRING__py() {
|
SCWRYPTS__GET_RUNSTRING__py() {
|
||||||
|
@ -74,8 +74,6 @@ _VIRTUALENV__GET_PATH() {
|
|||||||
local ENV_PATH="$(eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$GROUP 2>/dev/null)"
|
local ENV_PATH="$(eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$GROUP 2>/dev/null)"
|
||||||
[ ! $ENV_PATH ] && ENV_PATH="$SCWRYPTS_VIRTUALENV_PATH__scwrypts"
|
[ ! $ENV_PATH ] && ENV_PATH="$SCWRYPTS_VIRTUALENV_PATH__scwrypts"
|
||||||
|
|
||||||
mkdir -p "$ENV_PATH/$TYPE" &>/dev/null
|
|
||||||
|
|
||||||
echo $ENV_PATH/$TYPE
|
echo $ENV_PATH/$TYPE
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -97,7 +95,7 @@ CREATE_VIRTUALENV__scwrypts__py() {
|
|||||||
}
|
}
|
||||||
done
|
done
|
||||||
[ ! $PYTHON ] && {
|
[ ! $PYTHON ] && {
|
||||||
ERROR 'python>=3.10 not available; skipping python env'
|
ERROR 'python>=3.9 not available; skipping python env'
|
||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -124,7 +122,7 @@ UPDATE_VIRTUALENV__scwrypts__py() {
|
|||||||
PIP_INSTALL_ARGS+=(--no-cache-dir)
|
PIP_INSTALL_ARGS+=(--no-cache-dir)
|
||||||
PIP_INSTALL_ARGS+=(-r requirements.txt)
|
PIP_INSTALL_ARGS+=(-r requirements.txt)
|
||||||
|
|
||||||
cd "$SCWRYPTS_ROOT__scwrypts/py"
|
cd "$SCWRYPTS_ROOT/py"
|
||||||
pip install ${PIP_INSTALL_ARGS[@]}
|
pip install ${PIP_INSTALL_ARGS[@]}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -161,7 +159,7 @@ ACTIVATE_VIRTUALENV__scwrypts__zx() {
|
|||||||
UPDATE_VIRTUALENV__scwrypts__zx() {
|
UPDATE_VIRTUALENV__scwrypts__zx() {
|
||||||
local NPM_INSTALL_ARGS=()
|
local NPM_INSTALL_ARGS=()
|
||||||
|
|
||||||
cd "$SCWRYPTS_ROOT__scwrypts/zx"
|
cd "$SCWRYPTS_ROOT/zx"
|
||||||
npm install ${NPM_INSTALL_ARGS[@]}
|
npm install ${NPM_INSTALL_ARGS[@]}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -37,7 +37,7 @@ __CHECK_COREUTILS() {
|
|||||||
do
|
do
|
||||||
__CHECK_DEPENDENCY $UTIL || { ((MISSING_DEPENDENCY_COUNT+=1)); continue; }
|
__CHECK_DEPENDENCY $UTIL || { ((MISSING_DEPENDENCY_COUNT+=1)); continue; }
|
||||||
|
|
||||||
$UTIL --version 2>&1 | grep 'GNU' | grep -qv 'BSD' || {
|
$UTIL --version 2>&1 | grep -q 'GNU' || {
|
||||||
WARNING "non-GNU version of $UTIL detected"
|
WARNING "non-GNU version of $UTIL detected"
|
||||||
((NON_GNU_DEPENDENCY_COUNT+=1))
|
((NON_GNU_DEPENDENCY_COUNT+=1))
|
||||||
}
|
}
|
||||||
|
@ -9,7 +9,7 @@ FZF() {
|
|||||||
FZF_ARGS+=(--height=50%)
|
FZF_ARGS+=(--height=50%)
|
||||||
FZF_ARGS+=(--layout=reverse)
|
FZF_ARGS+=(--layout=reverse)
|
||||||
|
|
||||||
local SELECTION=$(fzf ${FZF_ARGS[@]} --prompt "$1 : " ${@:2} 2>/dev/tty)
|
local SELECTION=$(fzf ${FZF_ARGS[@]} --prompt "$1 : " ${@:2})
|
||||||
PROMPT "$1"
|
PROMPT "$1"
|
||||||
|
|
||||||
[ $BE_QUIET ] || {
|
[ $BE_QUIET ] || {
|
||||||
@ -40,3 +40,18 @@ FZF_USER_INPUT() { # allow user to type custom answers; reconfirm if ambiguous w
|
|||||||
echo $FZF_OUTPUT
|
echo $FZF_OUTPUT
|
||||||
[ $FZF_OUTPUT ]
|
[ $FZF_OUTPUT ]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
### vvv DEPRECATED vvv ##############################################
|
||||||
|
#####################################################################
|
||||||
|
|
||||||
|
FZF_HEAD() { # prefer user input over selected
|
||||||
|
WARNING 'FZF_HEAD is deprecated and will be unavailable in v4.2; please switch to FZF_USER_INPUT (drop-in fix!)'
|
||||||
|
FZF $@ --print-query | sed '/^$/d' | head -n1;
|
||||||
|
}
|
||||||
|
FZF_TAIL() { # prefer selected over user input
|
||||||
|
WARNING 'FZF_TAIL is deprecated and will be unavailable in v4.2; please switch to FZF_USER_INPUT (drop-in fix!)'
|
||||||
|
FZF $@ --print-query | sed '/^$/d' | tail -n1;
|
||||||
|
}
|
||||||
|
|
||||||
|
#####################################################################
|
||||||
|
@ -5,29 +5,20 @@ PRINT() {
|
|||||||
local STDOUT=0
|
local STDOUT=0
|
||||||
|
|
||||||
local LTRIM=1
|
local LTRIM=1
|
||||||
local FORMAT=$SCWRYPTS_OUTPUT_FORMAT
|
|
||||||
local _S
|
|
||||||
while [[ $# -gt 0 ]]
|
while [[ $# -gt 0 ]]
|
||||||
do
|
do
|
||||||
_S=1
|
|
||||||
case $1 in
|
case $1 in
|
||||||
-n | --no-trim-tabs ) LTRIM=0 ;;
|
-n | --no-trim-tabs ) LTRIM=0 ;;
|
||||||
-x | --no-line-end ) LAST_LINE_END='' ;;
|
-x | --no-line-end ) LAST_LINE_END='' ;;
|
||||||
-o | --use-stdout ) STDOUT=1; STDERR=0 ;;
|
-o | --use-stdout ) STDOUT=1; STDERR=0 ;;
|
||||||
|
|
||||||
-f | --format ) ((_S+=1)); FORMAT=$2 ;;
|
|
||||||
|
|
||||||
* ) MESSAGE+="$(echo $1) " ;;
|
* ) MESSAGE+="$(echo $1) " ;;
|
||||||
esac
|
esac
|
||||||
shift $_S
|
shift 1
|
||||||
done
|
done
|
||||||
|
|
||||||
[ $FORMAT ] || FORMAT=pretty
|
MESSAGE="$(echo "$MESSAGE" | sed 's/%/%%/g')"
|
||||||
local STYLED_MESSAGE
|
|
||||||
case $FORMAT in
|
local STYLED_MESSAGE="$({
|
||||||
pretty )
|
|
||||||
STYLED_MESSAGE="$(echo "$MESSAGE" | sed 's/%/%%/g')"
|
|
||||||
STYLED_MESSAGE="$({
|
|
||||||
printf "${COLOR}"
|
printf "${COLOR}"
|
||||||
while IFS='' read line
|
while IFS='' read line
|
||||||
do
|
do
|
||||||
@ -39,27 +30,9 @@ PRINT() {
|
|||||||
done <<< $MESSAGE
|
done <<< $MESSAGE
|
||||||
})"
|
})"
|
||||||
STYLED_MESSAGE="${COLOR}$(echo "$STYLED_MESSAGE" | sed 's/%/%%/g')${__COLOR_RESET}${LAST_LINE_END}"
|
STYLED_MESSAGE="${COLOR}$(echo "$STYLED_MESSAGE" | sed 's/%/%%/g')${__COLOR_RESET}${LAST_LINE_END}"
|
||||||
;;
|
|
||||||
json )
|
|
||||||
STYLED_MESSAGE="$(
|
|
||||||
echo '{}' | jq -c ".
|
|
||||||
| .timestamp = \"$(date +%s)\"
|
|
||||||
| .runtime = \"$SCWRYPTS_RUNTIME_ID\"
|
|
||||||
| .status = \"$(echo "$PREFIX" | sed 's/ .*//')\"
|
|
||||||
| .message = $(echo $MESSAGE | sed 's/^\t\+//' | jq -Rs)
|
|
||||||
" | sed 's/\\/\\\\/g'
|
|
||||||
)\n"
|
|
||||||
;;
|
|
||||||
* )
|
|
||||||
echo "ERROR : unsupported format '$FORMAT'" >&2
|
|
||||||
return 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
|
[[ $STDERR -eq 1 ]] && printf $STYLED_MESSAGE >&2
|
||||||
|
[[ $STDOUT -eq 1 ]] && printf $STYLED_MESSAGE
|
||||||
[[ $STDERR -eq 1 ]] && printf -- "$STYLED_MESSAGE" >&2
|
|
||||||
[[ $STDOUT -eq 1 ]] && printf -- "$STYLED_MESSAGE"
|
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
@ -6,7 +6,6 @@ source "${0:a:h}/io.print.zsh"
|
|||||||
[ ! $ERRORS ] && ERRORS=0
|
[ ! $ERRORS ] && ERRORS=0
|
||||||
|
|
||||||
ERROR() { # command encountered an error
|
ERROR() { # command encountered an error
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||||
&& PREFIX="ERROR ✖" COLOR=$__RED PRINT "$@"
|
&& PREFIX="ERROR ✖" COLOR=$__RED PRINT "$@"
|
||||||
((ERRORS+=1))
|
((ERRORS+=1))
|
||||||
@ -14,47 +13,35 @@ ERROR() { # command encountered an error
|
|||||||
}
|
}
|
||||||
|
|
||||||
SUCCESS() { # command completed successfully
|
SUCCESS() { # command completed successfully
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||||
&& PREFIX="SUCCESS ✔" COLOR=$__GREEN PRINT "$@"
|
&& PREFIX="SUCCESS ✔" COLOR=$__GREEN PRINT "$@"
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
REMINDER() { # include sysadmin reminder or other important notice to users
|
REMINDER() { # include sysadmin reminder or other important notice to users
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||||
&& PREFIX="REMINDER " COLOR=$__BRIGHT_MAGENTA PRINT "$@"
|
&& PREFIX="REMINDER " COLOR=$__BRIGHT_MAGENTA PRINT "$@"
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
STATUS() { # general status updates (prefer this to generic 'echo')
|
STATUS() { # general status updates (prefer this to generic 'echo')
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] \
|
||||||
&& PREFIX="STATUS " COLOR=$__BLUE PRINT "$@"
|
&& PREFIX="STATUS " COLOR=$__BLUE PRINT "$@"
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
WARNING() { # warning-level messages; not errors
|
WARNING() { # warning-level messages; not errors
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 3 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 3 ]] \
|
||||||
&& PREFIX="WARNING " COLOR=$__YELLOW PRINT "$@"
|
&& PREFIX="WARNING " COLOR=$__YELLOW PRINT "$@"
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
DEBUG() { # helpful during development or (sparingly) to help others' development
|
DEBUG() { # helpful during development or (sparingly) to help others' development
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 4 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 4 ]] \
|
||||||
&& PREFIX="DEBUG ℹ" COLOR=$__WHITE PRINT "$@"
|
&& PREFIX="DEBUG ℹ" COLOR=$__WHITE PRINT "$@"
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
PROMPT() { # you probably want to use yN or INPUT from below
|
PROMPT() { # you probably want to use yN or INPUT from below
|
||||||
[ ! $SCWRYPTS_LOG_LEVEL ] && local SCWRYPTS_LOG_LEVEL=4
|
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||||
&& PREFIX="PROMPT " COLOR=$__CYAN PRINT "$@" \
|
&& PREFIX="PROMPT " COLOR=$__CYAN PRINT "$@" \
|
||||||
&& PREFIX="USER ⌨" COLOR=$__BRIGHT_CYAN PRINT '' --no-line-end \
|
&& PREFIX="USER ⌨" COLOR=$__BRIGHT_CYAN PRINT '' --no-line-end \
|
||||||
;
|
;
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
FAIL() { SCWRYPTS_LOG_LEVEL=1 ERROR "${@:2}"; exit $1; }
|
FAIL() { SCWRYPTS_LOG_LEVEL=1 ERROR "${@:2}"; exit $1; }
|
||||||
@ -224,21 +211,15 @@ READ_YN() { # yes/no read is suprisingly tricky
|
|||||||
local yn
|
local yn
|
||||||
PROMPT "${USERPROMPT[@]}"
|
PROMPT "${USERPROMPT[@]}"
|
||||||
|
|
||||||
local PERFORM_FAKE_PROMPT=false
|
|
||||||
case $SKIP_USER_INPUT in
|
case $SKIP_USER_INPUT in
|
||||||
true ) yn=y ;;
|
true ) yn=y ;;
|
||||||
false )
|
false )
|
||||||
[[ $SCWRYPTS_LOG_LEVEL -lt 1 ]] && {
|
[[ $FORCE_USER_INPUT =~ true ]] && [[ $SCWRYPTS_LOG_LEVEL -lt 1 ]] \
|
||||||
[[ $FORCE_USER_INPUT =~ false ]] && [ ! -t 0 ] \
|
|
||||||
|| PERFORM_FAKE_PROMPT=true
|
|
||||||
}
|
|
||||||
|
|
||||||
[[ $PERFORM_FAKE_PROMPT =~ true ]] \
|
|
||||||
&& echo -n "${USERPROMPT[@]} : " >&2
|
&& echo -n "${USERPROMPT[@]} : " >&2
|
||||||
|
|
||||||
READ ${READ_ARGS[@]} -s -k yn
|
READ ${READ_ARGS[@]} -s -k yn
|
||||||
|
|
||||||
[[ $PERFORM_FAKE_PROMPT =~ true ]] \
|
[[ $FORCE_USER_INPUT =~ true ]] && [[ $SCWRYPTS_LOG_LEVEL -lt 1 ]] \
|
||||||
&& echo $yn >&2
|
&& echo $yn >&2
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
@ -72,7 +72,7 @@ CHECK_ENVIRONMENT() {
|
|||||||
$E "environment errors found (see above)\n$ERROR_MESSAGE"
|
$E "environment errors found (see above)\n$ERROR_MESSAGE"
|
||||||
}
|
}
|
||||||
|
|
||||||
[[ $MISSING_ENVIRONMENT_VARIABLES -ne 0 ]] && [[ $__SCWRYPT ]] && {
|
[[ $MISSING_ENVIRONMENT_VARIABLES -ne 0 ]] && {
|
||||||
REMINDER "
|
REMINDER "
|
||||||
to quickly update missing environment variables, run:
|
to quickly update missing environment variables, run:
|
||||||
'scwrypts zsh/scwrypts/environment/edit'
|
'scwrypts zsh/scwrypts/environment/edit'
|
||||||
|
2
zx/lib/.gitignore
vendored
2
zx/lib/.gitignore
vendored
@ -1,2 +0,0 @@
|
|||||||
dist/
|
|
||||||
node_modules/
|
|
@ -1,2 +0,0 @@
|
|||||||
dist
|
|
||||||
node_modules
|
|
@ -1,100 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "scwrypts",
|
|
||||||
"main": "dist/index.js",
|
|
||||||
"type": "module",
|
|
||||||
"files": [
|
|
||||||
"dist"
|
|
||||||
],
|
|
||||||
"description": "scwrypts integration for typescript",
|
|
||||||
"scripts": {
|
|
||||||
"build": "rm -rf ./dist && tsc",
|
|
||||||
"test": "jest",
|
|
||||||
"lint": "eslint . && prettier --check src/",
|
|
||||||
"format": "prettier --write src/"
|
|
||||||
},
|
|
||||||
"author": "Wryn (yage) Wagner",
|
|
||||||
"license": "GPL-3.0",
|
|
||||||
"devDependencies": {
|
|
||||||
"@jest/globals": "^29.7.0",
|
|
||||||
"@types/jest": "^29.5.12",
|
|
||||||
"@types/node": "^20.11.19",
|
|
||||||
"@types/uuid": "^9.0.8",
|
|
||||||
"@typescript-eslint/eslint-plugin": "^7.0.2",
|
|
||||||
"@typescript-eslint/parser": "^7.0.2",
|
|
||||||
"eslint": "^8.56.0",
|
|
||||||
"jest": "^29.7.0",
|
|
||||||
"prettier": "^3.2.5",
|
|
||||||
"ts-jest": "^29.1.2",
|
|
||||||
"ts-node": "^10.9.2",
|
|
||||||
"typescript": "^5.3.3",
|
|
||||||
"uuid": "^9.0.1"
|
|
||||||
},
|
|
||||||
"eslintConfig": {
|
|
||||||
"ignorePatterns": [
|
|
||||||
"dist",
|
|
||||||
"node_modules"
|
|
||||||
],
|
|
||||||
"env": {
|
|
||||||
"node": true,
|
|
||||||
"es2021": true
|
|
||||||
},
|
|
||||||
"extends": [
|
|
||||||
"eslint:recommended",
|
|
||||||
"plugin:@typescript-eslint/recommended"
|
|
||||||
],
|
|
||||||
"overrides": [
|
|
||||||
{
|
|
||||||
"env": {
|
|
||||||
"node": true
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
".eslintrc.{js,cjs}"
|
|
||||||
],
|
|
||||||
"parserOptions": {
|
|
||||||
"sourceType": "script"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"parser": "@typescript-eslint/parser",
|
|
||||||
"parserOptions": {
|
|
||||||
"ecmaVersion": "latest",
|
|
||||||
"sourceType": "module"
|
|
||||||
},
|
|
||||||
"plugins": [
|
|
||||||
"@typescript-eslint"
|
|
||||||
],
|
|
||||||
"rules": {
|
|
||||||
"linebreak-style": [
|
|
||||||
"error",
|
|
||||||
"unix"
|
|
||||||
],
|
|
||||||
"quotes": [
|
|
||||||
"error",
|
|
||||||
"single"
|
|
||||||
],
|
|
||||||
"semi": [
|
|
||||||
"error",
|
|
||||||
"always"
|
|
||||||
],
|
|
||||||
"comma-dangle": [
|
|
||||||
"error",
|
|
||||||
"always-multiline"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"prettier": {
|
|
||||||
"printWidth": 120,
|
|
||||||
"singleQuote": true,
|
|
||||||
"trailingComma": "all"
|
|
||||||
},
|
|
||||||
"jest": {
|
|
||||||
"preset": "ts-jest",
|
|
||||||
"clearMocks": true,
|
|
||||||
"moduleNameMapper": {
|
|
||||||
"^(\\.{1,2}/.*)\\.js$": "$1"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"execa": "^8.0.1"
|
|
||||||
}
|
|
||||||
}
|
|
3166
zx/lib/pnpm-lock.yaml
generated
3166
zx/lib/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1,5 +0,0 @@
|
|||||||
export * from './scwrypts/scwrypts.js';
|
|
||||||
|
|
||||||
export { ScwryptsLogLevel } from './scwrypts/types.js';
|
|
||||||
|
|
||||||
export type { ScwryptsOptions } from './scwrypts/types.js';
|
|
@ -1,116 +0,0 @@
|
|||||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
||||||
import { describe, expect, test, beforeEach, jest } from '@jest/globals';
|
|
||||||
import { v4 as uuid } from 'uuid';
|
|
||||||
|
|
||||||
import * as parseCLIArgs from './parse-cli-args.js';
|
|
||||||
|
|
||||||
import { getScwryptsLookup, Errors } from './get-scwrypts-lookup.js';
|
|
||||||
|
|
||||||
import type { ScwryptsOptions } from './types.js';
|
|
||||||
|
|
||||||
let sample: any;
|
|
||||||
beforeEach(() => {
|
|
||||||
sample = {
|
|
||||||
parsedCLIArgs: [uuid(), uuid(), uuid()],
|
|
||||||
spy: {},
|
|
||||||
};
|
|
||||||
|
|
||||||
sample.spy.parseCLIArgs = jest.spyOn(parseCLIArgs, 'parseCLIArgs');
|
|
||||||
sample.spy.parseCLIArgs.mockReturnValue(sample.parsedCLIArgs);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('exact', () => {
|
|
||||||
beforeEach(() => {
|
|
||||||
sample.exact = {
|
|
||||||
name: uuid(),
|
|
||||||
group: uuid(),
|
|
||||||
type: uuid(),
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
test('provides correct lookup', () => {
|
|
||||||
const lookup = getScwryptsLookup(sample.exact as ScwryptsOptions);
|
|
||||||
|
|
||||||
expect(lookup).toEqual({
|
|
||||||
method: 'exact',
|
|
||||||
...sample.exact,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('throws error', () => {
|
|
||||||
test('when missing group', () => {
|
|
||||||
delete sample.exact.group;
|
|
||||||
try {
|
|
||||||
getScwryptsLookup(sample.exact as ScwryptsOptions);
|
|
||||||
expect(true).toBeFalsy();
|
|
||||||
} catch (error) {
|
|
||||||
expect(error).toEqual(Errors.MissingScwryptsExactLookupParametersError);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test('when missing type', () => {
|
|
||||||
delete sample.exact.type;
|
|
||||||
try {
|
|
||||||
getScwryptsLookup(sample.exact as ScwryptsOptions);
|
|
||||||
expect(true).toBeFalsy();
|
|
||||||
} catch (error) {
|
|
||||||
expect(error).toEqual(Errors.MissingScwryptsExactLookupParametersError);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('patterns', () => {
|
|
||||||
describe('list', () => {
|
|
||||||
let lookup: any;
|
|
||||||
beforeEach(() => {
|
|
||||||
sample.patterns = {
|
|
||||||
patterns: [uuid(), uuid(), uuid()],
|
|
||||||
};
|
|
||||||
|
|
||||||
lookup = getScwryptsLookup(sample.patterns as ScwryptsOptions);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('provides correct lookup', () => {
|
|
||||||
expect(lookup).toEqual({
|
|
||||||
method: 'patterns',
|
|
||||||
patterns: sample.parsedCLIArgs,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test('parses patterns', () => {
|
|
||||||
expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.patterns.patterns);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('string', () => {
|
|
||||||
let lookup: any;
|
|
||||||
beforeEach(() => {
|
|
||||||
sample.patterns = {
|
|
||||||
patterns: uuid(),
|
|
||||||
};
|
|
||||||
|
|
||||||
lookup = getScwryptsLookup(sample.patterns as ScwryptsOptions);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('provides correct lookup', () => {
|
|
||||||
expect(lookup).toEqual({
|
|
||||||
method: 'patterns',
|
|
||||||
patterns: sample.parsedCLIArgs,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test('parses patterns', () => {
|
|
||||||
expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.patterns.patterns);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test('throws error when missing name and patterns', () => {
|
|
||||||
try {
|
|
||||||
getScwryptsLookup({} as ScwryptsOptions);
|
|
||||||
expect(true).toBeFalsy();
|
|
||||||
} catch (error) {
|
|
||||||
expect(error).toEqual(Errors.NoScwryptsLookupError);
|
|
||||||
}
|
|
||||||
});
|
|
@ -1,49 +0,0 @@
|
|||||||
import { parseCLIArgs } from './parse-cli-args.js';
|
|
||||||
|
|
||||||
import type { ScwryptsOptions } from './types.js';
|
|
||||||
|
|
||||||
export type ScwryptsLookupOptions =
|
|
||||||
| {
|
|
||||||
method: 'exact';
|
|
||||||
name: string;
|
|
||||||
group: string;
|
|
||||||
type: string;
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
method: 'patterns';
|
|
||||||
patterns: string[];
|
|
||||||
};
|
|
||||||
|
|
||||||
export const Errors = {
|
|
||||||
NoScwryptsLookupError: {
|
|
||||||
name: 'NoScwryptsLookupError',
|
|
||||||
message: 'no scwrypts lookup parameters provided',
|
|
||||||
},
|
|
||||||
MissingScwryptsExactLookupParametersError: {
|
|
||||||
name: 'MissingScwryptsExactLookupParametersError',
|
|
||||||
message: '"name" option requires "group" and "type" options',
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
export const getScwryptsLookup = (options: ScwryptsOptions): ScwryptsLookupOptions => {
|
|
||||||
if (options.name === undefined) {
|
|
||||||
if (options.patterns === undefined || options.patterns.length === 0) {
|
|
||||||
throw Errors.NoScwryptsLookupError;
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
method: 'patterns',
|
|
||||||
patterns: parseCLIArgs(options.patterns),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options.group === undefined || options.type === undefined) {
|
|
||||||
throw Errors.MissingScwryptsExactLookupParametersError;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
method: 'exact',
|
|
||||||
name: options.name,
|
|
||||||
group: options.group,
|
|
||||||
type: options.type,
|
|
||||||
};
|
|
||||||
};
|
|
@ -1,32 +0,0 @@
|
|||||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
||||||
import { describe, expect, test, beforeEach } from '@jest/globals';
|
|
||||||
import { v4 as uuid } from 'uuid';
|
|
||||||
|
|
||||||
import { parseCLIArgs } from './parse-cli-args.js';
|
|
||||||
|
|
||||||
let sample: any;
|
|
||||||
beforeEach(() => {
|
|
||||||
sample = {
|
|
||||||
args: [uuid(), uuid(), uuid()],
|
|
||||||
};
|
|
||||||
|
|
||||||
sample.argstring = sample.args.join(' ');
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('undefined input', () => {
|
|
||||||
test('produces a string[]', () => {
|
|
||||||
expect(parseCLIArgs(undefined)).toEqual([]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('string input', () => {
|
|
||||||
test('produces a string[]', () => {
|
|
||||||
expect(parseCLIArgs(sample.argstring)).toEqual(sample.args);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('string[] input', () => {
|
|
||||||
test('produces a string[]', () => {
|
|
||||||
expect(parseCLIArgs(sample.args)).toEqual(sample.args);
|
|
||||||
});
|
|
||||||
});
|
|
@ -1,12 +0,0 @@
|
|||||||
export type CLIArgs = string | string[] | undefined;
|
|
||||||
|
|
||||||
export const parseCLIArgs = (args: CLIArgs): string[] => {
|
|
||||||
switch (typeof args) {
|
|
||||||
case 'undefined':
|
|
||||||
return [];
|
|
||||||
case 'string':
|
|
||||||
return args.split(' ');
|
|
||||||
default:
|
|
||||||
return args;
|
|
||||||
}
|
|
||||||
};
|
|
@ -1,155 +0,0 @@
|
|||||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
||||||
import { describe, expect, test, beforeEach, jest } from '@jest/globals';
|
|
||||||
import { v4 as uuid } from 'uuid';
|
|
||||||
|
|
||||||
import { execa } from 'execa';
|
|
||||||
import * as Module_getScwryptsLookup from './get-scwrypts-lookup.js';
|
|
||||||
import * as Module_parseCLIArgs from './parse-cli-args.js';
|
|
||||||
import { ScwryptsLogLevel } from './types.js';
|
|
||||||
|
|
||||||
import { scwrypts } from './scwrypts.js';
|
|
||||||
|
|
||||||
jest.mock('execa', () => ({
|
|
||||||
execa: jest.fn(() => Promise.resolve()),
|
|
||||||
}));
|
|
||||||
|
|
||||||
const env = process.env;
|
|
||||||
beforeEach(() => {});
|
|
||||||
|
|
||||||
let sample: any;
|
|
||||||
beforeEach(() => {
|
|
||||||
sample = {
|
|
||||||
options: {
|
|
||||||
name: uuid(),
|
|
||||||
group: uuid(),
|
|
||||||
type: uuid(),
|
|
||||||
patterns: [uuid(), uuid(), uuid()],
|
|
||||||
log_level: Math.floor(Math.random() * Object.keys(ScwryptsLogLevel).length),
|
|
||||||
args: uuid(),
|
|
||||||
},
|
|
||||||
lookup: {
|
|
||||||
exact: {
|
|
||||||
method: 'exact',
|
|
||||||
name: uuid(),
|
|
||||||
group: uuid(),
|
|
||||||
type: uuid(),
|
|
||||||
},
|
|
||||||
patterns: {
|
|
||||||
method: 'patterns',
|
|
||||||
patterns: [uuid(), uuid(), uuid()],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
env: {
|
|
||||||
SCWRYPTS_EXECUTABLE: uuid(),
|
|
||||||
},
|
|
||||||
parsedCLIArgs: [uuid(), uuid(), uuid()],
|
|
||||||
spy: {},
|
|
||||||
};
|
|
||||||
|
|
||||||
sample.spy.getScwryptsLookup = jest.spyOn(Module_getScwryptsLookup, 'getScwryptsLookup');
|
|
||||||
sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.exact);
|
|
||||||
|
|
||||||
sample.spy.parseCLIArgs = jest.spyOn(Module_parseCLIArgs, 'parseCLIArgs');
|
|
||||||
sample.spy.parseCLIArgs.mockReturnValue(sample.parsedCLIArgs);
|
|
||||||
|
|
||||||
jest.resetModules();
|
|
||||||
process.env = {
|
|
||||||
...env,
|
|
||||||
...sample.env,
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
process.env = { ...env };
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('exact lookup', () => {
|
|
||||||
beforeEach(async () => {
|
|
||||||
sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.exact);
|
|
||||||
await scwrypts(sample.options);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('gets the correct lookup', () => {
|
|
||||||
expect(sample.spy.getScwryptsLookup).toHaveBeenCalledWith(sample.options);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('parses arguments correctly', () => {
|
|
||||||
expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.options.args);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('calls the correct scwrypt', () => {
|
|
||||||
expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
|
|
||||||
'--name',
|
|
||||||
sample.lookup.exact.name,
|
|
||||||
'--group',
|
|
||||||
sample.lookup.exact.group,
|
|
||||||
'--type',
|
|
||||||
sample.lookup.exact.type,
|
|
||||||
'--log-level',
|
|
||||||
sample.options.log_level.toString(),
|
|
||||||
'--',
|
|
||||||
...sample.parsedCLIArgs,
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('patterns lookup', () => {
|
|
||||||
beforeEach(async () => {
|
|
||||||
sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.patterns);
|
|
||||||
await scwrypts(sample.options);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('gets the correct lookup', () => {
|
|
||||||
expect(sample.spy.getScwryptsLookup).toHaveBeenCalledWith(sample.options);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('parses arguments correctly', () => {
|
|
||||||
expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.options.args);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('calls the correct scwrypt', () => {
|
|
||||||
expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
|
|
||||||
...sample.lookup.patterns.patterns,
|
|
||||||
'--log-level',
|
|
||||||
sample.options.log_level.toString(),
|
|
||||||
'--',
|
|
||||||
...sample.parsedCLIArgs,
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test('omits --log-level arguments if not provided', async () => {
|
|
||||||
delete sample.options.log_level;
|
|
||||||
|
|
||||||
await scwrypts(sample.options);
|
|
||||||
|
|
||||||
expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
|
|
||||||
'--name',
|
|
||||||
sample.lookup.exact.name,
|
|
||||||
'--group',
|
|
||||||
sample.lookup.exact.group,
|
|
||||||
'--type',
|
|
||||||
sample.lookup.exact.type,
|
|
||||||
'--',
|
|
||||||
...sample.parsedCLIArgs,
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('uses default scwrypts executable SCWRYPTS_EXECUTABLE is not provided', async () => {
|
|
||||||
delete process.env.SCWRYPTS_EXECUTABLE;
|
|
||||||
|
|
||||||
await scwrypts(sample.options);
|
|
||||||
|
|
||||||
expect(execa).toHaveBeenCalledWith('scwrypts', [
|
|
||||||
'--name',
|
|
||||||
sample.lookup.exact.name,
|
|
||||||
'--group',
|
|
||||||
sample.lookup.exact.group,
|
|
||||||
'--type',
|
|
||||||
sample.lookup.exact.type,
|
|
||||||
'--log-level',
|
|
||||||
sample.options.log_level.toString(),
|
|
||||||
'--',
|
|
||||||
...sample.parsedCLIArgs,
|
|
||||||
]);
|
|
||||||
});
|
|
@ -1,31 +0,0 @@
|
|||||||
import { execa } from 'execa';
|
|
||||||
|
|
||||||
import { getScwryptsLookup } from './get-scwrypts-lookup.js';
|
|
||||||
import { parseCLIArgs } from './parse-cli-args.js';
|
|
||||||
|
|
||||||
import type { ScwryptsOptions } from './types.js';
|
|
||||||
|
|
||||||
export const scwrypts = async (options: ScwryptsOptions) => {
|
|
||||||
const lookup = getScwryptsLookup(options);
|
|
||||||
|
|
||||||
const scwryptsExecutableArgs: string[] = [];
|
|
||||||
|
|
||||||
switch (lookup.method) {
|
|
||||||
case 'exact':
|
|
||||||
scwryptsExecutableArgs.push('--name', lookup.name, '--group', lookup.group, '--type', lookup.type);
|
|
||||||
break;
|
|
||||||
case 'patterns':
|
|
||||||
scwryptsExecutableArgs.push(...lookup.patterns);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options.log_level !== undefined) {
|
|
||||||
scwryptsExecutableArgs.push('--log-level', options.log_level.toString());
|
|
||||||
}
|
|
||||||
|
|
||||||
return await execa(process.env.SCWRYPTS_EXECUTABLE || 'scwrypts', [
|
|
||||||
...scwryptsExecutableArgs,
|
|
||||||
'--',
|
|
||||||
...parseCLIArgs(options.args),
|
|
||||||
]);
|
|
||||||
};
|
|
@ -1,16 +0,0 @@
|
|||||||
export type ScwryptsOptions = {
|
|
||||||
name: string | undefined;
|
|
||||||
group: string | undefined;
|
|
||||||
type: string | undefined;
|
|
||||||
patterns: string[] | undefined;
|
|
||||||
log_level: ScwryptsLogLevel | undefined;
|
|
||||||
args: string | string[] | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export enum ScwryptsLogLevel {
|
|
||||||
SILENT = 0,
|
|
||||||
QUIET = 1,
|
|
||||||
NORMAL = 2,
|
|
||||||
WARNING = 3,
|
|
||||||
DEBUG = 4,
|
|
||||||
}
|
|
@ -1,18 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"module": "ES2022",
|
|
||||||
"moduleResolution": "node",
|
|
||||||
"target": "ES2022",
|
|
||||||
"lib": ["ES2022"],
|
|
||||||
"checkJs": true,
|
|
||||||
"declaration": true,
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"forceConsistentCasingInFileNames": true,
|
|
||||||
"outDir": "dist",
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"strict": true
|
|
||||||
},
|
|
||||||
"include": ["src"],
|
|
||||||
"exclude": ["node_modules", "dist", "extensions", "**/*.test.ts"]
|
|
||||||
}
|
|
9024
zx/package-lock.json
generated
9024
zx/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -9,8 +9,5 @@
|
|||||||
"preinstall": "npm i -g zx"
|
"preinstall": "npm i -g zx"
|
||||||
},
|
},
|
||||||
"author": "yage",
|
"author": "yage",
|
||||||
"license": "GPL-3.0-or-later",
|
"license": "GPL-3.0-or-later"
|
||||||
"dependencies": {
|
|
||||||
"scwrypts": "file:lib"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user