machinery-tool 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87228d0f2d8ad38866a4ce59c3f10a54e2991ce6
-  data.tar.gz: 7f962d709d33e097a7fbc022be920951aa038351
+  metadata.gz: 33037a49f9cd5990355d5c07ad549d035542379b
+  data.tar.gz: ea404796918a26ef4e0571a568bf60045d4dbd0b
 SHA512:
-  metadata.gz: 49ab73f8072183dcb1275dc1902a50512c58f6e492799fb1893875bc28cae759a596029db17770985de808d471896efa3d13acbbc5c070e6b5e0fc487e267050
-  data.tar.gz: 5de36d69acd9c187e50d0d5707e3a12970937f31f94a4f83a3bb691a29237b5369e6d143fdf6d55f5845ac47afae05fc86c0b5a3dc56d4ae2e5aa658a6d05f5e
+  metadata.gz: 2c93f3958a8423294a50709550983a336fc65ab4f9588f1a5957a4d6c3ed10eda6d899986941194694525f8de96a28b3e5b7095e7984d3565bcfee6c24df7e6d
+  data.tar.gz: e7a29850ca4d1891e2bf1719870fe24a9f37312d0dcd3814e69274f2a012c9ed1e3fcbdf1c9356fb220842da15f1a3e5274644e66d1f7e49b9ccbc026bf6bceb

data/.git_revision

@@ -1 +1 @@
-cf6d038ddefdf0d539b132c206336e141c39b418
+964505b0908b5f767f7fb74053b19884ae2e0954

data/NEWS

@@ -1,6 +1,14 @@
 # Machinery Release Notes
 
 
+## Version 1.22.0 - Thu Oct 06 17:03:33 CEST 2016 - thardeck@suse.de
+
+* Add remaining systemd service states in Kiwi export (gh#SUSE/machinery#2122)
+* Add export of system descriptions as HTML page. This provides an offline
+  view of descrptions (gh#SUSE/machinery#2119)
+* Fix changed files inspections on dpkg systems in case of diversions
+  (gh#SUSE/machinery#2138)
+
 ## Version 1.21.0 - Tue Jun 21 16:28:31 CEST 2016 - thardeck@suse.de
 
 * Add attribute in patterns scope to identify the patterns manager

data/html/index.html.haml

@@ -30,11 +30,12 @@
             .spinner
             %textarea#file-modal-file-content{ "readonly" => "true" }
             #file-modal-error{ "style" => "display: none" }
-          .modal-footer
-            %a.btn.btn-success#file-modal-download-link{ "target" => "_blank" }
-              Download
-            %button.btn.btn-primary{ "type" => "button", "data-dismiss" => "modal" }
-              Close
+          - unless @static_html
+            .modal-footer
+              %a.btn.btn-success#file-modal-download-link{ "target" => "_blank" }
+                Download
+              %button.btn.btn-primary{ "type" => "button", "data-dismiss" => "modal" }
+                Close
 
     #file_popover{ :style => "display: none" }
       .header
@@ -42,11 +43,11 @@
       .body
         %textarea.content
 
-    = render_partial "description_selector"
+    = render_partial "description_selector" unless @static_html
 
     .container-fluid
       #nav-bar
-        = render_partial "nav_bar"
+        = render_partial "nav_bar" unless @static_html
         .row.toolbar
           %small.col-xs-1
             %a#expand-all{ :href => "#", :style => "display: none" }

data/html/partials/changed_config_files.html.haml

@@ -42,7 +42,7 @@
                   %tr
                     %td
                       %span
-                        - if file.on_disk?
+                        - if file.on_disk && !@static_html
                           %a.file-download{ href: "#" }
                             = file.name
                         - else

data/html/partials/changed_managed_files.html.haml

@@ -29,7 +29,7 @@
                 - changed_managed_files.each do |file|
                   %tr
                     %td
-                      - if file.on_disk?
+                      - if file.on_disk? && !@static_html
                         %a.file-download{ href: "#" }
                           = file.name
                       - else

data/html/partials/unmanaged_files.html.haml

@@ -26,7 +26,7 @@
                     %th.medium Group
                     %th.medium Size
                     - if unmanaged_files.has_subdir_counts?
-                      %th.medium Subdirectories
+                      %th.medium Directories
                       %th.medium Files in Directory
                     - else
                       %th.medium File Objects
@@ -34,7 +34,7 @@
                 - unmanaged_files.each do |file|
                   %tr
                     %td
-                      - if file.on_disk?
+                      - if file.on_disk? && !@static_html
                         %a.file-download{ href: "#" }
                           = file.name
                       - else

data/lib/cli.rb

@@ -471,7 +471,7 @@ class Cli
     c.flag ["kiwi-dir", :k], type: String, required: true,
       desc: "Location where the description will be stored", arg_name: "DIRECTORY"
     c.switch :force, default_value: false, required: false, negatable: false,
-      desc: "Overwrite existing description"
+      desc: "Overwrite existing directory"
 
     c.action do |global_options,options,args|
       name = shift_arg(args, "NAME")
@@ -498,7 +498,7 @@ class Cli
     c.flag ["autoyast-dir", :a], type: String, required: true,
       desc: "Location where the autoyast profile will be stored", arg_name: "DIRECTORY"
     c.switch :force, default_value: false, required: false, negatable: false,
-      desc: "Overwrite existing profile"
+      desc: "Overwrite existing directory"
 
     c.action do |_global_options, options, args|
       name = shift_arg(args, "NAME")
@@ -513,11 +513,34 @@ class Cli
     end
   end
 
+  desc "Export static HTML view of a system description"
+  long_desc <<-LONGDESC
+    Export system description as HTML
+
+    The HTML view will be placed in a subdirectory at the given location by the 'html-dir'
+    option.
+  LONGDESC
+  arg "NAME"
+  command "export-html" do |c|
+    c.flag ["html-dir", :d], type: String, required: true,
+      desc: "Location where the HTML view will be stored", arg_name: "DIRECTORY"
+    c.switch :force, default_value: false, required: false, negatable: false,
+      desc: "Overwrite existing directory"
+
+    c.action do |_global_options, options, args|
+      name = shift_arg(args, "NAME")
+      description = SystemDescription.load(name, system_description_store)
+      exporter = StaticHtml.new(description, options["html-dir"])
+      exporter.create_directory(options[:force])
+      exporter.write
+    end
+  end
+
   def self.define_inspect_command_options(c)
     c.flag [:name, :n], type: String, required: false, arg_name: "NAME",
       desc: "Store system description under the specified name"
     c.flag [:scope, :s], type: String, required: false,
-      desc: "Show specified scopes", arg_name: "SCOPE_LIST"
+      desc: "Inspect specified scopes", arg_name: "SCOPE_LIST"
     c.flag ["ignore-scope", :e], type: String, required: false,
       desc: "Exclude specified scopes", arg_name: "SCOPE_LIST"
     c.flag "skip-files", required: false, negatable: false,
@@ -834,7 +857,6 @@ class Cli
 
         Machinery::Ui.puts "# Inspection details\n" + details unless details.empty?
       end
-
       task = ShowTask.new
       opts = {
         show_diffs: options["show-diffs"],

data/lib/diff_widget.rb

@@ -0,0 +1,73 @@
+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
+      end
+
+      entry
+    end
+    @widget
+  end
+
+  private
+
+  def header_entry(line)
+    {
+      type: "header",
+      content: line
+    }
+  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 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

data/lib/dpkg_database.rb

@@ -28,7 +28,16 @@ class DpkgDatabase < ManagedFilesDatabase
   end
 
   def package_for_file_path(file)
-    package_name = @system.run_command("dpkg", "-S", file, stdout: :capture).split(":").first
+    output = @system.run_command(
+      "dpkg", "-S", file, stdout: :capture
+    )
+
+    package_name = if output.lines == 1
+      output.split(":").first
+    else
+      extract_package_name_from_file_diversions(output)
+    end
+
     package_details = @system.run_command("dpkg", "-s", package_name, stdout: :capture)
     package_version = package_details.match(/^Version: (.*)$/)[1]
 
@@ -65,4 +74,10 @@ class DpkgDatabase < ManagedFilesDatabase
     @system.check_requirement("stat", "--version")
     @system.check_requirement("find", "--version")
   end
+
+  private
+
+  def extract_package_name_from_file_diversions(output)
+    output.lines.last.split(":").first.split(",").first
+  end
 end

data/lib/haml_helpers.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# Copyright (c) 2013-2016 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 HamlHelpers
+  def render_partial(partial, locals = {})
+    source = File.read(File.join(Machinery::ROOT, "html/partials/#{partial}.html.haml"))
+    haml source, locals: locals
+  end
+
+  def render_scope(scope)
+    render_partial scope, scope => @description[scope]
+  end
+
+  def scope_meta_info(scope)
+    return "" unless @description[scope]
+
+    " (" \
+      "inspected host: '#{@description[scope].meta.hostname}', " \
+      "at: #{DateTime.parse(@description[scope].meta.modified).strftime("%F %T")})"
+  end
+
+  def scope_help(scope)
+    text = scope_info(scope)[:description]
+    Kramdown::Document.new(text).to_html
+  end
+
+  def scope_info(scope)
+    YAML.load(File.read(File.join(Machinery::ROOT, "plugins", "#{scope}/#{scope}.yml")))
+  end
+
+  def scope_title(scope)
+    scope_info(scope)[:name]
+  end
+
+  def scope_initials(scope)
+    scope_info(scope)[:initials].upcase
+  end
+
+  def nav_class(scope)
+    if @description
+      return @description[scope] ? "" : "disabled"
+    elsif @description_a && @description_b
+      return @description_a[scope] && @description_b[scope] ? "" : "disabled"
+    end
+  end
+end

data/lib/kiwi_config.rb

@@ -345,11 +345,18 @@ EOF
           when "linked"
             # Don't do anything because linking doesn't mean enabling
             # nor disabling.
+          when "indirect"
+            # Don't do anything because indirect doesn't mean enabling
+            # nor disabling.
           when "enabled-runtime"
           when "linked-runtime"
           when "masked-runtime"
+          when "transient"
+          when "generated"
             # Don't do anything because these states are not supposed
             # to be permanent.
+          when "bad"
+            # Don't do anything because the unit file is broken
           else
             raise Machinery::Errors::ExportFailed.new(
               "The systemd unit state #{service.state} is unknown."

data/lib/machinery.rb

@@ -49,6 +49,7 @@ require_relative "array"
 require_relative "object"
 require_relative "constants"
 require_relative "manifest"
+require_relative "diff_widget"
 require_relative "system_description"
 require_relative "version"
 require_relative "tarball"
@@ -103,6 +104,7 @@ require_relative "man_task"
 require_relative "comparison"
 require_relative "serve_html_task"
 require_relative "file_diff"
+require_relative "haml_helpers"
 require_relative "server"
 require_relative "html"
 require_relative "machinery_helper"
@@ -116,6 +118,7 @@ require_relative "managed_files_database"
 require_relative "rpm_database"
 require_relative "dpkg_database"
 require_relative "tee_io"
+require_relative "static_html"
 
 Dir[File.join(Machinery::ROOT, "plugins", "**", "*.rb")].each { |f| require(f) }
 

data/lib/man_task.rb

@@ -17,8 +17,9 @@
 
 class ManTask
   def self.compile_documentation
-    docs = Inspector.all_scopes.map do |scope|
-      scope_doc = "* #{scope}\n\n"
+    docs = "# Scopes\n\n"
+    docs += Inspector.all_scopes.map do |scope|
+      scope_doc = "* #{scope.tr("_", "-")}\n\n"
       scope_doc += YAML.load_file(
         File.join(Machinery::ROOT, "plugins/#{scope}/#{scope}.yml")
       )[:description]

data/lib/move_task.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2013-2016 SUSE LLC
 #
 # This program is free software; you can redistribute it and/or

data/lib/remote_system.rb

@@ -145,6 +145,10 @@ class RemoteSystem < System
     end
   end
 
+  def check_retrieve_files_dependencies
+    LocalSystem.new.check_requirement("rsync", "--version")
+  end
+
   # Reads a file from the System. Returns nil if it does not exist.
   def read_file(file)
     run_command("cat", file, stdout: :capture, privileged: true)

data/lib/server.rb

@@ -40,48 +40,7 @@ end
 
 class Server < Sinatra::Base
   module Helpers
-    def render_partial(partial, locals = {})
-      source = File.read(File.join(Machinery::ROOT, "html/partials/#{partial}.html.haml"))
-      haml source, locals: locals
-    end
-
-    def render_scope(scope)
-      render_partial scope, scope => @description[scope]
-    end
-
-    def scope_meta_info(scope)
-      return "" unless @description[scope]
-
-      " (" \
-      "inspected host: '#{@description[scope].meta.hostname}', " \
-      "at: #{DateTime.parse(@description[scope].meta.modified).strftime("%F %T")})"
-    end
-
-    def scope_help(scope)
-      text = scope_info(scope)[:description]
-      Kramdown::Document.new(text).to_html
-    end
-
-    def scope_info(scope)
-      YAML.load(File.read(File.join(Machinery::ROOT, "plugins", "#{scope}/#{scope}.yml")))
-    end
-
-    def scope_title(scope)
-      scope_info(scope)[:name]
-    end
-
-    def scope_initials(scope)
-      scope_info(scope)[:initials].upcase
-    end
-
-    def nav_class(scope)
-      if @description
-        return @description[scope] ? "" : "disabled"
-      elsif @description_a && @description_b
-        return @description_a[scope] && @description_b[scope] ? "" : "disabled"
-      end
-    end
-
+    include HamlHelpers
     def safe_length(object, attribute)
       if collection = object.try(attribute)
         collection.length
@@ -170,60 +129,6 @@ class Server < Sinatra::Base
 
       value.to_s
     end
-
-    def diff_to_object(diff)
-      diff = Machinery.scrub(diff)
-      lines = diff.lines[2..-1]
-      diff_object = {
-        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
-      diff_object[:lines] = lines.map do |line|
-        line = ERB::Util.html_escape(line.chomp).
-          gsub("\\", "&#92;").
-          gsub("\t", "&nbsp;" * 8)
-        case line
-        when /^@.*/
-          entry = {
-            type: "header",
-            content: line
-          }
-          original_line_number = line[/-(\d+)/, 1].to_i
-          new_line_number = line[/\+(\d+)/, 1].to_i
-        when /^ .*/, ""
-          entry = {
-            type: "common",
-            new_line_number: new_line_number,
-            original_line_number: original_line_number,
-            content: line[1..-1]
-          }
-          new_line_number += 1
-          original_line_number += 1
-        when /^\+.*/
-          entry = {
-            type: "addition",
-            new_line_number: new_line_number,
-            content: line[1..-1]
-          }
-          new_line_number += 1
-        when /^\-.*/
-          entry = {
-            type: "deletion",
-            original_line_number: original_line_number,
-            content: line[1..-1]
-          }
-          original_line_number += 1
-        end
-
-        entry
-      end
-
-      diff_object
-    end
   end
 
   helpers Helpers
@@ -357,15 +262,7 @@ class Server < Sinatra::Base
       @error = e
       haml File.read(File.join(Machinery::ROOT, "html/exception.html.haml"))
     else
-      diffs_dir = @description.scope_file_store("analyze/changed_config_files_diffs").path
-      if @description.changed_config_files && diffs_dir
-        # Enrich description with the config file diffs
-        @description.changed_config_files.each do |file|
-          path = File.join(diffs_dir, file.name + ".diff")
-          file.diff = diff_to_object(File.read(path)) if File.exist?(path)
-        end
-      end
-
+      @description.load_existing_diffs
       haml File.read(File.join(Machinery::ROOT, "html/index.html.haml"))
     end
   end