machinery-tool 1.5.0 → 1.6.0

data/plugins/inspect/os_inspector.rb

@@ -18,8 +18,8 @@
 #  Inspect name, version, and other attributes of the operating system
 class OsInspector < Inspector
   # determines the architecture
-  def get_arch(system)
-    system.run_command("uname", "-m", :stdout => :capture).chomp
+  def get_arch
+    @system.run_command("uname", "-m", :stdout => :capture).chomp
   end
 
   def strip_arch_from_name(name)
@@ -31,51 +31,58 @@ class OsInspector < Inspector
   end
 
   # checks for additional version information like Beta or RC
-  def get_additional_version(system)
-    issue = system.read_file("/etc/issue")
+  def get_additional_version
+    issue = @system.read_file("/etc/issue")
     special_version = issue.scan(/Beta\d+|RC\d|GMC\d*/).first if issue
 
     special_version ? " #{special_version.gsub(/[0-9]{1,2}/," \\0")}" : ""
   end
 
-  def inspect(system, description, _filter, _options = {})
-    system.check_requirement("cat", "--version") if system.is_a?(RemoteSystem)
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, _options = {})
+    @system.check_requirement("cat", "--version") if @system.is_a?(RemoteSystem)
 
-    os = get_os(system)
+    os = get_os
     if os
-      os.architecture = get_arch(system)
-      os.version += get_additional_version(system)
-      summary = "Found operating system '#{os.name}' version '#{os.version}'."
+      os.architecture = get_arch
+      os.version += get_additional_version
     else
       raise Machinery::Errors::UnknownOs
     end
 
-    description.os = os
-    summary
+    @description.os = os
+  end
+
+  def summary
+    "Found operating system '#{@description.os.name}' version '#{@description.os.version}'."
   end
 
   private
 
-  def get_os(system)
+  def get_os
     # Use os-release file by default
-    os = get_os_from_os_release(system)
+    os = get_os_from_os_release
 
     # Fall back to SuSE-release file
     if !os
-      os = get_os_from_suse_release(system)
+      os = get_os_from_suse_release
     end
 
     # Fall back to redhat-release file
     if !os
-      os = get_os_from_redhat_release(system)
+      os = get_os_from_redhat_release
     end
 
     os
   end
 
   # check for freedesktop standard: /etc/os-release
-  def get_os_from_os_release(system)
-    os_release = system.read_file("/etc/os-release")
+  def get_os_from_os_release
+    os_release = @system.read_file("/etc/os-release")
     return if !os_release
 
     result = Hash.new
@@ -94,8 +101,8 @@ class OsInspector < Inspector
   end
 
   # checks for old suse standard: /etc/SuSE-release
-  def get_os_from_suse_release(system)
-    suse_release = system.read_file("/etc/SuSE-release")
+  def get_os_from_suse_release
+    suse_release = @system.read_file("/etc/SuSE-release")
     return if !suse_release
 
     result = Hash.new
@@ -120,8 +127,8 @@ class OsInspector < Inspector
   end
 
   # checks for redhat standard: /etc/redhat-release
-  def get_os_from_redhat_release(system)
-    redhat_release = system.read_file("/etc/redhat-release")
+  def get_os_from_redhat_release
+    redhat_release = @system.read_file("/etc/redhat-release")
     return if !redhat_release
 
     result = Hash.new

data/plugins/inspect/packages_inspector.rb

@@ -16,11 +16,16 @@
 # you may find current contact information at www.suse.com
 
 class PackagesInspector < Inspector
-  def inspect(system, description, _filter, _options = {})
-    system.check_requirement("rpm", "--version")
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, _options = {})
+    @system.check_requirement("rpm", "--version")
 
     packages = Array.new
-    rpm_data = system.run_command(
+    rpm_data = @system.run_command(
       "rpm","-qa","--qf",
       "%{NAME}|%{VERSION}|%{RELEASE}|%{ARCH}|%{VENDOR}|%{SIGMD5}$",
       :stdout=>:capture
@@ -40,7 +45,10 @@ class PackagesInspector < Inspector
       )
     end
 
-    description.packages = PackagesScope.new(packages.sort_by(&:name))
-    "Found #{packages.count} packages."
+    @description.packages = PackagesScope.new(packages.sort_by(&:name))
+  end
+
+  def summary
+    "Found #{@description.packages.size} packages."
   end
 end

data/plugins/inspect/patterns_inspector.rb

@@ -16,20 +16,35 @@
 # you may find current contact information at www.suse.com
 
 class PatternsInspector < Inspector
-  def inspect(system, description, _filter, _options = {})
-    if system.has_command?("zypper")
-      inspect_with_zypper(system, description)
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, _options = {})
+    if @system.has_command?("zypper")
+      @patterns_supported = true
+      inspect_with_zypper
+    else
+      @patterns_supported = false
+      @description.patterns = PatternsScope.new
+      "Patterns are not supported on this system."
+    end
+  end
+
+  def summary
+    if @patterns_supported
+      "Found #{@description.patterns.count} patterns."
     else
-      description.patterns = PatternsScope.new
       "Patterns are not supported on this system."
     end
   end
 
   private
 
-  def inspect_with_zypper(system, description)
+  def inspect_with_zypper
     begin
-      xml = system.run_command("zypper", "-xq", "--no-refresh", "patterns",
+      xml = @system.run_command("zypper", "-xq", "--no-refresh", "patterns",
         "-i", stdout: :capture)
     rescue Cheetah::ExecutionFailed => e
       if e.stdout.include?("locked")
@@ -44,8 +59,8 @@ class PatternsInspector < Inspector
     pattern_list = Nokogiri::XML(xml).xpath("/stream/pattern-list/pattern")
 
     if pattern_list.count == 0
-      description.patterns = PatternsScope.new
-      return "Found 0 patterns."
+      @description.patterns = PatternsScope.new
+      return
     end
 
     patterns = pattern_list.map do |pattern|
@@ -56,7 +71,6 @@ class PatternsInspector < Inspector
       )
     end.uniq.sort_by(&:name)
 
-    description.patterns = PatternsScope.new(patterns)
-    "Found #{patterns.count} patterns."
+    @description.patterns = PatternsScope.new(patterns)
   end
 end

data/plugins/inspect/repositories_inspector.rb

@@ -16,23 +16,30 @@
 # you may find current contact information at www.suse.com
 
 class RepositoriesInspector < Inspector
-  def inspect(system, description, _filter, _options = {})
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, _options = {})
     if system.has_command?("zypper")
-      description.repositories, summary = inspect_zypp_repositories(system)
+      @description.repositories = inspect_zypp_repositories
     elsif system.has_command?("yum")
-      description.repositories, summary = inspect_yum_repositories(system)
+      @description.repositories = inspect_yum_repositories
     else
       raise Machinery::Errors::MissingRequirement.new(
         "Need either the binary 'zypper' or 'yum' to be available on the inspected system."
       )
     end
+  end
 
-    summary
+  def summary
+    "Found #{@description.repositories.size} repositories."
   end
 
   private
 
-  def inspect_zypp_repositories(system)
+  def inspect_zypp_repositories
     begin
       xml = system.run_command(
         "zypper", "--non-interactive", "--xmlout", "repos", "--details",
@@ -52,18 +59,16 @@ class RepositoriesInspector < Inspector
 
     if details.empty?
       result = []
-      summary = "Found 0 repositories."
     else
       priorities = parse_priorities_from_details(details)
-      credentials = get_credentials_from_system(system)
+      credentials = get_credentials_from_system
       result = parse_repositories_from_xml(xml, priorities, credentials)
-      summary = "Found #{result.count} repositories."
     end
 
-    [RepositoriesScope.new(result), summary]
+    RepositoriesScope.new(result)
   end
 
-  def inspect_yum_repositories(system)
+  def inspect_yum_repositories
     script = File.read(File.join(Machinery::ROOT, "helpers", "yum_repositories.py"))
     begin
       repositories = JSON.parse(system.run_command(
@@ -80,8 +85,7 @@ class RepositoriesInspector < Inspector
       raise Machinery::Errors::InspectionFailed.new("Extraction of YUM repositories failed.")
     end
 
-    summary = "Found #{repositories.count} repositories"
-    [RepositoriesScope.new(repositories), summary]
+    RepositoriesScope.new(repositories)
   end
 
   def parse_priorities_from_details(details)
@@ -98,16 +102,16 @@ class RepositoriesInspector < Inspector
     prio
   end
 
-  def get_credentials_from_system(system)
+  def get_credentials_from_system
     credentials = {}
     credential_dir = "/etc/zypp/credentials.d/"
-    credential_files = system.run_command(
+    credential_files = @system.run_command(
       "bash", "-c",
       "test -d '#{credential_dir}' && ls -1 '#{credential_dir}' || echo ''",
       stdout: :capture
     )
     credential_files.split("\n").each do |f|
-      content = system.run_command(
+      content = @system.run_command(
         "cat", "/etc/zypp/credentials.d/#{f}", stdout: :capture
       )
       content.match(/username=(\w*)\npassword=(\w*)/)

data/plugins/inspect/services_inspector.rb

@@ -16,27 +16,35 @@
 # you may find current contact information at www.suse.com
 
 class ServicesInspector < Inspector
-  def inspect(system, description, _filter, _options = {})
-    if system.has_command?("systemctl")
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, _options = {})
+    if @system.has_command?("systemctl")
       result = ServicesScope.new(
         init_system: "systemd",
-        services: inspect_systemd_services(system)
+        services: inspect_systemd_services
       )
     else
       result = ServicesScope.new(
         init_system: "sysvinit",
-        services: inspect_sysvinit_services(system)
+        services: inspect_sysvinit_services
       )
     end
 
-    description.services = result
-    @summary
+    @description.services = result
+  end
+
+  def summary
+    "Found #{@description.services.services.length} services."
   end
 
   private
 
-  def inspect_systemd_services(system)
-    output = system.run_command(
+  def inspect_systemd_services
+    output = @system.run_command(
       "systemctl",
       "list-unit-files",
       "--type=service,socket",
@@ -53,30 +61,28 @@ class ServicesInspector < Inspector
       Service.new(name: name, state: state)
     end
 
-    @summary = "Found #{services.size} services."
     ServiceList.new(services.sort_by(&:name))
   end
 
-  def inspect_sysvinit_services(system)
+  def inspect_sysvinit_services
     # Red Hat's chkconfig behaves differently than SUSE's: It takes different
     # command line arguments and has a different output format. We determine
     # if it's Red Hat by calling 'chkconfig --version'. On SUSE it exits with
     # an error, on Red Hat it doesn't.
     #
     begin
-      system.run_command("chkconfig", "--version")
-      services = parse_redhat_chkconfig(system)
+      @system.run_command("chkconfig", "--version")
+      services = parse_redhat_chkconfig
     rescue
-      services = parse_suse_chkconfig(system)
+      services = parse_suse_chkconfig
     end
 
-    @summary = "Found #{services.size} services."
     ServiceList.new(services.sort_by(&:name))
   end
 
-  def parse_suse_chkconfig(system)
-    system.check_requirement("chkconfig", "--help")
-    output = system.run_command(
+  def parse_suse_chkconfig
+    @system.check_requirement("chkconfig", "--help")
+    output = @system.run_command(
       "chkconfig",
       "--allservices",
       :stdout => :capture
@@ -88,15 +94,15 @@ class ServicesInspector < Inspector
     end
   end
 
-  def parse_redhat_chkconfig(system)
-    system.check_requirement("chkconfig", "--version")
-    system.check_requirement("runlevel")
-    _, runlevel = system.run_command(
+  def parse_redhat_chkconfig
+    @system.check_requirement("chkconfig", "--version")
+    @system.check_requirement("runlevel")
+    _, runlevel = @system.run_command(
       "runlevel",
       stdout: :capture
     ).split(" ")
 
-    output = system.run_command(
+    output = @system.run_command(
       "chkconfig", "--list",
       stdout: :capture
     )

data/plugins/inspect/unmanaged_files_inspector.rb

@@ -17,18 +17,18 @@
 
 class UnmanagedFilesInspector < Inspector
   # checks if all required binaries are present
-  def check_requirements(system, check_tar)
-    system.check_requirement("rpm", "--version")
-    system.check_requirement("sed", "--version")
-    system.check_requirement("cat", "--version")
-    system.check_requirement("find", "--version")
-    system.check_requirement("tar", "--version") if check_tar
-    system.check_requirement("gzip", "--version") if check_tar
+  def check_requirements(check_tar)
+    @system.check_requirement("rpm", "--version")
+    @system.check_requirement("sed", "--version")
+    @system.check_requirement("cat", "--version")
+    @system.check_requirement("find", "--version")
+    @system.check_requirement("tar", "--version") if check_tar
+    @system.check_requirement("gzip", "--version") if check_tar
   end
 
   # extract pathes from rpm database into ruby hashes
-  def extract_rpm_database(system)
-    out = system.run_command(
+  def extract_rpm_database
+    out = @system.run_command(
       ["rpm", "-qlav"],
       ["sed", "s/^\\(.\\)[^/]* /\\1 /"],
       :stdout => :capture
@@ -79,14 +79,14 @@ class UnmanagedFilesInspector < Inspector
     p "should not happen non-abs dirs:#{list}" unless list.empty?
   end
 
-  def extract_unmanaged_files(system, description, files, trees, excluded, store_name)
-    file_store = description.scope_file_store(store_name)
+  def extract_unmanaged_files(files, trees, excluded, store_name)
+    file_store = @description.scope_file_store(store_name)
     file_store.remove
     file_store.create
     store_path = file_store.path
 
     archive_path = File.join(store_path, "files.tgz")
-    system.create_archive(files.join("\0"), archive_path, excluded)
+    @system.create_archive(files.join("\0"), archive_path, excluded)
 
     trees.each do |tree|
       tree_name = File.basename(tree)
@@ -95,7 +95,7 @@ class UnmanagedFilesInspector < Inspector
 
       file_store.create_sub_directory(sub_dir)
       archive_path = File.join(store_path, sub_dir, "#{tree_name}.tgz")
-      system.create_archive(tree, archive_path, excluded)
+      @system.create_archive(tree, archive_path, excluded)
     end
   end
 
@@ -136,7 +136,7 @@ class UnmanagedFilesInspector < Inspector
   end
 
   # find paths below dir until a certain depth is reached
-  def get_find_data( system, dir, depth )
+  def get_find_data(dir, depth )
     dep = depth - 1
     files = {}
     dirs = {}
@@ -157,7 +157,7 @@ class UnmanagedFilesInspector < Inspector
     # string which can be safely used.
     out = ""
     begin
-      out = system.run_command(
+      out = @system.run_command(
         "/bin/bash",
         stdin:           cmd,
         stdout:          :capture,
@@ -218,20 +218,25 @@ class UnmanagedFilesInspector < Inspector
     3
   end
 
-  def inspect(system, description, filter, options = {})
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(filter, options = {})
     do_extract = options && options[:extract_unmanaged_files]
-    check_requirements(system, do_extract)
+    check_requirements(do_extract)
 
-    file_store_tmp = description.scope_file_store("unmanaged_files.tmp")
-    file_store_final = description.scope_file_store("unmanaged_files")
+    file_store_tmp = @description.scope_file_store("unmanaged_files.tmp")
+    file_store_final = @description.scope_file_store("unmanaged_files")
 
-    mount_points = MountPoints.new(system)
+    mount_points = MountPoints.new(@system)
 
-    rpm_files, rpm_dirs = extract_rpm_database(system)
+    rpm_files, rpm_dirs = extract_rpm_database
 
     # Btrfs subvolumes and local mounts need to be inspected separately because
     # they are not part of the `get_find_data` return data
-    local_filesystems = mount_points.local + btrfs_subvolumes(system)
+    local_filesystems = mount_points.local + btrfs_subvolumes
 
     unmanaged_files = []
     unmanaged_trees = []
@@ -242,10 +247,12 @@ class UnmanagedFilesInspector < Inspector
 
     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)
+    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, "/*") })
+    file_filter.matchers.each do |operator, matchers|
+      file_filter.add_matchers(operator, matchers.map { |entry| File.join(entry, "/*") })
+    end
 
     remote_dirs.delete_if { |e| file_filter.matches?(e) }
 
@@ -276,7 +283,7 @@ class UnmanagedFilesInspector < Inspector
 
       # determine files and directories below find_dir until a certain depth
       depth = local_filesystems.include?(find_dir) ? start : max
-      files, dirs, excluded = get_find_data( system, find_dir, depth )
+      files, dirs, excluded = get_find_data(find_dir, depth )
       excluded_files += excluded
       find_count += 1
       find_dir += "/" if find_dir.size > 1
@@ -341,8 +348,7 @@ class UnmanagedFilesInspector < Inspector
     Machinery.logger.debug "inspect unmanaged files find calls:#{find_count} files:#{unmanaged_files.size} trees:#{unmanaged_trees.size}"
     begin
       if do_extract
-        extract_unmanaged_files(system, description, unmanaged_files,
-          unmanaged_trees, excluded_files, file_store_tmp.store_name)
+        extract_unmanaged_files(unmanaged_files, unmanaged_trees, excluded_files, file_store_tmp.store_name)
       else
         file_store_final.remove
       end
@@ -360,7 +366,7 @@ class UnmanagedFilesInspector < Inspector
       # Handle SIGHUP(1), SIGINT(2) and SIGTERM(15) gracefully
       if [1, 2, 15].include?(e.signo)
         Machinery::Ui.warn "Interrupted by user. The partly extracted unmanaged-files are available" \
-          " under '#{description.file_store(tmp_file_store)}'"
+          " under '#{@description.file_store(tmp_file_store)}'"
       end
       raise
     end
@@ -368,12 +374,15 @@ class UnmanagedFilesInspector < Inspector
       osl << UnmanagedFile.new( name: remote_dir + "/", type: "remote_dir")
     end
 
-    summary = "#{do_extract ? "Extracted" : "Found"} #{osl.size} unmanaged files and trees."
-    description["unmanaged_files"] = UnmanagedFilesScope.new(
+    @description["unmanaged_files"] = UnmanagedFilesScope.new(
       extracted: !!do_extract,
       files: UnmanagedFileList.new(osl.sort_by(&:name))
     )
-    summary
+  end
+
+  def summary
+    "#{@description.unmanaged_files.extracted ? "Extracted" : "Found"} " +
+      "#{@description.unmanaged_files.files.count} unmanaged files and trees."
   end
 
   private
@@ -390,8 +399,8 @@ class UnmanagedFilesInspector < Inspector
     s.dup.force_encoding("UTF-8").encode("UTF-16", invalid: :replace).encode("UTF-8")
   end
 
-  def btrfs_subvolumes(system)
-    system.run_command(
+  def btrfs_subvolumes
+    @system.run_command(
       ["btrfs", "subvolume", "list", "/"],
       ["awk", "{print $NF}"],
       stdout: :capture