machinery-tool 1.0.2

data/lib/compare_task.rb

@@ -0,0 +1,68 @@
+# 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 CompareTask
+  def compare(description1, description2, scopes, options = {})
+    output = render_comparison(description1, description2, scopes, options)
+
+    Machinery::Ui.print_output(output, :no_pager => options[:no_pager])
+  end
+
+  def render_comparison(description1, description2, scopes, options = {})
+    output = ""
+    identical = true
+    common_scopes = false
+    scopes.each do |scope|
+      if description1[scope] && description2[scope]
+        comparison = description1[scope].compare_with(description2[scope])
+
+        partial_description1 = SystemDescription.new(
+          description1.name,
+          scope => comparison[0]
+        )
+
+        partial_description2 = SystemDescription.new(
+          description2.name,
+          scope => comparison[1]
+        )
+
+        partial_description_common = SystemDescription.new("common", scope => comparison[2])
+
+        output += Renderer.for(scope).render_comparison(
+          partial_description1,
+          partial_description2,
+          partial_description_common,
+          options
+        )
+
+        if partial_description1[scope] || partial_description2[scope]
+          identical = false
+        end
+        common_scopes = true
+      else
+        output += Renderer.for(scope).render_comparison_missing_scope(
+          description1, description2
+        )
+        identical = false if description1[scope] || description2[scope]
+      end
+    end
+
+    output = "Compared descriptions are identical.\n" + output if identical && common_scopes
+
+    output
+  end
+end

data/lib/config.rb

@@ -0,0 +1,33 @@
+# 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
+
+
+# This file contains the defaults for machinery's configuration.
+# They can be overwritten by the config file.
+
+module Machinery
+  class Config < ConfigBase
+    def define_entries
+      default_config_file(Machinery::DEFAULT_CONFIG_FILE)
+
+      entry("hints",
+        default:     true,
+        description: "Show hints about usage of Machinery in the context of the commands ran by the user"
+      )
+    end
+  end
+end

data/lib/config_base.rb

@@ -0,0 +1,117 @@
+# 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
+
+
+# The defaults for machinery's configuration are defined in
+# the file 'machinery_config.rb'.
+
+class ConfigBase
+  def initialize
+    @entries = {}
+    @file = ""
+    define_entries
+    apply_custom_config(@file) if File.exist?(@file)
+  end
+
+  def default_config_file(file)
+    @file = file
+  end
+
+  def entry(key, parameters = {})
+    @entries[key] = { value: parameters[:default], description: parameters[:description] }
+     create_method(key.to_sym) { get(key) }
+     create_method("#{key}=".to_sym) { |value| set(key, value) }
+  end
+
+  def define_entries
+    raise NotImplementedError.new("No config entries defined for #{self.class}")
+  end
+
+  def each(&block)
+    @entries.each(&block)
+  end
+
+  def get(key)
+    ensure_config_exists(key)
+    @entries[key][:value]
+  end
+
+  def set(key, value, options = {auto_save: true} )
+    ensure_config_exists(key)
+
+    # Check if data type is correct. true and false are not of the same type which makes the check complex
+    if value.class != @entries[key][:value].class &&
+      ! ( ( value == true || value == false ) && ( @entries[key][:value].class == TrueClass || @entries[key][:value].class == FalseClass ) )
+      raise Machinery::Errors::MachineryError.new("The value \"#{value}\" for configuration key \"#{key}\" is of an invalid data type.")
+    end
+
+    @entries[key][:value] = value
+
+    save if options[:auto_save]
+  end
+
+
+  private
+
+  def save
+    config_table_stripped = {}
+    @entries.each do |key,value|
+      config_table_stripped[key] = value[:value]
+    end
+
+    FileUtils.mkdir_p(Machinery::DEFAULT_CONFIG_DIR)
+
+    begin
+      File.write(@file, config_table_stripped.to_yaml)
+      Machinery.logger.info("Wrote configuration file \"#{@file}\".")
+    rescue => e
+      raise Machinery::Errors::MachineryError.new("Could not write configuration file \"#{@file}\": #{e}.")
+    end
+  end
+
+  def apply_custom_config(file)
+    content = read_config_file(file) || []
+
+    content.each do |key, value|
+      begin
+        set(key, value, :auto_save => false )
+      rescue => e
+        Machinery::Ui.warn "Warning: The machinery config file \"#{file}\" contains an invalid entry \"#{key}\":\n#{e}"
+      end
+    end
+  end
+
+  def read_config_file(file)
+    begin
+      content = YAML.load_file(file)
+      Machinery.logger.info("Read configuration file \"#{file}\".")
+    rescue => e
+      Machinery::Ui.warn "Warning: Cannot parse machinery config file \"#{@file}\":\n#{e}"
+    end
+    content
+  end
+
+  def ensure_config_exists(key)
+    if @entries[key].nil?
+      raise Machinery::Errors::UnknownConfig.new("Unknown configuration key: #{key}")
+    end
+  end
+
+  def create_method(name, &block)
+    self.class.send(:define_method, name, &block)
+  end
+end

data/lib/config_task.rb

@@ -0,0 +1,56 @@
+# 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 ConfigTask
+  def initialize(config = Machinery::Config.new)
+    @config = config
+  end
+
+  def config(key = nil, value_string = nil)
+    if !key
+      # show all config entries
+      @config.each do |key, value|
+        Machinery::Ui.puts "#{key} = #{value[:value]} (#{value[:description]})"
+      end
+    elsif !value_string
+      # show one specific config entry
+      Machinery::Ui.puts "#{key} = #{@config.get(key)}"
+    else
+      # set one specific config entry
+      @config.set(key, parse_value_string(key, value_string))
+      Machinery::Ui.puts "#{key} = #{@config.get(key)}"
+    end
+  end
+
+  def parse_value_string(key, value_string)
+    current_value = @config.get(key)
+
+    if current_value == true || current_value == false
+      if value_string == "true" || value_string == "on"
+        return true
+      elsif value_string == "false" || value_string == "off"
+        return false
+      else
+        raise Machinery::Errors::MachineryError.new("The value '#{value_string}' is not valid for key '#{key}'.")
+      end
+    elsif current_value.kind_of?(Integer)
+      return value_string.to_i
+    else
+      return value_string
+    end
+  end
+end

data/lib/constants.rb

@@ -0,0 +1,24 @@
+# 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
+  ROOT = File.expand_path("..", File.dirname(__FILE__))
+  DEFAULT_CONFIG_DIR = File.join(ENV['HOME'], ".machinery")
+  DEFAULT_LOG_FILE = File.join(DEFAULT_CONFIG_DIR, "machinery.log")
+  DEFAULT_CONFIG_FILE = File.join(DEFAULT_CONFIG_DIR, "machinery.config")
+  IMAGE_META_DATA_FILE = "machinery.meta"
+end

data/lib/copy_task.rb

@@ -0,0 +1,22 @@
+# 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 CopyTask
+  def copy(store, from, to)
+    store.copy(from, to)
+  end
+end

data/lib/current_user.rb

@@ -0,0 +1,23 @@
+# 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
+
+# Represents the user under which Machinery is running.
+class CurrentUser
+  def is_root?
+    Process.euid == 0
+  end
+end

data/lib/deploy_task.rb

@@ -0,0 +1,89 @@
+# 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 DeployTask
+  def deploy(description, cloud_config, options = {})
+    LocalSystem.validate_existence_of_package("python-glanceclient")
+    if !File.exists?(cloud_config)
+      raise(Machinery::Errors::DeployFailed,
+        "The cloud config file '#{cloud_config}' could not be found."
+      )
+    end
+
+    if options[:image_dir]
+      if !Dir.exists?(options[:image_dir])
+        raise(Machinery::Errors::DeployFailed,
+          "The image directory does not exist."
+        )
+      end
+      image_dir = options[:image_dir]
+    else
+      image_dir = Dir.mktmpdir("#{description.name}-image", "/tmp")
+      is_temporary = true
+      task = BuildTask.new
+      task.build(description, image_dir)
+    end
+
+    meta_data = load_meta_data(image_dir)
+    image_file = File.join(image_dir, meta_data[:image_file])
+
+    if meta_data[:description] != description.name
+      raise(Machinery::Errors::MissingRequirement,
+        "The image file '#{image_file}' was not build from the provided system description."
+      )
+    end
+
+    if !File.exists?(image_file)
+      raise(Machinery::Errors::DeployFailed,
+        "The image file '#{image_file}' does not exist."
+      )
+    end
+
+    command = "/usr/bin/glance"
+    command << " --insecure" if options[:insecure]
+    command << " image-create"
+    command << " --name=#{options[:image_name] || description.name}"
+    command << " --disk-format=qcow2 --container-format=bare"
+    command << " --file=#{Shellwords.escape(image_file)}"
+
+    system "sh -c '. #{Shellwords.escape(cloud_config)} && #{command}'"
+
+    if is_temporary && image_dir.start_with?("/tmp/")
+      FileUtils.rm_rf(image_dir)
+    end
+  end
+
+  private
+
+  def load_meta_data(meta_dir)
+      meta_file = File.join(meta_dir, Machinery::IMAGE_META_DATA_FILE)
+      if !File.exists?(meta_file)
+        raise(Machinery::Errors::DeployFailed,
+          "The meta data file '#{meta_file}' could not be found."
+        )
+      end
+
+      meta_data = YAML.load_file(meta_file)
+
+      if !meta_data[:image_file] || !meta_data[:description]
+        raise(Machinery::Errors::DeployFailed,
+          "The meta data file '#{meta_file}' is broken."
+        )
+      end
+      meta_data
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,113 @@
+# 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
+  module Errors
+    class IncompatibleHost < StandardError; end
+
+    # Superclass for all "expected" errors in Machinery.
+    # "Expected" errors are errors which are caused by the environment or input
+    # data and are not caused by bugs in the machinery codebase.
+    #
+    # Those errors will be handled specially by the machinery tool, e.g. by not
+    # showing a backtrace.
+    class MachineryError < StandardError; end
+
+    class UnknownScope < MachineryError; end
+    class UnknownOs < MachineryError; end
+    class InvalidPager < MachineryError; end
+    class InvalidCommandLine < MachineryError; end
+
+    class MissingRequirement < MachineryError; end
+
+    class SystemDescriptionError < MachineryError; end
+    class SystemDescriptionNotFound < SystemDescriptionError; end
+
+    class SystemDescriptionIncompatible < SystemDescriptionError
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def to_s
+        "The system description '#{@name}' has an incompatible data " \
+        "format and can not be read.\n" \
+        "Try '#{$0} upgrade-format #{name}' to upgrade it to the current version.\n"
+      end
+    end
+
+    class MissingExtractedFiles < SystemDescriptionError
+      def initialize(description, scopes)
+        @description = description
+        @scopes = scopes
+      end
+
+      def to_s
+        meta = @description[@scopes.first].meta
+        hostname = @scopes.map do |s|
+          @description[s].meta.hostname if @description[s].meta
+        end.compact.first || "<HOSTNAME>"
+        formatted_scopes = Machinery::Ui.internal_scope_list_to_string(@scopes)
+
+        cmd = "#{$0} inspect --extract-files --scope=#{formatted_scopes}"
+        cmd += " --name='#{@description.name}'" if hostname != @description.name
+        cmd += " #{hostname}"
+
+        if @scopes.count > 1
+          output = "The following scopes '#{formatted_scopes}' are part of the system description"
+        else
+          output = "The scope '#{formatted_scopes}' is part of the system description"
+        end
+        output += " but the corresponding files weren't extracted during inspection.\n" \
+        "The files are required to continue with this command." \
+        " Run `#{cmd}` to extract them."
+      end
+    end
+
+    class SystemDescriptionValidationFailed < SystemDescriptionError
+      attr_reader :errors
+      attr_accessor :header
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def to_s
+        message = ""
+        if @header
+          message += header + "\n\n"
+        end
+        message += @errors.join("\n")
+        message += "\n"
+        message
+      end
+    end
+
+    class MigrationError < MachineryError; end
+
+    class BuildFailed < MachineryError; end
+    class DeployFailed < MachineryError; end
+    class InspectionFailed < MachineryError; end
+    class KiwiExportFailed < MachineryError; end
+
+    class SshConnectionFailed < MachineryError; end
+    class RsyncFailed < MachineryError; end
+    class OpenInBrowserFailed < MachineryError; end
+    class UnknownConfig < MachineryError; end
+  end
+end