Mercurial > hg
view tests/test-trusted.py @ 35569:964212780daf
rust: implementation of `hg`
This commit provides a mostly-working implementation of the
`hg` script in Rust along with scaffolding to support Rust in
the repository.
If you are familiar with Rust, the contents of the added rust/
directory should be pretty straightforward. We create an "hgcli"
package that implements a binary application to run Mercurial.
The output of this package is an "hg" binary.
Our Rust `hg` (henceforth "rhg") essentially is a port of the existing
`hg` Python script. The main difference is the creation of the embedded
CPython interpreter is handled by the binary itself instead of relying
on the shebang. In that sense, rhg is more similar to the "exe wrapper"
we currently use on Windows. However, unlike the exe wrapper, rhg does
not call the `hg` Python script. Instead, it uses the CPython APIs to
import mercurial modules and call appropriate functions. The amount of
code here is surprisingly small.
It is my intent to replace the existing C-based exe wrapper with rhg.
Preferably in the next Mercurial release. This should be achievable -
at least for some Mercurial distributions. The future/timeline for
rhg on other platforms is less clear. We already ship a hg.exe on
Windows. So if we get the quirks with Rust worked out, shipping a
Rust-based hg.exe should hopefully not be too contentious.
Now onto the implementation.
We're using python27-sys and the cpython crates for talking to the
CPython API. We currently don't use too much functionality of the
cpython crate and could have probably cut it out. However, it does
provide a reasonable abstraction over unsafe {} CPython function
calls. While we still have our fair share of those, at least we're
not dealing with too much refcounting, error checking, etc. So I
think the use of the cpython crate is justified. Plus, there is
not-yet-implemented functionality that could benefit from cpython. I
see our use of this crate only increasing.
The cpython and python27-sys crates are not without their issues.
The cpython crate didn't seem to account for the embedding use case
in its design. Instead, it seems to assume that you are building
a Python extension. It is making some questionable decisions around
certain CPython APIs. For example, it insists that
PyEval_ThreadsInitialized() is called and that the Python code
likely isn't the main thread in the underlying application. It
is also missing some functionality that is important for embedded
use cases (such as exporting the path to the Python interpreter
from its build script). After spending several hours trying to
wrangle python27-sys and cpython, I gave up and forked the project
on GitHub. Our Cargo.toml tracks this fork. I'm optimistic that
the upstream project will accept our contributions and we can
eventually unfork.
There is a non-trivial amount of code in our custom Cargo build
script. Our build.rs (which is called as part of building the hgcli
crate):
* Validates that the Python interpreter that was detected by the
python27-sys crate provides a shared library (we only support
shared library linking at this time - although this restriction
could be loosened).
* Validates that the Python is built with UCS-4 support. This ensures
maximum Unicode compatibility.
* Exports variables to the crate build allowing the built crate to e.g.
find the path to the Python interpreter.
The produced rhg should be considered alpha quality. There are several
known deficiencies. Many of these are documented with inline TODOs.
Probably the biggest limitation of rhg is that it assumes it is
running from the ./rust/target/<target> directory of a source
distribution. So, rhg is currently not very practical for real-world
use. But, if you can `cargo build` it, running the binary *should*
yield a working Mercurial CLI.
In order to support using rhg with the test harness, we needed to hack
up run-tests.py so the path to Mercurial's Python files is set properly.
The change is extremely hacky and is only intended to be a stop-gap
until the test harness gains first-class support for installing rhg.
This will likely occur after we support running rhg outside the
source directory.
Despite its officially alpha quality, rhg copes extremely well with
the test harness (at least on Linux). Using
`run-tests.py --with-hg ../rust/target/debug/hg`, I only encounter
the following failures:
* test-run-tests.t -- Warnings emitted about using an unexpected
Mercurial library. This is due to the hacky nature of setting the
Python directory when run-tests.py detected rhg.
* test-devel-warnings.t -- Expected stack trace missing frame for `hg`
(This is expected since we no longer have an `hg` script!)
* test-convert.t -- Test running `$PYTHON "$BINDIR"/hg`, which obviously
assumes `hg` is a Python script.
* test-merge-tools.t -- Same assumption about `hg` being executable with
Python.
* test-http-bad-server.t -- Seeing exit code 255 instead of 1 around
line 358.
* test-blackbox.t -- Exit code 255 instead of 1.
* test-basic.t -- Exit code 255 instead of 1.
It certainly looks like we have a bug around exit code handling. I
don't think it is severe enough to hold up review and landing of this
initial implementation. Perfect is the enemy of good.
Differential Revision: https://phab.mercurial-scm.org/D1581
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Wed, 10 Jan 2018 08:53:22 -0800 |
parents | 85a2db47ad50 |
children | 73ccba60aaa1 |
line wrap: on
line source
# Since it's not easy to write a test that portably deals # with files from different users/groups, we cheat a bit by # monkey-patching some functions in the util module from __future__ import absolute_import, print_function import os from mercurial import ( error, ui as uimod, util, ) hgrc = os.environ['HGRCPATH'] f = open(hgrc) basehgrc = f.read() f.close() def testui(user='foo', group='bar', tusers=(), tgroups=(), cuser='foo', cgroup='bar', debug=False, silent=False, report=True): # user, group => owners of the file # tusers, tgroups => trusted users/groups # cuser, cgroup => user/group of the current process # write a global hgrc with the list of trusted users/groups and # some setting so that we can be sure it was read f = open(hgrc, 'w') f.write(basehgrc) f.write('\n[paths]\n') f.write('global = /some/path\n\n') if tusers or tgroups: f.write('[trusted]\n') if tusers: f.write('users = %s\n' % ', '.join(tusers)) if tgroups: f.write('groups = %s\n' % ', '.join(tgroups)) f.close() # override the functions that give names to uids and gids def username(uid=None): if uid is None: return cuser return user util.username = username def groupname(gid=None): if gid is None: return 'bar' return group util.groupname = groupname def isowner(st): return user == cuser util.isowner = isowner # try to read everything #print '# File belongs to user %s, group %s' % (user, group) #print '# trusted users = %s; trusted groups = %s' % (tusers, tgroups) kind = ('different', 'same') who = ('', 'user', 'group', 'user and the group') trusted = who[(user in tusers) + 2*(group in tgroups)] if trusted: trusted = ', but we trust the ' + trusted print('# %s user, %s group%s' % (kind[user == cuser], kind[group == cgroup], trusted)) u = uimod.ui.load() # disable the configuration registration warning # # the purpose of this test is to check the old behavior, not to validate the # behavior from registered item. so we silent warning related to unregisted # config. u.setconfig('devel', 'warn-config-unknown', False, 'test') u.setconfig('devel', 'all-warnings', False, 'test') u.setconfig('ui', 'debug', str(bool(debug))) u.setconfig('ui', 'report_untrusted', str(bool(report))) u.readconfig('.hg/hgrc') if silent: return u print('trusted') for name, path in u.configitems('paths'): print(' ', name, '=', util.pconvert(path)) print('untrusted') for name, path in u.configitems('paths', untrusted=True): print('.', end=' ') u.config('paths', name) # warning with debug=True print('.', end=' ') u.config('paths', name, untrusted=True) # no warnings print(name, '=', util.pconvert(path)) print() return u os.mkdir('repo') os.chdir('repo') os.mkdir('.hg') f = open('.hg/hgrc', 'w') f.write('[paths]\n') f.write('local = /another/path\n\n') f.close() #print '# Everything is run by user foo, group bar\n' # same user, same group testui() # same user, different group testui(group='def') # different user, same group testui(user='abc') # ... but we trust the group testui(user='abc', tgroups=['bar']) # different user, different group testui(user='abc', group='def') # ... but we trust the user testui(user='abc', group='def', tusers=['abc']) # ... but we trust the group testui(user='abc', group='def', tgroups=['def']) # ... but we trust the user and the group testui(user='abc', group='def', tusers=['abc'], tgroups=['def']) # ... but we trust all users print('# we trust all users') testui(user='abc', group='def', tusers=['*']) # ... but we trust all groups print('# we trust all groups') testui(user='abc', group='def', tgroups=['*']) # ... but we trust the whole universe print('# we trust all users and groups') testui(user='abc', group='def', tusers=['*'], tgroups=['*']) # ... check that users and groups are in different namespaces print("# we don't get confused by users and groups with the same name") testui(user='abc', group='def', tusers=['def'], tgroups=['abc']) # ... lists of user names work print("# list of user names") testui(user='abc', group='def', tusers=['foo', 'xyz', 'abc', 'bleh'], tgroups=['bar', 'baz', 'qux']) # ... lists of group names work print("# list of group names") testui(user='abc', group='def', tusers=['foo', 'xyz', 'bleh'], tgroups=['bar', 'def', 'baz', 'qux']) print("# Can't figure out the name of the user running this process") testui(user='abc', group='def', cuser=None) print("# prints debug warnings") u = testui(user='abc', group='def', cuser='foo', debug=True) print("# report_untrusted enabled without debug hides warnings") u = testui(user='abc', group='def', cuser='foo', report=False) print("# report_untrusted enabled with debug shows warnings") u = testui(user='abc', group='def', cuser='foo', debug=True, report=False) print("# ui.readconfig sections") filename = 'foobar' f = open(filename, 'w') f.write('[foobar]\n') f.write('baz = quux\n') f.close() u.readconfig(filename, sections=['foobar']) print(u.config('foobar', 'baz')) print() print("# read trusted, untrusted, new ui, trusted") u = uimod.ui.load() # disable the configuration registration warning # # the purpose of this test is to check the old behavior, not to validate the # behavior from registered item. so we silent warning related to unregisted # config. u.setconfig('devel', 'warn-config-unknown', False, 'test') u.setconfig('devel', 'all-warnings', False, 'test') u.setconfig('ui', 'debug', 'on') u.readconfig(filename) u2 = u.copy() def username(uid=None): return 'foo' util.username = username u2.readconfig('.hg/hgrc') print('trusted:') print(u2.config('foobar', 'baz')) print('untrusted:') print(u2.config('foobar', 'baz', untrusted=True)) print() print("# error handling") def assertraises(f, exc=error.Abort): try: f() except exc as inst: print('raised', inst.__class__.__name__) else: print('no exception?!') print("# file doesn't exist") os.unlink('.hg/hgrc') assert not os.path.exists('.hg/hgrc') testui(debug=True, silent=True) testui(user='abc', group='def', debug=True, silent=True) print() print("# parse error") f = open('.hg/hgrc', 'w') f.write('foo') f.close() try: testui(user='abc', group='def', silent=True) except error.ParseError as inst: print(inst) try: testui(debug=True, silent=True) except error.ParseError as inst: print(inst) print() print('# access typed information') with open('.hg/hgrc', 'w') as f: f.write('''\ [foo] sub=main sub:one=one sub:two=two path=monty/python bool=true int=42 bytes=81mb list=spam,ham,eggs ''') u = testui(user='abc', group='def', cuser='foo', silent=True) def configpath(section, name, default=None, untrusted=False): path = u.configpath(section, name, default, untrusted) if path is None: return None return util.pconvert(path) print('# suboptions, trusted and untrusted') trusted = u.configsuboptions('foo', 'sub') untrusted = u.configsuboptions('foo', 'sub', untrusted=True) print( (trusted[0], sorted(trusted[1].items())), (untrusted[0], sorted(untrusted[1].items()))) print('# path, trusted and untrusted') print(configpath('foo', 'path'), configpath('foo', 'path', untrusted=True)) print('# bool, trusted and untrusted') print(u.configbool('foo', 'bool'), u.configbool('foo', 'bool', untrusted=True)) print('# int, trusted and untrusted') print( u.configint('foo', 'int', 0), u.configint('foo', 'int', 0, untrusted=True)) print('# bytes, trusted and untrusted') print( u.configbytes('foo', 'bytes', 0), u.configbytes('foo', 'bytes', 0, untrusted=True)) print('# list, trusted and untrusted') print( u.configlist('foo', 'list', []), u.configlist('foo', 'list', [], untrusted=True))