Expose target cat-env

Author: pjeby

Targets.md

@@ -167,20 +167,20 @@ doco-target::jq-name() {
 	REPLY=("${1//::::/::}")
 }
 
-__get-compose-env() {
-	CLEAR_FILTERS
-	APPLY '.services[$svc].environment // {} | to_entries' svc="$1"
+doco-target::cat-env() {
+	this is-service || fail "$TARGET_NAME is not a service" || return
+	compose-config || return; CLEAR_FILTERS
+	APPLY '.services[$svc].environment // {} | to_entries' svc="$TARGET_NAME"
 	FILTER 'map( "\(.key)=\(.value / "$$" | map (. + "$") | add | .[:-1] | @sh)\n" )'
 	FILTER '.+[""] | add | .[:-1]'
-	RUN_JQ -r -j <<<"$COMPOSED_JSON"
+	RUN_JQ -r <<<"$COMPOSED_JSON"
 }
 
 doco-target::get-env() {
-	this is-service || fail "$TARGET_NAME is not a service" || return
 	# Fetch parsed env values from docker-compose config
 	local name=${TARGET_VAR}__env; local -n vals=$name
 	if ! array-exists "$name"; then
-		compose-config && eval "vals=($(__get-compose-env "$TARGET_NAME"))" || return
+		REPLY=$(this cat-env) || return; eval "vals=($REPLY)"
 	fi
 	REPLY=("${vals[@]}")
 }

bin/doco

@@ -700,20 +700,20 @@ doco-target::jq-name() {
 	REPLY=("${1//::::/::}")
 }
 
-__get-compose-env() {
-	CLEAR_FILTERS
-	APPLY '.services[$svc].environment // {} | to_entries' svc="$1"
+doco-target::cat-env() {
+	this is-service || fail "$TARGET_NAME is not a service" || return
+	compose-config || return; CLEAR_FILTERS
+	APPLY '.services[$svc].environment // {} | to_entries' svc="$TARGET_NAME"
 	FILTER 'map( "\(.key)=\(.value / "$$" | map (. + "$") | add | .[:-1] | @sh)\n" )'
 	FILTER '.+[""] | add | .[:-1]'
-	RUN_JQ -r -j <<<"$COMPOSED_JSON"
+	RUN_JQ -r <<<"$COMPOSED_JSON"
 }
 
 doco-target::get-env() {
-	this is-service || fail "$TARGET_NAME is not a service" || return
 	# Fetch parsed env values from docker-compose config
 	local name=${TARGET_VAR}__env; local -n vals=$name
 	if ! array-exists "$name"; then
-		compose-config && eval "vals=($(__get-compose-env "$TARGET_NAME"))" || return
+		REPLY=$(this cat-env) || return; eval "vals=($REPLY)"
 	fi
 	REPLY=("${vals[@]}")
 }

specs/Targets.cram.md

@@ -194,7 +194,7 @@ Groups can be made read-only; services are always read-only.  Any attempt to cha
 
 ### Target Environments
 
-Service targets can fetch their environments as an array of `key=val` strings using `get-env`, or run a command with local variables set from them (using `with-env`).  docker-compose's escaping of `$` is handled correctly, as are multi-line values.
+Service targets can fetch their environments as an array of `key=val` strings using `get-env`, or run a command with local variables set from them (using `with-env`).  docker-compose's escaping of `$` is handled correctly, as are multi-line values.  (You can also dump them to stdout with `cat-env`.)
 
 ~~~sh
 # Only services can get-env
@@ -210,7 +210,7 @@ Service targets can fetch their environments as an array of `key=val` strings us
 # Environment is loaded from compose-config, so let's mock that and
 # pretend we already have the configuration
 
-    $ compose-config() { echo "calling compose-config"; }
+    $ compose-config() { echo "calling compose-config" >&2; }
     $ COMPOSED_JSON='{"services": {"svc2": {"environment": { "X": "y$$z", "Q": "r\ns" }}}}'
 
 # aService has no environment, so we get nothing.
@@ -223,6 +223,15 @@ Service targets can fetch their environments as an array of `key=val` strings us
 
 # svc2 has two variables, one with `$$` and the other with a linefeed
 
+    $ target svc2 cat-env
+    calling compose-config
+    X='y$z'
+    Q='r
+    s'
+
+# But they are correctly parsed into k=v strings by get-env:
+# (cat-env doesn't cache, so compose-config will be called again)
+
     $ target svc2 get-env; printf '%q\n' "${REPLY[@]}"
     calling compose-config
     X=y\$z