hammer_cli_foreman 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4db93fb25a95e818a8b0b9fdaab9ab8760cc7f42c2607661e99ec4bb990815d4
-  data.tar.gz: d2187c023afc8dd80ae0247b53475354913950f1416e5f8bc308a48388e807fe
+  metadata.gz: 1cb3de28c168226867cc9b1f4f63ea96bf2ff8746b831e2cdf01e6fe6670a53b
+  data.tar.gz: 55b321941992865b2339fd1e0d11b3845c1396c0699f90c52ab4ba774974b70f
 SHA512:
-  metadata.gz: ac00a2af523db5f7cf5c881273f715128fbc1df82604ecd01bf6c06b95a09963fac84e76c79260b77908925f38e4864ace72a8f3b31f4b1e60179b8b89b716d6
-  data.tar.gz: 5300260e5c63d59ba8971dd784bb5f1e23a18a2de5b1611be02204c8a6b670368678742d8fa60815118b0f3b50127a4db92c599fb797d4bf045deb6ed366d263
+  metadata.gz: 7e50e0beb69a60b01613b3d7c282b927e54872de4533364e079f768e22f4a1e63aea967d7113e72a32ee35a20d4475a1cefef03055af956027e7fb3ce0fde00e
+  data.tar.gz: 8ec8cc1402c57faa1b5bbb960bb9b4963e2c4c0e21b9e0a62e88c7e02ca2a01f976c83795c21b7c801aa635842df6fc5fb0794283bd8f666364bd91f404c661d

data/doc/release_notes.md

@@ -1,5 +1,38 @@
 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))
+* Add a coverage test ([PR #522](https://github.com/theforeman/hammer-cli-foreman/pull/522))
+* Return 'set current context for request' to help ([PR #530](https://github.com/theforeman/hammer-cli-foreman/pull/530)), [#30182](http://projects.theforeman.org/issues/30182)
+* Display request uuid for audit ([PR #528](https://github.com/theforeman/hammer-cli-foreman/pull/528)), [#30130](http://projects.theforeman.org/issues/30130)
+* Use parent resource instead of hardcoded one ([PR #527](https://github.com/theforeman/hammer-cli-foreman/pull/527)), [#30125](http://projects.theforeman.org/issues/30125)
+* Added missing tests to realm command ([PR #526](https://github.com/theforeman/hammer-cli-foreman/pull/526)), [#30096](http://projects.theforeman.org/issues/30096)
+* Added missing tests to trend test ([PR #525](https://github.com/theforeman/hammer-cli-foreman/pull/525)), [#30070](http://projects.theforeman.org/issues/30070)
+* Revert "skip one test on ruby 2.7" ([PR #520](https://github.com/theforeman/hammer-cli-foreman/pull/520)), [#28601](http://projects.theforeman.org/issues/28601)
+* Eliminate auth_type from sessions file ([PR #521](https://github.com/theforeman/hammer-cli-foreman/pull/521)), [#29876](http://projects.theforeman.org/issues/29876)
+* Add disable option for user ([PR #497](https://github.com/theforeman/hammer-cli-foreman/pull/497)), [#28973](http://projects.theforeman.org/issues/28973)
+* Added manage command to user mail notifications ([PR #513](https://github.com/theforeman/hammer-cli-foreman/pull/513)), [#7665](http://projects.theforeman.org/issues/7665)
+* Bump to 2.2.0-develop
+
 ### 2.1.0 (2020-05-14)
 * Bump hammer_cli to 2.1.0 ([PR #519](https://github.com/theforeman/hammer-cli-foreman/pull/519))
 * Ask for oauth code only when needed ([PR #517](https://github.com/theforeman/hammer-cli-foreman/pull/517)), [#29635](http://projects.theforeman.org/issues/29635)

data/doc/testing.md

@@ -131,3 +131,16 @@ connection = api_connection
 api = APIExpectationsDecorator.new(connection.api)
 api.expects_search(:users, 'login=admin')
 ```
+## Checking the coverage against the API
+You can check how many API endpoints are covered by Hammer, this test runs all hammer tests,
+and check which API actions run, therefore there could be two reasons for an endpoint to not be covered:
+1. there is no test for this action
+2. there is no hammer command for the API endpoint.
+### running the coverage test
+```bash
+
+rake test TESTOPTS="-c"
+
+TEST_API_VERSION=2.0 rake test TESTOPTS="-c"
+
+```

data/lib/hammer_cli_foreman.rb

@@ -154,7 +154,7 @@ module HammerCLIForeman
       'HammerCLIForeman::Subnet', 'hammer_cli_foreman/subnet'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('template', _("Manipulate config templates"),
+    HammerCLI::MainCommand.lazy_subcommand('template', _("Manipulate provisioning templates"),
       'HammerCLIForeman::Template', 'hammer_cli_foreman/template'
     )
 
@@ -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/api/connection.rb

@@ -42,26 +42,9 @@ module HammerCLIForeman
 
       protected
 
-      # If the settings in foreman.yml has use_sessions as false, use :basic_auth
-      # Else if the settings in foreman.yml has use_sessions as true
-      # and if there exists a session_file with valid contents, we use the auth_type from sessions_file
-      # Thus if the session expires (indicated by nil session_id), we use the
-      # same auth_type for re-authentication as was used by the previous session.
-      # Else we use the passed auth_type.
       def default_auth_type(settings)
         return AUTH_TYPES[:basic_auth] unless HammerCLIForeman::Sessions.enabled?
-
-        url = settings.get(:_params, :host) || settings.get(:foreman, :host)
-        username = settings.get(:_params, :username) || settings.get(:foreman, :username)
-        session = HammerCLIForeman::Sessions.get(url)
-        if !session.valid? && session.user_name == username && !session.auth_type.nil?
-          session.auth_type
-        else
-          # If the caller has not sepcified an 'auth_type'
-          # and the 'default_auth_type' in settings is also undefined
-          # use :basic_auth for authentication.
-          HammerCLI::Settings.get(:foreman, :default_auth_type) || AUTH_TYPES[:basic_auth]
-        end
+        HammerCLI::Settings.get(:foreman, :default_auth_type) || AUTH_TYPES[:basic_auth]
       end
 
       def create_authenticator(uri, settings, auth_type)

data/lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb

@@ -69,7 +69,6 @@ module HammerCLIForeman
         if (r.cookies['_session_id'] && r.code != 401)
           session.id = r.cookies['_session_id']
           session.user_name = @authenticator.user
-          session.auth_type = @auth_type
           session.store
         end
         @authenticator.response(r)

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -244,8 +244,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(
@@ -259,7 +258,7 @@ module HammerCLIForeman
               template_ids << 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
 
@@ -281,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(
@@ -295,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/audit.rb

@@ -28,6 +28,7 @@ module HammerCLIForeman
         field :action, _("Action")
         field :auditable_type, _("Audit type")
         field nil, _("Audit record"), Fields::SingleReference, :key => :auditable
+        field :request_uuid, _("Request UUID"), Fields::Field, sets: ['ALL']
       end
 
       build_options
@@ -63,6 +64,12 @@ module HammerCLIForeman
         end
       end
 
+      extend_output_definition do |definition|
+        definition.insert(:replace, :request_uuid) do
+          field :request_uuid, _("Request UUID"), Fields::Field, sets: ['ALL', 'DEFAULT']
+        end
+      end
+
       build_options
     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/id_resolver.rb

@@ -50,8 +50,8 @@ module HammerCLIForeman
       :hostgroup =>        [ s_name(_("Hostgroup name")), s("title", _("Hostgroup title"), :editable => false) ],
       # :image =>            [],
       :interface =>        [],
-      :location =>         [  s('name', _('Location Name, Set the current location context for the request')),
-                              s('title', _('Location title, Set the current location context for the request' ),
+      :location =>         [  s('name', _('Set the current location context for the request')),
+                              s('title', _('Set the current location context for the request' ),
                                 editable: false
                               )
       ],

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/option_builders.rb

@@ -209,7 +209,7 @@ module HammerCLIForeman
       family = HammerCLI::Options::OptionFamily.new(
         referenced_resource: resource_name,
         aliased_resource: aliased_name,
-        description: _('%{types} of associated %{resource}') % { types: types, resource: associated_resource }
+        description: _('Set the current %{resource} context for the request. %{types} can be used') % { types: types, resource: associated_resource }
       )
 
       unless searchables.empty?

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/output/fields.rb

@@ -19,7 +19,7 @@ module Fields
 
     def id_detail
       {
-        :label => _('id'),
+        :label => {:target => _('id')},
         :structured_label => _('Id'),
         :key => @options[:id_key] || :id,
         :id => true

data/lib/hammer_cli_foreman/output/formatters.rb

@@ -35,7 +35,7 @@ module HammerCLIForeman::Output
           if detail.is_a?(Hash)
             next if detail[:id] && !show_ids
             if detail[:label]
-              "#{detail[:label]}: #{get_value(data, detail[:key])}"
+              "#{detail[:label][:target]}: #{get_value(data, detail[:key])}"
             else
               get_value(data, detail[:key])
             end

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/sessions.rb

@@ -55,7 +55,7 @@ module HammerCLIForeman
   end
 
   class Session
-    attr_accessor :id, :user_name, :auth_type
+    attr_accessor :id, :user_name
 
     def initialize(session_path)
       @session_path = File.expand_path(session_path)
@@ -63,7 +63,6 @@ module HammerCLIForeman
         session_data = JSON.parse(File.read(@session_path))
         @id = session_data['id']
         @user_name = session_data['user_name']
-        @auth_type = session_data['auth_type']
       end
     rescue JSON::ParserError
       warn _('Invalid session data. Resetting the session.')
@@ -73,7 +72,6 @@ module HammerCLIForeman
       File.open(@session_path,"w") do |f|
         f.write({
           id: id,
-          auth_type: auth_type,
           user_name: user_name
         }.to_json)
       end