redis-om-python/tests/test_hash_model.py

526 lines
14 KiB
Python
Raw Normal View History

2021-11-27 00:25:18 +01:00
# type: ignore
import abc
2021-11-25 03:12:27 +01:00
import dataclasses
2021-09-01 21:56:06 +02:00
import datetime
import decimal
2021-10-21 08:24:31 +02:00
from collections import namedtuple
2021-11-27 00:25:18 +01:00
from typing import Dict, List, Optional, Set
2021-09-30 05:23:39 +02:00
from unittest import mock
2021-09-01 21:56:06 +02:00
import pytest
from pydantic import ValidationError
2021-11-10 00:59:10 +01:00
from aredis_om import (
Field,
HashModel,
Migrator,
QueryNotSupportedError,
RedisModelError,
2021-09-01 21:56:06 +02:00
)
2021-11-10 20:31:02 +01:00
# We need to run this check as sync code (during tests) even in async mode
# because we call it in the top-level module scope.
from redis_om import has_redisearch
2021-09-01 21:56:06 +02:00
if not has_redisearch():
pytestmark = pytest.mark.skip
2021-09-01 21:56:06 +02:00
today = datetime.date.today()
2021-10-21 08:24:31 +02:00
@pytest.fixture
2021-11-10 00:59:10 +01:00
async def m(key_prefix, redis):
2021-10-21 08:24:31 +02:00
class BaseHashModel(HashModel, abc.ABC):
class Meta:
global_key_prefix = key_prefix
2021-09-01 21:56:06 +02:00
2021-10-21 08:24:31 +02:00
class Order(BaseHashModel):
total: decimal.Decimal
currency: str
created_on: datetime.datetime
2021-09-01 21:56:06 +02:00
2021-10-21 08:24:31 +02:00
class Member(BaseHashModel):
first_name: str = Field(index=True)
last_name: str = Field(index=True)
email: str = Field(index=True)
join_date: datetime.date
age: int = Field(index=True)
2022-01-05 19:08:49 +01:00
bio: str = Field(index=True, full_text_search=True)
2021-09-01 21:56:06 +02:00
2021-10-21 08:24:31 +02:00
class Meta:
model_key_prefix = "member"
primary_key_pattern = ""
2021-09-01 21:56:06 +02:00
2021-11-25 03:12:27 +01:00
await Migrator().run()
2021-09-01 21:56:06 +02:00
2021-10-21 08:31:11 +02:00
return namedtuple("Models", ["BaseHashModel", "Order", "Member"])(
BaseHashModel, Order, Member
)
2021-10-21 08:24:31 +02:00
@pytest.fixture
2021-11-10 00:59:10 +01:00
async def members(m):
2021-10-21 08:24:31 +02:00
member1 = m.Member(
first_name="Andrew",
last_name="Brookins",
email="a@example.com",
age=38,
join_date=today,
2022-01-05 19:08:49 +01:00
bio="This is member 1 whose greatness makes him the life and soul of any party he goes to.",
)
2021-10-21 08:24:31 +02:00
member2 = m.Member(
first_name="Kim",
last_name="Brookins",
email="k@example.com",
age=34,
join_date=today,
2022-01-05 19:08:49 +01:00
bio="This is member 2 who can be quite anxious until you get to know them.",
)
2021-10-21 08:24:31 +02:00
member3 = m.Member(
first_name="Andrew",
last_name="Smith",
email="as@example.com",
age=100,
join_date=today,
2022-01-05 19:08:49 +01:00
bio="This is member 3 who is a funny and lively sort of person.",
)
2021-11-10 00:59:10 +01:00
await member1.save()
await member2.save()
await member3.save()
yield member1, member2, member3
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_exact_match_queries(members, m):
member1, member2, member3 = members
2021-09-16 21:03:03 +02:00
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.last_name == "Brookins").sort_by("age").all()
2021-10-21 08:24:31 +02:00
assert actual == [member2, member1]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(
2021-10-21 08:24:31 +02:00
(m.Member.last_name == "Brookins") & ~(m.Member.first_name == "Andrew")
).all()
2021-09-16 21:03:03 +02:00
assert actual == [member2]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(~(m.Member.last_name == "Brookins")).all()
2021-09-16 21:03:03 +02:00
assert actual == [member3]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.last_name != "Brookins").all()
2021-09-16 21:03:03 +02:00
assert actual == [member3]
2021-11-10 00:59:10 +01:00
actual = await (
2021-10-21 08:31:11 +02:00
m.Member.find(
(m.Member.last_name == "Brookins") & (m.Member.first_name == "Andrew")
| (m.Member.first_name == "Kim")
)
.sort_by("age")
.all()
)
2021-10-21 08:24:31 +02:00
assert actual == [member2, member1]
2021-09-16 21:03:03 +02:00
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(
2021-10-21 08:24:31 +02:00
m.Member.first_name == "Kim", m.Member.last_name == "Brookins"
).all()
assert actual == [member2]
2022-01-13 18:08:46 +01:00
2022-01-05 19:08:49 +01:00
@pytest.mark.asyncio
async def test_full_text_search_queries(members, m):
member1, member2, member3 = members
2022-01-13 18:08:46 +01:00
actual = await (m.Member.find(m.Member.bio % "great").all())
2022-01-05 19:08:49 +01:00
assert actual == [member1]
2022-01-13 18:08:46 +01:00
actual = await (m.Member.find(~(m.Member.bio % "anxious")).all())
2022-01-05 19:08:49 +01:00
assert actual == [member1, member3]
2022-01-13 18:08:46 +01:00
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_recursive_query_resolution(members, m):
2021-09-21 01:06:04 +02:00
member1, member2, member3 = members
2021-11-10 00:59:10 +01:00
actual = await (
2021-10-21 08:31:11 +02:00
m.Member.find(
(m.Member.last_name == "Brookins")
| (m.Member.age == 100) & (m.Member.last_name == "Smith")
)
.sort_by("age")
.all()
)
2021-10-21 08:24:31 +02:00
assert actual == [member2, member1, member3]
2021-09-21 01:06:04 +02:00
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_tag_queries_boolean_logic(members, m):
2021-09-21 01:06:04 +02:00
member1, member2, member3 = members
2021-11-10 00:59:10 +01:00
actual = await (
2021-10-21 08:31:11 +02:00
m.Member.find(
(m.Member.first_name == "Andrew") & (m.Member.last_name == "Brookins")
| (m.Member.last_name == "Smith")
)
.sort_by("age")
.all()
)
assert actual == [member1, member3]
2021-09-21 01:06:04 +02:00
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_tag_queries_punctuation(m):
2021-10-21 08:24:31 +02:00
member1 = m.Member(
first_name="Andrew, the Michael",
last_name="St. Brookins-on-Pier",
email="a|b@example.com", # NOTE: This string uses the TAG field separator.
age=38,
join_date=today,
2022-01-05 19:08:49 +01:00
bio="This is a test user on our system.",
)
2021-11-10 00:59:10 +01:00
await member1.save()
2021-10-21 08:24:31 +02:00
member2 = m.Member(
first_name="Bob",
last_name="the Villain",
email="a|villain@example.com", # NOTE: This string uses the TAG field separator.
age=38,
join_date=today,
2022-01-05 19:08:49 +01:00
bio="This is a villain, they are a really bad person!",
)
2021-11-10 00:59:10 +01:00
await member2.save()
2021-11-10 00:59:10 +01:00
result = await (m.Member.find(m.Member.first_name == "Andrew, the Michael").first())
assert result == member1
result = await (m.Member.find(m.Member.last_name == "St. Brookins-on-Pier").first())
assert result == member1
# Notice that when we index and query multiple values that use the internal
# TAG separator for single-value exact-match fields, like an indexed string,
# the queries will succeed. We apply a workaround that queries for the union
# of the two values separated by the tag separator.
2021-11-10 00:59:10 +01:00
results = await m.Member.find(m.Member.email == "a|b@example.com").all()
assert results == [member1]
results = await m.Member.find(m.Member.email == "a|villain@example.com").all()
assert results == [member2]
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_tag_queries_negation(members, m):
2021-09-21 01:06:04 +02:00
member1, member2, member3 = members
"""
first_name
NOT EQ
Andrew
"""
2021-10-21 08:24:31 +02:00
query = m.Member.find(~(m.Member.first_name == "Andrew"))
2021-11-10 00:59:10 +01:00
assert await query.all() == [member2]
"""
first_name
NOT EQ
| Andrew
AND
| last_name
EQ
Brookins
"""
2021-10-21 08:24:31 +02:00
query = m.Member.find(
~(m.Member.first_name == "Andrew") & (m.Member.last_name == "Brookins")
)
2021-11-10 00:59:10 +01:00
assert await query.all() == [member2]
"""
first_name
NOT EQ
| Andrew
AND
| last_name
| EQ
| | Brookins
OR
| last_name
EQ
Smith
"""
2021-10-21 08:24:31 +02:00
query = m.Member.find(
~(m.Member.first_name == "Andrew")
& ((m.Member.last_name == "Brookins") | (m.Member.last_name == "Smith"))
)
2021-11-10 00:59:10 +01:00
assert await query.all() == [member2]
"""
first_name
NOT EQ
| Andrew
AND
| | last_name
| EQ
| Brookins
OR
| last_name
EQ
Smith
"""
2021-10-21 08:24:31 +02:00
query = m.Member.find(
~(m.Member.first_name == "Andrew") & (m.Member.last_name == "Brookins")
| (m.Member.last_name == "Smith")
)
2021-11-10 00:59:10 +01:00
assert await query.sort_by("age").all() == [member2, member3]
2021-09-21 01:06:04 +02:00
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(
2021-10-21 08:24:31 +02:00
(m.Member.first_name == "Andrew") & ~(m.Member.last_name == "Brookins")
).all()
assert actual == [member3]
2021-09-21 01:06:04 +02:00
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_numeric_queries(members, m):
member1, member2, member3 = members
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age == 34).all()
assert actual == [member2]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age > 34).sort_by("age").all()
assert actual == [member1, member3]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age < 35).all()
assert actual == [member2]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age <= 34).all()
assert actual == [member2]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age >= 100).all()
assert actual == [member3]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age != 34).sort_by("age").all()
2021-10-14 02:16:20 +02:00
assert actual == [member1, member3]
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(~(m.Member.age == 100)).sort_by("age").all()
2021-10-21 08:24:31 +02:00
assert actual == [member2, member1]
2021-11-10 00:59:10 +01:00
actual = (
await m.Member.find(m.Member.age > 30, m.Member.age < 40).sort_by("age").all()
)
2021-10-21 08:24:31 +02:00
assert actual == [member2, member1]
2021-10-14 02:16:20 +02:00
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_sorting(members, m):
2021-09-30 05:23:39 +02:00
member1, member2, member3 = members
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age > 34).sort_by("age").all()
assert actual == [member1, member3]
2021-09-30 05:23:39 +02:00
2021-11-10 00:59:10 +01:00
actual = await m.Member.find(m.Member.age > 34).sort_by("-age").all()
assert actual == [member3, member1]
2021-09-30 05:23:39 +02:00
with pytest.raises(QueryNotSupportedError):
# This field does not exist.
2021-11-10 00:59:10 +01:00
await m.Member.find().sort_by("not-a-real-field").all()
2021-09-30 05:23:39 +02:00
with pytest.raises(QueryNotSupportedError):
# This field is not sortable.
2021-11-10 00:59:10 +01:00
await m.Member.find().sort_by("join_date").all()
2021-09-30 05:23:39 +02:00
2021-11-10 00:59:10 +01:00
def test_validates_required_fields(m):
# Raises ValidationError: last_name is required
# TODO: Test the error value
with pytest.raises(ValidationError):
m.Member(first_name="Andrew", zipcode="97086", join_date=today)
def test_validates_field(m):
# Raises ValidationError: join_date is not a date
# TODO: Test the error value
with pytest.raises(ValidationError):
m.Member(first_name="Andrew", last_name="Brookins", join_date="yesterday")
2021-09-30 05:23:39 +02:00
2021-11-10 00:59:10 +01:00
def test_validation_passes(m):
member = m.Member(
first_name="Andrew",
last_name="Brookins",
email="a@example.com",
join_date=today,
age=38,
2022-01-05 19:08:49 +01:00
bio="This is the bio field.",
2021-11-10 00:59:10 +01:00
)
assert member.first_name == "Andrew"
@pytest.mark.asyncio
async def test_saves_model_and_creates_pk(m):
member = m.Member(
first_name="Andrew",
last_name="Brookins",
email="a@example.com",
join_date=today,
age=38,
2022-01-05 19:08:49 +01:00
bio="This is the bio field for this user.",
2021-11-10 00:59:10 +01:00
)
# Save a model instance to Redis
await member.save()
member2 = await m.Member.get(member.pk)
assert member2 == member
2022-02-14 21:44:49 +01:00
@pytest.mark.asyncio
async def test_delete(m):
member = m.Member(
first_name="Simon",
last_name="Prickett",
email="s@example.com",
join_date=today,
age=97,
bio="This is a test user to be deleted.",
2022-02-14 21:44:49 +01:00
)
await member.save()
response = await m.Member.delete(member.pk)
assert response == 1
2021-11-09 01:28:58 +01:00
2021-11-10 00:59:10 +01:00
def test_raises_error_with_embedded_models(m):
class Address(m.BaseHashModel):
address_line_1: str
address_line_2: Optional[str]
city: str
country: str
postal_code: str
with pytest.raises(RedisModelError):
2021-11-09 01:28:58 +01:00
2021-11-10 00:59:10 +01:00
class InvalidMember(m.BaseHashModel):
address: Address
2021-11-25 03:12:27 +01:00
def test_raises_error_with_dataclasses(m):
@dataclasses.dataclass
class Address:
address_line_1: str
with pytest.raises(RedisModelError):
2021-11-27 00:25:18 +01:00
2021-11-25 03:12:27 +01:00
class InvalidMember(m.BaseHashModel):
address: Address
def test_raises_error_with_dicts(m):
with pytest.raises(RedisModelError):
2021-11-27 00:25:18 +01:00
2021-11-25 03:12:27 +01:00
class InvalidMember(m.BaseHashModel):
address: Dict[str, str]
def test_raises_error_with_sets(m):
with pytest.raises(RedisModelError):
2021-11-27 00:25:18 +01:00
2021-11-25 03:12:27 +01:00
class InvalidMember(m.BaseHashModel):
friend_ids: Set[str]
def test_raises_error_with_lists(m):
with pytest.raises(RedisModelError):
2021-11-27 00:25:18 +01:00
2021-11-25 03:12:27 +01:00
class InvalidMember(m.BaseHashModel):
friend_ids: List[str]
2021-11-10 00:59:10 +01:00
@pytest.mark.asyncio
async def test_saves_many(m):
member1 = m.Member(
first_name="Andrew",
last_name="Brookins",
email="a@example.com",
join_date=today,
age=38,
2022-01-05 19:08:49 +01:00
bio="This is the user bio.",
2021-11-10 00:59:10 +01:00
)
member2 = m.Member(
first_name="Kim",
last_name="Brookins",
email="k@example.com",
join_date=today,
age=34,
2022-01-05 19:08:49 +01:00
bio="This is the bio for Kim.",
2021-11-10 00:59:10 +01:00
)
members = [member1, member2]
result = await m.Member.add(members)
assert result == [member1, member2]
assert await m.Member.get(pk=member1.pk) == member1
assert await m.Member.get(pk=member2.pk) == member2
@pytest.mark.asyncio
async def test_updates_a_model(members, m):
member1, member2, member3 = members
await member1.update(last_name="Smith")
member = await m.Member.get(member1.pk)
assert member.last_name == "Smith"
@pytest.mark.asyncio
async def test_paginate_query(members, m):
member1, member2, member3 = members
actual = await m.Member.find().sort_by("age").all(batch_size=1)
assert actual == [member2, member1, member3]
@pytest.mark.asyncio
async def test_access_result_by_index_cached(members, m):
member1, member2, member3 = members
query = m.Member.find().sort_by("age")
# Load the cache, throw away the result.
assert query._model_cache == []
await query.execute()
assert query._model_cache == [member2, member1, member3]
# Access an item that should be in the cache.
with mock.patch.object(query.model, "db") as mock_db:
assert await query.get_item(0) == member2
assert not mock_db.called
@pytest.mark.asyncio
async def test_access_result_by_index_not_cached(members, m):
member1, member2, member3 = members
query = m.Member.find().sort_by("age")
# Assert that we don't have any models in the cache yet -- we
# haven't made any requests of Redis.
assert query._model_cache == []
assert await query.get_item(0) == member2
assert await query.get_item(1) == member1
assert await query.get_item(2) == member3
2021-09-30 05:32:44 +02:00
2021-11-12 16:56:47 +01:00
def test_schema(m):
2021-10-21 08:24:31 +02:00
class Address(m.BaseHashModel):
a_string: str = Field(index=True)
a_full_text_string: str = Field(index=True, full_text_search=True)
an_integer: int = Field(index=True, sortable=True)
a_float: float = Field(index=True)
another_integer: int
another_float: float
2021-11-10 20:31:02 +01:00
# We need to build the key prefix because it will differ based on whether
# these tests were copied into the tests_sync folder and unasynce'd.
key_prefix = Address.make_key(Address._meta.primary_key_pattern.format(pk=""))
assert (
Address.redisearch_schema()
2022-01-05 22:12:31 +01:00
== f"ON HASH PREFIX 1 {key_prefix} SCHEMA pk TAG SEPARATOR | a_string TAG SEPARATOR | a_full_text_string TAG SEPARATOR | a_full_text_string AS a_full_text_string_fts TEXT an_integer NUMERIC SORTABLE a_float NUMERIC"
)