Class: Vagrant::Driver::VirtualBox_4_1

Inherits:
VirtualBoxBase show all
Defined in:
lib/vagrant/driver/virtualbox_4_1.rb

Overview

Driver for VirtualBox 4.1.x

Instance Method Summary collapse

Methods inherited from VirtualBoxBase

#execute, #raw

Methods included from Util::Retryable

#retryable

Constructor Details

#initialize(uuid) ⇒ VirtualBox_4_1

Returns a new instance of VirtualBox_4_1.



9
10
11
12
13
14
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 9

def initialize(uuid)
  super()

  @logger = Log4r::Logger.new("vagrant::driver::virtualbox_4_1")
  @uuid = uuid
end

Instance Method Details

#clear_forwarded_ports ⇒ Object 



16
17
18
19
20
21
22
23
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 16

def clear_forwarded_ports
  args = []
  read_forwarded_ports(@uuid).each do |nic, name, _, _|
    args.concat(["--natpf#{nic}", "delete", name])
  end

  execute("modifyvm", @uuid, *args) if !args.empty?
end

#clear_shared_folders ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 25

def clear_shared_folders
  info = execute("showvminfo", @uuid, "--machinereadable", :retryable => true)
  info.split("\n").each do |line|
    if line =~ /^SharedFolderNameMachineMapping\d+="(.+?)"$/
      execute("sharedfolder", "remove", @uuid, "--name", $1.to_s)
    end
  end
end

#create_dhcp_server(network, options) ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 34

def create_dhcp_server(network, options)
  execute("dhcpserver", "add", "--ifname", network,
          "--ip", options[:dhcp_ip],
          "--netmask", options[:netmask],
          "--lowerip", options[:dhcp_lower],
          "--upperip", options[:dhcp_upper],
          "--enable")
end

#create_host_only_network(options) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 43

def create_host_only_network(options)
  # Create the interface
  execute("hostonlyif", "create") =~ /^Interface '(.+?)' was successfully created$/
  name = $1.to_s

  # Configure it
  execute("hostonlyif", "ipconfig", name,
          "--ip", options[:adapter_ip],
          "--netmask", options[:netmask])

  # Return the details
  return {
    :name => name,
    :ip   => options[:adapter_ip],
    :netmask => options[:netmask],
    :dhcp => nil
  }
end

#delete ⇒ Object 



62
63
64
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 62

def delete
  execute("unregistervm", @uuid, "--delete")
end

#delete_unused_host_only_networks ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 66

def delete_unused_host_only_networks
  networks = []
  execute("list", "hostonlyifs").split("\n").each do |line|
    networks << $1.to_s if line =~ /^Name:\s+(.+?)$/
  end

  execute("list", "vms").split("\n").each do |line|
    if line =~ /^".+?"\s+\{(.+?)\}$/
      info = execute("showvminfo", $1.to_s, "--machinereadable", :retryable => true)
      info.split("\n").each do |line|
        if line =~ /^hostonlyadapter\d+="(.+?)"$/
          networks.delete($1.to_s)
        end
      end
    end
  end

  networks.each do |name|
    # First try to remove any DHCP servers attached. We use `raw` because
    # it is okay if this fails. It usually means that a DHCP server was
    # never attached.
    raw("dhcpserver", "remove", "--ifname", name)

    # Delete the actual host only network interface.
    execute("hostonlyif", "remove", name)
  end
end

#discard_saved_state ⇒ Object 



94
95
96
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 94

def discard_saved_state
  execute("discardstate", @uuid)
end

#enable_adapters(adapters) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 98

def enable_adapters(adapters)
  args = []
  adapters.each do |adapter|
    args.concat(["--nic#{adapter[:adapter]}", adapter[:type].to_s])

    if adapter[:bridge]
      args.concat(["--bridgeadapter#{adapter[:adapter]}",
                   adapter[:bridge]])
    end

    if adapter[:hostonly]
      args.concat(["--hostonlyadapter#{adapter[:adapter]}",
                   adapter[:hostonly]])
    end

    if adapter[:mac_address]
      args.concat(["--macaddress#{adapter[:adapter]}",
                   adapter[:mac_address]])
    end

    if adapter[:nic_type]
      args.concat(["--nictype#{adapter[:adapter]}", adapter[:nic_type].to_s])
    end
  end

  execute("modifyvm", @uuid, *args)
end

#execute_command(command) ⇒ Object 



126
127
128
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 126

def execute_command(command)
  raw(*command)
end

#export(path) ⇒ Object 



130
131
132
133
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 130

def export(path)
  # TODO: Progress
  execute("export", @uuid, "--output", path.to_s)
end

#forward_ports(ports) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 135

def forward_ports(ports)
  args = []
  ports.each do |options|
    pf_builder = [options[:name],
                  options[:protocol] || "tcp",
                  "",
                  options[:hostport],
                  "",
                  options[:guestport]]

    args.concat(["--natpf#{options[:adapter] || 1}",
                 pf_builder.join(",")])
  end

  execute("modifyvm", @uuid, *args) if !args.empty?
end

#halt ⇒ Object 



152
153
154
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 152

def halt
  execute("controlvm", @uuid, "poweroff")
end

#import(ovf) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 156

def import(ovf)
  output = ""
  total = ""
  last  = 0
  execute("import", ovf) do |type, data|
    if type == :stdout
      # Keep track of the stdout so that we can get the VM name
      output << data
    elsif type == :stderr
      # Append the data so we can see the full view
      total << data

      # Break up the lines. We can't get the progress until we see an "OK"
      lines = total.split("\n")
      if lines.include?("OK.")
        # The progress of the import will be in the last line. Do a greedy
        # regular expression to find what we're looking for.
        if lines.last =~ /.+(\d{2})%/
          current = $1.to_i
          if current > last
            last = current
            yield current if block_given?
          end
        end
      end
    end
  end

  # Find the name of the VM name
  if output !~ /Suggested VM name "(.+?)"/
    @logger.error("Couldn't find VM name in the output.")
    return nil
  end

  name = $1.to_s

  output = execute("list", "vms")
  if output =~ /^"#{Regexp.escape(name)}" \{(.+?)\}$/
    return $1.to_s
  end

  nil
end

#read_bridged_interfaces ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 230

def read_bridged_interfaces
  execute("list", "bridgedifs").split("\n\n").collect do |block|
    info = {}

    block.split("\n").each do |line|
      if line =~ /^Name:\s+(.+?)$/
        info[:name] = $1.to_s
      elsif line =~ /^IPAddress:\s+(.+?)$/
        info[:ip] = $1.to_s
      elsif line =~ /^NetworkMask:\s+(.+?)$/
        info[:netmask] = $1.to_s
      elsif line =~ /^Status:\s+(.+?)$/
        info[:status] = $1.to_s
      end
    end

    # Return the info to build up the results
    info
  end
end

#read_forwarded_ports(uuid = nil, active_only = false) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 200

def read_forwarded_ports(uuid=nil, active_only=false)
  uuid ||= @uuid

  @logger.debug("read_forward_ports: uuid=#{uuid} active_only=#{active_only}")

  results = []
  current_nic = nil
  info = execute("showvminfo", uuid, "--machinereadable", :retryable => true)
  info.split("\n").each do |line|
    # This is how we find the nic that a FP is attached to,
    # since this comes first.
    current_nic = $1.to_i if line =~ /^nic(\d+)=".+?"$/

    # If we care about active VMs only, then we check the state
    # to verify the VM is running.
    if active_only && line =~ /^VMState="(.+?)"$/ && $1.to_s != "running"
      return []
    end

    # Parse out the forwarded port information
    if line =~ /^Forwarding.+?="(.+?),.+?,.*?,(.+?),.*?,(.+?)"$/
      result = [current_nic, $1.to_s, $2.to_i, $3.to_i]
      @logger.debug("  - #{result.inspect}")
      results << result
    end
  end

  results
end

#read_guest_additions_version ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 251

def read_guest_additions_version
  output = execute("guestproperty", "get", @uuid, "/VirtualBox/GuestAdd/Version",
                   :retryable => true)
  if output =~ /^Value: (.+?)$/
    # Split the version by _ since some distro versions modify it
    # to look like this: 4.1.2_ubuntu, and the distro part isn't
    # too important.
    value = $1.to_s
    return value.split("_").first
  end

  return nil
end

#read_host_only_interfaces ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 265

def read_host_only_interfaces
  dhcp = {}
  execute("list", "dhcpservers", :retryable => true).split("\n\n").each do |block|
    info = {}

    block.split("\n").each do |line|
      if line =~ /^NetworkName:\s+HostInterfaceNetworking-(.+?)$/
        info[:network] = $1.to_s
      elsif line =~ /^IP:\s+(.+?)$/
        info[:ip] = $1.to_s
      elsif line =~ /^lowerIPAddress:\s+(.+?)$/
        info[:lower] = $1.to_s
      elsif line =~ /^upperIPAddress:\s+(.+?)$/
        info[:upper] = $1.to_s
      end
    end

    # Set the DHCP info
    dhcp[info[:network]] = info
  end

  execute("list", "hostonlyifs", :retryable => true).split("\n\n").collect do |block|
    info = {}

    block.split("\n").each do |line|
      if line =~ /^Name:\s+(.+?)$/
        info[:name] = $1.to_s
      elsif line =~ /^IPAddress:\s+(.+?)$/
        info[:ip] = $1.to_s
      elsif line =~ /^NetworkMask:\s+(.+?)$/
        info[:netmask] = $1.to_s
      elsif line =~ /^Status:\s+(.+?)$/
        info[:status] = $1.to_s
      end
    end

    # Set the DHCP info if it exists
    info[:dhcp] = dhcp[info[:name]] if dhcp[info[:name]]

    info
  end
end

#read_mac_address ⇒ Object 



308
309
310
311
312
313
314
315
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 308

def read_mac_address
  info = execute("showvminfo", @uuid, "--machinereadable", :retryable => true)
  info.split("\n").each do |line|
    return $1.to_s if line =~ /^macaddress1="(.+?)"$/
  end

  nil
end

#read_machine_folder ⇒ Object 



317
318
319
320
321
322
323
324
325
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 317

def read_machine_folder
  execute("list", "systemproperties", :retryable => true).split("\n").each do |line|
    if line =~ /^Default machine folder:\s+(.+?)$/i
      return $1.to_s
    end
  end

  nil
end

#read_network_interfaces ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 327

def read_network_interfaces
  nics = {}
  info = execute("showvminfo", @uuid, "--machinereadable", :retryable => true)
  info.split("\n").each do |line|
    if line =~ /^nic(\d+)="(.+?)"$/
      adapter = $1.to_i
      type    = $2.to_sym

      nics[adapter] ||= {}
      nics[adapter][:type] = type
    elsif line =~ /^hostonlyadapter(\d+)="(.+?)"$/
      adapter = $1.to_i
      network = $2.to_s

      nics[adapter] ||= {}
      nics[adapter][:hostonly] = network
    elsif line =~ /^bridgeadapter(\d+)="(.+?)"$/
      adapter = $1.to_i
      network = $2.to_s

      nics[adapter] ||= {}
      nics[adapter][:bridge] = network
    end
  end

  nics
end

#read_state ⇒ Object 



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 355

def read_state
  output = execute("showvminfo", @uuid, "--machinereadable", :retryable => true)
  if output =~ /^name="<inaccessible>"$/
    return :inaccessible
  elsif output =~ /^VMState="(.+?)"$/
    return $1.to_sym
  end

  nil
end

#read_used_ports ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 366

def read_used_ports
  ports = []
  execute("list", "vms", :retryable => true).split("\n").each do |line|
    if line =~ /^".+?" \{(.+?)\}$/
      uuid = $1.to_s

      # Ignore our own used ports
      next if uuid == @uuid

      read_forwarded_ports(uuid, true).each do |_, _, hostport, _|
        ports << hostport
      end
    end
  end

  ports
end

#read_vms ⇒ Object 



384
385
386
387
388
389
390
391
392
393
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 384

def read_vms
  results = []
  execute("list", "vms", :retryable => true).split("\n").each do |line|
    if line =~ /^".+?" \{(.+?)\}$/
      results << $1.to_s
    end
  end

  results
end

#set_mac_address(mac) ⇒ Object 



395
396
397
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 395

def set_mac_address(mac)
  execute("modifyvm", @uuid, "--macaddress1", mac)
end

#set_name(name) ⇒ Object 



399
400
401
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 399

def set_name(name)
  execute("modifyvm", @uuid, "--name", name)
end

#share_folders(folders) ⇒ Object 



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 403

def share_folders(folders)
  folders.each do |folder|
    args = ["--name",
            folder[:name],
            "--hostpath",
            folder[:hostpath]]
    args << "--transient" if folder.has_key?(:transient) && folder[:transient]
    execute("sharedfolder", "add", @uuid, *args)
  end
end

#ssh_port(expected_port) ⇒ Object 



414
415
416
417
418
419
420
421
422
423
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 414

def ssh_port(expected_port)
  @logger.debug("Searching for SSH port: #{expected_port.inspect}")

  # Look for the forwarded port only by comparing the guest port
  read_forwarded_ports.each do |_, _, hostport, guestport|
    return hostport if guestport == expected_port
  end

  nil
end

#start(mode) ⇒ Object

Raises:



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 425

def start(mode)
  command = ["startvm", @uuid, "--type", mode.to_s]
  r = raw(*command)

  if r.exit_code == 0 || r.stdout =~ /VM ".+?" has been successfully started/
    # Some systems return an exit code 1 for some reason. For that
    # we depend on the output.
    return true
  end

  # If we reached this point then it didn't work out.
  raise Errors::VBoxManageError, :command => command.inspect
end

#suspend ⇒ Object 



439
440
441
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 439

def suspend
  execute("controlvm", @uuid, "savestate")
end

#verify! ⇒ Object 



443
444
445
446
447
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 443

def verify!
  # This command sometimes fails if kernel drivers aren't properly loaded
  # so we just run the command and verify that it succeeded.
  execute("list", "hostonlyifs")
end

#verify_image(path) ⇒ Object 



449
450
451
452
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 449

def verify_image(path)
  r = raw("import", path.to_s, "--dry-run")
  return r.exit_code == 0
end

#vm_exists?(uuid) ⇒ Boolean

Returns:

  • (Boolean) 


454
455
456
 
# File 'lib/vagrant/driver/virtualbox_4_1.rb', line 454

def vm_exists?(uuid)
  raw("showvminfo", uuid).exit_code == 0
end