[libc++] Add an alternative Lit test format

[ldionne]

Summary

This new test format is simpler and more flexible. It creates Lit ShTests
on the fly that reuse existing substitutions (like %{cxx}) instead of
having complex logic in Python to run the tests. This has the benefit
that virtually no coding is required to customize how the test suite is
run -- one can achieve pretty much anything by defining the appropriate
substitutions in a simple lit.cfg file.

For example, in order to run the tests on an embedded device after
building with a specific SDK, one can set the %{cxx} and %{compile_flags}
substitutions to use that SDK, and the %{exec} substitution to the ssh.py
script currently used for .sh.cpp tests with a remote executor. Dealing with
the SSHExecutor becomes unnecessary, since all tests are treated like ShTests.

As a side effect of this design, configuration files for the test
suite can be as simple as:

config.substitutions.append(('%{cxx}', '<path-to-compiler>'))
config.substitutions.append(('%{compile_flags}', '<flags>'))
config.substitutions.append(('%{link_flags}', '<flags>'))
config.substitutions.append(('%{exec}', '<script-to-execute>'))

This should allow storing lit.cfg files for various configurations
directly in the repository instead of relying on complicated logic
in config.py to set up the right flags. I've found numerous problems
in that logic in the past years, and it seems like having simple and
explicit configuration files for the configurations we support is
going to solve most of these problems. Specifically, I am hoping to
store configuration files for testing other Standard Libraries in
the repository.

Improving the interaction with the test suite configuration is still a
work in progress, so for now this test format reuses the substitutions and
available features that are set up by the current config.py.

This new test format should support pretty much everything that the current
test format supports, however it will not be enabled by default at first to
make sure we're satisfied with it. For a short period of time, the new format
will require --param=use_new_format=True to be enabled, however it is a very
short term goal to replace the current testing format entirely and to simplify
the configuration accordingly.

[ldionne]

This is mostly a heads-up review. I welcome comments and improvement suggestions. This patch is a no-op unless one opts into the new format, and in particular this doesn't change the interaction between CMake and config.py at all. Because of this, I will not hold off committing this in order to start adopting it more widely right away -- improvements can be made as follow-up patches as I get more feedback from people who try it out.

I have been tweaking the libc++ test suite in the past couple of weeks in order to make this format and the current format essentially equivalent. As of right now, this format allows me to run all tests locally or remotely on both macOS and our CI Docker images (including filesystem tests, which doesn't work with the old format). I especially welcome feedback from people who try it out on Windows or on configurations I'm not aware of.

The only known "problem" with the new format is that the test/libcxx/type_traits/is_pointer.arc.pass.mm test doesn't pass right now. This is actually rather troubling -- the old format is broken and skips .pass.mm tests entirely, so that test simply was never executed since I added it one year ago.

[broadwaylamb]

This is awesome, thanks for your work!

libcxx/utils/libcxx/test/newformat.py

116

Can this be simplified?

compilerSupportsVerify = result.code != lit.Test.FAIL

[EricWF]

I like tests.
Assuming all of them pass;: LGTM.

libcxx/test/libcxx/selftest/newformat/additional_compile_flags/substitutes-in-compile-flags.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure that substitutions are performed inside additional compiler flags.
+
+// ADDITIONAL_COMPILE_FLAGS: -I %t.1
+// ADDITIONAL_COMPILE_FLAGS: -isystem %t.2 , -isysroot %t.3
+// RUN: echo "%{compile_flags}" | grep -e '-I %t.1 -isystem %t.2 -isysroot %t.3'

libcxx/test/libcxx/selftest/newformat/additional_compile_flags/substitutes-in-run.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure that additional compiler flags are added to the %{compile_flags}
+// substitution.
+
+// ADDITIONAL_COMPILE_FLAGS: -foo
+// ADDITIONAL_COMPILE_FLAGS: -bar
+// ADDITIONAL_COMPILE_FLAGS: -baz, -foom
+// RUN: echo "%{compile_flags}" | grep -e '-foo -bar -baz -foom'

libcxx/test/libcxx/selftest/newformat/compile.fail.cpp/compile-error.compile.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it fails at compile-time
+
+struct Foo { };
+typedef Foo::x x; // expected-error{{no type named 'x' in 'Foo'}}
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/compile.fail.cpp/compile-success.compile.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it succeeds at compile-time
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/compile.fail.cpp/wrong-expected.compile.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time, but the
+// expected-error is wrong.
+
+struct Foo { };
+typedef Foo::x x; // expected-error{{this is not found in the errors}}
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/compile.pass.cpp/compile-error.compile.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/compile.pass.cpp/compile-success.compile.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it succeeds to compile
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/compile.pass.cpp/link-error.compile.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes even if there's a link error, i.e. it isn't linked.
+
+extern void this_is_an_undefined_symbol();
+
+int main() {
+    this_is_an_undefined_symbol();
+}

libcxx/test/libcxx/selftest/newformat/compile.pass.cpp/run-error.compile.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes even if there's a runtime error, i.e. it isn't run.
+
+int main() {
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/fail.cpp/compile-error-with-verify.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it fails at compile-time, with verify
+
+struct Foo { };
+typedef Foo::x x; // expected-error{{no type named 'x' in 'Foo'}}
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/fail.cpp/compile-error-without-verify.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it fails at compile-time, without verify
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/fail.cpp/compile-success.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it succeeds at compile-time
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/fail.cpp/wrong-expected.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time, but the
+// expected-error is wrong.
+
+struct Foo { };
+typedef Foo::x x; // expected-error{{this is not found in the errors}}
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/file_dependencies/no-dependencies.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure that %{file_dependencies} is empty when no FILE_DEPENDENCIES
+// line appears. Amongst other things, this makes sure that we don't share
+// file dependencies across unrelated Lit tests.
+
+// RUN: test -z "%{file_dependencies}"

libcxx/test/libcxx/selftest/newformat/file_dependencies/substitute-in-dependencies.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure that lit substitutions are expanded inside FILE_DEPENDENCIES lines.
+
+// FILE_DEPENDENCIES: %s
+// RUN: echo %{file_dependencies} | grep 'substitute-in-dependencies.sh.cpp'

libcxx/test/libcxx/selftest/newformat/file_dependencies/substitute-in-run.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure %{file_dependencies} are substituted properly into RUN commands.
+
+// FILE_DEPENDENCIES: a.txt
+// FILE_DEPENDENCIES: b.txt, c.txt
+// FILE_DEPENDENCIES: /absolute/d.txt
+// RUN: echo %{file_dependencies} | grep 'a.txt'
+// RUN: echo %{file_dependencies} | grep 'b.txt'
+// RUN: echo %{file_dependencies} | grep 'c.txt'
+// RUN: echo %{file_dependencies} | grep '/absolute/d.txt'

libcxx/test/libcxx/selftest/newformat/link.fail.cpp/compile-error.link.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time.
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/link.fail.cpp/link-error.link.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it fails at link time.
+
+extern void this_is_an_undefined_symbol();
+
+int main() {
+    this_is_an_undefined_symbol();
+}

libcxx/test/libcxx/selftest/newformat/link.fail.cpp/link-success.link.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it succeeds to link.
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/link.pass.cpp/compile-error.link.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time.
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/link.pass.cpp/link-error.link.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails to link.
+
+extern void this_is_an_undefined_symbol();
+
+int main() {
+    this_is_an_undefined_symbol();
+}

libcxx/test/libcxx/selftest/newformat/link.pass.cpp/link-success.link.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it succeeds to link.
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/link.pass.cpp/run-error.link.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it succeeds to link, even though it would have
+// failed at runtime.
+
+int main() {
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/lit.local.cfg

+import libcxx.test.newformat
+
+if not isinstance(config.test_format, libcxx.test.newformat.CxxStandardLibraryTest):
+    config.unsupported = True

libcxx/test/libcxx/selftest/newformat/pass.cpp/compile-error.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/pass.cpp/link-error.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at link-time
+
+extern void this_is_an_undefined_symbol();
+
+int main() {
+    this_is_an_undefined_symbol();
+}

libcxx/test/libcxx/selftest/newformat/pass.cpp/run-error.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at runtime.
+
+int main() {
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/pass.cpp/run-success.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes pass if it succeeds at runtime.
+
+int main() {
+    return 0;
+}

libcxx/test/libcxx/selftest/newformat/pass.mm/compile-error.pass.mm

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() { }

libcxx/test/libcxx/selftest/newformat/pass.mm/link-error.pass.mm

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at link-time
+
+extern void this_is_an_undefined_symbol();
+
+int main() {
+    this_is_an_undefined_symbol();
+}

libcxx/test/libcxx/selftest/newformat/pass.mm/no-arc.pass.mm

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure ARC is not enabled by default in these tests.
+
+#if __has_feature(objc_arc)
+#   error "arc should not be enabled by default"
+#endif
+
+int main() {
+    return 0;
+}

libcxx/test/libcxx/selftest/newformat/pass.mm/run-error.pass.mm

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at runtime.
+
+int main() {
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/pass.mm/run-success.pass.mm

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes pass if it succeeds at runtime.
+
+int main() {
+    return 0;
+}

libcxx/test/libcxx/selftest/newformat/pass.mm/use-objective-cxx.pass.mm

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure we can use Objective C++ features in these tests.
+
+@interface Foo
+@end
+
+int main() {
+    return 0;
+}

libcxx/test/libcxx/selftest/newformat/run.fail.cpp/compile-error.run.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails at compile-time
+
+struct Foo { };
+typedef Foo::x x;
+
+int main() {
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/run.fail.cpp/link-error.run.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure that the test DOES NOT pass if it fails at link-time
+
+extern void this_is_an_undefined_symbol();
+
+int main() {
+    this_is_an_undefined_symbol();
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/run.fail.cpp/run-error.run.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it fails at runtime.
+
+int main() {
+    return 1;
+}

libcxx/test/libcxx/selftest/newformat/run.fail.cpp/run-success.run.fail.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it succeeds at runtime.
+
+int main() {
+    return 0;
+}

libcxx/test/libcxx/selftest/newformat/sh.cpp/empty.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it has no 'RUN:' steps

libcxx/test/libcxx/selftest/newformat/sh.cpp/remote-substitutions.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure that test-executables can appear in RUN lines and be executed
+// effectively. This somewhat difficult-to-understand test checks that when
+// we run with a remote executor, test-executables are copied to the remote
+// host and their path is fixed up (directly in the command-line) to their
+// path on the remote host instead of the local host.
+//
+// We also check that the path of test-executables is replaced whether they
+// appear first in the command-line or not.
+
+// FILE_DEPENDENCIES: %t.exe
+// RUN: %{cxx} %{compile_flags} %{link_flags} -o %t.exe %s
+// RUN: %{exec} %t.exe 0
+// RUN: %{exec} ! %t.exe 1
+
+#include <cassert>
+#include <cstdlib>
+
+int main(int argc, char** argv) {
+  assert(argc == 2);
+  int ret = std::atoi(argv[1]);
+  return ret;
+}

libcxx/test/libcxx/selftest/newformat/sh.cpp/run-error.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// XFAIL: *
+
+// Make sure the test DOES NOT pass if it fails to run
+
+// RUN: exit 1

libcxx/test/libcxx/selftest/newformat/sh.cpp/run-success.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure the test passes if it succeeds to run
+
+// RUN: exit 0

libcxx/test/libcxx/selftest/newformat/sh.cpp/substitutions.sh.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Make sure we have access to the following substitutions at all times:
+// - %{cxx}
+// - %{compile_flags}
+// - %{link_flags}
+// - %{exec}
+
+// FILE_DEPENDENCIES: %t.exe
+// RUN: %{cxx} %{compile_flags} %{link_flags} -o %t.exe %s
+// RUN: %{exec} %t.exe "HELLO"
+
+#include <cassert>
+#include <string>
+
+int main(int argc, char** argv) {
+  assert(argc == 2);
+
+  std::string arg = argv[1];
+  assert(arg == "HELLO");
+  return 0;
+}

libcxx/test/lit.cfg

 
 # Load the Configuration class from the module name <cfg_variant>.test.config.
 config_module_name = '.'.join([cfg_variant, 'test', 'config'])
 config_module = __import__(config_module_name, fromlist=['Configuration'])
 
 configuration = config_module.Configuration(lit_config, config)
 configuration.configure()
 configuration.print_config_info()
+if lit_config.params.get('use_new_format', False):
+    lit_config.note("Using the experimental libc++ testing format")
+    import libcxx.test.newformat
+    config.test_format = libcxx.test.newformat.CxxStandardLibraryTest()
+else:
     config.test_format = configuration.get_test_format()

libcxx/utils/libcxx/test/newformat.py

+#===----------------------------------------------------------------------===##
+#
+# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+#===----------------------------------------------------------------------===##
+
+import lit
+import os
+import pipes
+
+class CxxStandardLibraryTest(lit.formats.TestFormat):
+    """
+    Lit test format for the C++ Standard Library conformance test suite.
+
+    This test format is based on top of the ShTest format -- it basically
+    creates a shell script performing the right operations (compile/link/run)
+    based on the extension of the test file it encounters. It supports files
+    with the following extensions:
+
+    FOO.pass.cpp            - Compiles, links and runs successfully
+    FOO.pass.mm             - Same as .pass.cpp, but for Objective-C++
+    FOO.run.fail.cpp        - Compiles and links successfully, but fails at runtime
+    FOO.compile.pass.cpp    - Compiles successfully, link and run not attempted
+    FOO.compile.fail.cpp    - Does not compile successfully (run with clang-verify)
+    FOO.link.pass.cpp       - Compiles and links successfully, run not attempted
+    FOO.link.fail.cpp       - Compiles successfully, but fails to link
+    FOO.sh.cpp              - A builtin lit Shell test
+
+    FOO.fail.cpp            - Does not compile successfully -- run with clang-verify
+                              if any expected-meow appears in the file, otherwise
+                              just test that compilation fails. This is supported
+                              only for backwards compatibility with the test suite
+
+    The test format operates by assuming that each test's configuration provides
+    the following substitutions, which it will reuse in the shell scripts it
+    constructs:
+        %{cxx}           - A command that can be used to invoke the compiler
+        %{compile_flags} - Flags to use when compiling a test case
+        %{link_flags}    - Flags to use when linking a test case
+        %{exec}          - A command to prefix the execution of executables
+
+    Note that when building an executable (as opposed to only compiling a source
+    file), both %{compile_flags} and %{link_flags} will be used in the same
+    command line. In other words, the test format doesn't perform separate
+    compilation and linking steps in this case.
+
+
+    In addition to everything that's supported in Lit ShTests, this test format
+    also understands the following directives inside test files:
+
+        // FILE_DEPENDENCIES: file, directory, /path/to/file
+
+            This directive expresses that the test requires the provided files
+            or directories in order to run. An example is a test that requires
+            some test input stored in a data file. When a test file contains
+            such a directive, this test format will collect them and make them
+            available in a special %{file_dependencies} substitution. The intent
+            is that if one needs to e.g. execute tests on a remote host, the
+            %{exec} substitution could use %{file_dependencies} to know which
+            files and directories to copy to the remote host.
+
+        // ADDITIONAL_COMPILE_FLAGS: flag1, flag2, flag3
+
+            This directive will cause the provided flags to be added to the
+            %{compile_flags} substitution for the test that contains it. This
+            allows adding special compilation flags without having to use a
+            .sh.cpp test, which would be more powerful but perhaps overkill.
+
+    This test format still needs work in the following areas:
+        - It doesn't support the MODULES_DEFINES from the old test format, but
+          that can be achieved easily with ADDITIONAL_COMPILE_FLAGS.
+        - It is unknown how well it works on Windows yet.
+    """
+    def getTestsInDirectory(self, testSuite, pathInSuite, litConfig, localConfig):
+        SUPPORTED_SUFFIXES = ['.pass.cpp', '.run.fail.cpp',
+                              '.pass.mm',
+                              '.compile.pass.cpp', '.compile.fail.cpp',
+                              '.link.pass.cpp', '.link.fail.cpp',
+                              '.sh.cpp',
+                              '.fail.cpp']
+        sourcePath = testSuite.getSourcePath(pathInSuite)
+        for filename in os.listdir(sourcePath):
+            # Ignore dot files and excluded tests.
+            if filename.startswith('.') or filename in localConfig.excludes:
+                continue
+
+            filepath = os.path.join(sourcePath, filename)
+            if not os.path.isdir(filepath):
+                if any([filename.endswith(ext) for ext in SUPPORTED_SUFFIXES]):
+                    yield lit.Test.Test(testSuite, pathInSuite + (filename,), localConfig)
+
+    def _checkSubstitutions(self, substitutions):
+        substitutions = [s for (s, _) in substitutions]
+        for s in ['%{cxx}', '%{compile_flags}', '%{link_flags}', '%{exec}']:
+            assert s in substitutions, "Required substitution {} was not provided".format(s)
+
+    # Determine whether -verify should be used for a given test. We use -verify
+    # if the compiler supports it and there's at least one -verify tag in the
+    # source file.
+    #
+    # This is only supported for backwards compatibility with .fail.cpp tests.
+    def _useVerify(self, test, litConfig):
+        VERIFY_TAGS = (b'expected-note', b'expected-remark',
+                       b'expected-warning', b'expected-error',
+                       b'expected-no-diagnostics')
+        with open(test.getSourcePath(), 'rb') as f:
+            contents = f.read()
+        testContainsTags = any(tag in contents for tag in VERIFY_TAGS)
+
+        command = "echo | %{cxx} -xc++ - -Werror -fsyntax-only -Xclang -verify-ignore-unexpected"
+        result = lit.TestRunner.executeShTest(test, litConfig,
+                                              useExternalSh=True,
+                                              preamble_commands=[command])
+        compilerSupportsVerify = False if result.code == lit.Test.FAIL else True
+        return compilerSupportsVerify and testContainsTags
+
+    def execute(self, test, litConfig):
+        self._checkSubstitutions(test.config.substitutions)
+        VERIFY_FLAGS = '-Xclang -verify -Xclang -verify-ignore-unexpected=note -ferror-limit=0'
+        filename = test.path_in_suite[-1]
+        if filename.endswith('.sh.cpp'):
+            steps = [ ] # The steps are already in the script
+            return self._executeShTest(test, litConfig, steps)
+        elif filename.endswith('.compile.pass.cpp'):
+            steps = [
+                "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} -fsyntax-only"
+            ]
+            return self._executeShTest(test, litConfig, steps)
+        elif filename.endswith('.compile.fail.cpp'):
+            steps = [
+                "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} -fsyntax-only " + VERIFY_FLAGS
+            ]
+            return self._executeShTest(test, litConfig, steps)
+        elif filename.endswith('.link.pass.cpp'):
+            steps = [
+                "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} %{link_flags} -o %t.exe"
+            ]
+            return self._executeShTest(test, litConfig, steps)
+        elif filename.endswith('.link.fail.cpp'):
+            steps = [
+                "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} -c -o %t.o",
+                "%dbg(LINKED WITH) ! %{cxx} %t.o %{link_flags} -o %t.exe"
+            ]
+            return self._executeShTest(test, litConfig, steps)
+        elif filename.endswith('.run.fail.cpp'):
+            steps = [
+                "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} %{link_flags} -o %t.exe",
+                "%dbg(EXECUTED AS) %{exec} ! %t.exe"
+            ]
+            return self._executeShTest(test, litConfig, steps, fileDependencies=['%t.exe'])
+        # Make sure to check these ones last, since they will match other
+        # suffixes above too.
+        elif filename.endswith('.pass.cpp') or filename.endswith('.pass.mm'):
+            steps = [
+                "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} %{link_flags} -o %t.exe",
+                "%dbg(EXECUTED AS) %{exec} %t.exe"
+            ]
+            return self._executeShTest(test, litConfig, steps, fileDependencies=['%t.exe'])
+        # This is the same as .compile.fail.cpp, provided for backwards
+        # compatibility with the test suite.
+        elif filename.endswith('.fail.cpp'):
+            if self._useVerify(test, litConfig):
+                steps = [
+                    "%dbg(COMPILED WITH) %{cxx} %s %{compile_flags} -fsyntax-only " + VERIFY_FLAGS
+                ]
+            else:
+                steps = [
+                    "%dbg(COMPILED WITH) ! %{cxx} %s %{compile_flags} -fsyntax-only"
+                ]
+            return self._executeShTest(test, litConfig, steps)
+        else:
+            return lit.Test.Result(lit.Test.FAIL, "Unknown test suffix for '{}'".format(filename))
+
+    # Utility function to add compile flags in lit.local.cfg files.
+    def addCompileFlags(self, config, *flags):
+        string = ' '.join(flags)
+        config.substitutions = [(s, x + ' ' + string) if s == '%{compile_flags}' else (s, x) for (s, x) in config.substitutions]
+
+    # Modified version of lit.TestRunner.executeShTest to handle custom parsers correctly.
+    def _executeShTest(self, test, litConfig, steps, fileDependencies=None):
+        recursiveExpansionLimit = 10 # TODO: Use the value in litConfig once we set it.
+        if test.config.unsupported:
+            return lit.Test.Result(lit.Test.UNSUPPORTED, 'Test is unsupported')
+
+        additionalCompileFlags = []
+        fileDependencies = fileDependencies or []
+        parsers = [
+            lit.TestRunner.IntegratedTestKeywordParser('FILE_DEPENDENCIES:',
+                                                       lit.TestRunner.ParserKind.LIST,
+                                                       initial_value=fileDependencies),
+            lit.TestRunner.IntegratedTestKeywordParser('ADDITIONAL_COMPILE_FLAGS:',
+                                                       lit.TestRunner.ParserKind.LIST,
+                                                       initial_value=additionalCompileFlags)
+        ]
+
+        script = list(steps)
+        parsed = lit.TestRunner.parseIntegratedTestScript(test, additional_parsers=parsers,
+                                                                require_script=not script)
+        if isinstance(parsed, lit.Test.Result):
+            return parsed
+        script += parsed
+
+        if litConfig.noExecute:
+            return lit.Test.Result(lit.Test.PASS)
+
+        # Add compile flags specified with ADDITIONAL_COMPILE_FLAGS.
+        self.addCompileFlags(test.config, *additionalCompileFlags)
+
+        tmpDir, tmpBase = lit.TestRunner.getTempPaths(test)
+        useExternalSh = True
+        substitutions = lit.TestRunner.getDefaultSubstitutions(test, tmpDir, tmpBase,
+                                                               normalize_slashes=useExternalSh)
+
+        # Perform substitutions inside FILE_DEPENDENCIES lines (or injected dependencies).
+        # This allows using variables like %t in file dependencies. Also note that we really
+        # need to resolve %{file_dependencies} now, because otherwise we won't be able to
+        # make all paths absolute below.
+        fileDependencies = lit.TestRunner.applySubstitutions(fileDependencies, substitutions,
+                                                             recursion_limit=recursiveExpansionLimit)
+
+        # Add the %{file_dependencies} substitution before we perform substitutions
+        # inside the script.
+        testDir = os.path.dirname(test.getSourcePath())
+        fileDependencies = [f if os.path.isabs(f) else os.path.join(testDir, f) for f in fileDependencies]
+        substitutions.append(('%{file_dependencies}', ' '.join(map(pipes.quote, fileDependencies))))
+
+        # Perform substitution in the script itself.
+        script = lit.TestRunner.applySubstitutions(script, substitutions,
+                                                   recursion_limit=recursiveExpansionLimit)
+
+        return lit.TestRunner._runShTest(test, litConfig, useExternalSh, script, tmpBase)

libcxxabi/test/lit.cfg

 
 # Load the Configuration class from the module name <cfg_variant>.test.config.
 config_module_name = '.'.join([cfg_variant, 'test', 'config'])
 config_module = __import__(config_module_name, fromlist=['Configuration'])
 
 configuration = config_module.Configuration(lit_config, config)
 configuration.configure()
 configuration.print_config_info()
+if lit_config.params.get('use_new_format', False):
+    lit_config.note("Using the experimental libc++ testing format")
+    import libcxx.test.newformat
+    config.test_format = libcxx.test.newformat.CxxStandardLibraryTest()
+else:
     config.test_format = configuration.get_test_format()