Merge pull request #546 from DannyBen/add/environment-variable-validation

Add support for environment variable validations

Author: DannyBen

examples/README.md

@@ -61,7 +61,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [yaml](yaml#readme) - using the YAML reading functions
 - [colors](colors#readme) - using the color print feature
 - [completions](completions#readme) - adding bash completion functionality
-- [validations](validations#readme) - adding argument validation functions
+- [validations](validations#readme) - adding validation functions for arguments, flags or environment variables
 - [hooks](hooks#readme) - adding before/after hooks
 
 ## Real-world-like examples

examples/needs/README.md

@@ -83,15 +83,15 @@ Options:
 ### `$ ./cli --add deploy`
 
 ````shell
---add requires --command
+--add needs --command
 
 
 ````
 
 ### `$ ./cli --add deploy --command 'git push'`
 
 ````shell
---add requires --target
+--add needs --target
 
 
 ````

examples/validations/README.md

@@ -50,6 +50,15 @@ commands:
 
     # Validations also work on flags (when they have arguments)
     validate: file_exists
+
+- name: build
+  environment_variables:
+  - name: build_dir
+    help: Path to the build directory
+    default: release
+
+    # Validations also work on environment variables
+    validate: dir_exists
 ````
 
 
@@ -97,5 +106,28 @@ must be an existing file
 
 ````
 
+### `$ ./validate build`
+
+````shell
+validation error in environment variable BUILD_DIR:
+must be an existing directory
+
+
+````
+
+### `$ BUILD_DIR=src ./validate build`
+
+````shell
+# this file is located in 'src/build_command.sh'
+# code for 'validate build' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+
+environment variables:
+- $BUILD_DIR = src
+
+
+````
+
 
 

examples/validations/src/bashly.yml

@@ -27,3 +27,11 @@ commands:
     # Validations also work on flags (when they have arguments)
     validate: file_exists
 
+- name: build
+  environment_variables:
+  - name: build_dir
+    help: Path to the build directory
+    default: release
+
+    # Validations also work on environment variables
+    validate: dir_exists

examples/validations/src/build_command.sh

@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/build_command.sh'"
+echo "# code for 'validate build' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/validations/test.sh

@@ -14,3 +14,6 @@ bashly generate
 ./validate calc A
 ./validate calc 1 B
 ./validate calc 1 2 --save no-such-file.txt
+
+./validate build
+BUILD_DIR=src ./validate build

lib/bashly/docs/env.yml

@@ -49,6 +49,16 @@ environment_variable.required:
   help: Specify that this variable is required.
   url: https://bashly.dannyb.co/configuration/environment-variable/#required
   example: |-
+    environment_variables:
     - name: api_key
       help: Your API key
       required: true
+
+environment_variable.validate:
+  help: Apply custom validation functions.
+
+  url: https://bashly.dannyb.co/configuration/environment-variable/#validate
+  example: |-
+    environment_variables:
+    - name: build_dir
+      validate: dir_exists

lib/bashly/libraries/strings/strings.yml

@@ -42,3 +42,4 @@ disallowed_argument: "%{name} must be one of: %{allowed}"
 disallowed_environment_variable: "%{name} environment variable must be one of: %{allowed}"
 unsupported_bash_version: "bash version 4 or higher is required"
 validation_error: "validation error in %s:\\n%s"
+environment_variable_validation_error: "validation error in environment variable %s:\\n%s"

lib/bashly/script/environment_variable.rb

@@ -3,7 +3,9 @@ module Script
     class EnvironmentVariable < Base
       class << self
         def option_keys
-          @option_keys ||= %i[allowed default help name required private]
+          @option_keys ||= %i[
+            allowed default help name required private validate
+          ]
         end
       end
 

lib/bashly/script/introspection/environment_variables.rb

@@ -2,7 +2,7 @@ module Bashly
   module Script
     module Introspection
       module EnvironmentVariables
-        # Returns an array of all the default Environment Variables
+        # Returns an array of all the Environment Variables with default values
         def default_environment_variables
           environment_variables.select(&:default)
         end
@@ -26,6 +26,11 @@ def required_environment_variables
           environment_variables.select(&:required)
         end
 
+        # Returns an array of all the environment_variables with a validation
+        def validated_environment_variables
+          environment_variables.select(&:validate)
+        end
+
         # Returns an array of all the environment_variables with a whitelist arg
         def whitelisted_environment_variables
           environment_variables.select(&:allowed)