foreman_maintain 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f23ac8f61f67d6c71e3a31156f0267e724b62386f951e02ed4272276be5007
-  data.tar.gz: b4cc1198b259cbb1b074a2622caac177e7d93571cb3cb2f3d2d3630adaab205f
+  metadata.gz: ed8b16b2a22acb7bf2e2768976f2df46eb6a1b51b883904cbee0bb180869c5a4
+  data.tar.gz: 46473f96dba47ffc94f08fbb15fa031073852cdc234c8c701d5568a7727d269d
 SHA512:
-  metadata.gz: 21bfdc38c8d3a3a710aedb2e114bb0616e854b1144af15ede8ce0b326938662620e32117947f13c6eacff88b3ed5bc2076d403bb147310722c0110b71828d297
-  data.tar.gz: a232dd4b4ac70ad534fe4310a55382c89cfaf65b61a8afd3f850961c0ce84012810f91e577394c14d2fcaa2df2bc127b2d494312b3c8f31b3458031ef438add7
+  metadata.gz: 76da2fe52b25ac48af18295caaa92dad1e2cb106a8aaded53adc02804da1ef2c021a6d336e10e4abea87d6aed1f9950a9b994cc6dba075b8b116a31ea9c6b706
+  data.tar.gz: d25955e6f87bfb863d050935bf4ed253c2afa55e1552ec17edcc76500c6d563d7fe318b84d68877c942c63facdd3c93d973591df5e93fedd9fd445a4ff4c845a

data/definitions/checks/candlepin/db_up.rb

@@ -9,15 +9,19 @@ module Checks
 
       def run
         status = false
-        with_spinner('Checking connection to the Candlepin DB') do
-          status = feature(:candlepin_database).ping
+        if feature(:candlepin_database).psql_cmd_available?
+          with_spinner('Checking connection to the Candlepin DB') do
+            status = feature(:candlepin_database).ping
+          end
+          assert(status, 'Candlepin DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+                 :next_steps => start_pgsql)
+        else
+          feature(:candlepin_database).raise_psql_missing_error
         end
-        assert(status, 'Candlepin DB is not responding. ' \
-          'It needs to be up and running to perform the following steps',
-               :next_steps => next_steps)
       end
 
-      def next_steps
+      def start_pgsql
         if feature(:candlepin_database).local?
           [Procedures::Service::Start.new(:only => 'postgresql')]
         else

data/definitions/checks/foreman/db_up.rb

@@ -9,15 +9,19 @@ module Checks
 
       def run
         status = false
-        with_spinner('Checking connection to the Foreman DB') do
-          status = feature(:foreman_database).ping
+        if feature(:foreman_database).psql_cmd_available?
+          with_spinner('Checking connection to the Foreman DB') do
+            status = feature(:foreman_database).ping
+          end
+          assert(status, 'Foreman DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+                 :next_steps => start_pgsql)
+        else
+          feature(:foreman_database).raise_psql_missing_error
         end
-        assert(status, 'Foreman DB is not responding. ' \
-          'It needs to be up and running to perform the following steps',
-               :next_steps => next_steps)
       end
 
-      def next_steps
+      def start_pgsql
         if feature(:foreman_database).local?
           [Procedures::Service::Start.new(:only => 'postgresql')]
         else

data/definitions/checks/mongo/db_up.rb

@@ -9,15 +9,19 @@ module Checks
 
       def run
         status = false
-        with_spinner('Checking connection to the Mongo DB') do
-          status = feature(:mongo).ping
+        if feature(:mongo).mongo_cmd_available?
+          with_spinner('Checking connection to the Mongo DB') do
+            status = feature(:mongo).ping
+          end
+          assert(status, 'Mongo DB is not responding. ' \
+            'It needs to be up and running to perform the following steps.',
+                 :next_steps => start_mongodb)
+        else
+          feature(:mongo).raise_mongo_client_missing_error
         end
-        assert(status, 'Mongo DB is not responding. ' \
-          'It needs to be up and running to perform the following steps.',
-               :next_steps => next_steps)
       end
 
-      def next_steps
+      def start_mongodb
         if feature(:mongo).local?
           [Procedures::Service::Start.new(:only => feature(:mongo).services)]
         else

data/definitions/features/foreman_tasks.rb

@@ -97,10 +97,10 @@ class Features::ForemanTasks < ForemanMaintain::Feature
   end
 
   def resume_task_using_hammer
-    if check_min_version('satellite', '6.8')
-      feature(:hammer).run('task resume --search ""')
+    if feature(:satellite) && feature(:satellite).current_minor_version == '6.8'
+      feature(:hammer).run('task resume --search "" --fields="Total tasks resumed"')
     else
-      feature(:hammer).run('task resume')
+      feature(:hammer).run('task resume --fields="Total tasks resumed"')
     end
   end
 

data/definitions/features/katello.rb

@@ -16,9 +16,14 @@ class Features::Katello < ForemanMaintain::Feature
   end
 
   def services
-    [
-      system_service('elasticsearch', 30)
-    ]
+    if feature(:pulp2)
+      []
+    else
+      [
+        system_service('qpidd', 10),
+        system_service('qdrouterd', 10)
+      ]
+    end
   end
 
   # rubocop:disable  Metrics/MethodLength

data/definitions/features/mongo.rb

@@ -140,6 +140,16 @@ class Features::Mongo < ForemanMaintain::Feature
     end
   end
 
+  def mongo_cmd_available?
+    exit_status, _output = execute_with_status('which mongo')
+    exit_status == 0
+  end
+
+  def raise_mongo_client_missing_error
+    raise ForemanMaintain::Error::Fail, 'The mongo command not found.'\
+                                  ' Make sure system has mongo utility installed.'
+  end
+
   private
 
   def load_mongo_core_default(version)

data/definitions/features/pulp2.rb

@@ -5,7 +5,7 @@ class Features::Pulp < ForemanMaintain::Feature
     label :pulp2
 
     confine do
-      find_package('pulp-server')
+      find_package('pulp-server') && !check_min_version('katello-common', '4.0')
     end
   end
 

data/definitions/features/service.rb

@@ -8,7 +8,6 @@ class Features::Service < ForemanMaintain::Feature
     # { :only => ["httpd"] }
     # { :exclude => ["pulp-workers", "tomcat"] }
     # { :include => ["crond"] }
-
     if feature(:instance).downstream && feature(:instance).downstream.less_than_version?('6.3')
       use_katello_service(action, options)
     else
@@ -26,12 +25,14 @@ class Features::Service < ForemanMaintain::Feature
       select(&:exist?)
   end
 
-  def filtered_services(options)
-    service_list = include_unregistered_services(existing_services, options[:include])
-    service_list = filter_services(service_list, options)
-    raise 'No services found matching your parameters' unless service_list.any?
+  def filtered_services(options, action = '')
+    services = include_unregistered_services(existing_services, options[:include])
+    services = filter_services(services, options, action)
+
+    raise 'No services found matching your parameters' unless services.any?
+    return services unless options[:reverse]
 
-    options[:reverse] ? service_list.reverse : service_list
+    Hash[services.sort_by { |k, _| k.to_i }.reverse]
   end
 
   def action_noun(action)
@@ -61,22 +62,31 @@ class Features::Service < ForemanMaintain::Feature
   def run_action_on_services(action, options, spinner)
     status = 0
     failed_services = []
-
-    filtered_services(options).each do |service|
-      spinner.update("#{action_noun(action)} #{service}")
-      item_status, output = service.send(action.to_sym)
-
-      formatted = format_status(output, item_status, options)
-      puts formatted unless formatted.empty?
-
-      if item_status > 0
-        status = item_status
-        failed_services << service
+    filtered_services(options, action).each_value do |group|
+      fork_threads_for_services(action, group, spinner).each do |service, status_and_output|
+        spinner.update("#{action_noun(action)} #{service}") if action == 'status'
+        item_status, output = status_and_output
+        formatted = format_status(output, item_status, options)
+        puts formatted unless formatted.empty?
+
+        if item_status > 0
+          status = item_status
+          failed_services << service
+        end
       end
     end
     [status, failed_services]
   end
 
+  def fork_threads_for_services(action, services, spinner)
+    services_and_statuses = []
+    services.each do |service|
+      spinner.update("#{action_noun(action)} #{service}") if action != 'status'
+      services_and_statuses << [service, Thread.new { service.send(action.to_sym) }]
+    end
+    services_and_statuses.map! { |service, status| [service, status.value] }
+  end
+
   def format_status(output, exit_code, options)
     status = ''
     if !options[:failing] || exit_code > 0
@@ -106,7 +116,8 @@ class Features::Service < ForemanMaintain::Feature
     service_list + socket_list
   end
 
-  def filter_services(service_list, options)
+  # rubocop:disable Metrics/AbcSize
+  def filter_services(service_list, options, action)
     if options[:only] && options[:only].any?
       service_list = service_list.select do |service|
         options[:only].any? { |opt| service.matches?(opt) }
@@ -119,7 +130,16 @@ class Features::Service < ForemanMaintain::Feature
     end
 
     service_list = extend_service_list_with_sockets(service_list, options)
-    service_list.sort
+    service_list = filter_disabled_services!(action, service_list)
+    service_list.group_by(&:priority).to_h
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def filter_disabled_services!(action, service_list)
+    if %w[start stop restart status].include?(action)
+      service_list.select!(&:enabled?)
+    end
+    service_list
   end
 
   def include_unregistered_services(service_list, services_filter)

data/definitions/procedures/content/migration_reset.rb

@@ -0,0 +1,12 @@
+module Procedures::Content
+  class MigrationReset < ForemanMaintain::Procedure
+    metadata do
+      description 'Reset the Pulp 2 to Pulp 3 migration data (pre-switchover)'
+      for_feature :pulpcore
+    end
+
+    def run
+      puts execute!('foreman-rake katello:pulp3_migration_reset')
+    end
+  end
+end

data/definitions/procedures/content/switchover.rb

@@ -19,8 +19,11 @@ module Procedures::Content
       puts execute!('foreman-rake katello:pulp3_content_switchover')
       puts 'Re-running the installer to switch specified content over to pulp3'
       args = ['--foreman-proxy-content-proxy-pulp-isos-to-pulpcore=true',
+              '--foreman-proxy-content-proxy-pulp-yum-to-pulpcore=true',
+              '--foreman-proxy-content-proxy-pulp-deb-to-pulpcore=true',
               '--katello-use-pulp-2-for-file=false',
               '--katello-use-pulp-2-for-docker=false',
+              '--katello-use-pulp-2-for-deb=false',
               '--katello-use-pulp-2-for-yum=false']
       feature(:installer).run(args.join(' '))
     end

data/definitions/procedures/pulp/remove.rb

@@ -0,0 +1,87 @@
+module Procedures::Pulp
+  class Remove < ForemanMaintain::Procedure
+    metadata do
+      description 'Remove pulp2'
+
+      confine do
+        check_min_version('katello-common', '4.0')
+      end
+    end
+
+    def sys
+      ForemanMaintain::Utils::SystemHelpers.new
+    end
+
+    def pulp_data_dirs
+      [
+        '/var/lib/pulp/published',
+        '/var/lib/pulp/content',
+        '/var/lib/pulp/importers',
+        '/var/lib/pulp/uploads',
+        '/var/lib/mongodb/'
+      ]
+    end
+
+    def pulp_packages
+      [
+        'pulp-server', 'python-pulp-streamer', 'pulp-puppet-plugins',
+        'python-pulp-rpm-common', 'python-pulp-common',
+        'pulp-selinux', 'python-pulp-oid_validation',
+        'python-pulp-puppet-common', 'python-pulp-repoauth',
+        'pulp-rpm-plugins', 'python-blinker', 'python-celery',
+        'python-django', 'python-isodate', 'python-ldap',
+        'python-mongoengine', 'python-nectar', 'python-oauth2',
+        'python-pymongo'
+      ]
+    end
+
+    def data_dir_removal_cmds
+      pulp_data_dirs.collect { |dir| "rm -rf #{dir}" }
+    end
+
+    def ask_to_proceed(rm_cmds)
+      question = "\nWARNING: All pulp2 packages will be removed with the following commands:\n" \
+        "\n# yum remove #{pulp_packages.join('  ')}" \
+        "\n# yum remove rh-mongodb34-*" \
+        "\n\nAll pulp2 data will be removed.\n"
+      question += rm_cmds.collect { |cmd| "\n# #{cmd}" }.join
+      question += "\n\nDo you want to proceed?"
+      answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
+      abort! if answer != :yes
+    end
+
+    def run
+      rm_cmds = data_dir_removal_cmds
+      ask_to_proceed(rm_cmds)
+
+      remove_pulp
+
+      remove_mongo
+
+      delete_pulp_data(rm_cmds)
+    end
+
+    def remove_pulp
+      with_spinner('Removing pulp2 packages') do
+        packages_action(:remove, pulp_packages, :assumeyes => true)
+      end
+    end
+
+    def remove_mongo
+      with_spinner('Removing mongo packages') do
+        packages_action(:remove, ['rh-mongodb34-*'], :assumeyes => true)
+      end
+    end
+
+    def delete_pulp_data(rm_cmds)
+      with_spinner('Deleting pulp2 data directories') do |spinner|
+        rm_cmds.each do |cmd|
+          if File.directory?(cmd.split[2])
+            execute!(cmd)
+          end
+        end
+        spinner.update('Done deleting pulp2 data directories')
+      end
+    end
+  end
+end

data/definitions/procedures/service/base.rb

@@ -16,9 +16,8 @@ module Procedures
       def run_service_action(action, options)
         action_noun = feature(:service).action_noun(action).capitalize
         puts "\n#{action_noun} the following service(s):"
-        services = feature(:service).filtered_services(options)
+        services = feature(:service).filtered_services(options, action)
         print_services(services)
-
         with_spinner('') do |spinner|
           feature(:service).handle_services(spinner, action, options)
         end
@@ -31,7 +30,7 @@ module Procedures
       private
 
       def print_services(services)
-        puts services.map(&:to_s).join(', ')
+        puts services.values.flatten(1).join(', ')
       end
     end
   end

data/definitions/procedures/service/list.rb

@@ -9,6 +9,7 @@ module Procedures::Service
 
     def run
       services = feature(:service).filtered_services(common_options)
+      services = services.values.flatten(1)
       unit_files = unit_files_list(services)
       puts unit_files + "\n"
       puts 'All services listed'

data/definitions/scenarios/content.rb

@@ -1,6 +1,23 @@
 module ForemanMaintain::Scenarios
   module Content
-    class Prepare < ForemanMaintain::Scenario
+    class ContentBase < ForemanMaintain::Scenario
+      def enable_and_start_services
+        add_step(Procedures::Service::Start)
+        add_step(Procedures::Service::Enable.
+                 new(:only => Features::Pulpcore.pulpcore_migration_services))
+        add_step(Procedures::Service::Start.
+                 new(:only => Features::Pulpcore.pulpcore_migration_services))
+      end
+
+      def disable_and_stop_services
+        add_step(Procedures::Service::Stop.
+                 new(:only => Features::Pulpcore.pulpcore_migration_services))
+        add_step(Procedures::Service::Disable.
+                 new(:only => Features::Pulpcore.pulpcore_migration_services))
+      end
+    end
+
+    class Prepare < ContentBase
       metadata do
         label :content_prepare
         description 'Prepare content for Pulp 3'
@@ -16,26 +33,9 @@ module ForemanMaintain::Scenarios
           add_step(Procedures::Content::Prepare)
         end
       end
-
-      private
-
-      def enable_and_start_services
-        add_step(Procedures::Service::Start)
-        add_step(Procedures::Service::Enable.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-        add_step(Procedures::Service::Start.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-      end
-
-      def disable_and_stop_services
-        add_step(Procedures::Service::Stop.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-        add_step(Procedures::Service::Disable.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-      end
     end
 
-    class Switchover < ForemanMaintain::Scenario
+    class Switchover < ContentBase
       metadata do
         label :content_switchover
         description 'Switch support for certain content from Pulp 2 to Pulp 3'
@@ -51,7 +51,7 @@ module ForemanMaintain::Scenarios
       end
     end
 
-    class PrepareAbort < ForemanMaintain::Scenario
+    class PrepareAbort < ContentBase
       metadata do
         label :content_prepare_abort
         description 'Abort all running Pulp 2 to Pulp 3 migration tasks'
@@ -65,7 +65,7 @@ module ForemanMaintain::Scenarios
       end
     end
 
-    class MigrationStats < ForemanMaintain::Scenario
+    class MigrationStats < ContentBase
       metadata do
         label :content_migration_stats
         description 'Retrieve Pulp 2 to Pulp 3 migration statistics'
@@ -78,5 +78,35 @@ module ForemanMaintain::Scenarios
         end
       end
     end
+
+    class MigrationReset < ContentBase
+      metadata do
+        label :content_migration_reset
+        description 'Reset the Pulp 2 to Pulp 3 migration data (pre-switchover)'
+        manual_detection
+      end
+
+      def compose
+        if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
+          enable_and_start_services
+          add_step(Procedures::Content::MigrationReset)
+          disable_and_stop_services
+        elsif !feature(:satellite)
+          add_step(Procedures::Content::MigrationReset)
+        end
+      end
+    end
+
+    class RemovePulp2 < ContentBase
+      metadata do
+        label :content_remove_pulp2
+        description 'Remove Pulp2 and mongodb packages and data'
+        manual_detection
+      end
+
+      def compose
+        add_step_with_context(Procedures::Pulp::Remove)
+      end
+    end
   end
 end

data/definitions/scenarios/restore.rb

@@ -103,7 +103,7 @@ module ForemanMaintain::Scenarios
 
   class RestoreRescue < ForemanMaintain::Scenario
     metadata do
-      description 'Resuce Restore backup'
+      description 'Rescue Restore backup'
       manual_detection
     end
 

data/lib/foreman_maintain/cli/content_command.rb

@@ -27,6 +27,18 @@ module ForemanMaintain
           run_scenarios_and_exit(Scenarios::Content::MigrationStats.new)
         end
       end
+
+      subcommand 'migration-reset', 'Reset the Pulp 2 to Pulp 3 migration data (pre-switchover)' do
+        def execute
+          run_scenarios_and_exit(Scenarios::Content::MigrationReset.new)
+        end
+      end
+
+      subcommand 'remove-pulp2', 'Remove pulp2 and mongodb packages and data' do
+        def execute
+          run_scenarios_and_exit(Scenarios::Content::RemovePulp2.new)
+        end
+      end
     end
   end
 end

data/lib/foreman_maintain/concerns/base_database.rb

@@ -119,6 +119,7 @@ module ForemanMaintain
         SQL
         result = query(sql)
         return false if result.nil? || (result && result.empty?)
+
         result.first['exists'].eql?('t')
       end
 
@@ -161,6 +162,16 @@ module ForemanMaintain
         end
       end
 
+      def psql_cmd_available?
+        exit_status, _output = execute_with_status('which psql')
+        exit_status == 0
+      end
+
+      def raise_psql_missing_error
+        raise Error::Fail, 'The psql command not found.'\
+                ' Make sure system has psql utility installed.'
+      end
+
       private
 
       def base_command(config, command = 'psql')

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.7.5'.freeze
+  VERSION = '0.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -222,6 +222,7 @@ files:
 - definitions/procedures/backup/snapshot/mount_pulpcore_db.rb
 - definitions/procedures/backup/snapshot/prepare_mount.rb
 - definitions/procedures/candlepin/delete_orphaned_records_from_env_content.rb
+- definitions/procedures/content/migration_reset.rb
 - definitions/procedures/content/migration_stats.rb
 - definitions/procedures/content/prepare.rb
 - definitions/procedures/content/prepare_abort.rb
@@ -259,6 +260,7 @@ files:
 - definitions/procedures/passenger_recycler.rb
 - definitions/procedures/prep_6_10_upgrade.rb
 - definitions/procedures/pulp/migrate.rb
+- definitions/procedures/pulp/remove.rb
 - definitions/procedures/pulpcore/migrate.rb
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
 - definitions/procedures/remote_execution/remove_existing_settingsd.rb
@@ -416,7 +418,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt