Compare commits
11 Commits
v5.0.0
...
d4ef1c70e0
Author | SHA1 | Date | |
---|---|---|---|
d4ef1c70e0 | |||
c9e107d2fd | |||
b6b4f2e5b8 | |||
432593a0f3 | |||
6629caf459 | |||
8bcc99b898 | |||
05694ed022 | |||
67bd712590 | |||
a90482de8c | |||
261bbee1a4 | |||
fcf492c661 |
@ -1,352 +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
|
||||
|
||||
zsh:
|
||||
docker:
|
||||
- image: alpine:3
|
||||
resource_class: small
|
||||
|
||||
commands:
|
||||
archlinux-run:
|
||||
description: execute steps in the archlinux container as 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
|
||||
|
||||
temp-downgrade-fakeroot:
|
||||
- &archlinux-temp-downgrade-fakeroot
|
||||
run:
|
||||
name: downgrade fakeroot to v1.34 (v1.35 and v1.36 are confirmed to break)
|
||||
command: |
|
||||
pacman -U --noconfirm https://archive.archlinux.org/packages/f/fakeroot/fakeroot-1.34-1-x86_64.pkg.tar.zst
|
||||
|
||||
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-temp-downgrade-fakeroot
|
||||
- *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-temp-downgrade-fakeroot
|
||||
- *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/*
|
||||
|
||||
zsh-test:
|
||||
executor: zsh
|
||||
working_directory: ~/scwrypts
|
||||
steps:
|
||||
- checkout:
|
||||
path: ~/scwrypts
|
||||
- run:
|
||||
name: install dependencies
|
||||
command: |
|
||||
: \
|
||||
&& apk add \
|
||||
coreutils \
|
||||
findutils \
|
||||
fzf \
|
||||
perl \
|
||||
sed \
|
||||
gawk \
|
||||
git \
|
||||
jo \
|
||||
jq \
|
||||
util-linux \
|
||||
uuidgen \
|
||||
yq \
|
||||
zsh \
|
||||
;
|
||||
- run:
|
||||
name: scwrypts zsh/unittest
|
||||
command: |
|
||||
~/scwrypts/scwrypts run unittest \
|
||||
;
|
||||
- run:
|
||||
name: scwrypts returns proper success codes
|
||||
command: |
|
||||
~/scwrypts/scwrypts -n sanity check -- --exit-code 0
|
||||
[[ $? -eq 0 ]] || exit 1
|
||||
- run:
|
||||
shell: /bin/sh
|
||||
name: scwrypts returns proper error codes
|
||||
command: |
|
||||
~/scwrypts/scwrypts -n sanity check -- --exit-code 101
|
||||
[[ $? -eq 101 ]] || exit 1
|
||||
|
||||
workflows:
|
||||
test:
|
||||
jobs:
|
||||
- aur-test:
|
||||
&dev-filters
|
||||
filters:
|
||||
branches:
|
||||
ignore: /^main$/
|
||||
|
||||
- python-test: *dev-filters
|
||||
- nodejs-test: *dev-filters
|
||||
- zsh-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
|
||||
- zsh-test
|
||||
|
||||
- python-test: *only-publish-for-full-semver
|
||||
- python-publish:
|
||||
filters: *only-run-on-full-semver-tag-filters
|
||||
context: [pypi-yage]
|
||||
requires:
|
||||
- python-test
|
||||
- zsh-test
|
||||
|
||||
- nodejs-test: *only-publish-for-full-semver
|
||||
- nodejs-publish:
|
||||
filters: *only-run-on-full-semver-tag-filters
|
||||
context: [npm-wrynegade]
|
||||
requires:
|
||||
- nodejs-test
|
||||
- zsh-test
|
||||
|
||||
- zsh-test: *only-publish-for-full-semver
|
@ -1,89 +0,0 @@
|
||||
#!/bin/zsh
|
||||
#
|
||||
# a temporary template conversion utility for env.template (<=v4)
|
||||
# to env.yaml (>=v5)
|
||||
#
|
||||
eval $(scwrypts --config)
|
||||
use -c scwrypts/environment-files
|
||||
|
||||
ENVIRONMENT_ROOT="$1"
|
||||
[ "$ENVIRONMENT_ROOT" ] || ENVIRONMENT_ROOT="${0:a:h}"
|
||||
|
||||
OLDENV="$ENVIRONMENT_ROOT/env.template"
|
||||
NEWENV="$ENVIRONMENT_ROOT/env.yaml"
|
||||
ENVMAP="$ENVIRONMENT_ROOT/.map.txt"
|
||||
|
||||
GROUP="$2"
|
||||
[ $GROUP ] || GROUP=scwrypts
|
||||
GENERATE_TEMPLATE \
|
||||
| sed '1,4d; /^$/d' \
|
||||
| sed -z 's/# \([^\n]*\)\n\([^\n]*\)=/\2=\n\2=DESCRIPTION=\1/g' \
|
||||
| sed '
|
||||
s/^export //
|
||||
/./i---
|
||||
s/\s\+$//
|
||||
s/__/=/g
|
||||
s/^\(AWS\|REDIS\)_/\1=/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:\n \3:\n \4:\n \5:/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:\n \3:\n \4:/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:\n \3:/
|
||||
s/^\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:/
|
||||
s/^\([^=]*\)=$/\L\1:/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2:\n \3:\n \4:\n \5: \E\6/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2:\n \3:\n \4: \E\5/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2:\n \3: \E\4/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2: \E\3/
|
||||
s/^\([^=]*\)=\([^=]\+\)$/\L\1: \E\2/
|
||||
s/: (\(.*\))/: [\1]/
|
||||
/^/,/:/{s/_/-/g}
|
||||
' \
|
||||
| sed '
|
||||
s/^ \(description:.*\)/ \1/
|
||||
s/description:/.DESCRIPTION:/
|
||||
' \
|
||||
| sed -z 's/\n\(\s\+\).DESCRIPTION:\([^\n]\+\)/\n\1.DESCRIPTION: >-\n\1 \2/g' \
|
||||
| yq eval-all '. as $item ireduce ({}; . *+ $item)' \
|
||||
> "$NEWENV" \
|
||||
;
|
||||
|
||||
cat -- "$OLDENV" \
|
||||
| sed '
|
||||
s/#.*//
|
||||
/^$/d
|
||||
s/^export //
|
||||
s/\s\+$//
|
||||
s/^\([^=]*\)=.*/\1=\n\1/
|
||||
' \
|
||||
| sed '
|
||||
/^/s/.*/\L&/
|
||||
/^/s/__/./g
|
||||
/^/s/_/-/g
|
||||
s/^/./
|
||||
s/\(aws\|redis\)-/\1./
|
||||
' \
|
||||
| perl -pe 's/=\n/^/' \
|
||||
| column -ts '^' \
|
||||
> "$ENVMAP" \
|
||||
;
|
||||
|
||||
while read line
|
||||
do
|
||||
ENV_VAR=$(echo $line | awk '{print $1;}')
|
||||
LOOKUP=$(echo $line | awk '{print $2;}')
|
||||
|
||||
cp "$NEWENV" "$NEWENV.temp"
|
||||
cat "$NEWENV.temp" \
|
||||
| yq ". | $LOOKUP.[\".ENVIRONMENT\"] = \"$ENV_VAR\"" \
|
||||
| yq 'sort_keys(...)' \
|
||||
> "$NEWENV"
|
||||
;
|
||||
done < "$ENVMAP"
|
||||
|
||||
rm -- "$NEWENV.temp" "$ENVMAP" &>/dev/null
|
||||
|
||||
head -n1 -- "$NEWENV" | grep -q "^{}$" && {
|
||||
echo '---' > "$NEWENV"
|
||||
}
|
||||
|
||||
cat -- "$NEWENV" | yq
|
||||
SUCCESS "new environment saved to '$NEWENV'"
|
@ -12,9 +12,13 @@ export DISCORD__DEFAULT_AVATAR_URL=
|
||||
export DISCORD__DEFAULT_CHANNEL_ID=
|
||||
export DISCORD__DEFAULT_USERNAME=
|
||||
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 MEDIA_SYNC__S3_BUCKET=
|
||||
export MEDIA_SYNC__TARGETS=
|
||||
export MEDIA_SYNC__S3_BUCKET
|
||||
export MEDIA_SYNC__TARGETS
|
||||
export REDIS_AUTH=
|
||||
export REDIS_HOST=
|
||||
export REDIS_PORT=
|
||||
|
@ -15,6 +15,11 @@ DISCORD__DEFAULT_CHANNEL_ID |
|
||||
DISCORD__DEFAULT_USERNAME |
|
||||
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
|
||||
|
||||
MEDIA_SYNC__S3_BUCKET | s3 bucket name and filesystem targets for media backups
|
||||
|
@ -1,66 +0,0 @@
|
||||
---
|
||||
aws:
|
||||
.DESCRIPTION: >-
|
||||
standard AWS environment variables used by awscli and other tools
|
||||
account:
|
||||
.ENVIRONMENT: AWS_ACCOUNT
|
||||
efs:
|
||||
local-mount-point:
|
||||
.DESCRIPTION: >-
|
||||
fully-qualified path to mount the EFS drive
|
||||
.ENVIRONMENT: AWS__EFS__LOCAL_MOUNT_POINT
|
||||
profile:
|
||||
.ENVIRONMENT: AWS_PROFILE
|
||||
region:
|
||||
.ENVIRONMENT: AWS_REGION
|
||||
directus:
|
||||
.DESCRIPTION: >-
|
||||
details for a directus instance
|
||||
api-token:
|
||||
.ENVIRONMENT: DIRECTUS__API_TOKEN
|
||||
base-url:
|
||||
.ENVIRONMENT: DIRECTUS__BASE_URL
|
||||
discord:
|
||||
.DESCRIPTION: >-
|
||||
details for discord bot
|
||||
bot-token:
|
||||
.ENVIRONMENT: DISCORD__BOT_TOKEN
|
||||
content-footer:
|
||||
.ENVIRONMENT: DISCORD__CONTENT_FOOTER
|
||||
content-header:
|
||||
.ENVIRONMENT: DISCORD__CONTENT_HEADER
|
||||
default-avatar-url:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_AVATAR_URL
|
||||
default-channel-id:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_CHANNEL_ID
|
||||
default-username:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_USERNAME
|
||||
default-webhook:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_WEBHOOK
|
||||
linear:
|
||||
.DESCRIPTION: >-
|
||||
linear.app project management configuration
|
||||
api-token:
|
||||
.ENVIRONMENT: LINEAR__API_TOKEN
|
||||
redis:
|
||||
.DESCRIPTION: >-
|
||||
redis connection credentials
|
||||
auth:
|
||||
.ENVIRONMENT: REDIS_AUTH
|
||||
host:
|
||||
.ENVIRONMENT: REDIS_HOST
|
||||
port:
|
||||
.ENVIRONMENT: REDIS_PORT
|
||||
twilio:
|
||||
.DESCRIPTION: >-
|
||||
twilio account / credentials
|
||||
account-sid:
|
||||
.ENVIRONMENT: TWILIO__ACCOUNT_SID
|
||||
api-key:
|
||||
.ENVIRONMENT: TWILIO__API_KEY
|
||||
api-secret:
|
||||
.ENVIRONMENT: TWILIO__API_SECRET
|
||||
default-phone-from:
|
||||
.ENVIRONMENT: TWILIO__DEFAULT_PHONE_FROM
|
||||
default-phone-to:
|
||||
.ENVIRONMENT: TWILIO__DEFAULT_PHONE_TO
|
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
|
83
README.md
83
README.md
@ -1,77 +1,60 @@
|
||||
# *Scwrypts*
|
||||
# *Scwrypts* (Wryn + Scripts)
|
||||
|
||||
Scwrypts is a CLI and API for safely running scripts in the terminal, CI, and other automated environments.
|
||||
Scwrypts is a friendly CLI / API for quickly running *sandboxed scripts* in the terminal.
|
||||
|
||||
Local runs provide a user-friendly approach to quickly execute CI workflows and automations in your terminal.
|
||||
Each local run runs through an interactive, *sandboxed environment* so you never accidentally run dev credentials in production ever again!
|
||||
In modern developer / dev-ops workflows, scripts require a complex configurations.
|
||||
Without a better solution, the developer is cursed to copy lines-upon-lines of variables into terminals, create random text artifacts, or maybe even commit secure credentials into source.
|
||||
Scwrypts leverages ZSH to give hot-key access to run scripts in such environments.
|
||||
|
||||
## Major Version Upgrade Notice
|
||||
|
||||
Please refer to [Version 4 to Version 5 Upgrade Path](./docs/upgrade/v4-to-v5.md) when upgrading from scwrypts v4 to scwrypts v5!
|
||||
Please refer to [Version 3 to Version 4 Upgrade Path](./docs/upgrade/v3-to-v4.md) when upgrading from scwrypts v3 to scwrypts v4!
|
||||
|
||||
## Installation
|
||||
## Dependencies
|
||||
Due to the wide variety of resources used by scripting libraries, the user is expected to manually resolve dependencies.
|
||||
Dependencies are lazy-loaded, and more information can be found by command error messages or in the appropriate README.
|
||||
|
||||
Quick installation is supported through both the [Arch User Repository](https://aur.archlinux.org/packages/scwrypts) and [Homebrew](https://github.com/wrynegade/homebrew-brew/tree/main/Formula)
|
||||
Because Scwrypts relies on Scwrypts (see [Meta Scwrypts](./zsh/scwrypts)), `zsh` must be installed and [`junegunn/fzf`](https://github.com/junegunn/fzf) must be available on your PATH.
|
||||
|
||||
```bash
|
||||
# AUR
|
||||
yay -Syu scwrypts
|
||||
## Usage
|
||||
Install Scwrypts by cloning this repository and sourcing `scwrypts.plugin.zsh` in your `zshrc`.
|
||||
You can now run Scwrypts using the ZLE hotkey bound to `SCWRYPTS_SHORTCUT` (default `CTRL + W`).
|
||||
|
||||
# homebrew
|
||||
brew install wrynegade/scwrypts
|
||||
```console
|
||||
% cd <path-to-cloned-repo>
|
||||
% echo "source $(pwd)/scwrypts.plugin.zsh >> $HOME/.zshrc"
|
||||
```
|
||||
|
||||
### Manual Installation
|
||||
Check out [Meta Scwrypts](./zsh/scwrypts) to quickly set up environments and adjust configuration.
|
||||
|
||||
To install scwrypts manually, clone this repository (and take note of where it is installed)
|
||||
Replacing the `/path/to/cloned-repo` appropriately, add the following line to your `~/.zshrc`:
|
||||
|
||||
### No Install / API Usage
|
||||
Alternatively, the `scwrypts` API can be used directly:
|
||||
```zsh
|
||||
source /path/to/cloned-repo/scwrypts.plugin.zsh
|
||||
./scwrypts [--env environment-name] (...script-name-patterns...) [-- ...passthrough arguments... ]
|
||||
```
|
||||
|
||||
The next time you start your terminal, you can now execute scwrypts by using the plugin shortcut(s) (by default `CTRL + SPACE`).
|
||||
Plugin shortcuts are configurable in your scwrypts configuration file found in `~/.config/scwrypts/config.zsh`, and [here is the default config](./zsh/config.user.zsh).
|
||||
Given one or more script patterns, Scwrypts will filter the commands by pattern conjunction.
|
||||
If only one command is found which matches the pattern(s), it will immediately begin execution.
|
||||
If multiple commands match, the user will be prompted to select from the filtered list.
|
||||
Of course, if no commands match, Scwrypts will exit with an error.
|
||||
|
||||
If you want to use the `scwrypts` program directly, you can either invoke the executable `./scwrypts` or link it in your PATH for easy access.
|
||||
For example, if you have `~/.local/bin` in your PATH, you might run:
|
||||
```zsh
|
||||
ln -s /path/to/cloned-repo/scwrypts "${HOME}/.local/bin/scwrypts"
|
||||
```
|
||||
Given no script patterns, Scwrypts becomes an interactive CLI, prompting the user to select a command.
|
||||
|
||||
#### PATH Dependencies
|
||||
|
||||
Scwrypts provides a framework for workflows which often depend on a variety of other tools.
|
||||
Although the lazy-loaded dependency model allows hardening in CI and extendability, the user is expected to _resolve required PATH dependencies_.
|
||||
|
||||
When running locally, this is typically as simple as "install the missing program," but this may require additional steps when working in automated environments.
|
||||
|
||||
By default, the `ci` plugin is enabled which provides the `check all dependencies` scwrypt.
|
||||
You can run this to output a comprehensive list of PATH dependencies across all scwrypts groups, but, at a bare minimum, you will need the following applications in your PATH:
|
||||
|
||||
```bash
|
||||
zsh
|
||||
|
||||
grep # GNU
|
||||
sed # GNU
|
||||
sort # GNU
|
||||
|
||||
fzf # https://github.com/junegunn/fzf (only required for interactive / local)
|
||||
jo # https://github.com/jpmens/jo
|
||||
jq # https://github.com/jqlang/jq
|
||||
yq # https://github.com/mikefarah/yq
|
||||
```
|
||||
After determining which script to run, if no environment has been specified, Scwrypts prompts the user to choose one.
|
||||
|
||||
|
||||
## Usage in CI and Automated Environments
|
||||
|
||||
Set environment variable `CI=true` to run scwrypts in an automated environment.
|
||||
### Using in CI/CD or Automated Workflows
|
||||
Set environment variable `CI=true` (and use the no install method) to run in an automated pipeline.
|
||||
There are a few notable changes to this runtime:
|
||||
- **The Scwrypts sandbox environment will not load.** All variables will be read directly from the current context.
|
||||
- **The Scwrypts sandbox environment will not load.** All variables will be read from context.
|
||||
- User yes/no prompts will **always be YES**
|
||||
- Other user input will default to an empty string
|
||||
- Logs will not be captured in the user's local cache
|
||||
- Logs will not be captured
|
||||
- Setting the environment variable `SCWRYPTS_GROUP_LOADER__[a-z_]\+` will source the file indicated in the variable (this allows custom groups without needing to modify the `config.zsh` directly)
|
||||
- In GitHub actions, `*.scwrypts.zsh` groups are detected automatically from the `$GITHUB_WORKSPACE`; set `SCWRYPTS_GITHUB_NO_AUTOLOAD=true` to disable
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
Before contributing an issue, idea, or pull request, check out the [super-brief contributing guide](./docs/CONTRIBUTING.md)
|
||||
|
@ -29,7 +29,6 @@ runs:
|
||||
repository: wrynegade/scwrypts
|
||||
path: ./wrynegade/scwrypts
|
||||
ref: ${{ inputs.version }}
|
||||
fetch-tags: true
|
||||
|
||||
- name: check dependencies
|
||||
shell: bash
|
||||
@ -52,7 +51,7 @@ runs:
|
||||
} > $HOME/.scwrypts.apt-get.log 2>&1
|
||||
|
||||
echo "updating virtual dependencies"
|
||||
$GITHUB_WORKSPACE/wrynegade/scwrypts/scwrypts \
|
||||
$GITHUB_WORKSPACE/wrynegade/scwrypts/scwrypts -n \
|
||||
--name scwrypts/virtualenv/update-all \
|
||||
--group scwrypts \
|
||||
--type zsh \
|
||||
|
@ -57,7 +57,7 @@ Don't worry, it's easy.
|
||||
Take your original scwrypt, and slap the executable stuff into a function called `MAIN` (yes, it must be _exactly_, all-caps `MAIN`):
|
||||
|
||||
```diff
|
||||
#!/usr/bin/env zsh
|
||||
#!/bin/zsh
|
||||
#####################################################################
|
||||
DEPENDENCIES+=(dep-function-a dep-function-b)
|
||||
REQUIRED_ENV+=()
|
||||
@ -69,11 +69,11 @@ CHECK_ENVIRONMENT
|
||||
|
||||
- echo "do some stuff here"
|
||||
- # ... etc ...
|
||||
- echo.success "completed the stuff"
|
||||
- SUCCESS "completed the stuff"
|
||||
+ MAIN() {
|
||||
+ echo "do some stuff here"
|
||||
+ # ... etc ...
|
||||
+ echo.success "completed the stuff
|
||||
+ SUCCESS "completed the stuff
|
||||
+ }
|
||||
```
|
||||
|
||||
@ -85,7 +85,7 @@ All I had to do in this case was delete the function invocation at the end:
|
||||
```diff
|
||||
# ... top boilerplate ...
|
||||
MAIN() {
|
||||
echo.success "look at me I'm so cool I already wrote this in a main function"
|
||||
SUCCESS "look at me I'm so cool I already wrote this in a main function"
|
||||
}
|
||||
-
|
||||
- #####################################################################
|
||||
@ -115,7 +115,7 @@ Also you can ditch the `CHECK_ENVIRONMENT`.
|
||||
While it won't hurt, v4 already does this, so just get rid of it.
|
||||
Here's my recommended formatting:
|
||||
```diff
|
||||
#!/usr/bin/env zsh
|
||||
#!/bin/zsh
|
||||
- #####################################################################
|
||||
DEPENDENCIES+=(dep-function-a dep-function-b)
|
||||
- REQUIRED_ENV+=()
|
||||
@ -128,7 +128,7 @@ use do/awesome/stuff --group my-custom-library
|
||||
MAIN() {
|
||||
echo "do some stuff here"
|
||||
# ... etc ...
|
||||
echo.success "completed the stuff
|
||||
SUCCESS "completed the stuff
|
||||
}
|
||||
```
|
||||
|
||||
@ -164,7 +164,7 @@ If you _have_ done it already, typically by writing a variable called "USAGE" in
|
||||
|
||||
Returning to our original `MAIN()` example, I'll add some options parsing so we should now look something like this:
|
||||
```sh
|
||||
#!/usr/bin/env zsh
|
||||
#!/bin/zsh
|
||||
DEPENDENCIES+=(dep-function-a dep-function-b)
|
||||
|
||||
use do/awesome/stuff --group my-custom-library
|
||||
@ -200,7 +200,7 @@ I want to call out a few specific ones:
|
||||
|
||||
Just add another section to define these values before declaring `MAIN`:
|
||||
```sh
|
||||
#!/usr/bin/env zsh
|
||||
#!/bin/zsh
|
||||
DEPENDENCIES+=(dep-function-a dep-function-b)
|
||||
|
||||
use do/awesome/stuff --group my-custom-library
|
||||
|
@ -1,136 +0,0 @@
|
||||
# Scwrypts Upgrade v4 to v5 Notes
|
||||
|
||||
Although scwrypts v4 brings a number of new features, most functionality is backwards-compatible.
|
||||
|
||||
## Lots of renames!
|
||||
|
||||
Nearly every module received a rename.
|
||||
This was a decision made to improve both style-consistency and import transparency, but has resulted in a substantial number of breaking changes to `zsh-type scwrypts modules`.
|
||||
|
||||
### `zsh/utils` Functions
|
||||
|
||||
The functions in the underlying library have all been renamed, but otherwise maintain the same functionality.
|
||||
For a full reference, check out the [zsh/utils](../../zsh/utils/utils.module.zsh), but some critical renames are:
|
||||
```bash
|
||||
FZF >> utils.fzf
|
||||
FZF_USER_INPUT >> utils.fzf.user-input
|
||||
LESS >> utils.less
|
||||
YQ >> utils.yq
|
||||
|
||||
SUCCESS >> echo.success
|
||||
ERROR >> echo.error
|
||||
REMINDER >> echo.reminder
|
||||
STATUS >> echo.status
|
||||
WARNING >> echo.warning
|
||||
DEBUG >> echo.debug
|
||||
FAIL >> utils.fail
|
||||
ABORT >> utils.abort
|
||||
|
||||
CHECK_ERRORS >> utils.check-errors
|
||||
|
||||
Yn >> utils.Yn
|
||||
yN >> utils.yN
|
||||
|
||||
EDIT >> utils.io.edit
|
||||
|
||||
CHECK_ENVIRONMENT >> utils.check-environment
|
||||
```
|
||||
|
||||
### `zsh/utils` Color Functions
|
||||
|
||||
Rather than storing ANSI colors as a variable, colors are now stored as a function which prints the color code.
|
||||
Doing this has proven more versatile than trying to extract the value of the variable in several contexts.
|
||||
Rename looks like this for all named ANSI colors:
|
||||
|
||||
```bash
|
||||
$__GREEN >> utils.colors.green
|
||||
$__BRIGHT_RED >> utils.colors.bright-red
|
||||
```
|
||||
|
||||
The most common use case of colors is indirectly through the `echo.*` commands, so a new function now provides _the color used by the associated `echo.*` command_:
|
||||
|
||||
```bash
|
||||
# instead of
|
||||
STATUS "Hello there, ${_BRIGHT_GREEN}bobby${_YELLOW}. How are you?"
|
||||
|
||||
# use
|
||||
echo.status "Hello there, $(utils.colors.bright-green)bobby$(echo.status.color). How are you?
|
||||
```
|
||||
|
||||
### ZSH Scwrypts Module Naming
|
||||
|
||||
**This is the biggest point of refactor.**
|
||||
|
||||
You will notice that modules now declare their functions using a `${scwryptsmodule}` notation.
|
||||
This notation provides a dot-notated name which is intended to provide a consistent, unique naming system in ZSH (remember, everything loaded into the same shell script must have a globally-unique name).
|
||||
Consider the new naming method for the following:
|
||||
|
||||
```bash
|
||||
# v4: zsh/lib/helm/template.module.zsh
|
||||
|
||||
HELM__TEMPLATE__GET() {
|
||||
# ...
|
||||
}
|
||||
|
||||
# v5: zsh/helm/get-template.module.zsh
|
||||
${scwryptsmodule}() {
|
||||
# ...
|
||||
}
|
||||
```
|
||||
|
||||
Although the import syntax is generally the same, now we reference the full name of the module instead of the arbitrarily defined `HELM__TEMPLATE__GET`:
|
||||
|
||||
```
|
||||
# in some other scwrypt
|
||||
use helm/get-template
|
||||
|
||||
helm.get-template --raw ./my-helm-chart
|
||||
```
|
||||
|
||||
The name `${scwryptsmodule}` is depended on the scwrypts library path.
|
||||
Since there is not an easy way to provide an exhaustive list, go through all the places where you `use` something from the scwrypts core library, and check to see where it is now.
|
||||
One of the critical call-outs is the AWS CLI, which no longer follows the "just use ALL CAPS for function names," but instead is a proper module.
|
||||
|
||||
Both of the following are valid ways to use the scwrypts-safe aws-cli (`AWS` in v4):
|
||||
|
||||
```bash
|
||||
# to import _only_ AWS cli
|
||||
use cloud.aws.cli
|
||||
|
||||
cloud.aws.cli sts get-caller-identity
|
||||
|
||||
# importing the full AWS module also provides an alias
|
||||
use cloud.aws
|
||||
|
||||
cloud.aws sts get-caller-identity
|
||||
```
|
||||
|
||||
### Great news!
|
||||
|
||||
Great news!
|
||||
We have finished with **all of the necessary steps** to migrate to v5!
|
||||
|
||||
If you still have the energy, take some time to make these _recommended_ adjustments too.
|
||||
|
||||
|
||||
### Use the new `${scwryptsmodule}` syntax
|
||||
|
||||
The `${scwryptsmodule}` name is now automatically available in any module.
|
||||
The one change from the `${scwryptsmodule}` in scwrypts core is that **your scwrypts group name is the first dot**.
|
||||
|
||||
If I'm building the scwrypts group called `my-cool-stuff` and open the file `my-cool-stuff/zsh/module-a.module.zsh`, then `${scwryptsmodule}` will refer to `my-cool-stuff.module-a`.
|
||||
|
||||
### Update your `*.scwrypts.zsh` declaration file
|
||||
|
||||
In v4 and earlier, it was tricky to create your own scwrypts group, since you had to create a particular folder structure, and write a `group-name.scwrypts.zsh` file with some somewhat arbitrary requirements.
|
||||
In v5, you can now make any folder a scwrypts group by simply _creating the `*.scwrypts.zsh` file_.
|
||||
|
||||
```bash
|
||||
# this will turn the current folder into the root of a scwrypts group called `my-cool-stuff`
|
||||
touch 'my-cool-stuff.scwrypts.zsh'
|
||||
├── zsh
|
||||
├── zx
|
||||
└── py
|
||||
```
|
||||
|
||||
Advanced options for scwrypts are now [documented in the example](../../scwrypts.scwrypts.zsh), so please refer to it for any additional changes you may need for existing scwrypts modules.
|
@ -1 +0,0 @@
|
||||
---
|
@ -1,3 +1,10 @@
|
||||
# CI Helper
|
||||
# Kubernetes `kubectl` Helper Plugin
|
||||
|
||||
Disabled by default, this is used in CI contexts to try and identify missing requirements for the current workflow.
|
||||
Leverages a local `redis` application to quickly and easily set an alias `k` for `kubectl --context <some-context> --namespace <some-namespace>`.
|
||||
Much like scwrypts environments, `k` aliases are *only* shared amongst session with the same `SCWRYPTS_ENV` to prevent accidental cross-contamination.
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
Enable the plugin in `~/.config/scwrypts/config.zsh` by adding `SCWRYPTS_PLUGIN_ENABLED__KUBECTL=1`.
|
||||
Use `k` as your new `kubectl` and checkout `k --help` and `k meta --help`.
|
||||
|
@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env zsh
|
||||
#!/bin/zsh
|
||||
#####################################################################
|
||||
MAIN() {
|
||||
cd "$(scwrypts.config.group scwrypts root)"
|
||||
cd "$SCWRYPTS_ROOT__scwrypts/"
|
||||
|
||||
DEPENDENCIES+=()
|
||||
for group in ${SCWRYPTS_GROUPS[@]}
|
||||
@ -11,7 +11,7 @@ MAIN() {
|
||||
GROUP_HOME="$(eval 'echo $SCWRYPTS_ROOT__'$group)"
|
||||
[ $GROUP_HOME ] && [ -d "$GROUP_HOME" ] || continue
|
||||
|
||||
echo.status "checking dependencies for $group"
|
||||
STATUS "checking dependencies for $group"
|
||||
DEPENDENCIES+=($(
|
||||
for file in $(
|
||||
{
|
||||
@ -27,7 +27,7 @@ MAIN() {
|
||||
|
||||
DEPENDENCIES=(zsh $(echo $DEPENDENCIES | sed 's/ /\n/g' | sort -u | grep '^[-_a-zA-Z]\+$'))
|
||||
|
||||
echo.status "discovered dependencies: ($DEPENDENCIES)"
|
||||
STATUS "discovered dependencies: ($DEPENDENCIES)"
|
||||
echo $DEPENDENCIES | sed 's/ /\n/g'
|
||||
utils.check-environment && echo.success "all dependencies satisfied"
|
||||
CHECK_ENVIRONMENT && SUCCESS "all dependencies satisfied"
|
||||
}
|
||||
|
@ -1 +1,5 @@
|
||||
export ${scwryptsgroup}__type=zsh
|
||||
SCWRYPTS_GROUPS+=(ci)
|
||||
|
||||
export SCWRYPTS_TYPE__ci=zsh
|
||||
export SCWRYPTS_ROOT__ci="$SCWRYPTS_ROOT__scwrypts/plugins/ci"
|
||||
export SCWRYPTS_COLOR__ci='\033[0m'
|
||||
|
@ -1,5 +0,0 @@
|
||||
---
|
||||
scwrypts-kubectl-redis:
|
||||
.DESCRIPTION: >-
|
||||
[currently only 'managed'] 'managed' or 'custom' redis configuration
|
||||
.ENVIRONMENT: SCWRYPTS_KUBECTL_REDIS
|
@ -1,10 +0,0 @@
|
||||
export ${scwryptsgroup}__type=zsh
|
||||
export ${scwryptsgroup}__color=$(utils.colors.red)
|
||||
|
||||
#####################################################################
|
||||
|
||||
SCWRYPTS_STATIC_CONFIG__kubectl+=(
|
||||
"${scwryptsgrouproot}/.config/static/redis.zsh"
|
||||
)
|
||||
|
||||
source "${scwryptsgrouproot}/driver/kubectl.driver.zsh"
|
@ -1,18 +0,0 @@
|
||||
#####################################################################
|
||||
|
||||
DEPENDENCIES+=(kubectl)
|
||||
|
||||
use redis --group kube
|
||||
|
||||
#####################################################################
|
||||
|
||||
kube.cli() {
|
||||
local NAMESPACE="$(kube.redis get --prefix "current:namespace")"
|
||||
local CONTEXT="$(kube.kubectl.context.get)"
|
||||
|
||||
local ARGS=()
|
||||
[ "${NAMESPACE}" ] && ARGS+=(--namespace "${NAMESPACE}")
|
||||
[ "${CONTEXT}" ] && ARGS+=(--context "${CONTEXT}")
|
||||
|
||||
kubectl ${ARGS[@]} $@
|
||||
}
|
@ -1,56 +0,0 @@
|
||||
#####################################################################
|
||||
|
||||
use --group kube kubectl/cli
|
||||
use --group kube kubectl/namespace
|
||||
use --group kube redis
|
||||
|
||||
#####################################################################
|
||||
|
||||
${scwryptsmodule}.get() { kube.redis get --prefix "current:context"; }
|
||||
|
||||
${scwryptsmodule}.set() {
|
||||
local CONTEXT=$1
|
||||
[ ! "${CONTEXT}" ] && return 1
|
||||
|
||||
[[ "${CONTEXT}" =~ reset ]] && {
|
||||
: \
|
||||
&& kube.redis del --prefix "current:context" \
|
||||
&& kube.kubectl.namespace.set reset \
|
||||
;
|
||||
return $?
|
||||
}
|
||||
|
||||
: \
|
||||
&& kube.redis set --prefix "current:context" "${CONTEXT}" \
|
||||
&& kube.kubectl.namespace.set reset \
|
||||
;
|
||||
}
|
||||
|
||||
${scwryptsmodule}.select() {
|
||||
case "$(kube.kubectl.context.list | grep -v '^reset$' | wc -l)" in
|
||||
( 0 )
|
||||
echo.error "no contexts available"
|
||||
return 1
|
||||
;;
|
||||
( 1 )
|
||||
kube.kubectl.context.list | tail -n1
|
||||
;;
|
||||
( * )
|
||||
kube.kubectl.context.list | utils.fzf 'select a context'
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
${scwryptsmodule}.list() {
|
||||
echo reset
|
||||
local ALL_CONTEXTS="$(kube.cli config get-contexts -o name | sort -u)"
|
||||
|
||||
echo "${ALL_CONTEXTS}" | grep -v '^arn:aws:eks'
|
||||
|
||||
[[ "${AWS_ACCOUNT}" ]] && {
|
||||
echo "${ALL_CONTEXTS}" | grep "^arn:aws:eks:.*:${AWS_ACCOUNT}"
|
||||
true
|
||||
} || {
|
||||
echo "${ALL_CONTEXTS}" | grep '^arn:aws:eks'
|
||||
}
|
||||
}
|
@ -1,17 +0,0 @@
|
||||
#
|
||||
# combines kubectl with redis to both facilitate use of kubectl
|
||||
# between varying contexts/namespaces AND grant persistence between
|
||||
# terminal sessions
|
||||
#
|
||||
|
||||
# redis wrapper for kubectl
|
||||
use --group kube kubectl/cli
|
||||
|
||||
# simplify commands for kubecontexts
|
||||
use --group kube kubectl/context
|
||||
|
||||
# simplify commands for namespaces
|
||||
use --group kube kubectl/namespace
|
||||
|
||||
# local redirect commands for remote kubernetes services
|
||||
use --group kube kubectl/service
|
@ -1,23 +0,0 @@
|
||||
${scwryptsmodule}.get() { kube.redis get --prefix "current:namespace"; }
|
||||
|
||||
${scwryptsmodule}.set() {
|
||||
local NAMESPACE=$1
|
||||
[ ! "${NAMESPACE}" ] && return 1
|
||||
|
||||
[[ "${NAMESPACE}" =~ reset ]] && {
|
||||
kube.redis del --prefix "current:namespace"
|
||||
return $?
|
||||
}
|
||||
|
||||
kube.redis set --prefix "current:namespace" "${NAMESPACE}"
|
||||
}
|
||||
|
||||
${scwryptsmodule}.select() {
|
||||
kube.kubectl.namespace.list | utils.fzf 'select a namespace'
|
||||
}
|
||||
|
||||
${scwryptsmodule}.list() {
|
||||
echo reset
|
||||
echo default
|
||||
kube.cli get namespaces -o name | sed 's/^namespace\///' | sort | grep -v '^default$'
|
||||
}
|
@ -1,77 +0,0 @@
|
||||
#####################################################################
|
||||
|
||||
use --group kube kubectl/cli
|
||||
use --group kube kubectl/context
|
||||
use --group kube kubectl/namespace
|
||||
|
||||
#####################################################################
|
||||
|
||||
${scwryptsmodule}.serve() {
|
||||
[ "${CONTEXT}" ] || local CONTEXT="$(kube.kubectl.context.get)"
|
||||
[ "${CONTEXT}" ] || echo.error 'must configure a context in which to serve'
|
||||
|
||||
[ "${NAMESPACE}" ] || local NAMESPACE="$(kube.kubectl.namespace.get)"
|
||||
[ "${NAMESPACE}" ] || echo.error 'must configure a namespace in which to serve'
|
||||
|
||||
utils.check-errors --no-usage || return 1
|
||||
|
||||
[ "${SERVICE}" ] && SERVICE="$(kube.kubectl.service.list | jq -c "select (.service == \"${SERVICE}\")" || echo ${SERVICE})"
|
||||
[ "${SERVICE}" ] || local SERVICE="$(kube.kubectl.service.select)"
|
||||
[ "${SERVICE}" ] || echo.error 'must provide or select a service'
|
||||
|
||||
kube.kubectl.service.list | grep -q "^${SERVICE}$"\
|
||||
|| echo.error "no service '${SERVICE}' in '${CONFIG}/${NAMESPACE}'"
|
||||
|
||||
utils.check-errors --no-usage || return 1
|
||||
|
||||
##########################################
|
||||
|
||||
SERVICE_PASSWORD="$(kube.kubectl.service.get-password)"
|
||||
kube.kubectl.service.parse
|
||||
|
||||
echo.reminder "attempting to serve ${NAMESPACE}/${SERVICE_NAME}:${SERVICE_PORT}"
|
||||
[ "${SERVICE_PASSWORD}" ] && echo.reminder "password : ${SERVICE_PASSWORD}"
|
||||
|
||||
kube.cli port-forward "service/${SERVICE_NAME}" "${SERVICE_PORT}"
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
|
||||
${scwryptsmodule}.select() {
|
||||
[ "${NAMESPACE}" ] || local NAMESPACE="$(kube.kubectl.namespace.get)"
|
||||
[ "${NAMESPACE}" ] || return 1
|
||||
|
||||
local SERVICES="$(kube.kubectl.service.list)"
|
||||
local SELECTED="$({
|
||||
echo "namespace service port"
|
||||
echo ${SERVICES} \
|
||||
| jq -r '.service + " " + .port' \
|
||||
| sed "s/^/${NAMESPACE} /" \
|
||||
;
|
||||
} \
|
||||
| column -t \
|
||||
| utils.fzf 'select a service' --header-lines=1 \
|
||||
| awk '{print $2;}' \
|
||||
)"
|
||||
|
||||
echo "${SERVICES}" | jq -c "select (.service == \"${SELECTED}\")"
|
||||
}
|
||||
|
||||
${scwryptsmodule}.list() {
|
||||
kube.cli get service --no-headers\
|
||||
| awk '{print "{\"service\":\""$1"\",\"ip\":\""$3"\",\"port\":\""$5"\"}"}' \
|
||||
| jq -c 'select (.ip != "None")' \
|
||||
;
|
||||
}
|
||||
|
||||
${scwryptsmodule}.get-password() {
|
||||
[ "${PASSWORD_SECRET}" ] && [ "${PASSWORD_KEY}" ] || return 0
|
||||
|
||||
kube.cli get secret "${PASSWORD_SECRET}" -o jsonpath="{.data.${PASSWORD_KEY}}" \
|
||||
| base64 --decode
|
||||
}
|
||||
|
||||
${scwryptsmodule}.parse() {
|
||||
SERVICE_NAME="$(echo "${SERVICE}" | jq -r .service)"
|
||||
SERVICE_PORT="$(echo "${SERVICE}" | jq -r .port | sed 's|/.*$||')"
|
||||
}
|
@ -1,7 +0,0 @@
|
||||
#!/usr/bin/env zsh
|
||||
use redis --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
echo $(kube.redis --get-static-definition)
|
||||
}
|
@ -6,11 +6,10 @@ for CLI in kubectl helm flux
|
||||
do
|
||||
eval "_${CLI[1]}() {
|
||||
local SUBSESSION=0
|
||||
local SUBSESSION_OFFSET=2
|
||||
echo \${words[2]} | grep -q '^[0-9]\\+$' && SUBSESSION=\${words[2]} && SUBSESSION_OFFSET=3
|
||||
echo \${words[2]} | grep -q '^[0-9]\\+$' && SUBSESSION=\${words[2]}
|
||||
|
||||
local PASSTHROUGH_WORDS=($CLI)
|
||||
[[ \$CURRENT -gt \${SUBSESSION_OFFSET} ]] && echo \${words[\${SUBSESSION_OFFSET}]} | grep -qv '^[0-9]\\+$' && {
|
||||
[[ \$CURRENT -gt 2 ]] && echo \${words[2]} | grep -qv '^[0-9]\\+$' && {
|
||||
local KUBECONTEXT=\$(k \$SUBSESSION meta get context)
|
||||
local NAMESPACE=\$(k \$SUBSESSION meta get namespace)
|
||||
|
||||
@ -27,8 +26,8 @@ do
|
||||
for WORD in \${words[@]:1}
|
||||
do
|
||||
case \$WORD in
|
||||
( [0-9]* ) continue ;;
|
||||
( -- )
|
||||
[0-9]* ) continue ;;
|
||||
-- )
|
||||
echo \$words | grep -q 'exec' && ((DELIMIT_COUNT+=1))
|
||||
[[ \$DELIMIT_COUNT -eq 0 ]] && ((DELIMIT_COUNT+=1)) && continue
|
||||
;;
|
||||
@ -38,7 +37,7 @@ do
|
||||
|
||||
echo \"\$words\" | grep -q '\\s\\+$' && PASSTHROUGH_WORDS+=(' ')
|
||||
|
||||
words=\"\${PASSTHROUGH_WORDS[@]}\"
|
||||
words=\"\$PASSTHROUGH_WORDS\"
|
||||
_$CLI
|
||||
}
|
||||
"
|
@ -1,18 +1,19 @@
|
||||
[[ $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 $@; }
|
||||
h() { _SCWRYPTS_KUBECTL_DRIVER helm $@; }
|
||||
f() { _SCWRYPTS_KUBECTL_DRIVER flux $@; }
|
||||
|
||||
|
||||
_SCWRYPTS_KUBECTL_DRIVER() {
|
||||
[ ! $SCWRYPTS_ENV ] && {
|
||||
echo.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)'"
|
||||
return 1
|
||||
}
|
||||
|
||||
which kube.redis >/dev/null 2>&1 \
|
||||
|| eval "$(scwrypts -n --name meta/get-static-redis-definition --type zsh --group kube)"
|
||||
which REDIS >/dev/null 2>&1 \
|
||||
|| eval "$(scwrypts -n --name meta/get-static-redis-definition --type zsh --group kubectl)"
|
||||
|
||||
local CLI="$1"; shift 1
|
||||
|
||||
@ -42,11 +43,11 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
||||
|
||||
local USAGE__args="$(
|
||||
{
|
||||
echo "$(utils.colors.print green '[0-9]')^if the first argument is a number 0-9, uses or creates a subsession (default 0)"
|
||||
echo "\\033[0;32m[0-9]\\033[0m^if the first argument is a number 0-9, uses or creates a subsession (default 0)"
|
||||
echo " ^ "
|
||||
for C in ${CUSTOM_COMMANDS[@]}
|
||||
do
|
||||
echo "$(utils.colors.print green ${C})^$(SCWRYPTS_KUBECTL_CUSTOM_COMMAND_DESCRIPTION__$C 2>/dev/null)"
|
||||
echo "\\033[0;32m$C\\033[0m^$(SCWRYPTS_KUBECTL_CUSTOM_COMMAND_DESCRIPTION__$C 2>/dev/null)"
|
||||
done
|
||||
} | column -ts '^'
|
||||
)"
|
||||
@ -67,7 +68,7 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
||||
enriched, use-case-sensitive setup of kubernetes context.
|
||||
|
||||
All actions are scoped to the current SCWRYPTS_ENV
|
||||
currently : $(utils.colors.print yellow ${SCWRYPTS_ENV})
|
||||
currently : \\033[0;33m$SCWRYPTS_ENV\\033[0m
|
||||
|
||||
"
|
||||
|
||||
@ -134,9 +135,9 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
||||
while [[ $# -gt 0 ]]; do USER_ARGS+=($1); shift 1; done
|
||||
|
||||
|
||||
utils.check-errors || return 1
|
||||
CHECK_ERRORS --no-fail || return 1
|
||||
|
||||
[[ $HELP -eq 1 ]] && { utils.io.usage; return 0; }
|
||||
[[ $HELP -eq 1 ]] && { USAGE; return 0; }
|
||||
|
||||
#####################################################################
|
||||
|
||||
@ -154,12 +155,12 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
||||
[ $CONTEXT ] && [[ $CLI =~ ^flux$ ]] && CLI_ARGS+=(--context $CONTEXT)
|
||||
|
||||
[[ $STRICT -eq 1 ]] && {
|
||||
[ $CONTEXT ] || echo.error "missing kubectl 'context'"
|
||||
[ $NAMESPACE ] || echo.error "missing kubectl 'namespace'"
|
||||
[ $CONTEXT ] || ERROR "missing kubectl 'context'"
|
||||
[ $NAMESPACE ] || ERROR "missing kubectl 'namespace'"
|
||||
|
||||
utils.check-errors --no-fail --no-usage || {
|
||||
echo.error "with 'strict' settings enabled, context and namespace must be set!"
|
||||
echo.reminder "
|
||||
CHECK_ERRORS --no-fail --no-usage || {
|
||||
ERROR "with 'strict' settings enabled, context and namespace must be set!"
|
||||
REMINDER "
|
||||
these values can be set directly with
|
||||
$(echo $CLI | head -c1) meta set (namespace|context)
|
||||
"
|
||||
@ -170,16 +171,16 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
||||
|
||||
[ $NAMESPACE ] && CLI_ARGS+=(--namespace $NAMESPACE)
|
||||
[[ $VERBOSE -eq 1 ]] && {
|
||||
echo.reminder "
|
||||
INFO "
|
||||
context '$CONTEXT'
|
||||
namespace '$NAMESPACE'
|
||||
environment '$SCWRYPTS_ENV'
|
||||
subsession '$SUBSESSION'
|
||||
"
|
||||
echo.status "running $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||
STATUS "running $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||
} || {
|
||||
[[ $(_SCWRYPTS_KUBECTL_SETTINGS get context) =~ ^show$ ]] && {
|
||||
echo.reminder "$SCWRYPTS_ENV.$SUBSESSION : $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||
INFO "$SCWRYPTS_ENV.$SUBSESSION : $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||
}
|
||||
}
|
||||
$CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}
|
||||
@ -190,7 +191,7 @@ _SCWRYPTS_KUBECTL_DRIVER() {
|
||||
|
||||
_SCWRYPTS_KUBECTL_SETTINGS() {
|
||||
# (get setting-name) or (set setting-name setting-value)
|
||||
kube.redis h$1 ${SCWRYPTS_ENV}:kubectl:settings ${@:2} | grep .
|
||||
REDIS h$1 ${SCWRYPTS_ENV}:kubectl:settings ${@:2} | grep .
|
||||
}
|
||||
|
||||
#####################################################################
|
@ -23,16 +23,16 @@ SCWRYPTS_KUBECTL_CUSTOM_COMMAND_PARSE__meta() {
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
( -h | --help ) HELP=1 ;;
|
||||
-h | --help ) HELP=1 ;;
|
||||
|
||||
( set )
|
||||
set )
|
||||
USAGE__usage+=" set"
|
||||
USAGE__args="set (namespace|context)"
|
||||
USAGE__description="interactively set a namespace or context for '$SCWRYPTS_ENV'"
|
||||
case $2 in
|
||||
( namespace | context ) USER_ARGS+=($1 $2 $3); [ $3 ] && shift 1 ;;
|
||||
( -h | --help ) HELP=1 ;;
|
||||
( '' )
|
||||
namespace | context ) USER_ARGS+=($1 $2 $3); [ $3 ] && shift 1 ;;
|
||||
-h | --help ) HELP=1 ;;
|
||||
'' )
|
||||
: \
|
||||
&& SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta set context \
|
||||
&& SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta set namespace \
|
||||
@ -40,40 +40,40 @@ SCWRYPTS_KUBECTL_CUSTOM_COMMAND_PARSE__meta() {
|
||||
return $?
|
||||
;;
|
||||
|
||||
( * ) echo.error "cannot set '$2'" ;;
|
||||
* ) ERROR "cannot set '$2'" ;;
|
||||
esac
|
||||
shift 1
|
||||
;;
|
||||
|
||||
( get )
|
||||
get )
|
||||
USAGE__usage+=" get"
|
||||
USAGE__args="get (namespace|context|all)"
|
||||
USAGE__description="output the current namespace or context for '$SCWRYPTS_ENV'"
|
||||
case $2 in
|
||||
( namespace | context | all ) USER_ARGS+=($1 $2) ;;
|
||||
namespace | context | all ) USER_ARGS+=($1 $2) ;;
|
||||
|
||||
( -h | --help ) HELP=1 ;;
|
||||
-h | --help ) HELP=1 ;;
|
||||
|
||||
( * ) echo.error "cannot get '$2'" ;;
|
||||
* ) ERROR "cannot get '$2'" ;;
|
||||
esac
|
||||
shift 1
|
||||
;;
|
||||
|
||||
( copy )
|
||||
copy )
|
||||
USAGE__usage+=" copy"
|
||||
USAGE__args+="copy [0-9]"
|
||||
USAGE__description="copy current subsession ($SUBSESSION) to target subsession id"
|
||||
case $2 in
|
||||
( [0-9] ) USER_ARGS+=($1 $2) ;;
|
||||
( -h | --help ) HELP=1 ;;
|
||||
( * ) echo.error "target session must be a number [0-9]" ;;
|
||||
[0-9] ) USER_ARGS+=($1 $2) ;;
|
||||
-h | --help ) HELP=1 ;;
|
||||
* ) ERROR "target session must be a number [0-9]" ;;
|
||||
esac
|
||||
shift 1
|
||||
;;
|
||||
|
||||
( clear | show | hide | strict | loose ) USER_ARGS+=($1) ;;
|
||||
clear | show | hide | strict | loose ) USER_ARGS+=($1) ;;
|
||||
|
||||
( * ) echo.error "no meta command '$1'"
|
||||
* ) ERROR "no meta command '$1'"
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
@ -81,10 +81,10 @@ SCWRYPTS_KUBECTL_CUSTOM_COMMAND_PARSE__meta() {
|
||||
|
||||
SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta() {
|
||||
case $1 in
|
||||
( get )
|
||||
get )
|
||||
[[ $2 =~ ^all$ ]] && {
|
||||
local CONTEXT=$(kube.redis get --prefix current:context | grep . || utils.colors.print bright-red "none set")
|
||||
local NAMESPACE=$(kube.redis get --prefix current:namespace | grep . || utils.colors.print bright-red "none set")
|
||||
local CONTEXT=$(REDIS get --prefix current:context | grep . || echo "\\033[1;31mnone set\\033[0m")
|
||||
local NAMESPACE=$(REDIS get --prefix current:namespace | grep . || echo "\\033[1;31mnone set\\033[0m")
|
||||
echo "
|
||||
environment : $SCWRYPTS_ENV
|
||||
context : $CONTEXT
|
||||
@ -92,53 +92,51 @@ SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta() {
|
||||
|
||||
CLI settings
|
||||
command context : $(_SCWRYPTS_KUBECTL_SETTINGS get context)
|
||||
strict mode : $([[ $STRICT -eq 1 ]] && utils.colors.print green on || utils.colors.print bright-red off)
|
||||
strict mode : $([[ $STRICT -eq 1 ]] && echo "on" || echo "\\033[1;31moff\\033[0m")
|
||||
" | sed 's/^ \+//' >&2
|
||||
return 0
|
||||
}
|
||||
|
||||
kube.redis get --prefix current:$2
|
||||
REDIS get --prefix current:$2
|
||||
;;
|
||||
|
||||
( set )
|
||||
set )
|
||||
scwrypts -n --name set-$2 --type zsh --group kubectl -- $3 --subsession $SUBSESSION >/dev/null \
|
||||
&& SUCCESS "$2 set"
|
||||
;;
|
||||
|
||||
copy )
|
||||
: \
|
||||
&& scwrypts -n --name set-$2 --type zsh --group kube -- $3 --subsession $SUBSESSION >/dev/null \
|
||||
&& k $SUBSESSION meta get $2 \
|
||||
&& STATUS "copying $1 to $2" \
|
||||
&& scwrypts -n --name set-context --type zsh --group kubectl -- --subsession $2 $(k meta get context | grep . || echo 'reset') \
|
||||
&& scwrypts -n --name set-namespace --type zsh --group kubectl -- --subsession $2 $(k meta get namespace | grep . || echo 'reset') \
|
||||
&& SUCCESS "subsession $1 copied to $2" \
|
||||
;
|
||||
;;
|
||||
|
||||
( copy )
|
||||
: \
|
||||
&& echo.status "copying $1 to $2" \
|
||||
&& scwrypts -n --name set-context --type zsh --group kube -- --subsession $2 $(k $1 meta get context | grep . || echo 'reset') \
|
||||
&& scwrypts -n --name set-namespace --type zsh --group kube -- --subsession $2 $(k $1 meta get namespace | grep . || echo 'reset') \
|
||||
&& echo.success "subsession $1 copied to $2" \
|
||||
;
|
||||
clear )
|
||||
scwrypts -n --name set-context --type zsh --group kubectl -- --subsession $SUBSESSION reset >/dev/null \
|
||||
&& SUCCESS "subsession $SUBSESSION reset to default"
|
||||
;;
|
||||
|
||||
( clear )
|
||||
scwrypts -n --name set-context --type zsh --group kube -- --subsession $SUBSESSION reset >/dev/null \
|
||||
&& echo.success "subsession $SUBSESSION reset to default"
|
||||
;;
|
||||
|
||||
( show )
|
||||
show )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set context show >/dev/null \
|
||||
&& echo.success "now showing full command context"
|
||||
&& SUCCESS "now showing full command context"
|
||||
;;
|
||||
|
||||
( hide )
|
||||
hide )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set context hide >/dev/null \
|
||||
&& echo.success "now hiding command context"
|
||||
&& SUCCESS "now hiding command context"
|
||||
;;
|
||||
|
||||
( loose )
|
||||
loose )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set strict 0 >/dev/null \
|
||||
&& echo.warning "now running in 'loose' mode"
|
||||
&& WARNING "now running in 'loose' mode"
|
||||
;;
|
||||
|
||||
( strict )
|
||||
strict )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set strict 1 >/dev/null \
|
||||
&& echo.success "now running in 'strict' mode"
|
||||
&& SUCCESS "now running in 'strict' mode"
|
||||
;;
|
||||
esac
|
||||
}
|
@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#!/bin/zsh
|
||||
use kubectl --group kubectl
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
kube.kubectl.context.get
|
||||
KUBECTL__GET_CONTEXT
|
||||
}
|
@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#!/bin/zsh
|
||||
use kubectl --group kubectl
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
kube.kubectl.namespace.get
|
||||
KUBECTL__GET_NAMESPACE
|
||||
}
|
11
plugins/kubectl/kubectl.scwrypts.zsh
Normal file
11
plugins/kubectl/kubectl.scwrypts.zsh
Normal file
@ -0,0 +1,11 @@
|
||||
SCWRYPTS_GROUPS+=(kubectl)
|
||||
|
||||
export SCWRYPTS_TYPE__kubectl=zsh
|
||||
export SCWRYPTS_ROOT__kubectl="$SCWRYPTS_ROOT__scwrypts/plugins/kubectl"
|
||||
export SCWRYPTS_COLOR__kubectl='\033[0;31m'
|
||||
|
||||
SCWRYPTS_STATIC_CONFIG__kubectl+=(
|
||||
"$SCWRYPTS_ROOT__kubectl/.config/static/redis.zsh"
|
||||
)
|
||||
|
||||
source "$SCWRYPTS_ROOT__kubectl/driver/kubectl.driver.zsh"
|
158
plugins/kubectl/lib/kubectl.module.zsh
Normal file
158
plugins/kubectl/lib/kubectl.module.zsh
Normal file
@ -0,0 +1,158 @@
|
||||
#####################################################################
|
||||
|
||||
DEPENDENCIES+=(
|
||||
kubectl
|
||||
)
|
||||
|
||||
REQUIRED_ENV+=()
|
||||
|
||||
use redis --group kubectl
|
||||
|
||||
#####################################################################
|
||||
|
||||
KUBECTL() {
|
||||
local NAMESPACE=$(REDIS get --prefix "current:namespace")
|
||||
local CONTEXT=$(KUBECTL__GET_CONTEXT)
|
||||
|
||||
local KUBECTL_ARGS=()
|
||||
[ $NAMESPACE ] && KUBECTL_ARGS+=(--namespace $NAMESPACE)
|
||||
[ $CONTEXT ] && KUBECTL_ARGS+=(--context $CONTEXT)
|
||||
|
||||
kubectl ${KUBECTL_ARGS[@]} $@
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
|
||||
KUBECTL__GET_CONTEXT() { REDIS get --prefix "current:context"; }
|
||||
|
||||
KUBECTL__SET_CONTEXT() {
|
||||
local CONTEXT=$1
|
||||
[ ! $CONTEXT ] && return 1
|
||||
|
||||
[[ $CONTEXT =~ reset ]] && {
|
||||
: \
|
||||
&& REDIS del --prefix "current:context" \
|
||||
&& KUBECTL__SET_NAMESPACE reset \
|
||||
;
|
||||
return $?
|
||||
}
|
||||
|
||||
: \
|
||||
&& REDIS set --prefix "current:context" "$CONTEXT" \
|
||||
&& KUBECTL__SET_NAMESPACE reset \
|
||||
;
|
||||
}
|
||||
|
||||
KUBECTL__SELECT_CONTEXT() {
|
||||
KUBECTL__LIST_CONTEXTS | FZF 'select a context'
|
||||
}
|
||||
|
||||
KUBECTL__LIST_CONTEXTS() {
|
||||
echo reset
|
||||
local ALL_CONTEXTS=$(KUBECTL config get-contexts -o name | sort)
|
||||
|
||||
echo $ALL_CONTEXTS | grep -v '^arn:aws:eks'
|
||||
|
||||
[[ $AWS_ACCOUNT ]] && {
|
||||
echo $ALL_CONTEXTS | grep "^arn:aws:eks:.*:$AWS_ACCOUNT"
|
||||
true
|
||||
} || {
|
||||
echo $ALL_CONTEXTS | grep '^arn:aws:eks'
|
||||
}
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
|
||||
KUBECTL__GET_NAMESPACE() { REDIS get --prefix "current:namespace"; }
|
||||
|
||||
KUBECTL__SET_NAMESPACE() {
|
||||
local NAMESPACE=$1
|
||||
[ ! $NAMESPACE ] && return 1
|
||||
|
||||
[[ $NAMESPACE =~ reset ]] && {
|
||||
REDIS del --prefix "current:namespace"
|
||||
return $?
|
||||
}
|
||||
|
||||
REDIS set --prefix "current:namespace" "$NAMESPACE"
|
||||
}
|
||||
|
||||
KUBECTL__SELECT_NAMESPACE() {
|
||||
KUBECTL__LIST_NAMESPACES | FZF 'select a namespace'
|
||||
}
|
||||
|
||||
KUBECTL__LIST_NAMESPACES() {
|
||||
echo reset
|
||||
echo default
|
||||
KUBECTL get namespaces -o name | sed 's/^namespace\///' | sort
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
|
||||
KUBECTL__SERVE() {
|
||||
[ $CONTEXT ] || local CONTEXT=$(KUBECTL__GET_CONTEXT)
|
||||
[ $CONTEXT ] || ERROR 'must configure a context in which to serve'
|
||||
|
||||
[ $NAMESPACE ] || local NAMESPACE=$(KUBECTL__GET_NAMESPACE)
|
||||
[ $NAMESPACE ] || ERROR 'must configure a namespace in which to serve'
|
||||
|
||||
CHECK_ERRORS --no-fail --no-usage || return 1
|
||||
|
||||
[ $SERVICE ] && SERVICE=$(KUBECTL__LIST_SERVICES | jq -c "select (.service == \"$SERVICE\")" || echo $SERVICE)
|
||||
[ $SERVICE ] || local SERVICE=$(KUBECTL__SELECT_SERVICE)
|
||||
[ $SERVICE ] || ERROR 'must provide or select a service'
|
||||
|
||||
KUBECTL__LIST_SERVICES | grep -q "^$SERVICE$"\
|
||||
|| ERROR "no service '$SERVICE' in '$CONFIG/$NAMESPACE'"
|
||||
|
||||
CHECK_ERRORS --no-fail --no-usage || return 1
|
||||
|
||||
##########################################
|
||||
|
||||
SERVICE_PASSWORD="$(KUBECTL__GET_SERVICE_PASSWORD)"
|
||||
KUBECTL__SERVICE_PARSE
|
||||
|
||||
INFO "attempting to serve ${NAMESPACE}/${SERVICE_NAME}:${SERVICE_PORT}"
|
||||
[ $SERVICE_PASSWORD ] && INFO "password : $SERVICE_PASSWORD"
|
||||
|
||||
KUBECTL port-forward service/$SERVICE_NAME $SERVICE_PORT
|
||||
}
|
||||
|
||||
KUBECTL__SELECT_SERVICE() {
|
||||
[ $NAMESPACE ] || local NAMESPACE=$(KUBECTL__GET_NAMESPACE)
|
||||
[ $NAMESPACE ] || return 1
|
||||
|
||||
local SERVICES=$(KUBECTL__LIST_SERVICES)
|
||||
local SELECTED=$({
|
||||
echo "namespace service port"
|
||||
echo $SERVICES \
|
||||
| jq -r '.service + " " + .port' \
|
||||
| sed "s/^/$NAMESPACE /" \
|
||||
;
|
||||
} \
|
||||
| column -t \
|
||||
| FZF 'select a service' --header-lines=1 \
|
||||
| awk '{print $2;}' \
|
||||
)
|
||||
|
||||
echo $SERVICES | jq -c "select (.service == \"$SELECTED\")"
|
||||
}
|
||||
|
||||
KUBECTL__LIST_SERVICES() {
|
||||
KUBECTL get service --no-headers\
|
||||
| awk '{print "{\"service\":\""$1"\",\"ip\":\""$3"\",\"port\":\""$5"\"}"}' \
|
||||
| jq -c 'select (.ip != "None")' \
|
||||
;
|
||||
}
|
||||
|
||||
KUBECTL__GET_SERVICE_PASSWORD() {
|
||||
[ $PASSWORD_SECRET ] && [ $PASSWORD_KEY ] || return 0
|
||||
|
||||
KUBECTL get secret $PASSWORD_SECRET -o jsonpath="{.data.$PASSWORD_KEY}" \
|
||||
| base64 --decode
|
||||
}
|
||||
|
||||
KUBECTL__SERVICE_PARSE() {
|
||||
SERVICE_NAME=$(echo $SERVICE | jq -r .service)
|
||||
SERVICE_PORT=$(echo $SERVICE | jq -r .port | sed 's|/.*$||')
|
||||
}
|
@ -5,13 +5,16 @@ DEPENDENCIES+=(
|
||||
docker
|
||||
)
|
||||
|
||||
REQUIRED_ENV+=()
|
||||
# TODO; allow custom redis configuration
|
||||
export SCWRYPTS_KUBECTL_REDIS=managed
|
||||
|
||||
utils.environment.check SCWRYPTS_KUBECTL_REDIS --default managed
|
||||
REQUIRED_ENV+=(
|
||||
SCWRYPTS_KUBECTL_REDIS
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
|
||||
kube.redis() {
|
||||
REDIS() {
|
||||
[ ! $USAGE ] && local USAGE="
|
||||
usage: [...options...]
|
||||
|
||||
@ -21,7 +24,7 @@ kube.redis() {
|
||||
-p, --prefix apply dynamic prefix to the next command line argument
|
||||
|
||||
--get-prefix output key prefix for current session+subsession
|
||||
--get-static-definition output the static ZSH function definition for kube.redis
|
||||
--get-static-definition output the static ZSH function definition for REDIS
|
||||
|
||||
additional arguments and options are passed through to 'redis-cli'
|
||||
"
|
||||
@ -36,14 +39,14 @@ kube.redis() {
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
( -p | --prefix ) USER_ARGS+=("${REDIS_PREFIX}${SCWRYPTS_ENV}:${SUBSESSION}:$2"); shift 1 ;;
|
||||
-p | --prefix ) USER_ARGS+=("${REDIS_PREFIX}${SCWRYPTS_ENV}:${SUBSESSION}:$2"); shift 1 ;;
|
||||
|
||||
( --subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
( --get-prefix ) echo $REDIS_PREFIX; return 0 ;;
|
||||
( --get-static-definition ) ECHO_STATIC_DEFINITION=1 ;;
|
||||
--get-prefix ) echo $REDIS_PREFIX; return 0 ;;
|
||||
--get-static-definition ) ECHO_STATIC_DEFINITION=1 ;;
|
||||
|
||||
( * ) USER_ARGS+=($1) ;;
|
||||
* ) USER_ARGS+=($1) ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
@ -59,14 +62,14 @@ kube.redis() {
|
||||
REDIS_ARGS+=(--raw)
|
||||
|
||||
[[ $ECHO_STATIC_DEFINITION -eq 1 ]] && {
|
||||
echo "kube.redis() {\
|
||||
echo "REDIS() {\
|
||||
local USER_ARGS=(); \
|
||||
[ ! \$SUBSESSION ] && local SUBSESSION=0 ;\
|
||||
while [[ \$# -gt 0 ]]; \
|
||||
do \
|
||||
case \$1 in
|
||||
( -p | --prefix ) USER_ARGS+=(\"${REDIS_PREFIX}\${SCWRYPTS_ENV}:\${SUBSESSION}:\$2\"); shift 1 ;; \
|
||||
( * ) USER_ARGS+=(\$1) ;; \
|
||||
-p | --prefix ) USER_ARGS+=(\"${REDIS_PREFIX}\${SCWRYPTS_ENV}:\${SUBSESSION}:\$2\"); shift 1 ;; \
|
||||
* ) USER_ARGS+=(\$1) ;; \
|
||||
esac; \
|
||||
shift 1; \
|
||||
done; \
|
||||
@ -78,9 +81,9 @@ kube.redis() {
|
||||
redis-cli ${REDIS_ARGS[@]} ${USER_ARGS[@]}
|
||||
}
|
||||
|
||||
kube.redis ping 2>/dev/null | grep -qi pong || {
|
||||
REDIS ping | grep -qi pong || {
|
||||
RPID=$(docker ps -a | grep scwrypts-kubectl-redis | awk '{print $1;}')
|
||||
[ $RPID ] && echo.status 'refreshing redis instance' && docker rm -f $RPID
|
||||
[ $RPID ] && STATUS 'refreshing redis instance' && docker rm -f $RPID
|
||||
unset RPID
|
||||
|
||||
docker run \
|
||||
@ -89,6 +92,6 @@ kube.redis ping 2>/dev/null | grep -qi pong || {
|
||||
--publish $SCWRYPTS_KUBECTL_REDIS_PORT__managed:6379 \
|
||||
redis >/dev/null 2>&1
|
||||
|
||||
echo.status 'awaiting redis connection'
|
||||
until kube.redis ping 2>/dev/null | grep -qi pong; do sleep 0.5; done
|
||||
STATUS 'awaiting redis connection'
|
||||
until REDIS ping 2>/dev/null | grep -qi pong; do sleep 0.5; done
|
||||
}
|
7
plugins/kubectl/meta/get-static-redis-definition
Executable file
7
plugins/kubectl/meta/get-static-redis-definition
Executable file
@ -0,0 +1,7 @@
|
||||
#!/bin/zsh
|
||||
use redis --group kubectl
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
echo $(REDIS --get-static-definition)
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#!/bin/zsh
|
||||
use kubectl --group kubectl
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
@ -12,7 +12,7 @@ MAIN() {
|
||||
options:
|
||||
--context override context
|
||||
--namespace override namespace
|
||||
--subsession kube.redis subsession (default 0)
|
||||
--subsession REDIS subsession (default 0)
|
||||
|
||||
to show a required password on screen, use both:
|
||||
--password-secret Secret resource
|
||||
@ -33,17 +33,17 @@ MAIN() {
|
||||
--password-secret ) PASSWORD_SECRET=$2; shift 1 ;;
|
||||
--password-key ) PASSWORD_KEY=$2; shift 1 ;;
|
||||
|
||||
-h | --help ) utils.io.usage; return 0 ;;
|
||||
-h | --help ) USAGE; return 0 ;;
|
||||
|
||||
* )
|
||||
[ $SERVICE ] && echo.error "unexpected argument '$2'"
|
||||
[ $SERVICE ] && ERROR "unexpected argument '$2'"
|
||||
SERVICE=$1
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
utils.check-errors --fail
|
||||
CHECK_ERRORS
|
||||
|
||||
kube.kubectl.serve
|
||||
KUBECTL__SERVE
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#!/bin/zsh
|
||||
use kubectl --group kubectl
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
@ -10,7 +10,7 @@ MAIN() {
|
||||
context (optional) the full name of the kubeconfig context to set
|
||||
|
||||
options:
|
||||
--subsession kube.redis subsession (default 0)
|
||||
--subsession REDIS subsession (default 0)
|
||||
|
||||
-h, --help show this dialogue and exit
|
||||
"
|
||||
@ -22,18 +22,20 @@ MAIN() {
|
||||
case $1 in
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
-h | --help ) USAGE; return 0 ;;
|
||||
|
||||
* )
|
||||
[ $CONTEXT ] && echo.error "unexpected argument '$2'"
|
||||
[ $CONTEXT ] && ERROR "unexpected argument '$2'"
|
||||
CONTEXT=$1
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
[ $CONTEXT ] || CONTEXT=$(kube.kubectl.context.select)
|
||||
[ $CONTEXT ] || echo.error 'must provide or select a valid kube context'
|
||||
[ $CONTEXT ] || CONTEXT=$(KUBECTL__SELECT_CONTEXT)
|
||||
[ $CONTEXT ] || ERROR 'must provide or select a valid kube context'
|
||||
|
||||
utils.check-errors --fail
|
||||
CHECK_ERRORS
|
||||
|
||||
kube.kubectl.context.set $CONTEXT
|
||||
KUBECTL__SET_CONTEXT $CONTEXT
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#!/bin/zsh
|
||||
use kubectl --group kubectl
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
@ -10,7 +10,7 @@ MAIN() {
|
||||
namespace (optional) the full name of the namespace context to set
|
||||
|
||||
options:
|
||||
--subsession kube.redis subsession (default 0)
|
||||
--subsession REDIS subsession (default 0)
|
||||
|
||||
-h, --help show this dialogue and exit
|
||||
"
|
||||
@ -22,20 +22,20 @@ MAIN() {
|
||||
case $1 in
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
-h | --help ) utils.io.usage; return 0 ;;
|
||||
-h | --help ) USAGE; return 0 ;;
|
||||
|
||||
* )
|
||||
[ $NAMESPACE ] && echo.error "unexpected argument '$2'"
|
||||
[ $NAMESPACE ] && ERROR "unexpected argument '$2'"
|
||||
NAMESPACE=$1
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
[ $NAMESPACE ] || NAMESPACE=$(kube.kubectl.namespace.select)
|
||||
[ $NAMESPACE ] || echo.error 'must provide or select a valid namespace'
|
||||
[ $NAMESPACE ] || NAMESPACE=$(KUBECTL__SELECT_NAMESPACE)
|
||||
[ $NAMESPACE ] || ERROR 'must provide or select a valid namespace'
|
||||
|
||||
utils.check-errors --fail
|
||||
CHECK_ERRORS
|
||||
|
||||
kube.kubectl.namespace.set $NAMESPACE
|
||||
KUBECTL__SET_NAMESPACE $NAMESPACE
|
||||
}
|
@ -1,11 +1,13 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.data.converter import convert
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
from scwrypts.data import convert
|
||||
|
||||
|
||||
description = 'convert csv into json'
|
||||
parse_args = []
|
||||
|
||||
def main(_args, stream):
|
||||
return convert(
|
||||
@ -16,5 +18,7 @@ def main(_args, stream):
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'convert csv into json',
|
||||
parse_args = [],
|
||||
)
|
||||
|
@ -1,11 +1,13 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.data.converter import convert
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
from scwrypts.data import convert
|
||||
|
||||
|
||||
description = 'convert csv into yaml'
|
||||
parse_args = []
|
||||
|
||||
def main(_args, stream):
|
||||
return convert(
|
||||
@ -16,5 +18,7 @@ def main(_args, stream):
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'convert csv into yaml',
|
||||
parse_args = [],
|
||||
)
|
||||
|
@ -1,11 +1,13 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.data.converter import convert
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
from scwrypts.data import convert
|
||||
|
||||
|
||||
description = 'convert json into csv'
|
||||
parse_args = []
|
||||
|
||||
def main(_args, stream):
|
||||
return convert(
|
||||
@ -16,5 +18,7 @@ def main(_args, stream):
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'convert json into csv',
|
||||
parse_args = [],
|
||||
)
|
||||
|
@ -1,11 +1,13 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.data.converter import convert
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
from scwrypts.data import convert
|
||||
|
||||
|
||||
description = 'convert json into yaml'
|
||||
parse_args = []
|
||||
|
||||
def main(_args, stream):
|
||||
return convert(
|
||||
@ -16,5 +18,7 @@ def main(_args, stream):
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'convert json into yaml',
|
||||
parse_args = [],
|
||||
)
|
||||
|
@ -1,11 +1,13 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.data.converter import convert
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
from scwrypts.data import convert
|
||||
|
||||
|
||||
description = 'convert yaml into csv'
|
||||
parse_args = []
|
||||
|
||||
def main(_args, stream):
|
||||
return convert(
|
||||
@ -16,5 +18,7 @@ def main(_args, stream):
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'convert yaml into csv',
|
||||
parse_args = [],
|
||||
)
|
||||
|
@ -1,11 +1,13 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.data.converter import convert
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
from scwrypts.data import convert
|
||||
|
||||
|
||||
description = 'convert yaml into json'
|
||||
parse_args = []
|
||||
|
||||
def main(_args, stream):
|
||||
return convert(
|
||||
@ -16,5 +18,7 @@ def main(_args, stream):
|
||||
)
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'convert yaml into json',
|
||||
parse_args = [],
|
||||
)
|
||||
|
@ -1,55 +1,16 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
#####################################################################
|
||||
from json import dumps
|
||||
|
||||
from scwrypts.fzf import fzf, fzf_tail
|
||||
from scwrypts.http import directus
|
||||
from py.lib.fzf import fzf, fzf_tail
|
||||
from py.lib.http import directus
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
description = 'interactive CLI to get data from directus'
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
parse_args = [
|
||||
( ['-c', '--collection'], {
|
||||
"dest" : 'collection',
|
||||
"default" : None,
|
||||
"help" : 'the name of the collection',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['-f', '--filters'], {
|
||||
"dest" : 'filters',
|
||||
"default" : None,
|
||||
"help" : 'as a URL-suffix, filters for the query',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['-d', '--fields'], {
|
||||
"dest" : 'fields',
|
||||
"default" : None,
|
||||
"help" : 'comma-separated list of fields to include',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['-p', '--interactive-prompt'], {
|
||||
"action" : 'store_true',
|
||||
"dest" : 'interactive',
|
||||
"default" : False,
|
||||
"help" : 'interactively generate filter prompts; implied if no flags are provided',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['--prompt-filters'], {
|
||||
"action" : 'store_true',
|
||||
"dest" : 'generate_filters_prompt',
|
||||
"default" : False,
|
||||
"help" : '(superceded by -p) only generate filters interactively',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['--prompt-fields'], {
|
||||
"action" : 'store_true',
|
||||
"dest" : 'generate_fields_prompt',
|
||||
"default" : False,
|
||||
"help" : '(superceded by -p) only generate filters interactively',
|
||||
"required" : False,
|
||||
}),
|
||||
]
|
||||
#####################################################################
|
||||
|
||||
def main(args, stream):
|
||||
if {None} == { args.collection, args.filters, args.fields }:
|
||||
@ -135,6 +96,50 @@ def _get_or_select_fields(args, collection):
|
||||
|
||||
return fields
|
||||
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
execute(main,
|
||||
description = 'interactive CLI to get data from directus',
|
||||
parse_args = [
|
||||
( ['-c', '--collection'], {
|
||||
"dest" : 'collection',
|
||||
"default" : None,
|
||||
"help" : 'the name of the collection',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['-f', '--filters'], {
|
||||
"dest" : 'filters',
|
||||
"default" : None,
|
||||
"help" : 'as a URL-suffix, filters for the query',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['-d', '--fields'], {
|
||||
"dest" : 'fields',
|
||||
"default" : None,
|
||||
"help" : 'comma-separated list of fields to include',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['-p', '--interactive-prompt'], {
|
||||
"action" : 'store_true',
|
||||
"dest" : 'interactive',
|
||||
"default" : False,
|
||||
"help" : 'interactively generate filter prompts; implied if no flags are provided',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['--prompt-filters'], {
|
||||
"action" : 'store_true',
|
||||
"dest" : 'generate_filters_prompt',
|
||||
"default" : False,
|
||||
"help" : '(superceded by -p) only generate filters interactively',
|
||||
"required" : False,
|
||||
}),
|
||||
( ['--prompt-fields'], {
|
||||
"action" : 'store_true',
|
||||
"dest" : 'generate_fields_prompt',
|
||||
"default" : False,
|
||||
"help" : '(superceded by -p) only generate filters interactively',
|
||||
"required" : False,
|
||||
}),
|
||||
]
|
||||
|
||||
)
|
||||
|
@ -1,13 +1,36 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
#####################################################################
|
||||
from json import dumps
|
||||
from sys import stderr
|
||||
|
||||
from scwrypts.http import discord
|
||||
from py.lib.http import discord
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
|
||||
def main(args, stream):
|
||||
if args.content is None:
|
||||
print(f'reading input from {stream.input.name}', file=stderr)
|
||||
args.content = ''.join(stream.readlines()).strip()
|
||||
|
||||
if len(args.content) == 0:
|
||||
args.content = 'PING'
|
||||
|
||||
response = discord.send_message(**vars(args))
|
||||
|
||||
stream.writeline(dumps({
|
||||
**(response.json() if response.text != '' else {'message': 'OK'}),
|
||||
'scwrypts_metadata': {},
|
||||
}))
|
||||
|
||||
|
||||
description = 'post a message to the indicated discord channel'
|
||||
#####################################################################
|
||||
execute(main,
|
||||
description = 'post a message to the indicated discord channel',
|
||||
parse_args = [
|
||||
( ['-b', '--body'], {
|
||||
'dest' : 'content',
|
||||
@ -35,23 +58,4 @@ parse_args = [
|
||||
'required' : False,
|
||||
}),
|
||||
]
|
||||
|
||||
def main(args, stream):
|
||||
if args.content is None:
|
||||
print(f'reading input from {stream.input.name}', file=stderr)
|
||||
args.content = ''.join(stream.readlines()).strip()
|
||||
|
||||
if len(args.content) == 0:
|
||||
args.content = 'PING'
|
||||
|
||||
response = discord.send_message(**vars(args))
|
||||
|
||||
stream.writeline(dumps({
|
||||
**(response.json() if response.text != '' else {'message': 'OK'}),
|
||||
'scwrypts_metadata': {},
|
||||
}))
|
||||
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
)
|
||||
|
@ -1,8 +1,21 @@
|
||||
#!/usr/bin/env python
|
||||
from scwrypts import execute
|
||||
from py.lib.scwrypts import execute
|
||||
|
||||
from py.lib.scwrypts.exceptions import ImportedExecutableError
|
||||
|
||||
if __name__ != '__main__':
|
||||
raise ImportedExecutableError()
|
||||
|
||||
#####################################################################
|
||||
|
||||
description = 'a simple "Hello, World!" program'
|
||||
|
||||
def main(args, stream):
|
||||
stream.writeline(args.message)
|
||||
|
||||
|
||||
#####################################################################
|
||||
execute(main,
|
||||
description = 'a simple "Hello, World!" program',
|
||||
parse_args = [
|
||||
( ['-m', '--message'], {
|
||||
'dest' : 'message',
|
||||
@ -10,12 +23,5 @@ parse_args = [
|
||||
'help' : 'message to print',
|
||||
'required' : False,
|
||||
}),
|
||||
]
|
||||
|
||||
def main(args, stream):
|
||||
stream.writeline(args.message)
|
||||
|
||||
|
||||
#####################################################################
|
||||
if __name__ == '__main__':
|
||||
execute(main, description, parse_args)
|
||||
],
|
||||
)
|
||||
|
4
py/lib/.gitignore
vendored
4
py/lib/.gitignore
vendored
@ -1,4 +0,0 @@
|
||||
dist/
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*.so
|
@ -1,3 +0,0 @@
|
||||
# Python Scwrypts
|
||||
[](https://python.org)
|
||||
<br>
|
6
py/lib/__init__.py
Normal file
6
py/lib/__init__.py
Normal file
@ -0,0 +1,6 @@
|
||||
import py.lib.data
|
||||
import py.lib.fzf
|
||||
import py.lib.http
|
||||
import py.lib.redis
|
||||
import py.lib.scwrypts
|
||||
import py.lib.twilio
|
1
py/lib/data/__init__.py
Normal file
1
py/lib/data/__init__.py
Normal file
@ -0,0 +1 @@
|
||||
import py.lib.data.converter
|
@ -4,6 +4,9 @@ import yaml
|
||||
|
||||
|
||||
def convert(input_stream, input_type, output_stream, output_type):
|
||||
if input_type == output_type:
|
||||
raise ValueError('input type and output type are the same')
|
||||
|
||||
data = convert_input(input_stream, input_type)
|
||||
write_output(output_stream, output_type, data)
|
||||
|
1
py/lib/fzf/__init__.py
Normal file
1
py/lib/fzf/__init__.py
Normal file
@ -0,0 +1 @@
|
||||
from py.lib.fzf.client import fzf, fzf_tail, fzf_head
|
5
py/lib/http/__init__.py
Normal file
5
py/lib/http/__init__.py
Normal file
@ -0,0 +1,5 @@
|
||||
from py.lib.http.client import get_request_client
|
||||
|
||||
import py.lib.http.directus
|
||||
import py.lib.http.discord
|
||||
import py.lib.http.linear
|
20
py/lib/http/client.py
Normal file
20
py/lib/http/client.py
Normal file
@ -0,0 +1,20 @@
|
||||
from requests import request
|
||||
|
||||
|
||||
def get_request_client(base_url, headers=None):
|
||||
if headers is None:
|
||||
headers = {}
|
||||
|
||||
return lambda method, endpoint, **kwargs: request(
|
||||
method = method,
|
||||
url = f'{base_url}/{endpoint}',
|
||||
headers = {
|
||||
**headers,
|
||||
**kwargs.get('headers', {}),
|
||||
},
|
||||
**{
|
||||
key: value
|
||||
for key, value in kwargs.items()
|
||||
if key != 'headers'
|
||||
},
|
||||
)
|
2
py/lib/http/directus/__init__.py
Normal file
2
py/lib/http/directus/__init__.py
Normal file
@ -0,0 +1,2 @@
|
||||
from py.lib.http.directus.client import *
|
||||
from py.lib.http.directus.constant import *
|
56
py/lib/http/directus/client.py
Normal file
56
py/lib/http/directus/client.py
Normal file
@ -0,0 +1,56 @@
|
||||
from py.lib.http import get_request_client
|
||||
from py.lib.scwrypts import getenv
|
||||
|
||||
|
||||
REQUEST = None
|
||||
COLLECTIONS = None
|
||||
FIELDS = {}
|
||||
|
||||
|
||||
def request(method, endpoint, **kwargs):
|
||||
global REQUEST # pylint: disable=global-statement
|
||||
|
||||
if REQUEST is None:
|
||||
REQUEST = get_request_client(
|
||||
base_url = getenv("DIRECTUS__BASE_URL"),
|
||||
headers = {
|
||||
'Authorization': f'bearer {getenv("DIRECTUS__API_TOKEN")}',
|
||||
}
|
||||
)
|
||||
|
||||
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,23 +1,3 @@
|
||||
'''
|
||||
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 = {
|
||||
'_eq',
|
||||
'_neq',
|
2
py/lib/http/discord/__init__.py
Normal file
2
py/lib/http/discord/__init__.py
Normal file
@ -0,0 +1,2 @@
|
||||
from py.lib.http.discord.client import *
|
||||
from py.lib.http.discord.send_message import *
|
20
py/lib/http/discord/client.py
Normal file
20
py/lib/http/discord/client.py
Normal file
@ -0,0 +1,20 @@
|
||||
from py.lib.http import get_request_client
|
||||
from py.lib.scwrypts import getenv
|
||||
|
||||
REQUEST = None
|
||||
|
||||
def request(method, endpoint, **kwargs):
|
||||
global REQUEST # pylint: disable=global-statement
|
||||
|
||||
if REQUEST is None:
|
||||
headers = {}
|
||||
|
||||
if (token := getenv("DISCORD__BOT_TOKEN", required = False)) is not None:
|
||||
headers['Authorization'] = f'Bot {token}'
|
||||
|
||||
REQUEST = get_request_client(
|
||||
base_url = 'https://discord.com/api',
|
||||
headers = headers,
|
||||
)
|
||||
|
||||
return REQUEST(method, endpoint, **kwargs)
|
@ -1,5 +1,5 @@
|
||||
from scwrypts.env import getenv
|
||||
from .client import request
|
||||
from py.lib.scwrypts import getenv
|
||||
from py.lib.http.discord import request
|
||||
|
||||
def send_message(content, channel_id=None, webhook=None, username=None, avatar_url=None, **kwargs):
|
||||
if username is None:
|
1
py/lib/http/linear/__init__.py
Normal file
1
py/lib/http/linear/__init__.py
Normal file
@ -0,0 +1 @@
|
||||
from py.lib.http.linear.client import *
|
20
py/lib/http/linear/client.py
Normal file
20
py/lib/http/linear/client.py
Normal file
@ -0,0 +1,20 @@
|
||||
from py.lib.http import get_request_client
|
||||
from py.lib.scwrypts import getenv
|
||||
|
||||
REQUEST = None
|
||||
|
||||
def request(method, endpoint, **kwargs):
|
||||
global REQUEST # pylint: disable=global-statement
|
||||
|
||||
if REQUEST is None:
|
||||
REQUEST = get_request_client(
|
||||
base_url = 'https://api.linear.app',
|
||||
headers = {
|
||||
'Authorization': f'bearer {getenv("LINEAR__API_TOKEN")}',
|
||||
}
|
||||
)
|
||||
|
||||
return REQUEST(method, endpoint, **kwargs)
|
||||
|
||||
def graphql(query):
|
||||
return request('POST', 'graphql', json={'query': query})
|
@ -1,59 +0,0 @@
|
||||
[project]
|
||||
name = 'scwrypts'
|
||||
description = 'scwrypts library and invoker'
|
||||
license = 'GPL-3.0-or-later'
|
||||
|
||||
readme = 'README.md'
|
||||
requires-python = '>=3.10'
|
||||
|
||||
authors = [
|
||||
{ name='yage', email='yage@yage.io' },
|
||||
]
|
||||
|
||||
|
||||
classifiers = [
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.10',
|
||||
'Programming Language :: Python :: 3.11',
|
||||
'Programming Language :: Python :: 3.12',
|
||||
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
|
||||
]
|
||||
|
||||
dynamic = ['version']
|
||||
|
||||
dependencies = [
|
||||
'bpython',
|
||||
'pyfzf',
|
||||
'pyyaml',
|
||||
'redis',
|
||||
'twilio',
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
'pylint',
|
||||
]
|
||||
|
||||
test = [
|
||||
'pytest',
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
homepage = 'https://github.com/wrynegade/scwrypts'
|
||||
issues = 'https://github.com/wrynegade/scwrypts/issues'
|
||||
|
||||
[build-system]
|
||||
requires = [
|
||||
'hatchling',
|
||||
'versioningit',
|
||||
]
|
||||
build-backend = 'hatchling.build'
|
||||
|
||||
[tool.hatch.version]
|
||||
source = 'versioningit'
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ['./']
|
||||
|
||||
[tool.versioningit.vcs]
|
||||
match = ['v[0-9]*.[0-9]*.[0-9]*']
|
1
py/lib/redis/__init__.py
Normal file
1
py/lib/redis/__init__.py
Normal file
@ -0,0 +1 @@
|
||||
from py.lib.redis.client import get_client
|
@ -1,6 +1,6 @@
|
||||
from redis import StrictRedis
|
||||
|
||||
from scwrypts.env import getenv
|
||||
from py.lib.scwrypts import getenv
|
||||
|
||||
CLIENT = None
|
||||
|
@ -1,13 +1,6 @@
|
||||
'''
|
||||
scwrypts
|
||||
from py.lib.scwrypts.execute import execute
|
||||
from py.lib.scwrypts.getenv import getenv
|
||||
from py.lib.scwrypts.interactive import interactive
|
||||
from py.lib.scwrypts.run import run
|
||||
|
||||
python library functions and invoker for scwrypts
|
||||
'''
|
||||
|
||||
__all__ = [
|
||||
'scwrypts',
|
||||
'execute',
|
||||
'interactive',
|
||||
]
|
||||
|
||||
from .scwrypts import scwrypts, execute, interactive
|
||||
import py.lib.scwrypts.io
|
||||
|
@ -1 +0,0 @@
|
||||
from .converter import convert
|
@ -1,73 +0,0 @@
|
||||
from io import StringIO
|
||||
|
||||
from pytest import raises
|
||||
|
||||
from scwrypts.test import generate
|
||||
|
||||
from .converter import convert
|
||||
|
||||
GENERATE_OPTIONS = {
|
||||
'depth': 1,
|
||||
'minimum': -999999,
|
||||
'maximum': 999999,
|
||||
'dict_key_types': {str, int},
|
||||
'csv_columns_minimum': 10,
|
||||
'csv_columns_maximum': 64,
|
||||
'csv_rows_minimum': 10,
|
||||
'csv_rows_maximum': 64,
|
||||
}
|
||||
|
||||
INPUT_TYPES = {'csv', 'json', 'yaml'}
|
||||
OUTPUT_TYPES = {'csv', 'json', 'yaml'}
|
||||
|
||||
|
||||
def test_convert_to_csv():
|
||||
for input_type in INPUT_TYPES:
|
||||
input_stream = generate(input_type, {
|
||||
**GENERATE_OPTIONS,
|
||||
'data_types': {bool,int,float,str},
|
||||
})
|
||||
|
||||
if isinstance(input_stream, str):
|
||||
input_stream = StringIO(input_stream)
|
||||
|
||||
|
||||
convert(input_stream, input_type, StringIO(), 'csv')
|
||||
|
||||
def test_convert_to_json():
|
||||
for input_type in INPUT_TYPES:
|
||||
input_stream = generate(input_type, GENERATE_OPTIONS)
|
||||
|
||||
if isinstance(input_stream, str):
|
||||
input_stream = StringIO(input_stream)
|
||||
|
||||
convert(input_stream, input_type, StringIO(), 'json')
|
||||
|
||||
def test_convert_to_yaml():
|
||||
for input_type in INPUT_TYPES:
|
||||
input_stream = generate(input_type, GENERATE_OPTIONS)
|
||||
|
||||
if isinstance(input_stream, str):
|
||||
input_stream = StringIO(input_stream)
|
||||
|
||||
convert(input_stream, input_type, StringIO(), 'yaml')
|
||||
|
||||
|
||||
def test_convert_deep_json_to_yaml():
|
||||
input_stream = generate('json', {**GENERATE_OPTIONS, 'depth': 4})
|
||||
convert(input_stream, 'json', StringIO(), 'yaml')
|
||||
|
||||
def test_convert_deep_yaml_to_json():
|
||||
input_stream = generate('yaml', {**GENERATE_OPTIONS, 'depth': 4})
|
||||
convert(input_stream, 'yaml', StringIO(), 'json')
|
||||
|
||||
|
||||
def test_convert_output_unsupported():
|
||||
for input_type in list(INPUT_TYPES):
|
||||
with raises(ValueError):
|
||||
convert(StringIO(), input_type, StringIO(), generate(str))
|
||||
|
||||
def test_convert_input_unsupported():
|
||||
for output_type in list(OUTPUT_TYPES):
|
||||
with raises(ValueError):
|
||||
convert(StringIO(), generate(str), StringIO(), output_type)
|
@ -1,32 +0,0 @@
|
||||
from json import loads
|
||||
|
||||
from .scwrypts import scwrypts
|
||||
|
||||
from .scwrypts.exceptions import MissingVariableError
|
||||
|
||||
ENV = {}
|
||||
|
||||
def getenv(name, required=True, default=None):
|
||||
if ENV.get('configuration') is None or ENV.get('environment') is None:
|
||||
full_environment = loads(
|
||||
scwrypts(
|
||||
name = 'scwrypts/environment/getenv',
|
||||
group = 'scwrypts',
|
||||
_type = 'zsh',
|
||||
executable_args = '-n',
|
||||
args = '--all',
|
||||
).stdout
|
||||
)
|
||||
|
||||
ENV['configuration'] = full_environment['configuration']
|
||||
ENV['environment'] = full_environment['environment']
|
||||
|
||||
value = ENV.get('environment', {}).get(name, default)
|
||||
|
||||
if required and not value:
|
||||
raise MissingVariableError(name)
|
||||
|
||||
if value == '':
|
||||
value = None
|
||||
|
||||
return value
|
16
py/lib/scwrypts/exceptions.py
Normal file
16
py/lib/scwrypts/exceptions.py
Normal file
@ -0,0 +1,16 @@
|
||||
from argparse import ArgumentError
|
||||
|
||||
|
||||
class MissingVariableError(EnvironmentError):
|
||||
def init(self, name):
|
||||
super().__init__(f'Missing required environment variable "{name}"')
|
||||
|
||||
|
||||
class ImportedExecutableError(ImportError):
|
||||
def __init__(self):
|
||||
super().__init__('executable only; must run through scwrypts')
|
||||
|
||||
|
||||
class MissingFlagAndEnvironmentVariableError(EnvironmentError, ArgumentError):
|
||||
def __init__(self, flags, env_var):
|
||||
super().__init__(f'must provide at least one of : {{ flags: {flags} OR {env_var} }}')
|
@ -1,12 +1,9 @@
|
||||
from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
|
||||
|
||||
from scwrypts.io import get_combined_stream, add_io_arguments
|
||||
from py.lib.scwrypts.io import get_combined_stream, add_io_arguments
|
||||
|
||||
|
||||
def execute(main, description=None, parse_args=None, allow_input=True, allow_output=True):
|
||||
'''
|
||||
API to initiate a python-based scwrypt
|
||||
'''
|
||||
def execute(main, description=None, parse_args=None, toggle_input=True, toggle_output=True):
|
||||
if parse_args is None:
|
||||
parse_args = []
|
||||
|
||||
@ -15,7 +12,7 @@ def execute(main, description=None, parse_args=None, allow_input=True, allow_out
|
||||
formatter_class = ArgumentDefaultsHelpFormatter,
|
||||
)
|
||||
|
||||
add_io_arguments(parser, allow_input, allow_output)
|
||||
add_io_arguments(parser, toggle_input, toggle_output)
|
||||
|
||||
for a in parse_args:
|
||||
parser.add_argument(*a[0], **a[1])
|
@ -1 +0,0 @@
|
||||
from .client import fzf, fzf_tail, fzf_head
|
15
py/lib/scwrypts/getenv.py
Normal file
15
py/lib/scwrypts/getenv.py
Normal file
@ -0,0 +1,15 @@
|
||||
from os import getenv as os_getenv
|
||||
|
||||
from py.lib.scwrypts.exceptions import MissingVariableError
|
||||
|
||||
|
||||
def getenv(name, required=True):
|
||||
value = os_getenv(name, None)
|
||||
|
||||
if required and not value:
|
||||
raise MissingVariableError(name)
|
||||
|
||||
if value == '':
|
||||
value = None
|
||||
|
||||
return value
|
@ -1 +0,0 @@
|
||||
from .client import get_request_client
|
@ -1,25 +0,0 @@
|
||||
from requests import request
|
||||
|
||||
|
||||
CLIENTS = {}
|
||||
|
||||
def get_request_client(base_url, headers=None):
|
||||
if CLIENTS.get(base_url, None) is None:
|
||||
if headers is None:
|
||||
headers = {}
|
||||
|
||||
CLIENTS[base_url] = lambda method, endpoint, **kwargs: request(
|
||||
method = method,
|
||||
url = f'{base_url}/{endpoint}',
|
||||
headers = {
|
||||
**headers,
|
||||
**kwargs.get('headers', {}),
|
||||
},
|
||||
**{
|
||||
key: value
|
||||
for key, value in kwargs.items()
|
||||
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,12 +0,0 @@
|
||||
from scwrypts.env import getenv
|
||||
|
||||
from .. import get_request_client
|
||||
|
||||
|
||||
def request(method, endpoint, **kwargs):
|
||||
return get_request_client(
|
||||
base_url = getenv("DIRECTUS__BASE_URL"),
|
||||
headers = {
|
||||
'Authorization': f'bearer {getenv("DIRECTUS__API_TOKEN")}',
|
||||
}
|
||||
)(method, endpoint, **kwargs)
|
@ -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 +0,0 @@
|
||||
'''
|
||||
basic scwrypts.http client for discord
|
||||
|
||||
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 +0,0 @@
|
||||
from scwrypts.env import getenv
|
||||
|
||||
from .. import get_request_client
|
||||
|
||||
|
||||
def request(method, endpoint, **kwargs):
|
||||
headers = {}
|
||||
|
||||
if (token := getenv("DISCORD__BOT_TOKEN", required = False)) is not None:
|
||||
headers['Authorization'] = f'Bot {token}'
|
||||
|
||||
return get_request_client(
|
||||
base_url = 'https://discord.com/api',
|
||||
headers = headers,
|
||||
)(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, _mock_getenv, _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 +0,0 @@
|
||||
'''
|
||||
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
|
@ -1,12 +0,0 @@
|
||||
from scwrypts.env import getenv
|
||||
|
||||
from .. import get_request_client
|
||||
|
||||
|
||||
def request(method, endpoint, **kwargs):
|
||||
return get_request_client(
|
||||
base_url = 'https://api.linear.app',
|
||||
headers = {
|
||||
'Authorization': f'bearer {getenv("LINEAR__API_TOKEN")}',
|
||||
},
|
||||
)(method, endpoint, **kwargs)
|
@ -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,
|
||||
},
|
||||
)
|
@ -2,9 +2,6 @@ from bpython import embed
|
||||
|
||||
|
||||
def interactive(variable_descriptions):
|
||||
'''
|
||||
main() decorator to drop to interactive python environment upon completion
|
||||
'''
|
||||
def outer(function):
|
||||
|
||||
def inner(*args, **kwargs):
|
@ -2,47 +2,7 @@ from contextlib import contextmanager
|
||||
from pathlib import Path
|
||||
from sys import stdin, stdout, stderr
|
||||
|
||||
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,
|
||||
)
|
||||
|
||||
|
||||
#####################################################################
|
||||
from py.lib.scwrypts.getenv import getenv
|
||||
|
||||
|
||||
@contextmanager
|
||||
@ -74,6 +34,32 @@ def get_stream(filename=None, mode='r', encoding='utf-8', verbose=False, **kwarg
|
||||
stdout.flush()
|
||||
|
||||
|
||||
def add_io_arguments(parser, toggle_input=True, toggle_output=True):
|
||||
if toggle_input:
|
||||
parser.add_argument(
|
||||
'-i', '--input-file',
|
||||
dest = 'input_file',
|
||||
default = None,
|
||||
help = 'path to input file; omit for stdin',
|
||||
required = False,
|
||||
)
|
||||
|
||||
if toggle_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:
|
||||
def __init__(self, input_stream, output_stream):
|
||||
self.input = input_stream
|
@ -1 +0,0 @@
|
||||
from .combined_io_stream import get_combined_stream, add_io_arguments
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user