1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2018, Linaro Limited
3 # Author: Takahiro Akashi <takahiro.akashi@linaro.org>
9 from subprocess import call, check_call, check_output, CalledProcessError
10 from fstest_defs import *
12 supported_fs_basic = ['fat16', 'fat32', 'ext4']
13 supported_fs_ext = ['fat16', 'fat32']
14 supported_fs_mkdir = ['fat16', 'fat32']
15 supported_fs_unlink = ['fat16', 'fat32']
16 supported_fs_symlink = ['ext4']
19 # Filesystem test specific setup
21 def pytest_addoption(parser):
22 """Enable --fs-type option.
24 See pytest_configure() about how it works.
27 parser: Pytest command-line parser.
32 parser.addoption('--fs-type', action='append', default=None,
33 help='Targeting Filesystem Types')
35 def pytest_configure(config):
36 """Restrict a file system(s) to be tested.
38 A file system explicitly named with --fs-type option is selected
39 if it belongs to a default supported_fs_xxx list.
40 Multiple options can be specified.
43 config: Pytest configuration.
48 global supported_fs_basic
49 global supported_fs_ext
50 global supported_fs_mkdir
51 global supported_fs_unlink
52 global supported_fs_symlink
54 def intersect(listA, listB):
55 return [x for x in listA if x in listB]
57 supported_fs = config.getoption('fs_type')
59 print('*** FS TYPE modified: %s' % supported_fs)
60 supported_fs_basic = intersect(supported_fs, supported_fs_basic)
61 supported_fs_ext = intersect(supported_fs, supported_fs_ext)
62 supported_fs_mkdir = intersect(supported_fs, supported_fs_mkdir)
63 supported_fs_unlink = intersect(supported_fs, supported_fs_unlink)
64 supported_fs_symlink = intersect(supported_fs, supported_fs_symlink)
66 def pytest_generate_tests(metafunc):
67 """Parametrize fixtures, fs_obj_xxx
69 Each fixture will be parametrized with a corresponding support_fs_xxx
73 metafunc: Pytest test function.
78 if 'fs_obj_basic' in metafunc.fixturenames:
79 metafunc.parametrize('fs_obj_basic', supported_fs_basic,
80 indirect=True, scope='module')
81 if 'fs_obj_ext' in metafunc.fixturenames:
82 metafunc.parametrize('fs_obj_ext', supported_fs_ext,
83 indirect=True, scope='module')
84 if 'fs_obj_mkdir' in metafunc.fixturenames:
85 metafunc.parametrize('fs_obj_mkdir', supported_fs_mkdir,
86 indirect=True, scope='module')
87 if 'fs_obj_unlink' in metafunc.fixturenames:
88 metafunc.parametrize('fs_obj_unlink', supported_fs_unlink,
89 indirect=True, scope='module')
90 if 'fs_obj_symlink' in metafunc.fixturenames:
91 metafunc.parametrize('fs_obj_symlink', supported_fs_symlink,
92 indirect=True, scope='module')
97 def fstype_to_ubname(fs_type):
98 """Convert a file system type to an U-boot specific string
100 A generated string can be used as part of file system related commands
101 or a config name in u-boot. Currently fat16 and fat32 are handled
105 fs_type: File system type.
108 A corresponding string for file system type.
110 if re.match('fat', fs_type):
115 def check_ubconfig(config, fs_type):
116 """Check whether a file system is enabled in u-boot configuration.
118 This function is assumed to be called in a fixture function so that
119 the whole test cases will be skipped if a given file system is not
123 fs_type: File system type.
128 if not config.buildconfig.get('config_cmd_%s' % fs_type, None):
129 pytest.skip('.config feature "CMD_%s" not enabled' % fs_type.upper())
130 if not config.buildconfig.get('config_%s_write' % fs_type, None):
131 pytest.skip('.config feature "%s_WRITE" not enabled'
134 def mk_fs(config, fs_type, size, id):
135 """Create a file system volume.
138 fs_type: File system type.
139 size: Size of file system in MiB.
140 id: Prefix string of volume's file name.
145 fs_img = '%s.%s.img' % (id, fs_type)
146 fs_img = config.persistent_data_dir + '/' + fs_img
148 if fs_type == 'fat16':
150 elif fs_type == 'fat32':
152 elif fs_type == 'ext4':
153 mkfs_opt = '-O ^metadata_csum'
157 if re.match('fat', fs_type):
162 count = (size + 1048576 - 1) / 1048576
165 check_call('rm -f %s' % fs_img, shell=True)
166 check_call('dd if=/dev/zero of=%s bs=1M count=%d'
167 % (fs_img, count), shell=True)
168 check_call('mkfs.%s %s %s'
169 % (fs_lnxtype, mkfs_opt, fs_img), shell=True)
171 except CalledProcessError:
172 call('rm -f %s' % fs_img, shell=True)
175 # from test/py/conftest.py
176 def tool_is_in_path(tool):
177 """Check whether a given command is available on host.
183 True if available, False if not.
185 for path in os.environ['PATH'].split(os.pathsep):
186 fn = os.path.join(path, tool)
187 if os.path.isfile(fn) and os.access(fn, os.X_OK):
193 def mount_fs(fs_type, device, mount_point):
197 fs_type: File system type.
198 device: Volume's file name.
199 mount_point: Mount point.
208 if tool_is_in_path('guestmount'):
210 check_call('guestmount -a %s -m /dev/sda %s'
211 % (device, mount_point), shell=True)
213 mount_opt = 'loop,rw'
214 if re.match('fat', fs_type):
215 mount_opt += ',umask=0000'
217 check_call('sudo mount -o %s %s %s'
218 % (mount_opt, device, mount_point), shell=True)
220 # may not be effective for some file systems
221 check_call('sudo chmod a+rw %s' % mount_point, shell=True)
222 except CalledProcessError:
225 def umount_fs(mount_point):
229 mount_point: Mount point.
236 call('guestunmount %s' % mount_point, shell=True)
238 call('sudo umount %s' % mount_point, shell=True)
241 # Fixture for basic fs test
242 # derived from test/fs/fs-test.sh
244 # NOTE: yield_fixture was deprecated since pytest-3.0
245 @pytest.yield_fixture()
246 def fs_obj_basic(request, u_boot_config):
247 """Set up a file system to be used in basic fs test.
250 request: Pytest request object.
251 u_boot_config: U-boot configuration.
254 A fixture for basic fs test, i.e. a triplet of file system type,
255 volume file name and a list of MD5 hashes.
257 fs_type = request.param
260 fs_ubtype = fstype_to_ubname(fs_type)
261 check_ubconfig(u_boot_config, fs_ubtype)
263 mount_dir = u_boot_config.persistent_data_dir + '/mnt'
265 small_file = mount_dir + '/' + SMALL_FILE
266 big_file = mount_dir + '/' + BIG_FILE
271 fs_img = mk_fs(u_boot_config, fs_type, 0xc0000000, '3GB')
273 # Mount the image so we can populate it.
274 check_call('mkdir -p %s' % mount_dir, shell=True)
275 mount_fs(fs_type, fs_img, mount_dir)
277 # Create a subdirectory.
278 check_call('mkdir %s/SUBDIR' % mount_dir, shell=True)
280 # Create big file in this image.
281 # Note that we work only on the start 1MB, couple MBs in the 2GB range
282 # and the last 1 MB of the huge 2.5GB file.
283 # So, just put random values only in those areas.
284 check_call('dd if=/dev/urandom of=%s bs=1M count=1'
285 % big_file, shell=True)
286 check_call('dd if=/dev/urandom of=%s bs=1M count=2 seek=2047'
287 % big_file, shell=True)
288 check_call('dd if=/dev/urandom of=%s bs=1M count=1 seek=2499'
289 % big_file, shell=True)
291 # Create a small file in this image.
292 check_call('dd if=/dev/urandom of=%s bs=1M count=1'
293 % small_file, shell=True)
295 # Delete the small file copies which possibly are written as part of a
297 # check_call('rm -f "%s.w"' % MB1, shell=True)
298 # check_call('rm -f "%s.w2"' % MB1, shell=True)
300 # Generate the md5sums of reads that we will test against small file
302 'dd if=%s bs=1M skip=0 count=1 2> /dev/null | md5sum'
303 % small_file, shell=True).decode()
304 md5val = [ out.split()[0] ]
306 # Generate the md5sums of reads that we will test against big file
307 # One from beginning of file.
309 'dd if=%s bs=1M skip=0 count=1 2> /dev/null | md5sum'
310 % big_file, shell=True).decode()
311 md5val.append(out.split()[0])
313 # One from end of file.
315 'dd if=%s bs=1M skip=2499 count=1 2> /dev/null | md5sum'
316 % big_file, shell=True).decode()
317 md5val.append(out.split()[0])
319 # One from the last 1MB chunk of 2GB
321 'dd if=%s bs=1M skip=2047 count=1 2> /dev/null | md5sum'
322 % big_file, shell=True).decode()
323 md5val.append(out.split()[0])
325 # One from the start 1MB chunk from 2GB
327 'dd if=%s bs=1M skip=2048 count=1 2> /dev/null | md5sum'
328 % big_file, shell=True).decode()
329 md5val.append(out.split()[0])
331 # One 1MB chunk crossing the 2GB boundary
333 'dd if=%s bs=512K skip=4095 count=2 2> /dev/null | md5sum'
334 % big_file, shell=True).decode()
335 md5val.append(out.split()[0])
338 except CalledProcessError as err:
339 pytest.skip('Setup failed for filesystem: ' + fs_type + \
343 yield [fs_ubtype, fs_img, md5val]
346 call('rmdir %s' % mount_dir, shell=True)
348 call('rm -f %s' % fs_img, shell=True)
351 # Fixture for extended fs test
353 # NOTE: yield_fixture was deprecated since pytest-3.0
354 @pytest.yield_fixture()
355 def fs_obj_ext(request, u_boot_config):
356 """Set up a file system to be used in extended fs test.
359 request: Pytest request object.
360 u_boot_config: U-boot configuration.
363 A fixture for extended fs test, i.e. a triplet of file system type,
364 volume file name and a list of MD5 hashes.
366 fs_type = request.param
369 fs_ubtype = fstype_to_ubname(fs_type)
370 check_ubconfig(u_boot_config, fs_ubtype)
372 mount_dir = u_boot_config.persistent_data_dir + '/mnt'
374 min_file = mount_dir + '/' + MIN_FILE
375 tmp_file = mount_dir + '/tmpfile'
380 fs_img = mk_fs(u_boot_config, fs_type, 0x8000000, '128MB')
382 # Mount the image so we can populate it.
383 check_call('mkdir -p %s' % mount_dir, shell=True)
384 mount_fs(fs_type, fs_img, mount_dir)
386 # Create a test directory
387 check_call('mkdir %s/dir1' % mount_dir, shell=True)
389 # Create a small file and calculate md5
390 check_call('dd if=/dev/urandom of=%s bs=1K count=20'
391 % min_file, shell=True)
393 'dd if=%s bs=1K 2> /dev/null | md5sum'
394 % min_file, shell=True).decode()
395 md5val = [ out.split()[0] ]
397 # Calculate md5sum of Test Case 4
398 check_call('dd if=%s of=%s bs=1K count=20'
399 % (min_file, tmp_file), shell=True)
400 check_call('dd if=%s of=%s bs=1K seek=5 count=20'
401 % (min_file, tmp_file), shell=True)
402 out = check_output('dd if=%s bs=1K 2> /dev/null | md5sum'
403 % tmp_file, shell=True).decode()
404 md5val.append(out.split()[0])
406 # Calculate md5sum of Test Case 5
407 check_call('dd if=%s of=%s bs=1K count=20'
408 % (min_file, tmp_file), shell=True)
409 check_call('dd if=%s of=%s bs=1K seek=5 count=5'
410 % (min_file, tmp_file), shell=True)
411 out = check_output('dd if=%s bs=1K 2> /dev/null | md5sum'
412 % tmp_file, shell=True).decode()
413 md5val.append(out.split()[0])
415 # Calculate md5sum of Test Case 7
416 check_call('dd if=%s of=%s bs=1K count=20'
417 % (min_file, tmp_file), shell=True)
418 check_call('dd if=%s of=%s bs=1K seek=20 count=20'
419 % (min_file, tmp_file), shell=True)
420 out = check_output('dd if=%s bs=1K 2> /dev/null | md5sum'
421 % tmp_file, shell=True).decode()
422 md5val.append(out.split()[0])
424 check_call('rm %s' % tmp_file, shell=True)
426 except CalledProcessError:
427 pytest.skip('Setup failed for filesystem: ' + fs_type)
430 yield [fs_ubtype, fs_img, md5val]
433 call('rmdir %s' % mount_dir, shell=True)
435 call('rm -f %s' % fs_img, shell=True)
438 # Fixture for mkdir test
440 # NOTE: yield_fixture was deprecated since pytest-3.0
441 @pytest.yield_fixture()
442 def fs_obj_mkdir(request, u_boot_config):
443 """Set up a file system to be used in mkdir test.
446 request: Pytest request object.
447 u_boot_config: U-boot configuration.
450 A fixture for mkdir test, i.e. a duplet of file system type and
453 fs_type = request.param
456 fs_ubtype = fstype_to_ubname(fs_type)
457 check_ubconfig(u_boot_config, fs_ubtype)
461 fs_img = mk_fs(u_boot_config, fs_type, 0x8000000, '128MB')
463 pytest.skip('Setup failed for filesystem: ' + fs_type)
465 yield [fs_ubtype, fs_img]
468 call('rm -f %s' % fs_img, shell=True)
471 # Fixture for unlink test
473 # NOTE: yield_fixture was deprecated since pytest-3.0
474 @pytest.yield_fixture()
475 def fs_obj_unlink(request, u_boot_config):
476 """Set up a file system to be used in unlink test.
479 request: Pytest request object.
480 u_boot_config: U-boot configuration.
483 A fixture for unlink test, i.e. a duplet of file system type and
486 fs_type = request.param
489 fs_ubtype = fstype_to_ubname(fs_type)
490 check_ubconfig(u_boot_config, fs_ubtype)
492 mount_dir = u_boot_config.persistent_data_dir + '/mnt'
497 fs_img = mk_fs(u_boot_config, fs_type, 0x8000000, '128MB')
499 # Mount the image so we can populate it.
500 check_call('mkdir -p %s' % mount_dir, shell=True)
501 mount_fs(fs_type, fs_img, mount_dir)
504 check_call('mkdir %s/dir1' % mount_dir, shell=True)
505 check_call('dd if=/dev/urandom of=%s/dir1/file1 bs=1K count=1'
506 % mount_dir, shell=True)
507 check_call('dd if=/dev/urandom of=%s/dir1/file2 bs=1K count=1'
508 % mount_dir, shell=True)
511 check_call('mkdir %s/dir2' % mount_dir, shell=True)
512 for i in range(0, 20):
513 check_call('mkdir %s/dir2/0123456789abcdef%02x'
514 % (mount_dir, i), shell=True)
517 check_call('mkdir %s/dir4' % mount_dir, shell=True)
520 check_call('mkdir %s/dir5' % mount_dir, shell=True)
521 check_call('dd if=/dev/urandom of=%s/dir5/file1 bs=1K count=1'
522 % mount_dir, shell=True)
525 except CalledProcessError:
526 pytest.skip('Setup failed for filesystem: ' + fs_type)
529 yield [fs_ubtype, fs_img]
532 call('rmdir %s' % mount_dir, shell=True)
534 call('rm -f %s' % fs_img, shell=True)
537 # Fixture for symlink fs test
539 # NOTE: yield_fixture was deprecated since pytest-3.0
540 @pytest.yield_fixture()
541 def fs_obj_symlink(request, u_boot_config):
542 """Set up a file system to be used in symlink fs test.
545 request: Pytest request object.
546 u_boot_config: U-boot configuration.
549 A fixture for basic fs test, i.e. a triplet of file system type,
550 volume file name and a list of MD5 hashes.
552 fs_type = request.param
555 fs_ubtype = fstype_to_ubname(fs_type)
556 check_ubconfig(u_boot_config, fs_ubtype)
558 mount_dir = u_boot_config.persistent_data_dir + '/mnt'
560 small_file = mount_dir + '/' + SMALL_FILE
561 medium_file = mount_dir + '/' + MEDIUM_FILE
566 fs_img = mk_fs(u_boot_config, fs_type, 0x40000000, '1GB')
568 # Mount the image so we can populate it.
569 check_call('mkdir -p %s' % mount_dir, shell=True)
570 mount_fs(fs_type, fs_img, mount_dir)
572 # Create a subdirectory.
573 check_call('mkdir %s/SUBDIR' % mount_dir, shell=True)
575 # Create a small file in this image.
576 check_call('dd if=/dev/urandom of=%s bs=1M count=1'
577 % small_file, shell=True)
579 # Create a medium file in this image.
580 check_call('dd if=/dev/urandom of=%s bs=10M count=1'
581 % medium_file, shell=True)
583 # Generate the md5sums of reads that we will test against small file
585 'dd if=%s bs=1M skip=0 count=1 2> /dev/null | md5sum'
586 % small_file, shell=True).decode()
587 md5val = [out.split()[0]]
589 'dd if=%s bs=10M skip=0 count=1 2> /dev/null | md5sum'
590 % medium_file, shell=True).decode()
591 md5val.extend([out.split()[0]])
594 except CalledProcessError:
595 pytest.skip('Setup failed for filesystem: ' + fs_type)
598 yield [fs_ubtype, fs_img, md5val]
601 call('rmdir %s' % mount_dir, shell=True)
603 call('rm -f %s' % fs_img, shell=True)