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
77 # 'make install' will do the following:
78 # build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
79 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
80 # a different location
82 install: src/allmydata/_version.py
85 $(PYTHON) ./setup.py install --single-version-externally-managed \
86 --prefix=$(PREFIX) --record=./tahoe.files
88 $(PYTHON) ./setup.py install --single-version-externally-managed
94 .PHONY: signal-error-deps test test-figleaf figleaf-output
100 @echo "ERROR: Not all of Tahoe's dependencies are in place. Please see docs/install.html for help on installing dependencies."
106 $(PYTHON) setup.py -q check_auto_deps || $(MAKE) signal-error-deps
109 $(MAKE) check-auto-deps
112 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
113 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
117 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
118 # suppress the ansi color sequences
120 test: build src/allmydata/_version.py
121 $(PYTHON) setup.py trial -a "$(TRIALARGS) $(TEST)"
123 quicktest: .built .checked-deps
124 $(PYTHON) setup.py trial -a "$(TRIALARGS) $(TEST)"
126 test-figleaf: build src/allmydata/_version.py
128 $(PYTHON) setup.py trial -a "--reporter=bwverbose-figleaf $(TEST)"
130 quicktest-figleaf: src/allmydata/_version.py
132 $(PYTHON) setup.py trial -a "--reporter=bwverbose-figleaf $(TEST)"
135 $(RUNPP) -p -c "misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes"
136 @echo "now point your browser at coverage-html/index.html"
138 # after doing test-figleaf and figleaf-output, point your browser at
139 # coverage-html/index.html
141 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
142 .PHONY: check-memory check-memory-once clean
144 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
148 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
151 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
155 rsync -a coverage-html/ $(UPLOAD_TARGET)
156 ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
159 echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
163 .figleaf.el: .figleaf
164 $(RUNPP) -p -c "misc/figleaf2el.py .figleaf src"
167 $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
171 @find src -name '*.py' |grep -v /build/ |wc --lines
173 @cat `find src -name '*.py' |grep -v /build/` |wc --lines
175 @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
179 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload"
180 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-self"
181 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-POST"
182 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download"
183 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET"
184 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET-slow"
185 $(RUNPP) -p -c "src/allmydata/test/check_memory.py receive"
187 check-memory-once: .built
189 $(RUNPP) -p -c "src/allmydata/test/check_memory.py $(MODE)"
191 # The check-speed target uses a pre-established client node to run a canned
192 # set of performance tests against a test network that is also
193 # pre-established (probably on a remote machine). Provide it with the path to
194 # a local directory where this client node has been created (and populated
195 # with the necessary FURLs of the test network). This target will start that
196 # client with the current code and then run the tests. Afterwards it will
199 # The 'sleep 5' is in there to give the new client a chance to connect to its
200 # storageservers, since check_speed.py has no good way of doing that itself.
203 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
204 @echo "stopping any leftover client code"
205 -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
206 $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
208 $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
209 $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
211 # The check-grid target also uses a pre-established client node, along with a
212 # long-term directory that contains some well-known files. See the docstring
213 # in src/allmydata/test/check_grid.py to see how to set this up.
215 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
216 $(PYTHON) src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
218 # 'make repl' is a simple-to-type command to get a Python interpreter loop
219 # from which you can type 'import allmydata'
223 test-darcs-boringfile:
225 $(PYTHON) misc/test-darcs-boringfile.py
228 find . |grep -vEe"allfiles.tmp|src/allmydata/_(version|auto_deps).py|src/allmydata_tahoe.egg-info" |sort >allfiles.tmp.old
231 find . |grep -vEe"allfiles.tmp|src/allmydata/_(version|auto_deps).py|src/allmydata_tahoe.egg-info" |sort >allfiles.tmp.new
232 diff allfiles.tmp.old allfiles.tmp.new
235 rm -rf build _trial_temp _test_memory .checked-deps .built
237 rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
238 rm -rf tahoe_deps.egg-info allmydata_tahoe.egg-info
240 rm -rf setuptools*.egg *.pyc darcsver*.egg pyutil*.egg
241 rm -rf misc/dependencies/build misc/dependencies/temp
242 rm -rf misc/dependencies/tahoe_deps.egg-info
244 find-trailing-spaces:
245 $(PYTHON) misc/find-trailing-spaces.py -r src
247 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
248 # does a build, then asserts that the build did not try to download anything
249 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
250 # support/lib/ directory is gone.
252 fetch-and-unpack-deps:
253 test -f tahoe-deps.tar.gz || wget http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz
255 tar xf tahoe-deps.tar.gz
258 $(MAKE) fetch-and-unpack-deps
259 $(MAKE) 2>&1 | tee make.out
260 $(PYTHON) misc/check-build.py make.out no-downloads
264 .PHONY: tarballs upload-tarballs
267 $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
268 $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
271 for f in dist/allmydata-tahoe-*; do \
272 xfer-client --furlfile ~/.tahoe-tarball-upload.furl $$f; \
277 VER=$(shell $(PYTHON) misc/get-version.py)
278 DEBCOMMENTS="'make deb' build"
285 .PHONY: setup-deb deb-ARCH is-known-debian-arch
286 .PHONY: deb-etch deb-sid
287 .PHONY: deb-edgy deb-feisty deb-gutsy deb-hardy
290 $(MAKE) deb-ARCH ARCH=sid
292 $(MAKE) deb-ARCH ARCH=feisty
293 # edgy uses the feisty control files for now
295 $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
296 # etch uses the feisty control files for now
298 $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
299 # same with gutsy, the process has been nicely stable for a while now
301 $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
303 $(MAKE) deb-ARCH ARCH=hardy TAHOE_ARCH=feisty
305 # we know how to handle the following debian architectures
306 KNOWN_DEBIAN_ARCHES := etch sid edgy feisty gutsy hardy
308 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
309 is-known-debian-arch:
310 @echo "ARCH must be set when using setup-deb or deb-ARCH"
311 @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
314 is-known-debian-arch:
322 setup-deb: is-known-debian-arch
324 ln -s misc/$(TAHOE_ARCH)/debian debian
325 chmod +x debian/rules
327 # etch (current debian stable) has python-simplejson-1.3, which doesn't
329 # sid (debian unstable) currently has python-simplejson 1.7.1
330 # edgy has 1.3, which doesn't support indent=
331 # feisty has 1.4, which supports indent= but emits a deprecation warning
334 # we need 1.4 or newer
336 deb-ARCH: is-known-debian-arch setup-deb
337 fakeroot debian/rules binary
339 @echo "The newly built .deb packages are in the parent directory from here."
341 .PHONY: increment-deb-version
342 .PHONY: deb-edgy-head deb-feisty-head deb-gutsy-head deb-hardy-head
343 .PHONY: deb-etch-head deb-sid-head
345 # The buildbot runs the following targets after each change, to produce
346 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
348 increment-deb-version: make-version
349 debchange --newversion $(VER) $(DEBCOMMENTS)
351 $(MAKE) setup-deb ARCH=sid
352 $(MAKE) increment-deb-version
353 fakeroot debian/rules binary
355 $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
356 $(MAKE) increment-deb-version
357 fakeroot debian/rules binary
359 $(MAKE) setup-deb ARCH=feisty
360 $(MAKE) increment-deb-version
361 fakeroot debian/rules binary
363 $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
364 $(MAKE) increment-deb-version
365 fakeroot debian/rules binary
367 $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
368 $(MAKE) increment-deb-version
369 fakeroot debian/rules binary
371 $(MAKE) setup-deb ARCH=hardy TAHOE_ARCH=feisty
372 $(MAKE) increment-deb-version
373 fakeroot debian/rules binary
375 # These targets provide for windows native builds
376 .PHONY: windows-exe windows-installer windows-installer-upload
379 $(RUNPP) -c "$(MAKE) -C windows windows-exe"
382 $(RUNPP) -c "$(MAKE) -C windows windows-installer"
384 windows-installer-upload:
385 $(RUNPP) -c "$(MAKE) -C windows windows-installer-upload"
388 # These targets provide for mac native builds
389 .PHONY: mac-exe mac-upload mac-cleanup mac-dbg
393 VERSION=$(VER) $(RUNPP) -c "$(MAKE) -C mac build"
396 VERSION=$(VER) $(MAKE) -C mac diskimage
399 VERSION=$(VER) $(MAKE) -C mac upload
402 VERSION=$(VER) $(MAKE) -C mac cleanup
405 cd mac && $(PP) $(PYTHON)w allmydata_tahoe.py
407 # This target runs a stats gatherer server
408 .PHONY: stats-gatherer-run
410 $(RUNPP) -d stats_gatherer -p ../src/allmydata/stats.py