foreman_maintain 0.0.2 → 0.0.3

data/lib/foreman_maintain/runner/execution.rb

@@ -3,6 +3,8 @@ module ForemanMaintain
     # Class representing an execution of a single step in scenario
     class Execution
       include Concerns::Logger
+      extend Forwardable
+      def_delegators :@reporter, :with_spinner, :puts, :print, :ask, :assumeyes?
 
       # Step performed as part of the execution
       attr_reader :step
@@ -16,6 +18,8 @@ module ForemanMaintain
       # Output of the execution, to be filled by execution step
       attr_accessor :output
 
+      attr_reader :reporter
+
       def initialize(step, reporter)
         @step = step
         @reporter = reporter
@@ -35,6 +39,10 @@ module ForemanMaintain
         @status == :fail
       end
 
+      def warning?
+        @status == :warning
+      end
+
       def run
         @status = :running
         @reporter.before_execution_starts(self)

data/lib/foreman_maintain/scenario.rb

@@ -8,13 +8,14 @@ module ForemanMaintain
     attr_reader :steps
 
     class FilteredScenario < Scenario
-      manual_detection
+      metadata { manual_detection }
+
       attr_reader :filter_label, :filter_tags
 
       def initialize(filter)
         @filter_tags = filter[:tags]
         @filter_label = filter[:label]
-        @steps = ForemanMaintain.available_checks(filter)
+        @steps = ForemanMaintain.available_checks(filter).map(&:ensure_instance)
       end
 
       def description
@@ -36,6 +37,23 @@ module ForemanMaintain
       end
     end
 
+    class PreparationScenario < Scenario
+      metadata do
+        manual_detection
+        description 'preparation steps required to run the next scenarios'
+      end
+
+      attr_reader :main_scenario
+
+      def initialize(main_scenario)
+        @main_scenario = main_scenario
+      end
+
+      def steps
+        @steps ||= main_scenario.preparation_steps.find_all(&:necessary?)
+      end
+    end
+
     def initialize
       @steps = []
       compose
@@ -44,6 +62,32 @@ module ForemanMaintain
     # Override to compose steps for the scenario
     def compose; end
 
+    def preparation_steps
+      # we first take the preparation steps defined for the scenario + collect
+      # preparation steps for the steps inside the scenario
+      steps.inject(super.dup) do |results, step|
+        results.concat(step.preparation_steps)
+      end.uniq
+    end
+
+    # scenarios to be run before this scenario
+    def before_scenarios
+      scenarios = []
+      preparation_scenario = PreparationScenario.new(self)
+      scenarios << [preparation_scenario] unless preparation_scenario.steps.empty?
+      scenarios
+    end
+
+    def add_steps(steps)
+      steps.each do |step|
+        self.steps << step.ensure_instance
+      end
+    end
+
+    def add_step(step)
+      add_steps([step])
+    end
+
     def self.inspect
       "Scenario Class #{metadata[:description]}<#{name}>"
     end

data/lib/foreman_maintain/top_level_modules.rb

@@ -11,3 +11,6 @@ end
 
 module Scenarios
 end
+
+# do not include this names in autogenerated labels
+ForemanMaintain::Concerns::Metadata.top_level_modules = [Features, Checks, Procedures, Scenarios]

data/lib/foreman_maintain/utils.rb

@@ -1 +1,3 @@
+require 'foreman_maintain/utils/command_runner'
 require 'foreman_maintain/utils/disk'
+require 'foreman_maintain/utils/hammer'

data/lib/foreman_maintain/utils/command_runner.rb

@@ -0,0 +1,101 @@
+require 'English'
+require 'tempfile'
+
+module ForemanMaintain
+  module Utils
+    # Wrapper around running a command
+    class CommandRunner
+      attr_reader :logger, :command
+
+      def initialize(logger, command, options)
+        options.validate_options!(:stdin, :hidden_patterns, :interactive)
+        @logger = logger
+        @command = command
+        @stdin = options[:stdin]
+        @hidden_patterns = Array(options[:hidden_patterns])
+        @interactive = options[:interactive]
+        @options = options
+        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}"))
+        if @interactive
+          run_interactively
+        else
+          run_non_interactively
+        end
+        logger.debug("output of the command:\n #{hide_strings(output)}")
+      end
+
+      def interactive?
+        @interactive
+      end
+
+      def output
+        raise 'Command not yet executed' unless defined? @output
+        @output
+      end
+
+      def exit_status
+        raise 'Command not yet executed' unless defined? @exit_status
+        @exit_status
+      end
+
+      def success?
+        exit_status == 0
+      end
+
+      def execution_error
+        raise Error::ExecutionError.new(hide_strings(@command),
+                                        exit_status,
+                                        hide_strings(@stdin),
+                                        @interactive ? nil : hide_strings(@output))
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      def run_interactively
+        # use tmp files to capture output and exit status of the command when
+        # running interactively
+        log_file = Tempfile.open('captured-output')
+        exit_file = Tempfile.open('captured-exit-code')
+        Kernel.system("script -qc '#{full_command}; echo $? > #{exit_file.path}' #{log_file.path}")
+        File.open(log_file.path) { |f| @output = f.read }
+        File.open(exit_file.path) do |f|
+          exit_status = f.read.strip
+          @exit_status = if exit_status.empty?
+                           256
+                         else
+                           exit_status.to_i
+                         end
+        end
+      ensure
+        log_file.close
+        exit_file.close
+      end
+
+      def run_non_interactively
+        IO.popen(full_command, 'r+') do |f|
+          if @stdin
+            f.puts(@stdin)
+            f.close_write
+          end
+          @output = f.read.strip
+        end
+        @exit_status = $CHILD_STATUS.exitstatus
+      end
+
+      def full_command
+        "#{@command} 2>&1"
+      end
+
+      def hide_strings(string)
+        @hidden_patterns.reduce(string) do |result, hidden_pattern|
+          result.gsub(hidden_pattern, '[FILTERED]')
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/utils/disk/device.rb

@@ -2,28 +2,24 @@ module ForemanMaintain
   module Utils
     module Disk
       class Device
+        extend Forwardable
+
         include ForemanMaintain::Concerns::SystemHelpers
 
-        EXTERNAL_MOUNT_TYPE = %w(fuseblk nfs).freeze
+        EXTERNAL_MOUNT_TYPE = %w[fuseblk nfs].freeze
 
         attr_accessor :dir, :name, :unit, :read_speed
 
         attr_reader :io_device
 
+        def_delegators :io_device, :unit, :read_speed
+
         def initialize(dir)
           @dir = dir
           @name = find_device
           @io_device = init_io_device
         end
 
-        def unit
-          @unit ||= io_device.unit
-        end
-
-        def read_speed
-          @read_speed ||= io_device.read_speed
-        end
-
         def slow_disk_error_msg
           "Slow disk detected #{dir} mounted on #{name}.
              Actual disk speed: #{read_speed} #{default_unit}

data/lib/foreman_maintain/utils/hammer.rb

@@ -0,0 +1,78 @@
+module ForemanMaintain
+  module Utils
+    class Hammer
+      class CredentialsError < RuntimeError
+      end
+      include Concerns::SystemHelpers
+
+      attr_reader :settings
+
+      def self.instance
+        @instance ||= new
+      end
+
+      def config_file
+        config_dir = File.dirname(ForemanMaintain.config_file)
+        File.join(config_dir, 'foreman-maintain-hammer.yml')
+      end
+
+      # tries to setup hammer based on default configuration and returns true
+      # if it succeeds
+      # rubocop:disable Metrics/AbcSize
+      def setup_from_default
+        return unless File.exist?(default_config_file)
+        hammer_config = YAML.load_file(default_config_file)
+        foreman_config = hammer_config.fetch(:foreman, {})
+        if !foreman_config[:username].to_s.empty? && !foreman_config[:password].to_s.empty?
+          save_config(hammer_config)
+          ready? && default_config_file
+        end
+      end
+
+      def setup_from_answers(username = nil, password = nil)
+        save_config(:foreman => { :username => username, :password => password })
+        ready?
+      end
+
+      # Run a hammer command, examples:
+      # run_command('host list')
+      def run_command(args)
+        output = execute("#{command_base} #{args}")
+        if output =~ /Invalid username or password/
+          raise CredentialsError, 'Invalid hammer credentials: '\
+            'we expect the hammer username/password to be stored'\
+            "in #{config_file}"
+        end
+        output
+      end
+
+      def configured?
+        File.exist?(config_file)
+      end
+
+      def ready?
+        return @ready if defined? @ready
+        return false unless configured?
+        run_command('architecture list')
+        @ready = true
+      rescue CredentialsError
+        @ready = false
+      end
+
+      private
+
+      def default_config_file
+        @default_config_file ||= File.expand_path('~/.hammer/cli.modules.d/foreman.yml')
+      end
+
+      def command_base
+        %(LANG=en_US.utf-8 hammer -c "#{config_file}" --interactive=no)
+      end
+
+      def save_config(config)
+        remove_instance_variable '@ready' if defined? @ready
+        File.open(config_file, 'w', 0o600) { |f| f.puts YAML.dump(config) }
+      end
+    end
+  end
+end

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/foreman_maintain/yaml_storage.rb

@@ -0,0 +1,48 @@
+module ForemanMaintain
+  class YamlStorage
+    extend Forwardable
+    attr_reader :sub_key, :data
+    def_delegators :data, :[], :[]=
+
+    def initialize(sub_key, data = {})
+      @sub_key = sub_key
+      @data = data
+    end
+
+    def save
+      self.class.save_sub_key(sub_key, data)
+    end
+
+    class << self
+      def load_file
+        if File.exist?(storage_file_path)
+          YAML.load_file(storage_file_path) || {}
+        else
+          {}
+        end
+      end
+
+      def storage_file_path
+        File.expand_path(ForemanMaintain.config.storage_file)
+      end
+
+      def storage_register
+        @storage_register ||= {}
+      end
+
+      def load(sub_key)
+        storage_register[sub_key] ||= load_file.fetch(sub_key, {})
+        YamlStorage.new(sub_key, storage_register[sub_key])
+      end
+
+      def save_sub_key(sub_key, data_val)
+        new_data = load_file.merge(sub_key => data_val)
+        File.open(storage_file_path, 'w') { |f| f.write new_data.to_yaml }
+      end
+
+      def save_all
+        storage_register.values.each(&:save)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -94,9 +94,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  Provides various features that helps keeping the Foreman/Satellite up and
-  running.
+description: Provides various features that helps keeping the Foreman/Satellite up
+  and running.
 email: inecas@redhat.com
 executables:
 - foreman-maintain
@@ -109,15 +108,28 @@ files:
 - README.md
 - bin/foreman-maintain
 - definitions/checks/disk_speed_minimal.rb
-- definitions/checks/foreman_tasks_not_paused.rb
-- definitions/checks/foreman_tasks_not_running.rb
+- definitions/checks/foreman_tasks/invalid/check_old.rb
+- definitions/checks/foreman_tasks/invalid/check_pending_state.rb
+- definitions/checks/foreman_tasks/invalid/check_planning_state.rb
+- definitions/checks/foreman_tasks/not_paused.rb
+- definitions/checks/foreman_tasks/not_running.rb
+- definitions/checks/sync_plans/with_disabled_status.rb
+- definitions/checks/sync_plans/with_enabled_status.rb
+- definitions/checks/system_registration.rb
 - definitions/features/downstream.rb
 - definitions/features/foreman_1_11_x.rb
 - definitions/features/foreman_1_7_x.rb
 - definitions/features/foreman_database.rb
 - definitions/features/foreman_tasks.rb
+- definitions/features/sync_plans.rb
 - definitions/features/upstream.rb
-- definitions/procedures/foreman_tasks_resume.rb
+- definitions/procedures/foreman_tasks/delete.rb
+- definitions/procedures/foreman_tasks/resume.rb
+- definitions/procedures/foreman_tasks/ui_investigate.rb
+- definitions/procedures/hammer_setup.rb
+- definitions/procedures/install_package.rb
+- definitions/procedures/sync_plans/disable.rb
+- definitions/procedures/sync_plans/enable.rb
 - definitions/scenarios/pre_upgrade_check_foreman_1_14.rb
 - definitions/scenarios/pre_upgrade_check_satellite_6_0_z.rb
 - definitions/scenarios/pre_upgrade_check_satellite_6_1.rb
@@ -132,14 +144,17 @@ files:
 - lib/foreman_maintain/cli/health_command.rb
 - lib/foreman_maintain/cli/upgrade_command.rb
 - lib/foreman_maintain/concerns/finders.rb
+- lib/foreman_maintain/concerns/hammer.rb
 - lib/foreman_maintain/concerns/logger.rb
 - lib/foreman_maintain/concerns/metadata.rb
 - lib/foreman_maintain/concerns/system_helpers.rb
 - lib/foreman_maintain/config.rb
+- lib/foreman_maintain/core_ext.rb
 - lib/foreman_maintain/detector.rb
+- lib/foreman_maintain/error.rb
 - lib/foreman_maintain/executable.rb
 - lib/foreman_maintain/feature.rb
-- lib/foreman_maintain/logger.rb
+- lib/foreman_maintain/param.rb
 - lib/foreman_maintain/procedure.rb
 - lib/foreman_maintain/reporter.rb
 - lib/foreman_maintain/reporter/cli_reporter.rb
@@ -148,13 +163,16 @@ files:
 - lib/foreman_maintain/scenario.rb
 - lib/foreman_maintain/top_level_modules.rb
 - lib/foreman_maintain/utils.rb
+- lib/foreman_maintain/utils/command_runner.rb
 - lib/foreman_maintain/utils/disk.rb
 - lib/foreman_maintain/utils/disk/device.rb
 - lib/foreman_maintain/utils/disk/io.rb
 - lib/foreman_maintain/utils/disk/io/block_device.rb
 - lib/foreman_maintain/utils/disk/io/file_system.rb
 - lib/foreman_maintain/utils/disk/nil_device.rb
+- lib/foreman_maintain/utils/hammer.rb
 - lib/foreman_maintain/version.rb
+- lib/foreman_maintain/yaml_storage.rb
 homepage: https://github.com/theforeman/foreman_maintain
 licenses:
 - GPL-3.0