Merge pull request #159 from hmrc/VOA-3635_AutoBARS_HttpClientV2-used-in-EbarsClientV2

Stephen-Goddard · web-flow · commit 7157e7233b9a · 2026-01-16T11:46:36.000Z
VOA-3635 AutoBARS: `HttpClientV2` used in `EbarsClientV2`
diff --git a/app/uk/gov/hmrc/voabar/services/EbarsClientV2.scala b/app/uk/gov/hmrc/voabar/services/EbarsClientV2.scala
@@ -16,82 +16,60 @@
 
 package uk.gov.hmrc.voabar.services
 
-import org.apache.pekko.stream.Materializer
-import play.api.http.Status
-import play.api.libs.ws.ahc.{AhcConfigBuilder, AhcWSClient, StandaloneAhcWSClient}
-import play.api.libs.ws.{WSAuthScheme, WSClient, WSResponse, writeableOf_urlEncodedForm}
-import play.api.{Configuration, Logging}
-import play.shaded.ahc.org.asynchttpclient.proxy.{ProxyServer, ProxyType}
-import play.shaded.ahc.org.asynchttpclient.{AsyncHttpClient, DefaultAsyncHttpClient, Realm}
-import uk.gov.hmrc.http.UnauthorizedException
+import play.api.Logging
+import play.api.http.HeaderNames.AUTHORIZATION
+import play.api.http.Status.{INTERNAL_SERVER_ERROR, OK, UNAUTHORIZED}
+import play.api.libs.ws.writeableOf_urlEncodedForm
+import uk.gov.hmrc.http.HttpReads.Implicits.*
+import uk.gov.hmrc.http.client.HttpClientV2
+import uk.gov.hmrc.http.{HeaderCarrier, HttpResponse, StringContextOps, UnauthorizedException}
 import uk.gov.hmrc.play.bootstrap.config.ServicesConfig
 
-import java.util.Collections
+import java.net.URL
+import java.nio.charset.StandardCharsets.UTF_8
+import java.util.Base64
 import javax.inject.{Inject, Singleton}
 import scala.concurrent.duration.*
 import scala.concurrent.{ExecutionContext, Future}
 import scala.language.postfixOps
 import scala.util.{Failure, Success, Try}
 import scala.xml.XML
 
-// TODO: use uk.gov.hmrc.http.client.HttpClientV2 and method .withProxy
 @Singleton
 class EbarsClientV2 @Inject() (
-  servicesConfig: ServicesConfig,
-  configuration: Configuration
-)(implicit ec: ExecutionContext,
-  materialize: Materializer
-) extends Logging
-  with Status {
+  httpClientV2: HttpClientV2,
+  servicesConfig: ServicesConfig
+)(implicit ec: ExecutionContext
+) extends Logging:
 
-  private val voaEbarsBaseUrl  = servicesConfig.baseUrl("voa-ebars")
-  private val xmlFileUploadUrl = s"$voaEbarsBaseUrl/ebars_dmz_pres_ApplicationWeb/uploadXmlSubmission"
-  private val timeout          = 120 seconds
+  private val voaEbarsBaseUrl: String = servicesConfig.baseUrl("voa-ebars")
+  private val xmlFileUploadURL: URL   = url"$voaEbarsBaseUrl/ebars_dmz_pres_ApplicationWeb/uploadXmlSubmission"
+  private val timeout: FiniteDuration = 120 seconds
 
-  private val ws: WSClient = {
-    val proxyAhcConfig = configuration.getOptional[Boolean]("proxy.enabled") flatMap {
-      case true => Some {
-          val proxyHost     = configuration.get[String]("proxy.host")
-          val proxyPort     = configuration.get[Int]("proxy.port")
-          val proxyUsername = configuration.get[String]("proxy.username")
-          val proxyPassword = configuration.get[String]("proxy.password")
-          val realm         = new Realm.Builder(proxyUsername, proxyPassword)
-            .setScheme(Realm.AuthScheme.BASIC)
-            .setUsePreemptiveAuth(true)
-            .build()
-
-          new AhcConfigBuilder().modifyUnderlying {
-            _.setProxyServer(new ProxyServer(proxyHost, proxyPort, proxyPort, realm, Collections.emptyList(), ProxyType.HTTP))
-          }.build()
-        }
-      case _    => None
-    }
-
-    val clientConfig                            = proxyAhcConfig.getOrElse(new AhcConfigBuilder().build())
-    val asyncHttpClient: AsyncHttpClient        = new DefaultAsyncHttpClient(clientConfig)
-    val standaloneClient: StandaloneAhcWSClient = new StandaloneAhcWSClient(asyncHttpClient)
-    new AhcWSClient(standaloneClient)
-  }
+  private def basicAuth(clientId: String, clientSecret: String): String =
+    val encodedCredentials = Base64.getEncoder.encodeToString(s"$clientId:$clientSecret".getBytes(UTF_8))
+    s"Basic $encodedCredentials"
 
   def uploadXMl(username: String, password: String, xml: String, attempt: Int): Future[Try[Int]] =
-    ws.url(xmlFileUploadUrl)
-      .withAuth(username, password, WSAuthScheme.BASIC)
-      .withRequestTimeout(timeout)
-      .post(Map("xml" -> Seq(xml)))
+    httpClientV2.post(xmlFileUploadURL)(using HeaderCarrier())
+      .setHeader(AUTHORIZATION -> basicAuth(username, password))
+      .withBody(Map("xml" -> Seq(xml)))
+      .withProxy
+      .transform(_.withRequestTimeout(timeout))
+      .execute[HttpResponse]
       .map(processResponse(attempt))
 
-  private def processResponse(attempt: Int)(response: WSResponse): Try[Int] = {
+  private def processResponse(attempt: Int)(response: HttpResponse): Try[Int] =
     logger.trace(s"Response : $response")
     response.status match {
-      case Status.OK           => parseOkResponse(response, attempt)
-      case Status.UNAUTHORIZED => Failure(new UnauthorizedException("UNAUTHORIZED"))
-      case status              =>
+      case OK           => parseOkResponse(response, attempt)
+      case UNAUTHORIZED => Failure(new UnauthorizedException("UNAUTHORIZED"))
+      case status       =>
         logger.warn(s"Couldn't send BA Reports. status: $status\n${response.body}")
-        Failure(EbarsApiError(status, s"${response.statusText}. attempt: $attempt"))
+        Failure(EbarsApiError(status, s"${response.status}. attempt: $attempt"))
     }
-  }
 
-  private def parseOkResponse(response: WSResponse, attempt: Int): Try[Int] = {
+  private def parseOkResponse(response: HttpResponse, attempt: Int): Try[Int] =
     val body = response.body
     if body.contains("401 Unauthorized") then
       Failure(new UnauthorizedException("UNAUTHORIZED"))
@@ -104,14 +82,11 @@ class EbarsClientV2 @Inject() (
           case "error"   =>
             val errorDetail = (responseXML \ "message").text
             logger.warn(s"Couldn't send BA Reports. error: $errorDetail")
-            Failure(EbarsApiError(OK, s"$errorDetail. attempt: $attempt"))
+            Failure(EbarsApiError(INTERNAL_SERVER_ERROR, s"$errorDetail. attempt: $attempt"))
         }
       } getOrElse {
         logger.warn(s"Parsing eBars response failed. Body:\n$body")
-        Failure(EbarsApiError(OK, s"Parsing eBars response failed. attempt: $attempt"))
+        Failure(EbarsApiError(INTERNAL_SERVER_ERROR, s"Parsing eBars response failed. attempt: $attempt"))
       }
-  }
-
-}
 
 case class EbarsApiError(status: Int, message: String) extends RuntimeException(s"$status. $message")
diff --git a/it/test/uk/gov/hmrc/connectors/VoaEbarsConnectorItSpec.scala b/it/test/uk/gov/hmrc/connectors/VoaEbarsConnectorItSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 HM Revenue & Customs
+ * Copyright 2026 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.
@@ -35,25 +35,25 @@ import uk.gov.hmrc.play.bootstrap.config.ServicesConfig
 import uk.gov.hmrc.voabar.connectors.{DefaultVoaEbarsConnector, VoaBarAuditConnector, VoaEbarsConnector}
 import uk.gov.hmrc.voabar.models.EbarsRequests.BAReportRequest
 import uk.gov.hmrc.voabar.services.{EbarsApiError, EbarsClientV2}
-import com.github.tomakehurst.wiremock.client.WireMock._
+import com.github.tomakehurst.wiremock.client.WireMock.*
+import uk.gov.hmrc.http.client.HttpClientV2
 import uk.gov.hmrc.voabar.models.LoginDetails
 
-import scala.concurrent.duration._
+import scala.concurrent.duration.*
 import scala.concurrent.{Await, ExecutionContext, Future}
 import scala.language.postfixOps
 import scala.util.{Failure, Success, Try}
 
 class VoaEbarsConnectorItSpec extends PlaySpec with WiremockHelper with GuiceOneAppPerSuite with Injecting {
 
-  def voaEbarsConnector(port: Int) = {
-
+  def voaEbarsConnector(port: Int): VoaEbarsConnector = {
     val config = inject[Configuration]
 
     val servicesConfig = new ServicesConfig(Configuration("microservice.services.voa-ebars.port" -> port).withFallback(config))
 
     implicit val mat: Materializer = inject[Materializer]
 
-    val ebarsClientV2 = new EbarsClientV2(servicesConfig, config)
+    val ebarsClientV2 = new EbarsClientV2(inject[HttpClientV2], servicesConfig)
     new DefaultVoaEbarsConnector(servicesConfig, config, ebarsClientV2, inject[VoaBarAuditConnector])
   }
 
diff --git a/project/CodeCoverageSettings.scala b/project/CodeCoverageSettings.scala
@@ -12,7 +12,7 @@ object CodeCoverageSettings extends AutoPlugin {
   override lazy val projectSettings: Seq[Setting[?]] = Seq(
     ScoverageKeys.coverageExcludedPackages := excludedPackages.mkString(","),
     ScoverageKeys.coverageExcludedFiles := excludedFiles.mkString(","),
-    ScoverageKeys.coverageMinimumStmtTotal := 85.0,
+    ScoverageKeys.coverageMinimumStmtTotal := 85.2,
     ScoverageKeys.coverageFailOnMinimum := true,
     ScoverageKeys.coverageHighlighting := true
   )
diff --git a/test/uk/gov/hmrc/voabar/services/EbarsClientV2Spec.scala b/test/uk/gov/hmrc/voabar/services/EbarsClientV2Spec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 HM Revenue & Customs
+ * Copyright 2026 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.
@@ -16,28 +16,33 @@
 
 package uk.gov.hmrc.voabar.services
 
-import org.apache.pekko.stream.Materializer
-import org.apache.pekko.stream.testkit.NoMaterializer
 import org.scalatest.matchers.should
 import org.scalatest.wordspec.AnyWordSpec
 import play.api.Configuration
 import play.api.test.{DefaultAwaitTimeout, FutureAwaits}
+import uk.gov.hmrc.http.HeaderCarrier
+import uk.gov.hmrc.http.client.HttpClientV2
 import uk.gov.hmrc.play.bootstrap.config.ServicesConfig
+import org.mockito.ArgumentMatchers.any
 
-import java.net.ConnectException
-import scala.concurrent.ExecutionContext.Implicits._
+import java.net.URL
+import scala.concurrent.ExecutionContext.Implicits.*
+import org.mockito.Mockito.when
+import org.scalatestplus.mockito.MockitoSugar
+import play.api.http.Status.OK
+import uk.gov.hmrc.voabar.connectors.RequestBuilderStub
+
+import scala.util.Failure
 
 /**
   * @author Yuriy Tumakha
   */
-class EbarsClientV2Spec extends AnyWordSpec with should.Matchers with DefaultAwaitTimeout with FutureAwaits {
-
-  implicit private val mat: Materializer = NoMaterializer
+class EbarsClientV2Spec extends AnyWordSpec with should.Matchers with DefaultAwaitTimeout with FutureAwaits with MockitoSugar:
 
   "EbarsClientV2" should {
     "start with only proxy and voa-ebars service configuration" in {
       val configuration  = Configuration(
-        "proxy.enabled"                            -> true,
+        "http-verbs.proxy.enabled"                 -> true,
         "proxy.host"                               -> "localhost",
         "proxy.port"                               -> 9999,
         "proxy.username"                           -> "foo",
@@ -47,12 +52,16 @@ class EbarsClientV2Spec extends AnyWordSpec with should.Matchers with DefaultAwa
         "microservice.services.voa-ebars.protocol" -> "http"
       )
       val servicesConfig = new ServicesConfig(configuration)
-      val ebarsClient    = new EbarsClientV2(servicesConfig, configuration)
 
-      val thrown = intercept[ConnectException] {
-        await(ebarsClient.uploadXMl("", "", "<xml/>", 1))
-      }
-      thrown.getMessage shouldBe "Connection refused: localhost/127.0.0.1:9999"
+      val httpClientV2Mock = mock[HttpClientV2]
+      when(
+        httpClientV2Mock.post(any[URL])(using any[HeaderCarrier])
+      ).thenReturn(RequestBuilderStub(Right(OK), ""))
+
+      val ebarsClient = new EbarsClientV2(httpClientV2Mock, servicesConfig)
+
+      await(ebarsClient.uploadXMl("user", "pass", "<xml/>", 1)) shouldBe Failure(
+        EbarsApiError(500, "Parsing eBars response failed. attempt: 1")
+      )
     }
   }
-}

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ object CodeCoverageSettings extends AutoPlugin {`
`12`	`12`	`override lazy val projectSettings: Seq[Setting[?]] = Seq(`
`13`	`13`	`ScoverageKeys.coverageExcludedPackages := excludedPackages.mkString(","),`
`14`	`14`	`ScoverageKeys.coverageExcludedFiles := excludedFiles.mkString(","),`
`15`		`- ScoverageKeys.coverageMinimumStmtTotal := 85.0,`
	`15`	`+ ScoverageKeys.coverageMinimumStmtTotal := 85.2,`
`16`	`16`	`ScoverageKeys.coverageFailOnMinimum := true,`
`17`	`17`	`ScoverageKeys.coverageHighlighting := true`
`18`	`18`	`)`