foreman_maintain 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db720ab5cd56f2afbb74ccd75c4f8a479f2a4547c419b3b0f7b6d937e4df475a
-  data.tar.gz: b97c27565dc68d5395c4b163486d3c2758de583faae7282934608d66d9230dd1
+  metadata.gz: 7050dd905c1396f95686caabf7afaea60f963b8c68c2b0849eb4d06b7e5330f7
+  data.tar.gz: d683a46f74563cb3c22a4f0ab94ebf3354aa4685afd8b22a7ea68ec1fc6d70a7
 SHA512:
-  metadata.gz: 155e47d65bd4d8d0355e6a60133ddf4a14dd2c2604dfa5e793412e7bb07d9eb9df457f91d889396fd42ed6c9abd0a8347b6ae18afa51428567d8dfddee698489
-  data.tar.gz: 52ca518f6fad0fa372d8a7a132858b4503580e016024996efdb06fda7eab4672fd23e9074c3127e15459606aab256ea6f7ff7538c57fe7f23ea2fb41b69f4c9e
+  metadata.gz: 56ffb28e036596b3b7262ff27e5f7ab85ccd98ba3f261ef5049f0e4c404b743b96fe3086723a7a0d08005e27308b40888e209ca66125662d4dd72da8706a540c
+  data.tar.gz: f056a9c36223352dededfd338e462070f71780b679e2d661360733a85ef07045ac1fd7f803421f945d9f1cc0176d7351d8f0f951da558635b33a5dcc7e99a67c

data/README.md

@@ -1,6 +1,6 @@
 # Foreman Maintenance [![Build Status](https://travis-ci.org/theforeman/foreman_maintain.svg?branch=master)](https://travis-ci.org/theforeman/foreman_maintain) <a href="https://codeclimate.com/github/theforeman/foreman_maintain"><img src="https://codeclimate.com/github/theforeman/foreman_maintain/badges/gpa.svg" /></a>
 
-`foreman_maintain` aims to provide various features that helps keep the
+The `foreman_maintain` aims to provide various features that helps keep the
 Foreman/Satellite up and running. It supports multiple versions and subparts
 of the Foreman infrastructure, including server or smart proxy and is smart
 enough to provide the right tools for the specific version.
@@ -19,8 +19,10 @@ Subcommands:
     upgrade                       Upgrade related commands
       list-versions                 List versions this system is upgradable to
       check --target-version TARGET_VERSION   Run pre-upgrade checks for upgrading to specified version
+            --disable-self-upgrade            Disable automatic self upgrade (default: false)
       run --target-version TARGET_VERSION     Run the full upgrade
           [--phase=phase TARGET_VERSION]      Run just a specific phase of the upgrade
+          --disable-self-upgrade              Disable automatic self upgrade (default: false)
 
     advanced                      Advanced tools for server maintenance
       procedure                     Run maintain procedures manually
@@ -59,8 +61,8 @@ Subcommands:
 Foreman-maintain implements upgrade tooling that helps the administrator to go
 through the upgrade process.
 
-Foreman-maintain scans the system to know, what version are available
-to upgrade to for the particular system. To see what versions are available
+Foreman-maintain scans the system to know, what versions are available
+for upgrade on the particular system. To see what versions are available
 for upgrade, run:
 
 ```
@@ -88,13 +90,13 @@ of the system:
 
   * **pre-migrations** - these steps perform changes on the system before
     the actual upgrade starts. An example is disabling access to the system from
-    external sources, a.k.a. maintenance mode or disabling sync plans during the run.
+    external sources, a.k.a. maintenance mode or disabling Katello sync plans during the run.
 
     After this phase ends, the system is still running the old version, and it's possible
     to revert the changes by running the post-migrations steps.
 
   * **migrations** - this phase performs the actual migrations, starting with
-    configuring new repositories, updated the packages and running the installer.
+    configuring new repositories, updating the packages and running the installer.
 
     At the end of this phase, the system should be fully migrated to the new version.
     However, the system is not fully operational yet, as the post-migrations steps
@@ -103,7 +105,7 @@ of the system:
   * **post-migrations** - these steps revert the changes made in pre-migrations phase,
     turning the system into fully-operational again.
 
-  * **post-upgrade checks** - this steps should perform sanity check of the system
+  * **post-upgrade checks** - these steps should perform sanity check of the system
     to ensure the system is valid and ready to be used again.
 
 
@@ -114,6 +116,40 @@ the *pre-upgrade check* phase. In case the upgrade failed before **migrations**
 phase made some modifying changes, the tool tries to rollback to the previous
 state of the system.
 
+#### Self-upgrade for rubygem-foreman_maintain package
+
+**Note:** This feature is available from `rubygem-foreman_maintain` version 0.6.4 and newer.
+
+When a user runs any `foreman-maintain upgrade` sub commands (e.g. `foreman-maintain upgrade check` or `foreman-maintain upgrade run`) then,
+
+  * If update available for `rubygem-foreman_maintain` package, the sub command tries to update this package. After successful package update, it returns the exit code 75 and requests user to re-run with the updated source code.
+
+    Here, exit code (value 75) is to indicate that it can not continue with further execution & needs re-run. e.g.,
+
+    ~~~
+    # foreman-maintain upgrade check --target-version TARGET_VERSION
+    Checking for new version of foreman-maintain...
+    rubygem-foreman_maintain.noarch   repository
+
+    Updating foreman-maintain package.
+
+    The foreman-maintain package successfully updated.
+
+    Re-run foreman-maintain with required options!
+
+    # echo $?
+    75
+    ~~~
+
+  * If update is not available for `rubygem-foreman_maintain` package, then sub command simply executes the further steps without halt.
+
+  * If user wants to skip self-update mechanism then `--disable-self-upgrade` flag can be used with upgrade sub commands. e.g.,
+
+  ~~~
+  # foreman-maintain upgrade check --target-version TARGET_VERSION --disable-self-upgrade
+  # foreman-maintain upgrade run --target-version TARGET_VERSION --disable-self-upgrade
+  ~~~
+
 #### Satellite notes
 
 To use custom organization/activation key for configuring repositories during
@@ -132,7 +168,7 @@ export FOREMAN_MAINTAIN_USE_BETA='1'
 
 ## Implementation
 
-`foreman_maintain` maps the CLI commands into definitions. This allows to keep the set
+The `foreman_maintain` maps the CLI commands into definitions. This allows to keep the set
 of the commands the user needs to know immutable from version-specific changes. The mapping
 between the CLI commands and definitions is made by defining various metadata.
 
@@ -329,8 +365,8 @@ end
 ```
 
 Before executing the command the feature checks if it has valid hammer configuration to run the command.
-Foreman maintain always use the 'admin' account to run the commands. The password is taken either form
-the Hammer config or installer answer files or asked from the user interactively (in this order).
+Foreman maintain always use the 'admin' account to run the commands. The password is taken from
+the hammer config or installer answer files or asked from the user interactively (in this order).
 The valid credentials are stored and reused next time if still valid.
 
 Usually we want to do the user interaction at the beginning of our scenario.
@@ -449,7 +485,7 @@ Possible options for the `:completion` attribute are:
 * `maintenance-mode is-enabled` returns `0 or 1` output depending upon the maintenance-mode status.
 Here, 0=ON & 1=OFF.
 
-If User would like to check whether maintenance-mode is ON/OFF on system in their external script then
+If users would like to check whether maintenance-mode is ON/OFF on system in their external script then
 they can use subcommand `foreman-maintain maintenance-mode is-enabled`.
 
 ## How to contribute?

data/bin/foreman-maintain-complete

@@ -13,7 +13,8 @@ require 'foreman_maintain/utils/bash'
 # rubocop:disable Lint/RescueWithoutErrorClass, Lint/HandleExceptions
 def cache_file(config_file)
   config = YAML.load(File.open(config_file))
-  config[:completion_cache_file]
+  config.fetch(:completion_cache_file,
+               "#{ENV['HOME'] || '/root'}/.cache/foreman_maintain_completion.yml")
 rescue
 end
 # rubocop:enable Lint/RescueWithoutErrorClass, Lint/HandleExceptions
@@ -23,7 +24,7 @@ config_file = if File.exist?(CONFIG_FILE)
               else
                 File.join(project_root, 'config/foreman_maintain.yml')
               end
-completion_cache_file = cache_file(config_file) || '~/.cache/foreman_maintain_completion.yml'
+completion_cache_file = cache_file(config_file)
 completion_cache_file = File.expand_path(completion_cache_file)
 
 # build the cache if it does not exist

data/definitions/checks/env_proxy.rb

@@ -8,6 +8,6 @@ class Checks::EnvProxy < ForemanMaintain::Check
   def run
     variables = %w[http_proxy https_proxy HTTP_PROXY HTTPS_PROXY]
     has_proxy_set = true if variables.map { |variable| ENV[variable] }.compact.any?
-    assert(has_proxy_set, 'Global HTTP(S) proxy in environment (env) is set. Please unset first!')
+    assert(!has_proxy_set, 'Global HTTP(S) proxy in environment (env) is set. Please unset first!')
   end
 end

data/definitions/checks/foreman_proxy/verify_dhcp_config_syntax.rb

@@ -4,20 +4,18 @@ module Checks::ForemanProxy
       description 'Check for verifying syntax for ISP DHCP configurations'
       tags :default
       confine do
-        feature(:foreman_proxy)
+        feature(:foreman_proxy) &&
+          feature(:foreman_proxy).features.include?('dhcp') &&
+          feature(:foreman_proxy).dhcp_isc_provider?
       end
     end
 
     def run
-      if feature(:foreman_proxy).features.include?('dhcp')
-        if feature(:foreman_proxy).dhcpd_conf_exist?
-          success = feature(:foreman_proxy).valid_dhcp_configs?
-          assert(success, 'Please check and verify DHCP configurations.')
-        else
-          fail! "Couldn't find configuration file at #{feature(:foreman_proxy).dhcpd_config_file}"
-        end
+      if feature(:foreman_proxy).dhcpd_conf_exist?
+        success = feature(:foreman_proxy).valid_dhcp_configs?
+        assert(success, 'Please check and verify DHCP configurations.')
       else
-        skip 'DHCP feature is not enabled'
+        fail! "Couldn't find configuration file at #{feature(:foreman_proxy).dhcpd_config_file}"
       end
     end
   end

data/definitions/features/foreman_proxy.rb

@@ -101,7 +101,9 @@ class Features::ForemanProxy < ForemanMaintain::Feature
   end
 
   def certs_tar
-    feature(:installer).answers[content_module][certs_param_name[:param_section]] if content_module
+    if content_module
+      feature(:installer).answers.fetch(content_module, {})[certs_param_name[:param_key]]
+    end
   end
 
   def settings_file
@@ -120,6 +122,10 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     @tftp_root_directory ||= lookup_tftp_root_directory
   end
 
+  def dhcp_isc_provider?
+    configs_from_dhcp_yml[:use_provider] == 'dhcp_isc'
+  end
+
   private
 
   def backup_features(for_features)
@@ -227,10 +233,6 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     @configs_from_dhcp_yml ||= yaml_load(dhcp_yml_path)
   end
 
-  def dhcp_isc_provider?
-    configs_from_dhcp_yml[:use_provider] == 'dhcp_isc'
-  end
-
   def lookup_using_dhcp_yml
     if configs_from_dhcp_yml.key?(:dhcp_config)
       return configs_from_dhcp_yml[:dhcp_config]

data/definitions/procedures/backup/prepare_directory.rb

@@ -8,6 +8,7 @@ module Procedures::Backup
       param :incremental_dir, 'Changes since specified backup only'
     end
 
+    # rubocop:disable Metrics/MethodLength
     def run
       puts "Creating backup folder #{@backup_dir}"
 
@@ -22,8 +23,14 @@ module Procedures::Backup
 
       FileUtils.rm(Dir.glob(File.join(@backup_dir, '.*.snar'))) if @preserve_dir
       if @incremental_dir
-        FileUtils.cp(Dir.glob(File.join(@incremental_dir, '.*.snar')), @backup_dir)
+        if (snar_files = Dir.glob(File.join(@incremental_dir, '.*.snar'))).empty?
+          raise "#{@incremental_dir}/*.snar files unavailable. "\
+                'Provide a valid previous backup directory'
+        else
+          FileUtils.cp(snar_files, @backup_dir)
+        end
       end
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/definitions/procedures/content/prepare.rb

@@ -3,6 +3,11 @@ module Procedures::Content
     metadata do
       description 'Prepare content for Pulp 3'
       for_feature :pulpcore
+
+      confine do
+        # FIXME: remove this condition on next downstream upgrade scenario
+        !feature(:instance).downstream
+      end
     end
 
     def run

data/definitions/procedures/content/switchover.rb

@@ -3,6 +3,11 @@ module Procedures::Content
     metadata do
       description 'Switch support for certain content from Pulp 2 to Pulp 3'
       for_feature :pulpcore
+
+      confine do
+        # FIXME: remove this condition on next downstream upgrade scenario
+        !feature(:instance).downstream
+      end
     end
 
     def run

data/definitions/procedures/packages/locking_status.rb

@@ -18,7 +18,7 @@ module Procedures::Packages
       else
         puts '  Packages are not locked.'
         puts "  WARNING: When locking is disabled there is a risk of unwanted update\n" \
-             "  of #{feature(:instance).product_name}' and its components and possible " \
+             "  of #{feature(:instance).product_name} and its components and possible " \
              'data inconsistency'
       end
     end

data/definitions/scenarios/content.rb

@@ -8,7 +8,10 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        add_step(Procedures::Content::Prepare)
+        # FIXME: remove this condition on next downstream upgrade scenario
+        if Procedures::Content::Prepare.present?
+          add_step(Procedures::Content::Prepare)
+        end
       end
     end
 
@@ -20,7 +23,10 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        add_step(Procedures::Content::Switchover)
+        # FIXME: remove this condition on next downstream upgrade scenario
+        if Procedures::Content::Switchover.present?
+          add_step(Procedures::Content::Switchover)
+        end
       end
     end
   end

data/extras/foreman_protector/foreman-protector.py

@@ -26,7 +26,7 @@ def _load_whitelist():
                 continue
             _package_whitelist.add(line.rstrip().lower())
         llfile.close()
-    except urlgrabber.grabber.URLGrabError, e:
+    except urlgrabber.grabber.URLGrabError as e:
         raise PluginYumExit('Unable to read Foreman protector"s configuration: %s' % e)
 
 def _add_obsoletes(conduit):

data/lib/foreman_maintain.rb

@@ -53,6 +53,8 @@ module ForemanMaintain
     }.freeze
 
     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
@@ -60,6 +62,10 @@ module ForemanMaintain
       update_path
     end
 
+    def set_home_environment
+      ENV['HOME'] ||= '/root'
+    end
+
     # Appending PATH with expected paths needed for commands we run
     def update_path
       paths = ['/sbin']
@@ -162,7 +168,7 @@ module ForemanMaintain
         ForemanMaintain.package_manager.update(main_package_name, :assumeyes => true)
         puts "\nThe #{package_name} package successfully updated."\
              "\nRe-run #{command} with required options!"
-        exit 0
+        exit 75
       end
       puts "Nothing to update, can't find new version of #{package_name}."
     end

data/lib/foreman_maintain/concerns/base_database.rb

@@ -82,7 +82,7 @@ module ForemanMaintain
           tar_options = {
             :archive => backup_file,
             :command => 'create',
-            :transform => 's,^,var/lib/pgsql/data/,S',
+            :transform => "s,^,#{data_dir[1..-1]},S",
             :files => '*'
           }.merge(extra_tar_options)
           feature(:tar).run(tar_options)

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.6.8'.freeze
+  VERSION = '0.6.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -401,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt