google-nomulus

mirror of https://github.com/google/nomulus.git synced 2025-06-21 11:50:48 +02:00

History

jianglai 78edc62ab3 Upgrade to Gradle 5.4 ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=244686718		2019-04-23 10:43:09 -04:00
..
buildSrc	Make repo override messages more consistent	2019-04-22 12:52:55 -04:00
config/checkstyle	Add Checkstyle and Error Prone to the Gradle build	2019-01-31 13:49:33 -05:00
core	Enable flow documentation in external build	2019-04-05 11:49:49 -04:00
gradle	Upgrade to Gradle 5.4	2019-04-23 10:43:09 -04:00
node_modules	Add the Closure Compiler/Library/Templates dependencies	2019-02-08 11:21:43 -05:00
proxy	Update proxy deployment pipeline	2019-04-22 13:02:39 -04:00
services	Move the lockfiles back to where they should have been	2019-02-12 11:18:09 -05:00
third_party	Enable flow documentation in external build	2019-04-05 11:49:49 -04:00
util	Enable flow documentation in external build	2019-04-05 11:49:49 -04:00
build.gradle	Make repo override messages more consistent	2019-04-22 12:52:55 -04:00
dependencies.gradle	Enable flow documentation in external build	2019-04-05 11:49:49 -04:00
gradle.properties	Enable flow documentation in external build	2019-04-05 11:49:49 -04:00
gradlew	Upgrade to Gradle 5.4	2019-04-23 10:43:09 -04:00
gradlew.bat	Upgrade to Gradle 5.4	2019-04-23 10:43:09 -04:00
package-lock.json	Fix overrides of plugin repository (take 2 of []	2019-02-13 16:24:16 -05:00
package.json	Add the Closure Compiler/Library/Templates dependencies	2019-02-08 11:21:43 -05:00
README.md	Add deploy notes to Gradle README	2019-01-31 14:03:45 -05:00
settings.gradle	Make repo override messages more consistent	2019-04-22 12:52:55 -04:00

README.md

This folder contains experimental Gradle scripts as an alternative to Bazel for the open-source Nomulus project. These are work-in-progress and are expected to evolve in the near future.

Gradle is configured to use the directory containing this file as root, but use the existing Nomulus source tree.

All testing is done with Gradle v5.1.1.

Notable Issues

Test suites (RdeTestSuite and TmchTestSuite) are ignored to avoid duplicate execution of tests. Neither suite performs any shared test setup routine, so it is easier to exclude the suite classes than individual test classes. This is the reason why all test tasks in the :core project contain the exclude pattern '"/TestCase.", "/TestSuite."'

Many Nomulus tests are not hermetic: they modify global state (e.g., the shared local instance of Datastore) but do not clean up on completion. This becomes a problem with Gradle. In the beginning we forced Gradle to run every test class in a new process, and incurred heavy overheads. Since then, we have fixed some tests, and manged to divide all tests into three suites that do not have intra-suite conflicts. We will revisit the remaining tests soon.

Note that it is unclear if all conflicting tests have been identified. More may be exposed if test execution order changes, e.g., when new tests are added or execution parallelism level changes.

Initial Setup

Install Gradle on your local host, then run the following commands from this directory:

# One-time command to add gradle wrapper:
gradle wrapper

# Start the build:
./gradlew build

From now on, use './gradlew build' or './gradlew test' to build and test your changes.

To upgrade to a new Gradle version for this project, use:

gradle wrapper --gradle-version version-number

Deploy to AppEngine

Use the Gradle task 'appengineDeploy' to build and deploy to AppEngine. For now you must update the appengine.deploy.project in build.gradle to your GCP project ID.

To deploy the Gradle build, you will need the Google Cloud SDK and its app-engine-java component.