hammer_cli_foreman 0.9.0 → 0.10.0

data/lib/hammer_cli_foreman/exception_handler.rb

@@ -83,13 +83,42 @@ module HammerCLIForeman
       log_full_error e
     end
 
-    def handle_apipie_docloading_error(e)
-      rake_command = 'foreman-rake apipie:cache'
-      print_error _("Could not load the API description from the server") + "\n  - " +
-                  _("is the server down?") + "\n  - " +
-                  _("was '%s' run on the server when using apipie cache? (typical production settings)") % rake_command
-      log_full_error e
-      HammerCLI::EX_CONFIG
+    def ssl_cert_instructions
+      host_url = HammerCLI::Settings.get(:_params, :host) || HammerCLI::Settings.get(:foreman, :host)
+      uri = URI.parse(host_url)
+      if uri.host.nil?
+        host = '<FOREMAN_HOST>'
+        cert_name = "#{host}.crt"
+      else
+        host = uri.to_s
+        cert_name = "#{uri.host}.crt"
+      end
+
+      cmd = "hammer --fetch-ca-cert #{host}"
+
+      rh_install_cmd = "install #{cert_name} /etc/pki/ca-trust/source/anchors/"
+      rh_update_cmd = "update-ca-trust"
+      deb_install_cmd = "install #{cert_name} /usr/local/share/ca-certificates/"
+      deb_update_cmd = "update-ca-certificates"
+
+      _("Make sure you configured the correct URL and have the server's CA certificate installed on your system.") + "\n\n" +
+      _("You can use hammer to fetch the CA certificate from the server. Be aware that hammer cannot verify whether the certificate is correct and you should verify its authenticity after downloading it.") +
+      "\n\n" +
+      _("Download the certificate and save it as a CRT file as follows:") +
+      "\n\n  $ #{cmd} > #{cert_name}\n\n" +
+      _("As root install the certificate and update the list of trusted CA certificates as follows:") + "\n\n" +
+      "  " + _("on Redhat systems") +  ":\n" +
+      "  $ #{rh_install_cmd}\n" +
+      "  $ #{rh_update_cmd}\n\n" +
+      "  " + _("on Debian systems") + ":\n" +
+      "  $ #{deb_install_cmd}\n" +
+      "  $ #{deb_update_cmd}\n\n" +
+      _("Alternatively you can save the CA certificate into a custom location and use option --ssl-ca-file or corresponding setting in your configuration file.") +
+      "\n"
+    end
+
+    def rake_command
+      "foreman-rake apipie:cache"
     end
 
     private

data/lib/hammer_cli_foreman/filter.rb

@@ -41,18 +41,79 @@ module HammerCLIForeman
       build_options
     end
 
+
+    module TaxonomyCheck
+      def taxonomy_options?
+        option_location_names || option_location_ids || option_organization_names || option_organization_ids
+      end
+
+      def signal_override_usage_error
+        signal_usage_error _('Organizations and locations can be set only for overriding filters')
+      end
+
+      def self.included(base)
+        base.extend_help do |h|
+          h.section('Overriding organizations and locations') do
+            override_condition = "--override=true"
+            org_opts = '--organization[s|-ids]'
+            loc_opts = '--location[s|-ids]'
+
+            h.text(_("Filters inherit organizations and locations from its role by default. This behavior can be changed by setting %{condition}\n"+
+              "Therefore options %{org_opts} and %{loc_opts} are applicable only when the override flag is set.") % {
+              :org_opts => org_opts,
+              :loc_opts => loc_opts,
+              :condition => override_condition
+            })
+          end
+        end
+      end
+    end
+
+
     class CreateCommand < HammerCLIForeman::CreateCommand
+      include TaxonomyCheck
+
       success_message _("Permission filter for [%<resource_type>s] created")
       failure_message _("Could not create the permission filter")
 
+      def execute
+        signal_override_usage_error if !option_override && taxonomy_options?
+        super
+      end
+
       build_options
     end
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
+      include TaxonomyCheck
+
       success_message _("Permission filter for [%<resource_type>s] updated")
       failure_message _("Could not update the permission filter")
 
+      def request_params
+        params = super
+        if override?
+          # Clear taxonomies in case the filter is switching override from true to false
+          params['filter']['location_ids'] = []
+          params['filter']['organization_ids'] = []
+        end
+        params
+      end
+
+      def execute
+        signal_override_usage_error if !override? && taxonomy_options?
+        super
+      end
+
+      def override?
+        option_override || filter['override?']
+      end
+
+      def filter
+        @filter ||= HammerCLIForeman.foreman_resource!(:filters).action(:show).call({ :id => option_id }, request_headers, request_options)
+      end
+
       build_options
     end
 

data/lib/hammer_cli_foreman/host.rb

@@ -30,7 +30,7 @@ module HammerCLIForeman
         field :id, _("Id")
         field :name, _("Name")
         field nil, _("Operating System"), Fields::SingleReference, :key => :operatingsystem
-        field nil, _("Host Group"), Fields::SingleReference, :key => :hostgroup
+        field nil, _("Host Group"), Fields::SingleReference, :key => :hostgroup, :display_field => 'title'
         field :ip, _("IP")
         field :mac, _("MAC")
       end
@@ -64,7 +64,7 @@ module HammerCLIForeman
         field :name, _("Name")
         field nil, _("Organization"), Fields::SingleReference, :key => :organization, :hide_blank => true
         field nil, _("Location"), Fields::SingleReference, :key => :location, :hide_blank => true
-        field nil, _("Host Group"), Fields::SingleReference, :key => :hostgroup
+        field nil, _("Host Group"), Fields::SingleReference, :key => :hostgroup, :display_field => 'title'
         field nil, _("Compute Resource"), Fields::SingleReference, :key => :compute_resource
         field nil, _("Compute Profile"), Fields::SingleReference, :key => :compute_profile, :hide_blank => true
         field nil, _("Environment"), Fields::SingleReference, :key => :environment
@@ -235,8 +235,10 @@ module HammerCLIForeman
         super
         unless validator.any(:option_hostgroup_id, :option_hostgroup_name).exist?
           if option_managed
-            validator.all(:option_architecture_id, :option_domain_id,
-                          :option_operatingsystem_id, :option_ptable_id).required
+            validator.any(:option_architecture_name, :option_architecture_id).required
+            validator.any(:option_domain_name, :option_domain_id).required
+            validator.any(:option_operatingsystem_title, :option_operatingsystem_id).required
+            validator.any(:option_ptable_name, :option_ptable_id).required
           end
         end
       end
@@ -321,7 +323,7 @@ module HammerCLIForeman
 
       def option_power_action
         if option_force?
-          :cycle
+          :poweroff
         else
           :stop
         end

data/lib/hammer_cli_foreman/hosts/common_update_options.rb

@@ -8,7 +8,10 @@ module HammerCLIForeman
         base.option "--owner-id", "OWNER_ID", _("ID of the owner"),
           :attribute_name => :option_user_id
 
-        base.option "--root-password", "ROOT_PW", " "
+        base.option ["--root-password", "--root-pass"], "ROOT_PW",
+          _("Required if host is managed and value is not inherited from host group or default password in settings"),
+          :deprecated => { '--root-pass' => _("Use --root-password instead") }
+
         base.option "--ask-root-password", "ASK_ROOT_PW", " ",
           :format => HammerCLI::Options::Normalizers::Bool.new
 
@@ -48,7 +51,7 @@ module HammerCLIForeman
               :provision_method, :capabilities, :flavour_ref, :image_ref, :start,
               :network, :cpus, :memory, :provider, :type, :tenant_id, :image_id,
               # ----------------------------------------------------------------------------------
-              :puppet_class_ids, :host_parameters_attributes, :interfaces_attributes]
+              :puppet_class_ids, :host_parameters_attributes, :interfaces_attributes, :root_pass]
       end
 
       def self.ask_password
@@ -100,6 +103,14 @@ module HammerCLIForeman
         resolver.puppetclass_ids('option_names' => names) if names
       end
 
+      def subnet_id(name)
+        resolver.subnet_id('option_name' => name) if name
+      end
+
+      def domain_id(name)
+        resolver.domain_id('option_name' => name) if name
+      end
+
       def parameter_attributes
         return {} unless option_parameters
         option_parameters.collect do |key, value|
@@ -132,6 +143,10 @@ module HammerCLIForeman
               compute_attributes[key.gsub('compute_', '')] = nic.delete(key)
             end
           end
+          subnet_name = nic.delete('subnet')
+          nic['subnet_id'] ||= subnet_id(subnet_name) if subnet_name
+          domain_name = nic.delete('domain')
+          nic['domain_id'] ||= domain_id(domain_name) if domain_name
           nic['compute_attributes'] = compute_attributes unless compute_attributes.empty?
           nic
         end

data/lib/hammer_cli_foreman/output/fields.rb

@@ -6,9 +6,10 @@ module Fields
 
     def display?(value)
       id_key = "#{parameters[:key]}_id"
-      name_key = "#{parameters[:key]}_name"
+      display_field = parameters[:display_field] || 'name'
+      display_key = "#{parameters[:key]}_#{display_field}"
 
-      (value[name_key.to_sym] || value[name_key]) && (value[id_key.to_sym] || value[id_key])
+      (value[display_key.to_sym] || value[display_key]) && (value[id_key.to_sym] || value[id_key])
     end
   end
 

data/lib/hammer_cli_foreman/output/formatters.rb

@@ -11,11 +11,12 @@ module HammerCLIForeman::Output
         return "" if resource.nil?
 
         key = field_params[:key]
+        display_field = field_params[:display_field] || 'name'
 
         id_key = "#{key}_id"
-        name_key = "#{key}_name"
+        display_key = "#{key}_#{display_field}"
 
-        name = resource[name_key.to_sym] || resource[name_key]
+        name = resource[display_key.to_sym] || resource[display_key]
         id = resource[id_key.to_sym] || resource[id_key]
 
         context = field_params[:context] || {}

data/lib/hammer_cli_foreman/parameter.rb

@@ -48,6 +48,7 @@ module HammerCLIForeman
     class SetCommand < AbstractParameterCommand
       option "--name", "NAME", _("parameter name"), :required => true
       option "--value", "VALUE", _("parameter value"), :required => true
+      option "--hidden-value", "HIDDEN_VALUE", _("should the value be hidden"), :format => HammerCLI::Options::Normalizers::Bool.new
 
       def self.command_name(name=nil)
         (super(name) || "set-parameter").gsub('_', '-')
@@ -72,7 +73,8 @@ module HammerCLIForeman
         params = {
           "id" => get_parameter_identifier,
           "parameter" => {
-            "value" => option_value
+            "value" => option_value,
+            "hidden_value" => option_hidden_value
           }
         }.merge(base_action_params)
         HammerCLIForeman.record_to_common_format(parameter_resource.call(:update, params))
@@ -82,7 +84,8 @@ module HammerCLIForeman
         params = {
           "parameter" => {
             "name" => option_name,
-            "value" => option_value
+            "value" => option_value,
+            "hidden_value" => option_hidden_value
           }
         }.merge(base_action_params)
 

data/lib/hammer_cli_foreman/references.rb

@@ -99,7 +99,7 @@ module HammerCLIForeman
     def self.hostgroups(dsl)
       dsl.build do
         collection :hostgroups, _("Hostgroups"), :numbered => false do
-          custom_field Fields::Reference
+          custom_field Fields::Reference, :name_key => :title
         end
       end
     end

data/lib/hammer_cli_foreman/role.rb

@@ -35,7 +35,7 @@ module HammerCLIForeman
 
       def request_params
         role_id = get_resource_id(HammerCLIForeman.foreman_resource(:roles))
-        { :search => "role_id = \"#{role_id}\"" }
+        super.merge({ :search => "role_id = \"#{role_id}\"" })
       end
 
       def extend_data(filter)
@@ -71,6 +71,23 @@ module HammerCLIForeman
       build_options
     end
 
+    class CloneCommand < HammerCLIForeman::UpdateCommand
+      action :clone
+
+      def self.command_name(name = "clone")
+        super(name)
+      end
+
+      validate_options do
+        option(:option_new_name).required
+      end
+
+      success_message _("User role cloned")
+      failure_message _("Could not clone the user role")
+
+      build_options
+    end
+
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       success_message _("User role [%<name>s] deleted")

data/lib/hammer_cli_foreman/template.rb

@@ -69,7 +69,7 @@ module HammerCLIForeman
     class ListKindsCommand < HammerCLIForeman::ListCommand
 
       command_name "kinds"
-      desc _("List available config template kinds.")
+      desc _("List available provisioning template kinds.")
 
       output do
         field :name, _("Name")
@@ -88,7 +88,7 @@ module HammerCLIForeman
     class DumpCommand < HammerCLIForeman::InfoCommand
 
       command_name "dump"
-      desc _("View config template content.")
+      desc _("View provisioning template content.")
 
       def print_data(template)
         puts template["template"]
@@ -104,8 +104,8 @@ module HammerCLIForeman
         :format => HammerCLI::Options::Normalizers::File.new
       option "--type", "TYPE", _("Template type. Eg. snippet, script, provision"), :required => true
 
-      success_message _("Config template created")
-      failure_message _("Could not create the config template")
+      success_message _("Provisioning template created")
+      failure_message _("Could not create the provisioning template")
 
       include TemplateCreateUpdateCommons
 
@@ -122,8 +122,8 @@ module HammerCLIForeman
         :format => HammerCLI::Options::Normalizers::File.new
       option "--type", "TYPE", _("Template type. Eg. snippet, script, provision")
 
-      success_message _("Config template updated")
-      failure_message _("Could not update the config template")
+      success_message _("Provisioning template updated")
+      failure_message _("Could not update the provisioning template")
 
       include TemplateCreateUpdateCommons
 
@@ -136,8 +136,8 @@ module HammerCLIForeman
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
 
-      success_message _("Config template deleted")
-      failure_message _("Could not delete the config template")
+      success_message _("Provisioning template deleted")
+      failure_message _("Could not delete the provisioning template")
 
       build_options
     end
@@ -161,8 +161,8 @@ module HammerCLIForeman
       action :clone
       command_name 'clone'
 
-      success_message _('Config template cloned')
-      failure_message _('Could not clone the config template')
+      success_message _('Provisioning template cloned')
+      failure_message _('Could not clone the provisioning template')
 
       validate_options do
         option(:option_new_name).required

data/lib/hammer_cli_foreman/testing/api_expectations.rb

@@ -1,11 +1,14 @@
 module HammerCLIForeman
   module Testing
     module APIExpectations
-      class BlockMatcher < Mocha::ParameterMatchers::Base
+      class APICallMatcher < Mocha::ParameterMatchers::Base
+        attr_accessor :expected_params, :expected_resource, :expected_action, :block
+
         def initialize(resource=nil, action=nil, &block)
           @expected_resource = resource
           @expected_action = action
           @block = block if block_given?
+          @expected_params = {}
         end
 
         def matches?(actual_parameters)
@@ -17,6 +20,7 @@ module HammerCLIForeman
           result &&= (resource_name == @expected_resource.to_s) unless @expected_resource.nil?
           result &&= (action_name == @expected_action.to_s) unless @expected_action.nil?
           result &&= @block.call(params) if @block
+          result &&= assert_params(params)
           result
         end
 
@@ -26,28 +30,124 @@ module HammerCLIForeman
           blk = @block ? '&block' : '*any_argument'
           "#{res}, #{act}, #{blk}"
         end
+
+        protected
+        def assert_params(params)
+          params == deep_merge_hash(params, @expected_params)
+        end
+
+        def deep_merge_hash(h, other_h)
+          h = h.clone
+          h.merge!(other_h) do |key, old_val, new_val|
+            if old_val.is_a?(Hash) && new_val.is_a?(Hash)
+              deep_merge_hash(old_val, new_val)
+            else
+              new_val
+            end
+          end
+        end
       end
 
       module ExpectationExtensions
         def method_signature
-          "#{@note}\n  #{super}"
+          signature = "#{@note}\n  #{super}"
+          if @api_call_matcher && !@api_call_matcher.expected_params.empty?
+            signature += "\n  expected params to include: " + params_signature(@api_call_matcher.expected_params)
+          end
+          signature
+        end
+
+        def params_signature(hash)
+          JSON.pretty_generate(hash).split("\n").join("\n  ")
         end
 
         def set_note(note)
           @note = note
         end
+
+        def with_params(expected_params = {}, &block)
+          api_call_matcher.expected_params = expected_params
+          api_call_matcher.block = block if block_given?
+          self.with(api_call_matcher)
+          self
+        end
+
+        def with_action(resource, action)
+          api_call_matcher.expected_resource = resource
+          api_call_matcher.expected_action = action
+          self.with(api_call_matcher)
+          self
+        end
+
+        def api_call_matcher
+          @api_call_matcher ||= APICallMatcher.new
+        end
+      end
+
+      class APIExpectationsDecorator < SimpleDelegator
+        def initialize(api_instance = ApipieBindings::API.any_instance)
+          @api_instance = api_instance
+          super
+        end
+
+        def expects_call(resource=nil, action=nil, note=nil, &block)
+          ex = @api_instance.expects(:call_action)
+          ex.extend(ExpectationExtensions)
+          ex.with_action(resource, action).with_params(&block)
+          ex.set_note(note)
+          ex
+        end
+
+        def expects_no_call
+          @api_instance.expects(:call_action).never
+        end
+
+        def expects_search(resource=nil, search_options={}, note=nil)
+          note ||= "Find #{resource}"
+
+          if search_options.is_a?(Hash)
+            search_query = search_options.map{|k, v| "#{k} = \"#{v}\"" }.join(" or ")
+          else
+            search_query = search_options
+          end
+
+          expects_call(resource, :index, note).with_params(:search => search_query)
+        end
+      end
+
+      class TestAuthenticator < ApipieBindings::Authenticators::BasicAuth
+        attr_reader :user
+      end
+
+      class FakeApiConnection < HammerCLI::Apipie::ApiConnection
+        attr_reader :authenticator
+
+        def initialize(params, options = {})
+          @authenticator = params[:authenticator]
+          super
+        end
+      end
+
+      def api_connection(options={}, version = '1.15')
+        FakeApiConnection.new({
+          :uri => 'https://test.org',
+          :apidoc_cache_dir => "test/data/#{version}",
+          :apidoc_cache_name => 'foreman_api',
+          :authenticator => TestAuthenticator.new('admin', 'changeme'),
+          :dry_run => true
+        }.merge(options))
       end
 
       def api_expects(resource=nil, action=nil, note=nil, &block)
-        ex = ApipieBindings::API.any_instance.expects(:call_action)
-        ex.extend(ExpectationExtensions)
-        ex.with(BlockMatcher.new(resource, action, &block))
-        ex.set_note(note)
-        ex
+        APIExpectationsDecorator.new.expects_call(resource, action, note, &block)
       end
 
       def api_expects_no_call
-        ApipieBindings::API.any_instance.expects(:call_action).never
+        APIExpectationsDecorator.new.expects_no_call
+      end
+
+      def api_expects_search(resource=nil, search_options={}, note=nil)
+        APIExpectationsDecorator.new.expects_search(resource, search_options, note)
       end
 
       def index_response(items, options={})