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 without an obligatory 'build' step this rule
34 # wouldn't be run frequently enough anyways.
36 # So instead, I'll just make sure that we update the version at least once
37 # when we first start using the tree, and again whenever an explicit
38 # 'make-version' is run, since then at least the developer has some means to
39 # update things. It would be nice if 'make clean' deleted any
40 # automatically-generated _version.py too, so that 'make clean; make all'
41 # could be useable as a "what the heck is going on, get me back to a clean
42 # state', but we need 'make clean' to work on non-darcs trees without
43 # destroying useful information.
48 src/allmydata/_version.py:
51 # c.f. ticket #455, there is a problem in the intersection of setuptools,
52 # twisted's setup.py, and nevow's setup.py . A Tahoe build, to satisfy its
53 # dependencies, may try to build both Twisted and Nevow. If both of these
54 # occur during the same invocation of 'setup.py develop', then the Nevow
55 # build will fail with an "ImportError: No module named components". Running
56 # the build a second time will succeed. Until there is a new version of
57 # setuptools which properly sandboxes sys.modules (or a new version of nevow
58 # which doesn't import twisted during its build, or a new version of twisted
59 # which doesn't import itself during its build), we just build tahoe twice
60 # and ignore the errors from the first pass. Updated 16-Sep-2008: now we need
63 build: src/allmydata/_version.py
64 $(PYTHON) setup.py build
67 # 'make install' will do the following:
68 # build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
69 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
70 # a different location
72 install: src/allmydata/_version.py
75 $(PYTHON) ./setup.py install --single-version-externally-managed \
76 --prefix=$(PREFIX) --record=./tahoe.files
78 $(PYTHON) ./setup.py install --single-version-externally-managed
84 .PHONY: signal-error-deps test test-coverage quicktest quicktest-coverage
85 .PHONY: coverage-output get-old-coverage-coverage coverage-delta-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 fuse-test: .built .checked-deps
115 $(RUNPP) -d contrib/fuse -p -c runtests.py
117 test-coverage: build src/allmydata/_version.py
119 $(PYTHON) setup.py trial --reporter=bwverbose-coverage -s $(TEST)
122 $(PYTHON) misc/build_helpers/run-with-pythonpath.py trial $(TRIALARGS) $(TEST)
124 # code-coverage: install the "coverage" package from PyPI, do "make
125 # quicktest-coverage" to do a unit test run with coverage-gathering enabled,
126 # then use "make coverate-output-text" for a brief report, or "make
127 # coverage-output" for a pretty HTML report. Also see "make .coverage.el" and
128 # misc/coding_tools/coverage.el for emacs integration.
132 $(PYTHON) misc/build_helpers/run-with-pythonpath.py trial --reporter=bwverbose-coverage $(TEST)
133 # on my laptop, "quicktest" takes 239s, "quicktest-coverage" takes 304s
135 # --include appeared in coverage-3.4
136 COVERAGE_OMIT=--include '$(CURDIR)/src/allmydata/*' --omit '$(CURDIR)/src/allmydata/test/*'
139 coverage html -i -d coverage-html $(COVERAGE_OMIT)
140 cp .coverage coverage-html/coverage.data
141 @echo "now point your browser at coverage-html/index.html"
143 ## use these two targets to compare this coverage against the previous run.
144 ## The deltas only work if the old test was run in the same directory, since
145 ## it compares absolute filenames.
146 #get-old-figleaf-coverage:
147 # wget --progress=dot -O old.figleaf http://allmydata.org/tahoe-figleaf/current/figleaf.pickle
149 #figleaf-delta-output:
150 # $(RUNPP) -p -c "misc/figleaf2html -d coverage-html -r src -x misc/figleaf.excludes -o old.figleaf"
151 # cp .figleaf coverage-html/figleaf.pickle
152 # @echo "now point your browser at coverage-html/index.html"
154 .PHONY: upload-coverage .coverage.el pyflakes count-lines
155 .PHONY: check-memory check-memory-once check-speed check-grid
156 .PHONY: repl test-darcs-boringfile test-clean clean find-trailing-spaces
158 .coverage.el: .coverage
159 $(PYTHON) misc/coding_tools/coverage2el.py
161 # 'upload-coverage' is meant to be run with an UPLOAD_TARGET=host:/dir setting
165 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
168 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
172 rsync -a coverage-html/ $(UPLOAD_TARGET)
173 ssh $(UPLOAD_HOST) make update-tahoe-coverage COVERAGEDIR=$(COVERAGEDIR)
176 echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
182 $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
184 $(PYTHON) misc/coding_tools/check-umids.py `find src/allmydata -name '*.py'`
188 @find src -name '*.py' |grep -v /build/ |wc --lines
190 @cat `find src -name '*.py' |grep -v /build/` |wc --lines
192 @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
196 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload"
197 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-self"
198 $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-POST"
199 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download"
200 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET"
201 $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET-slow"
202 $(RUNPP) -p -c "src/allmydata/test/check_memory.py receive"
204 check-memory-once: .built
206 $(RUNPP) -p -c "src/allmydata/test/check_memory.py $(MODE)"
208 # The check-speed target uses a pre-established client node to run a canned
209 # set of performance tests against a test network that is also
210 # pre-established (probably on a remote machine). Provide it with the path to
211 # a local directory where this client node has been created (and populated
212 # with the necessary FURLs of the test network). This target will start that
213 # client with the current code and then run the tests. Afterwards it will
216 # The 'sleep 5' is in there to give the new client a chance to connect to its
217 # storageservers, since check_speed.py has no good way of doing that itself.
220 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
221 @echo "stopping any leftover client code"
222 -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
223 $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
225 $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
226 $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
228 # The check-grid target also uses a pre-established client node, along with a
229 # long-term directory that contains some well-known files. See the docstring
230 # in src/allmydata/test/check_grid.py to see how to set this up.
232 if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
233 $(PYTHON) src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
235 bench-dirnode: .built
236 $(RUNPP) -p -c src/allmydata/test/bench_dirnode.py
238 # 'make repl' is a simple-to-type command to get a Python interpreter loop
239 # from which you can type 'import allmydata'
243 test-darcs-boringfile:
245 $(PYTHON) misc/build_helpers/test-darcs-boringfile.py
248 find . |grep -vEe "_darcs|allfiles.tmp|src/allmydata/_(version|appname).py" |sort >allfiles.tmp.old
251 find . |grep -vEe "_darcs|allfiles.tmp|src/allmydata/_(version|appname).py" |sort >allfiles.tmp.new
252 diff allfiles.tmp.old allfiles.tmp.new
255 rm -rf build _trial_temp _test_memory .checked-deps .built
256 rm -f `find src *.egg -name '*.so' -or -name '*.pyc'`
257 rm -rf src/allmydata_tahoe.egg-info
259 rm -rf `ls -d *.egg | grep -vEe"setuptools-|setuptools_trial-|darcsver-"`
261 rm -rf misc/dependencies/build misc/dependencies/temp
262 rm -rf misc/dependencies/tahoe_deps.egg-info
263 rm -f bin/tahoe bin/tahoe.pyscript
265 find-trailing-spaces:
266 $(PYTHON) misc/coding_tools/find-trailing-spaces.py -r src
268 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
269 # does a build, then asserts that the build did not try to download anything
270 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
271 # support/lib/ directory is gone.
273 fetch-and-unpack-deps:
274 test -f tahoe-deps.tar.gz || wget http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz
276 tar xzf tahoe-deps.tar.gz
279 $(MAKE) fetch-and-unpack-deps
280 $(MAKE) 2>&1 | tee make.out
281 $(PYTHON) misc/build_helpers/check-build.py make.out no-downloads
285 .PHONY: tarballs upload-tarballs
288 $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
289 $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
292 @if [ "X${BB_BRANCH}" == "Xtrunk" ] || [ "X${BB_BRANCH}" == "X" ]; then for f in dist/allmydata-tahoe-*; do flappclient --furlfile ~/.tahoe-tarball-upload.furl upload-file $$f; done ; else echo not uploading tarballs because this is not trunk but is branch \"${BB_BRANCH}\" ; fi
296 VER=$(shell $(PYTHON) misc/build_helpers/get-version.py)
297 DEBCOMMENTS="'make deb' build"
304 .PHONY: setup-deb deb-ARCH is-known-debian-arch
305 .PHONY: deb-etch deb-lenny deb-sid
306 .PHONY: deb-edgy deb-feisty deb-gutsy deb-hardy deb-intrepid deb-jaunty
308 # we use misc/debian_helpers/$TAHOE_ARCH/debian
311 $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=etch
313 $(MAKE) deb-ARCH ARCH=lenny TAHOE_ARCH=lenny
315 $(MAKE) deb-ARCH ARCH=sid TAHOE_ARCH=sid
318 $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=etch
320 $(MAKE) deb-ARCH ARCH=feisty TAHOE_ARCH=lenny
322 $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=lenny
324 $(MAKE) deb-ARCH ARCH=hardy TAHOE_ARCH=lenny
325 deb-intrepid: # py2.5
326 $(MAKE) deb-ARCH ARCH=intrepid TAHOE_ARCH=lenny
328 $(MAKE) deb-ARCH ARCH=jaunty TAHOE_ARCH=lenny
332 # we know how to handle the following debian architectures
333 KNOWN_DEBIAN_ARCHES := etch lenny sid edgy feisty gutsy hardy intrepid jaunty
335 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
336 is-known-debian-arch:
337 @echo "ARCH must be set when using setup-deb or deb-ARCH"
338 @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
341 is-known-debian-arch:
349 setup-deb: is-known-debian-arch
351 ln -s misc/debian_helpers/$(TAHOE_ARCH)/debian debian
352 chmod +x debian/rules
354 # etch (current debian stable) has python-simplejson-1.3, which doesn't
356 # sid (debian unstable) currently has python-simplejson 1.7.1
357 # edgy has 1.3, which doesn't support indent=
358 # feisty has 1.4, which supports indent= but emits a deprecation warning
361 # we need 1.4 or newer
363 deb-ARCH: is-known-debian-arch setup-deb
364 fakeroot debian/rules binary
366 @echo "The newly built .deb packages are in the parent directory from here."
368 .PHONY: increment-deb-version
369 .PHONY: deb-etch-head deb-lenny-head deb-sid-head
370 .PHONY: deb-edgy-head deb-feisty-head deb-gutsy-head deb-hardy-head deb-intrepid-head deb-jaunty-head
372 # The buildbot runs the following targets after each change, to produce
373 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
375 increment-deb-version: make-version
376 debchange --newversion $(VER) $(DEBCOMMENTS)
378 $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=etch
379 $(MAKE) increment-deb-version
380 fakeroot debian/rules binary
382 $(MAKE) setup-deb ARCH=lenny TAHOE_ARCH=lenny
383 $(MAKE) increment-deb-version
384 fakeroot debian/rules binary
386 $(MAKE) setup-deb ARCH=sid TAHOE_ARCH=lenny
387 $(MAKE) increment-deb-version
388 fakeroot debian/rules binary
391 $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=etch
392 $(MAKE) increment-deb-version
393 fakeroot debian/rules binary
395 $(MAKE) setup-deb ARCH=feisty TAHOE_ARCH=lenny
396 $(MAKE) increment-deb-version
397 fakeroot debian/rules binary
399 $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=lenny
400 $(MAKE) increment-deb-version
401 fakeroot debian/rules binary
403 $(MAKE) setup-deb ARCH=hardy TAHOE_ARCH=lenny
404 $(MAKE) increment-deb-version
405 fakeroot debian/rules binary
407 $(MAKE) setup-deb ARCH=intrepid TAHOE_ARCH=lenny
408 $(MAKE) increment-deb-version
409 fakeroot debian/rules binary
411 $(MAKE) setup-deb ARCH=jaunty TAHOE_ARCH=lenny
412 $(MAKE) increment-deb-version
413 fakeroot debian/rules binary
415 # new experimental debian-packaging-building target
416 .PHONY: EXPERIMENTAL-deb
417 EXPERIMENTAL-deb: is-known-debian-arch
418 $(PYTHON) misc/build_helpers/build-deb.py $(ARCH)