From e9bafbf37011514827bfe32bb81d3f4e59f206da Mon Sep 17 00:00:00 2001 From: Jordan Rose Date: Fri, 13 Oct 2017 16:12:23 +0000 Subject: [PATCH] lit.py: Add new %{shared_output(LABEL)} substitution This refers to a temporary path that can be shared across all tests, identified by a particular label. This can be used for things like caches. At the moment, the character set for the LABEL is limited to C identifier characters, plus '-', '+', '=', and '.'. This is the same set of characters currently allowed in REQUIRES clause identifiers. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@315697 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/lit.rst | 23 ++++++++++--------- docs/TestingGuide.rst | 6 +++++ utils/lit/lit/TestRunner.py | 5 ++++ utils/lit/lit/run.py | 8 +++++++ utils/lit/tests/Inputs/shared-output/lit.cfg | 5 ++++ .../tests/Inputs/shared-output/primary.txt | 2 ++ .../tests/Inputs/shared-output/secondary.txt | 1 + .../tests/Inputs/shared-output/sub/sub.txt | 1 + utils/lit/tests/shared-output.py | 13 +++++++++++ 9 files changed, 53 insertions(+), 11 deletions(-) create mode 100644 utils/lit/tests/Inputs/shared-output/lit.cfg create mode 100644 utils/lit/tests/Inputs/shared-output/primary.txt create mode 100644 utils/lit/tests/Inputs/shared-output/secondary.txt create mode 100644 utils/lit/tests/Inputs/shared-output/sub/sub.txt create mode 100644 utils/lit/tests/shared-output.py diff --git a/docs/CommandGuide/lit.rst b/docs/CommandGuide/lit.rst index fbe1a9ab184..57d804478fc 100644 --- a/docs/CommandGuide/lit.rst +++ b/docs/CommandGuide/lit.rst @@ -395,17 +395,18 @@ PRE-DEFINED SUBSTITUTIONS :program:`lit` provides various patterns that can be used with the RUN command. These are defined in TestRunner.py. The base set of substitutions are: - ========== ============== - Macro Substitution - ========== ============== - %s source path (path to the file currently being run) - %S source dir (directory of the file currently being run) - %p same as %S - %{pathsep} path separator - %t temporary file name unique to the test - %T temporary directory unique to the test - %% % - ========== ============== + ======================= ============== + Macro Substitution + ======================= ============== + %s source path (path to the file currently being run) + %S source dir (directory of the file currently being run) + %p same as %S + %{pathsep} path separator + %t temporary file name unique to the test + %T temporary directory unique to the test + %{shared_output(LABEL)} temporary file name, identified by "LABEL", shared across all tests + %% % + ======================= ============== Other substitutions are provided that are variations on this base set and further substitution patterns can be defined by each test module. See the diff --git a/docs/TestingGuide.rst b/docs/TestingGuide.rst index a27da0de4d0..cd1f00b20f9 100644 --- a/docs/TestingGuide.rst +++ b/docs/TestingGuide.rst @@ -464,6 +464,12 @@ RUN lines: Example: ``/home/user/llvm.build/test/MC/ELF/Output`` +``%{shared_output(LABEL)}`` + File path to a temporary file name shared across all tests, identified by + LABEL. This is useful as a cache for generated resources. + + Example: ``/home/user/llvm.build/test/Output/Shared/LABEL.tmp`` + ``%{pathsep}`` Expands to the path separator, i.e. ``:`` (or ``;`` on Windows). diff --git a/utils/lit/lit/TestRunner.py b/utils/lit/lit/TestRunner.py index b874f9ee61b..6680bd0312c 100644 --- a/utils/lit/lit/TestRunner.py +++ b/utils/lit/lit/TestRunner.py @@ -829,6 +829,9 @@ def getDefaultSubstitutions(test, tmpDir, tmpBase, normalize_slashes=False): sourcepath = test.getSourcePath() sourcedir = os.path.dirname(sourcepath) + sharedOutputDir = os.path.join(test.suite.exec_root, 'Output', 'Shared') + sharedOutputDir += os.path.sep + # Normalize slashes, if requested. if normalize_slashes: sourcepath = sourcepath.replace('\\', '/') @@ -849,6 +852,8 @@ def getDefaultSubstitutions(test, tmpDir, tmpBase, normalize_slashes=False): ('%t', tmpName), ('%basename_t', baseName), ('%T', tmpDir), + ('%{shared_output\(([-+=._a-zA-Z0-9]+)\)}', + '%s\\1.tmp' % (sharedOutputDir,)), ('#_MARKER_#', '%')]) # "%/[STpst]" should be normalized. diff --git a/utils/lit/lit/run.py b/utils/lit/lit/run.py index a4a21234fa3..92dfed97d75 100644 --- a/utils/lit/lit/run.py +++ b/utils/lit/lit/run.py @@ -1,4 +1,5 @@ import os +import shutil import sys import threading import time @@ -136,6 +137,13 @@ class Run(object): return True win32api.SetConsoleCtrlHandler(console_ctrl_handler, True) + # Make fresh shared output directories. + suites = set(test.suite for test in self.tests) + for suite in suites: + shared_dir = os.path.join(suite.exec_root, 'Output', 'Shared') + shutil.rmtree(shared_dir, ignore_errors=True) + lit.util.mkdir_p(shared_dir) + # Save the display object on the runner so that we can update it from # our task completion callback. self.display = display diff --git a/utils/lit/tests/Inputs/shared-output/lit.cfg b/utils/lit/tests/Inputs/shared-output/lit.cfg new file mode 100644 index 00000000000..121bff7ec98 --- /dev/null +++ b/utils/lit/tests/Inputs/shared-output/lit.cfg @@ -0,0 +1,5 @@ +import lit.formats +config.name = 'shared-output' +config.suffixes = ['.txt'] +config.test_format = lit.formats.ShTest() +config.test_source_root = os.path.dirname(os.path.realpath(__file__)) diff --git a/utils/lit/tests/Inputs/shared-output/primary.txt b/utils/lit/tests/Inputs/shared-output/primary.txt new file mode 100644 index 00000000000..7da1deeaea6 --- /dev/null +++ b/utils/lit/tests/Inputs/shared-output/primary.txt @@ -0,0 +1,2 @@ +RUN: echo "primary" >> %{shared_output(SHARED)} +RUN: echo "other" >> %{shared_output(OTHER)} diff --git a/utils/lit/tests/Inputs/shared-output/secondary.txt b/utils/lit/tests/Inputs/shared-output/secondary.txt new file mode 100644 index 00000000000..c706a597eca --- /dev/null +++ b/utils/lit/tests/Inputs/shared-output/secondary.txt @@ -0,0 +1 @@ +RUN: echo "secondary" >> %{shared_output(SHARED)} diff --git a/utils/lit/tests/Inputs/shared-output/sub/sub.txt b/utils/lit/tests/Inputs/shared-output/sub/sub.txt new file mode 100644 index 00000000000..4418b348723 --- /dev/null +++ b/utils/lit/tests/Inputs/shared-output/sub/sub.txt @@ -0,0 +1 @@ +RUN: echo "sub" >> %{shared_output(SHARED)} diff --git a/utils/lit/tests/shared-output.py b/utils/lit/tests/shared-output.py new file mode 100644 index 00000000000..9f616f27810 --- /dev/null +++ b/utils/lit/tests/shared-output.py @@ -0,0 +1,13 @@ +# RUN: rm -rf %t && mkdir -p %t +# RUN: echo 'lit_config.load_config(config, "%{inputs}/shared-output/lit.cfg")' > %t/lit.site.cfg +# RUN: %{lit} %t +# RUN: FileCheck %s < %t/Output/Shared/SHARED.tmp +# RUN: FileCheck -check-prefix=NEGATIVE %s < %t/Output/Shared/SHARED.tmp +# RUN: FileCheck -check-prefix=OTHER %s < %t/Output/Shared/OTHER.tmp + +# CHECK-DAG: primary +# CHECK-DAG: secondary +# CHECK-DAG: sub + +# NEGATIVE-NOT: other +# OTHER: other