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 $(PYTHON) setup.py build
68 # 'make install' will do the following:
69 # build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
70 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
71 # a different location
73 install: src/allmydata/_version.py
76 $(PYTHON) ./setup.py install --single-version-externally-managed \
77 --prefix=$(PREFIX) --record=./tahoe.files
79 $(PYTHON) ./setup.py install --single-version-externally-managed
85 .PHONY: signal-error-deps test test-figleaf figleaf-output
91 @echo "ERROR: Not all of Tahoe's dependencies are in place. Please see docs/install.html for help on installing dependencies."
97 $(PYTHON) setup.py -q check_auto_deps || $(MAKE) signal-error-deps
100 $(MAKE) check-auto-deps
103 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
104 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
108 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
109 # suppress the ansi color sequences
111 test: build src/allmydata/_version.py
112 $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
114 quicktest: .built .checked-deps
115 $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
117 fuse-test: .built .checked-deps
118 $(RUNPP) -d contrib/fuse -p -c runtests.py
120 test-figleaf: build src/allmydata/_version.py
122 $(PYTHON) setup.py trial --reporter=bwverbose-figleaf -s $(TEST)
124 quicktest-figleaf: src/allmydata/_version.py
126 $(PYTHON) setup.py trial --reporter=bwverbose-figleaf -s $(TEST)
129 $(RUNPP) -p -c "misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes"
130 @echo "now point your browser at coverage-html/index.html"
132 # after doing test-figleaf and figleaf-output, point your browser at
133 # coverage-html/index.html
135 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
136 .PHONY: check-memory check-memory-once clean
138 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
142 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
145 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
149 cp .figleaf coverage-html/figleaf.pickle
150 rsync -a coverage-html/ $(UPLOAD_TARGET)
151 ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
154 echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
158 .figleaf.el: .figleaf
159 $(RUNPP) -p -c "misc/figleaf2el.py .figleaf src"
162 $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
166 @find src -name '*.py' |grep -v /build/ |wc --lines
168 @cat `find src -name '*.py' |grep -v /build/` |wc --lines
170 @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
174 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload"
175 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-self"
176 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-POST"
177 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download"
178 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET"
179 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET-slow"
180 $(RUNPP) -p -c "src/allmydata/test/check_memory.py receive"
182 check-memory-once: .built
184 $(RUNPP) -p -c "src/allmydata/test/check_memory.py $(MODE)"
186 # The check-speed target uses a pre-established client node to run a canned
187 # set of performance tests against a test network that is also
188 # pre-established (probably on a remote machine). Provide it with the path to
189 # a local directory where this client node has been created (and populated
190 # with the necessary FURLs of the test network). This target will start that
191 # client with the current code and then run the tests. Afterwards it will
194 # The 'sleep 5' is in there to give the new client a chance to connect to its
195 # storageservers, since check_speed.py has no good way of doing that itself.
198 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
199 @echo "stopping any leftover client code"
200 -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
201 $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
203 $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
204 $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
206 # The check-grid target also uses a pre-established client node, along with a
207 # long-term directory that contains some well-known files. See the docstring
208 # in src/allmydata/test/check_grid.py to see how to set this up.
210 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
211 $(PYTHON) src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
213 # 'make repl' is a simple-to-type command to get a Python interpreter loop
214 # from which you can type 'import allmydata'
218 test-darcs-boringfile:
220 $(PYTHON) misc/test-darcs-boringfile.py
223 find . |grep -vEe "allfiles.tmp|src/allmydata/_(version|auto_deps|appname).py" |sort >allfiles.tmp.old
226 find . |grep -vEe "allfiles.tmp|src/allmydata/_(version|auto_deps|appname).py" |sort >allfiles.tmp.new
227 diff allfiles.tmp.old allfiles.tmp.new
230 rm -rf build _trial_temp _test_memory .checked-deps .built
232 rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
233 rm -rf src/allmydata_tahoe.egg-info
235 rm -rf setuptools*.egg *.pyc darcsver*.egg pyutil*.egg
236 rm -rf misc/dependencies/build misc/dependencies/temp
237 rm -rf misc/dependencies/tahoe_deps.egg-info
238 rm -f bin/tahoe bin/tahoe-script.py
240 find-trailing-spaces:
241 $(PYTHON) misc/find-trailing-spaces.py -r src
243 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
244 # does a build, then asserts that the build did not try to download anything
245 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
246 # support/lib/ directory is gone.
248 fetch-and-unpack-deps:
249 test -f tahoe-deps.tar.gz || wget http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz
251 tar xf tahoe-deps.tar.gz
254 $(MAKE) fetch-and-unpack-deps
255 $(MAKE) 2>&1 | tee make.out
256 $(PYTHON) misc/check-build.py make.out no-downloads
260 .PHONY: tarballs upload-tarballs
263 $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
264 $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
267 for f in dist/allmydata-tahoe-*; do \
268 xfer-client --furlfile ~/.tahoe-tarball-upload.furl $$f; \
273 VER=$(shell $(PYTHON) misc/get-version.py)
274 DEBCOMMENTS="'make deb' build"
281 .PHONY: setup-deb deb-ARCH is-known-debian-arch
282 .PHONY: deb-etch deb-sid
283 .PHONY: deb-edgy deb-feisty deb-gutsy deb-hardy
286 $(MAKE) deb-ARCH ARCH=sid
288 $(MAKE) deb-ARCH ARCH=feisty
289 # edgy uses the feisty control files for now
291 $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
292 # etch uses the feisty control files for now
294 $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
295 # same with gutsy, the process has been nicely stable for a while now
297 $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
299 $(MAKE) deb-ARCH ARCH=hardy TAHOE_ARCH=feisty
301 # we know how to handle the following debian architectures
302 KNOWN_DEBIAN_ARCHES := etch sid edgy feisty gutsy hardy
304 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
305 is-known-debian-arch:
306 @echo "ARCH must be set when using setup-deb or deb-ARCH"
307 @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
310 is-known-debian-arch:
318 setup-deb: is-known-debian-arch
320 ln -s misc/$(TAHOE_ARCH)/debian debian
321 chmod +x debian/rules
323 # etch (current debian stable) has python-simplejson-1.3, which doesn't
325 # sid (debian unstable) currently has python-simplejson 1.7.1
326 # edgy has 1.3, which doesn't support indent=
327 # feisty has 1.4, which supports indent= but emits a deprecation warning
330 # we need 1.4 or newer
332 deb-ARCH: is-known-debian-arch setup-deb
333 fakeroot debian/rules binary
335 @echo "The newly built .deb packages are in the parent directory from here."
337 .PHONY: increment-deb-version
338 .PHONY: deb-edgy-head deb-feisty-head deb-gutsy-head deb-hardy-head
339 .PHONY: deb-etch-head deb-sid-head
341 # The buildbot runs the following targets after each change, to produce
342 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
344 increment-deb-version: make-version
345 debchange --newversion $(VER) $(DEBCOMMENTS)
347 $(MAKE) setup-deb ARCH=sid
348 $(MAKE) increment-deb-version
349 fakeroot debian/rules binary
351 $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
352 $(MAKE) increment-deb-version
353 fakeroot debian/rules binary
355 $(MAKE) setup-deb ARCH=feisty
356 $(MAKE) increment-deb-version
357 fakeroot debian/rules binary
359 $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
360 $(MAKE) increment-deb-version
361 fakeroot debian/rules binary
363 $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
364 $(MAKE) increment-deb-version
365 fakeroot debian/rules binary
367 $(MAKE) setup-deb ARCH=hardy TAHOE_ARCH=feisty
368 $(MAKE) increment-deb-version
369 fakeroot debian/rules binary
371 # These targets provide for windows native builds
372 .PHONY: windows-exe windows-installer windows-installer-upload
375 $(RUNPP) -c "$(MAKE) -C windows windows-exe"
378 $(RUNPP) -c "$(MAKE) -C windows windows-installer"
380 windows-installer-upload:
381 $(RUNPP) -c "$(MAKE) -C windows windows-installer-upload"
384 # These targets provide for mac native builds
385 .PHONY: mac-exe mac-upload mac-cleanup mac-dbg
389 VERSION=$(VER) $(RUNPP) -c "$(MAKE) -C mac build"
392 VERSION=$(VER) $(MAKE) -C mac diskimage
395 VERSION=$(VER) $(MAKE) -C mac upload
398 VERSION=$(VER) $(MAKE) -C mac cleanup
401 cd mac && $(PP) $(PYTHON)w allmydata_tahoe.py