Extract validation to its own file

Author: norascheuch

extensions/ql-vscode/package-lock.json

@@ -1299,6 +1299,7 @@
     "@primer/react": "^35.0.0",
     "@vscode/codicons": "^0.0.31",
     "@vscode/webview-ui-toolkit": "^1.0.1",
+    "ajv": "^8.11.0",
     "child-process-promise": "^2.2.1",
     "chokidar": "^3.5.3",
     "classnames": "~2.2.6",
@@ -1389,7 +1390,6 @@
     "@typescript-eslint/eslint-plugin": "^4.26.0",
     "@typescript-eslint/parser": "^4.26.0",
     "@vscode/test-electron": "^2.2.0",
-    "ajv": "^8.11.0",
     "ansi-colors": "^4.1.1",
     "applicationinsights": "^2.3.5",
     "babel-loader": "^8.2.5",

extensions/ql-vscode/package.json

@@ -0,0 +1,63 @@
+import { DbConfig } from './db-config';
+import Ajv from 'ajv';
+
+export function validateDbConfig(dbConfig: DbConfig): string[] {
+  const ajv = new Ajv({ allErrors: true });
+
+  const schema = {
+    type: 'object',
+    properties: {
+      remote: {
+        type: 'object',
+        properties: {
+          repositoryLists: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                name: {
+                  type: 'string'
+                },
+                repositories: {
+                  type: 'array',
+                  items: {
+                    type: 'string',
+                    pattern: '^[a-zA-Z0-9-_\\.]+/[a-zA-Z0-9-_\\.]+$'
+                  }
+                }
+              },
+              required: ['name', 'repositories'],
+              additionalProperties: false
+            }
+          },
+          owners: {
+            type: 'array',
+            items: {
+              type: 'string',
+              pattern: '^[a-zA-Z0-9-_\\.]+$'
+            }
+          },
+          repositories: {
+            type: 'array',
+            items: {
+              type: 'string',
+              pattern: '^[a-zA-Z0-9-_\\.]+/[a-zA-Z0-9-_\\.]+$'
+            }
+          }
+        },
+        required: ['repositoryLists', 'owners', 'repositories'],
+        additionalProperties: false
+      }
+    },
+    required: ['remote'],
+    additionalProperties: false
+  };
+
+  ajv.validate(schema, dbConfig);
+
+  if (ajv.errors) {
+    return ajv.errors.map((error) => `${error.instancePath} ${error.message}`);
+  }
+
+  return [];
+}

extensions/ql-vscode/src/databases/db-config-validation.ts

@@ -6,7 +6,6 @@ import { expect } from 'chai';
 describe('db config store', async () => {
   const tempWorkspaceStoragePath = path.join(__dirname, 'test-workspace');
   const testDataStoragePath = path.join(__dirname, 'data');
-  const corruptedTestDataStoragePath = path.join(__dirname, 'corruptedData');
 
   beforeEach(async () => {
     await fs.ensureDir(tempWorkspaceStoragePath);
@@ -54,28 +53,4 @@ describe('db config store', async () => {
     const reRetrievedConfig = configStore.getConfig();
     expect(reRetrievedConfig.remote.repositoryLists).to.have.length(1);
   });
-
-  it('should return error when file is not valid', async () => {
-    const configStore = new DbConfigStore(corruptedTestDataStoragePath);
-    await configStore.initialize();
-
-    const validationOutput = configStore.validateConfig();
-    expect(validationOutput).to.have.length(2);
-    if (validationOutput) {
-      expect(validationOutput[0]).to.deep.equal({
-        'instancePath': '/remote',
-        'keyword': 'required',
-        'message': 'must have required property \'owners\'',
-        'params': { 'missingProperty': 'owners' },
-        'schemaPath': '#/properties/remote/required'
-      });
-      expect(validationOutput[1]).to.deep.equal({
-        'instancePath': '/remote',
-        'keyword': 'additionalProperties',
-        'message': 'must NOT have additional properties',
-        'params': { 'additionalProperty': 'somethingElse' },
-        'schemaPath': '#/properties/remote/additionalProperties'
-      });
-    }
-  });
 });

extensions/ql-vscode/test/pure-tests/databases/corruptedData/workspace-databases.json

@@ -0,0 +1,28 @@
+import { validateDbConfig } from '../../../src/databases/db-config-validation';
+import { DbConfig } from '../../../src/databases/db-config';
+
+describe.only('db config validation', async () => {
+  it('should return error when file is not valid', async () => {
+    // We're intentionally bypassing the type check because we'd
+    // like to make sure validation errors are highlighted.
+    const dbConfig = {
+      'remote': {
+        'repositoryLists': [
+          {
+            'name': 'repoList1',
+            'repositories': ['foo/bar', 'foo/baz']
+          }
+        ],
+        'repositories': ['owner/repo1', 'owner/repo2', 'owner/repo3'],
+        'somethingElse': 'bar'
+      }
+    } as any as DbConfig;
+
+    const validationOutput = validateDbConfig(dbConfig);
+
+    expect(validationOutput).to.have.length(2);
+
+    expect(validationOutput[0]).to.deep.equal('/remote must have required property \'owners\'');
+    expect(validationOutput[1]).to.deep.equal('/remote must NOT have additional properties');
+  });
+});