fix(detector): sending testCase for html

Author: marabesi

cli/src/find-smells.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 import fs from 'node:fs/promises';
 import { glob } from 'glob';
-import { Smell, SmellDetector, SupportedLanguages } from 'smelly-detector';
+import { Smell, SmellDetector, SupportedLanguages, TestCase } from 'smelly-detector';
 import { SmellsAggreagtor, SmellsList } from 'smelly-detector/reports';
 import { statSync } from 'fs';
 
@@ -37,16 +37,18 @@ async function execute() {
 
     if (report) {
       const aggregator: SmellsList[] = [];
+      const testCases: TestCase[] = [];
 
       for (const file of pathWithAllFilesFound) {
         const fileContent = await fs.readFile(file, { encoding: 'utf8' });
         const smellDetector = new SmellDetector(file, fileContent, language);
-        const smells = smellDetector.findAll().smellsList.smells;
-        aggregator.push({ fileName: file, smells, language, fileContent });
+        const smells = smellDetector.findAll();
+        aggregator.push(smells.smellsList);
+        testCases.push(...smells.testCases);
       }
 
       const to = path.resolve(reportOutput.replace('--report-output=', ''));
-      const report = new SmellsAggreagtor(aggregator, { to });
+      const report = new SmellsAggreagtor(testCases, aggregator, { to });
       await report.build();
 
       console.info('Report HTML generated');

detector/src/index.ts

@@ -1,3 +1,3 @@
 export { SmellDetector } from './smells-detector';
-export { Smell, SupportedLanguages } from './types';
+export { Smell, SupportedLanguages, TestCase } from './types';
 export { supportedLanguages } from './languages/Supported';

detector/src/reporters/SmellsAgreggator.ts

@@ -1,11 +1,12 @@
-import { SmellsList } from '../types';
+import { SmellsList, TestCase } from '../types';
 import { HtmlOutput } from './Output';
 import { AgreggatorSmellls, ExportOptions } from './types';
 
 export class SmellsAggreagtor implements AgreggatorSmellls {
   constructor(
-    private totalTestFiles: SmellsList[],
-    private exportOptions: ExportOptions
+    private readonly result: TestCase[],
+    private readonly totalTestFiles: SmellsList[],
+    private readonly exportOptions: ExportOptions
   ) { }
 
   async build(): Promise<void> {
@@ -18,7 +19,7 @@ export class SmellsAggreagtor implements AgreggatorSmellls {
         totalSmells,
         data: this.totalTestFiles,
         averageSmellsPerTestFile: totalSmells / totalFiles,
-        totalTestCases: 0,
+        totalTestCases: this.result.length,
       }, this.exportOptions);
     } catch (err) {
       console.log(err);

detector/src/smells-detector.ts

@@ -7,7 +7,7 @@ import { SmellDetectorRunnerResult, SupportedLanguages } from './types';
 export class SmellDetector {
 
   constructor(
-    private fileName: string,
+    private readonly fileName: string,
     private readonly code: string,
     private readonly language: string
   ) { }

detector/test/html-report-builder.ts

@@ -1,4 +1,5 @@
-import { AggregatedData, ExportOptions, SmellsList } from '../src/reporters/types';
+import { AggregatedData, ExportOptions } from '../src/reporters/types';
+import { SmellsList } from '../src/types';
 import { HtmlOutput } from '../src/reporters/Output';
 import { readFileSync } from 'fs';
 

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

@@ -1,10 +1,10 @@
 import { test, describe, expect, afterEach, beforeEach } from 'vitest';
 import { parse } from 'node-html-parser';
-import { AggregatedData, ExportOptions, SmellsList } from '../src/reporters/types';
+import { AggregatedData, ExportOptions } from '../src/reporters/types';
 import { rmSync } from 'fs';
 import { buildEmptyHtmlReportForTestSmells, buildHtmlReportForTestSmellsFor } from './html-report-builder';
 import { SmellsBuilder } from '../src/smells-builder';
-import { Smell, SupportedLanguages } from '../src/types';
+import { Smell, SmellsList, SupportedLanguages } from '../src/types';
 
 describe('html report', () => {
   const exportsOptions: ExportOptions = { to: '.' };
@@ -71,7 +71,7 @@ describe('html report', () => {
         },
       ];
 
-      return { data: smellsFound, totalSmells: 0, averageSmellsPerTestFile: 0 };
+      return { data: smellsFound, totalSmells: 0, averageSmellsPerTestFile: 0, totalTestCases: 0 };
     };
 
     test('renders number of test smell for a given file', async () => {

detector/test/smells-aggregator.test.ts

@@ -2,8 +2,8 @@ import { vi,test, describe, expect } from 'vitest';
 import { HtmlOutput } from '../src/reporters/Output';
 import { SmellsBuilder } from '../src/smells-builder';
 import { SmellsAggreagtor } from '../src/reporters/SmellsAgreggator';
-import { ExportOptions, SmellsList } from '../src/reporters/types';
-import { Smell, SmellType, SupportedLanguages } from '../src/types';
+import { ExportOptions } from '../src/reporters/types';
+import { Smell, SmellsList, SmellType, SupportedLanguages, TestCase } from '../src/types';
 
 vi.mock('../src/reporters/Output');
 
@@ -37,7 +37,7 @@ describe('smells aggregator', () => {
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();
 
@@ -51,20 +51,20 @@ describe('smells aggregator', () => {
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();
 
     expect(write.mock.calls[0][0].data[0].fileContent).toEqual('console.log("Hello world")');
   });
 
-  test.skip('should send total of test cases to the output', async () => {
+  test('should send total of test cases to the output', async () => {
     const smellsFound: SmellsList[] = buildListWithSingleSmell([createSingleSmell()]);
     const exportsOptions: ExportOptions = { to: '.' };
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();
 
@@ -77,36 +77,47 @@ describe('smells aggregator', () => {
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();
 
     expect(write.mock.calls[0][0].data).toEqual(smellsFound);
   });
 
   test('compute smells for a single file', async () => {
-    const smell: Smell = {
-      type: SmellType.consoleStatement,
-      lineStart: 0,
-      lineEnd: 1,
-      startAt: 10,
-      endsAt: 20,
-      description: '',
-      diagnostic: ''
-    };
-
     const smellsFound: SmellsList[] = buildListWithSingleSmell([createSingleSmell()]);
     const exportsOptions: ExportOptions = { to: '.' };
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();
 
     expect(write.mock.calls[0][0].totalSmells).toEqual(1);
   });
 
+  test('compute test cases for a single file', async () => {
+    const smellsFound: SmellsList[] = buildListWithSingleSmell([createSingleSmell()]);
+    const testCases: TestCase[] = [
+      {
+        lineStart: 0,
+        lineEnd: 0,
+        startAt: 0,
+        endsAt: 0
+      }
+    ];
+    const exportsOptions: ExportOptions = { to: '.' };
+
+    const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
+
+    const reporter = new SmellsAggreagtor(testCases, smellsFound, exportsOptions);
+
+    await reporter.build();
+
+    expect(write.mock.calls[0][0].totalTestCases).toEqual(1);
+  });
+
   test('two test file with 5 smells each, should have average of 5 smells per test file', async () => {
     const smell: Smell = SmellsBuilder.console(0, 1, 10, 20);
     const smellsFound: SmellsList[] = [
@@ -127,7 +138,7 @@ describe('smells aggregator', () => {
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();
 
@@ -154,7 +165,7 @@ describe('smells aggregator', () => {
 
     const write = vi.mocked(HtmlOutput.prototype.writeTo = vi.fn());
 
-    const reporter = new SmellsAggreagtor(smellsFound, exportsOptions);
+    const reporter = new SmellsAggreagtor([], smellsFound, exportsOptions);
 
     await reporter.build();