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 quicktest quicktest-figleaf
86 .PHONY: figleaf-output get-old-figleaf-coverage figleaf-delta-output
92 @echo "ERROR: Not all of Tahoe's dependencies are in place. Please see docs/install.html for help on installing dependencies."
98 $(PYTHON) setup.py -q check_auto_deps || $(MAKE) signal-error-deps
101 $(MAKE) check-auto-deps
104 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
105 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
109 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
110 # suppress the ansi color sequences
112 test: build src/allmydata/_version.py
113 $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
115 quicktest: .built .checked-deps
116 $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
118 fuse-test: .built .checked-deps
119 $(RUNPP) -d contrib/fuse -p -c runtests.py
121 test-figleaf: build src/allmydata/_version.py
123 $(PYTHON) setup.py trial --reporter=bwverbose-figleaf -s $(TEST)
125 quicktest-figleaf: src/allmydata/_version.py
127 $(PYTHON) setup.py trial --reporter=bwverbose-figleaf -s $(TEST)
130 $(RUNPP) -p -c "misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes"
131 cp .figleaf coverage-html/figleaf.pickle
132 @echo "now point your browser at coverage-html/index.html"
134 # use these two targets to compare this coverage against the previous run.
135 # The deltas only work if the old test was run in the same directory, since
136 # it compares absolute filenames.
137 get-old-figleaf-coverage:
138 wget --progress=dot -O old.figleaf http://allmydata.org/tahoe-figleaf/current/figleaf.pickle
140 figleaf-delta-output:
141 $(RUNPP) -p -c "misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes -o old.figleaf"
142 cp .figleaf coverage-html/figleaf.pickle
143 @echo "now point your browser at coverage-html/index.html"
145 # after doing test-figleaf and figleaf-output, point your browser at
146 # coverage-html/index.html
148 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
149 .PHONY: check-memory check-memory-once check-speed check-grid
150 .PHONY: repl test-darcs-boringfile test-clean clean find-trailing-spaces
152 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
156 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
159 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
163 rsync -a coverage-html/ $(UPLOAD_TARGET)
164 ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
167 echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
171 .figleaf.el: .figleaf
172 $(RUNPP) -p -c "misc/figleaf2el.py .figleaf src"
175 $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
179 @find src -name '*.py' |grep -v /build/ |wc --lines
181 @cat `find src -name '*.py' |grep -v /build/` |wc --lines
183 @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
187 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload"
188 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-self"
189 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-POST"
190 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download"
191 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET"
192 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET-slow"
193 $(RUNPP) -p -c "src/allmydata/test/check_memory.py receive"
195 check-memory-once: .built
197 $(RUNPP) -p -c "src/allmydata/test/check_memory.py $(MODE)"
199 # The check-speed target uses a pre-established client node to run a canned
200 # set of performance tests against a test network that is also
201 # pre-established (probably on a remote machine). Provide it with the path to
202 # a local directory where this client node has been created (and populated
203 # with the necessary FURLs of the test network). This target will start that
204 # client with the current code and then run the tests. Afterwards it will
207 # The 'sleep 5' is in there to give the new client a chance to connect to its
208 # storageservers, since check_speed.py has no good way of doing that itself.
211 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
212 @echo "stopping any leftover client code"
213 -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
214 $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
216 $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
217 $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
219 # The check-grid target also uses a pre-established client node, along with a
220 # long-term directory that contains some well-known files. See the docstring
221 # in src/allmydata/test/check_grid.py to see how to set this up.
223 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
224 $(PYTHON) src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
226 # 'make repl' is a simple-to-type command to get a Python interpreter loop
227 # from which you can type 'import allmydata'
231 test-darcs-boringfile:
233 $(PYTHON) misc/test-darcs-boringfile.py
236 find . |grep -vEe "allfiles.tmp|src/allmydata/_(version|auto_deps|appname).py" |sort >allfiles.tmp.old
239 find . |grep -vEe "allfiles.tmp|src/allmydata/_(version|auto_deps|appname).py" |sort >allfiles.tmp.new
240 diff allfiles.tmp.old allfiles.tmp.new
243 rm -rf build _trial_temp _test_memory .checked-deps .built
245 rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
246 rm -rf src/allmydata_tahoe.egg-info
248 rm -rf setuptools*.egg *.pyc darcsver*.egg pyutil*.egg
249 rm -rf misc/dependencies/build misc/dependencies/temp
250 rm -rf misc/dependencies/tahoe_deps.egg-info
251 rm -f bin/tahoe bin/tahoe-script.py
253 find-trailing-spaces:
254 $(PYTHON) misc/find-trailing-spaces.py -r src
256 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
257 # does a build, then asserts that the build did not try to download anything
258 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
259 # support/lib/ directory is gone.
261 fetch-and-unpack-deps:
262 test -f tahoe-deps.tar.gz || wget http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz
264 tar xf tahoe-deps.tar.gz
267 $(MAKE) fetch-and-unpack-deps
268 $(MAKE) 2>&1 | tee make.out
269 $(PYTHON) misc/check-build.py make.out no-downloads
273 .PHONY: tarballs upload-tarballs
276 $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
277 $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
280 for f in dist/allmydata-tahoe-*; do \
281 xfer-client --furlfile ~/.tahoe-tarball-upload.furl $$f; \
286 VER=$(shell $(PYTHON) misc/get-version.py)
287 DEBCOMMENTS="'make deb' build"
294 .PHONY: setup-deb deb-ARCH is-known-debian-arch
295 .PHONY: deb-etch deb-sid
296 .PHONY: deb-edgy deb-feisty deb-gutsy deb-hardy deb-intrepid deb-lenny
299 $(MAKE) deb-ARCH ARCH=sid
301 $(MAKE) deb-ARCH ARCH=feisty
302 # edgy uses the feisty control files for now
304 $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
305 # etch uses the feisty control files for now
307 $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
308 # same with gutsy, the process has been nicely stable for a while now
310 $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
312 $(MAKE) deb-ARCH ARCH=hardy TAHOE_ARCH=feisty
314 $(MAKE) deb-ARCH ARCH=intrepid TAHOE_ARCH=feisty
316 $(MAKE) deb-ARCH ARCH=lenny TAHOE_ARCH=feisty
320 # we know how to handle the following debian architectures
321 KNOWN_DEBIAN_ARCHES := etch sid edgy feisty gutsy hardy intrepid lenny
323 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
324 is-known-debian-arch:
325 @echo "ARCH must be set when using setup-deb or deb-ARCH"
326 @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
329 is-known-debian-arch:
337 setup-deb: is-known-debian-arch
339 ln -s misc/$(TAHOE_ARCH)/debian debian
340 chmod +x debian/rules
342 # etch (current debian stable) has python-simplejson-1.3, which doesn't
344 # sid (debian unstable) currently has python-simplejson 1.7.1
345 # edgy has 1.3, which doesn't support indent=
346 # feisty has 1.4, which supports indent= but emits a deprecation warning
349 # we need 1.4 or newer
351 deb-ARCH: is-known-debian-arch setup-deb
352 fakeroot debian/rules binary
354 @echo "The newly built .deb packages are in the parent directory from here."
356 .PHONY: increment-deb-version
357 .PHONY: deb-edgy-head deb-feisty-head deb-gutsy-head deb-hardy-head deb-intrepid-head deb-lenny-head
358 .PHONY: deb-etch-head deb-sid-head
360 # The buildbot runs the following targets after each change, to produce
361 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
363 increment-deb-version: make-version
364 debchange --newversion $(VER) $(DEBCOMMENTS)
366 $(MAKE) setup-deb ARCH=sid
367 $(MAKE) increment-deb-version
368 fakeroot debian/rules binary
370 $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
371 $(MAKE) increment-deb-version
372 fakeroot debian/rules binary
374 $(MAKE) setup-deb ARCH=feisty
375 $(MAKE) increment-deb-version
376 fakeroot debian/rules binary
378 $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
379 $(MAKE) increment-deb-version
380 fakeroot debian/rules binary
382 $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
383 $(MAKE) increment-deb-version
384 fakeroot debian/rules binary
386 $(MAKE) setup-deb ARCH=hardy TAHOE_ARCH=feisty
387 $(MAKE) increment-deb-version
388 fakeroot debian/rules binary
390 $(MAKE) setup-deb ARCH=intrepid TAHOE_ARCH=feisty
391 $(MAKE) increment-deb-version
392 fakeroot debian/rules binary
394 $(MAKE) setup-deb ARCH=lenny TAHOE_ARCH=feisty
395 $(MAKE) increment-deb-version
396 fakeroot debian/rules binary
399 # These targets provide for windows native builds
400 .PHONY: windows-exe windows-installer windows-installer-upload
403 $(RUNPP) -c "$(MAKE) -C windows windows-exe"
406 $(RUNPP) -c "$(MAKE) -C windows windows-installer"
408 windows-installer-upload:
409 $(RUNPP) -c "$(MAKE) -C windows windows-installer-upload"
412 # These targets provide for mac native builds
413 .PHONY: mac-exe mac-upload mac-cleanup mac-dbg
417 VERSION=$(VER) $(RUNPP) -c "$(MAKE) -C mac build"
420 VERSION=$(VER) $(MAKE) -C mac diskimage
423 VERSION=$(VER) $(MAKE) -C mac upload
426 VERSION=$(VER) $(MAKE) -C mac cleanup
429 cd mac && $(PP) $(PYTHON)w allmydata_tahoe.py