machinery-tool 1.18.0 → 1.19.0

data/plugins/{config_files/config_files.yml → changed_config_files/changed_config_files.yml}

@@ -1,10 +1,10 @@
 ---
-:name: Config Files
-:initials: cf
+:name: Changed Configuration Files
+:initials: ccf
 :description: |
   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
+  Changed configuration files are all those files which are marked as such in the
   package which has installed them. A configuration file change is reported
   if its content or its attributes like Linux permission bits or ownership
   have changed.

data/plugins/{config_files/config_files_inspector.rb → changed_config_files/changed_config_files_inspector.rb}

@@ -15,10 +15,10 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class ConfigFilesInspector < Inspector
+class ChangedConfigFilesInspector < Inspector
   has_priority 80
 
-  # returns a hash with entries for changed config files
+  # returns a hash with entries for changed configuration files
   def config_file_changes(pkg)
     @system.changed_files.select(&:config_file?).map do |file|
       ConfigFile.new(
@@ -37,25 +37,27 @@ class ConfigFilesInspector < Inspector
   end
 
   def inspect(filter, options = {})
-    do_extract = options[:extract_changed_config_files]
+    do_extract = options[:extract_changed_changed_config_files]
     system.check_retrieve_files_dependencies if do_extract
 
     count = 0
     files = @system.managed_files_database.changed_files do |chunk|
       count += chunk.lines.count { |l| !l.chomp.end_with?(":") && l.split(" ")[1] == "c" }
-      Machinery::Ui.progress(" -> Found #{count} config #{Machinery::pluralize(count, "file")}...")
+      Machinery::Ui.progress(
+        " -> Found #{Machinery.pluralize(count, "%d changed configuration file")}..."
+      )
     end
     result = files.select(&:config_file?).map do |file|
       ConfigFile.new(file.attributes)
     end
 
     if filter
-      file_filter = filter.element_filter_for("/config_files/files/name")
+      file_filter = filter.element_filter_for("/changed_config_files/files/name")
       result.delete_if { |e| file_filter.matches?(e.name) } if file_filter
     end
 
-    scope = ConfigFilesScope.new
-    file_store = @description.scope_file_store("config_files")
+    scope = ChangedConfigFilesScope.new
+    file_store = @description.scope_file_store("changed_config_files")
     scope.scope_file_store = file_store
 
     file_store.remove
@@ -71,11 +73,13 @@ class ConfigFilesInspector < Inspector
     scope.extracted = !!do_extract
     scope += result.sort_by(&:name)
 
-    @description["config_files"] = scope
+    @description["changed_config_files"] = scope
   end
 
   def summary
-    "#{@description.config_files.extracted ? "Extracted" : "Found"} " +
-      "#{@description.config_files.count} changed configuration files."
+    "#{@description.changed_config_files.extracted ? "Extracted" : "Found"} " +
+      Machinery.pluralize(
+        @description.changed_config_files.count, "%d changed configuration file"
+      ) + "."
   end
 end

data/plugins/{config_files/config_files_model.rb → changed_config_files/changed_config_files_model.rb}

@@ -36,7 +36,7 @@ class ConfigFileList < Machinery::Array
   end
 end
 
-class ConfigFilesScope < FileScope
+class ChangedConfigFilesScope < FileScope
   include Machinery::Scope
   include ScopeFileAccessFlat
 

data/plugins/{config_files/config_files_renderer.rb → changed_config_files/changed_config_files_renderer.rb}

@@ -15,26 +15,26 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
-class ConfigFilesRenderer < Renderer
+class ChangedConfigFilesRenderer < Renderer
   def content(description)
-    return unless description["config_files"]
+    return unless description["changed_config_files"]
 
-    diffs_dir = description.scope_file_store("analyze/config_file_diffs").path
+    diffs_dir = description.scope_file_store("analyze/changed_config_files_diffs").path
 
     if !diffs_dir && @options[:show_diffs]
       raise Machinery::Errors::SystemDescriptionError.new(
         "Diffs can not be shown because they were not generated yet.\n" \
         "You can generate them with `#{Hint.program_name} analyze" \
-        " --operation=config-file-diffs #{description.name}`."
+        " --operation=changed-config-files-diffs #{description.name}`."
       )
     end
 
     list do
-      file_status = description["config_files"].extracted
-      files = description["config_files"]
+      file_status = description["changed_config_files"].extracted
+      files = description["changed_config_files"]
 
       if files.elements.empty?
-        puts "There are no config files."
+        puts "There are no changed configuration files."
       elsif !file_status.nil?
         puts "Files extracted: #{file_status ? "yes" : "no"}"
       end
@@ -56,7 +56,7 @@ class ConfigFilesRenderer < Renderer
   end
 
   def display_name
-    "Changed configuration files"
+    "Changed Configuration Files"
   end
 
   def compare_content_changed(changed_elements)
@@ -81,7 +81,7 @@ class ConfigFilesRenderer < Renderer
   def render_diff_file(diffs_dir, name)
     path = File.join(diffs_dir, name + ".diff")
 
-    if File.exists?(path)
+    if File.exist?(path)
       puts "Diff:\n#{File.read(path).chomp}"
     else
       Machinery::Ui.warn "Diff for #{name} was not found on disk."

data/plugins/changed_config_files/schema/system-description-changed-config-files.schema-v8.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "type": "object",
+  "required": [
+    "_elements"
+  ],
+  "properties": {
+    "_attributes": {
+      "type": "object",
+      "required": [
+        "extracted"
+      ],
+      "properties": {
+        "extracted": {
+          "type": "boolean"
+        }
+      }
+    },
+    "_elements": {
+      "type": "array",
+        "items" : {
+          "type": "object",
+          "required": ["name", "package_name", "package_version"],
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "package_name": {
+              "type": "string",
+              "minLength": 1
+            },
+            "package_version": {
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "oneOf": [
+            { "$ref": "#/definitions/file_changed" },
+            { "$ref": "#/definitions/file_error" }
+          ]
+        }
+    }
+  },
+  "definitions": {
+    "file_changed": {
+      "required": ["status"],
+      "properties": {
+        "status": {
+          "enum": ["changed"]
+        }
+      },
+      "oneOf": [
+        { "$ref": "#/definitions/file_changed_modified" },
+        { "$ref": "#/definitions/link_changed_modified" },
+        { "$ref": "#/definitions/file_changed_deleted" }
+      ]
+    },
+    "file_changed_modified": {
+      "required": ["changes", "mode", "user", "group", "type"],
+      "properties": {
+        "changes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "size",
+              "mode",
+              "md5",
+              "device_number",
+              "link_path",
+              "user",
+              "group",
+              "time",
+              "capabilities",
+              "replaced",
+              "other_rpm_changes"
+            ]
+          },
+          "minItems": 1
+        },
+        "mode": {
+          "type": "string",
+          "pattern": "^[0-7]{3,4}$"
+        },
+        "user": {
+          "type": "string",
+          "minLength": 1
+        },
+        "group": {
+          "type": "string",
+          "minLength": 1
+        },
+        "type": {
+          "enum": ["file", "dir"]
+        }
+      }
+    },
+    "link_changed_modified": {
+      "required": ["target", "changes", "mode", "user", "group", "type"],
+      "properties": {
+        "changes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "size",
+              "mode",
+              "md5",
+              "device_number",
+              "link_path",
+              "user",
+              "group",
+              "time",
+              "capabilities",
+              "replaced",
+              "other_rpm_changes"
+            ]
+          },
+          "minItems": 1
+        },
+        "mode": {
+          "type": "string",
+          "pattern": "^[0-7]{3,4}$"
+        },
+        "user": {
+          "type": "string",
+          "minLength": 1
+        },
+        "group": {
+          "type": "string",
+          "minLength": 1
+        },
+        "type": {
+          "enum": ["link"]
+        },
+        "target": {
+          "type": "string"
+        }
+      }
+    },
+    "file_changed_deleted": {
+      "required": ["changes"],
+      "properties": {
+        "changes": {
+          "enum": [["deleted"]]
+        }
+      }
+    },
+    "file_error": {
+      "required": ["status", "error_message"],
+      "properties": {
+        "status": {
+          "enum": ["error"]
+        },
+        "error_message": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

data/plugins/changed_managed_files/changed_managed_files_inspector.rb

@@ -62,7 +62,9 @@ class ChangedManagedFilesInspector < Inspector
 
   def summary
     "#{@description.changed_managed_files.extracted ? "Extracted" : "Found"} " +
-      "#{@description.changed_managed_files.count} changed files."
+      Machinery.pluralize(
+        @description.changed_managed_files.count, "%d changed managed file"
+      ) + "."
   end
 
   private
@@ -71,7 +73,9 @@ class ChangedManagedFilesInspector < Inspector
     count = 0
     files = @system.managed_files_database.changed_files do |chunk|
       count += chunk.lines.reject { |l| l.chomp.end_with?(":") || l.split(" ")[1] == "c" }.count
-      Machinery::Ui.progress(" -> Found #{count} changed #{Machinery::pluralize(count, "file")}...")
+      Machinery::Ui.progress(
+        " -> Found #{Machinery.pluralize(count, "%d changed managed file")}..."
+      )
     end
     files.reject(&:config_file?).map do |file|
       ChangedManagedFile.new(file.attributes)

data/plugins/changed_managed_files/changed_managed_files_renderer.rb

@@ -51,7 +51,7 @@ class ChangedManagedFilesRenderer < Renderer
   end
 
   def display_name
-    "Changed managed files"
+    "Changed Managed Files"
   end
 
   def compare_content_changed(changed_elements)

data/plugins/changed_managed_files/schema/system-description-changed-managed-files.schema-v8.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "type": "object",
+  "required": [
+    "_elements"
+  ],
+  "properties": {
+    "_attributes": {
+      "type": "object",
+      "required": [
+        "extracted"
+      ],
+      "properties": {
+        "extracted": {
+          "type": "boolean"
+        }
+      }
+    },
+    "_elements": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "name",
+          "package_name",
+          "package_version"
+        ],
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "package_name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "package_version": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "oneOf": [
+          {
+            "$ref": "#/definitions/file_changed"
+          },
+          {
+            "$ref": "#/definitions/file_error"
+          }
+        ]
+      }
+    }
+  },
+  "definitions": {
+    "file_changed": {
+      "required": ["status"],
+      "properties": {
+        "status": {
+          "enum": ["changed"]
+        }
+      },
+      "oneOf": [
+        { "$ref": "#/definitions/file_changed_modified" },
+        { "$ref": "#/definitions/link_changed_modified" }
+      ]
+    },
+    "file_changed_modified": {
+      "required": ["changes"],
+      "properties": {
+        "changes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "size",
+              "mode",
+              "md5",
+              "device_number",
+              "link_path",
+              "user",
+              "group",
+              "time",
+              "capabilities",
+              "replaced",
+              "other_rpm_changes",
+              "deleted"
+            ]
+          },
+          "minItems": 1
+        },
+        "mode": {
+          "type": "string",
+          "pattern": "^[0-7]{3,4}$"
+        },
+        "user": {
+          "type": "string",
+          "minLength": 1
+        },
+        "group": {
+          "type": "string",
+          "minLength": 1
+        },
+        "type": {
+          "enum": ["file", "dir"]
+        }
+      }
+    },
+    "link_changed_modified": {
+      "required": ["target", "changes", "mode", "user", "group", "type"],
+      "properties": {
+        "changes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "size",
+              "mode",
+              "md5",
+              "device_number",
+              "link_path",
+              "user",
+              "group",
+              "time",
+              "capabilities",
+              "replaced",
+              "other_rpm_changes"
+            ]
+          },
+          "minItems": 1
+        },
+        "mode": {
+          "type": "string",
+          "pattern": "^[0-7]{3,4}$"
+        },
+        "user": {
+          "type": "string",
+          "minLength": 1
+        },
+        "group": {
+          "type": "string",
+          "minLength": 1
+        },
+        "type": {
+          "enum": ["link"]
+        },
+        "target": {
+          "type": "string"
+        }
+      }
+    },
+    "file_error": {
+      "required": ["status", "error_message"],
+      "properties": {
+        "status": {
+          "enum": ["error"]
+        },
+        "error_message": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}