hammer_cli_foreman 2.1.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76e95389bb3b76b95c4c58d9faf7e7ff7e1b5c8bf2bcaed44aee693ef2fe9d02
-  data.tar.gz: 94cef7601ae22edec554dbfbccf4ffde70b45db465e3746f510437513d3b477e
+  metadata.gz: efc47b1a544eaf1e63d7328b51210b5d0b4d153bb6ff35156a8e55b9527aa207
+  data.tar.gz: dd374b8958f6a171a43b6b6521ff6f9d919a85c0b5b5daf5d099a49c08b4c2ec
 SHA512:
-  metadata.gz: 441c7dc0803a50667feafe17fc0fa5674e79ef10859fd2e06c4929ef7fe18dded59e354986e15f57c950a9e3be5bd8ec2701da1e090f36cc353fc06d150b25b4
-  data.tar.gz: bc7f373ce2e39987744a9a05c5cede008de26f0198e6ec3026a4be1b051452de701e0ae5245527768d2851dfbbd24d3f9417d1fd3939ddb7d4da7a63e2002e62
+  metadata.gz: d8d2cd3f5b7232c92a2a6133b23592dca23556f7738de97b8dfc5553306332ec93fefd9e00970c139b630563b08563afc2bd5c1112f1177db34b904c61ebe99e
+  data.tar.gz: 67d74339e57bd0c0e61942ad4ff94d7399877db33e2a2e0f190a4ab6eec4bf8f6070bad6adb7624009c2ecbd0dd7ed54f8589c1438293efc9c62970af65a7845

data/doc/release_notes.md

@@ -1,15 +1,46 @@
 Release notes
 =============
-### 2.1.2 (2020-07-14)
+
+### 2.4.0 (2021-02-01)
+* Fix hammer list failure when defaults are set ([PR #551](https://github.com/theforeman/hammer-cli-foreman/pull/551)), [#31384](http://projects.theforeman.org/issues/31384)
+* Deprecating puppetrun command ([PR #554](https://github.com/theforeman/hammer-cli-foreman/pull/554)), [#31536](http://projects.theforeman.org/issues/31536)
+* Set new owner with host update ([PR #556](https://github.com/theforeman/hammer-cli-foreman/pull/556)), [#31609](http://projects.theforeman.org/issues/31609)
+* Consume structured statuses api data ([PR #553](https://github.com/theforeman/hammer-cli-foreman/pull/553)), [#31570](http://projects.theforeman.org/issues/31570)
+* Added missing tests to filter ([PR #549](https://github.com/theforeman/hammer-cli-foreman/pull/549)), [#31074](http://projects.theforeman.org/issues/31074')
+* Bump to 2.4.0-develop
+
+### 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)) ([PR #529](https://github.com/theforeman/hammer-cli-foreman/pull/529)), [#30130](http://projects.theforeman.org/issues/30130)
-
-### 2.1.1 (2020-05-29)
+* 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

@@ -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/architecture.rb

@@ -11,7 +11,7 @@ module HammerCLIForeman
         field :name, _("Name")
       end
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
 
@@ -23,7 +23,7 @@ module HammerCLIForeman
         HammerCLIForeman::References.timestamps(self)
       end
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
 
@@ -31,7 +31,7 @@ module HammerCLIForeman
       success_message _("Architecture created.")
       failure_message _("Could not create the architecture")
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
 
@@ -39,7 +39,7 @@ module HammerCLIForeman
       success_message _("Architecture deleted.")
       failure_message _("Could not delete the architecture")
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
 
@@ -47,7 +47,7 @@ module HammerCLIForeman
       success_message _("Architecture updated.")
       failure_message _("Could not update the architecture")
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     HammerCLIForeman::AssociatingCommands::OperatingSystem.extend_command(self)

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

@@ -15,34 +15,34 @@ module HammerCLIForeman
         field :owner_type, _('Owner Type')
       end
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
       output ListCommand.output_definition
-      
-      build_options
+
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
       success_message _('Bookmark %<name>s created.')
       failure_message _('Failed to create %<name>s bookmark')
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       success_message _('Bookmark %<name>s updated successfully.')
       failure_message _('Failed to update %<name>s bookmark')
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       success_message _('Bookmark deleted successfully.')
       failure_message _('Failed to delete bookmark')
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     autoload_subcommands

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/command_extensions/status.rb

@@ -4,7 +4,7 @@ module HammerCLIForeman
       before_print do |data|
         return if data['results'].nil?
 
-        normalize_plugins(data['results']['foreman']['plugins'])
+        normalize_plugins(data['results']['foreman']['plugins']) if data['results']['foreman']['plugins'].any?(String)
         data['results']['foreman']['smart_proxies'].each do |proxy|
           proxy['features'] = normalize_features(proxy['features'])
           proxy['failed_features'] = normalize_failed_features(proxy['failed_features'])

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_profile.rb

@@ -9,7 +9,7 @@ module HammerCLIForeman
         field :id, _('Id')
         field :name, _('Name')
       end
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
@@ -25,13 +25,13 @@ module HammerCLIForeman
           field :vm_attrs, _('VM attributes')
         end
       end
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
       success_message _('Compute profile created.')
       failure_message _('Could not create a compute profile')
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
@@ -40,7 +40,7 @@ module HammerCLIForeman
       validate_options do
         any(:option_name,:option_id).required
       end
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
@@ -49,7 +49,7 @@ module HammerCLIForeman
       validate_options do
         any(:option_name,:option_id).required
       end
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     lazy_subcommand('values', _("Create update and delete Compute profile values"),

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

@@ -8,7 +8,7 @@ module HammerCLIForeman
         field :name, _("Name")
       end
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
@@ -16,28 +16,28 @@ module HammerCLIForeman
         HammerCLIForeman::References.puppetclasses(self)
       end
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
       success_message _("Config group created.")
       failure_message _("Could not create the config group")
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       success_message _("Config group updated.")
       failure_message _("Could not update the config group")
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       success_message _("Config group has been deleted.")
       failure_message _("Could not delete the config group")
 
-      build_options
+      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
     end
 
     autoload_subcommands

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

@@ -6,7 +6,7 @@ module HammerCLIForeman
         base.option "--owner", "OWNER_LOGIN", _("Login of the owner"),
           :attribute_name => :option_user_login
         base.option "--owner-id", "OWNER_ID", _("ID of the owner"),
-          :attribute_name => :option_user_id
+          :attribute_name => :option_owner_id
 
         base.option "--root-password", "ROOT_PW",
           _("Required if host is managed and value is not inherited from host group or default password in settings")
@@ -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