tortoise-orm/tests/fields/test_db_index.py at 623c8d7221ed35bf66f564994892d19d4dcb036b · waketzheng/tortoise-orm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
from __future__ import annotations

from typing import Any

from pypika_tortoise.terms import Field

from tests.testmodels import ModelWithIndexes
from tortoise import fields
from tortoise.contrib import test
from tortoise.exceptions import ConfigurationError
from tortoise.indexes import Index


class CustomIndex(Index):
    def __init__(self, *args, **kw):
        super().__init__(*args, **kw)
        self._foo = ""


class TestIndexHashEqualRepr(test.SimpleTestCase):
    def test_index_eq(self):
        assert Index(fields=("id",)) == Index(fields=("id",))
        assert CustomIndex(fields=("id",)) == CustomIndex(fields=("id",))
        assert Index(fields=("id", "name")) == Index(fields=["id", "name"])

        assert Index(fields=("id", "name")) != Index(fields=("name", "id"))
        assert Index(fields=("id",)) != Index(fields=("name",))
        assert CustomIndex(fields=("id",)) != Index(fields=("id",))

    def test_index_hash(self):
        assert hash(Index(fields=("id",))) == hash(Index(fields=("id",)))
        assert hash(Index(fields=("id", "name"))) == hash(Index(fields=["id", "name"]))
        assert hash(CustomIndex(fields=("id", "name"))) == hash(CustomIndex(fields=["id", "name"]))

        assert hash(Index(fields=("id", "name"))) != hash(Index(fields=["name", "id"]))
        assert hash(Index(fields=("id",))) != hash(Index(fields=("name",)))

        indexes = {Index(fields=("id",))}
        indexes.add(Index(fields=("id",)))
        assert len(indexes) == 1
        indexes.add(CustomIndex(fields=("id",)))
        assert len(indexes) == 2
        indexes.add(Index(fields=("name",)))
        assert len(indexes) == 3

    def test_index_repr(self):
        assert repr(Index(fields=("id",))) == "Index(fields=['id'])"
        assert repr(Index(fields=("id", "name"))) == "Index(fields=['id', 'name'])"
        assert repr(Index(fields=("id",), name="MyIndex")) == "Index(fields=['id'], name='MyIndex')"
        assert repr(Index(Field("id"))) == f"Index({str(Field('id'))})"
        assert repr(Index(Field("a"), name="Id")) == f"Index({str(Field('a'))}, name='Id')"
        with self.assertRaises(ConfigurationError):
            Index(Field("id"), fields=("name",))


class TestIndexAlias(test.TestCase):
    Field: Any = fields.IntField

    def test_index_alias(self) -> None:
        kwargs: dict = getattr(self, "init_kwargs", {})
        with self.assertWarnsRegex(
            DeprecationWarning, "`index` is deprecated, please use `db_index` instead"
        ):
            f = self.Field(index=True, **kwargs)
        assert f.index is True
        with self.assertWarnsRegex(
            DeprecationWarning, "`index` is deprecated, please use `db_index` instead"
        ):
            f = self.Field(index=False, **kwargs)
        assert f.index is False
        f = self.Field(db_index=True, **kwargs)
        assert f.index is True
        f = self.Field(db_index=True, index=True, **kwargs)
        assert f.index is True
        f = self.Field(db_index=False, **kwargs)
        assert f.index is False
        f = self.Field(db_index=False, index=False, **kwargs)
        assert f.index is False
        with self.assertRaisesRegex(ConfigurationError, "can't set both db_index and index"):
            self.Field(db_index=False, index=True, **kwargs)
        with self.assertRaisesRegex(ConfigurationError, "can't set both db_index and index"):
            self.Field(db_index=True, index=False, **kwargs)


class TestIndexAliasSmallInt(TestIndexAlias):
    Field = fields.SmallIntField


class TestIndexAliasBigInt(TestIndexAlias):
    Field = fields.BigIntField


class TestIndexAliasUUID(TestIndexAlias):
    Field = fields.UUIDField


class TestIndexAliasChar(TestIndexAlias):
    Field = fields.CharField
    init_kwargs = {"max_length": 10}


class TestModelWithIndexes(test.TestCase):
    def test_meta(self):
        self.assertEqual(
            ModelWithIndexes._meta.indexes,
            [Index(fields=("f1", "f2")), Index(fields=("f3",), name="model_with_indexes__f3")],
        )
        self.assertTrue(ModelWithIndexes._meta.fields_map["id"].index)
        self.assertTrue(ModelWithIndexes._meta.fields_map["indexed"].index)
        self.assertTrue(ModelWithIndexes._meta.fields_map["unique_indexed"].unique)