Skip to content
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

Applied Gradle Plugins Declaratively for path_provider #7822

Merged
merged 18 commits into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
plugins {
id "com.android.application"
id "org.jetbrains.kotlin.android"
id "dev.flutter.flutter-gradle-plugin"
}

def localProperties = new Properties()
def localPropertiesFile = rootProject.file('local.properties')
if (localPropertiesFile.exists()) {
Expand All @@ -6,11 +12,6 @@ if (localPropertiesFile.exists()) {
}
}

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.")
}

def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
if (flutterVersionCode == null) {
flutterVersionCode = '1'
Expand All @@ -21,9 +22,6 @@ if (flutterVersionName == null) {
flutterVersionName = '1.0'
}

apply plugin: 'com.android.application'
apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"

android {
namespace 'io.flutter.plugins.pathproviderexample'
compileSdk flutter.compileSdkVersion
Expand All @@ -32,7 +30,7 @@ android {
defaultConfig {
applicationId "io.flutter.plugins.pathproviderexample"
minSdkVersion flutter.minSdkVersion
targetSdkVersion 28
targetSdkVersion 35
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<application android:label="path_provider_example" android:icon="@mipmap/ic_launcher">
<activity android:name="io.flutter.embedding.android.FlutterActivity"
android:launchMode="singleTop"
android:exported="true"
android:theme="@android:style/Theme.Black.NoTitleBar"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection"
android:hardwareAccelerated="true"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
buildscript {
repositories {
google()
mavenCentral()
}

dependencies {
classpath 'com.android.tools.build:gradle:8.5.2'
}
}

allprojects {
repositories {
// See https://github.com/flutter/flutter/blob/master/docs/ecosystem/Plugins-and-Packages-repository-structure.md#gradle-structure for more info.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
include ':app'
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
}()

def flutterProjectRoot = rootProject.projectDir.parentFile.toPath()
includeBuild("$flutterSdkPath/packages/flutter_tools/gradle")

def plugins = new Properties()
def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins')
if (pluginsFile.exists()) {
pluginsFile.withInputStream { stream -> plugins.load(stream) }
}

plugins.each { name, path ->
def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile()
include ":$name"
project(":$name").projectDir = pluginDirectory
repositories {
google()
mavenCentral()
gradlePluginPortal()
}
}

// See https://github.com/flutter/flutter/blob/master/docs/ecosystem/Plugins-and-Packages-repository-structure.md#gradle-structure for more info.
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "gradle.plugin.com.google.cloud.artifactregistry:artifactregistry-gradle-plugin:2.2.1"
}
plugins {
id "dev.flutter.flutter-plugin-loader" version "1.0.0"
id "com.android.application" version "8.6.0" apply false
id "org.jetbrains.kotlin.android" version "1.7.10" apply false
id "com.google.cloud.artifactregistry.gradle-plugin" version "2.2.1"
}
apply plugin: "com.google.cloud.artifactregistry.gradle-plugin"

include ":app"
34 changes: 27 additions & 7 deletions script/tool/lib/src/gradle_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,19 @@ buildscript {
apply plugin: "com.google.cloud.artifactregistry.gradle-plugin"
''';

/// String printed as a valid example of settings.gradle repository
/// configuration that enables artifact hub env variable.
/// GP stands for the gradle plugin method of flutter tooling inclusion.
@visibleForTesting
static String exampleSettingsArtifactHubStringGP = '''
// See $artifactHubDocumentationString for more info.
plugins {
id "dev.flutter.flutter-plugin-loader" version "1.0.0"
// ...other plugins
id "com.google.cloud.artifactregistry.gradle-plugin" version "2.2.1"
}
''';

/// Validates that [gradleLines] reads and uses a artifiact hub repository
/// when ARTIFACT_HUB_REPOSITORY is set.
///
Expand All @@ -228,24 +241,31 @@ apply plugin: "com.google.cloud.artifactregistry.gradle-plugin"
r'classpath.*gradle\.plugin\.com\.google\.cloud\.artifactregistry:artifactregistry-gradle-plugin');
final RegExp artifactRegistryPluginApplyRegex = RegExp(
r'apply.*plugin.*com\.google\.cloud\.artifactregistry\.gradle-plugin');
final RegExp artifactRegistryPluginApplyRegexGP = RegExp(
r'id.*com\.google\.cloud\.artifactregistry\.gradle-plugin.*version.*\b\d+\.\d+\.\d+\b');


final bool documentationPresent = gradleLines
.any((String line) => documentationPresentRegex.hasMatch(line));
final bool artifactRegistryDefined = gradleLines
.any((String line) => artifactRegistryDefinitionRegex.hasMatch(line));
final bool artifactRegistryPluginApplied = gradleLines
.any((String line) => artifactRegistryPluginApplyRegex.hasMatch(line));
final bool artifactRegistryPluginAppliedGP = gradleLines
.any((String line) => artifactRegistryPluginApplyRegexGP.hasMatch(line));

final bool validArtifactConfiguration = documentationPresent &&
((artifactRegistryDefined && artifactRegistryPluginApplied) || artifactRegistryPluginAppliedGP);

if (!(documentationPresent &&
artifactRegistryDefined &&
artifactRegistryPluginApplied)) {
if (!validArtifactConfiguration && !artifactRegistryPluginAppliedGP) {
printError('Failed Artifact Hub validation. Include the following in '
'example root settings.gradle:\n$exampleSettingsArtifactHubStringGP');
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of these lines which I think are a response to this thread.

add documentationPresent to the check for GP method of applying artifact registry.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

if (!validArtifactConfiguration && !(artifactRegistryDefined && artifactRegistryPluginApplied)) {
printError('Failed Artifact Hub validation. Include the following in '
'example root settings.gradle:\n$exampleRootSettingsArtifactHubString');
}

return documentationPresent &&
artifactRegistryDefined &&
artifactRegistryPluginApplied;
return validArtifactConfiguration;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the only thing is missing is the documentation, before it would print an example of what needed to be included that included the documentation, whereas now it would fail without any actionable message.

Copy link
Contributor Author

@jesswrd jesswrd Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tried out only removing only the documentation, and it does include an error message. I have a check for documentationPresent when validArtifactConfiguration is deinfed, and check for !validArtifactConfiguration when an error should be printed. Could you further explain why it would fail?

}

/// Validates the top-level build.gradle for an example app (e.g.,
Expand Down
107 changes: 107 additions & 0 deletions script/tool/test/gradle_check_command_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,51 @@ ${includeArtifactHub ? GradleCheckCommand.exampleRootSettingsArtifactHubString :
''');
}

/// Writes a fake android/build.gradle file for an example [package] with the
/// given options.
void writeFakeExampleSettingsGradle(
RepositoryPackage package, {
bool includeArtifactHub = 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.
/// GP stands for the gradle plugin method of flutter tooling inclusion.
const String exampleSettingsWithoutArtifactHubStringGP = '''
// See ${GradleCheckCommand.artifactHubDocumentationString} for more info.
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()
}
}
${includeArtifactHub ? GradleCheckCommand.exampleSettingsArtifactHubStringGP : exampleSettingsWithoutArtifactHubStringGP}
include ":app"
''');
}

/// Writes a fake android/app/build.gradle file for an example [package] with
/// the given options.
void writeFakeExampleAppBuildGradle(
Expand Down Expand Up @@ -274,6 +319,31 @@ dependencies {
);
}

void writeFakeExampleBuildGradleGP(
RepositoryPackage package, {
required String pluginName,
bool includeNamespace = true,
bool commentNamespace = false,
bool warningsConfigured = true,
String? kotlinVersion,
bool includeBuildArtifactHub = true,
bool includeSettingsArtifactHub = true,
}) {
writeFakeExampleTopLevelBuildGradle(
package,
pluginName: pluginName,
warningsConfigured: warningsConfigured,
kotlinVersion: kotlinVersion,
includeArtifactHub: includeBuildArtifactHub,
);
writeFakeExampleAppBuildGradle(package,
includeNamespace: includeNamespace, commentNamespace: commentNamespace);
writeFakeExampleSettingsGradle(
package,
includeArtifactHub: includeSettingsArtifactHub,
);
}

void writeFakeManifest(
RepositoryPackage package, {
bool isApp = false,
Expand Down Expand Up @@ -788,6 +858,43 @@ dependencies {
output,
isNot(contains(GradleCheckCommand.exampleRootGradleArtifactHubString)),
);
expect(
output,
isNot(contains(GradleCheckCommand.exampleSettingsArtifactHubStringGP)),
);
});

test('contains declarative method of applying gradle plugins', () async {
const String packageName = 'a_package';
final RepositoryPackage package =
createFakePackage('a_package', packagesDir);
writeFakePluginBuildGradle(package, includeLanguageVersion: true);
writeFakeManifest(package);
final RepositoryPackage example = package.getExamples().first;
writeFakeExampleBuildGradleGP(example,
pluginName: packageName,
// ignore: avoid_redundant_argument_values
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we always want to have the tests be explicit about all of their arguments, then let's make the test helper arguments be required instead of having to annotate all of the calls.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont see the version of the code where includeBuildArtifactHub and includeSettingsDocumentationArtifactHub are required without defaults and the // ignore: avoid_redundant_argument_values are removed. Did you need to push a change?

Copy link
Contributor Author

@jesswrd jesswrd Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added required and removed the annotations for writeFakeExampleBuildGradleGP but not for writeFakeExampleBuildGradles. Keeping args optional for writeFakeExampleBuildGradles as it is used in unrelated tests.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that writeFakeExampleBuildGradles will need to be modified in the version of your pr that removes the "or" condition from the older way and the way you are replacing but for now can be left alone.

includeBuildArtifactHub: true,
includeSettingsArtifactHub: false);
writeFakeManifest(example, isApp: true);

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(GradleCheckCommand.exampleSettingsArtifactHubStringGP),
]),
);
expect(
output,
isNot(contains(GradleCheckCommand.exampleRootSettingsArtifactHubString)),
);
});
});

Expand Down