Merge pull request #109 from hmrc/GG-7813

GG-7813: openid-connect-userinfo : always enable addressLine5 & countryCode, remove unwanted code & config, and countryCode discovery [ GLSD-10273 ]

README.md

@@ -3,7 +3,7 @@
 
 [![Build Status](https://travis-ci.org/hmrc/openid-connect-userinfo.svg?branch=master)](https://travis-ci.org/hmrc/openid-connect-userinfo) [ ![Download](https://api.bintray.com/packages/hmrc/releases/openid-connect-userinfo/images/download.svg) ](https://bintray.com/hmrc/releases/openid-connect-userinfo/_latestVersion)
 
-This Beta REST API aims to provide a specification compliant OpenID Connect implementation. It allows consumers to access user details with consent and in the OpenID Connect UserInfo format.
+The REST API, exposed by the HMRC API Platform as /userinfo to external clients, aims to provide a specification compliant OpenID Connect implementation. It allows consumers to access user details with consent and in the OpenID Connect UserInfo format.
 
 A typical workflow would be:
 
@@ -15,10 +15,15 @@ User details data structures follow the OpenId Connect UserInfo specification (s
 
 You can dive deeper into the documentation in the [API Developer Hub](https://developer.service.hmrc.gov.uk/api-documentation/docs/api#openid-connect-userinfo).
 
-## Deprecated Class Usage
-You can find the deprecation suppression `@nowarn("cat=deprecation")` in the code in few places.
+## Authentication tokens
+Note, the /userinfo endpoint is an external API endpoint. This endpoint requires an API token for authentication.
 
-The reason is that when the latest `v2.Retrievals` was used then the integration tests were broken and wasn't obvious why.
+## API
+
+| Method | HMRC API Platform Path | Internal Path | Description                                                                                                          |
+|--------|------------------------|---------------|----------------------------------------------------------------------------------------------------------------------|
+| GET    | /userinfo              | /             | Returns information about an End-User as requested in the openid scopes as documented in the published API document. |
+| POST   | Internal use only      | /             |                                                                                                                      |
 
 ## Running Locally
 Run the service `sbt run -Drun.mode=Dev`

app/data/UserInfoGenerator.scala

@@ -19,7 +19,6 @@ package data
 import javax.inject.Singleton
 import java.time.LocalDate
 import uk.gov.hmrc.auth.core.{Enrolment, EnrolmentIdentifier}
-import config.UserInfoFeatureSwitches
 import domain.{Address, GovernmentGatewayDetails, Mdtp, UserInfo}
 
 import scala.util.Random.{nextInt => randomNextInt}
@@ -75,27 +74,21 @@ class UserInfoGenerator {
     )
   )
 
-  def addressWithToggleableFeatures(isAddressLine5: Boolean = false, isCountryCode: Boolean = false): Option[Address] = {
-    val addressLine5 = if (isAddressLine5) "\n|Line5" else ""
-    val code = if (isCountryCode) Some("GB") else None
-
+  def address: Option[Address] =
     Some(
       Address(
         s"""221B Baker Street
-        |Town centre
-        |London
-        |England$addressLine5
-        |NW1 9NT
-        |Great Britain""".stripMargin,
+           |Town centre
+           |London
+           |England
+           |Line5
+           |NW1 9NT
+           |Great Britain""".stripMargin,
         Some("NW1 9NT"),
         Some("Great Britain"),
-        code
+        Some("GB")
       )
     )
-  }
-
-  def address: Option[Address] =
-    addressWithToggleableFeatures(UserInfoFeatureSwitches.addressLine5.isEnabled, UserInfoFeatureSwitches.countryCode.isEnabled)
 
   val enrolments: Set[Enrolment] = Set(Enrolment("IR-SA", List(EnrolmentIdentifier("UTR", "174371121")), "Activated"))
   private val government_gateway_v1_0: GovernmentGatewayDetails = GovernmentGatewayDetails(

app/services/UserInfoTransformer.scala

@@ -20,7 +20,6 @@ import javax.inject.Singleton
 import java.time.LocalDate
 import uk.gov.hmrc.auth.core.Enrolments
 import uk.gov.hmrc.auth.core.retrieve.ItmpAddress
-import config.UserInfoFeatureSwitches
 import domain._
 
 @Singleton
@@ -39,10 +38,8 @@ class UserInfoTransformer {
 
     def address = if (scopes.contains("address")) {
       val countryName = desUserInfo flatMap { c => c.address.countryName }
-      val countryCode = if (UserInfoFeatureSwitches.countryCode.isEnabled) { desUserInfo flatMap { u => u.address.countryCode } }
-      else None
+      val countryCode = desUserInfo flatMap { u => u.address.countryCode }
       desUserInfo map (u => Address(formattedAddress(u.address), u.address.postCode, countryName, countryCode))
-
     } else None
 
     val identifier = if (scopes.contains("openid:gov-uk-identifiers")) authority flatMap (_.nino) else None
@@ -74,7 +71,7 @@ class UserInfoTransformer {
 
   private def formattedAddress(desAddress: ItmpAddress) = {
     val countryName = desAddress.countryName
-    val addressLine5 = if (UserInfoFeatureSwitches.addressLine5.isEnabled) desAddress.line5 else None
+    val addressLine5 = desAddress.line5
     Seq(desAddress.line1, desAddress.line2, desAddress.line3, desAddress.line4, addressLine5, desAddress.postCode, countryName).flatten.mkString("\n")
   }
 

conf/application.conf

@@ -54,9 +54,6 @@ play.i18n.langs = ["en"]
 # !!!WARNING!!! DO NOT CHANGE THIS ROUTER
 play.http.router = prod.Routes
 
-feature.addressLine5 = false
-feature.countryCode = false
-
 # Controller
 # ~~~~~
 # By default all controllers will have authorisation, logging and 
@@ -84,12 +81,6 @@ controllers {
     needsLogging = true
     needsAuditing = false
   }
-
-  controllers.testOnly.FeatureSwitchController = {
-    needsAuth = false
-    needsLogging = true
-    needsAuditing = false
-  }
 }
 
 # Root logger:

conf/testOnlyDoNotUseInAppConf.routes

@@ -1,4 +1 @@
-GET   /test-only/feature-switches  @controllers.testOnly.FeatureSwitchController.getFlags
-POST  /test-only/feature-switches  @controllers.testOnly.FeatureSwitchController.setFlags
-
 ->    /                            prod.Routes

it/test/UserInfoServiceISpec.scala

@@ -18,7 +18,6 @@ import java.nio.file.Paths
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.github.fge.jsonschema.core.report.LogLevel
 import com.github.fge.jsonschema.main.JsonSchemaFactory
-import config.{FeatureSwitch, UserInfoFeatureSwitches}
 import domain._
 
 import java.time.LocalDate
@@ -29,21 +28,7 @@ import uk.gov.hmrc.auth.core._
 import uk.gov.hmrc.auth.core.retrieve._
 import uk.gov.hmrc.domain.Nino
 
-import scala.jdk.CollectionConverters.CollectionHasAsScala
-
 class UserInfoServiceISpec extends BaseFeatureISpec with AuthStub with ThirdPartyDelegatedAuthorityStub {
-
-  override def beforeAll(): Unit = {
-    super.beforeAll()
-    FeatureSwitch.enable(UserInfoFeatureSwitches.countryCode)
-    FeatureSwitch.enable(UserInfoFeatureSwitches.addressLine5)
-  }
-  override def afterAll(): Unit = {
-    super.afterAll()
-    FeatureSwitch.disable(UserInfoFeatureSwitches.countryCode)
-    FeatureSwitch.disable(UserInfoFeatureSwitches.addressLine5)
-  }
-
   val serviceUrl: String = resource("")
 
   val authorizationTokens = "AUTHORIZATION_TOKENS"

project/AppDependencies.scala

@@ -4,7 +4,7 @@ import sbt.*
 
 object AppDependencies {
 
-  private val bootstrapPlayVersion = "8.5.0"
+  private val bootstrapPlayVersion = "8.6.0"
 
   private val compile: Seq[ModuleID] = Seq(
     ws,
@@ -14,19 +14,9 @@ object AppDependencies {
   )
 
   private val test: Seq[ModuleID] = Seq(
-    "org.scalatest"             %% "scalatest"               % "3.2.17"             % Test,
-    "org.scalatestplus"         %% "scalacheck-1-17"         % "3.2.17.0"           % Test,
-    "org.scalatestplus.play"    %% "scalatestplus-play"      % "5.1.0"              % Test,
-    "org.playframework"         %% "play-test"               % PlayVersion.current  % Test,
-    "com.github.tomakehurst"     % "wiremock"                % "2.27.2"             % Test,
-    "uk.gov.hmrc"               %% "bootstrap-test-play-30"  % bootstrapPlayVersion % Test,
-    "org.pegdown"                % "pegdown"                 % "1.6.0"              % Test,
-    "org.jsoup"                  % "jsoup"                   % "1.17.2"             % Test,
-    "org.scalaj"                %% "scalaj-http"             % "2.4.2"              % Test,
-    "org.mockito"               %% "mockito-scala-scalatest" % "1.17.30"            % Test,
-    "org.scalacheck"            %% "scalacheck"              % "1.17.0"             % Test,
-    "com.github.java-json-tools" % "json-schema-validator"   % "2.2.14"             % Test,
-    "com.vladsch.flexmark"       % "flexmark-all"            % "0.64.0"             % Test
+    "org.scalaj"                 %% "scalaj-http"             % "2.4.2"    % Test,
+    "com.github.java-json-tools" % "json-schema-validator"    % "2.2.14"   % Test,
+    "uk.gov.hmrc"                %% "bootstrap-test-play-30"  % "8.6.0"    % Test
   )
 
   def apply(): Seq[ModuleID] = compile ++ test

project/build.properties

@@ -1 +1 @@
-sbt.version=1.9.7
+sbt.version=1.9.9

project/plugins.sbt

@@ -2,9 +2,9 @@ resolvers += "HMRC-open-artefacts-maven" at "https://open.artefacts.tax.service.
 resolvers += Resolver.url("HMRC-open-artefacts-ivy", url("https://open.artefacts.tax.service.gov.uk/ivy2"))(Resolver.ivyStylePatterns)
 
 
-addSbtPlugin("uk.gov.hmrc"       % "sbt-auto-build"     % "3.20.0")
+addSbtPlugin("uk.gov.hmrc"       % "sbt-auto-build"     % "3.22.0")
 addSbtPlugin("uk.gov.hmrc"       % "sbt-distributables" % "2.5.0")
-addSbtPlugin("org.scoverage"     % "sbt-scoverage"      % "2.0.11")
-addSbtPlugin("org.playframework" % "sbt-plugin"         % "3.0.2")
+addSbtPlugin("org.scoverage"     % "sbt-scoverage"      % "2.0.12")
+addSbtPlugin("org.playframework" % "sbt-plugin"         % "3.0.3")
 addSbtPlugin("org.scalastyle"    %% "scalastyle-sbt-plugin"  % "1.0.0" exclude("org.scala-lang.modules", "scala-xml_2.12"))
 addSbtPlugin("org.scalameta"     % "sbt-scalafmt"            % "2.5.2")