machinery-tool 1.11.2 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5d39b671ef2bf800e50ffe8cb48003f1ad6cf50
-  data.tar.gz: a5f739eb08389646bd1d6e8d26ee29d6f21b1595
+  metadata.gz: 59b0cae046e00683fea873260999de11ce3ad562
+  data.tar.gz: 295b43b9d42e832be6f78363cee7f8c91c25a47d
 SHA512:
-  metadata.gz: 1992072db448872c81e4179fa7f2a7518179ecf15f12c433b9cd0f6c6a1811bdb4e7f68b4776ea69ac649fcdf8b5c813af213aa7e786f40d0cb02638f2462d1e
-  data.tar.gz: 651d2cfa1150a857ca265db080d113d61f845c8ed2cfdaeb626b81b058b5b52193239b751c2385cdf2978f86e7ff42510265f5efdb1dbc6f9f57f8031797a5c0
+  metadata.gz: be116d55112cf6d945db98ce6ce4723644df3753904d5811b9c7abe05f0dfc4b4199bb574025d9b3833b4fc642df6132103937b0a4aeb48fe551627a024d0253
+  data.tar.gz: 76221ef972ded4ce554d3b4e7e085477b7071057ef26847a6d40cf20ef94142aced57b5109cad75274135b8a0fe7573c3d815eab092d91066fcfe95131d217a8

data/NEWS

@@ -1,6 +1,13 @@
 # Machinery Release Notes
 
 
+## Version 1.12.0 - Fri Sep 04 16:51:10 CEST 2015 - cschum@suse.de
+
+* The x86_64 machinery-helper is now shipped with machinery. It speeds up
+  inspection of unmanaged-files when the files are not extracted
+* Fix for unmanaged-file inspector to not mark directories as unmanaged if they
+  only consist managed sub directories
+
 ## Version 1.11.2 - Thu Jul 30 14:42:44 CEST 2015 - thardeck@suse.de
 
 * Fix issue with showing HTML view when not all file scopes are inspected

data/export_helpers/containerize_readme.md

@@ -0,0 +1,44 @@
+# README for Docker Containers created by Machinery
+
+This directory contains a (Docker Compose) Container configuration that was exported by
+Machinery.
+
+The user is expected to be familiar with using Docker.
+Details on Docker can be found at https://www.docker.com/.
+
+## Requirements
+
+Docker and docker-compose are required. Packages are available in the Virtualization repository.
+
+Install on openSUSE 13.2:
+
+    sudo zypper ar -f http://download.opensuse.org/repositories/Virtualization:/containers/openSUSE_13.2/ virt
+    sudo zypper refresh
+    sudo zypper in docker docker-compose
+    sudo usermod -aG docker $(whoami)
+    sudo systemctl start docker
+
+Log out and in again to refresh the user's group.
+
+## Managing Docker containers
+
+Run container:
+
+    docker-compose up
+
+Run container as daemon in background:
+
+    docker-compose up -d
+
+Shows list of all running containers:
+
+    docker-compose ps
+
+Stop the container:
+
+    docker-compose kill
+
+Remove the container image:
+
+    docker-compose rm -vf
+

data/helpers/default_filters.json

@@ -7,6 +7,7 @@
     "/unmanaged_files/files/name=/var/tmp",
     "/unmanaged_files/files/name=/lost+found",
     "/unmanaged_files/files/name=/var/run",
+    "/unmanaged_files/files/name=/var/lock",
     "/unmanaged_files/files/name=/var/lib/rpm",
     "/unmanaged_files/files/name=/.snapshots",
     "/unmanaged_files/files/name=/proc",

data/html/index.html.haml

@@ -433,25 +433,25 @@
             %span.scope-navigation
               Scopes:
               %a{:href => "#os", :title => "Operating System"}
-                %img{:src => "assets/logo-os-small.png"}/
+                %img{:src => "assets/logo-os-small.png", :title=>"Operating System", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('os')}"}/
               %a{:href => "#packages", :title => "Packages"}
-                %img{:src => "assets/logo-packages-small.png"}/
+                %img{:src => "assets/logo-packages-small.png", :title => "Packages", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('packages')}"}/
               %a{:href => "#patterns", :title => "Patterns"}
-                %img{:src => "assets/logo-patterns-small.png"}/
+                %img{:src => "assets/logo-patterns-small.png", :title => "Patterns", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('patterns')}"}/
               %a{:href => "#repositories", :title => "Repositories"}
-                %img{:src => "assets/logo-repositories-small.png"}/
+                %img{:src => "assets/logo-repositories-small.png", :title => "Repositories", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('repositories')}"}/
               %a{:href => "#users", :title => "Users"}
-                %img{:src => "assets/logo-users-small.png"}/
+                %img{:src => "assets/logo-users-small.png", :title => "Users", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('users')}"}/
               %a{:href => "#groups", :title => "Groups"}
-                %img{:src => "assets/logo-groups-small.png"}/
+                %img{:src => "assets/logo-groups-small.png", :title => "Groups", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('groups')}"}/
               %a{:href => "#services", :title => "Services"}
-                %img{:src => "assets/logo-services-small.png"}/
+                %img{:src => "assets/logo-services-small.png", :title => "Services", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('services')}"}/
               %a{:href => "#config_files", :title => "Config Files"}
-                %img{:src => "assets/logo-config-files-small.png"}/
+                %img{:src => "assets/logo-config-files-small.png", :title => "Config Files", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('config_files')}"}/
               %a{:href => "#changed_managed_files", :title => "Changed Managed Files"}
-                %img{:src => "assets/logo-changed-managed-files-small.png"}/
+                %img{:src => "assets/logo-changed-managed-files-small.png", :title => "Changed Managed Files", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('changed_managed_files')}"}/
               %a{:href => "#unmanaged_files", :title => "Unmanaged Files"}
-                %img{:src => "assets/logo-unmanaged-files-small.png"}/
+                %img{:src => "assets/logo-unmanaged-files-small.png", :title => "Unmanaged Files", :class=>"over", :"data-toggle"=>"popover", :"data-content"=>"#{scope_help('unmanaged_files')}"}/
 
 
       #content_container{"ng-controller" => "showController"}

data/lib/build_task.rb

@@ -34,7 +34,7 @@ class BuildTask
         output_path, img_extension)
 
       begin
-        LoggedCheetah.run(
+        LoggedCheetah.run_with_c(
           "sudo",
           tmp_script.path,
           stdout: $stdout,

data/lib/cli.rb

@@ -87,7 +87,8 @@ class Cli
       Machinery::Ui.error("Option --" + e.message)
       exit 1
     when GLI::UnknownCommandArgument, GLI::UnknownGlobalArgument,
-        GLI::UnknownCommand, GLI::BadCommandLine, OptionParser::MissingArgument
+      GLI::UnknownCommand, GLI::BadCommandLine,
+      OptionParser::MissingArgument, OptionParser::AmbiguousOption
       Machinery::Ui.error e.to_s + "\n\n"
       command = ARGV & @commands.keys.map(&:to_s)
       Machinery::Ui.error "Run '#{$0} #{command.first} --help' for more information."
@@ -105,8 +106,16 @@ class Cli
       Machinery::Ui.error("Error: " + e.message)
       exit 1
     else
-      Machinery::Ui.error "Machinery experienced an unexpected error. Please file a " \
-        "bug report at: https://github.com/SUSE/machinery/issues/new\n"
+      if LocalSystem.os.canonical_name.include? ("SUSE Linux Enterprise")
+        Machinery::Ui.error "Machinery experienced an unexpected error.\n" \
+        "If this impacts your business please file a service request at " \
+        "https://www.suse.com/mysupport\n" \
+        "so that we can assist you on this issue. An active support contract is required.\n"
+      else
+        Machinery::Ui.error "Machinery experienced an unexpected error. Please file a " \
+          "bug report at: https://github.com/SUSE/machinery/issues/new\n"
+      end
+
       if e.is_a?(Cheetah::ExecutionFailed)
         result = ""
         result << "#{e.message}\n"
@@ -728,6 +737,10 @@ class Cli
 
     The value of a key is shown when no value argument is passed.
     If neither the key argument nor the value argument are specified a list of all keys and their values are shown.
+
+    ALTERNATIVE SYNOPSIS:
+
+    machinery [global options] config [KEY][=VALUE]
   LONGDESC
   arg "KEY", :optional
   arg "VALUE", :optional

data/lib/constants.rb

@@ -21,4 +21,5 @@ module Machinery
   DEFAULT_LOG_FILE = File.join(DEFAULT_CONFIG_DIR, "machinery.log")
   DEFAULT_CONFIG_FILE = File.join(DEFAULT_CONFIG_DIR, "machinery.config")
   IMAGE_META_DATA_FILE = "machinery.meta"
+  REMOTE_HELPERS_PATH = "/root"
 end

data/lib/containerize_task.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2013-2015 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 ContainerizeTask
+  def containerize(description, dir)
+    output_path = File.join(dir, description.name)
+
+    mapper = WorkloadMapper.new
+    workloads = mapper.identify_workloads(description)
+
+    if workloads.empty?
+      Machinery::Ui.puts "No workloads detected."
+    else
+      FileUtils.mkdir_p(output_path)
+      mapper.save(workloads, output_path)
+      mapper.extract(description, workloads, output_path)
+      write_readme_file(output_path)
+
+      workloads.each do |workload|
+        Machinery::Ui.puts "Detected workload '#{workload[0]}'."
+      end
+      Machinery::Ui.puts "\nWrote to #{output_path}."
+    end
+  end
+
+  def write_readme_file(dir)
+    FileUtils.cp(
+      File.join(Machinery::ROOT, "export_helpers", "containerize_readme.md"),
+      File.join(dir, "README.md")
+    )
+  end
+end

data/lib/exceptions.rb

@@ -135,5 +135,9 @@ module Machinery
     class UnknownConfig < MachineryError; end
     class UnsupportedArchitecture < MachineryError; end
     class ServeFailed < MachineryError; end
+    class RemoveFileFailed < MachineryError; end
+    class InjectFileFailed < MachineryError; end
+    class UnexpectedInputData < MachineryError; end
+    class ComposeServiceLink < MachineryError; end
   end
 end

data/lib/helper.rb

@@ -51,6 +51,10 @@ def with_c_locale(&block)
   with_env "LC_ALL" => "C", &block
 end
 
+def with_utf8_locale(&block)
+  with_env "LC_ALL" => "en_US.UTF-8", &block
+end
+
 def with_env(env)
   # ENV isn't a Hash, but a weird Hash-like object. Calling #to_hash on it
   # will copy its items into a newly created Hash instance. This approach

data/lib/local_system.rb

@@ -87,7 +87,9 @@ EOF
         message = "Building '#{system_description.os.display_name}' is " \
           "not supported on this distribution.\n" \
           "Check the 'BUILD SUPPORT MATRIX' by running `#{$0} build --help` for " \
-          "further information which build targets are supported."
+          "further information which build targets are supported.\n" \
+          "You are only able to build the architecture you are running " \
+          "(#{LocalSystem.os.architecture})."
 
         raise(Machinery::Errors::BuildFailed.new(message))
       end
@@ -112,7 +114,7 @@ EOF
     else
       cheetah_class = LoggedCheetah
     end
-    with_c_locale do
+    with_utf8_locale do
       cheetah_class.run(*args)
     end
   end
@@ -148,4 +150,24 @@ EOF
     # File not found, return nil
     return
   end
+
+  # Copies a file to the local system
+  def inject_file(source, destination)
+    FileUtils.copy(source, destination)
+  rescue => e
+    raise Machinery::Errors::InjectFileFailed.new(
+      "Could not inject file '#{source}' to local system.\n" \
+      "Error: #{e}"
+    )
+  end
+
+  # Removes a file from the System
+  def remove_file(file)
+    File.delete(file) if File.exist?(file)
+  rescue => e
+    raise Machinery::Errors::RemoveFileFailed.new(
+      "Could not remove file '#{file}' on local system'.\n" \
+      "Error: #{e}"
+    )
+  end
 end

data/lib/logged_cheetah.rb

@@ -16,12 +16,30 @@
 # you may find current contact information at www.suse.com
 
 class LoggedCheetah
-  def self.run(*args)
-    command = args.select{|e| e.is_a?(String)}.join(" ")
-    Machinery.logger.info("Running '#{command}'")
+  class << self
+    def run(*args)
+      run_overloaded(*args, {})
+    end
+
+    def run_with_c(*args)
+      run_overloaded(*args, with_c_locale: true)
+    end
+
+    private
+
+    def run_overloaded(*args, options)
+      command = args.select { |e| e.is_a?(String) }.join(" ")
+      Machinery.logger.info("Running '#{command}'")
 
-    with_c_locale do
-      Cheetah.run(*args)
+      if options[:with_c_locale]
+        with_c_locale do
+          Cheetah.run(*args)
+        end
+      else
+        with_utf8_locale do
+          Cheetah.run(*args)
+        end
+      end
     end
   end
 end

data/lib/machinery.rb

@@ -102,6 +102,10 @@ require_relative "serve_html_task"
 require_relative "file_diff"
 require_relative "server"
 require_relative "html"
+require_relative "machinery_helper"
+require_relative "workload_mapper"
+require_relative "containerize_task"
+require_relative "workload_mapper_dsl"
 
 Dir[File.join(Machinery::ROOT, "plugins", "**", "*.rb")].each { |f| require(f) }
 

data/lib/machinery_helper.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2015 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
+
+# The MachineryHelper class handles the helper binaries Machinery can use to
+# do inspections. It provides methods to check, if a helper is available, to
+# inject it to the target machine, run it there, and clean up after it's done.
+#
+# The inspection checks, if a binary helper is available on the machine where
+# the inspection is started. It looks at the location
+#
+#    /usr/share/machinery/helpers/<arch>/machinery-helper
+#
+# where <arch> is the hardware architecture of the target system. Valid values
+# are x86_64, i586, s390x, and ppcle.
+
+class MachineryHelper
+  attr_accessor :local_helpers_path
+
+  def initialize(s)
+    @system = s
+    @arch = @system.arch
+
+    @local_helpers_path = "/usr/share/machinery/helpers"
+  end
+
+  def local_helper_path
+    File.join(@local_helpers_path, @arch, "machinery-helper")
+  end
+
+  # Returns true, if there is a helper binary matching the architecture of the
+  # inspected system. Return false, if not.
+  def can_help?
+    File.exist?(local_helper_path)
+  end
+
+  def inject_helper
+    @system.inject_file(local_helper_path, Machinery::REMOTE_HELPERS_PATH)
+  end
+
+  def run_helper(scope)
+    json = @system.run_command(
+      File.join(
+        Machinery::REMOTE_HELPERS_PATH, "machinery-helper"
+      ), stdout: :capture, stderr: STDERR
+    )
+    scope.set_attributes(JSON.parse(json))
+  end
+
+  def remove_helper
+    @system.remove_file(File.join(Machinery::REMOTE_HELPERS_PATH, "machinery-helper"))
+  end
+end

data/lib/remote_system.rb

@@ -73,7 +73,9 @@ class RemoteSystem < System
     end
 
     sudo = ["sudo", "-n"] if options[:privileged] && remote_user != "root"
-    cmds = ["ssh", "#{remote_user}@#{host}", sudo, "LC_ALL=C", *piped_args, options].compact.flatten
+    cmds = [
+      "ssh", "#{remote_user}@#{host}", sudo, "LC_ALL=en_US.utf8", *piped_args, options
+    ].compact.flatten
     cheetah_class.run(*cmds)
   rescue Cheetah::ExecutionFailed => e
     if e.stderr.include?("password is required")
@@ -140,4 +142,32 @@ class RemoteSystem < System
       raise
     end
   end
+
+  # Copies a file to the system
+  def inject_file(source, destination)
+    destination = "#{remote_user}@#{host}:#{destination}"
+
+    cmd = [
+      "scp",
+      source,
+      destination
+    ]
+
+    begin
+      LoggedCheetah.run(*cmd)
+    rescue Cheetah::ExecutionFailed => e
+      raise Machinery::Errors::InjectFileFailed.new(
+        "Could not inject file '#{source}' to host '#{host}'.\nError: #{e}"
+      )
+    end
+  end
+
+  # Removes a file from the system
+  def remove_file(file)
+    run_command("rm", file, privileged: true)
+  rescue Cheetah::ExecutionFailed => e
+    raise Machinery::Errors::RemoveFileFailed.new(
+      "Could not remove file '#{file}' on host '#{host}'.\nError: #{e}"
+    )
+  end
 end