pennyworth-tool 0.0.1

data/lib/pennyworth/host_config.rb

@@ -0,0 +1,86 @@
+# Copyright (c) 2013-2015 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 Pennyworth
+  class HostConfig
+    attr_reader :config_file, :lock_server_address
+
+    def self.for_directory(config_dir)
+      HostConfig.new(File.join(config_dir, "hosts.yaml"))
+    end
+
+    def initialize(config_file)
+      @config_file = File.expand_path(config_file)
+    end
+
+    def parse(yaml_string)
+      yaml = YAML.load(yaml_string)
+      if !yaml
+        raise HostFileError.new("Could not parse YAML in file '#{config_file}'")
+      end
+
+      if yaml["include"]
+        begin
+          open(yaml["include"], "rb") do |u|
+            parse(u.read)
+          end
+        rescue OpenURI::HTTPError, Errno::ENOENT
+          raise HostFileError.new("Unable to include '#{yaml["include"]}'")
+        end
+      end
+
+      if yaml["hosts"]
+        if !@hosts
+          @hosts = yaml["hosts"]
+        else
+          yaml["hosts"].each do |key, value|
+            @hosts[key] = value
+          end
+        end
+      end
+
+      if yaml["lock_server_address"]
+        @lock_server_address = yaml["lock_server_address"]
+      end
+    end
+
+    def read
+      parse(File.read(config_file))
+    end
+
+    def hosts
+      @hosts.keys
+    end
+
+    def host(host_name)
+      @hosts[host_name]
+    end
+
+    def setup(url)
+      if File.exist?(config_file)
+        raise HostFileError.new("Config file '#{config_file}' already exists." +
+          " Canceling setup.")
+      end
+
+      FileUtils.mkdir_p(File.dirname(config_file))
+      File.open(config_file, "w") do |f|
+        f.puts("---")
+        f.puts("include: #{url}")
+      end
+    end
+  end
+end

data/lib/pennyworth/host_runner.rb

@@ -0,0 +1,133 @@
+# 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 Pennyworth
+  class HostRunner < Runner
+    def initialize(host_name, host_config, username = "root")
+      @host_name = host_name
+      @username = username
+      config_file = host_config.config_file
+
+      host = host_config.host(host_name)
+      if !host
+        raise InvalidHostError.new("Host '#{host_name}' is not defined in '#{config_file}'")
+      end
+
+      @ip = host["address"]
+      @base_snapshot_id = host["base_snapshot_id"]
+      if !@ip
+        raise InvalidHostError.new(
+          "Missing 'address' field for host '#{host_name}' in '#{config_file}'"
+        )
+      end
+      if should_cleanup && !@base_snapshot_id
+        raise InvalidHostError.new(
+          "Missing 'base_snapshot_id' field for host '#{host_name}' in '#{config_file}'"
+        )
+      end
+
+      @command_runner = RemoteCommandRunner.new(@ip, @username)
+      @locker = LockService.new(host_config.lock_server_address)
+    end
+
+    def start
+      if !@locker.request_lock(@host_name)
+        raise LockError.new("Host '#{@host_name}' already locked")
+      end
+
+      connect
+
+      if should_cleanup
+        check_cleanup_capabilities
+        install_cleanup_interrupt_handler
+      end
+
+      @ip
+    end
+
+    def cleanup
+      return if @cleaned_up || !@connected
+
+      remote = RemoteCommandRunner.new(@ip, @username)
+      remote.run "snapper", "create", "-c", "number", "--pre-number", @base_snapshot_id.to_s,
+        "--description", "pennyworth_snapshot"
+      remote.run "snapper", "cleanup", "number"
+      remote.run "snapper", "undochange", "#{@base_snapshot_id}..0"
+      remote.run "bash", "-c", "reboot &"
+      @cleaned_up = true
+    end
+
+    def stop
+      if should_cleanup
+        cleanup
+        uninstall_cleanup_interrupt_handler
+      end
+
+      @locker.release_lock(@host_name)
+    end
+
+    private
+
+    # Makes sure the we can connect to the remote system as root (without a
+    # password or passphrase)
+    def connect
+      Cheetah.run "ssh", "-q", "-o", "BatchMode=yes", "root@#{@ip}"
+    rescue Cheetah::ExecutionFailed
+      raise SshConnectionFailed.new(
+        "Could not establish SSH connection to host '#{@ip}'. Please make sure that " \
+        "you can connect non-interactively as root, e.g. using ssh-agent.\n\n" \
+        "To copy your default ssh key to the machine run:\n" \
+        "ssh-copy-id root@#{@ip}"
+      )
+    end
+
+    def check_cleanup_capabilities
+      begin
+        RemoteCommandRunner.new(@ip, @username).run "snapper", "--help"
+      rescue Cheetah::ExecutionFailed
+        raise CommandNotFoundError.new(
+          "Snapper needs to be installed on the test system '#{@ip}' for the automatic cleanup."
+        )
+      end
+      @connected = true
+    end
+
+    def should_cleanup
+      !ENV["SKIP_HOST_CLEANUP"]
+    end
+
+    def install_cleanup_interrupt_handler
+      @old_interrupt_handler = trap("INT") do
+        trap("INT") do
+          exit!(1)
+        end
+
+        puts "RSpec is shutting down. Resetting test host '#{@ip}'." \
+          "Interrupt again to force exit."
+        cleanup
+        puts "Done."
+
+        @old_interrupt_handler.call
+      end
+    end
+
+    def uninstall_cleanup_interrupt_handler
+      # Restore old interrupt handler
+      trap("INT", @old_interrupt_handler) if defined?(@old_interrupt_handler)
+    end
+  end
+end

data/lib/pennyworth/image_runner.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
+
+module Pennyworth
+  class ImageRunner < Runner
+    DOMAIN_TEMPLATE = File.join(File.dirname(__FILE__) + "/../../files/image_test-template.xml")
+
+    attr_accessor :name
+
+    def initialize(image, username)
+      @image = image
+      @name = File.basename(image)
+      @username = username
+
+      @connection = ::Libvirt::open("qemu:///system")
+    end
+
+    def start
+      cleanup
+
+      ip = start_built_image
+      @command_runner = RemoteCommandRunner.new(ip, @username)
+
+      ip
+    end
+
+    def stop
+      system = @connection.lookup_domain_by_name(@name)
+      system.destroy
+    end
+
+    def cleanup_directory(_dir)
+      # The machine will be reset anyway after the tests, so this is is a NOP
+    end
+
+    private
+
+    def cleanup
+      system = @connection.lookup_domain_by_name(@name)
+      system.destroy
+    rescue
+    end
+
+    # Creates a transient kvm domain from the predefined image_test-domain.xml
+    # file and returns the ip address for further interaction.
+    def start_built_image
+      domain_config = File.read(DOMAIN_TEMPLATE)
+      domain_config.gsub!("@@image@@", @image)
+      domain_config.gsub!("@@name@@", @name)
+
+      @connection.create_domain_xml(domain_config)
+      system = @connection.lookup_domain_by_name(@name)
+
+      domain_xml = Nokogiri::XML(system.xml_desc)
+      mac = domain_xml.xpath("//domain/devices/interface/mac").attr("address")
+      ip_address = nil
+
+      # Loop until the VM has got an IP address we can return
+      lease_file = "/var/lib/libvirt/dnsmasq/default.leases"
+      300.times do
+        match = File.readlines(lease_file).grep(/#{mac}/).first
+        if match
+          ip_address = match.split[2]
+          break
+        end
+
+        sleep 1
+      end
+
+      ip_address
+    end
+  end
+
+
+end

data/lib/pennyworth/libvirt.rb

@@ -0,0 +1,93 @@
+# 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 Pennyworth
+  class Libvirt
+    LIBVIRT_NET_NAME  = "default"
+    LIBVIRT_POOL_NAME = "default"
+
+    class << self
+      def ensure_libvirt_env_started
+        # The check here is unnecessary for technical reasons ("sysctl start" does
+        # not fail if the service is already running), but it avoids an unnecessary
+        # sudo password prompt.
+        libvirtd_start unless libvirtd_active?
+
+        libvirt_net_start unless libvirt_net_active?
+
+        # As default pool is not always available but gets sometimes created by
+        # tools like virt-manager, we need to create it ourself if it does not yet
+        # exist.
+        libvirt_pool_create unless libvirt_pool_exists?
+      end
+
+      private
+
+      def libvirtd_start
+        Cheetah.run "sudo", "systemctl", "start", "libvirtd"
+
+        sleep 0.1 until File.exists?("/var/run/libvirt/libvirt-sock")
+      end
+
+      def libvirtd_active?
+        output = Cheetah.run "systemctl", "show", "--property", "ActiveState", "libvirtd", :stdout => :capture
+
+        output == "ActiveState=active"
+      end
+
+      def libvirt_net_start
+        Cheetah.run "virsh", "-c", "qemu:///system", "net-start", LIBVIRT_NET_NAME
+      end
+
+      def libvirt_net_active?
+        output = with_c_locale do
+          Cheetah.run "virsh", "-c", "qemu:///system", "net-list", "--all", :stdout => :capture
+        end
+
+        # The output looks like this:
+        #
+        #    Name                 State      Autostart     Persistent
+        #   ----------------------------------------------------------
+        #    default              active     no            yes
+        #    vagrant0             active     yes           yes
+        #
+        output.split("\n")[2..-1].find do |line|
+          line =~ /^\s*#{LIBVIRT_NET_NAME}\s+active/
+        end
+      end
+
+      def libvirt_pool_create
+        pool_config_file = File.dirname(__FILE__) + "/../../files/pool-default.xml"
+        Cheetah.run "virsh", "-c", "qemu:///system", "pool-create", pool_config_file
+      end
+
+      def libvirt_pool_exists?
+        output = with_c_locale do
+          Cheetah.run "virsh", "-c", "qemu:///system", "pool-list", "--all", :stdout => :capture
+        end
+
+        # The output looks like this:
+        #
+        #    Name                 State      Autostart
+        #   -----------------------------------------
+        #    default              active     no
+        #
+        output.split("\n")[2..-1].detect { |line| line =~ /^\s*#{LIBVIRT_POOL_NAME}/ }
+      end
+    end
+  end
+end

data/lib/pennyworth/local_command_runner.rb

@@ -0,0 +1,77 @@
+# 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 Pennyworth
+  # LocalCommandRunner is used for executing commands on the local machine
+  class LocalCommandRunner
+    # Initialize the command runner
+    #
+    # +opts+:: Options to modify how and which the commands are run.
+    #
+    #          Available options:
+    #          [env]:: Hash of environment options to set for the command, e.g.
+    #            {
+    #              "MACHINERY_DIR" => "/tmp/machinery"
+    #            }
+    def initialize(opts = {})
+      @env = opts[:env] || {}
+    end
+
+    def run(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      with_env(@env) do
+        Cheetah.run(
+          "bash", "-c", *args, options
+        )
+      end
+    rescue Cheetah::ExecutionFailed => e
+      raise ExecutionFailed.new(e)
+    end
+
+    # Copy a local file to the remote system.
+    #
+    # +source+:: Path to the local file
+    # +destination+:: Path to the remote file or directory. If +destination+ is a
+    #                 path, the same filename as +source+ will be used.
+    # +opts+:: Options to modify the attributes of the remote file.
+    #
+    #          Available options:
+    #          [owner]:: Owner of the file, e.g. "tux"
+    #          [group]:: Group of the file, e.g. "users"
+    #          [mode]:: Mode of the file, e.g. "600"
+    def inject_file(source, destination, opts = {})
+      # Append filename (taken from +source+) to destination if it is a path, so
+      # that +destination+ is always the full target path including the filename.
+      destination = File.join(destination, File.basename(source)) if File.directory?(destination)
+
+      FileUtils.cp(source, destination)
+      FileUtils.chown(opts[:owner], opts[:group], destination)
+      FileUtils.chmod(opts[:mode], destination) if opts[:mode]
+    end
+
+    def extract_file(source, destination)
+      FileUtils.cp(source, destination)
+    end
+
+    def inject_directory(source, destination, opts = {})
+      FileUtils.mkdir_p(destination)
+      FileUtils.cp_r(source, destination)
+      FileUtils.chown_R(opts[:owner], opts[:group], destination)
+    end
+  end
+end