Fix a check-spaces warning.
[tor.git] / Makefile.am
blobc160af9732697ee846259416ea5a536fae965362
1 # Copyright (c) 2001-2004, Roger Dingledine
2 # Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson
3 # Copyright (c) 2007-2015, 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 CLEANFILES=
13 TESTS=
14 noinst_PROGRAMS=
15 DISTCLEANFILES=
16 bin_SCRIPTS=
17 AM_CPPFLAGS=
18 AM_CFLAGS=@TOR_SYSTEMD_CFLAGS@ @CFLAGS_BUGTRAP@
19 SHELL=@SHELL@
21 if COVERAGE_ENABLED
22 TESTING_TOR_BINARY=$(top_builddir)/src/or/tor-cov$(EXEEXT)
23 else
24 TESTING_TOR_BINARY=$(top_builddir)/src/or/tor$(EXEEXT)
25 endif
27 include src/include.am
28 include doc/include.am
29 include contrib/include.am
31 EXTRA_DIST+= \
32         ChangeLog                                       \
33         INSTALL                                         \
34         LICENSE                                         \
35         Makefile.nmake                                  \
36         README                                          \
37         ReleaseNotes
39 if COVERAGE_ENABLED
40 TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
41 if DISABLE_ASSERTS_IN_UNIT_TESTS
42 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS
43 else
44 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE
45 endif
46 TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
47 else
48 TEST_CFLAGS=
49 TEST_CPPFLAGS=-DTOR_UNIT_TESTS
50 TEST_NETWORK_FLAGS=--hs-multi-client 1
51 endif
53 TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
54 TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
56 #install-data-local:
57 #       $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
59 # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
60 # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
61 RPMBUILD ?= rpmbuild
63 # Use automake's dist-gzip target to build the tarball
64 dist-rpm: dist-gzip
65         TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S");                                \
66         RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX");      \
67         mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
68         cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/;                  \
69         LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec;  \
70         cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .;                                     \
71         cp -fa "$$RPM_BUILD_DIR"/RPMS/* .;                                      \
72         rm -rf "$$RPM_BUILD_DIR";                                               \
73         echo "RPM build finished";                                              \
74         #end of dist-rpm
76 doxygen:
77         doxygen && cd doc/doxygen/latex && make
79 test: all
80         $(top_builddir)/src/test/test
82 need-chutney-path:
83         @if test ! -d "$$CHUTNEY_PATH"; then \
84                 echo '$$CHUTNEY_PATH was not set.'; \
85                 if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
86                         echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
87                 else \
88                         echo; \
89                         echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
90                         exit 1; \
91                 fi \
92         fi
94 # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
95 # Chutney can be cloned from https://git.torproject.org/chutney.git .
96 test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
97         $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
99 # Run all available tests using automake's test-driver
100 # only run IPv6 tests if we can ping6 ::1 (localhost)
101 # some IPv6 tests will fail without an IPv6 DNS server (see #16971 and #17011)
102 # only run mixed tests if we have a tor-stable binary
103 # Try both the BSD and the Linux ping6 syntax, because they're incompatible
104 test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
105         mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
106         @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
107         if ping6 -q -c 1 -o ::1 >/dev/null 2>&1 || ping6 -q -c 1 -W 1 ::1 >/dev/null 2>&1; then \
108                 echo "ping6 ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
109                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
110         else \
111                 echo "ping6 ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
112                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
113         fi; \
114         if command -v tor-stable >/dev/null 2>&1; then \
115                 echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
116                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
117         else \
118                 echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
119                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
120         fi; \
121         for f in $$skip_flavors; do \
122                 echo "SKIP: $$f"; \
123         done; \
124         for f in $$flavors; do \
125                 $(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); \
126         done; \
127         echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
128         ! grep -q FAIL test_network_log/*.trs
130 need-stem-path:
131         @if test ! -d "$$STEM_SOURCE_DIR"; then \
132                 echo '$$STEM_SOURCE_DIR was not set.'; echo; \
133                 echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
134                 exit 1; \
135         fi
137 test-stem: need-stem-path $(TESTING_TOR_BINARY)
138         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL;
140 test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
141         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
143 test-full: need-stem-path need-chutney-path check test-network test-stem
145 test-full-online: need-stem-path need-chutney-path check test-network test-stem-full
147 reset-gcov:
148         rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda
150 HTML_COVER_DIR=$(top_builddir)/coverage_html
151 coverage-html: all
152 if COVERAGE_ENABLED
153         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
154         test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
155         lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
156         $(MAKE) reset-gcov
157         $(MAKE) check
158         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
159         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
160         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
161 else
162         @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
163 endif
165 coverage-html-full: all
166         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
167         test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
168         lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
169         $(MAKE) reset-gcov
170         $(MAKE) check
171         $(MAKE) test-stem-full
172         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
173         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
174         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
175         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
176         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
178 # Avoid strlcpy.c, strlcat.c, aes.c, OpenBSD_malloc_Linux.c, sha256.c,
179 # tinytest*.[ch]
180 check-spaces:
181         $(top_srcdir)/scripts/maint/checkSpace.pl -C \
182                 $(top_srcdir)/src/common/*.[ch] \
183                 $(top_srcdir)/src/or/*.[ch] \
184                 $(top_srcdir)/src/test/*.[ch] \
185                 $(top_srcdir)/src/tools/*.[ch]
187 check-docs: all
188         $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
190 check-logs:
191         $(top_srcdir)/scripts/maint/checkLogs.pl \
192                 $(top_srcdir)/src/*/*.[ch] | sort -n
194 .PHONY: check-changes
195 check-changes:
196         @if test -d "$(top_srcdir)/changes"; then \
197                 $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes/*; \
198                 fi
200 .PHONY: update-versions
201 update-versions:
202         $(PERL) $(top_builddir)/scripts/maint/updateVersions.pl
204 version:
205         @echo "Tor @VERSION@"
206         @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
207            echo -n "git: " ;\
208            (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
209         fi
211 mostlyclean-local:
212         rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
213         rm -rf $(HTML_COVER_DIR)
214         rm -rf $(top_builddir)/doc/doxygen
215         rm -rf $(TEST_NETWORK_ALL_LOG_DIR)