machinery-tool 1.0.2

data/lib/kiwi_export_task.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2013-2014 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 KiwiExportTask
+  def export(description, kiwi_dir, options)
+    if File.exists?(kiwi_dir)
+      if options[:force]
+        FileUtils.rm_r(kiwi_dir)
+      else
+        raise Machinery::Errors::KiwiExportFailed.new(
+          "The output directory '#{kiwi_dir}' already exists." \
+          " You can force overwriting it with the '--force' option."
+        )
+      end
+    end
+
+    FileUtils.mkdir_p(kiwi_dir) unless Dir.exists?(kiwi_dir)
+
+    config = KiwiConfig.new(description)
+    config.write(kiwi_dir)
+  end
+end

data/lib/list_task.rb

@@ -0,0 +1,64 @@
+# Copyright (c) 2013-2014 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 ListTask
+  def list(store, options = {})
+    descriptions = store.list.sort
+
+    descriptions.each do |name|
+      name = File.basename(name)
+      begin
+        description = store.load(name)
+      rescue Machinery::Errors::SystemDescriptionError
+        Machinery::Ui.puts " #{name}:\n"
+        Machinery::Ui.puts "   This description has an incompatible data format or is broken.\n" \
+             "   Use `#{$0} validate #{name}` to see the error message.\n\n"
+        next
+      end
+      scopes = []
+
+      description.scopes.each do |scope|
+        entry = Machinery::Ui.internal_scope_list_to_string(scope)
+        if SystemDescription::EXTRACTABLE_SCOPES.include?(scope)
+          if description.scope_extracted?(scope)
+            entry += " (extracted)"
+          else
+            entry += " (not extracted)"
+          end
+        end
+
+        if options["verbose"]
+          meta = description[scope].meta
+          if meta
+            time = Time.parse(meta.modified).getlocal
+            date = time.strftime "%Y-%m-%d %H:%M:%S"
+            hostname = meta.hostname
+          else
+            date = "unknown"
+            hostname = "Unknown hostname"
+          end
+          entry += "\n      Host: [#{hostname}]"
+          entry += "\n      Date: (#{date})"
+        end
+
+        scopes << entry
+      end
+
+      Machinery::Ui.puts " #{name}:\n   * " + scopes .join("\n   * ") + "\n\n"
+    end
+  end
+end

data/lib/local_system.rb

@@ -0,0 +1,127 @@
+# Copyright (c) 2013-2014 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 LocalSystem < System
+  class <<self
+    def os_object
+      description = SystemDescription.new("localhost")
+      inspector = OsInspector.new
+      inspector.inspect(System.for("localhost"), description)
+      description.os_object
+    end
+
+    def validate_existence_of_package(package)
+      begin
+        Cheetah.run("rpm", "-q", package)
+      rescue
+        needed_module = os_object.module_required_by_package(package)
+        if needed_module
+          raise(Machinery::Errors::MissingRequirement.new("You need the package '#{package}' from module '#{needed_module}'. You can install it as follows:\n" \
+            "If you haven't selected the module '#{needed_module}' before, run `yast2 scc` and choose 'Select Extensions' and activate '#{needed_module}'.\nRun `zypper install #{package}` to install the package."))
+        else
+          raise(Machinery::Errors::MissingRequirement.new("You need the package '#{package}'. You can install it by running `zypper install #{package}`"))
+        end
+      end
+    end
+
+    def validate_machinery_compatibility
+      begin
+        os = os_object
+      rescue Machinery::Errors::SystemDescriptionError
+        os = nil
+      end
+
+      if !os || !os.can_run_machinery?
+        message = "Running Machinery is not supported on this system.\n" \
+          "Check the 'Installation' section in the README.md for more information " \
+          "about the requirements."
+
+        raise(Machinery::Errors::IncompatibleHost.new(message))
+      end
+    end
+
+    def validate_build_compatibility(system_description)
+      if !os_object.can_build?(system_description.os_object)
+        message = "Building '#{system_description.os_object.name}' images is " \
+          "not supported on this distribution.\n" \
+          "Check the 'BUILD SUPPORT MATRIX' section in our man page for " \
+          "further information which build targets are supported."
+
+        raise(Machinery::Errors::BuildFailed.new(message))
+      end
+    end
+  end
+
+  def requires_root?
+    true
+  end
+
+  def run_command(*args)
+    if args.last.is_a?(Hash) && args.last[:disable_logging]
+      cheetah_class = Cheetah
+    else
+      cheetah_class = LoggedCheetah
+    end
+    with_c_locale do
+      cheetah_class.run(*args)
+    end
+  end
+
+  # Retrieves files specified in filelist from the local system and raises an
+  # Machinery::Errors::RsyncFailed exception when it's not successful. Destination is
+  # the directory where to put the files.
+  def retrieve_files(filelist, destination)
+    begin
+      LoggedCheetah.run("rsync",  "--chmod=go-rwx", "--files-from=-", "/", destination, :stdout => :capture, :stdin => filelist.join("\n") )
+    rescue Cheetah::ExecutionFailed => e
+      raise Machinery::Errors::RsyncFailed.new(
+      "Could not rsync files from localhost. \n" \
+      "Error: #{e}\n" \
+      "If you lack read permissions on some files you may want to retry as user root or specify\n" \
+      "the fully qualified host name instead of localhost in order to connect as root via ssh."
+    )
+    end
+  end
+
+  # Reads a file from the System. Returns nil if it does not exist.
+  def read_file(file)
+    File.read(file)
+  rescue Errno::ENOENT
+    # File not found, return nil
+    return
+  end
+
+  private
+
+  def with_c_locale(&block)
+    with_env "LC_ALL" => "C", &block
+  end
+
+  def with_env(env)
+    # ENV isn't a Hash, but a weird Hash-like object. Calling #to_hash on it
+    # will copy its items into a newly created Hash instance. This approach
+    # ensures that any modifications of ENV won't affect the stored value.
+    saved_env = ENV.to_hash
+    begin
+      ENV.replace(saved_env.merge(env))
+      yield
+    ensure
+      ENV.replace(saved_env)
+    end
+  end
+
+end

data/lib/logged_cheetah.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2013-2014 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 LoggedCheetah
+  def self.run(*args)
+    command = args.select{|e| e.is_a?(String)}.join(" ")
+    Machinery.logger.info("Running '#{command}'")
+
+    Cheetah.run(*args)
+  end
+end

data/lib/machinery.rb

@@ -0,0 +1,85 @@
+# Copyright (c) 2013-2014 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
+
+require 'ostruct'
+require 'json'
+require "abstract_method"
+require "cheetah"
+require "tmpdir"
+require 'tempfile'
+require "time"
+require "logger"
+require "erb"
+require "yaml"
+require "uri"
+require "gli"
+require "json-schema"
+require "haml"
+require "kramdown"
+
+require_relative 'machinery_logger'
+require_relative 'zypper'
+require_relative 'rpm'
+require_relative 'array'
+require_relative 'object'
+require_relative 'constants'
+require_relative 'system_description'
+require_relative 'system_description_validator'
+require_relative 'version'
+require_relative 'tarball'
+require_relative 'exceptions'
+require_relative 'inspector'
+require_relative 'system'
+require_relative 'local_system'
+require_relative 'remote_system'
+require_relative 'current_user'
+require_relative 'inspect_task'
+require_relative 'inspector'
+require_relative 'build_task'
+require_relative 'kiwi_config'
+require_relative 'renderer'
+require_relative 'show_task'
+require_relative 'compare_task'
+require_relative 'remove_task'
+require_relative 'list_task'
+require_relative 'system_description_store'
+require_relative 'logged_cheetah'
+require_relative 'renderer_helper'
+require_relative 'changed_rpm_files_helper'
+require_relative 'kiwi_export_task'
+require_relative 'helper'
+require_relative 'deploy_task'
+require_relative 'analyze_config_file_diffs_task'
+require_relative 'copy_task'
+require_relative 'scope_mixin'
+require_relative 'os'
+require_relative 'ui'
+require_relative 'validate_task'
+require_relative 'migration'
+require_relative 'upgrade_format_task'
+require_relative 'html'
+require_relative 'generate_html_task'
+require_relative 'hint'
+require_relative 'mountpoints'
+require_relative 'config_base'
+require_relative 'config'
+require_relative 'config_task'
+
+Dir[File.join(Machinery::ROOT, "plugins", "**", "*.rb")].each { |f| require(f) }
+
+# this file needs be loaded last, because it immediately collects the loaded inspectors
+require_relative 'cli'

data/lib/machinery_logger.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2013-2014 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
+
+module Machinery
+  @@logger = nil
+
+  def self.initialize_logger(log_file)
+    # We rotate one old log file of 21 MB
+    if File.exists?(log_file) && File.size(log_file) > 21*1024*1024
+      rotated_file = log_file + ".0"
+      FileUtils.rm(rotated_file) if File.exists?(rotated_file)
+      FileUtils.mv(log_file, rotated_file)
+    end
+
+    if !File.exists?(log_file)
+      dirname = File.dirname(log_file)
+      if !Dir.exists?(dirname)
+        FileUtils.mkdir_p(dirname)
+        File.chmod(0700, dirname)
+      end
+      FileUtils.touch(log_file)
+      FileUtils.chmod(0600, log_file)
+    end
+
+    @@logger = Logger.new(log_file)
+  end
+
+  def self.logger
+    initialize_logger(DEFAULT_LOG_FILE) unless @@logger
+
+    @@logger
+  end
+end

data/lib/migration.rb

@@ -0,0 +1,128 @@
+# Copyright (c) 2013-2014 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
+
+# = SystemDescription Migrations
+#
+# Migrations are used for migrating descriptions with an older format version to
+# the current version. They are defined as subclasses of `Migration` in
+# `schema/migrations`.
+#
+# == Naming schema
+#
+# Migrations need to follow a naming schema defining which format version they
+# are working on. `Migrate1To2` defines a migration which converts a version 1
+# description to a version 2 one, for example.
+#
+# == Defining migrations
+#
+# The migration classes need to define a `migrate` method which does the actual
+# migration. The raw hash of the system description in question is made
+# available as the `@hash` instance variable, the path to the description on
+# disk is given ash the `@path` instance variable.
+#
+# Migrations also need to describe their purpose using the `desc` class method
+# (see example below).
+#
+# *Note*: Migrations do not need to take care of updating the format version
+# attribute in the system description. That is already handled by the base
+# class.
+#
+# Simple example migration which adds a new attribute to the JSON:
+#
+#   class Migrate1To2 < Migration
+#     desc <<-EOT
+#       Add 'foo' element to the system description root.
+#     EOT
+#
+#     def migrate
+#       is_extracted = Dir.exists?(File.join(@path, "config-files"))
+#       @hash["config_files"]["extracted"] = is_extracted
+#     end
+#   end
+class Migration
+  MIGRATIONS_DIR= File.join(Machinery::ROOT, "schema/migrations")
+
+  class <<self
+    attr_reader :migration_desc
+
+    def desc(s)
+      @migration_desc = s
+    end
+
+    def migrate_description(store, description_name)
+      load_migrations
+
+      hash = JSON.parse(store.load_json(description_name))
+      path = store.description_path(description_name)
+
+      current_version = hash["meta"]["format_version"]
+      if !current_version
+        raise Machinery::Errors::SystemDescriptionError.new(
+          "The system description '#{description_name}' was generated by an old " \
+          "version of machinery that is not supported by the upgrade mechanism."
+        )
+      end
+
+      if current_version == SystemDescription::CURRENT_FORMAT_VERSION
+        # Nothing to do here
+        return false
+      end
+
+      (current_version..SystemDescription::CURRENT_FORMAT_VERSION-1).each do |version|
+        next_version = version + 1
+        begin
+          klass = Object.const_get("Migrate#{version}To#{next_version}")
+        rescue NameError
+          return
+        end
+
+        # Make sure that the migration was documented
+        if klass.migration_desc.nil?
+          raise Machinery::Errors::MigrationError.new(
+            "Invalid migration '#{klass}'. It does not specify its purpose using" \
+            " the 'desc' class method."
+          )
+        end
+
+        klass.new(hash, path).migrate
+        hash["meta"]["format_version"] = next_version
+      end
+
+      File.write(store.manifest_path(description_name), JSON.pretty_generate(hash))
+
+      true
+    end
+
+    private
+
+    def load_migrations
+      Dir.glob(File.join(MIGRATIONS_DIR, "*")).each do |migration|
+        require migration
+      end
+    end
+  end
+
+  attr_accessor :hash
+  attr_accessor :path
+
+  abstract_method :migrate
+
+  def initialize(hash, path)
+    @hash = hash
+    @path = path
+  end
+end