machinery-tool 1.14.0 → 1.14.1

data/html/partials/packages.html.haml

@@ -0,0 +1,30 @@
+- if packages
+  %div
+    %a.scope_anchor{ id: "packages" }
+    .scope#packages_container
+      = render_partial "scope_header",
+        :scope => "packages",
+        :title => "Packages",
+        :count => "#{packages.length} #{Machinery.pluralize(packages.length, "packages")}"
+
+      .row.scope_content.collapse.in
+        .col-xs-1
+        .col-xs-11
+          %table.table.table-striped.table-hover.table-condensed.filterable
+            %thead
+              %tr
+                %th Name
+                %th Version
+                %th Release
+                %th Arch
+                %th Vendor
+                %th Checksum
+            %tbody
+              - packages.each do |package|
+                %tr
+                  %td= package.name
+                  %td= package.version
+                  %td= package.release
+                  %td= package.arch
+                  %td= package.vendor
+                  %td= package.checksum

data/html/partials/patterns.html.haml

@@ -0,0 +1,23 @@
+- if patterns
+  %div
+    %a.scope_anchor{ id: "patterns" }
+    .scope#patterns_container
+      = render_partial "scope_header",
+        :scope => "patterns",
+        :title => "Patterns",
+        :count => "#{patterns.length} #{Machinery.pluralize(patterns.length, "pattern")}"
+      .row.scope_content.collapse.in
+        .col-xs-1
+        .col-xs-11
+          %table.table.table-striped.table-hover.table-condensed.filterable
+            %thead
+              %tr
+                %th Name
+                %th Version
+                %th Release
+            %tbody
+              - patterns.each do |pattern|
+                %tr
+                  %td= pattern.name
+                  %td= pattern.version
+                  %td= pattern.release

data/html/partials/repositories.html.haml

@@ -0,0 +1,35 @@
+- if repositories
+  %div
+    %a.scope_anchor{ id: "repositories" }
+    .scope#repositories_container
+      - count = repositories.length
+      = render_partial "scope_header",
+        :scope => "repositories",
+        :title => "Repositories",
+        :count => "#{count} #{Machinery.pluralize(count, "repository", "repositories")}"
+      .row.scope_content.collapse.in
+        .col-xs-1
+        .col-xs-11
+          %table.table.table-striped.table-hover.table-condensed.filterable
+            %thead
+              %tr
+                %th Name
+                %th Alias
+                %th Type
+                %th URL
+                %th Enabled
+                %th Autorefresh
+                %th GPG Check
+                %th Priority
+            %tbody
+              - repositories.each do |repo|
+                %tr
+                  %td= repo.name
+                  %td= repo.alias
+                  %td= repo.type
+                  %td
+                    %a{ href: repo.url }= repo.url
+                  %td= repo.enabled
+                  %td= repo.autorefresh
+                  %td= repo.gpgcheck
+                  %td= repo.priority

data/html/partials/scope_header.html.haml

@@ -0,0 +1,17 @@
+- meta = @description[scope].meta
+.row
+  .col-xs-1
+    %img.over.scope_logo_big{ "data-content" => "<p>#{scope_help(scope)}</p>",
+      "data-toggle" => "popover",
+      "src" => "assets/logo-#{scope.tr("_", "-")}.png",
+      "title" => "",
+      "data-original-title" => title,
+      "style" => "top: 125px;" }
+    %span.toggle{ "title" => "Collapse/Expand" }
+  .col-xs-11
+    %h2
+      = title
+      &nbsp;
+      .scope-summary
+        = count
+        (inspected host: '#{meta.hostname}', at: #{DateTime.parse(meta.modified).strftime("%F %T")})

data/html/partials/services.html.haml

@@ -0,0 +1,23 @@
+- if services
+  %div
+    %a.scope_anchor{ id: "services" }
+    .scope#services_container
+      - count = services.services.length
+      = render_partial "scope_header",
+        :scope => "services",
+        :title => "Services",
+        :count => "#{count} #{Machinery.pluralize(count, "service")}"
+      .row.scope_content.collapse.in
+        .col-xs-1
+        .col-xs-11
+          %table.table.table-striped.table-hover.table-condensed.filterable
+            %thead
+              %tr
+                %th Name
+                %th State
+            %tbody
+              - services.services.each do |service|
+                %tr
+                  %td= service.name
+                  %td{ class: "#{services.init_system}_#{service.state}" }
+                    = service.state

data/html/partials/unmanaged_files.html.haml

@@ -0,0 +1,28 @@
+- if unmanaged_files && unmanaged_files.files.length > 0
+  %div
+    %a.scope_anchor{ id: "unmanaged_files" }
+    .scope#unmanaged_files_container{ "data-scope" => "unmanaged_files" }
+      - count = unmanaged_files.files.length
+      = render_partial "scope_header",
+        :scope => "unmanaged_files",
+        :title => "Unmanaged Files",
+        :count => "#{count} #{Machinery.pluralize(count, "file")}"
+      .row.scope_content.collapse.in
+        .col-xs-1
+        .col-xs-11
+          %table.table.table-striped.table-hover.table-condensed.files-table.filterable
+            %thead
+              %tr
+                %th Name
+                %th Type
+            %tbody
+              - unmanaged_files.files.each do |file|
+                %tr
+                  %td
+                    - if file.on_disk?
+                      %a.file-download{ href: "#" }
+                        = file.name
+                    - else
+                      %span
+                        = file.name
+                  %td= file.type

data/html/partials/users.html.haml

@@ -0,0 +1,29 @@
+- if users
+  %div
+    %a.scope_anchor{ id: "users" }
+    .scope#users_container
+      = render_partial "scope_header",
+        :scope => "users",
+        :title => "Users",
+        :count => "#{users.length} #{Machinery.pluralize(users.length, "user")}"
+      .row.scope_content.collapse.in
+        .col-xs-1
+        .col-xs-11
+          %table.table.table-striped.table-hover.table-condensed.filterable
+            %thead
+              %tr
+                %th Name
+                %th UID
+                %th GID
+                %th Comment
+                %th Home
+                %th Shell
+            %tbody
+              - users.each do |user|
+                %tr
+                  %td= user.name
+                  %td= user.uid
+                  %td= user.gid
+                  %td= user.comment
+                  %td= user.home
+                  %td= user.shell

data/lib/cli.rb

@@ -248,12 +248,13 @@ class Cli
 
   def self.check_port_validity(port)
     if port < 2 || port > 65535
-      raise Machinery::Errors::InvalidCommandLine.new("Please choose a port between 2 and " \
-        "65535.")
+      raise Machinery::Errors::ServerPortError.new("The specified port '#{port}' is not " \
+        "valid. A valid port can be in a range 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.")
+        raise Machinery::Errors::ServerPortError.new("The specified port '#{port}' needs " \
+          "root privileges. Otherwise, the server cannot be started. All ports in a range " \
+          "of 2-1023 need root privileges.")
       end
     end
   end
@@ -347,14 +348,6 @@ class Cli
     c.switch "show-all", required: false, negatable: false,
       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. 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. 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
@@ -367,7 +360,14 @@ class Cli
       name1 = shift_arg(args, "NAME1")
       name2 = shift_arg(args, "NAME2")
 
-      check_port_validity(options[:port]) if options[:html]
+      if options[:html]
+        begin
+          check_port_validity(@config.http_server_port)
+        rescue Machinery::Errors::ServerPortError => e
+          raise Machinery::Errors::InvalidCommandLine.new(e.message + " The port can be " \
+            "specified in the 'http_server_port' section of the configuration file.")
+        end
+      end
 
       store = system_description_store
       description1 = SystemDescription.load(name1, store)
@@ -378,8 +378,8 @@ class Cli
       opts = {
         show_html: options["html"],
         show_all: options["show-all"],
-        ip: options["ip"],
-        port: options["port"]
+        ip: "127.0.0.1",
+        port: @config.http_server_port
       }
       task.compare(description1, description2, scope_list, opts)
     end
@@ -520,9 +520,6 @@ class Cli
     c.flag "skip-files", required: false, negatable: false,
       desc: "Do not consider given files or directories during inspection. " \
         "Either provide one file or directory name or a list of names separated by commas."
-    c.flag ["remote-user", :r], type: String, required: false, default_value: @config.remote_user,
-      desc: "Defines the user which is used to access the inspected system via SSH."\
-        "This user needs sudo access on the remote machine or be root.", arg_name: "USER"
     c.switch ["extract-files", :x], required: false, negatable: false,
       desc: "Extract changed configuration files and unmanaged files from inspected system"
     c.switch "extract-changed-config-files", required: false, negatable: false,
@@ -589,6 +586,9 @@ class Cli
   command "inspect" do |c|
     supports_filtering(c)
     define_inspect_command_options(c)
+    c.flag ["remote-user", :r], type: String, required: false, default_value: @config.remote_user,
+      desc: "Defines the user which is used to access the inspected system via SSH."\
+        "This user needs sudo access on the remote machine or be root.", arg_name: "USER"
 
     c.action do |_global_options, options, args|
       host = shift_arg(args, "HOSTNAME")
@@ -618,21 +618,20 @@ class Cli
   desc "Inspect container image"
   long_desc <<-LONGDESC
     Inspect container image and generate system descripton from inspected data.
+    Right now we only support docker images.
 
     Multiple scopes can be passed as comma-separated list. If no specific scopes
     are given, all scopes are inspected.
 
     Available scopes: #{AVAILABLE_SCOPE_LIST}
   LONGDESC
-  arg "IMAGENAME"
+  arg "(IMAGENAME|IMAGEID)"
   command "inspect-container" do |c|
     supports_filtering(c)
     define_inspect_command_options(c)
-    c.switch ["docker", :d], required: true, negatable: false,
-      desc: "Inspect a docker container"
 
     c.action do |_global_options, options, args|
-      image = shift_arg(args, "IMAGENAME")
+      image = shift_arg(args, "(IMAGENAME|IMAGEID)")
       system = DockerSystem.new(image)
       inspector_task = InspectTask.new
 
@@ -741,14 +740,6 @@ class Cli
       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. 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. 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,
@@ -761,13 +752,20 @@ class Cli
     c.action do |global_options,options,args|
       Machinery::Ui.use_pager = options["pager"]
 
+      if options[:html]
+        begin
+          check_port_validity(@config.http_server_port)
+        rescue Machinery::Errors::ServerPortError => e
+          raise Machinery::Errors::InvalidCommandLine.new(e.message + " The port can be " \
+            "specified in the 'http_server_port' section of the configuration file.")
+        end
+      end
+
       name = shift_arg(args, "NAME")
       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"])
 
@@ -791,8 +789,8 @@ class Cli
       opts = {
         show_diffs: options["show-diffs"],
         show_html: options["html"],
-        ip: options["ip"],
-        port: options["port"]
+        ip: "127.0.0.1",
+        port: @config.http_server_port
       }
       task.show(description, scope_list, filter, opts)
     end
@@ -887,19 +885,29 @@ class Cli
       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. 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 "public", required: false, negatable: false,
+      desc: "Makes the server reachable from all IP addresses."
 
     c.action do |_global_options, options, args|
       name = shift_arg(args, "NAME")
 
-      check_port_validity(options[:port])
+      begin
+        check_port_validity(options[:port])
+      rescue Machinery::Errors::ServerPortError => e
+        raise Machinery::Errors::InvalidCommandLine.new(e.message + " The port can be " \
+          "either specified in the 'http_server_port' section of the configuration file " \
+          "or via the --port option.")
+      end
+
+      if options[:public]
+        ip = "0.0.0.0"
+      else
+        ip = "127.0.0.1"
+      end
 
       description = SystemDescription.load(name, system_description_store)
       task = ServeHtmlTask.new
-      task.serve(description, options[:ip], options[:port])
+      task.serve(description, ip, options[:port])
     end
   end
 

data/lib/exceptions.rb

@@ -140,5 +140,12 @@ module Machinery
     class UnexpectedInputData < MachineryError; end
     class ComposeServiceLink < MachineryError; end
     class UnsupportedHelperVersion < MachineryError; end
+    class ServerPortError < MachineryError
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+    end
   end
 end

data/lib/helper.rb

@@ -20,6 +20,27 @@ module Machinery
     (string =~ /^\d+$/) != nil
   end
 
+  def self.content_is_binary?(content)
+    # Code by http://www.thecodingforums.com/threads/test-if-file-is-binary.843447/#post-4572282
+    # Modified by SUSE Linux GmbH
+    ascii = 0
+    control = 0
+    binary = 0
+
+    content.each_byte do |byte|
+      case byte
+      when 0...32
+        control += 1
+      when 32...128
+        ascii += 1
+      else
+        binary += 1
+      end
+    end
+
+    control.to_f / ascii > 0.1 || binary.to_f / ascii > 0.05
+  end
+
   # Implementation of String#scrub for Ruby < 2.1. Assumes the string is in
   # UTF-8.
   def self.scrub(s)

data/lib/hint.rb

@@ -67,7 +67,7 @@ class Hint
          "#{program_name} inspect #{options[:host]} --name #{options[:name]} --extract-files"
       elsif options[:docker_container]
         "To do a full inspection containing all scopes and to extract files run:\n" \
-         "#{program_name} inspect-container --docker #{options[:docker_container]} " \
+         "#{program_name} inspect-container #{options[:docker_container]}" \
          "--name #{options[:name]} --extract-files"
       end
     end

data/lib/html.rb

@@ -26,11 +26,19 @@ class Html
       Server.set :public_folder, File.join(Machinery::ROOT, "html")
 
       if opts[:ip] != "localhost" && opts[:ip] != "127.0.0.1"
-        Machinery::Ui.puts <<EOF
+        if opts[:ip] == "0.0.0.0"
+          Machinery::Ui.puts <<EOF
+Warning:
+The server is listening on all configured IP addresses.
+This could lead to confidential data like passwords or private keys being readable by others.
+EOF
+        else
+          Machinery::Ui.puts <<EOF
 Warning:
 You specified an IP address other than '127.0.0.1', your server may be reachable from the network.
 This could lead to confidential data like passwords or private keys being readable by others.
 EOF
+        end
       end
 
       begin