Rename role endpoints to include

Author: tomwatkins1994

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/AuthorisationFilter.kt

@@ -52,19 +52,19 @@ class AuthorisationFilter
       }
 
       val consumersRoles = consumerConfig?.roles
-      val roleEndpoints =
+      val roleIncludes =
         buildList {
           for (consumerRole in consumersRoles.orEmpty()) {
             for (role in rolesConfig.roles) {
               if (role.name == consumerRole) {
-                addAll(role.endpoints)
+                addAll(role.includes)
               }
             }
           }
         }
 
       val roleResult =
-        authoriseConsumerService.doesConsumerHaveRoleAccess(roleEndpoints, requestedPath)
+        authoriseConsumerService.doesConsumerHaveRoleAccess(roleIncludes, requestedPath)
       if (!roleResult) {
         res.sendError(HttpServletResponse.SC_FORBIDDEN, "Unable to authorise $requestedPath for $subjectDistinguishedName")
         return

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/roleconfig/Role.kt

@@ -2,5 +2,5 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.roleconfig
 
 data class Role(
   val name: String,
-  val endpoints: List<String>,
+  val includes: List<String>,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/internal/AuthoriseConsumerService.kt

@@ -20,10 +20,10 @@ class AuthoriseConsumerService {
   }
 
   fun doesConsumerHaveRoleAccess(
-    consumerRolesConfigPaths: List<String>?,
+    consumerRolesInclude: List<String>,
     requestPath: String,
   ): Boolean {
-    consumerRolesConfigPaths?.forEach {
+    consumerRolesInclude.forEach {
       if (Regex(it).matches(requestPath)) {
         return true
       }

src/main/resources/roles.yml

@@ -1,5 +1,5 @@
 data:
   roles:
     - name: "private-prison"
-      endpoints:
+      includes:
         - "/v1/persons/[^/]*$"

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/internal/AuthoriseConsumerServiceTest.kt

@@ -42,12 +42,12 @@ internal class AuthoriseConsumerServiceTest(
       }
 
       describe("doesConsumerHaveRoleAccess") {
-        val consumerRolesConfigPaths = listOf("/persons/.*")
+        val consumerRolesInclude = listOf("/persons/.*")
 
         it("access is allowed when the path is listed in the role included paths") {
           val authResult =
             authoriseConsumerService.doesConsumerHaveRoleAccess(
-              consumerRolesConfigPaths,
+              consumerRolesInclude,
               requestedPath,
             )
           authResult.shouldBeTrue()
@@ -60,7 +60,7 @@ internal class AuthoriseConsumerServiceTest(
 
         it("when the path isn't listed as allowed on the consumer") {
           val invalidPath = "/some-other-path/123"
-          val result = authoriseConsumerService.doesConsumerHaveRoleAccess(consumerRolesConfigPaths, invalidPath)
+          val result = authoriseConsumerService.doesConsumerHaveRoleAccess(consumerRolesInclude, invalidPath)
           result.shouldBeFalse()
         }
       }