test: clean up randtrimwrite test
[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_trimwrite(self, filename):
656         """Make sure that trims are followed by writes of the same size at the same offset."""
657
658         bw_log_filename = os.path.join(self.test_dir, filename)
659         file_data, success = self.get_file(bw_log_filename)
660         log_lines = file_data.split('\n')
661
662         prev_ddir = 1
663         for line in log_lines:
664             if len(line.strip()) == 0:
665                 continue
666             vals = line.split(',')
667             ddir = int(vals[2])
668             bs = int(vals[3])
669             offset = int(vals[4])
670             if prev_ddir == 1:
671                 if ddir != 2:
672                     self.passed = False
673                     self.failure_reason += " {0}: write not preceeded by trim: {1}".format(bw_log_filename, line)
674                     break
675             else:
676                 if ddir != 1:
677                     self.passed = False
678                     self.failure_reason += " {0}: trim not preceeded by write: {1}".format(bw_log_filename, line)
679                     break
680                 else:
681                     if prev_bs != bs:
682                         self.passed = False
683                         self.failure_reason += " {0}: block size does not match: {1}".format(bw_log_filename, line)
684                         break
685                     if prev_offset != offset:
686                         self.passed = False
687                         self.failure_reason += " {0}: offset does not match: {1}".format(bw_log_filename, line)
688                         break
689             prev_ddir = ddir
690             prev_bs = bs
691             prev_offset = offset
692
693
694     def check_result(self):
695         super(FioJobTest_t0023, self).check_result()
696
697         self.check_trimwrite("basic_bw.log")
698         self.check_trimwrite("bs_bw.log")
699         self.check_trimwrite("bsrange_bw.log")
700         self.check_trimwrite("bssplit_bw.log")
701         self.check_trimwrite("basic_no_rm_bw.log")
702         self.check_trimwrite("bs_no_rm_bw.log")
703         self.check_trimwrite("bsrange_no_rm_bw.log")
704         self.check_trimwrite("bssplit_no_rm_bw.log")
705
706         # TODO make sure all offsets were touched
707
708
709 class FioJobTest_iops_rate(FioJobTest):
710     """Test consists of fio test job t0009
711     Confirm that job0 iops == 1000
712     and that job1_iops / job0_iops ~ 8
713     With two runs of fio-3.16 I observed a ratio of 8.3"""
714
715     def check_result(self):
716         super(FioJobTest_iops_rate, self).check_result()
717
718         if not self.passed:
719             return
720
721         iops1 = self.json_data['jobs'][0]['read']['iops']
722         logging.debug("Test %d: iops1: %f", self.testnum, iops1)
723         iops2 = self.json_data['jobs'][1]['read']['iops']
724         logging.debug("Test %d: iops2: %f", self.testnum, iops2)
725         ratio = iops2 / iops1
726         logging.debug("Test %d: ratio: %f", self.testnum, ratio)
727
728         if iops1 < 950 or iops1 > 1050:
729             self.failure_reason = "{0} iops value mismatch,".format(self.failure_reason)
730             self.passed = False
731
732         if ratio < 6 or ratio > 10:
733             self.failure_reason = "{0} iops ratio mismatch,".format(self.failure_reason)
734             self.passed = False
735
736
737 class Requirements(object):
738     """Requirements consists of multiple run environment characteristics.
739     These are to determine if a particular test can be run"""
740
741     _linux = False
742     _libaio = False
743     _io_uring = False
744     _zbd = False
745     _root = False
746     _zoned_nullb = False
747     _not_macos = False
748     _not_windows = False
749     _unittests = False
750     _cpucount4 = False
751
752     def __init__(self, fio_root):
753         Requirements._not_macos = platform.system() != "Darwin"
754         Requirements._not_windows = platform.system() != "Windows"
755         Requirements._linux = platform.system() == "Linux"
756
757         if Requirements._linux:
758             config_file = os.path.join(fio_root, "config-host.h")
759             contents, success = FioJobTest.get_file(config_file)
760             if not success:
761                 print("Unable to open {0} to check requirements".format(config_file))
762                 Requirements._zbd = True
763             else:
764                 Requirements._zbd = "CONFIG_HAS_BLKZONED" in contents
765                 Requirements._libaio = "CONFIG_LIBAIO" in contents
766
767             contents, success = FioJobTest.get_file("/proc/kallsyms")
768             if not success:
769                 print("Unable to open '/proc/kallsyms' to probe for io_uring support")
770             else:
771                 Requirements._io_uring = "io_uring_setup" in contents
772
773             Requirements._root = (os.geteuid() == 0)
774             if Requirements._zbd and Requirements._root:
775                 try:
776                     subprocess.run(["modprobe", "null_blk"],
777                                    stdout=subprocess.PIPE,
778                                    stderr=subprocess.PIPE)
779                     if os.path.exists("/sys/module/null_blk/parameters/zoned"):
780                         Requirements._zoned_nullb = True
781                 except Exception:
782                     pass
783
784         if platform.system() == "Windows":
785             utest_exe = "unittest.exe"
786         else:
787             utest_exe = "unittest"
788         unittest_path = os.path.join(fio_root, "unittests", utest_exe)
789         Requirements._unittests = os.path.exists(unittest_path)
790
791         Requirements._cpucount4 = multiprocessing.cpu_count() >= 4
792
793         req_list = [Requirements.linux,
794                     Requirements.libaio,
795                     Requirements.io_uring,
796                     Requirements.zbd,
797                     Requirements.root,
798                     Requirements.zoned_nullb,
799                     Requirements.not_macos,
800                     Requirements.not_windows,
801                     Requirements.unittests,
802                     Requirements.cpucount4]
803         for req in req_list:
804             value, desc = req()
805             logging.debug("Requirements: Requirement '%s' met? %s", desc, value)
806
807     @classmethod
808     def linux(cls):
809         """Are we running on Linux?"""
810         return Requirements._linux, "Linux required"
811
812     @classmethod
813     def libaio(cls):
814         """Is libaio available?"""
815         return Requirements._libaio, "libaio required"
816
817     @classmethod
818     def io_uring(cls):
819         """Is io_uring available?"""
820         return Requirements._io_uring, "io_uring required"
821
822     @classmethod
823     def zbd(cls):
824         """Is ZBD support available?"""
825         return Requirements._zbd, "Zoned block device support required"
826
827     @classmethod
828     def root(cls):
829         """Are we running as root?"""
830         return Requirements._root, "root required"
831
832     @classmethod
833     def zoned_nullb(cls):
834         """Are zoned null block devices available?"""
835         return Requirements._zoned_nullb, "Zoned null block device support required"
836
837     @classmethod
838     def not_macos(cls):
839         """Are we running on a platform other than macOS?"""
840         return Requirements._not_macos, "platform other than macOS required"
841
842     @classmethod
843     def not_windows(cls):
844         """Are we running on a platform other than Windws?"""
845         return Requirements._not_windows, "platform other than Windows required"
846
847     @classmethod
848     def unittests(cls):
849         """Were unittests built?"""
850         return Requirements._unittests, "Unittests support required"
851
852     @classmethod
853     def cpucount4(cls):
854         """Do we have at least 4 CPUs?"""
855         return Requirements._cpucount4, "4+ CPUs required"
856
857
858 SUCCESS_DEFAULT = {
859     'zero_return': True,
860     'stderr_empty': True,
861     'timeout': 600,
862     }
863 SUCCESS_NONZERO = {
864     'zero_return': False,
865     'stderr_empty': False,
866     'timeout': 600,
867     }
868 SUCCESS_STDERR = {
869     'zero_return': True,
870     'stderr_empty': False,
871     'timeout': 600,
872     }
873 TEST_LIST = [
874     {
875         'test_id':          1,
876         'test_class':       FioJobTest,
877         'job':              't0001-52c58027.fio',
878         'success':          SUCCESS_DEFAULT,
879         'pre_job':          None,
880         'pre_success':      None,
881         'requirements':     [],
882     },
883     {
884         'test_id':          2,
885         'test_class':       FioJobTest,
886         'job':              't0002-13af05ae-post.fio',
887         'success':          SUCCESS_DEFAULT,
888         'pre_job':          't0002-13af05ae-pre.fio',
889         'pre_success':      None,
890         'requirements':     [Requirements.linux, Requirements.libaio],
891     },
892     {
893         'test_id':          3,
894         'test_class':       FioJobTest,
895         'job':              't0003-0ae2c6e1-post.fio',
896         'success':          SUCCESS_NONZERO,
897         'pre_job':          't0003-0ae2c6e1-pre.fio',
898         'pre_success':      SUCCESS_DEFAULT,
899         'requirements':     [Requirements.linux, Requirements.libaio],
900     },
901     {
902         'test_id':          4,
903         'test_class':       FioJobTest,
904         'job':              't0004-8a99fdf6.fio',
905         'success':          SUCCESS_DEFAULT,
906         'pre_job':          None,
907         'pre_success':      None,
908         'requirements':     [Requirements.linux, Requirements.libaio],
909     },
910     {
911         'test_id':          5,
912         'test_class':       FioJobTest_t0005,
913         'job':              't0005-f7078f7b.fio',
914         'success':          SUCCESS_DEFAULT,
915         'pre_job':          None,
916         'pre_success':      None,
917         'output_format':    'json',
918         'requirements':     [Requirements.not_windows],
919     },
920     {
921         'test_id':          6,
922         'test_class':       FioJobTest_t0006,
923         'job':              't0006-82af2a7c.fio',
924         'success':          SUCCESS_DEFAULT,
925         'pre_job':          None,
926         'pre_success':      None,
927         'output_format':    'json',
928         'requirements':     [Requirements.linux, Requirements.libaio],
929     },
930     {
931         'test_id':          7,
932         'test_class':       FioJobTest_t0007,
933         'job':              't0007-37cf9e3c.fio',
934         'success':          SUCCESS_DEFAULT,
935         'pre_job':          None,
936         'pre_success':      None,
937         'output_format':    'json',
938         'requirements':     [],
939     },
940     {
941         'test_id':          8,
942         'test_class':       FioJobTest_t0008,
943         'job':              't0008-ae2fafc8.fio',
944         'success':          SUCCESS_DEFAULT,
945         'pre_job':          None,
946         'pre_success':      None,
947         'output_format':    'json',
948         'requirements':     [],
949     },
950     {
951         'test_id':          9,
952         'test_class':       FioJobTest_t0009,
953         'job':              't0009-f8b0bd10.fio',
954         'success':          SUCCESS_DEFAULT,
955         'pre_job':          None,
956         'pre_success':      None,
957         'output_format':    'json',
958         'requirements':     [Requirements.not_macos,
959                              Requirements.cpucount4],
960         # mac os does not support CPU affinity
961     },
962     {
963         'test_id':          10,
964         'test_class':       FioJobTest,
965         'job':              't0010-b7aae4ba.fio',
966         'success':          SUCCESS_DEFAULT,
967         'pre_job':          None,
968         'pre_success':      None,
969         'requirements':     [],
970     },
971     {
972         'test_id':          11,
973         'test_class':       FioJobTest_iops_rate,
974         'job':              't0011-5d2788d5.fio',
975         'success':          SUCCESS_DEFAULT,
976         'pre_job':          None,
977         'pre_success':      None,
978         'output_format':    'json',
979         'requirements':     [],
980     },
981     {
982         'test_id':          12,
983         'test_class':       FioJobTest_t0012,
984         'job':              't0012.fio',
985         'success':          SUCCESS_DEFAULT,
986         'pre_job':          None,
987         'pre_success':      None,
988         'output_format':    'json',
989         'requirements':     [],
990     },
991     {
992         'test_id':          13,
993         'test_class':       FioJobTest,
994         'job':              't0013.fio',
995         'success':          SUCCESS_DEFAULT,
996         'pre_job':          None,
997         'pre_success':      None,
998         'output_format':    'json',
999         'requirements':     [],
1000     },
1001     {
1002         'test_id':          14,
1003         'test_class':       FioJobTest_t0014,
1004         'job':              't0014.fio',
1005         'success':          SUCCESS_DEFAULT,
1006         'pre_job':          None,
1007         'pre_success':      None,
1008         'output_format':    'json',
1009         'requirements':     [],
1010     },
1011     {
1012         'test_id':          15,
1013         'test_class':       FioJobTest_t0015,
1014         'job':              't0015-e78980ff.fio',
1015         'success':          SUCCESS_DEFAULT,
1016         'pre_job':          None,
1017         'pre_success':      None,
1018         'output_format':    'json',
1019         'requirements':     [Requirements.linux, Requirements.libaio],
1020     },
1021     {
1022         'test_id':          16,
1023         'test_class':       FioJobTest_t0015,
1024         'job':              't0016-d54ae22.fio',
1025         'success':          SUCCESS_DEFAULT,
1026         'pre_job':          None,
1027         'pre_success':      None,
1028         'output_format':    'json',
1029         'requirements':     [],
1030     },
1031     {
1032         'test_id':          17,
1033         'test_class':       FioJobTest_t0015,
1034         'job':              't0017.fio',
1035         'success':          SUCCESS_DEFAULT,
1036         'pre_job':          None,
1037         'pre_success':      None,
1038         'output_format':    'json',
1039         'requirements':     [Requirements.not_windows],
1040     },
1041     {
1042         'test_id':          18,
1043         'test_class':       FioJobTest,
1044         'job':              't0018.fio',
1045         'success':          SUCCESS_DEFAULT,
1046         'pre_job':          None,
1047         'pre_success':      None,
1048         'requirements':     [Requirements.linux, Requirements.io_uring],
1049     },
1050     {
1051         'test_id':          19,
1052         'test_class':       FioJobTest_t0019,
1053         'job':              't0019.fio',
1054         'success':          SUCCESS_DEFAULT,
1055         'pre_job':          None,
1056         'pre_success':      None,
1057         'requirements':     [],
1058     },
1059     {
1060         'test_id':          20,
1061         'test_class':       FioJobTest_t0020,
1062         'job':              't0020.fio',
1063         'success':          SUCCESS_DEFAULT,
1064         'pre_job':          None,
1065         'pre_success':      None,
1066         'requirements':     [],
1067     },
1068     {
1069         'test_id':          21,
1070         'test_class':       FioJobTest_t0020,
1071         'job':              't0021.fio',
1072         'success':          SUCCESS_DEFAULT,
1073         'pre_job':          None,
1074         'pre_success':      None,
1075         'requirements':     [],
1076     },
1077     {
1078         'test_id':          22,
1079         'test_class':       FioJobTest_t0022,
1080         'job':              't0022.fio',
1081         'success':          SUCCESS_DEFAULT,
1082         'pre_job':          None,
1083         'pre_success':      None,
1084         'requirements':     [],
1085     },
1086     {
1087         'test_id':          23,
1088         'test_class':       FioJobTest_t0023,
1089         'job':              't0023.fio',
1090         'success':          SUCCESS_DEFAULT,
1091         'pre_job':          None,
1092         'pre_success':      None,
1093         'requirements':     [],
1094     },
1095     {
1096         'test_id':          1000,
1097         'test_class':       FioExeTest,
1098         'exe':              't/axmap',
1099         'parameters':       None,
1100         'success':          SUCCESS_DEFAULT,
1101         'requirements':     [],
1102     },
1103     {
1104         'test_id':          1001,
1105         'test_class':       FioExeTest,
1106         'exe':              't/ieee754',
1107         'parameters':       None,
1108         'success':          SUCCESS_DEFAULT,
1109         'requirements':     [],
1110     },
1111     {
1112         'test_id':          1002,
1113         'test_class':       FioExeTest,
1114         'exe':              't/lfsr-test',
1115         'parameters':       ['0xFFFFFF', '0', '0', 'verify'],
1116         'success':          SUCCESS_STDERR,
1117         'requirements':     [],
1118     },
1119     {
1120         'test_id':          1003,
1121         'test_class':       FioExeTest,
1122         'exe':              't/readonly.py',
1123         'parameters':       ['-f', '{fio_path}'],
1124         'success':          SUCCESS_DEFAULT,
1125         'requirements':     [],
1126     },
1127     {
1128         'test_id':          1004,
1129         'test_class':       FioExeTest,
1130         'exe':              't/steadystate_tests.py',
1131         'parameters':       ['{fio_path}'],
1132         'success':          SUCCESS_DEFAULT,
1133         'requirements':     [],
1134     },
1135     {
1136         'test_id':          1005,
1137         'test_class':       FioExeTest,
1138         'exe':              't/stest',
1139         'parameters':       None,
1140         'success':          SUCCESS_STDERR,
1141         'requirements':     [],
1142     },
1143     {
1144         'test_id':          1006,
1145         'test_class':       FioExeTest,
1146         'exe':              't/strided.py',
1147         'parameters':       ['{fio_path}'],
1148         'success':          SUCCESS_DEFAULT,
1149         'requirements':     [],
1150     },
1151     {
1152         'test_id':          1007,
1153         'test_class':       FioExeTest,
1154         'exe':              't/zbd/run-tests-against-nullb',
1155         'parameters':       ['-s', '1'],
1156         'success':          SUCCESS_DEFAULT,
1157         'requirements':     [Requirements.linux, Requirements.zbd,
1158                              Requirements.root],
1159     },
1160     {
1161         'test_id':          1008,
1162         'test_class':       FioExeTest,
1163         'exe':              't/zbd/run-tests-against-nullb',
1164         'parameters':       ['-s', '2'],
1165         'success':          SUCCESS_DEFAULT,
1166         'requirements':     [Requirements.linux, Requirements.zbd,
1167                              Requirements.root, Requirements.zoned_nullb],
1168     },
1169     {
1170         'test_id':          1009,
1171         'test_class':       FioExeTest,
1172         'exe':              'unittests/unittest',
1173         'parameters':       None,
1174         'success':          SUCCESS_DEFAULT,
1175         'requirements':     [Requirements.unittests],
1176     },
1177     {
1178         'test_id':          1010,
1179         'test_class':       FioExeTest,
1180         'exe':              't/latency_percentiles.py',
1181         'parameters':       ['-f', '{fio_path}'],
1182         'success':          SUCCESS_DEFAULT,
1183         'requirements':     [],
1184     },
1185     {
1186         'test_id':          1011,
1187         'test_class':       FioExeTest,
1188         'exe':              't/jsonplus2csv_test.py',
1189         'parameters':       ['-f', '{fio_path}'],
1190         'success':          SUCCESS_DEFAULT,
1191         'requirements':     [],
1192     },
1193     {
1194         'test_id':          1012,
1195         'test_class':       FioExeTest,
1196         'exe':              't/log_compression.py',
1197         'parameters':       ['-f', '{fio_path}'],
1198         'success':          SUCCESS_DEFAULT,
1199         'requirements':     [],
1200     },
1201 ]
1202
1203
1204 def parse_args():
1205     """Parse command-line arguments."""
1206
1207     parser = argparse.ArgumentParser()
1208     parser.add_argument('-r', '--fio-root',
1209                         help='fio root path')
1210     parser.add_argument('-f', '--fio',
1211                         help='path to fio executable (e.g., ./fio)')
1212     parser.add_argument('-a', '--artifact-root',
1213                         help='artifact root directory')
1214     parser.add_argument('-s', '--skip', nargs='+', type=int,
1215                         help='list of test(s) to skip')
1216     parser.add_argument('-o', '--run-only', nargs='+', type=int,
1217                         help='list of test(s) to run, skipping all others')
1218     parser.add_argument('-d', '--debug', action='store_true',
1219                         help='provide debug output')
1220     parser.add_argument('-k', '--skip-req', action='store_true',
1221                         help='skip requirements checking')
1222     parser.add_argument('-p', '--pass-through', action='append',
1223                         help='pass-through an argument to an executable test')
1224     args = parser.parse_args()
1225
1226     return args
1227
1228
1229 def main():
1230     """Entry point."""
1231
1232     args = parse_args()
1233     if args.debug:
1234         logging.basicConfig(level=logging.DEBUG)
1235     else:
1236         logging.basicConfig(level=logging.INFO)
1237
1238     pass_through = {}
1239     if args.pass_through:
1240         for arg in args.pass_through:
1241             if not ':' in arg:
1242                 print("Invalid --pass-through argument '%s'" % arg)
1243                 print("Syntax for --pass-through is TESTNUMBER:ARGUMENT")
1244                 return
1245             split = arg.split(":", 1)
1246             pass_through[int(split[0])] = split[1]
1247         logging.debug("Pass-through arguments: %s", pass_through)
1248
1249     if args.fio_root:
1250         fio_root = args.fio_root
1251     else:
1252         fio_root = str(Path(__file__).absolute().parent.parent)
1253     print("fio root is %s" % fio_root)
1254
1255     if args.fio:
1256         fio_path = args.fio
1257     else:
1258         if platform.system() == "Windows":
1259             fio_exe = "fio.exe"
1260         else:
1261             fio_exe = "fio"
1262         fio_path = os.path.join(fio_root, fio_exe)
1263     print("fio path is %s" % fio_path)
1264     if not shutil.which(fio_path):
1265         print("Warning: fio executable not found")
1266
1267     artifact_root = args.artifact_root if args.artifact_root else \
1268         "fio-test-{0}".format(time.strftime("%Y%m%d-%H%M%S"))
1269     os.mkdir(artifact_root)
1270     print("Artifact directory is %s" % artifact_root)
1271
1272     if not args.skip_req:
1273         req = Requirements(fio_root)
1274
1275     passed = 0
1276     failed = 0
1277     skipped = 0
1278
1279     for config in TEST_LIST:
1280         if (args.skip and config['test_id'] in args.skip) or \
1281            (args.run_only and config['test_id'] not in args.run_only):
1282             skipped = skipped + 1
1283             print("Test {0} SKIPPED (User request)".format(config['test_id']))
1284             continue
1285
1286         if issubclass(config['test_class'], FioJobTest):
1287             if config['pre_job']:
1288                 fio_pre_job = os.path.join(fio_root, 't', 'jobs',
1289                                            config['pre_job'])
1290             else:
1291                 fio_pre_job = None
1292             if config['pre_success']:
1293                 fio_pre_success = config['pre_success']
1294             else:
1295                 fio_pre_success = None
1296             if 'output_format' in config:
1297                 output_format = config['output_format']
1298             else:
1299                 output_format = 'normal'
1300             test = config['test_class'](
1301                 fio_path,
1302                 os.path.join(fio_root, 't', 'jobs', config['job']),
1303                 config['success'],
1304                 fio_pre_job=fio_pre_job,
1305                 fio_pre_success=fio_pre_success,
1306                 output_format=output_format)
1307             desc = config['job']
1308         elif issubclass(config['test_class'], FioExeTest):
1309             exe_path = os.path.join(fio_root, config['exe'])
1310             if config['parameters']:
1311                 parameters = [p.format(fio_path=fio_path) for p in config['parameters']]
1312             else:
1313                 parameters = []
1314             if Path(exe_path).suffix == '.py' and platform.system() == "Windows":
1315                 parameters.insert(0, exe_path)
1316                 exe_path = "python.exe"
1317             if config['test_id'] in pass_through:
1318                 parameters += pass_through[config['test_id']].split()
1319             test = config['test_class'](exe_path, parameters,
1320                                         config['success'])
1321             desc = config['exe']
1322         else:
1323             print("Test {0} FAILED: unable to process test config".format(config['test_id']))
1324             failed = failed + 1
1325             continue
1326
1327         if not args.skip_req:
1328             reqs_met = True
1329             for req in config['requirements']:
1330                 reqs_met, reason = req()
1331                 logging.debug("Test %d: Requirement '%s' met? %s", config['test_id'], reason,
1332                               reqs_met)
1333                 if not reqs_met:
1334                     break
1335             if not reqs_met:
1336                 print("Test {0} SKIPPED ({1}) {2}".format(config['test_id'], reason, desc))
1337                 skipped = skipped + 1
1338                 continue
1339
1340         try:
1341             test.setup(artifact_root, config['test_id'])
1342             test.run()
1343             test.check_result()
1344         except KeyboardInterrupt:
1345             break
1346         except Exception as e:
1347             test.passed = False
1348             test.failure_reason += str(e)
1349             logging.debug("Test %d exception:\n%s\n", config['test_id'], traceback.format_exc())
1350         if test.passed:
1351             result = "PASSED"
1352             passed = passed + 1
1353         else:
1354             result = "FAILED: {0}".format(test.failure_reason)
1355             failed = failed + 1
1356             contents, _ = FioJobTest.get_file(test.stderr_file)
1357             logging.debug("Test %d: stderr:\n%s", config['test_id'], contents)
1358             contents, _ = FioJobTest.get_file(test.stdout_file)
1359             logging.debug("Test %d: stdout:\n%s", config['test_id'], contents)
1360         print("Test {0} {1} {2}".format(config['test_id'], result, desc))
1361
1362     print("{0} test(s) passed, {1} failed, {2} skipped".format(passed, failed, skipped))
1363
1364     sys.exit(failed)
1365
1366
1367 if __name__ == '__main__':
1368     main()