Merge main and resolve conflicts

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: adamtheturtle

CHANGELOG.rst

@@ -4,6 +4,13 @@ Changelog
 Next
 ----
 
+2026.02.22.3
+------------
+
+
+- ``MockVWS`` now intercepts both ``requests`` (via ``responses``) and ``httpx`` (via ``respx``) simultaneously.
+  ``MockVWSForHttpx`` has been removed — ``MockVWS`` handles both HTTP libraries.
+
 2026.02.22.2
 ------------
 

README.rst

@@ -8,10 +8,10 @@ VWS Mock
 
 Mock for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
 
-Mocking calls made to Vuforia with Python ``requests``
-------------------------------------------------------
+Mocking calls made to Vuforia
+------------------------------
 
-Using the mock redirects requests to Vuforia made with `requests`_ to an in-memory implementation.
+``MockVWS`` intercepts requests made with `requests`_ or `httpx`_.
 
 .. code-block:: shell
 
@@ -34,32 +34,26 @@ This requires Python |minimum-python-version|\+.
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 
-By default, an exception will be raised if any requests to unmocked addresses are made.
-
-.. _requests: https://pypi.org/project/requests/
-
-Mocking calls made to Vuforia with Python ``httpx``
-----------------------------------------------------
-
-Using the mock redirects requests to Vuforia made with `httpx`_ to an in-memory implementation.
+``MockVWS`` also intercepts `httpx`_ requests:
 
 .. code-block:: python
 
-    """Make a request to the Vuforia Web Services API mock."""
+    """Make a request to the Vuforia Web Services API mock using httpx."""
 
     import httpx
 
-    from mock_vws import MockVWSForHttpx
+    from mock_vws import MockVWS
     from mock_vws.database import CloudDatabase
 
-    with MockVWSForHttpx() as mock:
+    with MockVWS() as mock:
         database = CloudDatabase()
         mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
         httpx.get(url="https://vws.vuforia.com/summary", timeout=30)
 
 By default, an exception will be raised if any requests to unmocked addresses are made.
 
+.. _requests: https://pypi.org/project/requests/
 .. _httpx: https://pypi.org/project/httpx/
 
 Using Docker to mock calls to Vuforia from any language

admin/create_secrets_files.py

@@ -23,12 +23,12 @@
 )
 
 
-def _create_and_get_database_details(
+def _create_and_get_cloud_database_details(
     driver: "WebDriver",
     email_address: str,
     password: str,
-    license_name: str,
-    database_name: str,
+    cloud_license_name: str,
+    cloud_database_name: str,
 ) -> "DatabaseDict":
     """Create a cloud database and get its details.
 
@@ -40,17 +40,19 @@ def _create_and_get_database_details(
         password=password,
     )
     vws_web_tools.wait_for_logged_in(driver=driver)
-    vws_web_tools.create_license(driver=driver, license_name=license_name)
+    vws_web_tools.create_license(
+        driver=driver, license_name=cloud_license_name
+    )
 
     vws_web_tools.create_cloud_database(
         driver=driver,
-        database_name=database_name,
-        license_name=license_name,
+        database_name=cloud_database_name,
+        license_name=cloud_license_name,
     )
 
     return vws_web_tools.get_database_details(
         driver=driver,
-        database_name=database_name,
+        database_name=cloud_database_name,
     )
 
 
@@ -74,19 +76,20 @@ def _create_and_get_vumark_details(
 
 
 def _generate_secrets_file_content(
-    database_details: "DatabaseDict",
+    cloud_database_details: "DatabaseDict",
     vumark_details: "VuMarkDatabaseDict",
     inactive_database_details: "DatabaseDict",
+    inactive_vumark_details: "VuMarkDatabaseDict",
     vumark_target_id: str,
 ) -> str:
     """Generate the content of a secrets file."""
     return textwrap.dedent(
         text=f"""\
-        VUFORIA_TARGET_MANAGER_DATABASE_NAME={database_details["database_name"]}
-        VUFORIA_SERVER_ACCESS_KEY={database_details["server_access_key"]}
-        VUFORIA_SERVER_SECRET_KEY={database_details["server_secret_key"]}
-        VUFORIA_CLIENT_ACCESS_KEY={database_details["client_access_key"]}
-        VUFORIA_CLIENT_SECRET_KEY={database_details["client_secret_key"]}
+        VUFORIA_TARGET_MANAGER_DATABASE_NAME={cloud_database_details["database_name"]}
+        VUFORIA_SERVER_ACCESS_KEY={cloud_database_details["server_access_key"]}
+        VUFORIA_SERVER_SECRET_KEY={cloud_database_details["server_secret_key"]}
+        VUFORIA_CLIENT_ACCESS_KEY={cloud_database_details["client_access_key"]}
+        VUFORIA_CLIENT_SECRET_KEY={cloud_database_details["client_secret_key"]}
 
         INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME={inactive_database_details["database_name"]}
         INACTIVE_VUFORIA_SERVER_ACCESS_KEY={inactive_database_details["server_access_key"]}
@@ -98,6 +101,10 @@ def _generate_secrets_file_content(
         VUMARK_VUFORIA_TARGET_ID={vumark_target_id}
         VUMARK_VUFORIA_SERVER_ACCESS_KEY={vumark_details["server_access_key"]}
         VUMARK_VUFORIA_SERVER_SECRET_KEY={vumark_details["server_secret_key"]}
+
+        INACTIVE_VUMARK_VUFORIA_TARGET_MANAGER_DATABASE_NAME={inactive_vumark_details["database_name"]}
+        INACTIVE_VUMARK_VUFORIA_SERVER_ACCESS_KEY={inactive_vumark_details["server_access_key"]}
+        INACTIVE_VUMARK_VUFORIA_SERVER_SECRET_KEY={inactive_vumark_details["server_secret_key"]}
         """,
     )
 
@@ -122,23 +129,72 @@ def _create_and_get_vumark_target_id(
     )
 
 
-def _fetch_inactive_database_details(
+def _create_and_get_inactive_database_details(
     driver: "WebDriver",
     email_address: str,
     password: str,
-    database_name: str,
+    cloud_license_name: str,
+    cloud_database_name: str,
 ) -> "DatabaseDict":
-    """Fetch details for an existing inactive database."""
+    """Create a cloud database, get its details, then delete the license to
+    make it inactive.
+    """
     vws_web_tools.log_in(
         driver=driver,
         email_address=email_address,
         password=password,
     )
     vws_web_tools.wait_for_logged_in(driver=driver)
-    return vws_web_tools.get_database_details(
+    vws_web_tools.create_license(
+        driver=driver, license_name=cloud_license_name
+    )
+    vws_web_tools.create_cloud_database(
+        driver=driver,
+        database_name=cloud_database_name,
+        license_name=cloud_license_name,
+    )
+    cloud_database_details = vws_web_tools.get_database_details(
+        driver=driver,
+        database_name=cloud_database_name,
+    )
+    vws_web_tools.delete_license(
+        driver=driver, license_name=cloud_license_name
+    )
+    return cloud_database_details
+
+
+def _create_and_get_inactive_vumark_details(
+    driver: "WebDriver",
+    email_address: str,
+    password: str,
+    vumark_license_name: str,
+    vumark_database_name: str,
+) -> "VuMarkDatabaseDict":
+    """Create a VuMark database, get its details, then delete the license
+    to
+    make it inactive.
+    """
+    vws_web_tools.log_in(
+        driver=driver,
+        email_address=email_address,
+        password=password,
+    )
+    vws_web_tools.wait_for_logged_in(driver=driver)
+    vws_web_tools.create_license(
+        driver=driver, license_name=vumark_license_name
+    )
+    vws_web_tools.create_vumark_database(
+        driver=driver,
+        database_name=vumark_database_name,
+    )
+    vumark_database_details = vws_web_tools.get_vumark_database_details(
         driver=driver,
-        database_name=database_name,
+        database_name=vumark_database_name,
+    )
+    vws_web_tools.delete_license(
+        driver=driver, license_name=vumark_license_name
     )
+    return vumark_database_details
 
 
 def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
@@ -147,8 +203,8 @@ def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
         format="%Y-%m-%d-%H-%M-%S",
     )
     return (
-        f"my-license-{time}",
-        f"my-database-{time}",
+        f"my-cloud-license-{time}",
+        f"my-cloud-database-{time}",
         f"my-vumark-database-{time}",
         f"my-vumark-template-{time}",
     )
@@ -159,19 +215,31 @@ def main() -> None:
     email_address = os.environ["VWS_EMAIL_ADDRESS"]
     password = os.environ["VWS_PASSWORD"]
     new_secrets_dir = Path(os.environ["NEW_SECRETS_DIR"]).expanduser()
-    inactive_database_name = os.environ[
-        "INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME"
-    ]
     new_secrets_dir.mkdir(exist_ok=True)
+
+    time = datetime.datetime.now(tz=datetime.UTC).strftime(
+        format="%Y-%m-%d-%H-%M-%S",
+    )
     inactive_driver = vws_web_tools.create_chrome_driver()
-    inactive_database_details = _fetch_inactive_database_details(
+    inactive_database_details = _create_and_get_inactive_database_details(
         driver=inactive_driver,
         email_address=email_address,
         password=password,
-        database_name=inactive_database_name,
+        cloud_license_name=f"my-inactive-cloud-license-{time}",
+        cloud_database_name=f"my-inactive-cloud-database-{time}",
     )
     inactive_driver.quit()
 
+    inactive_vumark_driver = vws_web_tools.create_chrome_driver()
+    inactive_vumark_details = _create_and_get_inactive_vumark_details(
+        driver=inactive_vumark_driver,
+        email_address=email_address,
+        password=password,
+        vumark_license_name=f"my-inactive-vumark-license-{time}",
+        vumark_database_name=f"my-inactive-vumark-database-{time}",
+    )
+    inactive_vumark_driver.quit()
+
     num_databases = 100
     required_files = [
         (new_secrets_dir / f"vuforia_secrets_{i}.env")
@@ -186,51 +254,34 @@ def main() -> None:
         file = files_to_create[-1]
         sys.stdout.write(f"Creating database {file.name}\n")
         (
-            license_name,
-            database_name,
+            cloud_license_name,
+            cloud_database_name,
             vumark_database_name,
             vumark_template_name,
         ) = _create_vuforia_resource_names()
 
         try:
-            database_details = _create_and_get_database_details(
+            sys.stdout.write("Creating cloud database details\n")
+            cloud_database_details = _create_and_get_cloud_database_details(
                 driver=driver,
                 email_address=email_address,
                 password=password,
-                license_name=license_name,
-                database_name=database_name,
-            )
-        except TimeoutException:
-            sys.stderr.write(
-                "Timed out waiting for database setup/details after retries\n"
+                cloud_license_name=cloud_license_name,
+                cloud_database_name=cloud_database_name,
             )
-            driver.quit()
-            driver = None
-            continue
-
-        try:
+            sys.stdout.write("Creating VuMark database details\n")
             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:
+            sys.stdout.write("Creating VuMark target\n")
             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"
-            )
+            sys.stderr.write("Timed out during database setup\n")
             driver.quit()
             driver = None
             continue
@@ -239,9 +290,10 @@ def main() -> None:
         driver = None
 
         file_contents = _generate_secrets_file_content(
-            database_details=database_details,
+            cloud_database_details=cloud_database_details,
             vumark_details=vumark_details,
             inactive_database_details=inactive_database_details,
+            inactive_vumark_details=inactive_vumark_details,
             vumark_target_id=vumark_target_id,
         )
         file.write_text(data=file_contents)

docs/source/basic-example.rst

@@ -1,4 +1,4 @@
-Using the mock redirects requests to Vuforia made with `requests`_ to an in-memory implementation.
+``MockVWS`` intercepts requests to Vuforia made with `requests`_ or `httpx`_.
 
 .. code-block:: python
 
@@ -20,3 +20,4 @@ By default, an exception will be raised if any requests to unmocked addresses ar
 See :ref:`mock-api-reference` for details of what can be changed and how.
 
 .. _requests: https://pypi.org/project/requests/
+.. _httpx: https://pypi.org/project/httpx/

docs/source/contributing.rst

@@ -86,11 +86,9 @@ To find the environment variables to set in the :file:`vuforia_secrets.env` file
 
 Two Cloud databases are necessary in order to run all the Cloud Target tests.
 One of those must be an inactive project.
-To create an inactive project, delete the license key associated with a database.
+The script creates the inactive project automatically by deleting its license.
 
 VuMark tests require one VuMark database.
-When creating multiple credentials files, the same inactive database and the
-same VuMark database can be reused across all files.
 
 Targets sometimes get stuck at the "Processing" stage meaning that they cannot be deleted.
 When this happens, create a new target database to use for testing.
@@ -102,7 +100,6 @@ To create databases without using the browser, use :file:`admin/create_secrets_f
       $ export VWS_EMAIL_ADDRESS=...
       $ export VWS_PASSWORD=...
       $ export NEW_SECRETS_DIR=...
-      $ export INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME=...
       # You may have to run this a few times, but it is idempotent.
       $ python admin/create_secrets_files.py
       # Each generated file gets its own Cloud database credentials and shares

docs/source/getting-started.rst

@@ -1,12 +1,9 @@
 Getting started
 ---------------
 
-Mocking calls made to Vuforia with Python ``requests``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Mocking calls made to Vuforia
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. include:: basic-example.rst
 
-Mocking calls made to Vuforia with Python ``httpx``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 .. include:: httpx-example.rst