vmit 0.0.3

data/lib/vmit/version.rb

@@ -0,0 +1,23 @@
+#
+# 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.
+#
+module Vmit
+  VERSION = "0.0.3"
+end

data/lib/vmit/vfs.rb

@@ -0,0 +1,210 @@
+#
+# 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 'abstract_method'
+require 'cheetah'
+require 'uri'
+require 'open-uri'
+require 'progressbar'
+require 'tempfile'
+
+module Vmit
+
+  module VFS
+
+    # Opens a location
+    def self.from(location, *rest, &block)
+      [ISO, URI, Local].each do |handler|
+        if handler.accept?(location)
+          return handler.from(location)
+        end
+      end
+      raise ArgumentError.new("#{location} not supported")
+    end
+
+    class Handler
+      # alias for new
+      def self.from(*args)
+        self.new(*args)
+      end
+    end
+
+    class URI < Handler
+
+      # Whether this handler accepts the
+      # given location
+      #
+      # @param uri [URI,String] location
+      def self.accept?(location)
+        uri = case location
+          when ::URI then location
+          else ::URI.parse(location.to_s)
+        end
+        ['http', 'ftp'].include?(uri.scheme)
+      end
+
+      # @param [String] base_url Base location
+      def initialize(location)
+        @base_uri = case location
+          when ::URI then location
+          else ::URI.parse(location.to_s)
+        end
+      end
+
+      def self.open(loc, *rest, &block)
+        uri = case loc
+        when ::URI then loc
+        else ::URI.parse(loc.to_s)
+        end
+        unless accept?(uri)
+          raise ArgumentError.new('Only HTTP/FTP supported')
+        end
+        @pbar = nil
+        @filename = File.basename(uri.path)
+        ret = OpenURI.open_uri(uri.to_s,
+          :content_length_proc => lambda { |t|
+            if t && 0 < t
+              @pbar = ProgressBar.new(@filename, t)
+              @pbar.file_transfer_mode
+            end
+          },
+          :progress_proc => lambda { |s|
+            @pbar.set s if @pbar
+          }, &block)
+        @pbar = nil
+        # So that the progress bar line get overwriten
+        STDOUT.print "\r"
+        STDOUT.flush
+        ret
+      end
+      # Open a filename relative to the
+      # base location.
+      #
+      # @param [String] loc Location to open.
+      #   If a base URI was given for HTTP then
+      #   the path will be relative to that
+      def open(loc, *rest, &block)
+        uri = @base_uri.clone
+        uri.path = File.join(uri.path, loc.to_s)
+
+        Vmit::VFS::URI.open(uri, *rest, &block)
+      end
+    end
+
+    class ISO < Handler
+
+      attr_reader :iso_file
+
+      # Whether this handler accepts the
+      # given location.
+      #
+      # @param uri [URI,String] location
+      def self.accept?(location)
+        uri = case location
+          when ::URI then location
+          else ::URI.parse(location)
+        end
+
+        # either an iso:// url or a local file
+        unless (uri.scheme == 'iso' || uri.scheme.nil?)
+          return false
+        end
+        return false unless File.exist?(uri.path)
+        File.open(uri.path) do |f|
+          f.seek(0x8001)
+          return true if f.read(5) == 'CD001'
+        end
+        false
+      end
+
+      # Creates a ISO handler for +iso+
+      # @param [URI, String] iso ISO file
+      def initialize(location, *rest)
+        raise ArgumentError.new(location) unless self.class.accept?(location)
+        path = case location
+          when ::URI then location.path
+          else ::URI.parse(location).path
+        end
+        @iso_file = path
+      end
+
+      # Takes a iso URI on the form
+      # iso:///path/tothe/file.iso?path=/file/to/get
+      #
+      # @param [URI, String] uri ISO file and path as query string
+      def self.open(location)
+        uri = case location
+          when ::URI then location
+          else ::URI.parse(location)
+        end
+        handler = self.new(uri)
+        query = Hash[*uri.query.split('&').map {|p| p.split('=')}.flatten]
+        unless query.has_key?("path")
+          raise ArgumentError.new("#{uri}: missing path in query string")
+        end
+        handler.open(query["path"])
+      end
+
+      # Takes a path relative to +iso_file+
+      # @see iso_file
+      def open(name, *rest)
+        index = Cheetah.run('isoinfo', '-f', '-R', '-i', iso_file, :stdout => :capture)
+        files = index.each_line.to_a.map(&:strip)
+        raise Errno::ENOENT.new(name) if not files.include?(name)
+        tmp = Tempfile.new('vmit-vfs-iso-')
+        Cheetah.run('isoinfo', '-R', '-i', iso_file, '-x', name, :stdout => tmp)
+        tmp.close
+        tmp.open
+        if block_given?
+          yield tmp
+        end
+        tmp
+      end
+    end
+
+    class Local < Handler
+
+      # Whether this handler accepts the
+      # given location
+      #
+      # @param uri [URI,String] location
+      def self.accept?(location)
+        File.directory?(location.to_s)
+      end
+
+      def initialize(base_path=nil)
+        @base_path = base_path
+        @base_path ||= '/'
+        unless File.exist?(@base_path)
+          raise Errno::ENOENT.new(@base_path)
+        end
+      end
+
+      def self.open(dir, *rest, &block)
+        self.new(dir).open(name, *rest, &block)
+      end
+
+      def open(name, *rest, &block)
+        Kernel.open(File.join(@base_path, name), *rest, &block)
+      end
+    end
+
+  end
+end

data/lib/vmit/virtual_machine.rb

@@ -0,0 +1,299 @@
+#
+# 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 'vmit/utils'
+
+module Vmit
+
+  class VirtualMachine
+
+    attr_accessor :work_dir
+
+    VM_DEFAULTS = {
+      :memory => '1G',
+    }
+    SWITCH = 'br0'
+
+    # Accessor to current options
+    def [](key)
+      @opts[key]
+    end
+
+    def config_file
+      File.join(work_dir, 'config.yml')
+    end
+
+    def initialize(work_dir)
+      @pidfile = PidFile.new(:piddir => work_dir, :pidfile => "vmit.pid")
+      @work_dir = work_dir
+
+      @opts = {}
+      @opts.merge!(VM_DEFAULTS)
+
+      if File.exist?(config_file)
+        @opts.merge!(YAML::load(File.open(config_file)))
+      end
+
+      # By default the following keys are useful to be
+      # generated if they don't exist and then use the
+      # same in the future UNLESS they are
+      # overriden with vmit run
+      if not @opts.has_key?(:mac_address)
+        @opts[:mac_address] = Vmit::Utils.random_mac_address
+      end
+
+      if not @opts.has_key?(:uuid)
+        @opts[:uuid] = File.read("/proc/sys/kernel/random/uuid").strip
+      end
+
+      @network = if @opts.has_key?(:network)
+        Network.create(@opts[:network])
+      else
+        Vmit.logger.info 'No network selected. Using default.'
+        Network.default
+      end
+      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={})
+      runtime_opts = DISK_INIT_DEFAULTS.merge(opts)
+
+      file_name = File.join(work_dir, "sda-#{Time.now.to_i}.qcow2")
+      images = disk_images
+
+      file_name = '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 << runtime_opts[: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
+      @opts
+    end
+
+    # @return [Hash] Config of the virtual machine
+    #   This is all options plus the defaults
+    def config
+      VM_DEFAULTS.merge(@opts)
+    end
+
+    # @return [Hash] config that differs from default
+    #  and therefore relevant to be persisted in config.yml
+    def relevant_config
+      config.diff(VM_DEFAULTS)
+    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')
+
+    # Starts the virtual machine
+    #
+    # @param [Hash] runtime_opts Runtime options
+    #   @option runtime_opts [String] :cdrom CDROM image
+    #   @option runtime_opts [String] :kernel Kernel image
+    #   @option runtime_opts [String] :initrd initrd image
+    #   @option runtime_opts [String] :append Kernel command line
+    #   @option runtime_opts [String] :floppy Floppy (image or directory)
+    def run(runtime_opts)
+      Vmit.logger.info "Starting VM..."
+      # Don't overwrite @opts so that
+      # run can be called various times
+      opts = {}
+      opts.merge!(@opts)
+      opts.merge!(runtime_opts)
+
+      config.each do |k,v|
+        Vmit.logger.info "  => #{k} : #{v}"
+      end
+
+      begin
+        # HACK, will be replaced by a better config system
+        use_virtio = ! File.exist?(File.join(work_dir, '.disable-virtio'))
+
+        ifup = File.expand_path(File.join(BINDIR, 'vmit-ifup'))
+        ifdown = File.expand_path(File.join(BINDIR, 'vmit-ifdown'))
+
+        args = ['/usr/bin/qemu-kvm', '-boot', 'c',
+            '-m', "#{opts[:memory]}",
+            '-pidfile', File.join(work_dir, 'qemu.pid')]
+
+        if use_virtio
+          args << '-drive'
+          args << "file=#{current_image},if=virtio"
+
+          args << '-netdev'
+          args << "type=tap,script=#{ifup},downscript=#{ifdown},id=vnet0"
+          args << '-device'
+          args << "virtio-net-pci,netdev=vnet0,mac=#{opts[:mac_address]}"
+        else
+          args << '-drive'
+          args << "file=#{current_image}"
+
+          args << '-net'
+          args << "nic,macaddr=#{opts[:mac_address]}"
+          args << '-net'
+          args << "tap,script=#{ifup},downscript=#{ifdown}"
+        end
+
+        # advanced options, mostly to be used by plugins
+        [:cdrom, :kernel, :initrd, :append].each do |key|
+          if opts.has_key?(key)
+            args << "-#{key}"
+            args << case opts[key]
+              # append is multple
+              when Array then opts[key].join(' ')
+              else opts[key]
+            end
+          end
+        end
+
+        if opts.has_key?(:floppy)
+          if File.directory?(opts[:floppy])
+            args << '-fda'
+            args << "fat:floppy:#{opts[:floppy]}"
+          else
+            Vmit.logger.warn "#{opts[:floppy]} : only directories supported"
+          end
+        end
+
+        # options that translate to
+        # -no-something if :something => false
+        [:reboot].each do |key|
+          if opts.has_key?(key)
+            # default is true
+            args << "-no-#{key}" if not opts[key]
+          end
+        end
+
+        unless ENV['DISABLE_UUID']
+          args << '-uuid'
+          args << "#{opts[:uuid]}"
+        end
+
+        DRb.start_service nil, self
+        ENV['VMIT_SERVER'] = DRb.uri
+
+        ENV['VMIT_SWITCH'] = SWITCH
+        Vmit.logger.debug "Vmit server listening at #{DRb.uri}"
+
+        @network.auto do
+          begin
+            Cheetah.run(*args)
+          ensure
+            FileUtils.rm_f File.join(work_dir, 'qemu.pid')
+          end
+        end
+      rescue PidFile::DuplicateProcessError => e
+        Vmit.logger.fatal "VM in '#{work_dir}'' is already running (#{e})"
+        raise
+      end
+    end
+
+    # Called by vmit-ifup
+    def ifup(device)
+      Vmit.logger.info "  Bringing interface #{device} up"
+      Cheetah.run '/sbin/ifconfig', device, '0.0.0.0', 'up'
+      @network.connect_interface(device)
+    end
+
+    # Called by vmit-ifdown
+    def ifdown(device)
+      Vmit.logger.info "  Bringing down interface #{device}"
+      Cheetah.run '/sbin/ifconfig', device, '0.0.0.0', 'down'
+      @network.disconnect_interface(device)
+    end
+  end
+
+end