machinery-tool 1.17.0 → 1.18.0

data/lib/list_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/local_system.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/logged_cheetah.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/machinery.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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
@@ -32,11 +32,14 @@ require "haml"
 require "kramdown"
 require "find"
 require "pathname"
-require "nokogiri"
 require "socket"
 require "diffy"
 require "sinatra/base"
 require "mimemagic"
+require "rexml/document"
+require "builder"
+
+require_relative "json_schema_monkey_patch"
 
 require_relative "try"
 require_relative "machinery_logger"
@@ -112,6 +115,7 @@ require_relative "docker_system"
 require_relative "managed_files_database"
 require_relative "rpm_database"
 require_relative "dpkg_database"
+require_relative "tee_io"
 
 Dir[File.join(Machinery::ROOT, "plugins", "**", "*.rb")].each { |f| require(f) }
 

data/lib/machinery_helper.rb

@@ -26,33 +26,47 @@
 
 class MachineryHelper
   attr_accessor :local_helpers_path
-  attr_accessor :remote_helper_path
 
   def initialize(s)
     @system = s
-    @arch = @system.arch
 
     @local_helpers_path = File.join(Machinery::ROOT, "machinery-helper")
-    @remote_helper_path = File.join(Machinery::HELPER_REMOTE_PATH, "machinery-helper")
   end
 
   def local_helper_path
-    File.join(local_helpers_path, "machinery-helper")
+    File.join(local_helpers_path, "machinery-helper-#{@system.arch}")
+  end
+
+  def remote_helper_path
+    @remote_helper_path ||= @system.run_command(
+      # Expand Machinery::HELPER_REMOTE_PATH on remote machine
+      "bash", "-c", "echo -n #{File.join(Machinery::HELPER_REMOTE_PATH, "machinery-helper")}",
+        stdout: :capture
+    )
   end
 
   # Returns true, if there is a helper binary matching the architecture of the
   # inspected system. Return false, if not.
   def can_help?
-    File.exist?(local_helper_path) && LocalSystem.matches_architecture?(@arch)
+    File.exist?(local_helper_path)
   end
 
   def inject_helper
-    @system.inject_file(local_helper_path, Machinery::HELPER_REMOTE_PATH)
+    @system.inject_file(local_helper_path, remote_helper_path)
   end
 
-  def run_helper(scope)
-    json = @system.run_command(remote_helper_path, stdout: :capture, stderr: STDERR)
+  def run_helper(scope, *options)
+    error = TeeIO.new(STDERR, "sudo: a password is required\n")
+    json = @system.run_command(
+      remote_helper_path, *options, stdout: :capture, stderr: error, privileged: true
+    )
     scope.insert(0, *JSON.parse(json)["files"])
+  rescue Cheetah::ExecutionFailed => e
+    if error.string.include?("password is required")
+      raise Machinery::Errors::InsufficientPrivileges.new(@system.remote_user, @system.host)
+    else
+      raise e
+    end
   end
 
   def remove_helper
@@ -66,4 +80,10 @@ class MachineryHelper
 
     version == File.read(File.join(Machinery::ROOT, ".git_revision"))
   end
+
+  def run_helper_subcommand(subcommand, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options[:privileged] = true
+    @system.run_command(remote_helper_path, subcommand, *args, options)
+  end
 end

data/lib/machinery_logger.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/man_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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
@@ -16,12 +16,57 @@
 # you may find current contact information at www.suse.com
 
 class ManTask
-  def man
+  def self.compile_documentation
+    docs = Inspector.all_scopes.map do |scope|
+      scope_doc = "* #{scope}\n\n"
+      scope_doc += YAML.load_file(
+        File.join(Machinery::ROOT, "plugins/#{scope}/#{scope}.yml")
+      )[:description]
+      scope_doc + "\n"
+    end.join
+    File.write("manual/docs/machinery_main_scopes.1.md", docs)
+    Dir.chdir(File.join(Machinery::ROOT, "manual")) do
+      Cheetah.run("mkdocs", "build")
+    end
+  end
+
+  def man(options)
+    if options[:html]
+      man_html(options)
+    else
+      man_system
+    end
+  end
+
+  def man_system
     LocalSystem.validate_existence_of_package("man")
-    system("man", man_path)
+    system("man", File.join(Machinery::ROOT, "man/generated/machinery.1.gz"))
   end
 
-  def man_path
-    File.join(Machinery::ROOT, "man/generated/machinery.1.gz")
+  def man_html(options)
+    unless File.exist?(File.join(Machinery::ROOT, "manual/site"))
+      Machinery::Ui.warn(
+        "The documentation was not generated yet. Please make sure that `mkdocs` is installed on " \
+        "your system and run `rake man_pages:compile_documentation` from the machinery directory."
+      )
+      return
+    end
+
+    LocalSystem.validate_existence_of_command("xdg-open", "xdg-utils")
+
+    url = "http://#{options[:ip]}:#{options[:port]}/site/docs/index.html"
+
+    Machinery::Ui.use_pager = false
+    Machinery::Ui.puts <<EOF
+Trying to start a web server for serving the documentation on #{url}.
+
+The server can be closed with Ctrl+C.
+EOF
+
+    server = Html.run_server(SystemDescriptionStore.new, port: options[:port], ip: options[:ip]) do
+      LoggedCheetah.run("xdg-open", url)
+    end
+
+    server.join # Wait until the user cancelled the blocking webserver
   end
 end

data/lib/managed_files_database.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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
@@ -46,25 +46,30 @@ class ManagedFilesDatabase
     return @changed_files if @changed_files
     check_requirements
 
-    result = managed_files_list(&block).each_line.map do |line|
+    result = managed_files_list(&block).lines.inject({}) do |hash, line|
       line.chomp!
-      next unless line =~ /^[^ ]+[ ]+. \/.*$/
+      next(hash) unless line =~ /^[^ ]+[ ]+. \/.*$/
 
       file, changes, type = parse_changes_line(line)
 
-      package_name, package_version = package_for_file_path(file)
+      unless hash[file]
+        package_name, package_version = package_for_file_path(file)
+
+        hash[file] = ChangedFile.new(
+          type,
+          name:            file,
+          package_name:    package_name,
+          package_version: package_version,
+          status:          "changed",
+          changes:         []
+        )
+      end
 
-      ChangedFile.new(
-        type,
-        name:            file,
-        package_name:    package_name,
-        package_version: package_version,
-        status:          "changed",
-        changes:         changes
-      )
-    end.compact.uniq
+      hash[file].changes |= changes
+      hash
+    end.values
 
-    paths = result.reject { |f| f.changes == ["deleted"] }.map(&:name)
+    paths = result.reject { |f| f.changes.include?("deleted") }.map(&:name)
     path_data = get_path_data(paths)
     result.each do |pkg|
       next unless path_data[pkg.name]
@@ -90,11 +95,13 @@ class ManagedFilesDatabase
     path = fields.join(" ")
 
     changes = []
-    if @rpm_changes == "missing"
-      changes << "deleted"
-    elsif @rpm_changes == "........." && path.end_with?(" (replaced)")
+    if (@rpm_changes == "........." || @rpm_changes == "missing") && path.end_with?(" (replaced)")
       changes << "replaced"
       path.slice!(/ \(replaced\)$/)
+    end
+
+    if @rpm_changes == "missing"
+      changes << "deleted"
     else
       changes << "size" if expected_tag?("S", 0)
       changes << "mode" if expected_tag?("M", 1)

data/lib/manifest.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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
@@ -95,6 +95,7 @@ class Manifest
   end
 
   def compatible_json?
-    @hash && @hash["meta"] && @hash["meta"]["format_version"]
+    @hash && @hash["meta"] && @hash["meta"]["format_version"] &&
+      @hash["meta"]["format_version"] <= SystemDescription::CURRENT_FORMAT_VERSION
   end
 end

data/lib/migration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/mountpoints.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/move_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/object.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/remote_system.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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
@@ -178,7 +178,7 @@ class RemoteSystem < System
 
   # Removes a file from the system
   def remove_file(file)
-    run_command("rm", file, privileged: true)
+    run_command("rm", file)
   rescue Cheetah::ExecutionFailed => e
     raise Machinery::Errors::RemoveFileFailed.new(
       "Could not remove file '#{file}' on host '#{host}'.\nError: #{e}"

data/lib/remove_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/renderer.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/renderer_helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/rpm.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/rpm_database.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/scope.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/scope_file_store.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/serve_html_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/server.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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
@@ -16,6 +16,28 @@
 # To contact SUSE about this file by physical or electronic mail,
 # you may find current contact information at www.suse.com
 
+# Rack::TryStatic was taken from the rack-contrib repository (https://github.com/rack/rack-contrib)
+module Rack
+  class TryStatic
+    def initialize(app, options)
+      @app = app
+      @try = ["", *options[:try]]
+      @static = ::Rack::Static.new(->(_) { [404, {}, []] }, options)
+    end
+
+    def call(env)
+      orig_path = env["PATH_INFO"]
+      found = nil
+      @try.each do |path|
+        resp = @static.call(env.merge!("PATH_INFO" => orig_path + path))
+        break if !(403..405).cover?(resp[0]) && found = resp
+      end
+      found || @app.call(env.merge!("PATH_INFO" => orig_path))
+    end
+  end
+end
+
+
 class Server < Sinatra::Base
   module Helpers
     def render_partial(partial, locals = {})
@@ -126,7 +148,8 @@ class Server < Sinatra::Base
           id:       change[0][opts[:key]],
           change:   "(" + changes.join(", ") + ")",
           diffable: change[0].is_a?(UnmanagedFile) && change[0].is_a?(UnmanagedFile) &&
-            change[0].file? && change[1].file?
+            change[0].file? && change[1].file? &&
+            @diff[scope].try(:common).try(:attributes).try(:[], "extracted")
         )
       end
       changed
@@ -200,6 +223,13 @@ class Server < Sinatra::Base
 
   helpers Helpers
 
+  # Serve the 'manual/site' directory under /site using Rack::TryStatic
+  use Rack::TryStatic,
+    root: File.join(Machinery::ROOT, "manual"),
+    urls: %w[/site],
+    try: ["index.html"]
+
+
   get "/descriptions/:id/files/:scope/*" do
     description = SystemDescription.load(params[:id], settings.system_description_store)
     filename = File.join("/", params["splat"].first)

data/lib/show_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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

data/lib/system.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 SUSE LLC
+# Copyright (c) 2013-2016 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