hammer_cli_foreman 2.1.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c937e9c178ca90874c6807da863508ebd631bb3d2d4b09a3ef2babf992866c9
-  data.tar.gz: 9d80d80f23f1f653b1f7342a1f978651ea765468497dd9537876043d0ef444c1
+  metadata.gz: d3602bf5d1cda5fed0ace9196b7aa5dbd0622079db5ab77f252cd134d0e05d5d
+  data.tar.gz: e341fb0eb8b606c519199c36fc1a14a520661a010f62bd946cb0b3c394fdd267
 SHA512:
-  metadata.gz: '061920937107ab4af20dd3d02a86c679186376b2eab355a8587b3e405709dd8b14c924d907b8cfcf73ec24cdd1b02ed866c28c722a9cdb0167a6bf733ae83b34'
-  data.tar.gz: 56f1841eef3af5cdaa2350529ec4bff88544d5ef0d523dc4a311efc76e083d003e80642b96118705e40c628192ebfe5be6b7f3bfb28624ed142ebe9199f1f668
+  metadata.gz: 75f923de0d55217bf30a6c6d12afe19e5b806b360892f1d429d18aa39bab2443151c7317ed5d39f979af8c934edd8134d1767efacfe52a353b9546a29f1983de
+  data.tar.gz: 833444008fa0f26d711708980a65f39e8cc485409acdb6c23e6afff8998645c2f2c34acd3cf70b84638fe0569c299ee11a5aabb2ba916d5524abcc19b9c78be2

data/doc/release_notes.md

@@ -1,10 +1,40 @@
 Release notes
 =============
-### 2.1.1 (2020-05-29)
+### 2.3.1 (2021-01-27)
+* Deprecating puppetrun command ([PR #554](https://github.com/theforeman/hammer-cli-foreman/pull/554)), [#31536](http://projects.theforeman.org/issues/31536)
+
+### 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))

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

@@ -176,8 +176,9 @@ module HammerCLIForeman
       resource :puppet_hosts
       action :puppetrun
 
-      def print_data(records)
-        print_message _('Puppet run triggered')
+      def execute
+        warn _('The puppetrun feature has been removed, however you can use the Remote Execution Plugin to run Puppet commands')
+        HammerCLI::EX_SOFTWARE
       end
 
       build_options

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/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/testing/api_expectations.rb

@@ -1,6 +1,11 @@
 module HammerCLIForeman
   module Testing
     module APIExpectations
+
+      def self.api_calls
+        @api_calls ||= []
+      end
+
       class APICallMatcher < Mocha::ParameterMatchers::Base
         attr_accessor :expected_params, :expected_resource, :expected_action, :block
 
@@ -160,7 +165,12 @@ module HammerCLIForeman
         }.merge(options))
       end
 
+      def api_calls
+        HammerCLIForeman::Testing::APIExpectations.api_calls
+      end
+
       def api_expects(resource=nil, action=nil, note=nil, &block)
+        api_calls << [resource, action]
         APIExpectationsDecorator.new.expects_call(resource, action, note, &block)
       end