hammer_cli_foreman 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71742ee24003cbea249ed6b8fcc320a387f0cda6
-  data.tar.gz: 28009f6cd73936556d260a41d2867ad556fc4dfb
+  metadata.gz: 7c465b8794294776b0e5c79cad51f615097d8731
+  data.tar.gz: f5fb6f3c7d7bc2a30d3aefdcff70b7f53697225d
 SHA512:
-  metadata.gz: 4d28c63a5bbef34bd0366537402327574bf25df138b52e73acaa63033a089f90d774869a33919a81f985a4bc8448c46b5b1ba1ffda74b0491ec198e6f9f2bcbb
-  data.tar.gz: 4488cc268352a448ad178da5f76d4e1508391ad4d2a1a46cf6f7721c4b47b03a584f50163969ff39313498ace2dbe66ef16ebff5bbdf7abbb007bd5c086acb0b
+  metadata.gz: 65664eb6db87d9aad63d1b02474e5511bd45824e07f65f648e27bbc5d6092c4c7a53a56f5775cb2f19587a477e73e7771119304e74f1d588eb9d6c7ba09aa9a2
+  data.tar.gz: 386f80dc7f518c543c863228bdc0b73cdaa1ad1b128cbf4b72aa2413ce69d9f91e5a1c9fc1149f935d772042cdd29702d9ed9ad2bf9b3822fbd853638b6fdea6

data/doc/release_notes.md

@@ -1,6 +1,24 @@
 Release notes
 =============
 
+### 0.1.4 (2014-12-11)
+* sending puppet class ids ([#8651](http://projects.theforeman.org/issues/8651))
+* setting --puppet-class-ids on host create/update throws api exception ([#8642](http://projects.theforeman.org/issues/8642))
+* adding name equivalents to params in host/hostgroup create/update ([#8299](http://projects.theforeman.org/issues/8299))
+* id resolution for associted resources ([#8246](http://projects.theforeman.org/issues/8246))
+* added missing search option error message ([#5556](http://projects.theforeman.org/issues/5556))
+* OSs referenced by title ([#8247](http://projects.theforeman.org/issues/8247))
+* credentials definition moved to ApipieBindings ([#7408](http://projects.theforeman.org/issues/7408))
+* listing filters for roles always fail with an exception ([#7913](http://projects.theforeman.org/issues/7913))
+* api for operating systems now uses field 'title' ([#7917](http://projects.theforeman.org/issues/7917))
+* i18n - add zh_CN language
+* i18n - add de, it, pt_BR, zh_TW, ru, ja, ko languages
+* external user groups CLI ([#6879](http://projects.theforeman.org/issues/6879))
+* moved LDAP auth sources to separate command
+* adds command to manage ldap auth sources ([#2924](http://projects.theforeman.org/issues/2924))
+* avoid locale domain name conflict ([#7262](http://projects.theforeman.org/issues/7262))
+
+
 ### 0.1.3 (2014-08-20)
 * Update foreman.yml
 * Update the zanata.xml file to push to de-DE and es-ES ([#7112](http://projects.theforeman.org/issues/7112))

data/lib/hammer_cli_foreman.rb

@@ -35,6 +35,10 @@ module HammerCLIForeman
       'HammerCLIForeman::Architecture', 'hammer_cli_foreman/architecture'
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('auth-source', _("Manipulate auth sources."),
+      'HammerCLIForeman::AuthSource', 'hammer_cli_foreman/auth_source'
+    )
+
     HammerCLI::MainCommand.lazy_subcommand('compute-resource', _("Manipulate compute resources."),
       'HammerCLIForeman::ComputeResource', 'hammer_cli_foreman/compute_resource'
     )

data/lib/hammer_cli_foreman/auth_source.rb

@@ -0,0 +1,10 @@
+require 'hammer_cli_foreman/auth_source_ldap'
+
+module HammerCLIForeman
+
+  class AuthSource < HammerCLIForeman::Command
+
+    subcommand 'ldap', HammerCLIForeman::AuthSourceLdap.desc, HammerCLIForeman::AuthSourceLdap
+  end
+
+end

data/lib/hammer_cli_foreman/auth_source_ldap.rb

@@ -0,0 +1,70 @@
+module HammerCLIForeman
+
+  class AuthSourceLdap < HammerCLIForeman::Command
+
+    resource :auth_source_ldaps
+    command_name 'ldap'
+    desc _("Manage LDAP auth sources.")
+
+
+    class ListCommand < HammerCLIForeman::ListCommand
+
+      output do
+        field :id                , _("Id")
+        field :name              , _("Name")
+        field :tls               , _('LDAPS?')
+        field :port              , _('Port')
+        field :type              , _("Server Type")
+      end
+
+      build_options
+    end
+
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+
+      output ListCommand.output_definition do
+        field :account           , _('Account Username')
+        field :base_dn           , _('Base DN')
+        field :ldap_filter       , _('LDAP filter')
+        field :onthefly_register , _('Automatically Create Accounts?')
+        field :attr_login        , _('Login Name Attribute')
+        field :attr_firstname    , _('First Name Attribute')
+        field :attr_lastname     , _('Last Name Attribute')
+        field :attr_mail         , _('Email Address Attribute')
+        field :attr_photo        , _('Photo Attribute')
+      end
+
+      build_options
+    end
+
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _("Auth source created")
+      failure_message _("Could not create the Auth Source")
+
+      build_options
+    end
+
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _("Auth source deleted")
+      failure_message _("Could not delete the Auth Source")
+
+      build_options
+    end
+
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _("Auth source updated")
+      failure_message _("Could not update the Auth Source")
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+
+end
+
+

data/lib/hammer_cli_foreman/commands.rb

@@ -3,11 +3,16 @@ module HammerCLIForeman
   CONNECTION_NAME = 'foreman'
 
   RESOURCE_NAME_MAPPING = {
-    :usergroup => :user_group
+    :usergroup => :user_group,
+    :usergroups => :user_groups,
+    :ptable => :partition_table,
+    :ptables => :partition_tables,
+    :puppetclass => :puppet_class,
+    :puppetclasses => :puppet_classes
   }
 
   def self.credentials
-    @credentials ||= Credentials.new(
+    @credentials ||= BasicCredentials.new(
       :username => (HammerCLI::Settings.get(:_params, :username) || ENV['FOREMAN_USERNAME'] || HammerCLI::Settings.get(:foreman, :username)),
       :password => (HammerCLI::Settings.get(:_params, :password) || ENV['FOREMAN_PASSWORD'] || HammerCLI::Settings.get(:foreman, :password))
     )
@@ -25,6 +30,7 @@ module HammerCLIForeman
     config[:language] = HammerCLI::I18n.locale
     config[:timeout] = HammerCLI::Settings.get(:foreman, :request_timeout)
     config[:timeout] = -1 if (config[:timeout] && config[:timeout].to_i < 0)
+    config[:apidoc_authenticated] = false
     config
   end
 
@@ -54,7 +60,7 @@ module HammerCLIForeman
   end
 
   def self.param_to_resource(param_name)
-    HammerCLIForeman.foreman_resource(param_name.gsub(/_id$/, ""), :singular => true)
+    HammerCLIForeman.foreman_resource(param_name.gsub(/_id[s]?$/, ""), :singular => true)
   end
 
   def self.collection_to_common_format(data)
@@ -146,6 +152,15 @@ module HammerCLIForeman
       end
     end
 
+    def get_resource_ids(resource, options={})
+      opts = resolver.scoped_options(resource.singular_name, all_options)
+      begin
+        resolver.send("#{resource.singular_name}_ids", opts)
+      rescue HammerCLIForeman::MissingSeachOptions => e
+        raise e unless (options[:required] == false)
+      end
+    end
+
     def self.resolver
       api = HammerCLI::Connection.get("foreman").api
       HammerCLIForeman::IdResolver.new(api, HammerCLIForeman::Searchables.new)
@@ -162,6 +177,25 @@ module HammerCLIForeman
 
     def send_request
       HammerCLIForeman.record_to_common_format(super)
+    rescue HammerCLIForeman::MissingSeachOptions => 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 MissingSeachOptions.new(
+        error_message % {
+          :resource => e.resource.singular_name,
+          :switches => switches.join(", ")
+        },
+        e.resource
+      )
     end
 
     def customized_options
@@ -175,6 +209,16 @@ module HammerCLIForeman
           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)

data/lib/hammer_cli_foreman/credentials.rb

@@ -1,18 +1,36 @@
+require 'highline/import'
 module HammerCLIForeman
-  class Credentials < HammerCLI::Apipie::AbstractCredentials
+  class BasicCredentials < ApipieBindings::AbstractCredentials
 
+    # Can keep username and passwords credentials and prompt for them when necessary
+    # @param [Hash] params
+    # @option params [String] :username when nil, user is prompted when the attribute is accessed
+    # @option params [String] :password when nil, user is prompted when the attribute is accessed
+    # @example use container with prompt
+    #   c = HammerCLIForeman::BasicCredentials.new()
+    #   c.username
+    #   > [Foreman] Username: admin
+    #   => "admin"
+    # @example use container with preset value
+    #   c = HammerCLIForeman::BasicCredentials.new(:username => 'admin')
+    #   c.username
+    #   => "admin"
     def initialize(params={})
       @username = params[:username]
       @password = params[:password]
     end
 
+    # Get username. Prompt for it when not set
+    # @return [String]
     def username
-      @username ||= ask_user(_("[Foreman] username: ")) if HammerCLI.interactive?
+      @username ||= ask_user(_("[Foreman] Username: ")) if HammerCLI.interactive?
       @username
     end
 
+    # Get password. Prompt for it when not set. Password characters are replaced with asterisks on the screen.
+    # @return [String]
     def password
-      @password ||= ask_user(_("[Foreman] password for %s: ") % @username, true) if HammerCLI.interactive?
+      @password ||= ask_user(_("[Foreman] Password for %s: ") % username, true) if HammerCLI.interactive?
       @password
     end
 
@@ -21,16 +39,29 @@ module HammerCLIForeman
     end
 
     def clear
+      super
       @username = nil
       @password = nil
     end
 
+    # Convert credentials to hash usable for merging to RestClient configuration.
+    # @return [Hash]
     def to_params
       {
-        :username => username,
+        :user => username,
         :password => password
       }
     end
 
+    private
+
+    def ask_user(prompt, silent=false)
+      if silent
+        ask(prompt) {|q| q.echo = false}
+      else
+        ask(prompt)
+      end
+    end
+
   end
 end

data/lib/hammer_cli_foreman/exceptions.rb

@@ -3,7 +3,16 @@ module HammerCLIForeman
   class OperationNotSupportedError < StandardError; end
 
   # Resolver exceptions
-  class ResolverError < StandardError; end
+  class ResolverError < StandardError
+
+    attr_reader :resource
+
+    def initialize(msg, resource)
+      @resource = resource
+      super(msg)
+    end
+  end
+
   class MissingSeachOptions < ResolverError; end
 
 end

data/lib/hammer_cli_foreman/external_usergroup.rb

@@ -0,0 +1,83 @@
+require 'hammer_cli_foreman/usergroup'
+
+module HammerCLIForeman
+  class ExternalUsergroup < HammerCLIForeman::Command
+    resource :external_usergroups
+    desc _("View and manage user group's external user groups")
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _("Id")
+        field :name, _("Name")
+        field :_auth_source, _("Auth source"), Fields::Reference
+      end
+
+      def extend_data(record)
+        key = record.keys.find{ |k| k =~ /^auth_source/ }
+        record['_auth_source'] = record[key]
+        record
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition
+
+      def extend_data(record)
+        key = record.keys.find{ |k| k =~ /^auth_source/ }
+        record['_auth_source'] = record[key]
+        record
+      end
+
+      build_options
+    end
+
+    class RefreshExternalUsergroupsCommand < HammerCLIForeman::ListCommand
+      action :refresh
+      command_name 'refresh'
+      desc _("Refresh external user group")
+
+      output do
+        field :name, _("Name")
+        field :_auth_source, _("Auth source")
+      end
+
+      def extend_data(record)
+        key = record.keys.find{ |k| k =~ /^auth_source/ }
+        record['_auth_source'] = record[key]
+        record
+      end
+
+      build_options
+    end
+
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _("External user group created")
+      failure_message _("Could not create external user group")
+
+      build_options
+    end
+
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _("External user group updated")
+      failure_message _("Could not update external user group")
+
+      build_options
+    end
+
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _("External user group deleted")
+      failure_message _("Could not delete the external user group")
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+
+end
+

data/lib/hammer_cli_foreman/host.rb

@@ -9,19 +9,22 @@ module HammerCLIForeman
   module CommonHostUpdateOptions
 
     def self.included(base)
-      base.option "--environment-id", "ENVIRONMENT_ID", " "
-      base.option "--architecture-id", "ARCHITECTURE_ID", " "
-      base.option "--domain-id", "DOMAIN_ID", " "
-      base.option "--puppet-proxy-id", "PUPPET_PROXY_ID", " "
-      base.option "--operatingsystem-id", "OPERATINGSYSTEM_ID", " "
-      base.option "--partition-table-id", "PARTITION_TABLE_ID", " "
-      base.option "--compute-resource-id", "COMPUTE_RESOURCE", " "
-      base.option "--puppetclass-ids", "PUPPETCLASS_IDS", " ",
-        :format => HammerCLI::Options::Normalizers::List.new
+      base.option "--owner", "OWNER_LOGIN", _("Login of the owner"),
+        :attribute_name => :option_user_login
+      base.option "--owner-id", "OWNER_ID", _("ID of the owner"),
+        :attribute_name => :option_user_id
+
       base.option "--root-password", "ROOT_PW", " "
       base.option "--ask-root-password", "ASK_ROOT_PW", " ",
         :format => HammerCLI::Options::Normalizers::Bool.new
 
+      base.option "--puppet-proxy", "PUPPET_PROXY_NAME", ""
+      base.option "--puppet-ca-proxy", "PUPPET_CA_PROXY_NAME", ""
+      base.option "--puppet-class-ids", "PUPPET_CLASS_IDS", "",
+        :format => HammerCLI::Options::Normalizers::List.new,
+        :attribute_name => :option_puppetclass_ids
+      base.option "--puppet-classes", "PUPPET_CLASS_NAMES", "",
+        :format => HammerCLI::Options::Normalizers::List.new
 
       bme_options = {}
       bme_options[:default] = 'true' if base.action.to_sym == :create
@@ -45,16 +48,11 @@ module HammerCLIForeman
         :format => HammerCLI::Options::Normalizers::Enum.new(['build', 'image'])
 
       base.build_options :without => [
-            # - temporarily disabled params until they are fixed in API ------------------------
-            # issue #3884
-            :puppet_class_ids,
             # - temporarily disabled params that will be removed from the api ------------------
             :provision_method, :capabilities, :flavour_ref, :image_ref, :start,
             :network, :cpus, :memory, :provider, :type, :tenant_id, :image_id,
-            # - avoids future conflicts as :root_pass is currently missing in the api docs
-            :root_pass,
             # ----------------------------------------------------------------------------------
-            :ptable_id, :host_parameters_attributes]
+            :puppet_class_ids, :host_parameters_attributes]
     end
 
     def self.ask_password
@@ -64,15 +62,14 @@ module HammerCLIForeman
 
     def request_params
       params = super
+      params['host']['owner_id'] ||= get_resource_id(HammerCLIForeman.foreman_resource(:users), :required => false, :scoped => true)
+      params['host']['puppet_proxy_id'] ||= proxy_id(option_puppet_proxy)
+      params['host']['puppet_ca_proxy_id'] ||= proxy_id(option_puppet_ca_proxy)
+      params['host']['puppetclass_ids'] = option_puppetclass_ids || puppet_class_ids(option_puppet_classes)
 
       params['host']['build'] = option_build unless option_build.nil?
       params['host']['managed'] = option_managed unless option_managed.nil?
       params['host']['enabled'] = option_enabled unless option_enabled.nil?
-
-      params['host']['puppetclass_ids'] = option_puppetclass_ids unless option_puppetclass_ids.nil?
-
-      params['host']['ptable_id'] = option_partition_table_id unless option_partition_table_id.nil?
-      params['host']['compute_resource_id'] = option_compute_resource_id unless option_compute_resource_id.nil?
       params['host']['host_parameters_attributes'] = parameter_attributes
       params['host']['compute_attributes'] = option_compute_attributes || {}
       params['host']['compute_attributes']['volumes_attributes'] = nested_attributes(option_volume_list)
@@ -88,12 +85,19 @@ module HammerCLIForeman
       if option_ask_root_password
         params['host']['root_pass'] = HammerCLIForeman::CommonHostUpdateOptions::ask_password
       end
-
       params
     end
 
     private
 
+    def proxy_id(name)
+      resolver.smart_proxy_id('option_name' => name) if name
+    end
+
+    def puppet_class_ids(names)
+      resolver.puppetclass_ids('option_names' => names) if names
+    end
+
     def parameter_attributes
       return {} unless option_parameters
       option_parameters.collect do |key, value|
@@ -327,7 +331,7 @@ module HammerCLIForeman
           if option_managed
             validator.all(:option_environment_id, :option_architecture_id, :option_domain_id,
                           :option_puppet_proxy_id, :option_operatingsystem_id,
-                          :option_partition_table_id).required
+                          :option_ptable_id).required
           else
             # unmanaged host only requires environment
             validator.option(:option_environment_id).required