vagrant-ovirt4 1.0.0

data/lib/vagrant-ovirt4/action.rb

@@ -0,0 +1,255 @@
+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, ReadState do |env, b2|
+            if env[:machine_state_id] == :up
+              b2.use SyncFolders
+              b2.use MessageAlreadyUp
+              next
+            end
+
+            if env[:machine_state_id] == :saving_state
+              b2.use MessageSavingState
+              next
+            end
+
+            if env[:machine_state_id] == :not_created
+              b2.use SetNameOfDomain
+              b2.use CreateVM
+              #b2.use ResizeDisk
+
+              b2.use Provision
+              b2.use CreateNetworkInterfaces
+
+              b2.use SetHostname
+            end
+
+            b2.use StartVM
+            b2.use WaitTillUp
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      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 ProvisionerCleanup, :before if defined?(ProvisionerCleanup)
+            b2.use HaltVM
+            b2.use WaitTillDown
+            b2.use DestroyVM
+          end
+        end
+      end
+
+      def self.action_provision
+        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 Provision
+            b2.use SyncFolders
+          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
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use Call, ReadState do |env, b2|
+            if env[:machine_state_id] == :not_created
+              b2.use MessageNotCreated
+              next
+            end
+            if env[:machine_state_id] != :up
+              b2.use MessageNotUp
+              next
+            end
+
+            raise Errors::NoIPError if env[:ip_address].nil?
+            b2.use SSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use Call, ReadState do |env, b2|
+            if env[:machine_state_id] == :not_created
+              b2.use MessageNotCreated
+              next
+            end
+            if env[:machine_state_id] != :up
+              b2.use MessageNotUp
+              next
+            end
+
+            raise Errors::NoIPError if env[:ip_address].nil?
+            b2.use SSHRun
+          end
+        end
+      end
+
+
+      def self.action_halt
+        with_ovirt do |env, b|
+          b.use Call, IsRunning do |env2, b2|
+            if env[:machine_state_id] == :powering_up
+              b2.use MessagePoweringUp
+              next
+            end
+            if !env2[:result]
+              b2.use MessageNotUp
+              next
+            end
+            b2.use HaltVM
+            b2.use WaitTillDown
+          end
+        end
+      end
+
+      def self.action_reload
+        with_ovirt do |env, b|
+          b.use action_halt
+          b.use action_up
+        end
+      end
+
+      def self.action_suspend
+        with_ovirt do |env, b|
+          b.use Call, IsRunning do |env2, b2|
+            if env[:machine_state_id] == :powering_up
+              b2.use MessagePoweringUp
+              next
+            end
+            if !env2[:result]
+              b2.use MessageNotUp
+              next
+            end
+            b2.use SuspendVM
+            b2.use WaitTilSuspended
+          end
+        end
+      end
+
+      def self.action_resume
+        with_ovirt do |env, b|
+          if env[:machine_state_id] == :saving_state
+            b.use MessageSavingState
+            next
+          end
+          if env[:machine_state_id] != :suspended
+            b.use MessageNotSuspended
+            next
+          end
+          b.use action_up
+        end
+      end
+
+      def self.action_snapshot_list
+        with_ovirt do |env, b|
+          b.use SnapshotList
+        end
+      end
+
+      def self.action_snapshot_save
+        with_ovirt do |env, b|
+          b.use SnapshotSave
+        end
+      end
+
+      def self.action_snapshot_delete
+        with_ovirt do |env, b|
+          b.use SnapshotDelete
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectOVirt, action_root.join("connect_ovirt")
+      autoload :CreateNetworkInterfaces, action_root.join("create_network_interfaces")
+      autoload :CreateVM, action_root.join("create_vm")
+      autoload :DestroyVM, action_root.join("destroy_vm")
+      autoload :HaltVM, action_root.join("halt_vm")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :IsRunning, action_root.join("is_running")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :SetNameOfDomain, action_root.join("set_name_of_domain")
+      autoload :SnapshotDelete, action_root.join("snapshot_delete")
+      autoload :SnapshotList, action_root.join("snapshot_list")
+      autoload :SnapshotSave, action_root.join("snapshot_save")
+      autoload :StartVM, action_root.join("start_vm")
+      autoload :SuspendVM, action_root.join("suspend_vm")
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :WaitTillDown, action_root.join("wait_till_down")
+      autoload :WaitTillUp, action_root.join("wait_till_up")
+      autoload :WaitTilSuspended, action_root.join("wait_til_suspended")
+
+      autoload :MessageAlreadyUp, action_root.join("message_already_up")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :MessageNotSuspended, action_root.join("message_not_suspended")
+      autoload :MessageNotUp, action_root.join("message_not_up")
+      autoload :MessagePoweringUp, action_root.join("message_powering_up")
+      autoload :MessageSavingState, action_root.join("message_saving_state")
+
+      private
+      def self.with_ovirt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use Call, ReadState do |env, b2|
+            if !env[:machine_state_id] == :not_created
+              b2.use MessageNotCreated
+              next
+            end
+            yield env, b2
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/cap/snapshot_list.rb

@@ -0,0 +1,12 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Cap
+      module SnapshotList
+        def self.snapshot_list(machine)
+          env = machine.action(:snapshot_list, lock: false)
+          env[:machine_snapshot_list]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/cap/snapshot_save.rb

@@ -0,0 +1,12 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Cap
+      module SnapshotSave
+        def self.snapshot_save(machine)
+          env = machine.action(:snapshot_save, lock: false)
+          env[:machine_snapshot_save]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/config.rb

@@ -0,0 +1,49 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module OVirtProvider
+    class Config < Vagrant.plugin('2', :config)
+
+      attr_accessor :url
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :insecure
+      attr_accessor :debug
+      attr_accessor :cpus
+      attr_accessor :template
+      attr_accessor :memory
+      attr_accessor :cluster
+      attr_accessor :console
+
+      def initialize
+        @url            = UNSET_VALUE
+        @username       = UNSET_VALUE
+        @password       = UNSET_VALUE
+        @insecure       = UNSET_VALUE
+        @debug          = UNSET_VALUE
+        @cpus           = UNSET_VALUE
+        @template       = UNSET_VALUE
+        @memory         = UNSET_VALUE
+        @cluster        = UNSET_VALUE
+        @console        = UNSET_VALUE
+
+      end
+
+      def finalize!
+        @url = nil if @url == UNSET_VALUE
+        @username = nil if @username == UNSET_VALUE
+        @password = nil if @password == UNSET_VALUE
+        @insecure = false if @insecure == UNSET_VALUE
+        @debug = false if @debug == UNSET_VALUE
+        @cpus = 1 if @cpus == UNSET_VALUE
+        @cluster = nil if @cluster == UNSET_VALUE
+        @console = nil if @console == UNSET_VALUE
+        @memory = 256 if @memory == UNSET_VALUE
+        @template = nil if @template == UNSET_VALUE
+
+      end
+
+    end
+  end
+end
+

data/lib/vagrant-ovirt4/errors.rb

@@ -0,0 +1,48 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Errors
+      class VagrantOVirtError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_ovirt4.errors")
+      end
+
+      class NoVMError < VagrantOVirtError
+        error_key(:no_vm_error)
+      end
+
+      class CreateVMError < VagrantOVirtError
+        error_key(:create_vm_error)
+      end
+
+      class StartVMError < VagrantOVirtError
+        error_key(:start_vm_error)
+      end
+
+      class WaitForReadyVmTimeout < VagrantOVirtError
+        error_key(:wait_for_ready_vm_timeout)
+      end
+
+      class AddInterfaceError < VagrantOVirtError
+        error_key(:add_interface_error)
+      end
+
+      class NoNetworkError < VagrantOVirtError
+        error_key(:no_network_error)
+      end
+
+      class NoIPError < VagrantOVirtError
+        error_key(:no_ip_error)
+      end
+
+      class RemoveActiveSnapshotError < VagrantOVirtError
+        error_key(:remove_active_snapshot_error)
+      end
+
+      class RemoveSnapshotError < VagrantOVirtError
+        error_key(:remove_snapshot_error)
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt4/plugin.rb

@@ -0,0 +1,80 @@
+# vim: ai ts=2 sts=2 et sw=2 ft=ruby
+begin
+  require 'vagrant'
+rescue LoadError
+  raise "The Vagrant oVirt v4 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 v4 plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module OVirtProvider
+    class Plugin < Vagrant.plugin('2')
+      name "ovirt4"
+      description <<-DESC
+      Vagrant plugin to manage oVirt v4 machines.
+      DESC
+
+      provider_capability('ovirt4', 'snapshot_list') do
+        require_relative 'cap/snapshot_list'
+        Cap::SnapshotList
+      end
+
+      config("ovirt4", :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider("ovirt4", parallel: true) 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_ovirt4")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt4/provider.rb

@@ -0,0 +1,76 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module OVirtProvider
+
+    # This is the base class for a provider for the V2 API. A provider
+    # is responsible for creating compute resources to match the
+    # needs of a Vagrant-configured system.
+    class Provider < Vagrant.plugin('2', :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      # This should return an action callable for the given name.
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action.
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      # This method is called if the underying machine ID changes. Providers
+      # can use this method to load in new data for the actual backing
+      # machine or to realize that the machine is now gone (the ID can
+      # become `nil`).
+      def machine_id_changed
+      end
+
+      # This should return a hash of information that explains how to
+      # SSH into the machine. If the machine is not at a point where
+      # SSH is even possible, then `nil` should be returned.
+      def ssh_info
+        # Run a custom action called "read_ssh_info" which does what it says
+        # and puts the resulting SSH info into the `:machine_ssh_info` key in
+        # the environment.
+        #
+        # Ssh info has following format..
+        #
+        #{
+        #  :host => "1.2.3.4",
+        #  :port => "22",
+        #  :username => "mitchellh",
+        #  :private_key_path => "/path/to/my/key"
+        #}
+        env = @machine.action("read_ssh_info")
+        env[:machine_ssh_info]
+      end
+
+      # This should return the state of the machine within this provider.
+      # The state must be an instance of {MachineState}.
+      def state
+        # Run a custom action we define called "read_state" which does
+        # what it says. It puts the state in the `:machine_state_id`
+        # key in the environment.
+        env = @machine.action("read_state")
+
+        state_id = env[:machine_state_id]
+
+        # Get the short and long description
+        short = I18n.t("vagrant_ovirt4.states.short_#{state_id}")
+        long  = I18n.t("vagrant_ovirt4.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        id = @machine.id.nil? ? "new" : @machine.id
+        "oVirt (#{id})"
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt4/util/collection.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Util
+      module Collection
+        # This method finds a matching _thing_ in a collection of
+        # _things_. This works matching if the ID or NAME equals to
+        # `name`. Or, if `name` is a regexp, a partial match is chosen
+        # as well.
+        def self.find_matching(collection, name)
+          collection.each do |single|
+            return single if single.name == name
+            return single if single.id == name
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt4/util/timer.rb

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Util
+      class Timer
+        # A basic utility method that times the execution of the given
+        # block and returns it.
+        def self.time
+          start_time = Time.now.to_f
+          yield
+          end_time = Time.now.to_f
+
+          end_time - start_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/util.rb

@@ -0,0 +1,9 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Util
+      autoload :Collection,  'vagrant-ovirt4/util/collection'
+      autoload :Timer,  'vagrant-ovirt4/util/timer'
+    end
+  end
+end
+

data/lib/vagrant-ovirt4/version.rb

@@ -0,0 +1,6 @@
+module VagrantPlugins
+  module OVirtProvider
+    VERSION = '1.0.0'
+  end
+end
+

data/lib/vagrant-ovirt4.rb

@@ -0,0 +1,38 @@
+require 'pathname'
+require 'vagrant-ovirt4/plugin'
+
+module VagrantPlugins
+  module OVirtProvider
+    lib_path = Pathname.new(File.expand_path("../vagrant-ovirt4", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+    autoload :Util,   lib_path.join("util")
+
+    @@ovirt_connection = nil
+    @@vms_service = nil
+    def self.ovirt_connection
+      @@ovirt_connection
+    end
+
+    def self.ovirt_connection=(conn)
+      @@ovirt_connection = conn
+    end
+
+    def self.vms_service
+      @@vms_service
+    end
+
+    def self.vms_service=(conn)
+      @@vms_service = conn
+    end
+
+
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end