DMP-5257 Create new endpoint GET /admin/reports (#3079)

Author: karen-hedges

src/integrationTest/java/uk/gov/hmcts/darts/reports/controller/ReportsControllerGetAdminReportsIntTest.java

@@ -0,0 +1,60 @@
+package uk.gov.hmcts.darts.reports.controller;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.skyscreamer.jsonassert.JSONCompareMode;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+import uk.gov.hmcts.darts.common.enums.SecurityRoleEnum;
+import uk.gov.hmcts.darts.testutils.GivenBuilder;
+import uk.gov.hmcts.darts.testutils.IntegrationBase;
+
+import static org.junit.jupiter.params.provider.EnumSource.Mode.EXCLUDE;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@AutoConfigureMockMvc
+class ReportsControllerGetAdminReportsIntTest extends IntegrationBase {
+
+    private static final String ENDPOINT_URL = "/admin/reports";
+
+    @Autowired
+    private transient MockMvc mockMvc;
+    @Autowired
+    private GivenBuilder given;
+
+    @ParameterizedTest
+    @EnumSource(value = SecurityRoleEnum.class, names = {"SUPER_ADMIN", "SUPER_USER"}, mode = EnumSource.Mode.INCLUDE)
+    void getReportsAdmin_shouldReturn501Error_NotYetImplemented(SecurityRoleEnum role) throws Exception {
+
+        given.anAuthenticatedUserWithGlobalAccessAndRole(role);
+
+        mockMvc.perform(MockMvcRequestBuilders.get(ENDPOINT_URL))
+            .andExpect(status().isNotImplemented())
+            .andReturn();
+
+    }
+
+    @ParameterizedTest
+    @EnumSource(value = SecurityRoleEnum.class, names = {"SUPER_ADMIN", "SUPER_USER"}, mode = EXCLUDE)
+    void getReportsAdmin_shouldReturnForbidden_ForNotAuthorisedUsers(SecurityRoleEnum role) throws Exception {
+        given.anAuthenticatedUserWithGlobalAccessAndRole(role);
+
+        MvcResult mvcResult = mockMvc.perform(MockMvcRequestBuilders.get(ENDPOINT_URL))
+            .andExpect(status().isForbidden())
+            .andReturn();
+
+        var jsonString = mvcResult.getResponse().getContentAsString();
+        JSONAssert.assertEquals(
+            """
+                {
+                  "type": "AUTHORISATION_109",
+                  "title": "User is not authorised for this endpoint",
+                  "status": 403
+                }
+                """, jsonString, JSONCompareMode.STRICT);
+    }
+}

src/main/java/uk/gov/hmcts/darts/reports/controller/ReportsController.java

@@ -0,0 +1,35 @@
+package uk.gov.hmcts.darts.reports.controller;
+
+
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RestController;
+import uk.gov.hmcts.darts.authorisation.annotation.Authorisation;
+import uk.gov.hmcts.darts.reports.http.api.ReportsApi;
+import uk.gov.hmcts.darts.reports.model.AdminReportsResponseItem;
+import uk.gov.hmcts.darts.reports.service.ReportsAdminService;
+
+import static uk.gov.hmcts.darts.authorisation.constants.AuthorisationConstants.SECURITY_SCHEMES_BEARER_AUTH;
+import static uk.gov.hmcts.darts.authorisation.enums.ContextIdEnum.ANY_ENTITY_ID;
+import static uk.gov.hmcts.darts.common.enums.SecurityRoleEnum.SUPER_ADMIN;
+import static uk.gov.hmcts.darts.common.enums.SecurityRoleEnum.SUPER_USER;
+
+@RestController
+@RequiredArgsConstructor
+@ConditionalOnProperty(prefix = "darts", name = "api-pod", havingValue = "true")
+public class ReportsController implements ReportsApi {
+
+    private final ReportsAdminService reportsAdminService;
+
+    @Override
+    @SecurityRequirement(name = SECURITY_SCHEMES_BEARER_AUTH)
+    @Authorisation(contextId = ANY_ENTITY_ID,
+        globalAccessSecurityRoles = {SUPER_ADMIN, SUPER_USER})
+    public ResponseEntity<AdminReportsResponseItem> getAdminReports() {
+        reportsAdminService.getAdminReports();
+        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
+    }
+}

src/main/java/uk/gov/hmcts/darts/reports/service/ReportsAdminService.java

@@ -0,0 +1,10 @@
+package uk.gov.hmcts.darts.reports.service;
+
+import uk.gov.hmcts.darts.reports.model.AdminReportsResponseItem;
+
+@FunctionalInterface
+public interface ReportsAdminService {
+
+    AdminReportsResponseItem getAdminReports();
+
+}

src/main/java/uk/gov/hmcts/darts/reports/service/impl/ReportsAdminServiceImpl.java

@@ -0,0 +1,19 @@
+package uk.gov.hmcts.darts.reports.service.impl;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import uk.gov.hmcts.darts.reports.model.AdminReportsResponseItem;
+import uk.gov.hmcts.darts.reports.service.ReportsAdminService;
+
+@Service
+@RequiredArgsConstructor
+@Slf4j
+public class ReportsAdminServiceImpl implements ReportsAdminService {
+
+    @Override
+    public AdminReportsResponseItem getAdminReports() {
+        return null;
+    }
+
+}

src/main/resources/openapi/reports.yaml

@@ -0,0 +1,51 @@
+openapi: 3.0.1
+
+info:
+
+  version: ${version}
+  title: Modernised DARTS
+  description: |-
+    Modernised DARTS (Digital Audio Recording and Transcription Service).
+
+servers:
+  - url: http://localhost:4550/
+
+paths:
+  /admin/reports:
+    get:
+      tags:
+        - Reports
+      summary: Get admin reports
+      operationId: getAdminReports
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdminReportsResponseItem'
+        '403':
+          description: Forbidden Error
+          content:
+            application/json+problem:
+              schema:
+                $ref: './problem.yaml'
+
+components:
+  schemas:
+
+    AdminReportsResponseItem:
+      type: object
+      properties:
+        reports:
+          type: array
+          items:
+            $ref: '#/components/schemas/Report'
+
+    Report:
+      type: object
+      properties:
+        reportName:
+          type: string
+          example: "Monthly Report"
+

src/test/java/uk/gov/hmcts/darts/reports/service/impl/ReportsAdminServiceImplTest.java

@@ -0,0 +1,14 @@
+package uk.gov.hmcts.darts.reports.service.impl;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class ReportsAdminServiceImplTest {
+
+    @Test
+    void getAdminReports() {
+        ReportsAdminServiceImpl reportsAdminService = new ReportsAdminServiceImpl();
+        assertNull(reportsAdminService.getAdminReports());
+    }
+}