machinery-tool 1.18.0 → 1.19.0

data/lib/serve_html_task.rb

@@ -16,8 +16,21 @@
 # you may find current contact information at www.suse.com
 
 class ServeHtmlTask
+  def assemble_url(opts)
+    host = if !opts[:public]
+      "127.0.0.1"
+    else
+      begin
+        Socket.gethostbyname(Socket.gethostname).first
+      rescue SocketError
+        Socket.gethostname
+      end
+    end
+    "http://#{host}:#{opts[:port]}/"
+  end
+
   def serve(system_description_store, opts)
-    url = "http://127.0.0.1:#{opts[:port]}/"
+    url = assemble_url(opts)
     Machinery::Ui.use_pager = false
     Machinery::Ui.puts <<EOF
 Trying to start a web server for serving a view on all system descriptions.
@@ -26,7 +39,7 @@ The overview of all descriptions is accessible at:
 
     #{url}
 
-A specific descriptions with the name NAME is accessible at:
+A specific description with the name NAME is accessible at:
 
     #{url}NAME
 

data/lib/server.rb

@@ -50,7 +50,7 @@ class Server < Sinatra::Base
     end
 
     def scope_meta_info(scope)
-      return "" if !@description[scope]
+      return "" unless @description[scope]
 
       " (" \
       "inspected host: '#{@description[scope].meta.hostname}', " \
@@ -229,6 +229,7 @@ class Server < Sinatra::Base
     urls: %w[/site],
     try: ["index.html"]
 
+  enable :sessions
 
   get "/descriptions/:id/files/:scope/*" do
     description = SystemDescription.load(params[:id], settings.system_description_store)
@@ -251,6 +252,7 @@ class Server < Sinatra::Base
   end
 
   get "/" do
+    check_session_for_error
     descriptions = settings.system_description_store.list
     @all_descriptions = Hash.new
 
@@ -298,11 +300,11 @@ class Server < Sinatra::Base
       elsif @description_a[scope] || @description_b[scope]
         @meta[:uninspected] ||= Hash.new
 
-        if !@description_a[scope]
+        unless @description_a[scope]
           @meta[:uninspected][@description_a.name] ||= Array.new
           @meta[:uninspected][@description_a.name] << scope
         end
-        if !@description_b[scope]
+        unless @description_b[scope]
           @meta[:uninspected][@description_b.name] ||= Array.new
           @meta[:uninspected][@description_b.name] << scope
         end
@@ -328,17 +330,35 @@ class Server < Sinatra::Base
   end
 
   get "/:id" do
-    @description = SystemDescription.load(params[:id], settings.system_description_store)
-
-    diffs_dir = @description.scope_file_store("analyze/config_file_diffs").path
-    if @description.config_files && diffs_dir
-      # Enrich description with the config file diffs
-      @description.config_files.each do |file|
-        path = File.join(diffs_dir, file.name + ".diff")
-        file.diff = diff_to_object(File.read(path)) if File.exists?(path)
+    begin
+      @description = SystemDescription.load(params[:id], settings.system_description_store)
+    rescue Machinery::Errors::SystemDescriptionNotFound => e
+      session[:error] = e.to_s
+      redirect "/"
+    rescue Machinery::Errors::SystemDescriptionIncompatible => e
+      @error = e
+      haml File.read(File.join(Machinery::ROOT, "html/upgrade.html.haml"))
+    else
+      diffs_dir = @description.scope_file_store("analyze/changed_config_files_diffs").path
+      if @description.changed_config_files && diffs_dir
+        # Enrich description with the config file diffs
+        @description.changed_config_files.each do |file|
+          path = File.join(diffs_dir, file.name + ".diff")
+          file.diff = diff_to_object(File.read(path)) if File.exist?(path)
+        end
       end
+
+      haml File.read(File.join(Machinery::ROOT, "html/index.html.haml"))
     end
+  end
+
+  private
 
-    haml File.read(File.join(Machinery::ROOT, "html/index.html.haml"))
+  def check_session_for_error
+    if session[:error]
+      @errors ||= Array.new
+      @errors.push(session[:error])
+      session.clear
+    end
   end
 end

data/lib/system.rb

@@ -72,7 +72,7 @@ class System
     Machinery.logger.info(
       "The following files are packaged in #{archive}: " + Array(file_list).join(", ")
     )
-    created = !File.exists?(archive)
+    created = !File.exist?(archive)
     out = File.open(archive, "w")
     begin
       run_command(

data/lib/system_description.rb

@@ -26,10 +26,10 @@
 # The sub directories storing the data for specific scopes are handled by the
 # ScopeFileStore class.
 class SystemDescription < Machinery::Object
-  CURRENT_FORMAT_VERSION = 7
+  CURRENT_FORMAT_VERSION = 8
   EXTRACTABLE_SCOPES = [
     "changed_managed_files",
-    "config_files",
+    "changed_config_files",
     "unmanaged_files"
   ]
 
@@ -49,7 +49,7 @@ class SystemDescription < Machinery::Object
       description = from_hash(name, store, manifest.to_hash)
       description.validate_file_data!
 
-      if !options[:skip_format_compatibility]
+      unless options[:skip_format_compatibility]
         description.validate_format_compatibility
       end
 
@@ -62,12 +62,12 @@ class SystemDescription < Machinery::Object
     # loading of the system description succeeds.
     def load(name, store, options = {})
       manifest = Manifest.load(name, store.manifest_path(name))
-      manifest.validate if !options[:skip_validation]
+      manifest.validate unless options[:skip_validation]
 
       description = from_hash(name, store, manifest.to_hash)
-      description.validate_file_data if !options[:skip_validation]
+      description.validate_file_data unless options[:skip_validation]
 
-      description.validate_format_compatibility if !options[:skip_format_compatibility]
+      description.validate_format_compatibility unless options[:skip_format_compatibility]
 
       description
     end
@@ -90,7 +90,7 @@ class SystemDescription < Machinery::Object
       begin
         json_format_version = hash["meta"]["format_version"] if hash["meta"]
         description = SystemDescription.new(name, store, hash)
-      rescue NameError, TypeError
+      rescue NameError, TypeError, RuntimeError
         if json_format_version && json_format_version != SystemDescription::CURRENT_FORMAT_VERSION
           raise Machinery::Errors::SystemDescriptionIncompatible.new(name, json_format_version)
         else
@@ -148,7 +148,7 @@ class SystemDescription < Machinery::Object
   end
 
   def validate_format_compatibility
-    if !compatible?
+    unless compatible?
       raise Machinery::Errors::SystemDescriptionIncompatible.new(name, format_version)
     end
   end
@@ -197,7 +197,7 @@ class SystemDescription < Machinery::Object
     SystemDescription.validate_name(name)
     @store.directory_for(name)
     path = @store.manifest_path(name)
-    created = !File.exists?(path)
+    created = !File.exist?(path)
     File.write(path, to_json)
     File.chmod(0600, path) if created
   end
@@ -207,7 +207,7 @@ class SystemDescription < Machinery::Object
   end
 
   def set_filter_definitions(command, filter)
-    if !["inspect"].include?(command)
+    unless ["inspect"].include?(command)
       raise Machinery::Errors::MachineryError.new(
         "Storing the filter for command '#{command}' is not supported."
       )
@@ -221,12 +221,14 @@ class SystemDescription < Machinery::Object
   end
 
   def assert_scopes(*scopes)
-    missing = scopes.select { |scope| !self[scope] }
+    missing = scopes.select { |scope| !self[scope] }.map { |scope|
+      Machinery::Ui.internal_scope_list_to_string(scope)
+    }
 
     unless missing.empty?
       raise Machinery::Errors::SystemDescriptionError.new(
         "The system description misses the following" \
-          " #{Machinery.pluralize(missing.size, "scope")} : #{missing.join(", ")}."
+          " #{Machinery.pluralize(missing.size, "scope")}: #{missing.join(",")}."
       )
     end
   end
@@ -254,7 +256,7 @@ class SystemDescription < Machinery::Object
 
   def validate_file_data
     errors = FileValidator.new(to_hash, description_path).validate
-    if !errors.empty?
+    unless errors.empty?
       Machinery::Ui.warn("Warning: File validation errors:")
       Machinery::Ui.warn("Error validating description '#{@name}'\n\n")
       Machinery::Ui.warn(errors.join("\n"))
@@ -263,7 +265,7 @@ class SystemDescription < Machinery::Object
 
   def validate_file_data!
     errors = FileValidator.new(to_hash, description_path).validate
-    if !errors.empty?
+    unless errors.empty?
       e = Machinery::Errors::SystemDescriptionValidationFailed.new(errors)
       e.header = "Error validating description '#{@name}'"
       raise e

data/lib/system_description_store.rb

@@ -51,8 +51,9 @@ class SystemDescriptionStore
 
   def list
     Dir["#{@base_path}/*"].
-      select { |item| File.exists?(manifest_path(File.basename(item)))}.
-      map { |item| File.basename(item) }.sort
+      select { |item| File.exist?(manifest_path(File.basename(item))) }.map { |item|
+        File.basename(item)
+      }.sort
   end
 
   def remove(name)
@@ -124,9 +125,7 @@ class SystemDescriptionStore
   private
 
   def create_dir(dir, mode = 0700)
-    unless Dir.exists?(dir)
-      FileUtils.mkdir_p(dir, mode: mode)
-    end
+    FileUtils.mkdir_p(dir, mode: mode) unless Dir.exist?(dir)
   end
 
   def get_backup_name(description_name)
@@ -142,7 +141,7 @@ class SystemDescriptionStore
   end
 
   def validate_existence_of_description(description_name)
-    if !list.include?(description_name)
+    unless list.include?(description_name)
       raise Machinery::Errors::SystemDescriptionNotFound.new(
         "System description '#{description_name}' does not exist."
       )

data/lib/ui.rb

@@ -82,7 +82,7 @@ module Machinery
       end
 
       def progress(output)
-        return if !progress_enabled?
+        return unless progress_enabled?
 
         reset_line if progress_visible?
         print output

data/lib/upgrade_format_task.rb

@@ -50,7 +50,7 @@ class UpgradeFormatTask
       end
     end
 
-    if !errors.empty?
+    unless errors.empty?
       Machinery.logger.error errors.join("\n")
       exception = Machinery::Errors::UpgradeFailed.new("\n" + errors.join("\n") +
         Hint.to_string(:upgrade_format_force, name: name || "--all"))
@@ -61,7 +61,7 @@ class UpgradeFormatTask
       if migrations_done > 0
         Machinery::Ui.puts(
           "Upgraded #{migrations_done} " \
-            "#{Machinery::pluralize(migrations_done, "system description", "system descriptions")}."
+            "#{Machinery.pluralize(migrations_done, "system description", "system descriptions")}."
         )
       else
         Machinery::Ui.puts "No system descriptions were upgraded."

data/lib/version.rb

@@ -17,6 +17,6 @@
 
 module Machinery
 
-  VERSION = "1.18.0"
+  VERSION = "1.19.0"
 
 end

data/lib/workload_mapper.rb

@@ -62,14 +62,14 @@ class WorkloadMapper
   end
 
   def identify_workloads(system_description)
-    system_description.assert_scopes("services", "unmanaged_files", "config_files")
+    system_description.assert_scopes("services", "unmanaged_files", "changed_config_files")
 
-    ["unmanaged_files", "config_files"].each do |scope|
-      if !system_description.scope_extracted?(scope)
-        raise Machinery::Errors::SystemDescriptionError.new(
-          "Required scope: '#{scope}' was not extracted. Can't continue."
-        )
-      end
+    ["unmanaged_files", "changed_config_files"].each do |scope|
+      next if system_description.scope_extracted?(scope)
+
+      raise Machinery::Errors::SystemDescriptionError.new(
+        "Required scope: '#{scope}' was not extracted. Can't continue."
+      )
     end
 
     workloads = {}
@@ -94,19 +94,19 @@ class WorkloadMapper
 
   def extract(system_description, workloads, path)
     Dir.mktmpdir do |dir|
-      if !workloads.select { |_, w| w["data"] }.empty?
+      unless workloads.select { |_, w| w["data"] }.empty?
         system_description.unmanaged_files.export_files_as_tarballs(dir)
         workloads.each do |workload, config|
           config.fetch("data", {}).each do |origin, destination|
             file = system_description.unmanaged_files.find { |f| f.name == origin }
-            file ||= system_description.config_files.find { |f| f.name == origin }
+            file ||= system_description.changed_config_files.find { |f| f.name == origin }
             if file && file.directory?
               tgz_file = File.join(dir, "trees", "#{origin.chop}.tgz")
               output_path = File.join(path, workload, destination)
               FileUtils.mkdir_p(output_path)
               strip_number = origin.split("/").size - 1
               Cheetah.run("tar", "zxf", tgz_file, "-C", output_path, "--strip=#{strip_number}")
-              copy_workload_config_files(workload, output_path)
+              copy_workload_changed_config_files(workload, output_path)
             end
             if file && file.file?
               output_path = File.join(path, workload, destination, origin)
@@ -121,7 +121,7 @@ class WorkloadMapper
 
   private
 
-  def copy_workload_config_files(workload, path)
+  def copy_workload_changed_config_files(workload, path)
     FileUtils.cp_r(File.join(workload_mapper_path, workload, "config", "."), path)
   end
 

data/lib/zypper.rb

@@ -77,7 +77,7 @@ class Zypper
     raw_xml = call_zypper "-x", "download", package, stdout: :capture
 
     xml = REXML::Document.new(raw_xml)
-    xml.elements["//localfile"].attributes["path"]
+    xml.elements["//localfile"].attributes["path"] if xml.elements["//localfile"]
   end
 
   def version

data/machinery-helper/Rakefile

@@ -24,5 +24,5 @@ HELPER_DIR = File.expand_path(File.dirname(__FILE__))
 desc "Build the helper if needed"
 task :build do
   helper_builder = HelperBuilder.new(HELPER_DIR)
-  raise "Error: Build of Machinery helper failed" if !helper_builder.run_build
+  raise "Error: Build of Machinery helper failed" unless helper_builder.run_build
 end

data/machinery-helper/version.go

@@ -2,4 +2,4 @@
 
 package main
 
-const VERSION = "8df1e753fd5f3ef8a5bcfed6eb932b864acbebde"
+const VERSION = "2b9173e39c9aa1b627b29893d7374eae4378e029"

data/manual/docs/machinery-analyze.1.md

@@ -12,8 +12,8 @@
 The `analyze` subcommand analyzes an existing system description and enriches
 it with additional information. Supported operations are:
 
-  * `config-file-diffs`:
-    Generates the diffs between the extracted changed config files from the
+  * `changed-config-files-diffs`:
+    Generates the diffs between the extracted changed configuration files from the
     system and the original versions from the RPM packages.
     The diffs can be shown using `machinery show --show-diffs`
 
@@ -34,4 +34,4 @@ it with additional information. Supported operations are:
 
  * Analyze the config file diffs for the `myhost` system description:
 
-    $ `machinery` analyze myhost --operation=config-file-diffs
+    $ `machinery` analyze myhost --operation=changed-config-files-diffs

data/manual/docs/machinery-compare.1.md

@@ -3,7 +3,7 @@
 
 ## SYNOPSIS
 
-`machinery compare` [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-all] [--html] NAME1 NAME2
+`machinery compare` [-s SCOPE | --scope=SCOPE] [-e IGNORE-SCOPE | --ignore-scope=IGNORE-SCOPE] [--no-pager] [--show-all] [--html] NAME1 NAME2
 
 `machinery` help compare
 
@@ -29,7 +29,7 @@ be used to limit the output to the given scopes.
     Limit output to the specified scope.
     See the [Scope section](#Scopes) for more information.
 
-  * `-e SCOPE`, `--exclude-scope=EXCLUDE-SCOPE` (optional):
+  * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
     Skip output of the specified scope.
     See the [Scope section](#Scopes) for more information.
 

data/manual/docs/machinery-inspect-docker.1.md

@@ -43,7 +43,7 @@ trigger errors.
     Inspect image for specified scope.
     See the [Scope section](#Scopes) for more information.
 
-  * `-e SCOPE`, `--exclude-scope=EXCLUDE-SCOPE` (optional):
+  * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
     Inspect image for all scopes except the specified scope.
     See the [Scope section](#Scopes) for more information.
 

data/manual/docs/machinery-inspect.1.md

@@ -20,6 +20,9 @@ The system data is structured into scopes, controlled by the
 Machinery will always inspect all specified scopes, and skip scopes which
 trigger errors.
 
+**Note**:
+Tasks on Debian-like systems are treated as patterns.
+
 
 ## ARGUMENTS
 
@@ -38,7 +41,7 @@ trigger errors.
     Inspect system for specified scope.
     See the [Scope section](machinery_main_scopes.1/index.html) for more information.
 
-  * `-e SCOPE`, `--exclude-scope=EXCLUDE-SCOPE` (optional):
+  * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
     Inspect system for all scopes except the specified scope.
     See the [Scope section](machinery_main_scopes.1/index.html) for more information.