foreman_maintain 0.8.20 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72beb43529d9eb83adadc1f644b7e67cf8276d19527af380a94405affc16894b
-  data.tar.gz: 6a08f0bb85ad408f9dac5e904e7c6f5af30eba339e919e44d8740332fb8d33d3
+  metadata.gz: e995fb504729078ae910121820a8f286d1256b4319d07d25f27a17768ba515af
+  data.tar.gz: 8fb3b6231928b49a6c6cd8375a14394b31839452ead4c0a7e3dbc198f405912d
 SHA512:
-  metadata.gz: 480de2bbfe003b974b86d8f5baebdd624f3ebf407260f914b368c615fbc8481eb2b6c8d7592bd25f30f1055d892d7170385cbbdd06e84ec7100cd554fae993c8
-  data.tar.gz: 752ed2fb124297336e477357786adb1f8b157fe319bb13872d6cf684a5fbd9908d4e66c482bedf23cd5ef84ff75f573030e377a0e92a65e8f555fa793b85846a
+  metadata.gz: 12ff59c3185962df60825149e3f34892c6bc42071fb39b35aa701b891dd34eb71843784c161e64d0218e669e66a2f85715991f76a319f48f6fb4dbeba55ddf2f
+  data.tar.gz: 747024ed62640c6c49406f573557253e6ea96037921633ca94489c20f34f32a1a233c4f6a9bb67bdac45aa9dd8af9bb727733f7531c8d0c5303f56ce59a8ce60

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/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/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.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.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.20
+  version: 0.9.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 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
@@ -363,6 +378,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 +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/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