Basic hash and JSON models

tests/test_hash_model.py

@@ -0,0 +1,144 @@
+import decimal
+import datetime
+from typing import Optional, List
+
+import pytest
+import redis
+from pydantic import ValidationError
+
+from redis_developer.orm import (
+    HashModel,
+    Field,
+)
+from redis_developer.orm.model import RedisModelError
+
+r = redis.Redis()
+today = datetime.date.today()
+
+
+class BaseHashModel(HashModel):
+    class Meta(HashModel.Meta):
+        global_key_prefix = "redis-developer"
+
+
+class Address(BaseHashModel):
+    address_line_1: str
+    address_line_2: Optional[str]
+    city: str
+    country: str
+    postal_code: str
+
+
+class Order(BaseHashModel):
+    total: decimal.Decimal
+    currency: str
+    created_on: datetime.datetime
+
+
+class Member(BaseHashModel):
+    first_name: str
+    last_name: str
+    email: str = Field(unique=True, index=True)
+    join_date: datetime.date
+
+    class Meta(BaseHashModel.Meta):
+        model_key_prefix = "member"
+        primary_key_pattern = ""
+
+
+def test_validates_required_fields():
+    # Raises ValidationError: last_name, address are required
+    with pytest.raises(ValidationError):
+        Member(
+            first_name="Andrew",
+            zipcode="97086",
+            join_date=today
+        )
+
+
+def test_validates_field():
+    # Raises ValidationError: join_date is not a date
+    with pytest.raises(ValidationError):
+        Member(
+            first_name="Andrew",
+            last_name="Brookins",
+            join_date="yesterday"
+        )
+
+
+# Passes validation
+def test_validation_passes():
+    address = Address(
+        address_line_1="1 Main St.",
+        city="Happy Town",
+        state="WY",
+        postal_code=11111,
+        country="USA"
+    )
+    member = Member(
+        first_name="Andrew",
+        last_name="Brookins",
+        email="a@example.com",
+        join_date=today
+    )
+    assert member.first_name == "Andrew"
+
+
+def test_saves_model_and_creates_pk():
+    member = Member(
+        first_name="Andrew",
+        last_name="Brookins",
+        email="a@example.com",
+        join_date=today
+    )
+    # Save a model instance to Redis
+    member.save()
+
+    member2 = Member.get(member.pk)
+    assert member2 == member
+
+
+def test_raises_error_with_embedded_models():
+    with pytest.raises(RedisModelError):
+        class InvalidMember(BaseHashModel):
+            address: Address
+
+
+@pytest.mark.skip("Not implemented yet")
+def test_saves_many():
+    members = [
+        Member(
+            first_name="Andrew",
+            last_name="Brookins",
+            email="a@example.com",
+            join_date=today
+        ),
+        Member(
+            first_name="Kim",
+            last_name="Brookins",
+            email="k@example.com",
+            join_date=today
+        )
+    ]
+    Member.add(members)
+
+
+@pytest.mark.skip("No implemented yet")
+def test_updates_a_model():
+    member = Member(
+        first_name="Andrew",
+        last_name="Brookins",
+        email="a@example.com",
+        join_date=today
+    )
+
+    # Update a model instance in Redis
+    member.first_name = "Brian"
+    member.last_name = "Sam-Bodden"
+    member.save()
+
+    # Or, with an implicit save:
+    member.update(first_name="Brian", last_name="Sam-Bodden")
+
+    # Or, affecting multiple model instances with an implicit save:
+    Member.filter(Member.last_name == "Brookins").update(last_name="Sam-Bodden")

tests/test_json_model.py

@@ -7,21 +7,19 @@ import redis
 from pydantic import ValidationError
 
 from redis_developer.orm import (
-    RedisModel,
+    JsonModel,
     Field,
-    Relationship,
 )
 
 r = redis.Redis()
 
 
-class BaseRedisModel(RedisModel):
-    class Meta:
-        database = redis.Redis(password="my-password", decode_responses=True)
-        model_key_prefix = "redis-developer:"
+class BaseJsonModel(JsonModel):
+    class Meta(JsonModel.Meta):
+        global_key_prefix = "redis-developer"
 
 
-class Address(BaseRedisModel):
+class Address(BaseJsonModel):
     address_line_1: str
     address_line_2: Optional[str]
     city: str
@@ -29,28 +27,25 @@ class Address(BaseRedisModel):
     postal_code: str
 
 
-class Order(BaseRedisModel):
+class Order(BaseJsonModel):
     total: decimal.Decimal
     currency: str
     created_on: datetime.datetime
 
 
-class Member(BaseRedisModel):
+class Member(BaseJsonModel):
     first_name: str
     last_name: str
     email: str = Field(unique=True, index=True)
     join_date: datetime.date
 
-    # Creates an embedded document: stored as hash fields or JSON document.
+    # Creates an embedded model: stored as hash fields or JSON document.
     address: Address
 
-    # Creates a relationship to data in separate Hash or JSON documents.
-    orders: Optional[List[Order]] = Relationship(back_populates='member')
+    # Creates an embedded list of models.
+    orders: Optional[List[Order]]
 
-    # Creates a self-relationship.
-    recommended_by: Optional['Member'] = Relationship(back_populates='recommended')
-
-    class Meta(BaseRedisModel.Meta):
+    class Meta(BaseJsonModel.Meta):
         model_key_prefix = "member"
         primary_key_pattern = ""
 
@@ -94,6 +89,17 @@ def test_validation_passes():
     assert member.first_name == "Andrew"
 
 
+def test_gets_pk():
+    address = Address(
+        address_line_1="1 Main St.",
+        city="Happy Town",
+        state="WY",
+        postal_code=11111,
+        country="USA"
+    )
+    assert address.pk is not None
+
+
 def test_saves_model():
     address = Address(
         address_line_1="1 Main St.",
@@ -109,8 +115,7 @@ def test_saves_model():
     assert address2 == address
 
 
-# Saves a model with relationships (TODO!)
-@pytest.mark.skip("Not implemented yet")
+# Saves a model with embedded models
 def test_saves_with_relationships():
     address = Address(
         address_line_1="1 Main St.",
@@ -128,6 +133,9 @@ def test_saves_with_relationships():
     )
     member.save()
 
+    member2 = Member.get(member.pk)
+    assert member2.address == address
+
 
 # Save many model instances to Redis
 @pytest.mark.skip("Not implemented yet")