]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - Makefile
test/common.py: fix race condition waiting for the helper connection
[tahoe-lafs/tahoe-lafs.git] / Makefile
1
2 # NOTE: this Makefile requires GNU make
3
4 default: build
5
6 PYTHON=python
7 export PYTHON
8
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.
11
12 TAHOE=$(PYTHON) bin/tahoe
13 SOURCES=src/allmydata src/buildtest static misc bin/tahoe-script.template twisted setup.py
14
15 .PHONY: make-version build
16
17 # This is necessary only if you want to automatically produce a new
18 # _version.py file from the current git/darcs history.
19 make-version:
20         $(PYTHON) ./setup.py update_version
21
22 .built:
23         $(MAKE) build
24
25 src/allmydata/_version.py:
26         $(MAKE) make-version
27
28 # It is unnecessary to have this depend on build or src/allmydata/_version.py,
29 # since 'setup.py build' always updates the version using 'darcsver --count-all-patches'.
30 build:
31         $(PYTHON) setup.py build
32         touch .built
33
34 # 'make install' will do the following:
35 #   build+install tahoe (probably to /usr/lib/pythonN.N/site-packages)
36 # 'make install PREFIX=/usr/local/stow/tahoe-N.N' will do the same, but to
37 # a different location
38
39 install:
40 ifdef PREFIX
41         mkdir -p $(PREFIX)
42         $(PYTHON) ./setup.py install --single-version-externally-managed \
43            --prefix=$(PREFIX) --record=./tahoe.files
44 else
45         $(PYTHON) ./setup.py install --single-version-externally-managed
46 endif
47
48
49 # TESTING
50
51 .PHONY: signal-error-deps test check test-coverage quicktest quicktest-coverage
52 .PHONY: coverage-output get-old-coverage-coverage coverage-delta-output
53
54
55 # you can use 'make test TEST=allmydata.test.test_introducer' to run just
56 # test_introducer. TEST=allmydata.test.test_client.Basic.test_permute works
57 # too.
58 TEST=allmydata
59
60 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
61 # suppress the ansi color sequences
62
63 # It is unnecessary to have this depend on build or src/allmydata/_version.py,
64 # since 'setup.py test' always updates the version and builds before testing.
65 test:
66         $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
67         touch .built
68
69 check: test
70
71 test-coverage: build
72         rm -f .coverage
73         $(TAHOE) debug trial --reporter=bwverbose-coverage $(TEST)
74
75 quicktest:
76         $(TAHOE) debug trial $(TRIALARGS) $(TEST)
77
78 # code-coverage: install the "coverage" package from PyPI, do "make
79 # quicktest-coverage" to do a unit test run with coverage-gathering enabled,
80 # then use "make coverate-output-text" for a brief report, or "make
81 # coverage-output" for a pretty HTML report. Also see "make .coverage.el" and
82 # misc/coding_tools/coverage.el for emacs integration.
83
84 quicktest-coverage:
85         rm -f .coverage
86         PYTHONPATH=. $(TAHOE) debug trial --reporter=bwverbose-coverage $(TEST)
87 # on my laptop, "quicktest" takes 239s, "quicktest-coverage" takes 304s
88
89 # --include appeared in coverage-3.4
90 COVERAGE_OMIT=--include '$(CURDIR)/src/allmydata/*' --omit '$(CURDIR)/src/allmydata/test/*'
91 coverage-output:
92         rm -rf coverage-html
93         coverage html -i -d coverage-html $(COVERAGE_OMIT)
94         cp .coverage coverage-html/coverage.data
95         @echo "now point your browser at coverage-html/index.html"
96
97 .PHONY: upload-coverage .coverage.el pyflakes count-lines
98 .PHONY: check-memory check-memory-once check-speed check-grid
99 .PHONY: repl test-darcs-boringfile test-clean clean find-trailing-spaces
100
101 .coverage.el: .coverage
102         $(PYTHON) misc/coding_tools/coverage2el.py
103
104 # 'upload-coverage' is meant to be run with an UPLOAD_TARGET=host:/dir setting
105 ifdef UPLOAD_TARGET
106
107 ifndef UPLOAD_HOST
108 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
109 endif
110 ifndef COVERAGEDIR
111 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
112 endif
113
114 upload-coverage:
115         rsync -a coverage-html/ $(UPLOAD_TARGET)
116         ssh $(UPLOAD_HOST) make update-tahoe-coverage COVERAGEDIR=$(COVERAGEDIR)
117 else
118 upload-coverage:
119         echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
120         false
121 endif
122
123 code-checks: build version-and-path check-interfaces check-miscaptures -find-trailing-spaces -check-umids pyflakes
124
125 version-and-path:
126         $(TAHOE) --version-and-path
127
128 check-interfaces:
129         $(TAHOE) @misc/coding_tools/check-interfaces.py 2>&1 |tee violations.txt
130         @echo
131
132 check-miscaptures:
133         $(PYTHON) misc/coding_tools/check-miscaptures.py $(SOURCES) 2>&1 |tee miscaptures.txt
134         @echo
135
136 pyflakes:
137         @$(PYTHON) -OOu `which pyflakes` $(SOURCES) |sort |uniq
138         @echo
139
140 check-umids:
141         $(PYTHON) misc/coding_tools/check-umids.py `find $(SOURCES) -name '*.py'`
142         @echo
143
144 -check-umids:
145         -$(PYTHON) misc/coding_tools/check-umids.py `find $(SOURCES) -name '*.py'`
146         @echo
147
148 count-lines:
149         @echo -n "files: "
150         @find src -name '*.py' |grep -v /build/ |wc -l
151         @echo -n "lines: "
152         @cat `find src -name '*.py' |grep -v /build/` |wc -l
153         @echo -n "TODO: "
154         @grep TODO `find src -name '*.py' |grep -v /build/` | wc -l
155         @echo -n "XXX: "
156         @grep XXX `find src -name '*.py' |grep -v /build/` | wc -l
157
158 check-memory: .built
159         rm -rf _test_memory
160         $(TAHOE) @src/allmydata/test/check_memory.py upload
161         $(TAHOE) @src/allmydata/test/check_memory.py upload-self
162         $(TAHOE) @src/allmydata/test/check_memory.py upload-POST
163         $(TAHOE) @src/allmydata/test/check_memory.py download
164         $(TAHOE) @src/allmydata/test/check_memory.py download-GET
165         $(TAHOE) @src/allmydata/test/check_memory.py download-GET-slow
166         $(TAHOE) @src/allmydata/test/check_memory.py receive
167
168 check-memory-once: .built
169         rm -rf _test_memory
170         $(TAHOE) @src/allmydata/test/check_memory.py $(MODE)
171
172 # The check-speed target uses a pre-established client node to run a canned
173 # set of performance tests against a test network that is also
174 # pre-established (probably on a remote machine). Provide it with the path to
175 # a local directory where this client node has been created (and populated
176 # with the necessary FURLs of the test network). This target will start that
177 # client with the current code and then run the tests. Afterwards it will
178 # stop the client.
179 #
180 # The 'sleep 5' is in there to give the new client a chance to connect to its
181 # storageservers, since check_speed.py has no good way of doing that itself.
182
183 check-speed: .built
184         if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
185         @echo "stopping any leftover client code"
186         -$(TAHOE) stop $(TESTCLIENTDIR)
187         $(TAHOE) start $(TESTCLIENTDIR)
188         sleep 5
189         $(TAHOE) @src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
190         $(TAHOE) stop $(TESTCLIENTDIR)
191
192 # The check-grid target also uses a pre-established client node, along with a
193 # long-term directory that contains some well-known files. See the docstring
194 # in src/allmydata/test/check_grid.py to see how to set this up.
195 check-grid: .built
196         if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
197         $(TAHOE) @src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
198
199 bench-dirnode: .built
200         $(TAHOE) @src/allmydata/test/bench_dirnode.py
201
202 # the provisioning tool runs as a stand-alone webapp server
203 run-provisioning-tool: .built
204         $(TAHOE) @misc/operations_helpers/provisioning/run.py
205
206 # 'make repl' is a simple-to-type command to get a Python interpreter loop
207 # from which you can type 'import allmydata'
208 repl:
209         $(TAHOE) debug repl
210
211 test-darcs-boringfile:
212         $(MAKE)
213         $(PYTHON) misc/build_helpers/test-darcs-boringfile.py
214
215 test-git-ignore:
216         $(MAKE)
217         $(PYTHON) misc/build_helpers/test-git-ignore.py
218
219 test-clean:
220         find . |grep -vEe "_darcs|allfiles.tmp|src/allmydata/_(version|appname).py" |sort >allfiles.tmp.old
221         $(MAKE)
222         $(MAKE) clean
223         find . |grep -vEe "_darcs|allfiles.tmp|src/allmydata/_(version|appname).py" |sort >allfiles.tmp.new
224         diff allfiles.tmp.old allfiles.tmp.new
225
226 # It would be nice if 'make clean' deleted any automatically-generated
227 # _version.py too, so that 'make clean; make all' could be useable as a
228 # "what the heck is going on, get me back to a clean state', but we need
229 # 'make clean' to work on non-darcs trees without destroying useful information.
230 clean:
231         rm -rf build _trial_temp _test_memory .built
232         rm -f `find src *.egg -name '*.so' -or -name '*.pyc'`
233         rm -rf src/allmydata_tahoe.egg-info
234         rm -rf support dist
235         rm -rf `ls -d *.egg | grep -vEe"setuptools-|setuptools_darcs-|darcsver-"`
236         rm -rf *.pyc
237         rm -rf misc/dependencies/build misc/dependencies/temp
238         rm -rf misc/dependencies/tahoe_deps.egg-info
239         rm -f bin/tahoe bin/tahoe.pyscript
240
241 find-trailing-spaces:
242         $(PYTHON) misc/coding_tools/find-trailing-spaces.py -r $(SOURCES)
243         @echo
244
245 -find-trailing-spaces:
246         -$(PYTHON) misc/coding_tools/find-trailing-spaces.py -r $(SOURCES)
247         @echo
248
249 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
250 # does a build, then asserts that the build did not try to download anything
251 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
252 # support/lib/ directory is gone.
253
254 fetch-and-unpack-deps:
255         test -f tahoe-deps.tar.gz || wget https://tahoe-lafs.org/source/tahoe/deps/tahoe-deps.tar.gz
256         rm -rf tahoe-deps
257         tar xzf tahoe-deps.tar.gz
258
259 test-desert-island:
260         $(MAKE) fetch-and-unpack-deps
261         $(MAKE) 2>&1 | tee make.out
262         $(PYTHON) misc/build_helpers/check-build.py make.out no-downloads
263
264
265 # TARBALL GENERATION
266 .PHONY: tarballs upload-tarballs
267 tarballs:
268         $(MAKE) make-version
269         $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
270         $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
271
272 upload-tarballs:
273         @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