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 PP=$(shell $(PYTHON) setup.py -q show_pythonpath)
  13 RUNPP=$(PYTHON) setup.py run_with_pythonpath
  14
  15 .PHONY: make-version build
  16
  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.
  20 make-version:
  21         $(PYTHON) ./setup.py darcsver --count-all-patches
  22
  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:
  28 #
  29 #src/allmydata/_version.py: _darcs/patches
  30 #       $(MAKE) make-version
  31 #
  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.
  36 #
  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.
  45
  46 .built:
  47         $(MAKE) build
  48
  49 src/allmydata/_version.py:
  50         $(MAKE) make-version
  51
  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
  62 # three invocations.
  63
  64 build: src/allmydata/_version.py
  65         $(PYTHON) setup.py build
  66         touch .built
  67
  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
  72
  73 install: src/allmydata/_version.py
  74 ifdef PREFIX
  75         mkdir -p $(PREFIX)
  76         $(PYTHON) ./setup.py install --single-version-externally-managed \
  77            --prefix=$(PREFIX) --record=./tahoe.files
  78 else
  79         $(PYTHON) ./setup.py install --single-version-externally-managed
  80 endif
  81
  82
  83 # TESTING
  84
  85 .PHONY: signal-error-deps test test-figleaf quicktest quicktest-figleaf
  86 .PHONY: figleaf-output get-old-figleaf-coverage figleaf-delta-output
  87
  88
  89 signal-error-deps:
  90         @echo
  91         @echo
  92         @echo "ERROR: Not all of Tahoe's dependencies are in place.  Please see docs/install.html for help on installing dependencies."
  93         @echo
  94         @echo
  95         exit 1
  96
  97 check-auto-deps:
  98         $(PYTHON) setup.py -q check_auto_deps || $(MAKE) signal-error-deps
  99
 100 .checked-deps:
 101         $(MAKE) check-auto-deps
 102         touch .checked-deps
 103
 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
 106 # too.
 107 TEST=allmydata
 108
 109 # use 'make test TRIALARGS=--reporter=bwverbose' from buildbot, to
 110 # suppress the ansi color sequences
 111
 112 test: build src/allmydata/_version.py
 113         $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
 114
 115 quicktest: .built .checked-deps
 116         $(PYTHON) setup.py test $(TRIALARGS) -s $(TEST)
 117
 118 fuse-test: .built .checked-deps
 119         $(RUNPP) -d contrib/fuse -p -c runtests.py
 120
 121 test-figleaf: build src/allmydata/_version.py
 122         rm -f .figleaf
 123         $(PYTHON) setup.py trial --reporter=bwverbose-figleaf -s $(TEST)
 124
 125 quicktest-figleaf: src/allmydata/_version.py
 126         rm -f .figleaf
 127         $(PYTHON) setup.py trial --reporter=bwverbose-figleaf -s $(TEST)
 128
 129 figleaf-output:
 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"
 133
 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
 139
 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"
 144
 145 # after doing test-figleaf and figleaf-output, point your browser at
 146 # coverage-html/index.html
 147
 148 .PHONY: upload-figleaf .figleaf.el pyflakes count-lines
 149 .PHONY: check-memory check-memory-once clean
 150
 151 # 'upload-figleaf' is meant to be run with an UPLOAD_TARGET=host:/dir setting
 152 ifdef UPLOAD_TARGET
 153
 154 ifndef UPLOAD_HOST
 155 $(error UPLOAD_HOST must be set when using UPLOAD_TARGET)
 156 endif
 157 ifndef COVERAGEDIR
 158 $(error COVERAGEDIR must be set when using UPLOAD_TARGET)
 159 endif
 160
 161 upload-figleaf:
 162         rsync -a coverage-html/ $(UPLOAD_TARGET)
 163         ssh $(UPLOAD_HOST) make update-tahoe-figleaf COVERAGEDIR=$(COVERAGEDIR)
 164 else
 165 upload-figleaf:
 166         echo "this target is meant to be run with UPLOAD_TARGET=host:/path/"
 167         false
 168 endif
 169
 170 .figleaf.el: .figleaf
 171         $(RUNPP) -p -c "misc/figleaf2el.py .figleaf src"
 172
 173 pyflakes:
 174         $(PYTHON) -OOu `which pyflakes` src/allmydata |sort |uniq
 175
 176 count-lines:
 177         @echo -n "files: "
 178         @find src -name '*.py' |grep -v /build/ |wc --lines
 179         @echo -n "lines: "
 180         @cat `find src -name '*.py' |grep -v /build/` |wc --lines
 181         @echo -n "TODO: "
 182         @grep TODO `find src -name '*.py' |grep -v /build/` | wc --lines
 183
 184 check-memory: .built
 185         rm -rf _test_memory
 186         $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload"
 187         $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-self"
 188         $(RUNPP) -p -c "src/allmydata/test/check_memory.py upload-POST"
 189         $(RUNPP) -p -c "src/allmydata/test/check_memory.py download"
 190         $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET"
 191         $(RUNPP) -p -c "src/allmydata/test/check_memory.py download-GET-slow"
 192         $(RUNPP) -p -c "src/allmydata/test/check_memory.py receive"
 193
 194 check-memory-once: .built
 195         rm -rf _test_memory
 196         $(RUNPP) -p -c "src/allmydata/test/check_memory.py $(MODE)"
 197
 198 # The check-speed target uses a pre-established client node to run a canned
 199 # set of performance tests against a test network that is also
 200 # pre-established (probably on a remote machine). Provide it with the path to
 201 # a local directory where this client node has been created (and populated
 202 # with the necessary FURLs of the test network). This target will start that
 203 # client with the current code and then run the tests. Afterwards it will
 204 # stop the client.
 205 #
 206 # The 'sleep 5' is in there to give the new client a chance to connect to its
 207 # storageservers, since check_speed.py has no good way of doing that itself.
 208
 209 check-speed: .built
 210         if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
 211         @echo "stopping any leftover client code"
 212         -$(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
 213         $(PYTHON) bin/tahoe start $(TESTCLIENTDIR)
 214         sleep 5
 215         $(PYTHON) src/allmydata/test/check_speed.py $(TESTCLIENTDIR)
 216         $(PYTHON) bin/tahoe stop $(TESTCLIENTDIR)
 217
 218 # The check-grid target also uses a pre-established client node, along with a
 219 # long-term directory that contains some well-known files. See the docstring
 220 # in src/allmydata/test/check_grid.py to see how to set this up.
 221 check-grid: .built
 222         if [ -z '$(TESTCLIENTDIR)' ]; then exit 1; fi
 223         $(PYTHON) src/allmydata/test/check_grid.py $(TESTCLIENTDIR) bin/tahoe
 224
 225 # 'make repl' is a simple-to-type command to get a Python interpreter loop
 226 # from which you can type 'import allmydata'
 227 repl:
 228         $(RUNPP) -p
 229
 230 test-darcs-boringfile:
 231         $(MAKE)
 232         $(PYTHON) misc/test-darcs-boringfile.py
 233
 234 test-clean:
 235         find . |grep -vEe "allfiles.tmp|src/allmydata/_(version|auto_deps|appname).py" |sort >allfiles.tmp.old
 236         $(MAKE)
 237         $(MAKE) clean
 238         find . |grep -vEe "allfiles.tmp|src/allmydata/_(version|auto_deps|appname).py" |sort >allfiles.tmp.new
 239         diff allfiles.tmp.old allfiles.tmp.new
 240
 241 clean:
 242         rm -rf build _trial_temp _test_memory .checked-deps .built
 243         rm -f debian
 244         rm -f `find src/allmydata -name '*.so' -or -name '*.pyc'`
 245         rm -rf src/allmydata_tahoe.egg-info
 246         rm -rf support dist
 247         rm -rf setuptools*.egg *.pyc darcsver*.egg pyutil*.egg
 248         rm -rf misc/dependencies/build misc/dependencies/temp
 249         rm -rf misc/dependencies/tahoe_deps.egg-info
 250         rm -f bin/tahoe bin/tahoe-script.py
 251
 252 find-trailing-spaces:
 253         $(PYTHON) misc/find-trailing-spaces.py -r src
 254
 255 # The test-desert-island target grabs the tahoe-deps tarball, unpacks it,
 256 # does a build, then asserts that the build did not try to download anything
 257 # as it ran. Invoke this on a new tree, or after a 'clean', to make sure the
 258 # support/lib/ directory is gone.
 259
 260 fetch-and-unpack-deps:
 261         test -f tahoe-deps.tar.gz || wget http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz
 262         rm -rf tahoe-deps
 263         tar xf tahoe-deps.tar.gz
 264
 265 test-desert-island:
 266         $(MAKE) fetch-and-unpack-deps
 267         $(MAKE) 2>&1 | tee make.out
 268         $(PYTHON) misc/check-build.py make.out no-downloads
 269
 270
 271 # TARBALL GENERATION
 272 .PHONY: tarballs upload-tarballs
 273 tarballs:
 274         $(MAKE) make-version
 275         $(PYTHON) setup.py sdist --formats=bztar,gztar,zip
 276         $(PYTHON) setup.py sdist --sumo --formats=bztar,gztar,zip
 277
 278 upload-tarballs:
 279         for f in dist/allmydata-tahoe-*; do \
 280          xfer-client --furlfile ~/.tahoe-tarball-upload.furl $$f; \
 281         done
 282
 283 # DEBIAN PACKAGING
 284
 285 VER=$(shell $(PYTHON) misc/get-version.py)
 286 DEBCOMMENTS="'make deb' build"
 287
 288 show-version:
 289         @echo $(VER)
 290 show-pp:
 291         @echo $(PP)
 292
 293 .PHONY: setup-deb deb-ARCH is-known-debian-arch
 294 .PHONY: deb-etch deb-sid
 295 .PHONY: deb-edgy deb-feisty deb-gutsy deb-hardy
 296
 297 deb-sid:
 298         $(MAKE) deb-ARCH ARCH=sid
 299 deb-feisty:
 300         $(MAKE) deb-ARCH ARCH=feisty
 301 # edgy uses the feisty control files for now
 302 deb-edgy:
 303         $(MAKE) deb-ARCH ARCH=edgy TAHOE_ARCH=feisty
 304 # etch uses the feisty control files for now
 305 deb-etch:
 306         $(MAKE) deb-ARCH ARCH=etch TAHOE_ARCH=feisty
 307 # same with gutsy, the process has been nicely stable for a while now
 308 deb-gutsy:
 309         $(MAKE) deb-ARCH ARCH=gutsy TAHOE_ARCH=feisty
 310 deb-hardy:
 311         $(MAKE) deb-ARCH ARCH=hardy TAHOE_ARCH=feisty
 312
 313 # we know how to handle the following debian architectures
 314 KNOWN_DEBIAN_ARCHES := etch sid  edgy feisty gutsy hardy
 315
 316 ifeq ($(findstring x-$(ARCH)-x,$(foreach arch,$(KNOWN_DEBIAN_ARCHES),"x-$(arch)-x")),)
 317 is-known-debian-arch:
 318         @echo "ARCH must be set when using setup-deb or deb-ARCH"
 319         @echo "I know how to handle:" $(KNOWN_DEBIAN_ARCHES)
 320         false
 321 else
 322 is-known-debian-arch:
 323         true
 324 endif
 325
 326 ifndef TAHOE_ARCH
 327 TAHOE_ARCH=$(ARCH)
 328 endif
 329
 330 setup-deb: is-known-debian-arch
 331         rm -f debian
 332         ln -s misc/$(TAHOE_ARCH)/debian debian
 333         chmod +x debian/rules
 334
 335 # etch (current debian stable) has python-simplejson-1.3, which doesn't
 336 #  support indent=
 337 # sid (debian unstable) currently has python-simplejson 1.7.1
 338 # edgy has 1.3, which doesn't support indent=
 339 # feisty has 1.4, which supports indent= but emits a deprecation warning
 340 # gutsy has 1.7.1
 341 #
 342 # we need 1.4 or newer
 343
 344 deb-ARCH: is-known-debian-arch setup-deb
 345         fakeroot debian/rules binary
 346         @echo
 347         @echo "The newly built .deb packages are in the parent directory from here."
 348
 349 .PHONY: increment-deb-version
 350 .PHONY: deb-edgy-head deb-feisty-head deb-gutsy-head deb-hardy-head
 351 .PHONY: deb-etch-head deb-sid-head
 352
 353 # The buildbot runs the following targets after each change, to produce
 354 # up-to-date tahoe .debs. These steps do not create .debs for anything else.
 355
 356 increment-deb-version: make-version
 357         debchange --newversion $(VER) $(DEBCOMMENTS)
 358 deb-sid-head:
 359         $(MAKE) setup-deb ARCH=sid
 360         $(MAKE) increment-deb-version
 361         fakeroot debian/rules binary
 362 deb-edgy-head:
 363         $(MAKE) setup-deb ARCH=edgy TAHOE_ARCH=feisty
 364         $(MAKE) increment-deb-version
 365         fakeroot debian/rules binary
 366 deb-feisty-head:
 367         $(MAKE) setup-deb ARCH=feisty
 368         $(MAKE) increment-deb-version
 369         fakeroot debian/rules binary
 370 deb-etch-head:
 371         $(MAKE) setup-deb ARCH=etch TAHOE_ARCH=feisty
 372         $(MAKE) increment-deb-version
 373         fakeroot debian/rules binary
 374 deb-gutsy-head:
 375         $(MAKE) setup-deb ARCH=gutsy TAHOE_ARCH=feisty
 376         $(MAKE) increment-deb-version
 377         fakeroot debian/rules binary
 378 deb-hardy-head:
 379         $(MAKE) setup-deb ARCH=hardy TAHOE_ARCH=feisty
 380         $(MAKE) increment-deb-version
 381         fakeroot debian/rules binary
 382
 383 # These targets provide for windows native builds
 384 .PHONY: windows-exe windows-installer windows-installer-upload
 385
 386 windows-exe: .built
 387         $(RUNPP) -c "$(MAKE) -C windows windows-exe"
 388
 389 windows-installer:
 390         $(RUNPP) -c "$(MAKE) -C windows windows-installer"
 391
 392 windows-installer-upload:
 393         $(RUNPP) -c "$(MAKE) -C windows windows-installer-upload"
 394
 395
 396 # These targets provide for mac native builds
 397 .PHONY: mac-exe mac-upload mac-cleanup mac-dbg
 398
 399 mac-exe: .built
 400         $(MAKE) -C mac clean
 401         VERSION=$(VER) $(RUNPP) -c "$(MAKE) -C mac build"
 402
 403 mac-dist:
 404         VERSION=$(VER) $(MAKE) -C mac diskimage
 405
 406 mac-upload:
 407         VERSION=$(VER) $(MAKE) -C mac upload
 408
 409 mac-cleanup:
 410         VERSION=$(VER) $(MAKE) -C mac cleanup
 411
 412 mac-dbg:
 413         cd mac && $(PP) $(PYTHON)w allmydata_tahoe.py
 414