mirror of
https://github.com/apple/swift.git
synced 2026-11-06 00:14:32 +01:00
Henrik G. Olsson
f0946d8ed5
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.
60 lines
2.1 KiB
Python
60 lines
2.1 KiB
Python
import os
|
|
from swift_path_sanitize import reference_path, output_path, temp_dir_from_args
|
|
from lit_support.split_file import propagate_split_files
|
|
|
|
"""
|
|
This file provides the `psd_lit_plugin` function, which is invoked on failed RUN
|
|
lines when lit is executed with --update-tests.
|
|
It checks whether the failed command is a PathSanitizingDiff invocation and, if
|
|
so, repairs the test by replacing the reference file with the sanitized program
|
|
output. PathSanitizingDiff writes its sanitized input to an output file in the
|
|
per-test temporary namespace (see PathSanitizingDiff and
|
|
swift_path_sanitize.output_path); this plugin reads that output, overwrites the
|
|
reference file, and, if the reference file originated from `split-file`,
|
|
propagates the new content into the corresponding slice of the test file.
|
|
"""
|
|
|
|
|
|
def repair_test(test_path, reference, output, commands):
|
|
"""
|
|
Repair a PathSanitizingDiff test using the sanitized output previously
|
|
written to `output`. Overwrites `reference` with the output content and,
|
|
if `reference` came from `split-file`, propagates the content into the
|
|
matching slice of `test_path`.
|
|
|
|
Returns (error_string, None) on failure.
|
|
Returns (None, message_string) on success.
|
|
"""
|
|
if not os.path.exists(output):
|
|
return (
|
|
"update-pathsanitizing-diff-test: expected sanitized output at "
|
|
f"{output} but it was not found",
|
|
None,
|
|
)
|
|
|
|
with open(output, "r") as f:
|
|
content = f.read()
|
|
with open(reference, "w") as f:
|
|
f.write(content)
|
|
|
|
updated_files = propagate_split_files(test_path, [reference], commands)
|
|
return (
|
|
None,
|
|
f"update-pathsanitizing-diff-test: updated {updated_files[0]}",
|
|
)
|
|
|
|
|
|
def psd_lit_plugin(result, test, commands):
|
|
args = result.command.args
|
|
if not any(arg.endswith("PathSanitizingDiff") for arg in args):
|
|
return None
|
|
|
|
reference = reference_path(args)
|
|
temp_dir = temp_dir_from_args(args)
|
|
if reference is None or temp_dir is None:
|
|
return None
|
|
|
|
output = output_path(temp_dir, reference)
|
|
err, msg = repair_test(test.getFilePath(), reference, output, commands)
|
|
return err or msg
|