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