From 3ab01ddf1b10d0429676c19bceac495ad9c6d89d Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Thu, 2 May 2024 17:03:41 +0200 Subject: [PATCH 1/6] add dev mode where warnings don't fail the test --- .../src/main/kotlin/otel.java-conventions.gradle.kts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/conventions/src/main/kotlin/otel.java-conventions.gradle.kts b/conventions/src/main/kotlin/otel.java-conventions.gradle.kts index 8efde6aa777f..94b35baa54dc 100644 --- a/conventions/src/main/kotlin/otel.java-conventions.gradle.kts +++ b/conventions/src/main/kotlin/otel.java-conventions.gradle.kts @@ -72,12 +72,13 @@ tasks.withType().configureEach { // We suppress the "options" warning because it prevents compilation on modern JDKs "-Xlint:-options", // jdk21 generates more serial warnings than previous versions - "-Xlint:-serial", - - // Fail build on any warning - "-Werror" + "-Xlint:-serial" ) ) + if (System.getProperty("dev") != "true") { + // Fail build on any warning + compilerArgs.add("-Werror") + } } encoding = "UTF-8" From 968dab2c522b8fdb2898f8e4dc1fcce6b76d905f Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Tue, 14 May 2024 08:55:39 +0200 Subject: [PATCH 2/6] use local build cache in dev mode --- .gitignore | 1 + settings.gradle.kts | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index d5e39e5b25bd..2bcb97a8c2f8 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ target **/build/ **/generated/ examples/**/build/ +build-cache/ # Eclipse # ########### diff --git a/settings.gradle.kts b/settings.gradle.kts index 9df56a004b2d..a7dba311e9db 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -98,8 +98,15 @@ if (useScansGradleCom) { } buildCache { - remote(develocity.buildCache) { - isPush = isCI && geAccessKey.isNotEmpty() + if (System.getProperty("dev") == "true") { + local { + directory = File(rootDir, "build-cache") + removeUnusedEntriesAfterDays = 30 + } + } else { + remote(develocity.buildCache) { + isPush = isCI && geAccessKey.isNotEmpty() + } } } } From 23272a74d9b470f00acb1ef6f60fcc5524435aed Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Tue, 28 May 2024 11:21:28 +0200 Subject: [PATCH 3/6] document dev mode --- docs/contributing/running-tests.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/contributing/running-tests.md b/docs/contributing/running-tests.md index 58ff88f8405d..2a7fa024249a 100644 --- a/docs/contributing/running-tests.md +++ b/docs/contributing/running-tests.md @@ -38,6 +38,23 @@ To run these tests locally, add `-PtestLatestDeps=true` to your existing `gradle Executing `./gradlew :instrumentation::test --tests ` will run only the selected test. +### Ignoring warnings in tests + +During local development, you may want to ignore warnings in tests. + +To ignore warnings, formatting issues, or other non-fatal issues in tests, use + +``` +./gradlew test -Ddev=true -x spotlessCheck -x checkstyleMain +``` + +The `dev` flag + +- will ignore warnings in tests +- will use a local build cache, which can speed up the build + +The local build cache is also useful for other commands, such as `./gradlew spotlessApply -Ddev=true`. + ## Smoke tests The smoke tests are not run as part of a global `test` task run since they take a long time and are From d8902fe985115fe3dfd9dc981ccbdf4764a984d8 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Wed, 12 Jun 2024 12:51:11 +0200 Subject: [PATCH 4/6] Update docs/contributing/running-tests.md Co-authored-by: Trask Stalnaker --- docs/contributing/running-tests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/running-tests.md b/docs/contributing/running-tests.md index 2a7fa024249a..c21af76e49ad 100644 --- a/docs/contributing/running-tests.md +++ b/docs/contributing/running-tests.md @@ -40,7 +40,7 @@ Executing `./gradlew :instrumentation::test --tests Date: Wed, 12 Jun 2024 12:51:21 +0200 Subject: [PATCH 5/6] Update docs/contributing/running-tests.md Co-authored-by: Trask Stalnaker --- docs/contributing/running-tests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/running-tests.md b/docs/contributing/running-tests.md index c21af76e49ad..56cfdb3d71d9 100644 --- a/docs/contributing/running-tests.md +++ b/docs/contributing/running-tests.md @@ -38,7 +38,7 @@ To run these tests locally, add `-PtestLatestDeps=true` to your existing `gradle Executing `./gradlew :instrumentation::test --tests ` will run only the selected test. -### Ignoring warnings in tests +### How to prevent linting and formatting warnings from failing tests During local development, you may want to ignore lint warnings when running tests. From 81fc9fc4dc8bb81675551a3138c2849573d34c0b Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Wed, 12 Jun 2024 12:58:14 +0200 Subject: [PATCH 6/6] remove local build cache --- .gitignore | 1 - docs/contributing/running-tests.md | 7 +------ settings.gradle.kts | 11 ++--------- 3 files changed, 3 insertions(+), 16 deletions(-) diff --git a/.gitignore b/.gitignore index 2bcb97a8c2f8..d5e39e5b25bd 100644 --- a/.gitignore +++ b/.gitignore @@ -11,7 +11,6 @@ target **/build/ **/generated/ examples/**/build/ -build-cache/ # Eclipse # ########### diff --git a/docs/contributing/running-tests.md b/docs/contributing/running-tests.md index 56cfdb3d71d9..836a0f6d900b 100644 --- a/docs/contributing/running-tests.md +++ b/docs/contributing/running-tests.md @@ -48,12 +48,7 @@ To ignore warnings, formatting issues, or other non-fatal issues in tests, use ./gradlew test -Ddev=true -x spotlessCheck -x checkstyleMain ``` -The `dev` flag - -- will ignore warnings in tests -- will use a local build cache, which can speed up the build - -The local build cache is also useful for other commands, such as `./gradlew spotlessApply -Ddev=true`. +The `dev` flag will ignore warnings in tests. ## Smoke tests diff --git a/settings.gradle.kts b/settings.gradle.kts index a7dba311e9db..9df56a004b2d 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -98,15 +98,8 @@ if (useScansGradleCom) { } buildCache { - if (System.getProperty("dev") == "true") { - local { - directory = File(rootDir, "build-cache") - removeUnusedEntriesAfterDays = 30 - } - } else { - remote(develocity.buildCache) { - isPush = isCI && geAccessKey.isNotEmpty() - } + remote(develocity.buildCache) { + isPush = isCI && geAccessKey.isNotEmpty() } } }