hammer_cli_foreman 0.11.0 → 0.12.0

data/lib/hammer_cli_foreman/auth.rb

@@ -6,8 +6,8 @@ module HammerCLIForeman
       command_name "login"
       desc _("Set credentials")
 
-      option ["-u", "--username"], "USERNAME", _("username to access the remote system")
-      option ["-p", "--password"], "PASSWORD", _("password to access the remote system")
+      option ["-u", "--username"], "USERNAME", _("Username to access the remote system")
+      option ["-p", "--password"], "PASSWORD", _("Password to access the remote system")
 
       def execute
         if !(HammerCLIForeman.foreman_api_connection.authenticator.is_a?(HammerCLIForeman::Api::SessionAuthenticatorWrapper))

data/lib/hammer_cli_foreman/auth_source_ldap.rb

@@ -2,7 +2,7 @@ module HammerCLIForeman
   class AuthSourceLdap < HammerCLIForeman::Command
     resource :auth_source_ldaps
     command_name 'ldap'
-    desc _('Manage LDAP auth sources.')
+    desc _('Manage LDAP auth sources')
 
     class ListCommand < HammerCLIForeman::ListCommand
       output do
@@ -49,21 +49,21 @@ module HammerCLIForeman
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-      success_message _('Auth source [%{name}] created')
+      success_message _('Auth source [%{name}] created.')
       failure_message _('Could not create the Auth Source')
 
       build_options
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-      success_message _('Auth source [%{name}] deleted')
+      success_message _('Auth source [%{name}] deleted.')
       failure_message _('Could not delete the Auth Source')
 
       build_options
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-      success_message _('Auth source [%{name}] updated')
+      success_message _('Auth source [%{name}] updated.')
       failure_message _('Could not update the Auth Source')
 
       build_options

data/lib/hammer_cli_foreman/commands.rb

@@ -53,7 +53,7 @@ module HammerCLIForeman
       # produce [ { 'attr' => 'val' }, ... ]
       col = HammerCLI::Output::RecordCollection.new(data.map { |r| r.keys.length == 1 ? r[r.keys[0]] : r })
     else
-      raise RuntimeError.new(_("Received data of unknown format"))
+      raise RuntimeError.new(_("Received data of unknown format."))
     end
     col
   end
@@ -115,16 +115,17 @@ module HammerCLIForeman
       super(builder_params.to_hash, &nil)
     end
 
-    def get_identifier
-      @identifier ||= get_resource_id(resource)
+    def get_identifier(all_opts=all_options)
+      @identifier ||= get_resource_id(resource, :all_options => all_opts)
       @identifier
     end
 
     def get_resource_id(resource, options={})
+      all_opts = options[:all_options] || all_options
       if options[:scoped]
-        opts = resolver.scoped_options(resource.singular_name, all_options)
+        opts = resolver.scoped_options(resource.singular_name, all_opts, :single)
       else
-        opts = all_options
+        opts = all_opts
       end
       begin
         resolver.send("#{resource.singular_name}_id", opts)
@@ -137,7 +138,8 @@ module HammerCLIForeman
     end
 
     def get_resource_ids(resource, options={})
-      opts = resolver.scoped_options(resource.singular_name, all_options)
+      all_opts = options[:all_options] || all_options
+      opts = resolver.scoped_options(resource.singular_name, all_opts, :multi)
       begin
         resolver.send("#{resource.singular_name}_ids", opts)
       rescue HammerCLIForeman::MissingSearchOptions => e
@@ -164,25 +166,6 @@ module HammerCLIForeman
 
     def send_request
       transform_format(super)
-    rescue HammerCLIForeman::MissingSearchOptions => e
-
-      switches = self.class.find_options(:referenced_resource => e.resource.singular_name).map(&:long_switch)
-
-      if switches.empty?
-        error_message = _("Could not find %{resource}. Some search options were missing, please see --help.")
-      elsif switches.length == 1
-        error_message = _("Could not find %{resource}, please set option %{switches}.")
-      else
-        error_message = _("Could not find %{resource}, please set one of options %{switches}.")
-      end
-
-      raise MissingSearchOptions.new(
-        error_message % {
-          :resource => e.resource.singular_name,
-          :switches => switches.join(", ")
-        },
-        e.resource
-      )
     end
 
     def transform_format(data)
@@ -190,36 +173,14 @@ module HammerCLIForeman
     end
 
     def customized_options
-      params = options
-      # resolve all '<resource_name>_id' parameters if they are defined as options
-      # (they can be skipped using .without or .expand.except)
-      IdParamsFilter.new(:only_required => false).for_action(resource.action(action)).each do |api_param|
-        param_resource = HammerCLIForeman.param_to_resource(api_param.name)
-        if param_resource && respond_to?(HammerCLI.option_accessor_name("#{param_resource.singular_name}_id"))
-          resource_id = get_resource_id(param_resource, :scoped => true, :required => api_param.required?)
-          params[HammerCLI.option_accessor_name(api_param.name)] = resource_id if resource_id
-        end
-      end
-
-      # resolve all '<resource_name>_ids' parameters if they are defined as options
-      IdArrayParamsFilter.new(:only_required => false).for_action(resource.action(action)).each do |api_param|
-        param_resource = HammerCLIForeman.param_to_resource(api_param.name)
-        if param_resource && respond_to?(HammerCLI.option_accessor_name("#{param_resource.singular_name}_ids"))
-          resource_ids = get_resource_ids(param_resource, :scoped => true, :required => api_param.required?)
-          params[HammerCLI.option_accessor_name(api_param.name)] = resource_ids if resource_ids
-        end
-      end
-
-      # resolve 'id' parameter if it's defined as an option
-      id_option_name = HammerCLI.option_accessor_name('id')
-      params[id_option_name] ||= get_identifier if respond_to?(id_option_name)
-      params
+      # this method is deprecated and will be removed in future versions.
+      # Check option_sources for custom tuning of options
+      options
     end
 
     def request_params
       params = customized_options
       params_pruned = method_options(params)
-
       # Options defined manualy in commands are removed in method_options.
       # Manual ids are common so its handling is covered here
       id_option_name = HammerCLI.option_accessor_name('id')
@@ -227,6 +188,14 @@ module HammerCLIForeman
       params_pruned
     end
 
+    def option_sources
+      sources = super
+      sources << HammerCLIForeman::OptionSources::IdParams.new(self)
+      sources << HammerCLIForeman::OptionSources::IdsParams.new(self)
+      sources << HammerCLIForeman::OptionSources::SelfParam.new(self)
+      sources
+    end
+
     private
 
     def resource_search_requested(resource, options, plural=false)
@@ -237,7 +206,6 @@ module HammerCLIForeman
       end
       !(filed_options & searchable_options).empty?
     end
-
   end
 
 
@@ -506,11 +474,11 @@ module HammerCLIForeman
     end
 
     def self.failure_message(msg = nil)
-      super(msg) || default_message(_('Could not associate the %{resource_name}'))
+      super(msg) || default_message(_('Could not associate the %{resource_name}.'))
     end
 
     def self.success_message(msg = nil)
-      super(msg) || default_message(_('The %{resource_name} has been associated'))
+      super(msg) || default_message(_('The %{resource_name} has been associated.'))
     end
 
     def get_new_ids
@@ -544,11 +512,11 @@ module HammerCLIForeman
     end
 
     def self.failure_message(msg = nil)
-      super(msg) || default_message(_('Could not disassociate the %{resource_name}'))
+      super(msg) || default_message(_('Could not disassociate the %{resource_name}.'))
     end
 
     def self.success_message(msg = nil)
-      super(msg) || default_message(_('The %{resource_name} has been disassociated'))
+      super(msg) || default_message(_('The %{resource_name} has been disassociated.'))
     end
   end
 end

data/lib/hammer_cli_foreman/common_parameter.rb

@@ -19,14 +19,14 @@ module HammerCLIForeman
     class SetCommand < HammerCLIForeman::Command
 
       command_name "set"
-      desc _("Set a global parameter.")
+      desc _("Set a global parameter")
 
       success_message_for :create, _("Created parameter [%{name}] with value [%{value}].")
       success_message_for :update, _("Parameter [%{name}] updated to [%{value}].")
 
-      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
+      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 action
         @action ||= parameter_exist? ? :update : :create
@@ -65,4 +65,4 @@ module HammerCLIForeman
   end
 end
 
-HammerCLI::MainCommand.subcommand 'global-parameter', _("Manipulate global parameters."), HammerCLIForeman::CommonParameter
+HammerCLI::MainCommand.subcommand 'global-parameter', _("Manipulate global parameters"), HammerCLIForeman::CommonParameter

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -70,19 +70,31 @@ module HammerCLIForeman
 
     class CreateCommand < HammerCLIForeman::CreateCommand
 
-      success_message _("Compute resource created")
+      VALIDATION_PER_PROVIDER = {
+        'libvirt'   => [:option_url],
+        'ovirt'     => [:option_url, :option_user, :option_password, :option_datacenter],
+        'openstack' => [:option_url, :option_user, :option_password],
+        'racksapce' => [:option_url],
+        'ec2'       => [:option_region, :option_user, :option_password],
+        'vmware'    => [:option_user, :option_password, :option_datacenter, :option_server]
+      }
+
+      success_message _("Compute resource created.")
       failure_message _("Could not create the compute resource")
 
       build_options
 
       validate_options do
-        all(:option_name, :option_url, :option_provider).required
+        required_options = (VALIDATION_PER_PROVIDER[
+          option(:option_provider).value.to_s.downcase
+        ] || []).unshift(:option_name, :option_provider).uniq
+
+        all(*required_options).required
       end
     end
 
-
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-      success_message _("Compute resource updated")
+      success_message _("Compute resource updated.")
       failure_message _("Could not update the compute resource")
 
       build_options :without => :name
@@ -90,7 +102,7 @@ module HammerCLIForeman
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-      success_message _("Compute resource deleted")
+      success_message _("Compute resource deleted.")
       failure_message _("Could not delete the compute resource")
 
       build_options
@@ -126,5 +138,3 @@ module HammerCLIForeman
   end
 
 end
-
-

data/lib/hammer_cli_foreman/config_group.rb

@@ -20,21 +20,21 @@ module HammerCLIForeman
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-      success_message _("Config group created")
+      success_message _("Config group created.")
       failure_message _("Could not create the config group")
 
       build_options
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-      success_message _("Config group updated")
+      success_message _("Config group updated.")
       failure_message _("Could not update the config group")
 
       build_options
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-      success_message _("Config group has been deleted")
+      success_message _("Config group has been deleted.")
       failure_message _("Could not delete the config group")
 
       build_options

data/lib/hammer_cli_foreman/domain.rb

@@ -54,7 +54,7 @@ module HammerCLIForeman
     class CreateCommand < HammerCLIForeman::CreateCommand
       include DomainUpdateCreateCommons
 
-      success_message _("Domain [%{name}] created")
+      success_message _("Domain [%{name}] created.")
       failure_message _("Could not create the domain")
 
       option "--description", "DESC", _("Full name describing the domain"), :attribute_name => :option_fullname
@@ -65,7 +65,7 @@ module HammerCLIForeman
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       include DomainUpdateCreateCommons
 
-      success_message _("Domain [%{name}] updated")
+      success_message _("Domain [%{name}] updated.")
       failure_message _("Could not update the domain")
 
       option "--description", "DESC", _("Full name describing the domain"), :attribute_name => :option_fullname
@@ -75,7 +75,7 @@ module HammerCLIForeman
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
 
-      success_message _("Domain [%{name}] deleted")
+      success_message _("Domain [%{name}] deleted.")
       failure_message _("Could not delete the domain")
 
       build_options
@@ -83,7 +83,7 @@ module HammerCLIForeman
 
 
     class SetParameterCommand < HammerCLIForeman::Parameter::SetCommand
-      desc _("Create or update parameter for a domain.")
+      desc _("Create or update parameter for a domain")
 
       success_message_for :update, _("Domain parameter updated")
       success_message_for :create, _("New domain parameter created")
@@ -99,9 +99,9 @@ module HammerCLIForeman
 
 
     class DeleteParameterCommand < HammerCLIForeman::Parameter::DeleteCommand
-      desc _("Delete parameter for a domain.")
+      desc _("Delete parameter for a domain")
 
-      success_message _("Domain parameter deleted")
+      success_message _("Domain parameter deleted.")
 
       def validate_options
         super
@@ -115,5 +115,3 @@ module HammerCLIForeman
   end
 
 end
-
-

data/lib/hammer_cli_foreman/environment.rb

@@ -31,7 +31,7 @@ module HammerCLIForeman
 
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-      success_message _("Environment created")
+      success_message _("Environment created.")
       failure_message _("Could not create the environment")
 
       build_options
@@ -39,7 +39,7 @@ module HammerCLIForeman
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-      success_message _("Environment updated")
+      success_message _("Environment updated.")
       failure_message _("Could not update the environment")
 
       build_options
@@ -47,7 +47,7 @@ module HammerCLIForeman
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-      success_message _("Environment deleted")
+      success_message _("Environment deleted.")
       failure_message _("Could not delete the environment")
 
       build_options

data/lib/hammer_cli_foreman/exception_handler.rb

@@ -11,6 +11,7 @@ module HammerCLIForeman
         [RestClient::Forbidden, :handle_forbidden],
         [RestClient::UnprocessableEntity, :handle_unprocessable_entity],
         [RestClient::MovedPermanently, :handle_moved_permanently],
+        [RestClient::BadRequest, :handle_bad_request],
         [HammerCLIForeman::Api::UnauthorizedError, :handle_foreman_unauthorized],
         [HammerCLIForeman::Api::SessionExpired, :handle_sesion_expired],
         [ArgumentError, :handle_argument_error],
@@ -42,8 +43,8 @@ module HammerCLIForeman
       error = [_("Redirection of API call detected.")]
       https_message = _("It seems hammer is configured to use HTTP and the server prefers HTTPS.")
       error << https_message if strip_protocol(e.response.headers[:location]) == strip_protocol(e.response.request.url)
-      error << _("Update your server url configuration")
-      error << _("you can set 'follow_redirects' to one of :default or :always to enable redirects following")
+      error << _("Update your server url configuration.")
+      error << _("You can set 'follow_redirects' to one of :default or :always to enable redirects following.")
       print_error error.join("\n")
       log_full_error e
       HammerCLI::EX_CONFIG
@@ -64,7 +65,16 @@ module HammerCLIForeman
 
 
     def handle_forbidden(e)
-      print_error _("Forbidden - server refused to process the request")
+      if e.response
+        response = JSON.parse(e.response)
+        error = response['error']
+        if error && error['message'] && error['details']
+          message = error['message'] + "\n" + error['details']
+        end
+      end
+      message ||= _("Forbidden - server refused to process the request.")
+
+      print_error message
       log_full_error e
       HammerCLI::EX_NOPERM
     end
@@ -96,6 +106,12 @@ module HammerCLIForeman
       log_full_error e
     end
 
+    def handle_bad_request(e)
+      print_error "#{e.message}#{response_message(e.response)}"
+      log_full_error e
+      HammerCLI::EX_DATAERR
+    end
+
     def ssl_cert_instructions
       host_url = HammerCLI::Settings.get(:_params, :host) || HammerCLI::Settings.get(:foreman, :host)
       uri = URI.parse(host_url)
@@ -114,7 +130,7 @@ module HammerCLIForeman
         instructions = _("The following configuration option were used for the SSL connection:" ) + "\n"
         instructions << "  ssl_ca_path = #{ssl_option[:ssl_ca_path]}\n" unless ssl_option[:ssl_ca_path].nil?
         instructions << "  ssl_ca_file = #{ssl_option[:ssl_ca_file]}\n" unless ssl_option[:ssl_ca_file].nil?
-        instructions << "\n" + _("Make sure the location contains an unexpired and valid CA certificate for #{host_url}")
+        instructions << "\n" + _("Make sure the location contains an unexpired and valid CA certificate for %s.") % host_url
       else
         instructions = _("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.")
         instructions << "\n\n" + _("Download the certificate as follows:")
@@ -131,6 +147,13 @@ module HammerCLIForeman
 
     private
 
+    def response_message(response)
+      message = JSON.parse(response)["error"]["message"]
+      "\n  #{message}"
+    rescue JSON::ParserError
+      ''
+    end
+
     def strip_protocol(url)
       url.gsub(%r'^http(s)?://','').gsub(%r'//', '/')
     end