machinery-tool 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b0cae046e00683fea873260999de11ce3ad562
-  data.tar.gz: 295b43b9d42e832be6f78363cee7f8c91c25a47d
+  metadata.gz: f8e32d15586f31cf49aae783ee024ec80441361d
+  data.tar.gz: b25baa2048d9e5842f21813156e44b67ad833fd6
 SHA512:
-  metadata.gz: be116d55112cf6d945db98ce6ce4723644df3753904d5811b9c7abe05f0dfc4b4199bb574025d9b3833b4fc642df6132103937b0a4aeb48fe551627a024d0253
-  data.tar.gz: 76221ef972ded4ce554d3b4e7e085477b7071057ef26847a6d40cf20ef94142aced57b5109cad75274135b8a0fe7573c3d815eab092d91066fcfe95131d217a8
+  metadata.gz: 113477103631ae51730ea31d2da454aaf867e5c1576a87c41e00941af2704c0ccaedc9ea734366d7ddf9a4814ee98d25592bf5f632d04c8f3d6e398b0b68e4a1
+  data.tar.gz: 1867b37cec854da010e00429704f02b179b5fd3cd32a6baf6e2b69ac0de827d094c74111ba42bb9463c8a151136319e933864419228d26ce30eb4279a0b962bf

data/NEWS

@@ -1,6 +1,26 @@
 # Machinery Release Notes
 
 
+## Version 1.13.0 - Tue Sep 15 18:06:00 CEST 2015 - thardeck@suse.de
+
+* Fix: Show `Files extracted` status in `compare --html` when both
+  status are the same (gh#SUSE/machinery#1218)
+* Fix: Validate port option in the `show`, `compare`,  and `serve`
+  commands (gh#SUSE/machinery#1316)
+* Align output of `machinery config`
+* Add rpc_pipefs to filtered filesystems (gh#SUSE/machinery#1250)
+* Handle socket errors for `-i` option
+* Add `containerize` command to the experimental features
+* Export of autoyast files is now possible with system descriptions,
+  which have empty repository scopes (gh#SUSE/machinery#1268)
+* Inspection of unmanaged-files is now also using the faster machinery-helper
+  when the files are extracted
+* Introduce format version 5 which adds the "environment" scope (see
+  https://github.com/SUSE/machinery/blob/master/docs/System-Description-Format.md#version-5).
+  This scope is a hidden scope which is used internally by Machinery.
+* Only print binary path if it's not first in PATH (gh#SUSE/machinery#1284)
+* Do not exclude files with broken UTF-8 filenames anymore
+
 ## 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

data/export_helpers/containerize_readme.md

@@ -6,39 +6,56 @@ Machinery.
 The user is expected to be familiar with using Docker.
 Details on Docker can be found at https://www.docker.com/.
 
+This is an experimental feature and for now we **require to run every command as
+root**. If you encounter any issues please submit them to
+https://github.com/SUSE/machinery/issues
+
 ## 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
+    zypper ar -f http://download.opensuse.org/repositories/Virtualization:/containers/openSUSE_13.2/ virt
+    zypper refresh
+    zypper in docker docker-compose
+    systemctl start docker
+
+## Set Up
+
+When necessary, we've included a `setup.rb` script in your new containerized
+application. This script uses the ruby client for the Docker Remote API so you
+will need to install it as a gem.
 
-Log out and in again to refresh the user's group.
+    gem install docker-api
+
+Once installed please make sure to run the setup script before running
+`docker-compose up`.
+
+    ./setup.rb
 
 ## Managing Docker containers
 
-Run container:
+Start the application:
 
     docker-compose up
 
-Run container as daemon in background:
+_When started this way you can hit `ctrl-c` and the application will be
+stopped.)_
+
+Start the application as daemon in background:
 
     docker-compose up -d
 
-Shows list of all running containers:
+Shows a list of all running containers:
 
     docker-compose ps
 
-Stop the container:
+Stop the application:
 
     docker-compose kill
 
-Remove the container image:
+Remove all containers:
 
     docker-compose rm -vf
 

data/html/comparison.html.haml

@@ -269,7 +269,7 @@
 
     %script#scope_unmanaged_files_partial{:type => "text/ng-template"}
       %p
-        <strong>Files extracted:</strong> {{object.extracted}}
+        <strong>Files extracted:</strong> {{object.extracted ? "yes" : "no"}}
       %table.table.table-striped.table-hover.table-condensed.files-table{{"ng-show" => "object.files"}}
         %thead
           %tr
@@ -457,7 +457,7 @@
 
     %script#scope_changed_managed_files_partial{:type => "text/ng-template"}
       %p
-        <strong>Files extracted:</strong> {{object.extracted}}
+        <strong>Files extracted:</strong> {{object.extracted ? "yes" : "no"}}
       %table.table.table-striped.table-hover.table-condensed.files-table{{"ng-show" => "object.files"}}
         %thead
           %tr
@@ -524,7 +524,7 @@
 
     %script#scope_config_files_partial{:type => "text/ng-template"}
       %p
-        <strong>Files extracted:</strong> {{object.extracted}}
+        <strong>Files extracted:</strong> {{object.extracted ? "yes" : "no"}}
       %table.table.table-striped.table-hover.table-condensed.files-table{{"ng-show" => "object.files"}}
         %thead
           %tr

data/lib/build_task.rb

@@ -34,12 +34,14 @@ class BuildTask
         output_path, img_extension)
 
       begin
-        LoggedCheetah.run_with_c(
-          "sudo",
-          tmp_script.path,
-          stdout: $stdout,
-          stderr: $stderr
-        )
+        with_c_locale do
+          LoggedCheetah.run(
+            "sudo",
+            tmp_script.path,
+            stdout: $stdout,
+            stderr: $stderr
+          )
+        end
       rescue SignalException => e
         # Handle SIGHUP(1), SIGINT(2) and SIGTERM(15) gracefully
         if [1, 2, 15].include?(e.signo)

data/lib/cli.rb

@@ -240,6 +240,18 @@ class Cli
     end
   end
 
+  def self.check_port_validity(port)
+    if port < 2 || port > 65535
+      raise Machinery::Errors::InvalidCommandLine.new("Please choose a port between 2 and " \
+        "65535.")
+    else
+      if port >= 2 && port <= 1023 && !CurrentUser.new.is_root?
+        raise Machinery::Errors::InvalidCommandLine.new("You need root rights when you want " \
+          "to use a port between 2 and 65535.")
+      end
+    end
+  end
+
   AVAILABLE_SCOPE_LIST = Machinery::Ui.internal_scope_list_to_string(
     Inspector.all_scopes
   )
@@ -254,7 +266,7 @@ class Cli
       the package for the modified config files
   LONGDESC
   arg "NAME"
-  command :analyze do |c|
+  command "analyze" do |c|
     c.flag [:operation, :o], type: String, required: true,
       desc: "The analyze operation to perform", arg_name: "OPERATION"
 
@@ -288,7 +300,7 @@ class Cli
     #{buildable_distributions}
   LONGDESC
   arg "NAME"
-  command :build do |c|
+  command "build" do |c|
     c.flag ["image-dir", :i], type: String, required: true,
       desc: "Store the image under the specified path", arg_name: "DIRECTORY"
     c.switch ["enable-dhcp", :d], required: false, negatable: false,
@@ -321,7 +333,7 @@ class Cli
   LONGDESC
   arg "NAME1"
   arg "NAME2"
-  command :compare do |c|
+  command "compare" do |c|
     c.flag [:scope, :s], type: String, required: false,
       desc: "Compare specified scopes", arg_name: "SCOPE_LIST"
     c.flag ["exclude-scope", :e], type: String, required: false,
@@ -330,9 +342,13 @@ class Cli
       desc: "Show also common properties"
     if @config.experimental_features
       c.flag [:port, :p], type: Integer, required: false, default_value: @config.http_server_port,
-        desc: "Listen on port PORT", arg_name: "PORT"
+        desc: "Listen on port PORT. Ports can be selected in a range between 2-65535. Ports between
+          2 and 1023 can only be chosen when `machinery` will be executed as `root` user.",
+          arg_name: "PORT"
       c.flag [:ip, :i], type: String, required: false, default_value: "127.0.0.1",
-        desc: "Listen on ip address IP", arg_name: "IP"
+        desc: "Listen on ip address IP. 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.", arg_name: "IP"
       c.switch "html", required: false, negatable: false,
         desc: "Open comparison in HTML format in your web browser."
     end
@@ -344,6 +360,9 @@ class Cli
 
       name1 = shift_arg(args, "NAME1")
       name2 = shift_arg(args, "NAME2")
+
+      check_port_validity(options[:port]) if options[:html]
+
       store = system_description_store
       description1 = SystemDescription.load(name1, store)
       description2 = SystemDescription.load(name2, store)
@@ -370,7 +389,7 @@ class Cli
   LONGDESC
   arg "FROM_NAME"
   arg "TO_NAME"
-  command :copy do |c|
+  command "copy" do |c|
     c.action do |global_options,options,args|
       from = shift_arg(args, "FROM_NAME")
       to = shift_arg(args, "TO_NAME")
@@ -388,7 +407,7 @@ class Cli
     specified an image will be built from the description before deployment.
   LONGDESC
   arg "NAME"
-  command :deploy do |c|
+  command "deploy" do |c|
     c.flag ["cloud-config", :c], type: String, required: true, arg_name: "FILE",
       desc: "Path to file where the cloud config (openrc.sh) is located"
     c.flag ["image-dir", :i], type: String, required: false,
@@ -478,7 +497,7 @@ class Cli
     Available scopes: #{AVAILABLE_SCOPE_LIST}
   LONGDESC
   arg "HOSTNAME"
-  command :inspect do |c|
+  command "inspect" do |c|
     supports_filtering(c)
     c.flag [:name, :n], type: String, required: false, arg_name: "NAME",
       desc: "Store system description under the specified name"
@@ -571,7 +590,7 @@ class Cli
     The date of modification for each scope can be shown with the verbose
     option.
   LONGDESC
-  command :list do |c|
+  command "list" do |c|
     c.switch :verbose, required: false, negatable: false,
       desc: "Display additional information about origin of scopes"
     c.switch :short, required: false, negatable: false,
@@ -588,7 +607,7 @@ class Cli
     Shows the man page of the machinery tool.
 
   LONGDESC
-  command :man do |c|
+  command "man" do |c|
     c.action do
       task = ManTask.new
       task.man
@@ -605,7 +624,7 @@ class Cli
   LONGDESC
   arg "NAME", [:multiple, :optional]
 
-  command :remove do |c|
+  command "remove" do |c|
     c.switch :all, negatable: false,
       desc: "Remove all system descriptions"
     c.switch :verbose, required: false, negatable: false,
@@ -633,16 +652,20 @@ class Cli
     Available scopes: #{AVAILABLE_SCOPE_LIST}
   LONGDESC
   arg "NAME"
-  command :show do |c|
+  command "show" do |c|
     supports_filtering(c)
     c.flag [:scope, :s], type: String, required: false,
       desc: "Show specified scopes", arg_name: "SCOPE_LIST"
     c.flag ["exclude-scope", :e], type: String, required: false,
       desc: "Exclude specified scopes", arg_name: "SCOPE_LIST"
     c.flag [:port, :p], type: Integer, required: false, default_value: @config.http_server_port,
-      desc: "Listen on port PORT", arg_name: "PORT"
+      desc: "Listen on port PORT. Ports can be selected in a range between 2-65535. Ports between
+        2 and 1023 can only be chosen when `machinery` will be executed as `root` user.",
+        arg_name: "PORT"
     c.flag [:ip, :i], type: String, required: false, default_value: "127.0.0.1",
-      desc: "Listen on ip address IP", arg_name: "IP"
+      desc: "Listen on ip address IP. 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.", arg_name: "IP"
     c.switch "pager", required: false, default_value: true,
       desc: "Pipe output into a pager"
     c.switch "show-diffs", required: false, negatable: false,
@@ -659,6 +682,9 @@ class Cli
       if name == "localhost" && !CurrentUser.new.is_root?
         Machinery::Ui.puts "You need root rights to access the system description of your locally inspected system."
       end
+
+      check_port_validity(options[:port]) if options[:html]
+
       description = SystemDescription.load(name, system_description_store)
       scope_list = process_scope_option(options[:scope], options["exclude-scope"])
 
@@ -695,7 +721,7 @@ class Cli
     Validate system description stored under the specified name.
   LONGDESC
   arg "NAME"
-  command :validate do |c|
+  command "validate" do |c|
     c.action do |global_options,options,args|
       name = shift_arg(args, "NAME")
       if name == "localhost" && !CurrentUser.new.is_root?
@@ -774,19 +800,45 @@ class Cli
   command "serve" do |c|
     c.flag [:port, :p], type: Integer, required: false,
       default_value: Machinery::Config.new.http_server_port,
-      desc: "Listen on port PORT", arg_name: "PORT"
+      desc: "Listen on port PORT. Ports can be selected in a range between 2-65535. Ports between
+        2 and 1023 can only be chosen when `machinery` will be executed as `root` user.",
+        arg_name: "PORT"
     c.flag [:ip, :i], type: String, required: false, default_value: "127.0.0.1",
-      desc: "Listen on ip IP", arg_name: "IP"
+      desc: "Listen on ip address IP. 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.", arg_name: "IP"
 
     c.action do |_global_options, options, args|
       name = shift_arg(args, "NAME")
 
+      check_port_validity(options[:port])
+
       description = SystemDescription.load(name, system_description_store)
       task = ServeHtmlTask.new
       task.serve(description, options[:ip], options[:port])
     end
   end
 
+  if @config.experimental_features
+    desc "Containerize a system description"
+    long_desc <<-LONGDESC
+      Detects workloads from a system description and creates a recommendation for a corresponding
+      container setup
+    LONGDESC
+    arg "NAME"
+    command "containerize" do |c|
+      c.flag ["output-dir", :o], type: String, required: true,
+        desc: "Location where the container files will be stored", arg_name: "DIRECTORY"
+
+      c.action do |_global_options, options, args|
+        name = shift_arg(args, "NAME")
+        description = SystemDescription.load(name, system_description_store)
+        task = ContainerizeTask.new
+        task.containerize(description, File.expand_path(options["output-dir"]))
+      end
+    end
+  end
+
   def self.system_description_store
     if ENV.has_key?("MACHINERY_DIR")
       SystemDescriptionStore.new(ENV["MACHINERY_DIR"])

data/lib/compare_task.rb

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

data/lib/config_base.rb

@@ -20,7 +20,7 @@
 # the file 'machinery_config.rb'.
 
 class ConfigBase
-  attr_reader :file
+  attr_reader :file, :entries
 
   def initialize(file = default_config_file)
     @entries = {}

data/lib/config_task.rb

@@ -23,8 +23,11 @@ class ConfigTask
   def config(key = nil, value_string = nil)
     if !key
       # show all config entries
+      max_length = @config.entries.keys.map(&:length).max
       @config.each do |key, value|
-        Machinery::Ui.puts "#{key}=#{value[:value]} (#{value[:description]})"
+        Machinery::Ui.puts (
+          "%-#{max_length}s %s %s %s" % [key, "=", value[:value], "(#{value[:description]})"]
+        )
       end
     elsif !value_string
       # show one specific config entry

data/lib/containerize_task.rb

@@ -26,9 +26,10 @@ class ContainerizeTask
       Machinery::Ui.puts "No workloads detected."
     else
       FileUtils.mkdir_p(output_path)
-      mapper.save(workloads, output_path)
+      services = mapper.save(workloads, output_path)
       mapper.extract(description, workloads, output_path)
       write_readme_file(output_path)
+      copy_workload_setup_files(description, workloads, services, output_path)
 
       workloads.each do |workload|
         Machinery::Ui.puts "Detected workload '#{workload[0]}'."
@@ -43,4 +44,17 @@ class ContainerizeTask
       File.join(dir, "README.md")
     )
   end
+
+  private
+
+  def copy_workload_setup_files(description, workloads, services, path)
+    app = ContainerizedApp.new(description.name, workloads, services)
+    workloads.each do |workload, _|
+      Dir[File.join(Machinery::ROOT, "workload_mapper", workload, "setup", "*.erb")].each do |file|
+        setup_script = ERB.new(File.read(file))
+        File.write(File.join(path, File.basename(file, ".*")), setup_script.result(app.get_binding))
+        FileUtils.chmod "+x", File.join(path, File.basename(file, ".*"))
+      end
+    end
+  end
 end

data/lib/containerized_app.rb

@@ -0,0 +1,27 @@
+# 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 ContainerizedApp
+  def initialize(name, workloads, services)
+    @name = name
+    @services = services
+    @workloads = workloads
+  end
+
+  def get_binding
+    binding
+  end
+end