use ajv for release notes test schema (#35300)

Author: rsese

tests/helpers/schemas.js

@@ -0,0 +1,37 @@
+// lightly format the schema errors object returned from ajv to connect the
+// error message to where the problem is -- for example, if a top level 'date'
+// property isn't correctly formatted as a date we return:
+//
+//   at 'date': must match format "date"
+//
+// if sections > features has an array of objects that must have a 'notes'
+// property and we misspell the property name in the first item:
+//
+//   at 'sections > features > item 0': must have required property 'notes'
+export const formatAjvErrors = (errors = []) => {
+  return errors
+    .map((errorObj) => {
+      // ajv instancePath tells us in the data we're checking where there was a
+      // schema error -- for release notes looks like this for example
+      // `/sections/features/0` if the error is in the first feature under sections.
+      const split = errorObj.instancePath.split('/')
+      split.shift()
+
+      if (split.length === 0) {
+        return `at '/' (top-level): ${errorObj.message}`
+      }
+
+      const schemaErrorPath = split
+        .map((item) => {
+          if (!isNaN(item)) {
+            return `item ${item}`
+          } else {
+            return item
+          }
+        })
+        .join(' > ')
+
+      return `at '${schemaErrorPath}': ${errorObj.message}`
+    })
+    .join('\n  ')
+}

tests/helpers/schemas/release-notes-schema.js

@@ -7,17 +7,18 @@ const section = {
     },
     {
       type: 'array',
+      minItems: 1,
       items: {
         type: 'object',
+        required: ['heading', 'notes'],
+        additionalProperties: false,
         properties: {
           heading: {
             type: 'string',
-            required: true,
           },
           notes: {
             type: 'array',
             items: { type: 'string' },
-            required: true,
             minItems: 1,
           },
         },
@@ -27,14 +28,15 @@ const section = {
 }
 
 export default {
+  type: 'object',
+  required: ['date', 'sections'],
   properties: {
     intro: {
       type: 'string',
     },
     date: {
       type: 'string',
       format: 'date',
-      required: true,
     },
     release_candidate: {
       type: 'boolean',
@@ -45,9 +47,9 @@ export default {
       default: false,
     },
     sections: {
-      required: true,
       type: 'object',
       minProperties: 1,
+      additionalProperties: false,
       properties: [
         'bugs',
         'known_issues',

tests/linting/lint-files.js

@@ -5,6 +5,8 @@ import walk from 'walk-sync'
 import { zip } from 'lodash-es'
 import yaml from 'js-yaml'
 import revalidator from 'revalidator'
+import Ajv from 'ajv'
+import addFormats from 'ajv-formats'
 import { fromMarkdown } from 'mdast-util-from-markdown'
 import { visit } from 'unist-util-visit'
 import fs from 'fs/promises'
@@ -18,6 +20,7 @@ import getApplicableVersions from '../../lib/get-applicable-versions.js'
 import { allVersions } from '../../lib/all-versions.js'
 import { jest } from '@jest/globals'
 import { getDiffFiles } from '../helpers/diff-files.js'
+import { formatAjvErrors } from '../helpers/schemas.js'
 
 jest.useFakeTimers({ legacyFakeTimers: true })
 
@@ -345,6 +348,11 @@ if (
   })
 }
 
+// ajv for schema validation tests
+const ajv = new Ajv({ allErrors: true })
+addFormats(ajv)
+const ghesValidate = ajv.compile(releaseNotesSchema)
+
 describe('lint markdown content', () => {
   if (mdToLint.length < 1) return
 
@@ -878,11 +886,14 @@ describe('lint GHES release notes', () => {
     })
 
     it('matches the schema', () => {
-      const { errors } = revalidator.validate(dictionary, releaseNotesSchema)
-      const errorMessage = errors
-        .map((error) => `- [${error.property}]: ${error.actual}, ${error.message}`)
-        .join('\n')
-      expect(errors.length, errorMessage).toBe(0)
+      const valid = ghesValidate(dictionary)
+      let errors
+
+      if (!valid) {
+        errors = formatAjvErrors(ghesValidate.errors)
+      }
+
+      expect(valid, errors).toBe(true)
     })
 
     it('contains valid liquid', () => {

tests/unit/products.js

@@ -1,8 +1,9 @@
 import Ajv from 'ajv'
 import { productMap } from '../../lib/all-products.js'
+import { formatAjvErrors } from '../helpers/schemas.js'
 import schema from '../helpers/schemas/products-schema.js'
 
-const ajv = new Ajv()
+const ajv = new Ajv({ allErrors: true })
 const validate = ajv.compile(schema)
 
 describe('products module', () => {
@@ -17,14 +18,8 @@ describe('products module', () => {
       let errors
 
       if (!valid) {
-        errors = validate.errors
-          .map((errorObj) => {
-            return errorObj.message
-          })
-          .join(', ')
-        errors = `'${product.name}' product schema errors: ${errors}`
+        errors = formatAjvErrors(valid.errors)
       }
-
       expect(valid, errors).toBe(true)
     })
   })