machinery-tool 1.9.1 → 1.10.0

data/man/generated/machinery.1.html

@@ -65,10 +65,11 @@
     <a href="#deploy-Deploy-Image-to-OpenStack-Cloud">deploy — Deploy Image to OpenStack Cloud</a>
     <a href="#export-autoyast-Export-System-Description-as-AutoYasST-profile">export-autoyast — Export System Description as AutoYasST profile</a>
     <a href="#export-kiwi-Export-System-Description-as-KIWI-Image-Description">export-kiwi — Export System Description as KIWI Image Description</a>
-    <a href="#generate-html-Generate-an-HTML-view-of-a-System-Description">generate-html — Generate an HTML view of a System Description</a>
     <a href="#inspect-Inspect-Running-System">inspect — Inspect Running System</a>
     <a href="#list-List-System-Descriptions">list — List System Descriptions</a>
+    <a href="#man-Shows-Man-Page">man — Shows Man Page</a>
     <a href="#remove-Remove-System-Descriptions">remove — Remove System Descriptions</a>
+    <a href="#serve-Serve-A-System-Description-Using-A-Web-Server">serve — Serve A System Description Using A Web Server</a>
     <a href="#show-Show-System-Description">show — Show System Description</a>
     <a href="#upgrade-format-Upgrade-System-Description">upgrade-format — Upgrade System Description</a>
     <a href="#validate-Validate-System-Description">validate — Validate System Description</a>
@@ -777,36 +778,6 @@ will be created if it does not exist yet.</p></dd>
 </dl>
 
 
-<h2 id="generate-html-Generate-an-HTML-view-of-a-System-Description">generate-html — Generate an HTML view of a System Description</h2>
-
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-
-<p><code>machinery generate-html</code> NAME</p>
-
-<p><code>machinery</code> help generate-html</p>
-
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-
-<p>The <code>generate-html</code> generates an HTML view of a system description. The
-index.html file can be found in the according system description directory, e.g.
-~/.machinery/NAME/index.html.</p>
-
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-
-
-<h3 id="EXAMPLES">EXAMPLES</h3>
-
-<dl>
-<dt>Create an HTML view of the <code>moon</code> system description:</dt><dd><p></p>
-
-<p>$ <code>machinery</code> generate-html moon</p></dd>
-</dl>
-
-
 <h2 id="inspect-Inspect-Running-System">inspect — Inspect Running System</h2>
 
 <h3 id="SYNOPSIS">SYNOPSIS</h3>
@@ -958,6 +929,16 @@ Currently displays [HOSTNAME] and (DATE).</dd>
 </dl>
 
 
+<h2 id="man-Shows-Man-Page">man — Shows Man Page</h2>
+
+<h3 id="SYNOPSIS">SYNOPSIS</h3>
+
+<p>  <code>machinery man</code></p>
+
+<h3 id="DESCRIPTION">DESCRIPTION</h3>
+
+<p>The <code>man</code> command shows the Machinery man page.</p>
+
 <h2 id="remove-Remove-System-Descriptions">remove — Remove System Descriptions</h2>
 
 <h3 id="SYNOPSIS">SYNOPSIS</h3>
@@ -1001,11 +982,53 @@ Currently displays [HOSTNAME] and (DATE).</dd>
 </dl>
 
 
+<h2 id="serve-Serve-A-System-Description-Using-A-Web-Server">serve — Serve A System Description Using A Web Server</h2>
+
+<h3 id="SYNOPSIS">SYNOPSIS</h3>
+
+<p><code>machinery serve</code> [-p PORT | --port=PORT] [-i IP | --ip=IP] NAME</p>
+
+<p><code>machinery</code> help serve</p>
+
+<h3 id="DESCRIPTION">DESCRIPTION</h3>
+
+<p>The <code>serve</code> command spawns a web server and serves a stored system description on
+it.
+By default the description is available from http://127.0.0.1:7585 but both the
+IP address and the port can be configured using the according options.</p>
+
+<h3 id="ARGUMENTS">ARGUMENTS</h3>
+
+<dl>
+<dt><code>NAME</code> (required)</dt><dd>Use specified system description.</dd>
+</dl>
+
+
+<h3 id="OPTIONS">OPTIONS</h3>
+
+<dl>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p></dd>
+<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p></dd>
+</dl>
+
+
+<h3 id="EXAMPLES">EXAMPLES</h3>
+
+<dl>
+<dt>Serve the system description taken from the last inspection, saved as <code>earth</code>:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> serve earth</p></dd>
+<dt>Make the system description available to other machines on the network:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> serve earth -i 10.10.100.123 -p 3000</p></dd>
+</dl>
+
+
 <h2 id="show-Show-System-Description">show — Show System Description</h2>
 
 <h3 id="SYNOPSIS">SYNOPSIS</h3>
 
-<p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-diffs] [--html] NAME</p>
+<p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-diffs] [--html] [-p PORT | --port=PORT] [-i IP | --ip=IP] NAME</p>
 
 <p><code>machinery</code> help show</p>
 
@@ -1035,7 +1058,10 @@ See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more infor
 <dt><code>--no-pager</code> (optional)</dt><dd><p>Do not pipe output into a pager.</p></dd>
 <dt><code>--show-diffs</code> (optional)</dt><dd><p>Include the generated diffs in the output if available (see <code>machinery help analyze</code>
 for more information).</p></dd>
-<dt><code>--html</code> (optional)</dt><dd><p>Open the system description in HTML format in your web browser using the <code>xdg-open</code> command.</p></dd>
+<dt><code>--html</code> (optional)</dt><dd><p>Run a web server and open the system description in HTML format in your web browser using the
+<code>xdg-open</code> command.</p></dd>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p></dd>
+<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p></dd>
 <dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which were applied before showing the system description.</p></dd>
 </dl>
 
@@ -1172,7 +1198,7 @@ manually editing it.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>June 2015</li>
+    <li class='tc'>July 2015</li>
     <li class='tr'>machinery(1)</li>
   </ol>
 

data/plugins/changed_managed_files/changed_managed_files_renderer.rb

@@ -16,17 +16,17 @@
 # you may find current contact information at www.suse.com
 
 class ChangedManagedFilesRenderer < Renderer
-  def do_render
-    return unless @system_description["changed_managed_files"]
+  def content(description)
+    return unless description["changed_managed_files"]
 
-    if  @system_description["changed_managed_files"].files
-      files, errors = @system_description["changed_managed_files"].files.partition do |file|
+    if description["changed_managed_files"].files
+      files, errors = description["changed_managed_files"].files.partition do |file|
         file.status != "error"
       end
     end
 
     list do
-      file_status = @system_description["changed_managed_files"].extracted
+      file_status = description["changed_managed_files"].extracted
       if !file_status.nil?
         puts "Files extracted: #{file_status ? "yes" : "no"}"
       end

data/plugins/config_files/config_files_renderer.rb

@@ -16,24 +16,25 @@
 # you may find current contact information at www.suse.com
 
 class ConfigFilesRenderer < Renderer
-  def do_render
-    return unless @system_description["config_files"]
+  def content(description)
+    return unless description["config_files"]
 
-    diffs_dir = @system_description.scope_file_store("analyze/config_file_diffs").path
+    diffs_dir = description.scope_file_store("analyze/config_file_diffs").path
 
     if !diffs_dir && @options[:show_diffs]
       raise Machinery::Errors::SystemDescriptionError.new(
         "Diffs can not be shown because they were not generated yet.\n" \
-        "You can generate them with `#{$0} analyze --operation=config-file-diffs #{@system_description.name}`."
+        "You can generate them with `#{$0} analyze" \
+        " --operation=config-file-diffs #{description.name}`."
       )
     end
 
     list do
-      file_status = @system_description["config_files"].extracted
+      file_status = description["config_files"].extracted
       if !file_status.nil?
         puts "Files extracted: #{file_status ? "yes" : "no"}"
       end
-      files = @system_description["config_files"].files
+      files = description["config_files"].files
       if files
         files.each do |p|
           item_content = "#{p.name} (#{p.package_name}-#{p.package_version}, " \

data/plugins/groups/groups_renderer.rb

@@ -16,11 +16,11 @@
 # you may find current contact information at www.suse.com
 
 class GroupsRenderer < Renderer
-  def do_render
-    return unless @system_description.groups
+  def content(description)
+    return unless description.groups
 
     list do
-      @system_description.groups.each do |group|
+      description.groups.each do |group|
         gid = group.gid || "N/A"
         details ="gid: #{gid}"
         details += ", users: #{group.users.join(",")}" if !group.users.empty?

data/plugins/os/os_renderer.rb

@@ -17,12 +17,12 @@
 
 #  This renderer prints the operating system
 class OsRenderer < Renderer
-  def do_render
-    return unless @system_description.os
+  def content(description)
+    return unless description.os
 
-    puts "Name: #{@system_description.os.name}"
-    puts "Version: #{@system_description.os.version}"
-    puts "Architecture: #{@system_description.os.architecture}"
+    puts "Name: #{description.os.name}"
+    puts "Version: #{description.os.version}"
+    puts "Architecture: #{description.os.architecture}"
   end
 
   def display_name

data/plugins/packages/packages_model.rb

@@ -23,4 +23,29 @@ class PackagesScope < Machinery::Array
   include Machinery::Scope
 
   has_elements class: Package
+
+  def compare_with(other)
+    only_self = self - other
+    only_other = other - self
+    common = self & other
+
+    changed_package_names = only_self.map(&:name) & only_other.map(&:name)
+    changed = []
+
+    changed_package_names.each do |name|
+      changed << [
+        only_self.find { |package| package.name == name },
+        only_other.find { |package| package.name == name },
+      ]
+      only_self.reject! { |package| package.name == name }
+      only_other.reject! { |package| package.name == name }
+    end
+
+    [
+      only_self,
+      only_other,
+      changed,
+      common
+    ].map { |e| (e && !e.empty?) ? e : nil }
+  end
 end

data/plugins/packages/packages_renderer.rb

@@ -16,17 +16,48 @@
 # you may find current contact information at www.suse.com
 
 class PackagesRenderer < Renderer
-  def do_render
-    return unless @system_description.packages
+  def display_name
+    "Packages"
+  end
+
+  def content(description)
+    return unless description.packages
 
     list do
-      @system_description.packages.each do |p|
+      description.packages.each do |p|
         item "#{p.name}-#{p.version}-#{p.release}.#{p.arch} (#{p.vendor})"
       end
     end
   end
 
-  def display_name
-    "Packages"
+  # In the comparison case we only want to show the package name, not all details like version,
+  # architecture etc.
+  def compare_content_only_in(description)
+    list do
+      description.packages.each do |p|
+        item "#{p.name}"
+      end
+    end
+  end
+
+  def compare_content_changed(changed_elements)
+    list do
+      changed_elements.each do |one, two|
+        changes = []
+        relevant_attributes = ["version", "vendor", "arch"]
+        if one.version == two.version
+          relevant_attributes << "release"
+          relevant_attributes << "checksum" if one.release == two.release
+        end
+
+        relevant_attributes.each do |attribute|
+          if one[attribute] != two[attribute]
+            changes << "#{attribute}: #{one[attribute]} <> #{two[attribute]}"
+          end
+        end
+
+        item "#{one.name} (#{changes.join(", ")})"
+      end
+    end
   end
 end

data/plugins/patterns/patterns_renderer.rb

@@ -16,11 +16,11 @@
 # you may find current contact information at www.suse.com
 
 class PatternsRenderer < Renderer
-  def do_render
-    return unless @system_description.patterns
+  def content(description)
+    return unless description.patterns
 
     list do
-      @system_description.patterns.each do |p|
+      description.patterns.each do |p|
         item "#{p.name}"
       end
     end

data/plugins/repositories/repositories_model.rb

@@ -18,7 +18,7 @@
 
 class Repository < Machinery::Object
   def external_medium?
-    url.start_with?("cd://") || url.start_with?("dvd://")
+    url.start_with?("cd://") || url.start_with?("dvd://") || url.start_with?("iso://")
   end
 end
 

data/plugins/repositories/repositories_renderer.rb

@@ -16,15 +16,15 @@
 # you may find current contact information at www.suse.com
 
 class RepositoriesRenderer < Renderer
-  def do_render
-    return unless @system_description.repositories
+  def content(description)
+    return unless description.repositories
 
-    if @system_description.repositories.empty?
+    if description.repositories.empty?
       puts "System has no repositories"
     end
 
     list do
-      @system_description.repositories.each do |p|
+      description.repositories.each do |p|
         item "#{p.name}" do
           puts "URI: #{p.url}"
           puts "Alias: #{p.alias}"

data/plugins/services/services_model.rb

@@ -38,11 +38,12 @@ class ServicesScope < Machinery::Object
 
   def compare_with(other)
     if self.init_system != other.init_system
-      [self, other, nil]
+      [self, other, nil, nil]
     else
       [
         self.services - other.services,
         other.services - self.services,
+        [],
         self.services & other.services
       ].map do |services|
         if !services.empty?
@@ -54,4 +55,3 @@ class ServicesScope < Machinery::Object
     end
   end
 end
-

data/plugins/services/services_renderer.rb

@@ -16,11 +16,11 @@
 # you may find current contact information at www.suse.com
 
 class ServicesRenderer < Renderer
-  def do_render
-    return unless @system_description["services"]
+  def content(description)
+    return unless description["services"]
 
     list do
-      @system_description["services"].services.each do |p|
+      description["services"].services.each do |p|
         item "#{p.name}: #{p.state}"
       end
     end

data/plugins/unmanaged_files/unmanaged_files_model.rb

@@ -35,8 +35,9 @@ class UnmanagedFileList < Machinery::Array
     [
       self.class.new(only_self),
       self.class.new(only_other),
+      [],
       self.class.new(both)
-    ].map { |e| !e.empty? ? e : nil }
+    ].map { |e| e.empty? ? nil : e }
   end
 
   private

data/plugins/unmanaged_files/unmanaged_files_renderer.rb

@@ -16,17 +16,17 @@
 # you may find current contact information at www.suse.com
 
 class UnmanagedFilesRenderer < Renderer
-  def do_render
-    return unless @system_description["unmanaged_files"]
+  def content(description)
+    return unless description["unmanaged_files"]
 
     list do
-      file_status = @system_description["unmanaged_files"].extracted
+      file_status = description["unmanaged_files"].extracted
       if !file_status.nil?
         puts "Files extracted: #{file_status ? "yes" : "no"}"
       end
 
-      if @system_description["unmanaged_files"].files
-        @system_description["unmanaged_files"].files.each do |p|
+      if description["unmanaged_files"].files
+        description["unmanaged_files"].files.each do |p|
           if p.user && p.group
             item "#{p.name} (#{p.type})" do
               puts "User/Group: #{p.user}:#{p.group}"

data/plugins/users/users_renderer.rb

@@ -16,11 +16,11 @@
 # you may find current contact information at www.suse.com
 
 class UsersRenderer < Renderer
-  def do_render
-    return unless @system_description.users
+  def content(description)
+    return unless description.users
 
     list do
-      @system_description.users.each do |user|
+      description.users.each do |user|
         info = user.comment.empty? ? "N/A" : user.comment
         uid = user.uid || "N/A"
         gid = user.gid || "N/A"