machinery-tool 1.9.1 → 1.10.0

data/html/index.html.haml

@@ -2,7 +2,7 @@
 %html{"ng-app" => "machinery-show"}
   %head
     %title
-      = description.name + " - Machinery System Description"
+      = description_name + " - Machinery System Description"
     %meta{:charset => 'utf-8'}/
     %link{:href => "assets/machinery-base.css", :rel => "stylesheet", :type => "text/css"}/
     %link{:href => "assets/machinery.css", :rel => "stylesheet", :type => "text/css"}/
@@ -12,6 +12,7 @@
     %script{:src => "assets/jquery-2.1.1.min.js"}
     %script{:src => "assets/transition.js"}
     %script{:src => "assets/collapse.js"}
+    %script{:src => "assets/modal.js"}
 
     %script#inspection_details_template{:type => "text/ng-template"}
       #inspection_details.hidden
@@ -248,13 +249,13 @@
                 %tbody
                   %tr{"ng-repeat" => "service in description.services.services | filter:query"}
                     %td {{service.name}}
-                    %td{:class=>"{{services.init_system}}_{{state}}"}
+                    %td{:class=>"{{description.services.init_system}}_{{service.state}}"}
                       {{service.state}}
 
     %script#scope_config_files.partial{:type => "text/ng-template"}
       %div{"ng-show" => "description.config_files.files"}
         %a.scope_anchor{:id => "config_files"}
-        #config_files_container.scope
+        #config_files_container.scope{"data-scope" => "config_files"}
           %scope-header{ |
             :summary => "'#{scope_help('config_files')}'", |
             :logo => "'assets/logo-config-files.png'", |
@@ -289,7 +290,11 @@
                 %tbody
                   %tr{"ng-repeat" => "file in description.config_files.files | filter:query"}
                     %td
-                      {{file.name}}
+                      %span{"ng-switch" => true, "on" => "file.downloadable"}
+                        %a.file-download{"ng-switch-when" => "true", "href" => "#"}
+                          {{file.name}}
+                        %span{"ng-switch-default" => true}
+                          {{file.name}}
                       %a.diff-toggle{"ng-show" => "file.diff", "data-config-file" => "{{file.name}}", "data-toggle" => "popover"}
                         Show diff
                     %td {{file.package_name}}
@@ -304,7 +309,7 @@
     %script#scope_changed_managed_files.partial{:type => "text/ng-template"}
       %div{"ng-show" => "description.changed_managed_files.files"}
         %a.scope_anchor{:id => "changed_managed_files"}
-        #changed_managed_files_container.scope
+        #changed_managed_files_container.scope{"data-scope" => "changed_managed_files"}
           %scope-header{ |
             :summary => "'#{scope_help('changed_managed_files')}'", |
             :logo => "'assets/logo-changed-managed-files.png'", |
@@ -329,7 +334,11 @@
                     %th Group
                 %tbody
                   %tr{"ng-repeat" => "file in description.changed_managed_files.files | filter:query"}
-                    %td {{file.name}}
+                    %td{"ng-switch" => true, "on" => "file.downloadable"}
+                      %a.file-download{"ng-switch-when" => "true", "href" => "#"}
+                        {{file.name}}
+                      %span{"ng-switch-default" => true}
+                        {{file.name}}
                     %td {{file.package_name}}
                     %td {{file.package_version}}
                     %td
@@ -342,7 +351,7 @@
     %script#scope_unmanaged_files.partial{:type => "text/ng-template"}
       %div{"ng-show" => "description.unmanaged_files.files"}
         %a.scope_anchor{:id => "unmanaged_files"}
-        #unmanaged_files_container.scope
+        #unmanaged_files_container.scope{"data-scope" => "unmanaged_files"}
           %scope-header{ |
             :summary => "'#{scope_help('unmanaged_files')}'", |
             :logo => "'assets/logo-unmanaged-files.png'", |
@@ -362,22 +371,47 @@
                     %th Type
                 %tbody
                   %tr{"ng-repeat" => "file in description.unmanaged_files.files | filter:query"}
-                    %td {{file.name}}
+                    %td{"ng-switch" => true, "on" => "file.downloadable"}
+                      %a.file-download{"ng-switch-when" => "true", "href" => "#"}
+                        {{file.name}}
+                      %span{"ng-switch-default" => true}
+                        {{file.name}}
                     %td {{file.type}}
 
-    %script{:src => "assets/description.js"}
     %script{:src => "assets/show/machinery.js"}
     %script{:src => "assets/bootstrap-tooltip.js"}
     %script{:src => "assets/bootstrap-popover.js"}
 
-  %body
+  %body{"data-description" => description_name}
+    #file-modal.modal.fade
+      .modal-dialog.modal-lg
+        .modal-content
+          .modal-header
+            %button.close{"type" => "button", "data-dismiss" => "modal"}
+              ×
+            %h4#file-modal-title
+          .modal-body
+            %textarea#file-modal-file-content{"readonly" => "true"}
+            #file-modal-error{"style" => "display: none"}
+          .modal-footer
+            %a#file-modal-download-link.btn.btn-success{"target" => "_blank"}
+              Download
+            %button.btn.btn-primary{"type" => "button", "data-dismiss" => "modal"}
+              Close
+
+    #file_popover{:style => "display: none"}
+      .header
+        %h3.name
+      .body
+        %textarea.content
+
     .container-fluid
       #nav-bar
         .row
           .col-xs-1
           .col-xs-10
             %h1
-              System '#{description.name}'
+              System '#{description_name}'
 
             %a.inspection_details{:href => "#", "data-toggle" => "popover"} (inspection details)
         .row
@@ -386,7 +420,7 @@
               Expand all
             %a#collapse-all{:href => "#"}
               Collapse all
-          .col-xs-10
+          .col-xs-9
             %small.pull-right.pad-top
               created by
               %a{:href => "http://machinery-project.org", :target => "_blank"}

data/lib/array.rb

@@ -113,8 +113,9 @@ module Machinery
       [
         self - other,
         other - self,
+        [],
         self & other
-      ].map { |e| !e.empty? ? e : nil }
+      ].map { |e| e.empty? ? nil : e }
     end
 
     def method_missing(name, *args, &block)

data/lib/cli.rb

@@ -86,6 +86,9 @@ class Cli
     Machinery::Ui.kill_pager
 
     case e
+    when GLI::MissingRequiredArgumentsException
+      Machinery::Ui.error("Option --" + e.message)
+      exit 1 
     when GLI::UnknownCommandArgument, GLI::UnknownGlobalArgument,
         GLI::UnknownCommand, GLI::BadCommandLine, OptionParser::MissingArgument
       Machinery::Ui.error e.to_s + "\n\n"
@@ -359,7 +362,6 @@ class Cli
   end
 
 
-
   desc "Deploy image to OpenStack cloud"
   long_desc <<-LONGDESC
     Deploy system description as image to OpenStack cloud.
@@ -421,8 +423,6 @@ class Cli
     end
   end
 
-
-
   desc "Export system description as AutoYaST profile"
   long_desc <<-LONGDESC
     Export system description as AutoYaST profile
@@ -450,8 +450,6 @@ class Cli
     end
   end
 
-
-
   desc "Inspect running system"
   long_desc <<-LONGDESC
     Inspect running system and generate system descripton from inspected data.
@@ -566,6 +564,18 @@ class Cli
     end
   end
 
+  desc "Shows man page"
+  long_desc <<-LONGDESC
+    Shows the man page of the machinery tool.
+
+  LONGDESC
+  command :man do |c|
+    c.action do
+      task = ManTask.new
+      task.man
+    end
+  end
+
 
 
   desc "Remove system descriptions"
@@ -605,6 +615,10 @@ class Cli
       desc: "Show specified scopes", arg_name: "SCOPE_LIST"
     c.flag ["exclude-scope", :e], type: String, required: false,
       desc: "Exclude specified scopes", arg_name: "SCOPE_LIST"
+    c.flag [:port, :p], type: Integer, required: false, default_value: @config.http_server_port,
+      desc: "Listen on port PORT", arg_name: "PORT"
+    c.flag [:ip, :i], type: String, required: false, default_value: "127.0.0.1",
+      desc: "Listen on ip address IP", arg_name: "IP"
     c.switch "pager", required: false, default_value: true,
       desc: "Pipe output into a pager"
     c.switch "show-diffs", required: false, negatable: false,
@@ -642,8 +656,10 @@ class Cli
 
       task = ShowTask.new
       opts = {
-          show_diffs: options["show-diffs"],
-          show_html:  options["html"]
+        show_diffs: options["show-diffs"],
+        show_html: options["html"],
+        ip: options["ip"],
+        port: options["port"]
       }
       task.show(description, scope_list, filter, opts)
     end
@@ -691,21 +707,6 @@ class Cli
     end
   end
 
-  desc "Generate an HTML view for a system description"
-  long_desc <<-LONGDESC
-    Generates an HTML view for a system description.
-  LONGDESC
-  arg "NAME"
-  command "generate-html" do |c|
-    c.action do |global_options,options,args|
-      name = shift_arg(args, "NAME")
-
-      description = SystemDescription.load(name, system_description_store)
-      task = GenerateHtmlTask.new
-      task.generate(description)
-    end
-  end
-
   desc "Show or change machinery's configuration"
   long_desc <<-LONGDESC
     Show or change machinery's configuration.
@@ -731,12 +732,32 @@ class Cli
       task = ConfigTask.new
       task.config(key, value)
 
-      if key == "hints" && !@config.hints
+      if key == "hints" && (value == "false" || value == "off")
         Machinery::Ui.puts "Hints can be switched on again by '#{$0} config hints=on'."
       end
     end
   end
 
+  desc "Start a webserver serving an HTML view of a system description"
+  long_desc <<-LONGDESC
+    Starts a web server which serves an HTML view for the given system description.
+  LONGDESC
+  arg "NAME"
+  command "serve" do |c|
+    c.flag [:port, :p], type: Integer, required: false, default_value: 7585,
+      desc: "Listen on port PORT", arg_name: "PORT"
+    c.flag [:ip, :i], type: String, required: false, default_value: "127.0.0.1",
+      desc: "Listen on ip IP", arg_name: "IP"
+
+    c.action do |_global_options, options, args|
+      name = shift_arg(args, "NAME")
+
+      description = SystemDescription.load(name, system_description_store)
+      task = ServeHtmlTask.new
+      task.serve(description, options[:ip], options[:port])
+    end
+  end
+
   def self.system_description_store
     if ENV.has_key?("MACHINERY_DIR")
       SystemDescriptionStore.new(ENV["MACHINERY_DIR"])

data/lib/compare_task.rb

@@ -36,8 +36,8 @@ class CompareTask
 
     scopes.each do |scope|
       if description1[scope] && description2[scope]
-        comparison = description1[scope].compare_with(description2[scope])
-        diff[scope] = comparison.map { |scope| scope.as_json if scope }
+        comparison = Comparison.compare_scope(description1, description2, scope)
+        diff[scope] = comparison.as_json
       end
     end
 
@@ -54,37 +54,13 @@ class CompareTask
     identical = true
     identical_scopes = []
     common_scopes = false
-    store = description1.store
     scopes.each do |scope|
       if description1[scope] && description2[scope]
-        comparison = description1[scope].compare_with(description2[scope])
+        comparison = Comparison.compare_scope(description1, description2, scope)
 
-        partial_description1 = SystemDescription.new(
-          description1.name,
-          store,
-          scope => comparison[0]
-        )
-
-        partial_description2 = SystemDescription.new(
-          description2.name,
-          store,
-          scope => comparison[1]
-        )
-
-        partial_description_common = SystemDescription.new(
-          "common",
-          store,
-          scope => comparison[2]
-        )
-
-        output += Renderer.for(scope).render_comparison(
-          partial_description1,
-          partial_description2,
-          partial_description_common,
-          options
-        )
+        output += Renderer.for(scope).render_comparison(comparison, options)
 
-        if partial_description1[scope] || partial_description2[scope]
+        if comparison.only_in1 || comparison.only_in2 || comparison.changed
           identical = false
         else
           identical_scopes << scope

data/lib/comparison.rb

@@ -0,0 +1,69 @@
+# 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 Comparison
+  attr_accessor :name1, :name2, :only_in1, :only_in2, :changed, :common, :store, :scope
+
+  def self.compare_scope(description1, description2, scope)
+    result = new
+    result.store = description1.store
+    result.scope = scope
+    result.name1 = description1.name
+    result.name2 = description2.name
+
+    if !description1[scope]
+      result.only_in2 = description2[scope]
+    elsif !description2[scope]
+      result.only_in1 = description1[scope]
+    else
+      result.only_in1, result.only_in2, result.changed, result.common =
+        description1[scope].compare_with(description2[scope])
+    end
+
+    result
+  end
+
+  def as_description(which)
+    case which
+    when :one
+      name = name1
+      data = only_in1
+    when :two
+      name = name2
+      data = only_in2
+    when :common
+      name = "common"
+      data = common
+    else
+      raise "'which' has to be :one, :two or :common"
+    end
+
+    SystemDescription.new(name, store, scope => data)
+  end
+
+  def as_json
+    json = {}
+    json["only_in1"] = only_in1.as_json if only_in1
+    json["only_in2"] = only_in2.as_json if only_in2
+    if changed
+      json["changed"] = changed.map { |elements| [elements.first.as_json, elements.last.as_json] }
+    end
+    json["common"] = common.as_json if common
+
+    json
+  end
+end

data/lib/config.rb

@@ -42,6 +42,10 @@ module Machinery
         default: true,
         description: "Check whether the current platform is supported by Machinery"
       )
+      entry("http_server_port",
+        default: 7585,
+        description: "TCP port used by the HTTP server for the HTML view"
+      )
     end
   end
 end

data/lib/export_task.rb

@@ -24,6 +24,13 @@ class ExportTask
     @exporter.system_description.assert_scopes("os")
     @exporter.system_description.validate_export_compatibility
 
+    ["unmanaged_files", "changed_managed_files", "config_files"].each do |scope|
+      if @exporter.system_description[scope] &&
+          !@exporter.system_description.scope_extracted?(scope)
+        raise Machinery::Errors::MissingExtractedFiles.new(@exporter.system_description, [scope])
+      end
+    end
+
     output_dir = File.join(output_dir, @exporter.export_name)
     if File.exists?(output_dir)
       if options[:force]

data/lib/file_scope.rb

@@ -29,7 +29,7 @@ class FileScope < Machinery::Object
     only_self = nil if only_self.empty?
     only_other = nil if only_other.empty?
     shared = nil if shared.empty?
-    [only_self, only_other, shared]
+    [only_self, only_other, nil, shared]
   end
 
   private
@@ -57,7 +57,7 @@ class FileScope < Machinery::Object
   end
 
   def compare_files(other, only_self, only_other, shared)
-    own_files, other_files, shared_files = files.compare_with(other.files)
+    own_files, other_files, _changed, shared_files = files.compare_with(other.files)
 
     only_self.files = own_files if own_files
     only_other.files = other_files if other_files

data/lib/html.rb

@@ -16,39 +16,177 @@
 # you may find current contact information at www.suse.com
 
 class Html
-  def self.escape_javascript(object)
-    object.gsub(/([\\'"])/, "\\\\\\1")
+  module Helpers
+    def scope_help(scope)
+      text = File.read(File.join(Machinery::ROOT, "plugins", "#{scope}/#{scope}.md"))
+      Kramdown::Document.new(text).to_html
+    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("\\", "\").
+          gsub("\t", " " * 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
 
-  def self.generate(description)
-    template = Haml::Engine.new(
-      File.read(File.join(Machinery::ROOT, "html", "index.html.haml"))
-    )
-    target = description.store.description_path(description.name)
-
-    diffs_dir = description.scope_file_store("analyze/config_file_diffs").path
-    if description.config_files && diffs_dir
-      # Enrich description with the config file diffs
-      description.config_files.files.each do |file|
-        path = File.join(diffs_dir, file.name + ".diff")
-        file.diff = diff_to_object(File.read(path)) if File.exists?(path)
+  # this is required for the #generate_comparison method which renders a HAML template manually with
+  # the local binding, so it expects the helper methods to be available in Html. It can be removed
+  # once the comparison was move to the webserver approach as well
+  extend Helpers
+
+  # Creates a new thread running a sinatra webserver which serves the local system descriptions
+  # The Thread object is returned so that the caller can `.join` it until it's finished.
+  def self.run_server(system_description_store, opts)
+    Thread.new do
+      require "sinatra/base"
+      require "mimemagic"
+
+      server = Sinatra.new do
+        set :port, opts[:port] || 7585
+        set :bind, opts[:ip] || "localhost"
+        set :public_folder, File.join(Machinery::ROOT, "html")
+
+        helpers Helpers
+
+        get "/descriptions/:id.js" do
+          description = SystemDescription.load(params[:id], system_description_store)
+          diffs_dir = description.scope_file_store("analyze/config_file_diffs").path
+          if description.config_files && diffs_dir
+            # Enrich description with the config file diffs
+            description.config_files.files.each do |file|
+              path = File.join(diffs_dir, file.name + ".diff")
+              file.diff = diff_to_object(File.read(path)) if File.exists?(path)
+            end
+          end
+
+          # Enrich file information with downloadable flag
+          ["config_files", "changed_managed_files", "unmanaged_files"].each do |scope|
+            description[scope].files.each do |file|
+              file.downloadable = file.on_disk?
+            end
+          end
+
+          description.to_hash.to_json
+        end
+
+        get "/descriptions/:id/files/:scope/*" do
+          description = SystemDescription.load(params[:id], system_description_store)
+          filename = File.join("/", params["splat"].first)
+
+          file = description[params[:scope]].files.find { |f| f.name == filename }
+
+          if request.accept.first.to_s == "text/plain" && file.binary?
+            status 406
+            return "binary file"
+          end
+
+          content = file.content
+          type = MimeMagic.by_path(filename) || MimeMagic.by_magic(content) || "text/plain"
+
+          content_type type
+          attachment File.basename(filename)
+
+          content
+        end
+
+        get "/:id" do
+          haml File.read(File.join(Machinery::ROOT, "html/index.html.haml")),
+            locals: { description_name: params[:id] }
+        end
+      end
+
+      if opts[:ip] != "localhost" && opts[:ip] != "127.0.0.1"
+        Machinery::Ui.puts <<EOF
+Warning:
+You specified an IP address other than '127.0.0.1', your server may be reachable from the network.
+This could lead to confidential data like passwords or private keys being readable by others.
+EOF
+      end
+
+      begin
+        setup_output_redirection
+        server.run!
+      rescue => e
+        # Re-raise exception in main thread
+        Thread.main.raise e
+      ensure
+        remove_output_redirection
       end
     end
+  end
 
-    FileUtils.cp_r(File.join(Machinery::ROOT, "html", "assets"), target)
-    File.write(File.join(target, "index.html"), template.render(binding))
+  def self.when_server_ready(ip, port, &block)
+    20.times do
+      begin
+        TCPSocket.new(ip, port).close
+        block.call
+        return
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+        sleep 0.1
+      end
+    end
+    raise Machinery::Errors::MachineryError, "The web server did not come up in time."
+  end
 
-    # Generate JSON and escape the 's and "s in order to not break the JSON
-    # string in javascript.
-    json = escape_javascript(description.to_hash.to_json)
-    File.write(File.join(target, "assets/description.js"),<<-EOT
-      function getDescription() {
-        return JSON.parse('#{json}'
-        )
-      }
-      EOT
-    )
-    target
+  def self.setup_output_redirection
+    @orig_stdout = STDOUT.clone
+    @orig_stderr = STDERR.clone
+    server_log = File.join(Machinery::DEFAULT_CONFIG_DIR, "webserver.log")
+    STDOUT.reopen server_log, "w"
+    STDERR.reopen server_log, "w"
+  end
+
+  def self.remove_output_redirection
+    STDOUT.reopen @orig_stdout
+    STDERR.reopen @orig_stderr
   end
 
   def self.generate_comparison(diff, target)
@@ -68,65 +206,4 @@ class Html
       EOT
     )
   end
-
-  # Template helpers
-
-  def self.scope_help(scope)
-    text = File.read(File.join(Machinery::ROOT, "plugins", "#{scope}/#{scope}.md"))
-    Kramdown::Document.new(text).to_html
-  end
-
-  def self.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