DDCE-5088 Migration to Play 3.0 (#77)

* DDCE-5088 Play 3.0 migration * bump plugin * copyright update * address comments * remove test only route and add license * disable JUnitXmlReportPlugin
hmrc · Jan 25, 2024 · 768830d · 768830d
1 parent 3039164
commit 768830d
Show file tree

Hide file tree

Showing 40 changed files with 77 additions and 81 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,8 @@ tmp
 .idea_modules
 bin
 .bsp
+
+.metals/
+.vscode/
+project/.bloop/
+
diff --git a/README.md b/README.md
@@ -33,3 +33,7 @@ NB: If an exchange rate file cannot be found, an error will be logged and a `WAR
 
 ## Testing
 To run the tests locally, simply run `./run_all_tests.sh`
+
+## License
+
+This code is open source software licensed under the [Apache 2.0 License]("http://www.apache.org/licenses/LICENSE-2.0.html").
diff --git a/app/uk/gov/hmrc/currencyconversion/binders/DateBinder.scala b/app/uk/gov/hmrc/currencyconversion/binders/DateBinder.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/config/DesCircuitBreakerProvider.scala b/app/uk/gov/hmrc/currencyconversion/config/DesCircuitBreakerProvider.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,8 +16,8 @@
 
 package uk.gov.hmrc.currencyconversion.config
 
-import akka.actor.ActorSystem
-import akka.pattern.CircuitBreaker
+import org.apache.pekko.actor.ActorSystem
+import org.apache.pekko.pattern.CircuitBreaker
 import com.google.inject.{Inject, Provider, Singleton}
 import play.api.Configuration
 

diff --git a/app/uk/gov/hmrc/currencyconversion/config/HmrcModule.scala b/app/uk/gov/hmrc/currencyconversion/config/HmrcModule.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,7 +16,7 @@
 
 package uk.gov.hmrc.currencyconversion.config
 
-import akka.pattern.CircuitBreaker
+import org.apache.pekko.pattern.CircuitBreaker
 import play.api.inject.{Binding, Module}
 import play.api.{Configuration, Environment}
 import uk.gov.hmrc.currencyconversion.workers.XrsExchangeRateRequestWorker

diff --git a/app/uk/gov/hmrc/currencyconversion/connectors/HODConnector.scala b/app/uk/gov/hmrc/currencyconversion/connectors/HODConnector.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,7 +16,7 @@
 
 package uk.gov.hmrc.currencyconversion.connectors
 
-import akka.pattern.CircuitBreaker
+import org.apache.pekko.pattern.CircuitBreaker
 import com.google.inject.Inject
 import com.google.inject.name.Named
 import play.api.Configuration

diff --git a/app/uk/gov/hmrc/currencyconversion/connectors/HttpDate.scala b/app/uk/gov/hmrc/currencyconversion/connectors/HttpDate.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/controllers/ExchangeRateController.scala b/app/uk/gov/hmrc/currencyconversion/controllers/ExchangeRateController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/models/ConversionRatePeriod.scala b/app/uk/gov/hmrc/currencyconversion/models/ConversionRatePeriod.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/models/Currency.scala b/app/uk/gov/hmrc/currencyconversion/models/Currency.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/models/ExchangeRate.scala b/app/uk/gov/hmrc/currencyconversion/models/ExchangeRate.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/models/ExchangeRateObject.scala b/app/uk/gov/hmrc/currencyconversion/models/ExchangeRateObject.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/models/ExchangeRateResult.scala b/app/uk/gov/hmrc/currencyconversion/models/ExchangeRateResult.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/models/Service.scala b/app/uk/gov/hmrc/currencyconversion/models/Service.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/repositories/ConversionRatePeriodJson.scala b/app/uk/gov/hmrc/currencyconversion/repositories/ConversionRatePeriodJson.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/repositories/ConversionRatePeriodRepository.scala b/app/uk/gov/hmrc/currencyconversion/repositories/ConversionRatePeriodRepository.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/repositories/ExchangeRateRepository.scala b/app/uk/gov/hmrc/currencyconversion/repositories/ExchangeRateRepository.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/services/ExchangeRateService.scala b/app/uk/gov/hmrc/currencyconversion/services/ExchangeRateService.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/utils/MongoIdHelper.scala b/app/uk/gov/hmrc/currencyconversion/utils/MongoIdHelper.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/workers/XrsDelayHelper.scala b/app/uk/gov/hmrc/currencyconversion/workers/XrsDelayHelper.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/currencyconversion/workers/XrsExchangeRateRequestWorker.scala b/app/uk/gov/hmrc/currencyconversion/workers/XrsExchangeRateRequestWorker.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,9 +16,9 @@
 
 package uk.gov.hmrc.currencyconversion.workers
 
-import akka.stream.scaladsl.{Keep, Sink, SinkQueueWithCancel, Source}
-import akka.stream.{ActorAttributes, Materializer, Supervision}
 import com.google.inject.{Inject, Singleton}
+import org.apache.pekko.stream.scaladsl.{Keep, Sink, SinkQueueWithCancel, Source}
+import org.apache.pekko.stream.{ActorAttributes, Materializer, Supervision}
 import play.api.Configuration
 import play.api.http.Status.SERVICE_UNAVAILABLE
 import play.api.i18n.Lang.logger.logger

diff --git a/build.sbt b/build.sbt
@@ -1,10 +1,13 @@
 val appName = "currency-conversion"
 
+ThisBuild / majorVersion := 1
+ThisBuild / scalaVersion := "2.13.12"
+
 lazy val microservice = Project(appName, file("."))
-  .enablePlugins(play.sbt.PlayScala, SbtDistributablesPlugin)
+  .enablePlugins(PlayScala, SbtDistributablesPlugin)
+  .disablePlugins(JUnitXmlReportPlugin)
+  .settings(CodeCoverageSettings.settings)
   .settings(
-    // To resolve a bug with version 2.x.x of the scoverage plugin - https://github.com/sbt/sbt/issues/6997
-    libraryDependencySchemes += "org.scala-lang.modules" %% "scala-xml" % VersionScheme.Always,
     libraryDependencies ++= AppDependencies(),
     scalacOptions ++= Seq(
       "-feature",
@@ -14,17 +17,10 @@ lazy val microservice = Project(appName, file("."))
       "-language:postfixOps"
     )
   )
-  .settings(scalaVersion := "2.13.12")
-  .settings(majorVersion := 1)
   .settings(
     routesImport ++= Seq("uk.gov.hmrc.currencyconversion.binders.DateBinder._", "java.time._")
   )
-  .settings(
-    coverageExcludedFiles := "<empty>;.*Routes.*;",
-    coverageMinimumStmtTotal := 96,
-    coverageFailOnMinimum := true
-  )
   .settings(PlayKeys.playDefaultPort := 9016)
 
 addCommandAlias("scalafmtAll", "all scalafmtSbt scalafmt Test/scalafmt")
-addCommandAlias("scalastyleAll", "all scalastyle Test/scalastyle")
+addCommandAlias("scalastyleAll", "all scalastyle Test/scalastyle ")
diff --git a/conf/application.conf b/conf/application.conf
@@ -1,4 +1,4 @@
-# Copyright 2023 HM Revenue & Customs
+# 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.

diff --git a/conf/prod.routes b/conf/prod.routes
@@ -1,5 +1,3 @@
 # Add all the application routes to the app.routes file
 ->         /currency-conversion              app.Routes
 ->         /                          health.Routes
-
-GET        /admin/metrics             com.kenshoo.play.metrics.MetricsController.metrics
diff --git a/conf/testOnlyDoNotUseInAppConf.routes b/conf/testOnlyDoNotUseInAppConf.routes
diff --git a/project/AppDependencies.scala b/project/AppDependencies.scala
@@ -2,20 +2,18 @@ import sbt.*
 
 object AppDependencies {
 
-  private lazy val bootstrapPlayVersion = "7.23.0"
-  private lazy val hmrcMongoVersion     = "1.6.0"
+  private lazy val bootstrapPlayVersion = "8.4.0"
+  private lazy val hmrcMongoVersion     = "1.7.0"
 
   private lazy val compile: Seq[ModuleID] = Seq(
-    "uk.gov.hmrc"       %% "bootstrap-backend-play-28" % bootstrapPlayVersion,
-    "uk.gov.hmrc.mongo" %% "hmrc-mongo-play-28"        % hmrcMongoVersion
+    "uk.gov.hmrc"       %% "bootstrap-backend-play-30" % bootstrapPlayVersion,
+    "uk.gov.hmrc.mongo" %% "hmrc-mongo-play-30"        % hmrcMongoVersion
   )
 
   private lazy val test: Seq[ModuleID] = Seq(
-    "uk.gov.hmrc"         %% "bootstrap-test-play-28"  % bootstrapPlayVersion,
-    "uk.gov.hmrc.mongo"   %% "hmrc-mongo-test-play-28" % hmrcMongoVersion,
-    "org.scalatest"       %% "scalatest"               % "3.2.17",
-    "org.mockito"         %% "mockito-scala-scalatest" % "1.17.30",
-    "com.vladsch.flexmark" % "flexmark-all"            % "0.64.8"
+    "uk.gov.hmrc"       %% "bootstrap-test-play-30"  % bootstrapPlayVersion,
+    "uk.gov.hmrc.mongo" %% "hmrc-mongo-test-play-30" % hmrcMongoVersion,
+    "org.mockito"       %% "mockito-scala-scalatest" % "1.17.30"
   ).map(_ % Test)
 
   def apply(): Seq[ModuleID]           = compile ++ test

diff --git a/project/CodeCoverageSettings.scala b/project/CodeCoverageSettings.scala
@@ -0,0 +1,12 @@
+import sbt.Setting
+import scoverage.ScoverageKeys.*
+
+object CodeCoverageSettings {
+
+  val settings: Seq[Setting[?]] = Seq(
+    coverageExcludedFiles := "<empty>;.*Routes.*;",
+    coverageMinimumStmtTotal := 96,
+    coverageFailOnMinimum := true,
+    coverageHighlighting := true
+  )
+}
diff --git a/project/build.properties b/project/build.properties
@@ -1 +1 @@
-sbt.version=1.8.0
+sbt.version=1.9.7
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -3,14 +3,10 @@ resolvers += Resolver.url("HMRC-open-artefacts-ivy2", url("https://open.artefact
   Resolver.ivyStylePatterns
 )
 
-// To resolve a bug with version 2.x.x of the scoverage plugin - https://github.com/sbt/sbt/issues/6997
-// Try to remove when sbt 1.8.0+ and scoverage is 2.0.7+
-ThisBuild / libraryDependencySchemes += "org.scala-lang.modules" %% "scala-xml" % VersionScheme.Always
-
-addSbtPlugin("uk.gov.hmrc"       % "sbt-auto-build"        % "3.15.0")
+addSbtPlugin("uk.gov.hmrc"       % "sbt-auto-build"        % "3.20.0")
 addSbtPlugin("uk.gov.hmrc"       % "sbt-distributables"    % "2.4.0")
-addSbtPlugin("com.typesafe.play" % "sbt-plugin"            % "2.8.21")
-addSbtPlugin("org.scalastyle"    % "scalastyle-sbt-plugin" % "1.0.0")
+addSbtPlugin("org.playframework" % "sbt-plugin"            % "3.0.1")
+addSbtPlugin("org.scalastyle"    % "scalastyle-sbt-plugin" % "1.0.0" exclude ("org.scala-lang.modules", "scala-xml_2.12"))
 addSbtPlugin("org.scoverage"     % "sbt-scoverage"         % "2.0.9")
-addSbtPlugin("com.timushev.sbt"  % "sbt-updates"           % "0.6.3")
+addSbtPlugin("com.timushev.sbt"  % "sbt-updates"           % "0.6.4")
 addSbtPlugin("org.scalameta"     % "sbt-scalafmt"          % "2.5.2")
diff --git a/scalastyle-config.xml b/scalastyle-config.xml
@@ -9,7 +9,7 @@
     <check level="warning" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">
         <parameters>
             <parameter name="header"><![CDATA[/*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/binders/BinderSpec.scala b/test/uk/gov/hmrc/currencyconversion/binders/BinderSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/connectors/HODConnectorSpec.scala b/test/uk/gov/hmrc/currencyconversion/connectors/HODConnectorSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/controllers/ExchangeRateControllerSpec.scala b/test/uk/gov/hmrc/currencyconversion/controllers/ExchangeRateControllerSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/repositories/ConversionRatePeriodJsonSpec.scala b/test/uk/gov/hmrc/currencyconversion/repositories/ConversionRatePeriodJsonSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/repositories/DefaultExchangeRateRepositorySpec.scala b/test/uk/gov/hmrc/currencyconversion/repositories/DefaultExchangeRateRepositorySpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/services/ExchangeRateServiceSpec.scala b/test/uk/gov/hmrc/currencyconversion/services/ExchangeRateServiceSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/utils/MongoIdHelperSpec.scala b/test/uk/gov/hmrc/currencyconversion/utils/MongoIdHelperSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/utils/WireMockHelper.scala b/test/uk/gov/hmrc/currencyconversion/utils/WireMockHelper.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/workers/XrsDelayHelperSpec.scala b/test/uk/gov/hmrc/currencyconversion/workers/XrsDelayHelperSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/test/uk/gov/hmrc/currencyconversion/workers/XrsExchangeRateRequestWorkerSpec.scala b/test/uk/gov/hmrc/currencyconversion/workers/XrsExchangeRateRequestWorkerSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.