Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Changelog
Next
----

- Add ``VuMarkTarget`` class for VuMark template targets, alongside the renamed ``ImageTarget`` class (previously ``Target``).
``ImageTarget`` is for image-based targets and ``VuMarkTarget`` is for VuMark template targets.
Both can be stored in a ``VuforiaDatabase``.

2026.02.18.2
------------

Expand Down
89 changes: 13 additions & 76 deletions admin/create_secrets_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@
from vws_web_tools import DatabaseDict, VuMarkDatabaseDict


VUMARK_TEMPLATE_SVG_FILE_PATH = Path(__file__).with_name(
name="vumark_template.svg",
)


def _create_and_get_database_details(
driver: "WebDriver",
email_address: str,
Expand Down Expand Up @@ -55,25 +50,6 @@ def _create_and_get_database_details(
)


def _create_and_get_vumark_details(
driver: "WebDriver",
vumark_database_name: str,
) -> "VuMarkDatabaseDict":
"""Create a VuMark database and get its details.

Returns VuMark database details.
"""
vws_web_tools.create_vumark_database(
driver=driver,
database_name=vumark_database_name,
)

return vws_web_tools.get_vumark_database_details(
driver=driver,
database_name=vumark_database_name,
)


def _generate_secrets_file_content(
database_details: "DatabaseDict",
vumark_details: "VuMarkDatabaseDict",
Expand Down Expand Up @@ -103,36 +79,14 @@ def _generate_secrets_file_content(
)


def _create_and_get_vumark_target_id(
driver: "WebDriver",
vumark_database_name: str,
vumark_template_name: str,
) -> str:
"""Upload a VuMark template and get its target ID."""
vws_web_tools.upload_vumark_template(
driver=driver,
database_name=vumark_database_name,
svg_file_path=VUMARK_TEMPLATE_SVG_FILE_PATH,
template_name=vumark_template_name,
width=100.0,
)
return vws_web_tools.get_vumark_target_id(
driver=driver,
database_name=vumark_database_name,
target_name=vumark_template_name,
)


def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
def _create_vuforia_resource_names() -> tuple[str, str]:
"""Create names for Vuforia resources."""
time = datetime.datetime.now(tz=datetime.UTC).strftime(
format="%Y-%m-%d-%H-%M-%S",
)
return (
f"my-license-{time}",
f"my-database-{time}",
f"my-vumark-database-{time}",
f"my-vumark-template-{time}",
)


Expand All @@ -157,6 +111,18 @@ def main() -> None:
"client_access_key": os.environ["INACTIVE_VUFORIA_CLIENT_ACCESS_KEY"],
"client_secret_key": os.environ["INACTIVE_VUFORIA_CLIENT_SECRET_KEY"],
}
vumark_details: VuMarkDatabaseDict = {
"database_name": os.environ[
"VUMARK_VUFORIA_TARGET_MANAGER_DATABASE_NAME"
],
"server_access_key": os.environ[
"VUMARK_VUFORIA_SERVER_ACCESS_KEY"
],
"server_secret_key": os.environ[
"VUMARK_VUFORIA_SERVER_SECRET_KEY"
],
}
vumark_target_id = os.environ["VUMARK_VUFORIA_TARGET_ID"]
new_secrets_dir.mkdir(exist_ok=True)

num_databases = 100
Expand All @@ -175,8 +141,6 @@ def main() -> None:
(
license_name,
database_name,
vumark_database_name,
vumark_template_name,
) = _create_vuforia_resource_names()

try:
Expand All @@ -195,33 +159,6 @@ def main() -> None:
driver = None
continue

try:
vumark_details = _create_and_get_vumark_details(
driver=driver,
vumark_database_name=vumark_database_name,
)
except TimeoutException:
sys.stderr.write(
"Timed out waiting for VuMark setup/details after retries\n"
)
driver.quit()
driver = None
continue

try:
vumark_target_id = _create_and_get_vumark_target_id(
driver=driver,
vumark_database_name=vumark_database_name,
vumark_template_name=vumark_template_name,
)
except TimeoutException:
sys.stderr.write(
"Timed out waiting for VuMark template upload after retries\n"
)
driver.quit()
driver = None
continue

driver.quit()
driver = None

Expand Down
8 changes: 7 additions & 1 deletion docs/source/mock-api-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,13 @@ API Reference
:members:
:undoc-members:

.. autoclass:: mock_vws.target.Target
.. autoenum:: mock_vws.database_type.DatabaseType
:members:
:undoc-members:

.. autoclass:: mock_vws.target.ImageTarget

.. autoclass:: mock_vws.target.VuMarkTarget

Image matchers
--------------
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ optional-dependencies.dev = [
"vulture==2.14",
"vws-python==2026.2.15",
"vws-test-fixtures==2023.3.5",
"vws-web-tools==2026.2.17.1",
"vws-web-tools==2026.2.20",
"yamlfix==1.19.1",
"zizmor==1.22.0",
]
Expand Down Expand Up @@ -452,6 +452,7 @@ ignore_names = [
# Used in TYPE_CHECKING for type hints
"DatabaseDict",
"VuMarkDatabaseDict",
"VuMarkTargetDict",
]
# Duplicate some of .gitignore
exclude = [ ".venv" ]
Expand Down
Binary file modified secrets.tar.gpg
Binary file not shown.
1 change: 1 addition & 0 deletions src/mock_vws/_constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ class ResultCodes(Enum):
INVALID_ACCEPT_HEADER = "InvalidAcceptHeader"
INVALID_INSTANCE_ID = "InvalidInstanceId"
BAD_REQUEST = "BadRequest"
INVALID_TARGET_TYPE = "InvalidTargetType"


@beartype
Expand Down
94 changes: 58 additions & 36 deletions src/mock_vws/_flask_server/target_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
from pydantic_settings import BaseSettings

from mock_vws.database import VuforiaDatabase
from mock_vws.database_type import DatabaseType
from mock_vws.states import States
from mock_vws.target import Target
from mock_vws.target import ImageTarget, VuMarkTarget
from mock_vws.target_manager import TargetManager
from mock_vws.target_raters import (
BrisqueTargetTrackingRater,
Expand Down Expand Up @@ -159,8 +160,13 @@ def create_database() -> Response:
"state_name",
random_database.state.name,
)
database_type_name = request_json.get(
"database_type_name",
random_database.database_type.name,
)

state = States[state_name]
database_type = DatabaseType[database_type_name]

database = VuforiaDatabase(
server_access_key=server_access_key,
Expand All @@ -169,6 +175,7 @@ def create_database() -> Response:
client_secret_key=client_secret_key,
database_name=database_name,
state=state,
database_type=database_type,
)
try:
TARGET_MANAGER.add_database(database=database)
Expand Down Expand Up @@ -197,21 +204,29 @@ def create_target(database_name: str) -> Response:
if database.database_name == database_name
)
request_json = json.loads(s=request.data)
image_base64 = request_json["image_base64"]
image_bytes = base64.b64decode(s=image_base64)
settings = TargetManagerSettings.model_validate(obj={})
target_tracking_rater = settings.target_rater.to_target_rater()

target = Target(
name=request_json["name"],
width=request_json["width"],
image_value=image_bytes,
active_flag=request_json["active_flag"],
processing_time_seconds=request_json["processing_time_seconds"],
application_metadata=request_json["application_metadata"],
target_id=request_json["target_id"],
target_tracking_rater=target_tracking_rater,
)

target_type_name = request_json.get("target_type_name", "IMAGE")
if target_type_name == "VUMARK_TEMPLATE":
target: ImageTarget | VuMarkTarget = VuMarkTarget(
name=request_json["name"],
active_flag=request_json["active_flag"],
processing_time_seconds=request_json["processing_time_seconds"],
target_id=request_json["target_id"],
)
else:
image_bytes = base64.b64decode(s=request_json["image_base64"])
target_tracking_rater = settings.target_rater.to_target_rater()
target = ImageTarget(
name=request_json["name"],
width=request_json["width"],
image_value=image_bytes,
active_flag=request_json["active_flag"],
processing_time_seconds=request_json["processing_time_seconds"],
application_metadata=request_json["application_metadata"],
target_id=request_json["target_id"],
target_tracking_rater=target_tracking_rater,
)
database.targets.add(target)

return Response(
Expand All @@ -235,7 +250,7 @@ def delete_target(database_name: str, target_id: str) -> Response:
target = database.get_target(target_id=target_id)
now = datetime.datetime.now(tz=target.upload_date.tzinfo)
# See https://github.com/facebook/pyrefly/issues/1897
new_target = copy.replace(
new_target: ImageTarget | VuMarkTarget = copy.replace( # type: ignore[assignment]
target, # pyrefly: ignore[bad-argument-type]
delete_date=now,
)
Expand All @@ -261,32 +276,39 @@ def update_target(database_name: str, target_id: str) -> Response:
target = database.get_target(target_id=target_id)

request_json = json.loads(s=request.data)
width = request_json.get("width", target.width)
name = request_json.get("name", target.name)
active_flag = request_json.get("active_flag", target.active_flag)
application_metadata = request_json.get(
"application_metadata",
target.application_metadata,
)

image_value = target.image_value
request_json = json.loads(s=request.data)
if "image" in request_json:
image_value = base64.b64decode(s=request_json["image"])

gmt = ZoneInfo(key="GMT")
last_modified_date = datetime.datetime.now(tz=gmt)

# See https://github.com/facebook/pyrefly/issues/1897
new_target = copy.replace(
target, # pyrefly: ignore[bad-argument-type]
name=name,
width=width,
active_flag=active_flag,
application_metadata=application_metadata,
image_value=image_value,
last_modified_date=last_modified_date,
)
if isinstance(target, ImageTarget):
width = request_json.get("width", target.width)
application_metadata = request_json.get(
"application_metadata",
target.application_metadata,
)
image_value = target.image_value
if "image" in request_json:
image_value = base64.b64decode(s=request_json["image"])
# See https://github.com/facebook/pyrefly/issues/1897
new_target: ImageTarget | VuMarkTarget = copy.replace(
target, # pyrefly: ignore[bad-argument-type]
name=name,
width=width,
active_flag=active_flag,
application_metadata=application_metadata,
image_value=image_value,
last_modified_date=last_modified_date,
)
else:
# See https://github.com/facebook/pyrefly/issues/1897
new_target = copy.replace(
target, # pyrefly: ignore[bad-argument-type]
name=name,
active_flag=active_flag,
last_modified_date=last_modified_date,
)

database.targets.remove(target)
database.targets.add(new_target)
Expand Down
Loading
Loading