Makefile.in 10.5 KB
Newer Older
1 2
### @configure_input@

Paul Eggert's avatar
Paul Eggert committed
3
# Copyright (C) 2010-2020 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17

# 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
18
# along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
19

20 21 22
### Commentary:

## Some targets:
23
## check: re-run all tests, writing to .log files.
24 25
## check-maybe: run all tests which are outdated with their .log file
## or the source files they are testing.
26
## filename.log: run tests from filename.el(c) if .log file needs updating
27
## filename: re-run tests from filename.el(c), with no logging
28 29 30

### Code:

31
SHELL = @SHELL@
32 33

srcdir = @srcdir@
34
abs_top_srcdir=@abs_top_srcdir@
35 36
VPATH = $(srcdir)

Paul Eggert's avatar
Paul Eggert committed
37
FIND_DELETE = @FIND_DELETE@
38
MKDIR_P = @MKDIR_P@
39 40 41 42 43 44 45
CC = @CC@
CFLAGS = @CFLAGS@
PROFILING_CFLAGS = @PROFILING_CFLAGS@
WARN_CFLAGS = @WARN_CFLAGS@
WERROR_CFLAGS = @WERROR_CFLAGS@
CPPFLAGS = @CPPFLAGS@
SO = @MODULES_SUFFIX@
46

47
SEPCHAR = @SEPCHAR@
48

49 50 51 52

# 'make' verbosity.
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@

53 54 55 56 57
AM_V_CCLD = $(am__v_CCLD_@AM_V@)
am__v_CCLD_ = $(am__v_CCLD_@AM_DEFAULT_V@)
am__v_CCLD_0 = @echo "  CCLD    " $@;
am__v_CCLD_1 =

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
AM_V_ELC = $(am__v_ELC_@AM_V@)
am__v_ELC_ = $(am__v_ELC_@AM_DEFAULT_V@)
am__v_ELC_0 = @echo "  ELC     " $@;
am__v_ELC_1 =

AM_V_GEN = $(am__v_GEN_@AM_V@)
am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@)
am__v_GEN_0 = @echo "  GEN     " $@;
am__v_GEN_1 =

AM_V_at = $(am__v_at_@AM_V@)
am__v_at_ = $(am__v_at_@AM_DEFAULT_V@)
am__v_at_0 = @
am__v_at_1 =


74 75 76
# 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.
77
EMACS = ../src/emacs
78

79 80
EMACS_EXTRAOPT=

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

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

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

92 93 94 95 96
# 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

97 98 99 100
# Set this to 'yes' to run the tests in an interactive instance.
TEST_INTERACTIVE ?= no

ifeq ($(TEST_INTERACTIVE),yes)
101
TEST_RUN_ERT = --eval '(ert (quote ${SELECTOR_ACTUAL}))'
102
else
103
TEST_RUN_ERT = --batch --eval '(ert-run-tests-batch-and-exit (quote ${SELECTOR_ACTUAL}))' ${WRITE_LOG}
104 105
endif

106 107
# Whether to run tests from .el files in preference to .elc, we do
# this by default since it gives nicer stacktraces.
108
# If you just want a pass/fail, setting this to no is much faster.
109 110
export TEST_LOAD_EL ?= \
    $(if $(findstring $(MAKECMDGOALS), all check check-maybe),no,yes)
111

112 113 114
# Additional settings for ert.
ert_opts =

115 116 117 118
# Maximum length of lines in ert backtraces; nil for no limit.
# (if empty, use the default ert-batch-backtrace-right-margin).
TEST_BACKTRACE_LINE_LENGTH =

119 120 121 122
ifneq (${TEST_BACKTRACE_LINE_LENGTH},)
ert_opts += --eval '(setq ert-batch-backtrace-right-margin ${TEST_BACKTRACE_LINE_LENGTH})'
endif

123 124 125 126 127 128
ifeq (@HAVE_MODULES@, yes)
MODULES_EMACSOPT := --module-assertions
else
MODULES_EMACSOPT :=
endif

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

135 136 137 138 139
# Set HOME to a nonexistent directory to prevent tests from accessing
# it accidentally (e.g., popping up a gnupg dialog if ~/.authinfo.gpg
# exists, or writing to ~/.bzr.log when running bzr commands).
TEST_HOME = /nonexistent

140
test_module_dir := data/emacs-module
141

142
.PHONY: all check
143

144
all: check
145

146 147
SELECTOR_DEFAULT = (not (or (tag :expensive-test) (tag :unstable)))
SELECTOR_EXPENSIVE = (not (tag :unstable))
148
SELECTOR_ALL = t
Michael Albinus's avatar
Michael Albinus committed
149 150
ifdef SELECTOR
SELECTOR_ACTUAL=$(SELECTOR)
151 152 153 154
else ifndef MAKECMDGOALS
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
else ifeq ($(MAKECMDGOALS),all)
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
Michael Albinus's avatar
Michael Albinus committed
155 156 157
else ifeq ($(MAKECMDGOALS),check)
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
else ifeq ($(MAKECMDGOALS),check-maybe)
158 159
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
else
Michael Albinus's avatar
Michael Albinus committed
160
SELECTOR_ACTUAL=$(SELECTOR_EXPENSIVE)
161 162
endif

163 164
## Byte-compile all test files to test for errors.
%.elc: %.el
165
	$(AM_V_ELC)$(emacs) --batch -f batch-byte-compile $<
166 167

## Save logs, and show logs for failed tests.
168 169 170 171 172 173
WRITE_LOG = > $@ 2>&1 || { STAT=$$?; cat $@; exit $$STAT; }
ifdef EMACS_HYDRA_CI
## On Hydra, always show logs for certain problematic tests.
lisp/net/tramp-tests.log \
: WRITE_LOG = 2>&1 | tee $@
endif
174 175 176 177 178 179

ifeq ($(TEST_LOAD_EL), yes)
testloadfile = $*.el
else
testloadfile = $*
endif
180

181
%.log: %.elc
182
	$(AM_V_at)${MKDIR_P} $(dir $@)
183
	$(AM_V_GEN)HOME=$(TEST_HOME) $(emacs) \
184
	  -l ert ${ert_opts} -l $(testloadfile) \
185
	  $(TEST_RUN_ERT)
186

187 188 189 190 191 192
ifeq (@HAVE_MODULES@, yes)
maybe_exclude_module_tests :=
else
maybe_exclude_module_tests := -name emacs-module-tests.el -prune -o
endif

193 194 195 196 197 198
## Optional list of .el files to exclude from testing.
## Intended for use in automated testing where one or more files
## has some problem and needs to be excluded.
## To avoid writing full name, can use eg %foo-tests.el.
EXCLUDE_TESTS =

199 200 201 202
## To speed up parallel builds, put these slow test files (which can
## take longer than all the rest combined) at the start of the list.
SLOW_TESTS = ${srcdir}/lisp/net/tramp-tests.el

Paul Eggert's avatar
Paul Eggert committed
203 204
ELFILES := $(sort $(shell find ${srcdir} -name manual -prune -o \
		-name data -prune -o \
205 206
		-name "*resources" -prune -o \
		${maybe_exclude_module_tests} \
207
		-name "*.el" ! -name ".*" -print))
208 209 210

$(foreach slow,${SLOW_TESTS},$(eval ELFILES:= ${slow} $(filter-out ${slow},${ELFILES})))

211 212
$(foreach exclude,${EXCLUDE_TESTS},$(eval ELFILES:= $(filter-out ${exclude},${ELFILES})))

Paul Eggert's avatar
Paul Eggert committed
213
## .log files may be in a different directory for out of source builds
214
LOGFILES := $(patsubst %.el,%.log, \
215 216
		$(patsubst $(srcdir)/%,%,$(ELFILES)))
TESTS := $(LOGFILES:.log=)
217 218 219 220 221

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

222
## Stop make deleting these as intermediate files.
223
.SECONDARY: ${ELFILES:.el=.elc} $(test_module_dir)/*.o
224

225 226 227
.PHONY: ${TESTS}

define test_template
228 229
  ## A test FOO-tests depends on the source file with the similar
  ## name, unless FOO itself contains the string '-tests/'.
230
  ## The similar name is FOO.c if FOO begins with '{lib-,}src/', FOO.el
231 232 233 234
  ## otherwise.  Although this heuristic does not identify all the
  ## dependencies, it is better than nothing.
  ifeq (,$(patsubst %-tests,,$(1))$(findstring -tests/,$(1)))
    $(1).log: $(patsubst %-tests,$(srcdir)/../%,$(1))$(if \
235
					$(patsubst src/%,,$(patsubst lib-src/%,,$(1))),.el,.c)
236
    $(notdir $(1).log): $(1).log
237
  endif
238

239 240 241 242 243 244 245
  ## Short aliases that always re-run the tests, with no logging.
  ## Define both with and without the directory name for ease of use.
  .PHONY: $(1) $(notdir $(1))
  $(1):
	@test ! -f $(1).log || mv $(1).log $(1).log~
	@$(MAKE) $(1).log WRITE_LOG=
  $(notdir $(1)): $(1)
246 247 248 249
endef

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

250
ifeq (@HAVE_MODULES@, yes)
251 252 253 254 255 256 257
# -fPIC is a no-op on Windows, but causes a compiler warning
ifeq ($(SO),.dll)
FPIC_CFLAGS =
else
FPIC_CFLAGS = -fPIC
endif

Paul Eggert's avatar
Paul Eggert committed
258
GMP_H = @GMP_H@
Paul Eggert's avatar
Paul Eggert committed
259
LIBGMP = @LIBGMP@
Paul Eggert's avatar
Paul Eggert committed
260

261
MODULE_CFLAGS = -I../src -I$(srcdir)/../src -I../lib -I$(srcdir)/../lib \
Paul Eggert's avatar
Paul Eggert committed
262
  $(FPIC_CFLAGS) $(PROFILING_CFLAGS) \
263 264
  $(WARN_CFLAGS) $(WERROR_CFLAGS) $(CFLAGS)

265
test_module = $(test_module_dir)/mod-test${SO}
266
src/emacs-module-tests.log src/emacs-module-tests.elc: $(test_module)
267 268 269 270 271

# In the compilation command, we can't use any object or archive file
# as source because those are not compiled with -fPIC.  Therefore we
# use only source files.
$(test_module): $(test_module:${SO}=.c) ../src/emacs-module.h
272
	$(AM_V_at)${MKDIR_P} $(dir $@)
273
	$(AM_V_CCLD)$(CC) -shared $(CPPFLAGS) $(MODULE_CFLAGS) $(LDFLAGS) \
Paul Eggert's avatar
Paul Eggert committed
274
	  -o $@ $< $(LIBGMP) \
Paul Eggert's avatar
Paul Eggert committed
275
	  $(and $(GMP_H),$(srcdir)/../lib/mini-gmp-gnulib.c) \
276
	  $(srcdir)/../lib/timespec.c $(srcdir)/../lib/gettime.c
277 278
endif

Paul Eggert's avatar
Paul Eggert committed
279 280 281 282 283
## Check that there is no 'automated' subdirectory, which would
## indicate an incomplete merge from an older version of Emacs where
## the tests were arranged differently.
.PHONY: check-no-automated-subdir
check-no-automated-subdir:
284
	${AM_V_at}test ! -d $(srcdir)/automated
Paul Eggert's avatar
Paul Eggert committed
285

286
## Rerun all default tests.
Paul Eggert's avatar
Paul Eggert committed
287
check: mostlyclean check-no-automated-subdir
288
	@${MAKE} check-doit SELECTOR="${SELECTOR_ACTUAL}"
289

290
## Rerun all default and expensive tests.
291
.PHONY: check-expensive
Paul Eggert's avatar
Paul Eggert committed
292
check-expensive: mostlyclean check-no-automated-subdir
293 294
	@${MAKE} check-doit SELECTOR="${SELECTOR_EXPENSIVE}"

295 296 297 298 299
## Run all tests, regardless of tag.
.PHONY: check-all
check-all: mostlyclean check-no-automated-subdir
	@${MAKE} check-doit SELECTOR="${SELECTOR_ALL}"

300 301
## Re-run all tests which are outdated. A test is outdated if its
## logfile is out-of-date with either the test file, or the source
302
## files that the tests depend on.  See test_template.
303
.PHONY: check-maybe
Paul Eggert's avatar
Paul Eggert committed
304
check-maybe: check-no-automated-subdir
305
	@${MAKE} check-doit SELECTOR="${SELECTOR_ACTUAL}"
306 307 308

## Run the tests.
.PHONY: check-doit
309 310 311
## We can't put LOGFILES as prerequisites, because that would stop the
## summarizing step from running when there is an error.
check-doit:
312 313 314 315 316 317
ifeq ($(TEST_INTERACTIVE), yes)
	HOME=$(TEST_HOME) $(emacs) \
	  -l ert ${ert_opts} \
	  $(patsubst %,-l %,$(if $(findstring $(TEST_LOAD_EL),yes),$ELFILES,$(ELFILES:.el=)))  \
	  $(TEST_RUN_ERT)
else
318
	-@${MAKE} -k  ${LOGFILES}
Glenn Morris's avatar
Glenn Morris committed
319
	@$(emacs) --batch -l ert --eval \
320
	"(ert-summarize-tests-batch-and-exit ${SUMMARIZE_TESTS})" ${LOGFILES}
321
endif
322 323 324

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

325
mostlyclean:
326
	-@for f in ${LOGFILES}; do test ! -f $$f || mv $$f $$f~; done
327
	rm -f ./*.tmp
328 329

clean:
Paul Eggert's avatar
Paul Eggert committed
330
	find . '(' -name '*.log' -o -name '*.log~' ')' $(FIND_DELETE)
331 332
	rm -f $(test_module_dir)/*.o $(test_module_dir)/*.so \
	  $(test_module_dir)/*.dll
333 334

bootstrap-clean: clean
Paul Eggert's avatar
Paul Eggert committed
335
	find $(srcdir) -name '*.elc' $(FIND_DELETE)
336 337

distclean: clean
338
	rm -f Makefile
339 340

maintainer-clean: distclean bootstrap-clean
341 342 343 344 345 346

.PHONY: check-declare

check-declare:
	$(emacs) -l check-declare \
	  --eval '(check-declare-directory "$(srcdir)")'