2 # this Makefile requires GNU make
7 PATHSEP=$(shell python -c 'import os ; print os.pathsep')
8 OSSEP=$(shell python -c 'import os ; print os.sep')
12 ifneq ($(INCLUDE_DIRS),)
13 INCLUDE_DIRS_ARG = -I$(INCLUDE_DIRS)
15 ifneq ($(LIBRARY_DIRS),)
16 LIBRARY_DIRS_ARG = -L$(LIBRARY_DIRS)
19 PLAT = $(strip $(shell python -c "import sys ; print sys.platform"))
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
27 PYVER=$(shell $(PYTHON) misc/pyver.py)
28 SUPPORT = $(shell pwd)/support
29 SUPPORTLIB = $(SUPPORT)/lib/$(PYVER)/site-packages
30 SRCPATH := $(shell pwd)/src
34 TRIALCMD = $(shell PYTHONPATH="$(PYTHONPATH)$(PATHSEP)$(SRCPATH)" $(PYTHON) misc/find_trial.py)
41 REACTOROPT := --reactor=$(REACTOR)
46 TRIAL=PYTHONUNBUFFERED=1 $(TRIALCMD) --rterrors $(REACTOROPT)
48 build-auto-deps: check-deps
49 mkdir -p "$(SUPPORTLIB)"
50 @echo PYTHONPATH="$(PYTHONPATH)$(PATHSEP)$(SUPPORTLIB)$(PATHSEP)" \
51 $(PYTHON) misc/dependencies/build-deps-setup.py easy_install --prefix="$(SUPPORT)" --always-unzip misc/dependencies
52 @PYTHONPATH="$(PYTHONPATH)$(PATHSEP)$(SUPPORTLIB)$(PATHSEP)" \
53 $(PYTHON) misc/dependencies/build-deps-setup.py easy_install --prefix="$(SUPPORT)" --always-unzip misc/dependencies || \
54 ( echo "Build of Tahoe's bundled, automatically built dependent libraries failed -- please see docs/install.html for instructions." && false )
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
61 EGGSPATH = $(shell $(PYTHON) misc/find-dep-eggs.py)
65 ifneq ($(PYTHONPATH),)
66 PYTHONPATH := $(PYTHONPATH)$(PATHSEP)
68 PP=PYTHONPATH="$(SRCPATH)$(PATHSEP)$(PYTHONPATH)$(PATHSEP)$(EGGSPATH)"
70 .PHONY: make-version build
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.
76 $(PYTHON) ./setup.py darcsver
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:
84 #src/allmydata/_version.py: _darcs/patches
85 # $(MAKE) make-version
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.
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.
105 simple-build: build-auto-deps build
107 src/allmydata/_version.py:
110 build: src/allmydata/_version.py
111 @echo $(PYTHON) ./setup.py build_ext -i $(INCLUDE_DIRS_ARG) $(LIBRARY_DIRS_ARG) && chmod +x bin/tahoe
112 @( $(PYTHON) ./setup.py build_ext -i $(INCLUDE_DIRS_ARG) $(LIBRARY_DIRS_ARG) && chmod +x bin/tahoe ) || \
113 ( echo "Build of Allmydata-Tahoe failed -- please see docs/install.html for instructions." && false )
115 # 'make install' will do the following:
116 # build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
117 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
118 # a different location
120 install: src/allmydata/_version.py
123 $(PP) $(PYTHON) ./setup.py install \
124 --single-version-externally-managed \
125 --prefix=$(PREFIX) --record=./tahoe.files
127 $(PP) $(PYTHON) ./setup.py install \
128 --single-version-externally-managed
134 .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
140 @echo "ERROR: Not all of Tahoe's dependencies are in place. Please \
141 see the README for help on installing dependencies."
146 signal-error-twisted-dep:
149 @echo "ERROR: Before running \"make build-auto-deps\" you have to ensure that \
150 Twisted is installed (including its zope.interface dependency). Twisted and \
151 zope.interface are required for the automatic installation of certain other \
152 libraries that Tahoe requires). Please see the README for details."
157 signal-error-pywin32-dep:
160 @echo "ERROR: the pywin32 dependency is not in place. Please see the README \
161 for help on installing dependencies."
166 signal-error-pyopenssl-dep:
169 @echo "ERROR: the pyOpenSSL dependency is not in place (note that pyOpenSSL required \
170 OpenSSL). Please see the README for help on installing dependencies."
175 check-all-deps: check-deps
177 $(PYTHON) -c 'import allmydata, zfec, foolscap, simplejson, nevow, pycryptopp' || $(MAKE) signal-error-deps
180 $(PYTHON) -c 'import twisted, zope.interface' || $(MAKE) signal-error-twisted-dep
183 $(PYTHON) -c 'import win32process' || $(MAKE) signal-error-pywin32-dep
186 $(PYTHON) -c 'import OpenSSL' || $(MAKE) signal-error-pyopenssl-dep
188 check-deps: check-twisted-dep $(CHECK_PYWIN32_DEP) check-pyopenssl-dep
191 $(MAKE) check-all-deps
194 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
195 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
199 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
200 # suppress the ansi color sequences
202 test: .built .checked-deps
204 $(TRIAL) $(TRIALARGS) $(TEST)
206 test-figleaf: .built .checked-deps
209 $(TRIAL) --reporter=bwverbose-figleaf $(TEST)
213 $(PYTHON) misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes
214 @echo "now point your browser at coverage-html/index.html"
216 # after doing test-figleaf and figleaf-output, point your browser at
217 # coverage-html/index.html
219 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
220 .PHONY: check-memory check-memory-once clean
222 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
226 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
229 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
233 rsync -a coverage-html/ $(UPLOAD_TARGET)
234 ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
237 echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
241 .figleaf.el: .figleaf
243 $(PYTHON) misc/figleaf2el.py .figleaf src
246 $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
250 @find src -name '*.py' |grep -v /build/ |wc --lines
252 @cat `find src -name '*.py' |grep -v /build/` |wc --lines
254 @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
259 $(PYTHON) src/allmydata/test/check_memory.py upload
261 $(PYTHON) src/allmydata/test/check_memory.py upload-self
263 $(PYTHON) src/allmydata/test/check_memory.py upload-POST
265 $(PYTHON) src/allmydata/test/check_memory.py download
267 $(PYTHON) src/allmydata/test/check_memory.py download-GET
269 $(PYTHON) src/allmydata/test/check_memory.py download-GET-slow
271 $(PYTHON) src/allmydata/test/check_memory.py receive
273 check-memory-once: .built
276 $(PYTHON) src/allmydata/test/check_memory.py $(MODE)
278 # this target uses a pre-established client node to run a canned set of
279 # performance tests against a test network that is also pre-established
280 # (probably on a remote machine). Provide it with the path to a local
281 # directory where this client node has been created (and populated with the
282 # necessary FURLs of the test network). This target will start that client
283 # with the current code and then run the tests. Afterwards it will stop the
286 # The 'sleep 5' is in there to give the new client a chance to connect to its
287 # storageservers, since check_speed.py has no good way of doing that itself.
290 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
291 @echo "stopping any leftover client code"
292 -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
293 $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
295 $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
296 $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
298 # 'make repl' is a simple-to-type command to get a Python interpreter loop
299 # from which you can type 'import allmydata'
303 test-darcs-boringfile:
305 $(PYTHON) misc/test-darcs-boringfile.py
308 find . |grep -v allfiles.tmp |grep -v src/allmydata/_version.py |sort >allfiles.tmp.old
311 find . |grep -v allfiles.tmp |grep -v src/allmydata/_version.py |sort >allfiles.tmp.new
312 diff allfiles.tmp.old allfiles.tmp.new
315 rm -rf build _trial_temp _test_memory .checked-deps .built
317 rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
318 rm -rf tahoe_deps.egg-info allmydata_tahoe.egg-info
320 rm -rf setuptools*.egg *.pyc darcsver*.egg
321 rm -rf misc/dependencies/build misc/dependencies/temp
322 rm -rf misc/dependencies/tahoe_deps.egg-info
324 find-trailing-spaces:
325 $(PYTHON) misc/find-trailing-spaces.py -r src
330 VER=$(shell $(PYTHON) misc/get-version.py)
331 DEBCOMMENTS="'make deb' build"
336 .PHONY: setup-deb deb-ARCH is-known-debian-arch
337 .PHONY: deb-sid deb-feisty deb-edgy deb-etch
340 $(MAKE) deb-ARCH ARCH=sid
342 $(MAKE) deb-ARCH ARCH=feisty
343 # edgy uses the feisty control files for now
345 $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
346 # etch uses the feisty control files for now
348 $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
349 # same with gutsy, the process has been nicely stable for a while now
351 $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
353 # we know how to handle the following debian architectures
354 KNOWN_DEBIAN_ARCHES := sid feisty edgy etch gutsy
356 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
357 is-known-debian-arch:
358 @echo "ARCH must be set when using setup-deb or deb-ARCH"
359 @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
362 is-known-debian-arch:
370 setup-deb: is-known-debian-arch
372 ln -s misc/$(TAHOE_ARCH)/debian debian
373 chmod +x debian/rules
375 # etch (current debian stable) has python-simplejson-1.3, which doesn't
377 # sid (debian unstable) currently has python-simplejson 1.7.1
378 # edgy has 1.3, which doesn't support indent=
379 # feisty has 1.4, which supports indent= but emits a deprecation warning
382 # we need 1.4 or newer
384 deb-ARCH: is-known-debian-arch setup-deb
385 fakeroot debian/rules binary
387 @echo "The newly built .deb packages are in the parent directory from here."
389 .PHONY: increment-deb-version
390 .PHONY: deb-sid-head deb-edgy-head deb-feisty-head
391 .PHONY: deb-etch-head
393 # The buildbot runs the following targets after each change, to produce
394 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
396 increment-deb-version: make-version
397 debchange --newversion $(VER) $(DEBCOMMENTS)
399 $(MAKE) setup-deb ARCH=sid
400 $(MAKE) increment-deb-version
401 fakeroot debian/rules binary
403 $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
404 $(MAKE) increment-deb-version
405 fakeroot debian/rules binary
407 $(MAKE) setup-deb ARCH=feisty
408 $(MAKE) increment-deb-version
409 fakeroot debian/rules binary
411 $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
412 $(MAKE) increment-deb-version
413 fakeroot debian/rules binary
415 $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
416 $(MAKE) increment-deb-version
417 fakeroot debian/rules binary
419 # These targets provide for windows native builds
422 PYTHON=$(PYTHON) $(PP) $(MAKE) -C windows