foreman_maintain 0.8.17 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f613ab2a7afc435fa01364dac9c15825723b336336676056d7f796b57a21e841
-  data.tar.gz: fd709a9384cb55f2ccf9a9a7e3be34bf239b24748f8fff49fd2921c08df4c228
+  metadata.gz: e995fb504729078ae910121820a8f286d1256b4319d07d25f27a17768ba515af
+  data.tar.gz: 8fb3b6231928b49a6c6cd8375a14394b31839452ead4c0a7e3dbc198f405912d
 SHA512:
-  metadata.gz: 55958174a3e670b8ccfefeb09695a8fc84a323901c490f2dc0df88669c2f4d7e870f48a3d5c45f42f668f26fec8fe74d6478b29fcdb2a31f4bbd6b85137f8a41
-  data.tar.gz: 167635eec986782698efdaff762167d18e5a5f63d5f371ebe9600457ced03a6db849465d36c1c9e4fea377dcb47adfec1989e2ed67aaf71dba01d4dcce3a72b3
+  metadata.gz: 12ff59c3185962df60825149e3f34892c6bc42071fb39b35aa701b891dd34eb71843784c161e64d0218e669e66a2f85715991f76a319f48f6fb4dbeba55ddf2f
+  data.tar.gz: 747024ed62640c6c49406f573557253e6ea96037921633ca94489c20f34f32a1a233c4f6a9bb67bdac45aa9dd8af9bb727733f7531c8d0c5303f56ce59a8ce60

data/definitions/checks/check_for_newer_packages.rb

@@ -9,13 +9,11 @@ class Checks::CheckForNewerPackages < ForemanMaintain::Check
     param :manual_confirmation_version,
           'Version of satellite (6.9) to ask the user if they are on the latest minor release of.',
           :required => false
+    manual_detection
   end
 
   def run
-    exit_status, = ForemanMaintain.package_manager.check_update(packages: @packages,
-                                                                with_status: true)
-    assert(exit_status == 0, 'An update is available for one of these packages: '\
-                "#{@packages.join(',')}. Please update before proceeding.")
+    check_for_package_update
     if @manual_confirmation_version
       question = 'Confirm that you are running the latest minor release of Satellite '\
                 "#{@manual_confirmation_version}"
@@ -23,4 +21,45 @@ class Checks::CheckForNewerPackages < ForemanMaintain::Check
       abort! if answer != :yes
     end
   end
+
+  def check_for_package_update
+    exit_status, output = ForemanMaintain.package_manager.check_update(packages: @packages,
+                                                                       with_status: true)
+    packages_with_updates = []
+    if exit_status == 100
+      packages_with_updates = compare_pkg_versions(output).select do |_, result|
+        result == -1
+      end.keys
+    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
+    end
+  end
+
+  def packages_and_versions(output)
+    pkgs_versions = {}
+    pkg_details = output.split("\n\n")[1].split
+    @packages.each do |pkg|
+      pkg_details.each_with_index do |ele, index|
+        next unless ele.start_with?(pkg)
+        pkgs_versions[pkg] = version(pkg_details[index + 1].split('-').first)
+        break
+      end
+    end
+    pkgs_versions
+  end
+
+  def compare_pkg_versions(output)
+    compare_pkg_versions = {}
+    packages_and_versions = packages_and_versions(output)
+    pkg_versions610 = { 'python3-pulp-2to3-migration' => version('0.12'),
+                        'tfm-rubygem-katello' => version('4.1') }
+    packages_and_versions.each do |name, version|
+      compare_pkg_versions[name] = version.<=>(pkg_versions610[name])
+    end
+    compare_pkg_versions
+  end
 end

data/definitions/checks/foreman/check_https_proxies.rb

@@ -0,0 +1,34 @@
+module Checks
+  class CheckHttpsProxies < ForemanMaintain::Check
+    metadata do
+      label :https_proxies
+      for_feature :foreman_database
+      description 'Check for HTTPS proxies from the database'
+      manual_detection
+    end
+
+    def run
+      https_proxies = find_https_proxies
+      unless https_proxies.empty?
+        https_proxy_names = https_proxies.map { |proxy| proxy['name'] }
+        question = "Syncing repositories through an 'HTTP Proxy' that uses the HTTPS\n"\
+                    "protocol is not supported directly with Satellite 6.10.\n"\
+                    "The following proxies use HTTPS: #{https_proxy_names.join(', ')}.\n"\
+                    "For a suggested solution see https://access.redhat.com/solutions/6414991\n"\
+                    'Continue upgrade?'
+        answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
+        abort! if answer != :yes
+      end
+    end
+
+    def find_https_proxies
+      feature(:foreman_database).query(self.class.query_to_get_https_proxies)
+    end
+
+    def self.query_to_get_https_proxies
+      <<-SQL
+        SELECT \"http_proxies\".* FROM \"http_proxies\" WHERE (http_proxies.url ilike 'https://%')
+      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/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/pulp/remove.rb

@@ -21,7 +21,8 @@ module Procedures::Pulp
         '/var/lib/pulp/content',
         '/var/lib/pulp/importers',
         '/var/lib/pulp/uploads',
-        '/var/lib/mongodb/'
+        '/var/lib/mongodb/',
+        '/var/cache/pulp'
       ]
     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/definitions/scenarios/upgrade_to_satellite_6_10.rb

@@ -29,6 +29,7 @@ module Scenarios::Satellite_6_10
       add_step(Checks::CheckForNewerPackages.new(:packages => [foreman_plugin_name('katello'),
                                                                'python3-pulp-2to3-migration'],
                                                  :manual_confirmation_version => '6.9'))
+      add_step(Checks::CheckHttpsProxies)
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
 

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)
@@ -147,7 +148,7 @@ module ForemanMaintain
       end
 
       def format_shell_args(options = {})
-        options.map { |shell_optn, val| " #{shell_optn} '#{shellescape(val)}'" }.join
+        options.map { |shell_optn, val| " #{shell_optn} #{shellescape(val)}" }.join
       end
 
       def find_symlinks(dir_path)
@@ -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

@@ -77,11 +77,15 @@ module ForemanMaintain
       end
 
       def valid_fpc_backup?
-        fpc_online_backup? || fpc_standard_backup? || fpc_logical_backup?
+        fpc_online_backup? || fpc_standard_backup? || fpc_logical_backup? || \
+          # fpc can have setup where mongo or pulpcore db is external but not both
+          fpc_hybrid_db_backup?
       end
 
       def valid_katello_backup?
-        katello_online_backup? || katello_standard_backup? || katello_logical_backup?
+        katello_online_backup? || katello_standard_backup? || katello_logical_backup? || \
+          # Katello can have setup where some of dbs are external but not all
+          katello_hybrid_db_backup?
       end
 
       def valid_foreman_backup?
@@ -104,7 +108,6 @@ module ForemanMaintain
         true
       end
 
-      # TODO: Need to check for pulpcore feature?
       def katello_standard_backup?
         present = [:pgsql_data]
         absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump, :mongo_dump]
@@ -155,6 +158,14 @@ module ForemanMaintain
                              :absent => absent)
       end
 
+      def katello_hybrid_db_backup?
+        all_dbs = { :pgsql_data => %w[candlepin foreman], :mongo_data => [] }
+        all_dbs[:pgsql_data] << 'pulpcore' if feature(:pulpcore_database)
+        all_dbs[:mongo_data] << 'mongo' if feature(:mongo)
+        present, absent = dumps_for_hybrid_db_setup(all_dbs)
+        check_file_existence(:present => present, :absent => absent)
+      end
+
       def fpc_standard_backup?
         present = []
         absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump, :mongo_dump]
@@ -207,6 +218,15 @@ module ForemanMaintain
         check_file_existence(:present => present, :absent => absent)
       end
 
+      def fpc_hybrid_db_backup?
+        all_dbs = { :pgsql_data => [], :mongo_data => [] }
+        all_dbs[:pgsql_data] << 'pulpcore' if feature(:pulpcore_database)
+        all_dbs[:mongo_data] << 'mongo' if feature(:mongo)
+        present, absent = dumps_for_hybrid_db_setup(all_dbs)
+        absent.concat [:candlepin_dump, :foreman_dump]
+        check_file_existence(:present => present, :absent => absent)
+      end
+
       def foreman_standard_backup?
         check_file_existence(:present => [:pgsql_data],
                              :absent => [:candlepin_dump, :foreman_dump, :pulpcore_dump,
@@ -224,21 +244,67 @@ module ForemanMaintain
                              :absent => [:candlepin_dump, :mongo_data, :mongo_dump, :pulpcore_dump])
       end
 
+      # rubocop:disable Metrics/MethodLength
+      def dumps_for_hybrid_db_setup(dbs_hash)
+        present = []
+        absent = []
+        dbs_hash.each do |data_file, dbs|
+          dbs.each do |db|
+            feature_label = db == 'mongo' ? db : "#{db}_database"
+            dump_file = "#{db}_dump"
+            if feature(feature_label.to_sym).local?
+              present |= [data_file]
+              absent << dump_file.to_sym
+            else
+              present << dump_file.to_sym
+            end
+          end
+          absent |= [data_file] unless present.include?(data_file)
+        end
+        [present, absent]
+      end
+      # rubocop:enable Metrics/MethodLength
+
       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

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.17'.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.17
+  version: 0.9.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-22 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
@@ -134,6 +148,7 @@ files:
 - definitions/checks/foreman/check_corrupted_roles.rb
 - definitions/checks/foreman/check_duplicate_permission.rb
 - definitions/checks/foreman/check_duplicate_roles.rb
+- definitions/checks/foreman/check_https_proxies.rb
 - definitions/checks/foreman/db_up.rb
 - definitions/checks/foreman/facts_names.rb
 - definitions/checks/foreman/puppet_class_duplicates.rb
@@ -162,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
@@ -362,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
@@ -401,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