foreman_maintain 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbfb7def5819c4fdf0ca51b125a0834d27ceebd2
-  data.tar.gz: 5fcb3a45ac4c4cd35c2b0321e1f870dc87367658
+  metadata.gz: fe40b2c9fdd4999acc0a0b764a916815e51c9c4a
+  data.tar.gz: cf9939ee27a333b61665f3eee0277005bfdd0167
 SHA512:
-  metadata.gz: 5dad56ec28607fb9ece29c8a4de091a1a7ead1723c7808fd957bee0ad4369f61fc53288b204b97d775826e912bd7370e862f0305ec12cc7789bc5484ab2eb9c5
-  data.tar.gz: f238b221d8fd8062b15080085e21459a773d574cb6d27d1db3d883c9b3dae84661ee93fd8fd9a9bdc57120a52c96afa8904d23b672801687b546a001df534044
+  metadata.gz: c3297df9601ce8f75dae19f2539b9563434d523d2f3eec602f4562bb6ce98ff29a3622f5c07c859a4da29c6f2cd38f2d90cd8d9d3531dee6b6f08bc49fdecefc
+  data.tar.gz: 67e607579907ad237d497692781c7e226352f87b9494f3cbe51aa167e67298ef500884b2099b386a002a9604432a4afa41da8c74a0b51bcf64721a5fa9a421e8

data/README.md

@@ -10,10 +10,11 @@ enough to provide the right tools for the specific version.
 ```
 Subcommands:
     health                        Health related commands
-      list-checks                   List the checks based on criteria
+      list                          List the checks based on criteria
       list-tags                     List the tags to use for filtering checks
       check                         Run the health checks against the system
-        --tags tags                   Limit only for specific set of tags
+        --label label               Run only a specific check
+        --tags tags                 Limit only for specific set of tags
 
     upgrade                       Upgrade related commands
       list-versions                List versions this system is upgradable to

data/definitions/checks/disk_speed_minimal.rb

@@ -0,0 +1,41 @@
+class Checks::DiskSpeedMinimal < ForemanMaintain::Check
+  EXPECTED_IO = 80
+  DEFAULT_UNIT   = 'MB/sec'.freeze
+  DEFAULT_DIRS   = ['/var/lib/pulp', '/var/lib/mongodb', '/var/lib/pgsql'].freeze
+
+  label :disk_io
+  description 'Check for recommended disk speed of pulp, mongodb, pgsql dir.'
+  tags :basic
+
+  confine do
+    execute?('which hdparm') && execute?('which fio')
+  end
+
+  def run
+    success = true
+    io_obj = ForemanMaintain::Utils::Disk::NilDevice.new
+
+    dirs_to_check.each do |dir|
+      io_obj = ForemanMaintain::Utils::Disk::Device.new(dir)
+
+      next if io_obj.read_speed >= EXPECTED_IO
+
+      success = false
+      logger.info "\n Slow disk detected for #{dir} - #{io_obj.read_speed} #{io_obj.unit}."
+      break
+    end
+
+    assert(success, io_obj.slow_disk_error_msg)
+  end
+
+  def check_only_single_device?
+    DEFAULT_DIRS.map do |dir|
+      ForemanMaintain::Utils::Disk::Device.new(dir).name
+    end.uniq.length <= 1
+  end
+
+  def dirs_to_check
+    return DEFAULT_DIRS.first(1) if check_only_single_device?
+    DEFAULT_DIRS
+  end
+end

data/definitions/features/foreman_database.rb

@@ -6,7 +6,7 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
   end
 
   def query(sql)
-    parse_csv(psql(%{COPY (#{sql}) TO STDOUT WITH CSV HEADER)}))
+    parse_csv(psql(%{COPY (#{sql}) TO STDOUT WITH CSV HEADER}))
   end
 
   def psql(query)

data/definitions/procedures/foreman_tasks_resume.rb

@@ -4,10 +4,10 @@ class Procedures::ForemanTasksResume < ForemanMaintain::Procedure
 
   def run
     say 'resuming paused tasks'
-    sleep 2
+    sleep 1
     say 'hold on'
-    sleep 2
+    sleep 1
     say 'almost there'
-    sleep 2
+    sleep 1
   end
 end

data/lib/foreman_maintain/cli/base.rb

@@ -37,8 +37,20 @@ module ForemanMaintain
         collection.inject([]) { |array, check| array.concat(check.tags).uniq }.sort_by(&:to_s)
       end
 
+      def self.label_option
+        option '--label', 'label',
+               'Limit only for a specific label. ' \
+                 '(Use "list" command to see available labels)' do |label|
+          raise ArgumentError, 'value not specified' if label.nil? || label.empty?
+          underscorize(label).to_sym
+        end
+      end
+
       def self.tags_option
-        option '--tags', 'tags', 'Limit only for specific set of tags' do |tags|
+        option '--tags', 'tags',
+               'Limit only for specific set of labels. ' \
+                 '(Use list-tags command to see available tags)' do |tags|
+          raise ArgumentError, 'value not specified' if tags.nil? || tags.empty?
           tags.split(',').map(&:strip).map { |tag| underscorize(tag).to_sym }
         end
       end

data/lib/foreman_maintain/cli/health_command.rb

@@ -1,7 +1,7 @@
 module ForemanMaintain
   module Cli
     class HealthCommand < Base
-      subcommand 'list-checks', 'List the checks based on criteria' do
+      subcommand 'list', 'List the checks based on criteria' do
         tags_option
 
         def execute
@@ -28,10 +28,33 @@ module ForemanMaintain
       end
 
       subcommand 'check', 'Run the health checks against the system' do
+        label_option
         tags_option
 
         def execute
-          run_scenario(Scenario::ChecksScenario.new(tags || [:basic]))
+          scenario = Scenario::FilteredScenario.new(filter)
+          if scenario.steps.empty?
+            puts "No scenario matching #{humanized_filter}"
+            exit 1
+          else
+            run_scenario(scenario)
+          end
+        end
+
+        def filter
+          if label
+            { :label => label }
+          else
+            { :tags => tags || [:basic] }
+          end
+        end
+
+        def humanized_filter
+          if label
+            "label #{label_string(filter[:label])}"
+          else
+            "tags #{filter[:tags].map { |tag| tag_string(tag) }.join}"
+          end
         end
       end
     end

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -85,7 +85,7 @@ module ForemanMaintain
           end
           output = f.read
           logger.debug("output of the command:\n #{output}")
-          output
+          output.strip
         end
       end
     end

data/lib/foreman_maintain/scenario.rb

@@ -7,23 +7,32 @@ module ForemanMaintain
 
     attr_reader :steps
 
-    class ChecksScenario < Scenario
+    class FilteredScenario < Scenario
       manual_detection
-      attr_reader :filter_tags
+      attr_reader :filter_label, :filter_tags
 
-      def initialize(filter_tags)
-        @filter_tags = filter_tags
-        @steps = ForemanMaintain.available_checks(:tags => filter_tags)
+      def initialize(filter)
+        @filter_tags = filter[:tags]
+        @filter_label = filter[:label]
+        @steps = ForemanMaintain.available_checks(filter)
       end
 
       def description
-        "checks with tags #{tag_string(@filter_tags)}"
+        if @filter_label
+          "check with label [#{dashize(@filter_label)}]"
+        else
+          "checks with tags #{tag_string(@filter_tags)}"
+        end
       end
 
       private
 
       def tag_string(tags)
-        tags.map { |tag| "[#{tag}]" }.join(' ')
+        tags.map { |tag| dashize("[#{tag}]") }.join(' ')
+      end
+
+      def dashize(string)
+        string.to_s.tr('_', '-')
       end
     end
 

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

@@ -0,0 +1,62 @@
+module ForemanMaintain
+  module Utils
+    module Disk
+      class Device
+        include ForemanMaintain::Concerns::SystemHelpers
+
+        EXTERNAL_MOUNT_TYPE = %w(fuseblk nfs).freeze
+
+        attr_accessor :dir, :name, :unit, :read_speed
+
+        attr_reader :io_device
+
+        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}
+             Expected disk speed: #{expected_io} #{default_unit}."
+        end
+
+        private
+
+        def init_io_device
+          if externally_mounted?
+            IO::FileSystem
+          else
+            IO::BlockDevice
+          end.new(dir, name)
+        end
+
+        def externally_mounted?
+          device_type = execute("stat -f -c %T #{dir}")
+          EXTERNAL_MOUNT_TYPE.include?(device_type)
+        end
+
+        def find_device
+          execute("df -h #{dir} | sed -n '2p' | awk '{print $1}'")
+        end
+
+        def default_unit
+          Checks::DiskSpeedMinimal::DEFAULT_UNIT
+        end
+
+        def expected_io
+          Checks::DiskSpeedMinimal::EXPECTED_IO
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/utils/disk/io/block_device.rb

@@ -0,0 +1,40 @@
+module ForemanMaintain
+  module Utils
+    module Disk
+      module IO
+        class BlockDevice
+          include ForemanMaintain::Concerns::SystemHelpers
+
+          attr_accessor :dir, :unit, :read_speed, :name
+
+          def initialize(dir, name = Disk::Device.new('/var').name)
+            @dir = dir
+            @name = name
+          end
+
+          def read_speed
+            @read_speed ||= extract_speed(hdparm)
+          end
+
+          def unit
+            @unit ||= extract_unit(hdparm)
+          end
+
+          private
+
+          def hdparm
+            @stdout ||= execute("hdparm -t #{name} | awk 'NF'")
+          end
+
+          def extract_unit(stdout)
+            stdout.split(' ').last
+          end
+
+          def extract_speed(stdout)
+            stdout.split(' ').reverse[1].to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/utils/disk/io/file_system.rb

@@ -0,0 +1,41 @@
+module ForemanMaintain
+  module Utils
+    module Disk
+      module IO
+        class FileSystem
+          include ForemanMaintain::Concerns::SystemHelpers
+
+          attr_accessor :dir, :unit, :read_speed, :name
+
+          def initialize(dir, name = '')
+            @dir = dir
+            @name = name
+          end
+
+          def read_speed
+            @read_speed ||= convert_kb_to_mb(fio)
+          end
+
+          def unit
+            @unit ||= 'MB/sec'
+          end
+
+          private
+
+          # In fio command, --direct option bypass the cache page
+          def fio
+            cmd = "fio --name=job1 --rw=read --size=1g --output-format=json\
+                    --directory=#{dir} --direct=1"
+            stdout = execute(cmd)
+            output = JSON.parse(stdout)
+            @fio ||= output['jobs'].first['read']['bw'].to_i
+          end
+
+          def convert_kb_to_mb(val)
+            val / 1024
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+require 'foreman_maintain/utils/disk/io/block_device'
+require 'foreman_maintain/utils/disk/io/file_system'

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

@@ -0,0 +1,18 @@
+module ForemanMaintain
+  module Utils
+    module Disk
+      class NilDevice
+        NULL = 'NULL'.freeze
+
+        attr_accessor :dir, :name, :unit, :read_speed
+
+        def initialize
+          @dir = NULL
+          @name = NULL
+          @unit = NULL
+          @read_speed = NULL
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/utils/disk.rb

@@ -0,0 +1,3 @@
+require 'foreman_maintain/utils/disk/io'
+require 'foreman_maintain/utils/disk/device'
+require 'foreman_maintain/utils/disk/nil_device'

data/lib/foreman_maintain/utils.rb

@@ -0,0 +1 @@
+require 'foreman_maintain/utils/disk'

data/lib/foreman_maintain/version.rb

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

data/lib/foreman_maintain.rb

@@ -1,3 +1,9 @@
+if RUBY_VERSION <= '1.8.7'
+  require 'rubygems'
+end
+
+require 'json'
+
 module ForemanMaintain
   require 'foreman_maintain/concerns/logger'
   require 'foreman_maintain/concerns/metadata'
@@ -13,6 +19,7 @@ module ForemanMaintain
   require 'foreman_maintain/scenario'
   require 'foreman_maintain/runner'
   require 'foreman_maintain/reporter'
+  require 'foreman_maintain/utils'
 
   class << self
     attr_accessor :config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -98,7 +98,8 @@ description: |
   Provides various features that helps keeping the Foreman/Satellite up and
   running.
 email: inecas@redhat.com
-executables: []
+executables:
+- foreman-maintain
 extensions: []
 extra_rdoc_files:
 - LICENSE
@@ -107,6 +108,7 @@ files:
 - LICENSE
 - 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/features/downstream.rb
@@ -145,6 +147,13 @@ files:
 - lib/foreman_maintain/runner/execution.rb
 - lib/foreman_maintain/scenario.rb
 - lib/foreman_maintain/top_level_modules.rb
+- lib/foreman_maintain/utils.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/version.rb
 homepage: https://github.com/theforeman/foreman_maintain
 licenses: