Merge pull request #1549 from VWS-Python/adamtheturtle/vws-web-tools-issue-1486

Return the target ID from upload_vumark_template

Author: adamtheturtle

newsfragments/1486.change.rst

@@ -0,0 +1,3 @@
+Make ``upload_vumark_template`` return the ID of the target it uploaded.
+It now waits for VWS to finish processing the target, which takes longer
+than waiting for the target to appear in the targets table.

src/vws_web_tools/__init__.py

@@ -610,8 +610,14 @@ def upload_vumark_template(
     svg_file_path: Path,
     template_name: str,
     width: float,
-) -> None:
-    """Upload a VuMark SVG template to a VuMark database."""
+) -> str:
+    """Upload a VuMark SVG template to a VuMark database.
+
+    Returns:
+        The ID of the uploaded target. Waiting for the ID means waiting
+        for VWS to finish processing the target, which takes longer than
+        waiting for the target to appear in the targets table.
+    """
     navigate_to_database(driver=driver, database_name=database_name)
 
     thirty_second_wait = WebDriverWait(
@@ -687,6 +693,17 @@ def upload_vumark_template(
         ),
     )
 
+    wait_for_vumark_target_link(
+        driver=driver,
+        database_name=database_name,
+        target_name=template_name,
+    )
+    return get_vumark_target_id(
+        driver=driver,
+        database_name=database_name,
+        target_name=template_name,
+    )
+
 
 @beartype
 def _xpath_literal(

tests/test_create_database.py

@@ -376,7 +376,7 @@ def test_upload_vumark_template(
     assert test_file_path is not None
     svg_path = test_file_path.parent / "fixtures" / "vumark_template.svg"
     template_name = f"template-{random_str}"
-    vws_web_tools.upload_vumark_template(
+    target_id = vws_web_tools.upload_vumark_template(
         driver=chrome_driver,
         database_name=database_name,
         svg_file_path=svg_path,
@@ -385,6 +385,9 @@ def test_upload_vumark_template(
     )
 
     assert template_name in chrome_driver.page_source
+    expected_target_id_length = 32
+    assert len(target_id) == expected_target_id_length
+    assert target_id.isalnum()
 
 
 def test_upload_vumark_template_cli(