// 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 'package:args/command_runner.dart'; import 'package:file/file.dart'; import 'package:flutter_plugin_tools/src/common/core.dart'; import 'package:flutter_plugin_tools/src/common/plugin_utils.dart'; import 'package:flutter_plugin_tools/src/gradle_check_command.dart'; import 'package:git/git.dart'; import 'package:test/test.dart'; import 'util.dart'; const String _defaultFakeNamespace = 'dev.flutter.foo'; void main() { late CommandRunner runner; late Directory packagesDir; const javaIncompatabilityIndicator = 'build.gradle(.kts) must set an explicit Java compatibility version.'; setUp(() { final GitDir gitDir; (:packagesDir, processRunner: _, gitProcessRunner: _, :gitDir) = configureBaseCommandMocks(); final command = GradleCheckCommand(packagesDir, gitDir: gitDir); runner = CommandRunner( 'gradle_check_command', 'Test for gradle_check_command', ); runner.addCommand(command); }); /// Writes a fake android/build.gradle file for plugin [package] with the /// given options. void writeFakePluginBuildGradle( RepositoryPackage package, { bool includeLanguageVersion = false, bool includeSourceCompat = false, bool includeTargetCompat = false, bool commentSourceLanguage = false, bool includeNamespace = true, bool commentNamespace = false, bool warningsConfigured = true, bool useDeprecatedCompileSdkVersion = false, bool usePropertyAssignment = true, String compileSdk = '36', bool includeKotlinOptions = true, bool commentKotlinOptions = false, bool useDeprecatedJvmTargetStyle = false, int jvmTargetValue = 17, int kotlinJvmValue = 17, }) { final File buildGradle = package .platformDirectory(FlutterPlatform.android) .childFile('build.gradle'); buildGradle.createSync(recursive: true); const warningConfig = ''' lintOptions { checkAllWarnings = true warningsAsErrors = true disable 'AndroidGradlePluginVersion', 'InvalidPackage', 'GradleDependency', 'NewerVersionAvailable' baseline file("lint-baseline.xml") } '''; final javaSection = ''' java { toolchain { ${commentSourceLanguage ? '// ' : ''}languageVersion = JavaLanguageVersion.of(8) } } '''; final sourceCompat = '${commentSourceLanguage ? '// ' : ''}sourceCompatibility = JavaVersion.VERSION_$jvmTargetValue'; final targetCompat = '${commentSourceLanguage ? '// ' : ''}targetCompatibility = JavaVersion.VERSION_$jvmTargetValue'; final namespace = " ${commentNamespace ? '// ' : ''}namespace = '$_defaultFakeNamespace'"; final kotlinJvmTarget = useDeprecatedJvmTargetStyle ? '$jvmTargetValue' : 'JavaVersion.VERSION_$kotlinJvmValue.toString()'; final kotlinConfig = ''' ${commentKotlinOptions ? '//' : ''}kotlinOptions { ${commentKotlinOptions ? '//' : ''}jvmTarget = $kotlinJvmTarget ${commentKotlinOptions ? '//' : ''}}'''; buildGradle.writeAsStringSync(''' group 'dev.flutter.plugins.fake' version '1.0-SNAPSHOT' buildscript { repositories { google() mavenCentral() } } apply plugin: 'com.android.library' ${includeLanguageVersion ? javaSection : ''} android { ${includeNamespace ? namespace : ''} ${useDeprecatedCompileSdkVersion ? 'compileSdkVersion' : 'compileSdk'} ${usePropertyAssignment ? '=' : ''} $compileSdk defaultConfig { minSdk ${usePropertyAssignment ? '=' : ''} 30 } ${warningsConfigured ? warningConfig : ''} compileOptions { ${includeSourceCompat ? sourceCompat : ''} ${includeTargetCompat ? targetCompat : ''} } ${includeKotlinOptions ? kotlinConfig : ''} testOptions { unitTests.includeAndroidResources = true } } dependencies { implementation 'fake.package:fake:1.0.0' } '''); } /// Writes a fake android/build.gradle file for an example [package] with the /// given options. void writeFakeExampleTopLevelBuildGradle( RepositoryPackage package, { required String pluginName, required bool warningsConfigured, String? kotlinVersion, bool includeArtifactHub = true, }) { final File buildGradle = package .platformDirectory(FlutterPlatform.android) .childFile('build.gradle'); buildGradle.createSync(recursive: true); final warningConfig = ''' gradle.projectsEvaluated { project(":$pluginName") { tasks.withType(JavaCompile) { options.compilerArgs << "-Xlint:all" << "-Werror" } } } '''; buildGradle.writeAsStringSync(''' buildscript { ${kotlinVersion == null ? '' : "ext.kotlin_version = '$kotlinVersion'"} repositories { ${includeArtifactHub ? GradleCheckCommand.exampleRootGradleArtifactHubString : ''} google() mavenCentral() } dependencies { classpath 'fake.package:fake:1.0.0' } } allprojects { repositories { google() mavenCentral() } } rootProject.buildDir = '../build' subprojects { project.buildDir = "\${rootProject.buildDir}/\${project.name}" } subprojects { project.evaluationDependsOn(':app') } task clean(type: Delete) { delete rootProject.buildDir } ${warningsConfigured ? warningConfig : ''} '''); } /// Writes a fake android/build.gradle file for an example [package] with the /// given options. void writeFakeExampleSettingsGradle( RepositoryPackage package, { bool includeArtifactHub = true, bool includeArtifactDocumentation = true, }) { final File settingsGradle = package .platformDirectory(FlutterPlatform.android) .childFile('settings.gradle'); settingsGradle.createSync(recursive: true); /// String printed as a valid example of settings.gradle repository /// configuration without the artifact hub env variable. const exampleSettingsWithoutArtifactHubString = ''' plugins { id "dev.flutter.flutter-plugin-loader" version "1.0.0" // ...other plugins } '''; settingsGradle.writeAsStringSync(''' pluginManagement { def flutterSdkPath = { def properties = new Properties() file("local.properties").withInputStream { properties.load(it) } def flutterSdkPath = properties.getProperty("flutter.sdk") assert flutterSdkPath != null, "flutter.sdk not set in local.properties" return flutterSdkPath }() includeBuild("\$flutterSdkPath/packages/flutter_tools/gradle") repositories { google() mavenCentral() gradlePluginPortal() } } ${includeArtifactDocumentation ? '// See ${GradleCheckCommand.artifactHubDocumentationString} for more info.' : ''} ${includeArtifactHub ? GradleCheckCommand.exampleSettingsArtifactHubString : exampleSettingsWithoutArtifactHubString} include ":app" '''); } /// Writes a fake android/app/build.gradle file for an example [package] with /// the given options. void writeFakeExampleAppBuildGradle( RepositoryPackage package, { required bool includeNamespace, required bool commentNamespace, required bool includeNameSpaceAsDeclaration, required bool usePropertyAssignment, }) { final File buildGradle = package .platformDirectory(FlutterPlatform.android) .childDirectory('app') .childFile('build.gradle'); buildGradle.createSync(recursive: true); final namespace = "${commentNamespace ? '// ' : ''}namespace ${includeNameSpaceAsDeclaration ? '= ' : ''}'$_defaultFakeNamespace'"; buildGradle.writeAsStringSync(''' def flutterRoot = localProperties.getProperty('flutter.sdk') if (flutterRoot == null) { throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.") } apply plugin: 'com.android.application' apply from: "\$flutterRoot/packages/flutter_tools/gradle/flutter.gradle" android { ${includeNamespace ? namespace : ''} compileSdk ${usePropertyAssignment ? '=' : ''} flutter.compileSdkVersion lintOptions { disable 'InvalidPackage' } defaultConfig { applicationId "io.flutter.plugins.cameraexample" minSdkVersion 21 targetSdkVersion 28 } } flutter { source '../..' } dependencies { testImplementation("fake.package:fake:1.0.0") } '''); } void writeFakeExampleBuildGradles( RepositoryPackage package, { required String pluginName, bool includeNamespace = true, bool commentNamespace = false, bool includeNameSpaceAsDeclaration = true, bool warningsConfigured = true, String? kotlinVersion, bool includeBuildArtifactHub = true, bool includeSettingsArtifactHub = true, bool includeSettingsDocumentationArtifactHub = true, bool usePropertyAssignment = true, }) { writeFakeExampleTopLevelBuildGradle( package, pluginName: pluginName, warningsConfigured: warningsConfigured, kotlinVersion: kotlinVersion, includeArtifactHub: includeBuildArtifactHub, ); writeFakeExampleAppBuildGradle( package, includeNamespace: includeNamespace, commentNamespace: commentNamespace, includeNameSpaceAsDeclaration: includeNameSpaceAsDeclaration, usePropertyAssignment: usePropertyAssignment, ); writeFakeExampleSettingsGradle( package, includeArtifactHub: includeSettingsArtifactHub, includeArtifactDocumentation: includeSettingsDocumentationArtifactHub, ); } void writeFakeManifest( RepositoryPackage package, { bool isApp = false, String packageName = _defaultFakeNamespace, }) { final Directory androidDir = package.platformDirectory( FlutterPlatform.android, ); final Directory startDir = isApp ? androidDir.childDirectory('app') : androidDir; final File manifest = startDir .childDirectory('src') .childDirectory('main') .childFile('AndroidManifest.xml'); manifest.createSync(recursive: true); manifest.writeAsString(''' '''); } test('skips when package has no Android directory', () async { createFakePackage('a_package', packagesDir, examples: []); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([contains('Skipped 1 package(s)')]), ); }); test('fails when build.gradle has no java compatibility version', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle(package); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([contains(javaIncompatabilityIndicator)]), ); }); test( 'fails when sourceCompatibility is provided with out targetCompatibility', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle(package, includeSourceCompat: true); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([contains(javaIncompatabilityIndicator)]), ); }, ); test( 'fails when sourceCompatibility/targetCompatibility are below minimum', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeSourceCompat: true, includeTargetCompat: true, jvmTargetValue: 11, kotlinJvmValue: 11, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'Which is below the minimum required. Use at least "JavaVersion.VERSION_', ), ]), ); }, ); test('fails when compatibility values do not match kotlinOptions', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeSourceCompat: true, includeTargetCompat: true, jvmTargetValue: 21, // ignore: avoid_redundant_argument_values kotlinJvmValue: 17, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'If build.gradle(.kts) uses JavaVersion.* versions must be the same.', ), ]), ); }); test('passes when jvmValues are higher than minimim', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeSourceCompat: true, includeTargetCompat: true, jvmTargetValue: 21, kotlinJvmValue: 21, ); writeFakeManifest(package); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test( 'passes when sourceCompatibility and targetCompatibility are specified', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeSourceCompat: true, includeTargetCompat: true, ); writeFakeManifest(package); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }, ); test('passes when toolchain languageVersion is specified', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('does not require java version in examples', () async { const pluginName = 'a_plugin'; final RepositoryPackage package = createFakePlugin(pluginName, packagesDir); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: pluginName); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), contains('Ran for 2 package(s)'), ]), ); }); test('fails when java compatibility version is commented out', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeSourceCompat: true, includeTargetCompat: true, commentSourceLanguage: true, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([contains(javaIncompatabilityIndicator)]), ); }); test('fails when languageVersion is commented out', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, commentSourceLanguage: true, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([contains(javaIncompatabilityIndicator)]), ); }); test( 'fails when plugin namespace does not match AndroidManifest.xml', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package, packageName: 'wrong.package.name'); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'build.gradle "namespace" must match the "package" attribute in AndroidManifest.xml', ), ]), ); }, ); test('fails when namespace is missing', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, includeNamespace: false, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('build.gradle must set a "namespace"'), ]), ); }); test('fails when namespace is missing from example', () async { const pluginName = 'a_plugin'; final RepositoryPackage package = createFakePlugin(pluginName, packagesDir); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: pluginName, includeNamespace: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('build.gradle must set a "namespace"'), ]), ); }); // TODO(stuartmorgan): Consider removing this in the future; we may at some // point decide that we have a use case of example apps having different // app IDs and namespaces. For now, it's enforced for consistency so they // don't just accidentally diverge. test( 'fails when namespace in example does not match AndroidManifest.xml', () async { const pluginName = 'a_plugin'; final RepositoryPackage package = createFakePlugin( pluginName, packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: pluginName); writeFakeManifest( example, isApp: true, packageName: 'wrong.package.name', ); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'build.gradle "namespace" must match the "package" attribute in AndroidManifest.xml', ), ]), ); }, ); test('fails when namespace is commented out', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, commentNamespace: true, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('build.gradle must set a "namespace"'), ]), ); }); test('fails when namespace is declared without "=" declaration', () async { const pluginName = 'a_plugin'; final RepositoryPackage package = createFakePlugin(pluginName, packagesDir); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: pluginName, includeNameSpaceAsDeclaration: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('build.gradle must set a "namespace"'), contains('The following packages had errors:'), ]), ); }); test('fails if gradle-driven lint-warnings-as-errors is missing', () async { const pluginName = 'a_plugin'; final RepositoryPackage plugin = createFakePlugin( pluginName, packagesDir, examples: [], ); writeFakePluginBuildGradle( plugin, includeLanguageVersion: true, warningsConfigured: false, ); writeFakeManifest(plugin); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'This package is not configured to enable all ' 'Gradle-driven lint warnings and treat them as errors.', ), contains('The following packages had errors:'), ]), ); }); test( 'fails if plugin example javac lint-warnings-as-errors is missing', () async { const pluginName = 'a_plugin'; final RepositoryPackage plugin = createFakePlugin( pluginName, packagesDir, platformSupport: { platformAndroid: const PlatformDetails(PlatformSupport.inline), }, ); writeFakePluginBuildGradle(plugin, includeLanguageVersion: true); writeFakeManifest(plugin); final RepositoryPackage example = plugin.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: pluginName, warningsConfigured: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'The example "example" is not configured to treat javac ' 'lints and warnings as errors.', ), contains('The following packages had errors:'), ]), ); }, ); test( 'passes if non-plugin package example javac lint-warnings-as-errors is missing', () async { const packageName = 'a_package'; final RepositoryPackage plugin = createFakePackage( packageName, packagesDir, ); final RepositoryPackage example = plugin.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, warningsConfigured: false, ); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }, ); group('Artifact Hub check', () { test('passes build.gradle artifact hub check when set', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, // ignore: avoid_redundant_argument_values includeBuildArtifactHub: true, // ignore: avoid_redundant_argument_values includeSettingsArtifactHub: true, // ignore: avoid_redundant_argument_values includeSettingsDocumentationArtifactHub: true, ); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), contains('Validating android/settings.gradle'), ]), ); }); test( 'fails artifact hub check when build and settings sections missing', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, includeBuildArtifactHub: false, includeSettingsArtifactHub: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains(GradleCheckCommand.exampleRootGradleArtifactHubString), contains(GradleCheckCommand.exampleSettingsArtifactHubString), ]), ); }, ); test('fails build.gradle artifact hub check when missing', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, includeBuildArtifactHub: false, // ignore: avoid_redundant_argument_values includeSettingsArtifactHub: true, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains(GradleCheckCommand.exampleRootGradleArtifactHubString), ]), ); }); test('fails settings.gradle artifact hub check when missing', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, // ignore: avoid_redundant_argument_values includeBuildArtifactHub: true, includeSettingsArtifactHub: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains(GradleCheckCommand.exampleSettingsArtifactHubString), ]), ); expect( output, isNot(contains(GradleCheckCommand.exampleRootGradleArtifactHubString)), ); }); test( 'prints error for declarative method of applying gradle plugins', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, // ignore: avoid_redundant_argument_values includeBuildArtifactHub: true, includeSettingsArtifactHub: false, // ignore: avoid_redundant_argument_values includeSettingsDocumentationArtifactHub: true, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains(GradleCheckCommand.exampleSettingsArtifactHubString), ]), ); }, ); test( 'error message is printed when documentation link is missing', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, // ignore: avoid_redundant_argument_values includeBuildArtifactHub: true, // ignore: avoid_redundant_argument_values includeSettingsArtifactHub: true, includeSettingsDocumentationArtifactHub: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains(GradleCheckCommand.artifactHubDocumentationString), ]), ); }, ); }); group('Kotlin version check', () { test('passes if not set', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: packageName); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('passes if at the minimum allowed version', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, kotlinVersion: minKotlinVersion.toString(), ); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('passes if above the minimum allowed version', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, kotlinVersion: '99.99.0', ); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('fails if below the minimum allowed version', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( 'a_package', packagesDir, ); writeFakePluginBuildGradle(package, includeLanguageVersion: true); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, kotlinVersion: '1.6.21', ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'build.gradle sets "ext.kotlin_version" to "1.6.21". The ' 'minimum Kotlin version that can be specified is ' '$minKotlinVersion, for compatibility with modern dependencies.', ), ]), ); }); }); group('compileSdk check', () { test( 'passes if set to a version higher than flutter.compileSdkVersion', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( packageName, packagesDir, isFlutter: true, ); // Current flutter.compileSdkVersion is 36. writeFakePluginBuildGradle( package, includeLanguageVersion: true, compileSdk: '37', ); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: packageName); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }, ); test( 'passes if set to flutter.compileSdkVersion with Flutter 3.27+', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( packageName, packagesDir, isFlutter: true, flutterConstraint: '>=3.27.0', ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, compileSdk: 'flutter.compileSdkVersion', ); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: packageName); writeFakeManifest(example, isApp: true); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }, ); test( 'fails if set to a version lower than flutter.compileSdkVersion', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( packageName, packagesDir, isFlutter: true, ); // Current flutter.compileSdkVersion is 36. const minCompileSdkVersion = '36'; const testCompileSdkVersion = '35'; writeFakePluginBuildGradle( package, includeLanguageVersion: true, compileSdk: testCompileSdkVersion, ); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: packageName); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'compileSdk version $testCompileSdkVersion is too low. ' 'Minimum required version is $minCompileSdkVersion.', ), ]), ); }, ); test( 'fails if set to flutter.compileSdkVersion with Flutter <3.27', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( packageName, packagesDir, isFlutter: true, flutterConstraint: '>=3.24.0', ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, compileSdk: 'flutter.compileSdkVersion', ); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: packageName); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'Use of flutter.compileSdkVersion requires a minimum ' 'Flutter version of 3.27, but this package currently supports ' '3.24.0', ), ]), ); }, ); test('fails if uses the legacy key', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( packageName, packagesDir, isFlutter: true, ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, useDeprecatedCompileSdkVersion: true, ); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles(example, pluginName: packageName); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'Please replace the deprecated "compileSdkVersion" setting ' 'with the newer "compileSdk"', ), ]), ); }); test('fails if compileSdk uses the method assignment', () async { const packageName = 'a_package'; final RepositoryPackage package = createFakePackage( packageName, packagesDir, isFlutter: true, ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, usePropertyAssignment: false, ); writeFakeManifest(package); final RepositoryPackage example = package.getExamples().first; writeFakeExampleBuildGradles( example, pluginName: packageName, usePropertyAssignment: false, ); writeFakeManifest(example, isApp: true); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('No "compileSdk =" found. Please use property assignment.'), ]), ); }); }); group('kotlinOptions check', () { test('passes when kotlin options are specified', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, // ignore: avoid_redundant_argument_values ensure codepath is tested if defaults change. includeKotlinOptions: true, ); writeFakeManifest(package); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('passes when kotlin options are not specified', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, includeKotlinOptions: false, ); writeFakeManifest(package); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('passes when kotlin options commented out', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, commentKotlinOptions: true, ); writeFakeManifest(package); final List output = await runCapturingPrint(runner, [ 'gradle-check', ]); expect( output, containsAllInOrder([ contains('Validating android/build.gradle'), ]), ); }); test('fails when kotlin options uses string jvm version', () async { final RepositoryPackage package = createFakePlugin( 'a_plugin', packagesDir, examples: [], ); writeFakePluginBuildGradle( package, includeLanguageVersion: true, useDeprecatedJvmTargetStyle: true, ); writeFakeManifest(package); Error? commandError; final List output = await runCapturingPrint( runner, ['gradle-check'], errorHandler: (Error e) { commandError = e; }, ); expect(commandError, isA()); expect( output, containsAllInOrder([ contains( 'build.gradle(.kts) sets jvmTarget then it must use JavaVersion syntax', ), ]), ); }); }); }