foreman_maintain 1.7.14 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f9b342d0c7de2d288870f2ec1612abef36f3f966b87e1380766a6559e3ab39
-  data.tar.gz: 596e1552a72dcdff40a03eef29ed22c4cc4307f9426a0653836a45f5146b5018
+  metadata.gz: 8e99ddc1408ae68f584bbfc6e8798367e623e38f981682666f40cac91bb8f5f4
+  data.tar.gz: 173ee0cd4fbce206437d53937eaf0489111e4c6b57eac8b04943c9468eb5ab40
 SHA512:
-  metadata.gz: 440a16953ba3b289d989fa7cbc0f9a0ef852fc822601d0be5d7785abf8bf069b9344436e94b4c89691493e94703ac6627110b9afdaeccd01ef90ac2a34da7bee
-  data.tar.gz: 7a179118880980a5fac803379d02013d5927817127addf21331940aa8ee19e5f57a7f0bd059cf98f885b9aa7024f07b579951b72da949af655149a9d7a10bbb0
+  metadata.gz: 60a28996480d8564f5900a56d3f1494f9eb756d0a54c1bf3fee4c37fb5096a848db3a4ed2a6700e65d2fd4193bda13bebb4a50368ca0dbfd2ca1dccf9ea76d8e
+  data.tar.gz: c323322a2e40d116c34de3ed7430742caa127250024957aa4b2579b14bbc27fb271312a6d973d82533ef091ca77ead05de0cf61c005475da8e3766e910e35562

data/README.md

@@ -20,6 +20,7 @@ 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/features/installer.rb

@@ -8,7 +8,7 @@ class Features::Installer < ForemanMaintain::Feature
   end
 
   def answers
-    load_answers(configuration)
+    YAML.load_file(answer_file)
   end
 
   def configuration
@@ -28,11 +28,13 @@ class Features::Installer < ForemanMaintain::Feature
   end
 
   def config_files
-    Dir.glob(File.join(config_directory, '**/*')) +
-      [
-        '/opt/puppetlabs/puppet/cache/foreman_cache_data',
-        '/opt/puppetlabs/puppet/cache/pulpcore_cache_data',
-      ]
+    paths = [
+      config_directory,
+      '/opt/puppetlabs/puppet/cache/foreman_cache_data',
+      '/opt/puppetlabs/puppet/cache/pulpcore_cache_data',
+    ]
+    paths << answer_file unless answer_file.start_with?("#{config_directory}/")
+    paths
   end
 
   def last_scenario
@@ -80,8 +82,8 @@ class Features::Installer < ForemanMaintain::Feature
 
   private
 
-  def load_answers(config)
-    YAML.load_file(config[:answer_file])
+  def answer_file
+    configuration[:answer_file]
   end
 
   def last_scenario_config

data/definitions/features/pulpcore.rb

@@ -25,14 +25,7 @@ class Features::Pulpcore < ForemanMaintain::Feature
   end
 
   def running_tasks
-    tasks = cli('task list --state-in running --state-in canceling')
-    # cli() uses parse_json() which swallows JSON::ParserError and returns nil
-    # but running_tasks should return an Array
-    if tasks.nil?
-      []
-    else
-      tasks
-    end
+    cli('task list --state-in running --state-in canceling')
   rescue ForemanMaintain::Error::ExecutionError
     []
   end

data/definitions/features/satellite.rb

@@ -11,11 +11,11 @@ class Features::Satellite < ForemanMaintain::Feature
   end
 
   def target_version
-    '6.16'
+    satellite_maintain_target_version
   end
 
   def current_version
-    @current_version ||= package_version(package_name) || version_from_source
+    @current_version ||= package_version(package_name)
   end
 
   def package_name
@@ -25,10 +25,4 @@ class Features::Satellite < ForemanMaintain::Feature
   def module_name
     'satellite'
   end
-
-  private
-
-  def version_from_source
-    version(File.read('/usr/share/foreman/lib/satellite/version.rb')[/6\.\d\.\d/])
-  end
 end

data/definitions/procedures/pulpcore/container_handle_image_metadata.rb

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

data/definitions/procedures/repositories/index_katello_repositories_container_metadata.rb

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

data/definitions/scenarios/foreman_upgrade.rb

@@ -39,7 +39,6 @@ module Scenarios::Foreman
         Checks::Disk::AvailableSpace,
         Checks::Disk::AvailableSpaceCandlepin, # if candlepin
         Checks::Disk::AvailableSpacePostgresql13,
-        Checks::Disk::PostgresqlMountpoint,
         Checks::Foreman::ValidateExternalDbVersion, # if external database
         Checks::Foreman::CheckCorruptedRoles,
         Checks::Foreman::CheckDuplicatePermissions,
@@ -54,7 +53,6 @@ module Scenarios::Foreman
         Checks::PackageManager::Dnf::ValidateDnfConfig,
         Checks::Repositories::CheckNonRhRepository,
         Checks::CheckOrganizationContentAccessMode,
-        Checks::CheckSha1CertificateAuthority,
         Checks::Repositories::Validate
       )
     end
@@ -115,7 +113,6 @@ module Scenarios::Foreman
       add_steps(
         Procedures::RefreshFeatures,
         Procedures::Service::Start,
-        Procedures::Pulpcore::RpmDatarepair,
         Procedures::Crond::Start,
         Procedures::SyncPlans::Enable,
         Procedures::MaintenanceMode::DisableMaintenanceMode

data/definitions/scenarios/satellite_upgrade.rb

@@ -4,15 +4,14 @@ module Scenarios::Satellite
       metadata do
         tags :upgrade_scenario
         confine do
-          (feature(:instance).downstream&.current_minor_version == '6.15' || \
-            ForemanMaintain.upgrade_in_progress == '6.16')
+          feature(:instance).downstream&.satellite_upgrade_allowed?
         end
         instance_eval(&block)
       end
     end
 
     def target_version
-      '6.16'
+      feature(:instance).downstream&.satellite_maintain_target_version
     end
   end
 
@@ -39,7 +38,6 @@ module Scenarios::Satellite
         Checks::CheckUpstreamRepository,
         Checks::Disk::AvailableSpace,
         Checks::Disk::AvailableSpaceCandlepin, # if candlepin
-        Checks::Disk::PostgresqlMountpoint,
         Checks::Foreman::ValidateExternalDbVersion, # if external database
         Checks::Foreman::CheckCorruptedRoles,
         Checks::Foreman::CheckDuplicatePermissions,
@@ -56,7 +54,6 @@ module Scenarios::Satellite
         Checks::CheckIpv6Disable,
         Checks::Disk::AvailableSpacePostgresql13,
         Checks::CheckOrganizationContentAccessMode,
-        Checks::CheckSha1CertificateAuthority,
         Checks::Repositories::Validate.new(:version => target_version),
       )
     end
@@ -120,7 +117,6 @@ module Scenarios::Satellite
       add_steps(
         Procedures::RefreshFeatures,
         Procedures::Service::Start,
-        Procedures::Pulpcore::RpmDatarepair,
         Procedures::Crond::Start,
         Procedures::SyncPlans::Enable,
         Procedures::MaintenanceMode::DisableMaintenanceMode,

data/lib/foreman_maintain/cli/base.rb

@@ -137,7 +137,7 @@ module ForemanMaintain
         option '--label', 'label',
           'Run only a specific check with a label. ' \
             '(Use "list" command to see available labels)' do |label|
-          raise ArgumentError, 'no value provided' if label.nil? || label.empty?
+          raise ArgumentError, 'value not specified' if label.nil? || label.empty?
           underscorize(label).to_sym
         end
       end
@@ -147,7 +147,7 @@ module ForemanMaintain
           'Run only those with all specific set of tags. ' \
             '(Use list-tags command to see available tags)',
           :multivalued => true) do |tags|
-          raise ArgumentError, 'no value provided' if tags.nil? || tags.empty?
+          raise ArgumentError, 'value not specified' if tags.nil? || tags.empty?
           tags.map { |tag| underscorize(tag).to_sym }
         end
       end
@@ -166,7 +166,7 @@ module ForemanMaintain
         if opts.include?('whitelist')
           option(['-w', '--whitelist'], 'whitelist',
             'Comma-separated list of labels of steps to be skipped') do |whitelist|
-            raise ArgumentError, 'no value provided' if whitelist.nil? || whitelist.empty?
+            raise ArgumentError, 'value not specified' if whitelist.nil? || whitelist.empty?
             whitelist.split(',').map(&:strip)
           end
         end

data/lib/foreman_maintain/concerns/downstream.rb

@@ -1,6 +1,8 @@
 module ForemanMaintain
   module Concerns
     module Downstream
+      SATELLITE_MAINTAIN_CONFIG = '/usr/share/satellite-maintain/config.yml'.freeze
+
       def current_version
         raise NotImplementedError
       end
@@ -46,8 +48,25 @@ module ForemanMaintain
         %w[satellite-maintain satellite-maintain]
       end
 
+      def satellite_maintain_target_version
+        satellite_maintain_config['current_satellite_version']
+      end
+
+      def satellite_upgrade_allowed?
+        current_minor_version == satellite_maintain_config['previous_satellite_version'] ||
+          ForemanMaintain.upgrade_in_progress == satellite_maintain_target_version
+      end
+
       private
 
+      def satellite_maintain_config
+        if File.exist?(SATELLITE_MAINTAIN_CONFIG)
+          YAML.load_file(SATELLITE_MAINTAIN_CONFIG)
+        else
+          raise "Could not load satellite-maintain configuration file #{SATELLITE_MAINTAIN_CONFIG}."
+        end
+      end
+
       def rh_repos(server_version)
         server_version = version(server_version)
         rh_repos = main_rh_repos
@@ -71,10 +90,6 @@ module ForemanMaintain
           "rhel-#{el_major_version}-for-x86_64-appstream-rpms",
         ]
       end
-
-      def version_from_source
-        raise NotImplementedError
-      end
     end
   end
 end

data/lib/foreman_maintain/upgrade_runner.rb

@@ -137,6 +137,7 @@ 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/version.rb

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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.7.14
+  version: 1.8.0
 platform: ruby
 authors:
 - Ivan Nečas
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -55,16 +56,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -161,13 +162,11 @@ files:
 - definitions/checks/candlepin/db_up.rb
 - definitions/checks/check_hotfix_installed.rb
 - definitions/checks/check_ipv6_disable.rb
-- definitions/checks/check_sha1_certificate_authority.rb
 - definitions/checks/check_tmout.rb
 - definitions/checks/disk/available_space.rb
 - definitions/checks/disk/available_space_candlepin.rb
 - definitions/checks/disk/available_space_postgresql13.rb
 - definitions/checks/disk/performance.rb
-- definitions/checks/disk/postgresql_mountpoint.rb
 - definitions/checks/env_proxy.rb
 - definitions/checks/foreman/check_corrupted_roles.rb
 - definitions/checks/foreman/check_duplicate_permission.rb
@@ -274,7 +273,6 @@ files:
 - definitions/procedures/packages/update.rb
 - definitions/procedures/packages/update_all_confirmation.rb
 - definitions/procedures/pulpcore/container_handle_image_metadata.rb
-- definitions/procedures/pulpcore/rpm_datarepair.rb
 - definitions/procedures/pulpcore/wait_for_tasks.rb
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
 - definitions/procedures/puppet/remove_puppet.rb
@@ -412,6 +410,7 @@ homepage: https://github.com/theforeman/foreman_maintain
 licenses:
 - GPL-3.0
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -429,7 +428,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Foreman maintenance tool belt
 test_files: []

data/definitions/checks/check_sha1_certificate_authority.rb

@@ -1,49 +0,0 @@
-class Checks::CheckSha1CertificateAuthority < ForemanMaintain::Check
-  metadata do
-    label :check_sha1_certificate_authority
-    description 'Check if server certificate authority is sha1 signed'
-
-    confine do
-      feature(:katello) || feature(:foreman_proxy)
-    end
-
-    do_not_whitelist
-  end
-
-  def run
-    installer_answers = feature(:installer).answers
-    server_ca = installer_answers['certs']['server_ca_cert']
-
-    return unless server_ca
-
-    begin
-      certificates = load_fullchain(server_ca)
-    rescue OpenSSL::X509::CertificateError => e
-      assert(false, "Error reading server CA certificate #{server_ca}.\n #{e.message}")
-    else
-      msg = <<~MSG
-        Server CA certificate #{server_ca} signed with sha1 which will break on upgrade.
-        Update the server CA certificate with one signed with sha256 or
-        stronger then proceed with the upgrade.
-      MSG
-
-      assert(
-        certificates.all? { |cert| cert.signature_algorithm != 'sha1WithRSAEncryption' },
-        msg
-      )
-    end
-  end
-
-  def load_fullchain(bundle_pem)
-    if OpenSSL::X509::Certificate.respond_to?(:load_file)
-      OpenSSL::X509::Certificate.load_file(bundle_pem)
-    else
-      # Can be removed when only Ruby with load_file support is supported
-      File.binread(bundle_pem).
-        lines.
-        slice_after(/^-----END CERTIFICATE-----/).
-        filter { |pem| pem.join.include?('-----END CERTIFICATE-----') }.
-        map { |pem| OpenSSL::X509::Certificate.new(pem.join) }
-    end
-  end
-end

data/definitions/checks/disk/postgresql_mountpoint.rb

@@ -1,35 +0,0 @@
-module Checks
-  module Disk
-    class PostgresqlMountpoint < ForemanMaintain::Check
-      metadata do
-        label :postgresql_mountpoint
-        description 'Check to make sure PostgreSQL data is not on an own mountpoint'
-        confine do
-          feature(:instance).postgresql_local? && ForemanMaintain.el?
-        end
-      end
-
-      def run
-        assert(psql_dir_device == psql_data_dir_device, warning_message)
-      end
-
-      def psql_dir_device
-        device = ForemanMaintain::Utils::Disk::Device.new('/var/lib/pgsql')
-        device.name
-      end
-
-      def psql_data_dir_device
-        device = ForemanMaintain::Utils::Disk::Device.new('/var/lib/pgsql/data')
-        device.name
-      end
-
-      def warning_message
-        <<~MSG
-          PostgreSQL data (/var/lib/pgsql/data) is on a different device than /var/lib/pgsql.
-          This is not supported and breaks PostgreSQL upgrades.
-          Please ensure PostgreSQL data is on the same mountpoint as the /var/lib/pgsql.
-        MSG
-      end
-    end
-  end
-end

data/definitions/procedures/pulpcore/rpm_datarepair.rb

@@ -1,17 +0,0 @@
-module Procedures::Pulpcore
-  class RpmDatarepair < ForemanMaintain::Procedure
-    include ForemanMaintain::Concerns::PulpCommon
-
-    metadata do
-      description 'Rename ContentArtifact relative_paths to match `{N-V-R.A.rpm}`'
-      for_feature :pulpcore
-    end
-
-    def run
-      with_spinner('Running pulpcore-manager rpm-datarepair 4073') do
-        # Assumption: services are already started
-        execute!(pulpcore_manager('rpm-datarepair 4073'))
-      end
-    end
-  end
-end