machinery-tool 1.22.1 → 1.22.2

data/lib/mountpoints.rb

@@ -31,7 +31,7 @@
 #           local file systems with permanent data (e.g. ext3, btrfs, xfs)
 
 
-class MountPoints
+class Machinery::MountPoints
   attr_reader :mounts
   REMOTE_FILE_SYSTEMS = ["autofs", "cifs", "nfs", "nfs4"]
   SPECIAL_FILE_SYSTEMS = ["proc", "sysfs", "devtmpfs", "tmpfs", "fuse.gvfs-fuse-daemon"]

data/lib/move_task.rb

@@ -16,7 +16,7 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class MoveTask
+class Machinery::MoveTask
   def move(store, from, to)
     store.move(from, to)
   end

data/lib/remote_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 RemoteSystem < System
+class Machinery::RemoteSystem < Machinery::System
   attr_reader :host, :remote_user, :ssh_port, :ssh_identity_file
 
   def type
@@ -85,7 +85,7 @@ class RemoteSystem < System
     if options[:disable_logging]
       cheetah_class = Cheetah
     else
-      cheetah_class = LoggedCheetah
+      cheetah_class = Machinery::LoggedCheetah
     end
 
     sudo = ["sudo", "-n"] if options[:privileged] && sudo_required?
@@ -120,7 +120,7 @@ class RemoteSystem < System
       stdin: filelist.join("\n")
     ]
     begin
-      LoggedCheetah.run(*cmd)
+      Machinery::LoggedCheetah.run(*cmd)
     rescue Cheetah::ExecutionFailed  => e
       raise Machinery::Errors::RsyncFailed.new(
       "Could not rsync files from host '#{host}'.\n" \
@@ -130,7 +130,7 @@ class RemoteSystem < System
   end
 
   def check_retrieve_files_dependencies
-    LocalSystem.validate_existence_of_command("rsync", "rsync")
+    Machinery::LocalSystem.validate_existence_of_command("rsync", "rsync")
     check_requirement("rsync", "--version")
   end
 
@@ -161,7 +161,7 @@ class RemoteSystem < System
     ]
 
     begin
-      LoggedCheetah.run(*cmd)
+      Machinery::LoggedCheetah.run(*cmd)
     rescue Cheetah::ExecutionFailed => e
       raise Machinery::Errors::InjectFileFailed.new(
         "Could not inject file '#{source}' to host '#{host}'.\nError: #{e}"
@@ -187,7 +187,7 @@ class RemoteSystem < System
   # Tries to run the noop-command(:) on the remote system as root (without a password or passphrase)
   # and raises an Machinery::Errors::SshConnectionFailed exception when it's not successful.
   def check_connection
-    LoggedCheetah.run(*build_command(:ssh), "-q", "-o", "BatchMode=yes",
+    Machinery::LoggedCheetah.run(*build_command(:ssh), "-q", "-o", "BatchMode=yes",
                       "#{remote_user}@#{host}", ":")
   rescue Cheetah::ExecutionFailed
     raise Machinery::Errors::SshConnectionFailed.new(
@@ -200,7 +200,7 @@ class RemoteSystem < System
 
   def check_sudo
     check_requirement("sudo", "-h")
-    LoggedCheetah.run(*build_command(:ssh), "-q", "-o", "BatchMode=yes",
+    Machinery::LoggedCheetah.run(*build_command(:ssh), "-q", "-o", "BatchMode=yes",
       "#{remote_user}@#{host}", "sudo", "id")
   rescue Cheetah::ExecutionFailed => e
     if e.stderr && e.stderr.include?("password is required")

data/lib/remove_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 RemoveTask
+class Machinery::RemoveTask
   def remove(store, names, options = {})
     if options[:all]
       removed_descriptions = store.list

data/lib/renderer.rb

@@ -48,7 +48,7 @@
 #
 # Accordingly a simple renderer for the "packages" scope could look like this:
 #
-# class PackagesRenderer < Renderer
+# class PackagesRenderer < Machinery::Ui::Renderer
 #   def content(description)
 #     return if description.packages.empty?
 #
@@ -59,216 +59,221 @@
 #     end
 #   end
 # end
-class Renderer
+module Machinery
+  class Ui
+    class Renderer
 
-  class InvalidStructureError < StandardError; end
+      class InvalidStructureError < StandardError; end
 
-  attr_accessor :system_description
-  attr_accessor :buffer
+      attr_accessor :system_description
+      attr_accessor :buffer
 
-  abstract_method :content
-  abstract_method :compare_content_changed
+      abstract_method :content
+      abstract_method :compare_content_changed
 
-  @@renderers = []
+      @@renderers = []
 
-  class << self
-    def inherited(klass)
-      @@renderers << klass
-    end
+      class << self
+        def inherited(klass)
+          @@renderers << klass
+        end
 
-    def all
-      @@renderers.map { |renderer| renderer.new }
-    end
+        def all
+          @@renderers.map(&:new)
+        end
 
-    def for(scope)
-      class_name = "#{scope.split("_").map(&:capitalize).join}Renderer"
+        def for(scope)
+          class_name = "Machinery::Ui::#{scope.split("_").map(&:capitalize).join}Renderer"
 
-      if Object.const_defined?(class_name)
-        Object.const_get(class_name).new
+          begin
+            Object.const_get(class_name).new
+          rescue NameError
+          end
+        end
       end
-    end
-  end
-
-  def scope
-    # Return the un-camelcased name of the inspector,
-    # e.g. "foo_bar" for "FooBarInspector"
-    scope = self.class.name.match(/^(.*)Renderer$/)[1]
-    scope.gsub(/([^A-Z])([A-Z])/, "\\1_\\2").downcase
-  end
 
-  # Renders one system description using the specialized `content` method
-  def render(system_description, options = {})
-    @options = options
-    @buffer = ""
-    @indent = 2
-    @stack = []
-
-    if system_description[scope]
-      header = display_name
-      meta = system_description[scope].meta
-
-      if meta
-          header += " [#{meta.hostname}]"
-          date = Time.parse(meta.modified).localtime
-          date_human = date.strftime "%Y-%m-%d %H:%M:%S"
-          header += " (#{date_human})"
+      def scope
+        # Return the un-camelcased name of the inspector,
+        # e.g. "foo_bar" for "FooBarInspector"
+        scope = self.class.name.match(/^Machinery::Ui::(.*)Renderer$/)[1]
+        scope.gsub(/([^A-Z])([A-Z])/, "\\1_\\2").downcase
       end
 
-      heading(header)
-    end
-
-    content(system_description)
-
-    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
-
-    @buffer
-  end
-
-  # Renders the result of a comparison of two system descriptions.
-  def render_comparison(comparison, options = {})
-    @options = options
-    @buffer = ""
-    @indent = 0
-    @stack = []
-
-    show_heading = if options[:show_all]
-      comparison.only_in1 || comparison.only_in2 || comparison.changed || comparison.common
-    else
-      comparison.only_in1 || comparison.only_in2 || comparison.changed
-    end
-
-    heading(display_name) if show_heading
+      # Renders one system description using the specialized `content` method
+      def render(system_description, options = {})
+        @options = options
+        @buffer = ""
+        @indent = 2
+        @stack = []
 
-    render_comparison_only_in(comparison.as_description(:one))
-    render_comparison_only_in(comparison.as_description(:two))
-    render_comparison_changed(comparison) if comparison.changed
-    render_comparison_common(comparison.as_description(:common)) if @options[:show_all]
-    @buffer
-  end
+        if system_description[scope]
+          header = display_name
+          meta = system_description[scope].meta
 
-  def render_comparison_only_in(description)
-    return if !description[scope] || description[scope].elements.try(:empty?)
+          if meta
+            header += " [#{meta.hostname}]"
+            date = Time.parse(meta.modified).localtime
+            date_human = date.strftime "%Y-%m-%d %H:%M:%S"
+            header += " (#{date_human})"
+          end
 
-    puts "Only in '#{description.name}':"
-    indent { compare_content_only_in(description) }
-    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
-  end
+          heading(header)
+        end
 
-  def render_comparison_changed(comparison)
-    puts "In both with different attributes ('#{comparison.name1}' <> '#{comparison.name2}'):"
-    indent { compare_content_changed(comparison.changed) }
-    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
-  end
+        content(system_description)
 
-  def render_comparison_common(description)
-    return unless description[scope]
+        @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
 
-    puts "Common to both systems:"
-    indent { compare_content_common(description) }
-    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
-  end
+        @buffer
+      end
 
-  def compare_content_only_in(description)
-    content(description)
-  end
+      # Renders the result of a comparison of two system descriptions.
+      def render_comparison(comparison, options = {})
+        @options = options
+        @buffer = ""
+        @indent = 0
+        @stack = []
+
+        show_heading = if options[:show_all]
+          comparison.only_in1 || comparison.only_in2 || comparison.changed || comparison.common
+        else
+          comparison.only_in1 || comparison.only_in2 || comparison.changed
+        end
+
+        heading(display_name) if show_heading
+
+        render_comparison_only_in(comparison.as_description(:one))
+        render_comparison_only_in(comparison.as_description(:two))
+        render_comparison_changed(comparison) if comparison.changed
+        render_comparison_common(comparison.as_description(:common)) if @options[:show_all]
+        @buffer
+      end
 
-  def compare_content_common(description)
-    content(description)
-  end
+      def render_comparison_only_in(description)
+        return if !description[scope] || description[scope].elements.try(:empty?)
 
-  def render_comparison_missing_scope(description1, description2)
-    @buffer = ""
-    @indent = 0
-    @stack = []
-    missing_descriptions = Array.new
+        puts "Only in '#{description.name}':"
+        indent { compare_content_only_in(description) }
+        @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+      end
 
-    unless description1[scope]
-      missing_descriptions << description1.name
-    end
-    unless description2[scope]
-      missing_descriptions << description2.name
-    end
+      def render_comparison_changed(comparison)
+        puts "In both with different attributes ('#{comparison.name1}' <> '#{comparison.name2}'):"
+        indent { compare_content_changed(comparison.changed) }
+        @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+      end
 
-    if missing_descriptions.count == 1
-      @buffer += "# #{display_name}\n"
-      indent { puts "Unable to compare, no data in '#{missing_descriptions.join("', '")}'" }
-    end
-    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+      def render_comparison_common(description)
+        return unless description[scope]
 
-    @buffer
-  end
+        puts "Common to both systems:"
+        indent { compare_content_common(description) }
+        @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+      end
 
-  protected
+      def compare_content_only_in(description)
+        content(description)
+      end
 
-  def heading(s)
-    @buffer += "# #{s}\n\n"
-  end
+      def compare_content_common(description)
+        content(description)
+      end
 
-  def puts(s)
-    print_indented Machinery.scrub(s)
-  end
+      def render_comparison_missing_scope(description1, description2)
+        @buffer = ""
+        @indent = 0
+        @stack = []
+        missing_descriptions = Array.new
+
+        unless description1[scope]
+          missing_descriptions << description1.name
+        end
+        unless description2[scope]
+          missing_descriptions << description2.name
+        end
+
+        if missing_descriptions.count == 1
+          @buffer += "# #{display_name}\n"
+          indent { puts "Unable to compare, no data in '#{missing_descriptions.join("', '")}'" }
+        end
+        @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+
+        @buffer
+      end
 
-  def list(name = nil, options = {}, &block)
-    unless block_given?
-      raise InvalidStructureError.new(
-        "'list' was called without a block"
-      )
-    end
+      protected
 
-    @stack << :list
+      def heading(s)
+        @buffer += "# #{s}\n\n"
+      end
 
-    if name && !name.empty?
-      print_indented "#{name}:"
-      indent do
-        block.call
+      def puts(s)
+        print_indented Machinery.scrub(s)
       end
-    else
-      block.call
-    end
-    @buffer += "\n" unless @buffer.end_with?("\n\n") || options[:sublist]
 
-    @stack.pop
-  end
+      def list(name = nil, options = {}, &block)
+        unless block_given?
+          raise InvalidStructureError.new(
+            "'list' was called without a block"
+          )
+        end
+
+        @stack << :list
+
+        if name && !name.empty?
+          print_indented "#{name}:"
+          indent do
+            block.call
+          end
+        else
+          block.call
+        end
+        @buffer += "\n" unless @buffer.end_with?("\n\n") || options[:sublist]
+
+        @stack.pop
+      end
 
-  def item(s, &block)
-    unless @stack.last == :list
-      raise InvalidStructureError.new(
-        "'item' was called outside of a list block"
-      )
-    end
+      def item(s, &block)
+        unless @stack.last == :list
+          raise InvalidStructureError.new(
+            "'item' was called outside of a list block"
+          )
+        end
+
+        print_indented "* #{Machinery.scrub(s)}"
+
+        if block_given?
+          @stack << :item
+          indent do
+            block.call
+          end
+          @buffer += "\n"
+          @stack.pop
+        end
+      end
 
-    print_indented "* #{Machinery.scrub(s)}"
+      private
 
-    if block_given?
-      @stack << :item
-      indent do
-        block.call
+      def print_indented(s)
+        s.split("\n", -1).each do |line|
+          @buffer += if line.empty?
+            "\n"
+          else
+            " " * @indent + line + "\n"
+          end
+        end
       end
-      @buffer += "\n"
-      @stack.pop
-    end
-  end
 
-  private
+      def indent
+        @indent += 2
+        yield
+        @indent -= 2
+      end
 
-  def print_indented(s)
-    s.split("\n", -1).each do |line|
-      if line.empty?
-        @buffer += "\n"
-      else
-        @buffer += " " * @indent + line + "\n"
+      def na_note(s)
+        Machinery::Ui.puts "Note: 'N/A' represents a missing #{s} which could not\n" \
+          "be gathered during inspection.\n"
       end
     end
   end
-
-  def indent
-    @indent += 2
-    yield
-    @indent -= 2
-  end
-
-  def na_note(s)
-    Machinery::Ui.puts "Note: 'N/A' represents a missing #{s} which could not\n" \
-      "be gathered during inspection.\n"
-  end
 end