Gradle init script improvements

[erichaagdev]

❄️ Winter Update PR Navigator ❄️

1. Include realized build time savings in experiment summary #261
2. Include performance characteristics and support -x for Gradle experiment 1  #262
3. Always read project name from Build Scan data #263
4. ⛄ Gradle init script improvements #264
5. Adopt Foojay Toolchains and Kotlin DSL plugins in build logic #265
6. Add variable to query debug mode #266
7. Modernize Java launch code #267
8. Display serialization factor in summary of all experiments #272
9. Display potential build time savings in experiment summaries #274
10. Update the contract of command line tools #283

⛄ = you are here

Summary

This PR is a rebased version of #121 from @bigdaz. I decided to create a new branch and PR in order to preserve his branch as it. That way I could easily switch between the two as I verified these changes. Once this PR is merged #121 can be closed.

⚠️ While testing these changes, I discovered a bug that exists in the #121 version when running with Gradle 5.x. When running the scripts with -e both com.gradle.build-scan and com.gradle.enterprise are applied. This can be seen in this Build Scan. It seems this scenario causes an error when applying CCUD. I was able to resolve this by removing --scan as a parameter to the build validation scripts' Gradle invocation. Since the initialization scripts take care of configuring and setting up Gradle Enterprise I don't think the --scan parameter is required. However, --scan is still displayed in the printed Gradle invocation command. This is somewhat misleading now. In my opinion, it was also misleading before since the displayed command does not include the initialization scripts that perform additional configuration transparent to the user.

The only other change from #121 is that I removed all logger calls in the initialization scripts since they created unnecessary noise in the validation scripts output that was not present before.

Testing

In order to test this I ran the following experiments and verified a successful outcome.

The following parameter combinations were tested with Gradle 5.x, 6.x, and 7.x:

• online
• offline (-x)
• online, enable GE (-e)
• offline (-x), enable GE (-e)

./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/5.x/ge -t 'build'
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/5.x/ge -t 'build' -x
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/5.x/no-ge -t 'build' -e -s https://ge.solutions-team.gradle.com
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/5.x/no-ge -t 'build' -e -x
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/6.x/ge -t 'build'
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/6.x/ge -t 'build' -x
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/6.x/no-ge -t 'build' -e -s https://ge.solutions-team.gradle.com
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/6.x/no-ge -t 'build' -e -x
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/7.x/ge -t 'build'
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/7.x/ge -t 'build' -x
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/7.x/no-ge -t 'build' -e -s https://ge.solutions-team.gradle.com
./03-validate-local-build-caching-different-locations.sh -r git@github.com:gradle/ge-solutions.git -p sample-projects/gradle/7.x/no-ge -t 'build' -e -x
./04-validate-remote-build-caching-ci-ci.sh -1 https://ge.solutions-team.gradle.com/s/fvwne3ht4xgjg -2 https://ge.solutions-team.gradle.com/s/tjiwbi2b7oioo
./05-validate-remote-build-caching-ci-local.sh -1 https://ge.solutions-team.gradle.com/s/lc73bw56kdkxi

[jthurne]

However, --scan is still displayed in the printed Gradle invocation command. This is somewhat misleading now. In my opinion, it was also misleading before since the displayed command does not include the initialization scripts that perform additional configuration transparent to the user.

The intent with the displayed command is to show the user a simple command they can use themselves when running Gradle directly to achieve a similar result. With that in mind, we don't print out the full command used so as not to distract or misslead the user.

These initialization scripts have become sufficiently complex that I think many users would have difficulty interpreting them or understanding what they do. Which is fine, but it's a reason why we don't necessarily want to display their use in the command that we execute.

[jthurne]

Once this PR is merged #121 can be closed.

Would it be okay if we closed it now? I've gotten confused a few times between #121 and this PR. Closing a PR doesn't delete the underlying branch, so you could still compare your branch against Daz's original branch.

[erichaagdev]

A positive side effect of removing --scan is that if a build is not actually configured with Gradle Enterprise, then it will not try to publish a Build Scan to scans.gradle.com. For example:

./03-validate-local-build-caching-different-locations.sh -r https://github.com/android/nowinandroid -t assembleDemoDebug

If we run the above without these changes, the build will fail with the following error:

As you can see, it is asking to accept the terms of service so that a Build Scan may be published to scans.gradle.com. This is risky when running the scripts for a project whose Build Scan should not be made publicly available. With these changes, the user will see the following instead: