keep the dynamism of make in pure shell
Two mechanisms, matching what the make engine actually did:
Lazy defaults. A stack setting is a function myos_default_<VAR>, called only
when the variable has no value, and called again at every reference. That is
exactly a recursive ?=: an explicit value wins, and the default follows a
DOMAIN that a .env changes later. The prefix is what makes it safe; the first
version used a bare function named after the variable, and the test suite
caught it running /usr/bin/host for a stack group called host.
Templates. myos env-update fills a .env from the .env.dist files, expanding
${VAR} against the current values and running $(command), forward references
included.
Also fixed: the project .env now wins over /etc/conf.d/myos, which is what the
documentation claimed and the code did not.
share/make/shim.mk lets a project keep make as a front end: every myos command
becomes a target that shells out to bin/myos, and the project keeps its own
targets and its stack .mk files. It sits outside make/ because the legacy
engine globs every .mk in there.
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
#shellcheck shell=sh
|
||||
Include lib/str.sh
|
||||
Include lib/core.sh
|
||||
Include lib/var.sh
|
||||
Include lib/tags.sh
|
||||
Include lib/config.sh
|
||||
Include lib/compose.sh
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#shellcheck shell=sh
|
||||
Include lib/str.sh
|
||||
Include lib/core.sh
|
||||
Include lib/var.sh
|
||||
Include lib/tags.sh
|
||||
Include lib/config.sh
|
||||
|
||||
@@ -104,3 +105,95 @@ Describe 'lib/config.sh robustness'
|
||||
The status should be success
|
||||
End
|
||||
End
|
||||
|
||||
# The make engine generated a .env out of a .env.dist, expanding ${VAR} against
|
||||
# the current values and running $(cmd). These check the shell equivalent.
|
||||
Describe 'lib/config.sh templates'
|
||||
setup() { MYOS_TMP=$(mktemp -d "${TMPDIR:-/tmp}/myos-tpl.XXXXXX"); }
|
||||
cleanup() { rm -rf "$MYOS_TMP"; }
|
||||
BeforeEach setup
|
||||
AfterEach cleanup
|
||||
|
||||
Describe 'myos_expand'
|
||||
It 'substitutes a variable'
|
||||
DOMAIN=example.org
|
||||
When call myos_expand 'https://app.${DOMAIN}/'
|
||||
The output should equal "https://app.example.org/"
|
||||
End
|
||||
It 'substitutes several, including twice the same'
|
||||
DOMAIN=example.org
|
||||
When call myos_expand '${DOMAIN}:${DOMAIN}'
|
||||
The output should equal "example.org:example.org"
|
||||
End
|
||||
It 'substitutes a lazy default like any other value'
|
||||
# shellcheck disable=SC2317
|
||||
myos_default_LAZY_DOMAIN() { printf 'lazy.example.org'; }
|
||||
When call myos_expand 'https://${LAZY_DOMAIN}/'
|
||||
The output should equal "https://lazy.example.org/"
|
||||
End
|
||||
It 'empties an unknown variable, as make does'
|
||||
When call myos_expand 'a${NOT_SET_ANYWHERE}b'
|
||||
The output should equal "ab"
|
||||
End
|
||||
It 'runs a command substitution'
|
||||
When call myos_expand 'pre-$(echo mid)-post'
|
||||
The output should equal "pre-mid-post"
|
||||
End
|
||||
It 'leaves a malformed reference alone'
|
||||
When call myos_expand 'a${not-a-name}b'
|
||||
The output should equal 'a${not-a-name}b'
|
||||
End
|
||||
End
|
||||
|
||||
Describe 'myos_env_update'
|
||||
It 'adds the missing variables, expanded'
|
||||
printf 'DOMAIN=example.org\nAPP_URL=https://app.${DOMAIN}/\n' > "$MYOS_TMP/.env.dist"
|
||||
DOMAIN=chosen.org
|
||||
When call myos_env_update "$MYOS_TMP/.env" "$MYOS_TMP/.env.dist"
|
||||
The status should be success
|
||||
The contents of file "$MYOS_TMP/.env" should include "APP_URL=https://app.chosen.org/"
|
||||
The contents of file "$MYOS_TMP/.env" should include "DOMAIN=chosen.org"
|
||||
End
|
||||
It 'never touches a value already recorded'
|
||||
printf 'KEEP=default\n' > "$MYOS_TMP/.env.dist"
|
||||
printf 'KEEP=already-chosen\n' > "$MYOS_TMP/.env"
|
||||
When call myos_env_update "$MYOS_TMP/.env" "$MYOS_TMP/.env.dist"
|
||||
The contents of file "$MYOS_TMP/.env" should equal "KEEP=already-chosen"
|
||||
End
|
||||
It 'is idempotent'
|
||||
printf 'A=1\nB=${A}2\n' > "$MYOS_TMP/.env.dist"
|
||||
When run source spec/unit/config_update_helper.sh "$MYOS_TMP"
|
||||
The output should equal "2"
|
||||
End
|
||||
It 'does nothing without a template'
|
||||
When call myos_env_update "$MYOS_TMP/.env" "$MYOS_TMP/nope.dist"
|
||||
The status should be success
|
||||
The path "$MYOS_TMP/.env" should not be exist
|
||||
End
|
||||
End
|
||||
End
|
||||
|
||||
Describe 'lib/config.sh forward references'
|
||||
setup() { MYOS_TMP=$(mktemp -d "${TMPDIR:-/tmp}/myos-fwd.XXXXXX"); }
|
||||
cleanup() { rm -rf "$MYOS_TMP"; }
|
||||
BeforeEach setup
|
||||
AfterEach cleanup
|
||||
|
||||
It 'resolves a reference to a variable defined further down the template'
|
||||
printf 'IMAGE=alpine:${VERSION}\nVERSION=3.20\n' > "$MYOS_TMP/.env.dist"
|
||||
When call myos_env_update "$MYOS_TMP/.env" "$MYOS_TMP/.env.dist"
|
||||
The contents of file "$MYOS_TMP/.env" should include "IMAGE=alpine:3.20"
|
||||
End
|
||||
It 'resolves a chain of references'
|
||||
printf 'A=${B}\nB=${C}\nC=deep\n' > "$MYOS_TMP/.env.dist"
|
||||
When call myos_env_update "$MYOS_TMP/.env" "$MYOS_TMP/.env.dist"
|
||||
The contents of file "$MYOS_TMP/.env" should include "A=deep"
|
||||
End
|
||||
It 'still lets an explicit choice win over the template'
|
||||
printf 'IMAGE=alpine:${VERSION}\nVERSION=3.20\n' > "$MYOS_TMP/.env.dist"
|
||||
VERSION=3.19
|
||||
When call myos_env_update "$MYOS_TMP/.env" "$MYOS_TMP/.env.dist"
|
||||
The contents of file "$MYOS_TMP/.env" should include "IMAGE=alpine:3.19"
|
||||
The contents of file "$MYOS_TMP/.env" should include "VERSION=3.19"
|
||||
End
|
||||
End
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
#shellcheck shell=sh
|
||||
# Running the update twice must leave the same file: print how many lines it has.
|
||||
myos_env_update "$1/.env" "$1/.env.dist" >/dev/null 2>&1
|
||||
myos_env_update "$1/.env" "$1/.env.dist" >/dev/null 2>&1
|
||||
wc -l < "$1/.env" | tr -d ' '
|
||||
@@ -1,6 +1,7 @@
|
||||
#shellcheck shell=sh
|
||||
Include lib/str.sh
|
||||
Include lib/core.sh
|
||||
Include lib/var.sh
|
||||
Include lib/tags.sh
|
||||
Include lib/naming.sh
|
||||
Include lib/config.sh
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#shellcheck shell=sh
|
||||
Include lib/str.sh
|
||||
Include lib/core.sh
|
||||
Include lib/var.sh
|
||||
Include lib/tags.sh
|
||||
Include lib/stack.sh
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#shellcheck shell=sh
|
||||
Include lib/str.sh
|
||||
Include lib/core.sh
|
||||
Include lib/var.sh
|
||||
Include lib/tags.sh
|
||||
|
||||
# The expectations below are the very examples left as comments in
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
#shellcheck shell=sh
|
||||
myos_default BUILT 'printf "built-%s" here'
|
||||
myos_var BUILT
|
||||
@@ -0,0 +1,7 @@
|
||||
#shellcheck shell=sh
|
||||
# A lazy default is re-evaluated at each reference, so it follows a value that
|
||||
# changes later; an explicit value still wins over it.
|
||||
myos_default_LAZY_ONE() { printf 'from-%s' "$(myos_var LAZY_BASE)"; }
|
||||
LAZY_BASE=first; myos_var LAZY_ONE; echo
|
||||
LAZY_BASE=second; myos_var LAZY_ONE; echo
|
||||
LAZY_ONE=pinned; myos_var LAZY_ONE; echo
|
||||
@@ -0,0 +1,3 @@
|
||||
#shellcheck shell=sh
|
||||
myos_default_LOOPY() { myos_var LOOPY; }
|
||||
myos_var LOOPY
|
||||
@@ -0,0 +1,73 @@
|
||||
#shellcheck shell=sh
|
||||
Include lib/core.sh
|
||||
Include lib/var.sh
|
||||
|
||||
Describe 'lib/var.sh'
|
||||
Describe 'myos_var'
|
||||
It 'returns the value of a plain variable'
|
||||
SOME_VAR=plain
|
||||
When call myos_var SOME_VAR
|
||||
The output should equal "plain"
|
||||
End
|
||||
It 'returns empty for an unset variable'
|
||||
When call myos_var NEVER_SET
|
||||
The output should equal ""
|
||||
End
|
||||
It 'returns empty for an empty name'
|
||||
When call myos_var ""
|
||||
The output should equal ""
|
||||
End
|
||||
It 'never runs a command that happens to share the name'
|
||||
# `host` is a real program: a lazy default must never be confused with it
|
||||
When call myos_var host
|
||||
The output should equal ""
|
||||
The status should be success
|
||||
The stderr should equal ""
|
||||
End
|
||||
End
|
||||
|
||||
Describe 'lazy defaults'
|
||||
lazy() {
|
||||
myos_default_LAZY_ONE() { printf 'from-%s' "$(myos_var LAZY_BASE)"; }
|
||||
myos_var LAZY_ONE
|
||||
}
|
||||
It 'computes the default when the variable has no value'
|
||||
LAZY_BASE=a
|
||||
When call lazy
|
||||
The output should equal "from-a"
|
||||
End
|
||||
It 'recomputes it against the current values'
|
||||
When run source spec/unit/var_lazy_helper.sh
|
||||
The line 1 should equal "from-first"
|
||||
The line 2 should equal "from-second"
|
||||
The line 3 should equal "pinned"
|
||||
End
|
||||
It 'declares a default from a string too'
|
||||
When run source spec/unit/var_default_helper.sh
|
||||
The output should equal "built-here"
|
||||
End
|
||||
It 'refuses a default written in terms of itself'
|
||||
When run source spec/unit/var_loop_helper.sh
|
||||
The stderr should include "defined in terms of itself"
|
||||
The status should equal 1
|
||||
End
|
||||
End
|
||||
|
||||
Describe 'myos_var_is_lazy'
|
||||
It 'is true for a variable that only has a default'
|
||||
myos_default_ONLY_LAZY() { echo x; }
|
||||
When call myos_var_is_lazy ONLY_LAZY
|
||||
The status should be success
|
||||
End
|
||||
It 'is false once the variable has a value'
|
||||
myos_default_BOTH() { echo x; }
|
||||
BOTH=explicit
|
||||
When call myos_var_is_lazy BOTH
|
||||
The status should be failure
|
||||
End
|
||||
It 'is false for a program on PATH'
|
||||
When call myos_var_is_lazy host
|
||||
The status should be failure
|
||||
End
|
||||
End
|
||||
End
|
||||
Reference in New Issue
Block a user