hammer_cli_foreman 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87407ba2c43be96a076220e9500050007447596f6d14024932fa85a7c9046f20
-  data.tar.gz: 2987c54ab5fef04cc45629754a55c62d16a252b6cd950e7de461a989712a79ca
+  metadata.gz: 70a45953e142e7d3a67ee81e99bb5cc6fccaf179d2a61e44922f3b809196a178
+  data.tar.gz: 6c958ff14e311eef47ac379a41ceb45cbabe7f7ed34b3d28c64c40fe963f2ca5
 SHA512:
-  metadata.gz: 030d7c3ff4d19fb767e771c123b8cb0de2a6166cec3ec2012b689f7d920d3049a234f7900ee43141c2af97ce0d5aaf403ea9a9f3962072bdffc181126de57e70
-  data.tar.gz: 6acaf9a9b06c59b4c7db28b73bdc7dfe31170ac3b621adb2b85a5a501090e310a4fcfc703e2b6dc48170a693ff675507b8b9c478a8c344ff7793bfe778a8f3f3
+  metadata.gz: 6d436e24f99cc80f70aff4ad2c0436a92d63e8b60b5f1aa1ebb787e0fe202404c686fe78397ae16ae9bb3f2261834f8a02db39417a2511fd562c316344933d7a
+  data.tar.gz: 828772047e91923c3b6ac365fa942d381483988ed4c7303a1021d560e73d4f591d1656613ef45916cdc565fa3b7989a6b0f577c655c5624f5a5f8e9bdc82f24b

data/config/foreman.yml

@@ -29,6 +29,10 @@
   #:oidc_client_id: example-client-id
   #:oidc_redirect_uri: urn:ietf:wg:oauth:2.0:oob
 
+  # Negotiate (Kerberos) Auth:
+  # User needs to run kinit before using hammer (or initiate kerberos keyring in another way).
+  #:default_auth_type: 'Negotiate_Auth'
+
   # Enable using sessions
   # When sessions are enabled, hammer ignores credentials stored in the config file
   # and asks for them interactively at the begining of each session.

data/doc/configuration.md

@@ -49,3 +49,33 @@ Please note that when you turn sessions on, the credentials stored in your confi
 
 The default session timeout is 1 hour. This can be changed in the Foreman: `Settings > Authentication > Idle timeout`
 When the session expires hammer will prompt for username and password again.
+
+### Negotiate (Kerberos) auth
+
+This implements Kerberos authentication, usually implemented in FreeIPA or Microsoft Active Directory.
+For this to work, the host that we are trying to use hammer on, needs to have realm already configured on this host.
+This can be achieved through `realm join`, please refer to that command for more info.
+
+**Sessions needs to be enabled**
+
+`~/.hammer/cli.modules.d/foreman.yml`
+```yaml
+:foreman:
+  :default_auth_type: 'Negotiate_Auth'
+  :use_sessions: true
+```
+
+```bash
+# To initiate the kerberos keyring (this might be already done on login)
+$ kinit <kerb_user>
+# Enter your password
+$ klist
+Ticket cache: KEYRING:persistent:1000:1000
+Default principal: kerb_user@REALM.EXAMPLE.COM
+
+# use hammer as usuall, it will negotiate your auth on the first request
+hammer ...
+
+# or if you do not have negotiate as default auth, initiate the auth manually
+hammer auth login negotiate
+```

data/doc/release_notes.md

@@ -1,5 +1,15 @@
 Release notes
 =============
+### 3.3.0 (2022-05-10)
+* Add kerberos negotiate auth support ([PR #555](https://github.com/theforeman/hammer-cli-foreman/pull/555)), [#8923](http://projects.theforeman.org/issues/8923)
+* Pin mocha gem to < 1.14.0
+* Force api docs checksum check, [#28283](http://projects.theforeman.org/issues/28283)
+* Add template report-remplate and partition-table export command ([PR #595](https://github.com/theforeman/hammer-cli-foreman/pull/595)), [#34503](http://projects.theforeman.org/issues/34503)
+* Add template import and partition-table import commands ([PR #596](https://github.com/theforeman/hammer-cli-foreman/pull/596)), [#22692](http://projects.theforeman.org/issues/22692)
+* Add resource information to download command ([PR #598](https://github.com/theforeman/hammer-cli-foreman/pull/598)), [#34621](http://projects.theforeman.org/issues/34621)
+* Add command to import ipv4 subnet from smart proxy ([PR #593](https://github.com/theforeman/hammer-cli-foreman/pull/593)), [#33255](http://projects.theforeman.org/issues/33255)
+* Bump to 3.3.0-develop
+
 ### 3.2.0 (2022-02-10)
 * Domain update doesn't reset dns implicitly ([PR #591](https://github.com/theforeman/hammer-cli-foreman/pull/591)), [#34177](http://projects.theforeman.org/issues/34177)
 * Send filter's tax params only when required ([PR #592](https://github.com/theforeman/hammer-cli-foreman/pull/592)), [#34199](http://projects.theforeman.org/issues/34199)

data/lib/hammer_cli_foreman/api/authenticator.rb

@@ -13,6 +13,8 @@ module HammerCLIForeman
           void_auth
         elsif auth_type == AUTH_TYPES[:basic_auth]
           basic_auth
+        elsif auth_type == AUTH_TYPES[:negotiate]
+          negotiate_auth
         elsif auth_type == AUTH_TYPES[:oauth_password_grant]
           oauth_password_grant
         elsif auth_type == AUTH_TYPES[:oauth_authentication_code_grant]
@@ -43,6 +45,13 @@ module HammerCLIForeman
         end
       end
 
+      def negotiate_auth
+        return unless HammerCLIForeman::Sessions.enabled?
+
+        authenticator = NegotiateAuth.new(uri)
+        SessionAuthenticatorWrapper.new(authenticator, uri, auth_type)
+      end
+
       def oauth_password_grant
         return unless HammerCLIForeman::Sessions.enabled?
 

data/lib/hammer_cli_foreman/api/connection.rb

@@ -1,6 +1,7 @@
 require 'hammer_cli_foreman/api/session_authenticator_wrapper'
 require 'hammer_cli_foreman/api/authenticator'
 require 'hammer_cli_foreman/api/interactive_basic_auth'
+require 'hammer_cli_foreman/api/negotiate_auth'
 require 'hammer_cli_foreman/api/oauth/authentication_code_grant'
 require 'hammer_cli_foreman/api/oauth/password_grant'
 require 'hammer_cli_foreman/api/void_auth'
@@ -10,6 +11,7 @@ module HammerCLIForeman
   CONNECTION_NAME = 'foreman'
   AUTH_TYPES = {
     basic_auth: 'Basic_Auth',
+    negotiate: 'Negotiate_Auth',
     oauth_authentication_code_grant: 'Oauth_Authentication_Code_Grant',
     oauth_password_grant: 'Oauth_Password_Grant'
   }.freeze

data/lib/hammer_cli_foreman/api/negotiate_auth.rb

@@ -0,0 +1,36 @@
+module HammerCLIForeman
+  module Api
+    class NegotiateAuth < ApipieBindings::Authenticators::Negotiate
+      def initialize(foreman_url, **options)
+        super("#{foreman_url}/users/extlogin", HammerCLI::SSLOptions.new.get_options(foreman_url).merge(options))
+      end
+
+      def user
+        _('current Kerberos user')
+      end
+
+      def session_id
+        auth_cookie&.delete_prefix('_session_id=')
+      end
+
+      def status
+        if system('klist')
+          _('No session, but there is an active Kerberos session, that will be used for negotiate login.')
+        else
+          _('There is no active Kerberos session. Have you run %s?') % 'kinit'
+        end
+      end
+
+      def error(ex)
+        super unless ex.is_a?(RestClient::Unauthorized)
+
+        message = _('Invalid username or password.')
+        begin
+          message = JSON.parse(ex.response.body)['error']['message']
+        rescue
+        end
+        UnauthorizedError.new(message)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb

@@ -24,6 +24,8 @@ module HammerCLIForeman
       def status
         if session.valid?
           _("Session exists, currently logged in as '%s'.") % session.user_name
+        elsif @authenticator.respond_to?(:status)
+          @authenticator.status
         else
           _('Using sessions, you are currently not logged in.')
         end
@@ -66,8 +68,10 @@ module HammerCLIForeman
       end
 
       def response(r)
-        if (r.cookies['_session_id'] && r.code != 401)
-          session.id = r.cookies['_session_id']
+        session_id = @authenticator.session_id if @authenticator.respond_to?(:session_id)
+        session_id ||= r.cookies['_session_id']
+        if session_id && r.code != 401
+          session.id = session_id
           session.user_name = @authenticator.user
           session.store
         end

data/lib/hammer_cli_foreman/api.rb

@@ -7,4 +7,5 @@ module HammerCLIForeman
   end
 end
 
-HammerCLIForeman.init_api_connection
+api = HammerCLIForeman.init_api_connection.api
+api.update_cache(api.check_cache)

data/lib/hammer_cli_foreman/auth.rb

@@ -28,6 +28,19 @@ module HammerCLIForeman
         end
       end
 
+      class Negotiate < HammerCLI::AbstractCommand
+        extend HammerCLIForeman::Authenticate::Login
+
+        command_name('negotiate')
+        desc('negotiate the login credentials from the auth ticket (Kerberos)')
+
+        def execute
+          Negotiate.execute_with_params(AUTH_TYPES[:negotiate])
+          print_message(_("Successfully authenticated using negotiate auth, using the KEYRING principal."))
+          HammerCLI::EX_OK
+        end
+      end
+
       class Oauth < HammerCLI::AbstractCommand
         extend HammerCLIForeman::Authenticate::Login
 

data/lib/hammer_cli_foreman/commands.rb

@@ -744,13 +744,17 @@ module HammerCLIForeman
       response = send_request
       if option_path
         filepath = store_response(response)
-        print_message(_('The response has been saved to %{path}s.'), {:path => filepath})
+        print_message(saved_response_message(filepath))
       else
         puts response.body
       end
       return HammerCLI::EX_OK
     end
 
+    def saved_response_message(filepath)
+      _("The response has been saved to %{path}.") % { path: filepath }
+    end
+
     def default_filename
       "Downloaded-#{Time.new.strftime("%Y-%m-%d")}.txt"
     end

data/lib/hammer_cli_foreman/exception_handler.rb

@@ -12,6 +12,7 @@ module HammerCLIForeman
         [RestClient::UnprocessableEntity, :handle_unprocessable_entity],
         [RestClient::MovedPermanently, :handle_moved_permanently],
         [RestClient::BadRequest, :handle_bad_request],
+        [ApipieBindings::AuthenticatorError, :handle_authenticator_error],
         [HammerCLIForeman::Api::UnauthorizedError, :handle_foreman_unauthorized],
         [HammerCLIForeman::Api::SessionExpired, :handle_sesion_expired],
         [ArgumentError, :handle_argument_error],
@@ -112,6 +113,12 @@ module HammerCLIForeman
       HammerCLI::EX_DATAERR
     end
 
+    def handle_authenticator_error(e)
+      print_error authenticator_error_message(e)
+      log_full_error e.original_error
+      HammerCLI::EX_USAGE
+    end
+
     def ssl_cert_instructions
       host_url = HammerCLI::Settings.get(:_params, :host) || HammerCLI::Settings.get(:foreman, :host)
       uri = URI.parse(host_url)
@@ -147,6 +154,25 @@ module HammerCLIForeman
 
     private
 
+    def authenticator_error_message(e)
+      case e.type
+      when :negotiate then negotiation_error_message(e)
+      end
+    end
+
+    def negotiation_error_message(e)
+      case e.cause
+      when :configuration
+        _('Server misconfiguration detected') + "\n  - " +
+          _('have you run installer with option %s?') % '--foreman-ipa-authentication=true' + "\n  - " +
+          _('the user might come from a different authentication source') + "\n"
+      else
+        _('Could not authenticate using negotiation protocol') + "\n  - " +
+          _('have you run %s (for Kerberos)?') % 'kinit' + "\n  - " +
+          _('is the server down?') + "\n"
+      end
+    end
+
     def response_message(response)
       message = JSON.parse(response)["error"]["message"]
       "\n  #{message}"

data/lib/hammer_cli_foreman/partition_table.rb

@@ -71,6 +71,36 @@ module HammerCLIForeman
       build_options
     end
 
+    class ImportCommand < HammerCLIForeman::Command
+      command_name "import"
+      action :import
+      option '--file', 'PATH', _('Path to a file that contains the template content including metadata'),
+             :attribute_name => :option_template, :format => HammerCLI::Options::Normalizers::File.new
+
+      validate_options do
+        all(:option_name, :option_template).required
+      end
+
+      success_message _("Import partition table template succeeded.")
+      failure_message _("Could not import partition table template")
+
+      build_options :without => [:template]
+    end
+
+    class ExportCommand < HammerCLIForeman::DownloadCommand
+      command_name "export"
+      action :export
+
+      def default_filename
+        "Partition Table Template-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def saved_response_message(filepath)
+        _("The partition table template has been saved to %{path}.") % { path: filepath }
+      end
+
+      build_options
+    end
 
     HammerCLIForeman::AssociatingCommands::OperatingSystem.extend_command(self)
 

data/lib/hammer_cli_foreman/report_template.rb

@@ -148,6 +148,21 @@ module HammerCLIForeman
       build_options :without => [:template]
     end
 
+    class ExportCommand < HammerCLIForeman::DownloadCommand
+      command_name "export"
+      action :export
+
+      def default_filename
+        "Report Template-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def saved_response_message(filepath)
+        _("The report template has been saved to %{path}.") % { path: filepath }
+      end
+
+      build_options
+    end
+
     class ReportDataCommand < HammerCLIForeman::DownloadCommand
       command_name "report-data"
       action :report_data

data/lib/hammer_cli_foreman/smart_proxy.rb

@@ -73,6 +73,17 @@ module HammerCLIForeman
       build_options
     end
 
+    class ImportSubnetsCommand < HammerCLIForeman::Command
+
+      action :import_subnets
+
+      command_name    "import-subnets"
+      success_message _("Import subnets succeeded.")
+      failure_message _("Could not import subnets")
+
+      build_options
+    end
+
     autoload_subcommands
   end
 

data/lib/hammer_cli_foreman/template.rb

@@ -142,7 +142,37 @@ module HammerCLIForeman
       build_options
     end
 
+    class ImportCommand < HammerCLIForeman::Command
+      command_name "import"
+      action :import
+      option '--file', 'PATH', _('Path to a file that contains the template content including metadata'),
+             :attribute_name => :option_template, :format => HammerCLI::Options::Normalizers::File.new
 
+      validate_options do
+        all(:option_name, :option_template).required
+      end
+
+      success_message _("Import provisioning template succeeded.")
+      failure_message _("Could not import provisioning template")
+
+      build_options :without => [:template]
+    end
+
+    class ExportCommand < HammerCLIForeman::DownloadCommand
+      command_name "export"
+      action :export
+
+      def default_filename
+        "Template-#{Time.new.strftime("%Y-%m-%d")}.txt"
+      end
+
+      def saved_response_message(filepath)
+        _("The provisioning template has been saved to %{path}.") % { path: filepath }
+      end
+
+      build_options
+    end
+    
     class BuildPXEDefaultCommand < HammerCLIForeman::Command
 
       action :build_pxe_default

data/lib/hammer_cli_foreman/version.rb

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

data/test/functional/partition_table_test.rb

@@ -0,0 +1,63 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'partition-table' do
+  describe 'import' do
+    let(:template) do
+      {
+        'id' => 1,
+        'template' => 'Template content'
+      }
+    end
+    let(:cmd) { %w(partition-table import) }
+    let(:tempfile) { Tempfile.new('template') }
+
+    it 'requires --name and --file' do
+      params = ['--name=test']
+      api_expects_no_call
+      expected_result = usage_error_result(
+        cmd,
+        'Options --name, --file are required.',
+        'Could not import partition table template')
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'import template' do
+      params = ['--name=test', "--file=#{tempfile.path}"]
+      tempfile.write('Template content')
+      tempfile.rewind
+      api_expects(:ptables, :import, 'Import partition table template').with_params(
+        'ptable' => {
+          'name' => 'test',
+          'template' => 'Template content'
+        }).returns(template)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(success_result("Import partition table template succeeded.\n"), result)
+    end
+  end
+
+  describe 'export' do
+    let(:cmd) { %w(partition-table export) }
+    let(:tempfile) { Tempfile.new('template', '/tmp') }
+    let(:params) { ['--id=1', '--path=/tmp'] }
+    let(:template_response) do
+      response = mock('TemplateResponse')
+      response.stubs(:code).returns(200)
+      response.stubs(:body).returns('Template content')
+      response.stubs(:headers).returns({:content_disposition => "filename=\"#{File.basename(tempfile.path)}\""})
+      response
+    end
+
+    it 'download template' do
+      api_expects(:ptables, :export, 'Export partition table template').with_params(
+        'id' => '1').returns(template_response)
+
+      output = OutputMatcher.new("The partition table template has been saved to #{tempfile.path}")
+      expected_result = success_result(output)
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+      assert_equal('Template content', tempfile.read)
+    end
+  end
+end

data/test/functional/report_template_test.rb

@@ -384,6 +384,30 @@ describe 'report-template' do
     end
   end
 
+  describe 'export' do
+    let(:cmd) { %w(report-template export) }
+    let(:tempfile) { Tempfile.new('template', '/tmp') }
+    let(:params) { ['--id=1', '--path=/tmp'] }
+    let(:template_response) do
+      response = mock('TemplateResponse')
+      response.stubs(:code).returns(200)
+      response.stubs(:body).returns('Template content')
+      response.stubs(:headers).returns({:content_disposition => "filename=\"#{File.basename(tempfile.path)}\""})
+      response
+    end
+
+    it 'download template' do
+      api_expects(:report_templates, :export, 'Export report template').with_params(
+        'id' => '1').returns(template_response)
+
+      output = OutputMatcher.new("The report template has been saved to #{tempfile.path}")
+      expected_result = success_result(output)
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+      assert_equal('Template content', tempfile.read)
+    end
+  end
+
   describe 'report-data' do
     let(:cmd) { %w(report-template report-data) }
     let(:tempfile) { Tempfile.new('template', '/tmp') }

data/test/functional/template_test.rb

@@ -77,6 +77,66 @@ describe 'template' do
     end
   end
 
+  describe 'import' do
+    let(:template) do
+      {
+        'id' => 1,
+        'template' => 'Template content'
+      }
+    end
+    let(:cmd) { %w(template import) }
+    let(:tempfile) { Tempfile.new('template') }
+
+    it 'requires --name and --file' do
+      params = ['--name=test']
+      api_expects_no_call
+      expected_result = usage_error_result(
+        cmd,
+        'Options --name, --file are required.',
+        'Could not import provisioning template')
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'import template' do
+      params = ['--name=test', "--file=#{tempfile.path}"]
+      tempfile.write('Template content')
+      tempfile.rewind
+      api_expects(:provisioning_templates, :import, 'Import template').with_params(
+        'provisioning_template' => {
+          'name' => 'test',
+          'template' => 'Template content'
+        }).returns(template)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(success_result("Import provisioning template succeeded.\n"), result)
+    end
+  end
+
+  describe 'export' do
+    let(:cmd) { %w(template export) }
+    let(:tempfile) { Tempfile.new('template', '/tmp') }
+    let(:params) { ['--id=1', '--path=/tmp'] }
+    let(:template_response) do
+      response = mock('TemplateResponse')
+      response.stubs(:code).returns(200)
+      response.stubs(:body).returns('Template content')
+      response.stubs(:headers).returns({:content_disposition => "filename=\"#{File.basename(tempfile.path)}\""})
+      response
+    end
+
+    it 'download template' do
+      api_expects(:provisioning_templates, :export, 'Export template').with_params(
+        'id' => '1').returns(template_response)
+
+      output = OutputMatcher.new("The provisioning template has been saved to #{tempfile.path}")
+      expected_result = success_result(output)
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+      assert_equal('Template content', tempfile.read)
+    end
+  end
+
   describe 'update' do
     before do
       @cmd = %w(template update)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli_foreman
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Tomáš Strachota
 - Martin Bačovský
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hammer_cli
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: apipie-bindings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -75,12 +75,11 @@ dependencies:
         version: 2.2.1
 description: 'Foreman commands for Hammer CLI
 
-'
+  '
 email: tstracho@redhat.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- doc/configuration.md
 - doc/name_id_resolution.md
 - doc/option_builder.md
 - doc/using_hammer_cli_foreman_command.md
@@ -88,6 +87,7 @@ extra_rdoc_files:
 - doc/host_create.md
 - doc/plugin.md
 - doc/testing.md
+- doc/configuration.md
 - doc/release_notes.md
 - README.md
 files:
@@ -108,6 +108,7 @@ files:
 - lib/hammer_cli_foreman/api/authenticator.rb
 - lib/hammer_cli_foreman/api/connection.rb
 - lib/hammer_cli_foreman/api/interactive_basic_auth.rb
+- lib/hammer_cli_foreman/api/negotiate_auth.rb
 - lib/hammer_cli_foreman/api/oauth/authentication_code_grant.rb
 - lib/hammer_cli_foreman/api/oauth/password_grant.rb
 - lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb
@@ -267,6 +268,7 @@ files:
 - test/functional/model_test.rb
 - test/functional/operating_system_test.rb
 - test/functional/organization_test.rb
+- test/functional/partition_table_test.rb
 - test/functional/personal_access_token_test.rb
 - test/functional/ping_test.rb
 - test/functional/realm_test.rb
@@ -345,7 +347,7 @@ homepage: https://github.com/theforeman/hammer-cli-foreman
 licenses:
 - GPL-3.0+
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -361,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Foreman commands for Hammer
 test_files:
@@ -379,61 +381,63 @@ test_files:
 - test/data/1.24/foreman_api.json
 - test/data/2.0/foreman_api.json
 - test/data/2.1/foreman_api.json
+- test/data/README.md
 - test/data/2.4/foreman_api.json
 - test/data/2.5/foreman_api.json
-- test/data/README.md
 - test/data/3.1/foreman_api.json
 - test/functional/auth_source_test.rb
 - test/functional/commands/list_test.rb
-- test/functional/usergroup_test.rb
 - test/functional/hostgroup/create_test.rb
 - test/functional/hostgroup/update_test.rb
-- test/functional/personal_access_token_test.rb
-- test/functional/template_test.rb
+- test/functional/architecture_test.rb
 - test/functional/compute_attribute_test.rb
-- test/functional/model_test.rb
+- test/functional/ping_test.rb
+- test/functional/user_test.rb
 - test/functional/ssh_keys_test.rb
 - test/functional/subnet/update_test.rb
 - test/functional/subnet/create_test.rb
 - test/functional/test_helper.rb
-- test/functional/filter_test.rb
-- test/functional/http_proxy_test.rb
+- test/functional/location_test.rb
 - test/functional/media_test.rb
-- test/functional/registration_test.rb
+- test/functional/partition_table_test.rb
+- test/functional/personal_access_token_test.rb
+- test/functional/report_template_test.rb
+- test/functional/settings_test.rb
+- test/functional/status_test.rb
 - test/functional/user_mail_notification_test.rb
-- test/functional/domain/create_test.rb
-- test/functional/domain/update_test.rb
-- test/functional/operating_system_test.rb
-- test/functional/compute_resource_test.rb
+- test/functional/compute_profile_test.rb
+- test/functional/realm_test.rb
+- test/functional/usergroup_test.rb
 - test/functional/organization_test.rb
-- test/functional/report_template_test.rb
-- test/functional/user_test.rb
 - test/functional/virtual_machine_test.rb
+- test/functional/compute_resource_test.rb
+- test/functional/domain/create_test.rb
+- test/functional/domain/update_test.rb
+- test/functional/filter_test.rb
 - test/functional/host_test.rb
+- test/functional/http_proxy_test.rb
 - test/functional/mail_notification_test.rb
-- test/functional/bookmark_test.rb
-- test/functional/location_test.rb
+- test/functional/operating_system_test.rb
+- test/functional/template_test.rb
 - test/functional/associating_commands_test.rb
 - test/functional/audit_test.rb
-- test/functional/ping_test.rb
-- test/functional/realm_test.rb
 - test/functional/role_test.rb
-- test/functional/status_test.rb
-- test/functional/architecture_test.rb
-- test/functional/compute_profile_test.rb
-- test/functional/settings_test.rb
+- test/functional/bookmark_test.rb
+- test/functional/model_test.rb
+- test/functional/registration_test.rb
 - test/unit/api/void_auth_test.rb
 - test/unit/api/interactive_basic_auth_test.rb
 - test/unit/api/oauth/oauth_authentication_code_grant_test.rb
 - test/unit/api/oauth/oauth_password_grant_test.rb
 - test/unit/api/session_authenticator_wrapper_test.rb
 - test/unit/test_output_adapter.rb
-- test/unit/settings_test.rb
+- test/unit/host_test.rb
 - test/unit/auth_source_ldap_test.rb
 - test/unit/config_report_test.rb
 - test/unit/compute_resource_test.rb
 - test/unit/data/test_api.json
 - test/unit/defaults_test.rb
+- test/unit/id_resolver_test.rb
 - test/unit/external_usergroup_test.rb
 - test/unit/fact_test.rb
 - test/unit/helpers/fake_searchables.rb
@@ -442,26 +446,25 @@ test_files:
 - test/unit/image_test.rb
 - test/unit/location_test.rb
 - test/unit/messages_test.rb
+- test/unit/mail_notification_test.rb
 - test/unit/option_sources/id_params_test.rb
 - test/unit/option_sources/ids_params_test.rb
 - test/unit/organization_test.rb
 - test/unit/output/formatters_test.rb
 - test/unit/common_parameter_test.rb
 - test/unit/realm_test.rb
-- test/unit/compute_profile_test.rb
-- test/unit/host_test.rb
+- test/unit/settings_test.rb
+- test/unit/usergroup_test.rb
 - test/unit/subnet_test.rb
 - test/unit/test_helper.rb
 - test/unit/user_test.rb
 - test/unit/param_filters_test.rb
-- test/unit/partition_table_test.rb
 - test/unit/role_test.rb
-- test/unit/hostgroup_test.rb
-- test/unit/id_resolver_test.rb
-- test/unit/mail_notification_test.rb
 - test/unit/model_test.rb
 - test/unit/operating_system_test.rb
 - test/unit/option_builders_test.rb
+- test/unit/architecture_test.rb
+- test/unit/commands_test.rb
 - test/unit/audit_test.rb
 - test/unit/auth_source_external.rb
 - test/unit/dependency_resolver_test.rb
@@ -469,13 +472,13 @@ test_files:
 - test/unit/filter_test.rb
 - test/unit/media_test.rb
 - test/unit/sessions_test.rb
-- test/unit/apipie_resource_mock.rb
-- test/unit/commands_test.rb
+- test/unit/bookmark_test.rb
+- test/unit/hostgroup_test.rb
 - test/unit/api_test.rb
-- test/unit/architecture_test.rb
-- test/unit/smart_proxy_test.rb
-- test/unit/usergroup_test.rb
+- test/unit/apipie_resource_mock.rb
+- test/unit/compute_profile_test.rb
+- test/unit/partition_table_test.rb
 - test/unit/template_test.rb
-- test/unit/bookmark_test.rb
+- test/unit/smart_proxy_test.rb
 - test/unit/domain_test.rb
 - test/test_helper.rb