572808143dff23f4c8ff7054dfdcba75df137160
[platform/upstream/automake.git] / lib / am / check.am
1 ## automake - create Makefile.in from Makefile.am
2 ## Copyright (C) 2001, 2003, 2006, 2007, 2008, 2009, 2010, 2011 Free
3 ## Software Foundation, Inc.
4
5 ## This program is free software; you can redistribute it and/or modify
6 ## it under the terms of the GNU General Public License as published by
7 ## the Free Software Foundation; either version 2, or (at your option)
8 ## any later version.
9
10 ## This program is distributed in the hope that it will be useful,
11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 ## GNU General Public License for more details.
14
15 ## You should have received a copy of the GNU General Public License
16 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18 if %?COLOR%
19 # If stdout is a non-dumb tty, use colors.  If test -t is not supported,
20 # then this fails; a conservative approach.  Of course do not redirect
21 # stdout here, just stderr.
22 am__tty_colors = \
23 red=; grn=; lgn=; blu=; std=; \
24 test "X$(AM_COLOR_TESTS)" != Xno \
25 && test "X$$TERM" != Xdumb \
26 && { test "X$(AM_COLOR_TESTS)" = Xalways || test -t 1 2>/dev/null; } \
27 && { \
28   red='\e[0;31m'; \
29   grn='\e[0;32m'; \
30   lgn='\e[1;32m'; \
31   blu='\e[1;34m'; \
32   std='\e[m'; \
33 }
34 else !%?COLOR%
35 am__tty_colors = \
36 red=; grn=; lgn=; blu=; std=
37 endif !%?COLOR%
38
39 .PHONY: check-TESTS
40
41 if %?PARALLEL_TESTS%
42
43 include inst-vars.am
44
45 ## New parallel test driver.
46 ##
47 ## This code is adapted from check.mk which was originally
48 ## written at EPITA/LRDE, further developed at Gostai, then made
49 ## its way from GNU coreutils to end up, largely rewritten, in
50 ## Automake.
51 ##
52 ## It provides special support for "unit tests", that is to say,
53 ## tests that (once run) no longer need to be re-compiled and
54 ## re-run at each "make check", unless their sources changed.  To
55 ## enable unit-test supports, set RECHECK_LOGS to empty.  In such a
56 ## setting, that heavily relies on correct dependencies, its users may
57 ## prefer to define EXTRA_PROGRAMS instead of check_PROGRAMS, because
58 ## it allows intertwined compilation and execution of the tests.
59 ## Sometimes this helps catching errors earlier (you don't have to
60 ## wait for all the tests to be compiled).
61 ##
62 ## Define TEST_SUITE_LOG to be the name of the global log to create.
63 ## Define TEST_LOGS to the set of logs to include in it.  It defaults
64 ## to $(TESTS), with `.test' and `@EXEEXT@' removed, and `'.log'
65 ## appended.
66 ##
67 ## In addition to the magic "exit 77 means SKIP" feature (which was
68 ## imported from automake), there is a magic "exit 99 means FAIL" feature
69 ## which is useful if you need to issue a hard error no matter whether the
70 ## test is XFAIL or not.  You can disable this feature by setting the
71 ## variable DISABLE_HARD_ERRORS to a nonempty value.
72
73 # Restructured Text title and section.
74 am__rst_title   = sed 's/.*/   &   /;h;s/./=/g;p;x;p;g;p;s/.*//'
75 am__rst_section = sed 'p;s/./=/g;p;g'
76
77 # Put stdin (possibly several lines separated by ".  ") in a box.
78 am__text_box = $(AWK) '{                                \
79   n = split($$0, lines, "\\.  "); max = 0;              \
80   for (i = 1; i <= n; ++i)                              \
81     if (max < length(lines[i]))                         \
82       max = length(lines[i]);                           \
83   for (i = 0; i < max; ++i) line = line "=";            \
84   print line;                                           \
85   for (i = 1; i <= n; ++i) if (lines[i]) print lines[i];\
86   print line;                                           \
87 }'
88
89 # Solaris 10 'make', and several other traditional 'make' implementations,
90 # pass "-e" to $(SHELL), and POSIX 2008 even requires this.  Work around it
91 # by disabling -e (using the XSI extension "set +e") if it's set.
92 am__sh_e_setup = case $$- in *e*) set +e;; esac
93
94 # To be inserted before the command running the test.  Creates the
95 # directory for the log if needed.  Stores in $dir the directory
96 # containing $f, in $tst the test, in $log the log, and passes
97 # TESTS_ENVIRONMENT.  Save and restore TERM around use of
98 # TESTS_ENVIRONMENT, in case that unsets it.
99 am__check_pre =                                         \
100 $(am__sh_e_setup);                                      \
101 $(am__vpath_adj_setup) $(am__vpath_adj)                 \
102 srcdir=$(srcdir); export srcdir;                        \
103 rm -f $@-t;                                             \
104 am__trap='rm -f '\''$(abs_builddir)/$@-t'\''; (exit $$st); exit $$st'; \
105 trap "st=129; $$am__trap" 1; trap "st=130; $$am__trap" 2;       \
106 trap "st=141; $$am__trap" 13; trap "st=143; $$am__trap" 15; \
107 am__odir=`echo "./$@" | sed 's|/[^/]*$$||'`;            \
108 test "x$$am__odir" = x. || $(MKDIR_P) "$$am__odir" || exit $$?; \
109 if test -f "./$$f"; then dir=./;                        \
110 elif test -f "$$f"; then dir=;                          \
111 else dir="$(srcdir)/"; fi;                              \
112 tst=$$dir$$f; log='$@'; __SAVED_TERM=$$TERM;            \
113 $(TESTS_ENVIRONMENT)
114
115 # To be appended to the command running the test.  Handle the stdout
116 # and stderr redirection, and catch the exit status.
117 am__check_post =                                        \
118 >$@-t 2>&1;                                             \
119 estatus=$$?;                                            \
120 if test -n '$(DISABLE_HARD_ERRORS)'                     \
121    && test $$estatus -eq 99; then                       \
122   estatus=1;                                            \
123 fi;                                                     \
124 TERM=$$__SAVED_TERM; export TERM;                       \
125 $(am__tty_colors);                                      \
126 xfailed=PASS;                                           \
127 case " $(XFAIL_TESTS) " in                              \
128   *[\ \ ]$$f[\ \        ]* | *[\ \      ]$$dir$$f[\ \   ]*) \
129     xfailed=XFAIL;;                                     \
130 esac;                                                   \
131 case $$estatus.$$xfailed in                             \
132     0.XFAIL) col=$$red; res=XPASS;;                     \
133     0.*)     col=$$grn; res=PASS ;;                     \
134     77.*)    col=$$blu; res=SKIP ;;                     \
135     99.*)    col=$$red; res=FAIL ;;                     \
136     *.XFAIL) col=$$lgn; res=XFAIL;;                     \
137     *.*)     col=$$red; res=FAIL ;;                     \
138 esac;                                                   \
139 echo "$${col}$$res$${std}: $$f";                        \
140 echo "$$res: $$f (exit: $$estatus)" |                   \
141   $(am__rst_section) >$@;                               \
142 cat $@-t >>$@;                                          \
143 rm -f $@-t
144
145 $(TEST_SUITE_LOG): $(TEST_LOGS)
146         @$(am__sh_e_setup);                                             \
147         list='$(TEST_LOGS)';                                            \
148         results=`for f in $$list; do                                    \
149                    test -r $$f && read line < $$f && echo "$$line"      \
150                      || echo FAIL;                                      \
151                  done`;                                                 \
152         all=`echo "$$results" | sed '/^$$/d' | wc -l | sed -e 's/^[      ]*//'`; \
153         fail=`echo "$$results" | grep -c '^FAIL'`;                      \
154         pass=`echo "$$results" | grep -c '^PASS'`;                      \
155         skip=`echo "$$results" | grep -c '^SKIP'`;                      \
156         xfail=`echo "$$results" | grep -c '^XFAIL'`;                    \
157         xpass=`echo "$$results" | grep -c '^XPASS'`;                    \
158         failures=`expr $$fail + $$xpass`;                               \
159         all=`expr $$all - $$skip`;                                      \
160         if test "$$all" -eq 1; then tests=test; All=;                   \
161         else tests=tests; All="All "; fi;                               \
162         case fail=$$fail:xpass=$$xpass:xfail=$$xfail in                 \
163           fail=0:xpass=0:xfail=0)                                       \
164             msg="$$All$$all $$tests passed.  ";                         \
165             exit=true;;                                                 \
166           fail=0:xpass=0:xfail=*)                                       \
167             msg="$$All$$all $$tests behaved as expected";               \
168             if test "$$xfail" -eq 1; then xfailures=failure;            \
169             else xfailures=failures; fi;                                \
170             msg="$$msg ($$xfail expected $$xfailures).  ";              \
171             exit=true;;                                                 \
172           fail=*:xpass=0:xfail=*)                                       \
173             msg="$$fail of $$all $$tests failed.  ";                    \
174             exit=false;;                                                \
175           fail=*:xpass=*:xfail=*)                                       \
176             msg="$$failures of $$all $$tests did not behave as expected"; \
177             if test "$$xpass" -eq 1; then xpasses=pass;                 \
178             else xpasses=passes; fi;                                    \
179             msg="$$msg ($$xpass unexpected $$xpasses).  ";              \
180             exit=false;;                                                \
181           *)                                                            \
182             echo >&2 "incorrect case"; exit 4;;                         \
183         esac;                                                           \
184         if test "$$skip" -ne 0; then                                    \
185           if test "$$skip" -eq 1; then                                  \
186             msg="$$msg($$skip test was not run).  ";                    \
187           else                                                          \
188             msg="$$msg($$skip tests were not run).  ";                  \
189           fi;                                                           \
190         fi;                                                             \
191         {                                                               \
192           echo "$(PACKAGE_STRING): $(subdir)/$(TEST_SUITE_LOG)" |       \
193             $(am__rst_title);                                           \
194           echo "$$msg";                                                 \
195           echo;                                                         \
196           echo ".. contents:: :depth: 2";                               \
197           echo;                                                         \
198           for f in $$list; do                                           \
199             test -r $$f && read line < $$f || line=;                    \
200             case $$line in                                              \
201               PASS:*|XFAIL:*);;                                         \
202               *) echo; cat $$f;;                                        \
203             esac;                                                       \
204           done;                                                         \
205         } >$(TEST_SUITE_LOG).tmp;                                       \
206         mv $(TEST_SUITE_LOG).tmp $(TEST_SUITE_LOG);                     \
207         if test "$$failures" -ne 0; then                                \
208           msg="$${msg}See $(subdir)/$(TEST_SUITE_LOG).  ";              \
209           if test -n "$(PACKAGE_BUGREPORT)"; then                       \
210             msg="$${msg}Please report to $(PACKAGE_BUGREPORT).  ";      \
211           fi;                                                           \
212         fi;                                                             \
213         test x"$$VERBOSE" = x || $$exit || cat $(TEST_SUITE_LOG);       \
214         $(am__tty_colors);                                              \
215         if $$exit; then                                                 \
216           echo $(ECHO_N) "$$grn$(ECHO_C)";                              \
217          else                                                           \
218           echo $(ECHO_N) "$$red$(ECHO_C)";                              \
219         fi;                                                             \
220         echo "$$msg" | $(am__text_box);                                 \
221         echo $(ECHO_N) "$$std$(ECHO_C)";                                \
222         $$exit
223
224 RECHECK_LOGS = $(TEST_LOGS)
225
226 # Run all the tests.
227 check-TESTS:
228 ## Expand $(RECHECK_LOGS) only once, to avoid exceeding line length limits.
229         @list='$(RECHECK_LOGS)'; test -z "$$list" || rm -f $$list
230 ## We always have to remove TEST_SUITE_LOG, to ensure its rule is run
231 ## in any case even in lazy mode: otherwise, if no test needs rerunning,
232 ## or a prior run plus reruns all happen within the same timestamp
233 ## (can happen with a prior `make TESTS=<subset>'),
234 ## then we get no log output.
235 ## OTOH, this means that, in the rule for `$(TEST_SUITE_LOG)', we
236 ## cannot use `$?' to compute the set of lazily rerun tests, lest
237 ## we rely on .PHONY to work portably.
238         @test -z "$(TEST_SUITE_LOG)" || rm -f $(TEST_SUITE_LOG)
239         @list='$(TEST_LOGS)';                                           \
240         list=`for f in $$list; do                                       \
241           test .log = $$f || echo $$f;                                  \
242         done | tr '\012\015' '  '`;                                     \
243         $(MAKE) $(AM_MAKEFLAGS) $(TEST_SUITE_LOG) TEST_LOGS="$$list"
244
245 AM_RECURSIVE_TARGETS += check
246
247 ## -------------- ##
248 ## Produce HTML.  ##
249 ## -------------- ##
250
251 .log.html:
252         @list='$(RST2HTML) $$RST2HTML rst2html rst2html.py';            \
253         for r2h in $$list; do                                           \
254           if ($$r2h --version) >/dev/null 2>&1; then                    \
255             R2H=$$r2h;                                                  \
256           fi;                                                           \
257         done;                                                           \
258         if test -z "$$R2H"; then                                        \
259           echo >&2 "cannot find rst2html, cannot create $@";            \
260           exit 2;                                                       \
261         fi;                                                             \
262         $$R2H $< >$@.tmp
263         @mv $@.tmp $@
264
265 # Be sure to run check first, and then to convert the result.
266 # Beware of concurrent executions.  Run "check" not "check-TESTS", as
267 # check-SCRIPTS and other dependencies are rebuilt by the former only.
268 # And expect check to fail.
269 check-html:
270         @if $(MAKE) $(AM_MAKEFLAGS) check; then                 \
271           rv=0; else rv=$$?;                                    \
272         fi;                                                     \
273         $(MAKE) $(AM_MAKEFLAGS) $(TEST_SUITE_HTML) || exit 4;   \
274         exit $$rv
275
276 .PHONY: check-html
277 .MAKE: check-html
278
279 AM_RECURSIVE_TARGETS += check-html
280
281 ## -------------------- ##
282 ## Rechecking failures. ##
283 ## -------------------- ##
284
285 ## Rerun all FAILed or XPASSed tests.
286 recheck recheck-html:
287         @target=`echo $@ | sed 's,^re,,'`;                              \
288         list='$(TEST_LOGS)';                                            \
289         list=`for f in $$list; do                                       \
290                 test -f $$f || continue;                                \
291                 if test -r $$f && read line < $$f; then                 \
292                   case $$line in FAIL*|XPASS*) echo $$f;; esac;         \
293                 else echo $$f; fi;                                      \
294               done | tr '\012\015' '  '`;                               \
295 ## This apparently useless munging helps to avoid a nasty bug (a
296 ## segmentation fault!) on Solaris XPG4 make.
297         list=`echo "$$list" | sed 's/ *$$//'`;                          \
298         $(MAKE) $(AM_MAKEFLAGS) $$target AM_MAKEFLAGS='$(AM_MAKEFLAGS) TEST_LOGS="'"$$list"'"'
299
300 .PHONY: recheck recheck-html
301 .MAKE: recheck recheck-html
302
303 AM_RECURSIVE_TARGETS += recheck recheck-html
304
305 else !%?PARALLEL_TESTS%
306
307 check-TESTS: $(TESTS)
308         @failed=0; all=0; xfail=0; xpass=0; skip=0; \
309         srcdir=$(srcdir); export srcdir; \
310 ## Make sure Solaris VPATH-expands all members of this list, even
311 ## the first and the last one; thus the spaces around $(TESTS)
312         list=' $(TESTS) '; \
313         $(am__tty_colors); \
314         if test -n "$$list"; then \
315           for tst in $$list; do \
316             if test -f ./$$tst; then dir=./; \
317 ## Note: Solaris 2.7 seems to expand TESTS using VPATH.  That's
318 ## why we also try `dir='
319             elif test -f $$tst; then dir=; \
320             else dir="$(srcdir)/"; fi; \
321             if $(TESTS_ENVIRONMENT) $${dir}$$tst; then \
322 ## Success
323               all=`expr $$all + 1`; \
324               case " $(XFAIL_TESTS) " in \
325               *[\ \     ]$$tst[\ \      ]*) \
326                 xpass=`expr $$xpass + 1`; \
327                 failed=`expr $$failed + 1`; \
328                 col=$$red; res=XPASS; \
329               ;; \
330               *) \
331                 col=$$grn; res=PASS; \
332               ;; \
333               esac; \
334             elif test $$? -ne 77; then \
335 ## Failure
336               all=`expr $$all + 1`; \
337               case " $(XFAIL_TESTS) " in \
338               *[\ \     ]$$tst[\ \      ]*) \
339                 xfail=`expr $$xfail + 1`; \
340                 col=$$lgn; res=XFAIL; \
341               ;; \
342               *) \
343                 failed=`expr $$failed + 1`; \
344                 col=$$red; res=FAIL; \
345               ;; \
346               esac; \
347             else \
348 ## Skipped
349               skip=`expr $$skip + 1`; \
350               col=$$blu; res=SKIP; \
351             fi; \
352             echo "$${col}$$res$${std}: $$tst"; \
353           done; \
354 ## Prepare the banner
355           if test "$$all" -eq 1; then \
356             tests="test"; \
357             All=""; \
358           else \
359             tests="tests"; \
360             All="All "; \
361           fi; \
362           if test "$$failed" -eq 0; then \
363             if test "$$xfail" -eq 0; then \
364               banner="$$All$$all $$tests passed"; \
365             else \
366               if test "$$xfail" -eq 1; then failures=failure; else failures=failures; fi; \
367               banner="$$All$$all $$tests behaved as expected ($$xfail expected $$failures)"; \
368             fi; \
369           else \
370             if test "$$xpass" -eq 0; then \
371               banner="$$failed of $$all $$tests failed"; \
372             else \
373               if test "$$xpass" -eq 1; then passes=pass; else passes=passes; fi; \
374               banner="$$failed of $$all $$tests did not behave as expected ($$xpass unexpected $$passes)"; \
375             fi; \
376           fi; \
377 ## DASHES should contain the largest line of the banner.
378           dashes="$$banner"; \
379           skipped=""; \
380           if test "$$skip" -ne 0; then \
381             if test "$$skip" -eq 1; then \
382               skipped="($$skip test was not run)"; \
383             else \
384               skipped="($$skip tests were not run)"; \
385             fi; \
386             test `echo "$$skipped" | wc -c` -le `echo "$$banner" | wc -c` || \
387               dashes="$$skipped"; \
388           fi; \
389           report=""; \
390           if test "$$failed" -ne 0 && test -n "$(PACKAGE_BUGREPORT)"; then \
391             report="Please report to $(PACKAGE_BUGREPORT)"; \
392             test `echo "$$report" | wc -c` -le `echo "$$banner" | wc -c` || \
393               dashes="$$report"; \
394           fi; \
395           dashes=`echo "$$dashes" | sed s/./=/g`; \
396           if test "$$failed" -eq 0; then \
397             echo "$$grn$$dashes"; \
398           else \
399             echo "$$red$$dashes"; \
400           fi; \
401           echo "$$banner"; \
402           test -z "$$skipped" || echo "$$skipped"; \
403           test -z "$$report" || echo "$$report"; \
404           echo "$$dashes$$std"; \
405           test "$$failed" -eq 0; \
406         else :; fi
407
408 endif !%?PARALLEL_TESTS%