[all-commits] [llvm/llvm-project] 1d297f: [lit] Sort test start times based on prior test ti...

[David Zarzycki via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 1d297f90649dd63187590548e20de0eced61750c
      https://github.com/llvm/llvm-project/commit/1d297f90649dd63187590548e20de0eced61750c
  Author: David Zarzycki <dave at znu.io>
  Date:   2021-03-16 (Tue, 16 Mar 2021)

  Changed paths:
    M llvm/docs/CommandGuide/lit.rst
    M llvm/test/Unit/lit.cfg.py
    M llvm/utils/lit/lit/Test.py
    M llvm/utils/lit/lit/TestingConfig.py
    M llvm/utils/lit/lit/cl_arguments.py
    M llvm/utils/lit/lit/discovery.py
    M llvm/utils/lit/lit/main.py
    R llvm/utils/lit/tests/Inputs/early-tests/aaa.txt
    R llvm/utils/lit/tests/Inputs/early-tests/bbb.txt
    R llvm/utils/lit/tests/Inputs/early-tests/lit.cfg
    R llvm/utils/lit/tests/Inputs/early-tests/subdir/ccc.txt
    A llvm/utils/lit/tests/Inputs/reorder/.lit_test_times.txt
    A llvm/utils/lit/tests/Inputs/reorder/aaa.txt
    A llvm/utils/lit/tests/Inputs/reorder/bbb.txt
    A llvm/utils/lit/tests/Inputs/reorder/lit.cfg
    A llvm/utils/lit/tests/Inputs/reorder/subdir/ccc.txt
    R llvm/utils/lit/tests/early-tests.py
    M llvm/utils/lit/tests/ignore-fail.py
    A llvm/utils/lit/tests/reorder.py
    M llvm/utils/lit/tests/shtest-shell.py
    M mlir/test/Unit/lit.cfg.py

  Log Message:
  -----------
  [lit] Sort test start times based on prior test timing data

Lit as it exists today has three hacks that allow users to run tests earlier:

1) An entire test suite can set the `is_early` boolean.
2) A very recently introduced "early_tests" feature.
3) The `--incremental` flag forces failing tests to run first.

All of these approaches have problems.

1) The `is_early` feature was until very recently undocumented. Nevertheless it still lacks testing and is a imprecise way of optimizing test starting times.
2) The `early_tests` feature requires manual updates and doesn't scale.
3) `--incremental` is undocumented, untested, and it requires modifying the *source* file system by "touching" the file. This "touch" based approach is arguably a hack because it confuses editors (because it looks like the test was modified behind the back of the editor) and "touching" the test source file doesn't work if the test suite is read only from the perspective of `lit` (via advanced filesystem/build tricks).

This patch attempts to simplify and address all of the above problems.

This patch formalizes, documents, tests, and defaults lit to recording the execution time of tests and then reordering all tests during the next execution. By reordering the tests, high core count machines run faster, sometimes significantly so.

This patch also always runs failing tests first, which is a positive user experience win for those that didn't know about the hidden `--incremental` flag.

Finally, if users want, they can _optionally_ commit the test timing data (or a subset thereof) back to the repository to accelerate bots and first-time runs of the test suite.

Reviewed By: jhenderson, yln

Differential Revision: https://reviews.llvm.org/D98179