Merge pull request #600 from VWS-Python/database-dataclass

Use dataclasses for Vuforia Database

Author: adamtheturtle

src/mock_vws/database.py

@@ -3,73 +3,30 @@
 """
 
 import uuid
-from typing import Optional, Set
+from dataclasses import dataclass, field
+from typing import Set
 
 from .states import States
 from .target import Target
 
 
-class VuforiaDatabase:
+def _random_hex() -> str:
     """
-    Credentials for VWS APIs.
+    Return a random hex value.
     """
+    return uuid.uuid4().hex
 
-    database_name: str
-    server_access_key: str
-    server_secret_key: str
-    client_access_key: str
-    client_secret_key: str
-    targets: Set[Target]
-    state: States
-
-    def __init__(
-        self,
-        server_access_key: Optional[str] = None,
-        server_secret_key: Optional[str] = None,
-        client_access_key: Optional[str] = None,
-        client_secret_key: Optional[str] = None,
-        database_name: Optional[str] = None,
-        state: States = States.WORKING,
-    ) -> None:
-        """
-        Args:
-            database_name: The name of a VWS target manager database name.
-            server_access_key: A VWS server access key.
-            server_secret_key: A VWS server secret key.
-            client_access_key: A VWS client access key.
-            client_secret_key: A VWS client secret key.
-            state: The state of the database.
-
-        Attributes:
-            database_name (str): The name of a VWS target manager database.
-            server_access_key (bytes): A VWS server access key.
-            server_secret_key (bytes): A VWS server secret key.
-            client_access_key (bytes): A VWS client access key.
-            client_secret_key (bytes): A VWS client secret key.
-            targets (typing.Set[Target]): The
-                :class:`~mock_vws.target.Target` s in the database.
-            state (States): The state of the database.
-        """
-
-        if database_name is None:
-            database_name = uuid.uuid4().hex
-
-        if server_access_key is None:
-            server_access_key = uuid.uuid4().hex
 
-        if server_secret_key is None:
-            server_secret_key = uuid.uuid4().hex
-
-        if client_access_key is None:
-            client_access_key = uuid.uuid4().hex
-
-        if client_secret_key is None:
-            client_secret_key = uuid.uuid4().hex
+@dataclass(eq=True, frozen=True)
+class VuforiaDatabase:
+    """
+    Credentials for VWS APIs.
+    """
 
-        self.server_access_key = server_access_key
-        self.server_secret_key = server_secret_key
-        self.client_access_key = client_access_key
-        self.client_secret_key = client_secret_key
-        self.database_name = database_name
-        self.targets: Set[Target] = set([])
-        self.state = state
+    database_name: str = field(default_factory=_random_hex)
+    server_access_key: str = field(default_factory=_random_hex)
+    server_secret_key: str = field(default_factory=_random_hex)
+    client_access_key: str = field(default_factory=_random_hex)
+    client_secret_key: str = field(default_factory=_random_hex)
+    targets: Set[Target] = field(default_factory=set, hash=False)
+    state: States = States.WORKING

tests/mock_vws/test_authorization_header.py

@@ -181,11 +181,18 @@ def test_bad_access_key_services(
         vuforia_database: VuforiaDatabase,
     ) -> None:
         """
-        If the server access key given does not match any database, a
-        ``Fail`` response is returned.
+        If the server access key given does not match any database, a ``Fail``
+        response is returned.
         """
-        keys = vuforia_database
-        keys.server_access_key = 'example'
+        keys = VuforiaDatabase(
+            database_name=vuforia_database.database_name,
+            server_access_key='example',
+            server_secret_key=vuforia_database.server_secret_key,
+            client_access_key=vuforia_database.client_access_key,
+            client_secret_key=vuforia_database.client_secret_key,
+            targets=vuforia_database.targets,
+            state=vuforia_database.state,
+        )
         response = get_vws_target(
             target_id=uuid.uuid4().hex,
             vuforia_database=keys,
@@ -206,12 +213,20 @@ def test_bad_access_key_query(
         If the client access key given is incorrect, an
         ``UNAUTHORIZED`` response is returned.
         """
-        vuforia_database.client_access_key = 'example'
+        keys = VuforiaDatabase(
+            database_name=vuforia_database.database_name,
+            server_access_key=vuforia_database.server_access_key,
+            server_secret_key=vuforia_database.server_secret_key,
+            client_access_key='example',
+            client_secret_key=vuforia_database.client_secret_key,
+            targets=vuforia_database.targets,
+            state=vuforia_database.state,
+        )
         image_content = high_quality_image.getvalue()
         body = {'image': ('image.jpeg', image_content, 'image/jpeg')}
 
         response = query(
-            vuforia_database=vuforia_database,
+            vuforia_database=keys,
             body=body,
         )
 
@@ -244,8 +259,15 @@ def test_bad_secret_key_services(
         If the server secret key given is incorrect, an
         ``AuthenticationFailure`` response is returned.
         """
-        keys = vuforia_database
-        keys.server_secret_key = 'example'
+        keys = VuforiaDatabase(
+            database_name=vuforia_database.database_name,
+            server_access_key=vuforia_database.server_access_key,
+            server_secret_key='example',
+            client_access_key=vuforia_database.client_access_key,
+            client_secret_key=vuforia_database.client_secret_key,
+            targets=vuforia_database.targets,
+            state=vuforia_database.state,
+        )
         response = get_vws_target(
             target_id=uuid.uuid4().hex,
             vuforia_database=keys,
@@ -266,12 +288,20 @@ def test_bad_secret_key_query(
         If the client secret key given is incorrect, an
         ``UNAUTHORIZED`` response is returned.
         """
-        vuforia_database.client_secret_key = 'example'
+        keys = VuforiaDatabase(
+            database_name=vuforia_database.database_name,
+            server_access_key=vuforia_database.server_access_key,
+            server_secret_key=vuforia_database.server_secret_key,
+            client_access_key=vuforia_database.client_access_key,
+            client_secret_key='example',
+            targets=vuforia_database.targets,
+            state=vuforia_database.state,
+        )
         image_content = high_quality_image.getvalue()
         body = {'image': ('image.jpeg', image_content, 'image/jpeg')}
 
         response = query(
-            vuforia_database=vuforia_database,
+            vuforia_database=keys,
             body=body,
         )