This is an automated email from the ASF dual-hosted git repository. adoroszlai pushed a commit to branch HDDS-9299 in repository https://gitbox.apache.org/repos/asf/ozone.git
commit 9559b2b41b468e62a100ab83e70bbd7799ab7dcb Author: Doroszlai, Attila <[email protected]> AuthorDate: Fri Oct 13 07:31:17 2023 +0200 improve doc for test tags/categories --- .../test-utils/src/main/java/org/apache/ozone/test/SlowTest.java | 7 +++++-- .../src/main/java/org/apache/ozone/test/UnhealthyTest.java | 6 +++++- .../test-utils/src/main/java/org/apache/ozone/test/tag/Flaky.java | 7 ++++--- .../test-utils/src/main/java/org/apache/ozone/test/tag/Native.java | 2 +- .../test-utils/src/main/java/org/apache/ozone/test/tag/Slow.java | 6 ++++-- .../src/main/java/org/apache/ozone/test/tag/Unhealthy.java | 7 ++++--- 6 files changed, 23 insertions(+), 12 deletions(-) diff --git a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/SlowTest.java b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/SlowTest.java index 2dca4158a0..88913625a7 100644 --- a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/SlowTest.java +++ b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/SlowTest.java @@ -18,8 +18,11 @@ package org.apache.ozone.test; /** - * Interface to mark test classes or methods that take too much time. - * These are excluded from CI runs for each commit and run periodically. + * Interface to mark JUnit4 test classes or methods that take too much time. + * These are excluded from CI runs for each commit, but can be run manually or + * in scheduled runs. + * + * Usage: <code>@Category(SlowTest.class) @Slow("HDDS-123")</code> */ public interface SlowTest { // category marker diff --git a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/UnhealthyTest.java b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/UnhealthyTest.java index c0719bdd2e..c975461af4 100644 --- a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/UnhealthyTest.java +++ b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/UnhealthyTest.java @@ -18,8 +18,12 @@ package org.apache.ozone.test; /** - * Interface to mark test classes or methods that are unhealthy which + * Interface to mark JUnit4 test classes or methods that are unhealthy, which * means either they are unstable or inconsistent to run. + * These are excluded from CI runs for each commit, but can be run manually or + * in scheduled runs. + * + * Usage: <code>@Category(UnhealthyTest.class) @Unhealthy("HDDS-123")</code> */ public interface UnhealthyTest { // category marker diff --git a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Flaky.java b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Flaky.java index 6b86d58c44..ac63fc9d5b 100644 --- a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Flaky.java +++ b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Flaky.java @@ -25,9 +25,10 @@ import java.lang.annotation.Target; import org.junit.jupiter.api.Tag; /** - * Annotation to mark test classes or methods with some intermittent failures. - * These are handled separately from the normal tests. (Not required to pass, - * may be repeated automatically, etc.) + * Annotation to mark JUnit5 test classes or methods that exhibit intermittent + * issues. These are run separately from the normal tests in CI. In case of + * failure they may be repeated a few times. + * Usage: <code>@Flaky("HDDS-123")</code> */ @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) diff --git a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Native.java b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Native.java index d11f0fdb9e..1aeb476cb8 100644 --- a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Native.java +++ b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Native.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; import org.junit.jupiter.api.Tag; /** - * Annotation to mark test classes that require native libraries. + * Annotation to mark JUnit5 test classes that require native libraries. */ @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) diff --git a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Slow.java b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Slow.java index 51d312e222..30c4a0a48f 100644 --- a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Slow.java +++ b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Slow.java @@ -25,8 +25,10 @@ import java.lang.annotation.Target; import org.junit.jupiter.api.Tag; /** - * Annotation to mark test classes or methods that take too much time. - * These are excluded from CI runs for each commit and run periodically. + * Annotation to mark JUnit5 test classes or methods that take too much time. + * These are excluded from CI runs for each commit, but can be run manually or + * in scheduled runs. + * Usage: <code>@Slow("HDDS-123")</code> */ @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) diff --git a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Unhealthy.java b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Unhealthy.java index 981c2e15a2..f64d3b741e 100644 --- a/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Unhealthy.java +++ b/hadoop-hdds/test-utils/src/main/java/org/apache/ozone/test/tag/Unhealthy.java @@ -25,10 +25,11 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to mark test classes or methods that are unhealthy which + * Annotation to mark JUnit5 test classes or methods that are unhealthy which * means either they are unstable or inconsistent to run. - * These are excluded from CI runs for each commit and should run only - * during nightly or other scheduled runs. + * These are excluded from CI runs for each commit, but can be run manually or + * in scheduled runs. + * Usage: <code>@Unhealthy("HDDS-123")</code> */ @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
