Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add enforcement of targetCompatibility
  • Loading branch information
stuartmorgan-g committed Apr 26, 2023
commit 2fbe8d159042d577f79a45b81e2dde3f1561c35e
23 changes: 16 additions & 7 deletions script/tool/lib/src/gradle_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ class GradleCheckCommand extends PackageLoopingCommand {
if (!_validateNamespace(package, contents, isExample: false)) {
succeeded = false;
}
if (!_validateSourceCompatibilityVersion(lines)) {
if (!_validateCompatibilityVersions(lines)) {
succeeded = false;
}
if (!_validateGradleDrivenLintConfig(package, lines)) {
Expand Down Expand Up @@ -204,18 +204,27 @@ build.gradle "namespace" must match the "package" attribute in AndroidManifest.x
/// Checks for a source compatibiltiy version, so that it's explicit rather
/// than using whatever the client's local toolchaing defaults to (which can
/// lead to compile errors that show up for clients, but not in CI).
bool _validateSourceCompatibilityVersion(List<String> gradleLines) {
if (!gradleLines.any((String line) =>
line.contains('languageVersion') && !_isCommented(line)) &&
!gradleLines.any((String line) =>
line.contains('sourceCompatibility') && !_isCommented(line))) {
bool _validateCompatibilityVersions(List<String> gradleLines) {
final bool hasLanguageVersion = gradleLines.any((String line) =>
line.contains('languageVersion') && !_isCommented(line));
final bool hasCompabilityVersions = gradleLines.any((String line) =>
line.contains('sourceCompatibility') && !_isCommented(line)) &&
// Newer toolchains default targetCompatibility to the same value as
// sourceCompatibility, but older toolchains require it to be set
// explicitly. The exact version cutoff (and of which piece of the
// toolchain; likely AGP) is unknown; for context see
// https://github.com/flutter/flutter/issues/125482
gradleLines.any((String line) =>
line.contains('targetCompatibility') && !_isCommented(line));
if (!hasLanguageVersion && !hasCompabilityVersions) {
const String errorMessage = '''
build.gradle must set an explicit Java compatibility version.

This can be done either via "sourceCompatibility":
This can be done either via "sourceCompatibility"/"targetCompatibility":
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}

Expand Down
47 changes: 39 additions & 8 deletions script/tool/test/gradle_check_command_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ void main() {
RepositoryPackage package, {
bool includeLanguageVersion = false,
bool includeSourceCompat = false,
bool includeTargetCompat = false,
bool commentSourceLanguage = false,
bool includeNamespace = true,
bool commentNamespace = false,
Expand All @@ -64,11 +65,10 @@ java {
}

''';
final String compileOptionsSection = '''
compileOptions {
${commentSourceLanguage ? '// ' : ''}sourceCompatibility JavaVersion.VERSION_1_8
}
''';
final String sourceCompat =
'${commentSourceLanguage ? '// ' : ''}sourceCompatibility JavaVersion.VERSION_1_8';
final String targetCompat =
'${commentSourceLanguage ? '// ' : ''}targetCompatibility JavaVersion.VERSION_1_8';
final String namespace =
"${commentNamespace ? '// ' : ''}namespace '$_defaultFakeNamespace'";

Expand All @@ -94,7 +94,10 @@ android {
minSdkVersion 30
}
${warningsConfigured ? warningConfig : ''}
${includeSourceCompat ? compileOptionsSection : ''}
compileOptions {
${includeSourceCompat ? sourceCompat : ''}
${includeTargetCompat ? targetCompat : ''}
}
testOptions {
unitTests.includeAndroidResources = true
}
Expand Down Expand Up @@ -280,12 +283,38 @@ dependencies {
);
});

test('passes when sourceCompatibility is specified', () async {
test(
'fails when sourceCompatibility is provided with out targetCompatibility',
() async {
final RepositoryPackage package =
createFakePlugin('a_plugin', packagesDir, examples: <String>[]);
writeFakePluginBuildGradle(package, includeSourceCompat: true);
writeFakeManifest(package);

Error? commandError;
final List<String> output = await runCapturingPrint(
runner, <String>['gradle-check'], errorHandler: (Error e) {
commandError = e;
});

expect(commandError, isA<ToolExit>());
expect(
output,
containsAllInOrder(<Matcher>[
contains(
'build.gradle must set an explicit Java compatibility version.'),
]),
);
});

test('passes when sourceCompatibility and targetCompatibility are specified',
() async {
final RepositoryPackage package =
createFakePlugin('a_plugin', packagesDir, examples: <String>[]);
writeFakePluginBuildGradle(package,
includeSourceCompat: true, includeTargetCompat: true);
writeFakeManifest(package);

final List<String> output =
await runCapturingPrint(runner, <String>['gradle-check']);

Expand Down Expand Up @@ -339,7 +368,9 @@ dependencies {
final RepositoryPackage package =
createFakePlugin('a_plugin', packagesDir, examples: <String>[]);
writeFakePluginBuildGradle(package,
includeSourceCompat: true, commentSourceLanguage: true);
includeSourceCompat: true,
includeTargetCompat: true,
commentSourceLanguage: true);
writeFakeManifest(package);

Error? commandError;
Expand Down