machinery-tool 1.12.0 → 1.13.0

data/lib/hint.rb

@@ -29,34 +29,46 @@ class Hint
       "\nHint: #{send(method, options)}\n"
     end
 
+    def program_name
+      if which_machinery == $PROGRAM_NAME
+        "machinery"
+      else
+        $PROGRAM_NAME
+      end
+    end
+
     private
 
+    def which_machinery
+      `which machinery 2>/dev/null`.chomp
+    end
+
     def get_started(_options)
-      "You can get started by inspecting a system. Run:\n#{$0} inspect HOSTNAME"
+      "You can get started by inspecting a system. Run:\n#{program_name} inspect HOSTNAME"
     end
 
     def upgrade_format_force(options)
       "To force an upgrade of system descriptions run:\n" \
-      "#{$0} upgrade-format --force #{options[:name]}"
+      "#{program_name} upgrade-format --force #{options[:name]}"
     end
 
     def show_data(options)
-      "To show the data of the system you just inspected run:\n#{$0} show #{options[:name]}"
+      "To show the data of the system you just inspected run:\n#{program_name} show #{options[:name]}"
     end
 
     def show_analyze_data(options)
       "To show the config file diffs you just created run:\n" \
-        "#{$0} show --scope config-files --show-diffs #{options[:name]}"
+        "#{program_name} show --scope config-files --show-diffs #{options[:name]}"
     end
 
     def do_complete_inspection(options)
       "To do a full inspection containing all scopes and to extract files run:\n" \
-       "#{$0} inspect #{options[:host]} --name #{options[:name]} --extract-files"
+       "#{program_name} inspect #{options[:host]} --name #{options[:name]} --extract-files"
     end
 
     def upgrade_system_description(_options)
       "To upgrade all system descriptions run:\n" \
-       "#{$0} upgrade-format --all"
+       "#{program_name} upgrade-format --all"
     end
 
     def share_html_contents(options)

data/lib/html.rb

@@ -43,6 +43,23 @@ EOF
           servefailed_error = <<-EOF.chomp
 Port #{Server.settings.port} is already in use.
 Stop the already running server on port #{Server.settings.port} or specify a new port by using --port option.
+EOF
+          raise Machinery::Errors::ServeFailed, servefailed_error
+        rescue SocketError => e
+          servefailed_error = <<-EOF.chomp
+Cannot start server on #{opts[:ip]}:#{Server.settings.port}.
+ERROR: #{e.message}
+EOF
+          raise Machinery::Errors::ServeFailed, servefailed_error
+        rescue Errno::EADDRNOTAVAIL
+          servefailed_error = <<-EOF.chomp
+The IP-Address #{opts[:ip]} is not available. Please choose a different IP-Address.
+EOF
+          raise Machinery::Errors::ServeFailed, servefailed_error
+        rescue Errno::EACCES => e
+          servefailed_error = <<-EOF.chomp
+You are not allowed to start the server on port #{Server.settings.port}. You need root privileges for ports between 2 and 1023!
+ERROR: #{e.message}
 EOF
           raise Machinery::Errors::ServeFailed, servefailed_error
         end

data/lib/inspect_task.rb

@@ -70,6 +70,7 @@ class InspectTask
     else
       host = system.host
     end
+    set_system_locale(system, description)
 
     failed_inspections = {}
 
@@ -102,4 +103,9 @@ class InspectTask
 
     return description, failed_inspections
   end
+
+  def set_system_locale(system, description)
+    Inspector.for("environment").new(system, description).inspect
+    system.locale = description.environment.locale
+  end
 end

data/lib/inspector.rb

@@ -67,9 +67,10 @@ class Inspector
     def sort_scopes(scope_list)
       scope_priority = {}
 
+      visible_scopes = Machinery::Scope.visible_scopes.map(&:scope_name)
       scope_list.each do |scope|
         inspector = self.for(scope)
-        next if !inspector
+        next if !inspector || !visible_scopes.include?(scope)
 
         scope_priority[inspector.priority] = scope
       end

data/lib/kiwi_config.rb

@@ -30,7 +30,7 @@ class KiwiConfig < Exporter
       "os"
     )
     check_existance_of_extracted_files
-
+    check_repositories
     generate_config
   end
 
@@ -159,6 +159,19 @@ EOF
     end
   end
 
+  def check_repositories
+    if @system_description.repositories.empty?
+      raise(
+        Machinery::Errors::MissingRequirement.new(
+          "The scope 'repositories' of the system description doesn't contain a" \
+            " repository, which is necesarry for kiwi." \
+            " Please make sure that there is at least one accessible repository" \
+            " with all the required packages."
+        )
+      )
+    end
+  end
+
   def generate_config
     @sh = <<EOF
 test -f /.kconfig && . /.kconfig

data/lib/logged_cheetah.rb

@@ -18,28 +18,9 @@
 class LoggedCheetah
   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}'")
-
-      if options[:with_c_locale]
-        with_c_locale do
-          Cheetah.run(*args)
-        end
-      else
-        with_utf8_locale do
-          Cheetah.run(*args)
-        end
-      end
+      Cheetah.run(*args)
     end
   end
 end

data/lib/machinery.rb

@@ -106,6 +106,7 @@ require_relative "machinery_helper"
 require_relative "workload_mapper"
 require_relative "containerize_task"
 require_relative "workload_mapper_dsl"
+require_relative "containerized_app"
 
 Dir[File.join(Machinery::ROOT, "plugins", "**", "*.rb")].each { |f| require(f) }
 

data/lib/remote_system.rb

@@ -74,7 +74,8 @@ class RemoteSystem < System
 
     sudo = ["sudo", "-n"] if options[:privileged] && remote_user != "root"
     cmds = [
-      "ssh", "#{remote_user}@#{host}", sudo, "LC_ALL=en_US.utf8", *piped_args, options
+      "ssh", "#{remote_user}@#{host}", "-o", "LogLevel=ERROR", sudo, "LC_ALL=#{locale}",
+      *piped_args, options
     ].compact.flatten
     cheetah_class.run(*cmds)
   rescue Cheetah::ExecutionFailed => e

data/lib/scope.rb

@@ -18,6 +18,8 @@
 module Machinery
   module Scope
     def self.included(mod)
+      mod.extend(ClassMethods)
+
       @scopes ||= []
       @scopes.push(mod)
     end
@@ -26,6 +28,10 @@ module Machinery
       @scopes
     end
 
+    def self.visible_scopes
+      all_scopes.reject(&:hidden?)
+    end
+
     def self.for(scope_name, json, scope_file_store)
       all_scopes.each do |scope|
         if scope.new.scope_name == scope_name
@@ -40,6 +46,21 @@ module Machinery
       nil
     end
 
+    module ClassMethods
+      def hidden?
+        @hidden || false
+      end
+
+      def hidden_scope
+        @hidden = true
+      end
+
+      def scope_name
+        scope = name.match(/^(.*)Scope$/)[1]
+        scope.gsub(/([^A-Z])([A-Z])/, "\\1_\\2").downcase
+      end
+    end
+
     attr_accessor :meta
     attr_accessor :scope_file_store
 
@@ -51,8 +72,7 @@ module Machinery
     end
 
     def scope_name
-      scope = self.class.name.match(/^(.*)Scope$/)[1]
-      scope.gsub(/([^A-Z])([A-Z])/, "\\1_\\2").downcase
+      self.class.scope_name
     end
 
     def is_extractable?

data/lib/serve_html_task.rb

@@ -21,7 +21,7 @@ class ServeHtmlTask
 
     Machinery::Ui.use_pager = false
     Machinery::Ui.puts <<EOF
-The description is now available at #{url}
+Trying to start a web server for the description on #{url}
 
 The web server can be closed with Ctrl+C.
 EOF

data/lib/show_task.rb

@@ -36,7 +36,7 @@ class ShowTask
 
       Machinery::Ui.use_pager = false
       Machinery::Ui.puts <<EOF
-There is a web server running, serving the description on #{url}.
+Trying to start a web server for serving the description on #{url}.
 
 The server can be closed with Ctrl+C.
 EOF

data/lib/system.rb

@@ -30,6 +30,8 @@ class System
   abstract_method :inject_file
   abstract_method :remove_file
 
+  attr_writer :locale
+
   def self.for(host, remote_user = "root")
     if host && host != "localhost"
       RemoteSystem.new(host, remote_user)
@@ -96,4 +98,8 @@ class System
   def arch
     run_command("uname", "-m", stdout: :capture).chomp
   end
+
+  def locale
+    @locale || "C"
+  end
 end

data/lib/system_description.rb

@@ -26,7 +26,7 @@
 # The sub directories storing the data for specific scopes are handled by the
 # ScopeFileStore class.
 class SystemDescription < Machinery::Object
-  CURRENT_FORMAT_VERSION = 4
+  CURRENT_FORMAT_VERSION = 5
   EXTRACTABLE_SCOPES = [
     "changed_managed_files",
     "config_files",
@@ -218,11 +218,12 @@ class SystemDescription < Machinery::Object
   end
 
   def assert_scopes(*scopes)
-    missing = scopes.select { |scope| !self[scope] || self[scope].empty? }
+    missing = scopes.select { |scope| !self[scope] }
 
     unless missing.empty?
       raise Machinery::Errors::SystemDescriptionError.new(
-        "The system description misses the following section(s): #{missing.join(", ")}."
+        "The system description misses the following" \
+          " #{Machinery.pluralize(missing.size, "scope")} : #{missing.join(", ")}."
       )
     end
   end

data/lib/version.rb

@@ -17,6 +17,6 @@
 
 module Machinery
 
-  VERSION = "1.12.0"
+  VERSION = "1.13.0"
 
 end

data/lib/workload_mapper.rb

@@ -26,6 +26,7 @@ class WorkloadMapper
     compose_services = compose_services(workloads)
     linked_services = link_compose_services(compose_services)
     File.write(File.join(path, "docker-compose.yml"), linked_services.to_yaml)
+    linked_services
   end
 
   def link_compose_services(services)

data/man/generated/machinery.1.html

@@ -1014,8 +1014,14 @@ IP address and the port can be configured using the according options.</p>
 <h3 id="OPTIONS">OPTIONS</h3>
 
 <dl>
-<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p></dd>
-<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p></dd>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p>
+
+<p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
+chosen when <code>machinery</code> will be executed as <code>root</code> user.</p></dd>
+<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p>
+
+<p>It's only possible to use an IP address (or hostnames resolving to an IP address) which
+is assigned to a network interface on the local machine.</p></dd>
 </dl>
 
 
@@ -1067,8 +1073,14 @@ See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more infor
 for more information).</p></dd>
 <dt><code>--html</code> (optional)</dt><dd><p>Run a web server and open the system description in HTML format in your web browser using the
 <code>xdg-open</code> command.</p></dd>
-<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p></dd>
-<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p></dd>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p>
+
+<p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
+chosen when <code>machinery</code> will be executed as <code>root</code> user.</p></dd>
+<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p>
+
+<p>It's only possible to use an IP address (or hostnames resolving to an IP address) which
+is assigned to a network interface on the local machine.</p></dd>
 <dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which were applied before showing the system description.</p></dd>
 </dl>
 

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

@@ -0,0 +1,126 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "type": "object",
+  "required": ["extracted", "files"],
+  "properties": {
+    "extracted": {
+      "type": "boolean"
+    },
+    "files": {
+      "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"
+        }
+      }
+    }
+  }
+}