machinery-tool 1.0.2

data/lib/renderer.rb

@@ -0,0 +1,243 @@
+# Copyright (c) 2013-2014 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
+
+# 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.
+#
+# 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
+# specifies "--scope=packages".
+#
+# The rendering methods are:
+# def heading(s)   - Render a heading
+# def puts(s)      - Print one line
+# def list(name)   - Start a list. This method takes a block where the items are
+#                    created.
+# def item(s)      - Print a list item
+#
+# Accordingly a simple renderer for the "packages" scope could look like this:
+#
+# class PackagesRenderer < Renderer
+#   def do_render
+#     return if @system_description.packages.empty?
+#
+#     list "Packages" do
+#       @system_description.packages.each do |p|
+#         item "#{p.name} (#{p.version})"
+#       end
+#     end
+#   end
+# end
+class Renderer
+
+  class InvalidStructureError < StandardError; end
+
+  attr_accessor :system_description
+  attr_accessor :buffer
+
+  abstract_method :do_render
+
+  @@renderers = []
+
+  class << self
+    def inherited(klass)
+      @@renderers << klass
+    end
+
+    def all
+      @@renderers.map { |renderer| renderer.new }
+    end
+
+    def for(scope)
+      class_name = "#{scope.split("_").map(&:capitalize).join}Renderer"
+
+      if Object.const_defined?(class_name)
+        Object.const_get(class_name).new
+      end
+    end
+  end
+
+  def render(system_description, options = {})
+    @system_description = system_description
+    @options = options
+    @buffer = ""
+    @indent = 2
+    @stack = []
+
+    if system_description[scope]
+      header = display_name
+      meta = system_description[scope].meta
+
+      if system_description[scope].is_extractable?
+        if @system_description.scope_extracted?(scope)
+          header += " (extracted)"
+        else
+          header += " (not extracted)"
+        end
+      end
+      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
+
+      heading(header)
+    end
+
+    do_render
+
+    @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 = {})
+    @options = options
+    @buffer = ""
+    @indent = 0
+    @stack = []
+
+    show_heading = if options[:show_all]
+      description1[scope] || description2[scope] || description_common[scope]
+    else
+      description1[scope] || description2[scope]
+    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]
+
+    @buffer
+  end
+
+  def render_comparison_missing_scope(description1, description2)
+    @buffer = ""
+    @indent = 0
+    @stack = []
+    missing_descriptions = Array.new
+
+    @buffer += "# #{display_name}\n"
+
+   if !description1[scope]
+      missing_descriptions << description1.name
+    end
+    if !description2[scope]
+      missing_descriptions << description2.name
+    end
+
+    indent { puts "Unable to compare, no data in '#{missing_descriptions.join("', '")}'" }
+    @buffer += "\n" unless @buffer.empty? || @buffer.end_with?("\n\n")
+
+    @buffer
+  end
+
+  def heading(s)
+    @buffer += "# #{s}\n\n"
+  end
+
+  def puts(s)
+    print_indented "#{s}"
+  end
+
+  def list(name = nil, &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")
+
+    @stack.pop
+  end
+
+  def item(s, &block)
+    unless @stack.last == :list
+      raise InvalidStructureError.new(
+        "'item' was called outside of a list block"
+      )
+    end
+
+    print_indented "* #{s}"
+
+    if block_given?
+      @stack << :item
+      indent do
+        block.call
+      end
+      @buffer += "\n"
+      @stack.pop
+    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)
+    s.split("\n").each do |line|
+      @buffer += " " * @indent + line + "\n"
+    end
+  end
+
+  def indent
+    @indent += 2
+    yield
+    @indent -= 2
+  end
+end

data/lib/renderer_helper.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2013-2014 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
+
+def number_to_human_size(s)
+  unit = %W(B KiB MiB GiB TiB)
+  i = s.to_i
+
+  exp = i != 0 ? Math.log(i, 1024).floor : 0
+  value = (i / 1024.0 ** exp).round(1)
+
+  "#{"%g" % value} #{unit[exp]}"
+end

data/lib/rpm.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 2013-2014 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
+
+# Rpm represents an RPM package on the disk.
+class 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", "-iv", "--to-stdout", ".#{file}", stdin: cpio, stdout: :capture
+      )
+    rescue Cheetah::ExecutionFailed => e
+      Machinery.logger.error(e.stderr)
+      return nil
+    end
+
+    begin
+      LoggedCheetah.run(
+        "diff", "-u", "--label", "#{File.join("a", file)}", "--from-file=-",
+         "--label", "#{File.join("b", file)}", local_file,
+        stdin: original_config,
+        stdout: :capture
+      )
+    rescue Cheetah::ExecutionFailed => e
+      # diff exits with 1 when there are changes
+      if e.status.exitstatus == 1
+        e.stdout
+      else
+        Machinery.logger.error(e.stderr)
+        return nil
+      end
+    end
+  end
+end

data/lib/scope_mixin.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2013-2014 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
+
+module Machinery
+  module ScopeMixin
+    attr_accessor :meta
+
+    def set_metadata(timestring, host)
+      self.meta = Machinery::Object.new(
+        modified: timestring,
+        hostname: host
+      )
+    end
+
+    def scope_name
+      scope = self.class.name.match(/^(.*)Scope$/)[1]
+      scope.gsub(/([^A-Z])([A-Z])/, "\\1_\\2").downcase
+    end
+
+    def is_extractable?
+      SystemDescription::EXTRACTABLE_SCOPES.include?(self.scope_name)
+    end
+  end
+end

data/lib/show_task.rb

@@ -0,0 +1,65 @@
+# Copyright (c) 2013-2014 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 ShowTask
+  def show(description, scopes, options = {})
+    if options[:show_html]
+      show_html(description)
+    else
+      show_console(description, scopes, options )
+    end
+  end
+
+  private
+
+  def show_html(description)
+    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)
+    rescue Cheetah::ExecutionFailed => e
+      raise Machinery::Errors::OpenInBrowserFailed.new(
+        "Could not open system description \"#{description.name}\" in the web browser.\n" \
+          "Error: #{e}\n"
+      )
+    end
+  end
+
+  def show_console(description, scopes, options)
+    missing_scopes = []
+    output = ""
+
+    scopes.map { |s| Renderer.for(s) }.each do |renderer|
+      section = renderer.render(description, options)
+      unless section.empty?
+        output += section
+      else
+        missing_scopes << renderer.scope
+      end
+    end
+
+    if missing_scopes.length > 0
+      output += "# The following requested scopes were not inspected\n\n"
+      missing_scopes.each do |scope|
+        output += "  * #{Machinery::Ui.internal_scope_list_to_string(scope)}\n"
+      end
+    end
+
+    Machinery::Ui.print_output(output, :no_pager => options[:no_pager])
+  end
+end

data/lib/system.rb

@@ -0,0 +1,81 @@
+# Copyright (c) 2013-2014 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
+
+# System and its subclasses are used to represent systems that are to be
+# inspected.
+#
+# 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
+  abstract_method :requires_root?
+  abstract_method :run_command
+  abstract_method :kiwi_describe
+  abstract_method :retrieve_files
+  abstract_method :read_file
+
+  def self.for(host)
+    if host && host != "localhost"
+      RemoteSystem.new(host)
+    else
+      LocalSystem.new
+    end
+  end
+
+  # checks if the required command can be executed on the target system
+  def check_requirement(command, *args)
+    begin
+      run_command(command, *args)
+    rescue Cheetah::ExecutionFailed
+      raise Machinery::Errors::MissingRequirement.new(
+        "Need binary '#{command}' to be available on the inspected system."
+      )
+    end
+  end
+
+  # Retrieves files specified in filelist from the remote system and create an archive.
+  # To be able to deal with arbitrary filenames we use zero-terminated
+  # filelist and the --null option of tar
+  def create_archive(filelist, archive, exclude = [])
+    created = !File.exists?(archive)
+    out = File.open(archive, "w")
+    begin
+      run_command(
+        "tar", "--directory=/", "--create", "--gzip", "--null", "--files-from=-",
+        *exclude.flat_map { |f| ["--exclude", f]},
+        :stdout => out,
+        :stdin => filelist
+      )
+    rescue Cheetah::ExecutionFailed => e
+      if e.status.exitstatus == 1
+        # The tarball has been created successfully but some files were changed
+        # on disk while being archived, so we just log the warning and go on
+        Machinery.logger.info e.stderr
+      else
+        raise
+      end
+    end
+    out.close
+    File.chmod(0600, archive) if created
+  end
+
+  def run_script(*args)
+    script = File.read(File.join(Machinery::ROOT, "helpers", args.shift))
+
+    run_command("bash", "-c", script, *args)
+  end
+end