test: test job for randtrimwrite
[fio.git] / t / run-fio-tests.py
1 #!/usr/bin/env python3
2 # SPDX-License-Identifier: GPL-2.0-only
3 #
4 # Copyright (c) 2019 Western Digital Corporation or its affiliates.
5 #
6 """
7 # run-fio-tests.py
8 #
9 # Automate running of fio tests
10 #
11 # USAGE
12 # python3 run-fio-tests.py [-r fio-root] [-f fio-path] [-a artifact-root]
13 #                           [--skip # # #...] [--run-only # # #...]
14 #
15 #
16 # EXAMPLE
17 # # git clone git://git.kernel.dk/fio.git
18 # # cd fio
19 # # make -j
20 # # python3 t/run-fio-tests.py
21 #
22 #
23 # REQUIREMENTS
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).
30 # - 4 CPUs (t0009)
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)
36 #
37 """
38
39 #
40 # TODO  run multiple tests simultaneously
41 # TODO  Add sgunmap tests (requires SAS SSD)
42 #
43
44 import os
45 import sys
46 import json
47 import time
48 import shutil
49 import logging
50 import argparse
51 import platform
52 import traceback
53 import subprocess
54 import multiprocessing
55 from pathlib import Path
56
57
58 class FioTest(object):
59     """Base for all fio tests."""
60
61     def __init__(self, exe_path, parameters, success):
62         self.exe_path = exe_path
63         self.parameters = parameters
64         self.success = success
65         self.output = {}
66         self.artifact_root = None
67         self.testnum = None
68         self.test_dir = None
69         self.passed = True
70         self.failure_reason = ''
71         self.command_file = None
72         self.stdout_file = None
73         self.stderr_file = None
74         self.exitcode_file = None
75
76     def setup(self, artifact_root, testnum):
77         """Setup instance variables for test."""
78
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)
84
85         self.command_file = os.path.join(
86             self.test_dir,
87             "{0}.command".format(os.path.basename(self.exe_path)))
88         self.stdout_file = os.path.join(
89             self.test_dir,
90             "{0}.stdout".format(os.path.basename(self.exe_path)))
91         self.stderr_file = os.path.join(
92             self.test_dir,
93             "{0}.stderr".format(os.path.basename(self.exe_path)))
94         self.exitcode_file = os.path.join(
95             self.test_dir,
96             "{0}.exitcode".format(os.path.basename(self.exe_path)))
97
98     def run(self):
99         """Run the test."""
100
101         raise NotImplementedError()
102
103     def check_result(self):
104         """Check test results."""
105
106         raise NotImplementedError()
107
108
109 class FioExeTest(FioTest):
110     """Test consists of an executable binary or script"""
111
112     def __init__(self, exe_path, parameters, success):
113         """Construct a FioExeTest which is a FioTest consisting of an
114         executable binary or script.
115
116         exe_path:       location of executable binary or script
117         parameters:     list of parameters for executable
118         success:        Definition of test success
119         """
120
121         FioTest.__init__(self, exe_path, parameters, success)
122
123     def run(self):
124         """Execute the binary or script described by this instance."""
125
126         command = [self.exe_path] + self.parameters
127         command_file = open(self.command_file, "w+")
128         command_file.write("%s\n" % command)
129         command_file.close()
130
131         stdout_file = open(self.stdout_file, "w+")
132         stderr_file = open(self.stderr_file, "w+")
133         exitcode_file = open(self.exitcode_file, "w+")
134         try:
135             proc = None
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,
141                                     stdout=stdout_file,
142                                     stderr=stderr_file,
143                                     cwd=self.test_dir,
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:
150             proc.terminate()
151             proc.communicate()
152             assert proc.poll()
153             self.output['failure'] = 'timeout'
154         except Exception:
155             if proc:
156                 if not proc.poll():
157                     proc.terminate()
158                     proc.communicate()
159             self.output['failure'] = 'exception'
160             self.output['exc_info'] = sys.exc_info()
161         finally:
162             stdout_file.close()
163             stderr_file.close()
164             exitcode_file.close()
165
166     def check_result(self):
167         """Check results of test run."""
168
169         if 'proc' not in self.output:
170             if self.output['failure'] == 'timeout':
171                 self.failure_reason = "{0} timeout,".format(self.failure_reason)
172             else:
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])
177
178             self.passed = False
179             return
180
181         if 'zero_return' in self.success:
182             if self.success['zero_return']:
183                 if self.output['proc'].returncode != 0:
184                     self.passed = False
185                     self.failure_reason = "{0} non-zero return code,".format(self.failure_reason)
186             else:
187                 if self.output['proc'].returncode == 0:
188                     self.failure_reason = "{0} zero return code,".format(self.failure_reason)
189                     self.passed = False
190
191         stderr_size = os.path.getsize(self.stderr_file)
192         if 'stderr_empty' in self.success:
193             if self.success['stderr_empty']:
194                 if stderr_size != 0:
195                     self.failure_reason = "{0} stderr not empty,".format(self.failure_reason)
196                     self.passed = False
197             else:
198                 if stderr_size == 0:
199                     self.failure_reason = "{0} stderr empty,".format(self.failure_reason)
200                     self.passed = False
201
202
203 class FioJobTest(FioExeTest):
204     """Test consists of a fio job"""
205
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.
210
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
217         """
218
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))
226         self.fio_args = [
227             "--max-jobs=16",
228             "--output-format={0}".format(self.output_format),
229             "--output={0}".format(self.fio_output),
230             self.fio_job,
231             ]
232         FioExeTest.__init__(self, fio_path, self.fio_args, success)
233
234     def setup(self, artifact_root, testnum):
235         """Setup instance variables for fio job test."""
236
237         super(FioJobTest, self).setup(artifact_root, testnum)
238
239         self.command_file = os.path.join(
240             self.test_dir,
241             "{0}.command".format(os.path.basename(self.fio_job)))
242         self.stdout_file = os.path.join(
243             self.test_dir,
244             "{0}.stdout".format(os.path.basename(self.fio_job)))
245         self.stderr_file = os.path.join(
246             self.test_dir,
247             "{0}.stderr".format(os.path.basename(self.fio_job)))
248         self.exitcode_file = os.path.join(
249             self.test_dir,
250             "{0}.exitcode".format(os.path.basename(self.fio_job)))
251
252     def run_pre_job(self):
253         """Run fio job precondition step."""
254
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)
259         precon.run()
260         precon.check_result()
261         self.precon_failed = not precon.passed
262         self.failure_reason = precon.failure_reason
263
264     def run(self):
265         """Run fio job test."""
266
267         if self.fio_pre_job:
268             self.run_pre_job()
269
270         if not self.precon_failed:
271             super(FioJobTest, self).run()
272         else:
273             logging.debug("Test %d: precondition step failed", self.testnum)
274
275     @classmethod
276     def get_file(cls, filename):
277         """Safely read a file."""
278         file_data = ''
279         success = True
280
281         try:
282             with open(filename, "r") as output_file:
283                 file_data = output_file.read()
284         except OSError:
285             success = False
286
287         return file_data, success
288
289     def check_result(self):
290         """Check fio job results."""
291
292         if self.precon_failed:
293             self.passed = False
294             self.failure_reason = "{0} precondition step failed,".format(self.failure_reason)
295             return
296
297         super(FioJobTest, self).check_result()
298
299         if not self.passed:
300             return
301
302         if 'json' not in self.output_format:
303             return
304
305         file_data, success = self.get_file(os.path.join(self.test_dir, self.fio_output))
306         if not success:
307             self.failure_reason = "{0} unable to open output file,".format(self.failure_reason)
308             self.passed = False
309             return
310
311         #
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 {
315         #
316         lines = file_data.splitlines()
317         file_data = '\n'.join(lines[lines.index("{"):])
318         try:
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)
322             self.passed = False
323
324
325 class FioJobTest_t0005(FioJobTest):
326     """Test consists of fio test job t0005
327     Confirm that read['io_kbytes'] == write['io_kbytes'] == 102400"""
328
329     def check_result(self):
330         super(FioJobTest_t0005, self).check_result()
331
332         if not self.passed:
333             return
334
335         if self.json_data['jobs'][0]['read']['io_kbytes'] != 102400:
336             self.failure_reason = "{0} bytes read mismatch,".format(self.failure_reason)
337             self.passed = False
338         if self.json_data['jobs'][0]['write']['io_kbytes'] != 102400:
339             self.failure_reason = "{0} bytes written mismatch,".format(self.failure_reason)
340             self.passed = False
341
342
343 class FioJobTest_t0006(FioJobTest):
344     """Test consists of fio test job t0006
345     Confirm that read['io_kbytes'] ~ 2*write['io_kbytes']"""
346
347     def check_result(self):
348         super(FioJobTest_t0006, self).check_result()
349
350         if not self.passed:
351             return
352
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)
358             self.passed = False
359
360
361 class FioJobTest_t0007(FioJobTest):
362     """Test consists of fio test job t0007
363     Confirm that read['io_kbytes'] = 87040"""
364
365     def check_result(self):
366         super(FioJobTest_t0007, self).check_result()
367
368         if not self.passed:
369             return
370
371         if self.json_data['jobs'][0]['read']['io_kbytes'] != 87040:
372             self.failure_reason = "{0} bytes read mismatch,".format(self.failure_reason)
373             self.passed = False
374
375
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
380
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"""
383
384     def check_result(self):
385         super(FioJobTest_t0008, self).check_result()
386
387         if not self.passed:
388             return
389
390         ratio = self.json_data['jobs'][0]['write']['io_kbytes'] / 16568
391         logging.debug("Test %d: ratio: %f", self.testnum, ratio)
392
393         if ratio < 0.99 or ratio > 1.01:
394             self.failure_reason = "{0} bytes written mismatch,".format(self.failure_reason)
395             self.passed = False
396         if self.json_data['jobs'][0]['read']['io_kbytes'] != 32768:
397             self.failure_reason = "{0} bytes read mismatch,".format(self.failure_reason)
398             self.passed = False
399
400
401 class FioJobTest_t0009(FioJobTest):
402     """Test consists of fio test job t0009
403     Confirm that runtime >= 60s"""
404
405     def check_result(self):
406         super(FioJobTest_t0009, self).check_result()
407
408         if not self.passed:
409             return
410
411         logging.debug('Test %d: elapsed: %d', self.testnum, self.json_data['jobs'][0]['elapsed'])
412
413         if self.json_data['jobs'][0]['elapsed'] < 60:
414             self.failure_reason = "{0} elapsed time mismatch,".format(self.failure_reason)
415             self.passed = False
416
417
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"""
422
423     def check_result(self):
424         super(FioJobTest_t0012, self).check_result()
425
426         if not self.passed:
427             return
428
429         iops_files = []
430         for i in range(1,4):
431             file_data, success = self.get_file(os.path.join(self.test_dir, "{0}_iops.{1}.log".format(os.path.basename(self.fio_job), i)))
432
433             if not success:
434                 self.failure_reason = "{0} unable to open output file,".format(self.failure_reason)
435                 self.passed = False
436                 return
437
438             iops_files.append(file_data.splitlines())
439
440         # there are 9 samples for job1 and job2, 4 samples for job3
441         iops1 = 0.0
442         iops2 = 0.0
443         iops3 = 0.0
444         for i in range(9):
445             iops1 = iops1 + float(iops_files[0][i].split(',')[1])
446             iops2 = iops2 + float(iops_files[1][i].split(',')[1])
447             iops3 = iops3 + float(iops_files[2][i].split(',')[1])
448
449             ratio1 = iops3/iops2
450             ratio2 = iops3/iops1
451             logging.debug(
452                 "sample {0}: job1 iops={1} job2 iops={2} job3 iops={3} job3/job2={4:.3f} job3/job1={5:.3f}".format(
453                     i, iops1, iops2, iops3, ratio1, ratio2
454                 )
455             )
456
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 = "{0} iops ratio mismatch iops1={1} iops2={2} iops3={3} expected r1~2 r2~10 got r1={4:.3f} r2={5:.3f},".format(
460                 self.failure_reason, iops1, iops2, iops3, ratio1, ratio2
461             )
462             self.passed = False
463             return
464
465
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.
470
471     The test is about making sure the flow feature can
472     re-calibrate the activity dynamically"""
473
474     def check_result(self):
475         super(FioJobTest_t0014, self).check_result()
476
477         if not self.passed:
478             return
479
480         iops_files = []
481         for i in range(1,4):
482             file_data, success = self.get_file(os.path.join(self.test_dir, "{0}_iops.{1}.log".format(os.path.basename(self.fio_job), i)))
483
484             if not success:
485                 self.failure_reason = "{0} unable to open output file,".format(self.failure_reason)
486                 self.passed = False
487                 return
488
489             iops_files.append(file_data.splitlines())
490
491         # there are 9 samples for job1 and job2, 4 samples for job3
492         iops1 = 0.0
493         iops2 = 0.0
494         iops3 = 0.0
495         for i in range(9):
496             if i < 4:
497                 iops3 = iops3 + float(iops_files[2][i].split(',')[1])
498             elif i == 4:
499                 ratio1 = iops1 / iops2
500                 ratio2 = iops1 / iops3
501
502
503                 if ratio1 < 0.43 or ratio1 > 0.57 or ratio2 < 0.21 or ratio2 > 0.45:
504                     self.failure_reason = "{0} iops ratio mismatch iops1={1} iops2={2} iops3={3}\
505                                                 expected r1~0.5 r2~0.33 got r1={4:.3f} r2={5:.3f},".format(
506                         self.failure_reason, iops1, iops2, iops3, ratio1, ratio2
507                     )
508                     self.passed = False
509
510             iops1 = iops1 + float(iops_files[0][i].split(',')[1])
511             iops2 = iops2 + float(iops_files[1][i].split(',')[1])
512
513             ratio1 = iops1/iops2
514             ratio2 = iops1/iops3
515             logging.debug(
516                 "sample {0}: job1 iops={1} job2 iops={2} job3 iops={3} job1/job2={4:.3f} job1/job3={5:.3f}".format(
517                     i, iops1, iops2, iops3, ratio1, ratio2
518                 )
519             )
520
521         # test job1 and job2 succeeded to recalibrate
522         if ratio1 < 0.43 or ratio1 > 0.57:
523             self.failure_reason = "{0} iops ratio mismatch iops1={1} iops2={2} expected ratio~0.5 got ratio={3:.3f},".format(
524                 self.failure_reason, iops1, iops2, ratio1
525             )
526             self.passed = False
527             return
528
529
530 class FioJobTest_t0015(FioJobTest):
531     """Test consists of fio test jobs t0015 and t0016
532     Confirm that mean(slat) + mean(clat) = mean(tlat)"""
533
534     def check_result(self):
535         super(FioJobTest_t0015, self).check_result()
536
537         if not self.passed:
538             return
539
540         slat = self.json_data['jobs'][0]['read']['slat_ns']['mean']
541         clat = self.json_data['jobs'][0]['read']['clat_ns']['mean']
542         tlat = self.json_data['jobs'][0]['read']['lat_ns']['mean']
543         logging.debug('Test %d: slat %f, clat %f, tlat %f', self.testnum, slat, clat, tlat)
544
545         if abs(slat + clat - tlat) > 1:
546             self.failure_reason = "{0} slat {1} + clat {2} = {3} != tlat {4},".format(
547                 self.failure_reason, slat, clat, slat+clat, tlat)
548             self.passed = False
549
550
551 class FioJobTest_t0019(FioJobTest):
552     """Test consists of fio test job t0019
553     Confirm that all offsets were touched sequentially"""
554
555     def check_result(self):
556         super(FioJobTest_t0019, self).check_result()
557
558         bw_log_filename = os.path.join(self.test_dir, "test_bw.log")
559         file_data, success = self.get_file(bw_log_filename)
560         log_lines = file_data.split('\n')
561
562         prev = -4096
563         for line in log_lines:
564             if len(line.strip()) == 0:
565                 continue
566             cur = int(line.split(',')[4])
567             if cur - prev != 4096:
568                 self.passed = False
569                 self.failure_reason = "offsets {0}, {1} not sequential".format(prev, cur)
570                 return
571             prev = cur
572
573         if cur/4096 != 255:
574             self.passed = False
575             self.failure_reason = "unexpected last offset {0}".format(cur)
576
577
578 class FioJobTest_t0020(FioJobTest):
579     """Test consists of fio test jobs t0020 and t0021
580     Confirm that almost all offsets were touched non-sequentially"""
581
582     def check_result(self):
583         super(FioJobTest_t0020, self).check_result()
584
585         bw_log_filename = os.path.join(self.test_dir, "test_bw.log")
586         file_data, success = self.get_file(bw_log_filename)
587         log_lines = file_data.split('\n')
588
589         seq_count = 0
590         offsets = set()
591
592         prev = int(log_lines[0].split(',')[4])
593         for line in log_lines[1:]:
594             offsets.add(prev/4096)
595             if len(line.strip()) == 0:
596                 continue
597             cur = int(line.split(',')[4])
598             if cur - prev == 4096:
599                 seq_count += 1
600             prev = cur
601
602         # 10 is an arbitrary threshold
603         if seq_count > 10:
604             self.passed = False
605             self.failure_reason = "too many ({0}) consecutive offsets".format(seq_count)
606
607         if len(offsets) != 256:
608             self.passed = False
609             self.failure_reason += " number of offsets is {0} instead of 256".format(len(offsets))
610
611         for i in range(256):
612             if not i in offsets:
613                 self.passed = False
614                 self.failure_reason += " missing offset {0}".format(i*4096)
615
616
617 class FioJobTest_t0022(FioJobTest):
618     """Test consists of fio test job t0022"""
619
620     def check_result(self):
621         super(FioJobTest_t0022, self).check_result()
622
623         bw_log_filename = os.path.join(self.test_dir, "test_bw.log")
624         file_data, success = self.get_file(bw_log_filename)
625         log_lines = file_data.split('\n')
626
627         filesize = 1024*1024
628         bs = 4096
629         seq_count = 0
630         offsets = set()
631
632         prev = int(log_lines[0].split(',')[4])
633         for line in log_lines[1:]:
634             offsets.add(prev/bs)
635             if len(line.strip()) == 0:
636                 continue
637             cur = int(line.split(',')[4])
638             if cur - prev == bs:
639                 seq_count += 1
640             prev = cur
641
642         # 10 is an arbitrary threshold
643         if seq_count > 10:
644             self.passed = False
645             self.failure_reason = "too many ({0}) consecutive offsets".format(seq_count)
646
647         if len(offsets) == filesize/bs:
648             self.passed = False
649             self.failure_reason += " no duplicate offsets found with norandommap=1".format(len(offsets))
650
651
652 class FioJobTest_t0023(FioJobTest):
653     """Test consists of fio test job t0023"""
654
655     def check_seq(self, filename):
656         bw_log_filename = os.path.join(self.test_dir, filename)
657         file_data, success = self.get_file(bw_log_filename)
658         log_lines = file_data.split('\n')
659
660         prev_ddir = 1
661         for line in log_lines:
662             if len(line.strip()) == 0:
663                 continue
664             vals = line.split(',')
665             ddir = int(vals[2])
666             bs = int(vals[3])
667             offset = int(vals[4])
668             if prev_ddir == 1:
669                 if ddir != 2:
670                     self.passed = False
671                     self.failure_reason += " {0}: write not preceeded by trim: {1}".format(bw_log_filename, line)
672                     break
673             else:
674                 if ddir != 1:
675                     self.passed = False
676                     self.failure_reason += " {0}: trim not preceeded by write: {1}".format(bw_log_filename, line)
677                     break
678                 else:
679                     if prev_bs != bs:
680                         self.passed = False
681                         self.failure_reason += " {0}: block size does not match: {1}".format(bw_log_filename, line)
682                         break
683                     if prev_offset != offset:
684                         self.passed = False
685                         self.failure_reason += " {0}: offset does not match: {1}".format(bw_log_filename, line)
686                         break
687             prev_ddir = ddir
688             prev_bs = bs
689             prev_offset = offset
690
691
692     def check_result(self):
693         super(FioJobTest_t0023, self).check_result()
694
695         self.check_seq("basic_bw.log")
696         self.check_seq("bs_bw.log")
697         self.check_seq("bsrange_bw.log")
698         self.check_seq("bssplit_bw.log")
699         self.check_seq("basic_no_rm_bw.log")
700         self.check_seq("bs_no_rm_bw.log")
701         self.check_seq("bsrange_no_rm_bw.log")
702         self.check_seq("bssplit_no_rm_bw.log")
703
704         # TODO make sure all offsets were touched
705
706
707 class FioJobTest_iops_rate(FioJobTest):
708     """Test consists of fio test job t0009
709     Confirm that job0 iops == 1000
710     and that job1_iops / job0_iops ~ 8
711     With two runs of fio-3.16 I observed a ratio of 8.3"""
712
713     def check_result(self):
714         super(FioJobTest_iops_rate, self).check_result()
715
716         if not self.passed:
717             return
718
719         iops1 = self.json_data['jobs'][0]['read']['iops']
720         logging.debug("Test %d: iops1: %f", self.testnum, iops1)
721         iops2 = self.json_data['jobs'][1]['read']['iops']
722         logging.debug("Test %d: iops2: %f", self.testnum, iops2)
723         ratio = iops2 / iops1
724         logging.debug("Test %d: ratio: %f", self.testnum, ratio)
725
726         if iops1 < 950 or iops1 > 1050:
727             self.failure_reason = "{0} iops value mismatch,".format(self.failure_reason)
728             self.passed = False
729
730         if ratio < 6 or ratio > 10:
731             self.failure_reason = "{0} iops ratio mismatch,".format(self.failure_reason)
732             self.passed = False
733
734
735 class Requirements(object):
736     """Requirements consists of multiple run environment characteristics.
737     These are to determine if a particular test can be run"""
738
739     _linux = False
740     _libaio = False
741     _io_uring = False
742     _zbd = False
743     _root = False
744     _zoned_nullb = False
745     _not_macos = False
746     _not_windows = False
747     _unittests = False
748     _cpucount4 = False
749
750     def __init__(self, fio_root):
751         Requirements._not_macos = platform.system() != "Darwin"
752         Requirements._not_windows = platform.system() != "Windows"
753         Requirements._linux = platform.system() == "Linux"
754
755         if Requirements._linux:
756             config_file = os.path.join(fio_root, "config-host.h")
757             contents, success = FioJobTest.get_file(config_file)
758             if not success:
759                 print("Unable to open {0} to check requirements".format(config_file))
760                 Requirements._zbd = True
761             else:
762                 Requirements._zbd = "CONFIG_HAS_BLKZONED" in contents
763                 Requirements._libaio = "CONFIG_LIBAIO" in contents
764
765             contents, success = FioJobTest.get_file("/proc/kallsyms")
766             if not success:
767                 print("Unable to open '/proc/kallsyms' to probe for io_uring support")
768             else:
769                 Requirements._io_uring = "io_uring_setup" in contents
770
771             Requirements._root = (os.geteuid() == 0)
772             if Requirements._zbd and Requirements._root:
773                 try:
774                     subprocess.run(["modprobe", "null_blk"],
775                                    stdout=subprocess.PIPE,
776                                    stderr=subprocess.PIPE)
777                     if os.path.exists("/sys/module/null_blk/parameters/zoned"):
778                         Requirements._zoned_nullb = True
779                 except Exception:
780                     pass
781
782         if platform.system() == "Windows":
783             utest_exe = "unittest.exe"
784         else:
785             utest_exe = "unittest"
786         unittest_path = os.path.join(fio_root, "unittests", utest_exe)
787         Requirements._unittests = os.path.exists(unittest_path)
788
789         Requirements._cpucount4 = multiprocessing.cpu_count() >= 4
790
791         req_list = [Requirements.linux,
792                     Requirements.libaio,
793                     Requirements.io_uring,
794                     Requirements.zbd,
795                     Requirements.root,
796                     Requirements.zoned_nullb,
797                     Requirements.not_macos,
798                     Requirements.not_windows,
799                     Requirements.unittests,
800                     Requirements.cpucount4]
801         for req in req_list:
802             value, desc = req()
803             logging.debug("Requirements: Requirement '%s' met? %s", desc, value)
804
805     @classmethod
806     def linux(cls):
807         """Are we running on Linux?"""
808         return Requirements._linux, "Linux required"
809
810     @classmethod
811     def libaio(cls):
812         """Is libaio available?"""
813         return Requirements._libaio, "libaio required"
814
815     @classmethod
816     def io_uring(cls):
817         """Is io_uring available?"""
818         return Requirements._io_uring, "io_uring required"
819
820     @classmethod
821     def zbd(cls):
822         """Is ZBD support available?"""
823         return Requirements._zbd, "Zoned block device support required"
824
825     @classmethod
826     def root(cls):
827         """Are we running as root?"""
828         return Requirements._root, "root required"
829
830     @classmethod
831     def zoned_nullb(cls):
832         """Are zoned null block devices available?"""
833         return Requirements._zoned_nullb, "Zoned null block device support required"
834
835     @classmethod
836     def not_macos(cls):
837         """Are we running on a platform other than macOS?"""
838         return Requirements._not_macos, "platform other than macOS required"
839
840     @classmethod
841     def not_windows(cls):
842         """Are we running on a platform other than Windws?"""
843         return Requirements._not_windows, "platform other than Windows required"
844
845     @classmethod
846     def unittests(cls):
847         """Were unittests built?"""
848         return Requirements._unittests, "Unittests support required"
849
850     @classmethod
851     def cpucount4(cls):
852         """Do we have at least 4 CPUs?"""
853         return Requirements._cpucount4, "4+ CPUs required"
854
855
856 SUCCESS_DEFAULT = {
857     'zero_return': True,
858     'stderr_empty': True,
859     'timeout': 600,
860     }
861 SUCCESS_NONZERO = {
862     'zero_return': False,
863     'stderr_empty': False,
864     'timeout': 600,
865     }
866 SUCCESS_STDERR = {
867     'zero_return': True,
868     'stderr_empty': False,
869     'timeout': 600,
870     }
871 TEST_LIST = [
872     {
873         'test_id':          1,
874         'test_class':       FioJobTest,
875         'job':              't0001-52c58027.fio',
876         'success':          SUCCESS_DEFAULT,
877         'pre_job':          None,
878         'pre_success':      None,
879         'requirements':     [],
880     },
881     {
882         'test_id':          2,
883         'test_class':       FioJobTest,
884         'job':              't0002-13af05ae-post.fio',
885         'success':          SUCCESS_DEFAULT,
886         'pre_job':          't0002-13af05ae-pre.fio',
887         'pre_success':      None,
888         'requirements':     [Requirements.linux, Requirements.libaio],
889     },
890     {
891         'test_id':          3,
892         'test_class':       FioJobTest,
893         'job':              't0003-0ae2c6e1-post.fio',
894         'success':          SUCCESS_NONZERO,
895         'pre_job':          't0003-0ae2c6e1-pre.fio',
896         'pre_success':      SUCCESS_DEFAULT,
897         'requirements':     [Requirements.linux, Requirements.libaio],
898     },
899     {
900         'test_id':          4,
901         'test_class':       FioJobTest,
902         'job':              't0004-8a99fdf6.fio',
903         'success':          SUCCESS_DEFAULT,
904         'pre_job':          None,
905         'pre_success':      None,
906         'requirements':     [Requirements.linux, Requirements.libaio],
907     },
908     {
909         'test_id':          5,
910         'test_class':       FioJobTest_t0005,
911         'job':              't0005-f7078f7b.fio',
912         'success':          SUCCESS_DEFAULT,
913         'pre_job':          None,
914         'pre_success':      None,
915         'output_format':    'json',
916         'requirements':     [Requirements.not_windows],
917     },
918     {
919         'test_id':          6,
920         'test_class':       FioJobTest_t0006,
921         'job':              't0006-82af2a7c.fio',
922         'success':          SUCCESS_DEFAULT,
923         'pre_job':          None,
924         'pre_success':      None,
925         'output_format':    'json',
926         'requirements':     [Requirements.linux, Requirements.libaio],
927     },
928     {
929         'test_id':          7,
930         'test_class':       FioJobTest_t0007,
931         'job':              't0007-37cf9e3c.fio',
932         'success':          SUCCESS_DEFAULT,
933         'pre_job':          None,
934         'pre_success':      None,
935         'output_format':    'json',
936         'requirements':     [],
937     },
938     {
939         'test_id':          8,
940         'test_class':       FioJobTest_t0008,
941         'job':              't0008-ae2fafc8.fio',
942         'success':          SUCCESS_DEFAULT,
943         'pre_job':          None,
944         'pre_success':      None,
945         'output_format':    'json',
946         'requirements':     [],
947     },
948     {
949         'test_id':          9,
950         'test_class':       FioJobTest_t0009,
951         'job':              't0009-f8b0bd10.fio',
952         'success':          SUCCESS_DEFAULT,
953         'pre_job':          None,
954         'pre_success':      None,
955         'output_format':    'json',
956         'requirements':     [Requirements.not_macos,
957                              Requirements.cpucount4],
958         # mac os does not support CPU affinity
959     },
960     {
961         'test_id':          10,
962         'test_class':       FioJobTest,
963         'job':              't0010-b7aae4ba.fio',
964         'success':          SUCCESS_DEFAULT,
965         'pre_job':          None,
966         'pre_success':      None,
967         'requirements':     [],
968     },
969     {
970         'test_id':          11,
971         'test_class':       FioJobTest_iops_rate,
972         'job':              't0011-5d2788d5.fio',
973         'success':          SUCCESS_DEFAULT,
974         'pre_job':          None,
975         'pre_success':      None,
976         'output_format':    'json',
977         'requirements':     [],
978     },
979     {
980         'test_id':          12,
981         'test_class':       FioJobTest_t0012,
982         'job':              't0012.fio',
983         'success':          SUCCESS_DEFAULT,
984         'pre_job':          None,
985         'pre_success':      None,
986         'output_format':    'json',
987         'requirements':     [],
988     },
989     {
990         'test_id':          13,
991         'test_class':       FioJobTest,
992         'job':              't0013.fio',
993         'success':          SUCCESS_DEFAULT,
994         'pre_job':          None,
995         'pre_success':      None,
996         'output_format':    'json',
997         'requirements':     [],
998     },
999     {
1000         'test_id':          14,
1001         'test_class':       FioJobTest_t0014,
1002         'job':              't0014.fio',
1003         'success':          SUCCESS_DEFAULT,
1004         'pre_job':          None,
1005         'pre_success':      None,
1006         'output_format':    'json',
1007         'requirements':     [],
1008     },
1009     {
1010         'test_id':          15,
1011         'test_class':       FioJobTest_t0015,
1012         'job':              't0015-e78980ff.fio',
1013         'success':          SUCCESS_DEFAULT,
1014         'pre_job':          None,
1015         'pre_success':      None,
1016         'output_format':    'json',
1017         'requirements':     [Requirements.linux, Requirements.libaio],
1018     },
1019     {
1020         'test_id':          16,
1021         'test_class':       FioJobTest_t0015,
1022         'job':              't0016-d54ae22.fio',
1023         'success':          SUCCESS_DEFAULT,
1024         'pre_job':          None,
1025         'pre_success':      None,
1026         'output_format':    'json',
1027         'requirements':     [],
1028     },
1029     {
1030         'test_id':          17,
1031         'test_class':       FioJobTest_t0015,
1032         'job':              't0017.fio',
1033         'success':          SUCCESS_DEFAULT,
1034         'pre_job':          None,
1035         'pre_success':      None,
1036         'output_format':    'json',
1037         'requirements':     [Requirements.not_windows],
1038     },
1039     {
1040         'test_id':          18,
1041         'test_class':       FioJobTest,
1042         'job':              't0018.fio',
1043         'success':          SUCCESS_DEFAULT,
1044         'pre_job':          None,
1045         'pre_success':      None,
1046         'requirements':     [Requirements.linux, Requirements.io_uring],
1047     },
1048     {
1049         'test_id':          19,
1050         'test_class':       FioJobTest_t0019,
1051         'job':              't0019.fio',
1052         'success':          SUCCESS_DEFAULT,
1053         'pre_job':          None,
1054         'pre_success':      None,
1055         'requirements':     [],
1056     },
1057     {
1058         'test_id':          20,
1059         'test_class':       FioJobTest_t0020,
1060         'job':              't0020.fio',
1061         'success':          SUCCESS_DEFAULT,
1062         'pre_job':          None,
1063         'pre_success':      None,
1064         'requirements':     [],
1065     },
1066     {
1067         'test_id':          21,
1068         'test_class':       FioJobTest_t0020,
1069         'job':              't0021.fio',
1070         'success':          SUCCESS_DEFAULT,
1071         'pre_job':          None,
1072         'pre_success':      None,
1073         'requirements':     [],
1074     },
1075     {
1076         'test_id':          22,
1077         'test_class':       FioJobTest_t0022,
1078         'job':              't0022.fio',
1079         'success':          SUCCESS_DEFAULT,
1080         'pre_job':          None,
1081         'pre_success':      None,
1082         'requirements':     [],
1083     },
1084     {
1085         'test_id':          23,
1086         'test_class':       FioJobTest_t0023,
1087         'job':              't0023.fio',
1088         'success':          SUCCESS_DEFAULT,
1089         'pre_job':          None,
1090         'pre_success':      None,
1091         'requirements':     [],
1092     },
1093     {
1094         'test_id':          1000,
1095         'test_class':       FioExeTest,
1096         'exe':              't/axmap',
1097         'parameters':       None,
1098         'success':          SUCCESS_DEFAULT,
1099         'requirements':     [],
1100     },
1101     {
1102         'test_id':          1001,
1103         'test_class':       FioExeTest,
1104         'exe':              't/ieee754',
1105         'parameters':       None,
1106         'success':          SUCCESS_DEFAULT,
1107         'requirements':     [],
1108     },
1109     {
1110         'test_id':          1002,
1111         'test_class':       FioExeTest,
1112         'exe':              't/lfsr-test',
1113         'parameters':       ['0xFFFFFF', '0', '0', 'verify'],
1114         'success':          SUCCESS_STDERR,
1115         'requirements':     [],
1116     },
1117     {
1118         'test_id':          1003,
1119         'test_class':       FioExeTest,
1120         'exe':              't/readonly.py',
1121         'parameters':       ['-f', '{fio_path}'],
1122         'success':          SUCCESS_DEFAULT,
1123         'requirements':     [],
1124     },
1125     {
1126         'test_id':          1004,
1127         'test_class':       FioExeTest,
1128         'exe':              't/steadystate_tests.py',
1129         'parameters':       ['{fio_path}'],
1130         'success':          SUCCESS_DEFAULT,
1131         'requirements':     [],
1132     },
1133     {
1134         'test_id':          1005,
1135         'test_class':       FioExeTest,
1136         'exe':              't/stest',
1137         'parameters':       None,
1138         'success':          SUCCESS_STDERR,
1139         'requirements':     [],
1140     },
1141     {
1142         'test_id':          1006,
1143         'test_class':       FioExeTest,
1144         'exe':              't/strided.py',
1145         'parameters':       ['{fio_path}'],
1146         'success':          SUCCESS_DEFAULT,
1147         'requirements':     [],
1148     },
1149     {
1150         'test_id':          1007,
1151         'test_class':       FioExeTest,
1152         'exe':              't/zbd/run-tests-against-nullb',
1153         'parameters':       ['-s', '1'],
1154         'success':          SUCCESS_DEFAULT,
1155         'requirements':     [Requirements.linux, Requirements.zbd,
1156                              Requirements.root],
1157     },
1158     {
1159         'test_id':          1008,
1160         'test_class':       FioExeTest,
1161         'exe':              't/zbd/run-tests-against-nullb',
1162         'parameters':       ['-s', '2'],
1163         'success':          SUCCESS_DEFAULT,
1164         'requirements':     [Requirements.linux, Requirements.zbd,
1165                              Requirements.root, Requirements.zoned_nullb],
1166     },
1167     {
1168         'test_id':          1009,
1169         'test_class':       FioExeTest,
1170         'exe':              'unittests/unittest',
1171         'parameters':       None,
1172         'success':          SUCCESS_DEFAULT,
1173         'requirements':     [Requirements.unittests],
1174     },
1175     {
1176         'test_id':          1010,
1177         'test_class':       FioExeTest,
1178         'exe':              't/latency_percentiles.py',
1179         'parameters':       ['-f', '{fio_path}'],
1180         'success':          SUCCESS_DEFAULT,
1181         'requirements':     [],
1182     },
1183     {
1184         'test_id':          1011,
1185         'test_class':       FioExeTest,
1186         'exe':              't/jsonplus2csv_test.py',
1187         'parameters':       ['-f', '{fio_path}'],
1188         'success':          SUCCESS_DEFAULT,
1189         'requirements':     [],
1190     },
1191     {
1192         'test_id':          1012,
1193         'test_class':       FioExeTest,
1194         'exe':              't/log_compression.py',
1195         'parameters':       ['-f', '{fio_path}'],
1196         'success':          SUCCESS_DEFAULT,
1197         'requirements':     [],
1198     },
1199 ]
1200
1201
1202 def parse_args():
1203     """Parse command-line arguments."""
1204
1205     parser = argparse.ArgumentParser()
1206     parser.add_argument('-r', '--fio-root',
1207                         help='fio root path')
1208     parser.add_argument('-f', '--fio',
1209                         help='path to fio executable (e.g., ./fio)')
1210     parser.add_argument('-a', '--artifact-root',
1211                         help='artifact root directory')
1212     parser.add_argument('-s', '--skip', nargs='+', type=int,
1213                         help='list of test(s) to skip')
1214     parser.add_argument('-o', '--run-only', nargs='+', type=int,
1215                         help='list of test(s) to run, skipping all others')
1216     parser.add_argument('-d', '--debug', action='store_true',
1217                         help='provide debug output')
1218     parser.add_argument('-k', '--skip-req', action='store_true',
1219                         help='skip requirements checking')
1220     parser.add_argument('-p', '--pass-through', action='append',
1221                         help='pass-through an argument to an executable test')
1222     args = parser.parse_args()
1223
1224     return args
1225
1226
1227 def main():
1228     """Entry point."""
1229
1230     args = parse_args()
1231     if args.debug:
1232         logging.basicConfig(level=logging.DEBUG)
1233     else:
1234         logging.basicConfig(level=logging.INFO)
1235
1236     pass_through = {}
1237     if args.pass_through:
1238         for arg in args.pass_through:
1239             if not ':' in arg:
1240                 print("Invalid --pass-through argument '%s'" % arg)
1241                 print("Syntax for --pass-through is TESTNUMBER:ARGUMENT")
1242                 return
1243             split = arg.split(":", 1)
1244             pass_through[int(split[0])] = split[1]
1245         logging.debug("Pass-through arguments: %s", pass_through)
1246
1247     if args.fio_root:
1248         fio_root = args.fio_root
1249     else:
1250         fio_root = str(Path(__file__).absolute().parent.parent)
1251     print("fio root is %s" % fio_root)
1252
1253     if args.fio:
1254         fio_path = args.fio
1255     else:
1256         if platform.system() == "Windows":
1257             fio_exe = "fio.exe"
1258         else:
1259             fio_exe = "fio"
1260         fio_path = os.path.join(fio_root, fio_exe)
1261     print("fio path is %s" % fio_path)
1262     if not shutil.which(fio_path):
1263         print("Warning: fio executable not found")
1264
1265     artifact_root = args.artifact_root if args.artifact_root else \
1266         "fio-test-{0}".format(time.strftime("%Y%m%d-%H%M%S"))
1267     os.mkdir(artifact_root)
1268     print("Artifact directory is %s" % artifact_root)
1269
1270     if not args.skip_req:
1271         req = Requirements(fio_root)
1272
1273     passed = 0
1274     failed = 0
1275     skipped = 0
1276
1277     for config in TEST_LIST:
1278         if (args.skip and config['test_id'] in args.skip) or \
1279            (args.run_only and config['test_id'] not in args.run_only):
1280             skipped = skipped + 1
1281             print("Test {0} SKIPPED (User request)".format(config['test_id']))
1282             continue
1283
1284         if issubclass(config['test_class'], FioJobTest):
1285             if config['pre_job']:
1286                 fio_pre_job = os.path.join(fio_root, 't', 'jobs',
1287                                            config['pre_job'])
1288             else:
1289                 fio_pre_job = None
1290             if config['pre_success']:
1291                 fio_pre_success = config['pre_success']
1292             else:
1293                 fio_pre_success = None
1294             if 'output_format' in config:
1295                 output_format = config['output_format']
1296             else:
1297                 output_format = 'normal'
1298             test = config['test_class'](
1299                 fio_path,
1300                 os.path.join(fio_root, 't', 'jobs', config['job']),
1301                 config['success'],
1302                 fio_pre_job=fio_pre_job,
1303                 fio_pre_success=fio_pre_success,
1304                 output_format=output_format)
1305             desc = config['job']
1306         elif issubclass(config['test_class'], FioExeTest):
1307             exe_path = os.path.join(fio_root, config['exe'])
1308             if config['parameters']:
1309                 parameters = [p.format(fio_path=fio_path) for p in config['parameters']]
1310             else:
1311                 parameters = []
1312             if Path(exe_path).suffix == '.py' and platform.system() == "Windows":
1313                 parameters.insert(0, exe_path)
1314                 exe_path = "python.exe"
1315             if config['test_id'] in pass_through:
1316                 parameters += pass_through[config['test_id']].split()
1317             test = config['test_class'](exe_path, parameters,
1318                                         config['success'])
1319             desc = config['exe']
1320         else:
1321             print("Test {0} FAILED: unable to process test config".format(config['test_id']))
1322             failed = failed + 1
1323             continue
1324
1325         if not args.skip_req:
1326             reqs_met = True
1327             for req in config['requirements']:
1328                 reqs_met, reason = req()
1329                 logging.debug("Test %d: Requirement '%s' met? %s", config['test_id'], reason,
1330                               reqs_met)
1331                 if not reqs_met:
1332                     break
1333             if not reqs_met:
1334                 print("Test {0} SKIPPED ({1}) {2}".format(config['test_id'], reason, desc))
1335                 skipped = skipped + 1
1336                 continue
1337
1338         try:
1339             test.setup(artifact_root, config['test_id'])
1340             test.run()
1341             test.check_result()
1342         except KeyboardInterrupt:
1343             break
1344         except Exception as e:
1345             test.passed = False
1346             test.failure_reason += str(e)
1347             logging.debug("Test %d exception:\n%s\n", config['test_id'], traceback.format_exc())
1348         if test.passed:
1349             result = "PASSED"
1350             passed = passed + 1
1351         else:
1352             result = "FAILED: {0}".format(test.failure_reason)
1353             failed = failed + 1
1354             contents, _ = FioJobTest.get_file(test.stderr_file)
1355             logging.debug("Test %d: stderr:\n%s", config['test_id'], contents)
1356             contents, _ = FioJobTest.get_file(test.stdout_file)
1357             logging.debug("Test %d: stdout:\n%s", config['test_id'], contents)
1358         print("Test {0} {1} {2}".format(config['test_id'], result, desc))
1359
1360     print("{0} test(s) passed, {1} failed, {2} skipped".format(passed, failed, skipped))
1361
1362     sys.exit(failed)
1363
1364
1365 if __name__ == '__main__':
1366     main()