A collection of posix compliant, executable, ad-hoc utility scripts. See libsh for a collection of "stdlib" type function decs/defs.
A list of soft dependencies available during the development of any given script
- git, 2.24.3
$ git --version
git version 2.24.3 (Apple Git-128)- Bash, 5.1.8
$ bash --version
GNU bash, version 5.1.8(1)-release (x86_64-apple-darwin20.3.0)
Copyright (C) 2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.- shellcheck, 0.9.0
$ shellcheck -V
ShellCheck - shell script analysis tool
version: 0.9.0
license: GNU General Public License, version 3
website: https://www.shellcheck.net- socat, 1.7.4.3
$ socat -V
socat by Gerhard Rieger and contributors - see www.dest-unreach.org
socat version 1.7.4.3 on
running on Darwin version Darwin Kernel Version 20.3.0: Thu Jan 21 00:07:06 PST 2021; root:xnu-7195.81.3~1/RELEASE_X86_64, release 20.3.0, machine x86_64- docker, 20.10.12
$ docker version | grep -A2 -E -- 'Client|Server'
Client:
Version: 20.10.12
API version: 1.41
--
Server:
Engine:
Version: 20.10.12A list of the util scripts commited to this repo, which details usage and provides examples
- Rebases git commit log to a given sha
- Replaces author name, contact email
- Useful for dealing with the reality of contact information being frequently updated
# print usage
$ src/git-rebase-author.sh -h
usage:git-rebase-author.sh <sha> <author> <name># print latest commit log
$ git log -n1 | grep -E '^(commit|Author)'
commit 01422e4485bd71b27ddc5af36a533c5aec2ddcec (HEAD -> feature/git-rebase-author.sh)
Author: christian <[email protected]># update author
$ src/git-rebase-author.sh cc6b3edf7e7398aedfda87d5172c002bc42bc7fe~1 ssdd [email protected]
Mar 23 03:47:40 christian[17850] <Debug>: Enter :: sha=cc6b3edf7e7398aedfda87d5172c002bc42bc7fe~1 name=ssdd [email protected]
...# print latest commit log again
$ git log -n1 | grep -E '^(commit|Author)'
commit cccae4b5fc39c97bd99dfb817f2855c9f2d4e906 (HEAD -> feature/git-rebase-author.sh)
Author: ssdd <[email protected]>## src/mws.sh
- A socat-based minimal webserver,
- Returns a valid HTTP/1.0 response with an empty body
- Useful as a sanity check: an http clients' dispatch cycle and request payload
# usage
$ src/mws.sh -h
usage: mws.sh <port>
A minimal HTTP server# bind to 8080
$ src/mws.sh 8080
Mar 23 13:46:31 christian[21054] <Debug>: Enter :: port=8080
2023/03/23 13:46:31 socat[21055] N listening on LEN=16 AF=2 0.0.0.0:8080# curl from sep terminal/session/etc
$ curl -D/dev/stderr localhost:8080
HTTP/1.0 200 OK# socat logs from request
2023/03/23 13:46:31 socat[21055] N listening on LEN=16 AF=2 0.0.0.0:8080
...
> 2023/03/23 13:48:16.001524 length=73 from=0 to=72
GET / HTTP/1.1
Host: localhost:8080
User-Agent: curl/7.64.1
Accept: */*## src/posix.sh
- Passes an arbitrary shell command to an alpine posix shell
- Runs in a short-lived, self-cleaning docker container
- The container exit status is useful as a boolean for quick sanity checks of any command
# usage
$ src/posix.sh -h
usage: posix.sh <argv>
Run argv on posix-strict shell# use built-in read with flag for default value in bash
$ read -ei "default value" readvar
default value
$ echo $readvar
default value# posix standard doesn't define "-ei" flags for built-in read
$ src/posix.sh read -i "default value" readvar
Mar 23 14:01:09 christian[21141] <Debug>: Enter :: read -i default value readvar
+ cat /etc/os-release
NAME="Alpine Linux"
ID=alpine
VERSION_ID=3.17.2
PRETTY_NAME="Alpine Linux v3.17"
HOME_URL="https://alpinelinux.org/"
BUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine/aports/-/issues"
+ read -i default value readvar
_: read: line 0: illegal option -i
$ echo $?
2A set of acceptance tests built on top of bats that output tap compliant reports.
Tests are executed as part of the make workflow, but can be executed independently as well.
$ make check
...
1..8
ok 1 can print usage
ok 2 can pass a help flag
ok 3 fails to use an arbitrary flag
ok 4 can rebase a commit log's author
ok 5 can send an http request
ok 6 can receive an http response
ok 7 can run a posix compliant command
ok 8 fails to run a non posix-compliant commandTests cases are commited, as bats files, to the test directory.
A minimal overview of the development workflow.
1. Add an executable script to src and commit.
$ cat <<eof | tee src/foobar.sh
#!/bin/sh
set -eu
echo foobar
eof
$ chmod +x src/foobar.sh$ git add src/foobar.sh
$ git commit -m "Add Development Workflow Example Script"
[feature-github-actions db309ff] Add Development Workflow Example Script
Date: Mon Mar 27 19:00:31 2023 +0200
1 file changed, 4 insertions(+)
create mode 100644 src/foobar.sh2. Add a bats test case to test and commit.
$ cat <<eof | tee test/foobar.bats
> #!/usr/bin/env bats
@test "can foobar" {
foobar.sh | grep foobar
}
@test "can not barfoo" {
! ( foobar.sh | grep barfoo )
}
eof$ git commit -m "Add Development Worfklow Example Test"
[feature-github-actions 72c862f] Add Development Worfklow Example Test
1 files changed, 9 insertions(+), 0 deletions(-)
create mode 100644 test/foobar.bats3. Evaluate test cases by running make workflow.
$ make | grep foo
ok 4 can foobar
ok 5 can not barfoo4. Push changes to repository on successful make workflow
$ make push
test "feature-github-actions"
# ensure working tree is clean for push
git status --porcelain \
| xargs \
| grep -qv .
ssh-agent bash -c \
"<secrets/key.gpg gpg -d | ssh-add - \
&& git push origin feature-github-actions -f \
"
gpg: encrypted with rsa2048 key, ID BD4B2D8362388282, created 2019-05-30
"local <local@me>"
Identity added: (stdin) (ssdd)
...
* [new branch] feature-github-actions -> feature-github-actions5. Check github actions build status.
$ ( gh workflow view main.yaml ) </dev/null
main - main.yaml
ID: 52494213
Total runs 3
Recent runs
✓ Update README main feature-github-actions push 4534871010