Module: ForemanMaintain

Extended by:
Concerns::PrimaryChecks
Defined in:
lib/foreman_maintain.rb,
lib/foreman_maintain/cli.rb,
lib/foreman_maintain/check.rb,
lib/foreman_maintain/error.rb,
lib/foreman_maintain/param.rb,
lib/foreman_maintain/config.rb,
lib/foreman_maintain/runner.rb,
lib/foreman_maintain/context.rb,
lib/foreman_maintain/feature.rb,
lib/foreman_maintain/version.rb,
lib/foreman_maintain/cli/base.rb,
lib/foreman_maintain/core_ext.rb,
lib/foreman_maintain/detector.rb,
lib/foreman_maintain/reporter.rb,
lib/foreman_maintain/scenario.rb,
lib/foreman_maintain/procedure.rb,
lib/foreman_maintain/csv_parser.rb,
lib/foreman_maintain/executable.rb,
lib/foreman_maintain/utils/bash.rb,
lib/foreman_maintain/utils/backup.rb,
lib/foreman_maintain/yaml_storage.rb,
lib/foreman_maintain/upgrade_runner.rb,
lib/foreman_maintain/utils/response.rb,
lib/foreman_maintain/concerns/hammer.rb,
lib/foreman_maintain/concerns/logger.rb,
lib/foreman_maintain/package_manager.rb,
lib/foreman_maintain/concerns/finders.rb,
lib/foreman_maintain/dependency_graph.rb,
lib/foreman_maintain/runner/execution.rb,
lib/foreman_maintain/utils/disk/stats.rb,
lib/foreman_maintain/concerns/metadata.rb,
lib/foreman_maintain/concerns/reporter.rb,
lib/foreman_maintain/utils/disk/device.rb,
lib/foreman_maintain/cli/backup_command.rb,
lib/foreman_maintain/cli/health_command.rb,
lib/foreman_maintain/cli/content_command.rb,
lib/foreman_maintain/cli/restore_command.rb,
lib/foreman_maintain/cli/service_command.rb,
lib/foreman_maintain/cli/upgrade_command.rb,
lib/foreman_maintain/concerns/downstream.rb,
lib/foreman_maintain/utils/curl_response.rb,
lib/foreman_maintain/cli/advanced_command.rb,
lib/foreman_maintain/cli/packages_command.rb,
lib/foreman_maintain/concerns/pulp_common.rb,
lib/foreman_maintain/utils/command_runner.rb,
lib/foreman_maintain/utils/disk/io_device.rb,
lib/foreman_maintain/utils/system_helpers.rb,
lib/foreman_maintain/reporter/cli_reporter.rb,
lib/foreman_maintain/utils/disk/nil_device.rb,
lib/foreman_maintain/concerns/base_database.rb,
lib/foreman_maintain/concerns/primary_checks.rb,
lib/foreman_maintain/concerns/system_helpers.rb,
lib/foreman_maintain/concerns/system_service.rb,
lib/foreman_maintain/runner/stored_execution.rb,
lib/foreman_maintain/concerns/directory_marker.rb,
lib/foreman_maintain/concerns/scenario_metadata.rb,
lib/foreman_maintain/cli/transform_clamp_options.rb,
lib/foreman_maintain/cli/maintenance_mode_command.rb,
lib/foreman_maintain/cli/advanced/procedure_command.rb,
lib/foreman_maintain/cli/advanced/procedure/run_command.rb,
lib/foreman_maintain/cli/advanced/prebuild_bash_completion.rb,
lib/foreman_maintain/cli/advanced/procedure/by_tag_command.rb,
lib/foreman_maintain/cli/advanced/procedure/abstract_by_tag_command.rb,
lib/foreman_maintain/cli/advanced/procedure/abstract_procedure_command.rb

Defined Under Namespace

Modules: Cli, Concerns, CoreExt, Error, PackageManager, Utils Classes: CSVParser, Check, Config, Context, DependencyGraph, Detector, Executable, Feature, HammerConfigurationError, Param, Procedure, Reporter, Runner, Scenario, UpgradeRunner, YamlStorage

Constant Summary collapse

LOGGER_LEVEL_MAPPING = 
{
  'debug' => ::Logger::DEBUG,
  'info' => ::Logger::INFO,
  'warn' => ::Logger::WARN,
  'error' => ::Logger::ERROR,
  'fatal' => ::Logger::FATAL,
  'unknown' => ::Logger::UNKNOWN
}.freeze
VERSION = 
'0.8.12'.freeze

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Concerns::PrimaryChecks

package_name, validate_downstream_packages

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.



47
48
49
 
# File 'lib/foreman_maintain.rb', line 47

def config
  @config
end

.logger ⇒ Object

Returns the value of attribute logger.



47
48
49
 
# File 'lib/foreman_maintain.rb', line 47

def logger
  @logger
end

Class Method Details

.allowed_available_procedures(*args) ⇒ Object 



129
130
131
132
 
# File 'lib/foreman_maintain.rb', line 129

def allowed_available_procedures(*args)
  procedures = detector.available_procedures(*args)
  procedures.select(&:advanced_run?)
end

.available_checks(*args) ⇒ Object 



121
122
123
 
# File 'lib/foreman_maintain.rb', line 121

def available_checks(*args)
  detector.available_checks(*args)
end

.available_features(*args) ⇒ Object 



113
114
115
 
# File 'lib/foreman_maintain.rb', line 113

def available_features(*args)
  detector.available_features(*args)
end

.available_procedures(*args) ⇒ Object 



125
126
127
 
# File 'lib/foreman_maintain.rb', line 125

def available_procedures(*args)
  detector.available_procedures(*args)
end

.available_scenarios(*args) ⇒ Object 



117
118
119
 
# File 'lib/foreman_maintain.rb', line 117

def available_scenarios(*args)
  detector.available_scenarios(*args)
end

.cache ⇒ Object 



97
98
99
 
# File 'lib/foreman_maintain.rb', line 97

def cache
  ObjectCache.instance
end

.config_file ⇒ Object 



83
84
85
 
# File 'lib/foreman_maintain.rb', line 83

def config_file
  config.config_file
end

.detector ⇒ Object 



101
102
103
 
# File 'lib/foreman_maintain.rb', line 101

def detector
  @detector ||= Detector.new
end

.init_logger ⇒ Object 



134
135
136
137
138
139
140
141
142
 
# File 'lib/foreman_maintain.rb', line 134

def init_logger
  # convert size in KB to Bytes
  log_fsize = config.log_file_size.to_i * 1024
  @logger = Logger.new(config.log_filename, 10, log_fsize).tap do |logger|
    logger.level = LOGGER_LEVEL_MAPPING[config.log_level] || Logger::DEBUG
    logger.datetime_format = '%Y-%m-%d %H:%M:%S%z '
  end
  pickup_log_messages
end

.load_definitions ⇒ Object 



87
88
89
90
91
92
93
94
95
 
# File 'lib/foreman_maintain.rb', line 87

def load_definitions
  # we need to add the load paths first, in case there is crossreferencing
  # between the definitions directories
  $LOAD_PATH.concat(config.definitions_dirs)
  config.definitions_dirs.each do |definitions_dir|
    file_paths = File.expand_path(File.join(definitions_dir, '**', '*.rb'))
    Dir.glob(file_paths).each { |f| require f }
  end
end

.main_package_name ⇒ Object 



183
184
185
 
# File 'lib/foreman_maintain.rb', line 183

def main_package_name
  'rubygem-foreman_maintain'
end

.package_manager ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/foreman_maintain/package_manager.rb', line 6

def self.package_manager
  @package_manager ||= case (%w[dnf yum apt].find { |manager| !`command -v #{manager}`.empty? })
                       when 'dnf'
                         ForemanMaintain::PackageManager::Dnf.new
                       when 'yum'
                         ForemanMaintain::PackageManager::Yum.new
                       else
                         raise 'No supported package manager was found'
                       end
end

.perform_self_upgrade ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/foreman_maintain.rb', line 169

def perform_self_upgrade
  package_name, command = pkg_and_cmd_name

  puts "Checking for new version of #{package_name}..."
  if ForemanMaintain.package_manager.update_available?(main_package_name)
    puts "\nUpdating #{package_name} package."
    ForemanMaintain.package_manager.update(main_package_name, :assumeyes => true)
    puts "\nThe #{package_name} package successfully updated."\
         "\nRe-run #{command} with required options!"
    exit 75
  end
  puts "Nothing to update, can't find new version of #{package_name}."
end

.pickup_log_messages ⇒ Object 



144
145
146
147
148
 
# File 'lib/foreman_maintain.rb', line 144

def pickup_log_messages
  return if config.pre_setup_log_messages.empty?
  config.pre_setup_log_messages.each { |msg| logger.info msg }
  config.pre_setup_log_messages.clear
end

.pkg_and_cmd_name ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/foreman_maintain.rb', line 160

def pkg_and_cmd_name
  instance_feature = ForemanMaintain.available_features(:label => :instance).first
  if instance_feature.downstream
    return instance_feature.downstream.fm_pkg_and_cmd_name
  end

  [main_package_name, 'foreman-maintain']
end

.refresh_features ⇒ Object 



105
106
107
 
# File 'lib/foreman_maintain.rb', line 105

def refresh_features
  @detector = Detector.new
end

.reporter ⇒ Object 



109
110
111
 
# File 'lib/foreman_maintain.rb', line 109

def reporter
  @reporter ||= ForemanMaintain::Reporter::CLIReporter.new
end

.set_home_environment ⇒ Object 



68
69
70
 
# File 'lib/foreman_maintain.rb', line 68

def set_home_environment
  ENV['HOME'] ||= '/root'
end

.setup(options = {}) ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/foreman_maintain.rb', line 58

def setup(options = {})
  set_home_environment

  # using a queue, we can log the messages which are generated before initializing logger
  self.config = Config.new(options)
  load_definitions
  init_logger
  update_path
end

.storage(label = :default) ⇒ Object 



150
151
152
153
154
 
# File 'lib/foreman_maintain.rb', line 150

def storage(label = :default)
  ForemanMaintain::YamlStorage.load(label)
rescue StandardError => e
  logger.error "Invalid Storage label i.e #{label}. Error - #{e.message}"
end

.update_path ⇒ Object

Appending PATH with expected paths needed for commands we run



73
74
75
76
77
78
79
80
81
 
# File 'lib/foreman_maintain.rb', line 73

def update_path
  paths = ['/sbin']
  existing_paths = ENV['PATH'].split(':')
  paths -= existing_paths
  if paths.any?
    paths = paths.join(':').chomp(':')
    ENV['PATH'] = "#{ENV['PATH']}:#{paths}"
  end
end

.upgrade_in_progress ⇒ Object 



156
157
158
 
# File 'lib/foreman_maintain.rb', line 156

def upgrade_in_progress
  storage[:upgrade_target_version]
end