lit.py: Add new %{shared_output(LABEL)} substitution

[jordan_rose]

Summary

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.

Extracting out the simple, substitution-only part of D38010.

[jordan_rose]

Remove debugging prints.

[• ddunbar]

LGTM, thanks!

[jordan_rose]

Committed in rL315697.

docs/CommandGuide/lit.rst

 suffixes which identify test files.
 
 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
 modules :ref:`local-configuration-files`.
 
 More detailed information on substitutions can be found in the
 :doc:`../TestingGuide`.
 

docs/TestingGuide.rst

``%t``
 
    Example: ``/home/user/llvm.build/test/MC/ELF/Output/foo_test.s.tmp``
 
 ``%T``
    Directory of ``%t``.
 
    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).
 
 ``%/s, %/S, %/t, %/T:``
 
   Act like the corresponding substitution above but replace any ``\``
   character with a ``/``. This is useful to normalize path separators.

utils/lit/lit/TestRunner.py

def getTempPaths(test):
     tmpDir = os.path.join(execdir, 'Output')
     tmpBase = os.path.join(tmpDir, execbase)
     return tmpDir, tmpBase
 
 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('\\', '/')
         sourcedir = sourcedir.replace('\\', '/')
         tmpDir = tmpDir.replace('\\', '/')
         tmpBase = tmpBase.replace('\\', '/')
 
     # We use #_MARKER_# to hide %% while we do the other substitutions.
     substitutions = []
     substitutions.extend([('%%', '#_MARKER_#')])
     substitutions.extend(test.config.substitutions)
     tmpName = tmpBase + '.tmp'
     baseName = os.path.basename(tmpBase)
     substitutions.extend([('%s', sourcepath),
                           ('%S', sourcedir),
                           ('%p', sourcedir),
                           ('%{pathsep}', os.pathsep),
                           ('%t', tmpName),
                           ('%basename_t', baseName),
                           ('%T', tmpDir),
+                          ('%{shared_output\(([-+=._a-zA-Z0-9]+)\)}',
+                           '%s\\1.tmp' % (sharedOutputDir,)),
                           ('#_MARKER_#', '%')])
 
     # "%/[STpst]" should be normalized.
     substitutions.extend([
             ('%/s', sourcepath.replace('\\', '/')),
             ('%/S', sourcedir.replace('\\', '/')),
             ('%/p', sourcedir.replace('\\', '/')),
             ('%/t', tmpBase.replace('\\', '/') + '.tmp'),

utils/lit/lit/run.py

 import os
+import shutil
 import sys
 import threading
 import time
 import traceback
 try:
     import Queue as queue
 except ImportError:
     import queue
def execute_tests(self, display, jobs, max_time=None):
             def console_ctrl_handler(type):
                 print('\nCtrl-C detected, terminating.')
                 pool.terminate()
                 pool.join()
                 abort_now()
                 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
 
         self.failure_count = 0
         self.hit_max_failures = False
         if self.lit_config.singleProcess:
             global child_lit_config

utils/lit/tests/Inputs/shared-output/lit.cfg

+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__))
+

utils/lit/tests/Inputs/shared-output/primary.txt

+RUN: echo "primary" >> %{shared_output(SHARED)}
+RUN: echo "other" >> %{shared_output(OTHER)}

utils/lit/tests/Inputs/shared-output/secondary.txt

+RUN: echo "secondary" >> %{shared_output(SHARED)}

utils/lit/tests/Inputs/shared-output/sub/sub.txt

+RUN: echo "sub" >> %{shared_output(SHARED)}

utils/lit/tests/shared-output.py

+# 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