-
Notifications
You must be signed in to change notification settings - Fork 381
/
check-qemu-install
executable file
·885 lines (746 loc) · 30 KB
/
check-qemu-install
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
44
45
46
47
48
49
50
51
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
151
152
153
154
155
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
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
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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
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
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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
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
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
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
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
#!/usr/bin/env python3
#
# Copyright (C) 2019-2024, VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# File: check-qemu-install
# Purpose:
# This script installs a system on a emulated qemu host to verify
# that the iso produced is installable and boots.
# after the iso is booted from disk it also tries to execute the
# vyos-smoketest script to verify checks there.
#
# For now it will not fail on failed smoketest but will fail on
# install and boot errors.
# Arguments:
# iso iso image to install
# [disk] disk filename to use, if none is provided it
# is autogenerated
# [--keep] Keep the disk image after completion
# [--logfile] name of logfile to save, defaulting to stdout
# [--silent] only print on errors
# [--debug] print all communication with the device
import pexpect
import sys
import os
import time
import argparse
import subprocess
import random
import traceback
import logging
import re
import tomli
import shutil
from io import BytesIO
from datetime import datetime
EXCEPTION = 0
now = datetime.now()
tpm_folder = '/tmp/vyos_tpm_test'
qemu_name = 'VyOS-QEMU'
# getch.py
KEY_F2 = chr(27) + chr(91) + chr(49) + chr(50) + chr(126)
KEY_F10 = chr(27) + chr(91) + chr(50) + chr(49) + chr(126)
KEY_DOWN = chr(27) + chr(91) + chr(66)
KEY_SPACE = chr(32)
KEY_RETURN = chr(13)
KEY_ESC = chr(27)
KEY_Y = chr(121)
mok_password = '1234'
parser = argparse.ArgumentParser(description='Install and start a test VyOS vm.')
parser.add_argument('iso', help='ISO file to install')
parser.add_argument('disk', help='name of disk image file', nargs='?',
default='testinstall-{}-{}.img'.format(now.strftime('%Y%m%d-%H%M%S'),
"%04x" % random.randint(0,65535)))
parser.add_argument('--keep', help='Do not remove disk-image after installation',
action='store_true', default=False)
parser.add_argument('--silent', help='Do not show output on stdout unless an error has occured',
action='store_true', default=False)
parser.add_argument('--debug', help='Send all debug output to stdout',
action='store_true', default=False)
parser.add_argument('--logfile', help='Log to file')
parser.add_argument('--match', help='Smoketests to run')
parser.add_argument('--uefi', help='Boot using UEFI', action='store_true', default=False)
parser.add_argument('--vnc', help='Enable VNC', action='store_true', default=False)
parser.add_argument('--raid', help='Perform a RAID-1 install', action='store_true', default=False)
parser.add_argument('--configd', help='Execute testsuite with config daemon', action='store_true',
default=False)
parser.add_argument('--no-interfaces', help='Execute testsuite without interface tests to save time',
action='store_true', default=False)
parser.add_argument('--smoketest', help='Execute script based CLI smoketests',
action='store_true', default=False)
parser.add_argument('--configtest', help='Execute load/commit config tests',
action='store_true', default=False)
parser.add_argument('--tpmtest', help='Execute TPM encrypted config tests',
action='store_true', default=False)
parser.add_argument('--sbtest', help='Execute Secure Boot tests',
action='store_true', default=False)
parser.add_argument('--qemu-cmd', help='Only generate QEMU launch command',
action='store_true', default=False)
args = parser.parse_args()
with open('data/defaults.toml', 'rb') as f:
vyos_defaults = tomli.load(f)
class StreamToLogger(object):
"""
Fake file-like stream object that redirects writes to a logger instance.
"""
def __init__(self, logger, log_level=logging.INFO):
self.logger = logger
self.log_level = log_level
self.linebuf = b''
self.ansi_escape = re.compile(r'\x1B[@-_][0-?]*[ -/]*[@-~]')
def write(self, buf):
self.linebuf += buf
while b'\n' in self.linebuf:
f = self.linebuf.split(b'\n', 1)
if len(f) == 2:
self.logger.debug(self.ansi_escape.sub('', f[0].decode(errors="replace").rstrip()))
self.linebuf = f[1]
def flush(self):
pass
def get_half_cpus():
""" return 1/2 of the numbers of available CPUs """
cpu = os.cpu_count()
if cpu > 1:
cpu /= 2
return int(cpu)
OVMF_CODE = '/usr/share/OVMF/OVMF_CODE_4M.secboot.fd'
OVMF_VARS_TMP = args.disk.replace('.img', '.efivars')
if args.sbtest:
shutil.copy('/usr/share/OVMF/OVMF_VARS_4M.ms.fd', OVMF_VARS_TMP)
def get_qemu_cmd(name, enable_uefi, disk_img, raid=None, iso_img=None, tpm=False, vnc_enabled=False, secure_boot=False):
uefi = ""
uuid = "f48b60b2-e6ad-49ef-9d09-4245d0585e52"
machine = 'pc'
vga = '-vga none'
vnc = ''
if vnc_enabled:
vga = '-vga virtio'
vnc = '-vnc :0'
if enable_uefi:
uefi = '-bios /usr/share/OVMF/OVMF_CODE.fd'
name = f'{name}-UEFI'
if secure_boot:
name = f'{name}-SECURE-BOOT'
machine = 'q35,smm=on'
uefi = f'-drive "if=pflash,unit=0,format=raw,readonly=on,file={OVMF_CODE}" ' \
f'-drive "if=pflash,unit=1,format=raw,file={OVMF_VARS_TMP}"'
# Changing UEFI settings require a display
vga = '-vga virtio'
cdrom = ""
if iso_img:
cdrom = f' -drive file={iso_img},format=raw,if=none,media=cdrom,id=drive-cd1,readonly=on' \
f' -device ahci,id=achi0' \
f' -device ide-cd,bus=achi0.0,drive=drive-cd1,id=cd1,bootindex=10'
# test using half of the available CPUs on the system
cpucount = get_half_cpus()
macbase = '52:54:00:00:00'
cmd = f'qemu-system-x86_64 \
-name "{name}" \
-smp {cpucount},sockets=1,cores={cpucount},threads=1 \
-cpu host \
-machine {machine},accel=kvm \
{uefi} \
-m 4G \
-vga none \
-nographic \
{vga} {vnc}\
-uuid {uuid} \
-cpu host \
{cdrom} \
-enable-kvm \
-monitor unix:/tmp/qemu-monitor-socket-{disk_img},server,nowait \
-netdev user,id=n0,net=192.0.2.0/24,dhcpstart=192.0.2.101,dns=192.0.2.10 -device virtio-net-pci,netdev=n0,mac={macbase}:00,romfile="" \
-netdev user,id=n1 -device virtio-net-pci,netdev=n1,mac={macbase}:01,romfile="" \
-netdev user,id=n2 -device virtio-net-pci,netdev=n2,mac={macbase}:02,romfile="" \
-netdev user,id=n3 -device virtio-net-pci,netdev=n3,mac={macbase}:03,romfile="" \
-netdev user,id=n4 -device virtio-net-pci,netdev=n4,mac={macbase}:04,romfile="" \
-netdev user,id=n5 -device virtio-net-pci,netdev=n5,mac={macbase}:05,romfile="" \
-netdev user,id=n6 -device virtio-net-pci,netdev=n6,mac={macbase}:06,romfile="" \
-netdev user,id=n7 -device virtio-net-pci,netdev=n7,mac={macbase}:07,romfile="" \
-device virtio-scsi-pci,id=scsi0 \
-drive format=raw,file={disk_img},if=none,media=disk,id=drive-hd1,readonly=off \
-device scsi-hd,bus=scsi0.0,drive=drive-hd1,id=hd1,bootindex=1'
if raid:
cmd += f' -drive format=raw,file={raid},if=none,media=disk,id=drive-hd2,readonly=off' \
f' -device scsi-hd,bus=scsi0.0,drive=drive-hd2,id=hd2,bootindex=2'
if tpm:
cmd += f' -chardev socket,id=chrtpm,path={tpm_folder}/swtpm-sock' \
' -tpmdev emulator,id=tpm0,chardev=chrtpm' \
' -device tpm-tis,tpmdev=tpm0'
return cmd
def shutdownVM(c, log, message=''):
#################################################
# Powering off system
#################################################
if message:
log.info(message)
c.sendline('poweroff now')
log.info('Shutting down virtual machine')
for i in range(30):
log.info('Waiting for shutdown...')
# Shutdown in qemu doesnt work first time
# Use this workaround
# https://vyos.dev/T5024
c.sendline('poweroff now')
if not c.isalive():
log.info('VM is shut down!')
break
time.sleep(10)
else:
tmp = 'VM Did not shut down after 300sec'
log.error(tmp)
raise Exception(tmp)
def loginVM(c, log):
log.info('Waiting for login prompt')
c.expect('[Ll]ogin:', timeout=600)
c.sendline(default_user)
c.expect('[Pp]assword:')
c.sendline(default_password)
c.expect(op_mode_prompt)
log.info('Logged in!')
# Setting up logger
log = logging.getLogger()
log.setLevel(logging.DEBUG)
stl = StreamToLogger(log)
formatter = logging.Formatter('%(levelname)5s - %(message)s')
handler = logging.StreamHandler(sys.stdout)
if args.silent:
handler.setLevel(logging.ERROR)
elif args.debug:
handler.setLevel(logging.DEBUG)
else:
handler.setLevel(logging.INFO)
handler.setFormatter(formatter)
log.addHandler(handler)
if args.logfile:
filehandler = logging.FileHandler(args.logfile)
filehandler.setLevel(logging.DEBUG)
filehandler.setFormatter(formatter)
log.addHandler(filehandler)
if args.silent:
output = BytesIO()
else:
output = sys.stdout.buffer
if not os.path.isfile(args.iso):
log.error('Unable to find iso image to install')
sys.exit(1)
if not os.path.exists('/dev/kvm'):
log.error('KVM not enabled on host, proceeding with software emulation')
sys.exit(1)
# Creating diskimage!!
diskname_raid = None
def gen_disk(name):
if not os.path.isfile(name):
log.info(f'Creating Disk image {name}')
c = subprocess.check_output(['qemu-img', 'create', name, '2G'])
log.debug(c.decode())
else:
log.info(f'Diskimage "{name}" already exists, using the existing one.')
if args.raid:
filename, ext = os.path.splitext(args.disk)
diskname_raid = f'{filename}_disk1{ext}'
# change primary diskname, too
args.disk = f'{filename}_disk0{ext}'
gen_disk(diskname_raid)
# must be called after the raid disk as args.disk name is altered in the RAID path
gen_disk(args.disk)
# Create software emulated TPM
def start_swtpm():
if not os.path.exists(tpm_folder):
os.mkdir(tpm_folder)
def swtpm_thread():
c = subprocess.check_output([
'swtpm', 'socket', '--tpmstate', f'dir={tpm_folder}',
'--ctrl', f'type=unixio,path={tpm_folder}/swtpm-sock', '--tpm2', '--log', 'level=1'
])
from multiprocessing import Process
tpm_process = Process(target=swtpm_thread)
tpm_process.start()
return tpm_process
def toggleUEFISecureBoot(c):
def UEFIKeyPress(c, key):
UEFI_SLEEP = 1
c.send(key)
time.sleep(UEFI_SLEEP)
# Enter UEFI
for ii in range(1, 10):
c.send(KEY_F2)
time.sleep(0.250)
time.sleep(10)
# Device Manager
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_RETURN)
# Secure Boot Configuration
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_RETURN)
# Attempt Secure Boot Toggle
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_RETURN)
UEFIKeyPress(c, KEY_RETURN)
# Save Secure Boot
UEFIKeyPress(c, KEY_F10)
UEFIKeyPress(c, KEY_Y)
# Go Back to Menu
UEFIKeyPress(c, KEY_ESC)
UEFIKeyPress(c, KEY_ESC)
# Go Down for reset
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_DOWN)
UEFIKeyPress(c, KEY_RETURN)
if args.qemu_cmd:
tmp = get_qemu_cmd(qemu_name, args.uefi, args.disk, raid=diskname_raid, iso_img=args.iso, vnc_enabled=args.vnc, secure_boot=args.sbtest)
os.system(tmp)
exit(0)
test_timeout = 3 *3600 # 3 hours (in seconds)
tpm_process = None
try:
# Start TPM emulator
if args.tpmtest:
tpm_process = start_swtpm()
#################################################
# Installing image to disk
#################################################
log.info('Installing system')
cmd = get_qemu_cmd(qemu_name, args.uefi, args.disk, raid=diskname_raid, tpm=args.tpmtest, iso_img=args.iso, vnc_enabled=args.vnc, secure_boot=args.sbtest)
log.debug(f'Executing command: {cmd}')
c = pexpect.spawn(cmd, logfile=stl, timeout=60)
#################################################
# Logging into VyOS system
#################################################
op_mode_prompt = r'vyos@vyos:~\$'
cfg_mode_prompt = r'vyos@vyos#'
default_user = 'vyos'
default_password = 'vyos'
if args.sbtest:
log.info('Disable UEFI Secure Boot for initial installation')
toggleUEFISecureBoot(c)
try:
c.expect('Automatic boot in', timeout=10)
c.sendline('')
except pexpect.TIMEOUT:
log.warning('Did not find GRUB countdown window, ignoring')
loginVM(c, log)
#################################################
# Installing into VyOS system
#################################################
log.info('Starting installer')
c.sendline('install image')
c.expect('\nWould you like to continue?.*')
c.sendline('y')
c.expect('\nWhat would you like to name this image?.*')
c.sendline('')
c.expect(f'\nPlease enter a password for the "{default_user}" user.*')
c.sendline('vyos')
c.expect(f'\nPlease confirm password for the "{default_user}" user.*')
c.sendline('vyos')
c.expect('\nWhat console should be used by default?.*')
c.sendline('S')
if args.raid:
c.expect('\nWould you like to configure RAID-1 mirroring??.*')
c.sendline('y')
c.expect('\nWould you like to configure RAID-1 mirroring on them?.*')
c.sendline('y')
c.expect('\nInstallation will delete all data on both drives. Continue?.*')
c.sendline('y')
c.expect('\nWhich file would you like as boot config?.*')
c.sendline('')
else:
c.expect('\nWhich one should be used for installation?.*')
c.sendline('')
c.expect('\nInstallation will delete all data on the drive. Continue?.*')
c.sendline('y')
c.expect('\nWould you like to use all the free space on the drive?.*')
c.sendline('y')
c.expect('\nWhich file would you like as boot config?.*')
c.sendline('')
c.expect(op_mode_prompt)
if args.sbtest:
c.sendline('install mok')
c.expect('input password:.*')
c.sendline(mok_password)
c.expect('input password again:.*')
c.sendline(mok_password)
c.expect(op_mode_prompt)
log.info('system installed, rebooting')
c.sendline('reboot now')
#################################################
# SHIM Mok Manager
#################################################
if args.sbtest:
log.info('Install Secure Boot Machine Owner Key')
MOK_SLEEP = 0.5
c.expect('BdsDxe: starting Boot00.*')
time.sleep(3)
# press any key
c.send(KEY_RETURN)
time.sleep(MOK_SLEEP)
# Enroll MOK
c.send(KEY_DOWN)
time.sleep(MOK_SLEEP)
c.send(KEY_RETURN)
time.sleep(MOK_SLEEP)
# Continue
c.send(KEY_DOWN)
time.sleep(MOK_SLEEP)
c.send(KEY_RETURN)
time.sleep(MOK_SLEEP)
# Enroll Keys
c.send(KEY_DOWN)
time.sleep(MOK_SLEEP)
c.send(KEY_RETURN)
time.sleep(MOK_SLEEP)
c.sendline(mok_password)
c.send(KEY_RETURN)
time.sleep(MOK_SLEEP)
# Reboot
c.send(KEY_RETURN)
time.sleep(MOK_SLEEP)
#################################################
# Re-Enable Secure Boot
#################################################
if args.sbtest:
log.info('Enable UEFI Secure Boot for initial installation')
toggleUEFISecureBoot(c)
#################################################
# Removing CD installation media
#################################################
time.sleep(2)
log.info('eject installation media')
os.system(f'echo "eject -f drive-cd1" | socat - unix-connect:/tmp/qemu-monitor-socket-{args.disk}')
#################################################
# Booting installed system
#################################################
log.info('Booting installed system')
#################################################
# Logging into VyOS system
#################################################
try:
c.expect('The highlighted entry will be executed automatically in', timeout=10)
c.sendline('')
except pexpect.TIMEOUT:
log.warning('Did not find GRUB countdown window, ignoring')
loginVM(c, log)
################################################
# Always load the WiFi simulation module
################################################
c.sendline('sudo modprobe mac80211_hwsim')
c.expect(op_mode_prompt)
#################################################
# Start/stop config daemon
#################################################
if args.configd:
c.sendline('sudo systemctl start vyos-configd.service &> /dev/null')
else:
c.sendline('sudo systemctl stop vyos-configd.service &> /dev/null')
c.expect(op_mode_prompt)
#################################################
# Basic Configmode/Opmode switch
#################################################
log.info('Basic CLI configuration mode test')
c.sendline('configure')
c.expect(cfg_mode_prompt)
c.sendline('exit')
c.expect(op_mode_prompt)
c.sendline('show version')
c.expect(op_mode_prompt)
c.sendline('show version kernel')
c.expect(f'{vyos_defaults["kernel_version"]}-{vyos_defaults["kernel_flavor"]}')
c.expect(op_mode_prompt)
c.sendline('show version frr')
c.expect(op_mode_prompt)
c.sendline('show interfaces')
c.expect(op_mode_prompt)
c.sendline('systemd-detect-virt')
c.expect('kvm')
c.expect(op_mode_prompt)
# Ensure ephemeral key is loaded
vyos_kernel_key = 'VyOS build time autogenerated kernel key'
c.sendline(f'show log kernel | match "{vyos_kernel_key}"')
c.expect(f'.*{vyos_kernel_key}.*')
c.expect(op_mode_prompt)
#################################################
# Executing test-suite
#################################################
if args.tpmtest:
def verify_mount():
# Verify encrypted and mounted
c.sendline('mount | grep vyos_config')
c.expect('/dev/mapper/vyos_config on /config.*')
c.expect(op_mode_prompt)
def verify_config():
# Verify encrypted config is loaded
c.sendline('show config commands | cat')
c.expect('set system option performance \'network-latency\'')
c.expect('set system option reboot-on-panic')
c.expect(op_mode_prompt)
log.info('Running TPM encrypted config tests')
tpm_timeout = 600 # Give it 10 mins to encrypt
# Verify TPM is loaded
c.sendline('find /dev -name tpm0')
c.expect('/dev/tpm0')
c.expect(op_mode_prompt)
# Create recovery key
import string
from random import choices
test_recovery_key = ''.join(choices(string.ascii_uppercase + string.digits, k=32))
log.info('Encrypting config to TPM')
c.sendline('encryption enable')
c.expect('Automatically generate a recovery key\?.*')
c.sendline('n')
c.expect('Enter recovery key: ')
c.sendline(test_recovery_key)
c.expect('Enter size of encrypted config partition.*', timeout=30)
c.sendline('32')
c.expect('Encrypted config volume has been enabled', timeout=tpm_timeout)
c.expect('Backup the recovery key in a safe place!')
c.expect(f'Recovery key: {test_recovery_key}')
c.expect(op_mode_prompt)
verify_mount()
# Add some non-default config nodes this encrypted config
log.info('Adding nodes for encrypted config test')
c.sendline('configure')
c.expect(cfg_mode_prompt)
c.sendline('set system option performance network-latency')
c.expect(cfg_mode_prompt)
c.sendline('set system option reboot-on-panic')
c.expect(cfg_mode_prompt)
c.sendline('commit')
c.expect(cfg_mode_prompt)
c.sendline('save')
c.expect(cfg_mode_prompt)
c.sendline('exit')
c.expect(op_mode_prompt)
log.info('system installed, rebooting')
c.sendline('reboot now')
try:
c.expect('The highlighted entry will be executed automatically in', timeout=10)
c.sendline('')
except pexpect.TIMEOUT:
log.warning('Did not find GRUB countdown window, ignoring')
# Check for vyos-router message
c.expect('.*Mounted encrypted config volume', timeout=120)
loginVM(c, log)
verify_mount()
verify_config()
# Shutdown VM
shutdownVM(c, log, 'Shutdown VM for TPM fail test')
# Clear swtpm
from glob import glob
for f in glob(f'{tpm_folder}/*'):
os.remove(f)
# Shutdown kills swtpm
tpm_process.join()
tpm_process.close()
# Start emulator again
tpm_process = start_swtpm()
# Booting back into VM
log.info('Booting system with cleared TPM')
cmd = get_qemu_cmd(qemu_name, args.uefi, args.disk, raid=diskname_raid, tpm=args.tpmtest, vnc_enabled=args.vnc)
log.debug(f'Executing command: {cmd}')
c = pexpect.spawn(cmd, logfile=stl)
try:
c.expect('The highlighted entry will be executed automatically in', timeout=10)
c.sendline('')
except pexpect.TIMEOUT:
log.warning('Did not find GRUB countdown window, ignoring')
c.expect('.*Encrypted config volume has not been mounted', timeout=120)
loginVM(c, log)
# Test loading config with recovery key
c.sendline('encryption load')
c.expect('Enter recovery key: ')
c.sendline(test_recovery_key)
c.expect('Encrypted config volume has been mounted', timeout=120)
c.expect(op_mode_prompt)
verify_mount()
log.info('Loading encrypted config.boot')
c.sendline('configure')
c.expect(cfg_mode_prompt)
c.sendline('load /config/config.boot')
c.expect(cfg_mode_prompt)
c.sendline('commit')
c.expect(cfg_mode_prompt)
c.sendline('exit')
c.expect(op_mode_prompt)
verify_config()
elif args.raid:
# Verify RAID subsystem - by deleting a disk and re-create the array
# from scratch
c.sendline('cat /proc/mdstat')
c.expect(op_mode_prompt)
shutdownVM(c, log, f'Shutdown VM and start with empty RAID member "{args.disk}"')
if os.path.exists(args.disk):
os.unlink(args.disk)
gen_disk(args.disk)
#################################################
# Booting RAID-1 system with one missing disk
#################################################
log.info('Booting RAID-1 system')
cmd = get_qemu_cmd(qemu_name, args.uefi, args.disk, raid=diskname_raid, vnc_enabled=args.vnc)
# We need to swap boot indexes to boot from second harddisk so we can
# recreate the RAID on the first disk
cmd = cmd.replace('bootindex=1', 'bootindex=X')
cmd = cmd.replace('bootindex=2', 'bootindex=1')
cmd = cmd.replace('bootindex=X', 'bootindex=2')
log.debug(f'Executing command: {cmd}')
c = pexpect.spawn(cmd, logfile=stl)
#################################################
# Logging into VyOS system
#################################################
try:
c.expect('The highlighted entry will be executed automatically in', timeout=10)
c.sendline('')
except pexpect.TIMEOUT:
log.warning('Did not find GRUB countdown window, ignoring')
loginVM(c, log)
c.sendline('cat /proc/mdstat')
c.expect(op_mode_prompt)
log.info('Re-format new RAID member')
c.sendline('format by-id disk drive-hd1 like drive-hd2')
c.sendline('yes')
c.expect(op_mode_prompt)
log.info('Add member to RAID1 (md0)')
c.sendline('add raid md0 by-id member drive-hd1-part3')
c.expect(op_mode_prompt)
log.info('Now we need to wait for re-sync to complete')
start_time = time.time()
timeout = 60
while True:
if (start_time + timeout) < time.time():
break
c.sendline('cat /proc/mdstat')
c.expect(op_mode_prompt)
time.sleep(20)
# Reboot system with new primary RAID1 disk
shutdownVM(c, log, f'Shutdown VM and start from recovered RAID member "{args.disk}"')
log.info('Booting RAID-1 system')
cmd = get_qemu_cmd(qemu_name, args.uefi, args.disk, raid=diskname_raid, vnc_enabled=args.vnc)
log.debug(f'Executing command: {cmd}')
c = pexpect.spawn(cmd, logfile=stl)
loginVM(c, log)
c.sendline('cat /proc/mdstat')
c.expect(op_mode_prompt)
elif args.smoketest:
# run default smoketest suite
if args.match:
# Remove tests that we don't want to run
match_str = '-o '.join([f'-name "test_*{name}*.py" ' for name in args.match.split("|")]).strip()
c.sendline(f'sudo find /usr/libexec/vyos/tests/smoke -maxdepth 2 -type f -name test_* ! \( {match_str} \) -delete')
c.expect(op_mode_prompt)
if args.no_interfaces:
# remove interface tests as they consume a lot of time
c.sendline('sudo rm -f /usr/libexec/vyos/tests/smoke/cli/test_interfaces_*')
c.expect(op_mode_prompt)
log.info('Executing VyOS smoketests')
c.sendline('/usr/bin/vyos-smoketest')
i = c.expect(['\n +Invalid command:', '\n +Set failed',
'No such file or directory', r'\n\S+@\S+[$#]'], timeout=test_timeout)
if i == 0:
raise Exception('Invalid command detected')
elif i == 1:
raise Exception('Set syntax failed :/')
elif i == 2:
tmp = '(W)hy (T)he (F)ace? VyOS smoketest not found!'
log.error(tmp)
raise Exception(tmp)
c.sendline('echo EXITCODE:$\x16?')
i = c.expect(['EXITCODE:0', 'EXITCODE:\d+'])
if i == 0:
log.info('Smoketest finished successfully!')
pass
elif i == 1:
log.error('Smoketest failed :/')
raise Exception("Smoketest-failed, please look into debug output")
# else, run configtest suite
elif args.configtest:
log.info('Adding a legacy WireGuard default keypair for migrations')
c.sendline('sudo mkdir -p /config/auth/wireguard/default')
c.expect(op_mode_prompt)
c.sendline('echo "aGx+fvW916Ej7QRnBbW3QMoldhNv1u95/WHz45zDmF0=" | sudo tee /config/auth/wireguard/default/private.key')
c.expect(op_mode_prompt)
c.sendline('echo "x39C77eavJNpvYbNzPSG3n1D68rHYei6q3AEBEyL1z8=" | sudo tee /config/auth/wireguard/default/public.key')
c.expect(op_mode_prompt)
log.info('Generating PKI objects')
c.sendline(f'/usr/bin/vyos-configtest-pki')
c.expect(op_mode_prompt, timeout=900)
script_file = '/config/scripts/vyos-foo-update.script'
c.sendline(f'echo "#!/bin/sh" > {script_file}; chmod 775 {script_file}')
c.expect(op_mode_prompt)
log.info('Executing load config tests')
c.sendline('/usr/bin/vyos-configtest')
i = c.expect(['\n +Invalid command:', 'No such file or directory',
r'\n\S+@\S+[$#]'], timeout=test_timeout)
if i==0:
raise Exception('Invalid command detected')
elif i==1:
tmp = 'VyOS smoketest not found!'
log.error(tmp)
raise Exception(tmp)
c.sendline('echo EXITCODE:$\x16?')
i = c.expect(['EXITCODE:0', 'EXITCODE:\d+'])
if i == 0:
log.info('Configtest finished successfully!')
pass
elif i == 1:
tmp = 'Configtest failed :/ - check debug output'
log.error(tmp)
raise Exception(tmp)
elif args.sbtest:
c.sendline('show secure-boot')
c.expect('SecureBoot enabled')
c.expect(op_mode_prompt)
else:
log.info('No testcase selected!')
shutdownVM(c, log, 'Powering off system')
c.close()
except pexpect.exceptions.TIMEOUT:
log.error('Timeout waiting for VyOS system')
log.error(traceback.format_exc())
EXCEPTION = 1
except pexpect.exceptions.ExceptionPexpect:
log.error('Exeption while executing QEMU')
log.error('Is qemu working on this system?')
log.error(traceback.format_exc())
EXCEPTION = 1
except Exception:
log.error('Unknown error occured while VyOS!')
traceback.print_exc()
EXCEPTION = 1
#################################################
# Cleaning up
#################################################
log.info("Cleaning up")
if tpm_process:
tpm_process.terminate()
tpm_process.join()
if not args.keep:
log.info(f'Removing disk file: {args.disk}')
try:
os.remove(args.disk)
if diskname_raid:
os.remove(diskname_raid)
if args.sbtest:
os.remove(OVMF_VARS_TMP)
except Exception:
log.error('Exception while removing diskimage!')
log.error(traceback.format_exc())
EXCEPTION = 1
if EXCEPTION:
log.error('Hmm... system got an exception while processing.')
log.error('The ISO image is not considered usable!')
sys.exit(1)
sys.exit(0)