1phoronix-test-suite(1) General Commands Manual phoronix-test-suite(1)
2
6 phoronix-test-suite - The Phoronix Test Suite is an extensible open-
7 source platform for performing testing and performance evaluation.
8
10 phoronix-test-suite [options]
11 phoronix-test-suite benchmark [test | suite]
12
14 The **Phoronix Test Suite** is the most comprehensive testing and
15 benchmarking platform available for Linux, Solaris, macOS, Windows, and
16 BSD operating systems. The Phoronix Test Suite allows for carrying out
17 tests in a fully automated manner from test installation to execution
18 and reporting. All tests are meant to be easily reproducible, easy-to-
19 use, and support fully automated execution. The Phoronix Test Suite is
20 open-source under the GNU GPLv3 license and is developed by Phoronix
21 Media in cooperation with partners.
22
24 SYSTEM
25 interactive A simple text-driven interactive interface to the
26 Phoronix Test Suite.
27 php-conf
29 This option will print information that is useful to developers
30 when debugging problems with the Phoronix Test Suite and/or test
31 profiles and test suites.
32 shell A simple text-driven shell interface / helper to the Phoronix
34 Test Suite. Ideal for those that may be new to the Phoronix Test
35 Suite
36 system-info
38 Display the installed system hardware and software information
39 as detected by the Phoronix Test Suite Phodevi Library.
40 system-properties
42 Display various hardware/software system properties detected by
43 the Phoronix Device Interface (Phodevi) library.
44 system-sensors
46 Display the installed system hardware and software sensors in
47 real-time as detected by the Phoronix Test Suite Phodevi Li‐
48 brary.
49 TEST INSTALLATION
52 force-install [Test | Suite | OpenBenchmarking ID | Test Result]
53 ... This option will force the installation (or re-installa‐
54 tion) of a test or suite. The arguments and process is similar
55 to the install option but even if the test is installed, the en‐
56 tire installation process will automatically be executed. This
57 option is generally used when debugging a test installation
58 problem or wishing to re-install test(s) due to compiler or
59 other environmental changes.
60 install [Test | Suite | OpenBenchmarking ID | Test Result] ...
62 This option will install the selected test(s) inside the testing
63 environment directory. The install process from downloading of
64 the test files to the installation is fully automated. The in‐
65 stall option needs to be supplied with the test name or suite as
66 an argument. Optionally, a OpenBenchmarking.org ID or the name
67 of a saved results file can be supplied as well and the test(s)
68 to install will automatically be extracted from that informa‐
69 tion. If the test is already installed and was run by the latest
70 version of the installation process, no action will be taken.
71 Multiple arguments can be supplied to install additional tests
72 at the same time.
73 install-dependencies [Test | Suite | OpenBenchmarking ID | Test Result]
75 ...
76 This option will install the external dependencies needed by the
77 selected test(s) using the distribution's package management
78 system. For example, some tests depend upon GCC for compiling
79 code. If GCC is not detected on the system, the Phoronix Test
80 Suite will attempt to install GCC using the distribution's pack‐
81 age management system. If you are running this command as a lo‐
82 cal user, you may be prompted for the root password while the
83 process is running. For unsupported distributions, the depen‐
84 dency names will be displayed along with common names for the
85 package. The install-dependencies option needs to be supplied
86 with the test name or suite as an argument. When using the in‐
87 stall option, the external dependencies are automatically
88 checked.
89 make-download-cache
91 This option will create a download cache for use by the Phoronix
92 Test Suite. The download cache is created of test files already
93 downloaded to the local system. If passing any test/suite names
94 to make-download-cache, the needed files for those test profiles
95 will first be automatically downloaded before creating the
96 cache.
97 remove-installed-test [Test]
99 This option will permanently remove a installed test by the
100 Phoronix Test Suite.
101 TESTING
104 benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ...
105 This option will install the selected test(s) (if needed) and
106 will proceed to run the test(s). This option is equivalent to
107 running phoronix-test-suite with the install option followed by
108 the run option. Multiple arguments can be supplied to run addi‐
109 tional tests at the same time and save the results into one
110 file.
111 estimate-install-time [Test | Suite | OpenBenchmarking ID | Test Re‐
113 sult]
114 This option will provide estimates for test install/setup time
115 length.
116 estimate-run-time [Test | Suite | OpenBenchmarking ID | Test Result]
118 This option will provide estimates for test run-time / length.
119 finish-run [Test Result]
121 This option can be used if a test run had not properly finished
122 running all tests within a saved results file. Using this option
123 when specifying a saved results file where all tests had not
124 completed will attempt to finish / resume testing on the remain‐
125 ing tests where there are missing results to be completed.
126 run [Test | Suite | OpenBenchmarking ID | Test Result] ...
128 This option will run the selected test(s).
129 run-random-tests
131 This option will query OpenBenchmarking.org to run random bench‐
132 marks and result comparisons on the system. This test can be
133 used for simply supplying interesting results from your system
134 onto OpenBenchmarking.org, stressing your system with random
135 workloads, seeding new OpenBenchmarking.org results, etc. Basic
136 options are provided at start-up for tuning the randomness of
137 the testing when running this command.
138 run-subset [Test | Suite | OpenBenchmarking ID | Test Result] ...
140 This option will run the selected test(s) but prompt the user
141 when passing any test suites or result files what subset /
142 test(s) contained within there to run rather than running all
143 passed tests/suites/results.
144 run-tests-in-suite [Suite]
146 This option can be used if you wish to run all of the tests
147 found in a supplied suite, but you wish to re-configure each of
148 the test options rather than using the defaults supplied by the
149 suite.
150 stress-batch-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
152 This option will run the passed tests/suites in the multi-
153 process stress-testing mode while behaving by the Phoronix Test
154 Suite batch testing characteristics. The stress-batch-run mode
155 is similar to the stress-run command except that for any tests
156 passed to it will run all combinations of the options rather
157 than prompting the user for the values to be selected.
158 stress-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
160 This option will run the passed tests/suites in the multi-
161 process stress-testing mode. The stress-run mode will not pro‐
162 duce a result file but is rather intended for running multiple
163 test profiles concurrently to stress / burn-in the system. The
164 number of tests to run concurrently can be toggled via the
165 PTS_CONCURRENT_TEST_RUNS environment variable and by default is
166 set to a value of 2.
167 strict-benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ...
169 This option is equivalent to the `benchmark` option except it
170 enables various options to run benchmarks an extended number of
171 times for ensuring better statistical accuracy if enforcing
172 strict controls over the data quality, in some cases running the
173 benchmarks for 20+ times.
174 strict-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
176 This option is equivalent to the `run` option except it enables
177 various options to run benchmarks an extended number of times
178 for ensuring better statistical accuracy if enforcing strict
179 controls over the data quality, in some cases running the bench‐
180 marks for 20+ times.
181 BATCH TESTING
184 batch-benchmark [Test | Suite | OpenBenchmarking ID | Test Re‐
185 sult] ... This option and its arguments are equivalent to the
186 benchmark option, but the process will be run in the Phoronix
187 Test Suite batch mode.
188 batch-install [Test | Suite | OpenBenchmarking ID | Test Result] ...
190 If you wish to run the install process in the Phoronix Test
191 Suite batch mode but do not wish to run any tests at this time.
192 Running the install process in the batch mode will use the de‐
193 fault values and not prompt the user of any possible options, to
194 ensure the process is fully automated.
195 batch-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
197 This option and its arguments are equivalent to the run option,
198 but the process will be run in the Phoronix Test Suite batch
199 mode.
200 batch-setup
202 This option is used to configure the batch mode options for the
203 Phoronix Test Suite, which is subsequently written to the user
204 configuration file. Among the options are whether to automati‐
205 cally upload the test results to OpenBenchmarking.org and
206 prompting for the saved file name.
207 default-benchmark [Test | Suite | OpenBenchmarking ID | Test Result]
209 ...
210 This option will install the selected test(s) (if needed) and
211 will proceed to run the test(s) in the defaults mode. This op‐
212 tion is equivalent to running phoronix-test-suite with the in‐
213 stall option followed by the default-run option.
214 default-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
216 This option will run the selected test(s). The name of the test
217 or suite must be supplied or the OpenBenchmarking.org ID or
218 saved local file name. Multiple arguments can be supplied to run
219 additional tests at the same time and save the results in a
220 suite-like fashion. Unlike the normal run option, the default-
221 run will not prompt the user to select from the available test
222 options but will instead use the default options as automati‐
223 cally set by pts-core or the test profile. Use batch-run to au‐
224 tomatically test all of the available options.
225 dry-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
227 This option and its arguments pre-set the Phoronix Test Suite
228 batch run mode with enforcing of defaults to not save any re‐
229 sults and other behavior intended for a dry/test run. This op‐
230 tion is primarily intended for testing/evaluation purposes.
231 internal-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
233 This option and its arguments pre-set the Phoronix Test Suite
234 batch run mode with sane values for carrying out benchmarks in a
235 semi-automated manner and without uploading any of the result
236 data to the public OpenBenchmarking.org.
237 OPENBENCHMARKING.ORG
240 clone-result [OpenBenchmarking ID] ... This option will down‐
241 load a local copy of a file that was saved to OpenBenchmark‐
242 ing.org, as long as a valid public ID is supplied.
243 dump-suites-to-git
245 This option will create a Git repository of OpenBenchmarking.org
246 test suites.
247 dump-tests-to-git
249 This option will create a Git repository of OpenBenchmarking.org
250 test profiles.
251 enable-repo
253 This option is used if wanting to add a new OpenBenchmarking.org
254 account/repository to your system for enabling third-party/unof‐
255 ficial test profiles and test suites.
256 list-recommended-tests
258 This option will list recommended test profiles for benchmarking
259 sorted by hardware sub-system. The recommended tests are deter‐
260 mined via querying OpenBenchmarking.org and determining the most
261 popular tests for a given environment based upon the number of
262 times a test profile has been downloaded, the number of test re‐
263 sults available on OpenBenchmarking.org for a given test pro‐
264 file, the age of the test profile, and other weighted factors.
265 make-openbenchmarking-cache
267 This option will attempt to cache the test profile/suite meta-
268 data from OpenBenchmarking.org for all linked repositories. This
269 is useful if you're going to be running the Phoronix Test Suite
270 / Phoromatic behind a firewall or without any Internet connec‐
271 tion. Those with unrestricted Internet access or not utilizing a
272 large local deployment of the Phoronix Test Suite / Phoromatic
273 shouldn't need to run this command.
274 ob-test-profile-analyze
276 This option is intended for test profile creators and generates
277 a range of meta-data and other useful information that can be
278 submitted to OpenBenchmarking.org to provide more verbose infor‐
279 mation for users of your test profiles.
280 openbenchmarking-changes
282 This option will list recent changes to test profiles of enabled
283 OpenBenchmarking.org repositories.
284 openbenchmarking-login
286 This option is used for controlling your Phoronix Test Suite
287 client options for OpenBechmarking.org and syncing the client to
288 your account.
289 openbenchmarking-refresh
291 This option is used for refreshing the stored OpenBenchmark‐
292 ing.org repository information and other data. The Phoronix Test
293 Suite will automatically refresh this data every three days or
294 when other thresholds are exceeded, but this command can be used
295 to manually refresh/updates the data.
296 openbenchmarking-repositories
298 This option will list the OpenBenchmarking.org repositories cur‐
299 rently linked to this Phoronix Test Suite client instance.
300 openbenchmarking-uploads
302 This option will list any recent test result uploads from the
303 system's IP address to OpenBenchmarking.org.
304 recently-added-tests
306 This option will list the most recently added (newest) test pro‐
307 files.
308 upload-result [Test Result]
310 This option is used for uploading a test result to OpenBench‐
311 marking.org.
312 upload-test-profile
314 This option can be used for uploading a test profile to your ac‐
315 count on OpenBenchmarking.org. By uploading your test profile to
316 OpenBenchmarking.org, others are then able to browse and access
317 this test suite for easy distribution in a seamless manner by
318 other Phoronix Test Suite clients.
319 upload-test-suite [Suite]
321 This option can be used for uploading a test suite to your ac‐
322 count on OpenBenchmarking.org. By uploading your test suite to
323 OpenBenchmarking.org, others are then able to browse and access
324 this test suite for easy distribution.
325 INFORMATION
328 info [Test | Suite | OpenBenchmarking ID | Test Result] This op‐
329 tion will show details about the supplied test, suite, virtual
330 suite, or result file.
331 intersect [Test | Suite | OpenBenchmarking ID | Test Result] ...
333 This option will print the test profiles present in all passed
334 result files / test suites. Two or more results/suites must be
335 passed and printed will be all of the common test profiles.
336 list-all-tests
338 This option will list all test profiles that are available from
339 the enabled OpenBenchmarking.org repositories. Unlike the other
340 test listing options, list-all-tests will show deprecated tests,
341 potentially broken tests, or other tests not recommended for all
342 environments. The only check in place is ensuring the test pro‐
343 files are at least compatible with the operating system in use.
344 list-available-suites
346 This option will list all test suites that are available from
347 the enabled OpenBenchmarking.org repositories.
348 list-available-tests
350 This option will list all test profiles that are available from
351 the enabled OpenBenchmarking.org repositories where supported on
352 the system and are of a verified state. If the system has no In‐
353 ternet access, it will only list the test profiles where the
354 necessary test assets are available locally on the system or on
355 an available network cache (the same behavior as using the list-
356 cached-tests sub-command), unless using the list-all-tests op‐
357 tion to override this behavior.
358 list-available-virtual-suites
360 This option will list all available virtual test suites that can
361 be dynamically created based upon the available tests from en‐
362 abled OpenBenchmarking.org repositories.
363 list-cached-tests
365 This option will list all test profiles where any needed test
366 profiles are already cached or available from the local system
367 under test. This is primarily useful if testing offline/behind-
368 the-firewall and other use-cases where wanting to rely only upon
369 local data.
370 list-installed-dependencies
372 This option will list all of the packages / external test depen‐
373 dencies that are already installed on the system that the
374 Phoronix Test Suite may potentially depend upon by test pro‐
375 files.
376 list-installed-suites
378 This option will list all suites that are currently installed on
379 the system.
380 list-installed-tests
382 This option will list all test profiles that are currently in‐
383 stalled on the system.
384 list-missing-dependencies
386 This option will list all of the packages / external test depen‐
387 dencies that are missing from the system that the Phoronix Test
388 Suite may potentially need by select test profiles.
389 list-not-installed-tests
391 This option will list all test profiles that are supported and
392 available but presently NOT installed on the system.
393 list-possible-dependencies
395 This option will list all of the packages / external test depen‐
396 dencies that are are potentially used by the Phoronix Test
397 Suite.
398 list-saved-results
400 This option will list all of the saved test results found on the
401 system.
402 list-test-status
404 This sub-command provides a verbose look at all tests in‐
405 stalled/uninstalled on the system and whether any errors were
406 encountered at install-time or run-time and other test installa‐
407 tion/runtime metrics for complementing other Phoronix Test Suite
408 sub-command outputs.
409 list-test-usage
411 This option will list various details about installed tests and
412 their usage.
413 search This option provides command-line searching abilities for test
415 profiles / test suites / test results. The search query can be
416 passed as a parameter otherwise the user is prompted to input
417 their search query..
418 test-to-suite-map
420 This option will list all test profiles and any test suites each
421 test belongs to.
422 ASSET CREATION
425 build-suite This option will guide the user through the process
426 of generating their own test suite, which they can then run. Op‐
427 tionally, passed as arguments can be the test(s) or suite(s) to
428 add to the suite to be created, instead of being prompted
429 through the process.
430 create-test-profile
432 This option can be used for creating a Phoronix Test Suite test
433 profile by answering questions about the test for constructing
434 the test profile XML meta-data and handling other boiler-plate
435 basics for getting started in developing new tests.
436 debug-benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ...
438 This option is intended for use by test profile writers and is
439 identical to the <em>run</em> option but will yield more infor‐
440 mation during the run process that can be used to debug issues
441 with a test profile or to verify the test profile is functioning
442 correctly.
443 debug-install [Test | Suite | OpenBenchmarking ID | Test Result] ...
445 This option is intended for use by test profile writers and is
446 identical to the install option but will yield more information
447 during the run process that can be used to debug issues with a
448 test profile installer or to verify the test profile is func‐
449 tioning correctly.
450 debug-result-parser [Test | Suite | OpenBenchmarking ID | Test Result]
452 ...
453 This option is intended for use by test profile writers and is
454 used for debugging a result parser. No test execution is done,
455 but there must already be PTS-generated .log files present
456 within the test's installation directory.
457 debug-test-download-links [Test | Suite | OpenBenchmarking ID | Test
459 Result]
460 This option will check all download links within the specified
461 test profile(s) to ensure there are no broken URLs.
462 download-test-files [Test | Suite | OpenBenchmarking ID | Test Result]
464 ...
465 This will download the selected test file(s) to the Phoronix
466 Test Suite download cache but will not install the tests.
467 dump-documentation
469 This option is used for re-generating the Phoronix Test Suite
470 documentation.
471 inspect-test-profile [Test]
473 This option can be used for inspecting a Phoronix Test Suite
474 test profile with providing inside details on test profiles for
475 debugging / evaluation / learning purposes.
476 rebuild-test-suite [Suite]
478 This option will regenerate the local test suite XML file
479 against the OpenBenchmarking.org specification. This can be used
480 to clean up any existing XML syntax / styling issues, etc.
481 validate-result-file
483 This option can be used for validating a Phoronix Test Suite re‐
484 sult file as being compliant against the OpenBenchmarking.org
485 specification.
486 validate-test-profile [Test]
488 This option can be used for validating a Phoronix Test Suite
489 test profile as being compliant against the OpenBenchmarking.org
490 specification.
491 validate-test-suite [Suite]
493 This option can be used for validating a Phoronix Test Suite
494 test suite as being compliant against the OpenBenchmarking.org
495 specification.
496 RESULT MANAGEMENT
499 auto-sort-result-file [Test Result] This option is used if you
500 wish to automatically attempt to sort the results by their re‐
501 sult identifier string. Alternatively, if using the environment
502 variable "SORT_BY" other sort modes can be used, such as
503 SORT_BY=date / SORT_BY=date-desc for sorting by the test run-
504 time/date.
505 compare-results-to-baseline [Test Result] [Test Result]
507 This option will allows you to specify a result as a baseline
508 (first parameter) and a second result file (second parameter)
509 that will offer some analysis for showing how the second result
510 compares to the first in matching tests.
511 compare-results-two-way [Test Result]
513 This option will allows you to specify a result file and from
514 there to compare two individual runs within that result file for
515 looking at wins/losses and other metrics in a head-to-head type
516 comparison.
517 edit-result-file [Test Result]
519 This option is used if you wish to edit the title and descrip‐
520 tion of an existing result file.
521 extract-from-result-file [Test Result]
523 This option will extract a single set of test results from a
524 saved results file that contains multiple test results that have
525 been merged. The user is the prompted to specify a new result
526 file name and select which result identifier to extract.
527 keep-results-in-result-file [Test Result]
529 This option is the inverse of the remove-results-from-result-
530 file sub-command. If you wish to remove all results but those
531 listed from a given result file, this option can be used. The
532 user must specify a saved results file and then they will be
533 prompted to provide a string to search for in keeping those re‐
534 sults in that given result file but removing all other data.
535 merge-results [Test Result] ...
537 This option will manually merge multiple sets of test results
538 generated by the Phoronix Test Suite.
539 remove-incomplete-results-from-result-file [Test Result]
541 This option is used if there are test results (benchmarks) to be
542 dropped from a given result file for having incomplete data, ei‐
543 ther a test run did not attempt to run that benchmark or failed
544 to properly run. The user must specify a saved results file and
545 the command will then attempt to find any results with incom‐
546 plete/missing data and prompt the user with confirmation to re‐
547 move them.
548 remove-result [Test Result]
550 This option will permanently remove the saved file set that is
551 set as the first argument.
552 remove-result-from-result-file [Test Result]
554 This option is used if there are test results (benchmarks) to be
555 dropped from a given result file. The user must specify a saved
556 results file and then they will be prompted to select the
557 tests/benchmarks to remove.
558 remove-results-from-result-file [Test Result]
560 This option is used if there are test results (benchmarks) to be
561 dropped from a given result file. The user must specify a saved
562 results file and then they will be prompted to provide a string
563 to search for in removing those results from that given result
564 file.
565 remove-run-from-result-file [Test Result]
567 This option is used if there is a set of test results you wish
568 to remove/delete from a saved results file. The user must spec‐
569 ify a saved results file and then they will be prompted to se‐
570 lect the results identifier associated with the results they
571 wish to remove.
572 rename-identifier-in-result-file [Test Result]
574 This option is used if you wish to change the name of the iden‐
575 tifier in a test results file that is shown in the Phoronix Test
576 Suite Results Viewer and the contained graphs.
577 rename-result-file [Test Result]
579 This option is used if you wish to change the name of the saved
580 name of a result file.
581 reorder-result-file [Test Result]
583 This option is used if you wish to manually change the order in
584 which test results are shown in the Phoronix Test Suite Results
585 Viewer and the contained graphs. The user must specify a saved
586 results file and then they will be prompted to select the re‐
587 sults identifiers one at a time in the order they would like
588 them to be displayed from left to right.
589 show-result [Test Result]
591 Open up the test results in the Phoronix Test Suite Result
592 Viewer or on OpenBenchmarking.org.
593 OTHER commands This option will display a short list of possible
596 Phoronix Test Suite commands.
597 debug-dependency-handler
599 This option is used for testing the distribution-specific depen‐
600 dency handler for external dependencies.
601 debug-render-test
603 This option is used during the development of the Phoronix Test
604 Suite software for testing of the result and graph rendering
605 code-paths This option will download a large number of reference
606 test results from LinuxBenchmarking.com.
607 debug-self-test
609 This option is used during the development of the Phoronix Test
610 Suite software for testing of internal interfaces, commands, and
611 other common code-paths. The produced numbers should only be
612 comparable for the same version of the Phoronix Test Suite, on
613 the same hardware/software system, conducted on the same day of
614 testing. This isn't intended as any scientific benchmark but
615 simply to stress common PHP code-paths and looking for hot areas
616 to optimize, etc.
617 help This option will display a list of available Phoronix Test Suite
619 commands and possible parameter types.
620 version
622 This option will display the Phoronix Test Suite client version.
623 RESULT ANALYSIS
626 analyze-run-times [Test Result] This option will read a saved
627 test results file and print the statistics about how long the
628 testing took to complete.
629 executive-summary [Test Result]
631 This option will attempt to auto-generate a textual executive
632 summary for a result file to highlight prominent results / aver‐
633 ages.
634 result-file-confidence [Test Result]
636 This option will read a saved test results file and display var‐
637 ious statistics on the confidence of the results with the stan‐
638 dard deviation, three-sigma values, and other metrics while
639 color-coding "passing" results in green.
640 result-file-stats [Test Result]
642 This option is used if you wish to analyze a result file by see‐
643 ing various statistics on the result data for result files con‐
644 taining at least two sets of data.
645 wins-and-losses [Test Result]
647 This option is used if you wish to analyze a result file to see
648 which runs produced the most wins/losses of those result identi‐
649 fiers in the saved file.
650 workload-topology [Test Result]
652 This option will read a saved test results file and print the
653 test profiles contained within and their arrangement within dif‐
654 ferent test suites for getting an idea as to the workload topol‐
655 ogy/make-up / logical groupings of the benchmarks being run.
656 MODULES
659 auto-load-module This option can be used for easily adding a
660 module to the AutoLoadModules list in the Phoronix Test Suite
661 user configuration file. That list controls what PTS modules are
662 automatically loaded on start-up of the Phoronix Test Suite.
663 list-modules
665 This option will list all of the available Phoronix Test Suite
666 modules on this system.
667 module-info [Phoronix Test Suite Module]
669 This option will show detailed information on a Phoronix Test
670 Suite module such as the version, developer, and a description
671 of its purpose.
672 module-setup [Phoronix Test Suite Module]
674 This option will allow you to configure all available end-user
675 options for a Phoronix Test Suite module. These options are then
676 stored within the user's configuration file. Not all modules may
677 have options that can be configured by the end-user.
678 test-module [Phoronix Test Suite Module]
680 This option can be used for debugging a Phoronix Test Suite mod‐
681 ule.
682 unload-module
684 This option can be used for easily removing a module from the
685 AutoLoadModules list in the Phoronix Test Suite user configura‐
686 tion file. That list controls what modules are automatically
687 loaded on start-up of the Phoronix Test Suite.
688 DEBUGGING
691 check-tests [Test] This option will perform a check on one or
692 more test profiles to determine if there have been any vendor
693 changes to the filename, filesize, url location, md5 and sha256
694 checksums.
695 diagnostics
697 This option will print information that is useful to developers
698 when debugging problems with the Phoronix Test Suite and/or test
699 profiles and test suites.
700 dump-file-info
702 This option will dump the MD5 / SHA256 hashes and file size for
703 a given file.
704 dump-openbenchmarking-indexes
706 This option is used for dumping the parsed output of OpenBench‐
707 marking.org index files (metadata).
708 dump-phodevi-smart-cache
710 This option is used for displaying the contents of the Phodevi
711 smart cache on the system.
712 dump-possible-options
714 This option will print all possible phoronix-test-suite sub-com‐
715 mands.
716 dump-unhandled-dependencies
718 This option will list missing entries in the external dependen‐
719 cies XML file for the operating system under test. This option
720 is used if wanting to help find missing dependency XML data to
721 fill in for contributing to upstream Phoronix Test Suite.
722 list-failed-installs
724 This option will list all test profiles that were attempted to
725 be installed on the local system but failed to be installed.
726 Where applicable, the possible error(s) from the test installa‐
727 tion are also reported to assist in debugging.
728 list-test-errors
730 This sub-command is complementary to list-failed-installs.
731 Rather than listing test installation errors, list-test-errors
732 is used for displaying past test run-time errors. This option
733 will list all test profiles that produced an error previously
734 when running the test profile / benchmark. If a test profile
735 later successfully ran the test with any given option(s) without
736 errors, the error is then removed from the archive. This option
737 is intended to be helpful in debugging test profile issues later
738 on for having a persistent collection of run-time errors.
739 list-unsupported-tests
741 This option will list all available test profiles that are
742 available from the enabled OpenBenchmarking.org repositories but
743 are NOT SUPPORTED on the given hardware/software platform. This
744 is mainly a debugging option for those looking for test profiles
745 to potentially port to new platforms, etc.
746 USER CONFIGURATION
749 enterprise-setup This option can be run by enterprise users im‐
750 mediately after package installation or as part of an in-house
751 setup script. Running this command will ensure the phoronix-
752 test-suite program is never interrupted on new runs to accept
753 user agreement changes and defaults the anonymous usage report‐
754 ing to being disabled and other conservative defaults.
755 network-info
757 This option will print information detected by the Phoronix Test
758 Suite around the system's network configuration.
759 network-setup
761 This option allows the user to configure how the Phoronix Test
762 Suite connects to OpenBenchmarking.org and other web-services.
763 Connecting through an HTTP proxy can be configured through this
764 option.
765 user-config-reset
767 This option can be used for resetting the Phoronix Test Suite
768 user configuration file to its default state.
769 user-config-set
771 This option can be used for setting an XML value in the Phoronix
772 Test Suite user configuration file.
773 variables
775 This option will print all of the official environment variables
776 supported by the Phoronix Test Suite for user configuration pur‐
777 poses. These environment variables are also listed as part of
778 the official Phoronix Test Suite documentation while this com‐
779 mand will also show the current value of the variables if cur‐
780 rently set.
781 RESULT EXPORT
784 result-file-raw-to-csv [Test Result] This option will read a
785 saved test results file and output the raw result file run data
786 to a CSV file. This raw (individual) result file output is in‐
787 tended for data analytic purposes where the result-file-to-csv
788 is more end-user-ready.
789 result-file-to-csv [Test Result]
791 This option will read a saved test results file and output the
792 system hardware and software information along with the results
793 to a CSV output. The CSV (Comma Separated Values) output can
794 then be loaded into a spreadsheet for easy viewing. The out‐
795 putted file appears in the user home directory or can otherwise
796 be controlled via the OUTPUT_DIR and OUTPUT_FILE environment
797 variables.
798 result-file-to-html [Test Result]
800 This option will read a saved test results file and output the
801 system hardware and software information along with the results
802 to pure HTML file. No external files are required for CSS/Java‐
803 Script or other assets. The graphs are rendered as inline SVG.
804 This is a pure HTML-only representation of the results for
805 emailing or other easy analysis outside of the Phoronix Test
806 Suite. The outputted file appears in the user home directory or
807 can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE
808 environment variables.
809 result-file-to-json [Test Result]
811 This option will read a saved test results file and output the
812 basic result information to JSON (JavaScript Object Notation).
813 The outputted file appears in the user home directory or can
814 otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE envi‐
815 ronment variables.
816 result-file-to-pdf [Test Result]
818 This option will read a saved test results file and output the
819 system hardware and software information along with the results
820 to a PDF file. The outputted file appears in the user home di‐
821 rectory or can otherwise be controlled via the OUTPUT_DIR and
822 OUTPUT_FILE environment variables.
823 result-file-to-suite [Test Result]
825 This option will guide the user through the process of generat‐
826 ing their own test suite, which they can then run, that is based
827 upon an existing test results file.
828 result-file-to-text [Test Result]
830 This option will read a saved test results file and output the
831 system hardware and software information to the terminal. The
832 test results are also outputted.
833 PHOROMATIC
836 start-phoromatic-server Start the Phoromatic web server for con‐
837 trolling local Phoronix Test Suite client systems to facilitate
838 automated and repeated test orchestration and other automated
839 features targeted at the enterprise.
840 RESULT VIEWER
843 n _
844 SEE ALSO
847 Websites:
848 https://www.phoronix-test-suite.com/
849 https://commercial.phoronix-test-suite.com/
850 https://www.openbenchmarking.org/
851 https://www.phoronix.com/
852
854 Copyright 2008 - 2022 by Phoronix Media, Michael Larabel.
855