@defra/forms-engine-plugin 0.0.1

package/test/form/definitions/titles.json

@@ -0,0 +1,170 @@
+{
+  "startPage": "/applicant-one",
+  "pages": [
+    {
+      "path": "/applicant-one",
+      "title": "Applicant 1",
+      "section": "applicantOneDetails",
+      "components": [
+        {
+          "type": "Html",
+          "name": "html",
+          "title": "Html",
+          "content": "<p class=\"govuk-body\">Provide the details as they appear on your passport.</p>",
+          "options": {},
+          "schema": {}
+        },
+        {
+          "type": "TextField",
+          "name": "firstName1",
+          "title": "First name",
+          "options": {
+            "required": true
+          },
+          "schema": {}
+        },
+        {
+          "options": {
+            "required": false,
+            "optionalText": false
+          },
+          "type": "TextField",
+          "name": "middleName1",
+          "title": "Middle name",
+          "hint": "If you have a middle name on your passport you must include it here",
+          "schema": {}
+        },
+        {
+          "type": "TextField",
+          "name": "lastName1",
+          "title": "Surname",
+          "options": {
+            "required": true
+          },
+          "schema": {}
+        }
+      ],
+      "next": [
+        {
+          "path": "/applicant-one-address"
+        }
+      ]
+    },
+    {
+      "path": "/applicant-one-address",
+      "section": "applicantOneDetails",
+      "components": [
+        {
+          "type": "UkAddressField",
+          "name": "address1",
+          "title": "Address",
+          "options": {
+            "required": true
+          },
+          "schema": {}
+        }
+      ],
+      "next": [
+        {
+          "path": "/applicant-two"
+        }
+      ],
+      "title": "Address"
+    },
+    {
+      "path": "/applicant-two",
+      "title": "Applicant 2 details",
+      "section": "applicantTwoDetails",
+      "components": [
+        {
+          "type": "Html",
+          "name": "html",
+          "title": "Html",
+          "content": "<p class=\"govuk-body\">Provide the details as they appear on your passport.</p>",
+          "options": {},
+          "schema": {}
+        },
+        {
+          "type": "TextField",
+          "name": "firstName2",
+          "title": "First name",
+          "options": {
+            "required": true
+          },
+          "schema": {}
+        },
+        {
+          "options": {
+            "required": false,
+            "optionalText": false
+          },
+          "type": "TextField",
+          "name": "middleName2",
+          "title": "Middle name",
+          "hint": "If you have a middle name on your passport you must include it here",
+          "schema": {}
+        },
+        {
+          "type": "TextField",
+          "name": "lastName2",
+          "title": "Surname",
+          "options": {
+            "required": true
+          },
+          "schema": {}
+        }
+      ],
+      "next": [
+        {
+          "path": "/applicant-two-address-optional"
+        }
+      ]
+    },
+    {
+      "path": "/applicant-two-address-optional",
+      "section": "applicantOneDetails",
+      "components": [
+        {
+          "type": "UkAddressField",
+          "name": "address2",
+          "title": "Address",
+          "options": {
+            "required": false
+          },
+          "schema": {}
+        }
+      ],
+      "next": [
+        {
+          "path": "/summary"
+        }
+      ],
+      "title": "Address"
+    },
+    {
+      "path": "/summary",
+      "controller": "SummaryPageController",
+      "title": "Summary",
+      "components": [],
+      "next": []
+    }
+  ],
+  "lists": [],
+  "sections": [
+    {
+      "name": "applicantDetails",
+      "title": "Applicant details"
+    },
+    {
+      "name": "applicantOneDetails",
+      "title": "Applicant 1"
+    },
+    {
+      "name": "applicantTwoDetails",
+      "title": "Applicant 2",
+      "hideTitle": true
+    }
+  ],
+  "phaseBanner": {},
+  "conditions": []
+}

package/test/form/definitions.test.js

@@ -0,0 +1,47 @@
+import { join } from 'node:path'
+
+import { formDefinitionSchema } from '@defra/forms-model'
+
+import { getForm } from '~/src/server/plugins/engine/configureEnginePlugin.js'
+import { getForms } from '~/test/utils/get-form-definitions.js'
+
+describe('Form definition JSON', () => {
+  describe.each([
+    {
+      description: 'Demo forms',
+      directory: join(import.meta.dirname, '../../src/server/forms')
+    },
+    {
+      description: 'Test fixtures',
+      directory: join(import.meta.dirname, 'definitions')
+    }
+  ])('$description', ({ directory }) => {
+    /** @type {string[]} */
+    let filenames
+
+    beforeAll(async () => {
+      filenames = await getForms(directory)
+    })
+
+    it('passes schema validation', async () => {
+      for (const filename of filenames) {
+        const definition = await getForm(join(directory, filename))
+
+        // Validate form definition
+        const result = formDefinitionSchema.validate(definition, {
+          abortEarly: false
+        })
+
+        expect({
+          filename,
+          directory,
+          error: result.error
+        }).toMatchObject({
+          filename, // Include filename in test output
+          directory, // Include directory in test output
+          error: undefined
+        })
+      }
+    })
+  })
+})

package/test/form/exit-page.test.js

@@ -0,0 +1,210 @@
+import { join } from 'node:path'
+
+import { StatusCodes } from 'http-status-codes'
+
+import { createServer } from '~/src/server/index.js'
+import { getFormMetadata } from '~/src/server/plugins/engine/services/formsService.js'
+import * as fixtures from '~/test/fixtures/index.js'
+import { renderResponse } from '~/test/helpers/component-helpers.js'
+import { getCookie, getCookieHeader } from '~/test/utils/get-cookie.js'
+
+const basePath = '/demo-cph-number'
+
+jest.mock('~/src/server/utils/notify.ts')
+jest.mock('~/src/server/plugins/engine/services/formsService.js')
+jest.mock('~/src/server/plugins/engine/services/formSubmissionService.js')
+
+describe('Exit pages', () => {
+  const journey = [
+    {
+      heading1: 'Are you 18 or older?',
+
+      paths: {
+        current: '/are-you-18-or-older',
+        next: '/are-you-or-your-business-already-registered-with-the-rural-payments-agency',
+        exit: '/you-must-be-18-or-older-to-use-this-service'
+      },
+
+      fields: [
+        {
+          name: 'JGLmzy',
+          title: '18 or older',
+          payload: {
+            valid: { JGLmzy: 'true' },
+            invalid: { JGLmzy: 'false' }
+          }
+        }
+      ]
+    },
+    {
+      heading1:
+        'Are you or your business already registered with the Rural Payments Agency?',
+
+      paths: {
+        current:
+          '/are-you-or-your-business-already-registered-with-the-rural-payments-agency',
+        next: '/what-country-will-you-keep-livestock-in',
+        exit: '/already-registered-with-the-rural-payments-agency'
+      },
+
+      fields: [
+        {
+          name: 'zcjEtV',
+          title: 'Registered with the Rural Payments Agency',
+          payload: {
+            valid: { zcjEtV: 'false' },
+            invalid: { zcjEtV: 'true' }
+          }
+        }
+      ]
+    }
+  ]
+
+  /** @type {Server} */
+  let server
+
+  /** @type {string} */
+  let csrfToken
+
+  /** @type {ReturnType<typeof getCookieHeader>} */
+  let headers
+
+  /** @type {BoundFunctions<typeof queries>} */
+  let container
+
+  // Create server before each test
+  beforeAll(async () => {
+    server = await createServer({
+      formFileName: 'demo-cph-number.js',
+      formFilePath: join(import.meta.dirname, 'definitions'),
+      enforceCsrf: true
+    })
+
+    await server.initialize()
+
+    // Navigate to start
+    const response = await server.inject({
+      url: `${basePath}${journey[0].paths.current}`
+    })
+
+    // Extract the session cookie
+    csrfToken = getCookie(response, 'crumb')
+    headers = getCookieHeader(response, ['session', 'crumb'])
+  })
+
+  beforeEach(() => {
+    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+  })
+
+  describe.each(journey)(
+    'Page: $paths.current',
+    ({ heading1, paths, fields = [] }) => {
+      beforeEach(async () => {
+        ;({ container } = await renderResponse(server, {
+          url: `${basePath}${paths.current}`,
+          headers
+        }))
+      })
+
+      it('should render the page heading', () => {
+        const $heading = container.getByRole('heading', {
+          name: heading1,
+          level: 1
+        })
+
+        expect($heading).toBeInTheDocument()
+      })
+
+      it('should redirect to the exit page on submit (answer: No)', async () => {
+        const payload = {}
+
+        for (const field of fields) {
+          Object.assign(payload, field.payload.invalid)
+        }
+
+        // Submit form with populated values
+        const response = await server.inject({
+          url: `${basePath}${paths.current}`,
+          method: 'POST',
+          headers,
+          payload: { ...payload, crumb: csrfToken }
+        })
+
+        expect(response.statusCode).toBe(StatusCodes.SEE_OTHER)
+        expect(response.headers.location).toBe(`${basePath}${paths.exit}`)
+      })
+
+      it.each([
+        { path: '/what-country-will-you-keep-livestock-in' },
+        { path: '/what-type-of-business-do-you-have' },
+        { path: '/what-is-the-main-purpose-of-your-business' },
+
+        // Other pages etc, including summary
+        { path: '/summary' }
+      ])(
+        'should prevent access to the other pages (after exit)',
+        async ({ path }) => {
+          const response = await server.inject({
+            url: `${basePath}${path}`,
+            headers
+          })
+
+          // Redirect back to exit page
+          expect(response.statusCode).toBe(StatusCodes.MOVED_TEMPORARILY)
+          expect(response.headers.location).toBe(`${basePath}${paths.exit}`)
+        }
+      )
+
+      it('should prevent access to the summary page (after exit)', async () => {
+        const response = await server.inject({
+          url: `${basePath}/summary`,
+          headers
+        })
+
+        // Redirect back to exit page (without return URL)
+        expect(response.statusCode).toBe(StatusCodes.MOVED_TEMPORARILY)
+        expect(response.headers.location).toBe(`${basePath}${paths.exit}`)
+      })
+
+      it('should redirect to the next page on submit (answer: Yes)', async () => {
+        const payload = {}
+
+        for (const field of fields) {
+          Object.assign(payload, field.payload.valid)
+        }
+
+        // Submit form with populated values
+        const response1 = await server.inject({
+          url: `${basePath}${paths.current}`,
+          method: 'POST',
+          headers,
+          payload: { ...payload, crumb: csrfToken }
+        })
+
+        // Redirect to next page
+        expect(response1.statusCode).toBe(StatusCodes.SEE_OTHER)
+        expect(response1.headers.location).toBe(`${basePath}${paths.next}`)
+      })
+
+      it('should prevent access to the summary page (after continue)', async () => {
+        const response = await server.inject({
+          url: `${basePath}/summary`,
+          headers
+        })
+
+        // Redirect back to relevant page (with return URL)
+        expect(response.statusCode).toBe(StatusCodes.MOVED_TEMPORARILY)
+        expect(response.headers.location).toBe(`${basePath}${paths.next}`)
+      })
+    }
+  )
+})
+
+/**
+ * @import { Server } from '@hapi/hapi'
+ * @import { BoundFunctions, queries } from '@testing-library/dom'
+ */

package/test/form/feedback.test.js

@@ -0,0 +1,68 @@
+import { join } from 'node:path'
+
+import { createServer } from '~/src/server/index.js'
+import { getFormMetadata } from '~/src/server/plugins/engine/services/formsService.js'
+import * as fixtures from '~/test/fixtures/index.js'
+import { renderResponse } from '~/test/helpers/component-helpers.js'
+
+const { FEEDBACK_LINK } = process.env
+const basePath = '/feedback'
+
+jest.mock('~/src/server/plugins/engine/services/formsService.js')
+
+describe('Feedback link', () => {
+  /** @type {Server} */
+  let server
+
+  // Create server before each test
+  beforeAll(async () => {
+    server = await createServer({
+      formFileName: 'feedback.json',
+      formFilePath: join(import.meta.dirname, 'definitions')
+    })
+
+    await server.initialize()
+  })
+
+  beforeEach(() => {
+    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+  })
+
+  it.each([
+    {
+      // Default feedback link
+      url: '/help/cookies',
+      name: 'give your feedback (opens in new tab)',
+      href: FEEDBACK_LINK
+    },
+    {
+      // Email address from feedback.json
+      url: `${basePath}/uk-passport`,
+      name: 'give your feedback by email',
+      href: 'mailto:test@feedback.cat'
+    }
+  ])("should match route '$url'", async ({ url, name, href }) => {
+    const { container } = await renderResponse(server, {
+      method: 'GET',
+      url
+    })
+
+    const $phaseBanner = document.querySelector('.govuk-phase-banner')
+    const $link = container.getByRole('link', { name })
+
+    expect($link).toBeInTheDocument()
+    expect($link).toHaveAttribute('href', href)
+    expect($link).toHaveClass('govuk-link')
+
+    expect($phaseBanner).toHaveAttribute('class', 'govuk-phase-banner')
+    expect($phaseBanner).toContainElement($link)
+  })
+})
+
+/**
+ * @import { Server } from '@hapi/hapi'
+ */