hammer_cli_foreman 0.6.2 → 0.7.0

data/test/data/README.md

@@ -7,11 +7,16 @@
     ```bash
     $ APIPIE_RECORD=examples rake test:functionals
     ```
- 1. on the **Foreman instance** generate API documentation cache. It will land in `/usr/share/foreman/public/apipie-cache/apidoc.json`
+ 1. on the **Foreman instance** generate API documentation cache. It will land in `/usr/share/foreman/public/apipie-cache/apidoc/v2.en.json`
 
     ```bash
     $ FOREMAN_APIPIE_LANGS=en foreman-rake apipie:cache
     ```
+ 1. when running from **git**, run a similar command and it will land in `$FOREMAN_CHECKOUT/public/apipie-cache/apidoc/v2.en.json`
+
+    ```bash
+    $ FOREMAN_APIPIE_LANGS=en rake apipie:cache
+    ```
  1. in **hammer-cli-foreman** in `test/unit/data/` Create directory with name matching the Foreman version in `test/unit/data/` (e.g. `test/unit/data/1.10`)
  1. copy the API cache from the Foreman instance into the newly created directory and name it as `foreman_api.json`
  1. update the following line in `test/unit/test_helper.rb` to match the new default Foreman version

data/test/functional/commands/list_test.rb

@@ -0,0 +1,141 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+describe HammerCLIForeman::ListCommand do
+  class TestList < HammerCLIForeman::ListCommand
+    resource :domains
+
+    option '--page', 'PAGE', ''
+    option '--per-page', 'PER_PAGE', ''
+  end
+
+  class TestListWithOutput < TestList
+    output do
+      field :id, "Id"
+      field :name, "Name"
+    end
+  end
+
+  def build_items(cnt)
+    (1..cnt).map do |i|
+      {:id => i, :name => "Item #{i}"}
+    end
+  end
+
+  def expect_paged_call(page, per_page, item_cnt, response_metadata={})
+    api_expects(:domains, :index, "List records page #{page}") do |par|
+      par["page"].to_i == page && par["per_page"].to_i == per_page
+    end.returns(index_response(build_items(item_cnt), response_metadata))
+  end
+
+  let(:per_page_all) { HammerCLIForeman::ListCommand::RETRIEVE_ALL_PER_PAGE }
+
+  after do
+    HammerCLI::Settings.clear
+  end
+
+  describe "api interaction" do
+    context "without per_page in settings" do
+      it "fetches only first page when there's not enough records" do
+        expect_paged_call(1, 1000, 10)
+        result = run_cmd([], {}, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+
+      it "fetches all records" do
+        expect_paged_call(1, per_page_all, 1000)
+        expect_paged_call(2, per_page_all, 1000)
+        expect_paged_call(3, per_page_all, 10)
+
+        result = run_cmd([], {}, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+
+      it "uses --per-page value" do
+        per_page = 10
+        expect_paged_call(1, per_page, 10)
+        result = run_cmd(["--per-page=#{per_page}"], {}, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+
+      it "uses both --per-page and --page value" do
+        per_page = 10
+        expect_paged_call(2, per_page, 10)
+        result = run_cmd(["--per-page=#{per_page}", '--page=2'], {}, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+
+      it "sets per_page to 20 when only --page is used" do
+        expect_paged_call(2, 20, 10)
+        result = run_cmd(['--page=2'], {}, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+    end
+
+    context "with per_page in settings" do
+      let(:per_page_in_settings) { 30 }
+      before do
+        HammerCLI::Settings.load({ :ui => { :per_page => per_page_in_settings } })
+      end
+
+      it "gives preference to --per-page option over per_page setting" do
+        per_page = 10
+        expect_paged_call(1, per_page, 10)
+        result = run_cmd(["--per-page=#{per_page}"], {}, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+
+      it "respects per_page setting when the adapter allows pagination by default" do
+        expect_paged_call(1, per_page_in_settings, 30)
+        result = run_cmd([], { :adapter => :base, :interactive => false }, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+
+      it "fetches all records when the adapter doesn't allow pagination by default" do
+        expect_paged_call(1, per_page_all, 1000)
+        expect_paged_call(2, per_page_all, 10)
+        result = run_cmd([], { :adapter => :csv, :interactive => false }, TestList)
+        result.exit_code.must_equal HammerCLI::EX_OK
+      end
+    end
+  end
+
+  describe "pagination output" do
+    let(:row_data) { ['1', 'Item 1'] }
+    let(:header) { ['ID', 'NAME'] }
+    let(:pagination) { ['Page 1 of 2 (use --page and --per-page for navigation)'] }
+    let(:output_without_pagination) { IndexMatcher.new([header, row_data]) }
+    let(:output_with_pagination) { IndexMatcher.new([header, row_data, pagination]) }
+    let(:pagination_line_re) { /Page [1-9] of [0-9]/ }
+
+    it 'prints all rows by default' do
+      expected_result = success_result(output_without_pagination)
+      expect_paged_call(1, per_page_all, 1)
+
+      result = run_cmd([], {}, TestListWithOutput)
+      assert_cmd(expected_result, result)
+      result.out.wont_match pagination_line_re
+    end
+
+    it 'prints one page when --per-page is used' do
+      expected_result = success_result(output_with_pagination)
+      expect_paged_call(1, 1, 1, :total => 2, :subtotal => 2, :per_page => 1, :page => 1)
+
+      result = run_cmd(['--per-page=1'], {}, TestListWithOutput)
+      assert_cmd(expected_result, result)
+    end
+
+    context 'with per_page in settings' do
+      before do
+        HammerCLI::Settings.load({ :ui => { :per_page => '1' } })
+      end
+
+      it 'prints one page when per_page is set in the config' do
+        expected_result = success_result(output_with_pagination)
+        expect_paged_call(1, 1, 1, :total => 2, :subtotal => 2, :per_page => 1, :page => 1)
+
+        result = run_cmd([], {}, TestListWithOutput)
+        assert_cmd(expected_result, result)
+      end
+    end
+  end
+end

data/test/functional/organization_test.rb

@@ -138,3 +138,74 @@ describe "parameters" do
     end
   end
 end
+
+describe 'associating commands' do
+  def failure_test(message, &block)
+    error = Errno::ECONNREFUSED.new 'connect(2) for "testhost" port 3000'
+    block.call.raises(error)
+    result = run_cmd(@cmd + @params)
+    expected = common_error_result(
+      @cmd,
+      error.message,
+      message
+    )
+    assert_cmd(expected, result)
+  end
+
+  describe 'add domain' do
+    before do
+      @cmd = %w(organization add-domain)
+      @params = %w(--id=1 --domain-id=5)
+    end
+
+    it "should output success message" do
+      api_expects(:organizations, :show, 'Find organization') do |par|
+        par[:id] == '1'
+      end.returns({:id => 1, 'domains' => [{'id' => '1'}]})
+      api_expects(:organizations, :update, 'Update organization') do |par|
+        par['id'] == '1' &&
+          par['organization']['domain_ids'] == ['1', '5']
+      end
+      result = run_cmd(@cmd + @params)
+      expected = success_result("The domain has been associated\n")
+      assert_cmd(expected, result)
+    end
+
+    it "should output failure message" do
+      failure_test "Could not associate the domain" do
+        api_expects(:organizations, :show, 'Find organization') do |par|
+          par[:id] == '1'
+        end
+      end
+    end
+  end
+
+  describe 'remove domain' do
+    before do
+      @cmd = %w(organization remove-domain)
+      @params = %w(--id=1 --domain-id=5)
+    end
+
+    it "should output success message" do
+      domains = ['1', '5'].map { |x| { 'id' => x } }
+      api_expects(:organizations, :show, 'Find organization') do |par|
+        par[:id] == '1'
+      end.returns({:id => 1, 'domains' => domains})
+      api_expects(:organizations, :update, 'Update organization') do |par|
+        par['id'] == '1' &&
+          par['organization']['domain_ids'] == ['1']
+      end
+      result = run_cmd(@cmd + @params)
+      expected = success_result("The domain has been disassociated\n")
+      assert_cmd(expected, result)
+    end
+
+    it "should output failure message" do
+      failure_test "Could not disassociate the domain" do
+        api_expects(:organizations, :show, 'Find organization') do |par|
+          par[:id] == '1'
+        end
+      end
+    end
+  end
+end

data/test/functional/smart_class_parameter_test.rb

@@ -19,3 +19,64 @@ describe 'sc-params update' do
   end
 
 end
+
+describe 'sc-params add-override-value' do
+  let(:cmd) { %w(sc-param add-override-value) }
+  let(:override_value) { 'something' }
+  let(:match) { 'domain = example.com' }
+  let(:puppet_class) { { 'name' => 'motd', 'id' => '1' } }
+  let(:parameter) { { 'name' => 'content', 'id' => '2' } }
+  let(:base) { [
+    '--puppet-class', puppet_class['name'],
+    '--smart-class-parameter', parameter['name'],
+    '--match', match
+  ] }
+
+  it 'allows to set value' do
+    params = ['--value', override_value]
+    expected_result = success_result("Override value created\n")
+
+    prepare_api_expectations = proc do
+      expectations = []
+      expectations << api_expects(:puppetclasses, :index, 'Find puppet class') do |par|
+        par[:search] == %Q(name = "#{puppet_class['name']}")
+      end.returns(index_response('motd' => [puppet_class]))
+
+      expectations << api_expects(:smart_class_parameters, :index, 'Find smart parameter') do |par|
+        par[:search] == %Q(key = "#{parameter['name']}") &&
+          par[:puppetclass_id] == puppet_class['id']
+      end.returns(index_response([parameter]))
+
+      expectations << api_expects(:override_values, :create, 'Create override value') do |par|
+        val = par['override_value']
+        par['smart_class_parameter_id'] == parameter['id'] &&
+          val['match'] == match &&
+          val['value'] == override_value
+      end
+    end
+
+    expectations = prepare_api_expectations.call()
+    result = run_cmd(cmd + base + params)
+    assert_cmd(expected_result, result)
+    assert expectations.all?(&:verified?)
+
+    expectations = prepare_api_expectations.call()
+    result = run_cmd(cmd + base + params + ['--use-puppet-default', false])
+    assert_cmd(expected_result, result)
+    assert expectations.all?(&:verified?)
+  end
+
+  it 'does not allow to use puppet default and value at the same time' do
+    params = ['--value', 'something', '--use-puppet-default', true]
+
+    expected_result = usage_error_result(
+      cmd,
+      "Cannot use --value when --use-puppet-default is true",
+      'Could not create the override value'
+    )
+
+    api_expects_no_call
+    result = run_cmd(cmd + base + params)
+    assert_cmd(expected_result, result)
+  end
+end

data/test/functional/template_test.rb

@@ -0,0 +1,80 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'template' do
+  describe 'clone' do
+    before do
+      @cmd = %w(template clone)
+    end
+
+    it 'should print error on missing --id' do
+      params = ['--new-name=zzz']
+
+      expected_result = CommandExpectation.new
+      expected_result.expected_err =
+        ['Could not clone the config template:',
+         "  Missing arguments for 'id'",
+         ''].join("\n")
+      expected_result.expected_exit_code = HammerCLI::EX_USAGE
+
+      api_expects_no_call
+
+      result = run_cmd(@cmd + params)
+
+      assert_cmd(expected_result, result)
+    end
+
+    it 'should print error on missing --new-name' do
+      params = ['--id=1']
+
+      expected_result = usage_error_result(
+        @cmd,
+        'Option --new-name is required',
+        'Could not clone the config template')
+
+      api_expects_no_call
+
+      result = run_cmd(@cmd + params)
+
+      assert_cmd(expected_result, result)
+    end
+
+    it 'should clone a template by id' do
+      params = ['--id=1', '--new-name=zzz']
+
+      api_expects(:config_templates, :clone, 'Clone template') do |par|
+        par['id'] == '1' && par['config_template']['name'] == 'zzz'
+      end.returns(:name => 'A', :value => '1')
+
+      result = run_cmd(@cmd + params)
+
+      assert_cmd(success_result("Config template cloned\n"), result)
+    end
+
+    it 'should clone a template by name' do
+      params = ['--name=old', '--new-name=zzz']
+
+      api_expects(:config_templates, :index, 'Attempt find template') do |par|
+        par[:search] == 'name = "old"'
+      end.returns(
+        index_response(
+          [{
+            'snippet' => false,
+            'audit_comment' => nil,
+            'created_at' => '2016-02-29 14:32:57 UTC',
+            'updated_at' => '2016-02-29 14:32:57 UTC',
+            'id' => 1,
+            'name' => 'zzz',
+            'template_kind_id' => 7,
+            'template_kind_name' => 'user_data'
+          }]))
+
+      api_expects(:config_templates, :clone, 'Clone template') do |par|
+        par['id'] == 1 && par['config_template']['name'] == 'zzz'
+      end.returns(:name => 'A', :value => '1')
+
+      result = run_cmd(@cmd + params)
+
+      assert_cmd(success_result("Config template cloned\n"), result)
+    end
+  end
+end

data/test/functional/test_helper.rb

@@ -1,7 +1,10 @@
 require File.join(File.dirname(__FILE__), '../test_helper')
 
 require 'hammer_cli/testing/command_assertions'
+require 'hammer_cli/testing/output_matchers'
+
 require 'hammer_cli_foreman/testing/api_expectations'
 
 include HammerCLI::Testing::CommandAssertions
+include HammerCLI::Testing::OutputMatchers
 include HammerCLIForeman::Testing::APIExpectations

data/test/reports/TEST-HammerCLIForeman-Architecture-CreateCommand-parameters.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="HammerCLIForeman::Architecture::CreateCommand::parameters" tests="2" time="0.010592708" failures="0" errors="0" skipped="0" assertions="2">
+  <testcase name="test_0002_should fail with name missing" time="0.008160524" assertions="1">
+  </testcase>
+  <testcase name="test_0001_should accept name" time="0.002136914" assertions="1">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/test/reports/TEST-HammerCLIForeman-Architecture-CreateCommand.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="HammerCLIForeman::Architecture::CreateCommand" tests="0" time="0.000420125" failures="0" errors="0" skipped="0" assertions="0">
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/test/reports/TEST-HammerCLIForeman-Architecture-DeleteCommand-parameters.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="HammerCLIForeman::Architecture::DeleteCommand::parameters" tests="3" time="0.005292196" failures="0" errors="0" skipped="0" assertions="3">
+  <testcase name="test_0003_should fail with name or id missing" time="0.00155957" assertions="1">
+  </testcase>
+  <testcase name="test_0002_should accept id" time="0.001930339" assertions="1">
+  </testcase>
+  <testcase name="test_0001_should accept name" time="0.001509438" assertions="1">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/test/reports/TEST-HammerCLIForeman-Architecture-DeleteCommand.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="HammerCLIForeman::Architecture::DeleteCommand" tests="0" time="0.000534332" failures="0" errors="0" skipped="0" assertions="0">
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/test/reports/TEST-HammerCLIForeman-Architecture-InfoCommand-output.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="HammerCLIForeman::Architecture::InfoCommand::output" tests="3" time="0.008668972" failures="0" errors="0" skipped="0" assertions="5">
+  <testcase name="test_0001_should print 1 records" time="0.003258728" assertions="1">
+  </testcase>
+  <testcase name="test_0002_should print column Name" time="0.002410385" assertions="2">
+  </testcase>
+  <testcase name="test_0003_should print column Id" time="0.002710322" assertions="2">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>