foreman_maintain 1.8.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e99ddc1408ae68f584bbfc6e8798367e623e38f981682666f40cac91bb8f5f4
-  data.tar.gz: 173ee0cd4fbce206437d53937eaf0489111e4c6b57eac8b04943c9468eb5ab40
+  metadata.gz: a042b3f0cd480eab2e674abcbd5aecb247943b481bad114e31376610a3b785d0
+  data.tar.gz: 16e74a0e82caffb11d5d0363046bfa5120afab203ce1d88ad88a4311f664e1f4
 SHA512:
-  metadata.gz: 60a28996480d8564f5900a56d3f1494f9eb756d0a54c1bf3fee4c37fb5096a848db3a4ed2a6700e65d2fd4193bda13bebb4a50368ca0dbfd2ca1dccf9ea76d8e
-  data.tar.gz: c323322a2e40d116c34de3ed7430742caa127250024957aa4b2579b14bbc27fb271312a6d973d82533ef091ca77ead05de0cf61c005475da8e3766e910e35562
+  metadata.gz: 7bcc01a88e2f8bebb549a83af6d0b1f33a714a76925dc51ee48a2a979611e7d8fc47ed91b162ce97bd004360f9bb8cef7499c34160283e539e63e8b7f4b8315f
+  data.tar.gz: 4e056e25de905cb6bb98da55c10dc1c1a57b99de6ed39b13241c4d09d7e2ca8cbaacaf6a44153ccd0f9675f432cda32ed9cb617399c3258940b0569898b12448

data/README.md

@@ -20,7 +20,6 @@ Subcommands:
       check --target-version TARGET_VERSION   Run pre-upgrade checks for upgrading to specified version
             --disable-self-upgrade            Disable automatic self upgrade (default: false)
       run --target-version TARGET_VERSION     Run the full upgrade
-          [--phase=phase TARGET_VERSION]      Run just a specific phase of the upgrade
           --disable-self-upgrade              Disable automatic self upgrade (default: false)
 
     advanced                      Advanced tools for server maintenance

data/definitions/checks/restore/validate_backup.rb

@@ -42,35 +42,30 @@ module Checks::Restore
     def required_katello_files(backup)
       backup_files_message(
         backup.katello_online_files.join(', '),
-        backup.katello_offline_files.join(', '),
-        [backup.katello_online_files + backup.katello_offline_files].join(', ')
+        backup.katello_offline_files.join(', ')
       )
     end
 
     def required_fpc_files(backup)
       backup_files_message(
         backup.fpc_online_files.join(', '),
-        backup.fpc_offline_files.join(', '),
-        [backup.fpc_online_files + backup.fpc_offline_files].join(', ')
+        backup.fpc_offline_files.join(', ')
       )
     end
 
     def required_foreman_files(backup)
       backup_files_message(
         backup.foreman_online_files.join(', '),
-        backup.foreman_offline_files.join(', '),
-        [backup.foreman_online_files + backup.foreman_offline_files].join(', ')
+        backup.foreman_offline_files.join(', ')
       )
     end
 
-    def backup_files_message(online_files, offline_files, logical_files)
+    def backup_files_message(online_files, offline_files)
       message = ''
       message += 'An online or remote database backup directory contains: '
       message += "#{online_files}\n"
       message += 'An offline backup directory contains: '
       message += "#{offline_files}\n"
-      message += 'A logical backup directory contains: '
-      message += "#{logical_files}\n"
       message
     end
   end

data/definitions/features/candlepin_database.rb

@@ -28,15 +28,6 @@ class Features::CandlepinDatabase < ForemanMaintain::Feature
     execute?(help_cmd)
   end
 
-  def env_content_ids_with_null_content
-    sql = <<-SQL
-      SELECT ec.id
-      FROM cp_env_content ec
-      LEFT JOIN cp_content c ON ec.contentid = c.id WHERE c.id IS NULL
-    SQL
-    query(sql).map { |r| r['id'] }
-  end
-
   private
 
   def load_configuration

data/definitions/features/foreman_proxy.rb

@@ -70,6 +70,7 @@ class Features::ForemanProxy < ForemanMaintain::Feature
       configs += ['/var/lib/dhcpd', File.dirname(dhcpd_config_file)]
     end
     configs.push('/usr/share/xml/scap') if backup_features.include?('openscap')
+    configs.push('/etc/ansible') if backup_features.include?('ansible')
     configs
   end
 

data/definitions/features/pulpcore_database.rb

@@ -26,18 +26,21 @@ class Features::PulpcoreDatabase < ForemanMaintain::Feature
 
   private
 
-  # rubocop:disable Metrics/AbcSize
   def load_configuration
-    full_config = File.read(PULPCORE_DB_CONFIG).split(/[\s,'":]/).reject(&:empty?)
+    python_command = <<~PYTHON.strip
+      from django.conf import settings; import json; print(json.dumps(settings.DATABASES["default"]))
+    PYTHON
+    manager_command = pulpcore_manager("shell --command '#{python_command}'")
+    manager_result = execute!(manager_command)
+    db_config = JSON.parse(manager_result)
 
     @configuration = {}
     @configuration['adapter'] = 'postgresql'
-    @configuration['host'] = full_config[full_config.index('HOST') + 1]
-    @configuration['port'] = full_config[full_config.index('PORT') + 1]
-    @configuration['database'] = full_config[full_config.index('NAME') + 1]
-    @configuration['username'] = full_config[full_config.index('USER') + 1]
-    @configuration['password'] = full_config[full_config.index('PASSWORD') + 1]
+    @configuration['host'] = db_config['HOST']
+    @configuration['port'] = db_config['PORT']
+    @configuration['database'] = db_config['NAME']
+    @configuration['username'] = db_config['USER']
+    @configuration['password'] = db_config['PASSWORD']
     @configuration
   end
-  # rubocop:enable Metrics/AbcSize
 end

data/definitions/features/puppet_server.rb

@@ -26,10 +26,6 @@ class Features::PuppetServer < ForemanMaintain::Feature
     find_package('puppetserver') ? [system_service('puppetserver', 30)] : []
   end
 
-  def puppet_version
-    version(execute!("#{puppet_path} --version"))
-  end
-
   def find_empty_cacert_request_files
     cmd_output = execute!("find #{cacert_requests_directory} -type f -size 0 | paste -d, -s")
     cmd_output.split(',')

data/definitions/procedures/pulpcore/container_handle_image_metadata.rb

@@ -14,8 +14,7 @@ module Procedures::Pulpcore
 
         feature(:service).handle_services(spinner, 'start', :only => necessary_services)
 
-        spinner.update('Adding image metadata to pulp. You can continue using the ' \
-               'system normally while the task runs in the background.')
+        spinner.update('Adding image metadata to pulp.')
         execute!(pulpcore_manager('container-handle-image-data'))
       end
     end

data/definitions/procedures/repositories/index_katello_repositories_container_metadata.rb

@@ -8,8 +8,7 @@ module Procedures::Repositories
     end
 
     def run
-      with_spinner(('Adding image metadata. You can continue using the ' \
-                    'system normally while the task runs in the background.')) do
+      with_spinner('Adding image metadata to Katello.') do
         execute!('foreman-rake katello:import_container_manifest_labels')
       end
     end

data/lib/foreman_maintain/concerns/base_database.rb

@@ -16,11 +16,12 @@ module ForemanMaintain
       end
 
       def deb_postgresql_versions
-        installed_pkgs = package_manager.list_installed_packages('${binary:Package}\n')
-        @deb_postgresql_versions ||= installed_pkgs.grep(/^postgresql-\d+$/).map do |name|
-          name.split('-').last
+        @deb_postgresql_versions ||= begin
+          installed_pkgs = package_manager.list_installed_packages('${binary:Package}\n')
+          installed_pkgs.grep(/^postgresql-\d+$/).map do |name|
+            name.split('-').last
+          end
         end
-        @deb_postgresql_versions
       end
 
       def postgresql_conf
@@ -41,49 +42,47 @@ module ForemanMaintain
         raise NotImplementedError
       end
 
-      def local?(config = configuration)
-        ['localhost', '127.0.0.1', `hostname`.strip].include?(config['host'])
+      def local?
+        ['localhost', '127.0.0.1', `hostname`.strip].include?(configuration['host'])
       end
 
-      def query(sql, config = configuration)
-        parse_csv(query_csv(sql, config))
+      def query(sql)
+        parse_csv(query_csv(sql))
       end
 
-      def query_csv(sql, config = configuration)
-        psql(%{COPY (#{sql}) TO STDOUT WITH CSV HEADER}, config)
+      def query_csv(sql)
+        psql(%{COPY (#{sql}) TO STDOUT WITH CSV HEADER})
       end
 
-      def psql(query, config = configuration)
-        if ping(config)
-          execute(psql_command(config),
-            :stdin => query,
-            :hidden_patterns => [config['password']])
-        else
-          raise_service_error
-        end
+      def psql(query)
+        ping!
+
+        execute('psql',
+          :stdin => query,
+          :env => base_env)
       end
 
-      def ping(config = configuration)
-        execute?(psql_command(config),
+      def ping
+        execute?('psql',
           :stdin => 'SELECT 1 as ping',
-          :hidden_patterns => [config['password']])
+          :env => base_env)
       end
 
-      def dump_db(file, config = configuration)
-        execute!(dump_command(config) + " > #{file}", :hidden_patterns => [config['password']])
+      def dump_db(file)
+        dump_command = "pg_dump -Fc -f #{file}"
+        execute!(dump_command, :env => base_env)
       end
 
-      def restore_dump(file, localdb, config = configuration)
+      def restore_dump(file, localdb)
         if localdb
           dump_cmd = "runuser - postgres -c 'pg_restore -C -d postgres #{file}'"
           execute!(dump_cmd)
         else
           # TODO: figure out how to completely ignore errors. Currently this
           # sometimes exits with 1 even though errors are ignored by pg_restore
-          dump_cmd = base_command(config, 'pg_restore') +
-                     ' --no-privileges --clean --disable-triggers -n public ' \
-                     "-d #{config['database']} #{file}"
-          execute!(dump_cmd, :hidden_patterns => [config['password']],
+          dump_cmd = 'pg_restore --no-privileges --clean --disable-triggers -n public ' \
+                     "-d #{configuration['database']} #{file}"
+          execute!(dump_cmd, :env => base_env,
             :valid_exit_statuses => [0, 1])
         end
       end
@@ -109,11 +108,11 @@ module ForemanMaintain
         @backup_dir ||= File.expand_path(ForemanMaintain.config.db_backup_dir)
       end
 
-      def dropdb(config = configuration)
+      def dropdb
         if local?
-          execute!("runuser - postgres -c 'dropdb #{config['database']}'")
+          execute!("runuser - postgres -c 'dropdb #{configuration['database']}'")
         else
-          delete_statement = psql(<<-SQL)
+          delete_statement = psql(<<~SQL)
             select string_agg('drop table if exists \"' || tablename || '\" cascade;', '')
             from pg_tables
             where schemaname = 'public';
@@ -122,15 +121,13 @@ module ForemanMaintain
         end
       end
 
-      def db_version(config = configuration)
-        if ping(config)
-          # Note - t removes headers, -A removes alignment whitespace
-          server_version_cmd = psql_command(config) + ' -c "SHOW server_version" -t -A'
-          version_string = execute!(server_version_cmd, :hidden_patterns => [config['password']])
-          version(version_string)
-        else
-          raise_service_error
-        end
+      def db_version
+        ping!
+
+        query = 'SHOW server_version'
+        server_version_cmd = 'psql --tuples-only --no-align'
+        version_string = execute!(server_version_cmd, :stdin => query, :env => base_env)
+        version(version_string)
       end
 
       def psql_cmd_available?
@@ -145,22 +142,20 @@ module ForemanMaintain
 
       private
 
-      def base_command(config, command = 'psql')
-        "PGPASSWORD='#{config[%(password)]}' "\
-        "#{command} -h #{config['host'] || 'localhost'} "\
-        " -p #{config['port'] || '5432'} -U #{config['username']}"
+      def base_env
+        {
+          'PGHOST' => configuration.fetch('host', 'localhost'),
+          'PGPORT' => configuration['port']&.to_s,
+          'PGUSER' => configuration['username'],
+          'PGPASSWORD' => configuration['password'],
+          'PGDATABASE' => configuration['database'],
+        }
       end
 
-      def psql_command(config)
-        base_command(config, 'psql') + " -d #{config['database']}"
-      end
-
-      def dump_command(config)
-        base_command(config, 'pg_dump') + " -Fc #{config['database']}"
-      end
-
-      def raise_service_error
-        raise Error::Fail, 'Please check whether database service is up & running state.'
+      def ping!
+        unless ping
+          raise Error::Fail, 'Please check whether database service is up & running state.'
+        end
       end
     end
   end

data/lib/foreman_maintain/upgrade_runner.rb

@@ -137,7 +137,6 @@ module ForemanMaintain
         @reporter.before_scenario_starts(scenario)
         @reporter.puts <<~MESSAGE
           Skipping #{skipped_phase} phase as it was already run before.
-          To enforce to run the phase, use `upgrade run --phase #{skipped_phase}`
         MESSAGE
         @reporter.after_scenario_finishes(scenario)
       end

data/lib/foreman_maintain/utils/backup.rb

@@ -67,18 +67,15 @@ module ForemanMaintain
       end
 
       def valid_fpc_backup?
-        fpc_online_backup? || fpc_standard_backup? || fpc_logical_backup? || \
-          fpc_hybrid_db_backup?
+        fpc_online_backup? || fpc_standard_backup?
       end
 
       def valid_katello_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?
+        katello_online_backup? || katello_standard_backup?
       end
 
       def valid_foreman_backup?
-        foreman_standard_backup? || foreman_online_backup? || foreman_logical_backup?
+        foreman_standard_backup? || foreman_online_backup?
       end
 
       def check_file_existence(existence_map)
@@ -111,19 +108,6 @@ module ForemanMaintain
           :absent => absent)
       end
 
-      def katello_logical_backup?
-        present = [:pgsql_data, :candlepin_dump, :foreman_dump, :pulpcore_dump]
-        absent = []
-        check_file_existence(:present => present,
-          :absent => absent)
-      end
-
-      def katello_hybrid_db_backup?
-        all_dbs = { :pgsql_data => %w[candlepin foreman pulpcore] }
-        present, absent = dumps_for_hybrid_db_setup(all_dbs)
-        check_file_existence(:present => present, :absent => absent)
-      end
-
       def fpc_standard_backup?
         present = [:pgsql_data]
         absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
@@ -137,19 +121,6 @@ module ForemanMaintain
         check_file_existence(:present => present, :absent => absent)
       end
 
-      def fpc_logical_backup?
-        present = [:pulpcore_dump, :pgsql_data]
-        absent = [:candlepin_dump, :foreman_dump]
-        check_file_existence(:present => present, :absent => absent)
-      end
-
-      def fpc_hybrid_db_backup?
-        all_dbs = { :pgsql_data => ['pulpcore'] }
-        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])
@@ -160,30 +131,6 @@ module ForemanMaintain
           :absent => [:candlepin_dump, :pgsql_data, :pulpcore_dump])
       end
 
-      def foreman_logical_backup?
-        check_file_existence(:present => [:pgsql_data, :foreman_dump],
-          :absent => [:candlepin_dump, :pulpcore_dump])
-      end
-
-      def dumps_for_hybrid_db_setup(dbs_hash)
-        present = []
-        absent = []
-        dbs_hash.each do |data_file, dbs|
-          dbs.each do |db|
-            feature_label = "#{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
-
       def validate_hostname?
         # make sure that the system hostname is the same as the backup
         metadata.fetch('hostname', nil) == hostname

data/lib/foreman_maintain/utils/command_runner.rb

@@ -8,26 +8,27 @@ module ForemanMaintain
       attr_reader :logger, :command
 
       def initialize(logger, command, options)
-        options.validate_options!(:stdin, :hidden_patterns, :interactive, :valid_exit_statuses)
+        options.validate_options!(:stdin, :interactive, :valid_exit_statuses, :env)
         options[:valid_exit_statuses] ||= [0]
+        options[:env] ||= {}
         @logger = logger
         @command = command
         @stdin = options[:stdin]
-        @hidden_patterns = Array(options[:hidden_patterns]).compact
         @interactive = options[:interactive]
         @options = options
         @valid_exit_statuses = options[:valid_exit_statuses]
+        @env = options[:env]
         raise ArgumentError, 'Can not pass stdin for interactive command' if @interactive && @stdin
       end
 
       def run
-        logger&.debug(hide_strings("Running command #{@command} with stdin #{@stdin.inspect}"))
+        logger&.debug("Running command #{@command} with stdin #{@stdin.inspect}")
         if @interactive
           run_interactively
         else
           run_non_interactively
         end
-        logger&.debug("output of the command:\n #{hide_strings(output)}")
+        logger&.debug("output of the command:\n #{output}")
       end
 
       def interactive?
@@ -49,10 +50,10 @@ module ForemanMaintain
       end
 
       def execution_error
-        raise Error::ExecutionError.new(hide_strings(@command),
+        raise Error::ExecutionError.new(@command,
           exit_status,
-          hide_strings(@stdin),
-          @interactive ? nil : hide_strings(@output))
+          @stdin,
+          @interactive ? nil : @output)
       end
 
       private
@@ -81,7 +82,7 @@ module ForemanMaintain
       end
 
       def run_non_interactively
-        IO.popen(full_command, 'r+') do |f|
+        IO.popen(@env, full_command, 'r+') do |f|
           if @stdin
             f.puts(@stdin)
             f.close_write
@@ -94,13 +95,6 @@ module ForemanMaintain
       def full_command
         "#{@command} 2>&1"
       end
-
-      def hide_strings(string)
-        return unless string
-        @hidden_patterns.reduce(string) do |result, hidden_pattern|
-          result.gsub(hidden_pattern, '[FILTERED]')
-        end
-      end
     end
   end
 end

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.8.0'.freeze
+  VERSION = '1.8.2'.freeze
 end

data/lib/foreman_maintain.rb

@@ -181,20 +181,22 @@ module ForemanMaintain
 
     def perform_self_upgrade
       package_name, command = pkg_and_cmd_name
+      packages_to_update = [package_name, main_package_name].uniq
+      packages_to_update_str = packages_to_update.join(', ')
 
-      puts "Checking for new version of #{package_name}..."
+      puts "Checking for new version of #{packages_to_update_str}..."
 
       enable_maintenance_module
       package_manager = ForemanMaintain.package_manager
 
-      if package_manager.update_available?(main_package_name)
-        puts "\nUpdating #{package_name} package."
-        package_manager.update(main_package_name, :assumeyes => true)
-        puts "\nThe #{package_name} package successfully updated."\
+      if package_manager.update_available?(packages_to_update)
+        puts "\nUpdating #{packages_to_update_str}."
+        package_manager.update(packages_to_update, :assumeyes => true)
+        puts "\nSuccessfully updated #{packages_to_update_str}."\
              "\nRe-run #{command} with required options!"
         exit 75
       end
-      puts "Nothing to update, can't find new version of #{package_name}."
+      puts "Nothing to update, can't find new version of #{packages_to_update_str}."
     end
 
     def enable_maintenance_module

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Ivan Nečas
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -142,7 +142,6 @@ email: inecas@redhat.com
 executables:
 - foreman-maintain
 - foreman-maintain-complete
-- foreman-maintain-rotate-tar
 extensions: []
 extra_rdoc_files:
 - LICENSE
@@ -410,7 +409,7 @@ homepage: https://github.com/theforeman/foreman_maintain
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -429,7 +428,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt
 test_files: []