machinery-tool 1.4.0 → 1.5.0

data/lib/tarball.rb

@@ -25,26 +25,26 @@ class Tarball
     output = LoggedCheetah.run("tar", "tvf", @file, :stdout => :capture)
 
     output.lines.map do |line|
-      mode, user_and_group, size, date, time, *rest = line.split(" ")
+      mode, user_and_group, size, _date, _time, rest = line.split(" ", 6)
 
       case mode[0]
       when "l"
         type = :link
         # This may fail for files with "->" in their name, but there is no way
         # how to avoid this when using "tar".
-        path = rest.join(" ").split(" -> ").first
+        path = rest.split(" -> ").first
       when "h"
         type = :file
         # This may fail for files with "link to" in their name, but there is no way
         # how to avoid this when using "tar" unless we use the parameter
         # --hard-dereference with tar to get rid of hard links
-        path = rest.join(" ").split(" link to ").first
+        path = rest.split(" link to ").first
       when "d"
         type = :dir
-        path = rest.join(" ")[0..-2]   # Strip trailing "/".
+        path = rest.chomp("/\n")
       else
         type = :file
-        path = rest.join(" ")
+        path = rest.chomp
       end
 
       user, group = user_and_group.split("/")

data/lib/version.rb

@@ -17,6 +17,6 @@
 
 module Machinery
 
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 
 end

data/lib/zypper.rb

@@ -27,22 +27,21 @@ class Zypper
 
   class <<self
     def isolated(options = {}, &block)
-      zypper_base = Dir.mktmpdir("machinery_zypper")
-      zypper = Zypper.new
+      Dir.mktmpdir("machinery_zypper") do |zypper_base|
+        zypper = Zypper.new
 
-      zypper.zypper_options = [
-        "--non-interactive",
-        "--no-gpg-checks",
-        "--root", zypper_base
-      ]
+        zypper.zypper_options = [
+          "--non-interactive",
+          "--no-gpg-checks",
+          "--root", zypper_base
+        ]
 
-      if options[:arch]
-        zypper.zypp_config = create_zypp_config(zypper_base, options[:arch])
-      end
+        if options[:arch]
+          zypper.zypp_config = create_zypp_config(zypper_base, options[:arch])
+        end
 
-      block.call(zypper)
-    ensure
-      cleanup(zypper_base)
+        block.call(zypper)
+      end
     end
 
     private
@@ -60,10 +59,6 @@ class Zypper
 
       zypp_config
     end
-
-    def cleanup(base)
-      LoggedCheetah.run("rm", "-r", base)
-    end
   end
 
   def add_repo(url, repo_alias)

data/man/generated/machinery.1.html

@@ -240,14 +240,17 @@ scope to <code>packages</code>. This will output only the requested information.
 <li><p>changed-managed-files</p>
 
 <p>Contains the names and contents of all non-configuration files which have
-been changed compared to the files in the package.</p></li>
+been changed compared to the files in the package. A file change is reported
+if its content or its attributes like Linux permission bits or ownership
+have changed.</p></li>
 <li><p>config-files</p>
 
 <p>Contains all configuration files which have been changed since they were
 installed.
 Configuration files are all those files which are marked as such in the
-package which has installed them. A configuration file is considered changed
-if either its content or its Linux permission bits have changed.</p></li>
+package which has installed them. A configuration file change is reported
+if its content or its attributes like Linux permission bits or ownership
+have changed.</p></li>
 <li><p>groups</p>
 
 <p>Contains information about the system groups such as group attributes and the
@@ -853,6 +856,16 @@ Shortcut for the combination of <code>--extract-changed-config-files</code>,
 <dt><code>--extract-changed-config-files</code> (optional)</dt><dd><p>Extract changed configuration files from the inspected system.</p></dd>
 <dt><code>--extract-unmanaged-files</code> (optional)</dt><dd><p>Extract unmanaged files from the inspected system.</p></dd>
 <dt><code>--extract-changed-managed-files</code> (optional)</dt><dd><p>Extract changed managed files from inspected system.</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 --skip-files=@/path/to/filter_file myhost</p>
+
+<p>If a filename contains a comma it needs to be escaped, e.g.</p>
+
+<p>  $ <code>machinery</code> inspect --skip-files=/file\,with_comma myhost</p></dd>
 </dl>
 
 
@@ -917,6 +930,7 @@ scopes for each system.</p>
 <dl>
 <dt><code>--verbose</code> (optional)</dt><dd>Print additional information about the origin of scopes.
 Currently displays [HOSTNAME] and (DATE).</dd>
+<dt><code>--short</code> (optional)</dt><dd>List only descripton names.</dd>
 </dl>
 
 
@@ -929,6 +943,9 @@ Currently displays [HOSTNAME] and (DATE).</dd>
 <dt>Same as previous command, but additionally prints the date of each scope:</dt><dd><p></p>
 
 <p>$ <code>machinery</code> list --verbose</p></dd>
+<dt>Lists all available system description names without any additional details:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> list --short</p></dd>
 </dl>
 
 
@@ -1145,7 +1162,7 @@ manually editing it.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>February 2015</li>
+    <li class='tc'>March 2015</li>
     <li class='tr'>machinery(1)</li>
   </ol>
 

data/plugins/docs/changed_managed_files.md

@@ -1,2 +1,4 @@
   Contains the names and contents of all non-configuration files which have
-  been changed compared to the files in the package.
+  been changed compared to the files in the package. A file change is reported
+  if its content or its attributes like Linux permission bits or ownership
+  have changed.

data/plugins/docs/config_files.md

@@ -1,5 +1,6 @@
   Contains all configuration files which have been changed since they were
   installed.
   Configuration files are all those files which are marked as such in the
-  package which has installed them. A configuration file is considered changed
-  if either its content or its Linux permission bits have changed.
+  package which has installed them. A configuration file change is reported
+  if its content or its attributes like Linux permission bits or ownership
+  have changed.

data/plugins/inspect/changed_managed_files_inspector.rb

@@ -18,7 +18,7 @@
 class ChangedManagedFilesInspector < Inspector
   include ChangedRpmFilesHelper
 
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, options = {})
     system.check_requirement("rsync", "--version") if options[:extract_changed_managed_files]
 
     @system = system
@@ -29,7 +29,13 @@ class ChangedManagedFilesInspector < Inspector
     file_store.remove
     if options[:extract_changed_managed_files]
       file_store.create
-      existing_files = changed_files.reject { |f| f.changes.nil? || f.changes.include?("deleted") }
+
+      existing_files = changed_files.reject do |f|
+        f.changes.nil? ||
+        f.changes.include?("deleted") ||
+        f.name == "/"
+      end
+
       system.retrieve_files(existing_files.map(&:name), file_store.path)
     end
 

data/plugins/inspect/config_files_inspector.rb

@@ -82,7 +82,7 @@ class ConfigFilesInspector < Inspector
     end
   end
 
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, options = {})
     do_extract = options[:extract_changed_config_files]
     check_requirements(system, do_extract)
 

data/plugins/inspect/groups_inspector.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 class GroupsInspector < Inspector
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, _options = {})
     group_content = system.read_file("/etc/group")
 
     groups = group_content ? parse_groups(group_content) : []
@@ -29,6 +29,8 @@ class GroupsInspector < Inspector
 
   def parse_groups(content)
     content.lines.map do |line|
+      # prevent split from ignoring the last entry if it is empty and there is no newline
+      line += "\n" if line.end_with?(":")
       name, password, gid, users = line.split(":").map(&:chomp)
 
       gid = Machinery::is_int?(gid) ? gid.to_i : nil

data/plugins/inspect/os_inspector.rb

@@ -38,7 +38,7 @@ class OsInspector < Inspector
     special_version ? " #{special_version.gsub(/[0-9]{1,2}/," \\0")}" : ""
   end
 
-  def inspect(system, description, _options = {})
+  def inspect(system, description, _filter, _options = {})
     system.check_requirement("cat", "--version") if system.is_a?(RemoteSystem)
 
     os = get_os(system)
@@ -79,7 +79,7 @@ class OsInspector < Inspector
     return if !os_release
 
     result = Hash.new
-    key_value_pairs = Hash[os_release.split("\n").map { |l| l.split("=") }]
+    key_value_pairs = Hash[os_release.split("\n").reject(&:empty?).map { |l| l.split("=") }]
     key_value_pairs.each_pair do |k,v|
       result[k.downcase] = v.strip.gsub(/^"|"$/,"")
     end

data/plugins/inspect/packages_inspector.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 class PackagesInspector < Inspector
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, _options = {})
     system.check_requirement("rpm", "--version")
 
     packages = Array.new

data/plugins/inspect/patterns_inspector.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 class PatternsInspector < Inspector
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, _options = {})
     if system.has_command?("zypper")
       inspect_with_zypper(system, description)
     else

data/plugins/inspect/repositories_inspector.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 class RepositoriesInspector < Inspector
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, _options = {})
     if system.has_command?("zypper")
       description.repositories, summary = inspect_zypp_repositories(system)
     elsif system.has_command?("yum")

data/plugins/inspect/services_inspector.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 class ServicesInspector < Inspector
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, _options = {})
     if system.has_command?("systemctl")
       result = ServicesScope.new(
         init_system: "systemd",

data/plugins/inspect/unmanaged_files_inspector.rb

@@ -218,7 +218,7 @@ class UnmanagedFilesInspector < Inspector
     3
   end
 
-  def inspect(system, description, options = nil)
+  def inspect(system, description, filter, options = {})
     do_extract = options && options[:extract_unmanaged_files]
     check_requirements(system, do_extract)
 
@@ -227,40 +227,6 @@ class UnmanagedFilesInspector < Inspector
 
     mount_points = MountPoints.new(system)
 
-    ignore_list = [
-      "tmp",
-      "var/tmp",
-      "lost+found",
-      "var/run",
-      "var/lib/rpm",
-      ".snapshots",
-      description.store.base_path.sub(/^\//, ""),
-      "proc",
-      "boot"
-    ]
-
-    # Information about users and groups are extracted by the according inspector
-    ignore_list += [
-      "etc/passwd",
-      "etc/shadow",
-      "etc/group"
-    ]
-
-    # Information about services is extracted by the ServicesInspector, so
-    # we ignore the links representing the same information when inspecting
-    # unmanaged files.
-    ignore_list += [
-      "etc/init.d/boot.d",
-      "etc/init.d/rc0.d",
-      "etc/init.d/rc1.d",
-      "etc/init.d/rc2.d",
-      "etc/init.d/rc3.d",
-      "etc/init.d/rc4.d",
-      "etc/init.d/rc5.d",
-      "etc/init.d/rc6.d",
-      "etc/init.d/rcS.d"
-    ]
-
     rpm_files, rpm_dirs = extract_rpm_database(system)
 
     # Btrfs subvolumes and local mounts need to be inspected separately because
@@ -273,9 +239,16 @@ class UnmanagedFilesInspector < Inspector
     unmanaged_links = {}
     remote_dirs = mount_points.remote
     special_dirs = mount_points.special
-    ignore_list.each do |ignore|
-      remote_dirs.delete_if { |e| e.start_with?(File.join("/", ignore, "/")) }
-    end
+
+    file_filter = filter.element_filter_for("/unmanaged_files/files/name") if filter
+    file_filter ||= ElementFilter.new("/unmanaged_files/files/name")
+    file_filter.add_matchers(description.store.base_path)
+
+    # Add a recursive pendant to each ignored element
+    file_filter.add_matchers(file_filter.matchers.map { |entry| File.join(entry, "/*") })
+
+    remote_dirs.delete_if { |e| file_filter.matches?(e) }
+
     excluded_files += remote_dirs
     excluded_files += special_dirs
 
@@ -315,10 +288,12 @@ class UnmanagedFilesInspector < Inspector
         local_filesystems.reject! { |mp| dirs.has_key?(mp) }
       end
       if find_dir == "/"
-        ignore_list.each do |d|
-          td_with_slash = d + "/"
-          dirs.reject! {|p| p == d || p.start_with?(td_with_slash) }
-          files.reject! {|p| p == d || p.start_with?(td_with_slash) }
+        dirs.reject! do |dir|
+          file_filter.matches?("/" + dir)
+        end
+
+        files.reject! do |dir|
+          file_filter.matches?("/" + dir)
         end
       end
       managed, unmanaged = dirs.keys.partition{ |d| rpm_dirs.has_key?(find_dir + d) }

data/plugins/inspect/users_inspector.rb

@@ -16,7 +16,7 @@
 # you may find current contact information at www.suse.com
 
 class UsersInspector < Inspector
-  def inspect(system, description, options = {})
+  def inspect(system, description, _filter, _options = {})
     passwd = system.read_file("/etc/passwd")
     shadow = system.read_file("/etc/shadow")
 

data/plugins/schema/v3/system-description-changed-managed-files.schema.json

@@ -51,7 +51,7 @@
         "changes": {
           "type": "array",
           "items": {
-            "enum": ["mode", "md5", "group", "user", "replaced"]
+            "enum": ["size", "mode", "md5", "device_number", "link_path", "user", "group", "time", "capabilities", "replaced", "other_rpm_changes"]
           },
           "minItems": 1
         },

data/plugins/schema/v3/system-description-config-files.schema.json

@@ -51,7 +51,7 @@
         "changes": {
           "type": "array",
           "items": {
-            "enum": ["mode", "md5", "group", "user", "replaced"]
+            "enum": ["size", "mode", "md5", "device_number", "link_path", "user", "group", "time", "capabilities", "replaced", "other_rpm_changes"]
           },
           "minItems": 1
         },

data/plugins/schema/v3/system-description-repositories.schema.json

@@ -4,7 +4,7 @@
   "type": "array",
   "items" : {
     "type" : "object",
-    "required": ["alias", "name", "url", "type", "enabled", "gpgcheck"],
+    "required": ["alias", "name", "url", "type", "enabled", "gpgcheck", "package_manager"],
     "properties": {
       "alias": {
         "type": "string",

data/schema/v3/system-description-global.schema.json

@@ -10,6 +10,18 @@
         "format_version": {
           "type": "integer",
           "minimum": 1
+        },
+        "filters": {
+          "type": "object",
+          "required": ["inspect"],
+          "properties": {
+            "inspect": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
         }
       },
       "additionalProperties": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: machinery-tool
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - SUSE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cheetah
@@ -197,6 +197,7 @@ files:
 - export_helpers/unmanaged_files_autoyast_excludes
 - export_helpers/unmanaged_files_kiwi_excludes
 - helpers/changed_managed_files.sh
+- helpers/default_filters.json
 - helpers/filter-packages-for-build.yaml
 - helpers/yum_repositories.py
 - html/assets/arrow_down.png
@@ -248,10 +249,12 @@ files:
 - lib/copy_task.rb
 - lib/current_user.rb
 - lib/deploy_task.rb
+- lib/element_filter.rb
 - lib/exceptions.rb
 - lib/export_task.rb
 - lib/exporter.rb
 - lib/file_validator.rb
+- lib/filter.rb
 - lib/generate_html_task.rb
 - lib/helper.rb
 - lib/hint.rb