Makefile

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