foreman_maintain 0.3.6 → 0.4.1

data/definitions/scenarios/maintenance_mode.rb

@@ -0,0 +1,53 @@
+module ForemanMaintain::Scenarios
+  class MaintenanceModeStart < ForemanMaintain::Scenario
+    metadata do
+      description 'Start maintenance-mode'
+      tags :maintenance_mode_start
+      label :maintenance_mode_start
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_procedures(:maintenance_mode_on))
+    end
+  end
+
+  class MaintenanceModeStop < ForemanMaintain::Scenario
+    metadata do
+      description 'Stop maintenance-mode'
+      tags :maintenance_mode_stop
+      label :maintenance_mode_stop
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_procedures(:maintenance_mode_off))
+    end
+  end
+
+  class MaintenanceModeStatus < ForemanMaintain::Scenario
+    metadata do
+      description 'Status of maintenance-mode'
+      tags :maintenance_mode_status
+      label :maintenance_mode_status
+      manual_detection
+    end
+
+    def compose
+      add_step(Checks::MaintenanceMode::CheckConsistency)
+    end
+  end
+
+  class IsMaintenanceMode < ForemanMaintain::Scenario
+    metadata do
+      description 'Show only status code of maintenance-mode'
+      tags :is_maintenance_mode_enabled
+      label :is_maintenance_mode_enabled
+      manual_detection
+    end
+
+    def compose
+      add_step(Procedures::MaintenanceMode::IsEnabled.new)
+    end
+  end
+end

data/lib/foreman_maintain.rb

@@ -19,6 +19,7 @@ module ForemanMaintain
   require 'foreman_maintain/concerns/system_service'
   require 'foreman_maintain/concerns/hammer'
   require 'foreman_maintain/concerns/base_database'
+  require 'foreman_maintain/concerns/directory_marker'
   require 'foreman_maintain/top_level_modules'
   require 'foreman_maintain/yaml_storage'
   require 'foreman_maintain/config'

data/lib/foreman_maintain/cli.rb

@@ -8,6 +8,7 @@ require 'foreman_maintain/cli/backup_command'
 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'
 
 module ForemanMaintain
   module Cli
@@ -20,6 +21,8 @@ module ForemanMaintain
       subcommand 'backup', 'Backup server', BackupCommand
       subcommand 'restore', 'Restore a backup', RestoreCommand
       subcommand 'advanced', 'Advanced tools for server maintenance', AdvancedCommand
+      subcommand 'maintenance-mode', 'Control maintenance-mode for application',
+                 MaintenanceModeCommand
 
       def run(*arguments)
         logger.info("Running foreman-maintain command with arguments #{arguments.inspect}")

data/lib/foreman_maintain/cli/base.rb

@@ -7,6 +7,23 @@ module ForemanMaintain
 
       attr_reader :runner
 
+      class << self
+        include Concerns::Logger
+
+        def subcommand(name, description, subcommand_class = self, &block)
+          add_command = true
+          if subcommand_class.superclass == ForemanMaintain::Cli::Base
+            sc = subcommand_class.to_s
+            sc.slice!('ForemanMaintain::Cli::')
+            if ForemanMaintain.config.disable_commands.include? sc
+              logger.info("Disable command #{sc}")
+              add_command = false
+            end
+          end
+          super if add_command
+        end
+      end
+
       def self.dashize(string)
         string.to_s.tr('_', '-')
       end

data/lib/foreman_maintain/cli/maintenance_mode_command.rb

@@ -0,0 +1,50 @@
+module ForemanMaintain
+  module Cli
+    class MaintenanceModeCommand < Base
+      extend Concerns::Finders
+
+      subcommand 'start', 'Start maintenance-mode' do
+        def execute
+          scenario = Scenarios::MaintenanceModeStart.new
+          run_scenario(scenario)
+          exit runner.exit_code
+        end
+      end
+
+      subcommand 'stop', 'Stop maintenance-mode' do
+        def execute
+          scenario = Scenarios::MaintenanceModeStop.new
+          run_scenario(scenario)
+          exit runner.exit_code
+        end
+      end
+
+      subcommand 'status', 'Get maintenance-mode status' do
+        def execute
+          scenario = Scenarios::MaintenanceModeStatus.new
+          run_scenario(scenario)
+          exit runner.exit_code
+        end
+      end
+
+      subcommand 'is-enabled', 'Get maintenance-mode status code' do
+        def execute
+          scenario = Scenarios::IsMaintenanceMode.new
+          run_scenario(scenario)
+          procedure_used = fetch_procedure(scenario, Procedures::MaintenanceMode::IsEnabled)
+          puts procedure_used.status_code
+
+          if procedure_used.status_code == 1
+            exit procedure_used.status_code
+          else
+            exit runner.exit_code
+          end
+        end
+
+        def fetch_procedure(scenario, procedure_class_name)
+          scenario.steps.find { |procedure| procedure.class.eql?(procedure_class_name) }
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/concerns/directory_marker.rb

@@ -0,0 +1,35 @@
+module ForemanMaintain
+  module Concerns
+    module DirectoryMarker
+      def with_marked_directory(directory)
+        mark_directory(directory)
+        yield
+        unmark_directory(directory)
+      end
+
+      def find_marked_directory(directory)
+        find_dir_containing_file(directory, mark_name)
+      end
+
+      def mark_name
+        cls = self.class.name.split('::').last.downcase
+        ".#{cls}_directory_mark"
+      end
+
+      private
+
+      def unmark_directory(directory)
+        filename = mark_file_path(directory)
+        File.delete(filename) if File.exist?(filename)
+      end
+
+      def mark_directory(directory)
+        File.open(mark_file_path(directory), 'a') {}
+      end
+
+      def mark_file_path(directory)
+        File.join(directory, mark_name)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/concerns/system_service.rb

@@ -1,9 +1,13 @@
 module ForemanMaintain
   module Concerns
     module SystemService
-      def system_service(name, priority, options = {})
+      def system_service(name, priority = 50, options = {})
         ForemanMaintain::Utils.system_service(name, priority, options)
       end
+
+      def valid_sys_service?(service)
+        ForemanMaintain::Utils.valid_sys_service?(service)
+      end
     end
   end
 end

data/lib/foreman_maintain/config.rb

@@ -4,7 +4,7 @@ module ForemanMaintain
     attr_accessor :pre_setup_log_messages,
                   :config_file, :definitions_dirs, :log_level, :log_dir, :log_file_size,
                   :log_filename, :storage_file, :backup_dir, :foreman_proxy_cert_path,
-                  :db_backup_dir, :completion_cache_file
+                  :db_backup_dir, :completion_cache_file, :disable_commands, :manage_crond
 
     def initialize(options)
       @pre_setup_log_messages = []
@@ -14,10 +14,12 @@ module ForemanMaintain
                                          [File.join(source_path, 'definitions')])
       load_log_configs
       load_backup_dir_paths
+      load_cron_option
       @foreman_proxy_cert_path = @options.fetch(:foreman_proxy_cert_path, '/etc/foreman')
       @completion_cache_file = File.expand_path(
         @options.fetch(:completion_cache_file, '~/.cache/foreman_maintain_completion.yml')
       )
+      @disable_commands = @options.fetch(:disable_commands, [])
     end
 
     private
@@ -41,6 +43,11 @@ module ForemanMaintain
       )
     end
 
+    def load_cron_option
+      opt_val = @options.fetch(:manage_crond, false)
+      @manage_crond = boolean?(opt_val) ? opt_val : false
+    end
+
     def load_config
       if File.exist?(config_file)
         YAML.load(File.open(config_file)) || {}
@@ -71,5 +78,9 @@ module ForemanMaintain
       end
       dir_path
     end
+
+    def boolean?(value)
+      [true, false].include? value
+    end
   end
 end

data/lib/foreman_maintain/param.rb

@@ -3,7 +3,8 @@ module ForemanMaintain
     attr_reader :name, :description, :options
 
     def initialize(name, description, options, &block)
-      options.validate_options!(:description, :required, :flag, :array, :allowed_values, :default)
+      options.validate_options!(:description, :required, :flag, :array,
+                                :allowed_values, :default)
       @name = name
       @description = description || options[:description] || ''
       @options = options

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 reviewed to ensure the behavior is expected
+          but it should be reviews to ensure the behavior is expected
           MESSAGE
         end
         puts((message + recommend).join("\n"))

data/lib/foreman_maintain/utils/command_runner.rb

@@ -13,7 +13,7 @@ module ForemanMaintain
         @logger = logger
         @command = command
         @stdin = options[:stdin]
-        @hidden_patterns = Array(options[:hidden_patterns])
+        @hidden_patterns = Array(options[:hidden_patterns]).compact
         @interactive = options[:interactive]
         @options = options
         @valid_exit_statuses = options[:valid_exit_statuses]

data/lib/foreman_maintain/utils/service.rb

@@ -11,4 +11,8 @@ module ForemanMaintain::Utils
       Service::Systemd.new(name, priority, options)
     end
   end
+
+  def self.valid_sys_service?(service)
+    service.class < Service::Abstract
+  end
 end

data/lib/foreman_maintain/utils/service/systemd.rb

@@ -44,7 +44,7 @@ module ForemanMaintain::Utils
           systemd = @sys.execute("systemctl is-enabled #{@name} 2>&1 | tail -1").strip
           systemd == 'enabled' || systemd == 'disabled'
         else
-          File.exist?("/etc/init.d/#{service}")
+          File.exist?("/etc/init.d/#{@name}")
         end
       end
 

data/lib/foreman_maintain/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -123,6 +123,8 @@ files:
 - definitions/checks/candlepin/db_up.rb
 - definitions/checks/candlepin/validate_db.rb
 - definitions/checks/check_epel_repository.rb
+- definitions/checks/check_hotfix_installed.rb
+- definitions/checks/check_tmout.rb
 - definitions/checks/disk/available_space.rb
 - definitions/checks/disk/performance.rb
 - definitions/checks/foreman/check_corrupted_roles.rb
@@ -136,10 +138,13 @@ files:
 - definitions/checks/foreman_tasks/not_paused.rb
 - definitions/checks/foreman_tasks/not_running.rb
 - definitions/checks/hammer_ping.rb
+- definitions/checks/maintenance_mode/check_consistency.rb
 - definitions/checks/mongo/db_up.rb
 - definitions/checks/mongo/tools_installed.rb
 - definitions/checks/puppet/provide_upgrade_guide.rb
+- definitions/checks/puppet/verify_no_empty_cacert_requests.rb
 - definitions/checks/remote_execution/verify_settings_file_already_exists.rb
+- definitions/checks/repositories/check_upstream_repository.rb
 - definitions/checks/repositories/validate.rb
 - definitions/checks/restore/validate_backup.rb
 - definitions/checks/restore/validate_hostname.rb
@@ -148,6 +153,7 @@ files:
 - definitions/checks/system_registration.rb
 - definitions/features/candlepin.rb
 - definitions/features/candlepin_database.rb
+- definitions/features/cron.rb
 - definitions/features/downstream.rb
 - definitions/features/foreman_1_11_x.rb
 - definitions/features/foreman_1_7_x.rb
@@ -160,13 +166,14 @@ files:
 - definitions/features/hammer.rb
 - definitions/features/installer.rb
 - definitions/features/instance.rb
+- definitions/features/iptables.rb
 - definitions/features/katello.rb
 - definitions/features/mongo.rb
 - definitions/features/pulp.rb
-- definitions/features/puppet.rb
 - definitions/features/puppet_server.rb
 - definitions/features/service.rb
 - definitions/features/sync_plans.rb
+- definitions/features/system_repos.rb
 - definitions/features/tar.rb
 - definitions/features/upstream.rb
 - definitions/procedures/backup/accessibility_confirmation.rb
@@ -193,6 +200,8 @@ files:
 - definitions/procedures/backup/snapshot/mount_pulp.rb
 - definitions/procedures/backup/snapshot/prepare_mount.rb
 - definitions/procedures/candlepin/delete_orphaned_records_from_env_content.rb
+- definitions/procedures/crond/start.rb
+- definitions/procedures/crond/stop.rb
 - definitions/procedures/foreman/fix_corrupted_roles.rb
 - definitions/procedures/foreman_openscap/invalid_report_associations.rb
 - definitions/procedures/foreman_tasks/delete.rb
@@ -201,14 +210,17 @@ files:
 - definitions/procedures/foreman_tasks/ui_investigate.rb
 - definitions/procedures/hammer_setup.rb
 - definitions/procedures/installer/upgrade.rb
+- definitions/procedures/iptables/add_maintenance_mode_chain.rb
+- definitions/procedures/iptables/remove_maintenance_mode_chain.rb
 - definitions/procedures/knowledge_base_article.rb
-- definitions/procedures/maintenance_mode/disable.rb
-- definitions/procedures/maintenance_mode/enable.rb
+- definitions/procedures/maintenance_mode/is_enabled.rb
 - definitions/procedures/packages/install.rb
 - definitions/procedures/packages/update.rb
 - definitions/procedures/passenger_recycler.rb
 - definitions/procedures/pulp/migrate.rb
+- definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
 - definitions/procedures/remote_execution/remove_existing_settingsd.rb
+- definitions/procedures/repositories/disable.rb
 - definitions/procedures/repositories/setup.rb
 - definitions/procedures/restore/candlepin_dump.rb
 - definitions/procedures/restore/configs.rb
@@ -234,6 +246,7 @@ files:
 - definitions/procedures/sync_plans/disable.rb
 - definitions/procedures/sync_plans/enable.rb
 - definitions/scenarios/backup.rb
+- definitions/scenarios/maintenance_mode.rb
 - definitions/scenarios/restore.rb
 - definitions/scenarios/services.rb
 - definitions/scenarios/upgrade_to_satellite_6_2.rb
@@ -257,11 +270,13 @@ files:
 - lib/foreman_maintain/cli/backup_command.rb
 - 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/restore_command.rb
 - lib/foreman_maintain/cli/service_command.rb
 - lib/foreman_maintain/cli/transform_clamp_options.rb
 - lib/foreman_maintain/cli/upgrade_command.rb
 - lib/foreman_maintain/concerns/base_database.rb
+- lib/foreman_maintain/concerns/directory_marker.rb
 - lib/foreman_maintain/concerns/finders.rb
 - lib/foreman_maintain/concerns/hammer.rb
 - lib/foreman_maintain/concerns/logger.rb
@@ -329,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt

data/definitions/features/puppet.rb

@@ -1,23 +0,0 @@
-class Features::Puppet < ForemanMaintain::Feature
-  metadata do
-    label :puppet
-
-    confine do
-      find_package('puppetserver')
-    end
-  end
-
-  def config_files
-    [
-      '/etc/puppet',
-      '/etc/puppetlabs',
-      '/opt/puppetlabs/puppet/cache/foreman_cache_data',
-      '/var/lib/puppet/foreman_cache_data',
-      '/opt/puppetlabs/puppet/ssl/',
-      '/var/lib/puppet/ssl',
-      '/var/lib/puppet',
-      '/usr/share/ruby/vendor_ruby/puppet/reports/foreman.rb',
-      '/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/reports/foreman.rb'
-    ]
-  end
-end