machinery-tool 1.0.2

data/plugins/docs/changed_managed_files.md

@@ -0,0 +1,2 @@
+  Contains the names and contents of all non-configuration files which have
+  been changed compared to the files in the package.

data/plugins/docs/config_files.md

@@ -0,0 +1,5 @@
+  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.

data/plugins/docs/groups.md

@@ -0,0 +1,2 @@
+  Contains information about the system groups such as group attributes and the
+  list of group members.

data/plugins/docs/os.md

@@ -0,0 +1,2 @@
+  Contains information about the operating system, name, version, and
+  architecture of the inspected system.

data/plugins/docs/packages.md

@@ -0,0 +1,2 @@
+  Contains information on all installed RPM packages installed on the
+  inspected system.

data/plugins/docs/patterns.md

@@ -0,0 +1,5 @@
+  Contains all patterns installed on the inspected system. A pattern is a
+  collection of software packages.
+  The meaning of software patterns depends on the package manager of the
+  distribution. Therefore, the pattern scope on SUSE based systems uses the
+  `zypper` command to obtain the information about installed pattern names.

data/plugins/docs/repositories.md

@@ -0,0 +1,24 @@
+  Contains all information about software repositories configured on the
+  inspected system. The information about repositories depends on the package
+  manager of the distribution. Thus on SUSE-based systems the `zypper` command
+  is used. Machinery collects the following information from each configured repository:
+
+  - The alias name of the repository.
+
+  - The repository type, rpm-md and YaST types that are used on SUSE systems.
+
+  - The path to the repository. This could be a local path, a remote location,
+    a device, or a file.
+
+  - A boolean flag that indicates if this repository is in use or not.
+
+  - A boolean flag that indicates if this repository should update the locally
+    stored metadata files with metadata files from the origin automatically or
+    not.
+
+  - A boolean flag that indicates if packages which would be installed from
+    this repository should be checked by their gpg key or not.
+
+  - A numeric value for a priority. The priority of a repository is compared
+    to the priorities of all other activated repositories. Values can
+    range from 1 (highest) to 99 (lowest, default).

data/plugins/docs/services.md

@@ -0,0 +1,6 @@
+  Services are applications running in the background doing continuous work
+  or waiting for requests to do work.
+  The scope determines which services are configured to be started in which
+  runlevel. It uses the `chkconfig` command to obtain that information.
+  The xinetd services that are also displayed by `chkconfig` are switched
+  on/off by editing config files and are ignored in this context.

data/plugins/docs/unmanaged_files.md

@@ -0,0 +1,13 @@
+  Contains the names and contents of all files which are not part of any RPM
+  package. The list of unmanaged files contains only plain files and
+  directories. Special files like device nodes, named pipes and Unix domain
+  sockets are ignored. The directories `/tmp`,  `/var/tmp`, `/sys`, `/dev`,
+  `/.snapshots/`, and `/var/run` are ignored, too. If a directory is in this
+  list, no file or directory below it belongs to a RPM package.
+
+  Meta data information of unmanaged files is only available if the files were
+  extracted during inspection.
+
+  Using the `--extract-unmanaged-files` option, the files are transferred from
+  the system and stored in the system description. Depending on the content of
+  the inspected system, the amount of data stored may be huge.

data/plugins/docs/users.md

@@ -0,0 +1,3 @@
+  Contains information about the system users including user and group ids,
+  login information, such as password hashes and - if available - additional
+  password properties.

data/plugins/inspect/changed_managed_files_inspector.rb

@@ -0,0 +1,109 @@
+# Copyright (c) 2013-2014 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 ChangedManagedFilesInspector < Inspector
+  include ChangedRpmFilesHelper
+
+  def inspect(system, description, options = {})
+    @system = system
+    store_name = "changed_managed_files"
+
+    result = changed_files
+
+    description.remove_file_store(store_name)
+    if options[:extract_changed_managed_files]
+      description.initialize_file_store(store_name)
+      existing_files = changed_files.reject { |f| f.changes.nil? || f.changes.include?("deleted") }
+      system.retrieve_files(existing_files.map(&:name), description.file_store(store_name))
+    end
+
+    summary = "#{options[:extract_changed_managed_files] ? "Extracted" : "Found"} #{result.count} changed files."
+
+    description["changed_managed_files"] = ChangedManagedFilesScope.new(
+      extracted: !!options[:extract_changed_managed_files],
+      files: ChangedManagedFileList.new(result.sort_by(&:name))
+    )
+    summary
+  end
+
+  private
+
+  def amend_file_attributes(changed_files)
+    existing_files = changed_files.reject { |f| f.changes.nil? || f.changes.include?("deleted") }
+    file_attributes = get_path_data(@system, existing_files.map(&:name))
+    changed_files.map do |changed_file|
+      if file_attributes[changed_file.name]
+        ChangedManagedFile.new(changed_file.attributes.merge(file_attributes[changed_file.name]))
+      else
+        changed_file
+      end
+    end
+  end
+
+  def changed_files
+    raw_list = @system.run_script("changed_managed_files.sh", stdout: :capture)
+
+    # The raw list lists each package followed by the changed files, e.g.
+    #
+    #   libpulse0-4.0.git.270.g9490a:
+    #   S.5......  c /etc/pulse/client.conf
+    #   ntp-4.2.6p5:
+    #   S.5......  c /etc/ntp.conf
+    #
+    # We map this to an array of files like this:
+    #
+    # [
+    #   {
+    #     name: "/etc/pulse/client.conf",
+    #     package_name: "libpulse0",
+    #     package_version: "4.0.git.270.g9490a"
+    #   },
+    #   ...
+    # ]
+    changed_files = raw_list.split("\n").slice_before(/(.*):\z/).flat_map do |package, *changed_files|
+      package_name, package_version = package.scan(/(.*)-([^-]*):/).first
+      changed_files.map do |changed_file|
+        if changed_file =~ /\A(\/\S+) (.*)/
+          ChangedManagedFile.new(
+            name:              $1,
+            package_name:      package_name,
+            package_version:   package_version,
+            status:            "error",
+            error_message:     $2
+          )
+        else
+          file, changes, flag = parse_rpm_changes_line(changed_file)
+
+          # Config files (flagged as 'c') are handled by the ConfigFilesInspector
+          next if flag == "c"
+
+          ChangedManagedFile.new(
+              name:              file,
+              package_name:      package_name,
+              package_version:   package_version,
+              status:            "changed",
+              changes:           changes
+          )
+        end
+        # Since errors are also recognized for config-files we have
+        # to filter them
+      end.compact.select { |item| item.changes }
+    end
+    amend_file_attributes(changed_files)
+  end
+
+end

data/plugins/inspect/config_files_inspector.rb

@@ -0,0 +1,117 @@
+# Copyright (c) 2013-2014 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 ConfigFilesInspector < Inspector
+  include ChangedRpmFilesHelper
+
+  # checks if all required binaries are present
+  def check_requirements(system, check_rsync)
+    system.check_requirement("rpm", "--version")
+    system.check_requirement("stat", "--version")
+    system.check_requirement("rsync", "--version") if check_rsync
+  end
+
+  # returns list of packages containing configfiles
+  def packages_with_config_files(system)
+    # first determine packages that have config files at all
+    # rpm command provides lines with package names and subsequent
+    # lines with pathes of config files for that package
+    # e.g.
+    # apache2
+    # /etc/apache2/charset.conv
+    # /etc/apache2/default-server.conf
+    #
+    output = system.run_command(
+      "rpm", "-qa", "--configfiles", "--queryformat",
+      "%{NAME}-%{VERSION}\n",
+      :stdout => :capture
+    )
+    # use leading slash to decide between lines containing package names
+    # and lines containing config files
+    chunks = output.split("\n").slice_before { |l| !l.start_with?("/") }
+    chunks.reject { |pkg, *cfiles| cfiles.empty? }.map(&:first)
+  end
+
+  # returns a hash with entries for changed config files
+  def config_file_changes(system, pkg)
+    begin
+      out = system.run_command(
+        "rpm", "-V",
+        "--nodeps", "--nodigest", "--nosignature", "--nomtime", "--nolinkto",
+        pkg,
+        :stdout => :capture
+      )
+    # rpm returns 1 as exit code when modified config files are detected
+    # currently cheetah cannot be told to ignore this and throws ExecutionFailed
+    rescue Cheetah::ExecutionFailed => e
+      out = e.stdout
+    end
+
+    parts = pkg.split("-")
+    package_name    = parts[0..-2].join("-")
+    package_version = parts.last
+
+    paths_and_changes = out.lines.map { |line| parse_rpm_changes_line(line) }
+    paths_and_changes.reject! do |path, changes, type|
+      # only consider config files and only those with changes
+      type != "c" || changes.empty?
+    end
+
+    paths_and_changes.map do |path, changes|
+      ConfigFile.new(
+        name:            path,
+        package_name:    package_name,
+        package_version: package_version,
+        status:          "changed",
+        changes:         changes
+      )
+    end
+  end
+
+  def inspect(system, description, options = {})
+    do_extract = options[:extract_changed_config_files]
+    check_requirements(system, do_extract)
+
+    result = packages_with_config_files(system).flat_map do |package|
+      config_file_changes(system, package)
+    end
+
+    paths = result.reject { |f| f.changes == ["deleted"] }.map(&:name)
+    path_data = get_path_data(system, paths)
+    key_list = [ :user, :group, :mode ]
+    result.each do |pkg|
+      pname = pkg.name
+      if path_data.has_key?(pname)
+        key_list.each { |k| pkg[k] = path_data[pname][k] }
+      end
+    end
+
+    description.remove_file_store("config_files")
+    if do_extract
+      description.initialize_file_store("config_files")
+      system.retrieve_files(paths, description.file_store("config_files"))
+    end
+
+    summary = "#{do_extract ? "Extracted" : "Found"} #{result.count} changed configuration files."
+
+    description["config_files"] = ConfigFilesScope.new(
+      extracted: !!do_extract,
+      files: ConfigFileList.new(result.sort_by(&:name))
+    )
+    summary
+  end
+end

data/plugins/inspect/groups_inspector.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2013-2014 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 GroupsInspector < Inspector
+  def inspect(system, description, options = {})
+    group_content = system.read_file("/etc/group")
+
+    groups = group_content ? parse_groups(group_content) : []
+
+    description.groups = GroupsScope.new(groups.sort_by(&:name))
+    "Found #{groups.size} groups."
+  end
+
+  private
+
+  def parse_groups(content)
+    content.lines.map do |line|
+      name, password, gid, users = line.split(":").map(&:chomp)
+
+      gid = Machinery::is_int?(gid) ? gid.to_i : nil
+
+      attrs = {
+        name: name,
+        password: password,
+        gid: gid,
+        users: users.split(",")
+      }
+
+      Group.new(attrs)
+    end
+  end
+end

data/plugins/inspect/os_inspector.rb

@@ -0,0 +1,116 @@
+# Copyright (c) 2013-2014 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
+
+#  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
+  end
+
+  def strip_arch_from_name(name)
+    # architecture information in the name might be misleading
+    # information with regards to the real architecture name.
+    # in addition the architecture information is not consistently
+    # added for all distributions. Thus we strip this part
+    name.gsub(/\((i.86|x86_64|s390|ia64|ppc|arm).*\)/, "").strip
+  end
+
+  # checks for additional version information like Beta or RC
+  def get_additional_version(system)
+    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, _options = {})
+    system.check_requirement("cat", "--version") if system.is_a?(RemoteSystem)
+
+    os = get_os(system)
+    if os
+      os.architecture = get_arch(system)
+      os.version += get_additional_version(system)
+      summary = "Found operating system '#{os.name}' version '#{os.version}'."
+    else
+      os = OsScope.new(name: nil, version: nil, architecture: nil)
+      summary = "Could not determine the operating system."
+    end
+
+    description.os = os
+    summary
+  end
+
+  private
+
+  def get_os(system)
+    # Use os-release file by default
+    os = get_os_from_os_release(system)
+
+    # Fall back to SuSE-release file
+    if !os
+      os = get_os_from_suse_release(system)
+    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")
+    return if !os_release
+
+    result = Hash.new
+    key_value_pairs = Hash[os_release.split("\n").map { |l| l.split("=") }]
+    key_value_pairs.each_pair do |k,v|
+      result[k.downcase] = v.strip.gsub(/^"|"$/,"")
+    end
+    if result["pretty_name"]
+      result["pretty_name"] = strip_arch_from_name(result["pretty_name"])
+    end
+    # return pretty_name as name as it contains the actual full length
+    # name instead of an abbreviation
+    OsScope.new(
+      name:         result["pretty_name"],
+      version:      result["version"]
+    )
+  end
+
+  # checks for old suse standard: /etc/SuSE-release
+  def get_os_from_suse_release(system)
+    suse_release = system.read_file("/etc/SuSE-release")
+    return if !suse_release
+
+    result = Hash.new
+    # name is always the first line in /etc/SuSE-release
+    result["name"] = strip_arch_from_name(suse_release.split("\n").first)
+
+    patch = nil
+    suse_release.each_line do |l|
+      if l.start_with?("VERSION")
+        result["version"] = l.split("=").last.strip
+      end
+      if l.start_with?("PATCHLEVEL")
+        patch = l.split("=").last.strip
+      end
+    end
+    if result["version"] && !patch.nil?
+      result["version"] = "#{result["version"]} SP#{patch}"
+    end
+    OsScope.new(result)
+  end
+end