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