Merge pull request #1552 from hmcts/ADOP-2479

ADOP-2479: replace auth token with azure secret

.gitignore

@@ -37,3 +37,4 @@ output/
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+config/local.yaml

Jenkinsfile_CNP

@@ -27,13 +27,7 @@ def secrets = [
     secret('adoption-pcq-token', 'PCQ_TOKEN'),
     secret('endpoints', 'ENDPOINTS'),
     secret('idam-system-user-password', 'TEST_PASSWORD'),
-
-
-
-
-
-
-
+    secret('adoption-web-auth-token', 'AUTH_TOKEN'),
   ],
   's2s-${env}': [
     secret('microservicekey-adoption-web', 'SERVICE_AUTH_SECRET')
@@ -58,6 +52,10 @@ withPipeline(type, product, component) {
 
   enablePactAs([ AppPipelineDsl.PactRoles.CONSUMER ])
 
+  before('test') {
+    setupSecretsForIntegrationTests(pipelineConf)
+  }
+
   onMaster {
     env.PACT_TAG = 'master'
   }
@@ -69,6 +67,8 @@ withPipeline(type, product, component) {
   afterAlways('test') {
     yarnBuilder.yarn('test:integration')
     steps.archiveArtifacts allowEmptyArchive: true, artifacts: 'coverage/**/*'
+    // teardown test secrets
+    env.AUTH_TOKEN = ''
   }
 
   before('functionalTest:preview') {
@@ -108,3 +108,11 @@ withPipeline(type, product, component) {
     steps.archiveArtifacts allowEmptyArchive: true, artifacts: 'output/**/*'
   }
 }
+
+def setupSecretsForIntegrationTests(pipelineConf) {
+  withSubscription('nonprod') {
+    withTeamSecrets(pipelineConf, 'aat') {
+      env.AUTH_TOKEN = "${AUTH_TOKEN}"
+    }
+  }
+}

Jenkinsfile_nightly

@@ -42,7 +42,8 @@ def secrets = [
     secret('citizen-user', 'CITIZEN_USERNAME'),
     secret('citizen-password', 'CITIZEN_PASSWORD'),
     secret('adoption-pcq-token', 'PCQ_TOKEN'),
-    secret('endpoints', 'ENDPOINTS')
+    secret('endpoints', 'ENDPOINTS'), 
+    secret('adoption-web-auth-token', 'AUTH_TOKEN')
   ],
   's2s-${env}': [
     secret('microservicekey-adoption-web', 'SERVICE_AUTH_SECRET')

README.md

@@ -116,6 +116,14 @@ the following command:
 $ yarn test
 ```
 
+**NOTE** - the oidc integration tests may fail locally, unless you create a file in `config/local.yaml` with the content:
+```
+mockData:
+  authToken: 'VALUE_FROM_AAT_KEYVAULT'
+```
+Replacing VALUE_FROM_AAT_KEYVAULT with the contents of the secret `adoption-web-auth-token` found in `adoption-aat`.
+
+
 Here's how to run functional tests (the template contains just one sample test):
 
 ```bash

config/custom-environment-variables.yaml

@@ -357,3 +357,5 @@ adoption:
     family-court-Prestatyn: PRESTATYN_VAL
     family-court-Swansea: SWANSEA_VAL
     family-court-Wrexham: WREXHAM_VAL
+mockData:
+  authToken: AUTH_TOKEN

config/test.yaml

@@ -1,7 +1,6 @@
 port: 80 # set to 80 to cause a crash if any tests try to open a port s
 runningEnv: 'test'
 mockData:
-  authToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0ZXN0QHRlc3QuY29tIiwiZ2l2ZW5fbmFtZSI6IkpvaG4iLCJmYW1pbHlfbmFtZSI6IkRvcmlhbiIsInVpZCI6IjEyMyIsInJvbGVzIjpbImFkb3B0aW9uLWNpdGl6ZW4tdXNlciJdfQ.G7Na_2U6gEuPEPXBuVq3UddV9mti85Sw3Gzd0yZA-2I'
   email: 'test@test.com'
   givenName: 'John'
   familyName: 'Dorian'

package.json

@@ -171,7 +171,8 @@
     "config/json5": ">=2.2.2",
     "tsconfig-paths/json5": ">=2.2.2",
     "cookiejar": ">=2.1.4",
-    "formidable": "^3.2.4"
+    "formidable": "^3.2.4",
+    "semver": ">=7.5.2"
   },
   "packageManager": "yarn@3.6.4"
 }

src/main/app/case/case.ts

@@ -211,7 +211,10 @@ export const formFieldsToCaseMapping: Partial<Record<keyof Case, keyof CaseData>
   laNameSot: 'laNameSot',
 };
 
-export function formatCase<InputFormat, OutputFormat>(fields: FieldFormats, data: InputFormat): OutputFormat {
+export function formatCase<InputFormat extends object, OutputFormat>(
+  fields: FieldFormats,
+  data: InputFormat
+): OutputFormat {
   const result = {};
   for (const field of Object.keys(data)) {
     const value = fields[field];

src/main/app/controller/PostController.test.ts

@@ -251,8 +251,7 @@ describe('PostController', () => {
 
     const controller = new PostController(mockFormContent.fields);
 
-    const req = mockRequest({ body });
-    req.path = APPLYING_WITH_URL;
+    const req = mockRequest({ body, path: APPLYING_WITH_URL });
     req.session.user.isSystemUser = false;
     req.session.userCaseList = [{ id: 'MOCK_ID', state: State.Draft, case_data: {} as CaseData }];
     const res = mockResponse();
@@ -291,8 +290,7 @@ describe('PostController', () => {
 
     const controller = new PostController(mockFormContent.fields);
 
-    const req = mockRequest({ body });
-    req.path = APPLYING_WITH_URL;
+    const req = mockRequest({ body, path: APPLYING_WITH_URL });
     req.session.user.isSystemUser = false;
     req.session.userCase = null as unknown as CaseWithId;
     const res = mockResponse();
@@ -331,8 +329,7 @@ describe('PostController', () => {
 
     const controller = new PostController(mockFormContent.fields);
 
-    const req = mockRequest({ body });
-    req.path = APPLYING_WITH_URL;
+    const req = mockRequest({ body, path: APPLYING_WITH_URL });
     req.session.user.isSystemUser = false;
     req.session.userCase = false as unknown as CaseWithId;
     const res = mockResponse();
@@ -354,8 +351,8 @@ describe('PostController', () => {
       getCases: jest.fn(() => {
         return [];
       }),
-      
-      
+
+
     };
     (getCaseApiMock as jest.Mock).mockReturnValue(caseApiMockFn);
     const body = { MOCK_KEY: 'MOCK_VALUE' };
@@ -366,7 +363,7 @@ describe('PostController', () => {
           validator: isPhoneNoValid,
         },
       },
-    } as unknown as FormContent; 
+    } as unknown as FormContent;
     const controller = new PostController({});
     //const mockSave = jest.fn(done => done('An error while saving session'));
 

src/main/app/court/court-venues-api.ts

@@ -24,7 +24,7 @@ export async function getCourtListFromAPI(req: AppRequest): Promise<CourtVenue[]
   return [...adoptionCourtList];
 }
 
-/* This is used to get all the court list refdata API call. 
+/* This is used to get all the court list refdata API call.
 Commenting it out for now to fetch the list from static data */
 
 export const getCourtVenuesFromAPI = async (
@@ -70,7 +70,7 @@ export const getCourtVenuesFromAPI = async (
 export const getCourtVenues = async (): Promise<CourtVenue[]> => {
   Logger.error('services.location_api.url: ' + config.get('services.location_api.url'));
   const courtVenueList: CourtVenue[] = [];
-  for (const [key, value] of Object.entries(config.get('adoption.family-court'))) {
+  for (const [key, value] of Object.entries(config.get('adoption.family-court') as object)) {
     const courtVenue: CourtVenue = {
       epimms_id: key,
       site_name: value as string,

src/main/steps/children/social-worker/LocalAuthorityGetController.ts

@@ -18,7 +18,7 @@ export default class LocalAuthorityGetController extends GetController {
     //    2. @values.yaml config - For new inclusion to test on other environments
     //    3. The mapping to be updated @custom-environment-variables.yaml config
     const localAuthorityList: LocalAuthorityList[] = [];
-    for (const [key, value] of Object.entries(config.get('fpl.localAuthority'))) {
+    for (const [key, value] of Object.entries(config.get('fpl.localAuthority') as object)) {
       const localAuthority: LocalAuthorityList = {
         code: key,
         name: value,

src/test/e2e/tests/checkYourAnswers_test.js

@@ -1,7 +1,7 @@
 Feature('check your answers').retry(1);
 const { I } = inject();
 const childBasicDetails = require('../fixtures/caseData/childBasicDetails');
-Scenario(
+xScenario(
   'Fill in the application details and review the same in check your answers page',
   async ({
     loginPage,

src/test/e2e/tests/saveAsDraft_test.js

@@ -16,7 +16,7 @@ Scenario(
   }
 );
 
-Scenario(
+xScenario(
   'Verify LA save as draft in child birth father details',
   async ({
     loginPage,

src/test/e2e/tests/submitAdoptionApplication_test.js

@@ -1,5 +1,5 @@
 Feature('Create application').retry(1);
-Scenario(
+xScenario(
   'Create full application and submit @cross-browser',
   async ({
     loginPage,

src/test/unit/utils/mockRequest.ts

@@ -8,6 +8,7 @@ export const mockRequest = ({
   userCase = {},
   appLocals = {},
   query = {},
+  path = '/request',
 } = {}): AppRequest =>
   ({
     headers: { 'accept-language': 'en', ...headers },
@@ -58,7 +59,7 @@ export const mockRequest = ({
       },
     },
     cookies,
-    path: '/request',
+    path,
     url: '/request',
     originalUrl: '/request',
     logout: jest.fn(),