Fixes #24489 - add a command for report templates

lib/hammer_cli_foreman.rb

@@ -106,6 +106,10 @@ def self.exception_handler_class
       :warning => _('%{report} command is deprecated and will be removed in one of the future versions. Please use %{config_report} command instead.') % {:report => 'report', :config_report => 'config-report'}
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('report-template', _("Manipulate report templates"),
+      'HammerCLIForeman::ReportTemplate', 'hammer_cli_foreman/report_template',
+    )
+
     HammerCLI::MainCommand.lazy_subcommand('config-report', _("Browse and read reports"),
       'HammerCLIForeman::ConfigReport', 'hammer_cli_foreman/config_report'
     )

lib/hammer_cli_foreman/commands.rb

@@ -519,4 +519,49 @@ def self.success_message(msg = nil)
       super(msg) || default_message(_('The %{resource_name} has been disassociated.'))
     end
   end
+
+  class DownloadCommand < HammerCLIForeman::SingleResourceCommand
+    action :download
+
+    def self.command_name(name = nil)
+      super(name) || "download"
+    end
+
+    def request_options
+      { :response => :raw }
+    end
+
+    option "--path", "PATH", _("Path to directory where downloaded content will be saved"),
+        :attribute_name => :option_path
+
+    def execute
+      response = send_request
+      if option_path
+        filepath = store_response(response)
+        print_message(_('The response has been saved to %{path}s.'), {:path => filepath})
+      else
+        puts response.body
+      end
+      return HammerCLI::EX_OK
+    end
+
+    def default_filename
+      "Downloaded-#{Time.new.strftime("%Y-%m-%d")}.txt"
+    end
+
+    private
+
+    def store_response(response)
+      if response.headers.key?(:content_disposition)
+        suggested_filename = response.headers[:content_disposition].match(/filename="(.*)"/)
+      end
+      filename = suggested_filename ? suggested_filename[1] : default_filename
+      path = option_path.dup
+      path << '/' unless path.end_with? '/'
+      raise _("Cannot save file: %s does not exist") % path unless File.directory?(path)
+      filepath = path + filename
+      File.write(filepath, response.body)
+      filepath
+    end
+  end
 end

lib/hammer_cli_foreman/report_template.rb

@@ -0,0 +1,161 @@
+module HammerCLIForeman
+
+  class ReportTemplate < HammerCLIForeman::Command
+    resource :report_templates
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _("Id")
+        field :name, _("Name")
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition do
+        field :locked, _("Locked"), Fields::Boolean
+        field :default, _("Default"), Fields::Boolean
+        HammerCLIForeman::References.timestamps(self)
+        HammerCLIForeman::References.taxonomies(self)
+        collection :inputs, _("Template inputs") do
+          field :id, _("Id"), Fields::Id
+          field :name, _('Name')
+          field :description, _('Description')
+          field :required, _("Required"), Fields::Boolean
+          field :options, _('Options'), Fields::List, :hide_blank => true
+        end
+      end
+
+      def extend_data(template)
+        template[:inputs] = load_inputs
+        template
+      end
+
+      build_options
+
+      private
+
+      def load_inputs
+        template_inputs_api = HammerCLIForeman.foreman_api.resource(:template_inputs)
+        params = {:template_id => options['option_id']}
+        params[:organization_id] = options['option_organization_id'] if options['option_organization_id']
+        params[:location_id] = options['option_location_id'] if options['option_locations_id']
+        HammerCLIForeman.collection_to_common_format(template_inputs_api.call(:index, params))
+      end
+    end
+
+    class DumpCommand < HammerCLIForeman::InfoCommand
+      command_name "dump"
+      desc _("View report content")
+
+      def print_data(report_template)
+        puts report_template["template"]
+      end
+
+      build_options
+    end
+
+    class GenerateCommand < HammerCLIForeman::DownloadCommand
+      command_name "generate"
+      action :generate
+      desc _("Generate report")
+
+      option '--inputs', 'INPUTS', N_('Specify inputs'),
+        :format => HammerCLI::Options::Normalizers::KeyValueList.new
+
+      def default_filename
+        "Report-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def request_params
+        params = super
+        params['input_values'] = option_inputs || {}
+        params
+      end
+
+      build_options
+    end
+
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      option ['--interactive', '-i'], :flag, _('Open empty template in an $EDITOR. Upload the result')
+      option "--file", "LAYOUT", _("Path to a file that contains the report template content"),
+        :attribute_name => :option_template, :format => HammerCLI::Options::Normalizers::File.new
+
+      validate_options do
+        any(:option_interactive, :option_template).required
+      end
+
+      def request_params
+        params = super
+        if option_interactive?
+          params['report_template']['template'] = HammerCLI.open_in_editor(
+            '', content_type: 'report_template', suffix: '.erb')
+        end
+        params
+      end
+
+      success_message _("Report template created.")
+      failure_message _("Could not create the report template")
+
+      build_options :without => [:template]
+    end
+
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      option ['--interactive', '-i'], :flag, _('Dump existing template and open it in an $EDITOR. Update with the result')
+      option '--file', 'REPORT', _("Path to a file that contains the report template content"), :attribute_name => :option_template,
+        :format => HammerCLI::Options::Normalizers::File.new
+
+      def request_params
+        params = super
+        if option_interactive?
+          template = load_template
+          params['report_template']['template'] =  HammerCLI.open_in_editor(
+            template['template'], content_type: 'report_template', suffix: '.erb')
+        end
+        params
+      end
+
+      success_message _("Report template updated.")
+      failure_message _("Could not update the report template")
+
+      build_options :without => [:template]
+
+      private
+
+      def load_template
+        template_api = HammerCLIForeman.foreman_api.resource(:report_templates)
+        params = {:id => options['option_id']}
+        params[:organization_id] = options['option_organization_id'] if options['option_organization_id']
+        params[:location_id] = options['option_location_id'] if options['option_locations_id']
+        HammerCLIForeman.record_to_common_format(template_api.call(:show, params))
+      end
+    end
+
+    class CloneCommand < HammerCLIForeman::UpdateCommand
+      action :clone
+      command_name 'clone'
+
+      success_message _('Report template cloned.')
+      failure_message _('Could not clone the report template')
+
+      validate_options do
+        option(:option_new_name).required
+      end
+
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _("Report template deleted.")
+      failure_message _("Could not delete the report template")
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+
+end

test/functional/hostgroup/create_test.rb

@@ -167,7 +167,7 @@ module HammerCLIForeman
         api_expects(:hostgroups, :create).with_params({
           :hostgroup => {
             :name => 'hg1',
-            :parent_id => '1'
+            :parent_id => 1
           }
         })
         run_cmd(%w(hostgroup create --name hg1 --parent-id 1))
@@ -207,7 +207,7 @@ module HammerCLIForeman
         api_expects(:hostgroups, :create).with_params({
           :hostgroup => {
             :name => 'hg1',
-            :puppet_ca_proxy_id => '1'
+            :puppet_ca_proxy_id => 1
           }
         })
         run_cmd(%w(hostgroup create --name hg1 --puppet-ca-proxy-id 1))
@@ -250,7 +250,7 @@ module HammerCLIForeman
         api_expects(:hostgroups, :create).with_params({
           :hostgroup => {
             :name => 'hg1',
-            :puppet_proxy_id => '1'
+            :puppet_proxy_id => 1
           }
         })
         run_cmd(%w(hostgroup create --name hg1 --puppet-proxy-id 1))

test/functional/hostgroup/update_test.rb

@@ -166,7 +166,7 @@ module HammerCLIForeman
       it 'allows parent hostgroup id' do
         api_expects(:hostgroups, :update).with_params({
           :id => '1',
-          :hostgroup => { :parent_id => '1' }
+          :hostgroup => { :parent_id => 1 }
         })
         run_cmd(%w(hostgroup update --id 1 --parent-id 1))
       end
@@ -204,7 +204,7 @@ module HammerCLIForeman
       it 'allows puppet ca proxy id' do
         api_expects(:hostgroups, :update).with_params({
           :id => '1',
-          :hostgroup => { :puppet_ca_proxy_id => '1' }
+          :hostgroup => { :puppet_ca_proxy_id => 1 }
         })
         run_cmd(%w(hostgroup update --id 1 --puppet-ca-proxy-id 1))
       end
@@ -245,7 +245,7 @@ module HammerCLIForeman
       it 'allows puppet proxy id' do
         api_expects(:hostgroups, :update).with_params({
           :id => '1',
-          :hostgroup => { :puppet_proxy_id => '1' }
+          :hostgroup => { :puppet_proxy_id => 1 }
         })
         run_cmd(%w(hostgroup update --id 1 --puppet-proxy-id 1))
       end