chore: Unit tests

Author: Mat Walker

package.json

@@ -41,7 +41,6 @@
     "@types/luxon": "^3.6.2",
     "jest": "^29.6.0",
     "papaparse": "^5.5.3",
-    "parse5": "^7.3.0",
     "semantic-release": "^22.0.0",
     "ts-jest": "^29.1.0",
     "typescript": "^5.8.3"

src/general/log.spec.ts

@@ -1,4 +1,5 @@
 import { Log } from "./log";
+import { readFileSync } from "fs";
 
 
 // Unit tests for Log utility
@@ -62,6 +63,16 @@ describe('Log', () => {
       // ERROR - [07:58:18][00:00:00.0] [Object.<anonymous>(Log.spec.ts:15:17)]: Basic test
       expect(logOutput[0]).toMatch(/^.*: Basic test]$/);
     });
+    it('Log Level NoOutput', () => {
+      Log.writeLine(Log.LogLevels.NoOutput, 'Basic test');
+      expect(logOutput.length).toStrictEqual(0);
+    });
+    it('Check Error throwning if our output is bad stores', () => {
+      Log.throwErrorIfLogOutputFails = true;
+      expect(Log.throwErrorIfLogOutputFails).toEqual(true);
+      Log.throwErrorIfLogOutputFails = false;
+      expect(Log.throwErrorIfLogOutputFails).toEqual(false);
+    });
   });
 
   describe('Multiline logging', () => {
@@ -207,6 +218,10 @@ describe('Log', () => {
       Log.loggingCurrentLevel = level;
       expect(Log.loggingCurrentLevelText).toMatch(expectedText);
     });
+    it('Level is unknown (Should be impossible!)', () => {
+      (Log as any)['_loggingCurrentLevel'] = -10;
+      expect(Log.loggingCurrentLevelText).toMatch("Unknown!");
+    });
     it.each([
       ["Framework debug", "Framework debug (FKDBG)"],
       ["Framework information", "Framework information (FKINF)"],
@@ -277,6 +292,34 @@ describe('Log', () => {
 
   });
 
+  describe('General Attach test steps', () => {
+    let logOutput = new Array<string>;
+    beforeEach(() => {
+      logOutput = [];
+      Log.logOutputCallback = (message, mediaType) => {
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+    });
+    it('Verify a bad type is detected in error message', () => {
+      Log.logOutputCallback = (message, mediaType) => {
+        if (mediaType === 'base64:image/png') throw new Error('My Error');
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+      (Log.attach as (logLevel: Log.LogLevels, badParam: any, mediaType: string) => void)(0, 24, "base64:image/png");
+      expect(logOutput.length).toEqual(6);
+      expect(logOutput[3]).toMatch(/Not a string! Is type number/);
+    });
+    it('Verify a very long attach is truncated to avoid results overruns', () => {
+      Log.logOutputCallback = (message, mediaType) => {
+        if (mediaType === 'base64:image/png') throw new Error('My Error');
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+      Log.attach(0, "A very long text that will have to be truncated so that it doesnt overrun", "base64:image/png")
+      expect(logOutput.length).toEqual(6);
+      expect(logOutput[3]).toMatch(/A very long text that wil.\.\.run/);
+    });
+  });
+
   describe('Screenshot test steps', () => {
     let logOutput = new Array<string>;
     beforeEach(() => {
@@ -295,6 +338,194 @@ describe('Log', () => {
       expect(Log.screenshotSteps).toEqual(true);
     });
 
+    it('Check screen buffer attachment', () => {
+      const testString = "Test string";
+      const testBuffer = Buffer.from("Test string", 'utf8');
+      const base64 = testBuffer.toString('base64');
+      Log.attachScreenshot(0, testBuffer);
+      expect(logOutput.length).toEqual(1);
+      expect(logOutput[0]).toMatch(new RegExp(`MediaType\: \[base64\:image\/png\]\, Message\: \[${base64}\]`.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+    });
+
+    it('Check screen string attachment', () => {
+      const testString = "Test string";
+      const testBuffer = Buffer.from("Test string", 'utf8');
+      const base64 = testBuffer.toString('base64');
+      Log.attachScreenshot(0, testString);
+      expect(logOutput.length).toEqual(1);
+      expect(logOutput[0]).toMatch(new RegExp(`MediaType\: \[base64\:image\/png\]\, Message\: \[${base64}\]`.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+    });
+
+    it('Check if Reporter doesnt like it', () => {
+      const testText = 'No Like';
+      const screenShot = 'test';
+      Log.logOutputCallback = (message, mediaType) => {
+        if (mediaType === 'base64:image/png') throw new Error(testText);
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+      Log.attachScreenshot(0, screenShot);
+      expect(logOutput.length).toEqual(6);
+      expect(logOutput[0]).toMatch(/\[ERROR/);  // First is the error description
+      expect(logOutput[1]).toMatch(new RegExp(`\[${testText}\]`)); // Then the error the Callback threw
+      expect(logOutput[3]) // Forth line is the attachment text
+        .toMatch(new RegExp(`\[${Buffer // In our case base64 encoded screenshot
+          .from(screenShot, 'utf8').toString('base64')}\]`));
+      expect(logOutput[5]).toMatch(/\[base64:image\/png\]/); // Last line is the media type
+    });
+
+    it('Check if Reporter doesnt like it but throwing an error', () => {
+      const testText = 'No Like';
+      const screenShot = 'test';
+      Log.throwErrorIfLogOutputFails = true;
+      Log.logOutputCallback = (message, mediaType) => {
+        if (mediaType === 'base64:image/png') throw new Error(testText);
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+      let errorText = "";
+      try {
+        Log.attachScreenshot(0, screenShot);
+      }
+      catch (err) {
+        errorText = (err as Error).message;
+      }
+      logOutput = errorText.split('\n');
+      expect(logOutput.length).toEqual(6);
+      expect(logOutput[0]).toMatch(/Error thrown from Log Output Callback/);  // First is the error description
+      expect(logOutput[1]).toMatch(new RegExp(`${testText}`)); // Then the error the Callback threw
+      expect(logOutput[3]) // Forth line is the attachment text
+        .toMatch(new RegExp(`${Buffer // In our case base64 encoded screenshot
+          .from(screenShot, 'utf8').toString('base64')}`));
+      expect(logOutput[5]).toMatch(/base64:image\/png/); // Last line is the media type
+    });
+
+
+
+  });
+
+  describe('Video test steps', () => {
+    let logOutput = new Array<string>;
+    beforeEach(() => {
+      logOutput = [];
+      Log.logOutputCallback = (message, mediaType) => {
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+    });
+    afterEach(() => {
+      Log.reset();
+    });
+
+    it('Check video buffer attachment', () => {
+      const testString = "Test string";
+      const testBuffer = Buffer.from(testString, 'utf8');
+      const base64 = testBuffer.toString('base64');
+
+      Log.attachVideo(0, testBuffer);
+
+      expect(logOutput.length).toEqual(1);
+      const videoHTML = `<video controls width="320" height="180"><source src="data:video/webm;base64,${base64}" type="video/webm">Video (Codec webm) not supported by browser</video>`;
+      const expected = `MediaType: [text/html], Message: [${videoHTML}]`;
+      expect(logOutput[0]).toMatch(new RegExp(expected.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+    });
+
+    it('Check video buffer attachment using options', () => {
+      const testString = "Test string";
+      const width = 300;
+      const height = 200;
+      const codec = "Mats_Own";
+      const testBuffer = Buffer.from(testString, 'utf8');
+      const base64 = testBuffer.toString('base64');
+
+      Log.attachVideo(0, testBuffer, { width: width, height: height, videoCodec: codec });
+
+      expect(logOutput.length).toEqual(1);
+      const videoHTML = `<video controls width="${width}" height="${height}"><source src="data:video/${codec};base64,${base64}" type="video/${codec}">Video (Codec ${codec}) not supported by browser</video>`;
+      const expected = `MediaType: [text/html], Message: [${videoHTML}]`;
+      expect(logOutput[0]).toMatch(new RegExp(expected.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+
+    });
+
+    it('Check video buffer attachment with only hight modified', () => {
+      const testString = "Test string";
+      const width = 320;
+      const height = 200;
+      const codec = "webm";
+      const testBuffer = Buffer.from(testString, 'utf8');
+      const base64 = testBuffer.toString('base64');
+
+      Log.videoResolution = { height: height };
+
+      Log.attachVideo(0, testBuffer);
+
+      expect(logOutput.length).toEqual(1);
+      const videoHTML = `<video controls width="${width}" height="${height}"><source src="data:video/${codec};base64,${base64}" type="video/${codec}">Video (Codec ${codec}) not supported by browser</video>`;
+      const expected = `MediaType: [text/html], Message: [${videoHTML}]`;
+      expect(logOutput[0]).toMatch(new RegExp(expected.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+
+    });
+
+    it('Check video buffer attachment with only width modified', () => {
+      const testString = "Test string";
+      const width = 320;
+      const height = 180;
+      const codec = "webm";
+      const testBuffer = Buffer.from(testString, 'utf8');
+      const base64 = testBuffer.toString('base64');
+
+      Log.videoResolution = { width: width };
+
+      Log.attachVideo(0, testBuffer);
+
+      expect(logOutput.length).toEqual(1);
+      const videoHTML = `<video controls width="${width}" height="${height}"><source src="data:video/${codec};base64,${base64}" type="video/${codec}">Video (Codec ${codec}) not supported by browser</video>`;
+      const expected = `MediaType: [text/html], Message: [${videoHTML}]`;
+      expect(logOutput[0]).toMatch(new RegExp(expected.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+    });
+
+    it('Check video buffer attachment as file', () => {
+      const fileName = "testData/testData.txt";
+      const testBuffer = readFileSync(fileName);
+      const testString = testBuffer.toString('utf8');
+      const base64 = testBuffer.toString('base64');
+
+      Log.attachVideoFile(0, fileName);
+
+      expect(logOutput.length).toEqual(1);
+      const videoHTML = `<video controls width="320" height="180"><source src="data:video/webm;base64,${base64}" type="video/webm">Video (Codec webm) not supported by browser</video>`;
+      const expected = `MediaType: [text/html], Message: [${videoHTML}]`;
+      expect(logOutput[0]).toMatch(new RegExp(expected.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+
+    });
+
+    it('Check video buffer attachment as file but bad file', () => {
+      const fileName = "testData/testData.txt";
+      const testBuffer = Buffer.from('', 'utf8');
+      const testString = testBuffer.toString('utf8');
+      const base64 = testBuffer.toString('base64');
+
+      Log.attachVideoFile(0, 'nothere/' + fileName);
+
+      expect(logOutput.length).toEqual(2);
+      expect(logOutput[0]).toMatch(/\[ERROR.*Error thrown reading video data/);
+      expect(logOutput[1]).toMatch(/\[ENOENT.*no such file or directory/);
+    });
+
+  });
+
+  describe('HTML test steps', () => {
+    let logOutput = new Array<string>;
+    beforeEach(() => {
+      logOutput = [];
+      Log.logOutputCallback = (message, mediaType) => {
+        logOutput.push(`MediaType: [${mediaType ?? 'Not Defined'}], Message: [${message}]`);
+      };
+    });
+
+    it('Check HTML attachment', () => {
+      const testHTML = "<div>hello</div>"
+      Log.attachHTML(Log.LogLevels.Error, testHTML);
+      expect(logOutput.length).toEqual(1);
+      expect(logOutput[0]).toMatch(new RegExp(`MediaType\: \[text\/html\]\, Message\: \[${testHTML}\]`.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+    });
   });
 
   describe('Validate console logging', () => {
@@ -344,6 +575,12 @@ describe('Log', () => {
       Log.writeLine(Log.LogLevels.TestInformation, 'test meformation test');
       expect(logSpy).toHaveBeenCalledTimes(1);
     });
+     it('Veg', () => {
+      (Log.logOutputCallback as any) = "asdf";
+      Log.attach(0, "Test text", "base64:image/png")
+      expect(logSpy).toHaveBeenCalledTimes(1);
+      expect(logSpy).toHaveBeenCalledWith(expect.stringMatching(/Log Output callback is type \[string\]/));
+    });
   });
 
   describe('Validate setting of video window dimensions', () => {