hammer_cli 0.9.0 → 0.10.0

data/lib/hammer_cli/ssloptions.rb

@@ -0,0 +1,65 @@
+module HammerCLI
+  class SSLOptions
+    def initialize(settings = HammerCLI::Settings, logger = Logging.logger['SSLoptions'])
+      @settings = settings
+      @logger = logger
+    end
+
+    def self.get_options(settings = HammerCLI::Settings, logger = Logging.logger['SSLoptions'])
+      self.new(settings, logger).get_options
+    end
+
+    def get_options
+      ssl_options = {}
+      for sslopt in [:ssl_ca_file, :ssl_ca_path, :verify_ssl] do
+        ssloptval = read_ssl_option(sslopt)
+        ssl_options[sslopt] = ssloptval unless ssloptval.nil?
+      end
+      ssl_options.merge!(cert_key_options)
+
+      # enable ssl verification
+      ssl_options[:verify_ssl] = true if ssl_options[:verify_ssl].nil?
+      @logger.debug("SSL options: #{ApipieBindings::Utils::inspect_data(ssl_options)}")
+      ssl_options
+    end
+
+    protected
+
+    def read_ssl_option(key)
+      @settings.get(:_params, key).nil? ? @settings.get(:ssl, key) : @settings.get(:_params, key)
+    end
+
+    def cert_key_options
+      options = {
+        :ssl_client_cert => read_certificate(read_ssl_option(:ssl_client_cert)),
+        :ssl_client_key => read_key(read_ssl_option(:ssl_client_key))
+      }
+
+      if options[:ssl_client_cert] && options[:ssl_client_key]
+        options
+      elsif options[:ssl_client_cert] || options[:ssl_client_key]
+        if options[:ssl_client_cert]
+          warn _("SSL client certificate is set but the key is not")
+        elsif options[:ssl_client_key]
+          warn _("SSL client key is set but the certificate is not")
+        end
+        warn _("SSL client authentication disabled")
+        {}
+      else
+        {}
+      end
+    end
+
+    def read_certificate(path)
+      OpenSSL::X509::Certificate.new(File.read(path)) unless path.nil?
+    rescue SystemCallError => e
+      warn _("Could't read SSL client certificate %s") % path
+    end
+
+    def read_key(path)
+      OpenSSL::PKey::RSA.new(File.read(path)) unless path.nil?
+    rescue SystemCallError => e
+      warn _("Could't read SSL client key %s") % path
+    end
+  end
+end

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new '0.9.0'
+    @version ||= Gem::Version.new '0.10.0'
   end
 end

data/test/unit/abstract_test.rb

@@ -351,6 +351,40 @@ describe HammerCLI::AbstractCommand do
 
   end
 
+  describe 'defaults' do
+    class TestDefaultsCmd < HammerCLI::AbstractCommand
+      option '--test', 'TEST', '', :attribute_name => :different_attr_name
+      option ['--test-multi1', '--test-multi2'], 'TEST_MULTI', '', :attribute_name => :multiple_switches_option
+
+      def options
+        super
+      end
+    end
+
+    before do
+      @defaults = mock()
+      @defaults.stubs(:get_defaults).returns(nil)
+      @cmd = TestDefaultsCmd.new("", { :defaults => @defaults })
+    end
+
+    it 'provides default value for an option flag' do
+      @defaults.expects(:get_defaults).with('--test').returns(2)
+      assert_equal({'different_attr_name' => 2}, @cmd.options)
+    end
+
+    it 'prefers values from command line' do
+      @defaults.stubs(:get_defaults).with('--test').returns(2)
+      @cmd.run(['--test=1'])
+      assert_equal({'different_attr_name' => '1'}, @cmd.options)
+    end
+
+    it 'iterates over multiple switches of an option' do
+      @defaults.expects(:get_defaults).with('--test-multi1').returns(nil)
+      @defaults.expects(:get_defaults).with('--test-multi2').returns(3)
+      assert_equal({'multiple_switches_option' => 3}, @cmd.options)
+    end
+  end
+
   it "should inherit command_name" do
     class CmdName1 < HammerCLI::AbstractCommand
       command_name 'cmd'

data/test/unit/apipie/api_connection_test.rb

@@ -7,9 +7,10 @@ describe HammerCLI::Apipie::ApiConnection do
 
     let(:empty_params) {{}}
 
-    def api_stub(params = {})
+    def api_stub(params = {}, options = {})
       api_stub = stub()
-      ApipieBindings::API.expects(:new).with(params).returns(api_stub)
+      options[:verify_ssl] = true if options[:verify_ssl].nil?
+      ApipieBindings::API.expects(:new).with(params, options).returns(api_stub)
       api_stub
     end
 

data/test/unit/defaults_test.rb

@@ -29,6 +29,12 @@ describe HammerCLI::Defaults do
         assert_equal 3, defaults_result[:defaults][:location_id][:value]
         assert_equal nil, defaults_result[:defaults][:'location-id']
       end
+
+      it "should update underscored default with option syntax when dashed default is set" do
+        defaults_result = @defaults.add_defaults_to_conf({"--location-id"=> 3}, nil)
+        assert_equal 3, defaults_result[:defaults][:'location-id'][:value]
+        assert_equal nil, defaults_result[:defaults][:location_id]
+      end
     end
 
     it "Should add a default param to defaults file, with provider" do
@@ -70,8 +76,12 @@ describe HammerCLI::Defaults do
 
 
   describe '#get_defaults' do
-    it "should get the default param, without provider" do
-      assert_equal 2, @defaults.get_defaults("location_id")
+    it "should get the default param" do
+      assert_equal 2, @defaults.get_defaults("--location-id")
+    end
+
+    it "should get the default param for short flag" do
+      assert_equal 'F', @defaults.get_defaults("-f")
     end
 
     it "should get the default param, with provider" do
@@ -79,14 +89,14 @@ describe HammerCLI::Defaults do
       fake_provider.stubs(:provider_name).returns(:foreman)
       fake_provider.expects(:get_defaults).with(:organization_id).returns(3)
       @defaults.register_provider(fake_provider)
-      assert_equal 3, @defaults.get_defaults("organization_id")
+      assert_equal 3, @defaults.get_defaults("--organization-id")
     end
 
     context 'dashed params' do
       let(:filepath) { File.join(File.dirname(__FILE__), '/fixtures/defaults/defaults_dashed.yml') }
 
       it "should get the default param, without provider" do
-        assert_equal 2, @defaults.get_defaults("location_id")
+        assert_equal 2, @defaults.get_defaults("--location-id")
       end
 
       it "should get the default param, with provider" do
@@ -94,7 +104,7 @@ describe HammerCLI::Defaults do
         fake_provider.stubs(:provider_name).returns(:foreman)
         fake_provider.expects(:get_defaults).with(:organization_id).returns(3)
         @defaults.register_provider(fake_provider)
-        assert_equal 3, @defaults.get_defaults("organization_id")
+        assert_equal 3, @defaults.get_defaults("--organization-id")
       end
     end
   end

data/test/unit/fixtures/defaults/defaults.yml

@@ -4,3 +4,5 @@
     :provider: 'foreman'
   :location_id:
     :value: 2
+  :f:
+    :value: 'F'

data/test/unit/options/option_collector_test.rb

@@ -0,0 +1,29 @@
+require_relative '../test_helper'
+
+describe HammerCLI::Options::OptionCollector do
+  before do
+    recognised_options = [mock, mock]
+    source1_result = {:option1 => 1, :option2 => nil}
+    source2_result = source1_result.merge({:option3 => 3})
+
+    source1 = mock
+    source1.expects(:get_options).with(recognised_options, {}).returns(source1_result)
+
+    source2 = mock
+    source2.expects(:get_options).with(recognised_options, source1_result).returns(source2_result)
+
+    @collector = HammerCLI::Options::OptionCollector.new(recognised_options, [source1, source2])
+  end
+
+  describe '#options' do
+    it 'returns options without nil values' do
+      assert_equal({:option1 => 1, :option3 => 3}, @collector.options)
+    end
+  end
+
+  describe '#all_options' do
+    it 'returns all options' do
+      assert_equal({:option1 => 1, :option2 => nil, :option3 => 3}, @collector.all_options)
+    end
+  end
+end

data/test/unit/options/sources/command_line_test.rb

@@ -0,0 +1,36 @@
+require_relative '../../test_helper'
+
+describe HammerCLI::Options::Sources::CommandLine do
+
+  before do
+    @cmd = mock
+
+    @defined_options = [
+      stub(:read_method => :option_organization_id, :attribute_name => :organization_id),
+      stub(:read_method => :option_location_id, :attribute_name => :location_id)
+    ]
+
+    @source = HammerCLI::Options::Sources::CommandLine.new(@cmd)
+  end
+
+  describe '#get_options' do
+    it 'reads options from the command' do
+      @cmd.expects(:option_organization_id).returns(2)
+      @cmd.expects(:option_location_id).returns(3)
+
+      current_result = { :help => true }
+      expected_result = { :help => true, :organization_id => 2, :location_id => 3 }
+
+      assert_equal(expected_result, @source.get_options(@defined_options, current_result))
+    end
+
+    it 'keeps options that are already set' do
+      @cmd.expects(:option_location_id).returns(3)
+
+      current_result = { :help => true, :organization_id => 1 }
+      expected_result = { :help => true, :organization_id => 1, :location_id => 3 }
+
+      assert_equal(expected_result, @source.get_options(@defined_options, current_result))
+    end
+  end
+end

data/test/unit/options/sources/saved_defaults_test.rb

@@ -0,0 +1,59 @@
+require_relative '../../test_helper'
+
+describe HammerCLI::Options::Sources::SavedDefaults do
+  before do
+    @defaults = mock
+    @logger = stub
+    @logger.stubs(:info)
+
+    @defined_options = [
+      stub(:attribute_name => :different_attr_name, :switches => ['--test']),
+      stub(:attribute_name => :multiple_switches_option, :switches => ['--test-multi1', '--test-multi2'])
+    ]
+
+    @source = HammerCLI::Options::Sources::SavedDefaults.new(@defaults, @logger)
+  end
+
+  describe '#get_options' do
+    it 'logs message about loaded default value' do
+      @defaults.expects(:get_defaults).with('--test').returns(1)
+      @defaults.expects(:get_defaults).with('--test-multi1').returns(:first_value)
+
+      current_result = {}
+      expected_result = {
+        :different_attr_name => 1,
+        :multiple_switches_option => :first_value
+      }
+
+      @logger.expects(:info).with('Custom default value 1 was used for attribute --test')
+      @logger.expects(:info).with('Custom default value first_value was used for attribute --test-multi1')
+      @source.get_options(@defined_options, current_result)
+    end
+
+    it 'reads values for all switches' do
+      @defaults.expects(:get_defaults).with('--test').returns(1)
+      @defaults.expects(:get_defaults).with('--test-multi1').returns(nil)
+      @defaults.expects(:get_defaults).with('--test-multi2').returns(:second_value)
+
+      current_result = {}
+      expected_result = {
+        :different_attr_name => 1,
+        :multiple_switches_option => :second_value
+      }
+
+      assert_equal(expected_result, @source.get_options(@defined_options, current_result))
+    end
+
+    it 'keeps options that are already set' do
+      @defaults.expects(:get_defaults).with('--test-multi1').returns(2)
+
+      current_result = {:different_attr_name => :existing_value}
+      expected_result = {
+        :different_attr_name => :existing_value,
+        :multiple_switches_option => 2
+      }
+
+      assert_equal(expected_result, @source.get_options(@defined_options, current_result))
+    end
+  end
+end

data/test/unit/output/adapter/table_test.rb

@@ -322,33 +322,6 @@ describe HammerCLI::Output::Adapter::Table do
       end
 
     end
-
-    context "sort_columns" do
-      let(:fields) {
-        [field_firstname, field_lastname]
-      }
-
-      it "should sort output" do
-
-        table_print_output = [
-          "LASTNAME | FIRSTNAME",
-          "---------|----------",
-          "Doe      | John     "
-        ].join("\n")
-
-        expected_output = [
-          "----------|---------",
-          "FIRSTNAME | LASTNAME",
-          "----------|---------",
-          "John      | Doe     ",
-          "----------|---------",
-          ""
-        ].join("\n")
-
-        TablePrint::Printer.any_instance.stubs(:table_print).returns(table_print_output)
-        proc { adapter.print_collection(fields, data) }.must_output(expected_output)
-      end
-    end
   end
 
 end

data/test/unit/output/fields_test.rb

@@ -166,22 +166,25 @@ describe Fields::Label do
         end
       end
 
-      it "returns true when all the keys are present" do
+      it "returns true when all subfields are displayed" do
         field.display?({:a => 1, :b => 2}).must_equal true
       end
 
-      it "returns true when some of the keys are present" do
+      it "returns true when at least one or the subfields is displayed" do
         field.display?({:a => 1}).must_equal true
       end
 
-      it "returns false when there are some displayed subfields" do
-        field.display?({}).must_equal false
+      it "returns false when none of the subfieldsis displayed" do
+        field.display?({:c => 3}).must_equal false
       end
 
-      it "returns false the hash does not contain the required keys" do
-        field.display?({:c => 3}).must_equal false
+      it "returns false when the value is empty hash" do
+        field.display?({}).must_equal false
       end
 
+      it "returns false when the value is nil" do
+        field.display?(nil).must_equal false
+      end
     end
 
   end

data/test/unit/validator_test.rb

@@ -1,11 +1,5 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-
-# describe HammerCLI::OptionValidator do
-
-
-# end
-
 describe "constraints" do
 
   class FakeCmd < Clamp::Command