CI: enable documentation testing
[tor.git] / Makefile.am
blob5d18666edca17f016a77a517d43f8d8d53b7c805
1 # Copyright (c) 2001-2004, Roger Dingledine
2 # Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson
3 # Copyright (c) 2007-2019, The Tor Project, Inc.
4 # See LICENSE for licensing information
6 ACLOCAL_AMFLAGS = -I m4
8 noinst_LIBRARIES=
9 EXTRA_DIST=
10 noinst_HEADERS=
11 bin_PROGRAMS=
12 EXTRA_PROGRAMS=
13 CLEANFILES=
14 TESTS=
15 noinst_PROGRAMS=
16 DISTCLEANFILES=
17 bin_SCRIPTS=
18 AM_CPPFLAGS=\
19         -I$(top_srcdir)/src \
20         -I$(top_srcdir)/src/ext \
21         -I$(top_srcdir)/src/ext/trunnel \
22         -I$(top_srcdir)/src/trunnel
24 AM_CFLAGS=@TOR_SYSTEMD_CFLAGS@ @CFLAGS_BUGTRAP@ @TOR_LZMA_CFLAGS@ @TOR_ZSTD_CFLAGS@
25 SHELL=@SHELL@
27 if COVERAGE_ENABLED
28 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor-cov$(EXEEXT)
29 else
30 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor$(EXEEXT)
31 endif
33 if USE_RUST
34 ## this MUST be $(), otherwise am__DEPENDENCIES will not track it
35 rust_ldadd=$(top_builddir)/$(TOR_RUST_LIB_PATH) \
36         $(TOR_RUST_EXTRA_LIBS)
37 else
38 rust_ldadd=
39 endif
41 # "Common" libraries used to link tor's utility code.
42 TOR_UTIL_LIBS = \
43         src/lib/libtor-geoip.a \
44         src/lib/libtor-process.a \
45         src/lib/libtor-time.a \
46         src/lib/libtor-fs.a \
47         src/lib/libtor-encoding.a \
48         src/lib/libtor-sandbox.a \
49         src/lib/libtor-container.a \
50         src/lib/libtor-net.a \
51         src/lib/libtor-thread.a \
52         src/lib/libtor-memarea.a \
53         src/lib/libtor-math.a \
54         src/lib/libtor-meminfo.a \
55         src/lib/libtor-osinfo.a \
56         src/lib/libtor-log.a \
57         src/lib/libtor-lock.a \
58         src/lib/libtor-fdio.a \
59         src/lib/libtor-string.a \
60         src/lib/libtor-term.a \
61         src/lib/libtor-smartlist-core.a \
62         src/lib/libtor-malloc.a \
63         src/lib/libtor-wallclock.a \
64         src/lib/libtor-err.a \
65         src/lib/libtor-intmath.a \
66         src/lib/libtor-ctime.a
68 # Variants of the above for linking the testing variant of tor (for coverage
69 # and tests)
70 if UNITTESTS_ENABLED
71 TOR_UTIL_TESTING_LIBS = \
72         src/lib/libtor-geoip-testing.a \
73         src/lib/libtor-process-testing.a \
74         src/lib/libtor-time-testing.a \
75         src/lib/libtor-fs-testing.a \
76         src/lib/libtor-encoding-testing.a \
77         src/lib/libtor-sandbox-testing.a \
78         src/lib/libtor-container-testing.a \
79         src/lib/libtor-net-testing.a \
80         src/lib/libtor-thread-testing.a \
81         src/lib/libtor-memarea-testing.a \
82         src/lib/libtor-math-testing.a \
83         src/lib/libtor-meminfo-testing.a \
84         src/lib/libtor-osinfo-testing.a \
85         src/lib/libtor-term-testing.a \
86         src/lib/libtor-log-testing.a \
87         src/lib/libtor-lock-testing.a \
88         src/lib/libtor-fdio-testing.a \
89         src/lib/libtor-string-testing.a \
90         src/lib/libtor-smartlist-core-testing.a \
91         src/lib/libtor-malloc-testing.a \
92         src/lib/libtor-wallclock-testing.a \
93         src/lib/libtor-err-testing.a \
94         src/lib/libtor-intmath.a \
95         src/lib/libtor-ctime-testing.a
96 endif
98 # Internal crypto libraries used in Tor
99 TOR_CRYPTO_LIBS = \
100         src/lib/libtor-tls.a \
101         src/lib/libtor-crypt-ops.a \
102         $(LIBKECCAK_TINY) \
103         $(LIBDONNA)
105 # Variants of the above for linking the testing variant of tor (for coverage
106 # and tests)
107 if UNITTESTS_ENABLED
108 TOR_CRYPTO_TESTING_LIBS = \
109         src/lib/libtor-tls-testing.a \
110         src/lib/libtor-crypt-ops-testing.a \
111         $(LIBKECCAK_TINY) \
112         $(LIBDONNA)
113 endif
115 # All static libraries used to link tor.
116 TOR_INTERNAL_LIBS = \
117         src/core/libtor-app.a \
118         src/lib/libtor-compress.a \
119         src/lib/libtor-evloop.a \
120         $(TOR_CRYPTO_LIBS) \
121         $(TOR_UTIL_LIBS) \
122         src/trunnel/libor-trunnel.a \
123         src/lib/libtor-trace.a
125 # Variants of the above for linking the testing variant of tor (for coverage
126 # and tests)
127 if UNITTESTS_ENABLED
128 TOR_INTERNAL_TESTING_LIBS = \
129         src/core/libtor-app-testing.a \
130         src/lib/libtor-compress-testing.a \
131         src/lib/libtor-evloop-testing.a \
132         $(TOR_CRYPTO_TESTING_LIBS) \
133         $(TOR_UTIL_TESTING_LIBS) \
134         src/trunnel/libor-trunnel-testing.a \
135         src/lib/libtor-trace.a
136 endif
138 TOR_LDFLAGS_CRYPTLIB=@TOR_LDFLAGS_openssl@
139 TOR_LIBS_CRYPTLIB=@TOR_OPENSSL_LIBS@
140 TOR_CFLAGS_CRYPTLIB=
141 if USE_NSS
142 TOR_CFLAGS_CRYPTLIB+=@NSS_CFLAGS@
143 TOR_LIBS_CRYPTLIB+=@NSS_LIBS@
144 endif
146 # All libraries used to link tor-cov
148 include src/include.am
149 include doc/include.am
150 include contrib/include.am
152 EXTRA_DIST+= \
153         ChangeLog                                       \
154         CONTRIBUTING                                    \
155         CODE_OF_CONDUCT                                 \
156         INSTALL                                         \
157         LICENSE                                         \
158         Makefile.nmake                                  \
159         README                                          \
160         ReleaseNotes                                    \
161         scripts/maint/checkIncludes.py                  \
162         scripts/maint/checkSpace.pl
164 ## This tells etags how to find mockable function definitions.
165 AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
167 if COVERAGE_ENABLED
168 TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
169 if DISABLE_ASSERTS_IN_UNIT_TESTS
170 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
171 else
172 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
173 endif
174 TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
175 else
176 TEST_CFLAGS=
177 TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
178 TEST_NETWORK_FLAGS=--hs-multi-client 1
179 endif
180 TEST_NETWORK_WARNING_FLAGS=--quiet --only-warnings
182 if LIBFUZZER_ENABLED
183 TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
184 # not "edge"
185 endif
187 TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
188 TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
190 #install-data-local:
191 #       $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
193 # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
194 # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
195 RPMBUILD ?= rpmbuild
197 # Use automake's dist-gzip target to build the tarball
198 dist-rpm: dist-gzip
199         TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S");                                \
200         RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX");      \
201         mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
202         cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/;                  \
203         LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec;  \
204         cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .;                                     \
205         cp -fa "$$RPM_BUILD_DIR"/RPMS/* .;                                      \
206         rm -rf "$$RPM_BUILD_DIR";                                               \
207         echo "RPM build finished";                                              \
208         #end of dist-rpm
210 doxygen:
211         doxygen && cd doc/doxygen/latex && make
213 test: all
214         $(top_builddir)/src/test/test
216 check-local: check-spaces check-changes check-includes
218 need-chutney-path:
219         @if test ! -d "$$CHUTNEY_PATH"; then \
220                 echo '$$CHUTNEY_PATH was not set.'; \
221                 if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
222                         echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
223                 else \
224                         echo; \
225                         echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
226                         exit 1; \
227                 fi \
228         fi
230 # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
231 # Chutney can be cloned from https://git.torproject.org/chutney.git .
232 test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
233         $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
235 # Run all available tests using automake's test-driver
236 # only run IPv6 tests if we can ping6 ::1 (localhost)
237 # only run IPv6 tests if we can ping ::1 (localhost)
238 # some IPv6 tests will fail without an IPv6 DNS server (see #16971 and #17011)
239 # only run mixed tests if we have a tor-stable binary
240 # Try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
241 # because they're incompatible
242 test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
243         mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
244         rm -f $(TEST_NETWORK_ALL_LOG_DIR)/*.log $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
245         @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
246         if ping6 -q -c 1 -o ::1 >/dev/null 2>&1 || ping6 -q -c 1 -W 1 ::1 >/dev/null 2>&1 || ping -6 -c 1 -W 1 ::1 >/dev/null 2>&1; then \
247                 echo "ping6 ::1 or ping ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
248                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
249         else \
250                 echo "ping6 ::1 and ping ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
251                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
252         fi; \
253         if command -v tor-stable >/dev/null 2>&1; then \
254                 echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
255                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
256         else \
257                 echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
258                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
259         fi; \
260         for f in $$skip_flavors; do \
261                 echo "SKIP: $$f"; \
262         done; \
263         for f in $$flavors; do \
264                 $(SHELL) $(top_srcdir)/test-driver --test-name $$f --log-file $(TEST_NETWORK_ALL_LOG_DIR)/$$f.log --trs-file $(TEST_NETWORK_ALL_LOG_DIR)/$$f.trs $(TEST_NETWORK_ALL_DRIVER_FLAGS) $(top_srcdir)/src/test/test-network.sh --flavor $$f $(TEST_NETWORK_FLAGS); \
265                 $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_WARNING_FLAGS); \
266         done; \
267         echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
268         ! grep -q FAIL $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
270 need-stem-path:
271         @if test ! -d "$$STEM_SOURCE_DIR"; then \
272                 echo '$$STEM_SOURCE_DIR was not set.'; echo; \
273                 echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
274                 exit 1; \
275         fi
277 test-stem: need-stem-path $(TESTING_TOR_BINARY)
278         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --integ --test control.controller --test control.base_controller --test process --log notice;
280 test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
281         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
283 test-full: need-stem-path need-chutney-path check test-network test-stem
285 test-full-online: need-stem-path need-chutney-path check test-network test-stem-full
287 # We can't delete the gcno files, because they are created when tor is compiled
288 reset-gcov:
289         rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda \
290               $(top_builddir)/src/*/*.gcov $(top_builddir)/src/*/*/*.gcov
292 HTML_COVER_DIR=$(top_builddir)/coverage_html
293 coverage-html: all
294 if COVERAGE_ENABLED
295         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
296         test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
297         lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
298         $(MAKE) reset-gcov
299         $(MAKE) check
300         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
301         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
302         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
303 else
304         @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
305 endif
307 coverage-html-full: all
308         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
309         test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
310         lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
311         $(MAKE) reset-gcov
312         $(MAKE) check
313         $(MAKE) test-stem-full
314         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
315         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
316         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
317         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
318         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
320 # Avoid strlcpy.c, strlcat.c, aes.c, OpenBSD_malloc_Linux.c, sha256.c,
321 # tinytest*.[ch]
322 check-spaces:
323 if USE_PERL
324         $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
325                 $(top_srcdir)/src/lib/*/*.[ch] \
326                 $(top_srcdir)/src/core/*/*.[ch] \
327                 $(top_srcdir)/src/feature/*/*.[ch] \
328                 $(top_srcdir)/src/app/*/*.[ch] \
329                 $(top_srcdir)/src/test/*.[ch] \
330                 $(top_srcdir)/src/test/*/*.[ch] \
331                 $(top_srcdir)/src/tools/*.[ch]
332 endif
334 check-includes:
335 if USEPYTHON
336         $(PYTHON) $(top_srcdir)/scripts/maint/checkIncludes.py
337 endif
339 check-docs: all
340         $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
342 check-logs:
343         $(top_srcdir)/scripts/maint/checkLogs.pl \
344                 $(top_srcdir)/src/*/*.[ch] | sort -n
346 .PHONY: check-typos
347 check-typos:
348         @if test -x "`which misspell 2>&1;true`"; then \
349                 echo "Checking for Typos ..."; \
350                 (misspell \
351                         $(top_srcdir)/src/[^e]*/*.[ch] \
352                         $(top_srcdir)/doc \
353                         $(top_srcdir)/contrib \
354                         $(top_srcdir)/scripts \
355                         $(top_srcdir)/README \
356                         $(top_srcdir)/ChangeLog \
357                         $(top_srcdir)/INSTALL \
358                         $(top_srcdir)/ReleaseNotes \
359                         $(top_srcdir)/LICENSE); \
360         else \
361                 echo "Tor can use misspell to check for typos."; \
362                 echo "It seems that you don't have misspell installed."; \
363                 echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
364         fi
366 .PHONY: rustfmt
367 rustfmt:
368 if USE_RUST
369         @if test -x "`which cargo-fmt 2>&1;true`"; then \
370                 echo "Formatting Rust code ..."; \
371                 (cd "$(top_srcdir)/src/rust" && cargo fmt --all --); \
372         else \
373                 echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
374                 echo "However, it seems that you don't have rustfmt installed."; \
375                 printf "You can install rustfmt by following the directions here:"; \
376                 echo " https://github.com/rust-lang-nursery/rustfmt"; \
377         fi
378 endif
380 .PHONY: check-rustfmt
381 check-rustfmt:
382 if USE_RUST
383         @if test -x "`which cargo-fmt 2>&1;true`"; then \
384                 printf "Running rustfmt..."; \
385                 (cd "$(top_srcdir)/src/rust" && cargo fmt --all -- --check && echo "done.") || \
386                 (echo "**************** check-rustfmt failed. ****************"; \
387                  echo "   Run \`make rustfmt\` to apply the above changes."; \
388                  exit 1); \
389         else \
390                 echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
391                 echo "However, it seems that you don't have rustfmt installed."; \
392                 printf "You can install rustfmt by following the directions here:"; \
393                 echo " https://github.com/rust-lang-nursery/rustfmt"; \
394         fi
395 endif
397 .PHONY: clippy
398 clippy:
399 if USE_RUST
400         @if test -x "`which cargo-clippy 2>&1;true`"; then \
401                 echo "Running cargo clippy ..."; \
402                 echo "Prepare yourself for the onslaught of suggestions ..."; \
403                 (cd "$(top_srcdir)/src/rust" && cargo clippy); \
404         else \
405                 echo "Tor can use clippy to lint Rust code."; \
406                 echo "However, it seems that you don't have clippy installed."; \
407                 echo "You can install the latest version of clippy by following the directions here: https://github.com/rust-lang-nursery/rust-clippy"; \
408         fi
409 endif
411 .PHONY: check-changes
412 check-changes:
413 if USEPYTHON
414         @if test -d "$(top_srcdir)/changes"; then \
415                 $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
416                 fi
417 endif
419 .PHONY: update-versions
420 update-versions:
421         $(PERL) $(top_builddir)/scripts/maint/updateVersions.pl
423 .PHONY: callgraph
424 callgraph:
425         $(top_builddir)/scripts/maint/run_calltool.sh
427 version:
428         @echo "Tor @VERSION@"
429         @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
430            echo -n "git: " ;\
431            (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
432         fi
434 mostlyclean-local:
435         rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
436         rm -rf $(HTML_COVER_DIR)
437         rm -rf $(top_builddir)/doc/doxygen
438         rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
440 clean-local:
441         rm -rf $(top_builddir)/src/rust/target
442         rm -rf $(top_builddir)/src/rust/.cargo/registry
444 if USE_RUST
445 distclean-local: distclean-rust
446 endif
448 # This relies on some internal details of how automake implements
449 # distcheck.  We check two directories because automake-1.15 changed
450 # from $(distdir)/_build to $(distdir)/_build/sub.
451 show-distdir-testlog:
452         @if test -d "$(distdir)/_build/sub"; then \
453           cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
454         else \
455           cat $(distdir)/_build/$(TEST_SUITE_LOG); fi
457 # Similarly, this relies on automake internals to run file on an
458 # intermittent core file whose provenance is not known to us.  See
459 # ticket 26787.
460 show-distdir-core:
461         @if test -d "$(distdir)/_build/sub"; then \
462           file $(distdir)/_build/sub/core ; \
463         else \
464           file $(distdir)/_build/core; fi
466 show-libs:
467         @echo $(TOR_INTERNAL_LIBS)
469 show-testing-libs:
470         @echo $(TOR_INTERNAL_TESTING_LIBS)