hammer_cli_foreman 3.0.0 → 3.3.0

data/lib/hammer_cli_foreman/id_resolver.rb

@@ -1,14 +1,12 @@
 module HammerCLIForeman
 
   class Searchable
-    attr_reader :name, :description, :format
+    attr_reader :name, :description
 
     def initialize(name, description, options={})
       @name = name
       @description = description
       @editable = options[:editable].nil? ? true : options[:editable]
-      @format = options[:format]
-      @parent = options[:parent]
     end
 
     def plural_name
@@ -18,10 +16,6 @@ module HammerCLIForeman
     def editable?
       @editable
     end
-
-    def parent?
-      @parent
-    end
   end
 
   class Searchables
@@ -130,6 +124,12 @@ module HammerCLIForeman
       @searchables.for(resource)
     end
 
+    def template_kind_id(options = {})
+      name = options['option_type'] == 'snippet' ? nil : options['option_type']
+      options['option_name'] = name
+      get_id(:template_kinds, options)
+    end
+
     protected
 
     def define_id_finders

data/lib/hammer_cli_foreman/option_builders.rb

@@ -172,8 +172,7 @@ module HammerCLIForeman
     def build(builder_params={})
       resource_name_map = builder_params[:resource_mapping] || {}
       @searchables.for(@resource).collect do |s|
-        family = HammerCLI::Options::OptionFamily.new
-        family.parent(
+        option(
           optionamize("--#{s.name}"),
           s.name.upcase,
           s.description,
@@ -213,23 +212,43 @@ module HammerCLIForeman
 
     def build(builder_params={})
       resource_name_map = builder_params[:resource_mapping] || {}
-      dependent_options(@resource, resource_name_map)
+      command = builder_params[:command]
+      dependent_options(@resource, resource_name_map, command)
     end
 
     protected
 
-    def dependent_options(resource, resource_name_map)
+    def dependent_options(resource, resource_name_map, command)
       options = []
       searchables = @searchables.for(resource)
       resource_name = resource.singular_name
       aliased_name = aliased(resource_name, resource_name_map)
       types = searchables.map(&:name).push('id').map(&:capitalize).join('/')
       associated_resource = aliased_name.to_s.tr('_', ' ')
-      family = HammerCLI::Options::OptionFamily.new(
-        referenced_resource: resource_name,
-        aliased_resource: aliased_name,
-        description: _('%{types} of associated %{resource}') % { types: types, resource: associated_resource }
-      )
+      family = command.option_families.find do |f|
+        f.head.referenced_resource == resource_name
+      end
+      unless family
+        # If there is no family it probably means that we explicitly want to
+        # expand options via
+        # build_options do |o|
+        #   o.expand.including(:resource)
+        # end
+        # instead of generating it from API docs (it may not be even present there)
+        family = HammerCLI::Options::OptionFamily.new(
+          description: _('%{types} of associated %{resource}') % { types: types, resource: associated_resource },
+          creator: command
+        )
+        options << family.parent(
+          optionamize("--#{aliased_name}-id"),
+          "#{aliased_name}_id".upcase,
+          description("#{aliased_name}_id", @context[:action]),
+          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_id"),
+          referenced_resource: resource_name,
+          aliased_resource: aliased_name,
+          format: HammerCLI::Options::Normalizers::Number.new
+        )
+      end
 
       unless searchables.empty?
         first = searchables[0]
@@ -240,31 +259,25 @@ module HammerCLIForeman
         options << family.child(
           optionamize("--#{aliased_name}"),
           "#{aliased_name}_#{first.name}".upcase,
-          first.description || " ",
-          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{first.name}")
+          first.description || ' ',
+          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{first.name}"),
+          referenced_resource: resource_name,
+          aliased_resource: aliased_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 << family.send(s.parent? ? :parent : :child,
+          options << family.child(
             optionamize("--#{aliased_name}-#{s.name}"),
             "#{aliased_name}_#{s.name}".upcase,
-            s.description || " ",
+            s.description || ' ',
             attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{s.name}"),
-            format: s.format
+            referenced_resource: resource_name,
+            aliased_resource: aliased_name
           )
         end
       end
 
-      unless options.any? { |o| o.handles?(optionamize("--#{aliased_name}-id")) }
-        options << family.parent(
-          optionamize("--#{aliased_name}-id"),
-          "#{aliased_name}_id".upcase,
-          description("#{aliased_name}_id", @context[:action]),
-          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_id"),
-          format: HammerCLI::Options::Normalizers::Number.new
-        )
-      end
       options
     end
 
@@ -285,15 +298,25 @@ module HammerCLIForeman
   class UpdateDependentSearchablesOptionBuilder < DependentSearchablesOptionBuilder
     protected
 
-    def dependent_options(resource, resource_name_map)
+    def dependent_options(resource, resource_name_map, command)
       options = []
       searchables = @searchables.for(resource)
       resource_name = resource.singular_name
       aliased_name = aliased(resource_name, resource_name_map)
+      # Those options are not coming from API docs, thus create a new family only
       family = HammerCLI::Options::OptionFamily.new(
         prefix: 'new-',
         aliased_resource: aliased_name,
-        referenced_resource: resource_name
+        referenced_resource: resource_name,
+        creator: command
+      )
+
+      options << family.parent(
+        optionamize("--new-#{aliased_name}-id"),
+        "new_#{aliased_name}_id".upcase,
+        _('Use to update associated %s') % aliased_name,
+        attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_id"),
+        format: HammerCLI::Options::Normalizers::Number.new
       )
       unless searchables.empty?
         first = searchables[0]
@@ -304,73 +327,63 @@ module HammerCLIForeman
         options << family.child(
           optionamize("--new-#{aliased_name}"),
           "new_#{aliased_name}_#{first.name}".upcase,
-          _('Use to update'),
+          _('Use to update associated %s') % aliased_name,
           attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_#{first.name}")
         )
         # Other options are named by the resource plus the searchable name
         # Eg. --new-organization-label with accessor option_new_organization_label
         remaining.each do |s|
-          options << family.send(s.parent? ? :parent : :child,
+          options << family.child(
             optionamize("--new-#{aliased_name}-#{s.name}"),
             "new_#{aliased_name}_#{s.name}".upcase,
-            _('Use to update'),
+            _('Use to update associated %s') % aliased_name,
             attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_#{s.name}")
           )
         end
       end
 
-      unless options.any? { |o| o.handles?(optionamize("--new-#{aliased_name}-id")) }
-        options << family.parent(
-          optionamize("--new-#{aliased_name}-id"),
-          "new_#{aliased_name}_id".upcase,
-          _('Use to update'),
-          attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_id"),
-          format: HammerCLI::Options::Normalizers::Number.new
-        )
-      end
       options
     end
   end
 
   class DependentSearchablesArrayOptionBuilder < DependentSearchablesOptionBuilder
-
-
-    def dependent_options(resource, resource_name_map)
+    def dependent_options(resource, resource_name_map, command)
       options = []
       searchables = @searchables.for(resource)
       resource_name = resource.singular_name
 
       aliased_name = aliased(resource_name, resource_name_map)
       aliased_plural_name = aliased(resource.name, resource_name_map)
-
       unless searchables.empty?
         first = searchables[0]
         remaining = searchables[1..-1] || []
-        types = searchables.map(&:plural_name).map(&:capitalize).join('/')
-        associated_resource = aliased_plural_name.to_s.tr('_', ' ')
-        family = HammerCLI::Options::OptionFamily.new(
-          format: HammerCLI::Options::Normalizers::List.new,
-          referenced_resource: resource_name,
-          aliased_resource: aliased_name,
-          description: _('%{types} of associated %{resource}') % { types: types, resource: associated_resource }
-        )
+        # Find family created by HammerCLI::Apipie::OptionBuilder for *_ids options
+        family = command.option_families.find do |f|
+          f.head.referenced_resource == resource_name && f.formats.include?(HammerCLI::Options::Normalizers::List)
+        end
         # First option is named by the resource
         # Eg. --organizations with accessor option_organization_names
         options << family.child(
           optionamize("--#{aliased_plural_name}"),
           "#{aliased_name}_#{first.plural_name}".upcase,
           ' ',
-          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{first.plural_name}")
+          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{first.plural_name}"),
+          format: HammerCLI::Options::Normalizers::List.new,
+          referenced_resource: resource_name,
+          aliased_resource: aliased_name
         )
 
         # Other options are named by the resource plus the searchable name
         # Eg. --organization-labels with accessor option_organization_labels
         remaining.each do |s|
-          options << family.send(s.parent? ? :parent : :child,
+          options << family.child(
             optionamize("--#{aliased_name}-#{s.plural_name}"),
             "#{aliased_name}_#{s.plural_name}".upcase,
             ' ',
-            attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{s.plural_name}")
+            attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{s.plural_name}"),
+            format: HammerCLI::Options::Normalizers::List.new,
+            referenced_resource: resource_name,
+            aliased_resource: aliased_name
           )
         end
       end
@@ -421,4 +434,3 @@ module HammerCLIForeman
   end
 
 end
-

data/lib/hammer_cli_foreman/option_sources/id_params.rb

@@ -6,7 +6,7 @@ module HammerCLIForeman
       end
 
       def param_updatable?(param_resource)
-        param_resource && @command.respond_to?(HammerCLI.option_accessor_name("#{param_resource.singular_name}_id"))
+        param_resource && @command.respond_to?(cli_option_resource_id(param_resource))
       end
 
       def available_id_params
@@ -16,16 +16,23 @@ module HammerCLIForeman
       def needs_resolving?(param_option, param_resource, all_opts)
         return false unless param_updatable?(param_resource)
 
-        searchables_set = @command.searchables.for(param_resource).any? do |s|
+        cli_searchables_set = @command.searchables.for(param_resource).any? do |s|
           option = HammerCLI.option_accessor_name("#{param_resource.singular_name}_#{s.name}")
-          !all_opts[option].nil?
+          next false unless @command.respond_to?(option)
+
+          !@command.send(option).nil?
         end
-        return all_opts[param_option].nil? unless searchables_set
+        if cli_searchables_set
+          # Remove set '<resource_name>_id' option to force resolving in case of
+          # '<resource_name>_[name|title]' was set from CLI
+          all_opts.delete(param_option)
+          true
+        else
+          # Don't resolve if resource id was set via CLI
+          return false if @command.send(cli_option_resource_id(param_resource))
 
-        # Remove set '<resource_name>_id' option to force resolving in case of
-        # '<resource_name>_[name|title]' was set
-        all_opts.delete(param_option)
-        true
+          all_opts[param_option].nil?
+        end
       end
 
       def get_options(_defined_options, result)
@@ -63,6 +70,12 @@ module HammerCLIForeman
           e.resource
         )
       end
+
+      private
+
+      def cli_option_resource_id(resource)
+        HammerCLI.option_accessor_name("#{resource.singular_name}_id")
+      end
     end
   end
 end

data/lib/hammer_cli_foreman/option_sources/ids_params.rb

@@ -6,7 +6,7 @@ module HammerCLIForeman
       end
 
       def param_updatable?(param_resource)
-        param_resource && @command.respond_to?(HammerCLI.option_accessor_name("#{param_resource.singular_name}_ids"))
+        param_resource && @command.respond_to?(cli_option_resource_ids(param_resource))
       end
 
       def available_ids_params
@@ -16,16 +16,23 @@ module HammerCLIForeman
       def needs_resolving?(param_option, param_resource, all_opts)
         return false unless param_updatable?(param_resource)
 
-        searchables_set = @command.searchables.for(param_resource).any? do |s|
+        cli_searchables_set = @command.searchables.for(param_resource).any? do |s|
           option = HammerCLI.option_accessor_name("#{param_resource.singular_name}_#{s.plural_name}")
-          !all_opts[option].nil?
-        end
-        return all_opts[param_option].nil? unless searchables_set
+          next false unless @command.respond_to?(option)
 
-        # Remove set '<resource_name>_ids' option to force resolving in case of
-        # '<resource_name>_[names|titles]' was set
-        all_opts.delete(param_option)
-        true
+          !@command.send(option).nil?
+        end
+        if cli_searchables_set
+          # Remove set '<resource_name>_ids' option to force resolving in case of
+          # '<resource_name>_[names|titles]' were set from CLI
+          all_opts.delete(param_option)
+          true
+        else
+          # Don't resolve if resource ids were set via CLI
+          return false if @command.send(cli_option_resource_ids(param_resource))
+
+          all_opts[param_option].nil?
+        end
       end
 
       def get_options(_defined_options, result)
@@ -44,6 +51,12 @@ module HammerCLIForeman
         end
         result
       end
+
+      private
+
+      def cli_option_resource_ids(resource)
+        HammerCLI.option_accessor_name("#{resource.singular_name}_ids")
+      end
     end
   end
 end

data/lib/hammer_cli_foreman/partition_table.rb

@@ -71,6 +71,36 @@ module HammerCLIForeman
       build_options
     end
 
+    class ImportCommand < HammerCLIForeman::Command
+      command_name "import"
+      action :import
+      option '--file', 'PATH', _('Path to a file that contains the template content including metadata'),
+             :attribute_name => :option_template, :format => HammerCLI::Options::Normalizers::File.new
+
+      validate_options do
+        all(:option_name, :option_template).required
+      end
+
+      success_message _("Import partition table template succeeded.")
+      failure_message _("Could not import partition table template")
+
+      build_options :without => [:template]
+    end
+
+    class ExportCommand < HammerCLIForeman::DownloadCommand
+      command_name "export"
+      action :export
+
+      def default_filename
+        "Partition Table Template-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def saved_response_message(filepath)
+        _("The partition table template has been saved to %{path}.") % { path: filepath }
+      end
+
+      build_options
+    end
 
     HammerCLIForeman::AssociatingCommands::OperatingSystem.extend_command(self)
 

data/lib/hammer_cli_foreman/report_template.rb

@@ -148,6 +148,21 @@ module HammerCLIForeman
       build_options :without => [:template]
     end
 
+    class ExportCommand < HammerCLIForeman::DownloadCommand
+      command_name "export"
+      action :export
+
+      def default_filename
+        "Report Template-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def saved_response_message(filepath)
+        _("The report template has been saved to %{path}.") % { path: filepath }
+      end
+
+      build_options
+    end
+
     class ReportDataCommand < HammerCLIForeman::DownloadCommand
       command_name "report-data"
       action :report_data

data/lib/hammer_cli_foreman/smart_proxy.rb

@@ -10,8 +10,9 @@ module HammerCLIForeman
       output do
         field :id, _("Id")
         field :name, _("Name")
+        field :status, _("Status")
         field :url, _("URL")
-        field :_features, _( "Features"), Fields::List, :width => 25, :hide_blank => true
+        field :_features, _( "Features"), Fields::List, :hide_blank => true
       end
 
       def extend_data(proxy)
@@ -22,12 +23,13 @@ module HammerCLIForeman
       build_options
     end
 
-
     class InfoCommand < HammerCLIForeman::InfoCommand
-
       output ListCommand.output_definition do
-        collection :features,  _("Features"), :numbered => false do
-          custom_field Fields::Reference
+        field :version, _("Version")
+        field :hosts_count, _("Host_count")
+        collection :features, _("Features") do
+          field :name, _('Name')
+          field :version, _('Version')
         end
         HammerCLIForeman::References.taxonomies(self)
         HammerCLIForeman::References.timestamps(self)
@@ -71,6 +73,17 @@ module HammerCLIForeman
       build_options
     end
 
+    class ImportSubnetsCommand < HammerCLIForeman::Command
+
+      action :import_subnets
+
+      command_name    "import-subnets"
+      success_message _("Import subnets succeeded.")
+      failure_message _("Could not import subnets")
+
+      build_options
+    end
+
     autoload_subcommands
   end
 

data/lib/hammer_cli_foreman/template.rb

@@ -5,25 +5,13 @@ module HammerCLIForeman
     resource :provisioning_templates
 
     module TemplateCreateUpdateCommons
-
       def option_snippet
         option_type && (option_type == "snippet")
       end
 
-      def option_template_kind_id
-        table = kinds.inject({}){ |result, k| result.update(k["name"] => k["id"]) }
-        if option_snippet == false && table[option_type].nil?
-          signal_usage_error _("unknown template kind")
-        else
-          table[option_type]
-        end
-      end
-
-      def kinds
-        HammerCLIForeman.collection_to_common_format(
-          HammerCLIForeman.foreman_resource!(:template_kinds).call(:index))
-      end
-
+      # This method is for IdParams option source to make resolver work for
+      # --type option
+      def option_template_kind_id; end
     end
 
     class ListCommand < HammerCLIForeman::ListCommand
@@ -154,7 +142,37 @@ module HammerCLIForeman
       build_options
     end
 
+    class ImportCommand < HammerCLIForeman::Command
+      command_name "import"
+      action :import
+      option '--file', 'PATH', _('Path to a file that contains the template content including metadata'),
+             :attribute_name => :option_template, :format => HammerCLI::Options::Normalizers::File.new
+
+      validate_options do
+        all(:option_name, :option_template).required
+      end
+
+      success_message _("Import provisioning template succeeded.")
+      failure_message _("Could not import provisioning template")
+
+      build_options :without => [:template]
+    end
+
+    class ExportCommand < HammerCLIForeman::DownloadCommand
+      command_name "export"
+      action :export
+
+      def default_filename
+        "Template-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def saved_response_message(filepath)
+        _("The provisioning template has been saved to %{path}.") % { path: filepath }
+      end
 
+      build_options
+    end
+    
     class BuildPXEDefaultCommand < HammerCLIForeman::Command
 
       action :build_pxe_default

data/lib/hammer_cli_foreman/user.rb

@@ -29,6 +29,7 @@ module HammerCLIForeman
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       output ListCommand.output_definition do
+        field :mail_enabled, _("Email enabled"), Fields::Boolean
         field :effective_admin, _("Effective admin"), Fields::Boolean
         field :locale, _("Locale")
         field :timezone, _("Timezone")
@@ -56,9 +57,9 @@ module HammerCLIForeman
       success_message _("User [%{login}] created.")
       failure_message _("Could not create the user")
 
-      extend_with(HammerCLIForeman::CommandExtensions::User.new)
-
       build_options
+
+      extend_with(HammerCLIForeman::CommandExtensions::User.new)
     end
 
 
@@ -66,9 +67,9 @@ module HammerCLIForeman
       success_message _("User [%{login}] updated.")
       failure_message _("Could not update the user")
 
-      extend_with(HammerCLIForeman::CommandExtensions::User.new)
-
       build_options
+
+      extend_with(HammerCLIForeman::CommandExtensions::User.new)
     end
 
 

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new "3.0.0"
+    @version ||= Gem::Version.new "3.3.0"
   end
 end