hammer_cli_foreman 2.3.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b30a6bc396c149912681a2a600c7dcc84fc5144b90b5b4b8cf45f57690bbaa39
-  data.tar.gz: de18a4c812f92f1988791f404986a2e7b0c5464d401b001ddedee3c934a1f137
+  metadata.gz: 8287acd52ceb1bea84f8d518c3793d521d084ae771622ea7fc4dcccccd794a1b
+  data.tar.gz: b557d8fbbc7a451cd09084211c6e8a46a46ef3c198744cbb9c8dc7e861090e93
 SHA512:
-  metadata.gz: 4fe825dd7cb98c62c1093d11d33e1d488b80bd55f6927089cb4a84e9214d3fbedb7add28d5436492c63f6d8b5cf8b7c3f64d6d30de9aac1fc39fdace9324c465
-  data.tar.gz: 2d317a4070fa04020b10aa0f7c5c43a000c325ac2cde01a888c4d82fe8a6a01e746e0d4d9a66a92a239e4597f7e25daf5399e5b97d892fd84ac43e0b80052f02
+  metadata.gz: 283fd640422b5749f6dc9094907bb1c68e72cef15696704f4493f548dd23ca13bd1066fca15616996d4ff6ba48648d904f5633e3cc3305c30464fa9e22c8bf44
+  data.tar.gz: 94b81f8171c914bdd1435ad00a17c1b1606402bac1ab9b21ca3014056ed285029bc79fe2b0646630d964d3b4715bd94b42a67a35f5399cace731ec44c87e4ee8

data/doc/release_notes.md

@@ -1,10 +1,40 @@
 Release notes
 =============
-### 2.3.2 (2021-05-04)
+### 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)
-
-### 2.3.1 (2021-01-27)
+* 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)
 * 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)

data/lib/hammer_cli_foreman.rb

@@ -60,15 +60,6 @@ module HammerCLIForeman
       'HammerCLIForeman::Domain', 'hammer_cli_foreman/domain'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('environment', _("Manipulate environments"),
-      'HammerCLIForeman::PuppetEnvironment', 'hammer_cli_foreman/puppet_environment',
-      :warning => _('%{env} command is deprecated and will be removed in one of the future versions. Please use %{puppet_env} command instead.') % {:env => 'environment', :puppet_env => 'puppet-environment'}
-    )
-
-    HammerCLI::MainCommand.lazy_subcommand('puppet-environment', _("Manipulate Puppet environments"),
-      'HammerCLIForeman::PuppetEnvironment', 'hammer_cli_foreman/puppet_environment'
-    )
-
     HammerCLI::MainCommand.lazy_subcommand('fact', _("Search facts"),
       'HammerCLIForeman::Fact', 'hammer_cli_foreman/fact'
     )
@@ -113,10 +104,6 @@ module HammerCLIForeman
       'HammerCLIForeman::PartitionTable', 'hammer_cli_foreman/partition_table'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('puppet-class', _("Search puppet modules"),
-      'HammerCLIForeman::PuppetClass', 'hammer_cli_foreman/puppet_class'
-    )
-
     HammerCLI::MainCommand.lazy_subcommand('report', _("Browse and read reports"),
       'HammerCLIForeman::ConfigReport', 'hammer_cli_foreman/config_report',
       :warning => _('%{report} command is deprecated and will be removed in one of the future versions. Please use %{config_report} command instead.') % {:report => 'report', :config_report => 'config-report'}
@@ -134,10 +121,6 @@ module HammerCLIForeman
       'HammerCLIForeman::Role', 'hammer_cli_foreman/role'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('sc-param', _("Manipulate smart class parameters"),
-      'HammerCLIForeman::SmartClassParameter', 'hammer_cli_foreman/smart_class_parameter'
-    )
-
     HammerCLI::MainCommand.lazy_subcommand('proxy', _("Manipulate smart proxies"),
       'HammerCLIForeman::SmartProxy', 'hammer_cli_foreman/smart_proxy'
     )
@@ -166,10 +149,6 @@ module HammerCLIForeman
       'HammerCLIForeman::Usergroup', 'hammer_cli_foreman/usergroup'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('config-group', _("Manipulate config groups"),
-      'HammerCLIForeman::ConfigGroup', 'hammer_cli_foreman/config_group'
-    )
-
     HammerCLI::MainCommand.lazy_subcommand('ping', _("Get the status of the server and/or it's subcomponents"),
       'HammerCLIForeman::PingCommand', 'hammer_cli_foreman/ping'
     )
@@ -184,6 +163,9 @@ module HammerCLIForeman
 
     HammerCLI::MainCommand.lazy_subcommand('bookmark', _("Manage bookmarks"),
                                             'HammerCLIForeman::Bookmark', 'hammer_cli_foreman/bookmark')
+
+    HammerCLI::MainCommand.lazy_subcommand('host-registration', _("Host Registration"),
+                                            'HammerCLIForeman::Registration', 'hammer_cli_foreman/registration')
   rescue => e
     handler = HammerCLIForeman::ExceptionHandler.new(:context => {}, :adapter => :base)
     handler.handle_exception(e)

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

@@ -20,7 +20,7 @@ module HammerCLIForeman
 
     class InfoCommand < HammerCLIForeman::InfoCommand
       output ListCommand.output_definition
-      
+
       build_options
     end
 

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.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/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/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/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/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
@@ -294,7 +287,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 +541,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 +566,7 @@ module HammerCLIForeman
       opts
     end
 
+    extend_with(HammerCLIForeman::CommandExtensions::UpdateCommon.new)
   end
 
 

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -104,6 +104,15 @@ module HammerCLIForeman
       build_options
     end
 
+    class AssociateVmsCommand < HammerCLIForeman::Command
+      action :associate
+      command_name 'associate-vms'
+      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 +137,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/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/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

data/lib/hammer_cli_foreman/host.rb

@@ -1,7 +1,5 @@
 require 'hammer_cli_foreman/fact'
 require 'hammer_cli_foreman/config_report'
-require 'hammer_cli_foreman/puppet_class'
-require 'hammer_cli_foreman/smart_class_parameter'
 require 'hammer_cli_foreman/interface'
 require 'hammer_cli_foreman/hosts/common_update_options'
 require 'hammer_cli_foreman/compute_resource/register_compute_resources'
@@ -31,8 +29,6 @@ module HammerCLIForeman
       end
 
       build_options :without => [:include]
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
     end
 
 
@@ -58,9 +54,6 @@ module HammerCLIForeman
         field nil, _("Host Group"), Fields::SingleReference, :key => :hostgroup, :display_field => 'title'
         field nil, _("Compute Resource"), Fields::SingleReference, :key => :compute_resource
         field nil, _("Compute Profile"), Fields::SingleReference, :key => :compute_profile, :hide_blank => true
-        field nil, _("Puppet Environment"), Fields::SingleReference, :key => :environment
-        field nil, _("Puppet CA Proxy"), Fields::SingleReference, :key => :puppet_ca_proxy
-        field nil, _("Puppet Master Proxy"), Fields::SingleReference, :key => :puppet_proxy
         field :certname, _("Cert name")
         field :managed, _("Managed"), Fields::Boolean
 
@@ -171,18 +164,7 @@ module HammerCLIForeman
     end
 
 
-    class PuppetRunCommand < HammerCLIForeman::SingleResourceCommand
-      command_name "puppetrun"
-      resource :puppet_hosts
-      action :puppetrun
-
-      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
-    end
+ 
 
 
     class FactsCommand < HammerCLIForeman::AssociatedResourceListCommand
@@ -202,23 +184,6 @@ module HammerCLIForeman
       build_options
     end
 
-
-    class PuppetClassesCommand < HammerCLIForeman::ListCommand
-      command_name "puppet-classes"
-      resource :puppetclasses
-
-      output HammerCLIForeman::PuppetClass::ListCommand.output_definition
-
-      def send_request
-        HammerCLIForeman::PuppetClass::ListCommand.unhash_classes(super)
-      end
-
-      build_options do |o|
-        o.without(:hostgroup_id, :environment_id)
-        o.expand.only(:hosts)
-      end
-    end
-
     class ConfigReportsCommand < HammerCLIForeman::ListCommand
       command_name 'config-reports'
       resource :config_reports, :index
@@ -304,7 +269,6 @@ module HammerCLIForeman
         end
       end
 
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
       extend_with(HammerCLIForeman::CommandExtensions::Hosts::Help::Interfaces.new)
       extend_with(HammerCLIForeman::CommandExtensions::Hosts::Help::ComputeResources.custom(add_host_specific_attrs: true).new)
     end
@@ -335,7 +299,6 @@ module HammerCLIForeman
         sources
       end
 
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
       extend_with(HammerCLIForeman::CommandExtensions::Hosts::Help::Interfaces.new)
       extend_with(HammerCLIForeman::CommandExtensions::Hosts::Help::ComputeResources.custom(add_host_specific_attrs: true).new)
     end
@@ -468,15 +431,6 @@ module HammerCLIForeman
       build_options without: [:power_action]
     end
 
-    class SCParamsCommand < HammerCLIForeman::SmartClassParametersList
-      build_options_for :hosts
-
-      def validate_options
-        super
-        validator.any(:option_host_name, :option_host_id).required
-      end
-    end
-
     class RebuildConfigCommand < HammerCLIForeman::SingleResourceCommand
       action :rebuild_config
       command_name "rebuild-config"