@zohodesk/unit-testing-framework 0.0.30-experimental → 0.0.32-experimental

package/build/src/utils/__tests__/pipeline-summary.test.js

@@ -0,0 +1,473 @@
+"use strict";
+
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _url = require("url");
+var _pipelineSummary = require("../pipeline-summary.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const _dirname = _path.default.dirname((0, _url.fileURLToPath)(import.meta.url));
+const TEST_OUTPUT_DIR = _path.default.join(_dirname, '../../__temp__');
+describe('PipelineSummaryGenerator', () => {
+  let summary;
+  beforeEach(() => {
+    summary = (0, _pipelineSummary.createPipelineSummary)('TestStage', {
+      outputPath: _path.default.join(TEST_OUTPUT_DIR, 'test-summary.json'),
+      webUrl: 'https://example.com/report'
+    });
+
+    // Create temp directory
+    if (!_fs.default.existsSync(TEST_OUTPUT_DIR)) {
+      _fs.default.mkdirSync(TEST_OUTPUT_DIR, {
+        recursive: true
+      });
+    }
+  });
+  afterEach(() => {
+    // Clean up
+    if (_fs.default.existsSync(TEST_OUTPUT_DIR)) {
+      _fs.default.rmSync(TEST_OUTPUT_DIR, {
+        recursive: true,
+        force: true
+      });
+    }
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // SUCCESS RESPONSE TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('success()', () => {
+    test('should create success response with defaults', () => {
+      const response = summary.success();
+      expect(response.status).toBe('SUCCESS');
+      expect(response.message).toBe('TestStage completed successfully');
+      expect(response.web_url).toBe('https://example.com/report');
+    });
+    test('should create success response with custom message', () => {
+      const response = summary.success({
+        message: 'All tests passed'
+      });
+      expect(response.status).toBe('SUCCESS');
+      expect(response.message).toBe('All tests passed');
+    });
+    test('should create success response with custom web_url', () => {
+      const response = summary.success({
+        webUrl: 'https://example.com/custom-report'
+      });
+      expect(response.web_url).toBe('https://example.com/custom-report');
+    });
+    test('should not contain error field in success response', () => {
+      const response = summary.success();
+      expect(response).not.toHaveProperty('error');
+      expect(response).not.toHaveProperty('result');
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // FAILURE RESPONSE TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('failure()', () => {
+    test('should create failure response with defaults', () => {
+      const response = summary.failure();
+      expect(response.status).toBe('FAILURE');
+      expect(response.message).toBe('TestStage failed');
+      expect(response.error.code).toBe('UNKNOWN_ERROR');
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.TOOL);
+      expect(Array.isArray(response.error.errors)).toBe(true);
+    });
+    test('should create failure response with custom error details', () => {
+      const response = summary.failure({
+        message: 'Database connection failed',
+        errorCode: 'DB_CONN_ERROR',
+        errorCategory: _pipelineSummary.ERROR_CATEGORIES.ENVIRONMENT,
+        errorMessage: 'Cannot connect to database',
+        errors: ['Connection timeout', 'Host unreachable']
+      });
+      expect(response.status).toBe('FAILURE');
+      expect(response.message).toBe('Database connection failed');
+      expect(response.error.code).toBe('DB_CONN_ERROR');
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.ENVIRONMENT);
+      expect(response.error.message).toBe('Cannot connect to database');
+      expect(response.error.errors).toHaveLength(2);
+    });
+    test('should accept single error and convert to array', () => {
+      const response = summary.failure({
+        errors: 'Single error message'
+      });
+      expect(Array.isArray(response.error.errors)).toBe(true);
+      expect(response.error.errors[0]).toBe('Single error message');
+    });
+    test('should include result field if provided', () => {
+      const response = summary.failure({
+        result: [{
+          key: 'value'
+        }]
+      });
+      expect(response.result).toEqual([{
+        key: 'value'
+      }]);
+    });
+    test('should not include empty result field', () => {
+      const response = summary.failure({
+        result: []
+      });
+      expect(response).not.toHaveProperty('result');
+    });
+    test('should validate and warn for invalid error category', () => {
+      const response = summary.failure({
+        errorCategory: 'invalid_category'
+      });
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.TOOL);
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // TEST FAILURE TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('testFailure()', () => {
+    test('should handle test failure without results object', () => {
+      const response = summary.testFailure({
+        message: 'Tests failed'
+      });
+      expect(response.status).toBe('FAILURE');
+      expect(response.error.code).toBe('TEST_FAILURE');
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.CODE);
+    });
+    test('should extract failed test information from jest results', () => {
+      const testResults = {
+        numTotalTests: 10,
+        numFailedTests: 2,
+        numPassedTests: 8,
+        numSkippedTests: 0,
+        testResults: [{
+          name: 'test-file-1.js',
+          numFailingTests: 1,
+          assertionResults: [{
+            title: 'Test 1',
+            fullName: 'Suite › Test 1',
+            status: 'failed',
+            failureMessages: ['Expected true to be false']
+          }]
+        }, {
+          name: 'test-file-2.js',
+          numFailingTests: 1,
+          assertionResults: [{
+            title: 'Test 2',
+            fullName: 'Suite › Test 2',
+            status: 'failed',
+            failureMessages: ['Timeout after 5000ms']
+          }]
+        }]
+      };
+      const response = summary.testFailure({
+        testResults
+      });
+      expect(response.error.errors).toHaveLength(2);
+      expect(response.error.errors[0].test).toBe('Suite › Test 1');
+      expect(response.error.errors[0].file).toBe('test-file-1.js');
+      expect(response.result[0].failedTests).toBe(2);
+    });
+    test('should include test statistics in result', () => {
+      const testResults = {
+        numTotalTests: 50,
+        numFailedTests: 5,
+        numPassedTests: 45,
+        numSkippedTests: 0,
+        testResults: []
+      };
+      const response = summary.testFailure({
+        testResults
+      });
+      expect(response.result[0]).toEqual({
+        totalTests: 50,
+        failedTests: 5,
+        passedTests: 45,
+        skippedTests: 0
+      });
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // TOOL ERROR TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('toolError()', () => {
+    test('should handle error object', () => {
+      const error = new Error('Module not found');
+      error.stack = 'Error: Module not found\n    at line 10';
+      const response = summary.toolError({
+        toolName: 'jest',
+        error,
+        exitCode: 1
+      });
+      expect(response.status).toBe('FAILURE');
+      expect(response.error.code).toBe('JEST_EXECUTION_ERROR');
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.TOOL);
+      expect(response.error.errors[0].tool).toBe('jest');
+      expect(response.error.errors[0].stack).toBeDefined();
+    });
+    test('should handle string error message', () => {
+      const response = summary.toolError({
+        toolName: 'npm',
+        error: 'npm ERR! code ERESOLVE',
+        exitCode: 1
+      });
+      expect(response.error.errors[0].message).toBe('npm ERR! code ERESOLVE');
+    });
+    test('should handle missing error', () => {
+      const response = summary.toolError({
+        toolName: 'webpack',
+        exitCode: 127
+      });
+      expect(response.error.errors[0].message).toBeFalsy();
+      expect(response.error.errors[0].tool).toBe('webpack');
+    });
+    test('should format tool name in error code', () => {
+      const response = summary.toolError({
+        toolName: 'eslint',
+        error: 'Linting failed'
+      });
+      expect(response.error.code).toBe('ESLINT_EXECUTION_ERROR');
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // ENVIRONMENT ERROR TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('environmentError()', () => {
+    test('should create environment error response', () => {
+      const response = summary.environmentError({
+        issue: 'Node.js version too old',
+        requirement: 'Node.js >= 16',
+        suggestion: 'Update Node.js'
+      });
+      expect(response.status).toBe('FAILURE');
+      expect(response.error.code).toBe('ENV_SETUP_ERROR');
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.ENVIRONMENT);
+      expect(response.error.errors[0].issue).toBe('Node.js version too old');
+      expect(response.error.errors[0].requirement).toBe('Node.js >= 16');
+      expect(response.error.errors[0].suggestion).toBe('Update Node.js');
+    });
+    test('should handle partial environment error details', () => {
+      const response = summary.environmentError({
+        issue: 'Missing DATABASE_URL'
+      });
+      expect(response.error.errors[0]).toEqual({
+        issue: 'Missing DATABASE_URL'
+      });
+    });
+    test('should use default issue message', () => {
+      const response = summary.environmentError();
+      expect(response.error.errors[0].issue).toBe('Environment configuration issue');
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // FLAKY TEST TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('flakyTestFailure()', () => {
+    test('should create flaky test failure response', () => {
+      const response = summary.flakyTestFailure({
+        testNames: ['Test A', 'Test B'],
+        attemptNumber: 1,
+        maxAttempts: 3
+      });
+      expect(response.status).toBe('FAILURE');
+      expect(response.error.code).toBe('FLAKY_TEST_FAILURE');
+      expect(response.error.category).toBe(_pipelineSummary.ERROR_CATEGORIES.FLAKY);
+      expect(response.error.errors).toHaveLength(2);
+      expect(response.result[0].attemptNumber).toBe(1);
+      expect(response.result[0].maxAttempts).toBe(3);
+    });
+    test('should include attempt information in message', () => {
+      const response = summary.flakyTestFailure({
+        testNames: ['Flaky Test'],
+        attemptNumber: 2,
+        maxAttempts: 3
+      });
+      expect(response.message).toContain('attempt 2/3');
+    });
+    test('should handle custom message override', () => {
+      const response = summary.flakyTestFailure({
+        testNames: ['Test'],
+        message: 'Custom flaky message'
+      });
+      expect(response.message).toBe('Custom flaky message');
+    });
+    test('should use default attempt values', () => {
+      const response = summary.flakyTestFailure({
+        testNames: ['Test']
+      });
+      expect(response.result[0].attemptNumber).toBe(1);
+      expect(response.result[0].maxAttempts).toBe(3);
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // FILE SAVE TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('saveToFile()', () => {
+    test('should save response to file', () => {
+      const response = summary.success();
+      const saved = summary.saveToFile(response);
+      expect(saved).toBe(true);
+      expect(_fs.default.existsSync(summary.outputPath)).toBe(true);
+      const content = _fs.default.readFileSync(summary.outputPath, 'utf-8');
+      const parsed = JSON.parse(content);
+      expect(parsed.status).toBe('SUCCESS');
+    });
+    test('should create parent directories if not exist', () => {
+      const customPath = _path.default.join(TEST_OUTPUT_DIR, 'nested/deep/summary.json');
+      const customSummary = (0, _pipelineSummary.createPipelineSummary)('Test', {
+        outputPath: customPath
+      });
+      const response = customSummary.success();
+      const saved = customSummary.saveToFile(response);
+      expect(saved).toBe(true);
+      expect(_fs.default.existsSync(customPath)).toBe(true);
+    });
+    test('should handle missing output path', () => {
+      const noPathSummary = (0, _pipelineSummary.createPipelineSummary)('Test');
+      const response = noPathSummary.success();
+      const saved = noPathSummary.saveToFile(response);
+      expect(saved).toBe(false);
+    });
+    test('should format JSON with indentation', () => {
+      const response = summary.success();
+      summary.saveToFile(response);
+      const content = _fs.default.readFileSync(summary.outputPath, 'utf-8');
+      expect(content).toContain('\n');
+      expect(content).toContain('  ');
+    });
+    test('should override output path', () => {
+      const customPath = _path.default.join(TEST_OUTPUT_DIR, 'custom.json');
+      const response = summary.success();
+      summary.saveToFile(response, customPath);
+      expect(_fs.default.existsSync(customPath)).toBe(true);
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // SAVE AND RETURN TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('saveAndReturn()', () => {
+    test('should return response and save status', () => {
+      const response = summary.success();
+      const {
+        response: retResponse,
+        saved
+      } = summary.saveAndReturn(response);
+      expect(retResponse).toEqual(response);
+      expect(saved).toBe(true);
+      expect(_fs.default.existsSync(summary.outputPath)).toBe(true);
+    });
+    test('should indicate save failure', () => {
+      const noPathSummary = (0, _pipelineSummary.createPipelineSummary)('Test');
+      const response = noPathSummary.success();
+      const {
+        saved
+      } = noPathSummary.saveAndReturn(response);
+      expect(saved).toBe(false);
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // EDGE CASES
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('edge cases', () => {
+    test('should handle very long error messages', () => {
+      const longMessage = 'x'.repeat(10000);
+      const response = summary.failure({
+        errorMessage: longMessage
+      });
+      expect(response.error.message).toBe(longMessage);
+    });
+    test('should handle special characters in messages', () => {
+      const response = summary.failure({
+        message: 'Failed: "test" & <script>alert(1)</script>'
+      });
+      expect(response.message).toContain('<script>');
+    });
+    test('should handle null/undefined in optional fields', () => {
+      const response = summary.failure({
+        errorMessage: null,
+        errors: null
+      });
+      expect(response.error.message).toBeNull();
+      expect(Array.isArray(response.error.errors)).toBe(true);
+    });
+    test('should handle errors with circular references', () => {
+      const circularObj = {
+        name: 'test'
+      };
+      circularObj.self = circularObj;
+
+      // Should not throw
+      const response = summary.failure({
+        errors: [circularObj]
+      });
+      expect(response.error.errors).toBeDefined();
+    });
+    test('should handle unicode characters', () => {
+      const response = summary.failure({
+        errorMessage: '测试失败 🔥 エラーが発生しました'
+      });
+      expect(response.error.message).toContain('测试失败');
+      expect(response.error.message).toContain('🔥');
+    });
+    test('should handle multiple consecutive saves', () => {
+      const response1 = summary.success({
+        message: 'First'
+      });
+      const response2 = summary.failure({
+        message: 'Second'
+      });
+      summary.saveToFile(response1);
+      summary.saveToFile(response2);
+      const content = _fs.default.readFileSync(summary.outputPath, 'utf-8');
+      const parsed = JSON.parse(content);
+      expect(parsed.message).toBe('Second');
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // ERROR CATEGORIES EXPORT
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('ERROR_CATEGORIES', () => {
+    test('should export valid error categories', () => {
+      expect(_pipelineSummary.ERROR_CATEGORIES.CODE).toBe('code');
+      expect(_pipelineSummary.ERROR_CATEGORIES.ENVIRONMENT).toBe('environment');
+      expect(_pipelineSummary.ERROR_CATEGORIES.FLAKY).toBe('flaky');
+      expect(_pipelineSummary.ERROR_CATEGORIES.TOOL).toBe('tool');
+    });
+  });
+
+  // ──────────────────────────────────────────────────────────────────────
+  // FACTORY FUNCTION TESTS
+  // ──────────────────────────────────────────────────────────────────────
+
+  describe('createPipelineSummary()', () => {
+    test('should create instance with stage name', () => {
+      const instance = (0, _pipelineSummary.createPipelineSummary)('MyStage');
+      expect(instance).toBeInstanceOf(_pipelineSummary.PipelineSummaryGenerator);
+      const response = instance.success();
+      expect(response.message).toContain('MyStage');
+    });
+    test('should merge options correctly', () => {
+      const instance = (0, _pipelineSummary.createPipelineSummary)('Build', {
+        outputPath: '/path/to/file.json',
+        webUrl: 'https://example.com'
+      });
+      const response = instance.success();
+      expect(response.web_url).toBe('https://example.com');
+    });
+  });
+});