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