foreman_maintain 0.8.21 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a580f07f36c4c9ab021f465d02b0430ac81a444765f2793a7940d18182ce25
-  data.tar.gz: ef70e629eec6f635d2515b9eea748567c2d3e559fc762a3005a0ab9a85d7e61b
+  metadata.gz: e995fb504729078ae910121820a8f286d1256b4319d07d25f27a17768ba515af
+  data.tar.gz: 8fb3b6231928b49a6c6cd8375a14394b31839452ead4c0a7e3dbc198f405912d
 SHA512:
-  metadata.gz: '0797ffb2141b60a5811f62dcdddb2d600221c22df75868674a4628838a445836058b003d67296bc91a2bc4593f06dbe4bcd1223417263fb9335d4bb141dc8c14'
-  data.tar.gz: a40dd53e0d8633bd01301e2b85b2d38cf62d8ca0ab502c9c3747939d5a7b38f3fc90fc6b8f861ec956846660ab6ac0a22e2c257e3c07c3963fec945ee03cadde
+  metadata.gz: 12ff59c3185962df60825149e3f34892c6bc42071fb39b35aa701b891dd34eb71843784c161e64d0218e669e66a2f85715991f76a319f48f6fb4dbeba55ddf2f
+  data.tar.gz: 747024ed62640c6c49406f573557253e6ea96037921633ca94489c20f34f32a1a233c4f6a9bb67bdac45aa9dd8af9bb727733f7531c8d0c5303f56ce59a8ce60

data/definitions/checks/check_for_newer_packages.rb

@@ -33,11 +33,9 @@ class Checks::CheckForNewerPackages < ForemanMaintain::Check
     end
 
     unless packages_with_updates.empty?
-      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"
+      failure_message = 'An update is available for package(s): '\
+                        "#{packages_with_updates.join(',')}. Please update before proceeding!"
+      fail! failure_message
     end
   end
 

data/definitions/checks/disk/performance.rb

@@ -39,8 +39,8 @@ module Checks
         end
       end
 
-      def data_dirs
-        @data_dirs ||= %i[pulpcore_database mongo foreman_database].inject({}) do |dirs, f|
+      def default_dirs
+        @default_dirs ||= %i[pulp2 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,32 +48,20 @@ 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 '\
-        "#{[data_dirs.keys | pulp_dir.keys].join(', ')} directories."
-      end
-
-      def all_dirs
-        data_dirs.values | pulp_dir.values
+        "Check recommended disk speed for #{default_dirs.keys.join(', ')} directories."
       end
 
       def check_only_single_device?
-        all_dirs.each do |dir|
+        default_dirs.values do |dir|
           ForemanMaintain::Utils::Disk::Device.new(dir).name
         end.uniq.length <= 1
       end
 
       def dirs_to_check
-        return all_dirs.first(1) if check_only_single_device?
+        return default_dirs.values.first(1) if check_only_single_device?
 
-        all_dirs
+        default_dirs.values
       end
 
       private
@@ -86,10 +74,11 @@ 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/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/foreman_tasks.rb

@@ -17,17 +17,6 @@ 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/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 '
-      execute!("#{env_vars}foreman-rake katello:pulp3_migration", :interactive => true)
+      puts execute!("#{env_vars}foreman-rake katello:pulp3_migration", :interactive => true)
     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/restore.rb

@@ -18,6 +18,7 @@ module ForemanMaintain::Scenarios
       add_steps_with_context(Checks::Restore::ValidateBackup,
                              Procedures::Restore::Confirmation,
                              Checks::Restore::ValidateHostname,
+                             Checks::Restore::ValidateInterfaces,
                              Procedures::Selinux::SetFileSecurity,
                              Procedures::Restore::Configs)
       add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
@@ -87,6 +88,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/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,38 +185,13 @@ 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
 

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.children('/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,8 +66,7 @@ module ForemanMaintain
         log_file = Tempfile.open('captured-output')
         exit_file = Tempfile.open('captured-exit-code')
         Kernel.system(
-          "stdbuf -oL -eL bash -c '#{full_command}; echo $? > #{exit_file.path}'"\
-          "| tee -i #{log_file.path}"
+          "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.21'.freeze
+  VERSION = '0.9.1'.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.21
+  version: 0.9.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-10-20 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
@@ -163,6 +177,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
@@ -359,11 +374,11 @@ files:
 - lib/foreman_maintain/concerns/base_database.rb
 - lib/foreman_maintain/concerns/directory_marker.rb
 - lib/foreman_maintain/concerns/downstream.rb
-- lib/foreman_maintain/concerns/el_repos_manager_common.rb
 - lib/foreman_maintain/concerns/finders.rb
 - 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
@@ -387,9 +402,6 @@ files:
 - lib/foreman_maintain/procedure.rb
 - lib/foreman_maintain/reporter.rb
 - lib/foreman_maintain/reporter/cli_reporter.rb
-- lib/foreman_maintain/repos_manager/dnf_config_manager.rb
-- lib/foreman_maintain/repos_manager/el_common.rb
-- lib/foreman_maintain/repos_manager/yum_config_manager.rb
 - lib/foreman_maintain/runner.rb
 - lib/foreman_maintain/runner/execution.rb
 - lib/foreman_maintain/runner/stored_execution.rb
@@ -406,7 +418,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/concerns/el_repos_manager_common.rb

@@ -1,20 +0,0 @@
-module ForemanMaintain
-  module Concerns
-    module ElReposManagerCommon
-    include ForemanMaintain::Concerns::OsFacts
-
-    	def package_manager
-    		return 'dnf' if el8?
-
-    		'yum'
-    	end
-
-     	def enabled_repos_hash
-        repos = execute("#{package_manager} repolist enabled -d 6 -e 0 2> /dev/null | grep -E 'Repo-id|Repo-baseurl'")
-    	  return {} if repos.empty?
-
-    	  Hash[*repos.delete!(' ').split("\n")]
-  	  end
-    end
-  end
-end

data/lib/foreman_maintain/repos_manager/dnf_config_manager.rb

@@ -1,13 +0,0 @@
-module ForemanMaintain::ReposManager
-	class DnfConfigManager
-		include ForemanMaintain::Concerns::ElReposManagerCommon
-
-    def disable_repos(repo_ids)
-      execute!("dnf config-manager --set-disabled #{repo_ids.join(',')}")
-    end
-    
-    def enable_repos(repo_ids)
-      execute!("dnf config-manager --set-enabled #{repo_ids.join(',')}")
-    end
-	end
-end

data/lib/foreman_maintain/repos_manager/yum_config_manager.rb

@@ -1,20 +0,0 @@
-module ForemanMaintain::ReposManager
-	class YumConfigManager
-		include ForemanMaintain::Concerns::ElReposManagerCommon
-		
-		def disable_repos(repo_ids)
-      execute!("yum-config-manager --disable #{repo_ids.join(',')}")
-    end
-
-    def enable_repos(repo_ids)
-      execute!("yum-config-manager --enable #{repo_ids.join(',')}")
-    end
-
-    def enabled_repos_hash
-    	repos = execute("yum repolist enabled -d 6 -e 0 2> /dev/null | grep -E 'Repo-id|Repo-baseurl'")
-    	return {} if repos.empty?
-
-    	Hash[*repos.delete!(' ').split("\n")]
-  	end
-	end
-end

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