tests/test-propertycache.py

rhg: Add support for `rhg status --copies`

Copy sources are collected during `status()` rather than after the fact like
in Python, because `status()` takes a `&mut` exclusive reference to the dirstate map
(in order to potentially mutate it for directory mtimes) and returns `Cow<'_, HgPath>`
that borrow the dirstate map.

Even though with `Cow` only some shared borrows remain, the still extend the same
lifetime of the initial `&mut` so the dirstate map cannot be borrowed again
to access copy sources after the fact:

https://doc.rust-lang.org/nomicon/lifetime-mismatch.html#limits-of-lifetimes

Additionally, collecting copy sources during the dirstate tree traversal that
`status()` already does avoids the cost of another traversal or other lookups
(though I haven’t benchmarked that cost).

Differential Revision: https://phab.mercurial-scm.org/D11899

"""test behavior of propertycache and unfiltered propertycache

The repoview overlay is quite complex. We test the behavior of
property cache of both localrepo and repoview to prevent
regression."""

from __future__ import absolute_import, print_function
import os
import subprocess

from mercurial import (
    hg,
    localrepo,
    pycompat,
    ui as uimod,
    util,
)

from mercurial.utils import procutil

# create some special property cache that trace they call

calllog = []


@util.propertycache
def testcachedfoobar(repo):
    name = repo.filtername
    if name is None:
        name = ''
    val = len(name)
    calllog.append(val)
    return val


unficalllog = []


@localrepo.unfilteredpropertycache
def testcachedunfifoobar(repo):
    name = repo.filtername
    if name is None:
        name = ''
    val = 100 + len(name)
    unficalllog.append(val)
    return val


# plug them on repo
localrepo.localrepository.testcachedfoobar = testcachedfoobar
localrepo.localrepository.testcachedunfifoobar = testcachedunfifoobar


# Create an empty repo and instantiate it. It is important to run
# these tests on the real object to detect regression.
repopath = pycompat.fsencode(os.path.join(os.environ['TESTTMP'], 'repo'))
assert (
    subprocess.call(
        pycompat.rapply(procutil.tonativestr, [b'hg', b'init', repopath])
    )
    == 0
)

ui = uimod.ui.load()
repo = hg.repository(ui, path=repopath).unfiltered()


print('')
print('=== property cache ===')
print('')
print('calllog:', calllog)
print(
    'cached value (unfiltered):', vars(repo).get('testcachedfoobar', 'NOCACHE')
)

print('')
print('= first access on unfiltered, should do a call')
print('access:', repo.testcachedfoobar)
print('calllog:', calllog)
print(
    'cached value (unfiltered):', vars(repo).get('testcachedfoobar', 'NOCACHE')
)

print('')
print('= second access on unfiltered, should not do call')
print('access', repo.testcachedfoobar)
print('calllog:', calllog)
print(
    'cached value (unfiltered):', vars(repo).get('testcachedfoobar', 'NOCACHE')
)

print('')
print('= first access on "visible" view, should do a call')
visibleview = repo.filtered('visible')
print(
    'cached value ("visible" view):',
    vars(visibleview).get('testcachedfoobar', 'NOCACHE'),
)
print('access:', visibleview.testcachedfoobar)
print('calllog:', calllog)
print(
    'cached value (unfiltered):', vars(repo).get('testcachedfoobar', 'NOCACHE')
)
print(
    'cached value ("visible" view):',
    vars(visibleview).get('testcachedfoobar', 'NOCACHE'),
)

print('')
print('= second access on "visible view", should not do call')
print('access:', visibleview.testcachedfoobar)
print('calllog:', calllog)
print(
    'cached value (unfiltered):', vars(repo).get('testcachedfoobar', 'NOCACHE')
)
print(
    'cached value ("visible" view):',
    vars(visibleview).get('testcachedfoobar', 'NOCACHE'),
)

print('')
print('= no effect on other view')
immutableview = repo.filtered('immutable')
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedfoobar', 'NOCACHE'),
)
print('access:', immutableview.testcachedfoobar)
print('calllog:', calllog)
print(
    'cached value (unfiltered):', vars(repo).get('testcachedfoobar', 'NOCACHE')
)
print(
    'cached value ("visible" view):',
    vars(visibleview).get('testcachedfoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedfoobar', 'NOCACHE'),
)

# unfiltered property cache test
print('')
print('')
print('=== unfiltered property cache ===')
print('')
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("visible" view):  ',
    vars(visibleview).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedunfifoobar', 'NOCACHE'),
)

print('')
print('= first access on unfiltered, should do a call')
print('access (unfiltered):', repo.testcachedunfifoobar)
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)

print('')
print('= second access on unfiltered, should not do call')
print('access (unfiltered):', repo.testcachedunfifoobar)
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)

print('')
print('= access on view should use the unfiltered cache')
print('access (unfiltered):      ', repo.testcachedunfifoobar)
print('access ("visible" view):  ', visibleview.testcachedunfifoobar)
print('access ("immutable" view):', immutableview.testcachedunfifoobar)
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("visible" view):  ',
    vars(visibleview).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedunfifoobar', 'NOCACHE'),
)

print('')
print('= even if we clear the unfiltered cache')
del repo.__dict__['testcachedunfifoobar']
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("visible" view):  ',
    vars(visibleview).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedunfifoobar', 'NOCACHE'),
)
print('unficalllog:', unficalllog)
print('access ("visible" view):  ', visibleview.testcachedunfifoobar)
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("visible" view):  ',
    vars(visibleview).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedunfifoobar', 'NOCACHE'),
)
print('access ("immutable" view):', immutableview.testcachedunfifoobar)
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("visible" view):  ',
    vars(visibleview).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedunfifoobar', 'NOCACHE'),
)
print('access (unfiltered):      ', repo.testcachedunfifoobar)
print('unficalllog:', unficalllog)
print(
    'cached value (unfiltered):      ',
    vars(repo).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("visible" view):  ',
    vars(visibleview).get('testcachedunfifoobar', 'NOCACHE'),
)
print(
    'cached value ("immutable" view):',
    vars(immutableview).get('testcachedunfifoobar', 'NOCACHE'),
)