rename endpoint for clarity

Author: paulineribeyre

docs/local_installation.md

@@ -71,7 +71,7 @@ Try out the API at <http://localhost:8080/_status> or <http://localhost:8080/doc
 
 ## Run Nextflow workflows with Gen3Workflow
 
-- Hit the `/storage/info` endpoint to get your working directory
+- Hit the `/storage/setup` endpoint to get your working directory
 - Configure Nextflow. Example Nextflow configuration:
 ```
 plugins {

docs/openapi.yaml

@@ -498,7 +498,35 @@ paths:
       - S3
   /storage/info:
     get:
-      description: Get details about the current user's storage setup
+      description: 'Return details about the current user''s storage setup.
+
+        This endpoint also serves as a mandatory "first time setup" for the user''s
+        bucket
+
+        and authz.'
+      operationId: get_storage_info_2
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                additionalProperties: true
+                title: Response Get Storage Info 2
+                type: object
+          description: Successful Response
+      security:
+      - HTTPBearer: []
+      summary: Get Storage Info
+      tags:
+      - Storage
+  /storage/setup:
+    get:
+      description: 'Return details about the current user''s storage setup.
+
+        This endpoint also serves as a mandatory "first time setup" for the user''s
+        bucket
+
+        and authz.'
       operationId: get_storage_info
       responses:
         '200':

gen3workflow/aws_utils.py

@@ -226,7 +226,7 @@ def create_iam_role_for_bucket_access(user_id: str) -> str:
     if config["KMS_ENCRYPTION_ENABLED"]:
         _, kms_key_arn = get_existing_kms_key_for_bucket(bucket_name)
         if not kms_key_arn:
-            err_msg = "Bucket misconfigured. Hit the `GET /storage/info` endpoint and try again."
+            err_msg = "Bucket misconfigured. Hit the `GET /storage/setup` endpoint and try again."
             logger.error(
                 f"No existing KMS key found for bucket '{bucket_name}'. {err_msg}"
             )

gen3workflow/routes/s3.py

@@ -282,7 +282,7 @@ async def s3_endpoint(path: str, request: Request):
     if config["KMS_ENCRYPTION_ENABLED"] and request.method == "PUT":
         _, kms_key_arn = aws_utils.get_existing_kms_key_for_bucket(user_bucket)
         if not kms_key_arn:
-            err_msg = "Bucket misconfigured. Hit the `GET /storage/info` endpoint and try again."
+            err_msg = "Bucket misconfigured. Hit the `GET /storage/setup` endpoint and try again."
             logger.error(
                 f"No existing KMS key found for bucket '{user_bucket}'. {err_msg}"
             )

gen3workflow/routes/storage.py

@@ -15,11 +15,14 @@
 router = APIRouter(prefix="/storage")
 
 
+# TODO: remove the /storage/info path once CI has been updated to use /storage/setup
 @router.get("/info", status_code=HTTP_200_OK)
 @router.get("/info/", status_code=HTTP_200_OK, include_in_schema=False)
+@router.get("/setup", status_code=HTTP_200_OK)
+@router.get("/setup/", status_code=HTTP_200_OK, include_in_schema=False)
 async def get_storage_info(request: Request, auth=Depends(Auth)) -> dict:
     """
-    Get details about the current user's storage setup.
+    Return details about the current user's storage setup.
     This endpoint also serves as a mandatory "first time setup" for the user's bucket
     and authz.
     """

tests/test_misc.py

@@ -98,7 +98,7 @@ async def test_storage_info(
     client, access_token_patcher, mock_aws_services, trailing_slash
 ):
     """
-    Check that S3 buckets are correctly created and configured by the `/storage/info` endpoint.
+    Check that S3 buckets are correctly created and configured by the `/storage/setup` endpoint.
     When users who does not yet have access to their own data (NEW_TEST_USER_ID) hit this
     endpoint, calls to Arborist should be made to create resources, roles, policies and users, and to grant the users access.
     """
@@ -112,9 +112,9 @@ async def test_storage_info(
         e.value.response.get("ResponseMetadata", {}).get("HTTPStatusCode") == 404
     ), f"Bucket exists: {e.value}"
 
-    # hit the /storage/info endpoint
+    # hit the /storage/setup endpoint
     res = await client.get(
-        f"/storage/info{'/' if trailing_slash else ''}",
+        f"/storage/setup{'/' if trailing_slash else ''}",
         headers={"Authorization": f"bearer {TEST_USER_TOKEN}"},
     )
     assert res.status_code == 200, res.text
@@ -130,7 +130,7 @@ async def test_storage_info(
         "kms_key_arn": kms_key_arn,
     }
 
-    # check that the bucket was created after the call to `/storage/info`
+    # check that the bucket was created after the call to `/storage/setup`
     bucket_exists = aws_utils.s3_client.head_bucket(Bucket=expected_bucket_name)
     assert bucket_exists, "Bucket does not exist"
 
@@ -242,7 +242,7 @@ async def test_bucket_enforces_encryption(
     the right key.
     """
     res = await client.get(
-        "/storage/info", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
+        "/storage/setup", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
     )
     assert res.status_code == 200, res.text
     storage_info = res.json()
@@ -291,7 +291,7 @@ async def test_delete_user_bucket(
 
     # Create the bucket if it doesn't exist
     res = await client.get(
-        "/storage/info", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
+        "/storage/setup", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
     )
     bucket_name = res.json()["bucket"]
 
@@ -331,7 +331,7 @@ async def test_delete_user_bucket_with_files(
 
     # Create the bucket if it doesn't exist
     res = await client.get(
-        "/storage/info", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
+        "/storage/setup", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
     )
     bucket_name = res.json()["bucket"]
 
@@ -416,7 +416,7 @@ async def test_delete_user_bucket_objects_with_existing_files(
 
     # Create the bucket if it doesn't exist
     res = await client.get(
-        "/storage/info", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
+        "/storage/setup", headers={"Authorization": f"bearer {TEST_USER_TOKEN}"}
     )
     bucket_name = res.json()["bucket"]