DT-1130: API to return resources created by a billing profile (#1880)

* Add API to return all resources linked to a billing profile
* migrate profile controller test to use WebMvcTest

Author: pshapiro4broad

build.gradle

@@ -214,6 +214,7 @@ dependencies {
 
     implementation 'com.squareup.okhttp3:okhttp'
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
+    implementation 'org.springframework.hateoas:spring-hateoas'
     implementation 'io.micrometer:micrometer-registry-prometheus'
 
     implementation 'com.fasterxml.jackson.core:jackson-core'

src/main/java/bio/terra/app/configuration/ApplicationConfiguration.java

@@ -389,6 +389,8 @@ public NamedParameterJdbcTemplate synapseJdbcTemplate(
     return new NamedParameterJdbcTemplate(ds);
   }
 
+  // Use Primary to fix an issue with unqualified ObjectMapper injections in spring-hateoas.
+  @Primary
   @Bean("objectMapper")
   public ObjectMapper objectMapper() {
     return new ObjectMapper()

src/main/java/bio/terra/service/auth/iam/IamAction.java

@@ -48,6 +48,7 @@ public enum IamAction {
   // billing profiles
   UPDATE_BILLING_ACCOUNT,
   LINK,
+  READ_SPEND_REPORT,
   // journal
   VIEW_JOURNAL,
   // lock/unlock resources

src/main/java/bio/terra/service/profile/ProfileApiController.java

@@ -11,6 +11,7 @@
 import bio.terra.model.BillingProfileRequestModel;
 import bio.terra.model.BillingProfileUpdateModel;
 import bio.terra.model.EnumerateBillingProfileModel;
+import bio.terra.model.EnumerateBillingProfileResourcesModel;
 import bio.terra.model.JobModel;
 import bio.terra.model.PolicyMemberRequest;
 import bio.terra.model.PolicyModel;
@@ -20,13 +21,11 @@
 import bio.terra.service.auth.iam.IamService;
 import bio.terra.service.auth.iam.PolicyMemberValidator;
 import bio.terra.service.job.JobService;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.annotations.Api;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.validation.Valid;
 import java.util.Collections;
 import java.util.List;
-import java.util.Optional;
 import java.util.UUID;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -42,7 +41,6 @@
 @Api(tags = {"profiles"})
 public class ProfileApiController implements ProfilesApi {
 
-  private final ObjectMapper objectMapper;
   private final HttpServletRequest request;
   private final ProfileService profileService;
   private final ProfileRequestValidator billingProfileRequestValidator;
@@ -56,7 +54,6 @@ public class ProfileApiController implements ProfilesApi {
 
   @Autowired
   public ProfileApiController(
-      ObjectMapper objectMapper,
       HttpServletRequest request,
       ProfileService profileService,
       ProfileRequestValidator billingProfileRequestValidator,
@@ -66,7 +63,6 @@ public ProfileApiController(
       AuthenticatedUserRequestFactory authenticatedUserRequestFactory,
       IamService iamService,
       ApplicationConfiguration applicationConfiguration) {
-    this.objectMapper = objectMapper;
     this.request = request;
     this.profileService = profileService;
     this.billingProfileRequestValidator = billingProfileRequestValidator;
@@ -78,16 +74,6 @@ public ProfileApiController(
     this.applicationConfiguration = applicationConfiguration;
   }
 
-  @Override
-  public Optional<ObjectMapper> getObjectMapper() {
-    return Optional.ofNullable(objectMapper);
-  }
-
-  @Override
-  public Optional<HttpServletRequest> getRequest() {
-    return Optional.ofNullable(request);
-  }
-
   @InitBinder
   protected void initBinder(final WebDataBinder binder) {
     binder.addValidators(profileUpdateRequestValidator);
@@ -199,4 +185,14 @@ private void verifyAuthorization(
     // Verify permissions
     iamService.verifyAuthorization(userReq, resourceType, resourceId, action);
   }
+
+  @Override
+  public ResponseEntity<EnumerateBillingProfileResourcesModel> getProfileResources(UUID id) {
+    AuthenticatedUserRequest user = authenticatedUserRequestFactory.from(request);
+    var resources =
+        profileService.getProfileResources(id, user).stream()
+            .map(ProfileOwnedResource::toModel)
+            .toList();
+    return ResponseEntity.ok(new EnumerateBillingProfileResourcesModel().items(resources));
+  }
 }

src/main/java/bio/terra/service/profile/ProfileOwnedResource.java

@@ -1,5 +1,6 @@
 package bio.terra.service.profile;
 
+import bio.terra.model.ProfileOwnedResourceModel;
 import java.time.Instant;
 import java.util.UUID;
 
@@ -9,4 +10,16 @@ public enum Type {
     DATASET,
     SNAPSHOT,
   }
+
+  public ProfileOwnedResourceModel toModel() {
+    return new ProfileOwnedResourceModel()
+        .id(id)
+        .name(name)
+        .description(description)
+        .createdDate(createdDate.toString())
+        .type(
+            Type.DATASET == type
+                ? ProfileOwnedResourceModel.TypeEnum.DATASET
+                : ProfileOwnedResourceModel.TypeEnum.SNAPSHOT);
+  }
 }

src/main/java/bio/terra/service/profile/ProfileService.java

@@ -303,4 +303,11 @@ public void verifyDeployedApplication(
               + "operation");
     }
   }
+
+  public List<ProfileOwnedResource> getProfileResources(
+      UUID profileId, AuthenticatedUserRequest user) {
+    iamService.verifyAuthorization(
+        user, IamResourceType.SPEND_PROFILE, profileId.toString(), IamAction.READ_SPEND_REPORT);
+    return profileDao.listProfileOwnedResources(profileId);
+  }
 }

src/main/resources/api/data-repository-openapi.yaml

@@ -520,6 +520,42 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorModel'
 
+  /api/resources/v1/profiles/{id}/resources:
+    get:
+      tags:
+        - profiles
+        - resources
+      description: >
+        Given a profile ID, return the resources associated with that profile.
+      operationId: getProfileResources
+      parameters:
+        - $ref: '#/components/parameters/Id'
+      responses:
+        200:
+          description: List of resources
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnumerateBillingProfileResourcesModel'
+        400:
+          description: Bad request - invalid id, badly formed
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorModel'
+        403:
+          description: No permission to retreive resources
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorModel'
+        404:
+          description: Not found - profile id does not exist
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorModel'
+
   /api/repository/v1/snapshots:
     get:
       tags:
@@ -5242,6 +5278,33 @@ components:
             $ref: '#/components/schemas/BillingProfileModel'
       description: >
         The total number of billing profiles available and a page of profiles
+    EnumerateBillingProfileResourcesModel:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/ProfileOwnedResourceModel'
+      description: >
+        The resources created using this billing profile
+    ProfileOwnedResourceModel:
+      type: object
+      properties:
+        id:
+          $ref: '#/components/schemas/UniqueIdProperty'
+        name:
+          type: string
+          description: Name of the resource
+        description:
+          type: string
+          description: Description of the resource
+        createdDate:
+          type: string
+          description: Date the resource was created
+        type:
+          type: string
+          description: Type of the resource
+          enum: [ DATASET, SNAPSHOT ]
     DatasetModel:
       type: object
       properties: