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: 600, 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: 600)
  • hash_base (String) (defaults to: '')
  • interactive_console (Boolean) (defaults to: false) 


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 23

def initialize(name, config, tmpdir, sockdir, default_timeout: 600, hash_base: '', interactive_console: false)
  @name = name
  @config = config
  @tmpdir = tmpdir
  @sockdir = sockdir
  @default_timeout = default_timeout
  @hash_base = hash_base
  @interactive_console = interactive_console
  @start_kernel_params = []
  @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.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def config
  @config
end

#console_thread ⇒ Object (readonly, protected)

Returns the value of attribute console_thread.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def console_thread
  @console_thread
end

#hash_base ⇒ Object (readonly, protected)

Returns the value of attribute hash_base.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def hash_base
  @hash_base
end

#log ⇒ Object (readonly, protected)

Returns the value of attribute log.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def log
  @log
end

#name ⇒ String (readonly)

Returns:

  • (String) 


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

def name
  @name
end

#qemu_pid ⇒ Object (readonly, protected)

Returns the value of attribute qemu_pid.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def qemu_pid
  @qemu_pid
end

#qemu_read ⇒ Object (readonly, protected)

Returns the value of attribute qemu_read.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def qemu_read
  @qemu_read
end

#qemu_reaper ⇒ Object (readonly, protected)

Returns the value of attribute qemu_reaper.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def qemu_reaper
  @qemu_reaper
end

#shared_dir ⇒ Object (readonly, protected)

Returns the value of attribute shared_dir.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def shared_dir
  @shared_dir
end

#shared_filesystems ⇒ Object (readonly, protected)

Returns the value of attribute shared_filesystems.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def shared_filesystems
  @shared_filesystems
end

#shell ⇒ Object (readonly, protected)

Returns the value of attribute shell.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def shell
  @shell
end

#shell_server ⇒ Object (readonly, protected)

Returns the value of attribute shell_server.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def shell_server
  @shell_server
end

#sockdir ⇒ Object (readonly, protected)

Returns the value of attribute sockdir.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def sockdir
  @sockdir
end

#start_kernel_params ⇒ Array<String> (readonly)

Kernel parameters passed to #start

Returns:

  • (Array<String>) 


14
15
16
 
# File 'lib/osvm/machine.rb', line 14

def start_kernel_params
  @start_kernel_params
end

#tmpdir ⇒ Object (readonly, protected)

Returns the value of attribute tmpdir.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

def tmpdir
  @tmpdir
end

#virtiofsd_pids ⇒ Object (readonly, protected)

Returns the value of attribute virtiofsd_pids.



543
544
545
 
# File 'lib/osvm/machine.rb', line 543

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


317
318
319
 
# File 'lib/osvm/machine.rb', line 317

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


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

def all_succeed(*cmds)
  cmds.map { |cmd| succeeds(cmd) }
end

#booted? ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/osvm/machine.rb', line 215

def booted?
  shell_up?
end

#can_execute? ⇒ Boolean

Returns:

  • (Boolean) 


220
221
222
 
# File 'lib/osvm/machine.rb', line 220

def can_execute?
  shell_up?
end

#cleanup ⇒ Machine

Cleanup machine state

Returns:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/osvm/machine.rb', line 193

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) 



735
736
737
 
# File 'lib/osvm/machine.rb', line 735

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

#destroy ⇒ Machine

Destroy the machine

Returns:



168
169
170
171
172
173
 
# File 'lib/osvm/machine.rb', line 168

def destroy
  log.destroy
  shared_dir.destroy
  destroy_disks
  self
end

#destroy_disks ⇒ Machine

Destroy file-backed disks

Disks are destroyed automatically or when #destroy is called. #destroy_disks can be used to reset storage between machine runs.

Returns:



181
182
183
184
185
186
187
188
189
 
# File 'lib/osvm/machine.rb', line 181

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

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

  self
end

#disk_path(path) ⇒ Object (protected) 



739
740
741
742
743
744
745
746
747
 
# File 'lib/osvm/machine.rb', line 739

def disk_path(path)
  resolved = path.gsub('{machine}', name)

  if resolved.start_with?('/')
    resolved
  else
    File.join(tmpdir, resolved)
  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

Raises:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/osvm/machine.rb', line 235

def execute(cmd, timeout: @default_timeout)
  start unless running?
  wait_for_shell

  real_timeout = [timeout, 5].max
  vm_command = "set -euo pipefail; #{cmd}"
  timeout_command = "timeout #{real_timeout}"

  # For unknown reason, the first character written to the shell is cut. Sometimes
  # more characters are lost. We therefore prefix the executed command with whitespace
  # which can be lost.
  workaround = ' ' * 10

  shell.write("#{workaround}#{timeout_command} bash -c #{Shellwords.escape(vm_command)} 2>&1 | (base64 -w 0; echo)\n")
  log.execute_begin(cmd)

  begin
    raw_output = read_shell_output(timeout: real_timeout + 5, command: vm_command)
  rescue MachineShellClosed
    log.execute_end(-1, '[machine shell closed]')
    raise
  end

  output = Base64.decode64(raw_output)

  shell.write("#{workaround}echo ${PIPESTATUS[0]}\n")

  begin
    status = read_shell_output(timeout: 60, command: 'echo ${PIPESTATUS[0]}').strip.to_i
  rescue MachineShellClosed
    log.execute_end(-1, output)
    raise
  end

  if timeout && status == 124
    log.execute_end(-1, output)
    raise TimeoutError, "Timeout occurred while running command '#{cmd}', " \
                        "output: #{output.inspect}"
  end

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


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

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 



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

def finalize
  log.close
end

#inspect ⇒ Object 



537
538
539
 
# File 'lib/osvm/machine.rb', line 537

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

#join(timeout: @default_timeout) ⇒ Object

Block until the machine stops



111
112
113
114
 
# File 'lib/osvm/machine.rb', line 111

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

#kill(signal: 'TERM') ⇒ Machine

Kill the machine

Parameters:

  • signal ('TERM', 'KILL') (defaults to: 'TERM')

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/osvm/machine.rb', line 133

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

  log.kill(signal)

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

  if signal == 'KILL'
    qemu_reaper.join
    return self
  elsif qemu_reaper.join(60)
    return self
  end

  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:



505
506
507
508
 
# File 'lib/osvm/machine.rb', line 505

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:



513
514
515
516
 
# File 'lib/osvm/machine.rb', line 513

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) 


401
402
403
404
 
# File 'lib/osvm/machine.rb', line 401

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

#prepare_disks ⇒ Object (protected) 



694
695
696
697
698
699
700
 
# File 'lib/osvm/machine.rb', line 694

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

    `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



533
534
535
 
# File 'lib/osvm/machine.rb', line 533

def pull_file(src, preserve: false)
  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:



524
525
526
527
528
 
# File 'lib/osvm/machine.rb', line 524

def push_file(src, dst, preserve: false, mkpath: false)
  mkdir_p(File.dirname(dst)) if mkpath
  shared_dir.push_file(src, dst)
  self
end

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



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/osvm/machine.rb', line 547

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.networks.map(&:qemu_options).flatten + [
    '-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) 



573
574
575
576
577
578
579
580
581
582
 
# File 'lib/osvm/machine.rb', line 573

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) 



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/osvm/machine.rb', line 584

def qemu_virtiofs_options
  ret = []

  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) 



792
793
794
795
796
 
# File 'lib/osvm/machine.rb', line 792

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

#read_shell_output(timeout:, command:) ⇒ Object (protected) 



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/osvm/machine.rb', line 766

def read_shell_output(timeout:, command:)
  t1 = Time.now
  buffer = ''

  loop do
    if t1 + timeout < Time.now
      raise UnrecoverableTimeoutError, "Timeout occurred while running command '#{command}', " \
                                       "buffer contents: #{buffer.inspect}"
    end

    rs = shell.wait_readable(1)
    next unless rs

    begin
      buffer << read_nonblock(shell)
    rescue EOFError
      @shell_up = false
      raise MachineShellClosed
    end

    break if buffer.end_with?("\n")
  end

  buffer
end

#run_console_thread ⇒ Object (protected) 



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/osvm/machine.rb', line 669

def run_console_thread
  @console_output = ''

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

    begin
      loop do
        rs = qemu_read.wait_readable
        next unless rs

        data = read_nonblock(qemu_read)
        @console_output << data

        console_log.write(data)
        console_log.flush
      end
    rescue EOFError
      console_log.close
    rescue IOError
      # pass
    end
  end
end

#run_qemu_reaper(pid) ⇒ Object (protected) 



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/osvm/machine.rb', line 633

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
    @stopped_at = Time.now
  end
end

#running? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/osvm/machine.rb', line 210

def running?
  @running
end

#shell_socket_path ⇒ Object (protected) 



731
732
733
 
# File 'lib/osvm/machine.rb', line 731

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

#shell_up? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


762
763
764
 
# File 'lib/osvm/machine.rb', line 762

def shell_up?
  @shell_up
end

#socket_path(socket) ⇒ Object (protected) 



757
758
759
760
 
# File 'lib/osvm/machine.rb', line 757

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
101
102
103
104
105
106
107
108
 
# File 'lib/osvm/machine.rb', line 53

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

  # virtiofsd cannot be relaunched right away, it needs some time settle
  # for unknown reasons, so we ensure there's a 5 second gap between stop
  # and start of this machine
  if @stopped_at
    diff = Time.now - @stopped_at
    delay = 5
    sleep([delay - diff, delay].min) if diff <= delay
  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)

  shared_dir.setup
  start_virtiofs
  sleep(1)

  qemu_kwargs = {}

  unless @interactive_console
    @qemu_read, w = IO.pipe

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

  @start_kernel_params = kernel_params

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



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/osvm/machine.rb', line 601

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:



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/osvm/machine.rb', line 119

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

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

  self
end

#stop_virtiofs ⇒ Object (protected) 



619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/osvm/machine.rb', line 619

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


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

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) 



753
754
755
 
# File 'lib/osvm/machine.rb', line 753

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

#virtiofs_socket_path(mount_name) ⇒ Object (protected) 



749
750
751
 
# File 'lib/osvm/machine.rb', line 749

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) 


226
227
228
 
# File 'lib/osvm/machine.rb', line 226

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

#wait_for_console_text(regex, timeout: @default_timeout) ⇒ Machine

Wait for text to appear in console output

Parameters:

  • regex (Regexp)

Returns:



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/osvm/machine.rb', line 474

def wait_for_console_text(regex, timeout: @default_timeout)
  t1 = Time.now
  cur_timeout = timeout

  log.console_wait_begin(regex)

  loop do
    if regex =~ @console_output
      log.console_wait_end(true)
      return self
    end

    cur_timeout = timeout - (Time.now - t1)

    if cur_timeout <= 0
      log.console_wait_end(false, 'timeout')
      raise TimeoutError, "Timeout occurred while waiting for #{regex.inspect} on the console"
    elsif !running?
      log.console_wait_end(false, 'machine not running')
      raise Error, 'Machine is not running'
    end

    sleep(1)
  end

  self
end

#wait_for_osctl_container(id, state: 'running', timeout: @default_timeout) ⇒ Machine

Wait for osctl container to exist and be in a given state

Parameters:

  • id (String)
  • state (String) (defaults to: 'running')

Returns:



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

def wait_for_osctl_container(id, state: 'running', timeout: @default_timeout)
  t1 = Time.now
  cur_timeout = timeout

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

    return self if output.strip == state

    cur_timeout = timeout - (Time.now - t1)

    if cur_timeout <= 0
      raise TimeoutError, "Timeout occurred while waiting for container #{id.inspect} to become #{state}"
    end

    sleep(1)
  end

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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/osvm/machine.rb', line 419

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.strip == 'active'

    cur_timeout = timeout - (Time.now - t1)

    if cur_timeout <= 0
      raise TimeoutError, "Timeout occurred while waiting for pool #{name.inspect} to become active"
    end

    sleep(1)
  end

  self
end

#wait_for_service(name) ⇒ Machine

Wait for runit system service to start

Parameters:

  • name (String)

Returns:



393
394
395
396
 
# File 'lib/osvm/machine.rb', line 393

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

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



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/osvm/machine.rb', line 702

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 occurred while waiting for shell'
    end

    rs = shell.wait_readable(1)
    next unless rs

    begin
      buffer << read_nonblock(shell)
    rescue EOFError
      raise MachineShellClosed
    end

    next unless buffer.include?("test-shell-ready\n")

    @shell_up = true
    shared_dir.mount
    return
  end
end

#wait_for_shutdown(timeout: @default_timeout) ⇒ Machine

Wait until the machine shuts down

Parameters:

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

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/osvm/machine.rb', line 376

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

  loop do
    return self unless running?

    if t1 + timeout < Time.now
      raise TimeoutError, 'Timeout occurred 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:



410
411
412
413
 
# File 'lib/osvm/machine.rb', line 410

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

#wait_until_container_online(ctid, timeout: @default_timeout) ⇒ Machine

Wait until container’s network is operational, including DNS

Parameters:

  • ctid (String)

Returns:



365
366
367
368
369
370
371
 
# File 'lib/osvm/machine.rb', line 365

def wait_until_container_online(ctid, timeout: @default_timeout)
  wait_until_succeeds(
    "osctl ct exec #{ctid} sh -c 'ping -c 1 check-online.vpsadminos.org || curl --head https://check-online.vpsadminos.org || wget -O - https://check-online.vpsadminos.org || getent hosts check-online.vpsadminos.org'",
    timeout:
  )
  self
end

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

Wait until command fails

Returns:

  • (Array<Integer, String>) 


340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/osvm/machine.rb', line 340

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)
    raise TimeoutError, "Timeout occurred while running command '#{cmd}'" if cur_timeout <= 0

    sleep(1)
  end
end

#wait_until_online(timeout: @default_timeout) ⇒ Machine

Wait until network is operational, including DNS

Returns:



357
358
359
360
 
# File 'lib/osvm/machine.rb', line 357

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

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

Wait until command succeeds

Returns:

  • (Array<Integer, String>) 


323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/osvm/machine.rb', line 323

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)
    raise TimeoutError, "Timeout occurred while running command '#{cmd}'" if cur_timeout <= 0

    sleep(1)
  end
end