vws-python-mock 2026.8.4__py3-none-any.whl

mock_vws/_services_validators/name_validators.py

@@ -0,0 +1,235 @@
+"""Validators for target names."""
+
+import json
+import logging
+from collections.abc import Iterable, Mapping
+from http import HTTPMethod, HTTPStatus
+
+from beartype import beartype
+
+from mock_vws._database_matchers import (
+    AnyDatabase,
+    get_database_matching_server_keys,
+)
+from mock_vws._services_validators.exceptions import (
+    FailError,
+    TargetNameExistError,
+)
+
+_LOGGER = logging.getLogger(name=__name__)
+
+
+@beartype
+def validate_name_characters_in_range(
+    *,
+    request_body: bytes,
+    request_method: str,
+    request_path: str,
+) -> None:
+    """Validate the characters in the name argument given to a VWS
+    endpoint.
+
+    Args:
+        request_body: The body of the request.
+        request_method: The HTTP method the request is using.
+        request_path: The path to the endpoint.
+
+    Raises:
+        FailError: Characters are out of range and the request is trying to
+            make a new target.
+        TargetNameExistError: Characters are out of range and the request is
+            for another endpoint.
+    """
+    if not request_body:
+        return
+
+    request_text = request_body.decode()
+    if "name" not in json.loads(s=request_text):
+        return
+
+    name = json.loads(s=request_text)["name"]
+
+    max_character_ord = 65535
+    if all(ord(character) <= max_character_ord for character in name):
+        return
+
+    if (request_method, request_path) == (HTTPMethod.POST, "/targets"):
+        _LOGGER.warning(msg="Characters are out of range.")
+        raise FailError(status_code=HTTPStatus.INTERNAL_SERVER_ERROR)
+
+    _LOGGER.warning(msg="Characters are out of range.")
+    raise TargetNameExistError
+
+
+@beartype
+def validate_name_type(*, request_body: bytes) -> None:
+    """Validate the type of the name argument given to a VWS endpoint.
+
+    Args:
+        request_body: The body of the request.
+
+    Raises:
+        FailError: A name is given and it is not a string.
+    """
+    if not request_body:
+        return
+
+    request_text = request_body.decode()
+    if "name" not in json.loads(s=request_text):
+        return
+
+    name = json.loads(s=request_text)["name"]
+
+    if isinstance(name, str):
+        return
+
+    _LOGGER.warning(msg="Name is not a string.")
+    raise FailError(status_code=HTTPStatus.BAD_REQUEST)
+
+
+@beartype
+def validate_name_length(*, request_body: bytes) -> None:
+    """Validate the length of the name argument given to a VWS endpoint.
+
+    Args:
+        request_body: The body of the request.
+
+    Raises:
+        FailError: A name is given and it is not a between 1 and 64 characters
+            in length.
+    """
+    if not request_body:
+        return
+
+    request_text = request_body.decode()
+    if "name" not in json.loads(s=request_text):
+        return
+
+    name = json.loads(s=request_text)["name"]
+
+    max_length = 64
+    if name and len(name) <= max_length:
+        return
+
+    _LOGGER.warning(msg="Name is not between 1 and 64 characters in length.")
+    raise FailError(status_code=HTTPStatus.BAD_REQUEST)
+
+
+@beartype
+def validate_name_does_not_exist_new_target(
+    *,
+    databases: Iterable[AnyDatabase],
+    request_body: bytes,
+    request_headers: Mapping[str, str],
+    request_method: str,
+    request_path: str,
+) -> None:
+    """Validate that the name does not exist for any existing target.
+
+    Args:
+        databases: All Vuforia databases.
+        request_body: The body of the request.
+        request_headers: The headers sent with the request.
+        request_method: The HTTP method the request is using.
+        request_path: The path to the endpoint.
+
+    Raises:
+        TargetNameExistError: The target name already exists.
+    """
+    if not request_body:
+        return
+
+    request_text = request_body.decode()
+    if "name" not in json.loads(s=request_text):
+        return
+
+    split_path = request_path.split(sep="/")
+
+    split_path_no_target_id_length = 2
+    if len(split_path) != split_path_no_target_id_length:
+        return
+
+    name = json.loads(s=request_text)["name"]
+    database = get_database_matching_server_keys(
+        request_headers=request_headers,
+        request_body=request_body,
+        request_method=request_method,
+        request_path=request_path,
+        databases=databases,
+    )
+
+    matching_name_targets = [
+        target
+        for target in database.not_deleted_targets
+        if target.name == name
+    ]
+
+    if not matching_name_targets:
+        return
+
+    _LOGGER.warning(msg="Target name already exists.")
+    raise TargetNameExistError
+
+
+@beartype
+def validate_name_does_not_exist_existing_target(
+    *,
+    request_headers: Mapping[str, str],
+    request_body: bytes,
+    request_method: str,
+    request_path: str,
+    databases: Iterable[AnyDatabase],
+) -> None:
+    """Validate that the name does not exist for any existing target apart
+    from
+    the one being updated.
+
+    Args:
+        databases: All Vuforia databases.
+        request_body: The body of the request.
+        request_headers: The headers sent with the request.
+        request_method: The HTTP method the request is using.
+        request_path: The path to the endpoint.
+
+    Raises:
+        TargetNameExistError: The target name is not the same as the name of
+            the target being updated but it is the same as another target.
+    """
+    if not request_body:
+        return
+
+    request_text = request_body.decode()
+    if "name" not in json.loads(s=request_text):
+        return
+
+    split_path = request_path.split(sep="/")
+    split_path_no_target_id_length = 2
+    if len(split_path) == split_path_no_target_id_length:
+        return
+
+    target_id = split_path[-1]
+
+    name = json.loads(s=request_text)["name"]
+    database = get_database_matching_server_keys(
+        request_headers=request_headers,
+        request_body=request_body,
+        request_method=request_method,
+        request_path=request_path,
+        databases=databases,
+    )
+
+    matching_name_targets = [
+        target
+        for target in database.not_deleted_targets
+        if target.name == name
+    ]
+
+    if not matching_name_targets:
+        return
+
+    (matching_name_target,) = matching_name_targets
+    if matching_name_target.target_id == target_id:
+        return
+
+    _LOGGER.warning(msg="Name already exists for another target.")
+    raise TargetNameExistError

mock_vws/_services_validators/project_state_validators.py

@@ -0,0 +1,76 @@
+"""Validators for the project state."""
+
+import logging
+from collections.abc import Iterable, Mapping
+from http import HTTPMethod
+
+from beartype import beartype
+
+from mock_vws._database_matchers import (
+    AnyDatabase,
+    get_database_matching_server_keys,
+)
+from mock_vws._services_validators.exceptions import (
+    ProjectHasNoAPIAccessError,
+    ProjectInactiveError,
+    ProjectSuspendedError,
+    ValidatorError,
+)
+from mock_vws.database import CloudDatabase, VuMarkDatabase
+from mock_vws.states import States
+
+_LOGGER = logging.getLogger(name=__name__)
+
+
+@beartype
+def validate_project_state(
+    *,
+    request_path: str,
+    request_headers: Mapping[str, str],
+    request_body: bytes,
+    request_method: str,
+    databases: Iterable[AnyDatabase],
+) -> None:
+    """Validate the state of the project.
+
+    Args:
+        request_path: The path of the request.
+        request_headers: The headers sent with the request.
+        request_body: The body of the request.
+        request_method: The HTTP method of the request.
+        databases: All Vuforia databases.
+
+    Raises:
+        ProjectInactiveError: The project is inactive and this endpoint does
+            not work with inactive projects.
+    """
+    database = get_database_matching_server_keys(
+        request_headers=request_headers,
+        request_body=request_body,
+        request_method=request_method,
+        request_path=request_path,
+        databases=databases,
+    )
+
+    state_errors: dict[States, type[ValidatorError]] = {
+        States.PROJECT_HAS_NO_API_ACCESS: ProjectHasNoAPIAccessError,
+        States.PROJECT_SUSPENDED: ProjectSuspendedError,
+    }
+    if error := state_errors.get(database.state):
+        raise error
+
+    if database.state != States.PROJECT_INACTIVE:
+        return
+
+    if (
+        isinstance(database, CloudDatabase)
+        and request_method == HTTPMethod.GET
+        and "duplicates" not in request_path
+    ):
+        return
+
+    if isinstance(database, VuMarkDatabase):
+        return
+
+    _LOGGER.warning(msg="The project is inactive.")
+    raise ProjectInactiveError

mock_vws/_services_validators/request_quota_validators.py

@@ -0,0 +1,42 @@
+"""Validators for the VWS request quota.
+
+This behavior cannot be verified against the real Vuforia Web Services
+without deliberately exhausting a database's request quota. It implements the
+publicly documented behavior so that users can exercise their application's
+quota-error handling with the mock.
+"""
+
+from collections.abc import Iterable, Mapping
+
+from beartype import beartype
+
+from mock_vws._database_matchers import (
+    AnyDatabase,
+    get_database_matching_server_keys,
+)
+from mock_vws.database import CloudDatabase
+
+from .exceptions import RequestQuotaReachedError
+
+
+@beartype
+def validate_request_quota(
+    *,
+    request_headers: Mapping[str, str],
+    request_body: bytes,
+    request_method: str,
+    request_path: str,
+    databases: Iterable[AnyDatabase],
+) -> None:
+    """Raise an error if the matching cloud database has no request
+    quota.
+    """
+    database = get_database_matching_server_keys(
+        request_headers=request_headers,
+        request_body=request_body,
+        request_method=request_method,
+        request_path=request_path,
+        databases=databases,
+    )
+    if isinstance(database, CloudDatabase) and database.request_quota == 0:
+        raise RequestQuotaReachedError

mock_vws/_services_validators/target_quota_validators.py

@@ -0,0 +1,41 @@
+"""Validators for the VWS target quota."""
+
+from collections.abc import Iterable, Mapping
+from http import HTTPMethod
+
+from beartype import beartype
+
+from mock_vws._database_matchers import (
+    AnyDatabase,
+    get_database_matching_server_keys,
+)
+from mock_vws.database import CloudDatabase
+
+from .exceptions import TargetQuotaReachedError
+
+
+@beartype
+def validate_target_quota(
+    *,
+    request_headers: Mapping[str, str],
+    request_body: bytes,
+    request_method: str,
+    request_path: str,
+    databases: Iterable[AnyDatabase],
+) -> None:
+    """Raise an error when adding a target would exceed the quota."""
+    if request_method != HTTPMethod.POST or request_path != "/targets":
+        return
+
+    database = get_database_matching_server_keys(
+        request_headers=request_headers,
+        request_body=request_body,
+        request_method=request_method,
+        request_path=request_path,
+        databases=databases,
+    )
+    if (
+        isinstance(database, CloudDatabase)
+        and len(database.not_deleted_targets) >= database.target_quota
+    ):
+        raise TargetQuotaReachedError

mock_vws/_services_validators/target_validators.py

@@ -0,0 +1,69 @@
+"""Validators for given target IDs."""
+
+import logging
+from collections.abc import Iterable, Mapping
+
+from beartype import beartype
+
+from mock_vws._database_matchers import (
+    AnyDatabase,
+    get_database_matching_server_keys,
+)
+from mock_vws._services_validators.exceptions import UnknownTargetError
+
+_LOGGER = logging.getLogger(name=__name__)
+_TARGETS_WITH_INSTANCE_PATH_LENGTH = 4
+
+
+@beartype
+def validate_target_id_exists(
+    *,
+    request_path: str,
+    request_headers: Mapping[str, str],
+    request_body: bytes,
+    request_method: str,
+    databases: Iterable[AnyDatabase],
+) -> None:
+    """Validate that if a target ID is given, it exists in the database
+    matching the request.
+
+    Args:
+        request_path: The path of the request.
+        request_headers: The headers sent with the request.
+        request_body: The body of the request.
+        request_method: The HTTP method of the request.
+        databases: All Vuforia databases.
+
+    Raises:
+        UnknownTargetError: There are no matching targets for a given target
+            ID.
+    """
+    split_path = request_path.split(sep="/")
+
+    request_path_no_target_id_length = 2
+    if len(split_path) == request_path_no_target_id_length:
+        return
+
+    target_id = split_path[-1]
+    if (
+        len(split_path) == _TARGETS_WITH_INSTANCE_PATH_LENGTH
+        and split_path[-3] == "targets"
+        and split_path[-1] == "instances"
+    ):
+        target_id = split_path[-2]
+    database = get_database_matching_server_keys(
+        request_headers=request_headers,
+        request_body=request_body,
+        request_method=request_method,
+        request_path=request_path,
+        databases=databases,
+    )
+
+    matching_targets = [
+        target
+        for target in database.not_deleted_targets
+        if target.target_id == target_id
+    ]
+    if not matching_targets:
+        _LOGGER.warning('The target ID "%s" does not exist.', target_id)
+        raise UnknownTargetError

mock_vws/_services_validators/width_validators.py

@@ -0,0 +1,38 @@
+"""Validators for the width field."""
+
+import json
+import logging
+from http import HTTPStatus
+
+from beartype import beartype
+
+from mock_vws._services_validators.exceptions import FailError
+
+_LOGGER = logging.getLogger(name=__name__)
+
+
+@beartype
+def validate_width(*, request_body: bytes) -> None:
+    """Validate the width argument given to a VWS endpoint.
+
+    Args:
+        request_body: The body of the request.
+
+    Raises:
+        FailError: Width is given and is not a positive number.
+    """
+    if not request_body:
+        return
+
+    request_text = request_body.decode()
+    if "width" not in json.loads(s=request_text):
+        return
+
+    width = json.loads(s=request_text).get("width")
+
+    width_is_number = isinstance(width, int | float)
+    width_positive = width_is_number and width > 0
+
+    if not width_positive:
+        _LOGGER.warning(msg="Width is not a positive number.")
+        raise FailError(status_code=HTTPStatus.BAD_REQUEST)