# storage.py - Testing of storage primitives.

#

# Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

from __future__ import absolute_import

import unittest

from ..node import (

    hex,

    nullrev,

)

from ..pycompat import getattr

from .. import (

    error,

    mdiff,

)

from ..interfaces import repository

from ..utils import storageutil

class basetestcase(unittest.TestCase):

    if not getattr(unittest.TestCase, 'assertRaisesRegex', False):

        assertRaisesRegex = (  # camelcase-required

            unittest.TestCase.assertRaisesRegexp

        )

class ifileindextests(basetestcase):

    """Generic tests for the ifileindex interface.

    All file storage backends for index data should conform to the tests in this

    class.

    Use ``makeifileindextests()`` to create an instance of this type.

    """

    def testempty(self):

        f = self._makefilefn()

        self.assertEqual(len(f), 0, b'new file store has 0 length by default')

        self.assertEqual(list(f), [], b'iter yields nothing by default')

        gen = iter(f)

        with self.assertRaises(StopIteration):

            next(gen)

        self.assertFalse(f.hasnode(None))

        self.assertFalse(f.hasnode(0))

        self.assertFalse(f.hasnode(nullrev))

        self.assertFalse(f.hasnode(f.nullid))

        self.assertFalse(f.hasnode(b'0'))

        self.assertFalse(f.hasnode(b'a' * 20))

        # revs() should evaluate to an empty list.

        self.assertEqual(list(f.revs()), [])

        revs = iter(f.revs())

        with self.assertRaises(StopIteration):

            next(revs)

        self.assertEqual(list(f.revs(start=20)), [])

        # parents() and parentrevs() work with f.nullid/nullrev.

        self.assertEqual(f.parents(f.nullid), (f.nullid, f.nullid))

        self.assertEqual(f.parentrevs(nullrev), (nullrev, nullrev))

        with self.assertRaises(error.LookupError):

            f.parents(b'\x01' * 20)

        for i in range(-5, 5):

            if i == nullrev:

                continue

            with self.assertRaises(IndexError):

                f.parentrevs(i)

        # f.nullid/nullrev lookup always works.

        self.assertEqual(f.rev(f.nullid), nullrev)

        self.assertEqual(f.node(nullrev), f.nullid)

        with self.assertRaises(error.LookupError):

            f.rev(b'\x01' * 20)

        for i in range(-5, 5):

            if i == nullrev:

                continue

            with self.assertRaises(IndexError):

                f.node(i)

        self.assertEqual(f.lookup(f.nullid), f.nullid)

        self.assertEqual(f.lookup(nullrev), f.nullid)

        self.assertEqual(f.lookup(hex(f.nullid)), f.nullid)

        self.assertEqual(f.lookup(b'%d' % nullrev), f.nullid)

        with self.assertRaises(error.LookupError):

            f.lookup(b'badvalue')

        with self.assertRaises(error.LookupError):

            f.lookup(hex(f.nullid)[0:12])

        with self.assertRaises(error.LookupError):

            f.lookup(b'-2')

        with self.assertRaises(error.LookupError):

            f.lookup(b'0')

        with self.assertRaises(error.LookupError):

            f.lookup(b'1')

        with self.assertRaises(error.LookupError):

            f.lookup(b'11111111111111111111111111111111111111')

        for i in range(-5, 5):

            if i == nullrev:

                continue

            with self.assertRaises(LookupError):

                f.lookup(i)

        self.assertEqual(f.linkrev(nullrev), nullrev)

        for i in range(-5, 5):

            if i == nullrev:

                continue

            with self.assertRaises(IndexError):

                f.linkrev(i)

        self.assertFalse(f.iscensored(nullrev))

        for i in range(-5, 5):

            if i == nullrev:

                continue

            with self.assertRaises(IndexError):

                f.iscensored(i)

        self.assertEqual(list(f.commonancestorsheads(f.nullid, f.nullid)), [])

        with self.assertRaises(ValueError):

            self.assertEqual(list(f.descendants([])), [])

        self.assertEqual(list(f.descendants([nullrev])), [])

        self.assertEqual(f.heads(), [f.nullid])

        self.assertEqual(f.heads(f.nullid), [f.nullid])

        self.assertEqual(f.heads(None, [f.nullid]), [f.nullid])

        self.assertEqual(f.heads(f.nullid, [f.nullid]), [f.nullid])

        self.assertEqual(f.children(f.nullid), [])

        with self.assertRaises(error.LookupError):

            f.children(b'\x01' * 20)

    def testsinglerevision(self):

        f = self._makefilefn()

        with self._maketransactionfn() as tr:

            node = f.add(b'initial', None, tr, 0, f.nullid, f.nullid)

        self.assertEqual(len(f), 1)

        self.assertEqual(list(f), [0])

        gen = iter(f)

        self.assertEqual(next(gen), 0)

        with self.assertRaises(StopIteration):

            next(gen)

        self.assertTrue(f.hasnode(node))

        self.assertFalse(f.hasnode(hex(node)))

        self.assertFalse(f.hasnode(nullrev))

        self.assertFalse(f.hasnode(f.nullid))

        self.assertFalse(f.hasnode(node[0:12]))

        self.assertFalse(f.hasnode(hex(node)[0:20]))

        self.assertEqual(list(f.revs()), [0])

        self.assertEqual(list(f.revs(start=1)), [])

        self.assertEqual(list(f.revs(start=0)), [0])

        self.assertEqual(list(f.revs(stop=0)), [0])

        self.assertEqual(list(f.revs(stop=1)), [0])

        self.assertEqual(list(f.revs(1, 1)), [])

        # TODO buggy

        self.assertEqual(list(f.revs(1, 0)), [1, 0])

        self.assertEqual(list(f.revs(2, 0)), [2, 1, 0])

        self.assertEqual(f.parents(node), (f.nullid, f.nullid))

        self.assertEqual(f.parentrevs(0), (nullrev, nullrev))

        with self.assertRaises(error.LookupError):

            f.parents(b'\x01' * 20)

        with self.assertRaises(IndexError):

            f.parentrevs(1)

        self.assertEqual(f.rev(node), 0)

        with self.assertRaises(error.LookupError):

            f.rev(b'\x01' * 20)

        self.assertEqual(f.node(0), node)

        with self.assertRaises(IndexError):

            f.node(1)

        self.assertEqual(f.lookup(node), node)

        self.assertEqual(f.lookup(0), node)

        self.assertEqual(f.lookup(-1), f.nullid)

        self.assertEqual(f.lookup(b'0'), node)

        self.assertEqual(f.lookup(hex(node)), node)

        with self.assertRaises(error.LookupError):

            f.lookup(hex(node)[0:12])

        with self.assertRaises(error.LookupError):

            f.lookup(-2)

        with self.assertRaises(error.LookupError):

            f.lookup(b'-2')

        with self.assertRaises(error.LookupError):

            f.lookup(1)

        with self.assertRaises(error.LookupError):

            f.lookup(b'1')

        self.assertEqual(f.linkrev(0), 0)

        with self.assertRaises(IndexError):

            f.linkrev(1)

        self.assertFalse(f.iscensored(0))

        with self.assertRaises(IndexError):

            f.iscensored(1)

        self.assertEqual(list(f.descendants([0])), [])

        self.assertEqual(f.heads(), [node])

        self.assertEqual(f.heads(node), [node])

        self.assertEqual(f.heads(stop=[node]), [node])

        with self.assertRaises(error.LookupError):

            f.heads(stop=[b'\x01' * 20])

        self.assertEqual(f.children(node), [])

    def testmultiplerevisions(self):

        fulltext0 = b'x' * 1024

        fulltext1 = fulltext0 + b'y'

        fulltext2 = b'y' + fulltext0 + b'z'

        f = self._makefilefn()

        with self._maketransactionfn() as tr:

            node0 = f.add(fulltext0, None, tr, 0, f.nullid, f.nullid)

            node1 = f.add(fulltext1, None, tr, 1, node0, f.nullid)

            node2 = f.add(fulltext2, None, tr, 3, node1, f.nullid)

        self.assertEqual(len(f), 3)

        self.assertEqual(list(f), [0, 1, 2])

        gen = iter(f)

        self.assertEqual(next(gen), 0)

        self.assertEqual(next(gen), 1)

        self.assertEqual(next(gen), 2)

        with self.assertRaises(StopIteration):

            next(gen)

        self.assertEqual(list(f.revs()), [0, 1, 2])

        self.assertEqual(list(f.revs(0)), [0, 1, 2])

        self.assertEqual(list(f.revs(1)), [1, 2])

        self.assertEqual(list(f.revs(2)), [2])

        self.assertEqual(list(f.revs(3)), [])

        self.assertEqual(list(f.revs(stop=1)), [0, 1])

        self.assertEqual(list(f.revs(stop=2)), [0, 1, 2])

        self.assertEqual(list(f.revs(stop=3)), [0, 1, 2])

        self.assertEqual(list(f.revs(2, 0)), [2, 1, 0])

        self.assertEqual(list(f.revs(2, 1)), [2, 1])

        # TODO this is wrong

        self.assertEqual(list(f.revs(3, 2)), [3, 2])

        self.assertEqual(f.parents(node0), (f.nullid, f.nullid))

        self.assertEqual(f.parents(node1), (node0, f.nullid))

        self.assertEqual(f.parents(node2), (node1, f.nullid))

        self.assertEqual(f.parentrevs(0), (nullrev, nullrev))

        self.assertEqual(f.parentrevs(1), (0, nullrev))

        self.assertEqual(f.parentrevs(2), (1, nullrev))

        self.assertEqual(f.rev(node0), 0)

        self.assertEqual(f.rev(node1), 1)

        self.assertEqual(f.rev(node2), 2)

        with self.assertRaises(error.LookupError):

            f.rev(b'\x01' * 20)

        self.assertEqual(f.node(0), node0)

        self.assertEqual(f.node(1), node1)

        self.assertEqual(f.node(2), node2)

        with self.assertRaises(IndexError):

            f.node(3)

        self.assertEqual(f.lookup(node0), node0)

        self.assertEqual(f.lookup(0), node0)

        self.assertEqual(f.lookup(b'0'), node0)

        self.assertEqual(f.lookup(hex(node0)), node0)

        self.assertEqual(f.lookup(node1), node1)

        self.assertEqual(f.lookup(1), node1)

        self.assertEqual(f.lookup(b'1'), node1)

        self.assertEqual(f.lookup(hex(node1)), node1)

        self.assertEqual(f.linkrev(0), 0)

        self.assertEqual(f.linkrev(1), 1)

        self.assertEqual(f.linkrev(2), 3)

        with self.assertRaises(IndexError):

            f.linkrev(3)

        self.assertFalse(f.iscensored(0))

        self.assertFalse(f.iscensored(1))

        self.assertFalse(f.iscensored(2))

        with self.assertRaises(IndexError):

            f.iscensored(3)

        self.assertEqual(f.commonancestorsheads(node1, f.nullid), [])

        self.assertEqual(f.commonancestorsheads(node1, node0), [node0])

        self.assertEqual(f.commonancestorsheads(node1, node1), [node1])

        self.assertEqual(f.commonancestorsheads(node0, node1), [node0])

        self.assertEqual(f.commonancestorsheads(node1, node2), [node1])

        self.assertEqual(f.commonancestorsheads(node2, node1), [node1])

        self.assertEqual(list(f.descendants([0])), [1, 2])

        self.assertEqual(list(f.descendants([1])), [2])

        self.assertEqual(list(f.descendants([0, 1])), [1, 2])

        self.assertEqual(f.heads(), [node2])

        self.assertEqual(f.heads(node0), [node2])

        self.assertEqual(f.heads(node1), [node2])

        self.assertEqual(f.heads(node2), [node2])

        # TODO this behavior seems wonky. Is it correct? If so, the

        # docstring for heads() should be updated to reflect desired

        # behavior.