xref: /petsc/gmakefile.test (revision 76be6f4ff3bd4e251c19fc00ebbebfd58b6e7589)
1# -*- mode: makefile-gmake -*-
2-include petscdir.mk
3
4.SUFFIXES: .F  .F90 .f90 ${SUFFIXES} .PETSc .C .cc .cpp .cxx .r .rm .so .html .ad .m .tex .make  .fig .svg .eps .pdf .jpg .png .dvi .ps .F95 .f95 .fiat .cu .kokkos.cxx .raja.cxx .hip.cpp .sycl.cxx
5
6CONFIGDIR := $(PETSC_DIR)/config
7
8# TESTSRCDIR is always relative to gmakefile.test
9#  This must be before includes
10mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
11TESTSRCDIR := $(dir $(mkfile_path))src
12
13-include $(PETSC_DIR)/$(PETSC_ARCH)/lib/petsc/conf/petscvariables
14-include $(PETSC_DIR)/lib/petsc/conf/variables
15
16TESTDIR ?= ./$(PETSC_ARCH)/tests
17MODDIR := $(PETSC_DIR)/$(PETSC_ARCH)/include
18TESTLOGTAPFILE ?= $(TESTDIR)/test_$(PETSC_ARCH)_tap.log
19TESTLOGERRFILE ?= $(TESTDIR)/test_$(PETSC_ARCH)_err.log
20EXAMPLESDIR := $(TESTSRCDIR)
21
22pkgs := sys vec mat dm ksp snes ts tao
23
24petscconf      := $(PETSC_DIR)/$(PETSC_ARCH)/include/petscconf.h
25petscvariables := $(PETSC_DIR)/$(PETSC_ARCH)/lib/petsc/conf/petscvariables
26generatedtest  := $(TESTDIR)/testfiles
27
28.SECONDEXPANSION:		# to expand $$(@D)/.DIR
29
30TESTFLAGS :=             # Initialize as simple variable
31
32#workaround old cygwin versions
33ifeq ($(PETSC_CYGWIN_BROKEN_PIPE),1)
34ifeq ($(shell basename $(AR)),ar)
35  V ?=1
36endif
37endif
38V ?= $(if $(findstring s,$(MAKEFLAGS)),0)
39ifeq ($(V),)  # Default
40  quiet_HELP := "Use \"$(MAKE) V=1\" to see verbose compile lines, \"$(MAKE) V=0\" to suppress.\n"
41  quiet = @printf $(quiet_HELP)$(eval quiet_HELP:=)"  %10s %s\n" "$1$2" "$@"; $($1)
42  quiettest = @printf "  %10s %s\n" "TEST" "$(@:$(TESTDIR)/counts/%.counts=%)";
43else ifeq ($(V),0)		# Suppress entire command
44  quiet = @$($1)
45  quiettest = @
46  TESTFLAGS += -o err_only
47else				# Show the full command line
48  quiet = $($1)
49  quiettest =
50  TESTFLAGS += -v
51endif
52
53ifeq ($(FORCE),1)
54  TESTFLAGS += -f    # force test execution
55endif
56ifeq ($(CUDAMEMCHECK),1)
57  TESTFLAGS += -U    # Add cuda-memcheck option to the flags
58endif
59ifeq ($(VALGRIND),1)
60  TESTFLAGS += -V    # Add valgrind option to the flags
61endif
62ifeq ($(DEBUG),1)
63  TESTFLAGS += -d    # Launch test in debugger
64endif
65ifeq ($(REPLACE),1)
66  TESTFLAGS += -m    # Replace results by passing -m to petscdiff
67endif
68ifeq ($(OUTPUT),1)
69  TESTFLAGS += -o 'err_only'    # Show only the errors on stdout
70endif
71ifeq ($(ALT),1)
72  TESTFLAGS += -M    # Replace alt files by passing -M to petscdiff
73endif
74PRINTONLY ?= 0
75ifeq ($(PRINTONLY),1)
76  TESTFLAGS += -p    # Pass -p to petscdiff to print only command
77endif
78ifeq ($(DIFF_NUMBERS),1)
79  TESTFLAGS += -j    # Pass -j to petscdiff to diff the actual numbers
80endif
81ifdef OPTIONS
82  TESTFLAGS += -a '$(OPTIONS)'   # override arguments
83endif
84ifdef EXTRA_OPTIONS
85  TESTFLAGS += -e '$(EXTRA_OPTIONS)'  # add extra arguments
86endif
87ifdef NP
88  TESTFLAGS += -n $(NP)  # set number of processes
89endif
90# Override the default timeout that may be found at the top of config/petsc_harness.sh
91# This must be an integer.  It is given in seconds.
92ifdef TIMEOUT
93  TESTFLAGS += -t $(TIMEOUT)  # Override the default timeout
94endif
95
96$(generatedtest) : $(petscconf) $(petscvariables) $(CONFIGDIR)/gmakegentest.py $(TESTDIR)/.DIR | $$(@D)/.DIR
97	$(PYTHON) $(CONFIGDIR)/gmakegentest.py --petsc-dir=$(PETSC_DIR) --petsc-arch=$(PETSC_ARCH) --testdir=$(TESTDIR)
98
99ifneq ($(filter-out clean check info libs all checkbadSource allfortranstubs alletags,$(MAKECMDGOALS:clean%=clean)),)
100include $(generatedtest)
101endif
102
103ifeq ($(PETSC_LANGUAGE),CXXONLY)
104  cc_name := CXX
105else
106  cc_name := CC
107endif
108
109PETSC_COMPILE.c = $(call quiet,$(cc_name)) -c $(PCC_FLAGS) $($(CLANGUAGE)FLAGS) $(CCPPFLAGS) $(C_DEPFLAGS)
110PETSC_COMPILE.cxx = $(call quiet,CXX) -c $(CXX_FLAGS) $(CXXFLAGS) $(CXXCPPFLAGS) $(CXX_DEPFLAGS)
111PETSC_COMPILE.cu = $(call quiet,CUDAC) -c $(MPICXX_INCLUDES) $(CUDAC_FLAGS) $(CUFLAGS) --compiler-options="${PETSC_CCPPFLAGS} $(CUDACPPFLAGS) $(CUDA_CXXFLAGS)"
112PETSC_COMPILE.hip.cpp = $(call quiet,HIPC)   -c $(MPICXX_INCLUDES) $(HIPC_FLAGS) $(HIPPP_FLAGS) $(HIPFLAGS) $(HIPPPFLAGS) $(HIPOPTFLAGS) $(HIPC_DEPFLAGS) $(CXXFLAGS) $(CXXCPPFLAGS) $(HIP_DEPFLAGS)
113PETSC_COMPILE.sycl.cxx = $(call quiet,SYCLC) -c $(MPICXX_INCLUDES) $(SYCLC_FLAGS) $(SYCLPP_FLAGS) $(SYCLFLAGS) $(SYCLPPFLAGS) $(SYCLOPTFLAGS) $(CXXFLAGS) $(CXXCPPFLAGS) $(SYCL_DEPFLAGS)
114PETSC_GENDEPS.cu = $(call quiet,CUDAC,.dep) --generate-dependencies --output-directory=$(@D) $(MPICXX_INCLUDES) $(CUDAC_FLAGS) $(CUFLAGS)  --compiler-options="${PETSC_CCPPFLAGS} $(CUDA_CXXFLAGS)"
115PETSC_COMPILE.F = $(call quiet,FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS)
116
117ifneq ($(KOKKOS_USE_CUDA_COMPILER),)
118  # Kokkos requires nvcc to be in PATH and the C++ compiler to be given in an environmental variable
119  KOKC = PATH=`dirname $(CUDAC)`:$(PATH) NVCC_WRAPPER_DEFAULT_COMPILER="$(CUDA_CXX)" $(KOKKOS_BIN)/nvcc_wrapper --expt-extended-lambda
120  PETSC_COMPILE.kokkos.cxx = $(call quiet,KOKC) -c $(CUDAC_FLAGS) ${PETSC_CCPPFLAGS} $(CUDACPPFLAGS) $(CUDA_CXXFLAGS) $(MPICXX_INCLUDES)
121  PETSC_LINK.kokkos.cxx = $(KOKC) $(CUDAC_FLAGS) $(MPICXX_INCLUDES) ${PETSC_CCPPFLAGS} $(CUDA_CXXFLAGS) $(CUDA_CXXLIBS) $(MPICXX_LIBS) $(LDFLAGS)
122else ifneq ($(KOKKOS_USE_HIP_COMPILER),)
123  PETSC_COMPILE.kokkos.cxx = $(PETSC_COMPILE.hip.cpp)
124  PETSC_LINK.kokkos.cxx = $(HIPC) $(HIPFLAGS) $(CXXFLAGS) $(PETSC_CCPPFLAGS) $(CPPFLAGS) $(LDFLAGS) $(MPICXX_INCLUDES) $(MPICXX_LIBS)
125else ifneq ($(KOKKOS_USE_SYCL_COMPILER),)
126  PETSC_COMPILE.kokkos.cxx = $(PETSC_COMPILE.sycl.cxx)
127  PETSC_LINK.kokkos.cxx = $(SYCLC) $(SYCLFLAGS) $(CXXFLAGS) $(PETSC_CCPPFLAGS) $(CPPFLAGS) $(LDFLAGS) $(MPICXX_INCLUDES) $(MPICXX_LIBS)
128else
129  PETSC_COMPILE.kokkos.cxx = $(PETSC_COMPILE.cxx)
130  PETSC_LINK.kokkos.cxx = $(CXXLINKER) $(CXXFLAGS) $(PETSC_CCPPFLAGS) $(CPPFLAGS) $(LDFLAGS)
131endif
132
133ifneq ($(RAJA_USE_CUDA_COMPILER),)
134  PETSC_COMPILE.raja.cxx  = ${CUDAC} $(MPICXX_INCLUDES) ${CUDAC_FLAGS} ${CUFLAGS} -x cu -Xcudafe "--display_error_number" -c --compiler-options="${PETSC_CCPPFLAGS} ${PETSC_CC_INCLUDES} ${CUDA_CXXFLAGS}" --expt-extended-lambda --expt-relaxed-constexpr
135else
136  PETSC_COMPILE.raja.cxx = ${CXX} -o $*.o -c ${CXX_FLAGS} ${CXXFLAGS} ${CXXCPPFLAGS}
137endif
138
139testlangs := c cu cxx F F90 kokkos.cxx hip.cpp sycl.cxx raja.cxx
140$(foreach lang, $(testlangs), $(eval \
141  testexe.$(lang) = $(foreach pkg, $(pkgs), $(testsrcs-$(pkg).$(lang):%.$(lang)=$(TESTDIR)/%))))
142concattestlang = $(foreach lang, $(2), $(testsrcs-$(1).$(lang):%.$(lang)=$(TESTDIR)/%.o))
143testsrcs.o := $(foreach pkg, $(pkgs), $(call concattestlang,$(pkg),$(testlangs)))
144testsrcs-rel := $(foreach pkg, $(pkgs), $(foreach lang, $(testlangs), $(testsrcs-$(pkg).$(lang))))
145testsrcs := $(foreach sfile, $(testsrcs-rel), $(TESTSRCDIR)/$(sfile))
146
147# workaround win32fe failure
148ifneq (,$(findstring win32fe,$(call quiet,$(cc_name))))
149$(TESTDIR)/ts/tutorials/multirate/ex6: | $(TESTDIR)/ts/tutorials/multirate/ex5
150$(TESTDIR)/ts/tutorials/multirate/ex8: | $(TESTDIR)/ts/tutorials/multirate/ex6
151endif
152
153# Refresh testfiles when sources change, but don't balk if the source file is nonexistent (deleted)
154$(generatedtest) : $(testsrcs)
155$(testsrcs) :
156
157$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.c | $$(@D)/.DIR
158	$(PETSC_COMPILE.c) $(abspath $<) -o $@
159
160$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.kokkos.cxx | $$(@D)/.DIR
161	$(PETSC_COMPILE.kokkos.cxx) $(abspath $<) -o $@
162
163$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.sycl.cxx | $$(@D)/.DIR
164	$(PETSC_COMPILE.sycl.cxx) $(abspath $<) -o $@
165
166$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.raja.cxx | $$(@D)/.DIR
167	$(PETSC_COMPILE.raja.cxx) $(abspath $<) -o $@
168
169$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.cxx | $$(@D)/.DIR
170	$(PETSC_COMPILE.cxx) $(abspath $<) -o $@
171
172$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.cu | $$(@D)/.DIR
173	$(PETSC_COMPILE.cu) $(abspath $<) -o $@ # Compile first so that if there is an error, it comes from a normal compile
174	@$(PETSC_GENDEPS.cu) $(abspath $<) -o $(@:%.o=%.d) # Generate the dependencies for later
175
176$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.hip.cpp | $$(@D)/.DIR
177	$(PETSC_COMPILE.hip.cpp) $(abspath $<) -o $@
178
179# Test modules go in the same directory as the target *.o
180TESTMODDIR = $(@D)
181FCMOD = cd
182$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.F | $$(@D)/.DIR
183ifeq ($(FC_MODULE_OUTPUT_FLAG),)
184	$(call quiet,FCMOD) $(TESTMODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) -I$(dir $<) $(abspath $<) -o $(abspath $@)
185else
186	$(PETSC_COMPILE.F) -I$(dir $<) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(TESTMODDIR) $(FC_MODULE_FLAG)$(TESTMODDIR)
187endif
188	-@$(GFORTRAN_DEP_CLEANUP)
189
190$(TESTDIR)/%.o : $(EXAMPLESDIR)/%.F90 | $$(@D)/.DIR
191ifeq ($(FC_MODULE_OUTPUT_FLAG),)
192	$(call quiet,FCMOD) $(TESTMODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) -I$(dir $<) $(abspath $<) -o $(abspath $@)
193else
194	$(PETSC_COMPILE.F) -I$(dir $<) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(TESTMODDIR) $(FC_MODULE_FLAG)$(TESTMODDIR)
195endif
196	-@$(GFORTRAN_DEP_CLEANUP)
197
198#   This is a hack to fix a broken gfortran.
199define GFORTRAN_DEP_CLEANUP
200  if test -e "$(@:%.o=%.d)" && head -1 "$(@:%.o=%.d)" | fgrep -q -v : ; then\
201    echo "$(@): \\" > $(@:%.o=%.dtemp) ; \
202    tr '\n' '@' < $(@:%.o=%.d) | cut -d: -f2- | tr '@' '\n' >> $(@:%.o=%.dtemp) ; \
203    mv $(@:%.o=%.dtemp) $(@:%.o=%.d); \
204  fi
205endef
206
207# link line constructed differently for gmakefile vs gmakefile.test invocation
208ifeq ($(libpetscall),)
209PETSC_TEST_LIB = $(PETSC_LIB)
210else
211PETSC_TEST_LIB = $(C_SH_LIB_PATH) $(PETSC_EXTERNAL_LIB_BASIC)
212endif
213
214# manually list some some library dependencies to check for circular dependencies
215$(TESTDIR)/sys/tests/ex9: PETSC_TEST_LIB = $(PETSC_SYS_LIB)
216$(TESTDIR)/vec/vec/tests/ex1: PETSC_TEST_LIB = $(PETSC_VEC_LIB)
217$(TESTDIR)/mat/tests/ex1: PETSC_TEST_LIB = $(PETSC_MAT_LIB)
218$(TESTDIR)/dm/tests/ex1: PETSC_TEST_LIB = $(PETSC_DM_LIB)
219$(TESTDIR)/ksp/ksp/tests/ex1: PETSC_TEST_LIB = $(PETSC_KSP_LIB)
220$(TESTDIR)/snes/tests/ex1: PETSC_TEST_LIB = $(PETSC_SNES_LIB)
221$(TESTDIR)/ts/tests/ex2: PETSC_TEST_LIB = $(PETSC_TS_LIB)
222$(TESTDIR)/tao/tutorials/ex1: PETSC_TEST_LIB = $(PETSC_TAO_LIB)
223
224# MACOS FIREWALL HANDLING
225# - if run with MACOS_FIREWALL=1
226#   (automatically set in $PETSC_ARCH/lib/petsc/conf/petscvariables if configured --with-macos-firewall-rules),
227#   ensure mpiexec and test executable is on firewall list
228#
229ifeq ($(MACOS_FIREWALL),1)
230FW := /usr/libexec/ApplicationFirewall/socketfilterfw
231# There is no reliable realpath command in macOS without need for 3rd party tools like homebrew coreutils
232# Using Python's realpath seems like the most robust way here
233realpath-py = $(shell $(PYTHON) -c 'import os, sys; print(os.path.realpath(sys.argv[1]))' $(1))
234#
235define macos-firewall-register
236  @APP=$(call realpath-py, $(1)); \
237    if ! sudo -n true 2>/dev/null; then printf "Asking for sudo password to add new firewall rule for\n  $$APP\n"; fi; \
238    sudo $(FW) --remove $$APP --add $$APP --blockapp $$APP
239endef
240endif
241#
242macos-firewall-register-mpiexec:
243	-$(call macos-firewall-register, $(MPIEXEC))
244
245# Test executables
246$(testexe.F) $(testexe.F90) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall)
247	$(call quiet,FLINKER) -o $@ $^ $(PETSC_TEST_LIB)
248	-$(call macos-firewall-register,$@)
249
250$(testexe.c) $(testexe.cu) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall)
251	$(call quiet,CLINKER) $(EXEFLAGS) -o $@ $^ $(PETSC_TEST_LIB)
252	-$(call macos-firewall-register,$@)
253
254$(testexe.hip.cpp) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall)
255	$(call quiet,CLINKER) -o $@ $^ $(PETSC_TEST_LIB)
256	-$(call macos-firewall-register,$@)
257
258$(testexe.kokkos.cxx) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall)
259	$(call quiet,PETSC_LINK.kokkos.cxx) -o $@ $^ $(PETSC_TEST_LIB)
260	-$(call macos-firewall-register,$@)
261
262$(testexe.raja.cxx) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall)
263	$(call quiet,CLINKER) -o $@ $^ $(PETSC_TEST_LIB)
264	-$(call macos-firewall-register,$@)
265
266$(testexe.cxx) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall)
267	$(call quiet,CXXLINKER) -o $@ $^ $(PETSC_TEST_LIB)
268	-$(call macos-firewall-register,$@)
269
270# Fortran source files need petsc*.mod, which isn't explicitly managed in the makefile.
271$(foreach pkg, $(pkgs), $(call concattestlang,$(pkg),F F90)) : $(libpetscall)
272
273# Testing convenience targets
274.PHONY: test pre-clean
275
276test: report_tests
277
278pre-clean:
279	@$(RM) -rf $(TESTDIR)/counts $(TESTLOGTAPFILE) $(TESTLOGERRFILE)
280	@touch $(TESTLOGTAPFILE) $(TESTLOGERRFILE)
281	@echo "Using MAKEFLAGS:" ${MAKEFLAGS}
282
283check-test-errors:
284	@grep '^not ok' $(TESTLOGTAPFILE) | grep -v 'Exceeded timeout' | tee $(TESTDIR)/allgtests-tap-err.log
285	@test ! -s $(TESTDIR)/allgtests-tap-err.log
286
287.PHONY: $(foreach pkg, $(pkgs), test-$(pkg) $(foreach lang, $(testlangs), test-$(pkg).$(lang) test-rm-$(pkg).$(lang)))
288testpkgs := $(foreach pkg, $(pkgs), test-$(pkg))
289# Targets to run tests in test-$pkg.$lang and delete the executables, language by language
290$(testpkgs) : test-% : $(foreach lang, $(testlangs), test-rm-%.$(lang))
291# List of raw test run targets
292alltesttargets := $(foreach tp, $(testpkgs), $(foreach lang, $(testlangs), $($(tp).$(lang))))
293
294# Run targets
295$(alltesttargets) : % : $(TESTDIR)/counts/%.counts
296.PHONY: $(alltesttargets)
297
298$(TESTDIR)/counts/%.counts :
299	$(quiettest) $< $(TESTFLAGS)
300
301# Targets to run tests and remove executables, by package-lang pairs.
302# Run the tests in each batch using recursive invocation of make because
303# we need all of them to complete before removing the executables.  Make
304# doesn't guarantee an exploration order for the graph.  Only recursive
305# if there is something to be done.
306alltest-rm := $(foreach pkg, $(pkgs), $(foreach lang, $(testlangs), test-rm-$(pkg).$(lang)))
307$(alltest-rm) : test-rm-% : test-%
308ifneq ($(NO_RM),1)
309	$(call quiet,RM) $(addprefix $(TESTDIR)/,$(basename $($(@:test-rm-%=testsrcs-%))))
310endif
311
312# Remove intermediate .o files
313# This only removes the files at the end which is insufficient
314#.INTERMEDIATE: $(testsrcs.o:%.o=%)
315
316# all sources should get recompiled when petscvariables changes (i.e when configure is rerun or when petscvariables is manually edited.)
317$(testsrcs.o) : $(petscvariables)
318
319%/.DIR :
320	@mkdir -p $(@D)
321	@touch $@
322
323.PRECIOUS: %/.DIR
324
325.SUFFIXES: # Clear .SUFFIXES because we don't use implicit rules
326.DELETE_ON_ERROR:               # Delete likely-corrupt target file if rule fails
327
328.PHONY: clean cleantest all
329
330cleantest:
331	${RM} -r $(TESTDIR) $(generatedtest)
332
333clean: cleantest
334
335alltest.d := $(testsrcs.o:%.o=%.d)
336# Tell make that alltest.d are all up to date.  Without this, the include
337# below has quadratic complexity, taking more than one second for a
338# do-nothing build of PETSc (much worse for larger projects)
339$(alltest.d) : ;
340
341-include $(alltest.d)
342
343# Tests can be generated by searching -- see documentation below
344showreport=
345ifndef searchin
346   searchin = " "
347endif
348ifdef i
349   searchin = $(i)
350endif
351ifdef gs
352  gmakesearch = $(gs)
353endif
354ifdef gmakesearch
355  TESTTARGETS := $(filter $(gmakesearch),$(alltesttargets))
356  ifdef gmakesearchin
357    TESTTARGETS2 := $(foreach v,$(TESTTARGETS),$(if $(findstring $(gmakesearchin),$(v)),$(v)))
358    TESTTARGETS := $(TESTTARGETS2)
359  endif
360else ifdef gmakesearchin
361  TESTTARGETS := $(foreach v,$(alltesttargets),$(if $(findstring $(gmakesearchin),$(v)),$(v)))
362else ifdef argsearch
363  TESTTARGETS := $(foreach v,$(alltesttargets),$(if $(findstring $(argsearch),$($(v)_ARGS)),$(v)))
364else ifdef search
365  TESTTARGETS := $(shell $(PYTHON) $(CONFIGDIR)/query_tests.py --testdir=$(TESTDIR) --petsc-dir=$(PETSC_DIR) --petsc-arch=$(PETSC_ARCH) --searchin=$(searchin) 'name' '$(search)')
366else ifdef s
367  TESTTARGETS := $(shell $(PYTHON) $(CONFIGDIR)/query_tests.py --testdir=$(TESTDIR) --petsc-dir=$(PETSC_DIR) --petsc-arch=$(PETSC_ARCH) --searchin=$(searchin) 'name' '$(s)')
368else ifdef test-fail
369  TESTTARGETS := $(shell $(TESTDIR)/echofailures.sh)
370else ifdef query
371  TESTTARGETS := $(shell $(PYTHON) $(CONFIGDIR)/query_tests.py --testdir=$(TESTDIR) --petsc-dir=$(PETSC_DIR) --petsc-arch=$(PETSC_ARCH) --searchin=$(searchin) '$(query)' '$(queryval)')
372else ifdef q
373  TESTTARGETS := $(shell $(PYTHON) $(CONFIGDIR)/query_tests.py --testdir=$(TESTDIR) --petsc-dir=$(PETSC_DIR) --petsc-arch=$(PETSC_ARCH) --searchin=$(searchin) '$(q)' '$(qv)')
374else                            # No filter - run them all, but delete the executables as we go
375  TESTTARGETS := $(testpkgs)
376  ifneq ($(PRINTONLY),1)
377    showreport = "-s"  # Only show full report when all tests are run
378  endif
379endif
380
381.PHONY: report_tests print-test
382
383print-test:
384	$(info $(TESTTARGETS))
385	@true
386
387show-fail:
388	-@$(PYTHON) $(CONFIGDIR)/report_tests.py -d $(TESTDIR)/counts -f
389
390
391
392# Don't start running tests until starttime has completed
393$(alltesttargets:%=$(TESTDIR)/counts/%.counts) : starttime
394
395# Ensure that libpetsc (if it is a prerequisite) has been built and clean the counts/logs before starting timer
396starttime: pre-clean $(libpetscall) macos-firewall-register-mpiexec
397	@$(eval STARTTIME := $(shell date +%s))
398
399report_tests: starttime $(TESTTARGETS)
400	@$(eval ENDTIME := $(shell date +%s))
401	-@ elapsed_time=$$(($(ENDTIME)- $(STARTTIME))) && \
402	$(PYTHON) $(CONFIGDIR)/report_tests.py -m $(MAKE) -d $(TESTDIR)/counts -t 5 -e $${elapsed_time} $(showreport)
403
404check_output:
405	$(PYTHON) $(CONFIGDIR)/gmakegentest.py --petsc-dir=$(PETSC_DIR) --petsc-arch=$(PETSC_ARCH) --testdir=$(TESTDIR) --check-output
406
407# Do not how how to invoke test from makefile
408HASGMAKEFILE := $(filter gmakefile,$(MAKEFILE_LIST))
409ifeq ($(HASGMAKEFILE),gmakefile)
410helpdeps:=help-make help-targets
411makefile="gmakefile"
412other_help="To see full test help: make -f gmakefile.test help"
413else
414helpdeps:=help-make help-targets help-test
415makefile="gmakefile.test"
416other_help=""
417endif
418
419help: ${helpdeps}
420	-@echo "Above is from: ${helpdeps}"
421	-@echo "${other_help}"
422
423help-make:
424	-@echo
425	-@echo "Basic build usage:"
426	-@echo "   make -f ${makefile} <options>"
427	-@echo
428	-@echo "Options:"
429	-@echo "  V=0           Very quiet builds"
430	-@echo "  V=1           Verbose builds"
431	-@echo
432
433help-targets:
434	-@echo "All makefile targets and their dependencies:"
435	-@grep ^[a-z] ${makefile} | grep : | grep -v =
436	-@echo
437	-@echo
438
439help-test:
440	-@echo "Basic test usage:"
441	-@echo "   make -f ${makefile} test <options>"
442	-@echo
443	-@echo "Options:"
444	-@echo "  V=1               Verbose output (-v to scripts)"
445	-@echo "  NO_RM=1           Do not remove the executables after running"
446	-@echo "  REPLACE=1         Replace the output in PETSC_DIR source tree (-m to test scripts)"
447	-@echo "  OUTPUT=1          Show only the errors on stdout"
448	-@echo "  ALT=1             Replace 'alt' output in PETSC_DIR source tree (-M to test scripts)"
449	-@echo "  DIFF_NUMBERS=1    Diff the numbers in the output (-j to test scripts and petscdiff)"
450	-@echo "  CUDAMEMCHECK=1    Execute the tests using cuda-memcheck (-U to test scripts)"
451	-@echo "                    Use PETSC_CUDAMEMCHECK_COMMAND to change the executable to run and"
452	-@echo "                    PETSC_CUDAMEMCHECK_ARGS to change the arguments (note: both"
453	-@echo "                    cuda-memcheck and compute-sanitizer are supported)"
454	-@echo "  VALGRIND=1        Execute the tests using valgrind (-V to test scripts)"
455	-@echo "  DEBUG=1           Launch tests in the debugger (-d to the scripts)"
456	-@echo "  NP=<num proc>     Set a number of processors to pass to scripts."
457	-@echo "  FORCE=1           Force SKIP or TODO tests to run"
458	-@echo "  PRINTONLY=1       Print the command, but do not run.  For loops print first command"
459	-@echo "  TIMEOUT=<time>    Test timeout limit in seconds (default in config/petsc_harness.sh)"
460	-@echo "  TESTDIR='tests'   Subdirectory where tests are run ($${PETSC_DIR}/$${PETSC_ARCH}/$${TESTDIR}"
461	-@echo "                    or $${PREFIX_DIR}/$${TESTDIR}"
462	-@echo "                    or $${PREFIX_DIR}/share/petsc/examples/$${TESTDIR})"
463	-@echo "  TESTBASE='tests'   Subdirectory where tests are run ($${PETSC_DIR}/$${PETSC_ARCH}/$${TESTDIR}"
464	-@echo "  OPTIONS='<args>'  Override options to scripts (-a to test scripts)"
465	-@echo "  EXTRA_OPTIONS='<args>'  Add options to scripts (-e to test scripts)"
466	-@echo
467	-@echo "Special options for macOS:"
468	-@echo "  MACOS_FIREWALL=1  Add each built test to the macOS firewall list to prevent popups. Configure --with-macos-firewall-rules to make this default"
469	-@echo
470	-@echo "Tests can be generated by searching with multiple methods"
471	-@echo "  For general searching (using config/query_test.py):"
472	-@echo "    make -f ${makefile} test search='sys*ex2*'"
473	-@echo "   or the shortcut using s"
474	-@echo "    make -f ${makefile} test s='sys*ex2*'"
475	-@echo "  You can also use the full path to a file directory"
476	-@echo "    make -f ${makefile} test s='src/sys/tests/'"
477	-@echo
478	-@echo "  To search for fields from the original test definitions:"
479	-@echo "    make -f ${makefile} test query='requires' queryval='*MPI_PROCESS_SHARED_MEMORY*'"
480	-@echo "   or the shortcut using q and qv"
481	-@echo "    make -f ${makefile} test q='requires' qv='*MPI_PROCESS_SHARED_MEMORY*'"
482	-@echo "  To filter results from other searches, use searchin"
483	-@echo "    make -f ${makefile} test s='src/sys/tests/' searchin='*options*'"
484	-@echo
485	-@echo "  To re-run the last tests which failed:"
486	-@echo "    make -f ${makefile} test test-fail='1'"
487	-@echo
488	-@echo "  To see which targets match a given pattern (useful for doing a specific target):"
489	-@echo "    make -f ${makefile} print-test search=sys*"
490	-@echo
491	-@echo "  To build an executable, give full path to location:"
492	-@echo '    make -f ${makefile} $${PETSC_ARCH}/tests/sys/tests/ex1'
493	-@echo "  or make the test with NO_RM=1"
494	-@echo
495