vmit 0.0.3 → 0.0.3.99

data/lib/vmit/unattended_install.rb

@@ -0,0 +1,43 @@
+#
+# Copyright (C) 2013 Duncan Mac-Vicar P. <dmacvicar@suse.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'erb'
+require 'abstract_method'
+require 'confstruct'
+
+module Vmit
+
+  class UnattendedInstall
+
+    attr_accessor :config
+    attr_accessor :location
+
+    #abstract_method :execute_autoinstall
+
+    def initialize(location)
+      @config = Confstruct::Configuration.new({
+        :packages => []
+      })
+      @location = location
+    end
+
+  end
+
+end

data/lib/vmit/utils.rb

@@ -19,7 +19,6 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 require 'rubygems'
-require 'open4'
 require 'progressbar'
 require 'digest/sha1'
 
@@ -46,6 +45,57 @@ module Vmit
       ("%02x"%((rand 64).to_i*4|2))+(0..4).inject(""){|s,x|s+":%02x"%(rand 256).to_i}
     end
 
+    def self.arch
+      Cheetah.run('arch', :stdout => :capture).strip
+    end
+
+    # @returns [Boolean] wether the port is open
+    # @note uses nmap
+    def self.port_open?(host, port)
+      begin
+        # use logger => nil until a sane way of handling
+        # non zero return codes is implemented in cheetah
+        # https://github.com/openSUSE/cheetah/pull/19
+        Cheetah.run(['nmap', host, '-p',
+                      port.to_s, '-sV', '--version-all', '-oG', '-'],
+                    ['grep', '-iq', "#{port}/open"], :logger => nil)
+        true
+      rescue Cheetah::ExecutionFailed
+        false
+      end
+    end
+
+    # Waits unntil that host port is open
+    #
+    # @example
+    #   Vmit::Utils.wait_for_port('192.168.0.1', 22) do
+    #     # do something
+    #   end
+    #
+    #
+    def self.wait_for_port(host, port, &block)
+      chars = %w{ | / - \\ }
+      if block
+        thread = Thread.new(&block)
+        thread.abort_on_exception = true
+      end
+
+      Vmit.logger.info "Waiting for machine port #{port}..."
+      while true
+        print chars[0]
+
+        if port_open?(host, port)
+          Thread.kill(thread) if thread
+          break
+        end
+        break if thread && !thread.alive?
+        sleep(1)
+        print "\b"
+        chars.push chars.shift
+      end
+      puts
+    end
+
     def self.uname(bzimage)
       offset = 0
       File.open(bzimage) do |f|

data/lib/vmit/version.rb

@@ -19,5 +19,5 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Vmit
-  VERSION = "0.0.3"
+  VERSION = "0.0.3.99"
 end

data/lib/vmit/workspace.rb

@@ -0,0 +1,181 @@
+#
+# Copyright (C) 2013 Duncan Mac-Vicar P. <dmacvicar@suse.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'cheetah'
+require 'drb'
+require 'fileutils'
+require 'stringio'
+require 'yaml'
+require 'confstruct'
+# confstruct uses autoload, Deferred is
+# not defined until you use Configuration
+require 'confstruct/configuration'
+
+require 'vmit/utils'
+
+module Vmit
+
+  class Workspace
+
+    attr_accessor :work_dir
+
+    VM_GLOBAL_DEFAULTS = {
+      :memory => '1G',
+      :kernel_cmdline => [],
+      :virtio => true
+    }
+    SWITCH = 'br0'
+
+    def self.from_pwd
+      Vmit::Workspace.new(File.expand_path(Dir.pwd))
+    end
+
+    def name
+      work_dir.downcase.gsub(/[^a-z\s]/, '_')
+    end
+
+    # Accessor to current options
+    def [](key)
+      @config[key]
+    end
+
+    def config_file
+      File.join(work_dir, 'config.yml')
+    end
+
+    def initialize(work_dir)
+      @config = Confstruct::Configuration.new(VM_GLOBAL_DEFAULTS.merge({
+        :uuid => File.read("/proc/sys/kernel/random/uuid").strip,
+        :mac_address => Vmit::Utils.random_mac_address
+        }))
+      @work_dir = work_dir
+
+      if File.exist?(config_file)
+        @config.configure(YAML::load(File.open(config_file)))
+      end
+
+      @network = config.lookup!('network', 'default')
+      Vmit.logger.info "Network: #{@network}"
+    end
+
+    # @return [Array,<String>] sorted list of snapshots
+    def disk_images
+      Dir.glob(File.join(work_dir, '*.qcow2')).sort do |a,b|
+        File.ctime(a) <=> File.ctime(b)
+      end
+    end
+
+    # Takes a disk snapshot
+    def disk_snapshot!
+      disk_image_shift!
+    end
+
+    def disk_image_init!(opts={})
+      disk_image_shift!(opts)
+    end
+
+    DISK_INIT_DEFAULTS = {:disk_size => '10G'}
+
+    # Shifts an image, adding a new one using the
+    # previous newest one as backing file
+    #
+    # @param [Hash] opts options for the disk shift
+    # @option opts [String] :disk_size Disk size. Only used for image creation
+    def disk_image_shift!(opts={})
+      disk_config = Confstruct::Configuration.new(DISK_INIT_DEFAULTS)
+
+      file_name = File.join(work_dir, "sda-#{Time.now.to_i}.qcow2")
+      images = disk_images
+
+      file_name = File.join(work_dir, 'base.qcow2') if images.size == 0
+
+      args = ['/usr/bin/qemu-img', 'create',
+        '-f', "qcow2"]
+
+      if not images.empty?
+        args << '-b'
+        args << images.last
+      end
+
+      args << file_name
+      if images.empty?
+        args << disk_config.disk_size
+      end
+
+      Vmit.logger.info "Shifted image. Current is '#{file_name}'."
+      Cheetah.run(*args)
+    end
+
+    # Rolls back to the previous snapshot
+    def disk_rollback!
+      images = disk_images
+
+      return if images.empty?
+
+      if images.size == 1
+        Vmit.logger.fatal "Only the base snapshot left!"
+        return
+      end
+      Vmit.logger.info "Removing #{images.last}"
+      FileUtils.rm(images.last)
+    end
+
+    # @returns [String] The latest COW snapshot
+    def current_image
+      curr = disk_images.last
+      raise "No hard disk image available" if curr.nil?
+      curr
+    end
+
+    def options
+      raise 'Workspace#options is deprecated.'
+    end
+
+    # @return [Hash] Config of the virtual machine
+    #   This is all options plus the defaults
+    def config
+      @config
+    end
+
+    # @return [Hash] config that differs from default
+    #  and therefore relevant to be persisted in config.yml
+    def relevant_config
+      config.diff(config.default_values)
+    end
+
+    # Saves the configuration in config.yml
+    def save_config!
+      if not relevant_config.empty?
+        Vmit.logger.info "Writing config.yml..."
+        File.open(config_file, 'w') do |f|
+          f.write(relevant_config.to_yaml)
+        end
+      end
+    end
+
+    def to_s
+      config.to_s
+    end
+
+    BINDIR = File.join(File.dirname(__FILE__), '../../bin')
+
+  end
+
+end

data/test/data/registry.yml

@@ -0,0 +1,5 @@
+---
+memory: 2G
+mac_address: 7a:7f:c7:dd:5f:bb
+:sym_key: Hello
+

data/test/data/registry/key1

@@ -0,0 +1 @@
+val1

data/test/data/registry/key2

@@ -0,0 +1 @@
+4

data/test/data/registry/key4/key1

@@ -0,0 +1 @@
+val1

data/test/install_media_test.rb

@@ -0,0 +1,67 @@
+#
+# Copyright (C) 2013 Duncan Mac-Vicar P. <dmacvicar@suse.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require File.join(File.dirname(__FILE__), "helper")
+require 'test/unit'
+require 'vmit/install_media'
+require 'tmpdir'
+
+class InstallMedia_test < Test::Unit::TestCase
+
+  def test_scan
+
+    ['openSUSE 12.1', 'opensuse12.1', 'opensuse_12.1'].each do |key|
+      media = Vmit::InstallMedia.scan(key)
+      assert_kind_of(Vmit::SUSEInstallMedia, media)
+      assert_equal('http://download.opensuse.org/distribution/12.1/repo/oss/',
+                   media.location)
+    end
+
+    ['openSUSE Factory', 'factory', 'opensuse_factory'].each do |key|
+      media = Vmit::InstallMedia.scan(key)
+      assert_kind_of(Vmit::SUSEInstallMedia, media)
+      assert_equal('http://download.opensuse.org/factory/repo/oss/',
+                   media.location)
+    end
+
+    ['debian wheezy', 'Debian wheezy', 'debian wheezy'].each do |key|
+      media = Vmit::InstallMedia.scan(key)
+      assert_kind_of(Vmit::DebianInstallMedia, media)
+      assert_equal('http://cdn.debian.net/debian/dists/wheezy',
+                   media.location)
+    end
+
+    ['sles10sp1', 'sles-10sp1', 'SLES10 SP1', 'SLE10 SP1'].each do |key|
+      media = Vmit::InstallMedia.scan(key)
+      assert_kind_of(Vmit::SUSEInstallMedia, media)
+      assert_equal("http://schnell.suse.de/BY_PRODUCT/sle-server-10-sp1-#{Vmit::Utils.arch}/",
+                   media.location)
+    end
+
+  ['sles11', 'sles-11', 'SLES11', 'SLE11'].each do |key|
+      media = Vmit::InstallMedia.scan(key)
+      assert_kind_of(Vmit::SUSEInstallMedia, media)
+      assert_equal("http://schnell.suse.de/BY_PRODUCT/sle-server-11-sp0-#{Vmit::Utils.arch}/",
+                   media.location)
+    end
+
+  end
+
+end

data/test/registry_test.rb

@@ -0,0 +1,118 @@
+#
+# Copyright (C) 2013 Duncan Mac-Vicar P. <dmacvicar@suse.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require File.join(File.dirname(__FILE__), "helper")
+require 'test/unit'
+require 'vmit/registry'
+require 'tmpdir'
+
+class MyTypedRegistry < Vmit::TypedRegistry
+  type :key1, String
+  type :key2, Fixnum
+end
+
+class Registry_test < Test::Unit::TestCase
+
+  def test_basic_yaml
+    dir = File.join(File.dirname(__FILE__), "data/registry.yml")
+    reg = Vmit::YamlRegistry.new(dir)
+
+    assert_equal '2G', reg[:memory]
+    assert_equal '7a:7f:c7:dd:5f:bb', reg[:mac_address]
+    assert_equal 'Hello', reg[:sym_key]
+    keys = reg.keys
+    assert_equal [], [:memory, :mac_address, :sym_key] - keys
+
+    reg.each do |k,v|
+      assert keys.include?(k)
+      assert_equal reg[k], v
+    end
+  end
+
+  def test_basic_existing_registry
+    dir = File.join(File.dirname(__FILE__), "data/registry")
+    reg = Vmit::FilesystemRegistry.new(dir)
+
+    assert_equal 'val1', reg[:key1]
+    assert_equal '4', reg[:key2]
+    keys = reg.keys
+    assert_equal [], [:key2, :key4, :key3, :key1] - keys
+
+    reg.each do |k,v|
+      assert keys.include?(k)
+      assert_equal reg[k], v
+    end
+  end
+
+  def test_basic_new_registry
+    Dir.mktmpdir do |dir|
+      reg = Vmit::FilesystemRegistry.new(dir)
+
+      assert_nil reg[:nonexisting_key]
+
+      reg[:hello] = "Hello"
+      reg[:bye] = "Bye"
+
+      assert_equal "Hello", reg[:hello]
+      assert_equal "Bye", reg[:bye]
+    end
+  end
+
+  def test_buffered
+    Dir.mktmpdir do |dir|
+      reg = Vmit::FilesystemRegistry.new(dir)
+      breg = Vmit::BufferedRegistry.new(reg)
+
+      reg[:hello] = "Hello"
+      reg[:bye] = "Bye"
+
+      breg[:bye] = "Bye 2"
+
+      assert_equal "Bye", reg[:bye]
+      assert_equal "Bye 2", breg[:bye]
+      breg.save!
+      assert_equal "Bye 2", reg[:bye]
+
+      assert_equal "Hello", breg[:hello]
+      reg[:hello] = "Hello 2"
+      assert_equal "Hello", breg[:hello]
+      breg.reload!
+      assert_equal "Hello 2", breg[:hello]
+    end
+  end
+
+  def test_typed
+    Dir.mktmpdir do |dir|
+      reg = Vmit::FilesystemRegistry.new(dir)
+      treg = MyTypedRegistry.new(reg)
+
+      reg[:key1] = "Hello"
+      reg[:key2] = "1"
+
+      assert_equal "Hello", treg[:key1]
+      assert_equal 1, treg[:key2]
+
+      assert_raise TypeError do
+        treg[:key2] = "1"
+      end
+    end
+  end
+
+end