foreman_maintain 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3685c87a51938c933602dc6c14326eff9dcd0f17
-  data.tar.gz: aecc1a267b26067df5a4ecda9ffda31ddd278983
+  metadata.gz: 27f1643f7ff922cc3d9afb44a17f563b1fdb78e5
+  data.tar.gz: de21e1b4eb82ec7a0e108bd83506faa2323b541c
 SHA512:
-  metadata.gz: e972a4b2e2375bc8af5190c66b897fb9604ebada63804fc57a73547b93169b4a919ff54439e4efb2c4438b19b0b10b35f6d4cfd7805043479c4954d2f31b4acd
-  data.tar.gz: 521e0c73a330a750cfeee298ca9b7d2ed9341b4e863f56cb1a791df3b774a97c1fc27352d8bec14a453549fc9bb30fd3b87da059418b6266f0aca3a5e6d6269e
+  metadata.gz: fac7f856bb7cc2ad7b285514ce1b843dadd2beb989e9b0aa91bad8b8f3b564d906ce9e77abe98856f8d6fc5f8820ea2e350ff161c9e5cc7601c4ebeac71984d4
+  data.tar.gz: 90d43d34632fa926f07a0c437ad7f703ee407fb44f3ab8d4bf3d9a9ba142e42b1fe0b1e4987fbc8e5aa375f3b6f2e594334698de2332ef89620386d26276ff60

data/bin/foreman-maintain

@@ -4,6 +4,8 @@ $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'foreman_maintain'
 
+CONFIG_FILE = '/etc/foreman-maintain/config/foreman_maintain.yml'.freeze
+
 ForemanMaintain.setup
 
 require 'foreman_maintain/cli'

data/config/foreman_maintain.yml.example

@@ -0,0 +1,15 @@
+# Directory where the logs are stored.
+# The default file is named as /log/foreman_maintain.log
+:log_dir: 'log'
+
+# Logger levels: mention one of debug, info, warning, error, fatal
+:log_level: 'error'
+
+# Mention definitions directories. Default
+# :definitions_dirs:
+
+# Mention file path to store data
+# :storage_file: 'data.yml'
+
+# Mention directory to store whole backup data
+# :backup_dir: '/lib/foreman-maintain'

data/config/foreman_maintain.yml.packaging

@@ -0,0 +1,16 @@
+# Directory where the logs are stored.
+# The default file is named as /log/foreman_maintain.log
+:log_dir: '/var/log/foreman-maintain/'
+
+# Logger levels: mention one of debug, info, warning, error, fatal
+# :log_level: 'error'
+
+# Mention definitions directories. Default
+# :definitions_dirs:
+
+# Mention file path to store data
+:storage_file: '/lib/foreman-maintain/data.yml'
+
+# Mention directory to store whole backup data
+:backup_dir: '/lib/foreman-maintain'
+

data/definitions/checks/foreman_tasks/invalid/check_old.rb

@@ -6,6 +6,8 @@ module Checks::ForemanTasks
         for_feature :foreman_tasks
         tags :pre_upgrade
         description 'Check for old tasks in paused/stopped state'
+        before :check_foreman_tasks_in_pending_state
+        after :foreman_tasks_not_paused
       end
 
       def run

data/definitions/checks/foreman_tasks/invalid/check_pending_state.rb

@@ -6,6 +6,7 @@ module Checks::ForemanTasks
         for_feature :foreman_tasks
         tags :pre_upgrade
         description 'Check for pending tasks which are safe to delete'
+        before :check_foreman_tasks_in_planning_state
       end
 
       def run

data/definitions/checks/foreman_tasks/invalid/check_planning_state.rb

@@ -6,6 +6,7 @@ module Checks::ForemanTasks
         for_feature :foreman_tasks
         tags :pre_upgrade
         description 'Check for tasks in planning state'
+        after :check_foreman_tasks_in_pending_state
       end
 
       def run

data/definitions/checks/foreman_tasks/not_paused.rb

@@ -1,5 +1,6 @@
 module Checks::ForemanTasks
   class NotPaused < ForemanMaintain::Check
+    include ForemanMaintain::Concerns::Hammer
     metadata do
       for_feature :foreman_tasks
       description 'check for paused tasks'

data/definitions/checks/foreman_tasks/not_running.rb

@@ -4,6 +4,8 @@ module Checks::ForemanTasks
       for_feature :foreman_tasks
       description 'check for running tasks'
       tags :pre_upgrade
+      after :foreman_tasks_not_paused
+      before :check_old_foreman_tasks
     end
 
     def run

data/definitions/checks/sync_plans/with_enabled_status.rb

@@ -6,6 +6,7 @@ module Checks::SyncPlans
       for_feature :sync_plans
       description 'check for enabled sync plans'
       tags :pre_upgrade
+      before :disk_io
     end
 
     def run

data/definitions/features/foreman_tasks.rb

@@ -82,11 +82,19 @@ class Features::ForemanTasks < ForemanMaintain::Feature
     end
   end
 
+  def resume_task_using_hammer
+    hammer('task resume')
+  end
+
   private
 
+  def parent_backup_dir
+    File.expand_path(ForemanMaintain.config.backup_dir)
+  end
+
   def backup_dir(state)
     @backup_dir ||=
-      "/var/lib/foreman/backup-tasks/#{state}/#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}"
+      "#{parent_backup_dir}/backup-tasks/#{state}/#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}"
   end
 
   def backup_table(table, state, fkey = 'execution_plan_uuid')

data/definitions/procedures/foreman_tasks/resume.rb

@@ -1,14 +1,12 @@
 module Procedures::ForemanTasks
   class Resume < ForemanMaintain::Procedure
-    include ForemanMaintain::Concerns::Hammer
-
     metadata do
       for_feature :foreman_tasks
       description 'resume paused tasks'
     end
 
     def run
-      output << hammer('task resume')
+      output << feature(:foreman_tasks).resume_task_using_hammer
     end
   end
 end

data/lib/foreman_maintain/cli/health_command.rb

@@ -5,7 +5,9 @@ module ForemanMaintain
         tags_option
 
         def execute
-          available_checks.each { |check| print_check_info(check) }
+          DependencyGraph.sort(available_checks.map(&:ensure_instance)).each do |check|
+            print_check_info(check)
+          end
         end
 
         def print_check_info(check)

data/lib/foreman_maintain/concerns/metadata.rb

@@ -32,6 +32,15 @@ module ForemanMaintain
           @data[:confine_blocks] << block
         end
 
+        def before(*step_labels)
+          raise Error::MultipleBeforeDetected, step_labels if step_labels.count > 1
+          @data[:before].concat(step_labels)
+        end
+
+        def after(*step_labels)
+          @data[:after].concat(step_labels)
+        end
+
         # Parametrize the definition.
         #
         # == Arguments
@@ -143,11 +152,21 @@ module ForemanMaintain
           metadata[:params] || []
         end
 
+        def before
+          metadata[:before] || []
+        end
+
+        def after
+          metadata[:after] || []
+        end
+
         def initialize_metadata
           { :tags => [],
             :confine_blocks => [],
             :params => {},
-            :preparation_steps_blocks => [] }.tap do |metadata|
+            :preparation_steps_blocks => [],
+            :before => [],
+            :after => [] }.tap do |metadata|
             if superclass.respond_to?(:metadata)
               metadata[:label] = superclass.metadata[:label]
             end

data/lib/foreman_maintain/config.rb

@@ -2,18 +2,22 @@ require 'fileutils'
 module ForemanMaintain
   class Config
     attr_accessor :pre_setup_log_messages,
-                  :config_file, :definitions_dirs, :log_level, :log_dir, :storage_file
+                  :config_file, :definitions_dirs, :log_level, :log_dir, :storage_file,
+                  :backup_dir
 
     def initialize(options)
       @pre_setup_log_messages = []
-      @config_file = options.fetch(:config_file, default_config_file)
+      @config_file = options.fetch(:config_file, config_file_path)
       @options = load_config
       @definitions_dirs = @options.fetch(:definitions_dirs,
                                          [File.join(source_path, 'definitions')])
 
       @log_level = @options.fetch(:log_level, ::Logger::DEBUG)
-      @log_dir = find_log_dir_path(@options.fetch(:log_dir, 'log'))
+      @log_dir = find_dir_path(@options.fetch(:log_dir, 'log'))
       @storage_file = @options.fetch(:storage_file, 'data.yml')
+      @backup_dir = find_dir_path(
+        @options.fetch(:backup_dir, '/lib/foreman-maintain')
+      )
     end
 
     private
@@ -30,23 +34,23 @@ module ForemanMaintain
       raise "Couldn't load configuration file. Error: #{e.message}"
     end
 
-    def default_config_file
-      File.join(source_path, 'config/foreman_maintain.yml')
+    def config_file_path
+      File.exist?(CONFIG_FILE) ? CONFIG_FILE : 'config/foreman_maintain.yml'
     end
 
     def source_path
       File.expand_path('../../..', __FILE__)
     end
 
-    def find_log_dir_path(log_dir)
-      log_dir_path = File.expand_path(log_dir)
+    def find_dir_path(dir_path_str)
+      dir_path = File.expand_path(dir_path_str)
       begin
-        FileUtils.mkdir_p(log_dir_path, :mode => 0o750) unless File.exist?(log_dir_path)
+        FileUtils.mkdir_p(dir_path, :mode => 0o750) unless File.exist?(dir_path)
       rescue => e
-        $stderr.puts "No permissions to create log dir #{log_dir}"
+        $stderr.puts "No permissions to create dir #{dir_path_str}"
         $stderr.puts e.message.inspect
       end
-      log_dir_path
+      dir_path
     end
   end
 end

data/lib/foreman_maintain/dependency_graph.rb

@@ -0,0 +1,89 @@
+require 'tsort'
+
+module ForemanMaintain
+  class DependencyGraph
+    include TSort
+
+    attr_reader :graph, :collection, :labels
+
+    def self.sort(collection)
+      new(collection).tsort.map(&:ensure_instance)
+    end
+
+    def initialize(collection)
+      @graph = Hash.new([])
+      @collection = collection
+      @labels = extract_labels
+      generate_label_graph
+      convert_label_graph_to_object_graph
+    end
+
+    def add_to_graph(key, dependencies = [])
+      return unless key
+
+      dependencies = dependencies.map do |dep|
+        next unless labels.include?(dep)
+        dep
+      end.compact
+
+      graph[key] = dependencies
+    end
+
+    def tsort_each_node(&block)
+      graph.each_key(&block)
+    end
+
+    def tsort_each_child(node, &block)
+      graph.fetch(node).each(&block)
+    end
+
+    private
+
+    def cache
+      ForemanMaintain.cache
+    end
+
+    def convert_label_graph_to_object_graph
+      graph.keys.each do |key|
+        graph[cache.fetch(key)] = graph[key].map { |dep| cache.fetch(dep) }
+        graph.delete(key)
+      end
+
+      graph
+    end
+
+    def extract_labels
+      collection.map(&:label)
+    end
+
+    def find_class(dep)
+      case dep
+      when Class
+        dep
+      when String
+        if dep.include?('::')
+          dep.split('::').reduce(Object) { |o, e| o.const_get(e) }
+        else
+          cache.fetch(dep)
+        end
+      else
+        cache.fetch(dep)
+      end
+    end
+
+    def generate_label_graph
+      collection.each do |object|
+        klass = object.class
+        key = object.label
+
+        add_to_graph(klass.before.first, [key])
+        add_to_graph(key, klass.after)
+        map_label_to_object(object)
+      end
+    end
+
+    def map_label_to_object(object)
+      cache.fetch(object.label, object)
+    end
+  end
+end

data/lib/foreman_maintain/error.rb

@@ -6,6 +6,16 @@ module ForemanMaintain
     class Warn < StandardError
     end
 
+    class MultipleBeforeDetected < StandardError
+      def initialize(step_labels)
+        @step_labels = step_labels
+      end
+
+      def message
+        "multiple metadata detected instead of 1. \n before [#{@step_labels.join(', ')}]\n"
+      end
+    end
+
     class ExecutionError < StandardError
       attr_reader :command, :input, :output, :exit_status
 

data/lib/foreman_maintain/object_cache.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module ForemanMaintain
+  class ObjectCache
+    include Singleton
+
+    attr_reader :cache
+
+    def initialize
+      @cache = {}
+    end
+
+    def fetch(key, object = nil)
+      hit(key) || miss(key, object)
+    end
+
+    private
+
+    def add(key, object)
+      return if key.nil? || object.nil?
+      cache[key.to_sym] = object
+    end
+
+    def hit(key)
+      cache.fetch(key, nil)
+    end
+
+    def miss(key, object)
+      object ||= ForemanMaintain.detector.available_checks(:label => key).first
+      add(key, object)
+      hit(key)
+    end
+  end
+end

data/lib/foreman_maintain/runner.rb

@@ -29,6 +29,7 @@ module ForemanMaintain
 
     def run_scenario(scenario)
       @steps_to_run = scenario.steps.dup
+      @steps_to_run = ForemanMaintain::DependencyGraph.sort(@steps_to_run)
       @reporter.before_scenario_starts(scenario)
       while !@quit && !@steps_to_run.empty?
         step = @steps_to_run.shift

data/lib/foreman_maintain/scenario.rb

@@ -16,6 +16,7 @@ module ForemanMaintain
         @filter_tags = filter[:tags]
         @filter_label = filter[:label]
         @steps = ForemanMaintain.available_checks(filter).map(&:ensure_instance)
+        @steps = DependencyGraph.sort(@steps)
       end
 
       def description

data/lib/foreman_maintain/version.rb

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

data/lib/foreman_maintain.rb

@@ -18,10 +18,12 @@ module ForemanMaintain
   require 'foreman_maintain/yaml_storage'
   require 'foreman_maintain/config'
   require 'foreman_maintain/detector'
+  require 'foreman_maintain/dependency_graph'
   require 'foreman_maintain/param'
   require 'foreman_maintain/feature'
   require 'foreman_maintain/executable'
   require 'foreman_maintain/check'
+  require 'foreman_maintain/object_cache'
   require 'foreman_maintain/procedure'
   require 'foreman_maintain/scenario'
   require 'foreman_maintain/runner'
@@ -62,6 +64,10 @@ module ForemanMaintain
       end
     end
 
+    def cache
+      ObjectCache.instance
+    end
+
     def detector
       @detector ||= Detector.new
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -107,6 +107,8 @@ files:
 - LICENSE
 - README.md
 - bin/foreman-maintain
+- config/foreman_maintain.yml.example
+- config/foreman_maintain.yml.packaging
 - definitions/checks/disk_speed_minimal.rb
 - definitions/checks/foreman_tasks/invalid/check_old.rb
 - definitions/checks/foreman_tasks/invalid/check_pending_state.rb
@@ -150,10 +152,12 @@ files:
 - lib/foreman_maintain/concerns/system_helpers.rb
 - lib/foreman_maintain/config.rb
 - lib/foreman_maintain/core_ext.rb
+- lib/foreman_maintain/dependency_graph.rb
 - lib/foreman_maintain/detector.rb
 - lib/foreman_maintain/error.rb
 - lib/foreman_maintain/executable.rb
 - lib/foreman_maintain/feature.rb
+- lib/foreman_maintain/object_cache.rb
 - lib/foreman_maintain/param.rb
 - lib/foreman_maintain/procedure.rb
 - lib/foreman_maintain/reporter.rb