foreman_maintain 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e56d0ebde52242c236f12a7a5b1f6a5bff833f3
-  data.tar.gz: b1edcdce8bef56a30d93e8e87b353c0da2823d0f
+SHA256:
+  metadata.gz: 41f6663257db0cfdff24426812ca56a64a53105c6192b5abf5a2dba70e934fb5
+  data.tar.gz: a745621e9499e97d3c39e7d4d86f833b31c96e762d34d7a2def668e59cb555a8
 SHA512:
-  metadata.gz: d30075189e4c304a615af0f9184aec70e6a904e7918d02720a5fddb7241d8abaab5b02221aeeeedd0638a5f3f9b973c2def96e3612d42185d97b0fca9e8f18d8
-  data.tar.gz: 9a4793c2de2b9ee693109bd6bb16b5f89f4365b17e972651973b4eb9844535788a1c1c665eef52790e487aa4da794ee1bc04f1ab160e867f666bccb7dd40019b
+  metadata.gz: c78e8bfc7d0ef67cbaf4d79c319b37175b4148d2050625894ac9a3e5186795b08ffe7f696472f110f3260ebac0381dd3407df55ce2cb92704751d00c4bed40c2
+  data.tar.gz: 0bfaef53cbc4ccf91f1f841365bdbe0beb6256104f3e6c704f6e0b8554c6921d2b7e3cd5c4ce0e5c7c94d6fe71e6e51525a4d47c38d14f1ff8428045a8fd15ae

data/README.md

@@ -120,6 +120,12 @@ export EXTERNAL_SAT_ORG='Sat6-CI'
 export EXTERNAL_SAT_ACTIVATION_KEY='Satellite QA RHEL7'
 ```
 
+To use beta repositories during upgrade, set the following environment variable
+
+```
+export FOREMAN_MAINTAIN_USE_BETA='1'
+```
+
 ## Implementation
 
 `foreman_maintain` maps the CLI commands into definitions. This allows to keep the set
@@ -437,7 +443,7 @@ Possible options for the `:completion` attribute are:
 * `maintenance-mode status` gives a brief output with On/Off message. This includes status of each step.
 
 * `maintenance-mode is-enabled` returns `0 or 1` output depending upon the maintenance-mode status.
-Here, 1=ON & 0=OFF.
+Here, 0=ON & 1=OFF.
 
 If User would like to check whether maintenance-mode is ON/OFF on system in their external script then
 they can use subcommand `foreman-maintain maintenance-mode is-enabled`.

data/definitions/checks/disk/performance.rb

@@ -26,7 +26,11 @@ module Checks
           puts "\n"
           puts stats.stdout
 
-          assert(success, io_obj.slow_disk_error_msg)
+          if feature(:downstream) && feature(:downstream).at_least_version?('6.3')
+            assert(success, io_obj.slow_disk_error_msg + warning_message, :warn => true)
+          else
+            assert(success, io_obj.slow_disk_error_msg)
+          end
         end
       end
 
@@ -38,11 +42,17 @@ module Checks
 
       def dirs_to_check
         return DEFAULT_DIRS.first(1) if check_only_single_device?
+
         DEFAULT_DIRS
       end
 
       private
 
+      def warning_message
+        "\nWARNING: Low disk speed might have a negative impact on the system."\
+        "\nSee https://access.redhat.com/solutions/3397771 before proceeding"
+      end
+
       def compute_disk_speed(spinner)
         success = true
         io_obj = ForemanMaintain::Utils::Disk::NilDevice.new

data/definitions/checks/version_locking_enabled.rb

@@ -0,0 +1,14 @@
+module Checks
+  class VersionLockingEnabled < ForemanMaintain::Check
+    metadata do
+      description 'Check if tooling for package version locking is installed'
+    end
+
+    def run
+      enabled = feature(:package_manager).version_locking_enabled?
+      enable_locking = Procedures::Packages::EnableVersionLocking.new(:assumeyes => assumeyes?)
+      assert(enabled, 'Tools for package version locking are not available on this system',
+             :next_steps => enable_locking)
+    end
+  end
+end

data/definitions/features/candlepin_database.rb

@@ -7,7 +7,7 @@ class Features::CandlepinDatabase < ForemanMaintain::Feature
     label :candlepin_database
 
     confine do
-      file_exists?(CANDLEPIN_DB_CONFIG)
+      file_nonzero?(CANDLEPIN_DB_CONFIG)
     end
   end
 

data/definitions/features/downstream.rb

@@ -64,7 +64,9 @@ class Features::Downstream < ForemanMaintain::Feature
 
     rh_repos.concat(sat_and_tools_repos(rh_version_major, sat_version))
 
-    rh_repos << 'rhel-7-server-ansible-2.6-rpms' if sat_version.to_s == '6.4'
+    if sat_version > version('6.3')
+      rh_repos << ansible_repo(sat_version, rh_version_major)
+    end
 
     if current_minor_version == '6.3' && sat_version.to_s != '6.4' && (
       feature(:puppet_server) && feature(:puppet_server).puppet_version.major == 4)
@@ -74,6 +76,14 @@ class Features::Downstream < ForemanMaintain::Feature
     rh_repos
   end
 
+  def ansible_repo(sat_version, rh_version_major)
+    if sat_version >= version('6.6')
+      "rhel-#{rh_version_major}-server-ansible-2.8-rpms"
+    elsif sat_version >= version('6.4')
+      "rhel-#{rh_version_major}-server-ansible-2.6-rpms"
+    end
+  end
+
   def sat_and_tools_repos(rh_version_major, sat_version)
     sat_version_full = "#{sat_version.major}.#{sat_version.minor}"
     sat_repo_id = "rhel-#{rh_version_major}-server-satellite-#{sat_version_full}-rpms"
@@ -81,7 +91,7 @@ class Features::Downstream < ForemanMaintain::Feature
     sat_maintenance_repo_id = "rhel-#{rh_version_major}-server-satellite-maintenance-6-rpms"
 
     # Override to use Beta repositories for sat version until GA
-    if sat_version.to_s == '6.5'
+    if ENV['FOREMAN_MAINTAIN_USE_BETA'] == '1'
       sat_repo_id = "rhel-server-#{rh_version_major}-satellite-6-beta-rpms"
       sat_tools_repo_id = "rhel-#{rh_version_major}-server-satellite-tools-6-beta-rpms"
       sat_maintenance_repo_id = "rhel-#{rh_version_major}-server-satellite-maintenance-6-beta-rpms"

data/definitions/features/foreman_database.rb

@@ -7,7 +7,7 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
     label :foreman_database
 
     confine do
-      file_exists?(FOREMAN_DB_CONFIG)
+      file_nonzero?(FOREMAN_DB_CONFIG)
     end
   end
 

data/definitions/features/package_manager.rb

@@ -0,0 +1,34 @@
+class Features::PackageManager < ForemanMaintain::Feature
+  metadata do
+    label :package_manager
+  end
+
+  extend Forwardable
+  def_delegators :manager, :lock_versions, :unlock_versions,
+                 :installed?, :find_installed_package, :install, :update,
+                 :version_locking_enabled?, :configure_version_locking,
+                 :foreman_related_packages, :version_locking_packages,
+                 :versions_locked?, :clean_cache
+
+  def self.type
+    @type ||= %w[dnf yum apt].find { |manager| command_present?(manager) }
+  end
+
+  def type
+    self.class.type
+  end
+
+  def manager
+    @manager ||= case type
+                 when 'dnf'
+                   ForemanMaintain::PackageManager::Dnf.new
+                 when 'yum'
+                   ForemanMaintain::PackageManager::Yum.new
+                 else
+                   raise 'No supported package manager was found'
+                 end
+  end
+
+  # TODO: DEB  grep ^Package: /var/lib/apt/lists/deb.theforeman.org_dists_*
+  # TODO DEB apt-mark hold/unhold <package>
+end

data/definitions/features/sync_plans.rb

@@ -3,33 +3,34 @@ class Features::SyncPlans < ForemanMaintain::Feature
     label :sync_plans
   end
 
-  def active_sync_plans_count
-    feature(:foreman_database).query(
-      <<-SQL
-        SELECT count(*) AS count FROM katello_sync_plans WHERE enabled ='t'
-      SQL
-    ).first['count'].to_i
+  def required_new_implementation
+    @required_new_implementation ||=
+      feature(:foreman_database).query(
+        <<-SQL
+          SELECT COUNT(1) FROM information_schema.table_constraints
+          WHERE constraint_name='katello_sync_plan_foreman_tasks_recurring_logic_fk' AND table_name='katello_sync_plans'
+        SQL
+      ).first['count'].to_i > 0
   end
 
-  def ids_by_status(enabled = true)
-    enabled = enabled ? 't' : 'f'
-    feature(:foreman_database).query(
-      <<-SQL
-        SELECT id FROM katello_sync_plans WHERE enabled ='#{enabled}'
-      SQL
-    ).map { |r| r['id'].to_i }
-  end
+  def sync_plan_ids_by_status(enabled = true, filter_ids = nil)
+    if filter_ids
+      return [] if filter_ids.empty?
 
-  def verify_existing_ids_by_status(ids, enabled = true)
-    return [] if ids.empty?
+      ids_condition = filter_ids.map { |id| "'#{id}'" }.join(',')
+    end
 
-    enabled = enabled ? 't' : 'f'
-    ids_condition = ids.map { |id| "'#{id}'" }.join(',')
-    feature(:foreman_database).query(
-      <<-SQL
-        SELECT id FROM katello_sync_plans WHERE enabled ='#{enabled}' AND id IN (#{ids_condition})
+    if required_new_implementation
+      query = <<-SQL
+        select sp.id as id from katello_sync_plans sp inner join foreman_tasks_recurring_logics rl on sp.foreman_tasks_recurring_logic_id = rl.id
+        where rl.state='#{enabled ? 'active' : 'disabled'}' #{ids_condition ? " AND sp.id IN (#{ids_condition})" : ''}
       SQL
-    ).map { |r| r['id'].to_i }
+    else
+      query = <<-SQL
+        SELECT id FROM katello_sync_plans WHERE enabled ='#{enabled ? 't' : 'f'}' #{ids_condition ? " AND id IN (#{ids_condition})" : ''}
+      SQL
+    end
+    feature(:foreman_database).query(query).map { |r| r['id'].to_i }
   end
 
   def make_disable(ids)
@@ -69,7 +70,7 @@ class Features::SyncPlans < ForemanMaintain::Feature
   private
 
   def update_records(ids, enabled)
-    ids_not_required_update = verify_existing_ids_by_status(ids, enabled)
+    ids_not_required_update = sync_plan_ids_by_status(enabled, ids)
     ids_required_update = ids - ids_not_required_update
     make_data_key_empty(enabled) if !ids_not_required_update.empty? && ids_required_update.empty?
     updated_record_ids = []
@@ -104,7 +105,7 @@ class Features::SyncPlans < ForemanMaintain::Feature
     else
       @data[:disabled] = [] unless @data[:disabled]
       @data[:enabled] = [] if @data[:disabled].empty?
-      @data[:disabled].concat(new_ids)
+      @data[:disabled].concat(new_ids).uniq!
     end
   end
 

data/definitions/procedures/backup/config_files.rb

@@ -11,6 +11,8 @@ module Procedures::Backup
       param :backup_dir, 'Directory where to backup to', :required => true
       param :proxy_features, 'List of proxy features to backup (default: all)',
             :array => true, :default => ['all']
+      param :ignore_changed_files, 'Should packing tar ignore changed files',
+            :flag => true, :default => false
     end
 
     def run
@@ -18,9 +20,10 @@ module Procedures::Backup
       increments = File.join(@backup_dir, '.config.snar')
       with_spinner('Collecting config files to backup') do
         configs = config_files.join(' ')
+        statuses = @ignore_changed_files ? [0, 1] : [0]
         execute!("tar --selinux --create --gzip --file=#{tarball} " \
           "--listed-incremental=#{increments} --ignore-failed-read " \
-          "#{configs}")
+          "#{configs}", :valid_exit_statuses => statuses)
       end
     end
 

data/definitions/procedures/maintenance_mode/is_enabled.rb

@@ -9,8 +9,8 @@ module Procedures::MaintenanceMode
     attr_reader :status_code
 
     def run
-      @status_code = feature(:iptables).maintenance_mode_chain_exist? ? 1 : 0
-      puts "Maintenance mode is #{@status_code == 0 ? 'Off' : 'On'}"
+      @status_code = feature(:iptables).maintenance_mode_chain_exist? ? 0 : 1
+      puts "Maintenance mode is #{@status_code == 1 ? 'Off' : 'On'}"
     end
   end
 end

data/definitions/procedures/packages/enable_version_locking.rb

@@ -0,0 +1,17 @@
+module Procedures::Packages
+  class EnableVersionLocking < ForemanMaintain::Procedure
+    metadata do
+      description 'Install and configure tools for version locking'
+      param :assumeyes, 'Do not ask for confirmation'
+    end
+
+    def run
+      packages = feature(:package_manager).version_locking_packages
+      feature(:package_manager).install(packages, :assumeyes => @assumeyes)
+      unless feature(:package_manager).installed?(packages)
+        raise "Unable to install some of the required dependences:  #{packages.join(' ')}"
+      end
+      feature(:package_manager).configure_version_locking
+    end
+  end
+end

data/definitions/procedures/packages/lock_versions.rb

@@ -0,0 +1,17 @@
+module Procedures::Packages
+  class LockVersions < ForemanMaintain::Procedure
+    metadata do
+      for_feature :package_manager
+      description 'Lock versions of Foreman-related packages'
+      preparation_steps { [Checks::VersionLockingEnabled.new] }
+    end
+
+    def run
+      with_spinner('Collecting list of packages to lock') do |spinner|
+        package_list = feature(:package_manager).foreman_related_packages
+        spinner.update('Locking packages')
+        feature(:package_manager).lock_versions(package_list)
+      end
+    end
+  end
+end

data/definitions/procedures/packages/locking_status.rb

@@ -0,0 +1,17 @@
+module Procedures::Packages
+  class LockingStatus < ForemanMaintain::Procedure
+    metadata do
+      for_feature :package_manager
+      description 'Check status of version locking of Foreman-related packages'
+      preparation_steps { [Checks::VersionLockingEnabled.new] }
+    end
+
+    def run
+      if feature(:package_manager).versions_locked?
+        puts 'Packages are locked.'
+      else
+        puts 'Packages are not locked.'
+      end
+    end
+  end
+end

data/definitions/procedures/packages/unlock_versions.rb

@@ -0,0 +1,13 @@
+module Procedures::Packages
+  class UnlockVersions < ForemanMaintain::Procedure
+    metadata do
+      for_feature :package_manager
+      description 'Unlock versions of Foreman-related packages'
+      preparation_steps { [Checks::VersionLockingEnabled.new] }
+    end
+
+    def run
+      feature(:package_manager).unlock_versions
+    end
+  end
+end

data/definitions/procedures/packages/update.rb

@@ -7,7 +7,7 @@ module Procedures::Packages
 
     def run
       assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
-      clean_all_packages
+      feature(:package_manager).clean_cache
       packages_action(:update, @packages, :assumeyes => assumeyes_val)
     end
 

data/definitions/procedures/sync_plans/disable.rb

@@ -21,7 +21,7 @@ module Procedures::SyncPlans
       default_storage = ForemanMaintain.storage(:default)
       feature(:sync_plans).load_from_storage(default_storage)
       with_spinner('disabling sync plans') do |spinner|
-        ids = feature(:sync_plans).ids_by_status(true)
+        ids = feature(:sync_plans).sync_plan_ids_by_status(true)
         feature(:sync_plans).make_disable(ids)
         spinner.update "Total #{ids.length} sync plans are now disabled."
       end

data/definitions/scenarios/backup.rb

@@ -19,7 +19,6 @@ module ForemanMaintain::Scenarios
       param :tar_volume_size, 'Size of tar volume (indicates splitting)'
     end
 
-    # rubocop:disable  Metrics/MethodLength
     def compose
       check_valid_startegy
       safety_confirmation
@@ -27,7 +26,6 @@ module ForemanMaintain::Scenarios
       prepare_directory
       logical_volume_confirmation
       add_step_with_context(Procedures::Backup::Metadata)
-      add_step_with_context(Procedures::Backup::ConfigFiles)
 
       case strategy
       when :online
@@ -39,7 +37,6 @@ module ForemanMaintain::Scenarios
       end
       add_step_with_context(Procedures::Backup::CompressData)
     end
-    # rubocop:enable  Metrics/MethodLength
 
     # rubocop:disable  Metrics/MethodLength
     def set_context_mapping
@@ -132,6 +129,7 @@ module ForemanMaintain::Scenarios
       add_steps_with_context(
         find_procedures(:maintenance_mode_on),
         Procedures::Service::Stop,
+        Procedures::Backup::ConfigFiles,
         Procedures::Backup::Pulp,
         Procedures::Backup::Offline::Mongo,
         Procedures::Backup::Offline::CandlepinDB,
@@ -162,6 +160,7 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Snapshot::PrepareMount,
         find_procedures(:maintenance_mode_on),
         Procedures::Service::Stop,
+        Procedures::Backup::ConfigFiles,
         Procedures::Backup::Snapshot::MountMongo,
         Procedures::Backup::Snapshot::MountPulp,
         Procedures::Backup::Snapshot::MountCandlepinDB,
@@ -184,6 +183,7 @@ module ForemanMaintain::Scenarios
     # rubocop:enable  Metrics/MethodLength
 
     def add_online_backup_steps
+      add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
       add_steps_with_context(
         Procedures::Backup::Online::Mongo,

data/definitions/scenarios/upgrade_to_satellite_6_2.rb

@@ -45,6 +45,7 @@ module Scenarios::Satellite_6_2
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.2'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_2_z.rb

@@ -45,6 +45,7 @@ module Scenarios::Satellite_6_2_z
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.2'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_3.rb

@@ -46,6 +46,7 @@ module Scenarios::Satellite_6_3
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.3'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_3_z.rb

@@ -45,6 +45,7 @@ module Scenarios::Satellite_6_3_z
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.3'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_4.rb

@@ -46,6 +46,7 @@ module Scenarios::Satellite_6_4
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.4'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_4_z.rb

@@ -45,6 +45,7 @@ module Scenarios::Satellite_6_4_z
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.4'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_5.rb

@@ -45,6 +45,7 @@ module Scenarios::Satellite_6_5
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.5'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_5_z.rb

@@ -45,6 +45,7 @@ module Scenarios::Satellite_6_5_z
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.5'))
+      add_step(Procedures::Packages::UnlockVersions.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step(Procedures::Installer::Upgrade.new)
     end

data/definitions/scenarios/upgrade_to_satellite_6_6.rb

@@ -0,0 +1,80 @@
+module Scenarios::Satellite_6_6
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_to_satellite_6_6
+        confine do
+          feature(:downstream) && feature(:downstream).current_minor_version == '6.5'
+        end
+        instance_eval(&block)
+      end
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Satellite 6.6'
+      tags :pre_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Repositories::Validate.new(:version => '6.6'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Satellite 6.6'
+      tags :pre_migrations
+    end
+
+    def compose
+      add_steps(find_procedures(:pre_migrations))
+      add_step(Procedures::Service::Stop.new)
+    end
+  end
+
+  class Migrations < Abstract
+    upgrade_metadata do
+      description 'Migration scripts to Satellite 6.6'
+      tags :migrations
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '6.6'))
+      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true))
+      add_step(Procedures::Installer::Upgrade.new)
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures after migrating to Satellite 6.6'
+      tags :post_migrations
+    end
+
+    def compose
+      add_step(Procedures::Service::Start.new)
+      add_steps(find_procedures(:post_migrations))
+    end
+  end
+
+  class PostUpgradeChecks < Abstract
+    upgrade_metadata do
+      description 'Checks after upgrading to Satellite 6.6'
+      tags :post_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:post_upgrade))
+    end
+  end
+end
+
+ForemanMaintain::UpgradeRunner.register_version('6.6', :upgrade_to_satellite_6_6)

data/definitions/scenarios/version_locking.rb

@@ -0,0 +1,39 @@
+module ForemanMaintain::Scenarios
+  module VersionLocking
+    class Status < ForemanMaintain::Scenario
+      metadata do
+        label :version_locking_status
+        description 'detection of status of package version locking'
+        manual_detection
+      end
+
+      def compose
+        add_step(Procedures::Packages::LockingStatus)
+      end
+    end
+
+    class Unlock < ForemanMaintain::Scenario
+      metadata do
+        label :version_locking_unlock
+        description 'unlocking of package versions'
+        manual_detection
+      end
+
+      def compose
+        add_step(Procedures::Packages::UnlockVersions)
+      end
+    end
+
+    class Lock < ForemanMaintain::Scenario
+      metadata do
+        label :version_locking_lock
+        description 'locking of package versions'
+        manual_detection
+      end
+
+      def compose
+        add_step(Procedures::Packages::LockVersions)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/base.rb

@@ -64,6 +64,11 @@ module ForemanMaintain
         runner.run
       end
 
+      def run_scenarios_and_exit(scenarios, rescue_scenario: nil)
+        run_scenario(scenarios, rescue_scenario)
+        exit runner.exit_code
+      end
+
       def available_checks
         filter = {}
         filter[:tags] = tags if respond_to?(:tags)

data/lib/foreman_maintain/cli/packages_command.rb

@@ -0,0 +1,36 @@
+module ForemanMaintain
+  module Cli
+    class PackagesCommand < Base
+      subcommand 'lock', 'Prevent Foreman-related packages from automatic update' do
+        interactive_option
+        def execute
+          run_scenarios_and_exit(Scenarios::VersionLocking::Lock.new)
+        end
+      end
+
+      subcommand 'unlock', 'Enable Foreman-related packages for automatic update' do
+        interactive_option
+        def execute
+          run_scenarios_and_exit(Scenarios::VersionLocking::Unlock.new)
+        end
+      end
+
+      subcommand 'status', 'Check if Foreman-related packages are protected against update' do
+        interactive_option
+        def execute
+          run_scenarios_and_exit(Scenarios::VersionLocking::Status.new)
+        end
+      end
+
+      subcommand 'is-locked', 'Check if update of Foreman-related packages is allowed' do
+        interactive_option
+        def execute
+          locked = feature(:package_manager).versions_locked?
+          puts "Foreman related packages are#{locked ? '' : ' not'} locked"
+          exit_code = locked ? 0 : 1
+          exit exit_code
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli.rb

@@ -9,6 +9,7 @@ require 'foreman_maintain/cli/advanced_command'
 require 'foreman_maintain/cli/service_command'
 require 'foreman_maintain/cli/restore_command'
 require 'foreman_maintain/cli/maintenance_mode_command'
+require 'foreman_maintain/cli/packages_command'
 
 module ForemanMaintain
   module Cli
@@ -20,6 +21,7 @@ module ForemanMaintain
       subcommand 'service', 'Control applicable services', ServiceCommand
       subcommand 'backup', 'Backup server', BackupCommand
       subcommand 'restore', 'Restore a backup', RestoreCommand
+      subcommand 'packages', 'Lock/Unlock installed packages', PackagesCommand
       subcommand 'advanced', 'Advanced tools for server maintenance', AdvancedCommand
       subcommand 'maintenance-mode', 'Control maintenance-mode for application',
                  MaintenanceModeCommand

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -54,6 +54,10 @@ module ForemanMaintain
         $CHILD_STATUS.success?
       end
 
+      def command_present?(command_name)
+        execute?("command -v #{command_name}")
+      end
+
       def execute!(command, options = {})
         command_runner = Utils::CommandRunner.new(logger, command, options)
         execution.puts '' if command_runner.interactive? && respond_to?(:execution)
@@ -81,11 +85,12 @@ module ForemanMaintain
         File.exist?(filename)
       end
 
+      def file_nonzero?(filename)
+        File.exist?(filename) && !File.zero?(filename)
+      end
+
       def find_package(name)
-        result = execute(%(rpm -q '#{name}'))
-        if $CHILD_STATUS.success?
-          result
-        end
+        feature(:package_manager).find_installed_package(name)
       end
 
       def hostname
@@ -101,20 +106,15 @@ module ForemanMaintain
       end
 
       def packages_action(action, packages, options = {})
-        expected_actions = [:install, :update]
-        unless expected_actions.include?(action)
+        options.validate_options!(:assumeyes)
+        case action
+        when :install
+          feature(:package_manager).install(packages, :assumeyes => options[:assumeyes])
+        when :update
+          feature(:package_manager).update(packages, :assumeyes => options[:assumeyes])
+        else
           raise ArgumentError, "Unexpected action #{action} expected #{expected_actions.inspect}"
         end
-        options.validate_options!(:assumeyes)
-        yum_options = []
-        yum_options << '-y' if options[:assumeyes]
-        execute!("yum #{yum_options.join(' ')} #{action} #{packages.join(' ')}",
-                 :interactive => true)
-      end
-
-      def clean_all_packages
-        execute!('dnf clean all') if find_package('dnf')
-        execute!('yum clean all') if find_package('yum')
       end
 
       def package_version(name)

data/lib/foreman_maintain/package_manager/base.rb

@@ -0,0 +1,71 @@
+module ForemanMaintain::PackageManager
+  # rubocop:disable Lint/UnusedMethodArgument
+  class Base
+    def foreman_related_packages
+      raise NotImplementedError
+    end
+
+    # list of packages providing the version locking
+    def version_locking_packages
+      raise NotImplementedError
+    end
+
+    # check tools are installed and enabled
+    def version_locking_enabled?
+      raise NotImplementedError
+    end
+
+    # make sure the version locking tools are configured
+    # we can assume it is already installed
+    def configure_version_locking
+      raise NotImplementedError
+    end
+
+    # are the packages installed on the system?
+    def installed?(packages)
+      raise NotImplementedError
+    end
+
+    # find installed package and return full nvra or nil
+    def find_installed_package(name)
+      raise NotImplementedError
+    end
+
+    # install package
+    def install(packages, assumeyes: false)
+      raise NotImplementedError
+    end
+
+    # update package
+    def update(packages = [], assumeyes: false)
+      raise NotImplementedError
+    end
+
+    # prevent listed packages from update
+    def lock_versions(package_list)
+      raise NotImplementedError
+    end
+
+    # allow all packages we previously locked to update
+    def unlock_versions
+      raise NotImplementedError
+    end
+
+    # check if packages are locked
+    def versions_locked?
+      raise NotImplementedError
+    end
+
+    # clean the package manager cache
+    def clean_cache
+      raise NotImplementedError
+    end
+
+    private
+
+    def sys
+      ForemanMaintain::Utils::SystemHelpers
+    end
+  end
+  # rubocop:enable Lint/UnusedMethodArgument
+end

data/lib/foreman_maintain/package_manager/dnf.rb

@@ -0,0 +1,17 @@
+module ForemanMaintain::PackageManager
+  class Dnf < Yum
+    def clean_cache
+      dnf_action('clean', 'all')
+      super
+    end
+
+    private
+
+    def dnf_action(action, packages, assumeyes: false)
+      yum_options = []
+      yum_options << '-y' if assumeyes
+      sys.execute!("dnf #{yum_options.join(' ')} #{action} #{packages.join(' ')}",
+                   :interactive => true)
+    end
+  end
+end

data/lib/foreman_maintain/package_manager/yum.rb

@@ -0,0 +1,126 @@
+module ForemanMaintain::PackageManager
+  class Yum < Base
+    VERSIONLOCK_START_CLAUSE = '## foreman-maintain - start'.freeze
+    VERSIONLOCK_END_CLAUSE = '## foreman-maintain - end'.freeze
+    VERSIONLOCK_CONFIG_FILE = '/etc/yum/pluginconf.d/versionlock.conf'.freeze
+    VERSIONLOCK_DEFAULT_LIST_FILE = '/etc/yum/pluginconf.d/versionlock.list'.freeze
+
+    def self.parse_envra(envra)
+      # envra format: 0:foreman-1.20.1.10-1.el7sat.noarch
+      parsed = envra.match(/\d*:?(?<name>.*)-[^-]+-[^-]+\.[^.]+/)
+      parsed ? Hash[parsed.names.zip(parsed.captures)].merge(:envra => envra) : nil
+    end
+
+    def foreman_related_packages
+      query = "repoquery -a --qf='%{envra} %{repo.id}' --search foreman-installer |head -n1"
+      foreman_repo = sys.execute(query).split[1]
+      query_installed = "repoquery -a --qf='%{envra}' --repoid='#{foreman_repo}'"
+      sys.execute(query_installed). split("\n").map do |pkg|
+        self.class.parse_envra(pkg)
+      end
+    end
+
+    def version_locking_packages
+      %w[yum-utils yum-plugin-versionlock]
+    end
+
+    def lock_versions(package_list)
+      unlock_versions
+      File.open(versionlock_file, 'a') do |f|
+        f.puts VERSIONLOCK_START_CLAUSE
+        f.puts '# The following packages are locked by foreman-maintain. Do not modify!'
+        package_list.each { |package| f.puts "#{package[:envra]}.*" }
+        f.puts '# End of list of packages locked by foreman-maintain'
+        f.puts VERSIONLOCK_END_CLAUSE
+      end
+    end
+
+    def unlock_versions
+      lock_file = versionlock_file
+      content = File.read(lock_file)
+      content = content.gsub(/#{VERSIONLOCK_START_CLAUSE}.*#{VERSIONLOCK_END_CLAUSE}\n/m, '')
+      File.open(lock_file, 'w') { |f| f.write content }
+    end
+
+    def versions_locked?
+      lock_file = versionlock_file
+      return false if lock_file.nil?
+      content = File.read(lock_file)
+      !!content.match(/#{VERSIONLOCK_START_CLAUSE}.*#{VERSIONLOCK_END_CLAUSE}\n/m)
+    end
+
+    def version_locking_enabled?
+      installed?(version_locking_packages) && versionlock_config =~ /^\s*enabled\s+=\s+1/ \
+        && File.exist?(versionlock_file)
+    end
+
+    # make sure the version locking tools are configured
+    #  enabled = 1
+    #  locklist = <list file>
+    # we can assume it is already installed
+    def configure_version_locking
+      config = versionlock_config
+      config += "\n" unless config[-1] == "\n"
+      enabled_re = /^\s*enabled\s*=.*$/
+      if enabled_re.match(config)
+        config = config.gsub(enabled_re, 'enabled = 1')
+      else
+        config += "enabled = 1\n"
+      end
+      unless config =~ /^\s*locklist\s*=.*$/
+        config += "locklist = #{VERSIONLOCK_DEFAULT_LIST_FILE}\n"
+      end
+      File.open(versionlock_config_file, 'w') { |file| file.puts config }
+      FileUtils.touch(versionlock_file)
+    end
+
+    def installed?(packages)
+      packages_list = [packages].flatten(1).map { |pkg| "'#{pkg}'" }.join(' ')
+      sys.execute?(%(rpm -q #{packages_list}))
+    end
+
+    def find_installed_package(name)
+      status, result = sys.execute_with_status(%(rpm -q '#{name}'))
+      if status == 0
+        result
+      end
+    end
+
+    def install(packages, assumeyes: false)
+      yum_action('install', packages, :assumeyes => assumeyes)
+    end
+
+    def update(packages = [], assumeyes: false)
+      yum_action('update', packages, :assumeyes => assumeyes)
+    end
+
+    def clean_cache
+      yum_action('clean', 'all')
+    end
+
+    private
+
+    def versionlock_config
+      File.exist?(versionlock_config_file) ? File.read(versionlock_config_file) : ''
+    end
+
+    def versionlock_config_file
+      VERSIONLOCK_CONFIG_FILE
+    end
+
+    def versionlock_file
+      result = versionlock_config.match(/^\s*locklist\s*=\s*(\S+)/)
+      result.nil? ? nil : File.expand_path(result.captures[0])
+    end
+
+    def yum_action(action, packages, assumeyes: false)
+      yum_options = []
+      packages = [packages].flatten(1)
+      yum_options << '-y' if assumeyes
+      yum_options_s = yum_options.empty? ? '' : ' ' + yum_options.join(' ')
+      packages_s = packages.empty? ? '' : ' ' + packages.join(' ')
+      sys.execute!("yum#{yum_options_s} #{action}#{packages_s}",
+                   :interactive => true)
+    end
+  end
+end

data/lib/foreman_maintain/package_manager.rb

@@ -0,0 +1,3 @@
+require 'foreman_maintain/package_manager/base'
+require 'foreman_maintain/package_manager/yum'
+require 'foreman_maintain/package_manager/dnf'

data/lib/foreman_maintain/reporter/cli_reporter.rb

@@ -317,7 +317,7 @@ module ForemanMaintain
 
           recommend << <<-MESSAGE.strip_heredoc
           The steps in warning state itself might not mean there is an error,
-          but it should be reviews to ensure the behavior is expected
+          but it should be reviewed to ensure the behavior is expected
           MESSAGE
         end
         puts((message + recommend).join("\n"))

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.2'.freeze
 end

data/lib/foreman_maintain.rb

@@ -37,6 +37,7 @@ module ForemanMaintain
   require 'foreman_maintain/reporter'
   require 'foreman_maintain/utils'
   require 'foreman_maintain/error'
+  require 'foreman_maintain/package_manager'
 
   class << self
     attr_accessor :config, :logger

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -151,6 +151,7 @@ files:
 - definitions/checks/root_user.rb
 - definitions/checks/services_up.rb
 - definitions/checks/system_registration.rb
+- definitions/checks/version_locking_enabled.rb
 - definitions/features/candlepin.rb
 - definitions/features/candlepin_database.rb
 - definitions/features/cron.rb
@@ -169,6 +170,7 @@ files:
 - definitions/features/iptables.rb
 - definitions/features/katello.rb
 - definitions/features/mongo.rb
+- definitions/features/package_manager.rb
 - definitions/features/pulp.rb
 - definitions/features/puppet_server.rb
 - definitions/features/service.rb
@@ -214,7 +216,11 @@ files:
 - definitions/procedures/iptables/remove_maintenance_mode_chain.rb
 - definitions/procedures/knowledge_base_article.rb
 - definitions/procedures/maintenance_mode/is_enabled.rb
+- definitions/procedures/packages/enable_version_locking.rb
 - definitions/procedures/packages/install.rb
+- definitions/procedures/packages/lock_versions.rb
+- definitions/procedures/packages/locking_status.rb
+- definitions/procedures/packages/unlock_versions.rb
 - definitions/procedures/packages/update.rb
 - definitions/procedures/passenger_recycler.rb
 - definitions/procedures/pulp/migrate.rb
@@ -257,6 +263,8 @@ files:
 - definitions/scenarios/upgrade_to_satellite_6_4_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_5.rb
 - definitions/scenarios/upgrade_to_satellite_6_5_z.rb
+- definitions/scenarios/upgrade_to_satellite_6_6.rb
+- definitions/scenarios/version_locking.rb
 - lib/foreman_maintain.rb
 - lib/foreman_maintain/check.rb
 - lib/foreman_maintain/cli.rb
@@ -271,6 +279,7 @@ files:
 - lib/foreman_maintain/cli/base.rb
 - lib/foreman_maintain/cli/health_command.rb
 - lib/foreman_maintain/cli/maintenance_mode_command.rb
+- lib/foreman_maintain/cli/packages_command.rb
 - lib/foreman_maintain/cli/restore_command.rb
 - lib/foreman_maintain/cli/service_command.rb
 - lib/foreman_maintain/cli/transform_clamp_options.rb
@@ -294,6 +303,10 @@ files:
 - lib/foreman_maintain/error.rb
 - lib/foreman_maintain/executable.rb
 - lib/foreman_maintain/feature.rb
+- lib/foreman_maintain/package_manager.rb
+- lib/foreman_maintain/package_manager/base.rb
+- lib/foreman_maintain/package_manager/dnf.rb
+- lib/foreman_maintain/package_manager/yum.rb
 - lib/foreman_maintain/param.rb
 - lib/foreman_maintain/procedure.rb
 - lib/foreman_maintain/reporter.rb
@@ -344,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt