machinery-tool 1.9.1 → 1.10.0

data/lib/machinery.rb

@@ -33,6 +33,7 @@ require "kramdown"
 require "find"
 require "pathname"
 require "nokogiri"
+require "socket"
 
 require_relative "machinery_logger"
 require_relative "zypper"
@@ -75,7 +76,6 @@ require_relative "validate_task"
 require_relative "migration"
 require_relative "upgrade_format_task"
 require_relative "html"
-require_relative "generate_html_task"
 require_relative "hint"
 require_relative "mountpoints"
 require_relative "config_base"
@@ -92,7 +92,11 @@ require_relative "filter"
 require_relative "filter_option_parser"
 require_relative "file_scope"
 require_relative "system_file"
-require_relative "scope_file_access"
+require_relative "scope_file_access_flat"
+require_relative "scope_file_access_archive"
+require_relative "man_task"
+require_relative "comparison"
+require_relative "serve_html_task"
 
 Dir[File.join(Machinery::ROOT, "plugins", "**", "*.rb")].each { |f| require(f) }
 

data/lib/{generate_html_task.rb → man_task.rb}

@@ -15,11 +15,13 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class GenerateHtmlTask
-  def generate(description)
-    output = Html.generate(description)
-    Machinery::Ui.puts "The generated HTML file is stored in: \n" +
-      "#{output}"
-    Hint.print(:share_html_contents, directory: output)
+class ManTask
+  def man
+    LocalSystem.validate_existence_of_package("man")
+    system("man", man_path)
+  end
+
+  def man_path
+    File.join(Machinery::ROOT, "man/generated/machinery.1.gz")
   end
 end

data/lib/object.rb

@@ -152,7 +152,7 @@ module Machinery
     end
 
     def compare_with(other)
-      self == other ? [nil, nil, self] : [self, other, nil]
+      self == other ? [nil, nil, nil, self] : [self, other, nil, nil]
     end
   end
 end

data/lib/renderer.rb

@@ -18,7 +18,22 @@
 # Renderer is the base class for all text renderer plugins
 #
 # It defines methods for rendering data which will be called from the
-# specialized `do_render` methods in the subclasses.
+# specialized content methods in the subclasses.
+#
+# Subclasses can define the output for the `show` and `compare` commands using
+# the following `content` methods:
+#
+# For `machinery show`:
+# [content] (required) Defines the output for a scope in `machinery show`
+#
+# For `machinery compare`:
+# [compare_content_only_in] Defines the output of the "only in x" sections. The
+#                           default behavior is to fall back to `content`.
+# [compare_content_common]  Defines the output of the "in both" section. The
+#                           default behavior is to fall back to `content`.
+# [compare_content_changed] Defines the output of the "in both with changed
+#                           attributes" section for scopes where this is
+#                           supported.
 #
 # The names of the subclasses are 1:1 mappings of the scope areas, e.g.
 # the PackagesRenderer class would be used for rendering when the user
@@ -34,11 +49,11 @@
 # Accordingly a simple renderer for the "packages" scope could look like this:
 #
 # class PackagesRenderer < Renderer
-#   def do_render
-#     return if @system_description.packages.empty?
+#   def content(description)
+#     return if description.packages.empty?
 #
 #     list "Packages" do
-#       @system_description.packages.each do |p|
+#       description.packages.each do |p|
 #         item "#{p.name} (#{p.version})"
 #       end
 #     end
@@ -51,7 +66,8 @@ class Renderer
   attr_accessor :system_description
   attr_accessor :buffer
 
-  abstract_method :do_render
+  abstract_method :content
+  abstract_method :compare_content_changed
 
   @@renderers = []
 
@@ -73,8 +89,15 @@ class Renderer
     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 = {})
-    @system_description = system_description
     @options = options
     @buffer = ""
     @indent = 2
@@ -94,54 +117,65 @@ class Renderer
       heading(header)
     end
 
-    do_render
+    content(system_description)
 
     @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
 
     @buffer
   end
 
-  def render_comparison_section(description)
-    @system_description = description
-    indent { do_render }
-    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
-  end
-
-  def render_comparison_only_in(description, scope)
-    if description[scope]
-      puts "Only in '#{description.name}':"
-      render_comparison_section(description)
-    end
-  end
-
-  def render_comparison_common(description, scope)
-    if description[scope]
-      puts "Common to both systems:"
-      render_comparison_section(description)
-    end
-  end
-
-  def render_comparison(description1, description2, description_common, options = {})
+  # 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]
-      description1[scope] || description2[scope] || description_common[scope]
+      comparison.only_in1 || comparison.only_in2 || comparison.changed || comparison.common
     else
-      description1[scope] || description2[scope]
+      comparison.only_in1 || comparison.only_in2 || comparison.changed
     end
 
     heading(display_name) if show_heading
 
-    render_comparison_only_in(description1, scope)
-    render_comparison_only_in(description2, scope)
-    render_comparison_common(description_common, scope) if options[:show_all]
-
+    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 render_comparison_only_in(description)
+    return if !description[scope]
+
+    puts "Only in '#{description.name}':"
+    indent { compare_content_only_in(description) }
+    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+  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
+
+  def render_comparison_common(description)
+    return if !description[scope]
+
+    puts "Common to both systems:"
+    indent { compare_content_common(description) }
+    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+  end
+
+  def compare_content_only_in(description)
+    content(description)
+  end
+
+  def compare_content_common(description)
+    content(description)
+  end
+
   def render_comparison_missing_scope(description1, description2)
     @buffer = ""
     @indent = 0
@@ -164,6 +198,8 @@ class Renderer
     @buffer
   end
 
+  protected
+
   def heading(s)
     @buffer += "# #{s}\n\n"
   end
@@ -214,13 +250,6 @@ class Renderer
     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
-
   private
 
   def print_indented(s)

data/lib/{scope_file_access.rb → scope_file_access_archive.rb}

@@ -1,23 +1,3 @@
-module ScopeFileAccessFlat
-  def retrieve_files_from_system(system, paths)
-    system.retrieve_files(paths, scope_file_store.path)
-  end
-
-  def write_file(system_file, target)
-    raise Machinery::Errors::FileUtilsError, "Not a file" if !system_file.file?
-
-    target_path = File.join(target, system_file.name)
-    FileUtils.mkdir_p(File.dirname(target_path))
-    FileUtils.cp(file_path(system_file), target_path)
-  end
-
-  def file_path(system_file)
-    raise Machinery::Errors::FileUtilsError, "Not a file" if !system_file.file?
-
-    File.join(scope_file_store.path, system_file.name)
-  end
-end
-
 module ScopeFileAccessArchive
   def retrieve_files_from_system_as_archive(system, files, excluded_files)
     archive_path = File.join(scope_file_store.path, "files.tgz")
@@ -64,4 +44,27 @@ module ScopeFileAccessArchive
       File.join(system_file.scope.scope_file_store.path, "files.tgz")
     end
   end
+
+  def file_content(system_file)
+    if !extracted
+      raise Machinery::Errors::FileUtilsError, "The requested file '#{system_file.name}' is not" \
+        " available because files for scope '#{scope_name}' were not extracted."
+    end
+
+    tarball_path = File.join(scope_file_store.path, "files.tgz")
+    begin
+      Cheetah.run("tar", "xfO", tarball_path, system_file.name.gsub(/^\//, ""), stdout: :capture)
+    rescue
+      raise Machinery::Errors::FileUtilsError,
+        "The requested file '#{system_file.name}' was not found."
+    end
+  end
+
+  def binary?(system_file)
+    content = file_content(system_file)
+    return false if content.empty?
+
+    output = Cheetah.run("file", "-", stdin: content, stdout: :capture)
+    !output.include?("ASCII")
+  end
 end

data/lib/scope_file_access_flat.rb

@@ -0,0 +1,36 @@
+module ScopeFileAccessFlat
+  def retrieve_files_from_system(system, paths)
+    system.retrieve_files(paths, scope_file_store.path)
+  end
+
+  def write_file(system_file, target)
+    raise Machinery::Errors::FileUtilsError, "Not a file" if !system_file.file?
+
+    target_path = File.join(target, system_file.name)
+    FileUtils.mkdir_p(File.dirname(target_path))
+    FileUtils.cp(file_path(system_file), target_path)
+  end
+
+  def file_path(system_file)
+    raise Machinery::Errors::FileUtilsError, "Not a file" if !system_file.file?
+
+    File.join(scope_file_store.path, system_file.name)
+  end
+
+  def file_content(system_file)
+    if !extracted
+      raise Machinery::Errors::FileUtilsError, "The requested file '#{system_file.name}' is" \
+        " not available because files for scope '#{scope_name}' were not extracted."
+    end
+
+    File.read(file_path(system_file))
+  end
+
+  def binary?(system_file)
+    path = system_file.scope.file_path(system_file)
+    return false if File.zero?(path)
+
+    output = Cheetah.run("file", path, stdout: :capture)
+    !output.include?("ASCII")
+  end
+end

data/lib/serve_html_task.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2013-2015 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+class ServeHtmlTask
+  def serve(description, ip, port)
+    url = "http://#{ip}:#{port}/#{CGI.escape(description.name)}"
+
+    Machinery::Ui.use_pager = false
+    Machinery::Ui.puts <<EOF
+The description is now available at #{url}
+
+The web server can be closed with Ctrl+C.
+EOF
+
+    server = Html.run_server(description.store, port: port, ip: ip)
+
+    server.join
+  end
+end

data/lib/show_task.rb

@@ -19,7 +19,7 @@ class ShowTask
   def show(description, scopes, filter, options = {})
     scopes = Inspector.sort_scopes(scopes)
     if options[:show_html]
-      show_html(description)
+      show_html(description, options)
     else
       filter.apply!(description)
       show_console(description, scopes, options )
@@ -28,12 +28,26 @@ class ShowTask
 
   private
 
-  def show_html(description)
+  def show_html(description, options)
     begin
       LocalSystem.validate_existence_of_package("xdg-utils")
-      Html.generate(description)
-      html_path = SystemDescriptionStore.new.html_path(description.name)
-      LoggedCheetah.run("xdg-open", html_path)
+
+      url = "http://#{options[:ip]}:#{options[:port]}/#{CGI.escape(description.name)}"
+
+      Machinery::Ui.use_pager = false
+      Machinery::Ui.puts <<EOF
+There is a web server running, 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])
+
+      Html.when_server_ready(options[:ip], options[:port]) do
+        LoggedCheetah.run("xdg-open", url)
+      end
+
+      server.join # Wait until the user cancelled the blocking webserver
     rescue Cheetah::ExecutionFailed => e
       raise Machinery::Errors::OpenInBrowserFailed.new(
         "Could not open system description '#{description.name}' in the web browser.\n" \

data/lib/system_file.rb

@@ -40,5 +40,30 @@ module Machinery
         false
       end
     end
+
+    def on_disk?
+      assert_scope
+
+      scope.extracted && file? && !deleted?
+    end
+
+    def binary?
+      assert_scope
+      scope.binary?(self)
+    end
+
+    def content
+      assert_scope
+      scope.file_content(self)
+    end
+
+    private
+
+    def assert_scope
+      return if scope
+
+      raise Machinery::Errors::MachineryError,
+        "File store related method unavailable, the SystemFile does not have a Scope associated."
+    end
   end
 end

data/lib/version.rb

@@ -17,6 +17,6 @@
 
 module Machinery
 
-  VERSION = "1.9.1"
+  VERSION = "1.10.0"
 
 end