foreman_maintain 0.8.20 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72beb43529d9eb83adadc1f644b7e67cf8276d19527af380a94405affc16894b
-  data.tar.gz: 6a08f0bb85ad408f9dac5e904e7c6f5af30eba339e919e44d8740332fb8d33d3
+  metadata.gz: dcef2fd68b963d566c30be2531b1f09bf71da02eb8cd06e2c280f9d4a6222fc0
+  data.tar.gz: 5a1448015d72fe8e8ae19c73eff430b13387c699689a5dbbdd0b73bbbe49c9f0
 SHA512:
-  metadata.gz: 480de2bbfe003b974b86d8f5baebdd624f3ebf407260f914b368c615fbc8481eb2b6c8d7592bd25f30f1055d892d7170385cbbdd06e84ec7100cd554fae993c8
-  data.tar.gz: 752ed2fb124297336e477357786adb1f8b157fe319bb13872d6cf684a5fbd9908d4e66c482bedf23cd5ef84ff75f573030e377a0e92a65e8f555fa793b85846a
+  metadata.gz: 348bedd61056cffd63610b9a91d0e8c2a31e3012ec0e41880e05195ae840a61bd14c7d84ea23715cae771272f555b95f05085e4fb1fefc01a4f1a1f84880648d
+  data.tar.gz: 76f1871c0edb9671ec0a45fec272afed10ae05bb9ebab4b92ecc3f7960bb1a7625b9267eba032fb6335fac1e8cc32116047e87dab109fb8745ce37e212399768

data/definitions/checks/check_for_newer_packages.rb

@@ -33,9 +33,11 @@ class Checks::CheckForNewerPackages < ForemanMaintain::Check
     end
 
     unless packages_with_updates.empty?
-      failure_message = 'An update is available for package(s): '\
-                        "#{packages_with_updates.join(',')}. Please update before proceeding!"
-      fail! failure_message
+      command = ForemanMaintain.pkg_and_cmd_name[1]
+      fail! 'Required updates for some packages detected.'\
+        "\nPlease update to the latest #{@manual_confirmation_version}.z release "\
+        'before proceeding, using:'\
+        "\n# #{command} upgrade run --target-version #{@manual_confirmation_version}.z"
     end
   end
 

data/definitions/checks/disk/performance.rb

@@ -39,8 +39,8 @@ module Checks
         end
       end
 
-      def default_dirs
-        @default_dirs ||= %i[pulp2 pulpcore_database mongo foreman_database].inject({}) do |dirs, f|
+      def data_dirs
+        @data_dirs ||= %i[pulpcore_database mongo foreman_database].inject({}) do |dirs, f|
           if feature(f) && File.directory?(feature(f).data_dir)
             dirs[feature(f).label_dashed] = feature(f).data_dir
           end
@@ -48,20 +48,32 @@ module Checks
         end
       end
 
+      def pulp_dir
+        @pulp_dir ||= begin
+          pulp_feature = feature(:pulp2) || feature(:pulpcore_database)
+          { pulp_feature.label_dashed => pulp_feature.pulp_data_dir }
+        end
+      end
+
       def description
-        "Check recommended disk speed for #{default_dirs.keys.join(', ')} directories."
+        'Check recommended disk speed for '\
+        "#{[data_dirs.keys | pulp_dir.keys].join(', ')} directories."
+      end
+
+      def all_dirs
+        data_dirs.values | pulp_dir.values
       end
 
       def check_only_single_device?
-        default_dirs.values do |dir|
+        all_dirs.each do |dir|
           ForemanMaintain::Utils::Disk::Device.new(dir).name
         end.uniq.length <= 1
       end
 
       def dirs_to_check
-        return default_dirs.values.first(1) if check_only_single_device?
+        return all_dirs.first(1) if check_only_single_device?
 
-        default_dirs.values
+        all_dirs
       end
 
       private
@@ -74,11 +86,10 @@ module Checks
       def compute_disk_speed(spinner)
         success = true
         io_obj = ForemanMaintain::Utils::Disk::NilDevice.new
-
         dirs_to_check.each do |dir|
           io_obj = ForemanMaintain::Utils::Disk::Device.new(dir)
 
-          spinner.update("[Speed check In-Progress] device: #{io_obj.name}")
+          spinner.update("[Speed check In-Progress] device:#{io_obj.name}")
           stats << io_obj
 
           next if io_obj.read_speed >= EXPECTED_IO

data/definitions/checks/foreman/check_puppet_capsules.rb

@@ -0,0 +1,43 @@
+module Checks
+  class CheckPuppetCapsules < ForemanMaintain::Check
+    metadata do
+      label :puppet_capsules
+      for_feature :foreman_database
+      description 'Check for Puppet capsules from the database'
+      manual_detection
+    end
+
+    def run
+      puppet_proxies = find_puppet_proxies.reject { |proxy| local_proxy?(proxy['url']) }
+      unless puppet_proxies.empty?
+        names = puppet_proxies.map { |proxy| proxy['name'] }
+        print('You have proxies with Puppet feature enabled, '\
+              "please disable Puppet on all proxies first.\n"\
+              "The following proxies have Puppet feature: #{names.join(', ')}.")
+        abort!
+      end
+    end
+
+    def find_puppet_proxies
+      feature(:foreman_database).query(puppet_proxies_query)
+    end
+
+    private
+
+    def local_proxy?(url)
+      URI.parse(url).hostname.casecmp(hostname) == 0
+    end
+
+    def puppet_proxies_query
+      <<-SQL
+        SELECT \"smart_proxies\".*
+          FROM \"smart_proxies\"
+            INNER JOIN \"smart_proxy_features\"
+              ON \"smart_proxies\".\"id\" = \"smart_proxy_features\".\"smart_proxy_id\"
+            INNER JOIN \"features\"
+              ON \"features\".\"id\" = \"smart_proxy_features\".\"feature_id\"
+          WHERE \"features\".\"name\" = 'Puppet'
+      SQL
+    end
+  end
+end

data/definitions/checks/repositories/validate.rb

@@ -3,8 +3,7 @@ module Checks::Repositories
     metadata do
       description 'Validate availability of repositories'
       preparation_steps do
-        [Checks::Repositories::CheckNonRhRepository.new,
-         Procedures::Packages::Install.new(:packages => [ForemanMaintain::Utils::Facter.package])]
+        Checks::Repositories::CheckNonRhRepository.new
       end
 
       confine do

data/definitions/checks/restore/validate_interfaces.rb

@@ -0,0 +1,24 @@
+require 'foreman_maintain/utils/backup'
+
+module Checks::Restore
+  class ValidateInterfaces < ForemanMaintain::Check
+    metadata do
+      description 'Validate network interfaces match the backup'
+
+      param :backup_dir,
+            'Path to backup directory',
+            :required => true
+      manual_detection
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+      invalid_interfaces = backup.validate_interfaces
+      msg = 'The following features are enabled in the backup, '\
+        "\nbut the system does not have the interfaces used by these features: "
+      msg << invalid_interfaces.map { |k, v| "#{k} (#{v['configured']})" }.join(', ')
+      msg << '.'
+      assert(backup.validate_interfaces.empty?, msg)
+    end
+  end
+end

data/definitions/features/candlepin.rb

@@ -13,8 +13,7 @@ class Features::Candlepin < ForemanMaintain::Feature
 
   def services
     [
-      system_service('tomcat', 20),
-      system_service('tomcat6', 20)
+      system_service('tomcat', 20)
     ]
   end
 end

data/definitions/features/foreman_tasks.rb

@@ -17,6 +17,17 @@ class Features::ForemanTasks < ForemanMaintain::Feature
     Actions::Candlepin::ListenOnCandlepinEvents
     Actions::Katello::EventQueue::Monitor
     Actions::Insights::EmailPoller
+    ForemanInventoryUpload::Async::GenerateReportJob
+    ForemanInventoryUpload::Async::QueueForUploadJob
+    ForemanInventoryUpload::Async::UploadReportJob
+    InsightsCloud::Async::InsightsClientStatusAging
+    InsightsCloud::Async::InsightsFullSync
+    InsightsCloud::Async::InsightsResolutionsSync
+    InsightsCloud::Async::InsightsRulesSync
+    InventorySync::Async::InventoryFullSync
+    InventorySync::Async::InventoryHostsSync
+    InventorySync::Async::InventoryScheduledSync
+    InventorySync::Async::InventorySelfHostSync
   ].freeze
 
   metadata do

data/definitions/features/pulpcore.rb

@@ -37,7 +37,8 @@ class Features::Pulpcore < ForemanMaintain::Feature
 
   def config_files
     [
-      '/etc/pulp/settings.py'
+      '/etc/pulp/settings.py',
+      '/etc/pulp/certs/database_fields.symmetric.key'
     ]
   end
 

data/definitions/features/system_repos.rb

@@ -21,6 +21,10 @@ class Features::SystemRepos < ForemanMaintain::Feature
     Hash[*repos.delete!(' ').split("\n")]
   end
 
+  def enabled_repos_ids
+    trim_repoids(enabled_repos_hash.keys)
+  end
+
   def upstream_repos_ids
     trim_repoids(upstream_repos.keys)
   end
@@ -29,6 +33,10 @@ class Features::SystemRepos < ForemanMaintain::Feature
     execute!("yum-config-manager --disable #{repo_ids.join(',')}")
   end
 
+  def enable_repos(repo_ids)
+    execute!("yum-config-manager --enable #{repo_ids.join(',')}")
+  end
+
   private
 
   def trim_repoids(repos)

data/definitions/procedures/backup/metadata.rb

@@ -9,6 +9,8 @@ module Procedures::Backup
       param :online_backup, 'Select for online backup', :flag => true, :default => false
     end
 
+    PROXY_CONFIG_ENTRIES = %w[dns dns_interface dhcp dhcp_interface].freeze
+
     def run
       with_spinner('Collecting metadata') do |spinner|
         metadata = {}
@@ -18,6 +20,8 @@ module Procedures::Backup
         metadata['rpms'] = rpms(spinner)
         metadata['incremental'] = @incremental_dir || false
         metadata['online'] = @online_backup
+        metadata['hostname'] = hostname
+        metadata['proxy_config'] = proxy_config(spinner)
         save_metadata(metadata, spinner)
       end
     end
@@ -54,5 +58,12 @@ module Procedures::Backup
         feature(:foreman_proxy).features
       end
     end
+
+    def proxy_config(spinner)
+      spinner.update('Collecting proxy configuration')
+      feature(:installer).answers['foreman_proxy'].select do |key, _|
+        PROXY_CONFIG_ENTRIES.include?(key)
+      end
+    end
   end
 end

data/definitions/procedures/content/prepare.rb

@@ -10,7 +10,7 @@ module Procedures::Content
       sleep(20) # in satellite 6.9 the services are still coming up
       # use interactive to get realtime output
       env_vars = @quiet ? '' : 'preserve_output=true '
-      puts execute!("#{env_vars}foreman-rake katello:pulp3_migration", :interactive => true)
+      execute!("#{env_vars}foreman-rake katello:pulp3_migration", :interactive => true)
     end
   end
 end

data/definitions/procedures/installer/upgrade_rake_task.rb

@@ -5,7 +5,9 @@ module Procedures::Installer
     end
 
     def run
-      execute!('foreman-rake upgrade:run')
+      # only run this in the Satellite scenario, as in others
+      # the installer runs this rake task for us already
+      execute!('foreman-rake upgrade:run') if feature(:satellite)
     end
   end
 end

data/definitions/procedures/pulpcore/migrate.rb

@@ -18,7 +18,7 @@ module Procedures::Pulpcore
         spinner.update('Migrating pulpcore database')
         execute!('sudo PULP_SETTINGS=/etc/pulp/settings.py '\
           'DJANGO_SETTINGS_MODULE=pulpcore.app.settings '\
-          'python3-django-admin migrate --noinput')
+          'pulpcore-manager migrate --noinput')
       end
     end
   end

data/definitions/procedures/puppet/remove_puppet.rb

@@ -0,0 +1,50 @@
+module Procedures::Puppet
+  class RemovePuppet < ForemanMaintain::Procedure
+    metadata do
+      description 'Remove Puppet feature'
+      confine do
+        feature(:puppet_server) &&
+          (check_min_version('foreman', '3.0') || check_min_version('foreman-proxy', '3.0'))
+      end
+      advanced_run false
+    end
+
+    def run
+      services = feature(:foreman_server).services + feature(:dynflow_sidekiq).services
+      Procedures::Service::Stop.new(:only => services)
+      execute!('foreman-rake db:migrate VERSION=0 SCOPE=foreman_puppet') if server_with_puppet?
+      feature(:installer).run(installer_arguments_disabling_puppet.join(' '), :interactive => false)
+      packages_action(:remove, packages_to_remove, :assumeyes => true)
+    end
+
+    private
+
+    def server_with_puppet?
+      find_package(foreman_plugin_name('foreman_puppet'))
+    end
+
+    def installer_arguments_disabling_puppet
+      answers = feature(:installer).answers
+
+      options = []
+      options << '--no-enable-puppet' if answers.key?('puppet')
+      options << '--no-enable-foreman-plugin-puppet' if answers['foreman::plugin::puppet']
+      options << '--no-enable-foreman-cli-puppet' if answers['foreman::cli::puppet']
+      if answers['foreman_proxy']
+        options << '--foreman-proxy-puppet false'
+        options << '--foreman-proxy-puppetca false'
+      end
+      options << '--foreman-proxy-content-puppet false' if answers.key?('foreman_proxy_content')
+      options
+    end
+
+    def packages_to_remove
+      packages = ['puppetserver']
+      if server_with_puppet?
+        packages << foreman_plugin_name('foreman_puppet')
+        packages << hammer_plugin_name('foreman_puppet')
+      end
+      packages
+    end
+  end
+end

data/definitions/procedures/puppet/remove_puppet_data.rb

@@ -0,0 +1,21 @@
+module Procedures::Puppet
+  class RemovePuppetData < ForemanMaintain::Procedure
+    metadata do
+      description 'Remove Puppet data'
+    end
+
+    def run
+      execute!('foreman-rake purge:puppet')
+      execute!('rm -r ' + files_to_purge.join(' '))
+    end
+
+    private
+
+    def files_to_purge
+      %w[
+        /etc/puppetlabs
+        /opt/puppetlabs/server/data
+      ]
+    end
+  end
+end

data/definitions/procedures/repositories/backup_enabled_repos.rb

@@ -0,0 +1,16 @@
+module Procedures::Repositories
+  class BackupEnabledRepos < ForemanMaintain::Procedure
+    metadata do
+      label :backup_enabled_repos
+      description 'Stores enabled repositories in yaml file'
+    end
+
+    def run
+      enabled_repos_ids = feature(:system_repos).enabled_repos_ids
+      unless enabled_repos_ids.empty?
+        backup_dir = File.expand_path(ForemanMaintain.config.backup_dir)
+        File.write(File.join(backup_dir, 'enabled_repos.yml'), enabled_repos_ids.to_yaml)
+      end
+    end
+  end
+end

data/definitions/procedures/repositories/enable.rb

@@ -0,0 +1,13 @@
+module Procedures::Repositories
+  class Enable < ForemanMaintain::Procedure
+    metadata do
+      param :repos, 'List of repositories to enable'
+      description 'Enable repositories'
+    end
+    def run
+      with_spinner('Enabling repositories') do
+        feature(:system_repos).enable_repos(@repos)
+      end
+    end
+  end
+end

data/definitions/procedures/repositories/setup.rb

@@ -2,10 +2,6 @@ module Procedures::Repositories
   class Setup < ForemanMaintain::Procedure
     metadata do
       description 'Setup repositories'
-      preparation_steps do
-        Procedures::Packages::Install.new(:packages => [ForemanMaintain::Utils::Facter.package])
-      end
-
       confine do
         feature(:instance).downstream || feature(:upstream)
       end

data/definitions/procedures/restore/configs.rb

@@ -56,7 +56,11 @@ module Procedures::Restore
     def reset_qpid_jrnls
       # on restore without pulp data qpid fails to start
       # https://access.redhat.com/solutions/4645231
-      execute('rm -rf /var/lib/qpidd/.qpidd/qls/dat2/__db.00*')
+      ['/var/lib/qpidd/.qpidd/', '/var/lib/qpidd/'].each do |qpidd_path|
+        if Dir.exist?("#{qpidd_path}/qls/dat2/")
+          execute("rm -rf #{qpidd_path}/qls/dat2/__db.00*")
+        end
+      end
     end
   end
 end

data/definitions/scenarios/puppet.rb

@@ -0,0 +1,21 @@
+module ForemanMaintain::Scenarios
+  module Puppet
+    class RemovePuppet < ForemanMaintain::Scenario
+      metadata do
+        description 'Remove Puppet feature'
+        tags :puppet_disable
+        label :puppet_disable
+        param :remove_data, 'Purge the Puppet data after disabling plugin'
+        manual_detection
+      end
+
+      def compose
+        if check_min_version('foreman', '3.0') || check_min_version('foreman-proxy', '3.0')
+          add_step(Checks::CheckPuppetCapsules) if server?
+          add_step(Procedures::Puppet::RemovePuppet)
+          add_step(Procedures::Puppet::RemovePuppetData) if context.get(:remove_data)
+        end
+      end
+    end
+  end
+end

data/definitions/scenarios/restore.rb

@@ -6,18 +6,27 @@ module ForemanMaintain::Scenarios
       description 'Restore backup'
       param :backup_dir, 'Path to backup directory'
       param :incremental_backup, 'Is the backup incremental?'
+      param :dry_run, 'Check if backup could be restored, without performing the restore'
       manual_detection
     end
 
     # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
     def compose
       backup = ForemanMaintain::Utils::Backup.new(context.get(:backup_dir))
 
       add_steps(find_checks(:root_user))
       supported_version_check
       add_steps_with_context(Checks::Restore::ValidateBackup,
-                             Procedures::Restore::Confirmation,
                              Checks::Restore::ValidateHostname,
+                             Checks::Restore::ValidateInterfaces)
+
+      if context.get(:dry_run)
+        self.class.metadata[:run_strategy] = :fail_slow
+        return
+      end
+
+      add_steps_with_context(Procedures::Restore::Confirmation,
                              Procedures::Selinux::SetFileSecurity,
                              Procedures::Restore::Configs)
       add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
@@ -42,9 +51,12 @@ module ForemanMaintain::Scenarios
       add_steps_with_context(Procedures::Restore::RegenerateQueues) if backup.online_backup?
       add_steps_with_context(Procedures::Service::Start,
                              Procedures::Service::DaemonReload)
+      add_step(Procedures::Installer::Upgrade.new(:assumeyes => true))
+      add_step_with_context(Procedures::Installer::UpgradeRakeTask)
       add_step_with_context(Procedures::Crond::Start) if feature(:cron)
     end
     # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
 
     def drop_dbs(backup)
       if backup.file_map[:candlepin_dump][:present] ||
@@ -87,6 +99,7 @@ module ForemanMaintain::Scenarios
       context.map(:backup_dir,
                   Checks::Restore::ValidateBackup => :backup_dir,
                   Checks::Restore::ValidateHostname => :backup_dir,
+                  Checks::Restore::ValidateInterfaces => :backup_dir,
                   Procedures::Restore::Configs => :backup_dir,
                   Procedures::Restore::DropDatabases => :backup_dir,
                   Procedures::Restore::PgGlobalObjects => :backup_dir,

data/definitions/scenarios/self_upgrade.rb

@@ -0,0 +1,102 @@
+module ForemanMaintain::Scenarios
+  class SelfUpgradeBase < ForemanMaintain::Scenario
+    def enabled_system_repos_id
+      feature(:system_repos).enabled_repos_ids
+    end
+
+    def enable_repos(repo_ids = stored_enabled_repos_ids)
+      add_step(Procedures::Repositories::Enable.new(repos: repo_ids))
+    end
+
+    def disable_repos(repo_ids = stored_enabled_repos_ids)
+      add_step(Procedures::Repositories::Disable.new(repos: repo_ids))
+    end
+
+    def target_version
+      @target_version ||= context.get(:target_version)
+    end
+
+    def current_version
+      feature(:instance).downstream.current_minor_version
+    end
+
+    def maintenance_repo_id(version)
+      if (repo = ENV['maintenance_repo'])
+        return repo unless repo.empty?
+      end
+
+      maintenance_repo(version)
+    end
+
+    def maintenance_repo(version)
+      if el7?
+        "rhel-#{el_major_version}-server-satellite-maintenance-#{version}-rpms"
+      else
+        "satellite-maintenance-#{version}-for-rhel-#{el_major_version}-x86_64-rpms"
+      end
+    end
+
+    def maintenance_repo_version
+      return '6' if current_version == '6.10'
+
+      current_version
+    end
+
+    def stored_enabled_repos_ids
+      @stored_enabled_repos_ids ||= begin
+        path = File.expand_path('enabled_repos.yml', ForemanMaintain.config.backup_dir)
+        @stored_enabled_repos_ids = File.file?(path) ? YAML.load(File.read(path)) : []
+      end
+    end
+
+    def all_maintenance_repos
+      repo_regex = if el7?
+                     /rhel-\d-server-satellite-maintenance-\d.\d-rpms/
+                   else
+                     /satellite-maintenance-\d.\d-for-rhel-\d-x86_64-rpms/
+                   end
+      stored_enabled_repos_ids.select { |id| !id.match(repo_regex).nil? }
+    end
+
+    def repos_ids_to_reenable
+      repos_ids_to_reenable = stored_enabled_repos_ids - all_maintenance_repos
+      repos_ids_to_reenable << maintenance_repo(maintenance_repo_version)
+    end
+  end
+
+  class SelfUpgrade < SelfUpgradeBase
+    metadata do
+      label :self_upgrade_foreman_maintain
+      description "Enables the specified version's maintenance repository and, "\
+  								'updates the foreman-maintain packages'
+      manual_detection
+    end
+
+    def compose
+      if check_min_version('foreman', '2.5') || check_min_version('foreman-proxy', '2.5')
+        pkgs_to_update = %w[satellite-maintain rubygem-foreman_maintain]
+        add_step(Procedures::Repositories::BackupEnabledRepos.new)
+        disable_repos
+        add_step(Procedures::Repositories::Enable.new(repos: [maintenance_repo_id(target_version)]))
+        add_step(Procedures::Packages::Update.new(packages: pkgs_to_update, assumeyes: true))
+        enable_repos(repos_ids_to_reenable)
+      end
+    end
+  end
+
+  class SelfUpgradeRescue < SelfUpgradeBase
+    metadata do
+      label :rescue_self_upgrade
+      description 'Disables all version specific maintenance repos and,'\
+  		' enables the repositories which were configured prior to self upgrade'
+      manual_detection
+      run_strategy :fail_slow
+    end
+
+    def compose
+      if check_min_version('foreman', '2.5') || check_min_version('foreman-proxy', '2.5')
+        enable_repos(repos_ids_to_reenable)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/plugin_command.rb

@@ -0,0 +1,14 @@
+module ForemanMaintain
+  module Cli
+    class PluginCommand < Base
+      subcommand 'purge-puppet', 'Remove the Puppet feature' do
+        option ['-f', '--remove-all-data'], :flag, 'Purge all the Puppet data',
+               :attribute_name => :remove_data
+
+        def execute
+          run_scenarios_and_exit(Scenarios::Puppet::RemovePuppet.new(:remove_data => remove_data?))
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/restore_command.rb

@@ -7,11 +7,15 @@ module ForemanMaintain
 
       option ['-i', '--incremental'], :flag, 'Restore an incremental backup',
              :attribute_name => :incremental, :completion => { :type => :directory }
+      option ['-n', '--dry-run'], :flag,
+             'Check if backup could be restored, without performing the restore',
+             :attribute_name => :dry_run
 
       def execute
         scenario = Scenarios::Restore.new(
           :backup_dir => @backup_dir,
-          :incremental_backup => @incremental || incremental_backup?
+          :incremental_backup => @incremental || incremental_backup?,
+          :dry_run => @dry_run
         )
         rescue_scenario = Scenarios::RestoreRescue.new
         run_scenario(scenario, rescue_scenario)

data/lib/foreman_maintain/cli/self_upgrade_command.rb

@@ -0,0 +1,38 @@
+module ForemanMaintain
+  module Cli
+    class SelfUpgradeCommand < Base
+      option ['--target-version'], 'TARGET_VERSION',\
+             'Major version of the Satellite or Capsule'\
+           	', e.g 7.0', :required => true
+      def execute
+        allow_major_version_upgrade_only
+        run_scenario(upgrade_scenario, upgrade_rescue_scenario)
+      end
+
+      def upgrade_scenario
+        Scenarios::SelfUpgrade.new(target_version: target_version)
+      end
+
+      def upgrade_rescue_scenario
+        Scenarios::SelfUpgradeRescue.new(target_version: target_version)
+      end
+
+      def current_downstream_version
+        ForemanMaintain.detector.feature(:instance).downstream.current_version
+      end
+
+      def allow_major_version_upgrade_only
+        begin
+          next_version = Gem::Version.new(target_version)
+        rescue ArgumentError => err
+          raise Error::UsageError, "Invalid version! #{err}"
+        end
+        if current_downstream_version >= next_version
+          message = "The target-version #{target_version} should be "\
+                    "greater than existing version #{current_downstream_version}!"
+          raise Error::UsageError, message
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli.rb

@@ -11,6 +11,8 @@ require 'foreman_maintain/cli/restore_command'
 require 'foreman_maintain/cli/maintenance_mode_command'
 require 'foreman_maintain/cli/packages_command'
 require 'foreman_maintain/cli/content_command'
+require 'foreman_maintain/cli/plugin_command'
+require 'foreman_maintain/cli/self_upgrade_command'
 
 module ForemanMaintain
   module Cli
@@ -25,6 +27,8 @@ module ForemanMaintain
       subcommand 'packages', 'Lock/Unlock package protection, install, update', PackagesCommand
       subcommand 'advanced', 'Advanced tools for server maintenance', AdvancedCommand
       subcommand 'content', 'Content related commands', ContentCommand
+      subcommand 'plugin', 'Manage optional plugins on your server', PluginCommand
+      subcommand 'self-upgrade', 'Perform major version self upgrade', SelfUpgradeCommand
       subcommand 'maintenance-mode', 'Control maintenance-mode for application',
                  MaintenanceModeCommand
       if ForemanMaintain.detector.feature(:satellite) &&

data/lib/foreman_maintain/concerns/os_facts.rb

@@ -0,0 +1,70 @@
+module ForemanMaintain
+  module Concerns
+    module OsFacts
+      OS_RELEASE_FILE = '/etc/os-release'.freeze
+      FALLBACK_OS_RELEASE_FILE = '/usr/lib/os-release'.freeze
+
+      def os_release_file
+        if File.file?(OS_RELEASE_FILE)
+          return OS_RELEASE_FILE
+        elsif File.file?(FALLBACK_OS_RELEASE_FILE)
+          return FALLBACK_OS_RELEASE_FILE
+        else
+          puts "The #{OS_RELEASE_FILE} and #{FALLBACK_OS_RELEASE_FILE} files are missing! "\
+               "Can't continue the execution without Operating System's facts!"
+          exit 1
+        end
+      end
+
+      def facts
+        unless defined?(@facts)
+          @facts = {}
+          regex = /^(["'])(.*)(\1)$/
+          File.open(os_release_file) do |file|
+            file.readlines.each do |line|
+              line.strip! # drop any whitespace, including newlines from start and end of the line
+              next if line.start_with?('#') # ignore comments
+              # split at most into 2 items, if the value ever contains an =
+              key, value = line.split('=', 2)
+              next unless key && value
+              @facts[key] = value.gsub(regex, '\2').delete('\\')
+            end
+          end
+        end
+        @facts
+      end
+
+      def os_version_id
+        facts.fetch('VERSION_ID')
+      end
+
+      def os_id
+        facts.fetch('ID')
+      end
+
+      def os_id_like_list
+        facts.fetch('ID_LIKE', '').split
+      end
+
+      def el?
+        File.exist?('/etc/redhat-release')
+      end
+
+      def debian?
+        File.exist?('/etc/debian_version')
+      end
+
+      def el7?
+        el_major_version == 7
+      end
+
+      def el8?
+        el_major_version == 8
+      end
+
+      def el_major_version
+        return os_version_id.to_i if el?
+      end
+    end
+  end
+end

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -8,6 +8,7 @@ module ForemanMaintain
     module SystemHelpers
       include Logger
       include Concerns::Finders
+      include ForemanMaintain::Concerns::OsFacts
 
       def self.included(klass)
         klass.extend(self)
@@ -184,51 +185,24 @@ module ForemanMaintain
         ForemanMaintain.package_manager
       end
 
-      def os_facts
-        facter = ForemanMaintain::Utils::Facter.path
-        @os_facts ||= JSON.parse(execute("#{facter} -j os"))
-      end
-
-      def el?
-        os_facts['os']['family'] == 'RedHat'
-      end
-
-      def debian?
-        os_facts['os']['family'] == 'Debian'
-      end
-
-      def el7?
-        os_facts['os']['release']['major'] == '7' && el?
-      end
-
-      def el8?
-        os_facts['os']['release']['major'] == '8' && el?
-      end
-
-      def el_major_version
-        return os_facts['os']['release']['major'] if el?
-      end
-
       def ruby_prefix(scl = true)
-        if el7? && scl
+        if debian?
+          'ruby-'
+        elsif el7? && scl
           'tfm-rubygem-'
-        elsif el7? || el8?
+        else
           'rubygem-'
-        elsif debian?
-          'ruby-'
         end
       end
 
       def foreman_plugin_name(plugin)
-        if debian?
-          plugin.tr!('_', '-')
-        end
+        plugin = plugin.tr('_', '-') if debian?
         ruby_prefix + plugin
       end
 
       def proxy_plugin_name(plugin)
         if debian?
-          plugin.tr!('_', '-')
+          plugin = plugin.tr('_', '-')
           proxy_plugin_prefix = 'smart-proxy-'
         else
           proxy_plugin_prefix = 'smart_proxy_'
@@ -237,6 +211,11 @@ module ForemanMaintain
         ruby_prefix(scl) + proxy_plugin_prefix + plugin
       end
 
+      def hammer_plugin_name(plugin)
+        plugin = plugin.tr('_', '-') if debian?
+        [hammer_package, plugin].join(debian? ? '-' : '_')
+      end
+
       def hammer_package
         hammer_prefix = if debian?
                           'hammer-cli'

data/lib/foreman_maintain/utils/backup.rb

@@ -267,21 +267,46 @@ module ForemanMaintain
 
       def validate_hostname?
         # make sure that the system hostname is the same as the backup
-        config_tarball = file_map[:config_files][:path]
-        tar_cmd = "tar zxf #{config_tarball} etc/httpd/conf/httpd.conf --to-stdout --occurrence=1"
-        status, httpd_config = execute_with_status(tar_cmd)
-
-        # Incremental backups sometimes don't include httpd.conf. Since a "base" backup
-        # is restored before an incremental, we can assume that the hostname is checked
-        # during the base backup restore
-        if status == 0
-          match = httpd_config.match(/\s*ServerName\s+"*([^ "]+)"*\s*$/)
-          match ? match[1] == hostname : false
+        hostname_from_metadata = metadata.fetch('hostname', nil)
+        if hostname_from_metadata
+          hostname_from_metadata == hostname
         else
-          true
+          config_tarball = file_map[:config_files][:path]
+          tar_cmd = "tar zxf #{config_tarball} etc/httpd/conf/httpd.conf --to-stdout --occurrence=1"
+          status, httpd_config = execute_with_status(tar_cmd)
+
+          # Incremental backups sometimes don't include httpd.conf. Since a "base" backup
+          # is restored before an incremental, we can assume that the hostname is checked
+          # during the base backup restore
+          if status == 0
+            match = httpd_config.match(/\s*ServerName\s+"*([^ "]+)"*\s*$/)
+            match ? match[1] == hostname : false
+          else
+            true
+          end
         end
       end
 
+      def validate_interfaces
+        # I wanted to do `Socket.getifaddrs.map(&:name).uniq`,
+        # but this has to work with Ruby 2.0, and Socket.getifaddrs is 2.1+
+        errors = {}
+        system_interfaces = Dir.entries('/sys/class/net') - ['.', '..']
+
+        proxy_config = metadata.fetch('proxy_config', {})
+
+        %w[dns dhcp].each do |feature|
+          next unless proxy_config.fetch(feature, false)
+
+          wanted_interface = proxy_config.fetch("#{feature}_interface", 'lo')
+          unless system_interfaces.include?(wanted_interface)
+            errors[feature] = { 'configured' => wanted_interface, 'available' => system_interfaces }
+          end
+        end
+
+        return errors
+      end
+
       def metadata
         if file_map[:metadata][:present]
           YAML.load_file(file_map[:metadata][:path])

data/lib/foreman_maintain/utils/command_runner.rb

@@ -66,7 +66,8 @@ module ForemanMaintain
         log_file = Tempfile.open('captured-output')
         exit_file = Tempfile.open('captured-exit-code')
         Kernel.system(
-          "bash -c '#{full_command}; echo $? > #{exit_file.path}' | tee -i #{log_file.path}"
+          "stdbuf -oL -eL bash -c '#{full_command}; echo $? > #{exit_file.path}'"\
+          "| tee -i #{log_file.path}"
         )
         File.open(log_file.path) { |f| @output = f.read }
         File.open(exit_file.path) do |f|

data/lib/foreman_maintain/utils.rb

@@ -7,4 +7,3 @@ require 'foreman_maintain/utils/curl_response'
 require 'foreman_maintain/utils/mongo_core'
 require 'foreman_maintain/utils/service'
 require 'foreman_maintain/utils/system_helpers'
-require 'foreman_maintain/utils/facter'

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.8.20'.freeze
+  VERSION = '0.9.3'.freeze
 end

data/lib/foreman_maintain.rb

@@ -15,6 +15,7 @@ module ForemanMaintain
   require 'foreman_maintain/concerns/finders'
   require 'foreman_maintain/concerns/metadata'
   require 'foreman_maintain/concerns/scenario_metadata'
+  require 'foreman_maintain/concerns/os_facts'
   require 'foreman_maintain/concerns/system_helpers'
   require 'foreman_maintain/concerns/system_service'
   require 'foreman_maintain/concerns/hammer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.8.20
+  version: 0.9.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -84,16 +84,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: 11.0.0
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 11.0.0
+        version: 0.50.0
 description: Provides various features that helps keeping the Foreman/Satellite up
   and running.
 email: inecas@redhat.com
@@ -135,6 +149,7 @@ files:
 - definitions/checks/foreman/check_duplicate_permission.rb
 - definitions/checks/foreman/check_duplicate_roles.rb
 - definitions/checks/foreman/check_https_proxies.rb
+- definitions/checks/foreman/check_puppet_capsules.rb
 - definitions/checks/foreman/db_up.rb
 - definitions/checks/foreman/facts_names.rb
 - definitions/checks/foreman/puppet_class_duplicates.rb
@@ -163,6 +178,7 @@ files:
 - definitions/checks/repositories/validate.rb
 - definitions/checks/restore/validate_backup.rb
 - definitions/checks/restore/validate_hostname.rb
+- definitions/checks/restore/validate_interfaces.rb
 - definitions/checks/root_user.rb
 - definitions/checks/server_ping.rb
 - definitions/checks/services_up.rb
@@ -271,9 +287,13 @@ files:
 - definitions/procedures/pulp/remove.rb
 - definitions/procedures/pulpcore/migrate.rb
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
+- definitions/procedures/puppet/remove_puppet.rb
+- definitions/procedures/puppet/remove_puppet_data.rb
 - definitions/procedures/refresh_features.rb
 - definitions/procedures/remote_execution/remove_existing_settingsd.rb
+- definitions/procedures/repositories/backup_enabled_repos.rb
 - definitions/procedures/repositories/disable.rb
+- definitions/procedures/repositories/enable.rb
 - definitions/procedures/repositories/setup.rb
 - definitions/procedures/restore/candlepin_dump.rb
 - definitions/procedures/restore/configs.rb
@@ -305,7 +325,9 @@ files:
 - definitions/scenarios/maintenance_mode.rb
 - definitions/scenarios/packages.rb
 - definitions/scenarios/prep_6_10_upgrade.rb
+- definitions/scenarios/puppet.rb
 - definitions/scenarios/restore.rb
+- definitions/scenarios/self_upgrade.rb
 - definitions/scenarios/services.rb
 - definitions/scenarios/upgrade_to_capsule_6_10.rb
 - definitions/scenarios/upgrade_to_capsule_6_10_z.rb
@@ -352,7 +374,9 @@ files:
 - lib/foreman_maintain/cli/health_command.rb
 - lib/foreman_maintain/cli/maintenance_mode_command.rb
 - lib/foreman_maintain/cli/packages_command.rb
+- lib/foreman_maintain/cli/plugin_command.rb
 - lib/foreman_maintain/cli/restore_command.rb
+- lib/foreman_maintain/cli/self_upgrade_command.rb
 - lib/foreman_maintain/cli/service_command.rb
 - lib/foreman_maintain/cli/transform_clamp_options.rb
 - lib/foreman_maintain/cli/upgrade_command.rb
@@ -363,6 +387,7 @@ files:
 - lib/foreman_maintain/concerns/hammer.rb
 - lib/foreman_maintain/concerns/logger.rb
 - lib/foreman_maintain/concerns/metadata.rb
+- lib/foreman_maintain/concerns/os_facts.rb
 - lib/foreman_maintain/concerns/primary_checks.rb
 - lib/foreman_maintain/concerns/pulp_common.rb
 - lib/foreman_maintain/concerns/reporter.rb
@@ -402,7 +427,6 @@ files:
 - lib/foreman_maintain/utils/disk/io_device.rb
 - lib/foreman_maintain/utils/disk/nil_device.rb
 - lib/foreman_maintain/utils/disk/stats.rb
-- lib/foreman_maintain/utils/facter.rb
 - lib/foreman_maintain/utils/hash_tools.rb
 - lib/foreman_maintain/utils/mongo_core.rb
 - lib/foreman_maintain/utils/response.rb

data/lib/foreman_maintain/utils/facter.rb

@@ -1,17 +0,0 @@
-module ForemanMaintain::Utils
-  module Facter
-    include ForemanMaintain::Concerns::SystemHelpers
-
-    FACTER_FILES = %w[/usr/bin/facter /opt/puppetlabs/bin/facter].freeze
-
-    def self.package
-      puppet_version = version(execute!('/opt/puppetlabs/bin/puppet --version'))
-
-      puppet_version.major >= 4 ? 'puppet-agent' : 'facter'
-    end
-
-    def self.path
-      FACTER_FILES.find { |path| File.exist?(path) }
-    end
-  end
-end