feat: Support excluding source paths from coverage reporting (#1809)

* Disable a small linting thing.

* Pass the whole test run context down.

* Define our new setting.

* Remove an unused import.

* Implement new feature.

* Ensure coverage surfaces when no exclusions are set.

* Rewrote solution.

Sometimes simplicity is best.

* Do not permit negating.

---------

Co-authored-by: Changyong Gong <chagon@microsoft.com>

Author: glektarssza

package.json

@@ -350,6 +350,14 @@
                                     "type": "boolean",
                                     "description": "%configuration.java.test.config.coverage.appendResult.description%",
                                     "default": true
+                                },
+                                "excludes": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string"
+                                    },
+                                    "description": "%configuration.java.test.config.coverage.excludes.description%",
+                                    "default": []
                                 }
                             }
                         }
@@ -510,6 +518,14 @@
                                         "type": "boolean",
                                         "description": "%configuration.java.test.config.coverage.appendResult.description%",
                                         "default": true
+                                    },
+                                    "excludes": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "description": "%configuration.java.test.config.coverage.excludes.description%",
+                                        "default": []
                                     }
                                 }
                             }

package.nls.json

@@ -36,6 +36,7 @@
     "configuration.java.test.config.javaExec.description": "The path to java executable to use. For example: `C:\\Program Files\\jdk\\bin\\java.exe`. If unset project JDK's java executable is used.",
     "configuration.java.test.config.coverage.description": "The configurations for test coverage.",
     "configuration.java.test.config.coverage.appendResult.description": "Whether the coverage result is appended.",
+    "configuration.java.test.config.coverage.excludes.description": "A list of source files that should be excluded from coverage analysis. The can use any valid  [minimatch](https://www.npmjs.com/package/minimatch) pattern.",
     "contributes.viewsWelcome.inLightWeightMode": "No test cases are listed because the Java Language Server is currently running in [LightWeight Mode](https://aka.ms/vscode-java-lightweight). To show test cases, click on the button to switch to Standard Mode.\n[Switch to Standard Mode](command:java.server.mode.switch?%5B%22Standard%22,true%5D)",
     "contributes.viewsWelcome.enableTests": "Click below button to configure a test framework for your project.\n[Enable Java Tests](command:_java.test.enableTests)"
 }

src/controller/testController.ts

@@ -177,6 +177,8 @@ export const runTests: (request: TestRunRequest, option: IRunOption) => any = in
     let coverageProvider: JavaTestCoverageProvider | undefined;
     if (request.profile?.kind === TestRunProfileKind.Coverage) {
         coverageProvider = new JavaTestCoverageProvider();
+        // QUESTION: Fix this?
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         request.profile.loadDetailedCoverage = (_testRun: TestRun, fileCoverage: FileCoverage, _token: CancellationToken): Promise<FileCoverageDetail[]> => {
             return Promise.resolve(coverageProvider!.getCoverageDetails(fileCoverage.uri));
         };
@@ -265,7 +267,7 @@ export const runTests: (request: TestRunRequest, option: IRunOption) => any = in
                         }
                     }
                     if (request.profile?.kind === TestRunProfileKind.Coverage) {
-                        await coverageProvider!.provideFileCoverage(run, projectName);
+                        await coverageProvider!.provideFileCoverage(testContext);
                     }
                 }
             }

src/java-test-runner.api.ts

@@ -353,6 +353,14 @@ export interface IExecutionConfig {
          * @since 0.41.0
          */
         appendResult?: boolean;
+
+        /**
+         * A list of source files that should be excluded from coverage analysis.
+         * The can use any valid [minimatch](https://www.npmjs.com/package/minimatch)
+         * pattern.
+         * @since 0.43.2
+         */
+        excludes?: string[];
     }
 
     /**

src/provider/JavaTestCoverageProvider.ts

@@ -1,19 +1,34 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
-
-import { BranchCoverage, DeclarationCoverage, FileCoverage, FileCoverageDetail, Position, StatementCoverage, TestRun, Uri } from 'vscode';
+import * as minimatch from 'minimatch';
+import { BranchCoverage, DeclarationCoverage, FileCoverage, FileCoverageDetail, Position, StatementCoverage, Uri } from 'vscode';
 import { getJacocoReportBasePath } from '../utils/coverageUtils';
 import { executeJavaLanguageServerCommand } from '../utils/commandUtils';
 import { JavaTestRunnerDelegateCommands } from '../constants';
+import { IRunTestContext } from '../java-test-runner.api';
 
 export class JavaTestCoverageProvider {
 
     private coverageDetails: Map<Uri, FileCoverageDetail[]> = new Map<Uri, FileCoverageDetail[]>();
 
-    public async provideFileCoverage(run: TestRun, projectName: string): Promise<void> {
+    public async provideFileCoverage({testRun: run, projectName, testConfig}: IRunTestContext): Promise<void> {
         const sourceFileCoverages: ISourceFileCoverage[] = await executeJavaLanguageServerCommand<void>(JavaTestRunnerDelegateCommands.GET_COVERAGE_DETAIL,
             projectName, getJacocoReportBasePath(projectName)) || [];
-        for (const sourceFileCoverage of sourceFileCoverages) {
+        const sourceFileCoverageExclusions: minimatch.Minimatch[] = (testConfig?.coverage?.excludes ?? []).map((exclusion: string) =>
+            new minimatch.Minimatch(exclusion, {flipNegate: true, nonegate: true}));
+        const sourceFileCoveragesToReport: ISourceFileCoverage[] = [];
+        if (sourceFileCoverageExclusions.length <= 0) {
+            sourceFileCoveragesToReport.push(...sourceFileCoverages);
+        } else {
+            sourceFileCoverages.forEach((sourceFileCoverage: ISourceFileCoverage) => {
+                const uri: Uri = Uri.parse(sourceFileCoverage.uriString);
+                if (!sourceFileCoverageExclusions.some((exclusion: minimatch.Minimatch) =>
+                    exclusion.match(uri.fsPath))) {
+                    sourceFileCoveragesToReport.push(sourceFileCoverage);
+                }
+            });
+        }
+        for (const sourceFileCoverage of sourceFileCoveragesToReport) {
             const uri: Uri = Uri.parse(sourceFileCoverage.uriString);
             const detailedCoverage: FileCoverageDetail[] = [];
             for (const lineCoverage of sourceFileCoverage.lineCoverages) {