Makefile.am

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