- Validate uniqueness of command args, flags and subcommands

Author: DannyBen

lib/bashly/config_validator.rb

@@ -59,6 +59,12 @@ def assert_hash(key, value, whitelist = nil)
       end
     end
 
+    def assert_uniq(key, value, array_key)
+      return unless value
+      list = value.map { |c| c[array_key] }.compact.flatten
+      assert list.uniq?, "#{key} cannot have elements with similar #{array_key} values"
+    end
+
     def assert_string_or_array(key, value)
       return unless value
       assert [Array, String].include?(value.class),
@@ -149,7 +155,7 @@ def assert_env_var(key, value)
       assert_boolean "#{key}.required", value['required']
     end
 
-    def assert_command(key, value)
+    def assert_command(key, value)      
       assert_hash key, value, Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
@@ -177,6 +183,12 @@ def assert_command(key, value)
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
+      assert_uniq "#{key}.commands", value['commands'], 'name'
+      assert_uniq "#{key}.commands", value['commands'], 'alias'
+      assert_uniq "#{key}.flags", value['flags'], 'long'
+      assert_uniq "#{key}.flags", value['flags'], 'short'
+      assert_uniq "#{key}.args", value['args'], 'name'
+
       if value['catch_all'] and value['args']
         repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"

lib/bashly/extensions/array.rb

@@ -4,4 +4,9 @@ def indent(offset)
     indentation = " " * offset
     map { |line| "#{indentation}#{line}" }
   end
+
+  def uniq?
+    self == uniq
+  end
+
 end

spec/approvals/validations/non_uniq_arg_names

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.args cannot have elements with similar name values>

spec/approvals/validations/non_uniq_command_aliases

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.commands cannot have elements with similar alias values>

spec/approvals/validations/non_uniq_command_names

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.commands cannot have elements with similar name values>

spec/approvals/validations/non_uniq_flags_longs

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags cannot have elements with similar long values>

spec/approvals/validations/non_uniq_flags_shorts

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags cannot have elements with similar short values>

spec/fixtures/script/validations.yml

@@ -209,3 +209,42 @@
     help: Path to one or more files
     repeatable: true
     required: true
+
+:non_uniq_command_names:
+  name: invalid
+  help: commands with the same name
+  commands:
+  - name: upload
+  - name: download
+  - name: download
+
+:non_uniq_command_aliases:
+  name: invalid
+  help: commands with the same alias
+  commands:
+  - name: connect
+    alias: c
+  - name: config
+    alias: [c, conf]
+
+:non_uniq_flags_longs:
+  name: invalid
+  help: flags with the same long name
+  flags:
+  - long: --force
+  - long: --force
+
+:non_uniq_flags_shorts:
+  name: invalid
+  help: flags with the same short name
+  flags:
+  - short: -f
+  - short: -f
+  
+:non_uniq_arg_names:
+  name: invalid
+  help: args with the same name
+  args:
+  - name: file
+  - name: file
+