hammer_cli_foreman 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c478d3535da7a22a10907ad8838baedd0dd1ad9cd3f5168cadab57ef5cc61e53
-  data.tar.gz: d362b8e3e44db4ec092ea2451363be8875cbd1576aaa14e4f8b3652b19ae483f
+  metadata.gz: 1cb3de28c168226867cc9b1f4f63ea96bf2ff8746b831e2cdf01e6fe6670a53b
+  data.tar.gz: 55b321941992865b2339fd1e0d11b3845c1396c0699f90c52ab4ba774974b70f
 SHA512:
-  metadata.gz: 1bebff2d84aacc7ed3053a64920ff86b1420f10d98fc2cfba91a627d69722d5d9866afbf31131c25868ecdf705161ec0401aeaa338f26a5f2f97476664fd1704
-  data.tar.gz: 5dd93dbc8bfff2308ee1768c80ed545dd452278fa0753d2b7016d80ba659741b4c39c1f1b99aa27149e546bc2628b08bcc84419ab5f85cb8ab2ef673952c2581
+  metadata.gz: 7e50e0beb69a60b01613b3d7c282b927e54872de4533364e079f768e22f4a1e63aea967d7113e72a32ee35a20d4475a1cefef03055af956027e7fb3ce0fde00e
+  data.tar.gz: 8ec8cc1402c57faa1b5bbb960bb9b4963e2c4c0e21b9e0a62e88c7e02ca2a01f976c83795c21b7c801aa635842df6fc5fb0794283bd8f666364bd91f404c661d

data/doc/release_notes.md

@@ -1,5 +1,23 @@
 Release notes
 =============
+### 2.3.0 (2020-11-03)
+* Hammer ping skip authentication ([PR #550](https://github.com/theforeman/hammer-cli-foreman/pull/550)), [#31140](http://projects.theforeman.org/issues/31140)
+* Return non-zero exit code if services failed, [#30496](http://projects.theforeman.org/issues/30496)
+* Better option assignment for nested params ([PR #544](https://github.com/theforeman/hammer-cli-foreman/pull/544)), [#30910](http://projects.theforeman.org/issues/30910)
+* Use parent resource instead of hardcoded one, [#30938](http://projects.theforeman.org/issues/30938)
+* Added missing tests to setting, [#30886](http://projects.theforeman.org/issues/30886)
+* Added missing tests to installation medium test, [#30805](http://projects.theforeman.org/issues/30805)
+* Added missing tests to location test, [#30829](http://projects.theforeman.org/issues/30829)
+* Added missing tests to organization test, [#30794](http://projects.theforeman.org/issues/30794)
+* Added missing tests to audit test ([PR #537](https://github.com/theforeman/hammer-cli-foreman/pull/537)), [#30740](http://projects.theforeman.org/issues/30740)
+* Use underscores in `login oauth` option values ([PR #536](https://github.com/theforeman/hammer-cli-foreman/pull/536)), [#30720](http://projects.theforeman.org/issues/30720)
+* Drop trends from hammer-cli-foreman ([PR #535](https://github.com/theforeman/hammer-cli-foreman/pull/535)), [#30134](http://projects.theforeman.org/issues/30134)
+* Added highly available option to ovirt ([PR #532](https://github.com/theforeman/hammer-cli-foreman/pull/532)), [#30494](http://projects.theforeman.org/issues/30494)
+* Add ptables and realms to location and organization info ([PR #534](https://github.com/theforeman/hammer-cli-foreman/pull/534)), [#30663](http://projects.theforeman.org/issues/30663)
+* Bump to 2.3.0-develop
+* Bump to 2.2.0
+* Added missing tests to user test, [#30593](http://projects.theforeman.org/issues/30593)
+
 ### 2.2.0 (2020-08-11)
 * Change config templates to provisioning templates ([PR #531](https://github.com/theforeman/hammer-cli-foreman/pull/531)), [#29971](http://projects.theforeman.org/issues/29971)
 * Fix minitest deprecation ([PR #523](https://github.com/theforeman/hammer-cli-foreman/pull/523))

data/lib/hammer_cli_foreman.rb

@@ -178,10 +178,6 @@ module HammerCLIForeman
       'HammerCLIForeman::StatusCommand', 'hammer_cli_foreman/status'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('trend', _("Manage trends"),
-                                           'HammerCLIForeman::Trend', 'hammer_cli_foreman/trend'
-    )
-
     HammerCLI::MainCommand.lazy_subcommand('mail-notification', _("Manage mail notifications"),
                                            'HammerCLIForeman::MailNotification', 'hammer_cli_foreman/mail_notification'
     )

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -280,7 +280,7 @@ module HammerCLIForeman
         def request_params
           params = super
 
-          template_ids = params['operatingsystem']['provisioning_template_ids']
+          template_ids = params[resource.singular_name]['provisioning_template_ids']
           if options['option_provisioning_template_search']
             templates = HammerCLIForeman.collection_to_common_format(
               associated_resource.call(
@@ -294,7 +294,7 @@ module HammerCLIForeman
               template_ids.delete(template_id.to_s)
             end
           end
-          params['operatingsystem']['provisioning_template_ids'] = template_ids.uniq
+          params[resource.singular_name]['provisioning_template_ids'] = template_ids.uniq
           params
         end
 

data/lib/hammer_cli_foreman/auth.rb

@@ -36,11 +36,11 @@ module HammerCLIForeman
 
         option ["-u", "--username"], "USERNAME", _("Username to access the remote system")
         option ["-p", "--password"], "PASSWORD", _("Password to access the remote system")
-        option ["-t", "--oidc-token-endpoint"], "OPENIDC-TOKEN-ENDPOINT", _("Openidc provider URL which issues access token")
-        option ["-a", "--oidc-authorization-endpoint"], "OPENIDC-AUTHORIZATION-ENDPOINT", _("Openidc provider URL which issues authentication code (two factor only)")
-        option ["-c", "--oidc-client-id"], "OPENIDC-CLIENT-ID", _("Client id used in the Openidc provider")
+        option ["-t", "--oidc-token-endpoint"], "OPENIDC_TOKEN_ENDPOINT", _("Openidc provider URL which issues access token")
+        option ["-a", "--oidc-authorization-endpoint"], "OPENIDC_AUTHORIZATION_ENDPOINT", _("Openidc provider URL which issues authentication code (two factor only)")
+        option ["-c", "--oidc-client-id"], "OPENIDC_CLIENT_ID", _("Client id used in the Openidc provider")
         option ["-f", "--two-factor"], :flag, _("Authenticate with two factor")
-        option ["-r", "--oidc-redirect-uri"], "OPENIDC-REDIRECT-URI", _("Redirect URI for the authentication code grant flow")
+        option ["-r", "--oidc-redirect-uri"], "OPENIDC_REDIRECT_URI", _("Redirect URI for the authentication code grant flow")
 
         def execute
           if option_two_factor?

data/lib/hammer_cli_foreman/command_extensions/ping.rb

@@ -6,9 +6,18 @@ module HammerCLIForeman
           status = data['results']['foreman']['database']['active']
           data['results']['foreman']['database']['active'] = status ? 'ok' : 'FAIL'
           duration = data['results']['foreman']['database']['duration_ms']
-          data['results']['foreman']['database']['duration_ms'] = _("Duration: %sms") % duration
+          data['results']['foreman']['database']['duration_ms'] = _('Duration: %sms') % duration
         end
       end
+
+      def self.failed?(services)
+        services.each_value.any? { |s| s['status'] == _('FAIL') } ||
+          services['foreman']['database']['active'] == 'FAIL'
+      end
+
+      request_options do |options|
+        options[:with_authentication] = false
+      end
     end
   end
 end

data/lib/hammer_cli_foreman/commands.rb

@@ -548,10 +548,12 @@ module HammerCLIForeman
       builder
     end
 
-    def method_options_for_params(params, include_nil=true)
+    def method_options_for_params(params, options)
       opts = super
       # overwrite searchables with correct values
       searchables.for(resource).each do |s|
+        next unless params.map(&:name).include?(s.name)
+
         new_value = get_option_value("new_#{s.name}")
         opts[s.name] = new_value unless new_value.nil?
       end

data/lib/hammer_cli_foreman/compute_resource/ovirt.rb

@@ -12,6 +12,7 @@ module HammerCLIForeman
           ['cores',           _('Integer value, number of cores')],
           ['sockets',         _('Integer value, number of sockets')],
           ['memory',          _('Amount of memory, integer value in bytes')],
+          ['ha',              _('Boolean, set 1 to high availability')],
           ['display_type',    _('Possible values: %s') % 'VNC, SPICE'],
           ['keyboard_layout', _('Possible values: %s. Not usable if display type is SPICE.') % 'ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr']
         ]

data/lib/hammer_cli_foreman/hosts/common_update_options.rb

@@ -84,18 +84,16 @@ module HammerCLIForeman
 
         params['host']['host_parameters_attributes'] = parameter_attributes unless option_parameters.nil?
         params['host']['host_parameters_attributes'] ||= option_typed_parameters unless option_typed_parameters.nil?
-        params['host']['compute_attributes'] = option_compute_attributes || {}
 
-        compute_attributes = params['host']['compute_attributes']
-        compute_attributes['display'] = {} unless compute_attributes['display_type'].nil? && compute_attributes['keyboard_layout'].nil?
-        compute_attributes['display']['type'] = compute_attributes['display_type'] unless compute_attributes['display_type'].nil?
-        compute_attributes['display']['keyboard_layout'] = compute_attributes['keyboard_layout'] unless compute_attributes['keyboard_layout'].nil?
-        compute_attributes.delete('display_type')
-        compute_attributes.delete('keyboard_layout')
-        params['host']['compute_attributes'] = compute_attributes
+        if option_compute_attributes && !option_compute_attributes.empty?
+          params['host']['compute_attributes'] = host_compute_attrs(option_compute_attributes)
+        end
 
         if action == :update
-          params['host']['compute_attributes']['volumes_attributes'] = nested_attributes(option_volume_list) unless option_volume_list.empty?
+          unless option_volume_list.empty?
+            params['host']['compute_attributes'] ||= {}
+            params['host']['compute_attributes']['volumes_attributes'] = nested_attributes(option_volume_list)
+          end
           params['host']['interfaces_attributes'] = interfaces_attributes unless option_interface_list.empty?
           if options['option_new_location_id']
             params['host']['location_id'] = options['option_new_location_id']
@@ -108,6 +106,7 @@ module HammerCLIForeman
             params['host'].delete('organization_id')
           end
         else
+          params['host']['compute_attributes'] ||= {}
           params['host']['compute_attributes']['volumes_attributes'] = nested_attributes(option_volume_list)
           params['host']['interfaces_attributes'] = interfaces_attributes
         end
@@ -121,6 +120,7 @@ module HammerCLIForeman
           end
           raise ArgumentError, "Missing argument for 'compute_resource'" if compute_resource_id.nil?
           image_uuid =  ::HammerCLIForeman::ComputeResources.get_image_uuid(compute_resource_id, options["option_image_id"])
+          params['host']['compute_attributes'] ||= {}
           params['host']['compute_attributes']['image_id'] = image_uuid
         end
         params['host']['root_pass'] = option_root_password unless option_root_password.nil?
@@ -164,6 +164,13 @@ module HammerCLIForeman
         end
       end
 
+      def host_compute_attrs(attrs)
+        attrs['display'] = {} unless attrs['display_type'].nil? && attrs['keyboard_layout'].nil?
+        attrs['display']['type'] = attrs.delete('display_type') unless attrs['display_type'].nil?
+        attrs['display']['keyboard_layout'] = attrs.delete('keyboard_layout') unless attrs['keyboard_layout'].nil?
+        attrs
+      end
+
       def nested_attributes(attrs)
         return {} unless attrs
 

data/lib/hammer_cli_foreman/location.rb

@@ -33,7 +33,9 @@ module HammerCLIForeman
         HammerCLIForeman::References.compute_resources(self)
         HammerCLIForeman::References.media(self)
         HammerCLIForeman::References.provisioning_templates(self)
+        HammerCLIForeman::References.partition_tables(self)
         HammerCLIForeman::References.domains(self)
+        HammerCLIForeman::References.realms(self)
         HammerCLIForeman::References.environments(self)
         HammerCLIForeman::References.hostgroups(self)
         HammerCLIForeman::References.parameters(self)

data/lib/hammer_cli_foreman/organization.rb

@@ -33,7 +33,9 @@ module HammerCLIForeman
         HammerCLIForeman::References.compute_resources(self)
         HammerCLIForeman::References.media(self)
         HammerCLIForeman::References.provisioning_templates(self)
+        HammerCLIForeman::References.partition_tables(self)
         HammerCLIForeman::References.domains(self)
+        HammerCLIForeman::References.realms(self)
         HammerCLIForeman::References.environments(self)
         HammerCLIForeman::References.hostgroups(self)
         HammerCLIForeman::References.parameters(self)

data/lib/hammer_cli_foreman/ping.rb

@@ -1,23 +1,32 @@
 module HammerCLIForeman
   class PingCommand < HammerCLIForeman::Command
-      resource :ping
+    resource :ping
 
-      class ForemanCommand < HammerCLIForeman::Command
-        action :ping
-        command_name 'foreman'
+    class ForemanCommand < HammerCLIForeman::Command
+      action :ping
+      command_name 'foreman'
 
-        output do
-          from 'foreman' do
-            field :database, _('database'), Fields::Label do
-              field :active, _('Status')
-              field :duration_ms, _('Server Response')
-            end
+      output do
+        from 'foreman' do
+          field :database, _('database'), Fields::Label do
+            field :active, _('Status')
+            field :duration_ms, _('Server Response')
           end
         end
+      end
+
+      def execute
+        response = send_request
+        print_data(response)
 
-        extend_with(HammerCLIForeman::CommandExtensions::Ping.new)
+        return 1 if HammerCLIForeman::CommandExtensions::Ping.failed?(response)
+
+        HammerCLI::EX_OK
       end
 
+      extend_with(HammerCLIForeman::CommandExtensions::Ping.new)
+    end
+
     self.default_subcommand = 'foreman'
     autoload_subcommands
   end

data/lib/hammer_cli_foreman/references.rb

@@ -88,6 +88,14 @@ module HammerCLIForeman
       end
     end
 
+    def self.partition_tables(dsl)
+      dsl.build do
+        collection :ptables, _("Partition Tables"), :numbered => false do
+          custom_field Fields::Reference
+        end
+      end
+    end
+
     def self.domains(dsl)
       dsl.build do
         collection :domains, _("Domains"), :numbered => false do
@@ -96,6 +104,14 @@ module HammerCLIForeman
       end
     end
 
+    def self.realms(dsl)
+      dsl.build do
+        collection :realms, _("Realms"), :numbered => false do
+          custom_field Fields::Reference
+        end
+      end
+    end
+
     def self.environments(dsl)
       dsl.build do
         collection :environments, _("Environments"), :numbered => false do

data/lib/hammer_cli_foreman/settings.rb

@@ -32,6 +32,20 @@ module HammerCLIForeman
       build_options
     end
 
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output do
+        field :id, _("Id")
+        field :name, _("Name")
+        field :description, _("Description")
+        field :category_name, _("Category")
+        field :settings_type, _("Settings type")
+        field :value, _("Value")
+      end
+
+      build_options
+    end
+
+
     autoload_subcommands
   end
 

data/lib/hammer_cli_foreman/version.rb

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

data/test/functional/audit_test.rb

@@ -1,28 +1,28 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe 'audit' do
-  describe 'audit-list' do
+  before do
+    @audit_changed = {
+      'id' => 83,
+      'created_at' => "2017-10-31 11:25:44 UTC",
+      'remote_address' => '::1',
+      'user_name' => "foreman_api_admin",
+      'user_id' => 11,
+      'action' => "update",
+      'auditable_type' => "ProvisioningTemplate",
+      'auditable_name' => "default_location_subscribed_hosts",
+      'auditable_id' => 32,
+      'audited_changes' => {
+        'value' => [
+          nil,
+          "--- false\n..."
+        ]
+      }
+    }
+  end
+  describe 'audit-info' do
     let (:cmd) { ['audit', 'info'] }
     let(:params) { ['--id=83'] }
-    let(:audit_changed) do
-      {
-        'id' => 83,
-        'created_at' => "2017-10-31 11:25:44 UTC",
-        'remote_address' => '::1',
-        'user_name' => "foreman_api_admin",
-        'user_id' => 11,
-        'action' => "update",
-        'auditable_type' => "ProvisioningTemplate",
-        'auditable_name' => "default_location_subscribed_hosts",
-        'auditable_id' => 32,
-        'audited_changes' => {
-          'value' => [
-            nil,
-            "--- false\n..."
-          ]
-        }
-      }
-    end
     let(:audit_new) do
       {
         "user_id" => 1,
@@ -62,24 +62,26 @@ describe 'audit' do
     it 'shows audit information for changed records' do
       api_expects(:audits, :show, 'info')
         .with_params('id' => '83')
-        .returns(audit_changed)
+        .returns(@audit_changed)
 
-      output = OutputMatcher.new([
-        'Id:              83',
-        'At:              2017/10/31 11:25:44',
-        'IP:              ::1',
-        'User:            foreman_api_admin',
-        'Action:          update',
-        'Audit type:      ProvisioningTemplate',
-        'Audit record:    default_location_subscribed_hosts',
-        'Audited changes:',
-        ' 1) Attribute: value',
-        '    Old:',
-        '',
-        '    New:',
-        '      --- false',
-        '      ...',
-      ])
+      output = OutputMatcher.new(
+        [
+          'Id:              83',
+          'At:              2017/10/31 11:25:44',
+          'IP:              ::1',
+          'User:            foreman_api_admin',
+          'Action:          update',
+          'Audit type:      ProvisioningTemplate',
+          'Audit record:    default_location_subscribed_hosts',
+          'Audited changes:',
+          ' 1) Attribute: value',
+          '    Old:',
+          '',
+          '    New:',
+          '      --- false',
+          '      ...',
+        ]
+      )
       expected_result = success_result(output)
 
       result = run_cmd(cmd + params)
@@ -91,36 +93,57 @@ describe 'audit' do
         .with_params('id' => '83')
         .returns(audit_new)
 
-      output = OutputMatcher.new([
-        'Id:              63',
-        'At:              2017/10/09 23:42:44',
-        'IP:              ::1',
-        'User:            foreman_admin',
-        'Action:          create',
-        'Audit type:      User',
-        'Audit record:    John Doe',
-        'Audited changes:',
-        ' 1) Attribute: login',
-        '    Value:     john',
-        ' 2) Attribute: firstname',
-        '    Value:     John',
-        ' 3) Attribute: lastname',
-        '    Value:     Doe',
-        ' 4) Attribute: mail',
-        '    Value:     john@ipa.test',
-        ' 5) Attribute: admin',
-        '    Value:     false',
-        ' 6) Attribute: auth_source_id',
-        '    Value:     3',
-        ' 7) Attribute: lower_login',
-        '    Value:     john',
-        ' 8) Attribute: mail_enabled',
-        '    Value:     true',
-      ])
+      output = OutputMatcher.new(
+        [
+          'Id:              63',
+          'At:              2017/10/09 23:42:44',
+          'IP:              ::1',
+          'User:            foreman_admin',
+          'Action:          create',
+          'Audit type:      User',
+          'Audit record:    John Doe',
+          'Audited changes:',
+          ' 1) Attribute: login',
+          '    Value:     john',
+          ' 2) Attribute: firstname',
+          '    Value:     John',
+          ' 3) Attribute: lastname',
+          '    Value:     Doe',
+          ' 4) Attribute: mail',
+          '    Value:     john@ipa.test',
+          ' 5) Attribute: admin',
+          '    Value:     false',
+          ' 6) Attribute: auth_source_id',
+          '    Value:     3',
+          ' 7) Attribute: lower_login',
+          '    Value:     john',
+          ' 8) Attribute: mail_enabled',
+          '    Value:     true',
+        ]
+      )
       expected_result = success_result(output)
 
       result = run_cmd(cmd + params)
       assert_cmd(expected_result, result)
     end
   end
+
+  describe 'audit-list' do
+    let(:cmd) { ['audit', 'list'] }
+    let(:audits) do
+      [@audit_changed]
+    end
+
+    it "should show index list" do
+      api_expects(:audits, :index).returns(audits)
+
+      output = IndexMatcher.new([
+                                  ['ID', 'AT', 'IP', 'USER', 'ACTION', 'AUDIT TYPE', 'AUDIT RECORD'],
+                                  ['83', '2017/10/31 11:25:44', '::1', 'foreman_api_admin', 'update', 'ProvisioningTemplate', 'default_location_subscribed_hosts']
+                                ])
+
+      result = run_cmd(cmd)
+      assert_cmd(success_result(output), result)
+    end
+  end
 end