Makefile

   1
   2 # this Makefile requires GNU make
   3
   4 default: simple-build
   5
   6 PYTHON=python
   7 PATHSEP=$(shell python -c 'import os ; print os.pathsep')
   8 OSSEP=$(shell python -c 'import os ; print os.sep')
   9
  10 REACTOR=
  11
  12 ifneq ($(INCLUDE_DIRS),)
  13 INCLUDE_DIRS_ARG = -I$(INCLUDE_DIRS)
  14 endif
  15 ifneq ($(LIBRARY_DIRS),)
  16 LIBRARY_DIRS_ARG = -L$(LIBRARY_DIRS)
  17 endif
  18
  19 PLAT = $(strip $(shell python -c "import sys ; print sys.platform"))
  20 ifeq ($(PLAT),win32)
  21  # The platform is Windows with cygwin build tools and the native Python interpreter.
  22  SUPPORT = $(shell cygpath -w $(shell pwd))\support
  23  SUPPORTLIB := $(SUPPORT)\Lib\site-packages
  24  SRCPATH := $(shell cygpath -w $(shell pwd)/src)
  25  CHECK_PYWIN32_DEP := check-pywin32-dep
  26 else
  27  PYVER=$(shell $(PYTHON) misc/pyver.py)
  28  SUPPORT = $(shell pwd)/support
  29  SUPPORTLIB = $(SUPPORT)/lib/$(PYVER)/site-packages
  30  SRCPATH := $(shell pwd)/src
  31  CHECK_PYWIN32_DEP :=
  32 endif
  33
  34 TRIALCMD = $(shell PYTHONPATH="$(PYTHONPATH)$(PATHSEP)$(SRCPATH)" $(PYTHON) misc/find_trial.py)
  35
  36 ifeq ($(PLAT),cygwin)
  37 REACTOR = poll
  38 endif
  39
  40 ifneq ($(REACTOR),)
  41         REACTOROPT := --reactor=$(REACTOR)
  42 else
  43         REACTOROPT :=
  44 endif
  45
  46 TRIAL=PYTHONUNBUFFERED=1 $(TRIALCMD) --rterrors $(REACTOROPT)
  47
  48 build-auto-deps: check-deps
  49         mkdir -p "$(SUPPORTLIB)"
  50         echo PYTHONPATH="$(PYTHONPATH)$(PATHSEP)$(SUPPORTLIB)$(PATHSEP)" $(PYTHON) misc/dependencies/build-deps-setup.py install --prefix="$(SUPPORT)"
  51         @-PYTHONPATH="$(PYTHONPATH)$(PATHSEP)$(SUPPORTLIB)$(PATHSEP)" \
  52          $(PYTHON) misc/dependencies/build-deps-setup.py install \
  53          --prefix="$(SUPPORT)" || \
  54         echo "Build of Tahoe's bundled, automatically built dependent libraries failed -- please see docs/install.html for instructions."
  55
  56 # The following target is here because I don't know how to tell the buildmaster
  57 # to start instructing his slaves to "build-auto-deps" instead of instructing
  58 # them to "build-deps".  --Z
  59 build-deps: build-auto-deps
  60
  61 EGGSPATH = $(shell $(PYTHON) misc/find-dep-eggs.py)
  62 show-eggspath:
  63         @echo $(EGGSPATH)
  64
  65 ifneq ($(PYTHONPATH),)
  66         PYTHONPATH := $(PYTHONPATH)$(PATHSEP)
  67 endif
  68 PP=PYTHONPATH="$(SRCPATH)$(PATHSEP)$(PYTHONPATH)$(PATHSEP)$(EGGSPATH)"
  69
  70 .PHONY: make-version build
  71
  72 # The 'darcsver' setup.py command comes in the 'darcsver' package:
  73 # http://pypi.python.org/pypi/darcsver It is necessary only if you want to
  74 # automatically produce a new _version.py file from the current darcs history.
  75 make-version:
  76         $(PYTHON) ./setup.py darcsver
  77
  78 # We want src/allmydata/_version.py to be up-to-date, but it's a fairly
  79 # expensive operation (about 6 seconds on a just-before-0.7.0 tree, probably
  80 # because of the 332 patches since the last tag), and we've removed the need
  81 # for an explicit 'build' step by removing the C code from src/allmydata and
  82 # by running everything in place. It would be neat to do:
  83 #
  84 #src/allmydata/_version.py: _darcs/patches
  85 #       $(MAKE) make-version
  86 #
  87 # since that would update the embedded version string each time new darcs
  88 # patches were pulled, but 1) this would break non-darcs trees (i.e. building
  89 # from an exported tarball), and 2) without an obligatory 'build' step this
  90 # rule wouldn't be run frequently enought anyways.
  91 #
  92 # So instead, I'll just make sure that we update the version at least once
  93 # when we first start using the tree, and again whenever an explicit
  94 # 'make-version' is run, since then at least the developer has some means to
  95 # update things. It would be nice if 'make clean' deleted any
  96 # automatically-generated _version.py too, so that 'make clean; make all'
  97 # could be useable as a "what the heck is going on, get me back to a clean
  98 # state', but we need 'make clean' to work on non-darcs trees without
  99 # destroying useful information.
 100
 101 .built:
 102         $(MAKE) build
 103         touch .built
 104
 105 simple-build: build-auto-deps build
 106
 107 src/allmydata/_version.py:
 108         $(MAKE) make-version
 109
 110 build: src/allmydata/_version.py
 111         echo $(PYTHON) ./setup.py build_ext -i $(INCLUDE_DIRS_ARG) $(LIBRARY_DIRS_ARG)
 112         @$(PYTHON) ./setup.py build_ext -i $(INCLUDE_DIRS_ARG) $(LIBRARY_DIRS_ARG) || \
 113                 echo "Build of Allmydata-Tahoe failed -- please see docs/install.html for instructions."
 114         chmod +x bin/tahoe
 115
 116 # 'make install' will do the following:
 117 #   build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
 118 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
 119 # a different location
 120
 121 install: src/allmydata/_version.py
 122 ifdef PREFIX
 123         mkdir -p $(PREFIX)
 124         $(PP) $(PYTHON) ./setup.py install \
 125            --single-version-externally-managed \
 126            --prefix=$(PREFIX) --record=./tahoe.files
 127 else
 128         $(PP) $(PYTHON) ./setup.py install \
 129            --single-version-externally-managed
 130 endif
 131
 132
 133 # TESTING
 134
 135 .PHONY: check-all-deps check-twisted-dep $(CHECK_PYWIN32_DEP) signal-error-deps, signal-error-twisted-dep, signal-error-pywin32-dep, test test-figleaf figleaf-output
 136
 137
 138 signal-error-deps:
 139         @echo
 140         @echo
 141         @echo "ERROR: Not all of Tahoe's dependencies are in place.  Please \
 142 see the README for help on installing dependencies."
 143         @echo
 144         @echo
 145         exit 1
 146
 147 signal-error-twisted-dep:
 148         @echo
 149         @echo
 150         @echo "ERROR: Before running \"make build-auto-deps\" you have to ensure that \
 151 Twisted is installed (including its zope.interface dependency).  Twisted and \
 152 zope.interface are required for the automatic installation of certain other \
 153 libraries that Tahoe requires).  Please see the README for details."
 154         @echo
 155         @echo
 156         exit 1
 157
 158 signal-error-pywin32-dep:
 159         @echo
 160         @echo
 161         @echo "ERROR: the pywin32 dependency is not in place.  Please see the README \
 162 for help on installing dependencies."
 163         @echo
 164         @echo
 165         exit 1
 166
 167 signal-error-pyopenssl-dep:
 168         @echo
 169         @echo
 170         @echo "ERROR: the pyOpenSSL dependency is not in place (note that pyOpenSSL required \
 171 OpenSSL).  Please see the README for help on installing dependencies."
 172         @echo
 173         @echo
 174         exit 1
 175
 176 check-all-deps: check-deps
 177         $(PP) \
 178          $(PYTHON) -c 'import allmydata, zfec, foolscap, simplejson, nevow, pycryptopp' || $(MAKE) signal-error-deps
 179
 180 check-twisted-dep:
 181         $(PYTHON) -c 'import twisted, zope.interface' || $(MAKE) signal-error-twisted-dep
 182
 183 check-pywin32-dep:
 184         $(PYTHON) -c 'import win32process' || $(MAKE) signal-error-pywin32-dep
 185
 186 check-pyopenssl-dep:
 187         $(PYTHON) -c 'import OpenSSL' || $(MAKE) signal-error-pyopenssl-dep
 188
 189 check-deps: check-twisted-dep $(CHECK_PYWIN32_DEP) check-pyopenssl-dep
 190
 191 .checked-deps:
 192         $(MAKE) check-all-deps
 193         touch .checked-deps
 194
 195 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
 196 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
 197 # too.
 198 TEST=allmydata
 199
 200 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
 201 # suppress the ansi color sequences
 202
 203 test: .built .checked-deps
 204         $(PP) \
 205          $(TRIAL) $(TRIALARGS) $(TEST)
 206
 207 test-figleaf: .built .checked-deps
 208         rm -f .figleaf
 209         $(PP) \
 210          $(TRIAL) --reporter=bwverbose-figleaf $(TEST)
 211
 212 figleaf-output:
 213         $(PP) \
 214          $(PYTHON) misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes
 215         @echo "now point your browser at coverage-html/index.html"
 216
 217 # after doing test-figleaf and figleaf-output, point your browser at
 218 # coverage-html/index.html
 219
 220 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
 221 .PHONY: check-memory check-memory-once clean
 222
 223 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
 224 ifdef UPLOAD_TARGET
 225
 226 ifndef UPLOAD_HOST
 227 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
 228 endif
 229 ifndef COVERAGEDIR
 230 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
 231 endif
 232
 233 upload-figleaf:
 234         rsync -a coverage-html/ $(UPLOAD_TARGET)
 235         ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
 236 else
 237 upload-figleaf:
 238         echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
 239         /bin/false
 240 endif
 241
 242 .figleaf.el: .figleaf
 243         $(PP) \
 244          $(PYTHON) misc/figleaf2el.py .figleaf src
 245
 246 pyflakes:
 247         $(PYTHON) -OOu `which pyflakes` src/allmydata
 248
 249 count-lines:
 250         @echo -n "files: "
 251         @find src -name '*.py' |grep -v /build/ |wc --lines
 252         @echo -n "lines: "
 253         @cat `find src -name '*.py' |grep -v /build/` |wc --lines
 254         @echo -n "TODO: "
 255         @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
 256
 257 check-memory: .built
 258         rm -rf _test_memory
 259         $(PP) \
 260          $(PYTHON) src/allmydata/test/check_memory.py upload
 261         $(PP) \
 262          $(PYTHON) src/allmydata/test/check_memory.py upload-self
 263         $(PP) \
 264          $(PYTHON) src/allmydata/test/check_memory.py upload-POST
 265         $(PP) \
 266          $(PYTHON) src/allmydata/test/check_memory.py download
 267         $(PP) \
 268          $(PYTHON) src/allmydata/test/check_memory.py download-GET
 269         $(PP) \
 270          $(PYTHON) src/allmydata/test/check_memory.py download-GET-slow
 271         $(PP) \
 272          $(PYTHON) src/allmydata/test/check_memory.py receive
 273
 274 check-memory-once: .built
 275         rm -rf _test_memory
 276         $(PP) \
 277          $(PYTHON) src/allmydata/test/check_memory.py $(MODE)
 278
 279 # this target uses a pre-established client node to run a canned set of
 280 # performance tests against a test network that is also pre-established
 281 # (probably on a remote machine). Provide it with the path to a local
 282 # directory where this client node has been created (and populated with the
 283 # necessary FURLs of the test network). This target will start that client
 284 # with the current code and then run the tests. Afterwards it will stop the
 285 # client.
 286 #
 287 # The 'sleep 5' is in there to give the new client a chance to connect to its
 288 # storageservers, since check_speed.py has no good way of doing that itself.
 289
 290 check-speed: .built
 291         if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
 292         @echo "stopping any leftover client code"
 293         -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
 294         $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
 295         sleep 5
 296         $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
 297         $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
 298
 299 # 'make repl' is a simple-to-type command to get a Python interpreter loop
 300 # from which you can type 'import allmydata'
 301 repl:
 302         $(PP) python
 303
 304 test-darcs-boringfile:
 305         $(MAKE)
 306         $(PYTHON) misc/test-darcs-boringfile.py
 307
 308 test-clean:
 309         find . |grep -v allfiles.tmp |grep -v src/allmydata/_version.py |sort >allfiles.tmp.old
 310         $(MAKE)
 311         $(MAKE) clean
 312         find . |grep -v allfiles.tmp |grep -v src/allmydata/_version.py |sort >allfiles.tmp.new
 313         diff allfiles.tmp.old allfiles.tmp.new
 314
 315 clean:
 316         rm -rf build _trial_temp _test_memory .checked-deps .built
 317         rm -f debian
 318         rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
 319         rm -rf tahoe_deps.egg-info allmydata_tahoe.egg-info
 320         rm -rf support dist
 321         rm -rf setuptools*.egg *.pyc darcsver*.egg
 322
 323 find-trailing-spaces:
 324         $(PYTHON) misc/find-trailing-spaces.py -r src
 325
 326
 327 # DEBIAN PACKAGING
 328
 329 VER=$(shell $(PYTHON) misc/get-version.py)
 330 DEBCOMMENTS="'make deb' build"
 331
 332 show-version:
 333         @echo $(VER)
 334
 335 .PHONY: setup-deb deb-ARCH is-known-debian-arch
 336 .PHONY: deb-sid deb-feisty deb-edgy deb-etch
 337
 338 deb-sid:
 339         $(MAKE) deb-ARCH ARCH=sid
 340 deb-feisty:
 341         $(MAKE) deb-ARCH ARCH=feisty
 342 # edgy uses the feisty control files for now
 343 deb-edgy:
 344         $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
 345 # etch uses the feisty control files for now
 346 deb-etch:
 347         $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
 348 # same with gutsy, the process has been nicely stable for a while now
 349 deb-gutsy:
 350         $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
 351
 352 # we know how to handle the following debian architectures
 353 KNOWN_DEBIAN_ARCHES := sid feisty edgy etch gutsy
 354
 355 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
 356 is-known-debian-arch:
 357         @echo "ARCH must be set when using setup-deb or deb-ARCH"
 358         @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
 359         false
 360 else
 361 is-known-debian-arch:
 362         true
 363 endif
 364
 365 ifndef TAHOE_ARCH
 366 TAHOE_ARCH=$(ARCH)
 367 endif
 368
 369 setup-deb: is-known-debian-arch
 370         rm -f debian
 371         ln -s misc/$(TAHOE_ARCH)/debian debian
 372         chmod +x debian/rules
 373
 374 # etch (current debian stable) has python-simplejson-1.3, which doesn't
 375 #  support indent=
 376 # sid (debian unstable) currently has python-simplejson 1.7.1
 377 # edgy has 1.3, which doesn't support indent=
 378 # feisty has 1.4, which supports indent= but emits a deprecation warning
 379 # gutsy has 1.7.1
 380 #
 381 # we need 1.4 or newer
 382
 383 deb-ARCH: is-known-debian-arch setup-deb
 384         fakeroot debian/rules binary
 385         @echo
 386         @echo "The newly built .deb packages are in the parent directory from here."
 387
 388 .PHONY: increment-deb-version
 389 .PHONY: deb-sid-head deb-edgy-head deb-feisty-head
 390 .PHONY: deb-etch-head
 391
 392 # The buildbot runs the following targets after each change, to produce
 393 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
 394
 395 increment-deb-version: make-version
 396         debchange --newversion $(VER) $(DEBCOMMENTS)
 397 deb-sid-head:
 398         $(MAKE) setup-deb ARCH=sid
 399         $(MAKE) increment-deb-version
 400         fakeroot debian/rules binary
 401 deb-edgy-head:
 402         $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
 403         $(MAKE) increment-deb-version
 404         fakeroot debian/rules binary
 405 deb-feisty-head:
 406         $(MAKE) setup-deb ARCH=feisty
 407         $(MAKE) increment-deb-version
 408         fakeroot debian/rules binary
 409 deb-etch-head:
 410         $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
 411         $(MAKE) increment-deb-version
 412         fakeroot debian/rules binary
 413 deb-gutsy-head:
 414         $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
 415         $(MAKE) increment-deb-version
 416         fakeroot debian/rules binary