Files
org-vim/runtime/syntax/Makefile
Aliaksei Budavei dbd924f6a0 runtime(syntax-tests): Fail when executable syntax tests are found
The input files with syntax test cases are never compiled or
interpreted on behalf of test runners, just read, and their
parts are rendered in accordance with syntax definitions for
associated languages, to be compared with previously vetted
renderings.  Whether their arbitrary contents will be valid
programs, benign programs, etc., is left for test authors to
decide and verify in their own environments.  As executable
and non-executable files equally qualify for testing and yet
executability is never exercised, and since maintaining
executable files turns out to be a short-lived exception
than common practice, let us persist in keeping syntax files
non-executable and enforce it with a CI check.

closes: #19433

Co-authored-by: Christian Brabandt <cb@256bit.org>
Signed-off-by: Aliaksei Budavei <0x000c70@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
2026-02-18 18:35:26 +00:00

86 lines
2.9 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 ruler 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 executables 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 ruler 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
executables:
@! find testdir/input -type f -perm /a+x -exec echo Executable syntax test found: \{\} \; | grep :
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