hammer_cli_foreman 2.5.2 → 3.0.0

data/lib/hammer_cli_foreman/location.rb

@@ -36,7 +36,6 @@ module HammerCLIForeman
         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)
         collection :organizations, _("Organizations"), :numbered => false, :hide_blank => true do
@@ -58,8 +57,6 @@ module HammerCLIForeman
       failure_message _("Could not create the location")
 
       build_options
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironments.new)
     end
 
 
@@ -72,8 +69,6 @@ module HammerCLIForeman
       failure_message _("Could not update the location")
 
       build_options
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironments.new)
     end
 
 
@@ -112,7 +107,6 @@ module HammerCLIForeman
     end
 
     HammerCLIForeman::AssociatingCommands::Hostgroup.extend_command(self)
-    HammerCLIForeman::AssociatingCommands::PuppetEnvironment.extend_command(self)
     HammerCLIForeman::AssociatingCommands::Domain.extend_command(self)
     HammerCLIForeman::AssociatingCommands::Medium.extend_command(self)
     HammerCLIForeman::AssociatingCommands::Subnet.extend_command(self)

data/lib/hammer_cli_foreman/mail_notification.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
 
     class InfoCommand < HammerCLIForeman::InfoCommand
@@ -22,7 +22,7 @@ module HammerCLIForeman
         field :subscription_type, _("Subscription type")
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     autoload_subcommands

data/lib/hammer_cli_foreman/model.rb

@@ -13,7 +13,7 @@ module HammerCLIForeman
         field :hardware_model, _("HW model")
       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,14 +31,14 @@ module HammerCLIForeman
       success_message _("Hardware model created.")
       failure_message _("Could not create the hardware model")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       success_message _("Hardware model deleted.")
       failure_message _("Could not delete the hardware model")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -46,7 +46,7 @@ module HammerCLIForeman
       success_message _("Hardware model updated.")
       failure_message _("Could not update the hardware model")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 

data/lib/hammer_cli_foreman/operating_system.rb

@@ -13,7 +13,7 @@ module HammerCLIForeman
         field :family, _("Family")
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -36,7 +36,7 @@ module HammerCLIForeman
         HammerCLIForeman::References.parameters(self)
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -44,7 +44,7 @@ module HammerCLIForeman
       success_message _("Operating system created.")
       failure_message _("Could not create the operating system")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -52,7 +52,7 @@ module HammerCLIForeman
       success_message _("Operating system updated.")
       failure_message _("Could not update the operating system")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -60,7 +60,7 @@ module HammerCLIForeman
       success_message _("Operating system deleted.")
       failure_message _("Could not delete the operating system")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -76,7 +76,7 @@ module HammerCLIForeman
         validator.any(:option_operatingsystem_id, :option_operatingsystem_title).required
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -90,7 +90,7 @@ module HammerCLIForeman
         validator.any(:option_operatingsystem_id, :option_operatingsystem_title).required
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 
@@ -156,8 +156,8 @@ module HammerCLIForeman
         HammerCLI::EX_OK
       end
 
-      build_options expand: { except: %i[organizations locations] },
-                    without: %i[organization_id location_id template_kind_id type]
+      build_options without: [:template_kind_id, :type]
+
     end
 
 
@@ -192,7 +192,7 @@ module HammerCLIForeman
         {"operatingsystem_id" => option_id}
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 

data/lib/hammer_cli_foreman/option_sources/id_params.rb

@@ -13,22 +13,39 @@ module HammerCLIForeman
         IdParamsFilter.new(:only_required => false).for_action(@command.resource.action(@command.action))
       end
 
-      def get_options(defined_options, result)
+      def needs_resolving?(param_option, param_resource, all_opts)
+        return false unless param_updatable?(param_resource)
+
+        searchables_set = @command.searchables.for(param_resource).any? do |s|
+          option = HammerCLI.option_accessor_name("#{param_resource.singular_name}_#{s.name}")
+          !all_opts[option].nil?
+        end
+        return all_opts[param_option].nil? unless searchables_set
+
+        # Remove set '<resource_name>_id' option to force resolving in case of
+        # '<resource_name>_[name|title]' was set
+        all_opts.delete(param_option)
+        true
+      end
+
+      def get_options(_defined_options, result)
         # resolve all '<resource_name>_id' parameters if they are defined as options
         # (they can be skipped using .without or .expand.except)
         return result if @command.action.nil?
+
         available_id_params.each do |api_param|
           param_resource = HammerCLIForeman.param_to_resource(api_param.name)
-          if result[HammerCLI.option_accessor_name(api_param.name)].nil? && param_updatable?(param_resource)
-            resource_id = @command.get_resource_id(param_resource, :scoped => true, :required => api_param.required?, :all_options => result)
-            result[HammerCLI.option_accessor_name(api_param.name)] = resource_id if resource_id
-          end
+          param_option = HammerCLI.option_accessor_name(api_param.name)
+          next unless needs_resolving?(param_option, param_resource, result)
+
+          resource_id = @command.get_resource_id(
+            param_resource, scoped: true, required: api_param.required?, all_options: result
+          )
+          result[param_option] = resource_id if resource_id
         end
         result
-
       rescue HammerCLIForeman::MissingSearchOptions => e
-
-        switches = @command.class.find_options(:referenced_resource => e.resource.singular_name).map(&:long_switch)
+        switches = @command.class.find_options(referenced_resource: e.resource.singular_name).map(&:long_switch)
 
         if switches.empty?
           error_message = _("Could not find %{resource}. Some search options were missing, please see --help.")
@@ -40,8 +57,8 @@ module HammerCLIForeman
 
         raise MissingSearchOptions.new(
           error_message % {
-            :resource => e.resource.singular_name,
-            :switches => switches.join(", ")
+            resource: e.resource.singular_name,
+            switches: switches.join(', ')
           },
           e.resource
         )

data/lib/hammer_cli_foreman/option_sources/ids_params.rb

@@ -13,15 +13,34 @@ module HammerCLIForeman
         IdArrayParamsFilter.new(:only_required => false).for_action(@command.resource.action(@command.action))
       end
 
-      def get_options(defined_options, result)
-        return result if @command.action.nil?
+      def needs_resolving?(param_option, param_resource, all_opts)
+        return false unless param_updatable?(param_resource)
+
+        searchables_set = @command.searchables.for(param_resource).any? do |s|
+          option = HammerCLI.option_accessor_name("#{param_resource.singular_name}_#{s.plural_name}")
+          !all_opts[option].nil?
+        end
+        return all_opts[param_option].nil? unless searchables_set
+
+        # Remove set '<resource_name>_ids' option to force resolving in case of
+        # '<resource_name>_[names|titles]' was set
+        all_opts.delete(param_option)
+        true
+      end
+
+      def get_options(_defined_options, result)
         # resolve all '<resource_name>_ids' parameters if they are defined as options
+        return result if @command.action.nil?
+
         available_ids_params.each do |api_param|
           param_resource = HammerCLIForeman.param_to_resource(api_param.name)
-          if result[HammerCLI.option_accessor_name(api_param.name)].nil? && param_updatable?(param_resource)
-            resource_ids = @command.get_resource_ids(param_resource, :scoped => true, :required => api_param.required?, :all_options => result)
-            result[HammerCLI.option_accessor_name(api_param.name)] = resource_ids if resource_ids
-          end
+          param_option = HammerCLI.option_accessor_name(api_param.name)
+          next unless needs_resolving?(param_option, param_resource, result)
+
+          resource_ids = @command.get_resource_ids(
+            param_resource, scoped: true, required: api_param.required?, all_options: result
+          )
+          result[param_option] = resource_ids if resource_ids
         end
         result
       end

data/lib/hammer_cli_foreman/option_sources.rb

@@ -3,6 +3,5 @@ require 'hammer_cli_foreman/option_sources/ids_params'
 require 'hammer_cli_foreman/option_sources/self_param'
 require 'hammer_cli_foreman/option_sources/user_params'
 require 'hammer_cli_foreman/option_sources/fields_params'
-require 'hammer_cli_foreman/option_sources/puppet_environment_params'
 require 'hammer_cli_foreman/option_sources/new_params'
 require 'hammer_cli_foreman/option_sources/referenced_resource_id_params'

data/lib/hammer_cli_foreman/organization.rb

@@ -36,7 +36,6 @@ module HammerCLIForeman
         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)
         collection :locations, _("Locations"), :numbered => false, :hide_blank => true do
@@ -59,8 +58,6 @@ module HammerCLIForeman
       failure_message _("Could not create the organization")
 
       build_options
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironments.new)
     end
 
 
@@ -73,8 +70,6 @@ module HammerCLIForeman
       failure_message _("Could not update the organization")
 
       build_options
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironments.new)
     end
 
 
@@ -114,7 +109,6 @@ module HammerCLIForeman
 
 
     HammerCLIForeman::AssociatingCommands::Hostgroup.extend_command(self)
-    HammerCLIForeman::AssociatingCommands::PuppetEnvironment.extend_command(self)
     HammerCLIForeman::AssociatingCommands::Domain.extend_command(self)
     HammerCLIForeman::AssociatingCommands::Medium.extend_command(self)
     HammerCLIForeman::AssociatingCommands::Subnet.extend_command(self)

data/lib/hammer_cli_foreman/references.rb

@@ -112,14 +112,6 @@ module HammerCLIForeman
       end
     end
 
-    def self.environments(dsl)
-      dsl.build do
-        collection :environments, _("Environments"), :numbered => false do
-          custom_field Fields::Reference
-        end
-      end
-    end
-
     def self.hostgroups(dsl)
       dsl.build do
         collection :hostgroups, _("Hostgroups"), :numbered => false do
@@ -153,14 +145,6 @@ module HammerCLIForeman
       end
     end
 
-    def self.puppetclasses(dsl)
-      dsl.build do
-        collection :puppetclasses, _("Puppetclasses"), :numbered => false do
-          custom_field Fields::Reference
-        end
-      end
-    end
-
     def self.operating_systems(dsl)
       dsl.build do
         collection :operatingsystems, _("Operating systems"), :numbered => false do

data/lib/hammer_cli_foreman/settings.rb

@@ -20,7 +20,7 @@ module HammerCLIForeman
         data
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
@@ -29,7 +29,7 @@ module HammerCLIForeman
       success_message _("Setting [%{name}] updated to [%{value}].")
       failure_message _("Could not update the setting")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
@@ -42,7 +42,7 @@ module HammerCLIForeman
         field :value, _("Value")
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
 

data/lib/hammer_cli_foreman/smart_proxy.rb

@@ -60,58 +60,6 @@ module HammerCLIForeman
       build_options
     end
 
-
-    class ImportPuppetClassesCommand < HammerCLIForeman::Command
-      action :import_puppetclasses
-
-      command_name    "import-classes"
-
-      option "--dryrun", :flag, _("Do not run the import")
-
-      output do
-        field :message, _("Result"), Fields::LongText
-        collection :results, _("Changed environments"), :hide_blank => true do
-          field :name, nil
-          collection :new_puppetclasses, _("New classes"), :hide_blank => true, :numbered => false do
-            field nil, nil
-          end
-          collection :updated_puppetclasses, _("Updated classes"), :hide_blank => true, :numbered => false do
-            field nil, nil
-          end
-          collection :obsolete_puppetclasses, _("Removed classes"), :hide_blank => true, :numbered => false do
-            field nil, nil
-          end
-          collection :ignored_puppetclasses, _("Ignored classes"), :hide_blank => true, :numbered => false do
-            field nil, nil
-          end
-        end
-      end
-
-      build_options do |o|
-        o.without(:smart_proxy_id, :dryrun)
-        o.expand.except(:smart_proxies)
-      end
-
-      def request_params
-        opts = super
-        opts['dryrun'] = option_dryrun? || false
-        opts
-      end
-
-      def transform_format(data)
-        # Overriding the default behavior that tries to remove nesting
-        # when there's only {"message": "..."}
-        data
-      end
-
-      def print_data(record)
-        print_record(output_definition, record)
-      end
-
-      extend_with(HammerCLIForeman::CommandExtensions::PuppetEnvironment.new)
-    end
-
-
     class RefreshFeaturesCommand < HammerCLIForeman::Command
 
       action :refresh

data/lib/hammer_cli_foreman/usergroup.rb

@@ -13,7 +13,7 @@ module HammerCLIForeman
         field :admin, _("Admin"), Fields::Boolean
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
@@ -25,28 +25,28 @@ module HammerCLIForeman
         HammerCLIForeman::References.timestamps(self)
       end
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
       success_message _("User group [%<name>s] created.")
       failure_message _("Could not create the user group")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       success_message _("User group [%<name>s] updated.")
       failure_message _("Could not update the user group")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       success_message _("User group [%<name>s] deleted.")
       failure_message _("Could not delete the user group")
 
-      build_options expand: { except: %i[organizations locations] }, without: %i[organization_id location_id]
+      build_options
     end
 
     HammerCLIForeman::AssociatingCommands::Role.extend_command(self)

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new "2.5.2"
+    @version ||= Gem::Version.new "3.0.0"
   end
 end

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 classes"),
-      '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'
     )

data/lib/minitest/coverage_reporter.rb

@@ -3,7 +3,7 @@ require "json"
 module Minitest
   class CoverageRunner
 
-    RESOURCE_BLACK_LIST = ['tasks','home','config_groups','statistics','table_preferences','autosign','puppet_hosts']
+    RESOURCE_BLACK_LIST = ['tasks','home','statistics','table_preferences','autosign']
     attr_reader :raw_data, :api_endpoints, :covered_resources, :uncovered_resources, :partially_covered_resources
     def initialize(file_path)
       @raw_data = JSON.load(File.open(file_path))

data/test/functional/architecture_test.rb

@@ -7,9 +7,9 @@ describe 'architecture' do
     before do
       @cmd = %w[architecture list]
       @architectures = [{
-                      id: 1,
-                      name: 'i386',
-                    }]
+        id: 1,
+        name: 'i386'
+      }]
     end
 
     it 'should return a list of architectures' do
@@ -26,7 +26,7 @@ describe 'architecture' do
     end
 
     it 'should run list command with defaults' do
-      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.1')) }
+      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.5')) }
       defaults = HammerCLI::Defaults.new(
         {
           organization_id: {
@@ -39,6 +39,8 @@ describe 'architecture' do
       )
       defaults.stubs(:write_to_file).returns(true)
       defaults.stubs(:providers).returns(providers)
+      api_expects(:users, :index, 'Find user').with_params(search: 'login=admin').returns(index_response([{ 'default_organization' => { 'id' => 2 } }]))
+      api_expects(:users, :index, 'Find user').with_params(search: 'login=admin').returns(index_response([{ 'default_location' => { 'id' => 1 } }]))
       api_expects(:architectures, :index, 'List architectures').returns(@architectures)
 
       result = run_cmd(@cmd, { use_defaults: true, defaults: defaults })

data/test/functional/bookmark_test.rb

@@ -29,7 +29,7 @@ describe 'bookmark' do
     end
 
     it 'should run list command with defaults' do
-      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.1')) }
+      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.5')) }
       defaults = HammerCLI::Defaults.new(
         {
           organization_id: {
@@ -42,6 +42,8 @@ describe 'bookmark' do
       )
       defaults.stubs(:write_to_file).returns(true)
       defaults.stubs(:providers).returns(providers)
+      api_expects(:users, :index, 'Find user').with_params(search: 'login=admin').returns(index_response([{ 'default_organization' => { 'id' => 2 } }]))
+      api_expects(:users, :index, 'Find user').with_params(search: 'login=admin').returns(index_response([{ 'default_location' => { 'id' => 1 } }]))
       api_expects(:bookmarks, :index, 'List bookmarks').returns(@bookmarks)
 
       result = run_cmd(@cmd, { use_defaults: true, defaults: defaults })

data/test/functional/compute_profile_test.rb

@@ -132,7 +132,7 @@ describe "parameters" do
     end
 
     it 'should run list command with defaults' do
-      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.1')) }
+      providers = { 'foreman' => HammerCLIForeman::Defaults.new(api_connection({}, '2.5')) }
       defaults = HammerCLI::Defaults.new(
         {
           organization_id: {
@@ -145,6 +145,8 @@ describe "parameters" do
       )
       defaults.stubs(:write_to_file).returns(true)
       defaults.stubs(:providers).returns(providers)
+      api_expects(:users, :index, 'Find user').with_params(search: 'login=admin').returns(index_response([{ 'default_organization' => { 'id' => 2 } }]))
+      api_expects(:users, :index, 'Find user').with_params(search: 'login=admin').returns(index_response([{ 'default_location' => { 'id' => 1 } }]))
       api_expects(:compute_profiles, :index, 'List compute profiles').returns(@compute_profiles)
 
       result = run_cmd(@cmd, { use_defaults: true, defaults: defaults })

data/test/functional/host_test.rb

@@ -356,7 +356,6 @@ describe 'host update' do
       'organization_id' => '5',
       'location_id' => '5',
       'compute_attributes' => {},
-      'puppetclass_ids' => [],
       'owner_id' => '1',
       'owner_name' => 'adminGroup',
       'owner_type' => 'Usergroup'