tests/test-annotate.py
author Matt Harbison <matt_harbison@yahoo.com>
Thu, 26 Sep 2024 18:15:36 -0400
changeset 51923 b455dfddfed0
parent 48875 6000f5b25c9b
permissions -rw-r--r--
interfaces: convert the zope `Attribute` attrs to regular fields At this point, we should have a useful protocol class. The file syntax requires the type to be supplied for any fields that are declared, but we'll leave the complex ones partially unspecified for now, for simplicity. (Also, the things documented as `Callable` are really as future type annotating worked showed- roll with it for now, but they're marked as TODO for fixing later.) All of the fields and all of the attrs will need type annotations, or the type rules say they are considered to be `Any`. That can be done in a separate pass, possibly applying the `dirstate.pyi` file generated from the concrete class. The first cut of this turned the `interfaceutil.Attribute` fields into plain fields, and thus the types on them. PyCharm flagged a few things as having incompatible signatures when the concrete dirstate class subclassed this, when the concrete class has them declared as `@property`. So they've been changed to `@property` here in those cases. The remaining fields that are decorated in the concrete class have comments noting the differences. We'll see if they need to be changed going forward, but leave them for now. We'll be in trouble if the `@util.propertycache` is needed, because we can't import that module here at runtime, due to circular imports.

import unittest

from mercurial import (
    mdiff,
    pycompat,
)
from mercurial.dagop import (
    annotateline,
    _annotatedfile,
    _annotatepair,
)


def tr(a):
    return [
        annotateline(fctx, lineno, skip)
        for fctx, lineno, skip in zip(a.fctxs, a.linenos, a.skips)
    ]


class AnnotateTests(unittest.TestCase):
    """Unit tests for annotate code."""

    def testannotatepair(self):
        self.maxDiff = None  # camelcase-required

        oldfctx = b'old'
        p1fctx, p2fctx, childfctx = b'p1', b'p2', b'c'
        olddata = b'a\nb\n'
        p1data = b'a\nb\nc\n'
        p2data = b'a\nc\nd\n'
        childdata = b'a\nb2\nc\nc2\nd\n'
        diffopts = mdiff.diffopts()

        def decorate(text, fctx):
            n = text.count(b'\n')
            linenos = pycompat.rangelist(1, n + 1)
            return _annotatedfile([fctx] * n, linenos, [False] * n, text)

        # Basic usage

        oldann = decorate(olddata, oldfctx)
        p1ann = decorate(p1data, p1fctx)
        p1ann = _annotatepair([oldann], p1fctx, p1ann, False, diffopts)
        self.assertEqual(
            tr(p1ann),
            [
                annotateline(b'old', 1),
                annotateline(b'old', 2),
                annotateline(b'p1', 3),
            ],
        )

        p2ann = decorate(p2data, p2fctx)
        p2ann = _annotatepair([oldann], p2fctx, p2ann, False, diffopts)
        self.assertEqual(
            tr(p2ann),
            [
                annotateline(b'old', 1),
                annotateline(b'p2', 2),
                annotateline(b'p2', 3),
            ],
        )

        # Test with multiple parents (note the difference caused by ordering)

        childann = decorate(childdata, childfctx)
        childann = _annotatepair(
            [p1ann, p2ann], childfctx, childann, False, diffopts
        )
        self.assertEqual(
            tr(childann),
            [
                annotateline(b'old', 1),
                annotateline(b'c', 2),
                annotateline(b'p2', 2),
                annotateline(b'c', 4),
                annotateline(b'p2', 3),
            ],
        )

        childann = decorate(childdata, childfctx)
        childann = _annotatepair(
            [p2ann, p1ann], childfctx, childann, False, diffopts
        )
        self.assertEqual(
            tr(childann),
            [
                annotateline(b'old', 1),
                annotateline(b'c', 2),
                annotateline(b'p1', 3),
                annotateline(b'c', 4),
                annotateline(b'p2', 3),
            ],
        )

        # Test with skipchild (note the difference caused by ordering)

        childann = decorate(childdata, childfctx)
        childann = _annotatepair(
            [p1ann, p2ann], childfctx, childann, True, diffopts
        )
        self.assertEqual(
            tr(childann),
            [
                annotateline(b'old', 1),
                annotateline(b'old', 2, True),
                # note that this line was carried over from earlier so it is *not*
                # marked skipped
                annotateline(b'p2', 2),
                annotateline(b'p2', 2, True),
                annotateline(b'p2', 3),
            ],
        )

        childann = decorate(childdata, childfctx)
        childann = _annotatepair(
            [p2ann, p1ann], childfctx, childann, True, diffopts
        )
        self.assertEqual(
            tr(childann),
            [
                annotateline(b'old', 1),
                annotateline(b'old', 2, True),
                annotateline(b'p1', 3),
                annotateline(b'p1', 3, True),
                annotateline(b'p2', 3),
            ],
        )


if __name__ == '__main__':
    import silenttestrunner

    silenttestrunner.main(__name__)