refactor sandbox url

Author: Francisco Videira

sandbox/src/app.js

@@ -14,10 +14,12 @@ const addCommonHeaders = function (request, response) {
     response.headers = {}
   }
 
+  // API proxy always adds x-correlation-id to responses.
+  if (request.headers["x-correlation-id"]) {
+    response.headers["X-Correlation-ID"] = request.headers["x-correlation-id"]
+  }
+
   if (!request.path.includes("/ObjectStore")) {
-    if (request.headers["x-correlation-id"]) {
-      response.headers["X-Correlation-ID"] = request.headers["x-correlation-id"]
-    }
     response.headers["X-Request-ID"] = '58621d65-d5ad-4c3a-959f-0438e355990e-1'
   }
 }

tests/sandbox/conftest.py

@@ -38,14 +38,30 @@ def load_file(environment) -> Callable[[str], bytes]:
 
 @pytest.fixture
 def send_rest_request(
-    sandbox_url,
+    sandbox_url, environment
 ) -> Callable[[HttpMethod, str, Actor], requests.Response]:
     """Provides a method which encapsulates the logic of sending a REST call to the correct base URL"""
     return lambda method, url, actor, headers={}, **kwargs: _send_rest_request(
-        method, sandbox_url + "/" + url, actor, headers, **kwargs
+        method,
+        sandbox_url + "/" + url,
+        _process_headers(headers, environment, actor, sandbox_url),
+        **kwargs
     )
 
 
+def _process_headers(
+    headers: Dict[str, str], environment: str, actor: Actor, sandbox_url: str
+) -> Dict[str, str]:
+    if environment == "local":
+        headers.update({"x-ers-sandbox-baseurl": sandbox_url})
+
+    headers[RenamedHeader.BUSINESS_FUNCTION.original] = actor.business_function
+    if actor.obo_user_id != None:
+        headers[RenamedHeader.OBO_USER_ID.original] = actor.obo_user_id
+
+    return headers
+
+
 def _get_json(base_path: str, path: str) -> Dict[str, str]:
     with open(base_path + path) as f:
         return json.load(f)
@@ -57,9 +73,6 @@ def _get_file(base_path: str, path: str) -> bytes:
 
 
 def _send_rest_request(
-    method: HttpMethod, url: str, actor: Actor, headers: Dict[str, str], **kwargs
+    method: HttpMethod, url: str, headers: Dict[str, str], **kwargs
 ) -> requests.Response:
-    headers[RenamedHeader.BUSINESS_FUNCTION.original] = actor.business_function
-    if actor.obo_user_id != None:
-        headers[RenamedHeader.OBO_USER_ID.original] = actor.obo_user_id
     return method(url, headers=headers, **kwargs)

tests/sandbox/r4/test_a042_get_attachment.py

@@ -61,15 +61,8 @@ def test_success(
         actor: Actor,
         id: str,
         sandbox_url: str,
-        environment: str,
     ):
-        request_headers = (
-            {"x-ers-sandbox-baseurl": sandbox_url} if environment == "local" else {}
-        )
-
-        actual_response = call_endpoint_url_with_pathParams(
-            actor, {"binaryId": id}, request_headers
-        )
+        actual_response = call_endpoint_url_with_pathParams(actor, {"binaryId": id})
 
         asserts.assert_status_code(307, actual_response.status_code)
 

tests/sandbox/r4/test_a042_get_attachment_follow_redirection.py

@@ -66,15 +66,9 @@ def test_success(
         ],
         actor: Actor,
         id: str,
-        sandbox_url: str,
-        environment: str,
     ):
-        request_headers = (
-            {"x-ers-sandbox-baseurl": sandbox_url} if environment == "local" else {}
-        )
-
         actual_response = call_endpoint_url_with_pathParams(
-            actor, {"binaryId": id}, request_headers, allow_redirects=True
+            actor, {"binaryId": id}, allow_redirects=True
         )
 
         asserts.assert_status_code(200, actual_response.status_code)
@@ -96,34 +90,3 @@ def test_success(
             assert_content_length=True,
             assert_ignored_headers=False,
         )
-
-    def test_with_correlation_id(
-        self,
-        call_endpoint: Callable[[Actor], Response],
-        authorised_actors: Iterable[Actor],
-        default_headers: Dict[str, str],
-        sandbox_url: str,
-        environment: str,
-    ):
-        """
-        Overrides parent test. It's expected that following the redirection will result in a response from the object store without a correlation id.
-        """
-        request_headers = {RenamedHeader.CORRELATION_ID.original: "test"}
-
-        if environment == "local":
-            request_headers["x-ers-sandbox-baseurl"] = sandbox_url
-
-        response = call_endpoint(
-            authorised_actors[0],
-            headers=request_headers,
-        )
-
-        # Check that the response completed successfully.
-        assert (
-            response.status_code // 200 == 1
-        ), "Supplied request did not complete successfully."
-
-        with check:
-            assert (
-                RenamedHeader.CORRELATION_ID.original not in response.headers
-            ), "Object store expected not to return a correlation id."