Merge pull request #427 from DannyBen/add/arbitrary-config-values

Allow arbitrary (`x-anything`) keys in bashly.yml

Author: DannyBen

.github/workflows/test.yml

@@ -116,11 +116,5 @@ jobs:
     - name: Generate all subjects
       run: bundle exec run examples regen
 
-    - name: Run bashly schema tests
-      run: bundle exec run schema examples
-
-    - name: Run settings schema tests
-      run: bundle exec run schema settings
-
-    - name: Run strings schema tests
-      run: bundle exec run schema strings
+    - name: Run schema tests
+      run: bundle exec run schema all

lib/bashly/concerns/validation_helpers.rb

@@ -41,6 +41,7 @@ def assert_hash(key, value, keys: nil)
       return unless keys
 
       invalid_keys = value.keys.map(&:to_sym) - keys
+      invalid_keys.reject! { |key| key.start_with? 'x-' }
       assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
     end
 

schemas/bashly.json

@@ -1,6 +1,17 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema",
     "definitions": {
+        "custom-properties": {
+            "patternProperties": {
+                "^x-.": {
+                    "title": "custom property",
+                    "description": "A custom property of any type",
+                    "examples": [
+                        "This command shows the status of all `images`, `containers` and `volumes`. Use with `--verbose` to see deleted containers."
+                    ]
+                }
+            }
+        },
         "argument": {
             "title": "argument",
             "description": "A positional argument of the current script or sub-command\nhttps://bashly.dannyb.co/configuration/argument/",
@@ -74,6 +85,7 @@
                     ]
                 }
             },
+            "$ref": "#/definitions/custom-properties",
             "additionalProperties": false
         },
         "flag": {
@@ -209,6 +221,7 @@
                     ]
                 }
             },
+            "$ref": "#/definitions/custom-properties",
             "additionalProperties": false
         },
         "name-property": {
@@ -405,6 +418,7 @@
                             "$ref": "#/definitions/environment-variables-required-property"
                         }
                     },
+                    "$ref": "#/definitions/custom-properties",
                     "additionalProperties": false
                 },
                 "else": {
@@ -422,6 +436,7 @@
                             "$ref": "#/definitions/environment-variables-required-property"
                         }
                     },
+                    "$ref": "#/definitions/custom-properties",
                     "additionalProperties": false
                 }
             }
@@ -779,6 +794,7 @@
                     "$ref": "#/definitions/sub-command-import-property"
                 }
             },
+            "$ref": "#/definitions/custom-properties",
             "additionalProperties": false
         }
     },
@@ -835,5 +851,6 @@
             "$ref": "#/definitions/function-property"
         }
     },
+    "$ref": "#/definitions/custom-properties",
     "additionalProperties": false
 }

spec/fixtures/script/x-arbitrary.yml

@@ -0,0 +1,29 @@
+name: docker
+x-string: hello
+x-hash: { key: value }
+x-array: [1, 2]
+x-int: 1
+x-float: 1.2
+x-boolean: yes
+x-nil: ~
+
+environment_variables:
+- name: rush_config
+  x-any: hello
+
+commands:
+- name: status
+  x-any: hello
+
+  args:
+  - name: repo
+    x-any: hello
+
+  flags:
+  - long: --purge
+    x-any: hello
+
+- name: images
+  commands:
+  - name: ls
+    x-any: hello

support/runfile/schema.runfile

@@ -1,30 +1,57 @@
 summary 'Run json-schema checks on all examples'
 
-help   'Test the bashly schema against all examples'
-action :examples do
-  Example.all.each do |example|
-    file = example.yaml_path
-    command = "check-jsonschema --schemafile schemas/bashly.json #{file}"
-    say "\n$ check-jsonschema bb`#{example.dir}`"
-    success = system command
-    abort 'Failed' unless success
-  end
+help 'Run all the actions in this runfile'
+action :all do
+  check_examples
+  check_settings
+  check_strings
+  check_arbitrary
 end
 
-help   'Test the settings schema against the default settings template'
-action :settings do
-  file = 'lib/bashly/libraries/settings/settings.yml'
-  command = "check-jsonschema --schemafile schemas/settings.json #{file}"
-  say "\n$ check-jsonschema bb`#{file}`"
-  success = system command
-  abort 'Failed' unless success
-end
+help 'Test the bashly schema against all examples'
+action(:examples) { check_examples }
 
-help   'Test the strings schema against the default strings template'
-action :strings do
-  file = 'lib/bashly/libraries/strings/strings.yml'
-  command = "check-jsonschema --schemafile schemas/strings.json #{file}"
-  say "\n$ check-jsonschema bb`#{file}`"
-  success = system command
-  abort 'Failed' unless success
-end
+help 'Test the settings schema against the default settings template'
+action(:settings) { check_settings }
+
+help 'Test the strings schema against the default strings template'
+action(:strings) { check_strings }
+
+help 'Test the bashly schema against a bashly configuration that includes arbitrary (x-) keys'
+action(:arbitrary) { check_arbitrary }
+
+helpers do
+  def check_examples
+    say "\ngub`Examples`"
+    Example.all.each do |example|
+      file = example.yaml_path
+      schema_check file
+    end
+  end
+
+  def check_settings
+    say "\ngub`Settings`"
+    file = 'lib/bashly/libraries/settings/settings.yml'
+    schema_check file, :settings
+  end
+
+  def check_strings
+    say "\ngub`Strings`"
+    file = 'lib/bashly/libraries/strings/strings.yml'
+    schema_check file, :strings
+  end
+
+  def check_arbitrary
+    say "\ngub`Arbitrary`"
+    file = 'spec/fixtures/script/x-arbitrary.yml'
+    schema_check file
+  end
+
+  def schema_check(file, schema = 'bashly')
+    command = "check-jsonschema --schemafile schemas/#{schema}.json #{file}"
+    say "\nnb`$ check-jsonschema` [m`#{schema}`] bb`#{file}`"
+    success = system command
+    
+    abort 'Failed' unless success
+  end
+end