hammer_cli_foreman 3.0.0 → 3.3.0

data/test/functional/template_test.rb

@@ -77,6 +77,66 @@ describe 'template' do
     end
   end
 
+  describe 'import' do
+    let(:template) do
+      {
+        'id' => 1,
+        'template' => 'Template content'
+      }
+    end
+    let(:cmd) { %w(template import) }
+    let(:tempfile) { Tempfile.new('template') }
+
+    it 'requires --name and --file' do
+      params = ['--name=test']
+      api_expects_no_call
+      expected_result = usage_error_result(
+        cmd,
+        'Options --name, --file are required.',
+        'Could not import provisioning template')
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'import template' do
+      params = ['--name=test', "--file=#{tempfile.path}"]
+      tempfile.write('Template content')
+      tempfile.rewind
+      api_expects(:provisioning_templates, :import, 'Import template').with_params(
+        'provisioning_template' => {
+          'name' => 'test',
+          'template' => 'Template content'
+        }).returns(template)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(success_result("Import provisioning template succeeded.\n"), result)
+    end
+  end
+
+  describe 'export' do
+    let(:cmd) { %w(template export) }
+    let(:tempfile) { Tempfile.new('template', '/tmp') }
+    let(:params) { ['--id=1', '--path=/tmp'] }
+    let(:template_response) do
+      response = mock('TemplateResponse')
+      response.stubs(:code).returns(200)
+      response.stubs(:body).returns('Template content')
+      response.stubs(:headers).returns({:content_disposition => "filename=\"#{File.basename(tempfile.path)}\""})
+      response
+    end
+
+    it 'download template' do
+      api_expects(:provisioning_templates, :export, 'Export template').with_params(
+        'id' => '1').returns(template_response)
+
+      output = OutputMatcher.new("The provisioning template has been saved to #{tempfile.path}")
+      expected_result = success_result(output)
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+      assert_equal('Template content', tempfile.read)
+    end
+  end
+
   describe 'update' do
     before do
       @cmd = %w(template update)
@@ -85,7 +145,6 @@ describe 'template' do
     it "doesn't send snippet flag when --type is undefined" do
       params = ['--id=1', '--locked=true']
 
-      api_expects(:template_kinds, :index, 'Get list of template kinds').returns(index_response([]))
       api_expects(:provisioning_templates, :update, 'Update the template') do |par|
         par['id'] == '1' &&
         par['provisioning_template']['locked'] == true
@@ -99,7 +158,6 @@ describe 'template' do
     it 'updates nothing without template related parameters' do
       params = %w[--id=1 --organization-id=1 --location-id=1]
 
-      api_expects(:template_kinds, :index, 'Get list of template kinds').returns(index_response([]))
       api_expects(:provisioning_templates, :update, 'Update template with no params').returns({})
 
       expected_result = success_result("Nothing to update.\n")
@@ -107,6 +165,48 @@ describe 'template' do
       result = run_cmd(@cmd + params)
       assert_cmd(expected_result, result)
     end
+
+    it 'should update a template' do
+      params = ['--id=1', '--type=snippet']
+
+      expected_result = CommandExpectation.new
+      expected_result.expected_out =
+        ['Provisioning template updated.',
+         ''].join("\n")
+      expected_result.expected_exit_code = HammerCLI::EX_OK
+
+      api_expects(:provisioning_templates, :update, 'Update template with params') do |p|
+        p['id'] == '1' && p['provisioning_template']['snippet'] == true
+      end
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'should update a template by name' do
+      params = ['--name=tpl', '--type=provision']
+
+      expected_result = CommandExpectation.new
+      expected_result.expected_out =
+        ['Provisioning template updated.',
+         ''].join("\n")
+      expected_result.expected_exit_code = HammerCLI::EX_OK
+
+      api_expects_search(:provisioning_templates, name: 'tpl').returns(
+        index_response([{ 'id' => '1' }])
+      )
+      api_expects_search(:template_kinds, name: 'provision').returns(
+        index_response([{ 'id' => '1' }])
+      )
+      api_expects(:provisioning_templates, :update, 'Update template with params') do |p|
+        p['id'] == '1' &&
+          p['provisioning_template']['snippet'] == false &&
+          p['provisioning_template']['template_kind_id'] == '1'
+      end
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
   end
 
   describe 'create' do
@@ -120,15 +220,35 @@ describe 'template' do
       expected_result = CommandExpectation.new
       expected_result.expected_err =
         ['Could not create the provisioning template:',
-         "  Error: unknown template kind",
-         '  ',
-         "  See: 'hammer template create --help'.",
+         '  Error: template_kind not found.',
          ''].join("\n")
-      expected_result.expected_exit_code = HammerCLI::EX_USAGE
+      expected_result.expected_exit_code = HammerCLI::EX_SOFTWARE
 
-      HammerCLIForeman::Template::CreateCommand.any_instance.stubs(:kinds).returns(["PXELinux"])
+      api_expects_search(:template_kinds, name: 'unknown').returns(
+        index_response([])
+      )
 
-      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'should create a template' do
+      params = ['--name=tpl', '--file=Gemfile', '--type=provision']
+
+      expected_result = CommandExpectation.new
+      expected_result.expected_out =
+        ['Provisioning template created.',
+         ''].join("\n")
+      expected_result.expected_exit_code = HammerCLI::EX_OK
+
+      api_expects_search(:template_kinds, name: 'provision').returns(
+        index_response([{ 'id' => '1' }])
+      )
+      api_expects(:provisioning_templates, :create, 'Create template with params') do |p|
+        p['provisioning_template']['name'] == 'tpl' &&
+          p['provisioning_template']['snippet'] == false &&
+          p['provisioning_template']['template_kind_id'] = '1'
+      end
 
       result = run_cmd(@cmd + params)
       assert_cmd(expected_result, result)
@@ -144,9 +264,9 @@ describe 'template' do
       params = ['create','--provisioning-template-id=10', '--hostgroup-id=1']
       expected_result = success_result("Template combination created.\n")
       api_expects(:template_combinations, :create, 'Create template combination') do |params|
-        params['provisioning_template_id'] == 10 &&
-          params['hostgroup_id'] == 1 &&
-          params['template_combination'] == {'hostgroup_id' => 1}
+        params['provisioning_template_id'] == '10' &&
+          params['hostgroup_id'] == '1' &&
+          params['template_combination'] == { 'hostgroup_id' => '1' }
       end
 
       result = run_cmd(@cmd + params)
@@ -158,9 +278,9 @@ describe 'template' do
       expected_result = success_result("Template combination updated.\n")
       api_expects(:template_combinations, :update, 'Update template combination') do |params|
         params['id'] == '3' &&
-          params['provisioning_template_id'] == 10 &&
-          params['hostgroup_id'] == 1 &&
-          params['template_combination'] == { 'hostgroup_id' => 1 }
+          params['provisioning_template_id'] == '10' &&
+          params['hostgroup_id'] == '1' &&
+          params['template_combination'] == { 'hostgroup_id' => '1' }
       end
 
       result = run_cmd(@cmd + params)

data/test/functional/user_mail_notification_test.rb

@@ -55,9 +55,9 @@ describe 'user_mail_notification' do
       params = ['--user-id=2']
 
       expected_result = common_error_result(
-          @cmd,
-          "Could not find mail_notification, please set one of options --mail-notification, --mail-notification-id.",
-          "Could not add user mail notification"
+        @cmd,
+        'Could not find mail_notification, please set one of options --mail-notification-id, --mail-notification.',
+        'Could not add user mail notification'
       )
 
       result = run_cmd(@cmd + params)

data/test/test_helper.rb

@@ -17,7 +17,7 @@ require "mocha/minitest"
 require 'hammer_cli'
 require 'hammer_cli_foreman/testing/api_expectations'
 
-FOREMAN_VERSION = ENV['TEST_API_VERSION'] || '2.5'
+FOREMAN_VERSION = ENV['TEST_API_VERSION'] || '3.1'
 unless Dir.entries('test/data').include? FOREMAN_VERSION
   raise StandardError.new "Version is not correct"
 end

data/test/unit/commands_test.rb

@@ -183,8 +183,7 @@ describe HammerCLIForeman::Command do
     out, err = capture_io do
       _(com.run(['--location', 'loc'])).wont_equal HammerCLI::EX_OK
     end
-    _(err).must_equal "Error: Could not find location, please set one of options --location, --location-title, --location-id.\n"
-
+    _(err).must_equal "Error: Could not find location, please set one of options --location-id, --location, --location-title.\n"
   end
 
   it "ignores error on attempt to search of parameters that are not required" do

data/test/unit/option_builders_test.rb

@@ -209,7 +209,9 @@ describe HammerCLIForeman::ForemanOptionBuilder do
   end
 
   context "dependent searchables options expansion" do
-    let(:option_switches) { container.build(@build_options).map(&:switches) }
+    let(:option_switches) do
+      container.build(@build_options.merge(command: Class.new(HammerCLIForeman::Command))).map(&:switches)
+    end
 
     before :each do
       container.builders = [
@@ -218,51 +220,51 @@ describe HammerCLIForeman::ForemanOptionBuilder do
       ]
     end
 
-    it "does not filter searchable builders by default" do
-      @build_options = {:expand => {}}
+    it 'does not filter searchable builders by default' do
+      @build_options = { expand: {} }
       _(option_switches).must_equal [
-        ["--user"],
-        ["--user-label"],
-        ["--user-id"],
-        ["--post"],
-        ["--post-label"],
-        ["--post-id"]
+        ['--user-id'],
+        ['--user'],
+        ['--user-label'],
+        ['--post-id'],
+        ['--post'],
+        ['--post-label']
       ]
     end
 
-    it "adds dependent searchable builders on explicit requirement" do
-      @build_options = {:expand => {:including => [:posts, :comments]}}
+    it 'adds dependent searchable builders on explicit requirement' do
+      @build_options = { expand: { including: %i[posts comments] } }
       _(option_switches).must_equal [
-        ["--user"],
-        ["--user-label"],
-        ["--user-id"],
-        ["--post"],
-        ["--post-label"],
-        ["--post-id"],
-        ["--comment"],
-        ["--comment-label"],
-        ["--comment-id"]
+        ['--user-id'],
+        ['--user'],
+        ['--user-label'],
+        ['--post-id'],
+        ['--post'],
+        ['--post-label'],
+        ['--comment-id'],
+        ['--comment'],
+        ['--comment-label']
       ]
     end
 
-    it "filters dependent searchable builders on explicit requirement" do
-      @build_options = {:expand => {:except => [:users]}}
+    it 'filters dependent searchable builders on explicit requirement' do
+      @build_options = { expand: { except: [:users] } }
       _(option_switches).must_equal [
-        ["--post"],
-        ["--post-label"],
-        ["--post-id"]
+        ['--post-id'],
+        ['--post'],
+        ['--post-label']
       ]
     end
 
-    it "specifies custom set of dependent searchable builders on explicit requirement" do
-      @build_options = {:expand => {:only => [:comments, :users]}}
+    it 'specifies custom set of dependent searchable builders on explicit requirement' do
+      @build_options = { expand: { only: %i[comments users] } }
       _(option_switches).must_equal [
-        ["--user"],
-        ["--user-label"],
-        ["--user-id"],
-        ["--comment"],
-        ["--comment-label"],
-        ["--comment-id"]
+        ['--user-id'],
+        ['--user'],
+        ['--user-label'],
+        ['--comment-id'],
+        ['--comment'],
+        ['--comment-label']
       ]
     end
   end
@@ -327,7 +329,7 @@ describe HammerCLIForeman::DependentSearchablesOptionBuilder do
   let(:resource) { api.resource(:users) }
   let(:searchables) { FakeSearchables.new(["name", "label", "uuid"]) }
   let(:builder) { HammerCLIForeman::DependentSearchablesOptionBuilder.new(resource, searchables) }
-  let(:builder_params) { {} }
+  let(:builder_params) { { command: Class.new(HammerCLIForeman::Command) } }
   let(:options) { builder.build(builder_params) }
 
   describe "empty searchables" do
@@ -339,41 +341,40 @@ describe HammerCLIForeman::DependentSearchablesOptionBuilder do
     end
   end
 
-  describe "multiple searchables" do
-
-    it "creates correct switches" do
+  describe 'multiple searchables' do
+    it 'creates correct switches' do
       _(options.map(&:switches)).must_equal [
-        ["--user"],       # first option does not have the suffix
-        ["--user-label"], # other options with suffixes
-        ["--user-uuid"],
-        ["--user-id"]     # additional id
+        ['--user-id'],    # main option from API docs
+        ['--user'],       # additional option
+        ['--user-label'], # other options with suffixes
+        ['--user-uuid']
       ]
     end
 
-    it "creates correct option types" do
-      _(options.map(&:type)).must_equal [
-        "USER_NAME",
-        "USER_LABEL",
-        "USER_UUID",
-        "USER_ID",
+    it 'creates correct option types' do
+      _(options.map(&:type)).must_equal %w[
+        USER_ID
+        USER_NAME
+        USER_LABEL
+        USER_UUID
       ]
     end
 
-    it "creates correct descriptions" do
+    it 'creates correct descriptions' do
       _(options.map(&:description)).must_equal [
-        "Search by name",
-        "Search by label",
-        "Search by uuid",
-        "DESC"
+        'DESC',
+        'Search by name',
+        'Search by label',
+        'Search by uuid'
       ]
     end
 
-    it "creates correct attribute readers" do
-      _(options.map(&:read_method)).must_equal [
-        "option_user_name",
-        "option_user_label",
-        "option_user_uuid",
-        "option_user_id",
+    it 'creates correct attribute readers' do
+      _(options.map(&:read_method)).must_equal %w[
+        option_user_id
+        option_user_name
+        option_user_label
+        option_user_uuid
       ]
     end
 
@@ -385,44 +386,48 @@ describe HammerCLIForeman::DependentSearchablesOptionBuilder do
 
   describe "aliasing resource names" do
 
-    let(:builder_params) { {:resource_mapping => {:user => :usr}} }
+    let(:builder_params) do
+      {
+        resource_mapping: { user: :usr },
+        command: Class.new(HammerCLIForeman::Command)
+      }
+    end
 
-    it "renames options" do
+    it 'renames options' do
       _(options.map(&:switches)).must_equal [
-        ["--usr"],       # first option does not have the suffix
-        ["--usr-label"], # other options with suffixes
-        ["--usr-uuid"],
-        ["--usr-id"]     # additional id
+        ['--usr-id'],    # parent option id
+        ['--usr'],       # additional option
+        ['--usr-label'], # other options with suffixes
+        ['--usr-uuid']
       ]
     end
 
-    it "renames option types" do
-      _(options.map(&:type)).must_equal [
-        "USR_NAME",
-        "USR_LABEL",
-        "USR_UUID",
-        "USR_ID",
+    it 'renames option types' do
+      _(options.map(&:type)).must_equal %w[
+        USR_ID
+        USR_NAME
+        USR_LABEL
+        USR_UUID
       ]
     end
 
-    it "keeps option accessor the same" do
-      _(options.map(&:attribute_name)).must_equal [
-        "option_user_name",
-        "option_user_label",
-        "option_user_uuid",
-        "option_user_id"
+    it 'keeps option accessor the same' do
+      _(options.map(&:attribute_name)).must_equal %w[
+        option_user_id
+        option_user_name
+        option_user_label
+        option_user_uuid
       ]
     end
   end
 
-  describe "resources with id parameter in show action" do
-
-    it "uses descriptions from the action" do
+  describe 'resources with id parameter in show action' do
+    it 'uses descriptions from the action' do
       _(options.map(&:description)).must_equal [
-        "Search by name",
-        "Search by label",
-        "Search by uuid",
-        "DESC"
+        'DESC',
+        'Search by name',
+        'Search by label',
+        'Search by uuid'
       ]
     end
   end

data/test/unit/option_sources/id_params_test.rb

@@ -26,14 +26,5 @@ describe HammerCLIForeman::OptionSources::IdParams do
       params = id_params_source.get_options([], option_data)
       _(params).must_equal expected_data
     end
-
-    it 'resolves param when set but different name' do
-      hg_cmd.stubs(:get_resource_id).returns(nil)
-      hg_cmd.expects(:get_resource_id).with { |res| res.name == :domains }.returns(3)
-      option_data = { 'option_domain_id' => 1, 'option_domain_name' => 'test3' }
-      expected_data = { 'option_domain_id' => 3, 'option_domain_name' => 'test3' }
-      params = id_params_source.get_options([], option_data)
-      _(params).must_equal expected_data
-    end
   end
 end

data/test/unit/option_sources/ids_params_test.rb

@@ -26,14 +26,5 @@ describe HammerCLIForeman::OptionSources::IdsParams do
       params = ids_params_source.get_options([], option_data)
       _(params).must_equal expected_data
     end
-
-    it "resolves param when set but different name" do
-      cmd.stubs(:get_resource_ids).returns(nil)
-      cmd.expects(:get_resource_ids).with { |res| res.name == :locations }.returns([3])
-      option_data = { 'option_location_ids' => [1], 'option_location_names' => 'test3' }
-      expected_data = { 'option_location_ids' => [3], 'option_location_names' => 'test3' }
-      params = ids_params_source.get_options([], option_data)
-      _(params).must_equal expected_data
-    end
   end
 end