NGR-1175: adding declaration page and send data to backend (#94)

* NGR-1175: adding declaration page and send data to backend

* NGR-1175: adding tests

* NGR-1175: address PR bot

* NGR-1175: fix errors after rebased

---------

Co-authored-by: anna-shen-hmrc <[email protected]>

Author: anna-shen-hmrc

app/uk/gov/hmrc/ngrraldfrontend/connectors/NGRConnector.scala

@@ -16,13 +16,14 @@
 
 package uk.gov.hmrc.ngrraldfrontend.connectors
 
+import play.api.http.Status.CREATED
 import play.api.libs.json.Json
 import play.api.libs.ws.JsonBodyWritables.*
 import uk.gov.hmrc.http.HttpReads.Implicits.*
 import uk.gov.hmrc.http.client.HttpClientV2
-import uk.gov.hmrc.http.{HeaderCarrier, HttpReads, StringContextOps}
+import uk.gov.hmrc.http.{HeaderCarrier, HttpReads, HttpResponse, StringContextOps}
 import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
-import uk.gov.hmrc.ngrraldfrontend.models.PropertyLinkingUserAnswers
+import uk.gov.hmrc.ngrraldfrontend.models.{PropertyLinkingUserAnswers, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.vmvProperty.VMVProperty
 
@@ -54,4 +55,16 @@ class NGRConnector @Inject()(http: HttpClientV2,
         case None => None
       }
   }
+
+  def upsertRaldUserAnswers(model: UserAnswers)(implicit hc: HeaderCarrier):  Future[HttpResponse] = {
+    http.post(url("upsert-rald-user-answers"))
+      .withBody(Json.toJson(model))
+      .execute[HttpResponse]
+      .map { response =>
+        response.status match {
+          case CREATED => response
+          case _ => throw new Exception(s"${response.status}: ${response.body}")
+        }
+      }
+  }
 }

app/uk/gov/hmrc/ngrraldfrontend/controllers/AboutRepairsAndFittingOutController.scala

@@ -22,6 +22,7 @@ import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import uk.gov.hmrc.ngrraldfrontend.actions.{AuthRetrievals, DataRetrievalAction}
 import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AboutRepairsAndFittingOutForm
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{AboutRepairsAndFittingOut, Mode, NGRMonthYear, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.AboutRepairsAndFittingOutPage
@@ -48,7 +49,7 @@ class AboutRepairsAndFittingOutController @Inject()(
 
   def show(mode: Mode): Action[AnyContent] = (authenticate andThen getData).async { implicit request =>
     val preparedForm = request.userAnswers
-      .getOrElse(UserAnswers(request.credId))
+      .getOrElse(UserAnswers(CredId(request.credId)))
       .get(AboutRepairsAndFittingOutPage) match {
       case None => form
       case Some(value) =>
@@ -79,7 +80,7 @@ class AboutRepairsAndFittingOutController @Inject()(
 
         for {
           updatedAnswers <- Future.fromTry(
-            request.userAnswers.getOrElse(UserAnswers(request.credId))
+            request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
               .set(AboutRepairsAndFittingOutPage, updatedModel)
           )
           _ <- sessionRepository.set(updatedAnswers)

app/uk/gov/hmrc/ngrraldfrontend/controllers/AboutTheRentFreePeriodController.scala

@@ -25,7 +25,8 @@ import uk.gov.hmrc.ngrraldfrontend.actions.{AuthRetrievals, DataRetrievalAction}
 import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AboutTheRentFreePeriodForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AboutTheRentFreePeriodForm.form
-import uk.gov.hmrc.ngrraldfrontend.models.{Mode, AboutTheRentFreePeriod, NGRDate, UserAnswers}
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
+import uk.gov.hmrc.ngrraldfrontend.models.{AboutTheRentFreePeriod, Mode, NGRDate, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.AboutTheRentFreePeriodPage
 import uk.gov.hmrc.ngrraldfrontend.repo.SessionRepository
@@ -65,7 +66,7 @@ class AboutTheRentFreePeriodController @Inject()(aboutTheRentFreePeriodView: Abo
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(AboutTheRentFreePeriodPage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(AboutTheRentFreePeriodPage) match {
         case None => form
         case Some(value) => form.fill(AboutTheRentFreePeriodForm(value.months, NGRDate.fromString(value.date)))
       }
@@ -100,7 +101,7 @@ class AboutTheRentFreePeriodController @Inject()(aboutTheRentFreePeriodView: Abo
         howManyMonths =>
           val answers = AboutTheRentFreePeriod(howManyMonths.howManyMonths, howManyMonths.date.makeString)
           for {
-            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId)).set(AboutTheRentFreePeriodPage, answers))
+            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).set(AboutTheRentFreePeriodPage, answers))
             _ <- sessionRepository.set(updatedAnswers)
           } yield Redirect(navigator.nextPage(AboutTheRentFreePeriodPage, mode, updatedAnswers))
       )

app/uk/gov/hmrc/ngrraldfrontend/controllers/AgreedRentChangeController.scala

@@ -23,6 +23,7 @@ import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
 import uk.gov.hmrc.ngrraldfrontend.models.components.NGRRadio.{buildRadios, simpleNgrRadio}
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AgreedRentChangeForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AgreedRentChangeForm.form
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{Mode, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.AgreedRentChangePage
@@ -45,7 +46,7 @@ class AgreedRentChangeController @Inject()(agreedRentChangeView: AgreedRentChang
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(AgreedRentChangePage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(AgreedRentChangePage) match {
         case None => form
         case Some(value) => form.fill(AgreedRentChangeForm(value.toString))
       }
@@ -71,7 +72,7 @@ class AgreedRentChangeController @Inject()(agreedRentChangeView: AgreedRentChang
         },
         radioValue =>
           for {
-            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId))
+            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
               .set(AgreedRentChangePage, radioValue.radioValue.toBoolean))
             _ <- sessionRepository.set(updatedAnswers)
           } yield Redirect(navigator.nextPage(AgreedRentChangePage, mode, updatedAnswers))

app/uk/gov/hmrc/ngrraldfrontend/controllers/AgreementController.scala

@@ -24,6 +24,7 @@ import uk.gov.hmrc.ngrraldfrontend.models.components.*
 import uk.gov.hmrc.ngrraldfrontend.models.components.NGRRadio.buildRadios
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AgreementForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AgreementForm.{answerToForm, form, formToAnswers}
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{Agreement, Mode, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.AgreementPage
@@ -49,7 +50,7 @@ class AgreementController @Inject()(view: AgreementView,
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(AgreementPage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(AgreementPage) match {
         case None => form
         case Some(value) => answerToForm(value)
       }
@@ -91,7 +92,7 @@ class AgreementController @Inject()(view: AgreementView,
             ))),
           agreementForm =>
             for {
-              updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId))
+              updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
                 .set(AgreementPage, formToAnswers(agreementForm)))
               _ <- sessionRepository.set(updatedAnswers)
             } yield Redirect(navigator.nextPage(AgreementPage, mode, updatedAnswers))

app/uk/gov/hmrc/ngrraldfrontend/controllers/AgreementVerbalController.scala

@@ -29,6 +29,7 @@ import uk.gov.hmrc.ngrraldfrontend.models.components.*
 import uk.gov.hmrc.ngrraldfrontend.models.components.NGRRadio.buildRadios
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AgreementVerbalForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.AgreementVerbalForm.{agreementVerbalRadio, answerToForm, form, formToAnswers}
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{AgreementVerbal, Mode, NGRDate, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.AgreementVerbalPage
@@ -54,7 +55,7 @@ class AgreementVerbalController @Inject()(view: AgreementVerbalView,
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(AgreementVerbalPage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(AgreementVerbalPage) match {
         case None => form
         case Some(value) => answerToForm(value)
       }
@@ -90,7 +91,7 @@ class AgreementVerbalController @Inject()(view: AgreementVerbalView,
             ),
           agreementVerbalForm =>
             for {
-              updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId))
+              updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
                 .set(AgreementVerbalPage, formToAnswers(agreementVerbalForm)))
               _ <- sessionRepository.set(updatedAnswers)
             } yield Redirect(navigator.nextPage(AgreementVerbalPage, mode, updatedAnswers))

app/uk/gov/hmrc/ngrraldfrontend/controllers/CheckRentFreePeriodController.scala

@@ -23,6 +23,7 @@ import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
 import uk.gov.hmrc.ngrraldfrontend.models.components.NGRRadio.{buildRadios, simpleNgrRadio}
 import uk.gov.hmrc.ngrraldfrontend.models.forms.CheckRentFreePeriodForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.CheckRentFreePeriodForm.form
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{Mode, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.CheckRentFreePeriodPage
@@ -44,7 +45,7 @@ class CheckRentFreePeriodController @Inject()(checkRentFreePeriodView: CheckRent
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(CheckRentFreePeriodPage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(CheckRentFreePeriodPage) match {
         case None => form
         case Some(value) => form.fill(CheckRentFreePeriodForm(value.toString))
       }
@@ -70,7 +71,7 @@ class CheckRentFreePeriodController @Inject()(checkRentFreePeriodView: CheckRent
         },
         radioValue =>
           for {
-            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId))
+            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
               .set(CheckRentFreePeriodPage, radioValue.radioValue.toBoolean))
             _ <- sessionRepository.set(updatedAnswers)
           } yield Redirect(navigator.nextPage(CheckRentFreePeriodPage, mode, updatedAnswers))

app/uk/gov/hmrc/ngrraldfrontend/controllers/ConfirmBreakClauseController.scala

@@ -23,6 +23,7 @@ import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
 import uk.gov.hmrc.ngrraldfrontend.models.components.NGRRadio.{buildRadios, simpleNgrRadio}
 import uk.gov.hmrc.ngrraldfrontend.models.forms.ConfirmBreakClauseForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.ConfirmBreakClauseForm.form
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{Mode, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.ConfirmBreakClausePage
@@ -44,7 +45,7 @@ class ConfirmBreakClauseController  @Inject()(confirmBreakClauseView: ConfirmBre
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(ConfirmBreakClausePage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(ConfirmBreakClausePage) match {
         case None => form
         case Some(value) => form.fill(ConfirmBreakClauseForm(value.toString))
       }
@@ -70,7 +71,7 @@ class ConfirmBreakClauseController  @Inject()(confirmBreakClauseView: ConfirmBre
         },
         radioValue =>
           for {
-            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId))
+            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
               .set(ConfirmBreakClausePage, radioValue.radioValue.toBoolean))
             _ <- sessionRepository.set(updatedAnswers)
           } yield Redirect(navigator.nextPage(ConfirmBreakClausePage, mode, updatedAnswers))

app/uk/gov/hmrc/ngrraldfrontend/controllers/DeclarationController.scala

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2025 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.ngrraldfrontend.controllers
+
+import play.api.i18n.I18nSupport
+import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
+import uk.gov.hmrc.ngrraldfrontend.actions.{AuthRetrievals, DataRetrievalAction}
+import uk.gov.hmrc.ngrraldfrontend.config.AppConfig
+import uk.gov.hmrc.ngrraldfrontend.connectors.NGRConnector
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
+import uk.gov.hmrc.ngrraldfrontend.models.{NormalMode, UserAnswers}
+import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
+import uk.gov.hmrc.ngrraldfrontend.pages.DeclarationPage
+import uk.gov.hmrc.ngrraldfrontend.repo.SessionRepository
+import uk.gov.hmrc.ngrraldfrontend.utils.UniqueIdGenerator
+import uk.gov.hmrc.ngrraldfrontend.views.html.DeclarationView
+import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendController
+
+import javax.inject.{Inject, Singleton}
+import scala.concurrent.{ExecutionContext, Future}
+
+@Singleton
+class DeclarationController @Inject()(declarationView: DeclarationView,
+                                      authenticate: AuthRetrievals,
+                                      getData: DataRetrievalAction,
+                                      navigator: Navigator,
+                                      sessionRepository: SessionRepository,
+                                      ngrConnector: NGRConnector,
+                                      mcc: MessagesControllerComponents)(implicit appConfig: AppConfig, ec: ExecutionContext)
+  extends FrontendController(mcc) with I18nSupport {
+
+  def show: Action[AnyContent] = {
+    (authenticate andThen getData).async { implicit request =>
+      Future.successful(Ok(declarationView()))
+    }
+  }
+
+  def submit: Action[AnyContent] =
+    (authenticate andThen getData).async { implicit request =>
+      for {
+        updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
+          .set(DeclarationPage, UniqueIdGenerator.generateId)
+        )
+        result <- sessionRepository.set(updatedAnswers).flatMap {
+          case true =>
+            ngrConnector.upsertRaldUserAnswers(updatedAnswers).flatMap(
+              _.status match
+                case CREATED => Future.successful(Redirect(navigator.nextPage(DeclarationPage, NormalMode, updatedAnswers)))
+                case _       => Future.failed(new Exception(s"Failed upsert to backend for credId: ${request.credId}"))
+          )
+          case _ => Future.failed(new Exception(s"Could not save reference for credId: ${request.credId}"))
+        }
+      } yield result
+    }
+}

app/uk/gov/hmrc/ngrraldfrontend/controllers/DidYouAgreeRentWithLandlordController.scala

@@ -24,6 +24,7 @@ import uk.gov.hmrc.ngrraldfrontend.models.components.*
 import uk.gov.hmrc.ngrraldfrontend.models.components.NGRRadio.buildRadios
 import uk.gov.hmrc.ngrraldfrontend.models.forms.DidYouAgreeRentWithLandlordForm
 import uk.gov.hmrc.ngrraldfrontend.models.forms.DidYouAgreeRentWithLandlordForm.form
+import uk.gov.hmrc.ngrraldfrontend.models.registration.CredId
 import uk.gov.hmrc.ngrraldfrontend.models.{Mode, UserAnswers}
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.DidYouAgreeRentWithLandlordPage
@@ -46,7 +47,7 @@ class DidYouAgreeRentWithLandlordController @Inject()(didYouAgreeRentWithLandlor
 
   def show(mode: Mode): Action[AnyContent] = {
     (authenticate andThen getData).async { implicit request =>
-      val preparedForm = request.userAnswers.getOrElse(UserAnswers(request.credId)).get(DidYouAgreeRentWithLandlordPage) match {
+      val preparedForm = request.userAnswers.getOrElse(UserAnswers(CredId(request.credId))).get(DidYouAgreeRentWithLandlordPage) match {
         case None => form
         case Some(value) => form.fill(DidYouAgreeRentWithLandlordForm(value.toString))
       }
@@ -72,7 +73,7 @@ class DidYouAgreeRentWithLandlordController @Inject()(didYouAgreeRentWithLandlor
         },
         radioValue =>
           for {
-            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(request.credId))
+            updatedAnswers <- Future.fromTry(request.userAnswers.getOrElse(UserAnswers(CredId(request.credId)))
               .set(DidYouAgreeRentWithLandlordPage, radioValue.radioValue.toBoolean))
             _ <- sessionRepository.set(updatedAnswers)
           } yield Redirect(navigator.nextPage(DidYouAgreeRentWithLandlordPage, mode, updatedAnswers))