2 # NOTE: this Makefile requires GNU make
9 # setup.py will extend sys.path to include our support/lib/... directory
10 # itself. It will also create it in the beginning of the 'develop' command.
12 PP=$(shell $(PYTHON) setup.py -q show_pythonpath)
13 RUNPP=$(PYTHON) setup.py run_with_pythonpath
15 .PHONY: make-version build
17 # The 'darcsver' setup.py command comes in the 'darcsver' package:
18 # http://pypi.python.org/pypi/darcsver It is necessary only if you want to
19 # automatically produce a new _version.py file from the current darcs history.
21 $(PYTHON) ./setup.py darcsver --count-all-patches
23 # We want src/allmydata/_version.py to be up-to-date, but it's a fairly
24 # expensive operation (about 6 seconds on a just-before-0.7.0 tree, probably
25 # because of the 332 patches since the last tag), and we've removed the need
26 # for an explicit 'build' step by removing the C code from src/allmydata and
27 # by running everything in place. It would be neat to do:
29 #src/allmydata/_version.py: _darcs/patches
30 # $(MAKE) make-version
32 # since that would update the embedded version string each time new darcs
33 # patches were pulled, but 1) this would break non-darcs trees (i.e. building
34 # from an exported tarball), and 2) without an obligatory 'build' step this
35 # rule wouldn't be run frequently enought anyways.
37 # So instead, I'll just make sure that we update the version at least once
38 # when we first start using the tree, and again whenever an explicit
39 # 'make-version' is run, since then at least the developer has some means to
40 # update things. It would be nice if 'make clean' deleted any
41 # automatically-generated _version.py too, so that 'make clean; make all'
42 # could be useable as a "what the heck is going on, get me back to a clean
43 # state', but we need 'make clean' to work on non-darcs trees without
44 # destroying useful information.
49 src/allmydata/_version.py:
52 # c.f. ticket #455, there is a problem in the intersection of setuptools,
53 # twisted's setup.py, and nevow's setup.py . A Tahoe build, to satisfy its
54 # dependencies, may try to build both Twisted and Nevow. If both of these
55 # occur during the same invocation of 'setup.py develop', then the Nevow
56 # build will fail with an "ImportError: No module named components". Running
57 # the build a second time will succeed. Until there is a new version of
58 # setuptools which properly sandboxes sys.modules (or a new version of nevow
59 # which doesn't import twisted during its build, or a new version of twisted
60 # which doesn't import itself during its build), we just build tahoe twice
61 # and ignore the errors from the first pass. Updated 16-Sep-2008: now we need
64 build: src/allmydata/_version.py
65 $(MAKE) build-once || $(MAKE) build-once || $(MAKE) build-once
67 # setuptools has a bug (Issue17, see tahoe #229 for details) that causes it
68 # to mishandle dependencies that are installed in non-site-directories,
69 # including the /var/lib/ place that debian's python-support system uses. We
70 # add this debian/ubuntu-specific directory (via $SITEDIRARG) to the setup.py
71 # command line to work around this. Some day this will probably be fixed in
74 $(PYTHON) setup.py build_tahoe
78 # 'make install' will do the following:
79 # build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
80 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
81 # a different location
83 install: src/allmydata/_version.py
86 $(PYTHON) ./setup.py install --single-version-externally-managed \
87 --prefix=$(PREFIX) --record=./tahoe.files
89 $(PYTHON) ./setup.py install --single-version-externally-managed
95 .PHONY: signal-error-deps test test-figleaf figleaf-output
101 @echo "ERROR: Not all of Tahoe's dependencies are in place. Please see docs/install.html for help on installing dependencies."
107 $(PYTHON) setup.py -q check_auto_deps || $(MAKE) signal-error-deps
110 $(MAKE) check-auto-deps
113 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
114 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
118 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
119 # suppress the ansi color sequences
121 test: build src/allmydata/_version.py
122 $(PYTHON) setup.py trial -a "$(TRIALARGS) $(TEST)"
124 quicktest: .built .checked-deps
125 $(PYTHON) setup.py trial -a "$(TRIALARGS) $(TEST)"
127 test-figleaf: build src/allmydata/_version.py
129 $(PYTHON) setup.py trial -a "--reporter=bwverbose-figleaf $(TEST)"
131 quicktest-figleaf: src/allmydata/_version.py
133 $(PYTHON) setup.py trial -a "--reporter=bwverbose-figleaf $(TEST)"
136 $(RUNPP) -p -c "misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes"
137 @echo "now point your browser at coverage-html/index.html"
139 # after doing test-figleaf and figleaf-output, point your browser at
140 # coverage-html/index.html
142 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
143 .PHONY: check-memory check-memory-once clean
145 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
149 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
152 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
156 rsync -a coverage-html/ $(UPLOAD_TARGET)
157 ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
160 echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
164 .figleaf.el: .figleaf
165 $(RUNPP) -p -c "misc/figleaf2el.py .figleaf src"
168 $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
172 @find src -name '*.py' |grep -v /build/ |wc --lines
174 @cat `find src -name '*.py' |grep -v /build/` |wc --lines
176 @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
180 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload"
181 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-self"
182 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-POST"
183 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download"
184 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET"
185 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET-slow"
186 $(RUNPP) -p -c "src/allmydata/test/check_memory.py receive"
188 check-memory-once: .built
190 $(RUNPP) -p -c "src/allmydata/test/check_memory.py $(MODE)"
192 # The check-speed target uses a pre-established client node to run a canned
193 # set of performance tests against a test network that is also
194 # pre-established (probably on a remote machine). Provide it with the path to
195 # a local directory where this client node has been created (and populated
196 # with the necessary FURLs of the test network). This target will start that
197 # client with the current code and then run the tests. Afterwards it will
200 # The 'sleep 5' is in there to give the new client a chance to connect to its
201 # storageservers, since check_speed.py has no good way of doing that itself.
204 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
205 @echo "stopping any leftover client code"
206 -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
207 $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
209 $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
210 $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
212 # The check-grid target also uses a pre-established client node, along with a
213 # long-term directory that contains some well-known files. See the docstring
214 # in src/allmydata/test/check_grid.py to see how to set this up.
216 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
217 $(PYTHON) src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
219 # 'make repl' is a simple-to-type command to get a Python interpreter loop
220 # from which you can type 'import allmydata'
224 test-darcs-boringfile:
226 $(PYTHON) misc/test-darcs-boringfile.py
229 find . |grep -vEe"allfiles.tmp|src/allmydata/_(version|auto_deps).py|src/allmydata_tahoe.egg-info" |sort >allfiles.tmp.old
232 find . |grep -vEe"allfiles.tmp|src/allmydata/_(version|auto_deps).py|src/allmydata_tahoe.egg-info" |sort >allfiles.tmp.new
233 diff allfiles.tmp.old allfiles.tmp.new
236 rm -rf build _trial_temp _test_memory .checked-deps .built
238 rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
239 rm -rf tahoe_deps.egg-info allmydata_tahoe.egg-info
241 rm -rf setuptools*.egg *.pyc darcsver*.egg pyutil*.egg
242 rm -rf misc/dependencies/build misc/dependencies/temp
243 rm -rf misc/dependencies/tahoe_deps.egg-info
245 find-trailing-spaces:
246 $(PYTHON) misc/find-trailing-spaces.py -r src
248 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
249 # does a build, then asserts that the build did not try to download anything
250 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
251 # support/lib/ directory is gone.
253 fetch-and-unpack-deps:
254 test -f tahoe-deps.tar.gz || wget http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz
256 tar xf tahoe-deps.tar.gz
259 $(MAKE) fetch-and-unpack-deps
260 $(MAKE) 2>&1 | tee make.out
261 $(PYTHON) misc/check-build.py make.out no-downloads
265 .PHONY: tarballs upload-tarballs
268 $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
269 $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
272 for f in dist/allmydata-tahoe-*; do \
273 xfer-client --furlfile ~/.tahoe-tarball-upload.furl $$f; \
278 VER=$(shell $(PYTHON) misc/get-version.py)
279 DEBCOMMENTS="'make deb' build"
286 .PHONY: setup-deb deb-ARCH is-known-debian-arch
287 .PHONY: deb-etch deb-sid
288 .PHONY: deb-edgy deb-feisty deb-gutsy deb-hardy
291 $(MAKE) deb-ARCH ARCH=sid
293 $(MAKE) deb-ARCH ARCH=feisty
294 # edgy uses the feisty control files for now
296 $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
297 # etch uses the feisty control files for now
299 $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
300 # same with gutsy, the process has been nicely stable for a while now
302 $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
304 $(MAKE) deb-ARCH ARCH=hardy TAHOE_ARCH=feisty
306 # we know how to handle the following debian architectures
307 KNOWN_DEBIAN_ARCHES := etch sid edgy feisty gutsy hardy
309 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
310 is-known-debian-arch:
311 @echo "ARCH must be set when using setup-deb or deb-ARCH"
312 @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
315 is-known-debian-arch:
323 setup-deb: is-known-debian-arch
325 ln -s misc/$(TAHOE_ARCH)/debian debian
326 chmod +x debian/rules
328 # etch (current debian stable) has python-simplejson-1.3, which doesn't
330 # sid (debian unstable) currently has python-simplejson 1.7.1
331 # edgy has 1.3, which doesn't support indent=
332 # feisty has 1.4, which supports indent= but emits a deprecation warning
335 # we need 1.4 or newer
337 deb-ARCH: is-known-debian-arch setup-deb
338 fakeroot debian/rules binary
340 @echo "The newly built .deb packages are in the parent directory from here."
342 .PHONY: increment-deb-version
343 .PHONY: deb-edgy-head deb-feisty-head deb-gutsy-head deb-hardy-head
344 .PHONY: deb-etch-head deb-sid-head
346 # The buildbot runs the following targets after each change, to produce
347 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
349 increment-deb-version: make-version
350 debchange --newversion $(VER) $(DEBCOMMENTS)
352 $(MAKE) setup-deb ARCH=sid
353 $(MAKE) increment-deb-version
354 fakeroot debian/rules binary
356 $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
357 $(MAKE) increment-deb-version
358 fakeroot debian/rules binary
360 $(MAKE) setup-deb ARCH=feisty
361 $(MAKE) increment-deb-version
362 fakeroot debian/rules binary
364 $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
365 $(MAKE) increment-deb-version
366 fakeroot debian/rules binary
368 $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
369 $(MAKE) increment-deb-version
370 fakeroot debian/rules binary
372 $(MAKE) setup-deb ARCH=hardy TAHOE_ARCH=feisty
373 $(MAKE) increment-deb-version
374 fakeroot debian/rules binary
376 # These targets provide for windows native builds
377 .PHONY: windows-exe windows-installer windows-installer-upload
380 $(RUNPP) -c "$(MAKE) -C windows windows-exe"
383 $(RUNPP) -c "$(MAKE) -C windows windows-installer"
385 windows-installer-upload:
386 $(RUNPP) -c "$(MAKE) -C windows windows-installer-upload"
389 # These targets provide for mac native builds
390 .PHONY: mac-exe mac-upload mac-cleanup mac-dbg
394 VERSION=$(VER) $(RUNPP) -c "$(MAKE) -C mac build"
397 VERSION=$(VER) $(MAKE) -C mac diskimage
400 VERSION=$(VER) $(MAKE) -C mac upload UPLOAD_DEST=$(UPLOAD_DEST)
403 VERSION=$(VER) $(MAKE) -C mac cleanup
406 cd mac && $(PP) $(PYTHON)w allmydata_tahoe.py
408 # This target runs a stats gatherer server
409 .PHONY: stats-gatherer-run
411 $(RUNPP) -d stats_gatherer -p ../src/allmydata/stats.py