tests/test-hgweb-auth.py

worker: avoid potential partial write of pickled data

Previously, the code wrote the pickled data using os.write(). However,
os.write() can write less bytes than passed to it. To trigger the problem, the
pickled data had to be larger than 2147479552 bytes on my system.

Instead, open a file object and pass it to pickle.dump(). This also has the
advantage that it doesn’t buffer the whole pickled data in memory.

Note that the opened file must be buffered because pickle doesn’t support
unbuffered streams because unbuffered streams’ write() method might write less
bytes than passed to it (like os.write()) but pickle.dump() relies on that all
bytes are written (see https://github.com/python/cpython/issues/93050).

The side effect of using a file object and a with statement is that wfd is
explicitly closed now while it seems like before it was implicitly closed by
process exit.

from mercurial import demandimport

demandimport.enable()
from mercurial import (
    error,
    pycompat,
    ui as uimod,
    url,
    util,
)
from mercurial.utils import (
    stringutil,
    urlutil,
)

urlerr = util.urlerr
urlreq = util.urlreq


class myui(uimod.ui):
    def interactive(self):
        return False


origui = myui.load()


def writeauth(items):
    ui = origui.copy()
    for name, value in items.items():
        ui.setconfig(b'auth', name, value)
    return ui


def _stringifyauthinfo(ai):
    if ai is None:
        return ai
    realm, authuris, user, passwd = ai
    return (
        pycompat.strurl(realm),
        [pycompat.strurl(u) for u in authuris],
        pycompat.strurl(user),
        pycompat.strurl(passwd),
    )


def test(auth, urls=None):
    print('CFG:', pycompat.sysstr(stringutil.pprint(auth, bprefix=True)))
    prefixes = set()
    for k in auth:
        prefixes.add(k.split(b'.', 1)[0])
    for p in prefixes:
        for name in (b'.username', b'.password'):
            if (p + name) not in auth:
                auth[p + name] = p
    auth = {k: v for k, v in auth.items() if v is not None}

    ui = writeauth(auth)

    def _test(uri):
        print('URI:', pycompat.strurl(uri))
        try:
            pm = url.passwordmgr(ui, urlreq.httppasswordmgrwithdefaultrealm())
            u, authinfo = urlutil.url(uri).authinfo()
            if authinfo is not None:
                pm.add_password(*_stringifyauthinfo(authinfo))
            print(
                '    ',
                tuple(
                    pycompat.strurl(a)
                    for a in pm.find_user_password('test', pycompat.strurl(u))
                ),
            )
        except error.Abort:
            print('    ', 'abort')

    if not urls:
        urls = [
            b'http://example.org/foo',
            b'http://example.org/foo/bar',
            b'http://example.org/bar',
            b'https://example.org/foo',
            b'https://example.org/foo/bar',
            b'https://example.org/bar',
            b'https://[e-mail]/bar',
            b'https://[e-mail]/bar',
        ]
    for u in urls:
        _test(u)


print('\n*** Test in-uri schemes\n')
test({b'x.prefix': b'http://example.org'})
test({b'x.prefix': b'https://example.org'})
test({b'x.prefix': b'http://example.org', b'x.schemes': b'https'})
test({b'x.prefix': b'https://example.org', b'x.schemes': b'http'})

print('\n*** Test separately configured schemes\n')
test({b'x.prefix': b'example.org', b'x.schemes': b'http'})
test({b'x.prefix': b'example.org', b'x.schemes': b'https'})
test({b'x.prefix': b'example.org', b'x.schemes': b'http https'})

print('\n*** Test prefix matching\n')
test(
    {
        b'x.prefix': b'http://example.org/foo',
        b'y.prefix': b'http://example.org/bar',
    }
)
test(
    {
        b'x.prefix': b'http://example.org/foo',
        b'y.prefix': b'http://example.org/foo/bar',
    }
)
test({b'x.prefix': b'*', b'y.prefix': b'https://example.org/bar'})

print('\n*** Test user matching\n')
test(
    {
        b'x.prefix': b'http://example.org/foo',
        b'x.username': None,
        b'x.password': b'xpassword',
    },
    urls=[b'http://[e-mail]/foo'],
)
test(
    {
        b'x.prefix': b'http://example.org/foo',
        b'x.username': None,
        b'x.password': b'xpassword',
        b'y.prefix': b'http://example.org/foo',
        b'y.username': b'y',
        b'y.password': b'ypassword',
    },
    urls=[b'http://[e-mail]/foo'],
)
test(
    {
        b'x.prefix': b'http://example.org/foo/bar',
        b'x.username': None,
        b'x.password': b'xpassword',
        b'y.prefix': b'http://example.org/foo',
        b'y.username': b'y',
        b'y.password': b'ypassword',
    },
    urls=[b'http://[e-mail]/foo/bar'],
)

print('\n*** Test user matching with name in prefix\n')

# prefix, username and URL have the same user
test(
    {
        b'x.prefix': b'https://example.org/foo',
        b'x.username': None,
        b'x.password': b'xpassword',
        b'y.prefix': b'http://[e-mail]/foo',
        b'y.username': b'y',
        b'y.password': b'ypassword',
    },
    urls=[b'http://[e-mail]/foo'],
)
# Prefix has a different user from username and URL
test(
    {
        b'y.prefix': b'http://[e-mail]/foo',
        b'y.username': b'y',
        b'y.password': b'ypassword',
    },
    urls=[b'http://[e-mail]/foo'],
)
# Prefix has a different user from URL; no username
test(
    {b'y.prefix': b'http://[e-mail]/foo', b'y.password': b'ypassword'},
    urls=[b'http://[e-mail]/foo'],
)
# Prefix and URL have same user, but doesn't match username
test(
    {
        b'y.prefix': b'http://[e-mail]/foo',
        b'y.username': b'z',
        b'y.password': b'ypassword',
    },
    urls=[b'http://[e-mail]/foo'],
)
# Prefix and URL have the same user; no username
test(
    {b'y.prefix': b'http://[e-mail]/foo', b'y.password': b'ypassword'},
    urls=[b'http://[e-mail]/foo'],
)
# Prefix user, but no URL user or username
test(
    {b'y.prefix': b'http://[e-mail]/foo', b'y.password': b'ypassword'},
    urls=[b'http://example.org/foo'],
)


def testauthinfo(fullurl, authurl):
    print('URIs:', fullurl, authurl)
    pm = urlreq.httppasswordmgrwithdefaultrealm()
    ai = _stringifyauthinfo(
        urlutil.url(pycompat.bytesurl(fullurl)).authinfo()[1]
    )
    pm.add_password(*ai)
    print(pm.find_user_password('test', authurl))


print('\n*** Test urllib2 and urlutil.url\n')
testauthinfo('http://[e-mail]:8080/foo', 'http://example.com:8080/foo')