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) 


17
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
 
# File 'lib/osvm/machine.rb', line 17

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.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def config
  @config
end

#console_thread ⇒ Object (readonly, protected)

Returns the value of attribute console_thread.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def console_thread
  @console_thread
end

#hash_base ⇒ Object (readonly, protected)

Returns the value of attribute hash_base.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def hash_base
  @hash_base
end

#log ⇒ Object (readonly, protected)

Returns the value of attribute log.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def log
  @log
end

#name ⇒ String (readonly)

Returns:

  • (String) 


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

def name
  @name
end

#qemu_pid ⇒ Object (readonly, protected)

Returns the value of attribute qemu_pid.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def qemu_pid
  @qemu_pid
end

#qemu_read ⇒ Object (readonly, protected)

Returns the value of attribute qemu_read.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def qemu_read
  @qemu_read
end

#qemu_reaper ⇒ Object (readonly, protected)

Returns the value of attribute qemu_reaper.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def qemu_reaper
  @qemu_reaper
end

#shared_dir ⇒ Object (readonly, protected)

Returns the value of attribute shared_dir.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def shared_dir
  @shared_dir
end

#shared_filesystems ⇒ Object (readonly, protected)

Returns the value of attribute shared_filesystems.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def shared_filesystems
  @shared_filesystems
end

#shell ⇒ Object (readonly, protected)

Returns the value of attribute shell.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def shell
  @shell
end

#shell_server ⇒ Object (readonly, protected)

Returns the value of attribute shell_server.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def shell_server
  @shell_server
end

#sockdir ⇒ Object (readonly, protected)

Returns the value of attribute sockdir.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def sockdir
  @sockdir
end

#tmpdir ⇒ Object (readonly, protected)

Returns the value of attribute tmpdir.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

def tmpdir
  @tmpdir
end

#virtiofsd_pids ⇒ Object (readonly, protected)

Returns the value of attribute virtiofsd_pids.



425
426
427
 
# File 'lib/osvm/machine.rb', line 425

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]>>) 


273
274
275
 
# File 'lib/osvm/machine.rb', line 273

def all_fail(*cmds)
  cmds.map { |cmd| fails(cmd) }
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]>>) 


266
267
268
 
# File 'lib/osvm/machine.rb', line 266

def all_succeed(*cmds)
  cmds.map { |cmd| succeeds(cmd) }
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) 


629
630
631
 
# File 'lib/osvm/machine.rb', line 629

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
    # ignore
  end

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

  self
end

#console_log_path ⇒ Object (protected) 



617
618
619
 
# File 'lib/osvm/machine.rb', line 617

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) 



579
580
581
582
583
584
585
586
 
# File 'lib/osvm/machine.rb', line 579

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

    path = disk_path(disk.device)
    FileUtils.rm_f(path)
  end
end

#disk_path(path) ⇒ Object (protected) 



621
622
623
624
625
626
627
 
# File 'lib/osvm/machine.rb', line 621

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
 
# 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 = shell.wait_readable(1)
    next unless rs

    buffer << read_nonblock(shell)
    next unless rx =~ buffer

    status = ::Regexp.last_match(2).to_i
    output = ::Regexp.last_match(1).strip

    log.execute_end(status, output)
    return [status, output]
  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>) 


253
254
255
256
257
258
259
260
261
 
# File 'lib/osvm/machine.rb', line 253

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

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

  [status, output]
end

#finalize ⇒ Object 



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

def finalize
  log.close
end

#inspect ⇒ Object 



419
420
421
 
# File 'lib/osvm/machine.rb', line 419

def inspect
  "#<#{self.class.name}:#{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:



379
380
381
382
 
# File 'lib/osvm/machine.rb', line 379

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:



387
388
389
390
 
# File 'lib/osvm/machine.rb', line 387

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) 


342
343
344
345
 
# File 'lib/osvm/machine.rb', line 342

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

#prepare_disks ⇒ Object (protected) 



569
570
571
572
573
574
575
576
577
 
# File 'lib/osvm/machine.rb', line 569

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



411
412
413
414
415
416
417
 
# File 'lib/osvm/machine.rb', line 411

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

  shared_dir.pull_file(src, 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:



398
399
400
401
402
403
404
405
406
 
# File 'lib/osvm/machine.rb', line 398

def push_file(src, dst, preserve: false, mkpath: false)
  unless can_use_virtiofs?
    raise "#{$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) 



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/osvm/machine.rb', line 429

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.to_s,
    '-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) 



455
456
457
458
459
460
461
462
463
464
 
# File 'lib/osvm/machine.rb', line 455

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) 



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/osvm/machine.rb', line 466

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) 



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

def read_nonblock(io)
  io.read_nonblock(4096)
rescue IO::WaitReadable
  ''
end

#run_console_thread ⇒ Object (protected) 



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/osvm/machine.rb', line 551

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

    begin
      loop do
        rs = qemu_read.wait_readable
        next unless rs

        console_log.write(read_nonblock(qemu_read))
        console_log.flush
      end
    rescue EOFError
      console_log.close
    end
  end
end

#run_qemu_reaper(pid) ⇒ Object (protected) 



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/osvm/machine.rb', line 516

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) 



613
614
615
 
# File 'lib/osvm/machine.rb', line 613

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

#shell_up? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


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

def shell_up?
  @shell_up
end

#socket_path(socket) ⇒ Object (protected) 



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

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:



52
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 52

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

  log.start
  prepare_disks

  # Clear-out left-over socket
  begin
    File.unlink(shell_socket_path)
  rescue Errno::ENOENT
    # ignore
  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:),
    **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) 



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

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) 



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

def stop_virtiofs
  virtiofsd_pids.delete_if do |pid|
    Process.kill('TERM', pid)
    false
  rescue Errno::ESRCH
    true
  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>) 


239
240
241
242
243
244
245
246
247
 
# File 'lib/osvm/machine.rb', line 239

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

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

  [status, output]
end

#virtiofs_log_path(mount_name) ⇒ Object (protected) 



637
638
639
 
# File 'lib/osvm/machine.rb', line 637

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

#virtiofs_socket_path(mount_name) ⇒ Object (protected) 



633
634
635
 
# File 'lib/osvm/machine.rb', line 633

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:)
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:



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/osvm/machine.rb', line 360

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:



334
335
336
337
 
# File 'lib/osvm/machine.rb', line 334

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

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



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/osvm/machine.rb', line 588

def wait_for_shell(timeout: @default_timeout)
  raise "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 = shell.wait_readable(1)
    next unless rs

    buffer << read_nonblock(shell)
    next unless 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

#wait_for_shutdown(timeout: @default_timeout) ⇒ Machine

Wait until the machine shuts down

Parameters:

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

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/osvm/machine.rb', line 317

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:



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

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

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

Wait until command fails

Returns:

  • (Array<Integer, String>) 


294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/osvm/machine.rb', line 294

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:



309
310
311
312
 
# File 'lib/osvm/machine.rb', line 309

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

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

Wait until command succeeds

Returns:

  • (Array<Integer, String>) 


279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/osvm/machine.rb', line 279

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