-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
Changes from 13 commits
1723e03
dfa206d
1325af9
4d843ae
9e57354
ab38f6d
5ac281b
00c0579
30c2c33
c87ae30
8df5a41
8fc4466
a73ad60
80f0902
5629ea3
d51a036
55f9c9d
bf607c5
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 |
---|---|---|
@@ -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 |
---|---|---|
@@ -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" |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
/// | ||
|
@@ -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'); | ||
} | ||
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; | ||
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. 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. 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 just tried out only removing only the documentation, and it does include an error message. I have a check for |
||
} | ||
|
||
/// Validates the top-level build.gradle for an example app (e.g., | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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( | ||
|
@@ -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, | ||
|
@@ -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 | ||
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. If we always want to have the tests be explicit about all of their arguments, then let's make the test helper arguments be 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. done 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 dont see the version of the code where includeBuildArtifactHub and includeSettingsDocumentationArtifactHub are required without defaults and the 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 added 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 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)), | ||
); | ||
}); | ||
}); | ||
|
||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done