vagrant-ovirt 0.0.1

data/lib/vagrant-ovirt/action/read_ssh_info.rb

@@ -0,0 +1,68 @@
+require "log4r"
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # This action reads the SSH info for the machine and puts it into the
+      # `:machine_ssh_info` key in the environment.
+      class ReadSSHInfo
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::read_ssh_info")
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = read_ssh_info(
+            env[:ovirt_compute], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_ssh_info(ovirt, machine)
+          return nil if machine.id.nil?
+
+          # Get config.
+          config = machine.provider_config
+
+          # Find the machine
+          server = ovirt.servers.get(machine.id.to_s)
+
+          if server.nil?
+            # The machine can't be found
+            @logger.info("Machine couldn't be found, assuming it got destroyed.")
+            machine.id = nil
+            return nil
+          end
+
+          # oVirt doesn't provide a way how to find out IP of VM via API.
+          # IP command should return IP address of MAC defined as a shell
+          # variable.
+          # TODO place code for obtaining IP in one place.
+          first_interface = OVirtProvider::Util::Collection.find_matching(
+            server.interfaces, 'nic1')
+          ip_command = "MAC=#{first_interface.mac}; #{config.ip_command}"
+
+          for i in 1..3
+            # Get IP address via ip_command.
+            ip_address = %x{#{ip_command}}
+            break if ip_address != ''
+            sleep 2
+          end
+          if ip_address == nil or ip_address == ''
+            raise Errors::NoIpAddressError
+          end
+
+          # Return the info
+          # TODO: Some info should be configurable in Vagrantfile
+          return {
+            :host          => ip_address.chomp!,
+            :port          => 22,
+            :username      => 'root',
+            :forward_agent => true,
+            :forward_x11   => true,
+          }
+        end 
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/read_state.rb

@@ -0,0 +1,37 @@
+require "log4r"
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # This action reads the state of the machine and puts it in the
+      # `:machine_state_id` key in the environment.
+      class ReadState
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:ovirt_compute], env[:machine])
+          @app.call(env)
+        end
+
+        def read_state(ovirt, machine)
+          return :not_created if machine.id.nil?
+
+          # Find the machine
+          server = ovirt.servers.get(machine.id)
+          if server.nil? || [:"shutting-down", :terminated].include?(server.status.to_sym)
+            # The machine can't be found
+            @logger.info("Machine not found or terminated, assuming it got destroyed.")
+            machine.id = nil
+            return :not_created
+          end
+
+          # Return the state
+          return server.status.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/set_name_of_domain.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+
+      # Setup name for domain and domain volumes.
+      class SetNameOfDomain
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:domain_name] = env[:root_path].basename.to_s.dup
+          env[:domain_name].gsub!(/[^-a-z0-9_]/i, "")
+          env[:domain_name] << "_#{Time.now.to_i}"
+
+          # Check if the domain name is not already taken
+          domain = OVirtProvider::Util::Collection.find_matching(
+            env[:ovirt_compute].servers.all, env[:domain_name])
+          if domain != nil
+            raise Vagrant::Errors::DomainNameExists,
+              :domain_name => env[:domain_name]
+          end
+
+          @app.call(env)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/vagrant-ovirt/action/start_vm.rb

@@ -0,0 +1,37 @@
+require 'log4r'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+
+      # Just start the VM.
+      class StartVM
+
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::start_vm")
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_ovirt.starting_vm"))
+
+          machine = env[:ovirt_compute].servers.get(env[:machine].id.to_s)
+          if machine == nil
+            raise Errors::NoVMError,
+              :vm_name => env[:machine].id.to_s
+          end
+
+          # Start VM.
+          begin
+            machine.start
+          rescue OVIRT::OvirtException => e
+            raise Errors::StartVMError,
+              :error_message => e.message
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/sync_folders.rb

@@ -0,0 +1,58 @@
+require "log4r"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # This middleware uses `rsync` to sync the folders over to the
+      # oVirt VM.
+      class SyncFolders
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::sync_folders")
+        end
+
+        def call(env)
+          @app.call(env)
+
+          ssh_info = env[:machine].ssh_info
+
+          env[:machine].config.vm.synced_folders.each do |id, data|
+            hostpath  = File.expand_path(data[:hostpath], env[:root_path])
+            guestpath = data[:guestpath]
+
+            # Make sure there is a trailing slash on the host path to
+            # avoid creating an additional directory with rsync
+            hostpath = "#{hostpath}/" if hostpath !~ /\/$/
+
+            env[:ui].info(I18n.t("vagrant_ovirt.rsync_folder",
+                                :hostpath => hostpath,
+                                :guestpath => guestpath))
+
+            # Create the guest path
+            env[:machine].communicate.sudo("mkdir -p '#{guestpath}'")
+            env[:machine].communicate.sudo(
+              "chown #{ssh_info[:username]} '#{guestpath}'")
+
+            # Rsync over to the guest path using the SSH info
+            command = [
+              "rsync", "--verbose", "--archive", "-z",
+              "--exclude", ".vagrant/",
+              "-e", "ssh -p #{ssh_info[:port]} -o StrictHostKeyChecking=no -i '#{ssh_info[:private_key_path]}'",
+              hostpath,
+              "#{ssh_info[:username]}@#{ssh_info[:host]}:#{guestpath}"]
+
+            r = Vagrant::Util::Subprocess.execute(*command)
+            if r.exit_code != 0
+              raise Errors::RsyncError,
+                :guestpath => guestpath,
+                :hostpath => hostpath,
+                :stderr => r.stderr
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt/action/timed_provision.rb

@@ -0,0 +1,21 @@
+require "vagrant-ovirt/util/timer"
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # This is the same as the builtin provision except it times the
+      # provisioner runs.
+      class TimedProvision < Vagrant::Action::Builtin::Provision
+        def run_provisioner(env, p)
+          timer = Util::Timer.time do
+            super
+          end
+
+          env[:metrics] ||= {}
+          env[:metrics]["provisioner_times"] ||= []
+          env[:metrics]["provisioner_times"] << [p.class.to_s, timer]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/wait_till_up.rb

@@ -0,0 +1,108 @@
+require 'log4r'
+require 'vagrant-ovirt/util/timer'
+require 'vagrant/util/retryable'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+
+      # Wait till VM is started, till it obtains an IP address and is
+      # accessible via ssh.
+      class WaitTillUp
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::wait_till_up")
+          @app = app
+        end
+
+        def call(env)
+          # Initialize metrics if they haven't been
+          env[:metrics] ||= {}
+
+          # Get config.
+          config = env[:machine].provider_config
+
+          # Get VM.
+          server = env[:ovirt_compute].servers.get(env[:machine].id.to_s)
+          if server == nil
+            raise NoVMError, :vm_name => ''
+          end
+
+          # oVirt doesn't provide a way how to find out IP of VM via API.
+          # IP command should return IP address of MAC defined as a shell
+          # variable.
+          first_interface = OVirtProvider::Util::Collection.find_matching(
+            server.interfaces, 'nic1')
+          ip_command = "MAC=#{first_interface.mac}; #{config.ip_command}"
+
+          # Wait for VM to obtain an ip address. Ip address is searched via
+          # custom configurable 'ip_command', or by default in local arp table.
+          env[:ip_address] = nil
+          env[:metrics]["instance_ip_time"] = Util::Timer.time do
+            env[:ui].info(I18n.t("vagrant_ovirt.waiting_for_ip"))
+            #retryable(:on => Fog::Errors::TimeoutError, :tries => 300) do
+            for i in 1..300
+              # If we're interrupted don't worry about waiting
+              next if env[:interrupted]
+
+              # Wait for VM to obtain an ip address.
+              @logger.debug("Executing command #{ip_command}")
+              env[:ip_address] = %x{#{ip_command}}
+              @logger.debug("Got output #{env[:ip_address]}")
+              break if env[:ip_address] != ''
+              sleep 2
+            end
+            #end
+          end
+          terminate(env) if env[:interrupted]
+          @logger.info("Got IP address #{env[:ip_address]}")
+          @logger.info("Time for getting IP: #{env[:metrics]["instance_ip_time"]}")
+          
+          # Machine has ip address assigned, now wait till we are able to
+          # connect via ssh.
+          env[:metrics]["instance_ssh_time"] = Util::Timer.time do
+            env[:ui].info(I18n.t("vagrant_ovirt.waiting_for_ssh"))
+            retryable(:on => Fog::Errors::TimeoutError, :tries => 60) do
+              # If we're interrupted don't worry about waiting
+              next if env[:interrupted]
+
+              # Wait till we are able to connect via ssh.
+              while true
+                # If we're interrupted then just back out
+                break if env[:interrupted]
+                break if env[:machine].communicate.ready?
+                sleep 2
+              end            
+            end
+          end
+          terminate(env) if env[:interrupted]
+          @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
+
+          # Booted and ready for use.
+          env[:ui].info(I18n.t("vagrant_ovirt.ready"))
+          
+          @app.call(env)
+        end
+
+        def recover(env)
+          return if env["vagrant.error"].is_a?(Vagrant::Errors::VagrantError)
+
+          if env[:machine].provider.state.id != :not_created
+            # Undo the import
+            terminate(env)
+          end
+        end
+
+        def terminate(env)
+          destroy_env = env.dup
+          destroy_env.delete(:interrupted)
+          destroy_env[:config_validate] = false
+          destroy_env[:force_confirm_destroy] = true
+          env[:action_runner].run(Action.action_destroy, destroy_env)        
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt/action.rb

@@ -0,0 +1,89 @@
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            # Create and start VM if not yet created.
+            b2.use SetNameOfDomain
+            b2.use CreateVM
+            b2.use CreateNetworkInterfaces
+
+            b2.use TimedProvision
+            b2.use StartVM
+            b2.use WaitTillUp
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for completely
+      # freeing the resources of the underlying virtual machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConnectOVirt
+            b2.use DestroyVM
+          end
+        end
+      end
+
+      # This action is called to read the state of the machine. The resulting
+      # state is expected to be put into the `:machine_state_id` key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use ReadState
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use ReadSSHInfo
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectOVirt, action_root.join("connect_ovirt")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :SetNameOfDomain, action_root.join("set_name_of_domain")
+      autoload :CreateVM, action_root.join("create_vm")
+      autoload :CreateNetworkInterfaces, action_root.join("create_network_interfaces")
+      autoload :StartVM, action_root.join("start_vm")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :DestroyVM, action_root.join("destroy_vm")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :TimedProvision, action_root.join("timed_provision")
+      autoload :WaitTillUp, action_root.join("wait_till_up")
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+    end
+  end
+end
+

data/lib/vagrant-ovirt/config.rb

@@ -0,0 +1,57 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module OVirtProvider
+    class Config < Vagrant.plugin('2', :config)
+
+      attr_accessor :url
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :datacenter
+      attr_accessor :cluster
+      attr_accessor :ip_command
+
+      # Domain specific settings used while creating new machine.
+      attr_accessor :memory
+      attr_accessor :cpus
+      attr_accessor :template
+      attr_accessor :quota
+
+      def initialize
+        @url       = UNSET_VALUE
+        @username   = UNSET_VALUE
+        @password   = UNSET_VALUE
+        @datacenter = UNSET_VALUE
+        @cluster    = UNSET_VALUE
+        @ip_command = UNSET_VALUE
+
+        # Domain specific settings.
+        @memory     = UNSET_VALUE
+        @cpus       = UNSET_VALUE
+        @template   = UNSET_VALUE
+        @quota      = UNSET_VALUE
+      end
+
+      def finalize!
+        @url = nil if @url == UNSET_VALUE
+        @username = nil if @username == UNSET_VALUE
+        @password = nil if @password == UNSET_VALUE
+        @datacenter = nil if @datacenter == UNSET_VALUE
+        @cluster = nil if @cluster == UNSET_VALUE
+        if @ip_command == UNSET_VALUE
+          @ip_command = 'arp -an | grep -i $MAC | sed "s/.*(\(.*\)).*/\1/"'
+        end
+
+        # Domain specific settings.
+        @memory = 512 if @memory == UNSET_VALUE
+        @cpus = 1 if @cpus == UNSET_VALUE
+        @template = 'Blank' if @template == UNSET_VALUE
+        @quota = nil if @quota == UNSET_VALUE
+      end
+
+      def validate(machine)
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt/errors.rb

@@ -0,0 +1,61 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Errors
+      class VagrantOVirtError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_ovirt.errors")
+      end
+
+      class FogOVirtConnectionError < VagrantOVirtError
+        error_key(:fog_ovirt_connection_error)
+      end
+
+      class NoDatacenterError < VagrantOVirtError
+        error_key(:no_datacenter_error)
+      end
+
+      class NoClusterError < VagrantOVirtError
+        error_key(:no_cluster_error)
+      end
+
+      class NoTemplateError < VagrantOVirtError
+        error_key(:no_template_error)
+      end
+
+      class NoQuotaError < VagrantOVirtError
+        error_key(:no_template_error)
+      end
+
+      class FogCreateServerError < VagrantOVirtError
+        error_key(:fog_create_server_error)
+      end
+
+      class InterfaceSlotNotAvailable < VagrantOVirtError
+        error_key(:interface_slot_not_available)
+      end
+
+      class AddInterfaceError < VagrantOVirtError
+        error_key(:add_interface_error)
+      end
+
+      class NoVMError < VagrantOVirtError
+        error_key(:no_vm_error)
+      end
+
+      class StartVMError < VagrantOVirtError
+        error_key(:start_vm_error)
+      end
+
+      class NoIpAddressError < VagrantOVirtError
+        error_key(:no_ip_address_error)
+      end
+
+      class NoNetworkError < VagrantOVirtError
+        error_key(:no_network_error)
+      end
+
+    end
+  end
+end
+

data/lib/vagrant-ovirt/plugin.rb

@@ -0,0 +1,74 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise "The Vagrant oVirt plugin must be run within Vagrant."
+end
+
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < '1.1.0'
+  raise "The Vagrant oVirt plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module OVirtProvider
+    class Plugin < Vagrant.plugin('2')
+      name "ovirt"
+      description <<-DESC
+      Vagrant plugin to manage oVirt machines.
+      DESC
+
+      config("ovirt", :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider "ovirt" do
+        # Setup logging and i18n
+        setup_logging
+        setup_i18n
+
+        require_relative "provider"
+        Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml",
+          OVirtProvider.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new("vagrant_ovirt")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end
+