Merge pull request #489 from digital-land/483-update-tests-to-use-moc…

…k-data-generated-from-valibot-schemas

483 update tests to use mock data generated from valibot schemas

package.json

@@ -38,13 +38,15 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@gcornut/valibot-json-schema": "^0.42.0",
     "@playwright/test": "^1.39.0",
     "@testcontainers/localstack": "^10.7.2",
     "@types/node": "^20.8.9",
     "@wiremock/wiremock-testcontainers-node": "^0.0.1",
     "concurrently": "^8.2.2",
     "husky": "^9.0.11",
     "jsdom": "^24.1.0",
+    "json-schema-faker": "^0.5.6",
     "nodemon": "^3.0.1",
     "pluralize": "^8.0.0",
     "standard": "^17.1.0",

src/routes/schemas.js

@@ -30,7 +30,7 @@ export const StartPage = v.object({
  * The values of this enum should match values of the 'status' column
  * in the query in `performanceDbApi.getLpaOverview()`
  */
-const datasetStatusEnum = {
+export const datasetStatusEnum = {
   Live: 'Live',
   'Needs fixing': 'Needs fixing',
   Warning: 'Warning',
@@ -146,14 +146,14 @@ export const OrgIssueDetails = v.strictObject({
     })),
     items: v.array(v.variant('type', [
       v.strictObject({
-        type: v.literal('item'),
+        type: v.literal('number'),
         number: v.integer(),
         href: v.string(),
         current: v.boolean()
       }),
       v.strictObject({
         type: v.literal('ellipsis'),
-        ellipsis: v.boolean(),
+        ellipsis: v.literal(true),
         href: v.string()
       })
     ]))

src/views/organisations/issueDetails.html

@@ -8,7 +8,7 @@
 {% set serviceType = 'Submit'%}
 
 {% if issueEntitiesCount > 1 %}
-  {% set pageName %}{{organisation.name}} - {{dataset.name}} - Issues (Page {{entityNumber}} of {{issueEntitiesCount}}){% endset %}
+  {% set pageName %}{{organisation.name}} - {{dataset.name}} - Issues (Page {{pageNumber}} of {{issueEntitiesCount}}){% endset %}
 {% else %}
   {% set pageName %}{{organisation.name}} - {{dataset.name}} - Issues{% endset %}
 {%endif%}
@@ -75,7 +75,7 @@
       rows: entry.fields
     }) }}
 
-    {% if issueEntitiesCount > 1 %}
+    {% if pagination.items | length > 1 %}
       {{ govukPagination(pagination) }}
     {% endif %}
   </div>

src/views/organisations/overview.html

@@ -69,24 +69,24 @@ <h2 class="govuk-heading-m">Datasets</h2>
         <li class="govuk-task-list__item govuk-task-list__item--with-link">
           <div class="govuk-task-list__name-and-hint">
             <h2 class="govuk-heading-m">
-              {% if dataset.endpoint %}
+              {% if dataset.status == 'Not submitted' %}
                 <a class="govuk-link govuk-task-list__link"
-                  href="/organisations/{{ organisation.organisation }}/{{dataset.slug}}/overview">
+                  href="/organisations/{{ organisation.organisation }}/{{dataset.slug}}/get-started">
                   {{dataset.slug | datasetSlugToReadableName}}
                 </a>
               {% else %}
                 <a class="govuk-link govuk-task-list__link"
-                  href="/organisations/{{ organisation.organisation }}/{{dataset.slug}}/get-started">
+                  href="/organisations/{{ organisation.organisation }}/{{dataset.slug}}/overview">
                   {{dataset.slug | datasetSlugToReadableName}}
                 </a>
               {% endif %}
             </h2>
             <div class="govuk-task-list__hint">
-              {% if dataset.endpoint is null %}
+              {% if dataset.status == 'Not submitted' %}
                 <p>Data URL not submitted</p>
-              {% elif dataset.error %}
+              {% elif dataset.status == 'Error' %}
                 <p>{{dataset.error}}</p>
-              {% elif dataset.issue_count > 0 %}
+              {% elif dataset.status == 'Needs fixing' > 0 %}
                 <p>There are {{ dataset.issue_count }} {{ "issue" | pluralise(dataset.issue_count) }} in this dataset</p>
               {% else %}
                 <p>Data URL submitted</p>

test/unit/dataset-details.test.js

@@ -5,10 +5,12 @@ import { setupNunjucks } from '../../src/serverSetup/nunjucks.js'
 import { runGenericPageTests } from './generic-page.js'
 import { stripWhitespace } from '../utils/stripWhiteSpace.js'
 import { testValidationErrorMessage } from './validation-tests.js'
-import { mockDataSubjects } from './data.js'
 import { render } from '../../src/utils/custom-renderer.js'
 import * as v from 'valibot'
 
+import mock from '../utils/mocker.js'
+import { DatasetDetails } from '../../src/routes/schemas.js'
+
 const nunjucks = setupNunjucks({ datasetNameMapping: new Map() })
 
 function errorTestFn ({
@@ -38,32 +40,21 @@ function errorTestFn ({
   }
 }
 
-describe('dataset details View', () => {
-  const params = {
-    organisation: {
-      name: 'mock org',
-      organisation: 'mock-org'
-    },
-    dataset: {
-      name: 'mock dataset',
-      dataset: 'mock-dataset',
-      collection: 'mock-collection'
-    },
-    values: {
-      dataset: 'mockDataset'
-    },
-    errors: {}
-  }
+const seed = new Date().getTime()
+
+describe(`dataset details View (seed: ${seed})`, () => {
+  const params = mock(DatasetDetails, seed)
+  params.errors = {}
   const html = stripWhitespace(nunjucks.render('dataset-details.html', params))
-  const datasetName = mockDataSubjects.mockDataset.dataSets[0].value
+  const datasetName = params.values.dataset.toLowerCase()
 
   runGenericPageTests(html, {
-    pageTitle: `Enter ${datasetName.toLowerCase()} details - Submit and update your planning data`
+    pageTitle: `Enter ${datasetName} details - Submit and update your planning data`
   })
 
   it('should render the correct header', () => {
     const regex = new RegExp(
-      `<h1 class="govuk-heading-l".*${datasetName.toLowerCase()} details.*</h1>`,
+      `<h1 class="govuk-heading-l".*${datasetName} details.*</h1>`,
       'g'
     )