Merge pull request #13 from hmrc/hipp-1429

HIPP-1429: Add egressPrefix & prefixesToRemove fields to Update form

Author: PaulCDurham

app/uk/gov/hmrc/simpleapideploymentstubs/controllers/SimpleAPiDeploymentController.scala

@@ -24,7 +24,7 @@ import play.api.libs.Files
 import play.api.libs.json.{JsValue, Json}
 import play.api.mvc.{Action, AnyContent, ControllerComponents, MultipartFormData}
 import uk.gov.hmrc.play.bootstrap.backend.controller.BackendController
-import uk.gov.hmrc.simpleapideploymentstubs.models.{CreateMetadata, DeploymentFrom, DeploymentResponse, DeploymentsResponse, FailuresResponse, UpdateMetadata}
+import uk.gov.hmrc.simpleapideploymentstubs.models.{CreateMetadata, DeploymentFrom, DeploymentResponse, DeploymentsResponse, DetailsResponse, FailuresResponse, UpdateMetadata}
 
 @Singleton
 class SimpleAPiDeploymentController @Inject()(cc: ControllerComponents) extends BackendController(cc) with Logging {
@@ -100,4 +100,8 @@ class SimpleAPiDeploymentController @Inject()(cc: ControllerComponents) extends
       )
   }
 
+  def getDeploymentDetails(serviceId: String): Action[AnyContent] = Action {
+    Ok(Json.toJson(DetailsResponse.cannedResponse))
+  }
+
 }

app/uk/gov/hmrc/simpleapideploymentstubs/models/CreateMetadata.scala

@@ -28,8 +28,8 @@ case class CreateMetadata(
   domain: Option[String] = None,
   subdomain: Option[String] = None,
   backends: Seq[String] = Seq.empty,
-  prefixesToRemove: Seq[String],
-  egressPrefix: String
+  prefixestoremove: Seq[String],
+  egressprefix: String
 )
 
 object CreateMetadata {

app/uk/gov/hmrc/simpleapideploymentstubs/models/DetailsResponse.scala

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2024 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.simpleapideploymentstubs.models
+
+import play.api.libs.json.{Format, Json}
+
+case class DetailsResponse(
+  description: String,
+  status: String,
+  domain: String,
+  subdomain: String,
+  backends: Seq[String],
+  egressprefix: String,
+  prefixestoremove: Seq[String]
+)
+
+object DetailsResponse {
+
+  val cannedResponse: DetailsResponse = DetailsResponse(
+    description = "A short description of the API",
+    status = "ALPHA",
+    domain = "8",
+    subdomain = "8.1",
+    backends = Seq("NPS"),
+    egressprefix = "/prefix",
+    prefixestoremove = Seq("/v1")
+  )
+
+  implicit val formatDetailsResponse: Format[DetailsResponse] = Json.format[DetailsResponse]
+
+}

app/uk/gov/hmrc/simpleapideploymentstubs/models/UpdateMetadata.scala

@@ -23,7 +23,9 @@ case class UpdateMetadata(
   status: String,
   domain: Option[String] = None,
   subdomain: Option[String] = None,
-  backends: Seq[String] = Seq.empty
+  backends: Seq[String] = Seq.empty,
+  prefixestoremove: Seq[String],
+  egressprefix: String
 )
 
 object UpdateMetadata {

conf/app.routes

@@ -2,6 +2,7 @@
 
 POST    /v1/simple-api-deployment/validate                  uk.gov.hmrc.simpleapideploymentstubs.controllers.SimpleAPiDeploymentController.validate()
 POST    /v1/simple-api-deployment/deployments               uk.gov.hmrc.simpleapideploymentstubs.controllers.SimpleAPiDeploymentController.create()
+GET     /v1/simple-api-deployment/deployments/:serviceId    uk.gov.hmrc.simpleapideploymentstubs.controllers.SimpleAPiDeploymentController.getDeploymentDetails(serviceId: String)
 PUT     /v1/simple-api-deployment/deployments/:serviceId    uk.gov.hmrc.simpleapideploymentstubs.controllers.SimpleAPiDeploymentController.update(serviceId: String)
 PUT     /v1/simple-api-deployment/deployment-from           uk.gov.hmrc.simpleapideploymentstubs.controllers.SimpleAPiDeploymentController.deploymentFrom()
 GET     /v1/oas-deployments/:publisherReference             uk.gov.hmrc.simpleapideploymentstubs.controllers.SimpleAPiDeploymentController.deployment(publisherReference: String)

test/uk/gov/hmrc/simpleapideploymentstubs/controllers/SimpleAPiDeploymentControllerSpec.scala

@@ -25,7 +25,7 @@ import play.api.libs.json.Json
 import play.api.mvc.MultipartFormData
 import play.api.test.FakeRequest
 import play.api.test.Helpers._
-import uk.gov.hmrc.simpleapideploymentstubs.models.{CreateMetadata, DeploymentFrom, DeploymentsResponse, FailuresResponse, UpdateMetadata}
+import uk.gov.hmrc.simpleapideploymentstubs.models.{CreateMetadata, DeploymentFrom, DeploymentsResponse, DetailsResponse, FailuresResponse, UpdateMetadata}
 
 class SimpleAPiDeploymentControllerSpec extends AnyFreeSpec with Matchers with OptionValues {
 
@@ -69,8 +69,8 @@ class SimpleAPiDeploymentControllerSpec extends AnyFreeSpec with Matchers with O
         name = "test-name",
         description = "test-description",
         egress = "test-egress",
-        prefixesToRemove = Seq("test-prefix-1"),
-        egressPrefix = ""
+        prefixestoremove = Seq("test-prefix-1"),
+        egressprefix = ""
       )
 
       running(application) {
@@ -101,8 +101,8 @@ class SimpleAPiDeploymentControllerSpec extends AnyFreeSpec with Matchers with O
         name = "test-name",
         description = "test-description",
         egress = "test-egress",
-        prefixesToRemove = Seq("test-prefix-1"),
-        egressPrefix = ""
+        prefixestoremove = Seq("test-prefix-1"),
+        egressprefix = ""
       )
 
       running(application) {
@@ -156,7 +156,9 @@ class SimpleAPiDeploymentControllerSpec extends AnyFreeSpec with Matchers with O
 
       val metadata = UpdateMetadata(
         description = "test-description",
-        status = "test-status"
+        status = "test-status",
+        prefixestoremove = Seq("test-prefix-1", "test-prefix-2"),
+        egressprefix = "test-egress-prefix"
       )
 
       running(application) {
@@ -186,7 +188,9 @@ class SimpleAPiDeploymentControllerSpec extends AnyFreeSpec with Matchers with O
 
       val metadata = UpdateMetadata(
         description = "test-description",
-        status = "test-status"
+        status = "test-status",
+        prefixestoremove = Seq("test-prefix-1", "test-prefix-2"),
+        egressprefix = "test-egress-prefix"
       )
 
       running(application) {
@@ -280,6 +284,20 @@ class SimpleAPiDeploymentControllerSpec extends AnyFreeSpec with Matchers with O
     }
   }
 
+  "getDeploymentDetails" - {
+    "must return 200 Ok can a DetailsResponse" in {
+      val application = buildApplication()
+
+      running(application) {
+        val request = FakeRequest(routes.SimpleAPiDeploymentController.getDeploymentDetails("test-service-id"))
+        val result = route(application, request).value
+
+        status(result) mustBe OK
+        contentAsJson(result) mustBe Json.toJson(DetailsResponse.cannedResponse)
+      }
+    }
+  }
+
   private def buildApplication(): Application = {
     GuiceApplicationBuilder()
       .build()