hammer_cli_foreman 2.1.2 → 2.4.0

data/test/functional/realm_test.rb

@@ -0,0 +1,103 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'realm' do
+  describe 'list' do
+    before do
+      @cmd = %w[realm list]
+      @realms =
+        [{
+           id: 1,
+           name: 'test-realm' }]
+    end
+
+    it 'should return a list of realms' do
+      api_expects(:realms, :index, 'List realms').returns(@realms)
+
+      result = run_cmd(@cmd)
+      _(result.exit_code).must_equal HammerCLI::EX_OK
+    end
+  end
+
+  describe 'info' do
+    before do
+      @cmd = %w[realm info]
+      @realm = {
+          id: 1,
+          name: 'test-realm'
+      }
+    end
+
+    it 'should return a realm' do
+      params = ['--id=1']
+      api_expects(:realms, :show, 'Show realm').returns(@realm)
+
+      result = run_cmd(@cmd + params)
+      _(result.exit_code).must_equal HammerCLI::EX_OK
+    end
+  end
+
+  describe 'create' do
+    before do
+      @cmd = %w[realm create]
+    end
+
+    it 'should print error on missing --name, --realm-proxy-id, --realm-type' do
+      expected_result = "Could not create the realm:\n  Missing arguments for '--name', '--realm-proxy-id', '--realm-type'.\n"
+
+      api_expects_no_call
+      result = run_cmd(@cmd)
+      assert_match(expected_result, result.err)
+    end
+
+    it 'should create a realm' do
+      params = %w[--name=test-realm --realm-proxy-id=12345 --realm-type=FreeIPA]
+
+      api_expects(:realms, :create, 'Create a realm') do |params|
+        (params['realm']['name'] == 'test-realm' &&
+         params['realm']['realm_proxy_id'] == 12345 &&
+         params['realm']['realm_type'] == 'FreeIPA')
+      end
+
+      result = run_cmd(@cmd + params)
+
+      assert_cmd(success_result("Realm [%{name}] created.\n"), result)
+    end
+  end
+
+  describe 'delete' do
+    before do
+      @cmd = %w[realm delete]
+    end
+
+    it 'should delete a realm' do
+      params = ['--id=1']
+
+      api_expects(:realms, :destroy, 'Delete realm').with_params(id: '1')
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Realm [%{name}] deleted.\n"), result)
+    end
+  end
+
+  describe 'update' do
+    before do
+      @cmd = %w[realm update]
+      @realm = {
+        id: 1,
+        name: 'test-realm-update'
+      }
+    end
+
+    it 'should update a realm' do
+      params = %w[--id=1 --new-name=test-realm-update]
+
+      api_expects(:realms, :update, 'Update a realm') do |params|
+        (params['id'] == '1' &&
+         params['realm']['name'] == 'test-realm-update')
+      end
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Realm [%{name}] updated.\n"), result)
+    end
+  end
+end

data/test/functional/role_test.rb

@@ -40,9 +40,9 @@ describe 'role' do
     it 'should clone a role by id' do
       params = ['--id=1', '--new-name=zzz']
 
-      api_expects(:roles, :clone, 'Clone role').with_params({
-        'id' => '1', 'role' => {'name' => 'zzz'}, 'name' => 'zzz'
-      })
+      api_expects(:roles, :clone, 'Clone role').with_params(
+        { 'id' => '1', 'role' => { 'name' => 'zzz' } }
+      )
 
       result = run_cmd(@cmd + params)
       assert_cmd(success_result("User role cloned.\n"), result)
@@ -51,16 +51,13 @@ describe 'role' do
     it 'should clone a role by name' do
       params = ['--name=old', '--new-name=zzz']
 
-      api_expects_search(:roles, { :name => 'old' }, 'Attempt find role').returns(
-        index_response(
-          [{
-              'name' => 'old',
-              'id' => 1
-          }]))
+      api_expects_search(:roles, { name: 'old' }, 'Attempt find role').returns(
+        index_response([{ 'name' => 'old', 'id' => 1 }])
+      )
 
-      api_expects(:roles, :clone, 'Clone role').with_params({
-        'id' => 1, 'role' => {'name' => 'zzz'}, 'name' => 'zzz'
-      })
+      api_expects(:roles, :clone, 'Clone role').with_params(
+        { 'id' => 1, 'role' => { 'name' => 'zzz' } }
+      )
 
       result = run_cmd(@cmd + params)
       assert_cmd(success_result("User role cloned.\n"), result)

data/test/functional/settings_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', 'test_helper')
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe 'Settings' do
   let(:setting) do
@@ -31,6 +31,83 @@ describe 'Settings' do
       assert_cmd(expected_result, result)
     end
 
+    it 'should run list command with defaults' do
+      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.1')) }
+      defaults = HammerCLI::Defaults.new(
+        {
+          organization_id: {
+            provider: 'foreman'
+          },
+          location_id: {
+            provider: 'foreman'
+          }
+        }
+      )
+      defaults.stubs(:write_to_file).returns(true)
+      defaults.stubs(:providers).returns(providers)
+      api_expects(:settings, :index, 'List').with_params(
+        'page' => 1, 'per_page' => 1000
+      ).returns(index_response([setting]))
+
+      result = run_cmd(@cmd, { use_defaults: true, defaults: defaults })
+      _(result.exit_code).must_equal HammerCLI::EX_OK
+    end
+  end
+
+  describe 'info' do
+    before do
+      @cmd = ['setting', 'info']
+      @setting = {
+        description: 'Fix DB cache on next Foreman restart',
+        category: 'Setting::General',
+        settings_type: 'boolean',
+        default: false,
+        created_at: "2020-05-24 09:02:11 UTC",
+        updated_at: "2020-07-01 07:42:14 UTC",
+        id: 1,
+        name: "fix_db_cache",
+        full_name: "Fix DB cache",
+        value: false,
+        category_name: "General"
+      }
+    end
+
+    it 'should return a setting' do
+      params = ['--id=1']
+      api_expects(:settings, :show, 'Show a setting').returns(@setting)
+
+      output = OutputMatcher.new([
+                                   'Id:            1',
+                                   'Name:          fix_db_cache',
+                                   'Description:   Fix DB cache on next Foreman restart',
+                                   'Category:      General',
+                                   'Settings type: boolean',
+                                   'Value:         false'
+                                 ])
+
+      expected_result = success_result(output)
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'update' do
+    before do
+      @cmd = ['setting', 'set']
+    end
+
+    it 'should update a setting' do
+      params = ['--id=1', '--value=true']
+
+      api_expects(:settings, :update, 'Update a setting') do |params|
+        (params['setting']['id'] == '1')
+        (params['setting']['value'] == 'true')
+      end
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Setting [%{name}] updated to [%{value}].\n"), result)
+    end
   end
 
 end

data/test/functional/status_test.rb

@@ -1,24 +1,60 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
+BASIC_STATUS = {
+  'database' => { 'active' => true, 'duration_ms' => 0 },
+  'version' => '1.24.0-develop',
+  'api' => { 'version' => 'v2' },
+  'plugins' => [],
+  'smart_proxies' => [],
+  'compute_resources' => []
+}
+
+STRING_STATUS = Marshal.load(Marshal.dump(BASIC_STATUS)).merge({
+  'plugins' => [
+    'Foreman plugin: foreman_ansible, 6.0.1, Daniel Lobato Garcia, Ansible integration with Foreman'
+  ]
+})
+
+STRUCTURED_STATUS = Marshal.load(Marshal.dump(BASIC_STATUS)).merge({
+  'plugins' => [
+    {'name': 'foreman_ansible', 'version': '6.0.1'}
+  ]
+})
+
 describe 'status' do
   let(:base_cmd) { %w[status] }
 
   describe 'foreman' do
     let(:cmd) { base_cmd << 'foreman' }
-    let(:status_results) do
-      {
-        'results' => {
-          'foreman' => {
-            'database' => { 'active' => true, 'duration_ms' => 0 },
-            'version' => '1.24.0-develop',
-            'api' => { 'version' => 'v2' },
-            'plugins' => [],
-            'smart_proxies' => [],
-            'compute_resources' => []
-          }
-        }
-      }
+    let(:status_results) { {'results' => {'foreman' => BASIC_STATUS }} }
+
+    it 'checks status of the foreman system' do
+      api_expects(:ping, :statuses, 'Status').returns(status_results)
+
+      output = OutputMatcher.new(
+        [
+          'Version:           1.24.0-develop',
+          'API Version:       v2',
+          'Database:',
+          '    Status:          ok',
+          '    Server Response: Duration: 0ms',
+          'Plugins:',
+          '',
+          'Smart Proxies:',
+          '',
+          'Compute Resources:'
+        ]
+      )
+
+      expected_result = success_result(output)
+      result = run_cmd(cmd)
+      assert_cmd(expected_result, result)
     end
+  end
+
+  describe 'foreman with string plugins' do
+    let(:cmd) { base_cmd << 'foreman' }
+    let(:status_results) { {'results' => {'foreman' => STRING_STATUS }} }
 
     it 'checks status of the foreman system' do
       api_expects(:ping, :statuses, 'Status').returns(status_results)
@@ -31,7 +67,37 @@ describe 'status' do
           '    Status:          ok',
           '    Server Response: Duration: 0ms',
           'Plugins:',
+          ' 1) Name:    foreman_ansible',
+          '    Version: 6.0.1',
+          'Smart Proxies:',
           '',
+          'Compute Resources:'
+        ]
+      )
+
+      expected_result = success_result(output)
+      result = run_cmd(cmd)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'foreman with structured plugins' do
+    let(:cmd) { base_cmd << 'foreman' }
+    let(:status_results) { {'results' => {'foreman' => STRUCTURED_STATUS }} }
+
+    it 'checks status of the foreman system' do
+      api_expects(:ping, :statuses, 'Status').returns(status_results)
+
+      output = OutputMatcher.new(
+        [
+          'Version:           1.24.0-develop',
+          'API Version:       v2',
+          'Database:',
+          '    Status:          ok',
+          '    Server Response: Duration: 0ms',
+          'Plugins:',
+          ' 1) Name:    foreman_ansible',
+          '    Version: 6.0.1',
           'Smart Proxies:',
           '',
           'Compute Resources:'

data/test/functional/user_test.rb

@@ -162,4 +162,43 @@ describe "user" do
       end
     end
   end
+
+  describe 'list' do
+    let(:cmd) { ['user', 'list'] }
+    let(:users) do
+      [{
+           id: 1,
+           login: 'admin',
+           full_name: 'Admin User',
+           mail: 'root@localadmin.net',
+           admin: true,
+           disabled: false
+       }] end
+
+    it "should show index list" do
+      api_expects(:users, :index).returns(users)
+
+      output = IndexMatcher.new([
+                                    ['ID', 'LOGIN', 'NAME', 'EMAIL', 'ADMIN', 'DISABLED', 'AUTHORIZED BY'],
+                                    ['1',  'admin', 'Admin User', 'root@localadmin.net', 'yes', 'no', ''],
+                                ])
+
+      result = run_cmd(cmd)
+      assert_cmd(success_result(output), result)
+    end
+  end
+
+  describe 'delete' do
+    let(:cmd) { ['user', 'delete']  }
+
+    it 'deletes a user' do
+      params = ['--id', user['id']]
+      api_expects(:users, :destroy).returns(user)
+
+      expected_result = success_result("User [#{user['login']}] deleted.\n")
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
 end

data/test/functional/usergroup_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'user-group' do
+  describe 'list' do
+    before do
+      @cmd = %w[user-group list]
+      @user_groups = [{
+                          id: 1,
+                          name: 'test-user-group',
+                          admin: 'yes',
+                        }]
+    end
+
+    it 'should return a list of user groups' do
+      api_expects(:usergroups, :index, 'List user groups').returns(@user_groups)
+
+      output = IndexMatcher.new([
+                                  %w[ID NAME ADMIN],
+                                  %w[1 test-user-group yes]
+                                ])
+      expected_result = success_result(output)
+
+      result = run_cmd(@cmd)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'should run list command with defaults' do
+      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.1')) }
+      defaults = HammerCLI::Defaults.new(
+        {
+          organization_id: {
+            provider: 'foreman'
+          },
+          location_id: {
+            provider: 'foreman'
+          }
+        }
+      )
+      defaults.stubs(:write_to_file).returns(true)
+      defaults.stubs(:providers).returns(providers)
+      api_expects(:usergroups, :index, 'List user groups').returns(@user_groups)
+
+      result = run_cmd(@cmd, { use_defaults: true, defaults: defaults })
+      _(result.exit_code).must_equal HammerCLI::EX_OK
+    end
+  end
+end
+
+

data/test/test_helper.rb

@@ -17,11 +17,14 @@ require "mocha/minitest"
 require 'hammer_cli'
 require 'hammer_cli_foreman/testing/api_expectations'
 
-FOREMAN_VERSION = Gem::Version.new(ENV['TEST_API_VERSION'] || '2.1')
+FOREMAN_VERSION = ENV['TEST_API_VERSION'] || '2.1'
+unless Dir.entries('test/data').include? FOREMAN_VERSION
+  raise StandardError.new "Version is not correct"
+end
 
 include HammerCLIForeman::Testing::APIExpectations
 HammerCLI.context[:api_connection].create('foreman') do
-  api_connection({}, FOREMAN_VERSION)
+  api_connection({}, Gem::Version.new(FOREMAN_VERSION))
 end
 
 require 'hammer_cli_foreman'