hammer_cli 0.19.0 → 2.1.1

data/test/unit/bash_test.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe HammerCLI::Bash::Completion do
+  describe '#complete' do
+    let(:dict) do
+      {
+        'host' => {
+          'create' => {
+            '--installed-products-attributes' => { type: :schema, schema: '"product_id=string\,product_name=string\,arch=string\,version=string, ... "' },
+            '--help' => { type: :flag },
+            '--build' => { type: :flag },
+            '--managed' => { type: :enum, values: %w[yes no] },
+            '--volume' => { type: :multienum, values: %w[first second third] },
+            '--config-group-ids' => { type: :list },
+            '--params' => { type: :key_value_list },
+            '--log' => { type: :file, filter: '.*\.log$' },
+            '--pool' => { type: :directory },
+            '-t' => { type: :value },
+            :params => [{ type: :directory }, { type: :value }, { type: :file }]
+          },
+          '--dry' => { type: :flag },
+          '--help' => { type: :flag },
+        },
+        '--interactive' => { type: :enum, values: %w[yes no] },
+        '--help' => { type: :flag },
+        '-h' => { type: :flag }
+      }
+    end
+
+    subject do
+      HammerCLI::Bash::Completion.new(JSON.load(dict.to_json))
+    end
+
+    it 'returns options when no input given' do
+      result = subject.complete('').sort
+      result.must_equal ['host ', '--interactive ', '--help ', '-h '].sort
+    end
+
+    it 'returns filtered options when partial input is given' do
+      result = subject.complete('-').sort
+      result.must_equal ['--help ', '-h ', '--interactive '].sort
+    end
+
+    it 'returns filtered options when partial input is given' do
+      result = subject.complete('host')
+      result.must_equal ['host ']
+    end
+
+    it 'returns options when subcommand is given' do
+      result = subject.complete('host ').sort
+      result.must_equal ['create ', '--help ', '--dry '].sort
+    end
+
+    it 'returns no options when subcommand is wrong' do
+      result = subject.complete('unknown -h')
+      result.must_equal []
+    end
+
+    it 'returns no options when there are no other params allowed' do
+      result = subject.complete('host create /tmp some /tmp extra')
+      result.must_equal []
+    end
+
+    it 'return hint for option-value pair without value' do
+      result = subject.complete('host create -t ')
+      result.must_equal ['--->', 'Add option <value>']
+    end
+
+    it 'return no options for option-value pair without complete value' do
+      result = subject.complete('host create -t x')
+      result.must_equal []
+    end
+
+    # multiple options in one subcommand
+    it 'allows mutiple options of the same subcommand' do
+      result = subject.complete('host create --build --he')
+      result.must_equal ['--help ']
+    end
+
+    # multiple options with values in one subcommand
+    it 'allows mutiple options with values of the same subcommand' do
+      result = subject.complete('host create -t value --he')
+      result.must_equal ['--help ']
+    end
+
+    # subcommand after options
+    it 'allows subcommand after options' do
+      result = subject.complete('host --dry crea')
+      result.must_equal ['create ']
+    end
+
+    describe 'completion by type' do
+      it 'completes :value' do
+        result = subject.complete('host create -t ')
+        result.must_equal ['--->', 'Add option <value>']
+      end
+
+      it 'completes :flag' do
+        result = subject.complete('host --h')
+        result.must_equal ['--help ']
+      end
+
+      it 'completes :schema' do
+        result = subject.complete('host create --installed-products-attributes ')
+        result.must_equal ["--->", 'Add value by following schema: "product_id=string\,product_name=string\,arch=string\,version=string, ... "']
+      end
+
+      it 'completes :enum' do
+        result = subject.complete('host create --managed ')
+        result.must_equal ['yes ', 'no ']
+      end
+
+      it 'completes :multienum' do
+        result = subject.complete('host create --volume ')
+        result.must_equal ['first', 'second', 'third']
+
+        result = subject.complete('host create --volume fir')
+        result.must_equal ['first']
+
+        result = subject.complete('host create --volume first,')
+        result.must_equal ['second', 'third']
+
+        result = subject.complete('host create --volume first,se')
+        result.must_equal ['first,second']
+      end
+
+      it 'completes :list' do
+        result = subject.complete('host create --config-group-ids ')
+        result.must_equal ['--->', 'Add comma-separated list of values']
+      end
+
+      it 'completes :key_value_list' do
+        result = subject.complete('host create --params ')
+        result.must_equal ['--->', 'Add comma-separated list of key=value']
+      end
+    end
+  end
+end

data/test/unit/command_extensions_test.rb

@@ -23,6 +23,12 @@ describe HammerCLI::CommandExtensions do
 
   class CmdExtensions < HammerCLI::CommandExtensions
     option '--ext', 'EXT', 'ext'
+    option_family(
+      description: 'Test',
+    ) do
+      parent '--test-one', '', ''
+      child '--test-two', '', ''
+    end
     before_print do |data|
       data['key'] = 'value'
     end
@@ -64,49 +70,55 @@ describe HammerCLI::CommandExtensions do
 
     it 'should extend help only' do
       cmd.extend_with(CmdExtensions.new(only: :help))
-      cmd.new({}).help.must_match(/.*Section.*/)
-      cmd.new({}).help.must_match(/.*text.*/)
+      cmd.new('', {}).help.must_match(/.*Section.*/)
+      cmd.new('', {}).help.must_match(/.*text.*/)
     end
 
     it 'should extend params only' do
       cmd.extend_with(CmdExtensions.new(only: :request_params))
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal({})
-      cmd.new({}).extended_request[2].must_equal({})
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal({})
+      cmd.new('', {}).extended_request[2].must_equal({})
     end
 
     it 'should extend headers only' do
       cmd.extend_with(CmdExtensions.new(only: :request_headers))
-      cmd.new({}).extended_request[0].must_equal({})
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal({})
+      cmd.new('', {}).extended_request[0].must_equal({})
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal({})
     end
 
     it 'should extend options only' do
       cmd.extend_with(CmdExtensions.new(only: :request_options))
-      cmd.new({}).extended_request[0].must_equal({})
-      cmd.new({}).extended_request[1].must_equal({})
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal({})
+      cmd.new('', {}).extended_request[1].must_equal({})
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend params and options and headers' do
       cmd.extend_with(CmdExtensions.new(only: :request))
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend data only' do
       cmd.extend_with(CmdExtensions.new(only: :data))
-      cmd.new({}).help.wont_match(/.*Section.*/)
-      cmd.new({}).help.wont_match(/.*text.*/)
+      cmd.new('', {}).help.wont_match(/.*Section.*/)
+      cmd.new('', {}).help.wont_match(/.*text.*/)
       cmd.output_definition.empty?.must_equal true
       opt = cmd.find_option('--ext')
       opt.is_a?(HammerCLI::Options::OptionDefinition).must_equal false
-      cmd.new({}).extended_request[0].must_equal({})
-      cmd.new({}).extended_request[1].must_equal({})
-      cmd.new({}).extended_request[2].must_equal({})
-      cmd.new({}).extended_data({}).must_equal('key' => 'value')
+      cmd.new('', {}).extended_request[0].must_equal({})
+      cmd.new('', {}).extended_request[1].must_equal({})
+      cmd.new('', {}).extended_request[2].must_equal({})
+      cmd.new('', {}).extended_data({}).must_equal('key' => 'value')
+    end
+
+    it 'should extend option family only' do
+      cmd.extend_with(CmdExtensions.new(only: :option_family))
+      cmd.output_definition.empty?.must_equal true
+      cmd.recognised_options.map(&:switches).flatten.must_equal ['--test-one', '--test-two', '-h', '--help']
     end
   end
 
@@ -116,9 +128,9 @@ describe HammerCLI::CommandExtensions do
       opt = cmd.find_option('--ext')
       opt.is_a?(HammerCLI::Options::OptionDefinition).must_equal false
       cmd.output_definition.empty?.must_equal false
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend all except output' do
@@ -126,62 +138,68 @@ describe HammerCLI::CommandExtensions do
       cmd.output_definition.empty?.must_equal true
       opt = cmd.find_option('--ext')
       opt.is_a?(HammerCLI::Options::OptionDefinition).must_equal true
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend all except help' do
       cmd.extend_with(CmdExtensions.new(except: :help))
-      cmd.new({}).help.wont_match(/.*Section.*/)
-      cmd.new({}).help.wont_match(/.*text.*/)
+      cmd.new('', {}).help.wont_match(/.*Section.*/)
+      cmd.new('', {}).help.wont_match(/.*text.*/)
       cmd.output_definition.empty?.must_equal false
       opt = cmd.find_option('--ext')
       opt.is_a?(HammerCLI::Options::OptionDefinition).must_equal true
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend all except params' do
       cmd.extend_with(CmdExtensions.new(except: :request_params))
-      cmd.new({}).extended_request[0].must_equal({})
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal({})
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend all except headers' do
       cmd.extend_with(CmdExtensions.new(except: :request_headers))
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal({})
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal({})
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
     end
 
     it 'should extend all except options' do
       cmd.extend_with(CmdExtensions.new(except: :request_options))
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal({})
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal({})
     end
 
     it 'should extend all except params and options and headers' do
       cmd.extend_with(CmdExtensions.new(except: :request))
-      cmd.new({}).extended_request[0].must_equal({})
-      cmd.new({}).extended_request[1].must_equal({})
-      cmd.new({}).extended_request[2].must_equal({})
+      cmd.new('', {}).extended_request[0].must_equal({})
+      cmd.new('', {}).extended_request[1].must_equal({})
+      cmd.new('', {}).extended_request[2].must_equal({})
     end
 
     it 'should extend all except data' do
       cmd.extend_with(CmdExtensions.new(except: :data))
-      cmd.new({}).help.must_match(/.*Section.*/)
-      cmd.new({}).help.must_match(/.*text.*/)
+      cmd.new('', {}).help.must_match(/.*Section.*/)
+      cmd.new('', {}).help.must_match(/.*text.*/)
       cmd.output_definition.empty?.must_equal false
       opt = cmd.find_option('--ext')
       opt.is_a?(HammerCLI::Options::OptionDefinition).must_equal true
-      cmd.new({}).extended_request[0].must_equal(thin: true)
-      cmd.new({}).extended_request[1].must_equal(ssl: true)
-      cmd.new({}).extended_request[2].must_equal(with_authentication: true)
-      cmd.new({}).extended_data({}).must_equal({})
+      cmd.new('', {}).extended_request[0].must_equal(thin: true)
+      cmd.new('', {}).extended_request[1].must_equal(ssl: true)
+      cmd.new('', {}).extended_request[2].must_equal(with_authentication: true)
+      cmd.new('', {}).extended_data({}).must_equal({})
+    end
+
+    it 'should extend all except option family' do
+      cmd.extend_with(CmdExtensions.new(except: :option_family))
+      cmd.output_definition.empty?.must_equal false
+      cmd.recognised_options.map(&:switches).flatten.must_equal ['--ext', '-h', '--help']
     end
   end
 

data/test/unit/exception_handler_test.rb

@@ -55,4 +55,48 @@ describe HammerCLI::ExceptionHandler do
     assert_match /ERROR  Exception : (Resource )?Not Found/, @log_output.readline.strip
   end
 
+  it "should print default prompts for standard missing arguments" do
+    params = %w[login mail]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--login', '--mail'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print right prompts for nested missing arguments" do
+    params = %w[user[login] user[mail]]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--login', '--mail'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print simple prompts for even more nested arguments" do
+    params = %w[user[address][city] user[address][street]]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--address'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print simple prompts for even more different nested arguments" do
+    params = %w[user[address][city] user[address][street] user[nested][par1]]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--address', '--nested'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print default prompts for standard missing arguments" do
+    params = %w[opt_abc opt_a_b-c]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--opt-abc', '--opt-a-b-c'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
 end

data/test/unit/help/builder_test.rb

@@ -69,4 +69,26 @@ describe HammerCLI::Help::Builder do
       help.string.strip.must_equal expected_output
     end
   end
+
+  describe 'option family' do
+    let(:family) { Class.new(HammerCLI::Options::OptionFamily) }
+
+    it 'prints option families' do
+      fm1 = family.new
+      fm1.parent(['--option-zzz'], 'OPT', 'Some description')
+      fm1.child(['--option-aaa'], 'OPT', 'Some description')
+      fm2 = family.new
+      fm2.parent(['--option-bbb'], 'OPT', 'Some description')
+      fm2.child(['--option-yyy'], 'OPT', 'Some description')
+
+      options = fm1.all + fm2.all
+      help.add_list('Options', options)
+
+      help.string.strip.must_equal [
+        'Options:',
+        ' --option[-yyy|-bbb]           Some description',
+        ' --option[-aaa|-zzz]           Some description',
+      ].join("\n")
+    end
+  end
 end

data/test/unit/options/option_family_test.rb

@@ -0,0 +1,48 @@
+require_relative '../test_helper'
+
+describe HammerCLI::Options::OptionFamily do
+  let(:family) do
+    HammerCLI::Options::OptionFamily.new(
+      deprecated: { '--test-one' => 'Use --test-two instead' }
+    )
+  end
+  let(:first_option) { HammerCLI::Apipie::OptionDefinition.new("--test-one", '', '') }
+  let(:second_option) { HammerCLI::Apipie::OptionDefinition.new("--test-two", '', '') }
+  let(:third_option) { HammerCLI::Apipie::OptionDefinition.new("--test-three", '', '') }
+  let(:full_family) do
+    family.parent('--test-one', '', 'Test').family.child('--test-two', '', '').family
+  end
+
+  describe 'switch' do
+    it 'returns nil if family is empty' do
+      family.switch.must_be_nil
+    end
+
+    it 'returns parent switch if family has no children' do
+      family.parent('--test-one', '', '')
+      family.switch.must_equal '--test-one'
+    end
+
+    it 'returns switch based on members' do
+      full_family.switch.must_equal '--test[-two|-one]'
+    end
+  end
+
+  describe 'description' do
+    it 'returns parent description if nothing passed to initializer' do
+      full_family.description.must_equal full_family.head.help[1]
+    end
+
+    it 'returns description with deprecation message' do
+      full_family.description.must_equal 'Test (--test-one is deprecated: Use --test-two instead)'
+    end
+  end
+
+  describe 'adopt' do
+    it 'appends an option to children' do
+      full_family.adopt(third_option)
+      full_family.children.size.must_equal 2
+      third_option.family.must_equal full_family
+    end
+  end
+end