improve: allow flaky tests run with specify parameters

[hezhangjian]

Fix #3249

Motivation

This PR addresses the issue where tests annotated with @FlakyTest were not being executed by JUnit unless they were also annotated with @test. To resolve this, we have updated our Maven Surefire plugin configuration to exclude tests tagged with flaky during regular CI runs, allowing these tests to be run separately. This adjustment ensures that all tests, including those marked as flaky, are executed as intended unless explicitly excluded. Moreover, we've planned the addition of a daily CI job and non-required CI to specifically run tests tagged as flaky, ensuring continuous monitoring and quicker identification of intermittent issues without affecting the main test pipeline. This setup also enhances the ability to run tests directly from the IDE, making it more convenient for developers to execute and debug individual tests as needed.

[lhotari]

ChatGPT claims that it's possible to make the custom annotation hold the @Test and @Tag annotations when there's @Retention(RetentionPolicy.RUNTIME)

package org.apache.bookkeeper.common.testing.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

/**
 * Intended for marking a test case as flaky.
 */
@Documented
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Tag("flaky")
@Test
public @interface FlakyTest {

    /**
     * Context information such as links to discussion thread, tracking issues etc.
     *
     * @return context information about this flaky test.
     */
    String value();
}

I didn't validate this. Could you please check?

[lhotari]

Looks like it's in the Junit Jupiter docs too. Please see 2.1.1. Meta-Annotations and Composed Annotations.