@defra/forms-engine-plugin 0.0.1

package/test/condition/checkboxes.test.js

@@ -0,0 +1,112 @@
+import { resolve } 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'
+
+const basePath = '/checkboxes'
+const key = 'wqJmSf'
+
+jest.mock('~/src/server/plugins/engine/services/formsService.js')
+
+describe('Checkboxes based conditions', () => {
+  /** @type {Server} */
+  let server
+
+  // Create server before each test
+  beforeAll(async () => {
+    server = await createServer({
+      formFileName: 'checkboxes.json',
+      formFilePath: resolve(import.meta.dirname, '../form/definitions')
+    })
+
+    await server.initialize()
+  })
+
+  beforeEach(() => {
+    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+  })
+
+  test('Checkboxes are rendered', async () => {
+    const { container } = await renderResponse(server, {
+      url: `${basePath}/first-page`
+    })
+
+    for (const example of [
+      {
+        name: key,
+        id: key,
+        text: 'Shire',
+        value: 'shire'
+      },
+      {
+        name: key,
+        id: `${key}-2`,
+        text: 'Race',
+        value: 'race'
+      },
+      {
+        name: key,
+        id: `${key}-3`,
+        text: 'Pantomime',
+        value: 'pantomime'
+      },
+      {
+        name: key,
+        id: `${key}-4`,
+        text: 'Other',
+        value: 'other'
+      }
+    ]) {
+      const $checkbox = container.getByRole('checkbox', {
+        name: example.text
+      })
+
+      expect($checkbox).toBeInTheDocument()
+      expect($checkbox).toHaveAttribute('id', example.id)
+      expect($checkbox).toHaveAttribute('name', example.name)
+      expect($checkbox).toHaveAttribute('value', example.value)
+      expect($checkbox).toHaveClass('govuk-checkboxes__input')
+      expect($checkbox).not.toBeChecked()
+    }
+  })
+
+  test('Testing POST /first-page with nothing checked redirects correctly', async () => {
+    const form = {}
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.SEE_OTHER)
+    expect(res.headers.location).toBe(`${basePath}/second-page`)
+  })
+
+  test('Testing POST /first-page with "other" checked redirects correctly', async () => {
+    const form = {
+      [key]: 'other'
+    }
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.SEE_OTHER)
+    expect(res.headers.location).toBe(`${basePath}/third-page`)
+  })
+})
+
+/**
+ * @import { Server } from '@hapi/hapi'
+ */

package/test/condition/radios.test.js

@@ -0,0 +1,112 @@
+import { resolve } 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'
+
+const basePath = '/radios'
+const key = 'wqJmSf'
+
+jest.mock('~/src/server/plugins/engine/services/formsService.js')
+
+describe('Radio based conditions', () => {
+  /** @type {Server} */
+  let server
+
+  // Create server before each test
+  beforeAll(async () => {
+    server = await createServer({
+      formFileName: 'radios.json',
+      formFilePath: resolve(import.meta.dirname, '../form/definitions')
+    })
+
+    await server.initialize()
+  })
+
+  beforeEach(() => {
+    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+  })
+
+  test('Radio are rendered', async () => {
+    const { container } = await renderResponse(server, {
+      url: `${basePath}/first-page`
+    })
+
+    for (const example of [
+      {
+        name: key,
+        id: key,
+        text: 'Shire',
+        value: 'shire'
+      },
+      {
+        name: key,
+        id: `${key}-2`,
+        text: 'Race',
+        value: 'race'
+      },
+      {
+        name: key,
+        id: `${key}-3`,
+        text: 'Pantomime',
+        value: 'pantomime'
+      },
+      {
+        name: key,
+        id: `${key}-4`,
+        text: 'Other',
+        value: 'other'
+      }
+    ]) {
+      const $radio = container.getByRole('radio', {
+        name: example.text
+      })
+
+      expect($radio).toBeInTheDocument()
+      expect($radio).toHaveAttribute('id', example.id)
+      expect($radio).toHaveAttribute('name', example.name)
+      expect($radio).toHaveAttribute('value', example.value)
+      expect($radio).toHaveClass('govuk-radios__input')
+      expect($radio).not.toBeChecked()
+    }
+  })
+
+  test('Testing POST /first-page with nothing checked redirects correctly', async () => {
+    const form = {}
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.SEE_OTHER)
+    expect(res.headers.location).toBe(`${basePath}/second-page`)
+  })
+
+  test('Testing POST /first-page with "other" checked redirects correctly', async () => {
+    const form = {
+      [key]: 'other'
+    }
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.SEE_OTHER)
+    expect(res.headers.location).toBe(`${basePath}/third-page`)
+  })
+})
+
+/**
+ * @import { Server } from '@hapi/hapi'
+ */

package/test/condition/text.test.js

@@ -0,0 +1,103 @@
+import { resolve } 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'
+
+const basePath = '/text'
+const key = 'wqJmSf'
+
+jest.mock('~/src/server/plugins/engine/services/formsService.js')
+
+describe('TextField based conditions', () => {
+  /** @type {Server} */
+  let server
+
+  // Create server before each test
+  beforeAll(async () => {
+    server = await createServer({
+      formFileName: 'text.json',
+      formFilePath: resolve(import.meta.dirname, '../form/definitions')
+    })
+
+    await server.initialize()
+  })
+
+  beforeEach(() => {
+    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+  })
+
+  test('TextField is rendered', async () => {
+    const { container } = await renderResponse(server, {
+      url: `${basePath}/first-page`
+    })
+
+    const $input = container.getByRole('textbox', {
+      name: 'First page (optional)'
+    })
+
+    const $warning = container.getByRole('link', {
+      name: 'enter the email address (opens in new tab)'
+    })
+
+    expect($warning).toBeInTheDocument()
+    expect($input).toBeInTheDocument()
+    expect($input).toHaveAttribute('id', key)
+    expect($input).toHaveAttribute('name', key)
+    expect($input).toHaveClass('govuk-input')
+    expect($input).not.toHaveValue()
+  })
+
+  test('Testing POST /first-page without values does not redirect', async () => {
+    const form = {}
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.OK)
+  })
+
+  test('Testing POST /first-page with an empty string redirects correctly', async () => {
+    const form = {
+      [key]: ''
+    }
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.SEE_OTHER)
+    expect(res.headers.location).toBe(`${basePath}/second-page`)
+  })
+
+  test('Testing POST /first-page with an string "other" redirects correctly', async () => {
+    const form = {
+      [key]: 'other'
+    }
+
+    const res = await server.inject({
+      url: `${basePath}/first-page`,
+      method: 'POST',
+      payload: form
+    })
+
+    expect(res.statusCode).toBe(StatusCodes.SEE_OTHER)
+    expect(res.headers.location).toBe(`${basePath}/third-page`)
+  })
+})
+
+/**
+ * @import { Server } from '@hapi/hapi'
+ */

package/test/fixtures/assets-manifest.json

@@ -0,0 +1,4 @@
+{
+  "example.mjs": "javascripts/example.xxxxxxx.min.js",
+  "example.scss": "stylesheets/example.xxxxxxx.min.css"
+}

package/test/fixtures/form.js

@@ -0,0 +1,86 @@
+import {
+  ComponentType,
+  ControllerPath,
+  ControllerType
+} from '@defra/forms-model'
+
+const now = new Date()
+
+/**
+ * @satisfies {FormMetadataAuthor}
+ */
+export const author = {
+  id: 'J6PlucvwkmNlYxX9HnSEj27AcJAVx_08IvZ-IPNTvAN',
+  displayName: 'Enrique Chase'
+}
+
+/**
+ * @satisfies {FormMetadataState}
+ */
+export const state = {
+  createdAt: now,
+  createdBy: author,
+  updatedAt: now,
+  updatedBy: author
+}
+
+/**
+ * @satisfies {FormMetadata}
+ */
+export const metadata = {
+  id: '661e4ca5039739ef2902b214',
+  slug: 'test-form',
+  title: 'Test form',
+  organisation: 'Defra',
+  teamName: 'Defra Forms',
+  teamEmail: 'defraforms@defra.gov.uk',
+  createdAt: now,
+  createdBy: author,
+  updatedAt: now,
+  updatedBy: author
+}
+
+/**
+ * @satisfies {FormDefinition}
+ */
+export const definition = {
+  name: '',
+  startPage: '/page-one',
+  pages: [
+    {
+      path: '/page-one',
+      title: 'Page one',
+      section: 'section',
+      components: [
+        {
+          type: ComponentType.TextField,
+          name: 'textField',
+          title: 'This is your first field',
+          hint: 'Help text',
+          options: {},
+          schema: {}
+        }
+      ],
+      next: [{ path: ControllerPath.Summary }]
+    },
+    {
+      title: 'Summary',
+      path: ControllerPath.Summary,
+      controller: ControllerType.Summary
+    }
+  ],
+  sections: [
+    {
+      name: 'section',
+      title: 'Section title',
+      hideTitle: false
+    }
+  ],
+  conditions: [],
+  lists: [],
+  outputEmail: 'enrique.chase@defra.gov.uk'
+}
+
+/**
+ * @import { FormDefinition, FormMetadata, FormMetadataAuthor, FormMetadataState } from '@defra/forms-model'
+ */

package/test/fixtures/index.js

@@ -0,0 +1,2 @@
+export * as form from '~/test/fixtures/form.js'
+export * as list from '~/test/fixtures/list.js'

package/test/fixtures/list.js

@@ -0,0 +1,92 @@
+/**
+ * @satisfies {List}
+ */
+export const listNumber = {
+  title: 'Example number list',
+  name: 'listNumber',
+  type: 'number',
+  items: [
+    { text: '1 point', value: 1 },
+    { text: '2 points', value: 2 },
+    { text: '3 points', value: 3 },
+    { text: '4 points', value: 4 }
+  ]
+}
+
+export const listNumberExamples = [
+  {
+    text: '1 point',
+    value: 1,
+    state: 1
+  },
+  {
+    text: '2 points',
+    value: 2,
+    state: 2
+  },
+  {
+    text: '3 points',
+    value: 3,
+    state: 3
+  },
+  {
+    text: '4 points',
+    value: 4,
+    state: 4
+  }
+]
+
+/**
+ * @satisfies {List}
+ */
+export const listString = {
+  title: 'Example string list',
+  name: 'listString',
+  type: 'string',
+  items: [
+    { text: '1 hour', value: '1' },
+    { text: '2 hours', value: '2' },
+    { text: '3 hours', value: '3' },
+    { text: '4 hours', value: '4' }
+  ]
+}
+
+export const listStringExamples = [
+  {
+    text: '1 hour',
+    value: '1',
+    state: '1'
+  },
+  {
+    text: '2 hours',
+    value: '2',
+    state: '2'
+  },
+  {
+    text: '3 hours',
+    value: '3',
+    state: '3'
+  },
+  {
+    text: '4 hours',
+    value: '4',
+    state: '4'
+  }
+]
+
+export const listYesNoExamples = [
+  {
+    text: 'Yes',
+    value: true,
+    state: true
+  },
+  {
+    text: 'No',
+    value: false,
+    state: false
+  }
+]
+
+/**
+ * @import { List } from '@defra/forms-model'
+ */