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