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_iops_rate(FioJobTest):
 531     """Test consists of fio test job t0009
 532     Confirm that job0 iops == 1000
 533     and that job1_iops / job0_iops ~ 8
 534     With two runs of fio-3.16 I observed a ratio of 8.3"""
 535
 536     def check_result(self):
 537         super(FioJobTest_iops_rate, self).check_result()
 538
 539         if not self.passed:
 540             return
 541
 542         iops1 = self.json_data['jobs'][0]['read']['iops']
 543         logging.debug("Test %d: iops1: %f", self.testnum, iops1)
 544         iops2 = self.json_data['jobs'][1]['read']['iops']
 545         logging.debug("Test %d: iops2: %f", self.testnum, iops2)
 546         ratio = iops2 / iops1
 547         logging.debug("Test %d: ratio: %f", self.testnum, ratio)
 548
 549         if iops1 < 950 or iops1 > 1050:
 550             self.failure_reason = "{0} iops value mismatch,".format(self.failure_reason)
 551             self.passed = False
 552
 553         if ratio < 6 or ratio > 10:
 554             self.failure_reason = "{0} iops ratio mismatch,".format(self.failure_reason)
 555             self.passed = False
 556
 557
 558 class Requirements(object):
 559     """Requirements consists of multiple run environment characteristics.
 560     These are to determine if a particular test can be run"""
 561
 562     _linux = False
 563     _libaio = False
 564     _zbd = False
 565     _root = False
 566     _zoned_nullb = False
 567     _not_macos = False
 568     _not_windows = False
 569     _unittests = False
 570     _cpucount4 = False
 571
 572     def __init__(self, fio_root):
 573         Requirements._not_macos = platform.system() != "Darwin"
 574         Requirements._not_windows = platform.system() != "Windows"
 575         Requirements._linux = platform.system() == "Linux"
 576
 577         if Requirements._linux:
 578             config_file = os.path.join(fio_root, "config-host.h")
 579             contents, success = FioJobTest.get_file(config_file)
 580             if not success:
 581                 print("Unable to open {0} to check requirements".format(config_file))
 582                 Requirements._zbd = True
 583             else:
 584                 Requirements._zbd = "CONFIG_HAS_BLKZONED" in contents
 585                 Requirements._libaio = "CONFIG_LIBAIO" in contents
 586
 587             Requirements._root = (os.geteuid() == 0)
 588             if Requirements._zbd and Requirements._root:
 589                 try:
 590                     subprocess.run(["modprobe", "null_blk"],
 591                                    stdout=subprocess.PIPE,
 592                                    stderr=subprocess.PIPE)
 593                     if os.path.exists("/sys/module/null_blk/parameters/zoned"):
 594                         Requirements._zoned_nullb = True
 595                 except Exception:
 596                     pass
 597
 598         if platform.system() == "Windows":
 599             utest_exe = "unittest.exe"
 600         else:
 601             utest_exe = "unittest"
 602         unittest_path = os.path.join(fio_root, "unittests", utest_exe)
 603         Requirements._unittests = os.path.exists(unittest_path)
 604
 605         Requirements._cpucount4 = multiprocessing.cpu_count() >= 4
 606
 607         req_list = [Requirements.linux,
 608                     Requirements.libaio,
 609                     Requirements.zbd,
 610                     Requirements.root,
 611                     Requirements.zoned_nullb,
 612                     Requirements.not_macos,
 613                     Requirements.not_windows,
 614                     Requirements.unittests,
 615                     Requirements.cpucount4]
 616         for req in req_list:
 617             value, desc = req()
 618             logging.debug("Requirements: Requirement '%s' met? %s", desc, value)
 619
 620     @classmethod
 621     def linux(cls):
 622         """Are we running on Linux?"""
 623         return Requirements._linux, "Linux required"
 624
 625     @classmethod
 626     def libaio(cls):
 627         """Is libaio available?"""
 628         return Requirements._libaio, "libaio required"
 629
 630     @classmethod
 631     def zbd(cls):
 632         """Is ZBD support available?"""
 633         return Requirements._zbd, "Zoned block device support required"
 634
 635     @classmethod
 636     def root(cls):
 637         """Are we running as root?"""
 638         return Requirements._root, "root required"
 639
 640     @classmethod
 641     def zoned_nullb(cls):
 642         """Are zoned null block devices available?"""
 643         return Requirements._zoned_nullb, "Zoned null block device support required"
 644
 645     @classmethod
 646     def not_macos(cls):
 647         """Are we running on a platform other than macOS?"""
 648         return Requirements._not_macos, "platform other than macOS required"
 649
 650     @classmethod
 651     def not_windows(cls):
 652         """Are we running on a platform other than Windws?"""
 653         return Requirements._not_windows, "platform other than Windows required"
 654
 655     @classmethod
 656     def unittests(cls):
 657         """Were unittests built?"""
 658         return Requirements._unittests, "Unittests support required"
 659
 660     @classmethod
 661     def cpucount4(cls):
 662         """Do we have at least 4 CPUs?"""
 663         return Requirements._cpucount4, "4+ CPUs required"
 664
 665
 666 SUCCESS_DEFAULT = {
 667     'zero_return': True,
 668     'stderr_empty': True,
 669     'timeout': 600,
 670     }
 671 SUCCESS_NONZERO = {
 672     'zero_return': False,
 673     'stderr_empty': False,
 674     'timeout': 600,
 675     }
 676 SUCCESS_STDERR = {
 677     'zero_return': True,
 678     'stderr_empty': False,
 679     'timeout': 600,
 680     }
 681 TEST_LIST = [
 682     {
 683         'test_id':          1,
 684         'test_class':       FioJobTest,
 685         'job':              't0001-52c58027.fio',
 686         'success':          SUCCESS_DEFAULT,
 687         'pre_job':          None,
 688         'pre_success':      None,
 689         'requirements':     [],
 690     },
 691     {
 692         'test_id':          2,
 693         'test_class':       FioJobTest,
 694         'job':              't0002-13af05ae-post.fio',
 695         'success':          SUCCESS_DEFAULT,
 696         'pre_job':          't0002-13af05ae-pre.fio',
 697         'pre_success':      None,
 698         'requirements':     [Requirements.linux, Requirements.libaio],
 699     },
 700     {
 701         'test_id':          3,
 702         'test_class':       FioJobTest,
 703         'job':              't0003-0ae2c6e1-post.fio',
 704         'success':          SUCCESS_NONZERO,
 705         'pre_job':          't0003-0ae2c6e1-pre.fio',
 706         'pre_success':      SUCCESS_DEFAULT,
 707         'requirements':     [Requirements.linux, Requirements.libaio],
 708     },
 709     {
 710         'test_id':          4,
 711         'test_class':       FioJobTest,
 712         'job':              't0004-8a99fdf6.fio',
 713         'success':          SUCCESS_DEFAULT,
 714         'pre_job':          None,
 715         'pre_success':      None,
 716         'requirements':     [Requirements.linux, Requirements.libaio],
 717     },
 718     {
 719         'test_id':          5,
 720         'test_class':       FioJobTest_t0005,
 721         'job':              't0005-f7078f7b.fio',
 722         'success':          SUCCESS_DEFAULT,
 723         'pre_job':          None,
 724         'pre_success':      None,
 725         'output_format':    'json',
 726         'requirements':     [Requirements.not_windows],
 727     },
 728     {
 729         'test_id':          6,
 730         'test_class':       FioJobTest_t0006,
 731         'job':              't0006-82af2a7c.fio',
 732         'success':          SUCCESS_DEFAULT,
 733         'pre_job':          None,
 734         'pre_success':      None,
 735         'output_format':    'json',
 736         'requirements':     [Requirements.linux, Requirements.libaio],
 737     },
 738     {
 739         'test_id':          7,
 740         'test_class':       FioJobTest_t0007,
 741         'job':              't0007-37cf9e3c.fio',
 742         'success':          SUCCESS_DEFAULT,
 743         'pre_job':          None,
 744         'pre_success':      None,
 745         'output_format':    'json',
 746         'requirements':     [],
 747     },
 748     {
 749         'test_id':          8,
 750         'test_class':       FioJobTest_t0008,
 751         'job':              't0008-ae2fafc8.fio',
 752         'success':          SUCCESS_DEFAULT,
 753         'pre_job':          None,
 754         'pre_success':      None,
 755         'output_format':    'json',
 756         'requirements':     [],
 757     },
 758     {
 759         'test_id':          9,
 760         'test_class':       FioJobTest_t0009,
 761         'job':              't0009-f8b0bd10.fio',
 762         'success':          SUCCESS_DEFAULT,
 763         'pre_job':          None,
 764         'pre_success':      None,
 765         'output_format':    'json',
 766         'requirements':     [Requirements.not_macos,
 767                              Requirements.cpucount4],
 768         # mac os does not support CPU affinity
 769     },
 770     {
 771         'test_id':          10,
 772         'test_class':       FioJobTest,
 773         'job':              't0010-b7aae4ba.fio',
 774         'success':          SUCCESS_DEFAULT,
 775         'pre_job':          None,
 776         'pre_success':      None,
 777         'requirements':     [],
 778     },
 779     {
 780         'test_id':          11,
 781         'test_class':       FioJobTest_iops_rate,
 782         'job':              't0011-5d2788d5.fio',
 783         'success':          SUCCESS_DEFAULT,
 784         'pre_job':          None,
 785         'pre_success':      None,
 786         'output_format':    'json',
 787         'requirements':     [],
 788     },
 789     {
 790         'test_id':          12,
 791         'test_class':       FioJobTest_t0012,
 792         'job':              't0012.fio',
 793         'success':          SUCCESS_DEFAULT,
 794         'pre_job':          None,
 795         'pre_success':      None,
 796         'output_format':    'json',
 797         'requirements':     [],
 798     },
 799     {
 800         'test_id':          13,
 801         'test_class':       FioJobTest,
 802         'job':              't0013.fio',
 803         'success':          SUCCESS_DEFAULT,
 804         'pre_job':          None,
 805         'pre_success':      None,
 806         'output_format':    'json',
 807         'requirements':     [],
 808     },
 809     {
 810         'test_id':          14,
 811         'test_class':       FioJobTest_t0014,
 812         'job':              't0014.fio',
 813         'success':          SUCCESS_DEFAULT,
 814         'pre_job':          None,
 815         'pre_success':      None,
 816         'output_format':    'json',
 817         'requirements':     [],
 818     },
 819     {
 820         'test_id':          1000,
 821         'test_class':       FioExeTest,
 822         'exe':              't/axmap',
 823         'parameters':       None,
 824         'success':          SUCCESS_DEFAULT,
 825         'requirements':     [],
 826     },
 827     {
 828         'test_id':          1001,
 829         'test_class':       FioExeTest,
 830         'exe':              't/ieee754',
 831         'parameters':       None,
 832         'success':          SUCCESS_DEFAULT,
 833         'requirements':     [],
 834     },
 835     {
 836         'test_id':          1002,
 837         'test_class':       FioExeTest,
 838         'exe':              't/lfsr-test',
 839         'parameters':       ['0xFFFFFF', '0', '0', 'verify'],
 840         'success':          SUCCESS_STDERR,
 841         'requirements':     [],
 842     },
 843     {
 844         'test_id':          1003,
 845         'test_class':       FioExeTest,
 846         'exe':              't/readonly.py',
 847         'parameters':       ['-f', '{fio_path}'],
 848         'success':          SUCCESS_DEFAULT,
 849         'requirements':     [],
 850     },
 851     {
 852         'test_id':          1004,
 853         'test_class':       FioExeTest,
 854         'exe':              't/steadystate_tests.py',
 855         'parameters':       ['{fio_path}'],
 856         'success':          SUCCESS_DEFAULT,
 857         'requirements':     [],
 858     },
 859     {
 860         'test_id':          1005,
 861         'test_class':       FioExeTest,
 862         'exe':              't/stest',
 863         'parameters':       None,
 864         'success':          SUCCESS_STDERR,
 865         'requirements':     [],
 866     },
 867     {
 868         'test_id':          1006,
 869         'test_class':       FioExeTest,
 870         'exe':              't/strided.py',
 871         'parameters':       ['{fio_path}'],
 872         'success':          SUCCESS_DEFAULT,
 873         'requirements':     [],
 874     },
 875     {
 876         'test_id':          1007,
 877         'test_class':       FioExeTest,
 878         'exe':              't/zbd/run-tests-against-nullb',
 879         'parameters':       ['-s', '1'],
 880         'success':          SUCCESS_DEFAULT,
 881         'requirements':     [Requirements.linux, Requirements.zbd,
 882                              Requirements.root],
 883     },
 884     {
 885         'test_id':          1008,
 886         'test_class':       FioExeTest,
 887         'exe':              't/zbd/run-tests-against-nullb',
 888         'parameters':       ['-s', '2'],
 889         'success':          SUCCESS_DEFAULT,
 890         'requirements':     [Requirements.linux, Requirements.zbd,
 891                              Requirements.root, Requirements.zoned_nullb],
 892     },
 893     {
 894         'test_id':          1009,
 895         'test_class':       FioExeTest,
 896         'exe':              'unittests/unittest',
 897         'parameters':       None,
 898         'success':          SUCCESS_DEFAULT,
 899         'requirements':     [Requirements.unittests],
 900     },
 901     {
 902         'test_id':          1010,
 903         'test_class':       FioExeTest,
 904         'exe':              't/latency_percentiles.py',
 905         'parameters':       ['-f', '{fio_path}'],
 906         'success':          SUCCESS_DEFAULT,
 907         'requirements':     [],
 908     },
 909     {
 910         'test_id':          1011,
 911         'test_class':       FioExeTest,
 912         'exe':              't/jsonplus2csv_test.py',
 913         'parameters':       ['-f', '{fio_path}'],
 914         'success':          SUCCESS_DEFAULT,
 915         'requirements':     [],
 916     },
 917 ]
 918
 919
 920 def parse_args():
 921     """Parse command-line arguments."""
 922
 923     parser = argparse.ArgumentParser()
 924     parser.add_argument('-r', '--fio-root',
 925                         help='fio root path')
 926     parser.add_argument('-f', '--fio',
 927                         help='path to fio executable (e.g., ./fio)')
 928     parser.add_argument('-a', '--artifact-root',
 929                         help='artifact root directory')
 930     parser.add_argument('-s', '--skip', nargs='+', type=int,
 931                         help='list of test(s) to skip')
 932     parser.add_argument('-o', '--run-only', nargs='+', type=int,
 933                         help='list of test(s) to run, skipping all others')
 934     parser.add_argument('-d', '--debug', action='store_true',
 935                         help='provide debug output')
 936     parser.add_argument('-k', '--skip-req', action='store_true',
 937                         help='skip requirements checking')
 938     parser.add_argument('-p', '--pass-through', action='append',
 939                         help='pass-through an argument to an executable test')
 940     args = parser.parse_args()
 941
 942     return args
 943
 944
 945 def main():
 946     """Entry point."""
 947
 948     args = parse_args()
 949     if args.debug:
 950         logging.basicConfig(level=logging.DEBUG)
 951     else:
 952         logging.basicConfig(level=logging.INFO)
 953
 954     pass_through = {}
 955     if args.pass_through:
 956         for arg in args.pass_through:
 957             if not ':' in arg:
 958                 print("Invalid --pass-through argument '%s'" % arg)
 959                 print("Syntax for --pass-through is TESTNUMBER:ARGUMENT")
 960                 return
 961             split = arg.split(":", 1)
 962             pass_through[int(split[0])] = split[1]
 963         logging.debug("Pass-through arguments: %s", pass_through)
 964
 965     if args.fio_root:
 966         fio_root = args.fio_root
 967     else:
 968         fio_root = str(Path(__file__).absolute().parent.parent)
 969     print("fio root is %s" % fio_root)
 970
 971     if args.fio:
 972         fio_path = args.fio
 973     else:
 974         if platform.system() == "Windows":
 975             fio_exe = "fio.exe"
 976         else:
 977             fio_exe = "fio"
 978         fio_path = os.path.join(fio_root, fio_exe)
 979     print("fio path is %s" % fio_path)
 980     if not shutil.which(fio_path):
 981         print("Warning: fio executable not found")
 982
 983     artifact_root = args.artifact_root if args.artifact_root else \
 984         "fio-test-{0}".format(time.strftime("%Y%m%d-%H%M%S"))
 985     os.mkdir(artifact_root)
 986     print("Artifact directory is %s" % artifact_root)
 987
 988     if not args.skip_req:
 989         req = Requirements(fio_root)
 990
 991     passed = 0
 992     failed = 0
 993     skipped = 0
 994
 995     for config in TEST_LIST:
 996         if (args.skip and config['test_id'] in args.skip) or \
 997            (args.run_only and config['test_id'] not in args.run_only):
 998             skipped = skipped + 1
 999             print("Test {0} SKIPPED (User request)".format(config['test_id']))
1000             continue
1001
1002         if issubclass(config['test_class'], FioJobTest):
1003             if config['pre_job']:
1004                 fio_pre_job = os.path.join(fio_root, 't', 'jobs',
1005                                            config['pre_job'])
1006             else:
1007                 fio_pre_job = None
1008             if config['pre_success']:
1009                 fio_pre_success = config['pre_success']
1010             else:
1011                 fio_pre_success = None
1012             if 'output_format' in config:
1013                 output_format = config['output_format']
1014             else:
1015                 output_format = 'normal'
1016             test = config['test_class'](
1017                 fio_path,
1018                 os.path.join(fio_root, 't', 'jobs', config['job']),
1019                 config['success'],
1020                 fio_pre_job=fio_pre_job,
1021                 fio_pre_success=fio_pre_success,
1022                 output_format=output_format)
1023             desc = config['job']
1024         elif issubclass(config['test_class'], FioExeTest):
1025             exe_path = os.path.join(fio_root, config['exe'])
1026             if config['parameters']:
1027                 parameters = [p.format(fio_path=fio_path) for p in config['parameters']]
1028             else:
1029                 parameters = []
1030             if Path(exe_path).suffix == '.py' and platform.system() == "Windows":
1031                 parameters.insert(0, exe_path)
1032                 exe_path = "python.exe"
1033             if config['test_id'] in pass_through:
1034                 parameters += pass_through[config['test_id']].split()
1035             test = config['test_class'](exe_path, parameters,
1036                                         config['success'])
1037             desc = config['exe']
1038         else:
1039             print("Test {0} FAILED: unable to process test config".format(config['test_id']))
1040             failed = failed + 1
1041             continue
1042
1043         if not args.skip_req:
1044             reqs_met = True
1045             for req in config['requirements']:
1046                 reqs_met, reason = req()
1047                 logging.debug("Test %d: Requirement '%s' met? %s", config['test_id'], reason,
1048                               reqs_met)
1049                 if not reqs_met:
1050                     break
1051             if not reqs_met:
1052                 print("Test {0} SKIPPED ({1}) {2}".format(config['test_id'], reason, desc))
1053                 skipped = skipped + 1
1054                 continue
1055
1056         try:
1057             test.setup(artifact_root, config['test_id'])
1058             test.run()
1059             test.check_result()
1060         except KeyboardInterrupt:
1061             break
1062         except Exception as e:
1063             test.passed = False
1064             test.failure_reason += str(e)
1065             logging.debug("Test %d exception:\n%s\n", config['test_id'], traceback.format_exc())
1066         if test.passed:
1067             result = "PASSED"
1068             passed = passed + 1
1069         else:
1070             result = "FAILED: {0}".format(test.failure_reason)
1071             failed = failed + 1
1072             contents, _ = FioJobTest.get_file(test.stderr_file)
1073             logging.debug("Test %d: stderr:\n%s", config['test_id'], contents)
1074             contents, _ = FioJobTest.get_file(test.stdout_file)
1075             logging.debug("Test %d: stdout:\n%s", config['test_id'], contents)
1076         print("Test {0} {1} {2}".format(config['test_id'], result, desc))
1077
1078     print("{0} test(s) passed, {1} failed, {2} skipped".format(passed, failed, skipped))
1079
1080     sys.exit(failed)
1081
1082
1083 if __name__ == '__main__':
1084     main()