feat: tests

packages/core-tools/src/validate.ts

@@ -15,16 +15,17 @@
 import {Logger} from '@openstapps/logger';
 import Ajv from 'ajv';
 import betterAjvErrors, {IOutputError} from 'better-ajv-errors';
-import {PathLike} from 'fs';
+import type {PathLike} from 'fs';
+import {readFile, writeFile} from 'fs/promises';
 import {JSONSchema7} from 'json-schema';
 import mustache from 'mustache';
 import {Schema} from 'ts-json-schema-generator';
-import {globPromisified, readFilePromisified, writeFilePromisified} from './common.js';
 import {ExpectedValidationErrors, ValidationError, ValidationResult} from './types/validator.js';
 import {isThingWithType} from './util/guards.js';
 import path from 'path';
-import re2 from './types/re2.js';
-import {toPosixPath} from './util/posix-path.js';
+import re2 from 're2';
+import {glob} from 'glob';
+import {fileURLToPath} from 'url';
 
 /**
  * StAppsCore validator
@@ -35,13 +36,13 @@ export class Validator {
    */
   private readonly ajv = new Ajv.default({
     verbose: true,
-    code: {regExp: re2},
+    code: {regExp: re2 as never},
   });
 
   /**
    * Map of schema names to schemas
    */
-  private readonly schemas: {[type: string]: Schema} = {};
+  private readonly schemas: { [type: string]: Schema } = {};
 
   /**
    * A wrapper function for Ajv that transforms the error into the compatible old error
@@ -58,8 +59,9 @@ export class Validator {
    *
    * @param schemaDirectory Path to directory that contains schema files
    */
-  public async addSchemas(schemaDirectory: PathLike): Promise<string[]> {
-    const schemaFiles = await globPromisified(path.posix.join(toPosixPath(schemaDirectory), '*.json'));
+  public async addSchemas(schemaDirectory: string): Promise<string[]> {
+    const searchGlob = path.posix.join(schemaDirectory.replaceAll(path.sep, path.posix.sep), '*.json');
+    const schemaFiles = await glob(searchGlob);
 
     if (schemaFiles.length === 0) {
       throw new Error(`No schema files in ${schemaDirectory.toString()}!`);
@@ -70,7 +72,7 @@ export class Validator {
     await Promise.all(
       schemaFiles.map(async (file: string) => {
         // read schema file
-        const buffer = await readFilePromisified(file);
+        const buffer = await readFile(file);
 
         // add schema to map
         this.schemas[path.basename(file, '.json')] = JSON.parse(buffer.toString());
@@ -92,7 +94,7 @@ export class Validator {
     if (schema === undefined) {
       if (isThingWithType(instance)) {
         // schema name can be inferred from type string
-        const schemaSuffix = (instance as {type: string}).type
+        const schemaSuffix = (instance as { type: string }).type
           .split(' ')
           .map((part: string) => {
             return part.slice(0, 1).toUpperCase() + part.slice(1);
@@ -175,8 +177,8 @@ export async function validateFiles(
   const v = new Validator();
   await v.addSchemas(schemaDirectory);
 
-  // get list of files to test
-  const testFiles = await globPromisified(path.join(resourcesDirectory, '*.json'));
+  // get a list of files to test
+  const testFiles = await glob(path.posix.join(resourcesDirectory.replaceAll(path.sep, path.posix.sep), '*.json'), {absolute: true});
 
   if (testFiles.length === 0) {
     throw new Error(`No test files in ${resourcesDirectory}!`);
@@ -191,7 +193,7 @@ export async function validateFiles(
     testFiles.map(async (testFile: string) => {
       const testFileName = path.basename(testFile);
 
-      const buffer = await readFilePromisified(path.join(resourcesDirectory, testFileName));
+      const buffer = await readFile(testFile);
 
       // read test description from file
       const testDescription = JSON.parse(buffer.toString());
@@ -260,12 +262,14 @@ export async function validateFiles(
  * @param errors Errors that occurred in validation
  */
 export async function writeReport(reportPath: PathLike, errors: ExpectedValidationErrors): Promise<void> {
-  // eslint-disable-next-line unicorn/prefer-module
-  let buffer = await readFilePromisified(path.resolve(__dirname, '..', 'resources', 'file.html.mustache'));
+  let buffer = await readFile(
+    path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'resources', 'file.html.mustache'),
+  );
   const fileTemplate = buffer.toString();
 
-  // eslint-disable-next-line unicorn/prefer-module
-  buffer = await readFilePromisified(path.resolve(__dirname, '..', 'resources', 'error.html.mustache'));
+  buffer = await readFile(
+    path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'resources', 'error.html.mustache'),
+  );
   const errorTemplate = buffer.toString();
 
   let output = '';
@@ -295,11 +299,12 @@ export async function writeReport(reportPath: PathLike, errors: ExpectedValidati
     });
   }
 
-  // eslint-disable-next-line unicorn/prefer-module
-  buffer = await readFilePromisified(path.resolve(__dirname, '..', 'resources', 'report.html.mustache'));
+  buffer = await readFile(
+    path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'resources', 'report.html.mustache'),
+  );
   const reportTemplate = buffer.toString();
 
-  await writeFilePromisified(
+  await writeFile(
     reportPath,
     mustache.render(reportTemplate, {
       report: output,