foreman_maintain 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f61cb7b275e9978bc032513744950f822778872
-  data.tar.gz: f7614599245417a2fe6701e1216e234104743e63
+  metadata.gz: 3a34b76c9a33401d8fdcdd6060d927ec7524bbe4
+  data.tar.gz: 650f353493cb6d4ba3f8f74645fd214e7eb3829f
 SHA512:
-  metadata.gz: beb2a3862349655e2de9f31bfc069693304adae28ddc693fa3c74d2fece3412139a5e256bacbdf43eda8cdd19edc1047707e607c015308dc37002b0d88710078
-  data.tar.gz: 262695d71ed612c0eba941c14db87559e86c9057b03f63c33b4f24c1795dd7fe50bd4cc477aa32144a95a9f5610d2d45350c02bc8901cbdd857ce3fd4cc4967d
+  metadata.gz: 3c5775e4e063a09e46511cf7ddc8803ccefb3ab512d7b7c7c6e74d4d9164b27437715474a9100221dd82bc3f80425190c9ee9e84d52bfb771f282fef11a4879a
+  data.tar.gz: 5a34a85f37bc1295a3ec1591b71e8d3782a839b3de2c2433bb43b09634d112137d59aa1fb4c94f644f4cabf8b349a83e4cc232b2392291dfc88c81a113458b12

data/README.md

@@ -385,6 +385,43 @@ foreman-maintain console
 foreman-maintain config
 ```
 
+## Bash completion
+
+The completion offers suggestion of possible command-line subcommands and their options
+as usual. It can also suggest values for options and params where file
+or directory path is expected.
+
+Bash completion is automatically installed by RPM. To use it for development setup 
+`cp ./config/foreman-maintain.completion /etc/bash_completion.d/foreman-maintain` 
+and load it to the current shell `source /etc/bash_completion.d/foreman-maintain`.
+Make sure the `$PWD/bin` is in `PATH` or there is full path to `foreman-maintain-complete`
+executable specified in `/etc/bash_completion.d/foreman-maintain`.
+
+Bash completion for foreman-maintain needs pre-built cache that holds description of 
+all subcommands and its parameters. The cache is located by default in 
+`~/.cache/foreman_maintain_completion.yml`. The location can be changed in foreman-maintain's
+config file. The cache can be built manually with 
+`foreman-maintain advanced prebuild-bash-completion` or is built automatically when
+completion is used and the cache is missing (this may cause slight delay). The cache expires 
+after installer scenario answer file changed (it indicates that the features on the instance
+may have changed which has impact on foreman-maintain CLI options and subcommands).
+
+####  Available value types
+
+Completion of values is dependent on CLI option and prameter settings, e.g.:
+
+```ruby
+  parameter 'BACKUP_DIR', 'Path to backup dir', :completion => { :type => :directory }
+```
+
+Possible options for the `:completion` attribute are:
+ - `{ :type => :flag }` option has no value, default for flags
+ - `{ :type => :value }` option has value of unknown type, no suggestions for the value, default
+ - `{ :type => :directory }` value is directory, suggestions follow directory structure
+ - `{ :type => :file, :filter => '\.txt$' }` value is file, suggestions follow directory structure, 
+ 	optional `:filter` is regexp to filter the results.
+ 
+
 ## How to contribute?
 
 Generally, follow the [Foreman guidelines](https://theforeman.org/contribute.html). For code-related contributions, fork this project and send a pull request with all changes. Some things to keep in mind:

data/bin/foreman-maintain-complete

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'English'
+project_root = File.expand_path('../..', __FILE__)
+$LOAD_PATH.unshift(File.join(project_root, 'lib'))
+CONFIG_FILE = '/etc/foreman-maintain/foreman_maintain.yml'.freeze
+system('which foreman_maintain > /dev/null 2>&1')
+found = $CHILD_STATUS.success?
+FOREMAN_MAINTAIN = found ? 'foreman-maintain' : File.join(project_root, 'bin/foreman-maintain')
+
+require 'yaml'
+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]
+rescue
+end
+# rubocop:enable Lint/RescueWithoutErrorClass, Lint/HandleExceptions
+
+config_file = if File.exist?(CONFIG_FILE)
+                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 = File.expand_path(completion_cache_file)
+
+# build the cache if it does not exist
+`#{FOREMAN_MAINTAIN} advanced prebuild-bash-completion` unless File.exist?(completion_cache_file)
+
+dict = ForemanMaintain::Utils::Bash::Completion.load_description(completion_cache_file)
+
+# regenerate and reload cache if it expired
+sha1sum = `sha1sum #{dict[:expire][:file]}`
+if sha1sum.strip != dict[:expire][:sha1sum].strip
+  `#{FOREMAN_MAINTAIN} advanced prebuild-bash-completion`
+  dict = ForemanMaintain::Utils::Bash::Completion.load_description(completion_cache_file)
+end
+
+comp_line = ENV['COMP_LINE'] || ''
+comp_args = comp_line.split(' ', 2).last || ''
+
+result = ForemanMaintain::Utils::Bash::Completion.new(dict).complete(comp_args)
+
+puts result.join("\n")

data/config/foreman-maintain.completion

@@ -0,0 +1,5 @@
+#
+# Foreman Maintain bash completion script
+#
+
+complete -C foreman-maintain-complete -o nospace foreman-maintain

data/config/foreman_maintain.yml

@@ -0,0 +1,21 @@
+# 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 log file size in KB. Default set to 10000KB.
+# :log_file_size: 10000
+
+# 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: '/tmp/foreman-maintain'
+
+# Mention path where foreman-proxy certificates stored on filesystem
+# :foreman_proxy_cert_path: '/etc/foreman'

data/config/foreman_maintain.yml.example

@@ -23,3 +23,5 @@
 # Mention directory path to store candlepin db backups
 # :db_backup_dir: '/var/lib/foreman-maintain/db-backups'
 
+# Location of cache for bash completion
+:completion_cache_file: '~/.cache/foreman_maintain_completion.yml'

data/config/foreman_maintain.yml.packaging

@@ -22,3 +22,6 @@
 
 # Mention directory path to store candlepin db backups
 # :db_backup_dir: '/var/lib/foreman-maintain/db-backups'
+
+# Location of cache for bash completion
+:completion_cache_file: '~/.cache/foreman_maintain_completion.yml'

data/config/hammer.yml.example

@@ -0,0 +1,3 @@
+:foreman:
+  :username:
+  :password:

data/config/passenger-recycler.yaml

@@ -0,0 +1,37 @@
+---
+#
+# Trivial Passenger memory monitor. By default it is executed from cron every
+# five minutes and it kills one process that exceeds the RSS memory threashold
+# configured.
+#
+
+# Set to 'false' to completely disable this script.
+:ENABLED: true
+
+# RSS memory threashold to recycle processes (in kB).
+:MAX_PRIV_RSS_MEMORY: 2_000_000
+
+# Controls amount of processes killed during one run. This number should be
+# smaller by one or two than maximum allowed amount of processes by passenger
+# (defaults to 6) so there is at least one process left.
+:MAX_TERMINATION: 4
+
+# Kill processes which do not terminate gracefully using SIGKILL after
+# GRACEFUL_SHUTDOWN_SLEEP period.
+:KILL_BUSY: true
+
+# Amount of seconds to wait for graceful shutdown (SIGTERM) until a process
+# kill (SIGKILL) is sent. Must be lower than 15 minutes (900 seconds). This
+# gives Passenger some extra time for respawning application before another
+# process is terminated.
+:GRACEFUL_SHUTDOWN_SLEEP: 90
+
+# Print 'passenger-status' and 'ps' output before termination to get some extra
+# information via email from cron. Only printed when a kill is performed.
+:SEND_STATUS: true
+
+# Print verbose information "Process terminating" or "Process killed".
+:VERBOSE: true
+
+# Print extra debugging information.
+:DEBUG: false

data/definitions/features/downstream.rb

@@ -38,7 +38,7 @@ class Features::Downstream < ForemanMaintain::Feature
   end
 
   def absent_repos(version)
-    all_repo_lines = execute(%(LANG=en_US.utf-8 subscription-manager repos --list | ) +
+    all_repo_lines = execute(%(LANG=en_US.utf-8 subscription-manager repos --list 2>&1 | ) +
                               %(grep '^Repo ID:')).split("\n")
     all_repos = all_repo_lines.map { |line| line.split(/\s+/).last }
     repos_required = rh_repos(version)

data/definitions/features/installer.rb

@@ -20,13 +20,21 @@ class Features::Installer < ForemanMaintain::Feature
   end
 
   def answers
+    load_answers(configuration)
+  end
+
+  def configuration
+    YAML.load_file(config_file)
+  end
+
+  def config_file
     case @installer_type
     when :scenarios
-      last_scenario_answers
+      last_scenario_config
     when :legacy_katello
-      load_answers(File.join(config_directory, 'katello-installer.yaml'))
+      File.join(config_directory, 'katello-installer.yaml')
     when :legacy_capsule
-      load_answers(File.join(config_directory, 'capsule-installer.yaml'))
+      File.join(config_directory, 'capsule-installer.yaml')
     end
   end
 
@@ -87,19 +95,10 @@ class Features::Installer < ForemanMaintain::Feature
 
   private
 
-  def load_answers(config_file)
-    config = YAML.load_file(config_file)
+  def load_answers(config)
     YAML.load_file(config[:answer_file])
   end
 
-  def scenario_answers(scenario)
-    load_answers(File.join(config_directory, "scenarios.d/#{scenario}.yaml"))
-  end
-
-  def last_scenario_answers
-    scenario_answers(last_scenario)
-  end
-
   def last_scenario_config
     Pathname.new(File.join(config_directory, 'scenarios.d/last_scenario.yaml')).realpath.to_s
   end

data/lib/foreman_maintain/cli/advanced/prebuild_bash_completion.rb

@@ -0,0 +1,20 @@
+require 'fileutils'
+
+module ForemanMaintain
+  module Cli
+    class PrebuildBashCompletionCommand < Base
+      include ForemanMaintain::Concerns::SystemHelpers
+      def execute
+        comp_map = ForemanMaintain::Cli::MainCommand.completion_map
+        answers = feature(:installer).configuration[:answer_file]
+        comp_map[:expire] = {
+          :file => answers,
+          :sha1sum => execute!("sha1sum #{answers}")
+        }
+        cache_dir = File.dirname(ForemanMaintain.config.completion_cache_file)
+        FileUtils.mkdir_p(cache_dir) unless File.directory?(cache_dir)
+        File.write(ForemanMaintain.config.completion_cache_file, comp_map.to_yaml)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/advanced_command.rb

@@ -1,9 +1,13 @@
 require 'foreman_maintain/cli/advanced/procedure_command'
+require 'foreman_maintain/cli/advanced/prebuild_bash_completion'
 
 module ForemanMaintain
   module Cli
     class AdvancedCommand < Base
       subcommand 'procedure', 'Run maintain procedures manually', ProcedureCommand
+      subcommand 'prebuild-bash-completion',
+                 'Prepare map of options and subcommands for Bash completion',
+                 PrebuildBashCompletionCommand
     end
   end
 end

data/lib/foreman_maintain/cli/backup_command.rb

@@ -33,6 +33,7 @@ module ForemanMaintain
         def common_backup_options
           # TODO: BACKUP_DIR in f-m config - should be default?
           parameter 'BACKUP_DIR', 'Path to backup dir',
+                    :completion => { :type => :directory },
                     :attribute_name => :backup_root_dir do |dir|
             File.expand_path(dir)
           end
@@ -44,7 +45,8 @@ module ForemanMaintain
             self.class.valid_tape_size(size)
           end
           option ['-i', '--incremental'], 'PREVIOUS_BACKUP_DIR',
-                 'Backup changes since previous backup' do |dir|
+                 'Backup changes since previous backup',
+                 :completion => { :type => :directory } do |dir|
             unless File.directory?(dir)
               raise ArgumentError, "Previous backup directory does not exist: #{dir}"
             end

data/lib/foreman_maintain/cli/base.rb

@@ -67,8 +67,33 @@ module ForemanMaintain
         collection.inject([]) { |array, item| array.concat(item.tags).uniq }.sort_by(&:to_s)
       end
 
+      def self.completion_map
+        completion = {}
+        # collect options
+        recognised_options.each do |opt|
+          opt.switches.each do |switch|
+            completion[switch] = completion_types.fetch(switch, {})
+          end
+        end
+        # collect subcommands recursively
+        recognised_subcommands.each do |cmd|
+          completion[cmd.names.first] = cmd.subcommand_class.completion_map
+        end
+        # collect params
+        completion[:params] = completion_types[:params] unless completion_types[:params].empty?
+        completion
+      end
+
+      def self.completion_types
+        @completion_types ||= { :params => [] }
+      end
+
       def self.option(switches, type, description, opts = {}, &block)
         multivalued = opts.delete(:multivalued)
+        completion_type = opts.delete(:completion)
+        completion_type = { :type => :flag } if completion_type.nil? && type == :flag
+        completion_type ||= { :type => :value }
+        [switches].flatten(1).each { |s| completion_types[s] = completion_type }
         description += ' (comma-separated list)' if multivalued
         super(switches, type, description, opts) do |value|
           value = CSVParser.new.parse(value) if multivalued
@@ -77,6 +102,15 @@ module ForemanMaintain
         end
       end
 
+      def self.parameter(name, description, opts = {}, &block)
+        unless [:subcommand_name, :subcommand_arguments].include?(opts[:attribute_name])
+          completion_type = opts.delete(:completion)
+          completion_type ||= { :type => :value }
+          completion_types[:params] << completion_type
+        end
+        super(name, description, opts, &block)
+      end
+
       def self.label_option
         option '--label', 'label',
                'Limit only for a specific label. ' \

data/lib/foreman_maintain/cli/restore_command.rb

@@ -3,10 +3,10 @@ module ForemanMaintain
     class RestoreCommand < Base
       interactive_option
       parameter 'BACKUP_DIR', 'Path to backup directory to restore',
-                :attribute_name => :backup_dir
+                :attribute_name => :backup_dir, :completion => { :type => :directory }
 
       option ['-i', '--incremental'], :flag, 'Restore an incremental backup',
-             :attribute_name => :incremental
+             :attribute_name => :incremental, :completion => { :type => :directory }
 
       def execute
         scenario = Scenarios::Restore.new(

data/lib/foreman_maintain/config.rb

@@ -4,7 +4,7 @@ module ForemanMaintain
     attr_accessor :pre_setup_log_messages,
                   :config_file, :definitions_dirs, :log_level, :log_dir, :log_file_size,
                   :storage_file, :backup_dir, :foreman_proxy_cert_path,
-                  :db_backup_dir
+                  :db_backup_dir, :completion_cache_file
 
     def initialize(options)
       @pre_setup_log_messages = []
@@ -15,6 +15,9 @@ module ForemanMaintain
       load_log_configs
       load_backup_dir_paths
       @foreman_proxy_cert_path = @options.fetch(:foreman_proxy_cert_path, '/etc/foreman')
+      @completion_cache_file = File.expand_path(
+        @options.fetch(:completion_cache_file, '~/.cache/foreman_maintain_completion.yml')
+      )
     end
 
     private

data/lib/foreman_maintain/utils/bash.rb

@@ -0,0 +1,123 @@
+require 'yaml'
+
+module ForemanMaintain
+  module Utils
+    module Bash
+      class Completion
+        def initialize(dict)
+          @dict = dict
+        end
+
+        def complete(line)
+          @complete_line = line.end_with?(' ')
+          full_path = line.split(' ')
+          complete_path = @complete_line ? full_path : full_path[0..-2]
+          dict, path = traverse_tree(@dict, complete_path)
+
+          return [] unless path.empty? # lost during traversing
+
+          partial = @complete_line ? '' : full_path.last
+          finish_word(dict, partial)
+        end
+
+        def self.load_description(path)
+          YAML.load(File.open(path))
+        rescue Errno::ENOENT
+          {}
+        end
+
+        private
+
+        def finish_word(dict, incomplete)
+          finish_option_value(dict, incomplete) ||
+            (finish_option_or_subcommand(dict, incomplete) + finish_param(dict, incomplete))
+        end
+
+        def finish_option_or_subcommand(dict, incomplete)
+          dict.keys.select { |k| k.is_a?(String) && k =~ /^#{incomplete}/ }.map { |k| k + ' ' }
+        end
+
+        def complete_value(value_description, partial, is_param)
+          case value_description[:type]
+          when :value
+            if !partial.empty?
+              []
+            elsif is_param
+              ['--->', 'Add parameter']
+            else
+              ['--->', 'Add option <value>']
+            end
+          when :directory
+            directories(partial)
+          when :file
+            files(partial, value_description)
+          end
+        end
+
+        def finish_param(dict, incomplete)
+          if dict[:params] && !dict[:params].empty?
+            complete_value(dict[:params].first, incomplete, true)
+          else
+            []
+          end
+        end
+
+        def finish_option_value(dict, incomplete)
+          complete_value(dict, incomplete, false) if dict.key?(:type)
+        end
+
+        def traverse_tree(dict, path)
+          return [dict, []] if path.nil? || path.empty?
+          result = if dict.key?(path.first)
+                     if path.first.start_with?('-')
+                       parse_option(dict, path)
+                     else
+                       parse_subcommand(dict, path)
+                     end
+                   elsif dict[:params]
+                     # traverse params one by one
+                     parse_params(dict, path)
+                   else
+                     # not found
+                     [{}, path]
+                   end
+          result
+        end
+
+        def parse_params(dict, path)
+          traverse_tree({ :params => dict[:params][1..-1] }, path[1..-1])
+        end
+
+        def parse_subcommand(dict, path)
+          traverse_tree(dict[path.first], path[1..-1])
+        end
+
+        def parse_option(dict, path)
+          if dict[path.first][:type] == :flag # flag
+            traverse_tree(dict, path[1..-1])
+          elsif path.length >= 2 # option with value
+            traverse_tree(dict, path[2..-1])
+          else # option with value missing
+            [dict[path.first], path[1..-1]]
+          end
+        end
+
+        def directories(partial = '')
+          dirs = []
+          dirs += Dir.glob("#{partial}*").select { |f| File.directory?(f) }
+          dirs = dirs.map { |d| d + '/' } if dirs.length == 1
+          dirs
+        end
+
+        def files(partial = '', opts = {})
+          filter = opts.fetch(:filter, '.*')
+          file_names = []
+          file_names += Dir.glob("#{partial}*").select do |f|
+            File.directory?(f) || f =~ /#{filter}/
+          end
+          file_names.map { |f| File.directory?(f) ? f + '/' : f + ' ' }
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/utils.rb

@@ -1,5 +1,6 @@
 require 'foreman_maintain/utils/command_runner'
 require 'foreman_maintain/utils/disk'
+require 'foreman_maintain/utils/bash'
 require 'foreman_maintain/utils/hash_tools'
 require 'foreman_maintain/utils/curl_response'
 require 'foreman_maintain/utils/mongo_core'

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.2.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -100,6 +100,7 @@ email: inecas@redhat.com
 executables:
 - foreman-maintain
 - passenger-recycler
+- foreman-maintain-complete
 - foreman-maintain-rotate-tar
 extensions: []
 extra_rdoc_files:
@@ -109,10 +110,15 @@ files:
 - LICENSE
 - README.md
 - bin/foreman-maintain
+- bin/foreman-maintain-complete
 - bin/foreman-maintain-rotate-tar
 - bin/passenger-recycler
+- config/foreman-maintain.completion
+- config/foreman_maintain.yml
 - config/foreman_maintain.yml.example
 - config/foreman_maintain.yml.packaging
+- config/hammer.yml.example
+- config/passenger-recycler.yaml
 - definitions/checks/backup/certs_tar_exist.rb
 - definitions/checks/backup/directory_ready.rb
 - definitions/checks/candlepin/db_up.rb
@@ -233,6 +239,7 @@ files:
 - lib/foreman_maintain.rb
 - lib/foreman_maintain/check.rb
 - lib/foreman_maintain/cli.rb
+- lib/foreman_maintain/cli/advanced/prebuild_bash_completion.rb
 - lib/foreman_maintain/cli/advanced/procedure/abstract_by_tag_command.rb
 - lib/foreman_maintain/cli/advanced/procedure/abstract_procedure_command.rb
 - lib/foreman_maintain/cli/advanced/procedure/by_tag_command.rb
@@ -275,6 +282,7 @@ files:
 - lib/foreman_maintain/upgrade_runner.rb
 - lib/foreman_maintain/utils.rb
 - lib/foreman_maintain/utils/backup.rb
+- lib/foreman_maintain/utils/bash.rb
 - lib/foreman_maintain/utils/command_runner.rb
 - lib/foreman_maintain/utils/curl_response.rb
 - lib/foreman_maintain/utils/disk.rb
@@ -307,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt