✅ Add tests for export survey link

Author: pwildenhain

redcap/methods/surveys.py

@@ -17,7 +17,7 @@ def export_survey_link(
         record: str,
         event: Optional[str] = None,
         repeat_instance: int = 1,
-    ):
+    ) -> str:
         """
         Export one survey link
 
@@ -32,36 +32,27 @@ def export_survey_link(
             event:
                 Unique event name, only used in longitudinal projects
             repeat_instance:
-                only for projects with repeating instruments/events) 
-                The repeat instance number of the repeating event (if longitudinal) 
-                or the repeating instrument (if classic or longitudinal). 
+                only for projects with repeating instruments/events)
+                The repeat instance number of the repeating event (if longitudinal)
+                or the repeating instrument (if classic or longitudinal).
                 Default value is '1'.
 
         Returns:
-            Str:
-                URL of survey link requested
+            URL of survey link requested
 
         Examples:
-            >>> proj.export_survey_link(instrument="form_1", record="5", event="event_1_arm_1")
-            https://redcap.mytld.com/surveys/?s=6B2zFAEWPVSrXnnx
-        """       
-        payload = self._initialize_payload(
-            content="surveyLink"
-        )
+            >>> proj.export_survey_link(instrument="form_1", record="1", event="event_1_arm_1")
+            'https://redcapdemo.vumc.org/surveys/?s=...'
+        """
+        payload = self._initialize_payload(content="surveyLink")
         payload["instrument"] = instrument
         payload["record"] = record
-        if event:
-            payload["event"] = event
         payload["repeat_instance"] = repeat_instance
 
-        return_type = "str"
-        response = cast(Union[Json, str], self._call_api(payload, return_type))
+        if event:
+            payload["event"] = event
 
-        return self._return_data(
-            response=response,
-            content="surveyLink",
-            format_type=return_type,
-        )
+        return cast(str, self._call_api(payload, return_type="str"))
 
     def export_survey_participant_list(
         self,

tests/integration/test_long_project.py

@@ -303,3 +303,11 @@ def test_fem_import(long_project):
 
     response = long_project.import_instrument_event_mappings(current_fem)
     assert response == 44
+
+
+@pytest.mark.integration
+def test_export_survey_link(long_project):
+    link = long_project.export_survey_link(
+        instrument="contact_info", event="enrollment_arm_1", record="1"
+    )
+    assert link.startswith("https://redcapdemo.vumc.org/surveys/?s=")

tests/unit/callback_utils.py

@@ -781,6 +781,22 @@ def handle_long_project_survey_participants_request(**kwargs) -> Any:
     return (201, headers, json.dumps(resp))
 
 
+def handle_long_project_survey_link_request(**kwargs) -> Any:
+    """Get the survey link for a record and instrument and event"""
+    data = kwargs["data"]
+    headers = kwargs["headers"]
+    resp = None
+
+    if (
+        "test" in data.get("instrument")
+        and "raw" in data.get("event")
+        and "1" in data.get("record")
+    ):
+        resp = "https://redcapdemo.vumc.org/surveys/?s=DMgheEPAgLETxJkf"
+
+    return (201, headers, resp)
+
+
 def get_simple_project_request_handler(request_type: str) -> Callable:
     """Given a request type, extract the handler function"""
     handlers_dict = {
@@ -823,6 +839,7 @@ def get_long_project_request_handler(request_type: str) -> Callable:
         "pdf": handle_long_project_pdf_request,
         "record": handle_long_project_records_request,
         "report": handle_long_project_reports_request,
+        "surveyLink": handle_long_project_survey_link_request,
         "version": handle_long_project_version_request,
     }
 

tests/unit/test_long_project.py

@@ -71,6 +71,11 @@ def test_export_survey_participants_list(long_project):
     assert is_json(res)
 
 
+def test_export_survey_link(long_project):
+    res = long_project.export_survey_link(instrument="test", record="1", event="raw")
+    assert res.startswith("https://redcapdemo.vumc.org/surveys/?s=")
+
+
 def test_metadata_import_handles_api_error(long_project):
     metadata = long_project.export_metadata()