Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
84 lines (60 loc) · 2.86 KB

DEVELOPMENT.md

File metadata and controls

84 lines (60 loc) · 2.86 KB
Raw

Development

Useful Custom Gradle tasks

These tasks can be run like so:

./gradlew publishGuide

  • codeStyle - runs all code style checks
  • publishGuide - generates the user guide in the grails-doc/build/original-guide

Various properties that control which tasks to run

These can be set on the command line like so:

./gradlew check -PskipCodeStyle

  • gebAtCheckWaiting - enables Geb atCheckWaiting
  • onlyCoreTests - runs tests that do not include mongo, hibernate, or functional
  • onlyFunctionalTests - runs only grails-test-examples/* tests
  • onlyHibernate5Tests - runs only a hibernate5 related test
  • onlyHibernate7Tests - runs only a hibernate7 related test
  • onlyMongodbTests - runs only a mongodb related test
  • serializeMongoTests - if true, only integration tests from one mongo project will run at a time
  • skipCodeStyle - does not run code style checks
  • skipCoreTests - does not run the "core" tests
  • skipFunctionalTests - does not run the functional tests
  • skipHibernate5Tests - does not run hibernate5 related tests
  • skipHibernate7Tests - does not run hibernate7 related tests
  • skipMongodbTests - does not run mongo related tests
  • skipTests - no tests will run

Test slicing

Test classes tagged with @spock.lang.Tag('some-tag') can be run separately.
Tags are inherited from superclasses, so a test class is also included if any of its ancestors is tagged.

Example:

./gradlew iT -PincludeTestTags=geb

Available project properties:

  • includeTestTags - comma-separated list of test tags to include
  • excludeTestTags - comma-separated list of test tags to exclude

Example with multiple tags:

./gradlew iT -PincludeTestTags=geb,api

Environment variables

  • DO_NOT_CACHE_TESTS - set to 1 (or any truthy value) to force every Test task to run every invocation, without needing --rerun-tasks. This skips both Gradle's build cache and the up-to-date check for tests, while leaving the rest of the build (compilation, resource processing, etc.) cacheable. Useful when chasing flaky tests that depend on test execution order across runs.

    DO_NOT_CACHE_TESTS=1 ./gradlew :grails-gsp:test

Start a mongo docker container (containers will start by default)

docker run -d --name mongo-on-docker -p 27017:27017 mongo