mirror of
https://github.com/vim/vim.git
synced 2025-07-26 11:04:33 -04:00
0fde6aebdd
As reported in #16559, bytes of a multibyte character may be written as separate U+FFFD characters in a ":terminal" window on a busy machine. The testing facilities currently offer an optional filtering step to be carried out between reading and comparing the contents of two screendump files for each such file. This filtering has been resorted to (#14767 and #16560) in an attempt to unconditionally replace known non-Latin-1 characters with an arbitrary substitute ASCII character and avoid this rendering mishap leading to syntax tests failures. However, it has been overlooked at the time that metadata description (in shorthand) to follow spurious U+FFFD characters may be *distinct* and make the remainder of such a line, ASCII characters and whatnot, also unequal between compared screendump files. While it is straightforward to adapt current filter files to ignore the line characters after the leftmost U+FFFD, > It is challenging and error-prone to keep up to date filter > files because moving around examples in source files will > likely make redundant some previously required filter files > and, at the same time, it may require creating new filter > files for the same source file; substituting one multibyte > character for another multibyte character will also demand > a coordinated change for filter files. Besides, unconditionally dropping arbitrary parts of a line is rather too blunt an instrument. An alternative approach is to not use the supported filtering for this purpose; let a syntax test pass or fail initially; then *if* the same failure is imminent, drop the leftmost U+FFFD and the rest of the previously seen line (repeating it for all previously seen unequal lines) before another round of file contents comparing. The obvious disadvantage with this filtering, unconditional and otherwise, is that if there are consistent failures for _other reasons_ and the unequal parts happen to be after U+FFFDs, then spurious test passing can happen when stars align for _a particular test runner_. Hence syntax test authors should strive to write as little significant text after multibyte characters as syntactically permissible, write multibyte characters closer to EOL in general, and make sure that their checked-in and published "*.dump" files do not have any U+FFFDs. It is also practical to refrain from attempting screendump generation if U+FFFDs can already be discovered, and instead try re-running from scratch the syntax test in hand, while accepting other recently generated screendumps without going through with new rounds of verification. Reference: https://github.com/vim/vim/pull/16470#issuecomment-2599848525 closes: #17704 Signed-off-by: Aliaksei Budavei <0x000c70@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
83 lines
2.8 KiB
Makefile
83 lines
2.8 KiB
Makefile
# Portable Makefile for running syntax tests.
|
|
|
|
# To run the test manually:
|
|
# ../../src/vim -u 'testdir/runtest.vim' --cmd 'breakadd func RunTest'
|
|
|
|
# Override this if needed, the default assumes Vim was built in the src dir.
|
|
#VIMPROG = vim
|
|
VIMPROG = ../../src/vim
|
|
|
|
# "runtime" relative to "runtime/syntax/testdir"
|
|
VIMRUNTIME = ../..
|
|
|
|
# Uncomment this line to use valgrind for memory leaks and extra warnings.
|
|
# VALGRIND = valgrind --tool=memcheck --leak-check=yes --num-callers=45 --log-file=valgrind.$*
|
|
|
|
# Trace liveness on demand.
|
|
# VIM_SYNTAX_TEST_LOG = `pwd`/testdir/failed/00-TRACE_LOG
|
|
|
|
# ENVVARS = LC_ALL=C VIM_SYNTAX_TEST_LOG="$(VIM_SYNTAX_TEST_LOG)"
|
|
# ENVVARS = LC_ALL=C LANG=C LANGUAGE=C
|
|
# Run the syntax tests with a C locale
|
|
ENVVARS = LC_ALL=C
|
|
|
|
RUN_VIMTEST = VIMRUNTIME=$(VIMRUNTIME) $(VALGRIND) $(ENVVARS) ../$(VIMPROG) -f $(GUI_FLAG)
|
|
|
|
# Uncomment this line for debugging
|
|
# DEBUGLOG = --log testlog
|
|
|
|
# All initial phony targets; these names may clash with file types.
|
|
phonies = clean test testclean
|
|
.PHONY: $(phonies)
|
|
|
|
# Run the tests that didn't run yet or failed previously.
|
|
# If a test succeeds a testdir/done/{name} file will be written.
|
|
# If a test fails a testdir/failed/{name}.dump file will be written.
|
|
# Progress and error messages can be found in "testdir/messages".
|
|
# Comment out the "> /dev/null" part to see the in-progress Vim behaviors.
|
|
test:
|
|
@# the "vimcmd" file is used by the screendump utils
|
|
@echo "../$(VIMPROG)" > testdir/vimcmd
|
|
@echo "$(RUN_VIMTEST)" >> testdir/vimcmd
|
|
@# Trace liveness on demand.
|
|
@#mkdir -p testdir/failed
|
|
@#touch "$(VIM_SYNTAX_TEST_LOG)"
|
|
VIMRUNTIME=$(VIMRUNTIME) $(ENVVARS) $(VIMPROG) --clean --not-a-term $(DEBUGLOG) -u testdir/runtest.vim > /dev/null
|
|
@# FIXME: Temporarily show the whole file to find out what goes wrong
|
|
@#if [ -f testdir/messages ]; then tail -n 6 testdir/messages; fi
|
|
@if [ -f testdir/messages ]; then cat testdir/messages; fi
|
|
|
|
# add dependence on syntax files
|
|
testdir/testdeps.mk:
|
|
./testdir/tools/maketestdeps $(phonies) > $@
|
|
|
|
-include testdir/testdeps.mk
|
|
|
|
clean testclean:
|
|
rm -f testdir/failed/* testdir/done/* testdir/vimcmd testdir/messages testdir/Xtestscript testdir/Xfilter testdir/testdeps.mk
|
|
|
|
# Collect all input filenames and their file types.
|
|
testnames != set +f; \
|
|
awk 'BEGIN { \
|
|
for (i = 1; i < ARGC; i++) { \
|
|
split(ARGV[i], names, /\//); \
|
|
split(names[3], parts, /[._]/); \
|
|
types[parts[1]]; \
|
|
print names[3]; \
|
|
} \
|
|
delete types["vim9"]; \
|
|
split("$(phonies)", scratch); \
|
|
for (phony in scratch) \
|
|
phonies[scratch[phony]]; \
|
|
for (type in types) \
|
|
print type ((type in phonies) ? "_" : ""); \
|
|
}' testdir/input/*.*
|
|
|
|
.PHONY: self-testing $(testnames)
|
|
|
|
$(testnames)::
|
|
@echo $@ >> testdir/Xfilter
|
|
|
|
self-testing:: $(testnames)
|
|
@echo self-testing > testdir/Xfilter
|