Aa/chore/adjust logger tests (#3193)

* Keeping console clean during tests * Comparing strings without ANSI color codes * Adding changeset
FuelLabs · Sep 21, 2024 · ef50619 · ef50619
1 parent 8930417
commit ef50619
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/.changeset/fair-walls-smile.md b/.changeset/fair-walls-smile.md
@@ -0,0 +1,4 @@
+---
+---
+
+chore: adjust logger tests
diff --git a/packages/logger/test/index.test.ts b/packages/logger/test/index.test.ts
@@ -13,19 +13,26 @@ describe('Logger Tests', () => {
 
   beforeEach(() => {
     debug.enable('test');
-    debugSpy = vi.spyOn(debug, 'log');
+    debugSpy = vi.spyOn(debug, 'log').mockImplementation(() => ({}));
   });
 
   afterEach(() => {
     debugSpy.mockRestore();
   });
 
+  // Removes ANSI color codes from strings
+  function clean(s: string) {
+    // eslint-disable-next-line no-control-regex
+    const reg = /\u001b[^m]*?m/g;
+    return s.replace(reg, '');
+  }
+
   it('should log info messages correctly', () => {
     const log = logger('test');
     const message = 'This is a message';
     log(message);
     const callArgs = debugSpy.mock.calls[0][0];
-    expect(callArgs).toContain(`test ${message}`);
+    expect(clean(callArgs)).toContain(`test ${message}`);
   });
 
   it('should format a b256 string correctly', () => {
@@ -39,7 +46,7 @@ describe('Logger Tests', () => {
     log(formattedMessage, mockAddress);
 
     const callArgs = debugSpy.mock.calls[0][0];
-    expect(callArgs).toContain('0x123456789abcdef');
+    expect(clean(callArgs)).toContain('0x123456789abcdef');
   });
 
   it('should prefix log messages correctly using prefixLogger', () => {
@@ -53,7 +60,7 @@ describe('Logger Tests', () => {
 
     log(message);
     const callArgs = debugSpy.mock.calls[0][0];
-    expect(callArgs).toContain(`${prefix}:${component} ${message}`);
+    expect(clean(callArgs)).toContain(`${prefix}:${component} ${message}`);
   });
 
   it('should create a default logger and log messages correctly', () => {
@@ -65,7 +72,7 @@ describe('Logger Tests', () => {
     log(message);
 
     const callArgs = debugSpy.mock.calls[0][0];
-    expect(callArgs).toContain(`test-component ${message}`);
+    expect(clean(callArgs)).toContain(`test-component ${message}`);
   });
 
   it('should format BN values with commas correctly using formatter a', () => {