machinery-tool 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9dfaf00e73b823dc8164aa283469baefd8e9ea4
-  data.tar.gz: ccaf2f58602a73a1cac8a396c2134fc520ba48b6
+  metadata.gz: 7fa664c89d067292bb4703e9b8bba47651981831
+  data.tar.gz: 45c13a6f27432d9fc09ab306cdad7c07680df73f
 SHA512:
-  metadata.gz: 493bf1127ae653467d41ea5c4c3ab20ac28b546cd10e1018b8de2c881faf57ca5c1c2e488cdd32679477452ed7a748ff2013a0e655a001cf9eb7ec8c842c78d3
-  data.tar.gz: 397f7be936594a0b1b0eabadc988a360e4b561407787b4e809c8b16842e5e7d05f814d5548a0e9baaca98cbc2af870973d0037049067fe8a2fe7b86b6a481e3e
+  metadata.gz: f31cd802cb1ce442b18bb0dd374f9308371bf7376e168d97608d5a0ff94e10164d11c6cc0ed58c40aaad230338430c966f5013f3a8c49c940ab1ed45f810ca32
+  data.tar.gz: b1d69fc9f41836dab29ff51e449861517527b9b205ad5e6ccc6ef981199b40386518a93c02a98d3454b25bf842914c8da9f106a15179aa71e11c2e8b8b924908

data/NEWS

@@ -1,6 +1,19 @@
 # Machinery Release Notes
 
 
+## Version 1.9.0 - Wed Jun 17 09:57:07 CEST 2015 - thardeck@suse.de
+
+* Support links in changed managed files scope
+* Support links in config files scope
+* Introduce system description format version 4 (see https://github.com/SUSE/machinery/wiki/System-Description-Format#version-4)
+* Show progress during inspection of scopes
+* Show message when compared scopes are identical (gh#SUSE/machinery#631)
+* Check number of parameters in all commands (gh#SUSE/machinery#898)
+* Do not abort when Machinery is run on unsupported platforms, but just show a warning
+* Apply all filters on file extraction (gh#SUSE/machinery#887)
+* Consistent output of filters with --verbose option (gh#SUSE/machinery#797)
+* Fix export of changed managed files with quotes in file name (gh#SUSE/machinery#913)
+
 ## Version 1.8.2 - Wed May 27 16:56:44 CEST 2015 - thardeck@suse.de
 
 * Fixed repository inspection using a non-root user

data/helpers/changed_files.sh

@@ -0,0 +1,105 @@
+#!/bin/bash
+# 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
+
+# Print a list of each package with changed managed files followed by a list of
+# 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
+
+# Exit immediately if a command exits with a non-zero status.
+set -e
+
+scope=$1
+package=$2 # for scope config-files only
+
+if [[ -z "$scope" || "$scope" != "config-files" && "$scope" != "changed-managed-files" ]]; then
+  echo "Error: Expect scope 'config-files' or 'changed-managed-files' as first argument." >&2
+  exit 1
+fi
+
+if [[ "$scope" == "changed-managed-files" && $# != 1 ]]; then
+  echo "Error: Expect no extra arguments after changed-managed-files " >&2
+  exit 1
+fi
+
+if [[ "$scope" == "config-files" && $# != 2 ]]; then
+  echo "Error: Expect one argument with package name after config-files" >&2
+  exit 1
+fi
+
+if [ $UID -ne "0" ]; then
+   sudoprefix="sudo -n"
+fi
+
+rpm_supports_noscripts_option () {
+  rpm -V --noscripts rpm > /dev/null
+}
+
+if rpm_supports_noscripts_option; then
+  noscripts="--noscripts"
+fi
+
+package_contains_verify_script () {
+  rpm --scripts -q $1 | grep "verify scriptlet" > /dev/null
+}
+
+check_output () {
+  # rpm returns 1 as exit code when modified config files are detected
+  # that's why we explicitly detect if sudo failed
+  regex="^sudo:.*password is required"
+  if [[ "$1" =~ $regex ]]; then
+    echo "$1" >&2
+    exit 1
+  fi
+}
+
+inspect_package () {
+  package=$1
+  output=`$sudoprefix rpm -V --nodeps --nodigest --nosignature --nomtime $noscripts $package 2>&1 || true`
+
+  check_output "$output"
+
+  if [ -z "$noscripts" ] && ( package_contains_verify_script $package ); then
+    # remove the lines printed by verify scripts, because we cannot parse these lines
+    # in certain rpm versions verify scripts cannot be turned off
+    lines=`$sudoprefix rpm -V --nodeps --nodigest --nosignature --nomtime --nofiles $package | wc -l`
+    output=`echo -e "$output" | head -n-${lines}`
+  fi
+
+  if [ -n "$output" ]; then
+    if [ $scope == "changed-managed-files" ]; then
+      echo -e "$package:\\n$output";
+    else
+      echo -e "$output"
+    fi
+  fi
+}
+
+if [ $scope == "changed-managed-files" ]; then
+  for package in `rpm -qa --queryformat "%{NAME}-%{VERSION}\\n"`; do
+    inspect_package $package
+  done
+fi
+
+if [ $scope == "config-files" ]; then
+  inspect_package $package
+fi
+

data/helpers/filter-packages-for-build.yaml

@@ -1,4 +1,6 @@
 # check lib/os.rb for the distribution names
+"openSUSE 13.2 (Harlequin)":
+  - openSUSE-release-dvd
 "openSUSE 13.1 (Bottle)":
   - openSUSE-release-dvd
 "SUSE Linux Enterprise Server 12":

data/lib/array.rb

@@ -49,11 +49,19 @@ module Machinery
     end
 
     attr_reader :elements
+    attr_accessor :scope
 
     def initialize(elements = [])
       @elements = self.class.convert_raw_array(elements)
     end
 
+    def scope=(scope)
+      @scope = scope
+      @elements.each do |child|
+        child.scope = @scope if child.respond_to?(:scope=)
+      end
+    end
+
     def ==(other)
       self.class == other.class && @elements == other.elements
     end

data/lib/autoyast.rb

@@ -82,8 +82,8 @@ class Autoyast < Exporter
         apply_groups(xml)
         apply_services(xml)
 
-        apply_extracted_files("config_files")
-        apply_extracted_files("changed_managed_files")
+        apply_changed_files("config_files")
+        apply_changed_files("changed_managed_files")
         apply_unmanaged_files
         xml.scripts do
           apply_url_extraction(xml)
@@ -262,33 +262,37 @@ class Autoyast < Exporter
     end
   end
 
-  def apply_extracted_files(scope)
-    return if !@system_description[scope] || !@system_description[scope].extracted
-
-    base = Pathname(@system_description.scope_file_store(scope).path)
-    Dir["#{base}/**/*"].sort.each do |path|
-      next if File.directory?(path)
-
-      relative_path = Pathname(path).relative_path_from(base).to_s
-      url = "`cat /tmp/description_url`/#{URI.escape(File.join(scope, relative_path))}"
-
-      @chroot_scripts << "mkdir -p '#{File.join("/mnt", File.dirname(relative_path))}'"
-      @chroot_scripts << "curl -o '#{File.join("/mnt", relative_path)}' \"#{url}\""
-    end
-
-    @system_description[scope].files.map do |file|
-      if file.user
-        @chroot_scripts << "chown #{file.user}:#{file.group} '#{File.join("/mnt", file.name)}'"
-      end
-      if file.mode
-        @chroot_scripts << "chmod #{file.mode} '#{File.join("/mnt", file.name)}'"
+  def apply_changed_files(scope)
+    return if !@system_description.scope_extracted?(scope)
+
+    @system_description[scope].files.each do |file|
+      if file.deleted?
+        @chroot_scripts << "rm -rf '#{quote(file.name)}'"
+      elsif file.directory?
+        @chroot_scripts << <<EOF.strip
+chmod #{file.mode} '#{File.join("/mnt", quote(file.name))}'
+chown #{file.user}:#{file.group} '#{File.join("/mnt", quote(file.name))}'
+EOF
+      elsif file.file?
+        url = "`cat /tmp/description_url`/#{URI.escape(File.join(scope, quote(file.name)))}"
+        @chroot_scripts << <<EOF.strip
+mkdir -p '#{File.join("/mnt", File.dirname(quote(file.name)))}'
+curl -o '#{File.join("/mnt", quote(file.name))}' \"#{url}\"
+chmod #{file.mode} '#{File.join("/mnt", quote(file.name))}'
+chown #{file.user}:#{file.group} '#{File.join("/mnt", quote(file.name))}'
+EOF
+      elsif file.link?
+        @chroot_scripts << <<EOF.strip
+rm -rf '#{File.join("/mnt", quote(file.name))}'
+ln -s '#{quote(file.target)}' '#{File.join("/mnt", quote(file.name))}'
+chown --no-dereference #{file.user}:#{file.group} '#{File.join("/mnt", quote(file.name))}'
+EOF
       end
     end
   end
 
   def apply_unmanaged_files
-    return if !@system_description.unmanaged_files ||
-      !@system_description.unmanaged_files.extracted
+    return if !@system_description.scope_extracted?("unmanaged_files")
 
     base = Pathname(@system_description.scope_file_store("unmanaged_files").path)
     @chroot_scripts << <<-EOF.chomp.gsub(/^\s+/, "")
@@ -296,8 +300,6 @@ class Autoyast < Exporter
     EOF
 
     Dir["#{base}/**/*.tgz"].sort.each do |path|
-      next if !path.end_with?(".tgz")
-
       relative_path = Pathname(path).relative_path_from(base).to_s
       tarball_name = File.basename(path)
       url = "`cat /tmp/description_url`#{URI.escape(File.join("/unmanaged_files", relative_path))}"

data/lib/build_task.rb

@@ -35,8 +35,12 @@ class BuildTask
         output_path, img_extension)
 
       begin
-        LoggedCheetah.run("sudo", tmp_script.path, :stdout => $stdout,
-          :stderr => $stderr)
+        LoggedCheetah.run(
+          "sudo",
+          tmp_script.path,
+          stdout: $stdout,
+          stderr: $stderr
+        )
       rescue SignalException => e
         # Handle SIGHUP(1), SIGINT(2) and SIGTERM(15) gracefully
         if [1, 2, 15].include?(e.signo)
@@ -62,6 +66,11 @@ class BuildTask
           end
         end
         raise
+      rescue Cheetah::ExecutionFailed
+        raise(
+          Machinery::Errors::BuildFailed,
+          "The execution of the build script failed."
+        )
       ensure
         tmp_script.delete
       end

data/lib/changed_rpm_files_helper.rb

@@ -69,32 +69,51 @@ module ChangedRpmFilesHelper
   end
 
   def parse_stat_line(line)
-    mode, user, group, uid, gid, *path = line.split(":")
+    mode, user, group, uid, gid, type, *path = line.split(":")
 
     user = uid if user == "UNKNOWN"
     group = gid if group == "UNKNOWN"
 
+    type = case type
+    when "directory"
+      "dir"
+    when "symbolic link"
+      "link"
+    when "regular file"
+      "file"
+    end
+
     [path.join(":").chomp,
       {
-        :mode  => mode,
-        :user  => user,
-        :group => group
+        mode: mode,
+        user: user,
+        group: group,
+        type: type
       }
     ]
   end
 
+  def get_link_target(system, link)
+    system.run_command(
+      "find", link, "-prune", "-printf", "%l",
+      stdout: :capture,
+      privileged: true
+    ).strip
+  end
+
   # get path data for list of files
   # cur_files is guaranteed to not exceed max command line length
   def get_file_properties(system, cur_files)
     ret = {}
     out = system.run_command(
-        "stat", "--printf", "%a:%U:%G:%u:%g:%n\\n",
-        *cur_files,
-        :stdout => :capture
+      "stat", "--printf", "%a:%U:%G:%u:%g:%F:%n\\n",
+      *cur_files,
+      stdout: :capture
     )
     out.each_line do |l|
       path, values = parse_stat_line(l)
       ret[path] = values
+      ret[path][:target] = get_link_target(system, path) if values[:type] == "link"
     end
     ret
   end

data/lib/cli.rb

@@ -37,6 +37,7 @@ class Cli
     else
       Machinery.logger.level = Logger::INFO
     end
+    check_exceeding_arguments(command.arguments, args)
   end
 
   post do |global_options,command,options,args|
@@ -56,6 +57,14 @@ class Cli
 
   GLI::Commands::Help.skips_post = false
 
+  def self.check_exceeding_arguments(defined, parsed)
+    if parsed.size > defined.size
+      message = "The given arguments don't match the command's specified arguments."
+      raise GLI::BadCommandLine.new(message)
+    end
+    true
+  end
+
   def self.buildable_distributions
     distribution_string = ""
     Os.supported_host_systems.each do |distribution|
@@ -74,7 +83,7 @@ class Cli
         GLI::UnknownCommand, GLI::BadCommandLine, OptionParser::MissingArgument
       Machinery::Ui.error e.to_s + "\n\n"
       command = ARGV & @commands.keys.map(&:to_s)
-      run(command << "--help")
+      Machinery::Ui.error "Run '#{$0} #{command.first} --help' for more information."
       exit 1
     when Machinery::Errors::MachineryError
       Machinery.logger.error(e.message)
@@ -331,7 +340,8 @@ class Cli
 
     The system description is copied and stored under the provided name.
   LONGDESC
-  arg_name "FROM_NAME TO_NAME"
+  arg "FROM_NAME"
+  arg "TO_NAME"
   command :copy do |c|
     c.action do |global_options,options,args|
       from = shift_arg(args, "FROM_NAME")

data/lib/compare_task.rb

@@ -41,7 +41,7 @@ class CompareTask
       end
     end
 
-    target = "/tmp/machinery-html-comparison"
+    target = File.join(Machinery::DEFAULT_CONFIG_DIR, "html-comparison")
     FileUtils.rm_r(target) if Dir.exists?(target)
     FileUtils.mkdir_p(target)
 
@@ -52,6 +52,7 @@ class CompareTask
   def render_comparison(description1, description2, scopes, options = {})
     output = ""
     identical = true
+    identical_scopes = []
     common_scopes = false
     store = description1.store
     scopes.each do |scope|
@@ -85,6 +86,8 @@ class CompareTask
 
         if partial_description1[scope] || partial_description2[scope]
           identical = false
+        else
+          identical_scopes << scope
         end
         common_scopes = true
       else
@@ -94,9 +97,13 @@ class CompareTask
         identical = false if description1[scope] || description2[scope]
       end
     end
-
     output = "Compared descriptions are identical.\n" + output if identical && common_scopes
 
+    if !identical_scopes.empty?
+      phrase = Machinery::pluralize(identical_scopes.count, "scope is", "scopes are")
+      output += "Following #{phrase} identical in both descriptions: " + identical_scopes.join(",")
+    end
+
     output
   end
 end

data/lib/config.rb

@@ -38,6 +38,10 @@ module Machinery
         description: "Enable experimental features. See " \
           "https://github.com/SUSE/machinery/wiki/Experimental-Features for more details"
       )
+      entry("perform_support_check",
+        default: true,
+        description: "Check whether the current platform is supported by Machinery"
+      )
     end
   end
 end

data/lib/element_filter.rb

@@ -29,6 +29,10 @@ class ElementFilter
     add_matchers(operator, matchers) if operator && matchers
   end
 
+  def initialize_copy(other)
+    @matchers = other.matchers.dup
+  end
+
   def add_matchers(operator, matchers)
     if ![Filter::OPERATOR_EQUALS, Filter::OPERATOR_EQUALS_NOT].include?(operator)
       raise Machinery::Errors::InvalidFilter.new("Wrong filter operator '#{operator}'")

data/lib/exceptions.rb

@@ -118,6 +118,7 @@ module Machinery
     class ElementFilterTypeMismatch < MachineryError
       attr_accessor :failed_matcher
     end
+    class FileUtilsError < MachineryError; end
 
     class BuildFailed < MachineryError; end
     class DeployFailed < MachineryError; end

data/lib/exporter.rb

@@ -21,4 +21,8 @@ class Exporter
 
   abstract_method :write
   abstract_method :export_name
+
+  def quote(name)
+    name.gsub("'", "'\\\\''")
+  end
 end