machinery-tool 1.5.0 → 1.6.0

data/lib/scope_file_store.rb

@@ -51,7 +51,9 @@ class ScopeFileStore
   end
 
   def list_content
-    files = Dir.glob(File.join(path, "**/{*,.*}"))
+    files = Dir.
+      glob(File.join(path, "**/*"), File::FNM_DOTMATCH).
+      reject { |path| [".", ".."].include?(File.basename(path)) }
     # filter parent directories because they should not be listed separately
     files.reject { |f| files.index { |e| e =~ /^#{f}\/.+/ } }
   end

data/lib/show_task.rb

@@ -16,10 +16,11 @@
 # you may find current contact information at www.suse.com
 
 class ShowTask
-  def show(description, scopes, options = {})
+  def show(description, scopes, filter, options = {})
     if options[:show_html]
       show_html(description)
     else
+      filter.apply!(description)
       show_console(description, scopes, options )
     end
   end
@@ -42,24 +43,21 @@ class ShowTask
 
   def show_console(description, scopes, options)
     missing_scopes = []
-    output = ""
 
     scopes.map { |s| Renderer.for(s) }.each do |renderer|
       section = renderer.render(description, options)
       unless section.empty?
-        output += section
+        Machinery::Ui.puts section
       else
         missing_scopes << renderer.scope
       end
     end
 
     if missing_scopes.length > 0
-      output += "# The following requested scopes were not inspected\n\n"
+      Machinery::Ui.puts "# The following requested scopes were not inspected\n\n"
       missing_scopes.each do |scope|
-        output += "  * #{Machinery::Ui.internal_scope_list_to_string(scope)}\n"
+        Machinery::Ui.puts "  * #{Machinery::Ui.internal_scope_list_to_string(scope)}\n"
       end
     end
-
-    Machinery::Ui.print_output(output, :no_pager => options[:no_pager])
   end
 end

data/lib/system_description.rb

@@ -36,7 +36,7 @@ class SystemDescription < Machinery::Object
   attr_accessor :name
   attr_accessor :store
   attr_accessor :format_version
-  attr_accessor :filters
+  attr_accessor :filter_definitions
 
   class << self
     # Load the system description with the given name
@@ -103,12 +103,7 @@ class SystemDescription < Machinery::Object
       description.format_version = json_format_version
 
       if hash["meta"] && hash["meta"]["filters"]
-        hash["meta"]["filters"].each do |command, filter_definitions|
-          description.filters[command] = Filter.new
-          filter_definitions.each do |definition|
-            description.filters[command].add_element_filter_from_definition(definition)
-          end
-        end
+        description.filter_definitions = hash["meta"]["filters"]
       end
 
       description
@@ -139,7 +134,7 @@ class SystemDescription < Machinery::Object
     @name = name
     @store = store
     @format_version = CURRENT_FORMAT_VERSION
-    @filters = {}
+    @filter_definitions = {}
 
     super(hash)
   end
@@ -176,9 +171,9 @@ class SystemDescription < Machinery::Object
     attributes.keys.each do |key|
       meta[key] = self[key].meta.as_json if self[key].meta
     end
-    @filters.each do |command, filter|
+    @filter_definitions.each do |command, filter|
       meta["filters"] ||= {}
-      meta["filters"][command] = filter.to_array
+      meta["filters"][command] = filter
     end
 
     hash = as_json
@@ -199,14 +194,18 @@ class SystemDescription < Machinery::Object
     File.chmod(0600, path) if created
   end
 
-  def set_filter(command, filter)
+  def filter_definitions(command)
+    @filter_definitions[command] || []
+  end
+
+  def set_filter_definitions(command, filter)
     if !["inspect"].include?(command)
       raise Machinery::Errors::MachineryError.new(
         "Storing the filter for command '#{command}' is not supported."
       )
     end
 
-    @filters[command] = filter
+    @filter_definitions[command] = filter
   end
 
   def scopes

data/lib/system_description_store.rb

@@ -52,7 +52,7 @@ class SystemDescriptionStore
   def list
     Dir["#{@base_path}/*"].
       select { |item| File.exists?(manifest_path(File.basename(item)))}.
-      map { |item| File.basename(item) }
+      map { |item| File.basename(item) }.sort
   end
 
   def remove(name)

data/lib/ui.rb

@@ -17,58 +17,66 @@
 
 module Machinery
   class Ui
-    def self.internal_scope_list_to_string(scopes)
-      list = Array(scopes)
-      list.map { |e| e.tr("_", "-") }.join(", ")
-    end
+    class <<self
+      attr_accessor :use_pager
+
+      def internal_scope_list_to_string(scopes)
+        list = Array(scopes)
+        list.map { |e| e.tr("_", "-") }.join(", ")
+      end
+
+      def write_output_to_pager(output)
+        @pager ||= IO.popen("$PAGER", "w")
 
-    def self.write_output_to_pager(output)
-      IO.popen("$PAGER", "w") do |f|
         begin
-          f.puts output
+          @pager.puts output
         rescue Errno::EPIPE
           # We just ignore broken pipes.
         end
       end
-    end
 
-    def self.print_output(output, options = {})
-      if options[:no_pager] || !$stdout.tty?
-        Machinery::Ui.puts output
-      else
-        if !ENV['PAGER'] || ENV['PAGER'] == ''
-          ENV['PAGER'] = 'less'
-          ENV['LESS'] = 'FSRX'
+      def close_pager
+        @pager.close if @pager
+      end
+
+      def puts(output)
+        if !use_pager || !$stdout.tty?
           begin
-            LocalSystem.validate_existence_of_package("less")
-            write_output_to_pager(output)
-          rescue Machinery::Errors::MissingRequirement
-            Machinery::Ui.puts output
+            STDOUT.puts output
+          rescue Errno::EPIPE
+            # We just ignore broken pipes.
           end
         else
-          IO.popen("$PAGER &>/dev/null", "w") { |f| f.close }
-          if $?.success?
-            write_output_to_pager(output)
+          if !ENV['PAGER'] || ENV['PAGER'] == ''
+            ENV['PAGER'] = 'less'
+            ENV['LESS'] = 'FSRX'
+            begin
+              LocalSystem.validate_existence_of_package("less")
+              write_output_to_pager(output)
+            rescue Machinery::Errors::MissingRequirement
+              STDOUT.puts output
+            end
           else
-            raise(Machinery::Errors::InvalidPager.new("'#{ENV['PAGER']}' could not " \
-              "be executed. Use the --no-pager option or modify your $PAGER " \
-              "bash environment variable to display output.")
-            )
+            IO.popen("$PAGER &>/dev/null", "w") { |f| f.close }
+            if $?.success?
+              write_output_to_pager(output)
+            else
+              raise(Machinery::Errors::InvalidPager.new("'#{ENV['PAGER']}' could not " \
+                "be executed. Use the --no-pager option or modify your $PAGER " \
+                "bash environment variable to display output.")
+              )
+            end
           end
         end
       end
-    end
-
-    def self.puts(s)
-      STDOUT.puts s
-    end
 
-    def self.warn(s)
-      STDERR.puts s
-    end
+      def warn(s)
+        STDERR.puts s
+      end
 
-    def self.error(s)
-      STDERR.puts s
+      def error(s)
+        STDERR.puts s
+      end
     end
   end
 end

data/lib/upgrade_format_task.rb

@@ -35,6 +35,7 @@ class UpgradeFormatTask
     descriptions.each do |description|
       begin
         Machinery.logger.info "Upgrading description \"#{description}\""
+        Machinery::Ui.puts "Upgrading description \"#{description}\""
         migrated = Migration.migrate_description(store, description, force: options[:force])
         migrations_done += 1 if migrated
       rescue StandardError => e
@@ -44,7 +45,9 @@ class UpgradeFormatTask
 
     if !errors.empty?
       Machinery.logger.error errors.join("\n")
-      raise Machinery::Errors::UpgradeFailed.new(errors.join("\n"))
+      exception = Machinery::Errors::UpgradeFailed.new(errors.join("\n") +
+        Hint.to_string(:upgrade_format_force, name: name || "--all"))
+      raise exception
     end
 
     if options[:all]

data/lib/version.rb

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

data/man/generated/machinery.1.html

@@ -865,7 +865,11 @@ by adding an '@' before the path, e.g.</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>
+<p>  $ <code>machinery</code> inspect --skip-files=/file\,with_comma myhost</p>
+
+<p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
+  literally and not expanded.</p></dd>
+<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which are used during inspection.</p></dd>
 </dl>
 
 
@@ -1027,6 +1031,7 @@ See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more infor
 <dt><code>--show-diffs</code> (optional)</dt><dd><p>Include the generated diffs in the output if available (see <code>machinery help analyze</code>
 for more information).</p></dd>
 <dt><code>--html</code> (optional)</dt><dd><p>Open the system description in HTML format in your web browser using the <code>xdg-open</code> command.</p></dd>
+<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which were applied before showing the system description.</p></dd>
 </dl>
 
 
@@ -1162,7 +1167,7 @@ manually editing it.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>March 2015</li>
+    <li class='tc'>April 2015</li>
     <li class='tr'>machinery(1)</li>
   </ol>
 

data/plugins/inspect/changed_managed_files_inspector.rb

@@ -18,11 +18,16 @@
 class ChangedManagedFilesInspector < Inspector
   include ChangedRpmFilesHelper
 
-  def inspect(system, description, _filter, options = {})
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, options = {})
     system.check_requirement("rsync", "--version") if options[:extract_changed_managed_files]
 
     @system = system
-    file_store = description.scope_file_store("changed_managed_files")
+    file_store = @description.scope_file_store("changed_managed_files")
 
     result = changed_files
 
@@ -39,13 +44,15 @@ class ChangedManagedFilesInspector < Inspector
       system.retrieve_files(existing_files.map(&:name), file_store.path)
     end
 
-    summary = "#{options[:extract_changed_managed_files] ? "Extracted" : "Found"} #{result.count} changed files."
-
-    description["changed_managed_files"] = ChangedManagedFilesScope.new(
+    @description["changed_managed_files"] = ChangedManagedFilesScope.new(
       extracted: !!options[:extract_changed_managed_files],
       files: ChangedManagedFileList.new(result.sort_by(&:name))
     )
-    summary
+  end
+
+  def summary
+    "#{@description.changed_managed_files.extracted ? "Extracted" : "Found"} " +
+      "#{@description.changed_managed_files.files.count} changed files."
   end
 
   private

data/plugins/inspect/config_files_inspector.rb

@@ -19,14 +19,14 @@ 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
+  def check_requirements(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)
+  def packages_with_config_files
     # 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
@@ -35,7 +35,7 @@ class ConfigFilesInspector < Inspector
     # /etc/apache2/charset.conv
     # /etc/apache2/default-server.conf
     #
-    output = system.run_command(
+    output = @system.run_command(
       "rpm", "-qa", "--configfiles", "--queryformat",
       "%{NAME}-%{VERSION}\n",
       :stdout => :capture
@@ -47,9 +47,9 @@ class ConfigFilesInspector < Inspector
   end
 
   # returns a hash with entries for changed config files
-  def config_file_changes(system, pkg)
+  def config_file_changes(pkg)
     begin
-      out = system.run_command(
+      out = @system.run_command(
         "rpm", "-V",
         "--nodeps", "--nodigest", "--nosignature", "--nomtime", "--nolinkto",
         pkg,
@@ -82,16 +82,21 @@ class ConfigFilesInspector < Inspector
     end
   end
 
-  def inspect(system, description, _filter, options = {})
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, options = {})
     do_extract = options[:extract_changed_config_files]
-    check_requirements(system, do_extract)
+    check_requirements(do_extract)
 
-    result = packages_with_config_files(system).flat_map do |package|
-      config_file_changes(system, package)
+    result = packages_with_config_files.flat_map do |package|
+      config_file_changes(package)
     end
 
-    paths = result.reject { |f| f.changes == ["deleted"] }.map(&:name)
-    path_data = get_path_data(system, paths)
+    paths = result.reject { |f| f.changes == Machinery::Array.new(["deleted"]) }.map(&:name)
+    path_data = get_path_data(@system, paths)
     key_list = [ :user, :group, :mode ]
     result.each do |pkg|
       pname = pkg.name
@@ -100,19 +105,21 @@ class ConfigFilesInspector < Inspector
       end
     end
 
-    file_store = description.scope_file_store("config_files")
+    file_store = @description.scope_file_store("config_files")
     file_store.remove
     if do_extract
       file_store.create
-      system.retrieve_files(paths, file_store.path)
+      @system.retrieve_files(paths, file_store.path)
     end
 
-    summary = "#{do_extract ? "Extracted" : "Found"} #{result.count} changed configuration files."
-
-    description["config_files"] = ConfigFilesScope.new(
+    @description["config_files"] = ConfigFilesScope.new(
       extracted: !!do_extract,
       files: ConfigFileList.new(result.sort_by(&:name))
     )
-    summary
+  end
+
+  def summary
+    "#{@description.config_files.extracted ? "Extracted" : "Found"} " +
+      "#{@description.config_files.files.count} changed configuration files."
   end
 end

data/plugins/inspect/groups_inspector.rb

@@ -16,13 +16,21 @@
 # you may find current contact information at www.suse.com
 
 class GroupsInspector < Inspector
-  def inspect(system, description, _filter, _options = {})
-    group_content = system.read_file("/etc/group")
+  def initialize(system, description)
+    @system = system
+    @description = description
+  end
+
+  def inspect(_filter, _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."
+    @description.groups = GroupsScope.new(groups.sort_by(&:name))
+  end
+
+  def summary
+    "Found #{@description.groups.size} groups."
   end
 
   private