hammer_cli 0.8.0 → 0.9.0

data/test/functional/help_test.rb

@@ -0,0 +1,87 @@
+require File.join(File.dirname(__FILE__), './test_helper')
+
+describe 'help' do
+  class CmdWithHelp < HammerCLI::AbstractCommand
+    extend_help do |h|
+      h.text 'Details about interface settings'
+
+      h.section 'Available keys for --interface' do |h|
+        h.list([
+          'mac',
+          'ip',
+          ['type',         'One of interface, bmc, bond'],
+          'name',
+          'subnet_id',
+          'domain_id',
+          'identifier',
+          ['managed',      'true/false'],
+          ['primary',      'true/false, each managed hosts needs to have one primary interface.'],
+          ['provision',    'true/false'],
+          ['virtual',      'true/false']
+        ])
+        h.section 'For virtual interfaces' do |h|
+          h.list([
+            ['tag',          'VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.'],
+            ['attached_to',  'Identifier of the interface to which this interface belongs, e.g. eth1.']
+          ])
+        end
+        h.section 'For bonds' do |h|
+          h.list([
+            ['mode',             'One of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb'],
+            ['attached_devices', 'Identifiers of slave interfaces, e.g. [eth1,eth2]'],
+            'bond_options'
+          ])
+        end
+        h.section 'For BMCs' do |h|
+          h.list([
+            ['provider',         'always IPMI'],
+            'username',
+            'password'
+          ])
+        end
+      end
+    end
+  end
+
+  it 'prints additional help' do
+    result = run_cmd(['-h'], {}, CmdWithHelp)
+    result.out.must_equal [
+      'Usage:',
+      '    hammer [OPTIONS]',
+      '',
+      'Options:',
+      ' -h, --help                    print help',
+      '',
+      'Details about interface settings',
+      '',
+      'Available keys for --interface:',
+      '  mac',
+      '  ip',
+      '  type                One of interface, bmc, bond',
+      '  name',
+      '  subnet_id',
+      '  domain_id',
+      '  identifier',
+      '  managed             true/false',
+      '  primary             true/false, each managed hosts needs to have one primary interface.',
+      '  provision           true/false',
+      '  virtual             true/false',
+      '',
+      '  For virtual interfaces:',
+      '    tag                 VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.',
+      '    attached_to         Identifier of the interface to which this interface belongs, e.g. eth1.',
+      '',
+      '  For bonds:',
+      '    mode                One of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb',
+      '    attached_devices    Identifiers of slave interfaces, e.g. [eth1,eth2]',
+      '    bond_options',
+      '',
+      '  For BMCs:',
+      '    provider            always IPMI',
+      '    username',
+      '    password',
+      ''
+    ].join("\n")
+  end
+
+end

data/test/test_helper.rb

@@ -18,3 +18,9 @@ require 'hammer_cli/logger'
 
 Logging.logger.root.appenders = Logging::Appenders['__test__'] || Logging::Appenders::StringIo.new('__test__')
 
+HammerCLI.context[:api_connection].create(:apipie) do
+  HammerCLI::Apipie::ApiConnection.new({
+    :apidoc_cache_dir => 'test/unit/fixtures/apipie',
+    :apidoc_cache_name => 'architectures'
+  })
+end

data/test/unit/abstract_test.rb

@@ -376,5 +376,14 @@ describe HammerCLI::AbstractCommand do
     CmdOD2.output_definition.fields.length.must_equal 1
   end
 
+  it "should allow for multiple validation blocks" do
+    class CmdName1 < HammerCLI::AbstractCommand
+      validate_options do; end
+      validate_options do; end
+    end
+
+    assert_equal 2, CmdName1.validation_blocks.length
+  end
+
 end
 

data/test/unit/apipie/api_connection_test.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), '../../test_helper')
+
+describe HammerCLI::Apipie::ApiConnection do
+  let(:connection) { HammerCLI::Connection.new }
+
+  describe '#initialize' do
+
+    let(:empty_params) {{}}
+
+    def api_stub(params = {})
+      api_stub = stub()
+      ApipieBindings::API.expects(:new).with(params).returns(api_stub)
+      api_stub
+    end
+
+    it "passes attributes to apipie bindings" do
+      params = { :apidoc_cache_name => 'test.example.com' }
+
+      api_stub(params)
+      HammerCLI::Apipie::ApiConnection.new(params)
+    end
+
+    context "with :clear_cache => true" do
+      it "clears cache" do
+        api_stub.expects(:clean_cache)
+        HammerCLI::Apipie::ApiConnection.new(empty_params, :reload_cache => true)
+      end
+
+      it "logs message when logger is available" do
+        logger = stub()
+        logger.expects(:debug).with('Apipie cache was cleared')
+
+        api_stub.expects(:clean_cache)
+        HammerCLI::Apipie::ApiConnection.new(empty_params, :reload_cache => true, :logger => logger)
+      end
+    end
+  end
+end

data/test/unit/apipie/command_test.rb

@@ -3,17 +3,11 @@ require File.join(File.dirname(__FILE__), '../test_helper')
 
 describe HammerCLI::Apipie::Command do
 
-  class TestCommand < HammerCLI::Apipie::Command
-    def self.resource_config
-      { :apidoc_cache_dir => 'test/unit/fixtures/apipie', :apidoc_cache_name => 'architectures' }
-    end
-  end
-
-  class ParentCommand < TestCommand
+  class ParentCommand < HammerCLI::Apipie::Command
     action :show
   end
 
-  class OptionCommand < TestCommand
+  class OptionCommand < HammerCLI::Apipie::Command
     resource :architectures, :create
 
     def option_name
@@ -23,10 +17,9 @@ describe HammerCLI::Apipie::Command do
     def option_operatingsystem_ids
       nil
     end
-
   end
 
-  class CommandA < TestCommand
+  class CommandA < HammerCLI::Apipie::Command
     resource :architectures, :index
 
     class CommandB < ParentCommand
@@ -37,14 +30,10 @@ describe HammerCLI::Apipie::Command do
   end
 
   let(:ctx) { { :adapter => :silent, :interactive => false } }
-  let(:cmd_class) { TestCommand.dup }
+  let(:cmd_class) { HammerCLI::Apipie::Command.dup }
   let(:cmd) { cmd_class.new("", ctx) }
   let(:cmd_run) { cmd.run([]) }
 
-  before :each do
-    HammerCLI::Connection.drop_all
-  end
-
   context "setting resources" do
 
     it "should set resource and action together" do
@@ -103,40 +92,11 @@ describe HammerCLI::Apipie::Command do
   end
 
   context "resource defined" do
-
-    before :each do
-      HammerCLI::Connection.drop_all
-      ApipieBindings::API.any_instance.stubs(:call).returns([])
-      cmd.class.resource :architectures, :index
-    end
-
     it "should perform a call to api when resource is defined" do
-      ctx[:defaults] = stub(:get_defaults => {})
-      cmd_run.must_equal 0
-    end
-  end
-
-  context "reload apipie cache" do
-
-    before :each do
-      HammerCLI::Connection.drop_all
-      ApipieBindings::API.any_instance.stubs(:call).returns([])
-    end
-
-    it "clears the cache on init when required from config" do
-      HammerCLI::Settings.load({ :reload_cache => true })
-      ApipieBindings::API.any_instance.expects(:clean_cache).returns(nil)
+      ApipieBindings::API.any_instance.expects(:call).returns([])
       cmd.class.resource :architectures, :index
-      HammerCLI::Settings.load({ :reload_cache => false })
-    end
-
-    it "clears the cache on init when required from CLI" do
-      HammerCLI::Settings.load({ :_params => { :reload_cache => true }})
-      ApipieBindings::API.any_instance.expects(:clean_cache).returns(nil)
-      cmd.class.resource :architectures, :index
-      HammerCLI::Settings.load({ :_params => { :reload_cache => false }})
+      cmd_run.must_equal 0
     end
-
   end
 
   context "options" do

data/test/unit/connection_test.rb

@@ -1,68 +1,59 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe HammerCLI::Connection do
-
-  before :each do
-    # clean up global settings
-    HammerCLI::Connection.drop_all
-    HammerCLI::Settings.load({:_params => {:interactive => false}})
-  end
-
-  let(:connection) { HammerCLI::Connection }
-
-  class Connector < HammerCLI::AbstractConnector
-
-    attr_reader :url
-
-    def initialize(params)
-      @url = params[:url]
-      super
+  let(:connections) { HammerCLI::Connection.new }
+
+  describe '#create' do
+    it "creates new connection" do
+      connections.create(:test) do
+        :conn1
+      end
+      assert_equal :conn1, connections.get(:test)
     end
 
-  end
-
-  it "should return the conection" do
-    conn = connection.create(:test, {})
-    conn.must_be_kind_of HammerCLI::AbstractConnector
-  end
-
-  it "should create the connection only once" do
-    conn1 = connection.create(:test, {})
-    conn2 = connection.create(:test, {})
-    conn1.must_equal conn2
-  end
+    it "doesn't overwrite the connection when called multiple times" do
+      connections.create(:test) do
+        :conn1
+      end
+      connections.create(:test) do
+        :conn2
+      end
+      assert_equal :conn1, connections.get(:test)
+    end
 
-  it "should test the connection" do
-    connection.exist?(:test).must_equal false
-    conn1 = connection.create(:test, {})
-    connection.exist?(:test).must_equal true
-  end
+    it 'writes message to log' do
+      logger = stub()
+      logger.expects(:debug).with('Registered: test_connection')
 
-it "should get the connection" do
-    conn1 = connection.create(:test, {})
-    conn2 = connection.get(:test)
-    conn1.must_equal conn2
+      connections = HammerCLI::Connection.new(logger)
+      connections.create(:test_connection) do
+        :test_connection
+      end
+    end
   end
 
-
-  it "should be able to drop all" do
-    conn1 = connection.create(:test, {})
-    connection.drop_all
-    conn2 = connection.create(:test, {})
-    conn1.wont_equal conn2    # TODO
+  describe '#drop' do
+    it 'drops the connection' do
+      connections.create(:test) do
+        :conn1
+      end
+      connections.drop(:test)
+      assert_nil connections.get(:test)
+    end
   end
 
-  it "should drop the connection" do
-    conn1 = connection.create(:test, {})
-    connection.drop(:test)
-    conn2 = connection.create(:test, {})
-    conn1.wont_equal conn2
-  end
+  describe '#drop_all' do
+    it 'drops all connections' do
+      connections.create(:test1) do
+        :conn1
+      end
+      connections.create(:test2) do
+        :conn3
+      end
+      connections.drop_all
 
-  it "should accept custom connector" do
-    conn = connection.create(:test, {:url => 'URL'}, :connector => Connector)
-    conn.must_be_kind_of Connector
-    conn.url.must_equal 'URL'
+      assert_nil connections.get(:test1)
+      assert_nil connections.get(:test2)
+    end
   end
-
 end

data/test/unit/exception_handler_test.rb

@@ -14,7 +14,7 @@ describe HammerCLI::ExceptionHandler do
   let(:cmd) { Class.new(HammerCLI::AbstractCommand).new("command_name") }
 
   it "should handle unauthorized" do
-    output.expects(:print_error).with(heading, "Invalid username or password")
+    output.expects(:print_error).with(heading, "Unauthorized")
     handler.handle_exception(RestClient::Unauthorized.new, :heading => heading)
   end
 

data/test/unit/fixtures/apipie/documented.json

@@ -134,7 +134,7 @@
                                 "name": "boolean_param",
                                 "allow_null": false,
                                 "full_name": "documented[boolean_param]",
-                                "validator": "Must be Boolean",
+                                "validator": "Must be 'true' or 'false' or '1' or '0'",
                                 "expected_type": "boolean",
                                 "description": "",
                                 "required": false

data/test/unit/help/builder_test.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe HammerCLI::Help::Builder do
+  let(:help) { HammerCLI::Help::Builder.new }
+
+  describe 'sorting options' do
+    it 'prints options alphabetically sorted' do
+      options = [
+        Clamp::Option::Definition.new(['--zzz-option'], 'OPT_Z', 'Some description'),
+        Clamp::Option::Definition.new(['--yyy-option'], 'OPT_Y', 'Some description'),
+        Clamp::Option::Definition.new(['--aaa-option'], 'OPT_A', 'Some description'),
+        Clamp::Option::Definition.new(['--bbb-option'], 'OPT_B', 'Some description')
+      ]
+      help.add_list('Options', options)
+
+      help.string.strip.must_equal [
+        'Options:',
+        ' --aaa-option OPT_A            Some description',
+        ' --bbb-option OPT_B            Some description',
+        ' --yyy-option OPT_Y            Some description',
+        ' --zzz-option OPT_Z            Some description'
+      ].join("\n")
+    end
+  end
+
+  describe 'adding text' do
+    let(:content_1) {[
+      'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+      'Donec sem dolor, pellentesque sit amet auctor nec, finibus ut elit.'
+    ]}
+    let(:content_2) {[
+      'Donec et erat in enim pellentesque pretium. Sed egestas sem id lectus ultricies lobortis.',
+      'Etiam posuere, ipsum scelerisque maximus fermentum, libero dui sagittis felis, at molestie erat augue at dui. Ut dapibus rutrum purus a luctus.'
+    ]}
+
+    it 'prints paragraphs without headings' do
+      help.add_text(content_1.join("\n"))
+      help.string.strip.must_equal content_1.join("\n")
+    end
+
+    it 'prints paragraphs with headings' do
+      help.add_text(content_1.join("\n"))
+      help.string.strip.must_equal content_1.join("\n")
+    end
+
+    it 'prints multiple paragraphs divided with empty line' do
+      help.add_text(content_1.join("\n"))
+      help.add_text(content_2.join("\n"))
+
+      expected_output = content_1 + [''] + content_2
+      expected_output = expected_output.join("\n")
+
+      help.string.strip.must_equal expected_output
+    end
+  end
+end
+

data/test/unit/help/text_builder_test.rb

@@ -0,0 +1,140 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe HammerCLI::Help::TextBuilder do
+  let(:help) { HammerCLI::Help::TextBuilder.new }
+
+  describe '#text' do
+    it 'prints text' do
+      help.text('Lorem ipsum')
+      help.string.must_equal "Lorem ipsum\n"
+    end
+
+    it 'prints multiple blocks with spaces' do
+      help.text('Lorem ipsum')
+      help.text('Dolor sit amet')
+      help.string.must_equal [
+        'Lorem ipsum',
+        '',
+        'Dolor sit amet',
+        ''
+      ].join("\n")
+    end
+  end
+
+  describe '#section' do
+    it 'prints section heading' do
+      help.section('Heading')
+      help.string.must_equal "Heading:\n\n"
+    end
+
+    it 'indents section content' do
+      help.section('Heading') do |h|
+        h.text('Lorem ipsum')
+        h.text('Dolor sit amet')
+      end
+      help.string.must_equal [
+        'Heading:',
+        '  Lorem ipsum',
+        '',
+        '  Dolor sit amet',
+        ''
+      ].join("\n")
+    end
+  end
+
+  describe '#list' do
+    it 'prints empty list' do
+      help.list([])
+      help.string.must_equal ""
+    end
+
+    it 'prints single column list' do
+      help.list([
+        :a,
+        :bb,
+        :ccc
+      ])
+      help.string.must_equal [
+        'a',
+        'bb',
+        'ccc',
+        ''
+      ].join("\n")
+    end
+
+    it 'prints two column list' do
+      help.list([
+        [:a,   'This is line A'],
+        [:bb,  'This is line B'],
+        [:ccc]
+      ])
+      help.string.must_equal [
+        'a                   This is line A',
+        'bb                  This is line B',
+        'ccc',
+        ''
+      ].join("\n")
+    end
+
+    it 'handles multiple lines in the second column' do
+      help.list([
+        [:a,   "This is line A\nThis is line A part two"],
+        [:bb,  'This is line B'],
+        [:ccc, 'This is line C']
+      ])
+      help.string.must_equal [
+        'a                   This is line A',
+        '                    This is line A part two',
+        'bb                  This is line B',
+        'ccc                 This is line C',
+        ''
+      ].join("\n")
+    end
+
+    it 'can adjust indentation of the second column' do
+      help.list([
+        ['a',  'This is line A'],
+        ['This line B is too long for the first column',   'This is line B'],
+        ['ccc', 'This is line C']
+      ])
+      help.string.must_equal [
+        'a                                             This is line A',
+        'This line B is too long for the first column  This is line B',
+        'ccc                                           This is line C',
+        ''
+      ].join("\n")
+    end
+  end
+
+  describe '#indent' do
+    let(:text) {
+      [
+        'A',
+        'B',
+        '',
+        ' C'
+      ].join("\n")
+    }
+
+    it 'indents text' do
+      expected_result = [
+        '  A',
+        '  B',
+        '',
+        '   C'
+      ].join("\n")
+      help.indent(text).must_equal(expected_result)
+    end
+
+    it 'indents text with custom padding' do
+      expected_result = [
+        '**A',
+        '**B',
+        '**',
+        '** C'
+      ].join("\n")
+      help.indent(text, '**').must_equal(expected_result)
+    end
+  end
+end
+