refactor: Further simplify secrets APIs via the enum for entities

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
eclipse-apoapsis · May 21, 2024 · e51f3e6 · e51f3e6
1 parent 1aa1216
commit e51f3e6
Show file tree

Hide file tree

Showing 15 changed files with 112 additions and 344 deletions.
diff --git a/core/src/main/kotlin/api/OrganizationsRoute.kt b/core/src/main/kotlin/api/OrganizationsRoute.kt
@@ -176,7 +176,8 @@ fun Route.organizations() = route("organizations") {
                 val orgId = call.requireIdParameter("organizationId")
                 val pagingOptions = call.pagingOptions(SortProperty("name", SortDirection.ASCENDING))
 
-                val secretsForOrganization = secretService.listForOrganization(orgId, pagingOptions.mapToModel())
+                val secretsForOrganization = secretService
+                    .listSecrets(Entity.ORGANIZATION, orgId, pagingOptions.mapToModel())
                 val pagedResponse = PagedResponse(
                     secretsForOrganization.map { it.mapToApi() },
                     pagingOptions
@@ -192,7 +193,7 @@ fun Route.organizations() = route("organizations") {
                     val organizationId = call.requireIdParameter("organizationId")
                     val secretName = call.requireParameter("secretName")
 
-                    secretService.getSecretByOrganizationIdAndName(organizationId, secretName)
+                    secretService.getSecret(Entity.ORGANIZATION, organizationId, secretName)
                         ?.let { call.respond(HttpStatusCode.OK, it.mapToApi()) }
                         ?: call.respond(HttpStatusCode.NotFound)
                 }
@@ -206,7 +207,8 @@ fun Route.organizations() = route("organizations") {
 
                     call.respond(
                         HttpStatusCode.OK,
-                        secretService.updateSecretByOrganizationAndName(
+                        secretService.updateSecret(
+                            Entity.ORGANIZATION,
                             organizationId,
                             secretName,
                             updateSecret.value.mapToModel(),
@@ -221,7 +223,7 @@ fun Route.organizations() = route("organizations") {
                     val organizationId = call.requireIdParameter("organizationId")
                     val secretName = call.requireParameter("secretName")
 
-                    secretService.deleteSecretByOrganizationAndName(organizationId, secretName)
+                    secretService.deleteSecret(Entity.ORGANIZATION, organizationId, secretName)
 
                     call.respond(HttpStatusCode.NoContent)
                 }

diff --git a/core/src/main/kotlin/api/ProductsRoute.kt b/core/src/main/kotlin/api/ProductsRoute.kt
@@ -139,7 +139,7 @@ fun Route.products() = route("products/{productId}") {
             val productId = call.requireIdParameter("productId")
             val pagingOptions = call.pagingOptions(SortProperty("name", SortDirection.ASCENDING))
 
-            val secretsForProduct = secretService.listForProduct(productId, pagingOptions.mapToModel())
+            val secretsForProduct = secretService.listSecrets(Entity.PRODUCT, productId, pagingOptions.mapToModel())
             val pagedResponse = PagedResponse(
                 secretsForProduct.map { it.mapToApi() },
                 pagingOptions
@@ -155,7 +155,7 @@ fun Route.products() = route("products/{productId}") {
                 val productId = call.requireIdParameter("productId")
                 val secretName = call.requireParameter("secretName")
 
-                secretService.getSecretByProductIdAndName(productId, secretName)
+                secretService.getSecret(Entity.PRODUCT, productId, secretName)
                     ?.let { call.respond(HttpStatusCode.OK, it.mapToApi()) }
                     ?: call.respond(HttpStatusCode.NotFound)
             }
@@ -169,7 +169,8 @@ fun Route.products() = route("products/{productId}") {
 
                 call.respond(
                     HttpStatusCode.OK,
-                    secretService.updateSecretByProductAndName(
+                    secretService.updateSecret(
+                        Entity.PRODUCT,
                         productId,
                         secretName,
                         updateSecret.value.mapToModel(),
@@ -184,7 +185,7 @@ fun Route.products() = route("products/{productId}") {
                 val productId = call.requireIdParameter("productId")
                 val secretName = call.requireParameter("secretName")
 
-                secretService.deleteSecretByProductAndName(productId, secretName)
+                secretService.deleteSecret(Entity.PRODUCT, productId, secretName)
 
                 call.respond(HttpStatusCode.NoContent)
             }

diff --git a/core/src/main/kotlin/api/RepositoriesRoute.kt b/core/src/main/kotlin/api/RepositoriesRoute.kt
@@ -168,7 +168,8 @@ fun Route.repositories() = route("repositories/{repositoryId}") {
             val repositoryId = call.requireIdParameter("repositoryId")
             val pagingOptions = call.pagingOptions(SortProperty("name", SortDirection.ASCENDING))
 
-            val secretsForRepository = secretService.listForRepository(repositoryId, pagingOptions.mapToModel())
+            val secretsForRepository = secretService
+                .listSecrets(Entity.REPOSITORY, repositoryId, pagingOptions.mapToModel())
             val pagedResponse = PagedResponse(
                 secretsForRepository.map { it.mapToApi() },
                 pagingOptions
@@ -184,7 +185,7 @@ fun Route.repositories() = route("repositories/{repositoryId}") {
                 val repositoryId = call.requireIdParameter("repositoryId")
                 val secretName = call.requireParameter("secretName")
 
-                secretService.getSecretByRepositoryIdAndName(repositoryId, secretName)
+                secretService.getSecret(Entity.REPOSITORY, repositoryId, secretName)
                     ?.let { call.respond(HttpStatusCode.OK, it.mapToApi()) }
                     ?: call.respond(HttpStatusCode.NotFound)
             }
@@ -198,7 +199,8 @@ fun Route.repositories() = route("repositories/{repositoryId}") {
 
                 call.respond(
                     HttpStatusCode.OK,
-                    secretService.updateSecretByRepositoryAndName(
+                    secretService.updateSecret(
+                        Entity.REPOSITORY,
                         repositoryId,
                         secretName,
                         updateSecret.value.mapToModel(),
@@ -213,7 +215,7 @@ fun Route.repositories() = route("repositories/{repositoryId}") {
                 val repositoryId = call.requireIdParameter("repositoryId")
                 val secretName = call.requireParameter("secretName")
 
-                secretService.deleteSecretByRepositoryAndName(repositoryId, secretName)
+                secretService.deleteSecret(Entity.REPOSITORY, repositoryId, secretName)
 
                 call.respond(HttpStatusCode.NoContent)
             }

diff --git a/core/src/test/kotlin/api/OrganizationsRouteIntegrationTest.kt b/core/src/test/kotlin/api/OrganizationsRouteIntegrationTest.kt
@@ -694,7 +694,7 @@ class OrganizationsRouteIntegrationTest : AbstractIntegrationTest({
                 response shouldHaveStatus HttpStatusCode.Created
                 response shouldHaveBody Secret(secret.name, secret.description)
 
-                secretRepository.getByOrganizationIdAndName(organizationId, secret.name)?.mapToApi() shouldBe
+                secretRepository.get(Entity.ORGANIZATION, organizationId, secret.name)?.mapToApi() shouldBe
                     Secret(secret.name, secret.description)
 
                 val provider = SecretsProviderFactoryForTesting.instance()
@@ -732,7 +732,7 @@ class OrganizationsRouteIntegrationTest : AbstractIntegrationTest({
                 body.message shouldBe "Request validation has failed."
                 body.cause shouldContain "Validation failed for CreateSecret"
 
-                secretRepository.getByOrganizationIdAndName(organizationId, secret.name)?.mapToApi().shouldBeNull()
+                secretRepository.get(Entity.ORGANIZATION, organizationId, secret.name)?.mapToApi().shouldBeNull()
 
                 val provider = SecretsProviderFactoryForTesting.instance()
                 provider.readSecret(Path("organization_${organizationId}_${secret.name}"))?.value.shouldBeNull()
@@ -767,7 +767,7 @@ class OrganizationsRouteIntegrationTest : AbstractIntegrationTest({
                 response shouldHaveStatus HttpStatusCode.OK
                 response shouldHaveBody Secret(secret.name, updatedDescription)
 
-                secretRepository.getByOrganizationIdAndName(organizationId, updateSecret.name.valueOrThrow)
+                secretRepository.get(Entity.ORGANIZATION, organizationId, updateSecret.name.valueOrThrow)
                     ?.mapToApi() shouldBe Secret(secret.name, updatedDescription)
             }
         }
@@ -800,7 +800,7 @@ class OrganizationsRouteIntegrationTest : AbstractIntegrationTest({
                     setBody(updateSecret)
                 } shouldHaveStatus HttpStatusCode.InternalServerError
 
-                secretRepository.getByOrganizationIdAndName(organizationId, secret.name) shouldBe secret
+                secretRepository.get(Entity.ORGANIZATION, organizationId, secret.name) shouldBe secret
             }
         }
 
@@ -825,7 +825,7 @@ class OrganizationsRouteIntegrationTest : AbstractIntegrationTest({
                 superuserClient.delete("/api/v1/organizations/$organizationId/secrets/${secret.name}") shouldHaveStatus
                         HttpStatusCode.NoContent
 
-                secretRepository.listForOrganization(organizationId) shouldBe emptyList()
+                secretRepository.list(Entity.ORGANIZATION, organizationId) shouldBe emptyList()
 
                 val provider = SecretsProviderFactoryForTesting.instance()
                 provider.readSecret(Path(secret.path)) should beNull()
@@ -868,7 +868,7 @@ class OrganizationsRouteIntegrationTest : AbstractIntegrationTest({
                 superuserClient.delete("/api/v1/organizations/$organizationId/secrets/${secret.name}") shouldHaveStatus
                         HttpStatusCode.InternalServerError
 
-                secretRepository.getByOrganizationIdAndName(organizationId, secret.name) shouldBe secret
+                secretRepository.get(Entity.ORGANIZATION, organizationId, secret.name) shouldBe secret
             }
         }
 

diff --git a/core/src/test/kotlin/api/ProductsRouteIntegrationTest.kt b/core/src/test/kotlin/api/ProductsRouteIntegrationTest.kt
@@ -482,7 +482,7 @@ class ProductsRouteIntegrationTest : AbstractIntegrationTest({
                 response shouldHaveStatus HttpStatusCode.Created
                 response shouldHaveBody Secret(secret.name, secret.description)
 
-                secretRepository.getByProductIdAndName(productId, secret.name)?.mapToApi() shouldBe
+                secretRepository.get(Entity.PRODUCT, productId, secret.name)?.mapToApi() shouldBe
                     Secret(secret.name, secret.description)
 
                 val provider = SecretsProviderFactoryForTesting.instance()
@@ -520,7 +520,7 @@ class ProductsRouteIntegrationTest : AbstractIntegrationTest({
                 body.message shouldBe "Request validation has failed."
                 body.cause shouldContain "Validation failed for CreateSecret"
 
-                secretRepository.getByProductIdAndName(productId, secret.name)?.mapToApi().shouldBeNull()
+                secretRepository.get(Entity.PRODUCT, productId, secret.name)?.mapToApi().shouldBeNull()
 
                 val provider = SecretsProviderFactoryForTesting.instance()
                 provider.readSecret(Path("product_${productId}_${secret.name}"))?.value shouldBe null
@@ -555,7 +555,7 @@ class ProductsRouteIntegrationTest : AbstractIntegrationTest({
                 response shouldHaveStatus HttpStatusCode.OK
                 response shouldHaveBody Secret(secret.name, updatedDescription)
 
-                secretRepository.getByProductIdAndName(productId, updateSecret.name.valueOrThrow)?.mapToApi() shouldBe
+                secretRepository.get(Entity.PRODUCT, productId, updateSecret.name.valueOrThrow)?.mapToApi() shouldBe
                         Secret(secret.name, updatedDescription)
             }
         }
@@ -588,7 +588,7 @@ class ProductsRouteIntegrationTest : AbstractIntegrationTest({
                     setBody(updateSecret)
                 } shouldHaveStatus HttpStatusCode.InternalServerError
 
-                secretRepository.getByProductIdAndName(productId, secret.name) shouldBe secret
+                secretRepository.get(Entity.PRODUCT, productId, secret.name) shouldBe secret
             }
         }
 
@@ -613,7 +613,7 @@ class ProductsRouteIntegrationTest : AbstractIntegrationTest({
                 superuserClient.delete("/api/v1/products/$productId/secrets/${secret.name}") shouldHaveStatus
                         HttpStatusCode.NoContent
 
-                secretRepository.listForProduct(productId) shouldBe emptyList()
+                secretRepository.list(Entity.PRODUCT, productId) shouldBe emptyList()
 
                 val provider = SecretsProviderFactoryForTesting.instance()
                 provider.readSecret(Path(secret.path)) should beNull()
@@ -655,7 +655,7 @@ class ProductsRouteIntegrationTest : AbstractIntegrationTest({
                 superuserClient.delete("/api/v1/products/$productId/secrets/${secret.name}") shouldHaveStatus
                         HttpStatusCode.InternalServerError
 
-                secretRepository.getByProductIdAndName(productId, secret.name) shouldBe secret
+                secretRepository.get(Entity.PRODUCT, productId, secret.name) shouldBe secret
             }
         }
 

diff --git a/core/src/test/kotlin/api/RepositoriesRouteIntegrationTest.kt b/core/src/test/kotlin/api/RepositoriesRouteIntegrationTest.kt
@@ -654,7 +654,7 @@ class RepositoriesRouteIntegrationTest : AbstractIntegrationTest({
                 response shouldHaveStatus HttpStatusCode.Created
                 response shouldHaveBody Secret(secret.name, secret.description)
 
-                secretRepository.getByRepositoryIdAndName(repositoryId, secret.name)?.mapToApi() shouldBe
+                secretRepository.get(Entity.REPOSITORY, repositoryId, secret.name)?.mapToApi() shouldBe
                     Secret(secret.name, secret.description)
 
                 val provider = SecretsProviderFactoryForTesting.instance()
@@ -703,7 +703,7 @@ class RepositoriesRouteIntegrationTest : AbstractIntegrationTest({
                 body.message shouldBe "Request validation has failed."
                 body.cause shouldContain "Validation failed for CreateSecret"
 
-                secretRepository.getByRepositoryIdAndName(repositoryId, secret.name)?.mapToApi().shouldBeNull()
+                secretRepository.get(Entity.REPOSITORY, repositoryId, secret.name)?.mapToApi().shouldBeNull()
 
                 val provider = SecretsProviderFactoryForTesting.instance()
                 provider.readSecret(Path("repository_${repositoryId}_${secret.name}"))?.value.shouldBeNull()
@@ -727,7 +727,7 @@ class RepositoriesRouteIntegrationTest : AbstractIntegrationTest({
                 response shouldHaveStatus HttpStatusCode.OK
                 response shouldHaveBody Secret(secret.name, updatedDescription)
 
-                secretRepository.getByRepositoryIdAndName(repositoryId, updateSecret.name.valueOrThrow)
+                secretRepository.get(Entity.REPOSITORY, repositoryId, updateSecret.name.valueOrThrow)
                     ?.mapToApi() shouldBe Secret(secret.name, updatedDescription)
             }
         }
@@ -760,7 +760,7 @@ class RepositoriesRouteIntegrationTest : AbstractIntegrationTest({
                     setBody(updateSecret)
                 } shouldHaveStatus HttpStatusCode.InternalServerError
 
-                secretRepository.getByRepositoryIdAndName(repositoryId, secret.name) shouldBe secret
+                secretRepository.get(Entity.REPOSITORY, repositoryId, secret.name) shouldBe secret
             }
         }
 
@@ -785,7 +785,7 @@ class RepositoriesRouteIntegrationTest : AbstractIntegrationTest({
                 superuserClient.delete("/api/v1/repositories/$repositoryId/secrets/${secret.name}") shouldHaveStatus
                         HttpStatusCode.NoContent
 
-                secretRepository.listForRepository(repositoryId) shouldBe emptyList()
+                secretRepository.list(Entity.REPOSITORY, repositoryId) shouldBe emptyList()
 
                 val provider = SecretsProviderFactoryForTesting.instance()
                 provider.readSecret(Path(secret.path)) should beNull()
@@ -800,7 +800,7 @@ class RepositoriesRouteIntegrationTest : AbstractIntegrationTest({
                 superuserClient.delete("/api/v1/repositories/$repositoryId/secrets/${secret.name}") shouldHaveStatus
                         HttpStatusCode.InternalServerError
 
-                secretRepository.getByRepositoryIdAndName(repositoryId, secret.name) shouldBe secret
+                secretRepository.get(Entity.REPOSITORY, repositoryId, secret.name) shouldBe secret
             }
         }