2 # SPDX-License-Identifier: GPL-2.0-only
4 # Copyright (c) 2019 Western Digital Corporation or its affiliates.
9 # Automate running of fio tests
12 # python3 run-fio-tests.py [-r fio-root] [-f fio-path] [-a artifact-root]
13 # [--skip # # #...] [--run-only # # #...]
17 # # git clone git://git.kernel.dk/fio.git
20 # # python3 t/run-fio-tests.py
24 # - Python 3.5 (subprocess.run)
25 # - Linux (libaio ioengine, zbd tests, etc)
26 # - The artifact directory must be on a file system that accepts 512-byte IO
27 # (t0002, t0003, t0004).
28 # - The artifact directory needs to be on an SSD. Otherwise tests that carry
29 # out file-based IO will trigger a timeout (t0006).
31 # - SciPy (steadystate_tests.py)
32 # - libzbc (zbd tests)
33 # - root privileges (zbd test)
34 # - kernel 4.19 or later for zoned null block devices (zbd tests)
35 # - CUnit support (unittests)
40 # TODO run multiple tests simultaneously
41 # TODO Add sgunmap tests (requires SAS SSD)
54 import multiprocessing
55 from pathlib import Path
59 """Base for all fio tests."""
61 def __init__(self, exe_path, parameters, success):
62 self.exe_path = exe_path
63 self.parameters = parameters
64 self.success = success
66 self.artifact_root = None
70 self.failure_reason = ''
71 self.command_file = None
72 self.stdout_file = None
73 self.stderr_file = None
74 self.exitcode_file = None
76 def setup(self, artifact_root, testnum):
77 """Setup instance variables for test."""
79 self.artifact_root = artifact_root
80 self.testnum = testnum
81 self.test_dir = os.path.join(artifact_root, "{:04d}".format(testnum))
82 if not os.path.exists(self.test_dir):
83 os.mkdir(self.test_dir)
85 self.command_file = os.path.join(
87 "{0}.command".format(os.path.basename(self.exe_path)))
88 self.stdout_file = os.path.join(
90 "{0}.stdout".format(os.path.basename(self.exe_path)))
91 self.stderr_file = os.path.join(
93 "{0}.stderr".format(os.path.basename(self.exe_path)))
94 self.exitcode_file = os.path.join(
96 "{0}.exitcode".format(os.path.basename(self.exe_path)))
101 raise NotImplementedError()
103 def check_result(self):
104 """Check test results."""
106 raise NotImplementedError()
109 class FioExeTest(FioTest):
110 """Test consists of an executable binary or script"""
112 def __init__(self, exe_path, parameters, success):
113 """Construct a FioExeTest which is a FioTest consisting of an
114 executable binary or script.
116 exe_path: location of executable binary or script
117 parameters: list of parameters for executable
118 success: Definition of test success
121 FioTest.__init__(self, exe_path, parameters, success)
124 """Execute the binary or script described by this instance."""
126 command = [self.exe_path] + self.parameters
127 command_file = open(self.command_file, "w+")
128 command_file.write("%s\n" % command)
131 stdout_file = open(self.stdout_file, "w+")
132 stderr_file = open(self.stderr_file, "w+")
133 exitcode_file = open(self.exitcode_file, "w+")
136 # Avoid using subprocess.run() here because when a timeout occurs,
137 # fio will be stopped with SIGKILL. This does not give fio a
138 # chance to clean up and means that child processes may continue
139 # running and submitting IO.
140 proc = subprocess.Popen(command,
144 universal_newlines=True)
145 proc.communicate(timeout=self.success['timeout'])
146 exitcode_file.write('{0}\n'.format(proc.returncode))
147 logging.debug("Test %d: return code: %d", self.testnum, proc.returncode)
148 self.output['proc'] = proc
149 except subprocess.TimeoutExpired:
153 self.output['failure'] = 'timeout'
159 self.output['failure'] = 'exception'
160 self.output['exc_info'] = sys.exc_info()
164 exitcode_file.close()
166 def check_result(self):
167 """Check results of test run."""
169 if 'proc' not in self.output:
170 if self.output['failure'] == 'timeout':
171 self.failure_reason = "{0} timeout,".format(self.failure_reason)
173 assert self.output['failure'] == 'exception'
174 self.failure_reason = '{0} exception: {1}, {2}'.format(
175 self.failure_reason, self.output['exc_info'][0],
176 self.output['exc_info'][1])
181 if 'zero_return' in self.success:
182 if self.success['zero_return']:
183 if self.output['proc'].returncode != 0:
185 self.failure_reason = "{0} non-zero return code,".format(self.failure_reason)
187 if self.output['proc'].returncode == 0:
188 self.failure_reason = "{0} zero return code,".format(self.failure_reason)
191 stderr_size = os.path.getsize(self.stderr_file)
192 if 'stderr_empty' in self.success:
193 if self.success['stderr_empty']:
195 self.failure_reason = "{0} stderr not empty,".format(self.failure_reason)
199 self.failure_reason = "{0} stderr empty,".format(self.failure_reason)
203 class FioJobTest(FioExeTest):
204 """Test consists of a fio job"""
206 def __init__(self, fio_path, fio_job, success, fio_pre_job=None,
207 fio_pre_success=None, output_format="normal"):
208 """Construct a FioJobTest which is a FioExeTest consisting of a
209 single fio job file with an optional setup step.
211 fio_path: location of fio executable
212 fio_job: location of fio job file
213 success: Definition of test success
214 fio_pre_job: fio job for preconditioning
215 fio_pre_success: Definition of test success for fio precon job
216 output_format: normal (default), json, jsonplus, or terse
219 self.fio_job = fio_job
220 self.fio_pre_job = fio_pre_job
221 self.fio_pre_success = fio_pre_success if fio_pre_success else success
222 self.output_format = output_format
223 self.precon_failed = False
224 self.json_data = None
225 self.fio_output = "{0}.output".format(os.path.basename(self.fio_job))
228 "--output-format={0}".format(self.output_format),
229 "--output={0}".format(self.fio_output),
232 FioExeTest.__init__(self, fio_path, self.fio_args, success)
234 def setup(self, artifact_root, testnum):
235 """Setup instance variables for fio job test."""
237 super(FioJobTest, self).setup(artifact_root, testnum)
239 self.command_file = os.path.join(
241 "{0}.command".format(os.path.basename(self.fio_job)))
242 self.stdout_file = os.path.join(
244 "{0}.stdout".format(os.path.basename(self.fio_job)))
245 self.stderr_file = os.path.join(
247 "{0}.stderr".format(os.path.basename(self.fio_job)))
248 self.exitcode_file = os.path.join(
250 "{0}.exitcode".format(os.path.basename(self.fio_job)))
252 def run_pre_job(self):
253 """Run fio job precondition step."""
255 precon = FioJobTest(self.exe_path, self.fio_pre_job,
256 self.fio_pre_success,
257 output_format=self.output_format)
258 precon.setup(self.artifact_root, self.testnum)
260 precon.check_result()
261 self.precon_failed = not precon.passed
262 self.failure_reason = precon.failure_reason
265 """Run fio job test."""
270 if not self.precon_failed:
271 super(FioJobTest, self).run()
273 logging.debug("Test %d: precondition step failed", self.testnum)
276 def get_file(cls, filename):
277 """Safely read a file."""
282 with open(filename, "r") as output_file:
283 file_data = output_file.read()
287 return file_data, success
289 def check_result(self):
290 """Check fio job results."""
292 if self.precon_failed:
294 self.failure_reason = "{0} precondition step failed,".format(self.failure_reason)
297 super(FioJobTest, self).check_result()
302 if 'json' not in self.output_format:
305 file_data, success = self.get_file(os.path.join(self.test_dir, self.fio_output))
307 self.failure_reason = "{0} unable to open output file,".format(self.failure_reason)
312 # Sometimes fio informational messages are included at the top of the
313 # JSON output, especially under Windows. Try to decode output as JSON
314 # data, skipping everything until the first {
316 lines = file_data.splitlines()
317 file_data = '\n'.join(lines[lines.index("{"):])
319 self.json_data = json.loads(file_data)
320 except json.JSONDecodeError:
321 self.failure_reason = "{0} unable to decode JSON data,".format(self.failure_reason)
325 class FioJobTest_t0005(FioJobTest):
326 """Test consists of fio test job t0005
327 Confirm that read['io_kbytes'] == write['io_kbytes'] == 102400"""
329 def check_result(self):
330 super(FioJobTest_t0005, self).check_result()
335 if self.json_data['jobs'][0]['read']['io_kbytes'] != 102400:
336 self.failure_reason = "{0} bytes read mismatch,".format(self.failure_reason)
338 if self.json_data['jobs'][0]['write']['io_kbytes'] != 102400:
339 self.failure_reason = "{0} bytes written mismatch,".format(self.failure_reason)
343 class FioJobTest_t0006(FioJobTest):
344 """Test consists of fio test job t0006
345 Confirm that read['io_kbytes'] ~ 2*write['io_kbytes']"""
347 def check_result(self):
348 super(FioJobTest_t0006, self).check_result()
353 ratio = self.json_data['jobs'][0]['read']['io_kbytes'] \
354 / self.json_data['jobs'][0]['write']['io_kbytes']
355 logging.debug("Test %d: ratio: %f", self.testnum, ratio)
356 if ratio < 1.99 or ratio > 2.01:
357 self.failure_reason = "{0} read/write ratio mismatch,".format(self.failure_reason)
361 class FioJobTest_t0007(FioJobTest):
362 """Test consists of fio test job t0007
363 Confirm that read['io_kbytes'] = 87040"""
365 def check_result(self):
366 super(FioJobTest_t0007, self).check_result()
371 if self.json_data['jobs'][0]['read']['io_kbytes'] != 87040:
372 self.failure_reason = "{0} bytes read mismatch,".format(self.failure_reason)
376 class FioJobTest_t0008(FioJobTest):
377 """Test consists of fio test job t0008
378 Confirm that read['io_kbytes'] = 32768 and that
379 write['io_kbytes'] ~ 16568
381 I did runs with fio-ae2fafc8 and saw write['io_kbytes'] values of
382 16585, 16588. With two runs of fio-3.16 I obtained 16568"""
384 def check_result(self):
385 super(FioJobTest_t0008, self).check_result()
390 ratio = self.json_data['jobs'][0]['write']['io_kbytes'] / 16568
391 logging.debug("Test %d: ratio: %f", self.testnum, ratio)
393 if ratio < 0.99 or ratio > 1.01:
394 self.failure_reason = "{0} bytes written mismatch,".format(self.failure_reason)
396 if self.json_data['jobs'][0]['read']['io_kbytes'] != 32768:
397 self.failure_reason = "{0} bytes read mismatch,".format(self.failure_reason)
401 class FioJobTest_t0009(FioJobTest):
402 """Test consists of fio test job t0009
403 Confirm that runtime >= 60s"""
405 def check_result(self):
406 super(FioJobTest_t0009, self).check_result()
411 logging.debug('Test %d: elapsed: %d', self.testnum, self.json_data['jobs'][0]['elapsed'])
413 if self.json_data['jobs'][0]['elapsed'] < 60:
414 self.failure_reason = "{0} elapsed time mismatch,".format(self.failure_reason)
418 class FioJobTest_t0012(FioJobTest):
419 """Test consists of fio test job t0012
420 Confirm ratios of job iops are 1:5:10
421 job1,job2,job3 respectively"""
423 def check_result(self):
424 super(FioJobTest_t0012, self).check_result()
430 for i in range(1, 4):
431 filename = os.path.join(self.test_dir, "{0}_iops.{1}.log".format(os.path.basename(
433 file_data, success = self.get_file(filename)
436 self.failure_reason = "{0} unable to open output file,".format(self.failure_reason)
440 iops_files.append(file_data.splitlines())
442 # there are 9 samples for job1 and job2, 4 samples for job3
447 iops1 = iops1 + float(iops_files[0][i].split(',')[1])
448 iops2 = iops2 + float(iops_files[1][i].split(',')[1])
449 iops3 = iops3 + float(iops_files[2][i].split(',')[1])
453 logging.debug("sample {0}: job1 iops={1} job2 iops={2} job3 iops={3} " \
454 "job3/job2={4:.3f} job3/job1={5:.3f}".format(i, iops1, iops2, iops3, ratio1,
457 # test job1 and job2 succeeded to recalibrate
458 if ratio1 < 1 or ratio1 > 3 or ratio2 < 7 or ratio2 > 13:
459 self.failure_reason += " iops ratio mismatch iops1={0} iops2={1} iops3={2} " \
460 "expected r1~2 r2~10 got r1={3:.3f} r2={4:.3f},".format(iops1, iops2, iops3,
466 class FioJobTest_t0014(FioJobTest):
467 """Test consists of fio test job t0014
468 Confirm that job1_iops / job2_iops ~ 1:2 for entire duration
469 and that job1_iops / job3_iops ~ 1:3 for first half of duration.
471 The test is about making sure the flow feature can
472 re-calibrate the activity dynamically"""
474 def check_result(self):
475 super(FioJobTest_t0014, self).check_result()
481 for i in range(1, 4):
482 filename = os.path.join(self.test_dir, "{0}_iops.{1}.log".format(os.path.basename(
484 file_data, success = self.get_file(filename)
487 self.failure_reason = "{0} unable to open output file,".format(self.failure_reason)
491 iops_files.append(file_data.splitlines())
493 # there are 9 samples for job1 and job2, 4 samples for job3
499 iops3 = iops3 + float(iops_files[2][i].split(',')[1])
501 ratio1 = iops1 / iops2
502 ratio2 = iops1 / iops3
505 if ratio1 < 0.43 or ratio1 > 0.57 or ratio2 < 0.21 or ratio2 > 0.45:
506 self.failure_reason += " iops ratio mismatch iops1={0} iops2={1} iops3={2} " \
507 "expected r1~0.5 r2~0.33 got r1={3:.3f} r2={4:.3f},".format(
508 iops1, iops2, iops3, ratio1, ratio2)
511 iops1 = iops1 + float(iops_files[0][i].split(',')[1])
512 iops2 = iops2 + float(iops_files[1][i].split(',')[1])
516 logging.debug("sample {0}: job1 iops={1} job2 iops={2} job3 iops={3} " \
517 "job1/job2={4:.3f} job1/job3={5:.3f}".format(i, iops1, iops2, iops3,
520 # test job1 and job2 succeeded to recalibrate
521 if ratio1 < 0.43 or ratio1 > 0.57:
522 self.failure_reason += " iops ratio mismatch iops1={0} iops2={1} expected ratio~0.5 " \
523 "got ratio={2:.3f},".format(iops1, iops2, ratio1)
528 class FioJobTest_t0015(FioJobTest):
529 """Test consists of fio test jobs t0015 and t0016
530 Confirm that mean(slat) + mean(clat) = mean(tlat)"""
532 def check_result(self):
533 super(FioJobTest_t0015, self).check_result()
538 slat = self.json_data['jobs'][0]['read']['slat_ns']['mean']
539 clat = self.json_data['jobs'][0]['read']['clat_ns']['mean']
540 tlat = self.json_data['jobs'][0]['read']['lat_ns']['mean']
541 logging.debug('Test %d: slat %f, clat %f, tlat %f', self.testnum, slat, clat, tlat)
543 if abs(slat + clat - tlat) > 1:
544 self.failure_reason = "{0} slat {1} + clat {2} = {3} != tlat {4},".format(
545 self.failure_reason, slat, clat, slat+clat, tlat)
549 class FioJobTest_t0019(FioJobTest):
550 """Test consists of fio test job t0019
551 Confirm that all offsets were touched sequentially"""
553 def check_result(self):
554 super(FioJobTest_t0019, self).check_result()
556 bw_log_filename = os.path.join(self.test_dir, "test_bw.log")
557 file_data, success = self.get_file(bw_log_filename)
559 self.failure_reason += " unable to open output file {0}".format(bw_log_filename)
563 log_lines = file_data.split('\n')
566 for line in log_lines:
567 if len(line.strip()) == 0:
569 cur = int(line.split(',')[4])
570 if cur - prev != 4096:
572 self.failure_reason = "offsets {0}, {1} not sequential".format(prev, cur)
578 self.failure_reason = "unexpected last offset {0}".format(cur)
581 class FioJobTest_t0020(FioJobTest):
582 """Test consists of fio test jobs t0020 and t0021
583 Confirm that almost all offsets were touched non-sequentially"""
585 def check_result(self):
586 super(FioJobTest_t0020, self).check_result()
588 bw_log_filename = os.path.join(self.test_dir, "test_bw.log")
589 file_data, success = self.get_file(bw_log_filename)
591 self.failure_reason += " unable to open output file {0}".format(bw_log_filename)
595 log_lines = file_data.split('\n')
600 prev = int(log_lines[0].split(',')[4])
601 for line in log_lines[1:]:
602 offsets.add(prev/4096)
603 if len(line.strip()) == 0:
605 cur = int(line.split(',')[4])
606 if cur - prev == 4096:
610 # 10 is an arbitrary threshold
613 self.failure_reason = "too many ({0}) consecutive offsets".format(seq_count)
615 if len(offsets) != 256:
617 self.failure_reason += " number of offsets is {0} instead of 256".format(len(offsets))
622 self.failure_reason += " missing offset {0}".format(i*4096)
625 class FioJobTest_t0022(FioJobTest):
626 """Test consists of fio test job t0022"""
628 def check_result(self):
629 super(FioJobTest_t0022, self).check_result()
631 bw_log_filename = os.path.join(self.test_dir, "test_bw.log")
632 file_data, success = self.get_file(bw_log_filename)
634 self.failure_reason += " unable to open output file {0}".format(bw_log_filename)
638 log_lines = file_data.split('\n')
645 prev = int(log_lines[0].split(',')[4])
646 for line in log_lines[1:]:
648 if len(line.strip()) == 0:
650 cur = int(line.split(',')[4])
655 # 10 is an arbitrary threshold
658 self.failure_reason = "too many ({0}) consecutive offsets".format(seq_count)
660 if len(offsets) == filesize/bs:
662 self.failure_reason += " no duplicate offsets found with norandommap=1"
665 class FioJobTest_t0023(FioJobTest):
666 """Test consists of fio test job t0023 randtrimwrite test."""
668 def check_trimwrite(self, filename):
669 """Make sure that trims are followed by writes of the same size at the same offset."""
671 bw_log_filename = os.path.join(self.test_dir, filename)
672 file_data, success = self.get_file(bw_log_filename)
674 self.failure_reason += " unable to open output file {0}".format(bw_log_filename)
678 log_lines = file_data.split('\n')
681 for line in log_lines:
682 if len(line.strip()) == 0:
684 vals = line.split(',')
687 offset = int(vals[4])
691 self.failure_reason += " {0}: write not preceeded by trim: {1}".format(
692 bw_log_filename, line)
697 self.failure_reason += " {0}: trim not preceeded by write: {1}".format(
698 bw_log_filename, line)
703 self.failure_reason += " {0}: block size does not match: {1}".format(
704 bw_log_filename, line)
706 if prev_offset != offset:
708 self.failure_reason += " {0}: offset does not match: {1}".format(
709 bw_log_filename, line)
716 def check_all_offsets(self, filename, sectorsize, filesize):
717 """Make sure all offsets were touched."""
719 file_data, success = self.get_file(os.path.join(self.test_dir, filename))
722 self.failure_reason = " could not open {0}".format(filename)
725 log_lines = file_data.split('\n')
729 for line in log_lines:
730 if len(line.strip()) == 0:
732 vals = line.split(',')
734 offset = int(vals[4])
735 if offset % sectorsize != 0:
737 self.failure_reason += " {0}: offset {1} not a multiple of sector size {2}".format(
738 filename, offset, sectorsize)
740 if bs % sectorsize != 0:
742 self.failure_reason += " {0}: block size {1} not a multiple of sector size " \
743 "{2}".format(filename, bs, sectorsize)
745 for i in range(int(bs/sectorsize)):
746 offsets.add(offset/sectorsize + i)
748 if len(offsets) != filesize/sectorsize:
750 self.failure_reason += " {0}: only {1} offsets touched; expected {2}".format(
751 filename, len(offsets), filesize/sectorsize)
753 logging.debug("%s: %d sectors touched", filename, len(offsets))
756 def check_result(self):
757 super(FioJobTest_t0023, self).check_result()
761 self.check_trimwrite("basic_bw.log")
762 self.check_trimwrite("bs_bw.log")
763 self.check_trimwrite("bsrange_bw.log")
764 self.check_trimwrite("bssplit_bw.log")
765 self.check_trimwrite("basic_no_rm_bw.log")
766 self.check_trimwrite("bs_no_rm_bw.log")
767 self.check_trimwrite("bsrange_no_rm_bw.log")
768 self.check_trimwrite("bssplit_no_rm_bw.log")
770 self.check_all_offsets("basic_bw.log", 4096, filesize)
771 self.check_all_offsets("bs_bw.log", 8192, filesize)
772 self.check_all_offsets("bsrange_bw.log", 512, filesize)
773 self.check_all_offsets("bssplit_bw.log", 512, filesize)
776 class FioJobTest_t0024(FioJobTest_t0023):
777 """Test consists of fio test job t0024 trimwrite test."""
779 def check_result(self):
780 # call FioJobTest_t0023's parent to skip checks done by t0023
781 super(FioJobTest_t0023, self).check_result()
785 self.check_trimwrite("basic_bw.log")
786 self.check_trimwrite("bs_bw.log")
787 self.check_trimwrite("bsrange_bw.log")
788 self.check_trimwrite("bssplit_bw.log")
790 self.check_all_offsets("basic_bw.log", 4096, filesize)
791 self.check_all_offsets("bs_bw.log", 8192, filesize)
792 self.check_all_offsets("bsrange_bw.log", 512, filesize)
793 self.check_all_offsets("bssplit_bw.log", 512, filesize)
796 class FioJobTest_iops_rate(FioJobTest):
797 """Test consists of fio test job t0009
798 Confirm that job0 iops == 1000
799 and that job1_iops / job0_iops ~ 8
800 With two runs of fio-3.16 I observed a ratio of 8.3"""
802 def check_result(self):
803 super(FioJobTest_iops_rate, self).check_result()
808 iops1 = self.json_data['jobs'][0]['read']['iops']
809 logging.debug("Test %d: iops1: %f", self.testnum, iops1)
810 iops2 = self.json_data['jobs'][1]['read']['iops']
811 logging.debug("Test %d: iops2: %f", self.testnum, iops2)
812 ratio = iops2 / iops1
813 logging.debug("Test %d: ratio: %f", self.testnum, ratio)
815 if iops1 < 950 or iops1 > 1050:
816 self.failure_reason = "{0} iops value mismatch,".format(self.failure_reason)
819 if ratio < 6 or ratio > 10:
820 self.failure_reason = "{0} iops ratio mismatch,".format(self.failure_reason)
824 class Requirements():
825 """Requirements consists of multiple run environment characteristics.
826 These are to determine if a particular test can be run"""
839 def __init__(self, fio_root):
840 Requirements._not_macos = platform.system() != "Darwin"
841 Requirements._not_windows = platform.system() != "Windows"
842 Requirements._linux = platform.system() == "Linux"
844 if Requirements._linux:
845 config_file = os.path.join(fio_root, "config-host.h")
846 contents, success = FioJobTest.get_file(config_file)
848 print("Unable to open {0} to check requirements".format(config_file))
849 Requirements._zbd = True
851 Requirements._zbd = "CONFIG_HAS_BLKZONED" in contents
852 Requirements._libaio = "CONFIG_LIBAIO" in contents
854 contents, success = FioJobTest.get_file("/proc/kallsyms")
856 print("Unable to open '/proc/kallsyms' to probe for io_uring support")
858 Requirements._io_uring = "io_uring_setup" in contents
860 Requirements._root = (os.geteuid() == 0)
861 if Requirements._zbd and Requirements._root:
863 subprocess.run(["modprobe", "null_blk"],
864 stdout=subprocess.PIPE,
865 stderr=subprocess.PIPE)
866 if os.path.exists("/sys/module/null_blk/parameters/zoned"):
867 Requirements._zoned_nullb = True
871 if platform.system() == "Windows":
872 utest_exe = "unittest.exe"
874 utest_exe = "unittest"
875 unittest_path = os.path.join(fio_root, "unittests", utest_exe)
876 Requirements._unittests = os.path.exists(unittest_path)
878 Requirements._cpucount4 = multiprocessing.cpu_count() >= 4
880 req_list = [Requirements.linux,
882 Requirements.io_uring,
885 Requirements.zoned_nullb,
886 Requirements.not_macos,
887 Requirements.not_windows,
888 Requirements.unittests,
889 Requirements.cpucount4]
892 logging.debug("Requirements: Requirement '%s' met? %s", desc, value)
896 """Are we running on Linux?"""
897 return Requirements._linux, "Linux required"
901 """Is libaio available?"""
902 return Requirements._libaio, "libaio required"
906 """Is io_uring available?"""
907 return Requirements._io_uring, "io_uring required"
911 """Is ZBD support available?"""
912 return Requirements._zbd, "Zoned block device support required"
916 """Are we running as root?"""
917 return Requirements._root, "root required"
920 def zoned_nullb(cls):
921 """Are zoned null block devices available?"""
922 return Requirements._zoned_nullb, "Zoned null block device support required"
926 """Are we running on a platform other than macOS?"""
927 return Requirements._not_macos, "platform other than macOS required"
930 def not_windows(cls):
931 """Are we running on a platform other than Windws?"""
932 return Requirements._not_windows, "platform other than Windows required"
936 """Were unittests built?"""
937 return Requirements._unittests, "Unittests support required"
941 """Do we have at least 4 CPUs?"""
942 return Requirements._cpucount4, "4+ CPUs required"
947 'stderr_empty': True,
951 'zero_return': False,
952 'stderr_empty': False,
957 'stderr_empty': False,
963 'test_class': FioJobTest,
964 'job': 't0001-52c58027.fio',
965 'success': SUCCESS_DEFAULT,
972 'test_class': FioJobTest,
973 'job': 't0002-13af05ae-post.fio',
974 'success': SUCCESS_DEFAULT,
975 'pre_job': 't0002-13af05ae-pre.fio',
977 'requirements': [Requirements.linux, Requirements.libaio],
981 'test_class': FioJobTest,
982 'job': 't0003-0ae2c6e1-post.fio',
983 'success': SUCCESS_NONZERO,
984 'pre_job': 't0003-0ae2c6e1-pre.fio',
985 'pre_success': SUCCESS_DEFAULT,
986 'requirements': [Requirements.linux, Requirements.libaio],
990 'test_class': FioJobTest,
991 'job': 't0004-8a99fdf6.fio',
992 'success': SUCCESS_DEFAULT,
995 'requirements': [Requirements.linux, Requirements.libaio],
999 'test_class': FioJobTest_t0005,
1000 'job': 't0005-f7078f7b.fio',
1001 'success': SUCCESS_DEFAULT,
1003 'pre_success': None,
1004 'output_format': 'json',
1005 'requirements': [Requirements.not_windows],
1009 'test_class': FioJobTest_t0006,
1010 'job': 't0006-82af2a7c.fio',
1011 'success': SUCCESS_DEFAULT,
1013 'pre_success': None,
1014 'output_format': 'json',
1015 'requirements': [Requirements.linux, Requirements.libaio],
1019 'test_class': FioJobTest_t0007,
1020 'job': 't0007-37cf9e3c.fio',
1021 'success': SUCCESS_DEFAULT,
1023 'pre_success': None,
1024 'output_format': 'json',
1029 'test_class': FioJobTest_t0008,
1030 'job': 't0008-ae2fafc8.fio',
1031 'success': SUCCESS_DEFAULT,
1033 'pre_success': None,
1034 'output_format': 'json',
1039 'test_class': FioJobTest_t0009,
1040 'job': 't0009-f8b0bd10.fio',
1041 'success': SUCCESS_DEFAULT,
1043 'pre_success': None,
1044 'output_format': 'json',
1045 'requirements': [Requirements.not_macos,
1046 Requirements.cpucount4],
1047 # mac os does not support CPU affinity
1051 'test_class': FioJobTest,
1052 'job': 't0010-b7aae4ba.fio',
1053 'success': SUCCESS_DEFAULT,
1055 'pre_success': None,
1060 'test_class': FioJobTest_iops_rate,
1061 'job': 't0011-5d2788d5.fio',
1062 'success': SUCCESS_DEFAULT,
1064 'pre_success': None,
1065 'output_format': 'json',
1070 'test_class': FioJobTest_t0012,
1072 'success': SUCCESS_DEFAULT,
1074 'pre_success': None,
1075 'output_format': 'json',
1080 'test_class': FioJobTest,
1082 'success': SUCCESS_DEFAULT,
1084 'pre_success': None,
1085 'output_format': 'json',
1090 'test_class': FioJobTest_t0014,
1092 'success': SUCCESS_DEFAULT,
1094 'pre_success': None,
1095 'output_format': 'json',
1100 'test_class': FioJobTest_t0015,
1101 'job': 't0015-e78980ff.fio',
1102 'success': SUCCESS_DEFAULT,
1104 'pre_success': None,
1105 'output_format': 'json',
1106 'requirements': [Requirements.linux, Requirements.libaio],
1110 'test_class': FioJobTest_t0015,
1111 'job': 't0016-d54ae22.fio',
1112 'success': SUCCESS_DEFAULT,
1114 'pre_success': None,
1115 'output_format': 'json',
1120 'test_class': FioJobTest_t0015,
1122 'success': SUCCESS_DEFAULT,
1124 'pre_success': None,
1125 'output_format': 'json',
1126 'requirements': [Requirements.not_windows],
1130 'test_class': FioJobTest,
1132 'success': SUCCESS_DEFAULT,
1134 'pre_success': None,
1135 'requirements': [Requirements.linux, Requirements.io_uring],
1139 'test_class': FioJobTest_t0019,
1141 'success': SUCCESS_DEFAULT,
1143 'pre_success': None,
1148 'test_class': FioJobTest_t0020,
1150 'success': SUCCESS_DEFAULT,
1152 'pre_success': None,
1157 'test_class': FioJobTest_t0020,
1159 'success': SUCCESS_DEFAULT,
1161 'pre_success': None,
1166 'test_class': FioJobTest_t0022,
1168 'success': SUCCESS_DEFAULT,
1170 'pre_success': None,
1175 'test_class': FioJobTest_t0023,
1177 'success': SUCCESS_DEFAULT,
1179 'pre_success': None,
1184 'test_class': FioJobTest_t0024,
1186 'success': SUCCESS_DEFAULT,
1188 'pre_success': None,
1193 'test_class': FioExeTest,
1196 'success': SUCCESS_DEFAULT,
1201 'test_class': FioExeTest,
1204 'success': SUCCESS_DEFAULT,
1209 'test_class': FioExeTest,
1210 'exe': 't/lfsr-test',
1211 'parameters': ['0xFFFFFF', '0', '0', 'verify'],
1212 'success': SUCCESS_STDERR,
1217 'test_class': FioExeTest,
1218 'exe': 't/readonly.py',
1219 'parameters': ['-f', '{fio_path}'],
1220 'success': SUCCESS_DEFAULT,
1225 'test_class': FioExeTest,
1226 'exe': 't/steadystate_tests.py',
1227 'parameters': ['{fio_path}'],
1228 'success': SUCCESS_DEFAULT,
1233 'test_class': FioExeTest,
1236 'success': SUCCESS_STDERR,
1241 'test_class': FioExeTest,
1242 'exe': 't/strided.py',
1243 'parameters': ['{fio_path}'],
1244 'success': SUCCESS_DEFAULT,
1249 'test_class': FioExeTest,
1250 'exe': 't/zbd/run-tests-against-nullb',
1251 'parameters': ['-s', '1'],
1252 'success': SUCCESS_DEFAULT,
1253 'requirements': [Requirements.linux, Requirements.zbd,
1258 'test_class': FioExeTest,
1259 'exe': 't/zbd/run-tests-against-nullb',
1260 'parameters': ['-s', '2'],
1261 'success': SUCCESS_DEFAULT,
1262 'requirements': [Requirements.linux, Requirements.zbd,
1263 Requirements.root, Requirements.zoned_nullb],
1267 'test_class': FioExeTest,
1268 'exe': 'unittests/unittest',
1270 'success': SUCCESS_DEFAULT,
1271 'requirements': [Requirements.unittests],
1275 'test_class': FioExeTest,
1276 'exe': 't/latency_percentiles.py',
1277 'parameters': ['-f', '{fio_path}'],
1278 'success': SUCCESS_DEFAULT,
1283 'test_class': FioExeTest,
1284 'exe': 't/jsonplus2csv_test.py',
1285 'parameters': ['-f', '{fio_path}'],
1286 'success': SUCCESS_DEFAULT,
1291 'test_class': FioExeTest,
1292 'exe': 't/log_compression.py',
1293 'parameters': ['-f', '{fio_path}'],
1294 'success': SUCCESS_DEFAULT,
1301 """Parse command-line arguments."""
1303 parser = argparse.ArgumentParser()
1304 parser.add_argument('-r', '--fio-root',
1305 help='fio root path')
1306 parser.add_argument('-f', '--fio',
1307 help='path to fio executable (e.g., ./fio)')
1308 parser.add_argument('-a', '--artifact-root',
1309 help='artifact root directory')
1310 parser.add_argument('-s', '--skip', nargs='+', type=int,
1311 help='list of test(s) to skip')
1312 parser.add_argument('-o', '--run-only', nargs='+', type=int,
1313 help='list of test(s) to run, skipping all others')
1314 parser.add_argument('-d', '--debug', action='store_true',
1315 help='provide debug output')
1316 parser.add_argument('-k', '--skip-req', action='store_true',
1317 help='skip requirements checking')
1318 parser.add_argument('-p', '--pass-through', action='append',
1319 help='pass-through an argument to an executable test')
1320 args = parser.parse_args()
1330 logging.basicConfig(level=logging.DEBUG)
1332 logging.basicConfig(level=logging.INFO)
1335 if args.pass_through:
1336 for arg in args.pass_through:
1338 print("Invalid --pass-through argument '%s'" % arg)
1339 print("Syntax for --pass-through is TESTNUMBER:ARGUMENT")
1341 split = arg.split(":", 1)
1342 pass_through[int(split[0])] = split[1]
1343 logging.debug("Pass-through arguments: %s", pass_through)
1346 fio_root = args.fio_root
1348 fio_root = str(Path(__file__).absolute().parent.parent)
1349 print("fio root is %s" % fio_root)
1354 if platform.system() == "Windows":
1358 fio_path = os.path.join(fio_root, fio_exe)
1359 print("fio path is %s" % fio_path)
1360 if not shutil.which(fio_path):
1361 print("Warning: fio executable not found")
1363 artifact_root = args.artifact_root if args.artifact_root else \
1364 "fio-test-{0}".format(time.strftime("%Y%m%d-%H%M%S"))
1365 os.mkdir(artifact_root)
1366 print("Artifact directory is %s" % artifact_root)
1368 if not args.skip_req:
1369 req = Requirements(fio_root)
1375 for config in TEST_LIST:
1376 if (args.skip and config['test_id'] in args.skip) or \
1377 (args.run_only and config['test_id'] not in args.run_only):
1378 skipped = skipped + 1
1379 print("Test {0} SKIPPED (User request)".format(config['test_id']))
1382 if issubclass(config['test_class'], FioJobTest):
1383 if config['pre_job']:
1384 fio_pre_job = os.path.join(fio_root, 't', 'jobs',
1388 if config['pre_success']:
1389 fio_pre_success = config['pre_success']
1391 fio_pre_success = None
1392 if 'output_format' in config:
1393 output_format = config['output_format']
1395 output_format = 'normal'
1396 test = config['test_class'](
1398 os.path.join(fio_root, 't', 'jobs', config['job']),
1400 fio_pre_job=fio_pre_job,
1401 fio_pre_success=fio_pre_success,
1402 output_format=output_format)
1403 desc = config['job']
1404 elif issubclass(config['test_class'], FioExeTest):
1405 exe_path = os.path.join(fio_root, config['exe'])
1406 if config['parameters']:
1407 parameters = [p.format(fio_path=fio_path) for p in config['parameters']]
1410 if Path(exe_path).suffix == '.py' and platform.system() == "Windows":
1411 parameters.insert(0, exe_path)
1412 exe_path = "python.exe"
1413 if config['test_id'] in pass_through:
1414 parameters += pass_through[config['test_id']].split()
1415 test = config['test_class'](exe_path, parameters,
1417 desc = config['exe']
1419 print("Test {0} FAILED: unable to process test config".format(config['test_id']))
1423 if not args.skip_req:
1425 for req in config['requirements']:
1426 reqs_met, reason = req()
1427 logging.debug("Test %d: Requirement '%s' met? %s", config['test_id'], reason,
1432 print("Test {0} SKIPPED ({1}) {2}".format(config['test_id'], reason, desc))
1433 skipped = skipped + 1
1437 test.setup(artifact_root, config['test_id'])
1440 except KeyboardInterrupt:
1442 except Exception as e:
1444 test.failure_reason += str(e)
1445 logging.debug("Test %d exception:\n%s\n", config['test_id'], traceback.format_exc())
1450 result = "FAILED: {0}".format(test.failure_reason)
1452 contents, _ = FioJobTest.get_file(test.stderr_file)
1453 logging.debug("Test %d: stderr:\n%s", config['test_id'], contents)
1454 contents, _ = FioJobTest.get_file(test.stdout_file)
1455 logging.debug("Test %d: stdout:\n%s", config['test_id'], contents)
1456 print("Test {0} {1} {2}".format(config['test_id'], result, desc))
1458 print("{0} test(s) passed, {1} failed, {2} skipped".format(passed, failed, skipped))
1463 if __name__ == '__main__':