Makefile revision 1.107
1# $NetBSD: Makefile,v 1.107 2020/08/22 12:51:11 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	# broken on FreeBSD, enabled in t_make.sh
39TESTS+=		cmdline
40TESTS+=		comment
41TESTS+=		cond-cmp-numeric
42TESTS+=		cond-cmp-string
43TESTS+=		cond-func
44TESTS+=		cond-func-commands
45TESTS+=		cond-func-defined
46TESTS+=		cond-func-empty
47TESTS+=		cond-func-exists
48TESTS+=		cond-func-make
49TESTS+=		cond-func-target
50TESTS+=		cond-late
51TESTS+=		cond-op
52TESTS+=		cond-op-and
53TESTS+=		cond-op-not
54TESTS+=		cond-op-or
55TESTS+=		cond-op-parentheses
56TESTS+=		cond-short
57TESTS+=		cond-token-number
58TESTS+=		cond-token-plain
59TESTS+=		cond-token-string
60TESTS+=		cond-token-var
61TESTS+=		cond1
62TESTS+=		cond2
63TESTS+=		counter
64TESTS+=		dep
65TESTS+=		dep-colon
66TESTS+=		dep-double-colon
67TESTS+=		dep-exclam
68TESTS+=		dep-none
69TESTS+=		dep-wildcards
70TESTS+=		depsrc
71TESTS+=		depsrc-exec
72TESTS+=		depsrc-ignore
73TESTS+=		depsrc-made
74TESTS+=		depsrc-make
75TESTS+=		depsrc-meta
76TESTS+=		depsrc-nometa
77TESTS+=		depsrc-nometa_cmp
78TESTS+=		depsrc-nopath
79TESTS+=		depsrc-notmain
80TESTS+=		depsrc-optional
81TESTS+=		depsrc-phony
82TESTS+=		depsrc-precious
83TESTS+=		depsrc-recursive
84TESTS+=		depsrc-silent
85TESTS+=		depsrc-use
86TESTS+=		depsrc-usebefore
87TESTS+=		depsrc-usebefore-double-colon
88TESTS+=		depsrc-wait
89TESTS+=		deptgt
90TESTS+=		deptgt-begin
91TESTS+=		deptgt-default
92TESTS+=		deptgt-delete_on_error
93TESTS+=		deptgt-end
94TESTS+=		deptgt-error
95TESTS+=		deptgt-ignore
96TESTS+=		deptgt-interrupt
97TESTS+=		deptgt-main
98TESTS+=		deptgt-makeflags
99TESTS+=		deptgt-no_parallel
100TESTS+=		deptgt-nopath
101TESTS+=		deptgt-notparallel
102TESTS+=		deptgt-objdir
103TESTS+=		deptgt-order
104TESTS+=		deptgt-path
105TESTS+=		deptgt-path-suffix
106TESTS+=		deptgt-phony
107TESTS+=		deptgt-precious
108TESTS+=		deptgt-shell
109TESTS+=		deptgt-silent
110TESTS+=		deptgt-stale
111TESTS+=		deptgt-suffixes
112TESTS+=		dir
113TESTS+=		directive
114TESTS+=		directive-elif
115TESTS+=		directive-elifdef
116TESTS+=		directive-elifmake
117TESTS+=		directive-elifndef
118TESTS+=		directive-elifnmake
119TESTS+=		directive-else
120TESTS+=		directive-endif
121TESTS+=		directive-error
122TESTS+=		directive-export
123TESTS+=		directive-export-env
124TESTS+=		directive-export-literal
125TESTS+=		directive-if
126TESTS+=		directive-ifdef
127TESTS+=		directive-ifmake
128TESTS+=		directive-ifndef
129TESTS+=		directive-ifnmake
130TESTS+=		directive-info
131TESTS+=		directive-undef
132TESTS+=		directive-unexport
133TESTS+=		directive-unexport-env
134TESTS+=		directive-warning
135TESTS+=		directives
136TESTS+=		dollar
137TESTS+=		doterror
138TESTS+=		dotwait
139TESTS+=		envfirst
140TESTS+=		error
141TESTS+=		# escape	# broken by reverting POSIX changes
142TESTS+=		export
143TESTS+=		export-all
144TESTS+=		export-env
145TESTS+=		export-variants
146TESTS+=		forloop
147TESTS+=		forsubst
148TESTS+=		hash
149TESTS+=		impsrc
150TESTS+=		include-main
151TESTS+=		lint
152TESTS+=		make-exported
153TESTS+=		misc
154TESTS+=		moderrs
155TESTS+=		modmatch
156TESTS+=		modmisc
157TESTS+=		modts
158TESTS+=		modword
159TESTS+=		opt
160TESTS+=		opt-backwards
161TESTS+=		opt-chdir
162TESTS+=		opt-debug
163TESTS+=		opt-define
164TESTS+=		opt-env
165TESTS+=		opt-file
166TESTS+=		opt-ignore
167TESTS+=		opt-include-dir
168TESTS+=		opt-jobs
169TESTS+=		opt-jobs-internal
170TESTS+=		opt-keep-going
171TESTS+=		opt-m-include-dir
172TESTS+=		opt-no-action
173TESTS+=		opt-no-action-at-all
174TESTS+=		opt-query
175TESTS+=		opt-raw
176TESTS+=		opt-silent
177TESTS+=		opt-touch
178TESTS+=		opt-tracefile
179TESTS+=		opt-var-expanded
180TESTS+=		opt-var-literal
181TESTS+=		opt-warnings-as-errors
182TESTS+=		opt-where-am-i
183TESTS+=		opt-x-reduce-exported
184TESTS+=		order
185TESTS+=		phony-end
186TESTS+=		posix
187TESTS+=		# posix1	# broken by reverting POSIX changes
188TESTS+=		qequals
189TESTS+=		recursive
190TESTS+=		sh
191TESTS+=		sh-dots
192TESTS+=		sh-jobs
193TESTS+=		sh-jobs-error
194TESTS+=		sh-leading-at
195TESTS+=		sh-leading-hyphen
196TESTS+=		sh-leading-plus
197TESTS+=		sh-meta-chars
198TESTS+=		sh-multi-line
199TESTS+=		sh-single-line
200TESTS+=		# suffixes	# runs into an endless loop (try -dA)
201TESTS+=		sunshcmd
202TESTS+=		sysv
203TESTS+=		ternary
204TESTS+=		unexport
205TESTS+=		unexport-env
206TESTS+=		use-inference
207TESTS+=		var-class
208TESTS+=		var-class-cmdline
209TESTS+=		var-class-env
210TESTS+=		var-class-global
211TESTS+=		var-class-local
212TESTS+=		var-class-local-legacy
213TESTS+=		var-op
214TESTS+=		var-op-append
215TESTS+=		var-op-assign
216TESTS+=		var-op-default
217TESTS+=		var-op-expand
218TESTS+=		var-op-shell
219TESTS+=		varcmd
220TESTS+=		vardebug
221TESTS+=		varfind
222TESTS+=		varmisc
223TESTS+=		varmod
224TESTS+=		varmod-assign
225TESTS+=		varmod-defined
226TESTS+=		varmod-edge
227TESTS+=		varmod-exclam-shell
228TESTS+=		varmod-extension
229TESTS+=		varmod-gmtime
230TESTS+=		varmod-hash
231TESTS+=		varmod-head
232TESTS+=		varmod-ifelse
233TESTS+=		varmod-l-name-to-value
234TESTS+=		varmod-localtime
235TESTS+=		varmod-loop
236TESTS+=		varmod-match
237TESTS+=		varmod-match-escape
238TESTS+=		varmod-no-match
239TESTS+=		varmod-order
240TESTS+=		varmod-order-reverse
241TESTS+=		varmod-order-shuffle
242TESTS+=		varmod-path
243TESTS+=		varmod-quote
244TESTS+=		varmod-quote-dollar
245TESTS+=		varmod-range
246TESTS+=		varmod-remember
247TESTS+=		varmod-root
248TESTS+=		varmod-select-words
249TESTS+=		varmod-shell
250TESTS+=		varmod-subst
251TESTS+=		varmod-subst-regex
252TESTS+=		varmod-sysv
253TESTS+=		varmod-tail
254TESTS+=		varmod-to-abs
255TESTS+=		varmod-to-lower
256TESTS+=		varmod-to-many-words
257TESTS+=		varmod-to-one-word
258TESTS+=		varmod-to-separator
259TESTS+=		varmod-to-upper
260TESTS+=		varmod-undefined
261TESTS+=		varmod-unique
262TESTS+=		varname
263TESTS+=		varname-dollar
264TESTS+=		varname-dot-alltargets
265TESTS+=		varname-dot-curdir
266TESTS+=		varname-dot-includedfromdir
267TESTS+=		varname-dot-includedfromfile
268TESTS+=		varname-dot-make-dependfile
269TESTS+=		varname-dot-make-expand_variables
270TESTS+=		varname-dot-make-exported
271TESTS+=		varname-dot-make-jobs
272TESTS+=		varname-dot-make-jobs-prefix
273TESTS+=		varname-dot-make-level
274TESTS+=		varname-dot-make-makefile_preference
275TESTS+=		varname-dot-make-makefiles
276TESTS+=		varname-dot-make-meta-bailiwick
277TESTS+=		varname-dot-make-meta-created
278TESTS+=		varname-dot-make-meta-files
279TESTS+=		varname-dot-make-meta-ignore_filter
280TESTS+=		varname-dot-make-meta-ignore_paths
281TESTS+=		varname-dot-make-meta-ignore_patterns
282TESTS+=		varname-dot-make-meta-prefix
283TESTS+=		varname-dot-make-mode
284TESTS+=		varname-dot-make-path_filemon
285TESTS+=		varname-dot-make-pid
286TESTS+=		varname-dot-make-ppid
287TESTS+=		varname-dot-make-save_dollars
288TESTS+=		varname-dot-makeoverrides
289TESTS+=		varname-dot-newline
290TESTS+=		varname-dot-objdir
291TESTS+=		varname-dot-parsedir
292TESTS+=		varname-dot-parsefile
293TESTS+=		varname-dot-path
294TESTS+=		varname-dot-targets
295TESTS+=		varname-make
296TESTS+=		varname-make_print_var_on_error
297TESTS+=		varname-makeflags
298TESTS+=		varname-pwd
299TESTS+=		varname-vpath
300TESTS+=		varparse-dynamic
301TESTS+=		varquote
302TESTS+=		varshell
303
304# Additional environment variables for some of the tests.
305# The base environment is -i PATH="$PATH".
306ENV.envfirst=		FROM_ENV=value-from-env
307ENV.varmisc=		FROM_ENV=env
308ENV.varmisc+=		FROM_ENV_BEFORE=env
309ENV.varmisc+=		FROM_ENV_AFTER=env
310
311# Override make flags for some of the tests; default is -k.
312FLAGS.archive=		-dA
313FLAGS.counter=		-dv
314FLAGS.doterror=		# none
315FLAGS.envfirst=		-e
316FLAGS.export=		# none
317FLAGS.lint=		-dL -k
318FLAGS.opt-no-action=	-n
319FLAGS.opt-query=	-q
320FLAGS.order=		-j1
321FLAGS.recursive=	-dL
322FLAGS.vardebug=		-k -dv FROM_CMDLINE=
323FLAGS.varmod-match-escape= -dv
324
325# Some tests need extra post-processing.
326SED_CMDS.varmod-subst-regex+= \
327			-e 's,\(Regex compilation error:\).*,\1 (details omitted),'
328SED_CMDS.varmod-edge+=	-e 's, line [0-9]*:, line omitted:,'
329SED_CMDS.varshell+=	-e 's,^[a-z]*sh: ,,'
330SED_CMDS.varshell+=	-e '/command/s,No such.*,not found,'
331
332# Some tests need an additional round of postprocessing.
333POSTPROC.counter=	${TOOL_SED} -n -e '/:RELEVANT = yes/,/:RELEVANT = no/p'
334POSTPROC.vardebug=	${TOOL_SED} -n -e '/:RELEVANT = yes/,/:RELEVANT = no/p'
335POSTPROC.varmod-match-escape= ${TOOL_SED} -n -e '/^Pattern/p'
336
337# Some tests reuse other tests, which makes them unnecessarily fragile.
338export-all.rawout: export.mk
339unexport.rawout: export.mk
340unexport-env.rawout: export.mk
341
342# End of the configuration section.
343
344.MAIN: all
345
346UNIT_TESTS:=	${.PARSEDIR}
347.PATH: ${UNIT_TESTS}
348
349OUTFILES=	${TESTS:=.out}
350
351all: ${OUTFILES}
352
353CLEANFILES=		*.rawout *.out *.status *.tmp *.core *.tmp
354CLEANFILES+=		obj*.[och] lib*.a	# posix1.mk
355CLEANFILES+=		issue* .[ab]*		# suffixes.mk
356CLEANDIRS=		dir dummy		# posix1.mk
357
358clean:
359	rm -f ${CLEANFILES}
360	rm -rf ${CLEANDIRS}
361
362TEST_MAKE?=	${.MAKE}
363TOOL_SED?=	sed
364
365# ensure consistent results from sort(1)
366LC_ALL=		C
367LANG=		C
368.export LANG LC_ALL
369
370# the tests are actually done with sub-makes.
371.SUFFIXES: .mk .rawout .out
372.mk.rawout:
373	@${_MKMSG_TEST:Uecho '#      test '} ${.PREFIX}
374	@set -eu; \
375	cd ${.OBJDIR}; \
376	env -i PATH="$$PATH" ${ENV.${.TARGET:R}} \
377	  ${TEST_MAKE} \
378	    -r -C ${.CURDIR} -f ${.IMPSRC} \
379	    ${FLAGS.${.TARGET:R}:U-k} \
380	    > ${.TARGET}.tmp 2>&1 \
381	&& status=$$? || status=$$?; \
382	echo $$status > ${.TARGET:R}.status
383	@mv ${.TARGET}.tmp ${.TARGET}
384
385# Post-process the test output so that the results can be compared.
386#
387# always pretend .MAKE was called 'make'
388_SED_CMDS+=	-e 's,^${TEST_MAKE:T:S,.,\\.,g}[][0-9]*:,make:,'
389_SED_CMDS+=	-e 's,${TEST_MAKE:S,.,\\.,g},make,'
390# replace anything after 'stopped in' with unit-tests
391_SED_CMDS+=	-e '/stopped/s, /.*, unit-tests,'
392# strip ${.CURDIR}/ from the output
393_SED_CMDS+=	-e 's,${.CURDIR:S,.,\\.,g}/,,g'
394_SED_CMDS+=	-e 's,${UNIT_TESTS:S,.,\\.,g}/,,g'
395
396.rawout.out:
397	@${TOOL_SED} ${_SED_CMDS} ${SED_CMDS.${.TARGET:R}} \
398	  < ${.IMPSRC} > ${.TARGET}.tmp1
399	@${POSTPROC.${.TARGET:R}:Ucat} < ${.TARGET}.tmp1 > ${.TARGET}.tmp2
400	@rm ${.TARGET}.tmp1
401	@echo "exit status `cat ${.TARGET:R}.status`" >> ${.TARGET}.tmp2
402	@mv ${.TARGET}.tmp2 ${.TARGET}
403
404# Compare all output files
405test:	${OUTFILES} .PHONY
406	@failed= ; \
407	for test in ${TESTS}; do \
408	  diff -u ${UNIT_TESTS}/$${test}.exp $${test}.out \
409	  || failed="$${failed}$${failed:+ }$${test}" ; \
410	done ; \
411	if [ -n "$${failed}" ]; then \
412	  echo "Failed tests: $${failed}" ; false ; \
413	else \
414	  echo "All tests passed" ; \
415	fi
416
417accept:
418	@for test in ${TESTS}; do \
419	  cmp -s ${UNIT_TESTS}/$${test}.exp $${test}.out \
420	  || { echo "Replacing $${test}.exp" ; \
421	       cp $${test}.out ${UNIT_TESTS}/$${test}.exp ; } \
422	done
423
424SYNC_MI_AWK= \
425	BEGIN {								\
426	  testsdir = "usr.bin/make/unit-tests";				\
427	  linestart = "./usr/tests/" testsdir;				\
428	  fmt = linestart "/%s\ttests-usr.bin-tests\tcompattestfile,atf\\n"; \
429	  cmd = "cd " testsdir " && ls *.exp *.mk | xargs printf '" fmt "'" \
430	}								\
431	function startswith(s, prefix) {				\
432	  return substr(s, 1, length(prefix)) == prefix;		\
433	}								\
434	startswith($$1, linestart) && $$1 ~ /\.(exp|mk)$$/ { next }	\
435	{ print $$0 }							\
436	$$1 == linestart "/Makefile" { system(cmd) }
437
438sync-mi:
439	@set -eu;							\
440	cd "${MAKEFILE:tA:H}/../../..";					\
441	mi="distrib/sets/lists/tests/mi";				\
442	cvs update "$$mi";						\
443	awk ${SYNC_MI_AWK:Q} < "$$mi" > "$$mi.$@";			\
444	mv -f "$$mi.$@" "$$mi";						\
445	cvs diff "$$mi" || true
446
447.if exists(${TEST_MAKE})
448${TESTS:=.rawout}: ${TEST_MAKE} ${.PARSEDIR}/Makefile
449.endif
450
451.-include <bsd.obj.mk>
452