vagrant-ovirt4 2.0.0 → 2.2.0

data/lib/vagrant-ovirt4/config.rb

@@ -5,6 +5,7 @@ require 'ovirtsdk4'
 module VagrantPlugins
   module OVirtProvider
     class Config < Vagrant.plugin('2', :config)
+      attr_reader :disks
 
       attr_accessor :url
       attr_accessor :username
@@ -29,7 +30,10 @@ module VagrantPlugins
       attr_accessor :optimized_for
       attr_accessor :description
       attr_accessor :comment
-      attr_accessor :disks
+      attr_accessor :vmname
+      attr_accessor :timeout
+      attr_accessor :connect_timeout
+      attr_accessor :run_once
 
       def initialize
         @url               = UNSET_VALUE
@@ -55,6 +59,10 @@ module VagrantPlugins
         @optimized_for     = UNSET_VALUE
         @description       = UNSET_VALUE
         @comment           = UNSET_VALUE
+        @vmname            = UNSET_VALUE
+        @timeout           = UNSET_VALUE
+        @connect_timeout   = UNSET_VALUE
+        @run_once          = UNSET_VALUE
         @disks             = []
 
       end
@@ -109,6 +117,10 @@ module VagrantPlugins
         @optimized_for = nil if @optimized_for == UNSET_VALUE
         @description = '' if @description == UNSET_VALUE
         @comment = '' if @comment == UNSET_VALUE
+        @vmname = nil if @vmname == UNSET_VALUE
+        @timeout = nil if @timeout == UNSET_VALUE
+        @connect_timeout = nil if @connect_timeout == UNSET_VALUE
+        @run_once = @run_once == UNSET_VALUE ? false : !!@run_once
 
         unless optimized_for.nil?
           raise "Invalid 'optimized_for'. Must be one of #{OvirtSDK4::VmType.constants.map { |s| "'#{s.downcase}'" }.join(' ')}" unless OvirtSDK4::VmType.constants.include? optimized_for.upcase.to_sym
@@ -133,6 +145,24 @@ module VagrantPlugins
         rescue ArgumentError
           raise "Not able to parse either `memory_size` or `memory_guaranteed`. Please verify and check again."
         end
+
+        unless timeout.nil?
+          begin
+            @timeout = Integer(@timeout)
+            raise ArgumentError if @timeout < 0
+          rescue ArgumentError, TypeError
+            raise "`timeout` argument #{@timeout.inspect} is not a valid nonnegative integer"
+          end
+        end
+
+        unless connect_timeout.nil?
+          begin
+            @connect_timeout = Integer(@connect_timeout)
+            raise ArgumentError if @connect_timeout < 0
+          rescue ArgumentError, TypeError
+            raise "`connect_timeout` argument #{@connect_timeout.inspect} is not a valid nonnegative integer"
+          end
+        end
       end
 
     end

data/lib/vagrant-ovirt4/errors.rb

@@ -7,6 +7,10 @@ module VagrantPlugins
         error_namespace("vagrant_ovirt4.errors")
       end
 
+      class ServiceConnectionError < VagrantOVirtError
+        error_key(:service_connection_error)
+      end
+
       class RsyncError < VagrantOVirtError
         error_key(:rsync_error)
       end

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

@@ -0,0 +1,40 @@
+require 'ovirtsdk4'
+require 'ovirtsdk4/connection'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Util
+      module Connection
+        # Use OVirtSDK4::ConnectionError if available; SDK versions older than
+        # 4.2.0 used the generic OVirtSDK4::Error.
+        ERROR_CLASSES = (OvirtSDK4.const_defined?(:ConnectionError) ? [OvirtSDK4::ConnectionError, OvirtSDK4::Error] : [OvirtSDK4::Error]).freeze
+
+      module_function
+
+        # Close a connection, suppressing errors generated by the SDK.  Yield
+        # the error to the caller to re-raise if appropriate (or log, or do
+        # whatever).
+        def safe_close_connection!(conn)
+          conn.close
+        rescue *ERROR_CLASSES => e
+          yield e if block_given?
+        rescue StandardError => e
+          yield e if block_given?
+          raise e
+        end
+
+        # Wrapper for "#safe_close_connection" that issues a warning message
+        # with diagnostic information about the exception raised.
+        def safe_close_connection_with_warning!(conn, ui)
+          safe_close_connection!(conn) { |e| ui.warn("Encountered exception of class #{e.class}: #{e.message}") }
+        end
+
+        # Wrapper for "#safe_close_connection_with_warning" that extracts the
+        # connection and UI from a Vagrant environment.
+        def safe_close_connection_standard!(env)
+          safe_close_connection_with_warning!(env[:connection], env[:ui])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Util
+      module MachineNames
+        DEFAULT_NAME = 'vagrant'.freeze
+
+      module_function
+
+        def machine_hostname(machine)
+          machine.config.vm.hostname || DEFAULT_NAME
+        end
+
+        def machine_vmname(machine)
+          machine.provider_config.vmname || machine_hostname(machine)
+        end
+      end
+    end
+  end
+end
+
+

data/lib/vagrant-ovirt4/version.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   module OVirtProvider
-    VERSION = '2.0.0'
+    VERSION = '2.2.0'
   end
 end
 

data/lib/vagrant-ovirt4.rb

@@ -1,3 +1,4 @@
+require 'log4r'
 require 'pathname'
 require 'vagrant-ovirt4/plugin'
 
@@ -8,9 +9,11 @@ module VagrantPlugins
     autoload :Errors, lib_path.join("errors")
     autoload :Util,   lib_path.join("util")
 
+    @@logger = Log4r::Logger.new("vagrant_ovirt4::provider")
     @@ovirt_connection = nil
     @@vms_service = nil
     def self.ovirt_connection
+      @@logger.warn('Use of deprecated OVirtProvider.ovirt_connection detected.')
       @@ovirt_connection
     end
 
@@ -19,6 +22,7 @@ module VagrantPlugins
     end
 
     def self.vms_service
+      @@logger.warn('Use of deprecated OVirtProvider.vms_service detected.')
       @@vms_service
     end
 

data/locales/en.yml

@@ -60,6 +60,8 @@ en:
       short_not_created: |-
         not created
     errors:
+      service_connection_error: |-
+        Error connecting to the oVirt cluster endpoint: "%{error_message}"
       remove_vm_error: |-
         Error removing VM '%{vm_name}'. oVirt error message was '%{error_message}'
       no_vm_error: |-

data/spec/spec_helper.rb

@@ -1 +1,3 @@
 require 'vagrant'
+
+require_relative 'support/shared_context'

data/spec/support/shared_context.rb

@@ -0,0 +1,39 @@
+require 'vagrant-ovirt4/config'
+
+shared_context 'provider:action' do
+  let(:app) { double('app') }
+
+  let(:env) {
+    {
+      connection: double('connection',
+        system_service: double('system_service', disks_service: double('disks_service'))
+      ),
+      machine: double('machine',
+        provider: double('provider'),
+        provider_config: VagrantPlugins::OVirtProvider::Config.new,
+        name: 'machname',
+        id: 'ID',
+        config: double('config',
+          vm: double('vm_config',
+            networks: [],
+          ),
+        ),
+      ),
+      ui: double('ui'),
+      vms_service: double('vms_service'),
+    }
+  }
+
+  let(:vm_service) {
+    double('vm_service',
+      disk_attachments_service: double('disk_attachments_service', list: []),
+      get: double('get'),
+    )
+  }
+
+  before do
+    allow(app).to receive(:call)
+    allow(env[:vms_service]).to receive(:vm_service).with(env[:machine].id).and_return(vm_service)
+    env[:machine].provider_config.finalize!
+  end
+end

data/spec/vagrant-ovirt4/action/create_vm_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'vagrant-ovirt4/action/create_vm'
+require 'vagrant-ovirt4/config'
+
+describe VagrantPlugins::OVirtProvider::Action::CreateVM do
+  include_context 'provider:action'
+
+  let(:vm) { double('vm', id: 'ID') }
+
+  subject(:action) { described_class.new(app, env) }
+
+  before do
+    allow(env[:ui]).to receive(:info)
+    allow(env[:machine]).to receive(:"id=").with(vm.id)
+    allow(vm_service.get).to receive(:status).and_return('down')
+  end
+
+  context 'given a custom vmname' do
+    let(:vmname) { 'VMNAME' }
+
+    it 'uses that as the name for machine creation' do
+      env[:machine].provider_config.vmname = vmname
+      expect(env[:vms_service]).to receive(:add).with(hash_including(name: vmname)).and_return(vm)
+      action.call(env)
+    end
+  end
+
+  context 'given no custom vmname' do
+    context 'given a custom hostname' do
+      let(:hostname) { 'HOSTNAME' }
+
+      it 'uses that as the name for machine creation' do
+        expect(env[:machine].config.vm).to receive(:hostname).and_return(hostname)
+        expect(env[:vms_service]).to receive(:add).with(hash_including(name: hostname)).and_return(vm)
+        action.call(env)
+      end
+    end
+
+    context 'given no custom hostname' do
+      it 'uses a default name for machine creation' do
+        expect(env[:machine].config.vm).to receive(:hostname)
+        expect(env[:vms_service]).to receive(:add).with(hash_including(name: 'vagrant')).and_return(vm)
+        action.call(env)
+      end
+    end
+  end
+end

data/spec/vagrant-ovirt4/action/read_ssh_info_spec.rb

@@ -17,7 +17,7 @@ describe VagrantPlugins::OVirtProvider::Action::ReadSSHInfo do
     expect(action).to receive(:call).with(env)
     action.call(env)
   end
-  
+
   context 'unknown API error' do
     before do
       allow(env.machine).to receive(:id).and_return('wat')
@@ -25,35 +25,35 @@ describe VagrantPlugins::OVirtProvider::Action::ReadSSHInfo do
       allow(env.vms_service.vm_service).to receive(:get).and_raise('boom')
 
     end
-  
-    it 'continues the middleware chain' do
+
+    it 'returns nil' do
       expect(app).to receive(:call).with(env)
       action.call(env)
-      expect(env.machine_ssh_info).to eq(:not_created)
+      expect(env.machine_ssh_info).to be_nil
     end
-
   end
 
   context 'machine does not exist' do
     before do
       allow(env.machine).to receive(:id).and_return(nil)
     end
-  
-    it 'continues the middleware chain' do
+
+    it 'returns nil' do
       expect(app).to receive(:call).with(env)
       action.call(env)
-      expect(env.machine_ssh_info).to eq(:not_created)
+      expect(env.machine_ssh_info).to be_nil
     end
-
   end
 
   context 'machine exists' do
+    let(:port)     { 44 }
+
     before do
       allow(env.machine).to receive(:id).and_return('wat')
       allow(env.machine).to receive(:config).and_return(OpenStruct.new({
         ssh: OpenStruct.new({
-          guest_port: 44,
-        }),
+          guest_port: port
+        })
       }))
       allow(env.vms_service).to receive(:vm_service).and_return({})
       allow(env.vms_service.vm_service).to receive(:get).and_return({})
@@ -61,13 +61,27 @@ describe VagrantPlugins::OVirtProvider::Action::ReadSSHInfo do
       allow(env.vms_service.vm_service.nics_service).to receive(:list).and_return({})
       allow(env.vms_service.vm_service.get).to receive(:status).and_return('active')
     end
-  
-    it 'continues the middleware chain' do
-      expect(app).to receive(:call).with(env)
-      action.call(env)
-      expect(env.machine_ssh_info).to eq({:host=>nil, :port=>44, :username=>nil, :private_key_path=>nil, :forward_agent=>nil, :forward_x11=>nil})
+
+    context 'with no IP addresses defined' do
+      it 'returns nil' do
+        expect(app).to receive(:call).with(env)
+        action.call(env)
+        expect(env.machine_ssh_info).to be_nil
+      end
     end
 
+    context 'with at least one IP address defined' do
+      let(:host) { '10.10.10.10' }
+
+      before do
+        allow(action).to receive(:first_active_ipv4_address).and_return(host)
+      end
+
+      it 'returns filled-out SSH information' do
+        expect(app).to receive(:call).with(env)
+        action.call(env)
+        expect(env.machine_ssh_info).to eq(host: host, port: port, username: nil, private_key_path: nil, forward_agent: nil, forward_x11: nil)
+      end
+    end
   end
 end
-

data/spec/vagrant-ovirt4/action/start_vm_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'vagrant-ovirt4/action/start_vm'
+require 'vagrant-ovirt4/config'
+
+describe VagrantPlugins::OVirtProvider::Action::StartVM do
+  include_context 'provider:action'
+
+  subject(:action) { described_class.new(app, env) }
+
+  before do
+    allow(env[:ui]).to receive(:info)
+    allow(env[:machine].config.vm).to receive(:hostname)
+    allow(vm_service.get).to receive(:status).and_return('nominal')
+    allow(vm_service).to receive(:start)
+  end
+
+  def vm_initialization_hash_including_hostname(hostname)
+    hash_including(vm: hash_including(initialization: hash_including(host_name: hostname)))
+  end
+
+  context 'given a custom hostname' do
+    let(:hostname) { 'HOSTNAME' }
+
+    it 'uses that as the hostname for machine initialization' do
+      expect(env[:machine].config.vm).to receive(:hostname).and_return(hostname)
+      expect(vm_service).to receive(:start).with(vm_initialization_hash_including_hostname(hostname))
+      action.call(env)
+    end
+  end
+
+  context 'given no custom hostname' do
+    it 'uses a default value as the hostname for machine initialization' do
+      expect(vm_service).to receive(:start).with(vm_initialization_hash_including_hostname('vagrant'))
+      action.call(env)
+    end
+  end
+
+  context 'given a custom run_once setting' do
+    [true, false].each do |value|
+      it 'uses that setting' do
+        env[:machine].provider_config.run_once = value
+        expect(vm_service).to receive(:start).with(hash_including(vm: hash_including(run_once: value)))
+        action.call(env)
+      end
+    end
+  end
+
+  context 'given no custom run_once setting' do
+    it 'defaults to false' do
+      expect(vm_service).to receive(:start).with(hash_including(vm: hash_including(run_once: false)))
+      action.call(env)
+    end
+  end
+end