Makefile revision 1.187
1# $NetBSD: Makefile,v 1.187 2020/11/03 17:17:31 rillig Exp $
2#
3# Unit tests for make(1)
4#
5# The main targets are:
6#
7# all:
8#	run all the tests
9# test:
10#	run 'all', and compare to expected results
11# accept:
12#	move generated output to expected results
13#
14# Settable variables
15#
16# TEST_MAKE
17#	The make program to be tested.
18#
19#
20# Adding a test case
21#
22# Each feature should get its own set of tests in its own suitably
23# named makefile (*.mk), with its own set of expected results (*.exp),
24# and it should be added to the TESTS list.
25#
26# Any added files must also be added to src/distrib/sets/lists/tests/mi.
27# To do that, just run "make sync-mi" in this directory.
28#
29# A few *.mk files are helper files for other tests (such as include-sub.mk)
30# and are thus not added to TESTS.  Such files must be ignored in
31# src/tests/usr.bin/make/t_make.sh.
32#
33
34# Each test is in a sub-makefile.
35# Keep the list sorted.
36# Any test that is commented out must be ignored in
37# src/tests/usr.bin/make/t_make.sh as well.
38TESTS+=		archive
39TESTS+=		archive-suffix
40TESTS+=		cmd-errors
41TESTS+=		cmd-errors-lint
42TESTS+=		cmd-interrupt
43TESTS+=		cmdline
44TESTS+=		comment
45TESTS+=		cond-cmp-numeric
46TESTS+=		cond-cmp-numeric-eq
47TESTS+=		cond-cmp-numeric-ge
48TESTS+=		cond-cmp-numeric-gt
49TESTS+=		cond-cmp-numeric-le
50TESTS+=		cond-cmp-numeric-lt
51TESTS+=		cond-cmp-numeric-ne
52TESTS+=		cond-cmp-string
53TESTS+=		cond-cmp-unary
54TESTS+=		cond-func
55TESTS+=		cond-func-commands
56TESTS+=		cond-func-defined
57TESTS+=		cond-func-empty
58TESTS+=		cond-func-exists
59TESTS+=		cond-func-make
60TESTS+=		cond-func-target
61TESTS+=		cond-late
62TESTS+=		cond-op
63TESTS+=		cond-op-and
64TESTS+=		cond-op-not
65TESTS+=		cond-op-or
66TESTS+=		cond-op-parentheses
67TESTS+=		cond-short
68TESTS+=		cond-token-number
69TESTS+=		cond-token-plain
70TESTS+=		cond-token-string
71TESTS+=		cond-token-var
72TESTS+=		cond-undef-lint
73TESTS+=		cond1
74TESTS+=		counter
75TESTS+=		counter-append
76TESTS+=		dep
77TESTS+=		dep-colon
78TESTS+=		dep-colon-bug-cross-file
79TESTS+=		dep-double-colon
80TESTS+=		dep-double-colon-indep
81TESTS+=		dep-exclam
82TESTS+=		dep-none
83TESTS+=		dep-percent
84TESTS+=		dep-var
85TESTS+=		dep-wildcards
86TESTS+=		depsrc
87TESTS+=		depsrc-end
88TESTS+=		depsrc-exec
89TESTS+=		depsrc-ignore
90TESTS+=		depsrc-made
91TESTS+=		depsrc-make
92TESTS+=		depsrc-meta
93TESTS+=		depsrc-nometa
94TESTS+=		depsrc-nometa_cmp
95TESTS+=		depsrc-nopath
96TESTS+=		depsrc-notmain
97TESTS+=		depsrc-optional
98TESTS+=		depsrc-phony
99TESTS+=		depsrc-precious
100TESTS+=		depsrc-recursive
101TESTS+=		depsrc-silent
102TESTS+=		depsrc-use
103TESTS+=		depsrc-usebefore
104TESTS+=		depsrc-usebefore-double-colon
105TESTS+=		depsrc-wait
106TESTS+=		deptgt
107TESTS+=		deptgt-begin
108TESTS+=		deptgt-default
109TESTS+=		deptgt-delete_on_error
110TESTS+=		deptgt-end
111TESTS+=		deptgt-end-jobs
112TESTS+=		deptgt-error
113TESTS+=		deptgt-ignore
114TESTS+=		deptgt-interrupt
115TESTS+=		deptgt-main
116TESTS+=		deptgt-makeflags
117TESTS+=		deptgt-no_parallel
118TESTS+=		deptgt-nopath
119TESTS+=		deptgt-notparallel
120TESTS+=		deptgt-objdir
121TESTS+=		deptgt-order
122TESTS+=		deptgt-path
123TESTS+=		deptgt-path-suffix
124TESTS+=		deptgt-phony
125TESTS+=		deptgt-precious
126TESTS+=		deptgt-shell
127TESTS+=		deptgt-silent
128TESTS+=		deptgt-stale
129TESTS+=		deptgt-suffixes
130TESTS+=		dir
131TESTS+=		dir-expand-path
132TESTS+=		directive
133TESTS+=		directive-dinclude
134TESTS+=		directive-elif
135TESTS+=		directive-elifdef
136TESTS+=		directive-elifmake
137TESTS+=		directive-elifndef
138TESTS+=		directive-elifnmake
139TESTS+=		directive-else
140TESTS+=		directive-endif
141TESTS+=		directive-error
142TESTS+=		directive-export
143TESTS+=		directive-export-env
144TESTS+=		directive-export-gmake
145TESTS+=		directive-export-literal
146TESTS+=		directive-for
147TESTS+=		directive-for-generating-endif
148TESTS+=		directive-hyphen-include
149TESTS+=		directive-if
150TESTS+=		directive-ifdef
151TESTS+=		directive-ifmake
152TESTS+=		directive-ifndef
153TESTS+=		directive-ifnmake
154TESTS+=		directive-include
155TESTS+=		directive-include-fatal
156TESTS+=		directive-info
157TESTS+=		directive-sinclude
158TESTS+=		directive-undef
159TESTS+=		directive-unexport
160TESTS+=		directive-unexport-env
161TESTS+=		directive-warning
162TESTS+=		dollar
163TESTS+=		doterror
164TESTS+=		dotwait
165TESTS+=		envfirst
166TESTS+=		error
167TESTS+=		# escape	# broken by reverting POSIX changes
168TESTS+=		export
169TESTS+=		export-all
170TESTS+=		export-env
171TESTS+=		export-variants
172TESTS+=		forloop
173TESTS+=		forsubst
174TESTS+=		hanoi-include
175TESTS+=		impsrc
176TESTS+=		include-main
177TESTS+=		job-output-long-lines
178TESTS+=		lint
179TESTS+=		make-exported
180TESTS+=		moderrs
181TESTS+=		modmatch
182TESTS+=		modmisc
183TESTS+=		modts
184TESTS+=		modword
185TESTS+=		opt
186TESTS+=		opt-backwards
187TESTS+=		opt-chdir
188TESTS+=		opt-debug
189TESTS+=		opt-debug-all
190TESTS+=		opt-debug-archive
191TESTS+=		opt-debug-curdir
192TESTS+=		opt-debug-cond
193TESTS+=		opt-debug-dir
194TESTS+=		opt-debug-errors
195TESTS+=		opt-debug-file
196TESTS+=		opt-debug-for
197TESTS+=		opt-debug-graph1
198TESTS+=		opt-debug-graph2
199TESTS+=		opt-debug-graph3
200TESTS+=		opt-debug-hash
201TESTS+=		opt-debug-jobs
202TESTS+=		opt-debug-lint
203TESTS+=		opt-debug-loud
204TESTS+=		opt-debug-meta
205TESTS+=		opt-debug-making
206TESTS+=		opt-debug-no-rm
207TESTS+=		opt-debug-parse
208TESTS+=		opt-debug-suff
209TESTS+=		opt-debug-targets
210TESTS+=		opt-debug-varraw
211TESTS+=		opt-debug-var
212TESTS+=		opt-debug-x-trace
213TESTS+=		opt-define
214TESTS+=		opt-env
215TESTS+=		opt-file
216TESTS+=		opt-ignore
217TESTS+=		opt-include-dir
218TESTS+=		opt-jobs
219TESTS+=		opt-jobs-internal
220TESTS+=		opt-keep-going
221TESTS+=		opt-m-include-dir
222TESTS+=		opt-no-action
223TESTS+=		opt-no-action-at-all
224TESTS+=		opt-query
225TESTS+=		opt-raw
226TESTS+=		opt-silent
227TESTS+=		opt-touch
228TESTS+=		opt-tracefile
229TESTS+=		opt-var-expanded
230TESTS+=		opt-var-literal
231TESTS+=		opt-warnings-as-errors
232TESTS+=		opt-where-am-i
233TESTS+=		opt-x-reduce-exported
234TESTS+=		order
235TESTS+=		parse-var
236TESTS+=		phony-end
237TESTS+=		posix
238TESTS+=		# posix1	# broken by reverting POSIX changes
239TESTS+=		qequals
240TESTS+=		recursive
241TESTS+=		sh
242TESTS+=		sh-dots
243TESTS+=		sh-jobs
244TESTS+=		sh-jobs-error
245TESTS+=		sh-leading-at
246TESTS+=		sh-leading-hyphen
247TESTS+=		sh-leading-plus
248TESTS+=		sh-meta-chars
249TESTS+=		sh-multi-line
250TESTS+=		sh-single-line
251TESTS+=		shell-csh
252TESTS+=		shell-custom
253TESTS+=		shell-ksh
254TESTS+=		shell-sh
255TESTS+=		suff-add-later
256TESTS+=		suff-clear-regular
257TESTS+=		suff-clear-single
258TESTS+=		suff-lookup
259TESTS+=		suff-main
260TESTS+=		suff-rebuild
261TESTS+=		suff-transform-endless
262TESTS+=		suff-transform-expand
263TESTS+=		suff-transform-select
264TESTS+=		sunshcmd
265TESTS+=		ternary
266TESTS+=		unexport
267TESTS+=		unexport-env
268TESTS+=		use-inference
269TESTS+=		var-class
270TESTS+=		var-class-cmdline
271TESTS+=		var-class-env
272TESTS+=		var-class-global
273TESTS+=		var-class-local
274TESTS+=		var-class-local-legacy
275TESTS+=		var-op
276TESTS+=		var-op-append
277TESTS+=		var-op-assign
278TESTS+=		var-op-default
279TESTS+=		var-op-expand
280TESTS+=		var-op-shell
281TESTS+=		var-op-sunsh
282TESTS+=		var-recursive
283TESTS+=		varcmd
284TESTS+=		vardebug
285TESTS+=		varfind
286TESTS+=		varmisc
287TESTS+=		varmod
288TESTS+=		varmod-assign
289TESTS+=		varmod-defined
290TESTS+=		varmod-edge
291TESTS+=		varmod-exclam-shell
292TESTS+=		varmod-extension
293TESTS+=		varmod-gmtime
294TESTS+=		varmod-hash
295TESTS+=		varmod-head
296TESTS+=		varmod-ifelse
297TESTS+=		varmod-l-name-to-value
298TESTS+=		varmod-localtime
299TESTS+=		varmod-loop
300TESTS+=		varmod-match
301TESTS+=		varmod-match-escape
302TESTS+=		varmod-no-match
303TESTS+=		varmod-order
304TESTS+=		varmod-order-reverse
305TESTS+=		varmod-order-shuffle
306TESTS+=		varmod-path
307TESTS+=		varmod-quote
308TESTS+=		varmod-quote-dollar
309TESTS+=		varmod-range
310TESTS+=		varmod-remember
311TESTS+=		varmod-root
312TESTS+=		varmod-select-words
313TESTS+=		varmod-shell
314TESTS+=		varmod-subst
315TESTS+=		varmod-subst-regex
316TESTS+=		varmod-sysv
317TESTS+=		varmod-tail
318TESTS+=		varmod-to-abs
319TESTS+=		varmod-to-lower
320TESTS+=		varmod-to-many-words
321TESTS+=		varmod-to-one-word
322TESTS+=		varmod-to-separator
323TESTS+=		varmod-to-upper
324TESTS+=		varmod-undefined
325TESTS+=		varmod-unique
326TESTS+=		varname
327TESTS+=		varname-dollar
328TESTS+=		varname-dot-alltargets
329TESTS+=		varname-dot-curdir
330TESTS+=		varname-dot-includes
331TESTS+=		varname-dot-includedfromdir
332TESTS+=		varname-dot-includedfromfile
333TESTS+=		varname-dot-libs
334TESTS+=		varname-dot-make-dependfile
335TESTS+=		varname-dot-make-expand_variables
336TESTS+=		varname-dot-make-exported
337TESTS+=		varname-dot-make-jobs
338TESTS+=		varname-dot-make-jobs-prefix
339TESTS+=		varname-dot-make-level
340TESTS+=		varname-dot-make-makefile_preference
341TESTS+=		varname-dot-make-makefiles
342TESTS+=		varname-dot-make-meta-bailiwick
343TESTS+=		varname-dot-make-meta-created
344TESTS+=		varname-dot-make-meta-files
345TESTS+=		varname-dot-make-meta-ignore_filter
346TESTS+=		varname-dot-make-meta-ignore_paths
347TESTS+=		varname-dot-make-meta-ignore_patterns
348TESTS+=		varname-dot-make-meta-prefix
349TESTS+=		varname-dot-make-mode
350TESTS+=		varname-dot-make-path_filemon
351TESTS+=		varname-dot-make-pid
352TESTS+=		varname-dot-make-ppid
353TESTS+=		varname-dot-make-save_dollars
354TESTS+=		varname-dot-makeoverrides
355TESTS+=		varname-dot-newline
356TESTS+=		varname-dot-objdir
357TESTS+=		varname-dot-parsedir
358TESTS+=		varname-dot-parsefile
359TESTS+=		varname-dot-path
360TESTS+=		varname-dot-shell
361TESTS+=		varname-dot-targets
362TESTS+=		varname-empty
363TESTS+=		varname-make
364TESTS+=		varname-make_print_var_on_error
365TESTS+=		varname-make_print_var_on_error-jobs
366TESTS+=		varname-makefile
367TESTS+=		varname-makeflags
368TESTS+=		varname-pwd
369TESTS+=		varname-vpath
370TESTS+=		varparse-dynamic
371TESTS+=		varparse-mod
372TESTS+=		varparse-undef-partial
373TESTS+=		varquote
374TESTS+=		varshell
375
376# Additional environment variables for some of the tests.
377# The base environment is -i PATH="$PATH".
378ENV.envfirst=		FROM_ENV=value-from-env
379ENV.varmisc=		FROM_ENV=env
380ENV.varmisc+=		FROM_ENV_BEFORE=env
381ENV.varmisc+=		FROM_ENV_AFTER=env
382ENV.varmod-localtime+=	TZ=Europe/Berlin
383
384# Override make flags for some of the tests; default is -k.
385# If possible, write ".MAKEFLAGS: -dv" in the test .mk file instead of
386# settings FLAGS.test=-dv here, since that is closer to the test code.
387FLAGS.cond-func-make=	via-cmdline
388FLAGS.directive-ifmake=	first second
389FLAGS.doterror=		# none
390FLAGS.envfirst=		-e
391FLAGS.export=		# none
392FLAGS.opt-ignore=	-i
393FLAGS.opt-keep-going=	-k
394FLAGS.opt-no-action=	-n
395FLAGS.opt-query=	-q
396FLAGS.opt-var-expanded=	-v VAR -v VALUE
397FLAGS.opt-var-literal=	-V VAR -V VALUE
398FLAGS.opt-warnings-as-errors= -W
399FLAGS.order=		-j1
400FLAGS.recursive=	-dL
401FLAGS.sh-leading-plus=	-n
402FLAGS.varname-empty=	-dv '$${:U}=cmdline-u' '=cmline-plain'
403
404# Some tests need extra postprocessing.
405SED_CMDS.job-output-long-lines= \
406	${:D Job separators on their own line are ok. } \
407	-e '/^--- job-[ab] ---$$/d' \
408	${:D Plain output lines are ok as well. } \
409	${:D They may come in multiples of 1024 or as 10000. } \
410	-e '/^aa*$$/d' \
411	-e '/^bb*$$/d' \
412	${:D The following lines should rather not occur since the job } \
413	${:D marker should always be at the beginning of the line. } \
414	-e '/^aa*--- job-b ---$$/d' \
415	-e '/^bb*--- job-a ---$$/d'
416SED_CMDS.opt-debug-graph1= \
417			-e 's,${.CURDIR},CURDIR,'
418SED_CMDS.opt-debug-graph1+= \
419			-e '/Global Variables:/,/Suffixes:/d'
420SED_CMDS.sh-dots=	-e 's,^.*\.\.\.:.*,<normalized: ...: not found>,'
421SED_CMDS.opt-debug-jobs=	-e 's,([0-9][0-9]*),(<pid>),'
422SED_CMDS.opt-debug-jobs+=	-e 's,pid [0-9][0-9]*,pid <pid>,'
423SED_CMDS.opt-debug-jobs+=	-e 's,Process [0-9][0-9]*,Process <pid>,'
424SED_CMDS.opt-debug-jobs+=	-e 's,JobFinish: [0-9][0-9]*,JobFinish: <pid>,'
425# The "-q" may be there or not, see jobs.c, variable shells.
426SED_CMDS.opt-debug-jobs+=	-e 's,^\(.Command: sh\) -q,\1,'
427SED_CMDS.varmod-subst-regex+= \
428			-e 's,\(Regex compilation error:\).*,\1 (details omitted),'
429SED_CMDS.varmod-edge+=	-e 's, line [0-9]*:, line omitted:,'
430SED_CMDS.varshell+=	-e 's,^${.SHELL:T}: ,,'
431SED_CMDS.varshell+=	-e '/command/s,No such.*,not found,'
432SED_CMDS.varname-dot-parsedir=	-e '/in some cases/ s,^make: "[^"]*,make: "<normalized>,'
433SED_CMDS.varname-dot-parsefile=	-e '/in some cases/ s,^make: "[^"]*,make: "<normalized>,'
434SED_CMDS.varname-dot-shell=	-e 's, = /[^ ]*, = (details omitted),g'
435SED_CMDS.varname-dot-shell+=	-e 's,"/[^" ]*","(details omitted)",g'
436SED_CMDS.varname-dot-shell+=	-e 's,\[/[^] ]*\],[(details omitted)],g'
437
438# Some tests need an additional round of postprocessing.
439POSTPROC.deptgt-suffixes= \
440			${TOOL_SED} -n -e '/^\#\*\*\* Suffixes/,/^\#\*/p'
441POSTPROC.varname-empty=	${TOOL_SED} -n -e '/^Var_Set/p' -e '/^out:/p'
442
443# Some tests reuse other tests, which makes them unnecessarily fragile.
444export-all.rawout: export.mk
445unexport.rawout: export.mk
446unexport-env.rawout: export.mk
447
448# End of the configuration section.
449
450.MAIN: all
451
452UNIT_TESTS:=	${.PARSEDIR}
453.PATH: ${UNIT_TESTS}
454
455.if ${USE_ABSOLUTE_TESTNAMES:Uno} == yes
456OUTFILES=	${TESTS:@test@${.CURDIR:tA}/${test}.out@}
457.else
458OUTFILES=	${TESTS:=.out}
459.endif
460
461all: ${OUTFILES}
462
463CLEANFILES=		*.rawout *.out *.status *.tmp *.core *.tmp
464CLEANFILES+=		obj*.[och] lib*.a	# posix1.mk
465CLEANFILES+=		issue* .[ab]*		# suffixes.mk
466CLEANDIRS=		dir dummy		# posix1.mk
467
468clean:
469	rm -f ${CLEANFILES}
470	rm -rf ${CLEANDIRS}
471
472TEST_MAKE?=	${.MAKE}
473TOOL_SED?=	sed
474
475# ensure consistent results from sort(1)
476LC_ALL=		C
477LANG=		C
478.export LANG LC_ALL
479
480MAKE_TEST_ENV?=	MALLOC_OPTIONS="JA"	# for jemalloc
481
482# Each test is run in a sub-make, to keep the tests for interfering with
483# each other, and because they use different environment variables and
484# command line options.
485.SUFFIXES: .mk .rawout .out
486.mk.rawout:
487	@${_MKMSG_TEST:Uecho '#      test '} ${.PREFIX}
488	@set -eu; \
489	cd ${.OBJDIR}; \
490	env -i PATH="$$PATH" ${MAKE_TEST_ENV} ${ENV.${.PREFIX:T}} \
491	  ${TEST_MAKE} \
492	    -r -C ${.CURDIR} -f ${.IMPSRC} \
493	    ${FLAGS.${.PREFIX:T}:U-k} \
494	    > ${.TARGET}.tmp 2>&1 \
495	&& status=$$? || status=$$?; \
496	echo $$status > ${.TARGET:R}.status
497	@mv ${.TARGET}.tmp ${.TARGET}
498
499# Postprocess the test output so that the results can be compared.
500#
501# always pretend .MAKE was called 'make'
502_SED_CMDS+=	-e 's,^${TEST_MAKE:T:S,.,\\.,g}[][0-9]*:,make:,'
503_SED_CMDS+=	-e 's,${TEST_MAKE:S,.,\\.,g},make,'
504# replace anything after 'stopped in' with unit-tests
505_SED_CMDS+=	-e '/stopped/s, /.*, unit-tests,'
506# strip ${.CURDIR}/ from the output
507_SED_CMDS+=	-e 's,${.CURDIR:S,.,\\.,g}/,,g'
508_SED_CMDS+=	-e 's,${UNIT_TESTS:S,.,\\.,g}/,,g'
509
510.rawout.out:
511	@${TOOL_SED} ${_SED_CMDS} ${SED_CMDS.${.PREFIX:T}} \
512	  < ${.IMPSRC} > ${.TARGET}.tmp1
513	@${POSTPROC.${.PREFIX:T}:Ucat} < ${.TARGET}.tmp1 > ${.TARGET}.tmp2
514	@rm ${.TARGET}.tmp1
515	@echo "exit status `cat ${.TARGET:R}.status`" >> ${.TARGET}.tmp2
516	@mv ${.TARGET}.tmp2 ${.TARGET}
517
518# Compare all output files
519test:	${OUTFILES} .PHONY
520	@failed= ; \
521	for test in ${TESTS}; do \
522	  diff -u ${UNIT_TESTS}/$${test}.exp $${test}.out \
523	  || failed="$${failed}$${failed:+ }$${test}" ; \
524	done ; \
525	if [ -n "$${failed}" ]; then \
526	  echo "Failed tests: $${failed}" ; false ; \
527	else \
528	  echo "All tests passed" ; \
529	fi
530
531accept:
532	@for test in ${TESTS}; do \
533	  cmp -s ${UNIT_TESTS}/$${test}.exp $${test}.out \
534	  || { echo "Replacing $${test}.exp" ; \
535	       cp $${test}.out ${UNIT_TESTS}/$${test}.exp ; } \
536	done
537
538# Note: only works for adding tests.
539# To remove a test, the $$mi file must be edited manually.
540sync-mi:
541	@set -eu;							\
542	cd "${MAKEFILE:tA:H}/../../..";					\
543	mi="distrib/sets/lists/tests/mi";				\
544	cvs update "$$mi";						\
545	testsdir="usr.bin/make/unit-tests";				\
546	fmt="./usr/tests/$$testsdir/%s\ttests-usr.bin-tests\tcompattestfile,atf\\n"; \
547	cat "$$mi" > "$$mi.tmp";					\
548	(cd "$$testsdir" && ls *.exp *.mk) | xargs printf "$$fmt" >> "$$mi.tmp"; \
549	distrib/sets/fmt-list "$$mi.tmp";				\
550	mv "$$mi.tmp" "$$mi";						\
551	cvs diff "$$mi" || true
552
553.if exists(${TEST_MAKE})
554${TESTS:=.rawout}: ${TEST_MAKE}
555# in meta mode, we *know* if a target script is impacted
556# by a makefile change.
557.if ${.MAKE.MODE:Unormal:Mmeta} == ""
558${TESTS:=.rawout}: ${.PARSEDIR}/Makefile
559.endif
560.endif
561
562.-include <bsd.obj.mk>
563