machinery-tool 1.14.0 → 1.14.1

data/lib/scope_file_access_archive.rb

@@ -74,7 +74,6 @@ module ScopeFileAccessArchive
     content = file_content(system_file)
     return false if content.empty?
 
-    output = Cheetah.run("file", "-", stdin: content, stdout: :capture)
-    !output.include?("ASCII")
+    Machinery.content_is_binary?(content.slice(0, 1024))
   end
 end

data/lib/scope_file_access_flat.rb

@@ -30,8 +30,7 @@ module ScopeFileAccessFlat
     path = system_file.scope.file_path(system_file)
     return false if File.zero?(path)
 
-    output = Cheetah.run("file", path, stdout: :capture)
-    !output.include?("ASCII")
+    Machinery.content_is_binary?(File.read(path))
   end
 
   def has_file?(name)

data/lib/server.rb

@@ -17,11 +17,88 @@
 
 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 "" if !@description[scope]
+
+      " (" \
+      "inspected host: '#{@description[scope].meta.hostname}', " \
+      "at: #{DateTime.parse(@description[scope].meta.modified).strftime("%F %T")})"
+    end
+
     def scope_help(scope)
       text = File.read(File.join(Machinery::ROOT, "plugins", "#{scope}/#{scope}.md"))
       Kramdown::Document.new(text).to_html
     end
 
+    def safe_length(object, attribute)
+      if object && collection = object.send(attribute)
+        collection.length
+      else
+        0
+      end
+    end
+
+    def only_in_a
+      "<h3>Only in '#{@description_a.name}':</h3>"
+    end
+
+    def only_in_b
+      "<h3>Only in '#{@description_b.name}':</h3>"
+    end
+
+    def in_both
+      "<h3>In both descriptions:</h3>"
+    end
+
+    def changed
+      "<h3>In both with different attributes:</h3>"
+    end
+
+    def changed_packages
+      changed = []
+      @diff["packages"].changed.each do |change|
+        changes = []
+        relevant_attributes = ["version", "vendor", "arch"]
+
+        if change[0].version == change[1].version
+          relevant_attributes.push("release")
+          if change[0].release == change[1].release
+            relevant_attributes.push("checksum")
+          end
+        end
+
+        relevant_attributes.each do |attribute|
+          if change[0][attribute] != change[1][attribute]
+            changes.push(attribute + ": " + change[0][attribute] + " ↔ " + change[1][attribute])
+          end
+        end
+
+        changed.push(change[0].name + " (" + changes.join(", ") + ")")
+      end
+      changed
+    end
+
+    def diffable_unmanaged_files
+      return @diffable_unmanaged_files if @diffable_unmanaged_files
+
+      return [] if !@diff["unmanaged_files"] || !@diff["unmanaged_files"].only_in1 ||
+          !@diff["unmanaged_files"].only_in2
+
+      files_in_1 = @diff["unmanaged_files"].only_in1.files.select(&:file?).map(&:name)
+      files_in_2 = @diff["unmanaged_files"].only_in2.files.select(&:file?).map(&:name)
+
+      @diffable_unmanaged_files = files_in_1 & files_in_2
+    end
+
     def diff_to_object(diff)
       diff = Machinery.scrub(diff)
       lines = diff.lines[2..-1]
@@ -79,29 +156,6 @@ class Server < Sinatra::Base
 
   helpers Helpers
 
-  get "/descriptions/:id.js" do
-    description = SystemDescription.load(params[:id], settings.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|
-      next if !description[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], settings.system_description_store)
     filename = File.join("/", params["splat"].first)
@@ -122,41 +176,31 @@ class Server < Sinatra::Base
     content
   end
 
-  get "/compare/:a/:b.json" do
-    description_a = SystemDescription.load(params[:a], settings.system_description_store)
-    description_b = SystemDescription.load(params[:b], settings.system_description_store)
+  get "/compare/:a/:b" do
+    @description_a = SystemDescription.load(params[:a], settings.system_description_store)
+    @description_b = SystemDescription.load(params[:b], settings.system_description_store)
 
-    diff = {
-      meta: {
-        description_a: description_a.name,
-        description_b: description_b.name,
-      }
-    }
+    @meta = {}
+    @diff = {}
 
     Inspector.all_scopes.each do |scope|
-      if description_a[scope] && description_b[scope]
-        comparison = Comparison.compare_scope(description_a, description_b, scope)
-        diff[scope] = comparison.as_json
+      if @description_a[scope] && @description_b[scope]
+        @diff[scope] = Comparison.compare_scope(@description_a, @description_b, scope)
       else
-        diff[:meta][:uninspected] ||= Hash.new
+        @meta[:uninspected] ||= Hash.new
 
-        if !description_a[scope] && description_b[scope]
-          diff[:meta][:uninspected][description_a.name] ||= Array.new
-          diff[:meta][:uninspected][description_a.name] << scope
+        if !@description_a[scope] && @description_b[scope]
+          @meta[:uninspected][@description_a.name] ||= Array.new
+          @meta[:uninspected][@description_a.name] << scope
         end
-        if !description_b[scope] && description_a[scope]
-          diff[:meta][:uninspected][description_b.name] ||= Array.new
-          diff[:meta][:uninspected][description_b.name] << scope
+        if !@description_b[scope] && @description_a[scope]
+          @meta[:uninspected][@description_b.name] ||= Array.new
+          @meta[:uninspected][@description_b.name] << scope
         end
       end
     end
 
-    diff.to_json
-  end
-
-  get "/compare/:a/:b" do
-    haml File.read(File.join(Machinery::ROOT, "html/comparison.html.haml")),
-      locals: { description_a: params[:a], description_b: params[:b] }
+    haml File.read(File.join(Machinery::ROOT, "html/comparison.html.haml"))
   end
 
   get "/compare/:a/:b/files/:scope/*" do
@@ -175,7 +219,17 @@ class Server < Sinatra::Base
   end
 
   get "/:id" do
-    haml File.read(File.join(Machinery::ROOT, "html/index.html.haml")),
-      locals: { description_name: params[:id] }
+    @description = SystemDescription.load(params[:id], settings.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
+
+    haml File.read(File.join(Machinery::ROOT, "html/index.html.haml"))
   end
 end

data/lib/version.rb

@@ -17,6 +17,6 @@
 
 module Machinery
 
-  VERSION = "1.14.0"
+  VERSION = "1.14.1"
 
 end

data/machinery-helper/version.go

@@ -2,4 +2,4 @@
 
 package main
 
-const VERSION = "9787fc1eff835522740423ff35c98b78205b31cb"
+const VERSION = "a879bc791c625025e2861c0bc37a2d2207da250a"

data/man/generated/machinery.1.html

@@ -67,6 +67,7 @@
     <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="#inspect-Inspect-Running-System">inspect — Inspect Running System</a>
+    <a href="#inspect-container-Inspect-Container">inspect-container — Inspect Container</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="#move-Move-System-Description">move — Move System Description</a>
@@ -900,6 +901,105 @@ configuration files are saved:</p>
 </ul>
 
 
+<h2 id="inspect-container-Inspect-Container">inspect-container — Inspect Container</h2>
+
+<h3 id="SYNOPSIS">SYNOPSIS</h3>
+
+<p><code>machinery inspect-container</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> IMAGENAME</p>
+
+<p><code>machinery inspect-container</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> IMAGEID</p>
+
+<p><code>machinery</code> help inspect-container</p>
+
+<h3 id="DESCRIPTION">DESCRIPTION</h3>
+
+<p>The <code>inspect-container</code> command inspects a container image. It creates and starts the container from the provided image before inspection
+and generates a system description from the gathered data. After the inspection the container will be killed and removed again.
+This approach ensures that no containers and images are affected by the inspection.</p>
+
+<p>Right now we support only images from the type <code>docker</code>.</p>
+
+<p>The system data is structured into scopes, controlled by the
+<code>--scope</code> option.</p>
+
+<p><strong>Note</strong>:
+Machinery will always inspect all specified scopes, and skip scopes which
+trigger errors.</p>
+
+<h3 id="ARGUMENTS">ARGUMENTS</h3>
+
+<dl>
+<dt><code>IMAGENAME / IMAGEID</code> (required)</dt><dd>The name or id of the image to be inspected. The provided name or id will also be
+used as the name of the stored system description unless another name is
+provided with the <code>--name</code> option.</dd>
+</dl>
+
+
+<h3 id="OPTIONS">OPTIONS</h3>
+
+<dl>
+<dt><code>-n NAME</code>, <code>--name=NAME</code> (optional)</dt><dd><p>Store the system description under the specified name.</p></dd>
+<dt><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional)</dt><dd><p>Inspect image for specified scope.
+See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
+<dt><code>-e SCOPE</code>, <code>--exclude-scope=EXCLUDE-SCOPE</code> (optional)</dt><dd><p>Inspect image for all scopes except the specified scope.
+See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
+<dt><code>-x</code>, <code>--extract-files</code> (optional)</dt><dd><p>Extract changed configuration and unmanaged files from the inspected container.
+Shortcut for the combination of <code>--extract-changed-config-files</code>,
+<code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p></dd>
+<dt><code>--extract-changed-config-files</code> (optional)</dt><dd><p>Extract changed configuration files from the inspected image.</p></dd>
+<dt><code>--extract-unmanaged-files</code> (optional)</dt><dd><p>Extract unmanaged files from the inspected image.</p></dd>
+<dt><code>--extract-changed-managed-files</code> (optional)</dt><dd><p>Extract changed managed files from inspected image.</p></dd>
+<dt><code>--skip-files</code> (optional)</dt><dd><p>Do not consider given files or directories during inspection. Either provide
+one file or directory name or a list of names separated by commas. You can
+also point to a file which contains a list of files to filter (one per line)
+by adding an '@' before the path, e.g.</p>
+
+<p>  $ <code>machinery</code> inspect-container --skip-files=@/path/to/filter_file mycontainer</p>
+
+<p>If a filename contains a comma it needs to be escaped, e.g.</p>
+
+<p>  $ <code>machinery</code> inspect-container --skip-files=/file\,with_comma mycontainer</p>
+
+<p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
+  literally and not expanded.</p></dd>
+<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which are used during inspection.</p></dd>
+</dl>
+
+
+<h3 id="PREREQUISITES">PREREQUISITES</h3>
+
+<ul>
+<li><p>Inspecting a container requires an image specified by the name or id.</p></li>
+<li><p>The image to be inspected needs to have the following commands:</p>
+
+<ul>
+<li><code>rpm</code></li>
+<li><code>zypper</code> or <code>yum</code></li>
+<li><code>rsync</code></li>
+<li><code>chkconfig</code></li>
+<li><code>cat</code></li>
+<li><code>sed</code></li>
+<li><code>find</code></li>
+</ul>
+</li>
+</ul>
+
+
+<h3 id="EXAMPLES">EXAMPLES</h3>
+
+<dl>
+<dt>Inspect docker-container <code>mycontainer</code> and save system description under name 'MyContainer':</dt><dd><p></p>
+
+<p>$ <code>machinery</code> inspect-container --name=MyContainer mycontainer</p></dd>
+<dt>Inspect docker-container <code>076f46c1bef1</code> and save system description under name 'MySecondContainer':</dt><dd><p></p>
+
+<p>$ <code>machinery</code> inspect-container --name=MySecondContainer 076f46c1bef1</p></dd>
+<dt>Extracts changed managed files and saves them:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> inspect-container --scope=changed-managed-files --extract-files mycontainer</p></dd>
+</dl>
+
+
 <h2 id="list-List-System-Descriptions">list — List System Descriptions</h2>
 
 <h3 id="SYNOPSIS">SYNOPSIS</h3>
@@ -1030,7 +1130,7 @@ Currently displays [HOSTNAME] and (DATE).</dd>
 
 <h3 id="SYNOPSIS">SYNOPSIS</h3>
 
-<p><code>machinery serve</code> [-p PORT | --port=PORT] [-i IP | --ip=IP] NAME</p>
+<p><code>machinery serve</code> [-p PORT | --port=PORT] [--public] NAME</p>
 
 <p><code>machinery</code> help serve</p>
 
@@ -1055,10 +1155,8 @@ IP address and the port can be configured using the according options.</p>
 
 <p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
 chosen when <code>machinery</code> will be executed as <code>root</code> user.</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>
-
-<p>It's only possible to use an IP address (or hostnames resolving to an IP address) which
-is assigned to a network interface on the local machine.</p></dd>
+<dt><code>--public</code> (optional)</dt><dd><p>Specifying this option, lets the server listen on each configured IP address. By default
+the server will only listen on the localhost IP address 127.0.0.1</p></dd>
 </dl>
 
 
@@ -1068,9 +1166,9 @@ is assigned to a network interface on the local machine.</p></dd>
 <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>
+<dt>Make the system description available to other machines on the network on port 3000:</dt><dd><p></p>
 
-<p>$ <code>machinery</code> serve earth -i 10.10.100.123 -p 3000</p></dd>
+<p>$ <code>machinery</code> serve earth --public --port 3000</p></dd>
 </dl>
 
 
@@ -1078,7 +1176,7 @@ is assigned to a network interface on the local machine.</p></dd>
 
 <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] [-p PORT | --port=PORT] [-i IP | --ip=IP] NAME</p>
+<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</code> help show</p>
 
@@ -1110,14 +1208,6 @@ See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more infor
 for more information).</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>
-
-<p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
-chosen when <code>machinery</code> will be executed as <code>root</code> user.</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>
-
-<p>It's only possible to use an IP address (or hostnames resolving to an IP address) which
-is assigned to a network interface on the local machine.</p></dd>
 <dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which were applied before showing the system description.</p></dd>
 </dl>
 

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: machinery-tool
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.1
 platform: ruby
 authors:
 - SUSE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cheetah
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: abstract_method
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '2.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +126,14 @@ dependencies:
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -243,18 +243,16 @@ files:
 - export_helpers/unmanaged_files_kiwi_excludes
 - filters/default_filters.json
 - filters/filter-packages-for-build.yaml
-- html/assets/angular-sanitize.min.js
-- html/assets/angular.min.js
 - html/assets/arrow_down.png
 - html/assets/arrow_up.png
 - html/assets/bootstrap-popover.js
 - html/assets/bootstrap-tooltip.js
 - html/assets/bootstrap.min.css
 - html/assets/collapse.js
-- html/assets/compare/machinery-compare.js
 - html/assets/compare/machinery.js
 - html/assets/cross.png
 - html/assets/jquery-2.1.1.min.js
+- html/assets/jquery.searcher.min.js
 - html/assets/logo-changed-managed-files-small.png
 - html/assets/logo-changed-managed-files.png
 - html/assets/logo-config-files-small.png
@@ -279,12 +277,43 @@ files:
 - html/assets/machinery.css
 - html/assets/modal.js
 - html/assets/reset.png
-- html/assets/show/machinery-show.js
 - html/assets/show/machinery.js
 - html/assets/transition.js
 - html/assets/wheels_horizontal.png
 - html/comparison.html.haml
 - html/index.html.haml
+- html/partials/changed_managed_files.html.haml
+- html/partials/compare/alert.html.haml
+- html/partials/compare/changed_managed_file_list.html.haml
+- html/partials/compare/changed_managed_files.html.haml
+- html/partials/compare/config_file_list.html.haml
+- html/partials/compare/config_files.html.haml
+- html/partials/compare/group_list.html.haml
+- html/partials/compare/groups.html.haml
+- html/partials/compare/os.html.haml
+- html/partials/compare/os_table.html.haml
+- html/partials/compare/package_list.html.haml
+- html/partials/compare/packages.html.haml
+- html/partials/compare/pattern_list.html.haml
+- html/partials/compare/patterns.html.haml
+- html/partials/compare/repositories.html.haml
+- html/partials/compare/repository_list.html.haml
+- html/partials/compare/service_list.html.haml
+- html/partials/compare/services.html.haml
+- html/partials/compare/unmanaged_file_list.html.haml
+- html/partials/compare/unmanaged_files.html.haml
+- html/partials/compare/user_list.html.haml
+- html/partials/compare/users.html.haml
+- html/partials/config_files.html.haml
+- html/partials/groups.html.haml
+- html/partials/os.html.haml
+- html/partials/packages.html.haml
+- html/partials/patterns.html.haml
+- html/partials/repositories.html.haml
+- html/partials/scope_header.html.haml
+- html/partials/services.html.haml
+- html/partials/unmanaged_files.html.haml
+- html/partials/users.html.haml
 - inspect_helpers/changed_files.sh
 - inspect_helpers/yum_repositories.py
 - lib/analyze_config_file_diffs_task.rb