test/Makefile.in

   1 ### @configure_input@
   2
   3 # Copyright (C) 2010-2015 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 %.log: ${srcdir}/%.el
  91         @if grep '^;.*no-byte-compile: t' $< > /dev/null; then \
  92           loadfile=$<; \
  93         else \
  94           loadfile=$<c; \
  95           ${MAKE} $$loadfile; \
  96         fi; \
  97         echo Testing $$loadfile; \
  98         stat=OK ; \
  99         $(emacs) -l ert -l $$loadfile \
 100           -f ert-run-tests-batch-and-exit ${WRITE_LOG}
 101
 102 ELFILES = $(shell find ${srcdir} -path "./manual" -prune -o \
 103                 -path "*resources" -prune -o -name "*el" -print)
 104 ELCFILES = $(patsubst %.el,%.elc,${ELFILES})
 105 LOGFILES = $(patsubst %.el,%.log,${ELFILES})
 106 LOGSAVEFILES  = $(patsubst %.el,%.log~,${ELFILES})
 107 TESTS = $(subst ${srcdir}/,,$(LOGFILES:.log=))
 108
 109 ## If we have to interrupt a hanging test, preserve the log so we can
 110 ## see what the problem was.
 111 .PRECIOUS: %.log
 112
 113 .PHONY: ${TESTS}
 114
 115 ## The short aliases that always re-run the tests, with no logging.
 116 ## Define an alias both with and without the directory name for ease
 117 ## of use.
 118 define test_template
 119 $(1):
 120         @test ! -f ${srcdir}/$(1).log || mv ${srcdir}/$(1).log ${srcdir}/$(1).log~
 121         @${MAKE} ${srcdir}/$(1).log WRITE_LOG=
 122
 123 $(notdir $(1)): $(1)
 124 endef
 125
 126 $(foreach test,${TESTS},$(eval $(call test_template,${test})))
 127
 128 ## Include dependencies between test files and the files they test.
 129 ## We do this without the file and eval directly, but then we would
 130 ## have to run Emacs for every make invocation, and it might not be
 131 ## available during clean.
 132 -include make-test-deps.mk
 133
 134 ## Re-run all the tests every time.
 135 check:
 136         -@for f in *.log; do test ! -f $$f || mv $$f $$f~; done
 137         @${MAKE} check-maybe
 138
 139 ## Only re-run tests whose .log is older than the test.
 140 .PHONY: check-maybe
 141 check-maybe: ${LOGFILES}
 142         $(emacs) -l ert -f ert-summarize-tests-batch-and-exit $^
 143
 144 .PHONY: mostlyclean clean bootstrap-clean distclean maintainer-clean
 145
 146 clean mostlyclean:
 147         -rm -f ${LOGFILES} ${LOGSAVEFILES}
 148         -rm make-test-deps.mk
 149
 150 bootstrap-clean: clean
 151         -rm -f ${ELCFILES}
 152
 153 distclean: clean
 154         rm -f Makefile
 155
 156 maintainer-clean: distclean bootstrap-clean
 157
 158 make-test-deps.mk: $(ELFILES) make-test-deps.emacs-lisp
 159         $(EMACS) --batch -l make-test-deps.emacs-lisp \
 160         --eval "(make-test-deps \"`pwd`\")" \
 161         2> $@
 162 # Makefile ends here.