hammer_cli_foreman 2.4.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efc47b1a544eaf1e63d7328b51210b5d0b4d153bb6ff35156a8e55b9527aa207
-  data.tar.gz: dd374b8958f6a171a43b6b6521ff6f9d919a85c0b5b5daf5d099a49c08b4c2ec
+  metadata.gz: 12d3353f9d530459e2a7f58e8f5603b1f52af4b2ee28aa51c6252bda84f5a5b3
+  data.tar.gz: cb323fd78217f8d5b5b1e7b69dd691ea85b3d332dcbbc2e375a668fc7043c298
 SHA512:
-  metadata.gz: d8d2cd3f5b7232c92a2a6133b23592dca23556f7738de97b8dfc5553306332ec93fefd9e00970c139b630563b08563afc2bd5c1112f1177db34b904c61ebe99e
-  data.tar.gz: 67d74339e57bd0c0e61942ad4ff94d7399877db33e2a2e0f190a4ab6eec4bf8f6070bad6adb7624009c2ecbd0dd7ed54f8589c1438293efc9c62970af65a7845
+  metadata.gz: 04b1444a37f464ab35afdfd3832cf0549448484e9932972603ca5d29d7660a4bd599ab0cae461730a7fca5735712451553983724cbe5a23d8f6ffb0135e5510e
+  data.tar.gz: b625099ac29545814e7c73a1d74f0b20559b117bfabac2e2074c448557386c40e81a280ae2fb31271e3e5bd60b1c29c4a60881acfe4d5cbcad3f91cda05ca21c

data/doc/release_notes.md

@@ -1,5 +1,45 @@
 Release notes
 =============
+### 3.1.0 (2021-11-10)
+* Update test data for 3.1
+* Make sure provided options override defaults, [#33711](http://projects.theforeman.org/issues/33711)
+* Make template create/update commands use resolver, [#33721](http://projects.theforeman.org/issues/33721)
+* Revert fix rake version
+* Fix rake version
+* Show status once for proxy info ([PR #581](https://github.com/theforeman/hammer-cli-foreman/pull/581)), [#19510](http://projects.theforeman.org/issues/19510)
+* Add proxy status and version to info command ([PR #572](https://github.com/theforeman/hammer-cli-foreman/pull/572))
+* Associate a vm via hammer to a compute resource, [#33047](http://projects.theforeman.org/issues/33047)
+* Fix option builders and tests, [#33226](http://projects.theforeman.org/issues/33226)
+* Bump to 3.1.0-develop
+* Add parent title option for hostgroup, [#32878](http://projects.theforeman.org/issues/32878)
+
+### 3.0.0 (2021-08-04)
+* Puppet extraction ([PR #571](https://github.com/theforeman/hammer-cli-foreman/pull/571)), [#33174](http://projects.theforeman.org/issues/33174)
+* Update rel-eng notebook ([PR #573](https://github.com/theforeman/hammer-cli-foreman/pull/573))
+* Bump version to 3.0-develop
+* Deprecate root-pass and remove deprecation warning, [#22574](http://projects.theforeman.org/issues/22574)
+* Return org and loc options to all hammer commands ([PR #575](https://github.com/theforeman/hammer-cli-foreman/pull/575)), [#32872](http://projects.theforeman.org/issues/32872)
+*  prevent full-help from failure if apidoc not available ([PR #574](https://github.com/theforeman/hammer-cli-foreman/pull/574)), [#32861](http://projects.theforeman.org/issues/32861)
+* Show new msg for empty update commands, [#32454](http://projects.theforeman.org/issues/32454)
+* Remove --environment deprecations ([PR #569](https://github.com/theforeman/hammer-cli-foreman/pull/569)), [#28862](http://projects.theforeman.org/issues/28862)
+* Force name resolving due defaults, [#32392](http://projects.theforeman.org/issues/32392)
+* Bump to 2.6.0-develop
+
+### 2.5.0 (2021-05-04)
+* Update test data to latest foreman
+*  change to resource_type_label, [#11454](http://projects.theforeman.org/issues/11454)
+* Display the report origin, [#32428](http://projects.theforeman.org/issues/32428)
+* Apply option family on searchablesoptionbuilder, [#30996](http://projects.theforeman.org/issues/30996)
+* Add associate vms command for compute resource ([PR #563](https://github.com/theforeman/hammer-cli-foreman/pull/563)), [#32271](http://projects.theforeman.org/issues/32271)
+* Support unrecognized services in ping, [#32265](http://projects.theforeman.org/issues/32265)
+* Change --owner_type's default to user ([PR #562](https://github.com/theforeman/hammer-cli-foreman/pull/562)), [#30814](http://projects.theforeman.org/issues/30814)
+* Drop puppetrun command from hammer ([PR #561](https://github.com/theforeman/hammer-cli-foreman/pull/561)), [#31806](http://projects.theforeman.org/issues/31806)
+* Global registration module ([PR #558](https://github.com/theforeman/hammer-cli-foreman/pull/558)), [#31630](http://projects.theforeman.org/issues/31630)
+* Add support for vnic profile ([PR #552](https://github.com/theforeman/hammer-cli-foreman/pull/552)), [#31493](http://projects.theforeman.org/issues/31493)
+* Bump to 2.5.0-develop
+* Bump to 2.4.0
+* Correct descriptions for resources, [#31668](http://projects.theforeman.org/issues/31668)
+
 
 ### 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)

data/lib/hammer_cli_foreman/architecture.rb

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

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -53,30 +53,6 @@ module HammerCLIForeman
       end
     end
 
-    module PuppetEnvironment
-      extend CommandExtension
-
-      class AddPuppetEnvironmentCommand < HammerCLIForeman::AddAssociatedCommand
-        associated_resource :environments
-        desc _('Associate a Puppet environment')
-
-        success_message _("The environment has been associated.")
-        failure_message _("Could not associate the environment")
-
-        extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
-      end
-
-      class RemovePuppetEnvironmentCommand < HammerCLIForeman::RemoveAssociatedCommand
-        associated_resource :environments
-        desc _('Disassociate a Puppet environment')
-
-        success_message _("The environment has been disassociated.")
-        failure_message _("Could not disassociate the environment")
-
-        extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
-      end
-    end
-
     module Domain
       extend CommandExtension
 

data/lib/hammer_cli_foreman/bookmark.rb

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

data/lib/hammer_cli_foreman/combination.rb

@@ -6,8 +6,7 @@ module HammerCLIForeman
 
     module RequestParams
       def request_params
-        combination_params = { 'hostgroup_id' => params['hostgroup_id'].to_s,
-                               'environment_id' => params['environment_id'].to_s }
+        combination_params = { 'hostgroup_id' => params['hostgroup_id'].to_s }
         super.merge('template_combination' => combination_params)
       end
     end
@@ -21,8 +20,6 @@ module HammerCLIForeman
         field :provisioning_template_name, _('Provisioning template name')
         field :hostgroup_id, _('Hostgroup ID')
         field :hostgroup_name, _('Hostgroup name')
-        field :environment_id, _('Environment ID')
-        field :environment_name, _('Environment name')
 
         HammerCLIForeman::References.taxonomies(self)
         HammerCLIForeman::References.timestamps(self)
@@ -31,8 +28,6 @@ module HammerCLIForeman
       build_options do |o|
         o.expand(:all)
       end
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
     end
 
     class ListCombination < HammerCLIForeman::ListCommand
@@ -40,12 +35,11 @@ module HammerCLIForeman
         field :id, _('ID')
         field nil, _('Provisioning Template'), Fields::SingleReference, :key => :provisioning_template
         field nil, _('Hostgroup'), Fields::SingleReference, :key => :hostgroup
-        field nil, _('Environment'), Fields::SingleReference, :key => :environment
       end
 
       build_options do |o|
-        o.expand(:all).except(:hostgroups, :environments)
-        o.without(:hostgroup_id, :environment_id)
+        o.expand(:all).except(:hostgroups)
+        o.without(:hostgroup_id)
       end
     end
 
@@ -58,8 +52,6 @@ module HammerCLIForeman
       build_options do |o|
         o.expand(:all)
       end
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
     end
 
     class CreateCombination < HammerCLIForeman::CreateCommand
@@ -71,8 +63,6 @@ module HammerCLIForeman
       build_options do |o|
         o.expand(:all)
       end
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
     end
 
     class DeleteCombination < HammerCLIForeman::DeleteCommand

data/lib/hammer_cli_foreman/command_extensions/ping.rb

@@ -10,9 +10,28 @@ module HammerCLIForeman
         end
       end
 
+      def self.check_for_unrecognized(plugins, output_definition)
+        failed = plugins.select { |_, data| data['services'] }
+                        .each_with_object([]) { |(_, d), s| s << d['services'] }
+                        .reduce({}, :merge)
+                        .select do |name, data|
+          begin
+            output_definition.find_field(name)
+            false
+          rescue ArgumentError
+            data['status'] == _('FAIL')
+          end
+        end
+        return if failed.empty?
+
+        warn [_('%{count} more service(s) failed, but not shown:') % { count: failed.size },
+              failed.keys.join(', '),
+              ''].join("\n")
+      end
+
       def self.failed?(services)
-        services.each_value.any? { |s| s['status'] == _('FAIL') } ||
-          services['foreman']['database']['active'] == 'FAIL'
+        services['foreman']['database']['active'] == 'FAIL' ||
+          services.each_value.any? { |s| s['status'] == _('FAIL') }
       end
 
       request_options do |options|

data/lib/hammer_cli_foreman/command_extensions/subnet.rb

@@ -1,16 +1,7 @@
 module HammerCLIForeman
   module CommandExtensions
     class Subnet < HammerCLI::CommandExtensions
-      option "--dns", "DNS_NAME", _("DNS Proxy to use within this subnet"),
-             attribute_name: :option_dns_name,
-             referenced_resource: :smart_proxy
-      option "--dhcp", "DHCP_NAME", _("DHCP Proxy to use within this subnet"),
-             attribute_name: :option_dhcp_name,
-             referenced_resource: :smart_proxy
-      option "--tftp", "TFTP_NAME", _("TFTP Proxy to use within this subnet"),
-             attribute_name: :option_tftp_name,
-             referenced_resource: :smart_proxy
-      option "--prefix", "PREFIX", _("Network prefix in CIDR notation (e.g. 64) for this subnet")
+      option '--prefix', 'PREFIX', _('Network prefix in CIDR notation (e.g. 64) for this subnet')
 
       option_sources do |sources, command|
         sources.find_by_name('IdResolution').insert_relative(
@@ -20,6 +11,30 @@ module HammerCLIForeman
         )
         sources
       end
+
+      option_family associate: 'tftp' do
+        child '--tftp', 'TFTP_NAME', _('TFTP Proxy to use within this subnet'),
+              attribute_name: :option_tftp_name,
+              referenced_resource: :smart_proxy
+      end
+
+      option_family associate: 'dns' do
+        child '--dns', 'DNS_NAME', _('DNS Proxy to use within this subnet'),
+              attribute_name: :option_dns_name,
+              referenced_resource: :smart_proxy
+      end
+
+      option_family associate: 'dhcp' do
+        child '--dhcp', 'DHCP_NAME', _('DHCP Proxy to use within this subnet'),
+              attribute_name: :option_dhcp_name,
+              referenced_resource: :smart_proxy
+      end
+
+      option_family associate: 'bmc' do
+        child '--bmc', 'BMC_NAME', _('BMC Proxy to use within this subnet'),
+              attribute_name: :option_bmc_name,
+              referenced_resource: :smart_proxy
+      end
     end
   end
 end

data/lib/hammer_cli_foreman/command_extensions/update_common.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module HammerCLIForeman
+  module CommandExtensions
+    class UpdateCommon < HammerCLI::CommandExtensions
+      inheritable true
+
+      request_params do |params, command_object|
+        update_params = params[command_object.resource.singular_name]
+        command_object.context[:action_message] = :nothing_to_do if update_params && update_params.empty?
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/command_extensions/user.rb

@@ -1,17 +1,21 @@
 module HammerCLIForeman
   module CommandExtensions
     class User < HammerCLI::CommandExtensions
-      option '--default-organization', 'DEFAULT_ORGANIZATION_NAME', _('Default organization name'),
-             aliased_resource: 'default_organization', referenced_resource: 'default_organization'
-      option '--default-location', 'DEFAULT_LOCATION_NAME', _('Default location name'),
-             aliased_resource: 'default_location', referenced_resource: 'default_location'
-
       option '--ask-password', 'ASK_PW', ' ', format: HammerCLI::Options::Normalizers::Bool.new
 
       option_sources do |sources, command|
         sources << HammerCLIForeman::OptionSources::UserParams.new(command)
         sources
       end
+
+      option_family associate: 'default_organization' do
+        child '--default-organization', 'DEFAULT_ORGANIZATION_NAME', _('Default organization name'),
+              aliased_resource: 'default_organization', referenced_resource: 'organization'
+      end
+      option_family associate: 'default_location' do
+        child '--default-location', 'DEFAULT_LOCATION_NAME', _('Default location name'),
+              aliased_resource: 'default_location', referenced_resource: 'location'
+      end
     end
   end
 end

data/lib/hammer_cli_foreman/command_extensions.rb

@@ -1,6 +1,5 @@
+require 'hammer_cli_foreman/command_extensions/update_common'
 require 'hammer_cli_foreman/command_extensions/fields'
-require 'hammer_cli_foreman/command_extensions/puppet_environment'
-require 'hammer_cli_foreman/command_extensions/puppet_environments'
 require 'hammer_cli_foreman/command_extensions/option_sources'
 require 'hammer_cli_foreman/command_extensions/hosts'
 require 'hammer_cli_foreman/command_extensions/ping'

data/lib/hammer_cli_foreman/commands.rb

@@ -7,16 +7,9 @@ module HammerCLIForeman
     :usergroups => :user_groups,
     :ptable => :partition_table,
     :ptables => :partition_tables,
-    :puppetclass => :puppet_class,
-    :puppetclasses => :puppet_classes,
-    :environment => :puppet_environment,
-    :environments => :puppet_environments
   }
 
-  RESOURCE_ALIAS_NAME_MAPPING = {
-    environment: :puppet_environment,
-    environments: :puppet_environments
-  }
+  RESOURCE_ALIAS_NAME_MAPPING = { }
 
   def self.foreman_api
     foreman_api_connection
@@ -104,9 +97,8 @@ module HammerCLIForeman
       configurator = BuilderConfigurator.new(searchables, dependency_resolver)
 
       builder = ForemanOptionBuilder.new(searchables)
-      builder.builders = []
+      builder.builders = super.builders
       builder.builders += configurator.builders_for(resource, resource.action(action)) if resource_defined?
-      builder.builders += super.builders
       builder
     end
 
@@ -294,7 +286,7 @@ module HammerCLIForeman
     def help
       return super unless resource
 
-      meta = resource.action(action).apidoc[:metadata]
+      meta = resource.action(action).apidoc&.dig(:metadata)
       if meta && meta[:search] && respond_to?(:option_search)
         self.class.extend_help do |h|
           h.section(_('Search / Order fields'), id: :search_fields_section) do |h|
@@ -548,6 +540,19 @@ module HammerCLIForeman
       builder
     end
 
+    def self.inherited(child)
+      child.success_message_for(:nothing_to_do, _('Nothing to update.'))
+    end
+
+    def clean_up_context
+      super
+      context.delete(:action_message)
+    end
+
+    def success_message
+      success_message_for(context[:action_message] || :default)
+    end
+
     def method_options_for_params(params, options)
       opts = super
       # overwrite searchables with correct values
@@ -560,6 +565,7 @@ module HammerCLIForeman
       opts
     end
 
+    extend_with(HammerCLIForeman::CommandExtensions::UpdateCommon.new)
   end
 
 

data/lib/hammer_cli_foreman/compute_attribute.rb

@@ -12,7 +12,7 @@ module HammerCLIForeman
       profile = HammerCLIForeman.record_to_common_format(
           HammerCLIForeman.foreman_resource(:compute_profiles).call(:show, 'id' => options['option_compute_profile_id'] )
       )
-      params['compute_attribute'] = profile['compute_attributes'].select { |hash| hash['compute_resource_id'] == options['option_compute_resource_id']}[0] || {}
+      params['compute_attribute'] = profile['compute_attributes'].select { |hash| hash['compute_resource_id'].to_s == options['option_compute_resource_id'].to_s}[0] || {}
       params['compute_attribute'].delete('attributes') if params['compute_attribute']['attributes']
       params
     end

data/lib/hammer_cli_foreman/compute_profile.rb

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

data/lib/hammer_cli_foreman/compute_resource/ovirt.rb

@@ -28,7 +28,8 @@ module HammerCLIForeman
         [
           ['compute_name',      _('Compute name, e.g. eth0')],
           ['compute_network',   _('Select one of available networks for a cluster, must be an ID or a name')],
-          ['compute_interface', _('Interface type')]
+          ['compute_interface', _('Interface type')],
+          ['compute_vnic_profile', _('Vnic Profile')]
         ]
       end
 

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -104,6 +104,16 @@ module HammerCLIForeman
       build_options
     end
 
+    class AssociateVmsCommand < HammerCLIForeman::Command
+      action :associate
+      command_name 'associate-vms'
+      option "--vm-id","VM ID", _("Associate a specific VM")
+      success_message _("Virtual machines have been associated.")
+      failure_message _("Could not associate the virtual machines")
+
+      build_options
+    end
+
     class AvailableClustersCommand < HammerCLIForeman::ListCommand
       action :available_clusters
       command_name 'clusters'
@@ -128,6 +138,19 @@ module HammerCLIForeman
       build_options
     end
 
+    class AvailableVnicProfilesCommand < HammerCLIForeman::ListCommand
+      action :available_vnic_profiles
+      command_name 'vnic-profiles'
+
+      output do
+        field :id, _('VNIC profile ID'), Fields::Field, :max_width => 200, :hide_blank => true
+        field :name, _('Name')
+        field :network, _('Network ID')
+      end
+
+      build_options
+    end
+
     class AvailableImagesCommand < HammerCLIForeman::ListCommand
       action :available_images
       command_name 'images'

data/lib/hammer_cli_foreman/config_report.rb

@@ -10,6 +10,7 @@ module HammerCLIForeman
         field :id, _("Id")
         field :host_name, _("Host")
         field :reported_at, _("Last report"), Fields::Date
+        field :origin, _("Origin")
         from "status" do
           field :applied, _("Applied")
           field :restarted, _("Restarted")
@@ -30,6 +31,7 @@ module HammerCLIForeman
         field :id, _("Id")
         field :host_name, _("Host")
         field :reported_at, _("Reported at"), Fields::Date
+        field :origin, _("Origin")
         label _("Report status") do
           from "status" do
             field :applied, _("Applied")

data/lib/hammer_cli_foreman/filter.rb

@@ -78,7 +78,7 @@ module HammerCLIForeman
     class CreateCommand < HammerCLIForeman::CreateCommand
       include TaxonomyCheck
 
-      success_message _("Permission filter for [%<resource_type>s] created.")
+      success_message _("Permission filter for [%<resource_type_label>s] created.")
       failure_message _("Could not create the permission filter")
 
       def validate_options
@@ -92,7 +92,7 @@ module HammerCLIForeman
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       include TaxonomyCheck
 
-      success_message _("Permission filter for [%<resource_type>s] updated.")
+      success_message _("Permission filter for [%<resource_type_label>s] updated.")
       failure_message _("Could not update the permission filter")
 
       def request_params