machinery-tool 1.22.1 → 1.22.2

data/lib/compare_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 CompareTask
+class Machinery::CompareTask
   def compare(description1, description2, scopes, options = {})
     if options[:show_html]
       render_html_comparison(description1, description2, scopes, options)
@@ -27,7 +27,7 @@ class CompareTask
   end
 
   def render_html_comparison(description1, description2, scopes, options)
-    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]}/compare/" \
       "#{CGI.escape(description1.name)}/#{CGI.escape(description2.name)}"
@@ -39,8 +39,12 @@ Trying to start a web server for serving the comparison result on #{url}.
 The server can be closed with Ctrl+C.
 EOF
 
-    server = Html.run_server(description1.store, port: options[:port], ip: options[:ip]) do
-      LoggedCheetah.run("xdg-open", url)
+    server = Machinery::Html.run_server(
+      description1.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
@@ -53,9 +57,9 @@ EOF
     common_scopes = false
     scopes.each do |scope|
       if description1[scope] && description2[scope]
-        comparison = Comparison.compare_scope(description1, description2, scope)
+        comparison = Machinery::Comparison.compare_scope(description1, description2, scope)
 
-        output += Renderer.for(scope).render_comparison(comparison, options)
+        output += Machinery::Ui::Renderer.for(scope).render_comparison(comparison, options)
 
         if comparison.only_in1 || comparison.only_in2 || comparison.changed
           identical = false
@@ -64,7 +68,7 @@ EOF
         end
         common_scopes = true
       else
-        output += Renderer.for(scope).render_comparison_missing_scope(
+        output += Machinery::Ui::Renderer.for(scope).render_comparison_missing_scope(
           description1, description2
         )
         identical = false if description1[scope] || description2[scope]

data/lib/comparison.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 Comparison
+class Machinery::Comparison
   attr_accessor :name1, :name2, :only_in1, :only_in2, :changed, :common, :store, :scope
 
   def self.compare_scope(description1, description2, scope)
@@ -52,7 +52,7 @@ class Comparison
       raise "'which' has to be :one, :two or :common"
     end
 
-    SystemDescription.new(name, store, scope => data)
+    Machinery::SystemDescription.new(name, store, scope => data)
   end
 
   def as_json

data/lib/config_base.rb

@@ -19,7 +19,7 @@
 # The defaults for machinery's configuration are defined in
 # the file 'machinery_config.rb'.
 
-class ConfigBase
+class Machinery::ConfigBase
   attr_reader :file, :entries
 
   def initialize(file = default_config_file)

data/lib/config_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 ConfigTask
+class Machinery::ConfigTask
   def initialize(config = Machinery::Config.new)
     @config = config
   end

data/lib/containerize_task.rb

@@ -15,11 +15,11 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class ContainerizeTask
+class Machinery::ContainerizeTask
   def containerize(description, dir)
     output_path = File.join(dir, description.name)
 
-    mapper = WorkloadMapper.new
+    mapper = Machinery::WorkloadMapper.new
     workloads = mapper.identify_workloads(description)
 
     if workloads.empty?
@@ -48,7 +48,7 @@ class ContainerizeTask
   private
 
   def copy_workload_setup_files(description, workloads, services, path)
-    app = ContainerizedApp.new(description.name, workloads, services)
+    app = Machinery::ContainerizedApp.new(description.name, workloads, services)
     workloads.each do |workload, _|
       Dir[File.join(Machinery::ROOT, "workload_mapper", workload, "setup", "*.erb")].each do |file|
         setup_script = ERB.new(File.read(file))

data/lib/containerized_app.rb

@@ -14,7 +14,7 @@
 #
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
-class ContainerizedApp
+class Machinery::ContainerizedApp
   def initialize(name, workloads, services)
     @name = name
     @services = services

data/lib/copy_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 CopyTask
+class Machinery::CopyTask
   def copy(store, from, to)
     store.copy(from, to)
   end

data/lib/current_user.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 # Represents the user under which Machinery is running.
-class CurrentUser
+class Machinery::CurrentUser
   def username
     ENV["USER"]
   end

data/lib/deploy_task.rb

@@ -15,10 +15,12 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class DeployTask
+class Machinery::DeployTask
   def deploy(description, cloud_config, options = {})
-    LocalSystem.validate_architecture("x86_64")
-    LocalSystem.validate_existence_of_packages(["python-glanceclient", "kiwi", "kiwi-desc-vmxboot"])
+    Machinery::LocalSystem.validate_architecture("x86_64")
+    Machinery::LocalSystem.validate_existence_of_packages(
+      ["python-glanceclient", "kiwi", "kiwi-desc-vmxboot"]
+    )
     description.validate_build_compatibility
 
     unless File.exist?(cloud_config)
@@ -37,7 +39,7 @@ class DeployTask
     else
       image_dir = Dir.mktmpdir("#{description.name}-image", "/tmp")
       is_temporary = true
-      task = BuildTask.new
+      task = Machinery::BuildTask.new
       task.build(description, image_dir)
     end
 

data/lib/diff_widget.rb

@@ -1,73 +1,77 @@
-class DiffWidget
-  def initialize(diff_text)
-    diff = Machinery.scrub(diff_text)
-    @lines = diff.lines[2..-1]
-    @widget = {
-      file: diff[/--- a(.*)/, 1],
-      additions: @lines.select { |l| l.start_with?("+") }.length,
-      deletions: @lines.select { |l| l.start_with?("-") }.length
-    }
+module Machinery
+  class Ui
+    class DiffWidget
+      def initialize(diff_text)
+        diff = Machinery.scrub(diff_text)
+        @lines = diff.lines[2..-1]
+        @widget = {
+          file: diff[/--- a(.*)/, 1],
+          additions: @lines.select { |l| l.start_with?("+") }.length,
+          deletions: @lines.select { |l| l.start_with?("-") }.length
+        }
 
-    @original_line_number = 0
-    @new_line_number = 0
-  end
-
-  def widget
-    @widget[:lines] = @lines.map do |line|
-      line = ERB::Util.html_escape(line.chomp).gsub("\\", "\").gsub("\t", " " * 8)
-      case line
-      when /^@.*/
-        entry = header_entry(line)
-        @original_line_number = line[/-(\d+)/, 1].to_i
-        @new_line_number = line[/\+(\d+)/, 1].to_i
-      when /^ .*/, ""
-        entry = common_entry(line)
-        @new_line_number += 1
-        @original_line_number += 1
-      when /^\+.*/
-        entry = addition_entry(line)
-        @new_line_number += 1
-      when /^\-.*/
-        entry = deletion_entry(line)
-        @original_line_number += 1
+        @original_line_number = 0
+        @new_line_number = 0
       end
 
-      entry
-    end
-    @widget
-  end
+      def widget
+        @widget[:lines] = @lines.map do |line|
+          line = ERB::Util.html_escape(line.chomp).gsub("\\", "\").gsub("\t", " " * 8)
+          case line
+          when /^@.*/
+            entry = header_entry(line)
+            @original_line_number = line[/-(\d+)/, 1].to_i
+            @new_line_number = line[/\+(\d+)/, 1].to_i
+          when /^ .*/, ""
+            entry = common_entry(line)
+            @new_line_number += 1
+            @original_line_number += 1
+          when /^\+.*/
+            entry = addition_entry(line)
+            @new_line_number += 1
+          when /^\-.*/
+            entry = deletion_entry(line)
+            @original_line_number += 1
+          end
 
-  private
+          entry
+        end
+        @widget
+      end
 
-  def header_entry(line)
-    {
-      type: "header",
-      content: line
-    }
-  end
+      private
 
-  def common_entry(line)
-    {
-      type: "common",
-      new_line_number: @new_line_number,
-      original_line_number: @original_line_number,
-      content: line[1..-1]
-    }
-  end
+      def header_entry(line)
+        {
+          type: "header",
+          content: line
+        }
+      end
 
-  def addition_entry(line)
-    {
-      type: "addition",
-      new_line_number: @new_line_number,
-      content: line[1..-1]
-    }
-  end
+      def common_entry(line)
+        {
+          type: "common",
+          new_line_number: @new_line_number,
+          original_line_number: @original_line_number,
+          content: line[1..-1]
+        }
+      end
 
-  def deletion_entry(line)
-    {
-      type: "deletion",
-      original_line_number: @original_line_number,
-      content: line[1..-1]
-    }
+      def addition_entry(line)
+        {
+          type: "addition",
+          new_line_number: @new_line_number,
+          content: line[1..-1]
+        }
+      end
+
+      def deletion_entry(line)
+        {
+          type: "deletion",
+          original_line_number: @original_line_number,
+          content: line[1..-1]
+        }
+      end
+    end
   end
 end

data/lib/docker_system.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 DockerSystem < System
+class Machinery::DockerSystem < Machinery::System
   attr_accessor :image
 
   def type
@@ -29,19 +29,21 @@ class DockerSystem < System
   end
 
   def start
-    @container = LoggedCheetah.run("docker", "run", "-id", @image, "bash", stdout: :capture).chomp
+    @container = Machinery::LoggedCheetah.run(
+      "docker", "run", "-id", @image, "bash", stdout: :capture
+    ).chomp
   rescue Cheetah::ExecutionFailed => e
     raise Machinery::Errors::MachineryError, "Container could not be started." \
       " The error message was:\n" + e.stderr
   end
 
   def stop
-    LoggedCheetah.run("docker", "rm", "-f", @container) if @container
+    Machinery::LoggedCheetah.run("docker", "rm", "-f", @container) if @container
   end
 
   def run_command(*args)
     Machinery.logger.info("Running '#{args}'")
-    LoggedCheetah.run("docker", "exec", "--user=root", "-i", @container, *args)
+    Machinery::LoggedCheetah.run("docker", "exec", "--user=root", "-i", @container, *args)
   end
 
   def check_retrieve_files_dependencies
@@ -76,7 +78,7 @@ class DockerSystem < System
 
   # Copies a file to the system
   def inject_file(source, destination)
-    LoggedCheetah.run("docker", "cp", source, "#{@container}:#{destination}")
+    Machinery::LoggedCheetah.run("docker", "cp", source, "#{@container}:#{destination}")
   end
 
   # Retrieves files specified in file_list from the container
@@ -85,8 +87,10 @@ class DockerSystem < System
       destination_path = File.join(destination, file)
       FileUtils.mkdir_p(File.dirname(destination_path), mode: 0700)
 
-      LoggedCheetah.run("docker", "cp", "#{@container}:#{file}", "#{destination_path}")
-      LoggedCheetah.run("chmod", "go-rwx", destination_path)
+      Machinery::LoggedCheetah.run(
+        "docker", "cp", "#{@container}:#{file}", destination_path.to_s
+      )
+      Machinery::LoggedCheetah.run("chmod", "go-rwx", destination_path)
     end
   end
 
@@ -123,7 +127,7 @@ class DockerSystem < System
   private
 
   def validate_image_name(image)
-    LoggedCheetah.run("docker", "inspect", image)
+    Machinery::LoggedCheetah.run("docker", "inspect", image)
   rescue
     raise Machinery::Errors::InspectionFailed.new("Unknown docker image: '#{image}'")
   end

data/lib/dpkg_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 DpkgDatabase < ManagedFilesDatabase
+class Machinery::DpkgDatabase < Machinery::ManagedFilesDatabase
   def managed_files_list(&block)
     message = "The list of changed config and managed files is not complete on dpkg systems."\
      " The reason for this is missing verification data:" \

data/lib/element_filter.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 ElementFilter
+class Machinery::ElementFilter
   attr_accessor :path, :matchers
 
   def initialize(path, operator = nil, matchers = nil)
@@ -34,7 +34,10 @@ class ElementFilter
   end
 
   def add_matchers(operator, matchers)
-    unless [Filter::OPERATOR_EQUALS, Filter::OPERATOR_EQUALS_NOT].include?(operator)
+    unless [
+      Machinery::Filter::OPERATOR_EQUALS,
+      Machinery::Filter::OPERATOR_EQUALS_NOT
+    ].include?(operator)
       raise Machinery::Errors::InvalidFilter.new("Wrong filter operator '#{operator}'")
     end
 
@@ -66,9 +69,9 @@ class ElementFilter
             value == matcher
           end
         end
-        if operator == Filter::OPERATOR_EQUALS
+        if operator == Machinery::Filter::OPERATOR_EQUALS
           return true if values_equal
-        elsif operator == Filter::OPERATOR_EQUALS_NOT
+        elsif operator == Machinery::Filter::OPERATOR_EQUALS_NOT
           return true unless values_equal
         end
       end

data/lib/exceptions.rb

@@ -28,7 +28,12 @@ module Machinery
     class MachineryError < StandardError; end
 
     class UnknownScope < MachineryError; end
-    class UnknownOs < MachineryError; end
+    class UnknownOs < MachineryError
+      def to_s
+        "Unable to determine the operating system. There does not seem to be an" \
+          " /etc/os-release file."
+      end
+    end
     class InvalidPager < MachineryError; end
     class InvalidCommandLine < MachineryError; end
 
@@ -49,8 +54,9 @@ module Machinery
         if !@format_version
           "#{@name}: incompatible format version. Can not be upgraded."
         elsif @format_version < SystemDescription::CURRENT_FORMAT_VERSION
-          "#{@name}: format version #{@format_version}, needs to be upgraded. " \
-          "Try '#{Hint.program_name} upgrade-format #{name}' to upgrade it to the current version."
+          "#{@name}: format version #{@format_version}, needs to be upgraded. "\
+          "Try '#{Ui::Hint.program_name} upgrade-format #{name}'"\
+          " to upgrade it to the current version."
         else
           "#{@name}: format version #{@format_version}. " \
             "Please upgrade Machinery to the latest version."
@@ -76,7 +82,7 @@ module Machinery
           inspect_cmd = "inspect"
         end
 
-        cmd = "#{Hint.program_name} #{inspect_cmd} --extract-files " \
+        cmd = "#{Ui::Hint.program_name} #{inspect_cmd} --extract-files " \
           "--scope=#{formatted_scopes.delete(" ")}"
         cmd += " --name='#{@description.name}'" if hostname != @description.name
         cmd += " #{hostname}"
@@ -124,6 +130,18 @@ module Machinery
       end
     end
 
+    class CommandFailed < MachineryError
+      def initialize(command, error)
+        @command = command
+        @error = error
+      end
+
+      def to_s
+        "The required call '#{@command}' does not seem to work as expected on the" \
+          " inspected system. This is the error message:\n#{@error}"
+      end
+    end
+
     class SudoMissingTTY < MachineryError
       def initialize(host)
         @host = host
@@ -131,7 +149,7 @@ module Machinery
 
       def to_s
         "'sudo' isn't configured on the inspected host '#{@host}'." \
-        " Remove the RequireTTY settings from sudoers.conf."
+        " Remove the 'requiretty' settings from /etc/sudoers by running `visudo`."
       end
     end