-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Add code coverage presubmit test #11942
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
c01885c
405bb67
6a60b80
c573a96
144f4f3
e77c789
146ab9b
56d8762
fcdfb2c
6cc606c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| tasks: | ||
| - name: prepare tool | ||
| script: .ci/scripts/prepare_tool.sh | ||
| infra_step: true | ||
| - name: code coverage check | ||
| script: .ci/scripts/tool_runner.sh | ||
| args: ["coverage-check", "--base-branch=origin/main"] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # A list of packages and their minimum required code coverage. | ||
| # Only packages listed in this file will be checked for code coverage | ||
| # when running the script/tool/lib/src/coverage_check_command.dart | ||
| # command. If a package drops below its listed threshold, the check | ||
| # will fail. | ||
| custom_coverage_minimums: | ||
| camera_android: 30.0 | ||
| camera_android_camerax: 18.3 |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,151 @@ | ||||||||||||||||||||||||||||||||||||||||||
| // Copyright 2013 The Flutter Authors | ||||||||||||||||||||||||||||||||||||||||||
| // Use of this source code is governed by a BSD-style license that can be | ||||||||||||||||||||||||||||||||||||||||||
| // found in the LICENSE file. | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| import 'dart:io' as io; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| import 'package:file/file.dart'; | ||||||||||||||||||||||||||||||||||||||||||
| import 'package:yaml/yaml.dart'; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| import 'common/package_looping_command.dart'; | ||||||||||||||||||||||||||||||||||||||||||
| import 'common/repository_package.dart'; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| /// A command to run code coverage checks on changed packages. | ||||||||||||||||||||||||||||||||||||||||||
| class CoverageCheckCommand extends PackageLoopingCommand { | ||||||||||||||||||||||||||||||||||||||||||
| /// Creates a coverage check command instance. | ||||||||||||||||||||||||||||||||||||||||||
| CoverageCheckCommand(super.packagesDir, {super.processRunner, super.platform, super.gitDir}); | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||
| final String name = 'coverage-check'; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||
| final String description = | ||||||||||||||||||||||||||||||||||||||||||
| 'Checks that code coverage meets the specified minimums ' | ||||||||||||||||||||||||||||||||||||||||||
| 'for opted-in packages.'; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||
| PackageLoopingType get packageLoopingType => PackageLoopingType.includeAllSubpackages; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| final Map<String, double> _customMinimums = <String, double>{}; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||
| Future<void> initializeRun() async { | ||||||||||||||||||||||||||||||||||||||||||
| final File minimumsFile = packagesDir.parent | ||||||||||||||||||||||||||||||||||||||||||
| .childDirectory('script') | ||||||||||||||||||||||||||||||||||||||||||
| .childDirectory('configs') | ||||||||||||||||||||||||||||||||||||||||||
| .childFile('custom_coverage_minimums.yaml'); | ||||||||||||||||||||||||||||||||||||||||||
| if (minimumsFile.existsSync()) { | ||||||||||||||||||||||||||||||||||||||||||
| final Object? yaml = loadYaml(minimumsFile.readAsStringSync()); | ||||||||||||||||||||||||||||||||||||||||||
| if (yaml is YamlMap) { | ||||||||||||||||||||||||||||||||||||||||||
| final Object? packageMap = yaml['custom_coverage_minimums']; | ||||||||||||||||||||||||||||||||||||||||||
| if (packageMap is YamlMap) { | ||||||||||||||||||||||||||||||||||||||||||
| for (final MapEntry<dynamic, dynamic> entry in packageMap.entries) { | ||||||||||||||||||||||||||||||||||||||||||
| final Object? key = entry.key; | ||||||||||||||||||||||||||||||||||||||||||
| final Object? value = entry.value; | ||||||||||||||||||||||||||||||||||||||||||
| if (key is String && value is num) { | ||||||||||||||||||||||||||||||||||||||||||
| _customMinimums[key] = value.toDouble(); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||
| Future<PackageResult> runForPackage(RepositoryPackage package) async { | ||||||||||||||||||||||||||||||||||||||||||
| // Only run for first-party packages. | ||||||||||||||||||||||||||||||||||||||||||
| final List<String> pathComponents = package.directory.fileSystem.path.split(package.path); | ||||||||||||||||||||||||||||||||||||||||||
| if (pathComponents.contains('third_party')) { | ||||||||||||||||||||||||||||||||||||||||||
| return PackageResult.skip('Not a first-party package.'); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| if (!package.testDirectory.existsSync()) { | ||||||||||||||||||||||||||||||||||||||||||
| return PackageResult.skip('No test/ directory.'); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| final String packageName = package.directory.basename; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| if (!_customMinimums.containsKey(packageName)) { | ||||||||||||||||||||||||||||||||||||||||||
| return PackageResult.skip('Package not opted into coverage checks.'); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| // Collect code coverage for the package. | ||||||||||||||||||||||||||||||||||||||||||
| final double? currentCoverage = await _runCoverageAndParse(package); | ||||||||||||||||||||||||||||||||||||||||||
| if (currentCoverage == null) { | ||||||||||||||||||||||||||||||||||||||||||
| return PackageResult.fail(<String>['Failed to run tests or parse coverage']); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| final double requiredCoverage = _customMinimums[packageName]!; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| // Delete generated lcov.info. | ||||||||||||||||||||||||||||||||||||||||||
| final Directory coverageDir = package.directory.childDirectory('coverage'); | ||||||||||||||||||||||||||||||||||||||||||
| if (coverageDir.existsSync()) { | ||||||||||||||||||||||||||||||||||||||||||
| coverageDir.deleteSync(recursive: true); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| if (currentCoverage < requiredCoverage) { | ||||||||||||||||||||||||||||||||||||||||||
| return PackageResult.fail(<String>[ | ||||||||||||||||||||||||||||||||||||||||||
| 'Code coverage for $packageName is ${currentCoverage.toStringAsFixed(1)}%, which is below the required ${requiredCoverage.toStringAsFixed(1)}%.', | ||||||||||||||||||||||||||||||||||||||||||
| ]); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| return PackageResult.success(); | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+80
to
+91
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Currently, the Swapping the deletion logic to only run on success improves the developer experience significantly by leaving the coverage artifacts intact for debugging when a check fails.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think the test is easily reproduceable locally so not sure we need this. |
||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| Future<double?> _runCoverageAndParse(RepositoryPackage package) async { | ||||||||||||||||||||||||||||||||||||||||||
| final io.ProcessResult result = await processRunner.run( | ||||||||||||||||||||||||||||||||||||||||||
| 'flutter', | ||||||||||||||||||||||||||||||||||||||||||
| <String>[ | ||||||||||||||||||||||||||||||||||||||||||
| 'test', | ||||||||||||||||||||||||||||||||||||||||||
| '--coverage', | ||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||
| workingDir: package.directory, | ||||||||||||||||||||||||||||||||||||||||||
| ); | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| if (result.exitCode != 0) { | ||||||||||||||||||||||||||||||||||||||||||
| print('Test failed for ${package.directory.basename}:\n${result.stdout}\n${result.stderr}'); | ||||||||||||||||||||||||||||||||||||||||||
| return null; | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| final File lcovFile = package.directory.childDirectory('coverage').childFile('lcov.info'); | ||||||||||||||||||||||||||||||||||||||||||
| if (!lcovFile.existsSync()) { | ||||||||||||||||||||||||||||||||||||||||||
| print('Coverage file not found at ${lcovFile.path}.'); | ||||||||||||||||||||||||||||||||||||||||||
| return null; | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| return _calculateCoverage(lcovFile); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| /// Calculates code coverage for non-generated code files by finding | ||||||||||||||||||||||||||||||||||||||||||
| /// the percentage of covered lines of code over the total lines of code. | ||||||||||||||||||||||||||||||||||||||||||
| double _calculateCoverage(File lcovFile) { | ||||||||||||||||||||||||||||||||||||||||||
| var linesHit = 0; | ||||||||||||||||||||||||||||||||||||||||||
| var linesFound = 0; | ||||||||||||||||||||||||||||||||||||||||||
| var skipCurrentFile = false; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| final List<String> lines = lcovFile.readAsLinesSync(); | ||||||||||||||||||||||||||||||||||||||||||
| for (final line in lines) { | ||||||||||||||||||||||||||||||||||||||||||
| if (line.startsWith('SF:')) { | ||||||||||||||||||||||||||||||||||||||||||
| final String fileName = line.substring(3); | ||||||||||||||||||||||||||||||||||||||||||
| skipCurrentFile = _isGeneratedFile(fileName); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| if (!skipCurrentFile) { | ||||||||||||||||||||||||||||||||||||||||||
| if (line.startsWith('LH:')) { | ||||||||||||||||||||||||||||||||||||||||||
| linesHit += int.parse(line.substring(3)); | ||||||||||||||||||||||||||||||||||||||||||
| } else if (line.startsWith('LF:')) { | ||||||||||||||||||||||||||||||||||||||||||
| linesFound += int.parse(line.substring(3)); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| if (linesFound == 0) { | ||||||||||||||||||||||||||||||||||||||||||
| return 100.0; | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| return (linesHit / linesFound) * 100.0; | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| bool _isGeneratedFile(String fileName) { | ||||||||||||||||||||||||||||||||||||||||||
| return fileName.endsWith('.g.dart') || | ||||||||||||||||||||||||||||||||||||||||||
| fileName.endsWith('.pb.dart') || | ||||||||||||||||||||||||||||||||||||||||||
| fileName.endsWith('.mocks.dart'); | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+147
to
+151
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider adding
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see no usages of https://pub.dev/packages/freezed but if reviewers think I should protect against this, I can go ahead and add it.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same answer for addressing #11942 (comment) |
||||||||||||||||||||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.