Add test utility 'split-file'
authorFangrui Song <maskray@google.com>
Mon, 3 Aug 2020 17:17:55 +0000 (10:17 -0700)
committerFangrui Song <i@maskray.me>
Tue, 4 Aug 2020 03:42:09 +0000 (20:42 -0700)
commitbcea3a7a288e0b5ac977f90c46e4eef7946467e7
tree86a2f9f4c13e83237b9dbd09e64c43859c5b32d5
parente56626e43826c9d7c35113635d62b57c905ef3c0
Add test utility 'split-file'

See https://lists.llvm.org/pipermail/llvm-dev/2020-July/143373.html
"[llvm-dev] Multiple documents in one test file" for some discussions.

This patch has explored several alternatives. The current semantics are similar to
what @dblaikie proposed.
`split-file filename output` splits the input file into multiple parts separated by
regex `^(.|//)--- filename` and write each part to the file `output/filename`
(`filename` can include path separators).

Use case A (organizing input of different formats (e.g. linker
script+assembly) in one file).

```
# RUN: split-file %s %t
# RUN: llvm-mc %t/asm -o %t.o
# RUN: ld.lld -T %t/lds %t.o -o %t
This is sometimes better than the %S/Inputs/ approach because the user
can see the auxiliary files immediately and don't have to open another file.

# asm
...
# lds
...
```

Use case B (for utilities which don't have built-in input splitting
feature):

```
// RUN: split-file %s %t
// RUN: llc < %t/1.ll | FileCheck %s --check-prefix=CASE1
// RUN: llc < %t/2.ll | FileCheck %s --check-prefix=CASE2
Combing tests prudently can improve readability.
For example, when testing parsing errors if the recovery mechanism isn't possible,
grouping the tests in one file can more readily see test coverage/strategy.

//--- 1.ll
...
//--- 2.ll
...
```

Since this is a new utility, there is no git history concerns for
UpperCase variable names. I use lowerCase variable names like mlir/lld.

Reviewed By: jhenderson, lattner

Differential Revision: https://reviews.llvm.org/D83834
22 files changed:
lld/test/CMakeLists.txt
lld/test/ELF/linkerscript/noload.s
llvm/docs/TestingGuide.rst
llvm/test/CMakeLists.txt
llvm/test/lit.cfg.py
llvm/test/tools/gold/X86/multiple-sections.ll
llvm/test/tools/llvm-strings/radix.test
llvm/test/tools/split-file/Inputs/basic-aa.txt [new file with mode: 0644]
llvm/test/tools/split-file/Inputs/basic-bb.txt [new file with mode: 0644]
llvm/test/tools/split-file/Inputs/basic-cc.txt [new file with mode: 0644]
llvm/test/tools/split-file/basic.test [new file with mode: 0644]
llvm/test/tools/split-file/empty.test [new file with mode: 0644]
llvm/test/tools/split-file/error.test [new file with mode: 0644]
llvm/test/tools/split-file/help.test [new file with mode: 0644]
llvm/test/tools/split-file/no-leading-lines.test [new file with mode: 0644]
llvm/test/tools/split-file/output-is-special.test [new file with mode: 0644]
llvm/tools/split-file/.clang-tidy [new file with mode: 0644]
llvm/tools/split-file/CMakeLists.txt [new file with mode: 0644]
llvm/tools/split-file/split-file.cpp [new file with mode: 0644]
llvm/utils/gn/secondary/lld/test/BUILD.gn
llvm/utils/gn/secondary/llvm/test/BUILD.gn
llvm/utils/gn/secondary/llvm/tools/split-file/BUILD.gn [new file with mode: 0644]