refactor(detector): test cases for html

Author: marabesi

detector/test/html-report-builder.ts

@@ -9,6 +9,16 @@ export async function buildEmptyHtmlReportForTestSmells(exportsOptions: ExportOp
   const reporter = new HtmlOutput();
   await reporter.writeTo(aggregatedData, exportsOptions);
 
-  const generatedHtml = readFileSync(filePath, { encoding: 'utf8', flag: 'r' });
-  return generatedHtml;
+  return readFileSync(filePath, { encoding: 'utf8', flag: 'r' });
+}
+
+export async function buildHtmlReportForTestSmellsFor(
+  exportsOptions: ExportOptions,
+  filePath: string,
+  aggregatedData: AggregatedData
+) {
+  const reporter = new HtmlOutput();
+  await reporter.writeTo(aggregatedData, exportsOptions);
+
+  return readFileSync(filePath, { encoding: 'utf8', flag: 'r' });
 }

detector/test/html-report.integration.test.ts

@@ -1,8 +1,10 @@
 import { test, describe, expect, afterEach, beforeEach } from 'vitest';
 import { parse } from 'node-html-parser';
-import { ExportOptions } from '../src/reporters/types';
+import { AggregatedData, ExportOptions, SmellsList } from '../src/reporters/types';
 import { rmSync } from 'fs';
-import { buildEmptyHtmlReportForTestSmells } from './html-report-builder';
+import { buildEmptyHtmlReportForTestSmells, buildHtmlReportForTestSmellsFor } from './html-report-builder';
+import { SmellsBuilder } from '../src/smells-builder';
+import { Smell, SupportedLanguages } from '../src/types';
 
 describe('html report', () => {
   const exportsOptions: ExportOptions = { to: '.' };
@@ -16,34 +18,73 @@ describe('html report', () => {
     rmSync(filePath, { force: true });
   });
 
-  test('renders empty table when no tests are found', async () => {
-    const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
-    const root = parse(generatedHtml);
+  describe('when no smells are found', () => {
 
-    expect(root.querySelectorAll('table tbody tr').length).toEqual(0);
+    test('renders empty table when no tests are found', async () => {
+      const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
+      const root = parse(generatedHtml);
+  
+      expect(root.querySelectorAll('table tbody tr').length).toEqual(0);
+    });
+  
+    test('renders report title', async () => {
+      const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
+      const root = parse(generatedHtml);
+  
+      expect(root.querySelector('[data-testid="report-title"]')?.textContent).toEqual('Test smells report');
+    });
+  
+    test('renders total number of smells found', async () => {
+      const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
+      const root = parse(generatedHtml);
+  
+      expect(root.querySelector('[data-testid="total-smells-found"]')?.textContent).toEqual('0');
+      expect(root.querySelector('[data-testid="title-smells-found"]')?.textContent).toEqual('Test smells');
+    });
+  
+    test('renders the number of test files', async () => {
+      const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
+      const root = parse(generatedHtml);
+  
+      expect(root.querySelector('[data-testid="total-test-files"]')?.textContent).toEqual('0');
+      expect(root.querySelector('[data-testid="title-test-files"]')?.textContent).toEqual('Test files');
+    });
   });
 
-  test('renders report title', async () => {
-    const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
-    const root = parse(generatedHtml);
+  describe('when there are test smells', () => {
+    const buildAggregatedData = (): AggregatedData => {
+      const smell: Smell = SmellsBuilder.console(0, 1, 10, 20);
+      const smellsFound: SmellsList[] = [
+        {
+          smells: [smell, smell, smell, smell],
+          language: SupportedLanguages.javascript,
+          fileName: 'first_test.js'
+        },
+      ];
 
-    expect(root.querySelector('[data-testid="report-title"]')?.textContent).toEqual('Test smells report');
-  });
+      return { data: smellsFound, totalSmells: 0, averageSmellsPerTestFile: 0 };
+    };
 
-  test('renders total number of smells found', async () => {
-    const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
-    const root = parse(generatedHtml);
+    test('renders number of test smell for a given file', async () => {
+      const generatedHtml = await buildHtmlReportForTestSmellsFor(exportsOptions, filePath, buildAggregatedData());
+      const root = parse(generatedHtml);
 
-    expect(root.querySelector('[data-testid="total-smells-found"]')?.textContent).toEqual('0');
-    expect(root.querySelector('[data-testid="title-smells-found"]')?.textContent).toEqual('Test smells');
-  });
+      expect(root.querySelector('table tbody tr')?.textContent).toContain('4');
+    });
+    
+    test('renders file name', async () => {
+      const generatedHtml = await buildHtmlReportForTestSmellsFor(exportsOptions, filePath, buildAggregatedData());
+      const root = parse(generatedHtml);
+
+      expect(root.querySelector('table tbody tr')?.textContent).toContain('first_test.js');
+    });
 
-  test('renders the number of test files', async () => {
-    const generatedHtml = await buildEmptyHtmlReportForTestSmells(exportsOptions, filePath);
-    const root = parse(generatedHtml);
+    test('renders language', async () => {
+      const generatedHtml = await buildHtmlReportForTestSmellsFor(exportsOptions, filePath, buildAggregatedData());
+      const root = parse(generatedHtml);
 
-    expect(root.querySelector('[data-testid="total-test-files"]')?.textContent).toEqual('0');
-    expect(root.querySelector('[data-testid="title-test-files"]')?.textContent).toEqual('Test files');
+      expect(root.querySelector('table tbody tr')?.textContent).toContain('javascript');
+    });
   });
 });