summaryrefslogtreecommitdiff
path: root/test/Makefile.in
blob: 1e76675ac76207cdd2e1d1c9bdb709c5c4cb3e55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
### @configure_input@

# Copyright (C) 2010-2015 Free Software Foundation, Inc.

# This file is part of GNU Emacs.

# GNU Emacs is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# GNU Emacs is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

### Commentary:

## Some targets:
## check: re-run all tests, writing to .log files.
## check-maybe: run all tests whose .log file needs updating
## filename.log: run tests from filename.el(c) if .log file needs updating
## filename: re-run tests from filename.el(c), with no logging

### Code:

SHELL = @SHELL@

srcdir = @srcdir@
VPATH = $(srcdir)

SEPCHAR = @SEPCHAR@

# We never change directory before running Emacs, so a relative file
# name is fine, and makes life easier.  If we need to change
# directory, we can use emacs --chdir.
EMACS = ../src/emacs

EMACS_EXTRAOPT=

# Command line flags for Emacs.
# Apparently MSYS bash would convert "-L :" to "-L ;" anyway,
# but we might as well be explicit.
EMACSOPT = -batch --no-site-file --no-site-lisp -L "$(SEPCHAR)$(srcdir)" $(EMACS_EXTRAOPT)

# Prevent any settings in the user environment causing problems.
unexport EMACSDATA EMACSDOC EMACSPATH GREP_OPTIONS

## To run tests under a debugger, set this to eg: "gdb --args".
GDB =

# The locale to run tests under.  Tests should work if this is set to
# any supported locale.  Use the C locale by default, as it should be
# supported everywhere.
TEST_LOCALE = C

# The actual Emacs command run in the targets below.
# Prevent any setting of EMACSLOADPATH in user environment causing problems.
emacs = EMACSLOADPATH= LC_ALL=$(TEST_LOCALE) EMACS_TEST_DIRECTORY=$(srcdir) \
 $(GDB) "$(EMACS)" $(EMACSOPT)

.PHONY: all check

all: check

%.elc: %.el
	@echo Compiling $<
	@$(emacs) -f batch-byte-compile $<

## Ignore any test errors so we can continue to test other files.
## But compilation errors are always fatal.
WRITE_LOG = > $@ 2>&1 || { stat=ERROR; cat $@; }; echo $$stat: $@

## I'd prefer to use -emacs -f ert-run-tests-batch-and-exit rather
## than || true, since the former makes problems more obvious.
## I'd also prefer to @-hide the grep part and not the
## ert-run-tests-batch-and-exit part.
##
## We need to use $loadfile because:
## i) -L :$srcdir -l basename does not work, because we have files whose
## basename duplicates a file in lisp/ (eg eshell.el).
## ii) Although -l basename will automatically load .el or .elc,
## -l ./basename treats basename as a literal file (it would be nice
## to change this; bug#17848 - if that gets done, this can be simplified).
##
## Beware: it approximates 'no-byte-compile', so watch out for false-positives!
%.log: %.el
	@if grep '^;.*no-byte-compile: t' $< > /dev/null; then \
	  loadfile=$<; \
	else \
	  loadfile=$<c; \
	  ${MAKE} $$loadfile; \
	fi; \
	echo Testing $$loadfile; \
	stat=OK ; \
	mkdir --parents $(dir $@) ; \
	$(emacs) -l ert -l $$loadfile \
	  -f ert-run-tests-batch-and-exit ${WRITE_LOG}

ELFILES = $(shell find ${srcdir} -path "${srcdir}/manual" -prune -o \
		-path "*resources" -prune -o -name "*el" -print)
## .elc files may be in a different directory for out of source builds
ELCFILES = $(patsubst %.el,%.elc, \
		$(patsubst $(srcdir)%,.%,$(ELFILES)))
LOGFILES = $(patsubst %.elc,%.log,${ELCFILES})
LOGSAVEFILES  = $(patsubst %.elc,%.log~,${ELCFILES})
TESTS = $(subst ${srcdir}/,,$(LOGFILES:.log=))

## If we have to interrupt a hanging test, preserve the log so we can
## see what the problem was.
.PRECIOUS: %.log

.PHONY: ${TESTS}

## The short aliases that always re-run the tests, with no logging.
## Define an alias both with and without the directory name for ease
## of use.
define test_template
$(1):
	@test ! -f ./$(1).log || mv ./$(1).log ./$(1).log~
	@${MAKE} ./$(1).log WRITE_LOG=

$(notdir $(1)): $(1)
endef

$(foreach test,${TESTS},$(eval $(call test_template,${test})))

## Include dependencies between test files and the files they test.
## We do this without the file and eval directly, but then we would
## have to run Emacs for every make invocation, and it might not be
## available during clean.
-include make-test-deps.mk

## Re-run all the tests every time.
check:
	-@for f in $(LOGFILES); do test ! -f $$f || mv $$f $$f~; done
	@${MAKE} check-maybe

## Only re-run tests whose .log is older than the test.
.PHONY: check-maybe
check-maybe: ${LOGFILES}
	$(emacs) -l ert -f ert-summarize-tests-batch-and-exit $^

.PHONY: mostlyclean clean bootstrap-clean distclean maintainer-clean

clean mostlyclean:
	-rm -f ${LOGFILES} ${LOGSAVEFILES}
	-rm make-test-deps.mk

bootstrap-clean: clean
	-rm -f ${ELCFILES}

distclean: clean
	rm -f Makefile

maintainer-clean: distclean bootstrap-clean

make-test-deps.mk: $(ELFILES) make-test-deps.emacs-lisp
	$(EMACS) --batch -l $(srcdir)/make-test-deps.emacs-lisp \
	--eval "(make-test-deps \"$(srcdir)\")" \
	2> $@
# Makefile ends here.