Switch config name back to ucs_url

Author: TheByronHimes

.devcontainer/.dev_config.yaml

@@ -4,7 +4,7 @@ mongo_dsn: mongodb://localhost:27017
 db_name: uos
 mongo_timeout: 300
 auth_key: "{}"
-file_box_service_url: http://127.0.0.1/upload
+ucs_url: http://127.0.0.1/upload
 access_url: http://127.0.0.1/access
 audit_record_topic: audit-records
 audit_record_type: audit_record_logged

README.md

@@ -94,7 +94,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- <a id="properties/file_box_service_url"></a>**`file_box_service_url`** *(string, format: uri, required)*: URL pointing to the API of the service that owns FileUploadBoxes (currently the UCS). Length must be between 1 and 2083 (inclusive).
+- <a id="properties/ucs_url"></a>**`ucs_url`** *(string, format: uri, required)*: URL pointing to the API of the service that owns FileUploadBoxes (currently the UCS). Length must be between 1 and 2083 (inclusive).
 
 
   Examples:

config_schema.json

@@ -35,15 +35,15 @@
       "title": "Audit Record Type",
       "type": "string"
     },
-    "file_box_service_url": {
+    "ucs_url": {
       "description": "URL pointing to the API of the service that owns FileUploadBoxes (currently the UCS).",
       "examples": [
         "http://127.0.0.1/upload"
       ],
       "format": "uri",
       "maxLength": 2083,
       "minLength": 1,
-      "title": "File Box Service Url",
+      "title": "Ucs Url",
       "type": "string"
     },
     "work_order_signing_key": {
@@ -500,7 +500,7 @@
     "file_upload_box_topic",
     "audit_record_topic",
     "audit_record_type",
-    "file_box_service_url",
+    "ucs_url",
     "work_order_signing_key",
     "access_url",
     "service_instance_id",

example_config.yaml

@@ -21,7 +21,6 @@ cors_exposed_headers: null
 db_name: uos
 docs_url: /docs
 enable_opentelemetry: false
-file_box_service_url: http://127.0.0.1/upload
 file_upload_box_topic: file-upload-boxes
 generate_correlation_id: true
 host: 127.0.0.1
@@ -49,5 +48,6 @@ port: 8080
 research_data_upload_box_topic: research-data-upload-boxes
 service_instance_id: '1'
 service_name: uos
+ucs_url: http://127.0.0.1/upload
 work_order_signing_key: '**********'
 workers: 1

src/uos/adapters/outbound/http.py

@@ -53,7 +53,7 @@ class AccessApiConfig(BaseSettings):
 class FileBoxClientConfig(BaseSettings):
     """Config parameters for interacting with the service owning FileUploadBoxes."""
 
-    file_box_service_url: HttpUrl = Field(
+    ucs_url: HttpUrl = Field(
         ...,
         description="URL pointing to the API of the service that owns FileUploadBoxes"
         + " (currently the UCS).",
@@ -255,7 +255,7 @@ class FileBoxClient(FileBoxClientPort):
     """
 
     def __init__(self, *, config: FileBoxClientConfig):
-        self._file_box_service_url = config.file_box_service_url
+        self._ucs_url = config.ucs_url
         self._signing_key = jwk.JWK.from_json(
             config.work_order_signing_key.get_secret_value()
         )
@@ -277,9 +277,7 @@ async def create_file_upload_box(self, *, storage_alias: str) -> UUID4:
         """
         headers = self._auth_header(CreateFileBoxWorkOrder())
         body = {"storage_alias": storage_alias}
-        response = httpx.post(
-            f"{self._file_box_service_url}/boxes", headers=headers, json=body
-        )
+        response = httpx.post(f"{self._ucs_url}/boxes", headers=headers, json=body)
         if response.status_code != 201:
             log.error(
                 "Error creating new FileUploadBox in external service with storage alias %s.",
@@ -308,7 +306,7 @@ async def lock_file_upload_box(self, *, box_id: UUID4) -> None:
         headers = self._auth_header(wot)
         body = {"lock": True}
         response = httpx.patch(
-            f"{self._file_box_service_url}/boxes/{box_id}", headers=headers, json=body
+            f"{self._ucs_url}/boxes/{box_id}", headers=headers, json=body
         )
         if response.status_code != 204:
             log.error(
@@ -332,7 +330,7 @@ async def unlock_file_upload_box(self, *, box_id: UUID4) -> None:
         headers = self._auth_header(wot)
         body = {"lock": False}
         response = httpx.patch(
-            f"{self._file_box_service_url}/boxes/{box_id}", headers=headers, json=body
+            f"{self._ucs_url}/boxes/{box_id}", headers=headers, json=body
         )
         if response.status_code != 204:
             log.error(
@@ -353,9 +351,7 @@ async def get_file_upload_list(self, *, box_id: UUID4) -> list[UUID4]:
         """
         wot = ViewFileBoxWorkOrder(box_id=box_id)
         headers = self._auth_header(wot)
-        response = httpx.get(
-            f"{self._file_box_service_url}/boxes/{box_id}/uploads", headers=headers
-        )
+        response = httpx.get(f"{self._ucs_url}/boxes/{box_id}/uploads", headers=headers)
         if response.status_code != 200:
             log.error(
                 "Error unlocking FileUploadBox ID %s in external service.",

tests/fixtures/test_config.yaml

@@ -4,7 +4,7 @@ mongo_dsn: mongodb://localhost:27017
 db_name: uos
 mongo_timeout: 300
 auth_key: "{}"
-file_box_service_url: http://127.0.0.1/upload
+ucs_url: http://127.0.0.1/upload
 access_url: http://127.0.0.1/access
 audit_record_topic: audit-records
 audit_record_type: audit_record_logged

tests/integration/test_typical_journey.py

@@ -45,7 +45,7 @@ async def test_typical_journey(joint_fixture: JointFixture, httpx_mock: HTTPXMoc
     - Setting the state to LOCKED
     """
     # Test data
-    file_box_service_url = joint_fixture.config.file_box_service_url
+    file_box_service_url = joint_fixture.config.ucs_url
     access_url = joint_fixture.config.access_url
     ds_user_id = uuid4()
     regular_user_id = uuid4()