polish integration tests

Author: BioPhoton

e2e/plugin-doc-coverage-e2e/tests/__snapshots__/collect.e2e.test.ts.snap

@@ -8,8 +8,9 @@ import {
   E2E_ENVIRONMENTS_DIR,
   TEST_OUTPUT_DIR,
   omitVariableReportData,
+  removeColorCodes,
 } from '@code-pushup/test-utils';
-import { executeProcess, readJsonFile } from '@code-pushup/utils';
+import { executeProcess, readJsonFile, readTextFile } from '@code-pushup/utils';
 
 describe('PLUGIN collect report with doc-coverage-plugin NPM package', () => {
   const fixturesDir = path.join(
@@ -47,19 +48,33 @@ describe('PLUGIN collect report with doc-coverage-plugin NPM package', () => {
   });
 
   it('should run Doc Coverage plugin for Angular example dir and create report.json', async () => {
-    const { code } = await executeProcess({
+    const { code, stdout } = await executeProcess({
       command: 'npx',
       args: ['@code-pushup/cli', 'collect', '--no-progress'],
       cwd: angularDir,
     });
 
     expect(code).toBe(0);
 
+    expect(removeColorCodes(stdout)).toMatchFileSnapshot(
+      '__snapshots__/report.txt',
+    );
+
     const report = await readJsonFile(
       path.join(angularOutputDir, 'report.json'),
     );
 
     expect(() => reportSchema.parse(report)).not.toThrow();
-    expect(omitVariableReportData(report as Report)).toMatchSnapshot();
+    expect(
+      JSON.stringify(omitVariableReportData(report as Report), null, 2),
+    ).toMatchFileSnapshot('__snapshots__/report.json');
+
+    const reportMd = await readTextFile(
+      path.join(angularOutputDir, 'report.md'),
+    );
+
+    expect(reportMd.replace(/## About\.*/gm, '')).toMatchFileSnapshot(
+      '__snapshots__/report.md',
+    );
   });
 });

e2e/plugin-doc-coverage-e2e/tests/collect.e2e.test.ts

@@ -4,5 +4,5 @@ export class ExampleWithProperties {
    * Internal identifier that can only be accessed within this class
    * @private
    */
-  private readonly internalId = '123';
+  private readonly exampleProperty = '123';
 }

packages/plugin-doc-coverage/mocks/fixtures/filled-documentation/properties-coverage.ts

@@ -1,4 +1,7 @@
-export class Container {
+/**
+ * A class that serves as an example for documentation coverage testing
+ */
+export class ExampleClass {
   exampleMethod(): string {
     return 'exampleMethod';
   }

packages/plugin-doc-coverage/mocks/fixtures/missing-documentation/methods-coverage.ts

@@ -1,3 +1,6 @@
+/**
+ * A class that serves as an example for documentation coverage testing
+ */
 export class ExampleWithProperties {
-  private readonly internalId = '123';
+  private readonly exampleProperty = '123';
 }

packages/plugin-doc-coverage/mocks/fixtures/missing-documentation/properties-coverage.ts

@@ -0,0 +1,43 @@
+import {SyntaxKind,} from 'ts-morph';
+import type {CoverageType} from '../src/lib/runner/models.js';
+
+export function nodeMock(options: {
+  coverageType: CoverageType;
+  line: number;
+  file: string;
+  isCommented: boolean;
+}) {
+  return {
+    getKind: () => getKindFromCoverageType(options.coverageType),
+    getJsDocs: () => (options.isCommented ? ['Comment'] : []),
+    getName: () => 'test',
+    getStartLineNumber: () => options.line,
+    getDeclarations: () => [],
+    // Only for classes
+    getMethods: () => [],
+    getProperties: () => [],
+  };
+}
+
+function getKindFromCoverageType(coverageType: CoverageType): SyntaxKind {
+  switch (coverageType) {
+    case 'classes':
+      return SyntaxKind.ClassDeclaration;
+    case 'methods':
+      return SyntaxKind.MethodDeclaration;
+    case 'functions':
+      return SyntaxKind.FunctionDeclaration;
+    case 'interfaces':
+      return SyntaxKind.InterfaceDeclaration;
+    case 'enums':
+      return SyntaxKind.EnumDeclaration;
+    case 'variables':
+      return SyntaxKind.VariableDeclaration;
+    case 'properties':
+      return SyntaxKind.PropertyDeclaration;
+    case 'types':
+      return SyntaxKind.TypeAliasDeclaration;
+    default:
+      throw new Error(`Unsupported syntax kind: ${coverageType}`);
+  }
+}

packages/plugin-doc-coverage/mocks/node.mock.ts

@@ -9,6 +9,7 @@ import {
   VariableStatement,
 } from 'ts-morph';
 import type { CoverageType } from '../src/lib/runner/models.js';
+import {nodeMock} from "./node.mock";
 
 export function sourceFileMock(
   file: string,
@@ -39,44 +40,3 @@ export function sourceFileMock(
       createNodeGetter<VariableStatement>('variables', nodes.variables),
   } as SourceFile;
 }
-
-export function nodeMock(options: {
-  coverageType: CoverageType;
-  line: number;
-  file: string;
-  isCommented: boolean;
-}) {
-  return {
-    getKind: () => getKindFromCoverageType(options.coverageType),
-    getJsDocs: () => (options.isCommented ? ['Comment'] : []),
-    getName: () => 'test',
-    getStartLineNumber: () => options.line,
-    getDeclarations: () => [],
-    // Only for classes
-    getMethods: () => [],
-    getProperties: () => [],
-  };
-}
-
-function getKindFromCoverageType(coverageType: CoverageType): SyntaxKind {
-  switch (coverageType) {
-    case 'classes':
-      return SyntaxKind.ClassDeclaration;
-    case 'methods':
-      return SyntaxKind.MethodDeclaration;
-    case 'functions':
-      return SyntaxKind.FunctionDeclaration;
-    case 'interfaces':
-      return SyntaxKind.InterfaceDeclaration;
-    case 'enums':
-      return SyntaxKind.EnumDeclaration;
-    case 'variables':
-      return SyntaxKind.VariableDeclaration;
-    case 'properties':
-      return SyntaxKind.PropertyDeclaration;
-    case 'types':
-      return SyntaxKind.TypeAliasDeclaration;
-    default:
-      throw new Error(`Unsupported syntax kind: ${coverageType}`);
-  }
-}