Merge pull request #268 from DannyBen/fix/default-env-vars-init

Make default environment variable values available in `initialize()`

Author: DannyBen

lib/bashly/views/command/environment_variables_default.gtx

@@ -0,0 +1,7 @@
+if default_environment_variables.any?
+  = view_marker 
+
+  default_environment_variables.each do |env_var|
+    > export {{ env_var.name.upcase }}="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
+  end
+end

lib/bashly/views/command/environment_variables_filter.gtx

@@ -1,11 +1,6 @@
 if default_environment_variables.any? or required_environment_variables.any?
   = view_marker 
-
-  if default_environment_variables.any?
-    default_environment_variables.each do |env_var|
-      > export {{ env_var.name.upcase }}="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
-    end
-  end
+  = render(:environment_variables_default)
 
   if required_environment_variables.any?
     required_environment_variables.each do |env_var|

lib/bashly/views/command/initialize.gtx

@@ -6,6 +6,10 @@
 >   {{ Settings.strict ? "set -euo pipefail" : "set -e" }}
 > 
 
+if root_command?
+  = render(:environment_variables_default).indent 2
+end
+
 = load_user_file("initialize.sh", placeholder: false).indent 2
 
 > }

spec/approvals/fixtures/environment-variables-initialize

@@ -0,0 +1,34 @@
+creating user files in src
+skipped src/initialize.sh (exists)
+created src/download_command.sh
+created ./cli
+run ./cli --help to test your bash script
++ ./cli
+PASS: API_KEY=must-be-available-in-initialize
+PASS: NESTED_VAR is empty
+missing required environment variable: CONFIG_PATH
++ export CONFIG_PATH=somepath
++ CONFIG_PATH=somepath
++ ./cli download source
+PASS: API_KEY=must-be-available-in-initialize
+PASS: NESTED_VAR is empty
+# this file is located in 'src/download_command.sh'
+# code for 'cli download' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[source]} = source
++ export API_KEY=override-value
++ API_KEY=override-value
++ ./cli
+PASS: API_KEY=override-value
+PASS: NESTED_VAR is empty
+cli - Sample application
+
+Usage:
+  cli [command]
+  cli [command] --help | -h
+  cli --version | -v
+
+Commands:
+  download   Download a file
+

spec/fixtures/workspaces/environment-variables-initialize/.gitignore

@@ -0,0 +1,2 @@
+cli
+src/download_command.sh

spec/fixtures/workspaces/environment-variables-initialize/README.md

@@ -0,0 +1,5 @@
+This fixture tests that default values for environment variables exist in
+the initialize function, and that required environment variables are NOT
+blocking --help.
+
+Reference issue: https://github.com/DannyBen/bashly/issues/265

spec/fixtures/workspaces/environment-variables-initialize/src/bashly.yml

@@ -0,0 +1,28 @@
+name: cli
+help: Sample application
+version: 0.1.0
+
+environment_variables:
+- name: api_key
+  default: must-be-available-in-initialize
+  help: Set your API key
+- name: config_path
+  required: true
+  help: Set the config path
+
+commands:
+- name: download
+  alias: d
+  help: Download a file
+
+  args:
+  - name: source
+    help: URL to download from
+  - name: target
+    help: "Target filename (default: same as source)"
+
+  environment_variables:
+  - name: nested_var
+    default: not-available-in-initialize
+    help: Set the default location to download to
+

spec/fixtures/workspaces/environment-variables-initialize/src/initialize.sh

@@ -0,0 +1,13 @@
+if [[ -n "$API_KEY" ]]; then
+  echo "PASS: API_KEY=$API_KEY"
+else
+  echo "FAIL: API_KEY is empty"
+fi
+
+if [[ -z "$NESTED_VAR" ]]; then
+  echo "PASS: NESTED_VAR is empty"
+else
+  echo "FAIL: NESTED_VAR=$NESTED_VAR"
+fi
+
+

spec/fixtures/workspaces/environment-variables-initialize/test.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# This fixture tests that default values for environment variables exist in
+# the initialize function, and that required environment variables are NOT
+# blocking --help.
+# Reference issue: https://github.com/DannyBen/bashly/issues/265
+
+rm -f ./src/download_command.sh
+rm -f ./cli
+
+bundle exec bashly generate
+
+set -x
+
+./cli
+export CONFIG_PATH=somepath
+./cli download source
+export API_KEY=override-value
+./cli