hammer_cli_foreman 0.1.1 → 0.1.2

data/lib/hammer_cli_foreman/host.rb

@@ -149,7 +149,7 @@ module HammerCLIForeman
       end
 
       def get_parameters(host_id)
-        params = HammerCLIForeman.foreman_resource(:parameters).call(:index, :host_id => host_id)
+        params = HammerCLIForeman.foreman_resource!(:parameters).call(:index, :host_id => host_id)
         HammerCLIForeman.collection_to_common_format(params)
       end
 
@@ -323,7 +323,7 @@ module HammerCLIForeman
 
       def validate_options
         super
-        unless validator.option(:option_hostgroup_id).exist?
+        unless validator.any(:option_hostgroup_id, :option_hostgroup_name).exist?
           if option_managed
             validator.all(:option_environment_id, :option_architecture_id, :option_domain_id,
                           :option_puppet_proxy_id, :option_operatingsystem_id,
@@ -395,7 +395,7 @@ module HammerCLIForeman
       end
 
       def request_params
-        params = method_options
+        params = super
         params['id'] = get_identifier
         params
       end
@@ -429,7 +429,7 @@ module HammerCLIForeman
       end
 
       def request_params
-        params = method_options
+        params = super
         params['id'] = get_identifier
         params
       end
@@ -449,7 +449,7 @@ module HammerCLIForeman
       end
 
       def request_params
-        params = method_options
+        params = super
         params['id'] = get_identifier
         params
       end
@@ -466,5 +466,3 @@ module HammerCLIForeman
   end
 
 end
-
-HammerCLI::MainCommand.subcommand 'host', ("Manipulate hosts."), HammerCLIForeman::Host

data/lib/hammer_cli_foreman/hostgroup.rb

@@ -1,11 +1,12 @@
 require 'hammer_cli_foreman/smart_class_parameter'
+require 'hammer_cli_foreman/puppet_class'
 
 module HammerCLIForeman
 
   module HostgroupUpdateCreateCommons
 
     def request_params
-      params = method_options
+      params = super
       params['hostgroup']['puppetclass_ids'] = option_puppetclass_ids
       params
     end
@@ -99,7 +100,7 @@ module HammerCLIForeman
       end
 
       def request_params
-        params = method_options
+        params = super
         params['hostgroup_id'] = get_identifier
         params
       end
@@ -138,4 +139,4 @@ module HammerCLIForeman
 
 end
 
-HammerCLI::MainCommand.subcommand 'hostgroup', _("Manipulate hostgroups."), HammerCLIForeman::Hostgroup
+

data/lib/hammer_cli_foreman/id_resolver.rb

@@ -18,13 +18,45 @@ module HammerCLIForeman
 
   class Searchables
 
+    protected
+
+    def self.s(name, description, options={})
+      Searchable.new(name, description, options)
+    end
+
+    def self.s_name(description, options={})
+      s("name", description, options)
+    end
+
     SEARCHABLES = {
-      :user => [ Searchable.new("login", _("User's login to search by")) ],
-      :template => [],
-      :image => [],
-      :operatingsystem => []
+      :architecture =>     [ s_name(_("Architecture name")) ],
+      :compute_resource => [ s_name(_("Compute resource name")) ],
+      :domain =>           [ s_name(_("Domain name")) ],
+      :environment =>      [ s_name(_("Environment name")) ],
+      :fact_value =>       [],
+      :filter =>           [],
+      :host =>             [ s_name(_("Host name")) ],
+      :hostgroup =>        [ s_name(_("Hostgroup name")) ],
+      :image =>            [],
+      :location =>         [ s_name(_("Location name")) ],
+      :medium =>           [ s_name(_("Medium name")) ],
+      :model =>            [ s_name(_("Model name")) ],
+      :organization =>     [ s_name(_("Organization name")) ],
+      :operatingsystem =>  [],
+      :ptable =>           [ s_name(_("Partition table name")) ],
+      :proxy =>            [ s_name(_("Proxy name")) ],
+      :puppetclass =>      [ s_name(_("Puppet class name")) ],
+      :report =>           [ s_name(_("Report name")) ],
+      :role =>             [ s_name(_("User role name")) ],
+      :subnet =>           [ s_name(_("Subnet name")) ],
+      :template =>         [],
+      :user =>             [ s("login", _("User's login to search by")) ],
+      :common_parameter =>      [ s_name(_("Common parameter name")) ],
+      :smart_class_parameter => [ s_name(_("Smart class parameter name")) ]
     }
-    DEFAULT_SEARCHABLES = [ Searchable.new("name", _("Name to search by")) ]
+    DEFAULT_SEARCHABLES = [ s_name(_("Name to search by")) ]
+
+    public
 
     def for(resource)
       SEARCHABLES[resource.singular_name.to_sym] || DEFAULT_SEARCHABLES
@@ -43,59 +75,31 @@ module HammerCLIForeman
     end
 
     def scoped_options(scope, options)
-      prefix = HammerCLI.option_accessor_name("#{scope}_")
-      plain_prefix = HammerCLI.option_accessor_name("")
-
       scoped_options = options.dup
-      options.each do |k, v|
-        if k.start_with? prefix
-          # remove the scope
-          # e.g. option_architecture_id -> option_id
-          scoped_options[k.sub(prefix, plain_prefix)] = v
-          scoped_options.delete(k)
+
+      resource = HammerCLIForeman.param_to_resource(scope)
+      return scoped_options unless resource
+
+      option_names = searchables(resource).map { |s| s.name }
+      option_names << "id"
+
+      option_names.each do |name|
+        option = HammerCLI.option_accessor_name(name)
+        scoped_option = HammerCLI.option_accessor_name("#{scope}_#{name}")
+        # remove the scope
+        # e.g. option_architecture_id -> option_id
+        if scoped_options[scoped_option]
+          scoped_options[option] = scoped_options.delete(scoped_option)
+        else
+          scoped_options.delete(option)
         end
       end
       scoped_options
     end
 
-    def dependent_resources(resource, options={})
-      options[:required] = (options[:required] == true)
-      options[:recursive] = !(options[:recursive] == false)
-
-      resolve_dependent_resources(resource, [], options)
-    end
-
-    def id_params(action, options={})
-      required = !(options[:required] == false)
-
-      params = action.params.reject{ |p| !(p.name.end_with?("_id")) }
-      params = params.reject{ |p| !(p.required?) } if required
-      params
-    end
-
-    def param_to_resource(param_name)
-      resource_name = param_name.gsub(/_id$/, "")
-      resource_name = ApipieBindings::Inflector.pluralize(resource_name.to_s).to_sym
-      begin
-        @api.resource(resource_name)
-      rescue NameError
-        nil
-      end
-    end
 
     protected
 
-    def resolve_dependent_resources(resource, resources_found, options)
-      id_params(resource.action(:index), :required => options[:required]).each do |param|
-        res = param_to_resource(param.name)
-        if res and !resources_found.map(&:name).include?(res.name)
-          resources_found << res
-          resolve_dependent_resources(res, resources_found, options) if options[:recursive]
-        end
-      end
-      resources_found
-    end
-
     def define_id_finders
       @api.resources.each do |resource|
         method_name = "#{resource.singular_name}_id"
@@ -114,7 +118,7 @@ module HammerCLIForeman
       resource = @api.resource(resource_name)
 
       search_options = search_options(options, resource)
-      id_params(resource.action(:index), :required => true).each do |param|
+      IdParamsFilter.new(:only_required => true).for_action(resource.action(:index)).each do |param|
         search_options[param.name] ||= send(param.name, scoped_options(param.name.gsub(/_id$/, ""), options))
       end
       resource.action(:index).routes.each do |route|
@@ -139,7 +143,12 @@ module HammerCLIForeman
     end
 
     def search_options(options, resource)
-      search_options = create_search_options(options, resource)
+      method = "create_#{resource.name}_search_options"
+      search_options = if respond_to?(method)
+                         send(method, options)
+                       else
+                         create_search_options(options, resource)
+                       end
       raise MissingSeachOptions.new(_("Missing options to search %s") % resource.singular_name) if search_options.empty?
       search_options
     end

data/lib/hammer_cli_foreman/image.rb

@@ -1,4 +1,3 @@
-require 'hammer_cli_foreman/compute_resource'
 
 module HammerCLIForeman
 

data/lib/hammer_cli_foreman/location.rb

@@ -40,7 +40,9 @@ module HammerCLIForeman
         HammerCLIForeman::References.timestamps(self)
       end
 
-      build_options
+      build_options do |o|
+        o.expand.primary(:organizations)
+      end
     end
 
 
@@ -74,7 +76,9 @@ module HammerCLIForeman
       success_message _("Location deleted")
       failure_message _("Could not delete the location")
 
-      build_options
+      build_options do |o|
+        o.expand.primary(:organizations)
+      end
     end
 
     HammerCLIForeman::AssociatingCommands::Hostgroup.extend_command(self)
@@ -93,5 +97,5 @@ module HammerCLIForeman
 
 end
 
-HammerCLI::MainCommand.subcommand 'location', _("Manipulate locations."), HammerCLIForeman::Location
+
 

data/lib/hammer_cli_foreman/media.rb

@@ -61,5 +61,5 @@ module HammerCLIForeman
 
 end
 
-HammerCLI::MainCommand.subcommand 'medium', _("Manipulate installation media."), HammerCLIForeman::Medium
+
 

data/lib/hammer_cli_foreman/model.rb

@@ -55,5 +55,5 @@ module HammerCLIForeman
 
 end
 
-HammerCLI::MainCommand.subcommand 'model', _("Manipulate hardware models."), HammerCLIForeman::Model
+
 

data/lib/hammer_cli_foreman/operating_system.rb

@@ -56,7 +56,7 @@ module HammerCLIForeman
       failure_message _("Could not create the operating system")
 
       def request_params
-        params = method_options
+        params = super
         params["operatingsystem"]["architecture_ids"] = option_architecture_ids if option_architecture_ids
         params["operatingsystem"]["config_template_ids"] = option_config_template_ids if option_config_template_ids
         params["operatingsystem"]["medium_ids"] = option_medium_ids if option_medium_ids
@@ -83,7 +83,7 @@ module HammerCLIForeman
       failure_message _("Could not update the operating system")
 
       def request_params
-        params = method_options
+        params = super
         params["operatingsystem"]["architecture_ids"] = option_architecture_ids if option_architecture_ids
         params["operatingsystem"]["config_template_ids"] = option_config_template_ids if option_config_template_ids
         params["operatingsystem"]["medium_ids"] = option_medium_ids if option_medium_ids
@@ -146,7 +146,7 @@ module HammerCLIForeman
 
       def option_type_name
         tpl = HammerCLIForeman.collection_to_common_format(
-          HammerCLIForeman.foreman_resource(:config_templates).call(:show, {"id" => option_config_template_id}))
+          HammerCLIForeman.foreman_resource!(:config_templates).call(:show, {"id" => option_config_template_id}))
         tpl[0]["template_kind_name"]
       end
 
@@ -214,7 +214,7 @@ module HammerCLIForeman
         tpl = templates.find { |p| p["template_kind_name"] == option_type }
 
         if tpl.nil?
-          raise RuntimeError.new(_("Default template of type #{option_type} not found"))
+          raise RuntimeError.new(_("Default template of type %s not found") % option_type)
         end
 
         params = {
@@ -244,5 +244,3 @@ module HammerCLIForeman
 
 end
 
-HammerCLI::MainCommand.subcommand 'os', "Manipulate operating system.", HammerCLIForeman::OperatingSystem
-

data/lib/hammer_cli_foreman/option_builders.rb

@@ -0,0 +1,285 @@
+module HammerCLIForeman
+
+  class BuildParams
+
+    class ExpansionParams
+
+      def initialize(params={})
+        @params = params || {}
+      end
+
+      def except(*resource_names)
+        @params[:except] = resource_names
+        self
+      end
+
+      def including(*resource_names)
+        @params[:including] = resource_names
+        self
+      end
+
+      def only(*resource_names)
+        @params[:only] = resource_names
+        self
+      end
+
+      def primary(resource_name)
+        @params[:primary] = resource_name
+        self
+      end
+
+      def to_hash
+        @params
+      end
+    end
+
+
+    def initialize(params={})
+      @params = params || {}
+    end
+
+    def without(*option_names)
+      @params[:without] = option_names
+    end
+
+    def expand(switch = :all)
+      @expansion ||= ExpansionParams.new(@params[:expand])
+      if (switch == :none)
+        @expansion.only()
+      end
+      @expansion
+    end
+
+    def to_hash
+      @params[:expand] = @expansion.to_hash if @expansion
+      @params
+    end
+
+  end
+
+  class BuilderConfigurator
+
+    def initialize(searchables, dependency_resolver)
+      @searchables = searchables
+      @dependency_resolver = dependency_resolver
+    end
+
+    def builders_for(resource, action)
+      builders = []
+
+      dependent_resources = []
+
+      if action.params.find{ |p| p.name == "id" }
+        builders << SearchablesOptionBuilder.new(resource, @searchables)
+        dependent_resources += @dependency_resolver.resource_dependencies(resource, :only_required => true, :recursive => true)
+      end
+
+      dependent_resources += @dependency_resolver.action_dependencies(action, :only_required => false, :recursive => false)
+      dependent_resources += @dependency_resolver.action_dependencies(action, :only_required => true, :recursive => true)
+
+      unique(dependent_resources).each do |dep_resource|
+        builders << DependentSearchablesOptionBuilder.new(dep_resource, @searchables)
+      end
+
+      builders
+    end
+
+    protected
+
+    def unique(resources)
+      # ruby 1.8 hack - it does not support passing blocks to Array#uniq
+      resources.inject({}) do |h, r|
+        h.update(r.name => r)
+      end.values
+    end
+
+  end
+
+  class ForemanOptionBuilder < HammerCLI::OptionBuilderContainer
+
+    def initialize(searchables)
+      @searchables = searchables
+    end
+
+    def build(builder_params={})
+      expansion_options = builder_params[:expand] || {}
+
+      allowed_resources = expansion_options[:only] || default_dependent_resources
+      allowed_resources -= expansion_options[:except] || []
+      allowed_resources += expansion_options[:including] || []
+      allowed_resources.uniq!
+
+      primary_resource = expansion_options[:primary]
+
+      to_remove = default_dependent_resources - allowed_resources
+      to_add = allowed_resources - default_dependent_resources
+
+      builders.reject! do |b|
+        b.class <= DependentSearchablesOptionBuilder && to_remove.include?(b.resource.name)
+      end
+      to_add.each do |resource_name|
+        builders << DependentSearchablesOptionBuilder.new(HammerCLIForeman.foreman_resource(resource_name), @searchables)
+      end
+
+      if !primary_resource.nil?
+        builders.reject! do |b|
+          b.class <= SearchablesOptionBuilder
+        end
+        builders << SearchablesOptionBuilder.new(HammerCLIForeman.foreman_resource(primary_resource), @searchables) if primary_resource != false
+      end
+
+      super
+    end
+
+    def default_dependent_resources
+      dependent_searchable_builders.map(&:resource).map(&:name)
+    end
+
+    def dependent_searchable_builders
+      self.builders.select{|b| b.class <= DependentSearchablesOptionBuilder }
+    end
+
+  end
+
+  class SearchablesAbstractOptionBuilder < HammerCLI::AbstractOptionBuilder
+
+    protected
+
+    def description(param_name, action_name)
+      return " " unless @resource.has_action? action_name
+
+      params = ParamsNameFilter.new(param_name).for_action(@resource.action(action_name))
+      if params.empty?
+        return " "
+      else
+        return params[0].description
+      end
+    end
+
+  end
+
+  class SearchablesOptionBuilder < SearchablesAbstractOptionBuilder
+
+    def initialize(resource, searchables)
+      @resource = resource
+      @searchables = searchables
+    end
+
+    attr_reader :resource
+
+    def build(builder_params={})
+      @searchables.for(@resource).collect do |s|
+        option(
+          optionamize("--#{s.name}"),
+          s.name.upcase,
+          s.description
+        )
+      end
+    end
+  end
+
+
+  class DependentSearchablesOptionBuilder < SearchablesAbstractOptionBuilder
+
+    def initialize(resource, searchables)
+      @resource = resource
+      @searchables = searchables
+    end
+
+    attr_reader :resource
+
+    def build(builder_params={})
+      resource_name_map = builder_params[:resource_mapping] || {}
+      dependent_options(@resource, resource_name_map)
+    end
+
+    protected
+
+    def dependent_options(resource, resource_name_map)
+      options = []
+      searchables = @searchables.for(resource)
+      resource_name = resource.singular_name
+      aliased_name = aliased(resource_name, resource_name_map)
+
+      unless searchables.empty?
+        first = searchables[0]
+        remaining = searchables[1..-1] || []
+
+        # First option is named by the resource
+        # Eg. --organization with accessor option_organization_name
+        options << option(
+          optionamize("--#{aliased_name}"),
+          "#{aliased_name}_#{first.name}".upcase,
+          first.description || " ",
+          :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_#{first.name}")
+        )
+
+        # Other options are named by the resource plus the searchable name
+        # Eg. --organization-label with accessor option_organization_label
+        remaining.each do |s|
+          options << option(
+            optionamize("--#{aliased_name}-#{s.name}"),
+            "#{aliased_name}_#{s.name}".upcase,
+            s.description || " ",
+            :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_#{s.name}")
+          )
+        end
+      end
+
+      options << option(
+        optionamize("--#{aliased_name}-id"),
+        "#{aliased_name}_id".upcase,
+        description("id", :show),
+        :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_id")
+      )
+      options
+    end
+
+    def aliased(name, resource_name_map)
+      resource_name_map[name.to_s] || resource_name_map[name.to_sym] || name
+    end
+
+  end
+
+  class SearchablesUpdateOptionBuilder < SearchablesAbstractOptionBuilder
+
+    def initialize(resource, searchables)
+      @resource = resource
+      @searchables = searchables
+    end
+
+    attr_reader :resource
+
+    def build(builder_params={})
+
+      @searchables.for(@resource).collect do |s|
+        if s.editable?
+          option(
+            optionamize("--new-#{s.name}"),
+            "NEW_#{s.name.upcase}",
+            description(s.name, :update)
+          )
+        end
+      end.compact
+    end
+
+  end
+
+  # it adds id with description of the id param from resource's show action
+  class IdOptionBuilder < SearchablesAbstractOptionBuilder
+
+    def initialize(resource)
+      @resource = resource
+    end
+
+    attr_reader :resource
+
+    def build(builder_params={})
+      [
+        option("--id", "ID", description("id", :show))
+      ]
+    end
+
+  end
+
+end