[all-commits] [llvm/llvm-project] 51ca23: [lit] Fix substitutions containing backslashes (#1...

[Martin Storsjö via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 51ca2354d0a4083b9219df131ceff98bccb622b4
      https://github.com/llvm/llvm-project/commit/51ca2354d0a4083b9219df131ceff98bccb622b4
  Author: Martin Storsjö <martin at martin.st>
  Date:   2024-08-22 (Thu, 22 Aug 2024)

  Changed paths:
    M llvm/docs/TestingGuide.rst
    M llvm/utils/lit/lit/TestRunner.py
    M llvm/utils/lit/tests/Inputs/shtest-define/lit.cfg
    M llvm/utils/lit/tests/Inputs/shtest-define/value-escaped.txt

  Log Message:
  -----------
  [lit] Fix substitutions containing backslashes (#103042)

Substitutions can be added in a couple different ways; they can be added
via the calling python scripts by adding entries to the
config.substitutions dictionary, or via DEFINE lines in the scripts
themselves.

The substitution strings passed to Python's re classes are interpreted
so that backslashes expand to escape sequences, and literal backslashes
need to be escaped.

On Unix, the script defined substitutions don't (usually, so far)
contain backslashes - but on Windows, they often do, due to paths
containing backslashes. This lead to a Windows specific escaping of
backslashes before doing Python re substitutions - since
7c9eab8fef0ed79a5911d21eb97b6b0fa9d39f82. There's nothing inherently
Windows specific about this though - any intended literal backslashes in
the substitution strings need to be escaped; this is how the Python re
API works.

The DEFINE lines were added later, and in order to cope with
backslashes, escaping of backslashes was added in the SubstDirective
class in TestRunner, applying to DEFINE lines in the tests only.

The fact that the escaping right before passing to the Python re API was
done conditionally on Windows led to two inconsistencies:

- DEFINE lines in the tests that contain backslashes got double
backslashes on Windows. (This was visible as a FIXME in
llvm/utils/lit/tests/Inputs/shtest-define/value-escaped.txt.)

- Script provided substitutions containing backslashes did not work on
Unix, but they did work on Windows.

By removing the escaping from SubstDirective and escaping it
unconditionally in the processLine function, before feeding the
substitutions to Python's re classes, we should have consistent
behaviour across platforms, and get rid of the FIXME in the lit test.

This fixes issues with substitutions containing backslashes on Unix
platforms, as encountered in PR #86649.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications