contrib/lock-checker.py
author Chris Jerdonek <chris.jerdonek@gmail.com>
Mon, 02 Dec 2013 07:49:49 -0800
changeset 20166 7eda5bb9ec8f
parent 17738 b8424c92ba2b
child 20244 47d0843647d1
permissions -rw-r--r--
parsers: clarify documentation of test-parseindex2.py This change updates and improves the description of test-parseindex2.py. In particular, it removes language that can be interpreted to mean that the test module checks only the C implementation of parsers.parse_index2(). Rather, the module checks parsers.parse_index2(), which can be either the C or pure Python implementation, depending on which version is being used. As of e57c532c3835, the module also does more than just compare the return value with the original Python implementation.

"""Extension to verify locks are obtained in the required places.

This works by wrapping functions that should be surrounded by a lock
and asserting the lock is held. Missing locks are called out with a
traceback printed to stderr.

This currently only checks store locks, not working copy locks.
"""
import os
import traceback

def _warnstack(ui, msg, skip=1):
    '''issue warning with the message and the current stack, skipping the
    skip last entries'''
    ui.warn('%s at:\n' % msg)
    entries = traceback.extract_stack()[:-skip]
    fnmax = max(len(entry[0]) for entry in entries)
    for fn, ln, func, _text in entries:
        ui.warn(' %*s:%-4s in %s\n' % (fnmax, fn, ln, func))

def _checklock(repo):
    l = repo._lockref and repo._lockref()
    if l is None or not l.held:
        _warnstack(repo.ui, 'missing lock', skip=2)

def reposetup(ui, repo):
    orig = repo.__class__
    class lockcheckrepo(repo.__class__):
        def _writejournal(self, *args, **kwargs):
            _checklock(self)
            return orig._writejournal(self, *args, **kwargs)

        def transaction(self, *args, **kwargs):
            _checklock(self)
            return orig.transaction(self, *args, **kwargs)

        # TODO(durin42): kiilerix had a commented-out lock check in
        # _writebranchcache and _writerequirements

        def _tag(self, *args, **kwargs):
            _checklock(self)
            return orig._tag(self, *args, **kwargs)

        def write(self, *args, **kwargs):
            assert os.path.lexists(self._join('.hg/wlock'))
            return orig.write(self, *args, **kwargs)

    repo.__class__ = lockcheckrepo