Class: OsVm::Machine

Inherits:
Object
  • Object
show all
Defined in:
lib/osvm/machine.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, config, tmpdir, sockdir, default_timeout: 900, hash_base: '', interactive_console: false) ⇒ Machine

Returns a new instance of Machine.

Parameters:

  • name (String)
  • config (MachineConfig)
  • tmpdir (String)
  • sockdir (String)
  • default_timeout (Integer) (defaults to: 900)
  • hash_base (String) (defaults to: '')
  • interactive_console (Boolean) (defaults to: false) 


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/osvm/machine.rb', line 18

def initialize(name, config, tmpdir, sockdir, default_timeout: 900, hash_base: '', interactive_console: false)
  @can_use_virtiofs = Process.uid == 0

  if !@can_use_virtiofs && config.shared_filesystems.any?
    raise ArgumentError, 'Unable to mount shared file systems, must be run as root'
  end

  @name = name
  @config = config
  @tmpdir = tmpdir
  @sockdir = sockdir
  @default_timeout = default_timeout || 900
  @hash_base = hash_base
  @interactive_console = interactive_console
  @running = false
  @shell_up = false
  @shared_dir = SharedDir.new(self)
  @shared_filesystems = {
    shared_dir.fs_name => shared_dir.host_path,
  }.merge(config.shared_filesystems)
  @virtiofsd_pids = []
  @mutex = Mutex.new

  FileUtils.mkdir_p(tmpdir)
  FileUtils.mkdir_p(sockdir)
  @log = MachineLog.new(File.join(tmpdir, "#{name}-log.log"))
end

Instance Attribute Details

#config ⇒ Object (readonly, protected)

Returns the value of attribute config.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def config
  @config
end

#console_thread ⇒ Object (readonly, protected)

Returns the value of attribute console_thread.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def console_thread
  @console_thread
end

#hash_base ⇒ Object (readonly, protected)

Returns the value of attribute hash_base.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def hash_base
  @hash_base
end

#log ⇒ Object (readonly, protected)

Returns the value of attribute log.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def log
  @log
end

#name ⇒ String (readonly)

Returns:

  • (String) 


9
10
11
 
# File 'lib/osvm/machine.rb', line 9

def name
  @name
end

#qemu_pid ⇒ Object (readonly, protected)

Returns the value of attribute qemu_pid.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def qemu_pid
  @qemu_pid
end

#qemu_read ⇒ Object (readonly, protected)

Returns the value of attribute qemu_read.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def qemu_read
  @qemu_read
end

#qemu_reaper ⇒ Object (readonly, protected)

Returns the value of attribute qemu_reaper.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def qemu_reaper
  @qemu_reaper
end

#shared_dir ⇒ Object (readonly, protected)

Returns the value of attribute shared_dir.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def shared_dir
  @shared_dir
end

#shared_filesystems ⇒ Object (readonly, protected)

Returns the value of attribute shared_filesystems.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def shared_filesystems
  @shared_filesystems
end

#shell ⇒ Object (readonly, protected)

Returns the value of attribute shell.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def shell
  @shell
end

#shell_server ⇒ Object (readonly, protected)

Returns the value of attribute shell_server.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def shell_server
  @shell_server
end

#sockdir ⇒ Object (readonly, protected)

Returns the value of attribute sockdir.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def sockdir
  @sockdir
end

#tmpdir ⇒ Object (readonly, protected)

Returns the value of attribute tmpdir.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def tmpdir
  @tmpdir
end

#virtiofsd_pids ⇒ Object (readonly, protected)

Returns the value of attribute virtiofsd_pids.



442
443
444
 
# File 'lib/osvm/machine.rb', line 442

def virtiofsd_pids
  @virtiofsd_pids
end

Instance Method Details

#all_fail(*cmds) ⇒ Array<Array<[Integer, String]>>

Execute all commands and check that they all fail

Parameters:

  • cmds (String)

Returns:

  • (Array<Array<[Integer, String]>>) 


285
286
287
288
289
290
291
292
293
 
# File 'lib/osvm/machine.rb', line 285

def all_fail(*cmds)
  ret = []

  cmds.each do |cmd|
    ret << fails(cmd)
  end

  ret
end

#all_succeed(*cmds) ⇒ Array<Array<[Integer, String]>>

Execute all commands and check that they all succeed

Parameters:

  • cmds (String)

Returns:

  • (Array<Array<[Integer, String]>>) 


272
273
274
275
276
277
278
279
280
 
# File 'lib/osvm/machine.rb', line 272

def all_succeed(*cmds)
  ret = []

  cmds.each do |cmd|
    ret << succeeds(cmd)
  end

  ret
end

#booted? ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/osvm/machine.rb', line 185

def booted?
  shell_up?
end

#can_use_virtiofs? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


658
659
660
 
# File 'lib/osvm/machine.rb', line 658

def can_use_virtiofs?
  @can_use_virtiofs
end

#cleanup ⇒ Machine

Cleanup machine state

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/osvm/machine.rb', line 163

def cleanup
  begin
    File.unlink(shell_socket_path)
  rescue Errno::ENOENT
  end

  shared_filesystems.each_key do |fs_name|
    begin
      File.unlink(virtiofs_socket_path(fs_name))
    rescue Errno::ENOENT
    end
  end

  self
end

#console_log_path ⇒ Object (protected) 



646
647
648
 
# File 'lib/osvm/machine.rb', line 646

def console_log_path
  File.join(tmpdir, "#{name}-console.log")
end

#destroy ⇒ Machine

Destroy the machine

Returns:



154
155
156
157
158
159
 
# File 'lib/osvm/machine.rb', line 154

def destroy
  log.destroy
  shared_dir.destroy
  destroy_disks
  self
end

#destroy_disks ⇒ Object (protected) 



602
603
604
605
606
607
608
609
 
# File 'lib/osvm/machine.rb', line 602

def destroy_disks
  config.disks.each do |disk|
    next if disk.type != 'file'

    path = disk_path(disk.device)
    File.unlink(path) if File.exist?(path)
  end
end

#disk_path(path) ⇒ Object (protected) 



650
651
652
653
654
655
656
 
# File 'lib/osvm/machine.rb', line 650

def disk_path(path)
  if path.start_with?('/')
    path
  else
    File.join(tmpdir, path)
  end
end

#execute(cmd, timeout: @default_timeout) ⇒ Array<Integer, String>

Execute a command

Parameters:

  • cmd (String)
  • timeout (Integer) (defaults to: @default_timeout)

Returns:

  • (Array<Integer, String>) —

    exit status and output



199
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
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/osvm/machine.rb', line 199

def execute(cmd, timeout: @default_timeout)
  start unless running?
  wait_for_shell
  t1 = Time.now

  # It is a bit of a mystery why this write is needed. The shell just
  # sometimes swallows the first character, which would be a '(', and then
  # it complains about a syntax error. So we first write a character that
  # it can harmlessly swallow.
  shell.write("\n")

  shell.write("( #{cmd} ); echo '|!=EOF' $?\n")
  log.execute_begin(cmd)
  rx = /(.*)\|\!=EOF\s+(\d+)/m
  buffer = ''

  loop do
    if t1 + timeout < Time.now
      log.execute_end(-1, buffer)
      raise TimeoutError, "Timeout occured while running command '#{cmd}'"
    end

    rs, _ = IO.select([shell], [], [], 1)
    next if rs.nil?

    rs.each do |io|
      case io
      when shell
        buffer << read_nonblock(shell)
      end
    end

    if rx =~ buffer
      status = $2.to_i
      output = $1.strip

      log.execute_end(status, output)
      return [status, output]
    end
  end
end

#fails(cmd, timeout: @default_timeout) ⇒ Array<Integer, String>

Execute command and check that it fails

Parameters:

  • cmd (String)
  • timeout (Integer) (defaults to: @default_timeout)

Returns:

  • (Array<Integer, String>) 


259
260
261
262
263
264
265
266
267
 
# File 'lib/osvm/machine.rb', line 259

def fails(cmd, timeout: @default_timeout)
  status, output = execute(cmd, timeout: timeout)

  if status == 0
    raise CommandSucceeded, "Command '#{cmd}' succeeds with status #{status}. Output:\n #{output}"
  end

  return [status, output]
end

#finalize ⇒ Object 



46
47
48
 
# File 'lib/osvm/machine.rb', line 46

def finalize
  log.close
end

#inspect ⇒ Object 



437
438
439
 
# File 'lib/osvm/machine.rb', line 437

def inspect
  "#<#{self.class.name}:#{self.object_id} name=#{name}>"
end

#join(timeout: @default_timeout) ⇒ Object

Block until the machine stops



103
104
105
106
 
# File 'lib/osvm/machine.rb', line 103

def join(timeout: @default_timeout)
  qemu_reaper.join(timeout)
  nil
end

#kill ⇒ Machine

Kill the machine

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/osvm/machine.rb', line 124

def kill
  unless running?
    log.kill('NONE')
    return
  end

  log.kill('TERM')

  begin
    Process.kill('TERM', qemu_pid)
  rescue Errno::ESRCH
    warn "Unable to kill machine #{name} using SIGTERM"
  end

  return if qemu_reaper.join(60)

  log.kill('KILL')

  begin
    Process.kill('KILL', qemu_pid)
  rescue Errno::ESRCH
    warn "Unable to kill machine #{name} using SIGKILL"
  end

  qemu_reaper.join
  self
end

#mkdir(path) ⇒ Machine

Create a directory inside the machine

Parameters:

  • path (String) —

    path within the machine

Returns:



397
398
399
400
 
# File 'lib/osvm/machine.rb', line 397

def mkdir(path)
  succeeds("mkdir \"#{path}\"")
  self
end

#mkdir_p(path) ⇒ Machine

Create a directory inside the machine

Parameters:

  • path (String) —

    path within the machine

Returns:



405
406
407
408
 
# File 'lib/osvm/machine.rb', line 405

def mkdir_p(path)
  succeeds("mkdir -p \"#{path}\"")
  self
end

#osctl_json(cmd) ⇒ Hash

osctl command without `osctl`, output is returned as JSON

Parameters:

  • cmd (String)

Returns:

  • (Hash) 


360
361
362
363
 
# File 'lib/osvm/machine.rb', line 360

def osctl_json(cmd)
  status, output = succeeds("osctl -j #{cmd}")
  JSON.parse(output, symbolize_names: true)
end

#prepare_disks ⇒ Object (protected) 



592
593
594
595
596
597
598
599
600
 
# File 'lib/osvm/machine.rb', line 592

def prepare_disks
  config.disks.each do |disk|
    if disk.type != 'file' || !disk.create || File.exist?(disk_path(disk.device))
      next
    end

    `truncate -s#{disk.size} #{disk_path(disk.device)}`
  end
end

#pull_file(src, preserve: false) ⇒ String

Pull file from the machine to the host

Parameters:

  • src (String) —

    file within the machine

Returns:

  • (String) —

    path to the file on the host



429
430
431
432
433
434
435
 
# File 'lib/osvm/machine.rb', line 429

def pull_file(src, preserve: false)
  unless can_use_virtiofs?
    fail "#{$0} must be run as root for pull_file() to work"
  end

  shared_dir.pull_file(src, preserve: preserve)
end

#push_file(src, dst, preserve: false, mkpath: false) ⇒ Machine

Push file from the host to the machine

Parameters:

  • src (String) —

    file on the host

  • dst (String) —

    file within the machine

  • preserve (Boolean) (defaults to: false)
  • mkpath (Boolean) (defaults to: false)

Returns:



416
417
418
419
420
421
422
423
424
 
# File 'lib/osvm/machine.rb', line 416

def push_file(src, dst, preserve: false, mkpath: false)
  unless can_use_virtiofs?
    fail "#{$0} must be run as root for push_file() to work"
  end

  mkdir_p(File.dirname(dst)) if mkpath
  shared_dir.push_file(src, dst)
  self
end

#qemu_command(kernel_params: []) ⇒ Object (protected) 



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/osvm/machine.rb', line 446

def qemu_command(kernel_params: [])
  all_kernel_params = [
    "console=ttyS0",
    "init=#{config.toplevel}/init",
  ] + config.kernel_params + kernel_params

  [
    "#{config.qemu}/bin/qemu-kvm",
    "-name", "os-vm-#{name}",
    "-m", "#{config.memory}",
    "-cpu", "host",
    "-smp", "cpus=#{config.cpus},cores=#{config.cpu.cores},threads=#{config.cpu.threads},sockets=#{config.cpu.sockets}",
    "--no-reboot",
    "-device", "ahci,id=ahci",
  ] + config.network.qemu_options + [
    "-drive", "index=0,id=drive1,file=#{config.squashfs},readonly=on,media=cdrom,format=raw,if=virtio",
    "-chardev", "socket,id=shell,path=#{shell_socket_path}",
    "-device", "virtio-serial",
    "-device", "virtconsole,chardev=shell",
    "-kernel", config.kernel,
    "-initrd", config.initrd,
    "-append", "#{all_kernel_params.join(' ')}",
    "-nographic",
  ] + qemu_disk_options + qemu_virtiofs_options + config.extra_qemu_options
end

#qemu_disk_options ⇒ Object (protected) 



472
473
474
475
476
477
478
479
480
481
 
# File 'lib/osvm/machine.rb', line 472

def qemu_disk_options
  ret = []

  config.disks.each_with_index do |disk, i|
    ret << "-drive" << "id=disk#{i},file=#{disk_path(disk.device)},if=none,format=raw"
    ret << "-device" << "ide-hd,drive=disk#{i},bus=ahci.#{i}"
  end

  ret
end

#qemu_virtiofs_options ⇒ Object (protected) 



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/osvm/machine.rb', line 483

def qemu_virtiofs_options
  ret = []
  return ret unless can_use_virtiofs?

  shared_filesystems.each_with_index do |fs, i|
    name, _ = fs
    ret << "-chardev" << "socket,id=char#{i},path=#{virtiofs_socket_path(name)}"
    ret << "-device" << "vhost-user-fs-pci,queue-size=1024,chardev=char#{i},tag=#{name}"
  end

  if ret.any?
    ret << "-object" << "memory-backend-file,id=m0,size=#{config.memory}M,mem-path=/dev/shm,share=on"
    ret << "-numa" << "node,memdev=m0"
  end

  ret
end

#read_nonblock(io) ⇒ Object (protected) 



679
680
681
682
683
684
 
# File 'lib/osvm/machine.rb', line 679

def read_nonblock(io)
  io.read_nonblock(4096)

rescue IO::WaitReadable
  ''
end

#run_console_thread ⇒ Object (protected) 



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/osvm/machine.rb', line 570

def run_console_thread
  @console_thread = Thread.new do
    console_log = File.open(console_log_path, 'w')

    begin
      loop do
        rs, _ = IO.select([qemu_read])

        rs.each do |io|
          case io
          when qemu_read
            console_log.write(read_nonblock(qemu_read))
            console_log.flush
          end
        end
      end
    rescue EOFError
      console_log.close
    end
  end
end

#run_qemu_reaper(pid) ⇒ Object (protected) 



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/osvm/machine.rb', line 535

def run_qemu_reaper(pid)
  @qemu_reaper = Thread.new do
    Process.wait(pid)
    log.exit($?.exitstatus)

    @qemu_pid = nil

    if @qemu_read
      @qemu_read.close
      @qemu_read = nil
    end

    if @console_thread
      console_thread.join
      @console_thread = nil
    end

    shell_server.close
    @shell_server = nil

    if shell
      shell.close
      @shell = nil
    end

    stop_virtiofs

    cleanup

    @qemu_reaper = nil
    @shell_up = false
    @running = false
  end
end

#running? ⇒ Boolean

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/osvm/machine.rb', line 180

def running?
  @running
end

#shell_socket_path ⇒ Object (protected) 



642
643
644
 
# File 'lib/osvm/machine.rb', line 642

def shell_socket_path
  socket_path("#{name}-shell.sock")
end

#shell_up? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


675
676
677
 
# File 'lib/osvm/machine.rb', line 675

def shell_up?
  @shell_up
end

#socket_path(socket) ⇒ Object (protected) 



670
671
672
673
 
# File 'lib/osvm/machine.rb', line 670

def socket_path(socket)
  @socket_hash ||= Digest::SHA256.hexdigest([hash_base, name].join)[0..7]
  File.join(sockdir, "#{@socket_hash}-#{socket}")
end

#start(kernel_params: []) ⇒ Machine

Start the machine

Parameters:

  • kernel_params (Array<String>) (defaults to: [])

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
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
93
94
95
96
97
98
99
100
 
# File 'lib/osvm/machine.rb', line 53

def start(kernel_params: [])
  if running?
    fail 'Machine already started'
  end

  log.start
  prepare_disks

  # Clear-out left-over socket
  begin
    File.unlink(shell_socket_path)
  rescue Errno::ENOENT
  end

  @shell_server = UNIXServer.new(shell_socket_path)

  if can_use_virtiofs?
    shared_dir.setup
    start_virtiofs
    sleep(1)
  end

  qemu_kwargs = {}

  unless @interactive_console
    @qemu_read, w = IO.pipe

    qemu_kwargs = {
      in: :close,
      out: w,
      err: w,
    }
  end

  @qemu_pid = Process.spawn(
    *qemu_command(kernel_params: kernel_params),
    **qemu_kwargs,
  )
  w.close unless @interactive_console
  run_qemu_reaper(qemu_pid)

  @running = true

  run_console_thread unless @interactive_console

  @shell = @shell_server.accept
  self
end

#start_virtiofs ⇒ Object (protected) 



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/osvm/machine.rb', line 501

def start_virtiofs
  shared_filesystems.each do |name, path|
    f = File.open(virtiofs_log_path(name), 'w')

    virtiofsd_pids << Process.spawn(
      File.join(config.virtiofsd, 'bin/virtiofsd'),
      "--socket-path", virtiofs_socket_path(name),
      "--shared-dir", path,
      "--cache", "never",
      in: :close,
      out: f,
      err: f,
    )

    f.close
  end
end

#stop(timeout: @default_timeout) ⇒ Machine

Stop the machine

Parameters:

  • timeout (Integer) (defaults to: @default_timeout)

Returns:



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/osvm/machine.rb', line 111

def stop(timeout: @default_timeout)
  log.stop
  execute('poweroff -f')

  if qemu_reaper.join(timeout).nil?
    raise TimeoutError, "Timeout while stopping machine #{name}"
  end

  self
end

#stop_virtiofs ⇒ Object (protected) 



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/osvm/machine.rb', line 519

def stop_virtiofs
  virtiofsd_pids.delete_if do |pid|
    begin
      Process.kill('TERM', pid)
      false
    rescue Errno::ESRCH
      true
    end
  end

  virtiofsd_pids.delete_if do |pid|
    Process.wait(pid)
    true
  end
end

#succeeds(cmd, timeout: @default_timeout) ⇒ Array<Integer, String>

Execute command and check that it succeeds

Parameters:

  • cmd (String)
  • timeout (Integer) (defaults to: @default_timeout)

Returns:

  • (Array<Integer, String>) 


245
246
247
248
249
250
251
252
253
 
# File 'lib/osvm/machine.rb', line 245

def succeeds(cmd, timeout: @default_timeout)
  status, output = execute(cmd, timeout: timeout)

  if status != 0
    raise CommandFailed, "Command '#{cmd}' failed with status #{status}. Output:\n #{output}"
  end

  return [status, output]
end

#virtiofs_log_path(mount_name) ⇒ Object (protected) 



666
667
668
 
# File 'lib/osvm/machine.rb', line 666

def virtiofs_log_path(mount_name)
  File.join(tmpdir, "#{name}-fs-#{mount_name}.log")
end

#virtiofs_socket_path(mount_name) ⇒ Object (protected) 



662
663
664
 
# File 'lib/osvm/machine.rb', line 662

def virtiofs_socket_path(mount_name)
  socket_path("#{name}-fs-#{mount_name}.sock")
end

#wait_for_boot(timeout: @default_timeout) ⇒ Object

Wait until the system has booted

Parameters:

  • timeout (Integer) (defaults to: @default_timeout) 


191
192
193
 
# File 'lib/osvm/machine.rb', line 191

def wait_for_boot(timeout: @default_timeout)
  wait_for_shell(timeout: timeout)
end

#wait_for_osctl_pool(name, timeout: @default_timeout) ⇒ Machine

Wait for pool to be imported into osctld

Parameters:

  • name (String)
  • timeout (Integer) (defaults to: @default_timeout)

Returns:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/osvm/machine.rb', line 378

def wait_for_osctl_pool(name, timeout: @default_timeout)
  t1 = Time.now
  cur_timeout = timeout

  loop do
    status, output = wait_until_succeeds(
      "osctl pool show -H -o state #{name}",
      timeout: cur_timeout,
    )

    return self if output == 'active'

    cur_timeout = timeout - (Time.now - t1)
  end
end

#wait_for_service(name) ⇒ Machine

Wait for runit system service to start

Parameters:

  • name (String)

Returns:



352
353
354
355
 
# File 'lib/osvm/machine.rb', line 352

def wait_for_service(name)
  wait_until_succeeds("sv check #{name}")
  self
end

#wait_for_shell(timeout: @default_timeout) ⇒ Object (protected) 



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/osvm/machine.rb', line 611

def wait_for_shell(timeout: @default_timeout)
  fail "machine #{name} is not running" unless running?
  return if shell_up?

  t1 = Time.now
  buffer = ''

  loop do
    if t1 + timeout < Time.now
      raise TimeoutError, "Timeout occured while waiting for shell"
    end

    rs, _ = IO.select([shell], [], [], 1)
    next if rs.nil?

    rs.each do |io|
      case io
      when shell
        buffer << read_nonblock(shell)
      end
    end

    if buffer.include?("test-shell-ready\r\n")
      @shell_up = true
      succeeds("stty -F /dev/hvc0 -echo")
      shared_dir.mount if can_use_virtiofs?
      return
    end
  end
end

#wait_for_shutdown(timeout: @default_timeout) ⇒ Machine

Wait until the machine shuts down

Parameters:

  • timeout (Integer) (defaults to: @default_timeout)

Returns:



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/osvm/machine.rb', line 335

def wait_for_shutdown(timeout: @default_timeout)
  t1 = Time.now

  loop do
    return self unless running?

    if t1 + timeout < Time.now
      raise TimeoutError, "Timeout occured while waiting for shutdown"
    end

    sleep(1)
  end
end

#wait_for_zpool(name, timeout: @default_timeout) ⇒ Machine

Wait for zpool

Parameters:

  • name (String)
  • timeout (Integer) (defaults to: @default_timeout)

Returns:



369
370
371
372
 
# File 'lib/osvm/machine.rb', line 369

def wait_for_zpool(name, timeout: @default_timeout)
  wait_until_succeeds("zpool list #{name}", timeout: timeout)
  self
end

#wait_until_fails(cmd, timeout: @default_timeout) ⇒ Array<Integer, String>

Wait until command fails

Returns:

  • (Array<Integer, String>) 


312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/osvm/machine.rb', line 312

def wait_until_fails(cmd, timeout: @default_timeout)
  t1 = Time.now
  cur_timeout = timeout

  loop do
    status, output = execute(cmd, timeout: cur_timeout)
    return [status, output] if status != 0

    cur_timeout = timeout - (Time.now - t1)
    sleep(1)
  end
end

#wait_until_online(timeout: @default_timeout) ⇒ Machine

Wait until network is operational, including DNS

Returns:



327
328
329
330
 
# File 'lib/osvm/machine.rb', line 327

def wait_until_online(timeout: @default_timeout)
  wait_until_succeeds("curl --head https://vpsadminos.org", timeout: timeout)
  self
end

#wait_until_succeeds(cmd, timeout: @default_timeout) ⇒ Array<Integer, String>

Wait until command succeeds

Returns:

  • (Array<Integer, String>) 


297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/osvm/machine.rb', line 297

def wait_until_succeeds(cmd, timeout: @default_timeout)
  t1 = Time.now
  cur_timeout = timeout

  loop do
    status, output = execute(cmd, timeout: cur_timeout)
    return [status, output] if status == 0

    cur_timeout = timeout - (Time.now - t1)
    sleep(1)
  end
end