Add support for collecting coverage from dependencies that exist in the workspace #5631

DanTup · 2025-08-05T11:58:01Z

…he workspace Fixes #5623

DanTup · 2025-08-05T11:59:52Z

/gemini review

Copilot

Pull Request Overview

This PR adds support for collecting code coverage from workspace dependencies when running Flutter tests. It modifies the test runner to include coverage data from packages that exist in the workspace, not just the current package being tested.

Key changes:

Extends the test launch configuration to accept workspace package names for coverage collection
Adds new test files demonstrating the dependency coverage functionality
Updates the test controller to expose the coverage parser for accessing collected coverage data

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`src/test/test_projects/flutter_hello_world/lib/printer.dart`	Adds a simple print function to serve as a dependency for coverage testing
`src/test/test_projects/flutter_hello_world/example/test/printer_test.dart`	Test file that imports and tests the printer function from the parent package
`src/test/test_projects/flutter_hello_world/example/pubspec.yaml`	Configuration for the example package with dependency on the parent package
`src/test/test_projects/flutter_hello_world/example/lib/printer.dart`	Wrapper function that calls the parent package's printer function
`src/test/helpers.ts`	Adds file path constants for the new test project files
`src/test/flutter_test_debug/debug/flutter_test.test.ts`	Adds test coverage verification for dependency packages
`src/shared/vscode/interfaces.ts`	Exposes the coverage parser in the test controller API
`src/shared/utils/test.ts`	Extends launch configuration to include workspace package names for coverage
`src/extension/commands/test.ts`	Implements workspace package discovery for coverage collection

Copilot · 2025-08-05T12:00:18Z

src/extension/commands/test.ts

+		let workspacePackageNames: string[] | undefined;
+		if (includeCoverage && isFlutter) {
+			const workspacePackagePaths = await getAllProjectFolders(this.logger, getExcludedFolders, { requirePubspec: true, searchDepth: config.projectSearchDepth });
+			workspacePackageNames = workspacePackagePaths.map((packagePath) => path.basename(packagePath));


Using path.basename() to extract package names from paths may not be reliable. Consider reading the package name from each package's pubspec.yaml file instead, as the directory name might not always match the actual package name declared in pubspec.yaml.

gemini-code-assist

Code Review

This pull request adds support for collecting test coverage from workspace dependencies in Flutter projects. The changes correctly identify workspace packages and pass them to the flutter test command using the --coverage-package flag. The implementation is accompanied by good test coverage, including a new test case that verifies coverage is collected from a local dependency.

My review includes a couple of suggestions to improve code conciseness and reduce duplication in the tests. Overall, the changes are solid and address the intended issue effectively.

gemini-code-assist · 2025-08-05T12:01:41Z

src/shared/utils/test.ts

+			for (const packageName of workspacePackageNames) {
+				toolArgs.push("--coverage-package");
+				toolArgs.push(packageName);
+			}


This loop can be written more concisely using flatMap to create the arguments array in a single expression. This improves readability and is more idiomatic for functional-style programming.

toolArgs.push(...workspacePackageNames.flatMap((packageName) => ["--coverage-package", packageName]));

gemini-code-assist · 2025-08-05T12:01:41Z

src/test/flutter_test_debug/debug/flutter_test.test.ts

+	describe("collects coverage", () => {
+		it("for a basic test", async () => {
+			// Discover tests.
+			await openFile(flutterTestMainFile);
+			await waitForResult(() => !!privateApi.fileTracker.getOutlineFor(flutterTestMainFile));
+			const controller = privateApi.testController;
+
+			const suiteNode = controller.controller.items.get(`SUITE:${fsPath(flutterTestMainFile)}`)!;
+			const testRequest = new vs.TestRunRequest([suiteNode]);
+
+			const createTestRunOriginal = controller.controller.createTestRun;
+			const createTestRunStub = sb.stub(controller.controller, "createTestRun");
+			let addCoverageStub: SinonStub | undefined;
+			createTestRunStub.callsFake((request) => {
+				const originalResult = createTestRunOriginal.call(controller.controller, request);
+				addCoverageStub = sb.stub(originalResult, "addCoverage").returns(null);
+				return originalResult;
+			});
+			await controller.runTests(false, true, testRequest, fakeCancellationToken);
+
+			assert(addCoverageStub?.calledOnce);
+			const coverage = addCoverageStub.firstCall.args[0] as DartFileCoverage;
+			assert.equal(fsPath(coverage.uri), fsPath(flutterHelloWorldMainFile)); // App file, not test file.
+			assert.ok(coverage.statementCoverage.covered > 0);
+			assert.ok(coverage.statementCoverage.total > 0);
 		});
-		await controller.runTests(false, true, testRequest, fakeCancellationToken);

-		assert(addCoverageStub?.calledOnce);
-		const coverage = addCoverageStub.firstCall.args[0] as DartFileCoverage;
-		assert.equal(fsPath(coverage.uri), fsPath(flutterHelloWorldMainFile)); // App file, not test file.
-		assert.ok(coverage.statementCoverage.covered > 0);
-		assert.ok(coverage.statementCoverage.total > 0);
+		it("and includes dependencies", async () => {
+			// Discover tests.
+			await openFile(flutterHelloWorldExampleTestFile);
+			await waitForResult(() => !!privateApi.fileTracker.getOutlineFor(flutterHelloWorldExampleTestFile));
+
+			const controller = privateApi.testController;
+			const suiteNode = controller.controller.items.get(`SUITE:${fsPath(flutterHelloWorldExampleTestFile)}`)!;
+			const testRequest = new vs.TestRunRequest([suiteNode]);
+
+			const createTestRunOriginal = controller.controller.createTestRun;
+			const createTestRunStub = sb.stub(controller.controller, "createTestRun");
+			let addCoverageStub: SinonStub | undefined;
+			createTestRunStub.callsFake((request) => {
+				const originalResult = createTestRunOriginal.call(controller.controller, request);
+				addCoverageStub = sb.stub(originalResult, "addCoverage").returns(null);
+				return originalResult;
+			});
+			await controller.runTests(false, true, testRequest, fakeCancellationToken);
+
+			assert(addCoverageStub?.called);
+			const coverageFiles = addCoverageStub.getCalls().map((call) => fsPath((call.args[0] as DartFileCoverage).uri));
+			assert.deepStrictEqual(coverageFiles, [fsPath(flutterHelloWorldExamplePrinterFile), fsPath(flutterHelloWorldPrinterFile)]);
+		});
 	});


There's some duplicated test setup code in this describe block. You can extract the common logic for stubbing createTestRun and addCoverage into a beforeEach hook to reduce duplication and improve maintainability.

describe("collects coverage", () => { let addCoverageStub: SinonStub | undefined; beforeEach(() => { const controller = privateApi.testController; const createTestRunOriginal = controller.controller.createTestRun; const createTestRunStub = sb.stub(controller.controller, "createTestRun"); createTestRunStub.callsFake((request) => { const originalResult = createTestRunOriginal.call(controller.controller, request); addCoverageStub = sb.stub(originalResult, "addCoverage").returns(null); return originalResult; }); }); it("for a basic test", async () => { // Discover tests. await openFile(flutterTestMainFile); await waitForResult(() => !!privateApi.fileTracker.getOutlineFor(flutterTestMainFile)); const controller = privateApi.testController; const suiteNode = controller.controller.items.get(`SUITE:${fsPath(flutterTestMainFile)}`)!; const testRequest = new vs.TestRunRequest([suiteNode]); await controller.runTests(false, true, testRequest, fakeCancellationToken); assert(addCoverageStub?.calledOnce); const coverage = addCoverageStub!.firstCall.args[0] as DartFileCoverage; assert.equal(fsPath(coverage.uri), fsPath(flutterHelloWorldMainFile)); // App file, not test file. assert.ok(coverage.statementCoverage.covered > 0); assert.ok(coverage.statementCoverage.total > 0); }); it("and includes dependencies", async () => { // Discover tests. await openFile(flutterHelloWorldExampleTestFile); await waitForResult(() => !!privateApi.fileTracker.getOutlineFor(flutterHelloWorldExampleTestFile)); const controller = privateApi.testController; const suiteNode = controller.controller.items.get(`SUITE:${fsPath(flutterHelloWorldExampleTestFile)}`)!; const testRequest = new vs.TestRunRequest([suiteNode]); await controller.runTests(false, true, testRequest, fakeCancellationToken); assert(addCoverageStub?.called); const coverageFiles = addCoverageStub!.getCalls().map((call) => fsPath((call.args[0] as DartFileCoverage).uri)); assert.deepStrictEqual(coverageFiles, [fsPath(flutterHelloWorldExamplePrinterFile), fsPath(flutterHelloWorldPrinterFile)]); }); });

Add support for collecting coverage from dependencies that exist in t…

d70e240

…he workspace Fixes #5623

DanTup added this to the v3.118.0 milestone Aug 5, 2025

DanTup added is enhancement in flutter Relates to running Flutter apps in testing Relates to test execution of Dart/Flutter tests for end users labels Aug 5, 2025

DanTup changed the title ~~Add support for collecting coverage from dependencies that exist in t…~~ Add support for collecting coverage from dependencies that exist in the workspace Aug 5, 2025

DanTup requested a review from Copilot August 5, 2025 11:59

Copilot AI reviewed Aug 5, 2025

View reviewed changes

gemini-code-assist bot reviewed Aug 5, 2025

View reviewed changes

DanTup added 2 commits August 5, 2025 13:50

Fix tests

0b6414d

Review tweaks

2159fe5

DanTup merged commit d0d8c2f into master Aug 5, 2025
21 checks passed

DanTup deleted the handle-coverage-for-dependencies branch August 5, 2025 13:19

DanTup mentioned this pull request Sep 17, 2025

Code covarage isn't collected if the packages folder name does not match the package name in pubspec.yaml #5706

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for collecting coverage from dependencies that exist in the workspace #5631

Add support for collecting coverage from dependencies that exist in the workspace #5631

Uh oh!

DanTup commented Aug 5, 2025 •

edited

Loading

Uh oh!

DanTup commented Aug 5, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 5, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Aug 5, 2025

Uh oh!

gemini-code-assist bot Aug 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add support for collecting coverage from dependencies that exist in the workspace #5631

Add support for collecting coverage from dependencies that exist in the workspace #5631

Uh oh!

Conversation

DanTup commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DanTup commented Aug 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DanTup commented Aug 5, 2025 •

edited

Loading