Ticket #1303: bin-tahoe-runner-support.darcs.patch

1 patch for repository davidsarah@dev.allmydata.org:/home/darcs/tahoe/trunk:

Thu Jan 13 02:54:21 GMT Standard Time 2011  david-sarah@jacaranda.org
  * Add support to bin/tahoe for invoking a runner command prefixed with @, with the Tahoe libraries on the PYTHONPATH. This is documented in 'tahoe debug --help'.

New patches:

[Add support to bin/tahoe for invoking a runner command prefixed with @, with the Tahoe libraries on the PYTHONPATH. This is documented in 'tahoe debug --help'.
david-sarah@jacaranda.org**20110113025421
 Ignore-this: 138b35ef88f2c48ae2b135ed99348542
] {
hunk ./bin/tahoe-script.template 17
 whoami = '''\
 I am a "bin%stahoe" executable who is only for the convenience of running
 Tahoe from its source distribution -- I work only when invoked as the "tahoe"
-script that lives in the "bin/" subdirectory of a Tahoe source code
-distribution, and only if you have already run "make".
+script that lives in the "bin" subdirectory of a Tahoe source code
+distribution, and only if you have already run "python setup.py build".
 ''' % (os.path.sep,)
 
 # look for Tahoe.home .
hunk ./bin/tahoe-script.template 68
     def mangle(s):
         return str(re.sub(ur'[^\x20-\x7F]', lambda m: u'\x7F%x;' % (ord(m.group(0)),), s))
 
-    argv = [mangle(argv_unicode[i]) for i in xrange(1, argc.value)]
+    argv = [mangle(argv_unicode[i]) for i in xrange(0, argc.value)]
 
hunk ./bin/tahoe-script.template 70
-    # Skip option arguments to the Python interpreter.
-    while len(argv) > 0:
-        arg = argv[0]
-        if not arg.startswith(u"-") or arg == u"-":
-            break
-        argv = argv[1:]
-        if arg == u'-m' or arg == u'-c':
-            break
+    # Take only the suffix with the same number of arguments as sys.argv.
+    # This accounts for anything that can cause initial arguments to be stripped,
+    # for example, the Python interpreter or any options passed to it, or runner
+    # scripts such as 'coverage run'. It works even if there are no such arguments,
+    # as in the case of a frozen executable created by bb-freeze or similar.
 
hunk ./bin/tahoe-script.template 76
-    script = os.path.join(base, "support", "Scripts", "tahoe.pyscript")
+    argv = argv[-len(sys.argv):]
 
     # On Windows, the script is not directly executable and must be run via python.
hunk ./bin/tahoe-script.template 79
-    args = [sys.executable, script] + argv[1:]
+    prefix = [sys.executable]
+    script = os.path.join(base, "support", "Scripts", "tahoe.pyscript")
+    args = argv[1:]
 else:
hunk ./bin/tahoe-script.template 83
-    script = os.path.join(base, "support", "bin", "tahoe")
-
     # On non-Windows, invoke the script directly, so that 'top' for example shows 'tahoe'.
hunk ./bin/tahoe-script.template 84
-    args = [script] + sys.argv[1:]
+    prefix = []
+    script = os.path.join(base, "support", "bin", "tahoe")
+    args = sys.argv[1:]
 
hunk ./bin/tahoe-script.template 88
-try:
-    res = subprocess.call(args, env=os.environ)
-except (OSError, IOError), le:
-    if le.args[0] == errno.ENOENT:
-        print whoami
-        print '''\
+if not os.path.exists(script):
+    print whoami
+    print '''\
 I just tried to run and could not find my brother at
 "%s". To run Tahoe when it is installed, please execute my
 brother, who gets installed into the appropriate place for executables
hunk ./bin/tahoe-script.template 94
-when you run "make install" (perhaps as "%s").
+when you run "python setup.py install" (perhaps as "%s").
 ''' % (script, perhaps_installed_tahoe)
hunk ./bin/tahoe-script.template 96
-        raise
+    sys.exit(1)
+
+# Support indirection via another "runner" script (e.g. coverage).
+# For example: bin/tahoe @RUNNER RUNNER_ARGS @tahoe TAHOE_ARGS
+
+if len(args) >= 1 and args[0].startswith('@'):
+    command = [args[0][1:]] + [(script if a == '@tahoe' else a) for a in args[1:]]
+else:
+    command = prefix + [script] + args
+
+try:
+    res = subprocess.call(command, env=os.environ)
 except Exception, le:
     print whoami
     print '''\
hunk ./bin/tahoe-script.template 117
     raise
 else:
     sys.exit(res)
-
hunk ./src/allmydata/scripts/debug.py 809
 
 Please run e.g. 'tahoe debug dump-share --help' for more details on each
 subcommand.
-"""
+
+Another debugging feature is that bin%stahoe allows executing an arbitrary
+"runner" command (typically an installed Python script, such as 'coverage'),
+with the Tahoe libraries on the PYTHONPATH. The runner command name is
+prefixed with '@', and any occurrences of '@tahoe' in its arguments are
+replaced by the full path to the tahoe script.
+
+For example, if 'coverage' is installed and on the PATH, you can use:
+
+    bin%stahoe @coverage run --branch @tahoe debug trial
+
+to get branch coverage for the Tahoe test suite. Or, to run python with
+the -3 option that warns about Python 3 incompatibilities:
+
+    bin%stahoe @python -3 @tahoe command [options]
+""" % (os.sep, os.sep, os.sep)
         return t
 
 subDispatch = {
hunk ./src/allmydata/windows/fixups.py 180
         return re.sub(ur'\x7F[0-9a-fA-F]*\;', lambda m: unichr(int(m.group(0)[1:-1], 16)), s)
 
     try:
-        argv = [unmangle(argv_unicode[i]).encode('utf-8') for i in xrange(1, argc.value)]
+        argv = [unmangle(argv_unicode[i]).encode('utf-8') for i in xrange(0, argc.value)]
     except Exception, e:
         _complain("%s:  could not unmangle Unicode arguments.\n%r"
hunk ./src/allmydata/windows/fixups.py 183
-                  % (sys.argv[0], [argv_unicode[i] for i in xrange(1, argc.value)]))
+                  % (sys.argv[0], [argv_unicode[i] for i in xrange(0, argc.value)]))
         raise
 
hunk ./src/allmydata/windows/fixups.py 186
-    # Skip option arguments to the Python interpreter.
-    while len(argv) > 0:
-        arg = argv[0]
-        if not arg.startswith(u"-") or arg == u"-":
-            if arg.endswith('.pyscript'):
-                argv[0] = arg[:-9]
-            break
-        argv = argv[1:]
-        if arg == u'-m':
-            # sys.argv[0] should really be the absolute path of the module source, but never mind
-            break
-        if arg == u'-c':
-            argv[0] = u'-c'
-            break
+    # Take only the suffix with the same number of arguments as sys.argv.
+    # This accounts for anything that can cause initial arguments to be stripped,
+    # for example, the Python interpreter or any options passed to it, or runner
+    # scripts such as 'coverage run'. It works even if there are no such arguments,
+    # as in the case of a frozen executable created by bb-freeze or similar.
 
hunk ./src/allmydata/windows/fixups.py 192
-    sys.argv = argv
+    sys.argv = argv[-len(sys.argv):]
}

Context:

[bin/tahoe-script.template: improve the error message if we end up running under Python 3. refs #1302
david-sarah@jacaranda.org**20110112211628
 Ignore-this: ee78f8e4bbd197e620cb0cc6b995ac46
] 
[Makefile: Fix uploading of tarballs on trunk builds.
david-sarah@jacaranda.org**20110109065851
 Ignore-this: 864b06e39103f46dbb6ccb74e1e333d3
] 
[docs/frontends/CLI.rst: fix the rst syntax to be as actually intended :-)
david-sarah@jacaranda.org**20110109014057
 Ignore-this: c11331670ba89d8601ba3782ffc4f32c
] 
[docs/frontends/CLI.rst: really fix rst syntax error this time.
david-sarah@jacaranda.org**20110109013914
 Ignore-this: 59550154c9ab41488ddfdee8938d7bda
] 
[docs/frontends/CLI.rst: fix rst syntax error.
david-sarah@jacaranda.org**20110109010943
 Ignore-this: 427444f5572115059c75fa1bd8371d51
] 
[docs/frontends/CLI.rst: discuss commandline/output quoting issues and wildcards. refs #1135
david-sarah@jacaranda.org**20110109010119
 Ignore-this: 533938d89be878b404a8540aebdf68ad
] 
[setup.py: add Python 2.7 trove classifier.
david-sarah@jacaranda.org**20110108211212
 Ignore-this: b479c0a1adf9b7a2d1fdc54abc6582e6
] 
[docs/FTP-and-SFTP.rst: document issue in ref #1297. Remove known issue #1045 which is fixed. Also some cosmetic changes.
david-sarah@jacaranda.org**20110108061038
 Ignore-this: 8d9aa2e33f1054545f7bed47bf0e647d
] 
[misc/build_helpers/show-tool-versions.py: remove attempts to show stdout.encoding and stderr.encoding that always printed None due to redirection. Also remove code to show os.path.supports_unicode_filenames which is not useful. refs #1251
david-sarah@jacaranda.org**20110103015144
 Ignore-this: 45e11431f7e2e0cebcb58e1841485cf8
] 
[NEWS: 'top' for node processes, WUI formatting, removal of GUI apps, documentation updates, foolscap dependency. refs #174, #1219, #1225
david-sarah@jacaranda.org**20110106005727
 Ignore-this: f61ac58b4d10e635feb6f7391b1b48fe
] 
[Makefile: update 'clean' target for files in bin/
david-sarah@jacaranda.org**20110103052738
 Ignore-this: 2bdbc4a50e13e508b66d0f65718c79b2
] 
[docs: update performance.rst to describe the difference between already-uploaded and not-already-uploaded, to parameterize segment size, and to use "~A" to mean "approximately A"
zooko@zooko.com**20110104065455
 Ignore-this: 8df0d79a062ee19854c0211bd202f606
] 
[bin/tahoe-script.template: On non-Windows, invoke support/bin/tahoe directly as a script (rather than via python), so that 'top' for example will show it as 'tahoe'. On Windows, simplify some code that set argv[0], which is never used. fixes #174
david-sarah@jacaranda.org**20101127232650
 Ignore-this: 42a86f3eecfdc1ea7b76a7cc68626898
] 
[test_runner: avoid unnecessary use of non-ASCII.
david-sarah@jacaranda.org**20110101100101
 Ignore-this: e2ff40dce6bb3b021306f2913d4e75df
] 
[docs/quickstart.html: fix redundant, badly nested tag. refs #1284
david-sarah@jacaranda.org**20110102175159
 Ignore-this: 2ae9cc0b47d2e87b9eb64a0f517c4eef
] 
[docs/quickstart.html: information about 'troublesome dependencies' and 'verified systems' de-emphasized by smaller italic font. Re-wrap so that the HTML source is readable (just about) as text. Minor wording tweaks. Improve organization by adding 'Windows Caveats' subsection. fixes #1284
david-sarah@jacaranda.org**20110102174212
 Ignore-this: e9dc57983974478200856651c5318fee
] 
[NEWS: update entry for removal of Mac and Windows apps. refs #1282
david-sarah@jacaranda.org**20101226042245
 Ignore-this: c8099bc6e8235718d042c9a13c1e2425
] 
[Move dependency imports from windows/depends.py (which has gone away) into src/allmydata/windows/tahoesvc.py. Also fix a pyflakes warning, and change the service display name from 'Allmydata Tahoe Node' to 'Tahoe-LAFS node'. refs #1282
david-sarah@jacaranda.org**20101226042100
 Ignore-this: ee45f324934e1251380206dbee6346d0
] 
[Remove unmaintained Windows GUI app, except for windows/tahoesvc.py which is moved to src/allmydata/windows. refs #1282
david-sarah@jacaranda.org**20101226040237
 Ignore-this: cae37b6622a7dd5940acc7d3e6a98b90
] 
[Remove the Makefile targets relating to the Mac GUI app. refs #1282
david-sarah@jacaranda.org**20101226025859
 Ignore-this: 75303be783974b41138744ec62b07965
] 
[NEWS: remove unmaintained Mac GUI app. refs #1282
david-sarah@jacaranda.org**20101226020858
 Ignore-this: 40474a07f4a550b48563d35350be7ab5
] 
[Remove unmaintained Mac GUI app. fixes #1282
david-sarah@jacaranda.org**20101226020508
 Ignore-this: b3613bf1abfd284d542bf7c753ec557a
] 
[Remove src/allmydata/util/find_exe.py which is no longer used. fixes #1150
david-sarah@jacaranda.org**20101226023206
 Ignore-this: 7436c9b53bf210aed34a1a973cd9cace
] 
[status_web_pages_review.darcs.patch 
freestorm77@gmail.com**20110102034214
 Ignore-this: 29f1ecb36177f10f3f846b3d56b313b2
 
 I make some changes on status web pages
 
 status.xhtml:
 - Delete unused webform_css link
 - Align tables on the left
 
 tahoe-css:
 - Do some minor changes on code synthax
 - changes table.status-download-events style to look like other tables
 
 status.py:
 - Align table on the left
 - Changes table header
 - Add heading tags
 - Modify google api graph: add image border, calculate height to feet data
 
 signed-off-by: zooko@zooko.com
 fixes #1219
] 
[test_storage.py: fix a pyflakes unused import warning.
david-sarah@jacaranda.org**20101231220756
 Ignore-this: df08231540cb7dff9d2b038e47ab30ee
] 
[test_storage.py: leave at least 512 MiB free when running test_large_share. refs #1195
david-sarah@jacaranda.org**20101231203215
 Ignore-this: b2144c0341c3452b5d4ba219e284ea0e
] 
[storage: use fileutil's version of get_disk_stats() and get_available_space(), use mockery/fakery in tests, enable large share test on platforms with sparse files and if > 4 GiB of disk space is currently available
zooko@zooko.com**20100910173629
 Ignore-this: 1304f1164c661de6d5304f993eb9b27b
] 
[fileutil: copy in the get_disk_stats() and get_available_space() functions from storage/server.py
zooko@zooko.com**20100910173520
 Ignore-this: 8b15569715f710f4fc5092f7ca109253
] 
[Update foolscap version requirement to 0.6.0, to address http://foolscap.lothar.com/trac/ticket/167
david-sarah@jacaranda.org**20101231060039
 Ignore-this: 98d2b8086a1a500b9f4565bca5a3810
] 
[docs/webapi.rst: typos.
david-sarah@jacaranda.org**20101230034422
 Ignore-this: d1f5166d72cc711f7e0d9981eac9105e
] 
[docs/webapi.rst: capitalization, formatting of section on URL character encoding, and a correction about Internet Explorer.
david-sarah@jacaranda.org**20101230034049
 Ignore-this: b3b9819d2fb264b4cdc5c8afd4e8c48d
] 
[docs: corrections and clarifications.
david-sarah@jacaranda.org**20101227051056
 Ignore-this: e33202858c7644c58f3f924b164294b6
] 
[docs: more formatting cleanups and corrections. Spell webapi and wapi as web-API.
david-sarah@jacaranda.org**20101227050533
 Ignore-this: 18b23cbfb780df585d8a722a1ec63e94
] 
[docs/debian.rst: bring description of building dependencies from source up-to-date, and change hostname from allmydata.com to tahoe-lafs.org.
david-sarah@jacaranda.org**20101212222912
 Ignore-this: f38462afc88b4475195610385a28391c
] 
[docs/architecture.rst: correct rst syntax.
david-sarah@jacaranda.org**20101212202003
 Ignore-this: 3fbe12feb28bec6f1c63aedbc79aad21
] 
[docs/architecture.rst: formatting.
david-sarah@jacaranda.org**20101212201719
 Ignore-this: 305fa5dfc2939355eaf6d0d2161eb1ff
] 
[docs: linkification, wording improvements.
david-sarah@jacaranda.org**20101212201234
 Ignore-this: 4e67287f527a8bc728cfbd93255d2aae
] 
[docs: formatting.
david-sarah@jacaranda.org**20101212201115
 Ignore-this: 2e0ed394ac7726651d3a4f2c4b0d3798
] 
[docs/configuration.rst: more formatting tweaks; which -> that.
david-sarah@jacaranda.org**20101212195522
 Ignore-this: a7becb7021854ca5a90edd892b36fdd7
] 
[docs/configuration.rst: more changes to formatting.
david-sarah@jacaranda.org**20101212194511
 Ignore-this: 491aac33e5f5268d224359f1447d10be
] 
[docs/configuration.rst: changes to formatting (mainly putting commands and filenames in monospace).
david-sarah@jacaranda.org**20101212181828
 Ignore-this: 8a1480e2d5f43bee678476424615b50f
] 
[scripts/backupdb.py: more accurate comment about path field.
david-sarah@jacaranda.org**20101212170320
 Ignore-this: 50e47a2228a85207bbcd188a78a0d4e6
] 
[scripts/cli.py: fix missing 'put' in usage example for 'tahoe put'.
david-sarah@jacaranda.org**20101212170207
 Ignore-this: 2cbadf066fff611fc03d3c0ff97ce6ec
] 
[docs/frontends/CLI.rst: changes to formatting (mainly putting commands and filenames in monospace), and to command syntax to reflect that DIRCAP/... is accepted. Clarify the syntax of 'tahoe put' and other minor corrections. Tahoe -> Tahoe-LAFS.
david-sarah@jacaranda.org**20101212165800
 Ignore-this: a123ef6b564aa8624d1e79c97068ea12
] 
[docs/frontends/CLI.rst: Unicode arguments to 'tahoe' work on Windows as of v1.7.1.
david-sarah@jacaranda.org**20101212063740
 Ignore-this: 3977a99dfa86ac33a44171deaf43aaab
] 
[docs/known_issues.rst: fix title and linkify another URL. refs #1225
david-sarah@jacaranda.org**20101212062817
 Ignore-this: cc91287f7fb51c23440b3d2fe79c449c
] 
[docs/known_issues.rst: fix an external link. refs #1225
david-sarah@jacaranda.org**20101212062435
 Ignore-this: b8cbf12f353131756c358965c48060ec
] 
[Fix a link from uri.rst to dirnodes.rst. refs #1225
david-sarah@jacaranda.org**20101212054502
 Ignore-this: af6205299f5c9a33229cab259c00f9d5
] 
[Fix a link from webapi.rst to FTP-and-SFTP.rst. refs #1225
david-sarah@jacaranda.org**20101212053435
 Ignore-this: 2b9f88678c3447ea860d6b61e8799858
] 
[More specific hyperlink to architecture.rst from helper.rst. refs #1225
david-sarah@jacaranda.org**20101212052607
 Ignore-this: 50424c768fca481252fabf58424852dc
] 
[Update hyperlinks between docs, and linkify some external references. refs #1225
david-sarah@jacaranda.org**20101212051459
 Ignore-this: cd43a4c3d3de1f832abfa88d5fc4ace1
] 
[docs/specifications/dirnodes.rst: fix references to mutable.rst. refs #1225
david-sarah@jacaranda.org**20101212012720
 Ignore-this: 6819b4b4e06e947ee48b365e840db37d
] 
[docs/specifications/mutable.rst: correct the magic string for v1 mutable containers. refs #1225
david-sarah@jacaranda.org**20101212011400
 Ignore-this: 99a5fcdd40cef83dbb08f323f6cdaaca
] 
[Move .txt files in docs/frontends and docs/specifications to .rst. refs #1225
david-sarah@jacaranda.org**20101212010251
 Ignore-this: 8796d35d928370f7dc6ad2dafdc1c0fe
] 
[Convert docs/frontends and docs/specifications to reStructuredText format (not including file moves).
david-sarah@jacaranda.org**20101212004632
 Ignore-this: e3ceb2d832d73875abe48624ddbb5622
] 
[scripts/cli.py: remove the disclaimer in the help for 'tahoe cp' that it does not handle non-ASCII filenames well. (At least, we intend to handle them.)
david-sarah@jacaranda.org**20101130002145
 Ignore-this: 94c003efaa20b9eb4a83503d79844ca
] 
[relnotes.txt: fifth -> sixth labor-of-love release
zooko@zooko.com**20101129045647
 Ignore-this: 21c245015268b38916e3a138d256c09d
] 
[Makefile: BB_BRANCH is set to the empty string for trunk, not the string 'trunk'.
david-sarah@jacaranda.org**20101128233512
 Ignore-this: 5a7ef8eb10475636d21b91e25b56c369
] 
[relnotes.txt: eleventh -> twelfth release.
david-sarah@jacaranda.org**20101128223321
 Ignore-this: 1e26410156a665271c1170803dea2c0d
] 
[relnotes.tst: point to known_issues.rst, not known_issues.txt.
david-sarah@jacaranda.org**20101128222918
 Ignore-this: 60194eb4544cac446fe4f60b3e34b887
] 
[quickstart.html: fix link to point to allmydata-tahoe-1.8.1.zip.
david-sarah@jacaranda.org**20101128221728
 Ignore-this: 7b3ee86f8256aa12f5d862f689f3ee29
] 
[TAG allmydata-tahoe-1.8.1
david-sarah@jacaranda.org**20101128212336
 Ignore-this: 9c18bdeaef4822f590d2a0d879e00621
] 
Patch bundle hash:
889c9913784be31b30f166fc1f4c9db07c41c697