test/automated/Makefile.in

   1 ### @configure_input@
   2
   3 # Copyright (C) 2010-2016 Free Software Foundation, Inc.
   4
   5 # This file is part of GNU Emacs.
   6
   7 # GNU Emacs is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11
  12 # GNU Emacs is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16
  17 # You should have received a copy of the GNU General Public License
  18 # along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 ### Commentary:
  21
  22 ## Some targets:
  23 ## check: re-run all tests, writing to .log files.
  24 ## check-maybe: run all tests whose .log file needs updating
  25 ## filename.log: run tests from filename.el(c) if .log file needs updating
  26 ## filename: re-run tests from filename.el(c), with no logging
  27
  28 ### Code:
  29
  30 SHELL = @SHELL@
  31
  32 srcdir = @srcdir@
  33 VPATH = $(srcdir)
  34
  35 SEPCHAR = @SEPCHAR@
  36
  37 # We never change directory before running Emacs, so a relative file
  38 # name is fine, and makes life easier.  If we need to change
  39 # directory, we can use emacs --chdir.
  40 EMACS = ../../src/emacs
  41
  42 EMACS_EXTRAOPT=
  43
  44 # Command line flags for Emacs.
  45 # Apparently MSYS bash would convert "-L :" to "-L ;" anyway,
  46 # but we might as well be explicit.
  47 EMACSOPT = -batch --no-site-file --no-site-lisp -L "$(SEPCHAR)$(srcdir)" $(EMACS_EXTRAOPT)
  48
  49 # Prevent any settings in the user environment causing problems.
  50 unexport EMACSDATA EMACSDOC EMACSPATH GREP_OPTIONS
  51
  52 ## To run tests under a debugger, set this to eg: "gdb --args".
  53 GDB =
  54
  55 # The locale to run tests under.  Tests should work if this is set to
  56 # any supported locale.  Use the C locale by default, as it should be
  57 # supported everywhere.
  58 TEST_LOCALE = C
  59
  60 # The actual Emacs command run in the targets below.
  61 # Prevent any setting of EMACSLOADPATH in user environment causing problems.
  62 emacs = EMACSLOADPATH= LC_ALL=$(TEST_LOCALE) EMACS_TEST_DIRECTORY=$(srcdir) \
  63  $(GDB) "$(EMACS)" $(EMACSOPT)
  64
  65 .PHONY: all check
  66
  67 all: check
  68
  69 %.elc: %.el
  70         @echo Compiling $<
  71         @$(emacs) -f batch-byte-compile $<
  72
  73 ## Ignore any test errors so we can continue to test other files.
  74 ## But compilation errors are always fatal.
  75 WRITE_LOG = > $@ 2>&1 || { stat=ERROR; cat $@; }; echo $$stat: $@
  76
  77 ## I'd prefer to use -emacs -f ert-run-tests-batch-and-exit rather
  78 ## than || true, since the former makes problems more obvious.
  79 ## I'd also prefer to @-hide the grep part and not the
  80 ## ert-run-tests-batch-and-exit part.
  81 ##
  82 ## We need to use $loadfile because:
  83 ## i) -L :$srcdir -l basename does not work, because we have files whose
  84 ## basename duplicates a file in lisp/ (eg eshell.el).
  85 ## ii) Although -l basename will automatically load .el or .elc,
  86 ## -l ./basename treats basename as a literal file (it would be nice
  87 ## to change this; bug#17848 - if that gets done, this can be simplified).
  88 ##
  89 ## Beware: it approximates 'no-byte-compile', so watch out for false-positives!
  90 SELECTOR_DEFAULT = (quote (not (tag :expensive-test)))
  91 SELECTOR_EXPENSIVE = nil
  92 ifndef SELECTOR
  93 SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
  94 else
  95 SELECTOR_ACTUAL=$(SELECTOR)
  96 endif
  97
  98
  99 %.log: ${srcdir}/%.el
 100         @if grep '^;.*no-byte-compile: t' $< > /dev/null; then \
 101           loadfile=$<; \
 102         else \
 103           loadfile=$<c; \
 104           ${MAKE} $$loadfile; \
 105         fi; \
 106         echo Testing $$loadfile; \
 107         stat=OK ; \
 108         $(emacs) -l ert -l $$loadfile \
 109           --eval "(ert-run-tests-batch-and-exit ${SELECTOR_ACTUAL})" ${WRITE_LOG}
 110
 111 ELFILES = $(sort $(wildcard ${srcdir}/*.el))
 112 LOGFILES = $(patsubst %.el,%.log,$(notdir ${ELFILES}))
 113 TESTS = ${LOGFILES:.log=}
 114
 115 ## If we have to interrupt a hanging test, preserve the log so we can
 116 ## see what the problem was.
 117 .PRECIOUS: %.log
 118
 119 .PHONY: ${TESTS}
 120
 121 ## The short aliases that always re-run the tests, with no logging.
 122 define test_template
 123 $(1):
 124         @test ! -f $(1).log || mv $(1).log $(1).log~
 125         @${MAKE} $(1).log WRITE_LOG=
 126 endef
 127
 128 $(foreach test,${TESTS},$(eval $(call test_template,${test})))
 129
 130 ## Rerun all default tests.
 131 check: mostlyclean
 132         @${MAKE} check-doit SELECTOR="${SELECTOR_ACTUAL}"
 133
 134 ## Rerun all default and expensive tests.
 135 .PHONY: check-expensive
 136 check-expensive: mostlyclean
 137         @${MAKE} check-doit SELECTOR="${SELECTOR_EXPENSIVE}"
 138
 139 ## Only re-run default tests whose .log is older than the test.
 140 .PHONY: check-maybe
 141 check-maybe:
 142         @${MAKE} check-doit SELECTOR="${SELECTOR_ACTUAL}"
 143
 144 ## Run the tests.
 145 .PHONY: check-doit
 146 check-doit: ${LOGFILES}
 147         $(emacs) -l ert -f ert-summarize-tests-batch-and-exit $^
 148
 149 .PHONY: mostlyclean clean bootstrap-clean distclean maintainer-clean
 150
 151 mostlyclean:
 152         -@for f in *.log; do test ! -f $$f || mv $$f $$f~; done
 153
 154 clean:
 155         -rm -f *.log *.log~
 156
 157 bootstrap-clean: clean
 158         -rm -f ${srcdir}/*.elc
 159
 160 distclean: clean
 161         rm -f Makefile
 162
 163 maintainer-clean: distclean bootstrap-clean
 164
 165 # Makefile ends here.