machinery-tool 1.0.2

data/lib/mountpoints.rb

@@ -0,0 +1,72 @@
+# 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
+
+# MountPoints represents the currently mounted file systems of the
+# inspected system.
+#
+# all()     returns an array containing the mount points of all mounted
+#           file systems
+#
+# remote()  returns an array containing the mount points of all mounted
+#           file systems that are remote file systems (e.g. nfs, cifs)
+#
+# local()   returns an array containing the mount points of all mounted
+#           local file systems with permanent data (e.g. ext3, btrfs, xfs)
+
+
+class MountPoints
+  attr_reader :mounts
+  REMOTE_FILE_SYSTEMS = ["autofs", "cifs", "nfs", "nfs4"]
+  LOCAL_FILE_SYSTEMS  = ["ext2", "ext3", "ext4", "reiserfs", "btrfs", "vfat", "xfs", "jfs"]
+  def initialize(system)
+    @mounts = parse_mounts(system.read_file("/proc/mounts"))
+  end
+
+  def remote
+    @mounts.select { |fs_file,fs_vfstype| remote_fs?(fs_vfstype) }.keys
+  end
+
+  def local
+    @mounts.select { |fs_file,fs_vfstype| local_fs?(fs_vfstype) }.keys
+  end
+
+  def all
+    @mounts.keys
+  end
+
+
+  private
+
+  def parse_mounts(proc_mounts)
+    # /proc/mounts can contain multiple lines for the same fs_file
+    # we store the latest entry only, because that's the relevant one
+    mounts = Hash.new
+    proc_mounts.each_line do |line|
+      fs_spec, fs_file, fs_vfstype, fs_mntops, fs_freq, fs_passno = line.split(' ')
+      mounts[fs_file] = fs_vfstype
+    end
+    mounts
+  end
+
+  def remote_fs?(fs)
+    REMOTE_FILE_SYSTEMS.include?(fs)
+  end
+
+  def local_fs?(fs)
+    LOCAL_FILE_SYSTEMS.include?(fs)
+  end
+end

data/lib/object.rb

@@ -0,0 +1,138 @@
+# 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
+  class Object
+    class << self
+      def has_property(name, options)
+        @property_classes ||= {}
+        @property_classes[name.to_sym] = options[:class]
+      end
+
+      def from_json(json)
+        return nil unless json
+
+        entries = json.map do |key, value|
+          value_converted = if @property_classes && @property_classes[key.to_sym]
+            @property_classes[key.to_sym].from_json(value)
+          else
+            case value
+              when ::Array
+                Machinery::Array.from_json(value)
+              when Hash
+                Machinery::Object.from_json(value)
+              else
+                value
+            end
+          end
+
+          [key, value_converted]
+        end
+
+        new(Hash[entries])
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(attrs = {})
+      @attributes = attrs.inject({}) do |attributes, (key, value)|
+        key = key.to_sym if key.respond_to?(:to_sym)
+
+        attributes[key] = value
+        attributes
+      end
+    end
+
+    def ==(other)
+      self.class == other.class && @attributes == other.attributes
+    end
+
+    # Various Array operators such as "-" and "&" use #eql? and #hash to compare
+    # array elements, which is why we need to make sure they work properly.
+
+    alias eql? ==
+
+    def hash
+      @attributes.hash
+    end
+
+    def [](key)
+      @attributes[key.to_sym]
+    end
+
+    def []=(key, value)
+      @attributes[key.to_sym] = value
+    end
+
+    def empty?
+      @attributes.keys.empty?
+    end
+
+    def method_missing(name, *args, &block)
+      if name.to_s.end_with?("=")
+        if args.size != 1
+          raise ArgumentError, "wrong number of arguments (#{args.size} for 1)"
+        end
+
+        @attributes[name.to_s[0..-2].to_sym] = args.first
+      else
+        if @attributes.has_key?(name)
+          if !args.empty?
+            raise ArgumentError, "wrong number of arguments (#{args.size} for 0)"
+          end
+
+          @attributes[name]
+        else
+          nil
+        end
+      end
+    end
+
+    def respond_to?(name, include_all = false)
+      if name.to_s.end_with?("=")
+        true
+      else
+        @attributes.has_key?(name) || super(name, include_all)
+      end
+    end
+
+    def initialize_copy(orig)
+      super
+      @attributes = @attributes.dup
+    end
+
+    def as_json
+      entries = @attributes.map do |key, value|
+        case value
+        when Machinery::Array, Machinery::Object
+          value_json = value.as_json
+        else
+          value_json = value
+        end
+
+        [key, value_json]
+      end
+
+      Hash[entries]
+    end
+
+    def compare_with(other)
+      self == other ? [nil, nil, self] : [self, other, nil]
+    end
+  end
+end

data/lib/os.rb

@@ -0,0 +1,78 @@
+# 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 Os
+  attr_reader :can_build, :name
+
+  def self.descendants
+    ObjectSpace.each_object(::Class).select { |klass| klass < self }
+  end
+
+  def self.for(os_name)
+    descendants.each do |os_class|
+      os_object = os_class.new
+      if os_name == os_object.name
+        return os_object
+      end
+    end
+    raise Machinery::Errors::UnknownOs.new("Unknown OS: '#{os_name}'")
+  end
+
+  def can_build?(os)
+    if os.is_a?(Class)
+      return @can_build.include?(os)
+    else
+      return @can_build.include?(os.class)
+    end
+  end
+
+  def module_required_by_package(package)
+    if @module_required_by_package
+      return @module_required_by_package[package]
+    end
+  end
+
+  def can_run_machinery?
+    @can_run_machinery
+  end
+end
+
+class OsSles11 < Os
+  def initialize
+    @can_build = []
+    @name = "SUSE Linux Enterprise Server 11"
+  end
+end
+
+class OsSles12 < Os
+  def initialize
+    @can_build = [OsSles12]
+    @name = "SUSE Linux Enterprise Server 12"
+    @module_required_by_package = {
+      "python-glanceclient" => "Public Cloud Module"
+    }
+    @can_run_machinery = true
+  end
+end
+
+class OsOpenSuse13_1 < Os
+  def initialize
+    @can_build = [OsSles11, OsOpenSuse13_1]
+    @name = "openSUSE 13.1 (Bottle)"
+    @can_run_machinery = true
+  end
+end

data/lib/remote_system.rb

@@ -0,0 +1,114 @@
+# 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 RemoteSystem < System
+  attr_accessor :host
+
+  def initialize(host)
+    @host = host
+
+    connect
+  end
+
+  def requires_root?
+    false
+  end
+
+  def run_command(*args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+
+    # There are three valid ways how to call Cheetah.run, whose interface this
+    # method mimics. The following code ensures that the "commands" variable
+    # consistently (in all three cases) contains an array of arrays specifying
+    # commands and their arguments.
+    #
+    # See comment in Cheetah.build_commands for more detailed explanation:
+    #
+    #   https://github.com/openSUSE/cheetah/blob/0cd3f88c1210305e87dfc4852bb83040e82d783f/lib/cheetah.rb#L395
+    #
+    commands = args.all? { |a| a.is_a?(Array) } ? args : [args]
+
+    # When ssh executes commands, it passes them through shell expansion. For
+    # example, compare
+    #
+    #   $ echo '$HOME'
+    #   $HOME
+    #
+    # with
+    #
+    #   $ ssh localhost echo '$HOME'
+    #   /home/dmajda
+    #
+    # To mitigate that and maintain usual Cheetah semantics, we need to protect
+    # the command and its arguments using another layer of escaping.
+    escaped_commands = commands.map do |command|
+      command.map { |c| Shellwords.escape(c) }
+    end
+
+    # Arrange the commands in a way that allows piped commands trough ssh.
+    piped_args = escaped_commands[0..-2].flat_map do |command|
+      [*command, "|"]
+    end + escaped_commands.last
+
+    if options[:disable_logging]
+      cheetah_class = Cheetah
+    else
+      cheetah_class = LoggedCheetah
+    end
+
+    cheetah_class.run("ssh", "root@#{host}", "LC_ALL=C", *piped_args, options)
+  end
+
+  # Tries to connect to the remote system as root (without a password or passphrase)
+  # and raises an Machinery::Errors::SshConnectionFailed exception when it's not successful.
+  def connect
+    LoggedCheetah.run "ssh", "-q", "-o", "BatchMode=yes", "root@#{host}"
+  rescue Cheetah::ExecutionFailed
+    raise Machinery::Errors::SshConnectionFailed.new(
+      "Could not establish SSH connection to host '#{host}'. Please make sure that " \
+      "you can connect non-interactively as root, e.g. using ssh-agent."
+    )
+  end
+
+
+  # Retrieves files specified in filelist from the remote 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)
+    source="root@#{host}:/"
+    begin
+      LoggedCheetah.run("rsync", "-e", "ssh", "--chmod=go-rwx", "--files-from=-", source, destination, :stdout => :capture, :stdin => filelist.join("\n") )
+    rescue Cheetah::ExecutionFailed  => e
+      raise Machinery::Errors::RsyncFailed.new(
+      "Could not rsync files from host '#{host}'.\n" \
+      "Error: #{e}"
+    )
+    end
+  end
+
+  # Reads a file from the System. Returns nil if it does not exist.
+  def read_file(file)
+    run_command("cat", file, stdout: :capture)
+  rescue Cheetah::ExecutionFailed => e
+    if e.status.exitstatus == 1
+      # File not found, return nil
+      return
+    else
+      raise
+    end
+  end
+end

data/lib/remove_task.rb

@@ -0,0 +1,43 @@
+# 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 RemoveTask
+  def remove(store, name, options = {})
+    if !options[:all] && !store.list.include?(name)
+        raise Machinery::Errors::SystemDescriptionNotFound.new(
+          "System description \"#{name}\" does not exist."
+        )
+    end
+
+    if options[:all]
+      removed_descriptions = store.list
+      removed_descriptions.each do |name|
+        store.remove(name)
+      end
+    else
+      store.remove(name)
+    end
+
+    if options[:verbose]
+      if options[:all]
+        Machinery::Ui.puts "Removed #{removed_descriptions.length} system descriptions successfully."
+      else
+        Machinery::Ui.puts "System description \"#{name}\" successfully removed."
+      end
+    end
+  end
+end