Refactory fileloader test utility

Author: r59q

src/__tests__/archtest/fileloader.ts

@@ -0,0 +1,52 @@
+/**
+ * (c) 2023-2025, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+import fs from 'fs';
+import * as path from 'path';
+
+const directoriesToScan = ['./src/'];
+
+export interface DirectoryContents {
+  files: string[];
+  folders: string[];
+}
+
+export const readDirectory = (
+  directory: string,
+  ignoreList: string[],
+): DirectoryContents => {
+  const files: string[] = [];
+  const folders: string[] = [];
+  const filesRead = fs.readdirSync(directory);
+  filesRead.forEach(file => {
+    if (ignoreList.includes(file)) return;
+    if (file.endsWith('.json')) return; // Json cant have comments
+    const fileLocation = path.join(directory, file);
+    const stats = fs.statSync(fileLocation);
+    if (stats.isFile()) {
+      files.push(fileLocation);
+    } else {
+      folders.push(fileLocation);
+    }
+  });
+  return { files: files, folders: folders };
+};
+
+export const getFilesInDirectory = (
+  directory: string,
+  ignoredFiles: string[],
+): string[] => {
+  const files: string[] = [];
+  const content = readDirectory(directory, ignoredFiles);
+  const filesFromSubFolders: string[] = [];
+  content.folders.forEach(value => {
+    const subFolderFlat = getFilesInDirectory(value, ignoredFiles);
+    subFolderFlat.forEach(value => filesFromSubFolders.push(value));
+  });
+  filesFromSubFolders.forEach(value => files.push(value));
+  content.files.forEach(value => files.push(value));
+  return files;
+};

src/__tests__/archtest/lib-dependency.test.ts

@@ -0,0 +1,12 @@
+/**
+ * @vitest-environment jsdom
+ */
+/**
+ * (c) 2023-2025, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+describe('Dependency direction test', () => {
+  test('Files in lib should not depend on files in components', () => {});
+});

src/__tests__/archtest/license-identifiers.test.ts

@@ -9,6 +9,7 @@
 
 import fs from 'fs';
 import * as path from 'path';
+import { getFilesInDirectory } from './fileloader';
 
 // Place files you wish to ignore by name in here
 const ignoredFiles: string[] = ['.DS_Store', 'ui.da.json', 'ui.en.json', 'README.md'];
@@ -26,42 +27,6 @@ const readFile = (fileLocation: string, expect: string) => {
   return fileContent.toString().toLowerCase().includes(expect.toLowerCase());
 };
 
-type DirectoryContents = {
-  files: string[];
-  folders: string[];
-};
-
-const readDirectory = (directory: string, ignoreList: string[]): DirectoryContents => {
-  const files: string[] = [];
-  const folders: string[] = [];
-  const filesRead = fs.readdirSync(directory);
-  filesRead.forEach(file => {
-    if (ignoreList.includes(file)) return;
-    if (file.endsWith('.json')) return; // Json cant have comments
-    const fileLocation = path.join(directory, file);
-    const stats = fs.statSync(fileLocation);
-    if (stats.isFile()) {
-      files.push(fileLocation);
-    } else {
-      folders.push(fileLocation);
-    }
-  });
-  return { files: files, folders: folders };
-};
-
-const flattenDirectory = (directory: string): string[] => {
-  const files: string[] = [];
-  const content = readDirectory(directory, ignoredFiles);
-  const filesFromSubFolders: string[] = [];
-  content.folders.forEach(value => {
-    const subFolderFlat = flattenDirectory(value);
-    subFolderFlat.forEach(value => filesFromSubFolders.push(value));
-  });
-  filesFromSubFolders.forEach(value => files.push(value));
-  content.files.forEach(value => files.push(value));
-  return files;
-};
-
 const filesMissingIdentifier = (files: string[], expects: string[]): string[] => {
   const filesWithMissingIdentifier: string[] = [];
 
@@ -82,7 +47,7 @@ describe('License identifier tests', () => {
     'All files should contain license identifier',
     () => {
       const flatten = directoriesToScan.reduce((acc: string[], current) => {
-        return acc.concat(flattenDirectory(current));
+        return acc.concat(getFilesInDirectory(current, ignoredFiles));
       }, []);
 
       const faultyFiles = filesMissingIdentifier(flatten, [