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

Paul Eggert's avatar
Paul Eggert committed
3
# Copyright (C) 2010-2021 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
top_builddir = @top_builddir@
36 37
VPATH = $(srcdir)

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

48
SEPCHAR = @SEPCHAR@
49

50
HAVE_NATIVE_COMP = @HAVE_NATIVE_COMP@
51

Paul Eggert's avatar
Paul Eggert committed
52 53
REPLACE_FREE = @REPLACE_FREE@

54
-include ${top_builddir}/src/verbose.mk
55

56 57 58 59 60 61 62 63 64
# Load any GNU ELPA dependencies that are present, for optional tests.
GNU_ELPA_DIRECTORY ?= $(srcdir)/../../elpa
# Keep elpa_dependencies dependency-ordered.
elpa_dependencies = \
	url-http-ntlm/url-http-ntlm.el \
	web-server/web-server.el
elpa_els = $(addprefix $(GNU_ELPA_DIRECTORY)/packages/,$(elpa_dependencies))
elpa_opts = $(foreach el,$(elpa_els),$(and $(wildcard $(el)),-L $(dir $(el)) -l $(el)))

65 66 67
# 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.
68
EMACS = ../src/emacs
69

70 71
EMACS_EXTRAOPT=

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

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

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

83 84 85 86
# Set this to 'yes' to run the tests in an interactive instance.
TEST_INTERACTIVE ?= no

ifeq ($(TEST_INTERACTIVE),yes)
87
TEST_RUN_ERT = --eval '(ert (quote ${SELECTOR_ACTUAL}))'
88
else
89
TEST_RUN_ERT = --batch --eval '(ert-run-tests-batch-and-exit (quote ${SELECTOR_ACTUAL}))' ${WRITE_LOG}
90 91
endif

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

98
# Additional settings for ert.
99
ert_opts += $(elpa_opts)
100

101 102 103 104
# 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 =

105 106 107 108
ifneq (${TEST_BACKTRACE_LINE_LENGTH},)
ert_opts += --eval '(setq ert-batch-backtrace-right-margin ${TEST_BACKTRACE_LINE_LENGTH})'
endif

109 110 111 112 113 114
ifeq (@HAVE_MODULES@, yes)
MODULES_EMACSOPT := --module-assertions
else
MODULES_EMACSOPT :=
endif

115
# The actual Emacs command run in the targets below.
116 117 118
# Prevent any setting of EMACSLOADPATH in user environment causing problems,
# and prevent locals to influence the text of the errors we expect to receive.
emacs = LANG=C EMACSLOADPATH= 		   \
119
 EMACS_TEST_DIRECTORY=$(abspath $(srcdir)) \
120
 $(GDB) "$(EMACS)" $(MODULES_EMACSOPT) $(EMACSOPT)
121

122 123 124
# 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).
125 126
# NOTE if the '/nonexistent' name is changed `normal-top-level' in
# startup.el must be updated too.
127 128
TEST_HOME = /nonexistent

129
test_module_dir := src/emacs-module-resources
130

131
.PHONY: all check
132

133
all: check
134

135
ifeq ($(HAVE_NATIVE_COMP),yes)
136 137
SELECTOR_DEFAULT = (not (or (tag :expensive-test) (tag :unstable)))
SELECTOR_EXPENSIVE = (not (tag :unstable))
138
SELECTOR_ALL = t
139 140 141 142 143
else
SELECTOR_DEFAULT = (not (or (tag :expensive-test) (tag :unstable) (tag :nativecomp)))
SELECTOR_EXPENSIVE = (not (or (tag :unstable) (tag :nativecomp)))
SELECTOR_ALL = (not (tag :nativecomp))
endif
Michael Albinus's avatar
Michael Albinus committed
144 145
ifdef SELECTOR
SELECTOR_ACTUAL=$(SELECTOR)
146 147 148 149
else ifndef MAKECMDGOALS
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
else ifeq ($(MAKECMDGOALS),all)
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
Michael Albinus's avatar
Michael Albinus committed
150 151 152
else ifeq ($(MAKECMDGOALS),check)
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
else ifeq ($(MAKECMDGOALS),check-maybe)
153 154
SELECTOR_ACTUAL=$(SELECTOR_DEFAULT)
else
Michael Albinus's avatar
Michael Albinus committed
155
SELECTOR_ACTUAL=$(SELECTOR_EXPENSIVE)
156 157
endif

158 159
## Byte-compile all test files to test for errors.
%.elc: %.el
160
	$(AM_V_ELC)$(emacs) --batch -f batch-byte-compile $<
161 162

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

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

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

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

192 193 194 195 196 197
## 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 =

198 199 200 201
## 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
202 203
ELFILES := $(sort $(shell find ${srcdir} -name manual -prune -o \
		-name data -prune -o \
204 205
		-name "*resources" -prune -o \
		${maybe_exclude_module_tests} \
206
		-name "*.el" ! -name ".*" -print))
207 208 209

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

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

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

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

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

224 225 226
.PHONY: ${TESTS}

define test_template
227 228
  ## A test FOO-tests depends on the source file with the similar
  ## name, unless FOO itself contains the string '-tests/'.
229
  ## The similar name is FOO.c if FOO begins with '{lib-,}src/', FOO.el
230 231 232 233
  ## 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 \
234
					$(patsubst src/%,,$(patsubst lib-src/%,,$(1))),.el,.c)
235
    $(notdir $(1).log): $(1).log
236
  endif
237

238 239 240 241 242 243 244
  ## 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)
245 246 247 248
endef

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

249
## Get the tests for only a specific directory.
250
SUBDIRS = $(sort $(shell cd ${srcdir} && find lib-src lisp misc src -type d ! -path "*resources*" -print))
251 252 253 254 255

define subdir_template
  .PHONY: check-$(subst /,-,$(1))
  check-$(subst /,-,$(1)):
	@${MAKE} check LOGFILES="$(patsubst %.el,%.log, \
256
		$(patsubst $(srcdir)/%,%,$(wildcard ${srcdir}/$(1)/*.el)))"
257 258 259
endef

$(foreach subdir, $(SUBDIRS), $(eval $(call subdir_template,$(subdir))))
260

261
ifeq (@HAVE_MODULES@, yes)
262 263 264 265 266 267 268
# -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
269
GMP_H = @GMP_H@
Paul Eggert's avatar
Paul Eggert committed
270
LIBGMP = @LIBGMP@
Paul Eggert's avatar
Paul Eggert committed
271

272
MODULE_CFLAGS = -I../src -I$(srcdir)/../src -I../lib -I$(srcdir)/../lib \
Paul Eggert's avatar
Paul Eggert committed
273
  $(FPIC_CFLAGS) $(PROFILING_CFLAGS) \
274 275
  $(WARN_CFLAGS) $(WERROR_CFLAGS) $(CFLAGS)

276
test_module = $(test_module_dir)/mod-test${SO}
277
src/emacs-module-tests.log src/emacs-module-tests.elc: $(test_module)
278

Paul Eggert's avatar
Paul Eggert committed
279 280 281
FREE_SOURCE_0 =
FREE_SOURCE_1 = $(srcdir)/../lib/free.c

282 283 284 285
# 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
286
	$(AM_V_at)${MKDIR_P} $(dir $@)
287
	$(AM_V_CCLD)$(CC) -shared $(CPPFLAGS) $(MODULE_CFLAGS) $(LDFLAGS) \
Paul Eggert's avatar
Paul Eggert committed
288
	  -o $@ $< $(LIBGMP) \
Paul Eggert's avatar
Paul Eggert committed
289
	  $(and $(GMP_H),$(srcdir)/../lib/mini-gmp-gnulib.c) \
Paul Eggert's avatar
Paul Eggert committed
290
	  $(FREE_SOURCE_$(REPLACE_FREE)) \
291
	  $(srcdir)/../lib/timespec.c $(srcdir)/../lib/gettime.c
292 293
endif

294 295
src/emacs-tests.log: ../lib-src/seccomp-filter.c

Paul Eggert's avatar
Paul Eggert committed
296 297 298 299 300
## 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:
301
	${AM_V_at}test ! -d $(srcdir)/automated
Paul Eggert's avatar
Paul Eggert committed
302

303
## Rerun all default tests.
Paul Eggert's avatar
Paul Eggert committed
304
check: mostlyclean check-no-automated-subdir
305
	@${MAKE} check-doit SELECTOR="${SELECTOR_ACTUAL}"
306

307
## Rerun all default and expensive tests.
308
.PHONY: check-expensive
Paul Eggert's avatar
Paul Eggert committed
309
check-expensive: mostlyclean check-no-automated-subdir
310 311
	@${MAKE} check-doit SELECTOR="${SELECTOR_EXPENSIVE}"

312 313 314 315 316
## Run all tests, regardless of tag.
.PHONY: check-all
check-all: mostlyclean check-no-automated-subdir
	@${MAKE} check-doit SELECTOR="${SELECTOR_ALL}"

317 318
## 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
319
## files that the tests depend on.  See test_template.
320
.PHONY: check-maybe
Paul Eggert's avatar
Paul Eggert committed
321
check-maybe: check-no-automated-subdir
322
	@${MAKE} check-doit SELECTOR="${SELECTOR_ACTUAL}"
323 324 325

## Run the tests.
.PHONY: check-doit
326 327 328
## We can't put LOGFILES as prerequisites, because that would stop the
## summarizing step from running when there is an error.
check-doit:
329 330 331
ifeq ($(TEST_INTERACTIVE), yes)
	HOME=$(TEST_HOME) $(emacs) \
	  -l ert ${ert_opts} \
332
	  $(patsubst %,-l %,$(if $(findstring $(TEST_LOAD_EL),yes),$ELFILES,$(ELFILES:.el=))) \
333 334
	  $(TEST_RUN_ERT)
else
335
	-@${MAKE} -k ${LOGFILES}
Glenn Morris's avatar
Glenn Morris committed
336
	@$(emacs) --batch -l ert --eval \
337
	"(ert-summarize-tests-batch-and-exit ${SUMMARIZE_TESTS})" ${LOGFILES}
338
endif
339 340 341

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

342
mostlyclean:
343
	-@for f in ${LOGFILES}; do test ! -f $$f || mv $$f $$f~; done
344
	rm -f ./*.tmp
345 346

clean:
Paul Eggert's avatar
Paul Eggert committed
347
	find . '(' -name '*.log' -o -name '*.log~' ')' $(FIND_DELETE)
348
	rm -f ${srcdir}/lisp/gnus/mml-sec-resources/random_seed
349 350
	rm -f $(test_module_dir)/*.o $(test_module_dir)/*.so \
	  $(test_module_dir)/*.dll
351 352

bootstrap-clean: clean
Paul Eggert's avatar
Paul Eggert committed
353
	find $(srcdir) -name '*.elc' $(FIND_DELETE)
354 355

distclean: clean
356
	rm -f Makefile
357 358

maintainer-clean: distclean bootstrap-clean
359 360 361 362 363 364

.PHONY: check-declare

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