Files
swift-mirror/utils/PathSanitizingFileCheck
Henrik G. Olsson f0946d8ed5 [Utils] Add PathSanitizingDiff sharing internals with PathSanitizingFileCheck
Extract the path-sanitization core (path normalization, shared argument
definitions, replacement loop, and runtime-warning suppression) into a
new swift_path_sanitize module so that both PathSanitizingFileCheck and
a new PathSanitizingDiff front-end can share it.

PathSanitizingDiff sanitizes stdin the same way and then compares the
result against a reference file using diff, collapsing the
`PathSanitizingFileCheck --dry-run > out; diff out expected` pattern
into a single step (exposed as the %PathSanitizingDiff lit
substitution). Similar to PathSanitizingFileCheck, PathSanitizingDiff
takes input on stdin, a positional file argument (which is the reference
file, instead of file to check for CHECK directives), and various
sanitize options.

Like diff, PathSanitizingDiff tests can be automatically updated to
match the current behavior using lit's `--update-tests`, thanks to the
accompanying lit plugin.

Migrates a swiftify-import test to demonstrate the new form.
2026-07-21 23:22:32 -07:00

72 lines
2.0 KiB
Python
Executable File

#!/usr/bin/env python3
# utils/PathSanitizingFileCheck -*- python -*-
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
import argparse
import io
import subprocess
import sys
import swift_path_sanitize
def main():
parser = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter,
description="""
PathSanitizingFileCheck is a wrapper around LLVM's FileCheck. In addition
to all FileCheck features, PathSanitizingFileCheck can replace given
strings in the input with other strings. This feature is used to replace
paths to the source and build directories with path-independent
constants.""",
)
swift_path_sanitize.add_shared_arguments(parser)
parser.add_argument(
"--use-filecheck",
help="path to LLVM FileCheck executable",
metavar="PATH",
action="store",
dest="file_check_path",
default="FileCheck",
)
parser.add_argument(
"--dry-run",
help="Apply the replacements to the input and print the result "
"to standard output",
action="store_true",
)
args, unknown_args = parser.parse_known_args()
stdin = io.open(sys.stdin.fileno(), "r", encoding="utf-8", errors="ignore").read()
stdin = swift_path_sanitize.sanitize(stdin, args)
if args.dry_run:
print(stdin)
return 0
else:
p = subprocess.Popen(
[args.file_check_path] + unknown_args, stdin=subprocess.PIPE
)
stdout, stderr = p.communicate(stdin.encode("utf-8"))
if stdout is not None:
print(stdout)
if stderr is not None:
print(stderr, file=sys.stderr)
return p.wait()
if __name__ == "__main__":
exit(main())