[lit, python] Always add quotes around the python path in lit

[stella.stamenova]

Summary

The issue with the python path is that the path to python on Windows can contain spaces. To make the tests always work, the path to python needs to be surrounded by quotes.

This change updates several configuration files which specify the path to python as a substitution and also remove quotes from existing tests.

[zturner]

Should the substitution just be surrounded by quotes automatically so we
don’t have this problem?

[stella.stamenova]

I looked at doing this in a generic way when we first encountered it and I couldn't find a good way of doing it partially because configuration files (such as lit.cfg in this changeset) can override the substitutions.

A couple of things we can do:

1. Update the cfg files as much as possible rather than the test themselves
2. Update config.py (where we define the default substitusions for tools) to use quotes as well.

One of the problems I originally ran into was that when the tool has inputs, putting quotes around the tool AND the input caused more problems. I think 2) will avoid that, but it's still not entirely generic and some tests might need individual fixes.

Let me know if you'd prefer that I try to update config.py as well.

[alexander-shaposhnikov]

Thanks!

utils/lit/tests/boolean-parsing.py

 # Test the boolean expression parser
 # used for REQUIRES and UNSUPPORTED and XFAIL
 
-# RUN: %{python} -m lit.BooleanExpression
+# RUN: '%{python}' -m lit.BooleanExpression

utils/lit/tests/discovery.py

 # CHECK-BASIC-OUT: -- Available Tests --
 # CHECK-BASIC-OUT: sub-suite :: test-one
 # CHECK-BASIC-OUT: sub-suite :: test-two
 # CHECK-BASIC-OUT: top-level-suite :: subdir/test-three
 # CHECK-BASIC-OUT: top-level-suite :: test-one
 # CHECK-BASIC-OUT: top-level-suite :: test-two
 
 # Check discovery when providing the special builtin 'config_map'
-# RUN: %{python} %{inputs}/config-map-discovery/driver.py \
+# RUN: '%{python}' %{inputs}/config-map-discovery/driver.py \
 # RUN:           %{inputs}/config-map-discovery/main-config/lit.cfg \
 # RUN:           %{inputs}/config-map-discovery/lit.alt.cfg \
 # RUN:           --single-process --debug --show-tests --show-suites > %t.out 2> %t.err
 # RUN: FileCheck --check-prefix=CHECK-CONFIG-MAP-OUT < %t.out %s
 # RUN: FileCheck --check-prefix=CHECK-CONFIG-MAP-ERR < %t.err %s
 
 # CHECK-CONFIG-MAP-OUT-NOT: ERROR: lit.cfg invoked
 # CHECK-CONFIG-MAP-OUT: -- Test Suites --

utils/lit/tests/lit.cfg

if llvm_src_root != None:
   lit_path = os.path.join(llvm_src_root, 'utils', 'lit')
 else:
   lit_path = src_root
 
 config.environment['PYTHONPATH'] = lit_path # Required because some tests import the lit module
 config.substitutions.append(('%{src_root}', src_root))
 config.substitutions.append(('%{inputs}', os.path.join(
             src_root, 'tests', 'Inputs')))
-config.substitutions.append(('%{lit}', "%%{python} %s" % (
+config.substitutions.append(('%{lit}', "\'%%{python}\' %s" % (
             os.path.join(lit_path, 'lit.py'),)))
 config.substitutions.append(('%{python}', sys.executable))
 
 # Enable coverage.py reporting, assuming the coverage module has been installed
 # and sitecustomize.py in the virtualenv has been modified appropriately.
 if lit_config.params.get('check-coverage', None):
     config.environment['COVERAGE_PROCESS_START'] = os.path.join(
         os.path.dirname(__file__), ".coveragerc")

utils/lit/tests/shell-parsing.py

 # Just run the ShUtil unit tests.
 #
-# RUN: %{python} -m lit.ShUtil
+# RUN: '%{python}' -m lit.ShUtil

utils/lit/tests/unittest-adaptor.py

 # Check the lit adaption to run under unittest.
 #
-# RUN: %{python} %s %{inputs}/unittest-adaptor 2> %t.err
+# RUN: '%{python}' %s %{inputs}/unittest-adaptor 2> %t.err
 # RUN: FileCheck < %t.err %s
 #
 # CHECK-DAG: unittest-adaptor :: test-two.txt ... FAIL
 # CHECK-DAG: unittest-adaptor :: test-one.txt ... ok
 
 import unittest
 import sys
 
 import lit
 import lit.discovery
 
 input_path = sys.argv[1]
 unittest_suite = lit.discovery.load_test_suite([input_path])
 runner = unittest.TextTestRunner(verbosity=2)
 runner.run(unittest_suite)