feat: validate config with schema

lib/env.js

@@ -6,5 +6,6 @@ module.exports = {
   CREATE_PR_COMMENT: process.env.CREATE_PR_COMMENT || 'true',
   CREATE_ERROR_ISSUE: process.env.CREATE_ERROR_ISSUE || 'true',
   BLOCK_REPO_RENAME_BY_HUMAN: process.env.BLOCK_REPO_RENAME_BY_HUMAN || 'false',
-  FULL_SYNC_NOP: process.env.FULL_SYNC_NOP === 'true'
+  FULL_SYNC_NOP: process.env.FULL_SYNC_NOP === 'true',
+  VALIDATE_CONFIG_SCHEMA: process.env.VALIDATE_CONFIG_SCHEMA === 'true'
 }

lib/settings.js

@@ -1,16 +1,21 @@
 const path = require('path')
 const { Eta } = require('eta')
-const commetMessageTemplate = require('./commentmessage')
+const commentMessageTemplate = require('./commentmessage')
 const errorTemplate = require('./error')
 const Glob = require('./glob')
 const NopCommand = require('./nopcommand')
 const MergeDeep = require('./mergeDeep')
-const Archive = require('./plugins/archive')
 const env = require('./env')
 const CONFIG_PATH = env.CONFIG_PATH
 const eta = new Eta({ views: path.join(__dirname) })
 const SCOPE = { ORG: 'org', REPO: 'repo' } // Determine if the setting is a org setting or repo setting
 const yaml = require('js-yaml');
+const Ajv = require('ajv/dist/2020')
+const schema = require('../schema/dereferenced/settings.json');
+
+const ajv = new Ajv({
+  strict: false
+})
 
 class Settings {
   static fileCache = {};
@@ -99,6 +104,34 @@ class Settings {
       }
     }
     this.mergeDeep = new MergeDeep(this.log, this.github, [], this.configvalidators, this.overridevalidators)
+
+    const filePath = path.posix.join(env.CONFIG_PATH, env.SETTINGS_FILE_PATH)
+    const validation = this.validateConfig(this.config)
+
+    if (validation instanceof Error) {
+      this.appendToResults([{
+        type: 'ERROR',
+        plugin: 'settings',
+        repo: this.repo.repo,
+        action: {
+          msg: `${filePath} fails schema validation:\n${validation.message}`
+        }
+      }])
+
+      this.logError(`${filePath} fails schema validation:\n${validation.message}`)
+    }
+  }
+
+  validateConfig (config) {
+    if (env.VALIDATE_CONFIG_SCHEMA) {
+      const valid = ajv.validate(schema, config)
+
+      if (!valid) {
+        return new Error(ajv.errorsText(ajv.errors))
+      }
+    }
+
+    return true
   }
 
   // Create a check in the Admin repo for safe-settings.
@@ -232,7 +265,7 @@ class Settings {
     <tbody>
     `
 
-    const renderedCommentMessage = await eta.renderString(commetMessageTemplate, stats)
+    const renderedCommentMessage = await eta.renderString(commentMessageTemplate, stats)
 
     if (env.CREATE_PR_COMMENT === 'true') {
       const summary = `
@@ -246,7 +279,7 @@ ${this.results.reduce((x, y) => {
           error = true
           return `${x}
 <tr><td> ❗ ${y.action.msg} </td><td> ${y.plugin} </td><td> ${prettify(y.repo)} </td><td> ${prettify(y.action.additions)} </td><td> ${prettify(y.action.deletions)} </td><td> ${prettify(y.action.modifications)} </td><tr>`
-        } else if (y.action.additions === null && y.action.deletions === null && y.action.modifications === null) {
+        } else if (y.action?.additions === null && y.action.deletions === null && y.action.modifications === null) {
           return `${x}`
         } else {
           if (y.action === undefined) {
@@ -644,7 +677,7 @@ ${this.results.reduce((x, y) => {
   /**
    * If repo param is null load configs for all repos
    * If repo param is null and suborg change, load configs for suborg repos only
-   * If repo partam is not null, load the config for a specific repo
+   * If repo param is not null, load the config for a specific repo
    * @param {*} repo repo param
    * @returns repoConfigs object
    */
@@ -844,6 +877,20 @@ ${this.results.reduce((x, y) => {
         }
       }
 
+      const validation = this.validateConfig(content)
+
+      if (validation instanceof Error) {
+        this.appendToResults([{
+          type: 'ERROR',
+          plugin: 'settings',
+          repo: this.repo.repo,
+          action: {
+            msg: `${namespacedFilepath} fails schema validation:\n${validation.message}`
+          }
+        }])
+        this.logError(`${namespacedFilepath} fails schema validation:\n${validation.message}`)
+      }
+
       return content
     } catch (e) {
       if (e.status === 404) {

package.json

@@ -27,6 +27,7 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^12.0.2",
     "@probot/adapter-aws-lambda-serverless": "^4.0.3",
+    "ajv": "^8.17.1",
     "deepmerge": "^4.3.1",
     "eta": "^3.5.0",
     "js-yaml": "^4.1.0",

test/unit/lib/settings-validation.test.js

@@ -0,0 +1,47 @@
+/* eslint-disable no-undef */
+const Settings = require('../../../lib/settings')
+
+jest.mock('../../../lib/env', () => ({
+  VALIDATE_CONFIG_SCHEMA: true,
+  CONFIG_PATH: '.github',
+  SETTINGS_FILE_PATH: 'settings.yml'
+}))
+
+const context = {
+  log: {
+    debug: jest.fn(),
+    info: jest.fn(),
+    error: jest.fn()
+  },
+  payload: {
+    installation: {
+      id: 123
+    }
+  }
+}
+
+describe('Settings Validation Tests', () => {
+  it('should validate config schema when VALIDATE_CONFIG_SCHEMA is true', async () => {
+    const settings = new Settings(true, context, {}, {
+      repositories: {
+        has_wiki: 'nonsense'
+      }
+    }, 'main', 'github')
+
+    expect(settings.results).toContainEqual(expect.objectContaining({
+      action: {
+        msg: expect.stringContaining('has_wiki must be boolean')
+      }
+    }))
+  })
+
+  it('should pass valid config', async () => {
+    const settings = new Settings(false, context, {}, {
+      repositories: {
+        has_wiki: true
+      }
+    }, 'main', 'github')
+
+    expect(settings.results).toEqual([])
+  })
+}) // Settings Tests

test/unit/lib/settings.test.js

@@ -82,8 +82,6 @@ repository:
       }
     }
 
-
-
     mockRepo = { owner: 'test', repo: 'test-repo' }
     mockRef = 'main'
     mockSubOrg = 'frontend'