machinery-tool 1.22.1 → 1.22.2

data/lib/rpm.rb

@@ -16,15 +16,15 @@
 # you may find current contact information at www.suse.com
 
 # Rpm represents an RPM package on the disk.
-class Rpm
+class Machinery::Rpm
   def initialize(path)
     @path = path
   end
 
   def diff(file, local_file)
     begin
-      cpio = LoggedCheetah.run("rpm2cpio", @path, stdout: :capture)
-      original_config = LoggedCheetah.run(
+      cpio = Machinery::LoggedCheetah.run("rpm2cpio", @path, stdout: :capture)
+      original_config = Machinery::LoggedCheetah.run(
         "cpio", "-iv", "--to-stdout", ".#{file}", stdin: cpio, stdout: :capture
       )
     rescue Cheetah::ExecutionFailed => e
@@ -33,7 +33,7 @@ class Rpm
     end
 
     begin
-      LoggedCheetah.run(
+      Machinery::LoggedCheetah.run(
         "diff", "-u", "--label", "#{File.join("a", file)}", "--from-file=-",
          "--label", "#{File.join("b", file)}", local_file,
         stdin: original_config,

data/lib/rpm_database.rb

@@ -15,7 +15,7 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class RpmDatabase < ManagedFilesDatabase
+class Machinery::RpmDatabase < Machinery::ManagedFilesDatabase
   def managed_files_list(&block)
     @system.run_script_with_progress("changed_files.sh", &block)
   end

data/lib/scope.rb

@@ -72,7 +72,7 @@ module Machinery
       end
 
       def scope_name
-        scope = name.match(/^(.*)Scope$/)[1]
+        scope = name.match(/^Machinery::(.*)Scope$/)[1]
         scope.gsub(/([^A-Z])([A-Z])/, "\\1_\\2").downcase
       end
     end
@@ -92,7 +92,7 @@ module Machinery
     end
 
     def is_extractable?
-      SystemDescription::EXTRACTABLE_SCOPES.include?(self.scope_name)
+      Machinery::SystemDescription::EXTRACTABLE_SCOPES.include?(scope_name)
     end
   end
 end

data/lib/scope_file_access_archive.rb

@@ -1,4 +1,4 @@
-module ScopeFileAccessArchive
+module Machinery::ScopeFileAccessArchive
   def retrieve_files_from_system_as_archive(system, files, excluded_files)
     archive_path = File.join(scope_file_store.path, "files.tgz")
     system.create_archive(files, archive_path, excluded_files)

data/lib/scope_file_access_flat.rb

@@ -1,4 +1,4 @@
-module ScopeFileAccessFlat
+module Machinery::ScopeFileAccessFlat
   def retrieve_files_from_system(system, paths)
     system.retrieve_files(paths, scope_file_store.path)
   end

data/lib/scope_file_store.rb

@@ -18,7 +18,7 @@
 # The responsibility of the ScopeFileStore class is to represent a sub directory
 # of a system description which is used to hold files belonging to a specific
 # scope.
-class ScopeFileStore
+class Machinery::ScopeFileStore
   attr_accessor :base_path, :store_name
 
   def initialize(base_path, store_name)

data/lib/serve_html_task.rb

@@ -15,7 +15,7 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class ServeHtmlTask
+class Machinery::ServeHtmlTask
   def assemble_url(opts)
     host = if !opts[:public]
       "127.0.0.1"
@@ -46,7 +46,11 @@ A specific description with the name NAME is accessible at:
 The web server can be closed with Ctrl+C.
 EOF
 
-    server = Html.run_server(system_description_store, port: opts[:port], public: opts[:public])
+    server = Machinery::Html.run_server(
+      system_description_store,
+      port: opts[:port],
+      public: opts[:public]
+    )
 
     server.join
   end

data/lib/server.rb

@@ -111,7 +111,8 @@ class Server < Sinatra::Base
         changed.push(
           id:       change[0][opts[:key]],
           change:   "(" + changes.join(", ") + ")",
-          diffable: change[0].is_a?(UnmanagedFile) && change[0].is_a?(UnmanagedFile) &&
+          diffable: change[0].is_a?(Machinery::UnmanagedFile) &&
+            change[0].is_a?(Machinery::UnmanagedFile) &&
             change[0].file? && change[1].file? &&
             @diff[scope].try(:common).try(:attributes).try(:[], "extracted")
         )
@@ -142,7 +143,7 @@ class Server < Sinatra::Base
   enable :sessions
 
   get "/descriptions/:id/files/:scope/*" do
-    description = SystemDescription.load(params[:id], settings.system_description_store)
+    description = Machinery::SystemDescription.load(params[:id], settings.system_description_store)
     filename = File.join("/", params["splat"].first)
 
     file = description[params[:scope]].find { |f| f.name == filename }
@@ -169,7 +170,7 @@ class Server < Sinatra::Base
     descriptions.each do |name|
       scopes = []
       begin
-        system_description = SystemDescription.load(
+        system_description = Machinery::SystemDescription.load(
           name, settings.system_description_store, skip_validation: true
         )
         @all_descriptions[name] = Hash.new
@@ -177,7 +178,7 @@ class Server < Sinatra::Base
         @all_descriptions[name]["host"] = system_description.host
         system_description.scopes.each do |scope|
           entry = Machinery::Ui.internal_scope_list_to_string(scope)
-          if SystemDescription::EXTRACTABLE_SCOPES.include?(scope)
+          if Machinery::SystemDescription::EXTRACTABLE_SCOPES.include?(scope)
             if system_description.scope_extracted?(scope)
               entry += " (extracted)"
             else
@@ -208,15 +209,19 @@ class Server < Sinatra::Base
   get "/compare/:a/:b" do
     all_descriptions
 
-    @description_a = SystemDescription.load(params[:a], settings.system_description_store)
-    @description_b = SystemDescription.load(params[:b], settings.system_description_store)
+    @description_a = Machinery::SystemDescription.load(
+      params[:a], settings.system_description_store
+    )
+    @description_b = Machinery::SystemDescription.load(
+      params[:b], settings.system_description_store
+    )
 
     @meta = {}
     @diff = {}
 
-    Inspector.all_scopes.each do |scope|
+    Machinery::Inspector.all_scopes.each do |scope|
       if @description_a[scope] && @description_b[scope]
-        @diff[scope] = Comparison.compare_scope(@description_a, @description_b, scope)
+        @diff[scope] = Machinery::Comparison.compare_scope(@description_a, @description_b, scope)
       elsif @description_a[scope] || @description_b[scope]
         @meta[:uninspected] ||= Hash.new
 
@@ -235,12 +240,12 @@ class Server < Sinatra::Base
   end
 
   get "/compare/:a/:b/files/:scope/*" do
-    description1 = SystemDescription.load(params[:a], settings.system_description_store)
-    description2 = SystemDescription.load(params[:b], settings.system_description_store)
+    description1 = Machinery::SystemDescription.load(params[:a], settings.system_description_store)
+    description2 = Machinery::SystemDescription.load(params[:b], settings.system_description_store)
     filename = File.join("/", params["splat"].first)
 
     begin
-      diff = FileDiff.diff(description1, description2, params[:scope], filename)
+      diff = Machinery::FileDiff.diff(description1, description2, params[:scope], filename)
     rescue Machinery::Errors::BinaryDiffError
       status 406
       return "binary file"
@@ -253,7 +258,9 @@ class Server < Sinatra::Base
     all_descriptions
 
     begin
-      @description = SystemDescription.load(params[:id], settings.system_description_store)
+      @description = Machinery::SystemDescription.load(
+        params[:id], settings.system_description_store
+      )
     rescue Machinery::Errors::SystemDescriptionNotFound => e
       session[:error] = e.to_s
       redirect "/"

data/lib/show_task.rb

@@ -15,9 +15,9 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class ShowTask
+class Machinery::ShowTask
   def show(description, scopes, filter, options = {})
-    scopes = Inspector.sort_scopes(scopes)
+    scopes = Machinery::Inspector.sort_scopes(scopes)
     if options[:show_html]
       show_html(description, options)
     else
@@ -30,7 +30,7 @@ class ShowTask
 
   def show_html(description, options)
     begin
-      LocalSystem.validate_existence_of_command("xdg-open", "xdg-utils")
+      Machinery::LocalSystem.validate_existence_of_command("xdg-open", "xdg-utils")
 
       url = "http://#{options[:ip]}:#{options[:port]}/#{CGI.escape(description.name)}"
 
@@ -41,8 +41,12 @@ Trying to start a web server for serving the description on #{url}.
 The server can be closed with Ctrl+C.
 EOF
 
-      server = Html.run_server(description.store, port: options[:port], ip: options[:ip]) do
-        LoggedCheetah.run("xdg-open", url)
+      server = Machinery::Html.run_server(
+        description.store,
+        port: options[:port],
+        ip:   options[:ip]
+      ) do
+        Machinery::LoggedCheetah.run("xdg-open", url)
       end
 
       server.join # Wait until the user cancelled the blocking webserver
@@ -57,7 +61,7 @@ EOF
   def show_console(description, scopes, options)
     missing_scopes = []
 
-    scopes.map { |s| Renderer.for(s) }.each do |renderer|
+    scopes.map { |s| Machinery::Ui::Renderer.for(s) }.each do |renderer|
       section = renderer.render(description, options)
       unless section.empty?
         Machinery::Ui.puts section

data/lib/static_html.rb

@@ -15,7 +15,7 @@
 #
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
-class StaticHtml < Exporter
+class Machinery::StaticHtml < Machinery::Exporter
   TEMPLATE_DIR = File.join(Machinery::ROOT, "html").freeze
   PARTIAL_DIR = File.join(Machinery::ROOT, "html", "partials").freeze
 

data/lib/system.rb

@@ -21,7 +21,7 @@
 # It abstracts common inspection tasks that need to be run, like executing
 # commands or running "kiwi --describe". Different implementations, e.g. for
 # local or ssh-accessed systems are done in the according subclasses.
-class System
+class Machinery::System
   abstract_method :requires_root?
   abstract_method :run_command
   abstract_method :kiwi_describe
@@ -35,9 +35,9 @@ class System
 
   def self.for(host, opts = {})
     if host && host != "localhost"
-      RemoteSystem.new(host, opts)
+      Machinery::RemoteSystem.new(host, opts)
     else
-      LocalSystem.new
+      Machinery::LocalSystem.new
     end
   end
 
@@ -52,7 +52,8 @@ class System
       end
     end
     raise Machinery::Errors::MissingRequirement.new(
-      "Need binary '#{commands.join("' or '")}' to be available on the inspected system."
+      "Need the '#{commands.join("' or '")}' #{Machinery.pluralize(commands.length, "command")}" \
+        " to be available on the inspected system."
     )
   end
 
@@ -140,9 +141,9 @@ class System
     if @managed_files_database
       return @managed_files_database
     elsif has_command?("rpm")
-      @managed_files_database = RpmDatabase.new(self)
+      @managed_files_database = Machinery::RpmDatabase.new(self)
     elsif has_command?("dpkg")
-      @managed_files_database = DpkgDatabase.new(self)
+      @managed_files_database = Machinery::DpkgDatabase.new(self)
     else
       raise Machinery::Errors::MissingRequirement.new(
         "Need binary 'rpm' or 'dpkg' to be available on the inspected system."
@@ -163,6 +164,7 @@ class System
     options[:stdout] = write_io
     options[:stderr] = error_io
 
+    Thread.abort_on_exception = true
     inspect_thread = Thread.new do
       if type == :script
         run_script(*command, options)
@@ -177,10 +179,8 @@ class System
       callback.call(chunk) if callback
     end
 
-    if error.include?("password is required")
-      raise Machinery::Errors::InsufficientPrivileges.new(remote_user, host)
-    end
-
     output
+  rescue
+    raise Machinery::Errors::CommandFailed.new(command.join(" "), error)
   end
 end

data/lib/system_description.rb

@@ -25,7 +25,7 @@
 #
 # The sub directories storing the data for specific scopes are handled by the
 # ScopeFileStore class.
-class SystemDescription < Machinery::Object
+class Machinery::SystemDescription < Machinery::Object
   CURRENT_FORMAT_VERSION = 10
   EXTRACTABLE_SCOPES = [
     "changed_managed_files",
@@ -43,7 +43,7 @@ class SystemDescription < Machinery::Object
     #
     # If there are file validation errors the call fails with an exception
     def load!(name, store, options = {})
-      manifest = Manifest.load(name, store.manifest_path(name))
+      manifest = Machinery::Manifest.load(name, store.manifest_path(name))
       manifest.validate!
 
       description = from_hash(name, store, manifest.to_hash)
@@ -61,7 +61,7 @@ class SystemDescription < Machinery::Object
     # If there are file validation errors these are put out as warnings but the
     # loading of the system description succeeds.
     def load(name, store, options = {})
-      manifest = Manifest.load(name, store.manifest_path(name))
+      manifest = Machinery::Manifest.load(name, store.manifest_path(name))
       manifest.validate unless options[:skip_validation]
 
       description = from_hash(name, store, manifest.to_hash)
@@ -89,9 +89,10 @@ class SystemDescription < Machinery::Object
     def from_hash(name, store, hash)
       begin
         json_format_version = hash["meta"]["format_version"] if hash["meta"]
-        description = SystemDescription.new(name, store, hash)
+        description = Machinery::SystemDescription.new(name, store, hash)
       rescue NameError, TypeError, RuntimeError
-        if json_format_version && json_format_version != SystemDescription::CURRENT_FORMAT_VERSION
+        if json_format_version &&
+            json_format_version != Machinery::SystemDescription::CURRENT_FORMAT_VERSION
           raise Machinery::Errors::SystemDescriptionIncompatible.new(name, json_format_version)
         else
           raise Machinery::Errors::SystemDescriptionError.new(
@@ -146,7 +147,7 @@ class SystemDescription < Machinery::Object
 
   def compatible?
     !format_version.nil? &&
-      format_version == SystemDescription::CURRENT_FORMAT_VERSION
+      format_version == Machinery::SystemDescription::CURRENT_FORMAT_VERSION
   end
 
   def validate_format_compatibility
@@ -156,7 +157,7 @@ class SystemDescription < Machinery::Object
   end
 
   def validate_analysis_compatibility
-    Zypper.isolated(arch: os.architecture) do |zypper|
+    Machinery::Zypper.isolated(arch: os.architecture) do |zypper|
       major, minor, patch = zypper.version
       if major <= 1 && minor <= 11 && patch < 4
         raise Machinery::Errors::AnalysisFailed.new("Analyzing command requires zypper 1.11.4 " \
@@ -196,7 +197,7 @@ class SystemDescription < Machinery::Object
   end
 
   def save
-    SystemDescription.validate_name(name)
+    Machinery::SystemDescription.validate_name(name)
     @store.directory_for(name)
     path = @store.manifest_path(name)
     created = !File.exist?(path)
@@ -219,7 +220,7 @@ class SystemDescription < Machinery::Object
   end
 
   def scopes
-    Inspector.sort_scopes(attributes.keys.map(&:to_s).sort)
+    Machinery::Inspector.sort_scopes(attributes.keys.map(&:to_s).sort)
   end
 
   def assert_scopes(*scopes)
@@ -253,11 +254,11 @@ class SystemDescription < Machinery::Object
   end
 
   def scope_file_store(store_name)
-    ScopeFileStore.new(description_path, store_name)
+    Machinery::ScopeFileStore.new(description_path, store_name)
   end
 
   def validate_file_data
-    errors = FileValidator.new(to_hash, description_path).validate
+    errors = Machinery::FileValidator.new(to_hash, description_path).validate
     unless errors.empty?
       Machinery::Ui.warn("Warning: File validation errors:")
       Machinery::Ui.warn("Error validating description '#{@name}'\n\n")
@@ -266,7 +267,7 @@ class SystemDescription < Machinery::Object
   end
 
   def validate_file_data!
-    errors = FileValidator.new(to_hash, description_path).validate
+    errors = Machinery::FileValidator.new(to_hash, description_path).validate
     unless errors.empty?
       e = Machinery::Errors::SystemDescriptionValidationFailed.new(errors)
       e.header = "Error validating description '#{@name}'"
@@ -316,7 +317,7 @@ class SystemDescription < Machinery::Object
     return unless changed_config_files && diffs_dir
     changed_config_files.each do |file|
       path = File.join(diffs_dir, file.name + ".diff")
-      file.diff = DiffWidget.new(File.read(path)).widget if File.exist?(path)
+      file.diff = Machinery::Ui::DiffWidget.new(File.read(path)).widget if File.exist?(path)
     end
   end
 

data/lib/system_description_memory_store.rb

@@ -21,7 +21,7 @@
 # a program and doesn't have to be persisted. Attempts to save the
 # description or related data will result in an exception.
 
-class SystemDescriptionMemoryStore
+class Machinery::SystemDescriptionMemoryStore
   def persistent?
     false
   end

data/lib/system_description_store.rb

@@ -21,7 +21,7 @@
 #
 # System descriptions are represented by sub directories of this top-level
 # directory. They are handled by the SystemDescription class.
-class SystemDescriptionStore
+class Machinery::SystemDescriptionStore
   attr_reader :base_path
 
   def default_path
@@ -58,7 +58,7 @@ class SystemDescriptionStore
 
   def remove(name)
     unless name.empty?
-      SystemDescription.validate_name(name)
+      Machinery::SystemDescription.validate_name(name)
       FileUtils.rm_rf(description_path(name))
     else
       raise "The system description has no name specified and thus can't be deleted."
@@ -66,8 +66,8 @@ class SystemDescriptionStore
   end
 
   def copy(from, to)
-    SystemDescription.validate_name(from)
-    SystemDescription.validate_name(to)
+    Machinery::SystemDescription.validate_name(from)
+    Machinery::SystemDescription.validate_name(to)
 
     validate_existence_of_description(from)
     validate_nonexistence_of_description(to)
@@ -76,8 +76,8 @@ class SystemDescriptionStore
   end
 
   def move(from, to)
-    SystemDescription.validate_name(from)
-    SystemDescription.validate_name(to)
+    Machinery::SystemDescription.validate_name(from)
+    Machinery::SystemDescription.validate_name(to)
 
     validate_existence_of_description(from)
     validate_nonexistence_of_description(to)
@@ -86,7 +86,7 @@ class SystemDescriptionStore
   end
 
   def backup(description_name)
-    SystemDescription.validate_name(description_name)
+    Machinery::SystemDescription.validate_name(description_name)
     validate_existence_of_description(description_name)
 
     backup_name = get_backup_name(description_name)
@@ -96,8 +96,8 @@ class SystemDescriptionStore
   end
 
   def rename(from, to)
-    SystemDescription.validate_name(from)
-    SystemDescription.validate_name(to)
+    Machinery::SystemDescription.validate_name(from)
+    Machinery::SystemDescription.validate_name(to)
 
     validate_existence_of_description(from)
     validate_nonexistence_of_description(to)