tests/acceptance/virtiofs_submounts.py

   1 import logging
   2 import re
   3 import os
   4 import subprocess
   5 import time
   6
   7 from avocado import skipUnless
   8 from avocado_qemu import Test, BUILD_DIR
   9 from avocado_qemu import wait_for_console_pattern
  10 from avocado.utils import ssh
  11
  12 from qemu.accel import kvm_available
  13
  14 from boot_linux import BootLinux
  15
  16
  17 def run_cmd(args):
  18     subp = subprocess.Popen(args,
  19                             stdout=subprocess.PIPE,
  20                             stderr=subprocess.PIPE,
  21                             universal_newlines=True)
  22     stdout, stderr = subp.communicate()
  23     ret = subp.returncode
  24
  25     return (stdout, stderr, ret)
  26
  27 def has_cmd(name, args=None):
  28     """
  29     This function is for use in a @avocado.skipUnless decorator, e.g.:
  30
  31         @skipUnless(*has_cmd('sudo -n', ('sudo', '-n', 'true')))
  32         def test_something_that_needs_sudo(self):
  33             ...
  34     """
  35
  36     if args is None:
  37         args = ('which', name)
  38
  39     try:
  40         _, stderr, exitcode = run_cmd(args)
  41     except Exception as e:
  42         exitcode = -1
  43         stderr = str(e)
  44
  45     if exitcode != 0:
  46         cmd_line = ' '.join(args)
  47         err = f'{name} required, but "{cmd_line}" failed: {stderr.strip()}'
  48         return (False, err)
  49     else:
  50         return (True, '')
  51
  52 def has_cmds(*cmds):
  53     """
  54     This function is for use in a @avocado.skipUnless decorator and
  55     allows checking for the availability of multiple commands, e.g.:
  56
  57         @skipUnless(*has_cmds(('cmd1', ('cmd1', '--some-parameter')),
  58                               'cmd2', 'cmd3'))
  59         def test_something_that_needs_cmd1_and_cmd2(self):
  60             ...
  61     """
  62
  63     for cmd in cmds:
  64         if isinstance(cmd, str):
  65             cmd = (cmd,)
  66
  67         ok, errstr = has_cmd(*cmd)
  68         if not ok:
  69             return (False, errstr)
  70
  71     return (True, '')
  72
  73
  74 class VirtiofsSubmountsTest(BootLinux):
  75     """
  76     :avocado: tags=arch:x86_64
  77     """
  78
  79     def get_portfwd(self):
  80         port = None
  81
  82         res = self.vm.command('human-monitor-command',
  83                               command_line='info usernet')
  84         for line in res.split('\r\n'):
  85             match = \
  86                 re.search(r'TCP.HOST_FORWARD.*127\.0\.0\.1\s*(\d+)\s+10\.',
  87                           line)
  88             if match is not None:
  89                 port = match[1]
  90                 break
  91
  92         self.assertIsNotNone(port)
  93         self.log.debug('sshd listening on port: ' + port)
  94         return port
  95
  96     def ssh_connect(self, username, keyfile):
  97         self.ssh_logger = logging.getLogger('ssh')
  98         port = self.get_portfwd()
  99         self.ssh_session = ssh.Session('127.0.0.1', port=int(port),
 100                                        user=username, key=keyfile)
 101         for i in range(10):
 102             try:
 103                 self.ssh_session.connect()
 104                 return
 105             except:
 106                 time.sleep(4)
 107                 pass
 108         self.fail('sshd timeout')
 109
 110     def ssh_command(self, command):
 111         self.ssh_logger.info(command)
 112         result = self.ssh_session.cmd(command)
 113         stdout_lines = [line.rstrip() for line
 114                         in result.stdout_text.splitlines()]
 115         for line in stdout_lines:
 116             self.ssh_logger.info(line)
 117         stderr_lines = [line.rstrip() for line
 118                         in result.stderr_text.splitlines()]
 119         for line in stderr_lines:
 120             self.ssh_logger.warning(line)
 121
 122         self.assertEqual(result.exit_status, 0,
 123                          f'Guest command failed: {command}')
 124         return stdout_lines, stderr_lines
 125
 126     def run(self, args, ignore_error=False):
 127         stdout, stderr, ret = run_cmd(args)
 128
 129         if ret != 0:
 130             cmdline = ' '.join(args)
 131             if not ignore_error:
 132                 self.fail(f'{cmdline}: Returned {ret}: {stderr}')
 133             else:
 134                 self.log.warn(f'{cmdline}: Returned {ret}: {stderr}')
 135
 136         return (stdout, stderr, ret)
 137
 138     def set_up_shared_dir(self):
 139         self.shared_dir = os.path.join(self.workdir, 'virtiofs-shared')
 140
 141         os.mkdir(self.shared_dir)
 142
 143         self.run(('cp', self.get_data('guest.sh'),
 144                  os.path.join(self.shared_dir, 'check.sh')))
 145
 146         self.run(('cp', self.get_data('guest-cleanup.sh'),
 147                  os.path.join(self.shared_dir, 'cleanup.sh')))
 148
 149     def set_up_virtiofs(self):
 150         attmp = os.getenv('AVOCADO_TESTS_COMMON_TMPDIR')
 151         self.vfsdsock = os.path.join(attmp, 'vfsdsock')
 152
 153         self.run(('sudo', '-n', 'rm', '-f', self.vfsdsock), ignore_error=True)
 154
 155         self.virtiofsd = \
 156             subprocess.Popen(('sudo', '-n',
 157                               'tools/virtiofsd/virtiofsd',
 158                               f'--socket-path={self.vfsdsock}',
 159                               '-o', f'source={self.shared_dir}',
 160                               '-o', 'cache=always',
 161                               '-o', 'xattr',
 162                               '-o', 'announce_submounts',
 163                               '-f'),
 164                              stdout=subprocess.DEVNULL,
 165                              stderr=subprocess.PIPE,
 166                              universal_newlines=True)
 167
 168         while not os.path.exists(self.vfsdsock):
 169             if self.virtiofsd.poll() is not None:
 170                 self.fail('virtiofsd exited prematurely: ' +
 171                           self.virtiofsd.communicate()[1])
 172             time.sleep(0.1)
 173
 174         self.run(('sudo', '-n', 'chmod', 'go+rw', self.vfsdsock))
 175
 176         self.vm.add_args('-chardev',
 177                          f'socket,id=vfsdsock,path={self.vfsdsock}',
 178                          '-device',
 179                          'vhost-user-fs-pci,queue-size=1024,chardev=vfsdsock' \
 180                              ',tag=host',
 181                          '-object',
 182                          'memory-backend-file,id=mem,size=1G,' \
 183                              'mem-path=/dev/shm,share=on',
 184                          '-numa',
 185                          'node,memdev=mem')
 186
 187     def launch_vm(self):
 188         self.launch_and_wait()
 189         self.ssh_connect('root', self.ssh_key)
 190
 191     def set_up_nested_mounts(self):
 192         scratch_dir = os.path.join(self.shared_dir, 'scratch')
 193         try:
 194             os.mkdir(scratch_dir)
 195         except FileExistsError:
 196             pass
 197
 198         args = ['bash', self.get_data('host.sh'), scratch_dir]
 199         if self.seed:
 200             args += [self.seed]
 201
 202         out, _, _ = self.run(args)
 203         seed = re.search(r'^Seed: \d+', out)
 204         self.log.info(seed[0])
 205
 206     def mount_in_guest(self):
 207         self.ssh_command('mkdir -p /mnt/host')
 208         self.ssh_command('mount -t virtiofs host /mnt/host')
 209
 210     def check_in_guest(self):
 211         self.ssh_command('bash /mnt/host/check.sh /mnt/host/scratch/share')
 212
 213     def live_cleanup(self):
 214         self.ssh_command('bash /mnt/host/cleanup.sh /mnt/host/scratch')
 215
 216         # It would be nice if the above was sufficient to make virtiofsd clear
 217         # all references to the mounted directories (so they can be unmounted
 218         # on the host), but unfortunately it is not.  To do so, we have to
 219         # resort to a remount.
 220         self.ssh_command('mount -o remount /mnt/host')
 221
 222         scratch_dir = os.path.join(self.shared_dir, 'scratch')
 223         self.run(('bash', self.get_data('cleanup.sh'), scratch_dir))
 224
 225     @skipUnless(*has_cmds(('sudo -n', ('sudo', '-n', 'true')),
 226                           'ssh-keygen', 'bash', 'losetup', 'mkfs.xfs', 'mount'))
 227     def setUp(self):
 228         vmlinuz = self.params.get('vmlinuz')
 229         if vmlinuz is None:
 230             self.cancel('vmlinuz parameter not set; you must point it to a '
 231                         'Linux kernel binary to test (to run this test with ' \
 232                         'the on-image kernel, set it to an empty string)')
 233
 234         self.seed = self.params.get('seed')
 235
 236         self.ssh_key = os.path.join(self.workdir, 'id_ed25519')
 237
 238         self.run(('ssh-keygen', '-N', '', '-t', 'ed25519', '-f', self.ssh_key))
 239
 240         pubkey = open(self.ssh_key + '.pub').read()
 241
 242         super(VirtiofsSubmountsTest, self).setUp(pubkey)
 243
 244         if len(vmlinuz) > 0:
 245             self.vm.add_args('-kernel', vmlinuz,
 246                              '-append', 'console=ttyS0 root=/dev/sda1')
 247
 248         # Allow us to connect to SSH
 249         self.vm.add_args('-netdev', 'user,id=vnet,hostfwd=:127.0.0.1:0-:22',
 250                          '-device', 'e1000,netdev=vnet')
 251
 252         if not kvm_available(self.arch, self.qemu_bin):
 253             self.cancel(KVM_NOT_AVAILABLE)
 254         self.vm.add_args('-accel', 'kvm')
 255
 256     def tearDown(self):
 257         try:
 258             self.vm.shutdown()
 259         except:
 260             pass
 261
 262         scratch_dir = os.path.join(self.shared_dir, 'scratch')
 263         self.run(('bash', self.get_data('cleanup.sh'), scratch_dir),
 264                  ignore_error=True)
 265
 266     def test_pre_virtiofsd_set_up(self):
 267         self.set_up_shared_dir()
 268
 269         self.set_up_nested_mounts()
 270
 271         self.set_up_virtiofs()
 272         self.launch_vm()
 273         self.mount_in_guest()
 274         self.check_in_guest()
 275
 276     def test_pre_launch_set_up(self):
 277         self.set_up_shared_dir()
 278         self.set_up_virtiofs()
 279
 280         self.set_up_nested_mounts()
 281
 282         self.launch_vm()
 283         self.mount_in_guest()
 284         self.check_in_guest()
 285
 286     def test_post_launch_set_up(self):
 287         self.set_up_shared_dir()
 288         self.set_up_virtiofs()
 289         self.launch_vm()
 290
 291         self.set_up_nested_mounts()
 292
 293         self.mount_in_guest()
 294         self.check_in_guest()
 295
 296     def test_post_mount_set_up(self):
 297         self.set_up_shared_dir()
 298         self.set_up_virtiofs()
 299         self.launch_vm()
 300         self.mount_in_guest()
 301
 302         self.set_up_nested_mounts()
 303
 304         self.check_in_guest()
 305
 306     def test_two_runs(self):
 307         self.set_up_shared_dir()
 308
 309         self.set_up_nested_mounts()
 310
 311         self.set_up_virtiofs()
 312         self.launch_vm()
 313         self.mount_in_guest()
 314         self.check_in_guest()
 315
 316         self.live_cleanup()
 317         self.set_up_nested_mounts()
 318
 319         self.check_in_guest()