machinery-tool 1.18.0 → 1.19.0

data/lib/cli.rb

@@ -41,7 +41,7 @@ class Cli
   end
 
   post do |global_options,command,options,args|
-    if command.is_a?(GLI::Commands::Help) && !global_options[:version] && ARGV == ["help"]
+    if (command.is_a?(GLI::Commands::Help) && !global_options[:version]) || ARGV == ["help"]
 
       Machinery::Ui.puts "\nFor more detailed information, open the documentation by typing " \
         "'machinery man --html'.\nIf you are unable to find a solution within the man page " \
@@ -168,7 +168,7 @@ class Cli
   end
 
   def self.shift_arg(args, name)
-    if !res = args.shift
+    unless res = args.shift
       raise GLI::BadCommandLine.new("You need to provide the required argument #{name}.")
     end
     res
@@ -177,19 +177,19 @@ class Cli
   def self.process_scope_option(scopes, exclude_scopes)
     if scopes
       if exclude_scopes
-        # scope and exclude-scope
+        # scope and ignore-scope
         raise Machinery::Errors::InvalidCommandLine.new("You cannot provide the --scope and " \
-          "--exclude-scope option at the same time.")
+          "--ignore-scope option at the same time.")
       else
         # scope only
         scope_list = parse_scopes(scopes)
       end
     else
       if exclude_scopes
-        # exclude-scope only
+        # ignore-scope only
         scope_list = Inspector.all_scopes - parse_scopes(exclude_scopes)
       else
-        # neither scope nor exclude-scope
+        # neither scope nor ignore-scope
         scope_list = Inspector.all_scopes
       end
     end
@@ -205,11 +205,18 @@ class Cli
     scopes = []
 
     scope_string.split(",").each do |scope|
-      if !(scope =~ /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/)
+      unless scope =~ /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/
         invalid_scopes << scope
         next
       end
 
+      if scope == "config-files"
+        Machinery::Ui.warn(
+          "The scope name `config-files` is deprecated. The new name is `changed-config-files`."
+        )
+        scope = "changed-config-files"
+      end
+
       # convert cli scope naming to internal one
       scope.tr!("-", "_")
 
@@ -271,28 +278,28 @@ class Cli
 
     The supported operations are:
 
-    - config-file-diffs: Generate diffs against the original version from
-      the package for the modified config files
+    - changed-config-files-diffs: Generate diffs against the original version from
+      the package for the changed configuration files
   LONGDESC
   arg "NAME"
   command "analyze" do |c|
     c.flag [:operation, :o], type: String, required: false,
-      desc: "The analyze operation to perform", arg_name: "OPERATION", default_value: "config-file-diffs"
+      desc: "The analyze operation to perform", arg_name: "OPERATION", default_value: "changed-config-files-diffs"
 
     c.action do |global_options,options,args|
       name = shift_arg(args, "NAME")
       description = SystemDescription.load(name, system_description_store)
 
       case options[:operation]
-        when "config-file-diffs"
-          task = AnalyzeConfigFileDiffsTask.new
-          task.analyze(description)
-          Hint.print(:show_analyze_data, name: name)
-        else
-          raise Machinery::Errors::InvalidCommandLine.new(
-            "The operation '#{options[:operation]}' is not supported. " \
-            "Valid operations are: config-file-diffs."
-          )
+      when "changed-config-files-diffs"
+        task = AnalyzeConfigFileDiffsTask.new
+        task.analyze(description)
+        Hint.print(:show_analyze_data, name: name)
+      else
+        raise Machinery::Errors::InvalidCommandLine.new(
+          "The operation '#{options[:operation]}' is not supported. " \
+          "Valid operations are: changed-config-files-diffs."
+        )
       end
     end
   end
@@ -341,7 +348,7 @@ class Cli
   command "compare" do |c|
     c.flag [:scope, :s], type: String, required: false,
       desc: "Compare specified scopes", arg_name: "SCOPE_LIST"
-    c.flag ["exclude-scope", :e], type: String, required: false,
+    c.flag ["ignore-scope", :e], type: String, required: false,
       desc: "Exclude specified scopes", arg_name: "SCOPE_LIST"
     c.switch "show-all", required: false, negatable: false,
       desc: "Show also common properties"
@@ -368,7 +375,7 @@ class Cli
       store = system_description_store
       description1 = SystemDescription.load(name1, store)
       description2 = SystemDescription.load(name2, store)
-      scope_list = process_scope_option(options[:scope], options["exclude-scope"])
+      scope_list = process_scope_option(options[:scope], options["ignore-scope"])
 
       task = CompareTask.new
       opts = {
@@ -511,7 +518,7 @@ class Cli
       desc: "Store system description under the specified name"
     c.flag [:scope, :s], type: String, required: false,
       desc: "Show specified scopes", arg_name: "SCOPE_LIST"
-    c.flag ["exclude-scope", :e], type: String, required: false,
+    c.flag ["ignore-scope", :e], type: String, required: false,
       desc: "Exclude specified scopes", arg_name: "SCOPE_LIST"
     c.flag "skip-files", required: false, negatable: false,
       desc: "Do not consider given files or directories during inspection. " \
@@ -535,11 +542,11 @@ class Cli
   end
 
   def self.parse_inspect_command_options(host, options)
-    scope_list = process_scope_option(options[:scope], options["exclude-scope"])
+    scope_list = process_scope_option(options[:scope], options["ignore-scope"])
     name = options[:name] || host
 
 
-    if !scope_list.empty?
+    unless scope_list.empty?
       inspected_scopes = " for #{Machinery::Ui.internal_scope_list_to_string(scope_list)}"
     end
     Machinery::Ui.puts "Inspecting #{host}#{inspected_scopes}..."
@@ -552,7 +559,7 @@ class Cli
       inspect_options[:verbose] = true
     end
     if options["extract-files"] || options["extract-changed-config-files"]
-      inspect_options[:extract_changed_config_files] = true
+      inspect_options[:extract_changed_changed_config_files] = true
     end
     if options["extract-files"] || options["extract-changed-managed-files"]
       inspect_options[:extract_changed_managed_files] = true
@@ -773,12 +780,12 @@ class Cli
     supports_filtering(c)
     c.flag [:scope, :s], type: String, required: false,
       desc: "Show specified scopes", arg_name: "SCOPE_LIST"
-    c.flag ["exclude-scope", :e], type: String, required: false,
+    c.flag ["ignore-scope", :e], type: String, required: false,
       desc: "Exclude specified scopes", arg_name: "SCOPE_LIST"
     c.switch "pager", required: false, default_value: true,
       desc: "Pipe output into a pager"
     c.switch "show-diffs", required: false, negatable: false,
-      desc: "Show diffs of configuration files changes."
+      desc: "Show diffs of changed configuration files changes."
     c.switch "html", required: false, negatable: false,
       desc: "Open system description in HTML format in your web browser."
     c.switch "verbose", required: false, negatable: false,
@@ -802,7 +809,7 @@ class Cli
       end
 
       description = SystemDescription.load(name, system_description_store)
-      scope_list = process_scope_option(options[:scope], options["exclude-scope"])
+      scope_list = process_scope_option(options[:scope], options["ignore-scope"])
 
       filter = FilterOptionParser.parse("show", options)
 
@@ -815,12 +822,12 @@ class Cli
           details += "\n  Type of inspected container: #{description[:environment].system_type}\n"
         end
 
-        if !inspected_filters.empty?
+        unless inspected_filters.empty?
           details += "\n  The following filters were applied during inspection:"
           details += "\n    * " + inspected_filters.join("\n    * ") + "\n\n"
         end
 
-        if !filter.empty?
+        unless filter.empty?
           details += "\n  The following filters were applied before showing the description:"
           details += "\n    * " + filter.to_array.join("\n    * ") + "\n\n"
         end
@@ -869,7 +876,7 @@ class Cli
       desc: "Keep backup after migration and ingnore validation errors"
 
     c.action do |global_options,options,args|
-      name = shift_arg(args, "NAME") if !options[:all]
+      name = shift_arg(args, "NAME") unless options[:all]
 
       task = UpgradeFormatTask.new
       task.upgrade(
@@ -968,7 +975,7 @@ class Cli
   end
 
   def self.system_description_store
-    if ENV.has_key?("MACHINERY_DIR")
+    if ENV.key?("MACHINERY_DIR")
       SystemDescriptionStore.new(ENV["MACHINERY_DIR"])
     else
       SystemDescriptionStore.new

data/lib/compare_task.rb

@@ -74,7 +74,7 @@ EOF
       output = "\n" + output unless output.empty?
       output = "Compared descriptions are identical." + output
     elsif !identical_scopes.empty?
-      phrase = Machinery::pluralize(identical_scopes.count, "scope is", "scopes are")
+      phrase = Machinery.pluralize(identical_scopes.count, "scope is", "scopes are")
       output += "Following #{phrase} identical in both descriptions: " + identical_scopes.join(",")
     end
 

data/lib/config_base.rb

@@ -29,7 +29,7 @@ class ConfigBase
     apply_custom_config(@file) if File.exist?(@file)
   end
 
-  abstract_method :default_config_files
+  abstract_method :default_changed_config_files
 
   abstract_method :define_entries
   abstract_method :deprecated_entries

data/lib/deploy_task.rb

@@ -21,14 +21,14 @@ class DeployTask
     LocalSystem.validate_existence_of_packages(["python-glanceclient", "kiwi", "kiwi-desc-vmxboot"])
     description.validate_build_compatibility
 
-    if !File.exists?(cloud_config)
+    unless File.exist?(cloud_config)
       raise(Machinery::Errors::DeployFailed,
         "The cloud config file '#{cloud_config}' could not be found."
       )
     end
 
     if options[:image_dir]
-      if !Dir.exists?(options[:image_dir])
+      unless Dir.exist?(options[:image_dir])
         raise(Machinery::Errors::DeployFailed,
           "The image directory does not exist."
         )
@@ -50,7 +50,7 @@ class DeployTask
       )
     end
 
-    if !File.exists?(image_file)
+    unless File.exist?(image_file)
       raise(Machinery::Errors::DeployFailed,
         "The image file '#{image_file}' does not exist."
       )
@@ -74,7 +74,7 @@ class DeployTask
 
   def load_meta_data(meta_dir)
       meta_file = File.join(meta_dir, Machinery::IMAGE_META_DATA_FILE)
-      if !File.exists?(meta_file)
+      unless File.exist?(meta_file)
         raise(Machinery::Errors::DeployFailed,
           "The meta data file '#{meta_file}' could not be found."
         )

data/lib/docker_system.rb

@@ -92,7 +92,7 @@ class DockerSystem < System
 
   # Retrieves files specified in file_list from the container and creates an archive.
   def create_archive(file_list, archive, exclude = [])
-    created = !File.exists?(archive)
+    created = !File.exist?(archive)
     out = File.open(archive, "w")
     begin
       helper = MachineryHelper.new(self)

data/lib/element_filter.rb

@@ -22,7 +22,7 @@ class ElementFilter
     @path = path
     @matchers = {}
 
-    if ![NilClass, String, Array].include?(matchers.class)
+    unless [NilClass, String, Array].include?(matchers.class)
       raise Machinery::Errors::InvalidFilter.new("Wrong filter type")
     end
 
@@ -34,7 +34,7 @@ class ElementFilter
   end
 
   def add_matchers(operator, matchers)
-    if ![Filter::OPERATOR_EQUALS, Filter::OPERATOR_EQUALS_NOT].include?(operator)
+    unless [Filter::OPERATOR_EQUALS, Filter::OPERATOR_EQUALS_NOT].include?(operator)
       raise Machinery::Errors::InvalidFilter.new("Wrong filter operator '#{operator}'")
     end
 
@@ -69,7 +69,7 @@ class ElementFilter
         if operator == Filter::OPERATOR_EQUALS
           return true if values_equal
         elsif operator == Filter::OPERATOR_EQUALS_NOT
-          return true if !values_equal
+          return true unless values_equal
         end
       end
     end

data/lib/export_task.rb

@@ -23,7 +23,7 @@ class ExportTask
   def export(output_dir, options)
     @exporter.system_description.assert_scopes("os")
 
-    ["unmanaged_files", "changed_managed_files", "config_files"].each do |scope|
+    ["unmanaged_files", "changed_managed_files", "changed_config_files"].each do |scope|
       if @exporter.system_description[scope] &&
           !@exporter.system_description.scope_extracted?(scope)
         raise Machinery::Errors::MissingExtractedFiles.new(@exporter.system_description, [scope])
@@ -31,7 +31,7 @@ class ExportTask
     end
 
     output_dir = File.join(output_dir, @exporter.export_name)
-    if File.exists?(output_dir)
+    if File.exist?(output_dir)
       if options[:force]
         FileUtils.rm_r(output_dir)
       else
@@ -43,7 +43,7 @@ class ExportTask
     end
 
     begin
-      FileUtils.mkdir_p(output_dir, mode: 0700) if !Dir.exists?(output_dir)
+      FileUtils.mkdir_p(output_dir, mode: 0700) unless Dir.exist?(output_dir)
     rescue Errno::EACCES
       raise(Machinery::Errors::ExportFailed, \
             "Permission denied. Directory '#{output_dir}' is not writable")

data/lib/file_validator.rb

@@ -22,7 +22,7 @@ class FileValidator
 
     @format_version = @json_hash["meta"]["format_version"] if @json_hash["meta"]
 
-    if !@format_version
+    unless @format_version
       raise Machinery::Errors::SystemDescriptionValidationFailed.new(
         ["Could not determine format version"]
       )
@@ -32,13 +32,16 @@ class FileValidator
   def validate
     errors = []
 
-    ["config_files", "changed_managed_files", "unmanaged_files"].each do |scope|
-      next if !scope_extracted?(scope)
+    # the deprecated config_files is still needed to be able to validate older descriptions
+    [
+      "changed_config_files", "config_files", "changed_managed_files", "unmanaged_files"
+    ].each do |scope|
+      next unless scope_extracted?(scope)
 
       expected_files = expected_files(scope)
       file_errors = validate_scope(ScopeFileStore.new(@base_path, scope.to_s), expected_files)
 
-      errors << "Scope '#{scope}':\n" + file_errors.join("\n") if !file_errors.empty?
+      errors << "Scope '#{scope}':\n" + file_errors.join("\n") unless file_errors.empty?
     end
 
     errors
@@ -94,7 +97,7 @@ class FileValidator
   end
 
   def missing_files(file_list)
-    file_list.select { |file| !File.exists?(file) }
+    file_list.select { |file| !File.exist?(file) }
   end
 
   def additional_files(file_list, file_store)

data/lib/filter.rb

@@ -54,7 +54,7 @@ class Filter
     Array(filter_definitions).each do |definition|
       path, operator, matcher_definition = definition.scan(/([a-zA-Z_\/]+)(.*=)(.*)/)[0]
 
-      raise Machinery::Errors::InvalidFilter.new("Invalid filter: '#{definition}'") if !operator
+      raise Machinery::Errors::InvalidFilter.new("Invalid filter: '#{definition}'") unless operator
       element_filters[path] ||= ElementFilter.new(path)
       if matcher_definition.index(",")
         matchers = matcher_definition.split(/(?<!\\),/)
@@ -73,7 +73,7 @@ class Filter
     filter = Filter.new
 
     default_filters_file = File.join(Machinery::ROOT, "filters", "default_filters.json")
-    if File.exists?(default_filters_file)
+    if File.exist?(default_filters_file)
       default_filters = JSON.parse(File.read(default_filters_file))
       if default_filters[command]
         default_filters[command].each do |definition|
@@ -134,7 +134,7 @@ class Filter
 
   def matches?(path, value)
     filter = element_filter_for(path)
-    return false if !filter
+    return false unless filter
 
     filter.matches?(value)
   end
@@ -147,12 +147,12 @@ class Filter
       pointer = system_description
       container = nil
       steps.each do |step|
-        break if !pointer
+        break unless pointer
         pointer = pointer[step]
         container ||= pointer if pointer.is_a?(Machinery::Array)
       end
 
-      next if !pointer
+      next unless pointer
 
       begin
         pointer.delete_if do |element|

data/lib/filter_option_parser.rb

@@ -36,7 +36,7 @@ class FilterOptionParser
     private
 
     def exclude_definitions(exclude)
-      return [] if !exclude
+      return [] unless exclude
 
       filters = if exclude.start_with?("@")
         expand_filter_file(exclude)
@@ -49,7 +49,7 @@ class FilterOptionParser
     end
 
     def skip_files_definitions(skip_files)
-      return [] if !skip_files
+      return [] unless skip_files
 
       files = skip_files.split(/(?<!\\),/) # Do not split on escaped commas
       files = files.flat_map do |file|
@@ -69,7 +69,7 @@ class FilterOptionParser
     def expand_filter_file(path)
       filename = File.expand_path(path[1..-1])
 
-      if !File.exists?(filename)
+      unless File.exist?(filename)
         raise Machinery::Errors::MachineryError.new(
           "The filter file '#{filename}' does not exist."
         )

data/lib/hint.rb

@@ -18,13 +18,13 @@
 class Hint
   class << self
     def print(method, options = {})
-      return if !Machinery::Config.new.hints
+      return unless Machinery::Config.new.hints
 
       Machinery::Ui.puts to_string(method, options)
     end
 
     def to_string(method, options = {})
-      return "" if !Machinery::Config.new.hints
+      return "" unless Machinery::Config.new.hints
 
       "\nHint: #{send(method, options)}\n"
     end
@@ -41,10 +41,15 @@ class Hint
 
     def which_machinery
       `which machinery 2>/dev/null`.chomp
+    rescue Errno::EPIPE => e
+      Machinery.logger.debug "Command `which machinery 2>/dev/null` crashed. " \
+                             "Error was #{e.class}: #{e}"
     end
 
     def get_started(_options)
-      "You can get started by inspecting a system. Run:\n#{program_name} inspect HOSTNAME"
+      "You can get started by inspecting a system. Run:\n'#{program_name} inspect HOSTNAME'\n" \
+      "To inspect a system as a user with sudo rights instead of root run:\n" \
+      "'#{program_name} inspect --remote-user USER HOSTNAME'"
     end
 
     def upgrade_format_force(options)
@@ -58,7 +63,7 @@ class Hint
 
     def show_analyze_data(options)
       "To show the config file diffs you just created run:\n" \
-        "#{program_name} show --scope config-files --show-diffs #{options[:name]}"
+        "#{program_name} show --scope changed-config-files --show-diffs #{options[:name]}"
     end
 
     def do_complete_inspection(options)