feat(test): write test logs to timestamped files in special dir

Author: seansica

.github/workflows/release.yml

@@ -57,6 +57,12 @@ jobs:
         run: npm run build
       - name: Test
         run: npm run test
+      - name: Upload test logs
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: test-logs
+          path: .test-logs/
       - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
         run: npm audit signatures
       - name: Release

.gitignore

@@ -4,6 +4,9 @@
 *.js
 *.js.map
 
+# Test logs
+test-logs/**/*
+
 # Files tagged with .ignore
 *.ignore
 

test/objects/relationship.test.ts

@@ -1,4 +1,4 @@
-import { describe, beforeEach, it, expect } from 'vitest';
+import { describe, beforeEach, it, expect, afterAll } from 'vitest';
 import { z } from 'zod';
 import { v4 as uuidv4 } from 'uuid';
 import {
@@ -21,6 +21,8 @@ import {
   stixTypeSchema,
   xMitreIdentity,
 } from '../../src/schemas/common/index';
+import { logger } from '../utils/logger';
+
 
 describe('RelationshipSchema', () => {
   let relationships: any[];
@@ -327,12 +329,12 @@ describe('RelationshipSchema', () => {
     };
 
     if (errors.length > 0) {
-      console.warn(
+      logger.warn(
         `The following ${errors.length} relationship(s) failed validation:\n${formatErrorReport(errors)}`,
       );
     }
 
-    console.log(`
+    logger.log(`
         Total relationships: ${relationships.length}
         Valid relationships: ${validRelationships.length}
         Relationships with errors: ${errors.length}
@@ -341,4 +343,8 @@ describe('RelationshipSchema', () => {
     // This expectation will always pass, but it gives us a way to surface the error count in the test results
     expect(true).toBe(true);
   });
+
+  afterAll(() => {
+    logger.close();
+  });
 });

test/objects/stix-bundle.test.ts

@@ -1,4 +1,4 @@
-import { describe, beforeEach, it, expect } from 'vitest';
+import { describe, beforeEach, it, expect, afterAll } from 'vitest';
 import { v4 as uuidv4 } from 'uuid';
 import { type StixBundle, stixBundleSchema } from '../../src/schemas/sdo/stix-bundle.schema';
 import {
@@ -9,6 +9,7 @@ import {
 import type { Collection } from '../../src/schemas/sdo/collection.schema';
 import type { Technique } from '../../src/schemas/sdo/technique.schema';
 import { z } from 'zod';
+import { logger } from '../utils/logger';
 
 /**
  * Test suite for validating StixBundle schema.
@@ -220,16 +221,21 @@ describe('StixBundleSchema', () => {
           });
 
           bundlesWithErrors.push({ bundleIndex, errors });
-          console.warn(errors.join('\n\n'));
+          logger.warn(errors.join('\n\n'));
         }
       }
     });
 
     // Log a summary of the validation results
-    console.log(`Validated ${bundles.length} bundles`);
-    console.log(`Found errors in ${bundlesWithErrors.length} bundles`);
+    logger.log(`Validated ${bundles.length} bundles`);
+    logger.log(`Found errors in ${bundlesWithErrors.length} bundles`);
 
     // This expectation will always pass, but it gives us a way to surface the error count in the test results
     expect(bundlesWithErrors.length).toBeLessThanOrEqual(bundles.length);
   });
+
+  // Close the logger after all tests are complete
+  afterAll(() => {
+    logger.close();
+  });
 });

test/utils/logger.ts

@@ -0,0 +1,47 @@
+// file: test/utils/logger.ts
+
+import fs from 'fs';
+import path from 'path';
+
+class TestLogger {
+  private static instance: TestLogger;
+  private logStream: fs.WriteStream;
+  private static readonly LOG_DIR = '.test-logs';
+
+  private constructor() {
+    const timestamp = new Date().toISOString().replace(/[:]/g, '-').replace(/\..+/, '');
+    
+    // Ensure the log directory exists
+    if (!fs.existsSync(TestLogger.LOG_DIR)) {
+      fs.mkdirSync(TestLogger.LOG_DIR, { recursive: true });
+    }
+
+    const logFilePath = path.join(TestLogger.LOG_DIR, `test-log-${timestamp}.txt`);
+    this.logStream = fs.createWriteStream(logFilePath, { flags: 'a' });
+  }
+
+  public static getInstance(): TestLogger {
+    if (!TestLogger.instance) {
+      TestLogger.instance = new TestLogger();
+    }
+    return TestLogger.instance;
+  }
+
+  public log(message: string): void {
+    this.logStream.write(`LOG: ${message}\n`);
+  }
+
+  public warn(message: string): void {
+    this.logStream.write(`WARNING: ${message}\n`);
+  }
+
+  public error(message: string): void {
+    this.logStream.write(`ERROR: ${message}\n`);
+  }
+
+  public close(): void {
+    this.logStream.end();
+  }
+}
+
+export const logger = TestLogger.getInstance();