This is an automated email from the ASF dual-hosted git repository.
adoroszlai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ratis.git
The following commit(s) were added to refs/heads/master by this push:
new 6238fe30f RATIS-2252. Replace JUnitRunListener with
JUnit5TestExecutionListener (#1228)
6238fe30f is described below
commit 6238fe30fd2e54cdd6ec1a66edc383d033c7b47a
Author: Tsz-Wo Nicholas Sze <[email protected]>
AuthorDate: Wed Feb 26 00:15:55 2025 -0800
RATIS-2252. Replace JUnitRunListener with JUnit5TestExecutionListener
(#1228)
---
pom.xml | 6 --
.../apache/ratis/JUnit5TestExecutionListener.java | 51 ++++++++++++
.../java/org/apache/ratis/JUnitRunListener.java | 91 ----------------------
...g.junit.platform.launcher.TestExecutionListener | 18 +++++
4 files changed, 69 insertions(+), 97 deletions(-)
diff --git a/pom.xml b/pom.xml
index 5aa395b6d..0d5a0443e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -654,12 +654,6 @@
<exclude>**/Test*$*.java</exclude>
<exclude>${test.exclude.pattern}</exclude>
</excludes>
- <properties>
- <property>
- <name>listener</name>
- <value>org.apache.ratis.JUnitRunListener</value>
- </property>
- </properties>
</configuration>
</plugin>
<plugin>
diff --git
a/ratis-common/src/test/java/org/apache/ratis/JUnit5TestExecutionListener.java
b/ratis-common/src/test/java/org/apache/ratis/JUnit5TestExecutionListener.java
new file mode 100644
index 000000000..535d8968c
--- /dev/null
+++
b/ratis-common/src/test/java/org/apache/ratis/JUnit5TestExecutionListener.java
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.ratis;
+
+import org.apache.ratis.util.JavaUtils;
+import org.junit.platform.engine.TestExecutionResult;
+import org.junit.platform.launcher.TestExecutionListener;
+import org.junit.platform.launcher.TestIdentifier;
+
+import java.io.PrintStream;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * A {@link TestExecutionListener} to dump all threads after a test timeout
failure.
+ */
+public class JUnit5TestExecutionListener implements TestExecutionListener {
+ private final PrintStream out = System.out;
+
+ @Override
+ public void executionFinished(TestIdentifier id, TestExecutionResult result)
{
+ final Throwable timeoutException = getTimeoutException(result);
+ if (timeoutException != null) {
+ out.format("%n%s %s failed%n", JavaUtils.date(), id.getDisplayName());
+ timeoutException.printStackTrace(out);
+ JavaUtils.dumpAllThreads(out::println);
+ }
+ }
+
+ private static Throwable getTimeoutException(TestExecutionResult result) {
+ if (result == null) {
+ return null;
+ }
+ final Throwable throwable = result.getThrowable().orElse(null);
+ return throwable instanceof TimeoutException? throwable : null;
+ }
+}
diff --git a/ratis-common/src/test/java/org/apache/ratis/JUnitRunListener.java
b/ratis-common/src/test/java/org/apache/ratis/JUnitRunListener.java
deleted file mode 100644
index 144c8069c..000000000
--- a/ratis-common/src/test/java/org/apache/ratis/JUnitRunListener.java
+++ /dev/null
@@ -1,91 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.ratis;
-
-import org.apache.ratis.util.JavaUtils;
-import org.junit.internal.runners.statements.FailOnTimeout;
-import org.junit.runner.notification.Failure;
-import org.junit.runner.notification.RunListener;
-import org.junit.runners.model.Statement;
-import org.junit.runners.model.TestTimedOutException;
-
-import java.io.PrintStream;
-import java.util.concurrent.TimeUnit;
-
-/**
- * A {@link RunListener} to dump all threads after a test timeout failure.
- */
-public class JUnitRunListener extends RunListener {
- private static final Throwable TIMEOUT_EXCEPTION = getTimeoutException();
- private static final String TIMEOUT_EXCEPTION_PREFIX;
-
- private static Throwable getTimeoutException() {
- final FailOnTimeout f = FailOnTimeout.builder().withTimeout(1,
TimeUnit.NANOSECONDS).build(new Statement() {
- @Override
- public void evaluate() throws InterruptedException {
- Thread.sleep(1000);
- }
- });
- try {
- f.evaluate();
- } catch(Throwable throwable) {
- return throwable;
- }
- throw new IllegalStateException("Failed to getTimeoutException");
- }
-
- static {
- final String message = JUnitRunListener.TIMEOUT_EXCEPTION.getMessage();
- TIMEOUT_EXCEPTION_PREFIX = message.substring(0, message.indexOf('1'));
- }
-
- private final PrintStream out = System.out;
-
- @Override
- public void testFailure(Failure failure) {
- final Throwable timeoutException = getTimeoutException(failure);
- if (timeoutException != null) {
- out.format("%n%s ", JavaUtils.date());
- timeoutException.printStackTrace(out);
- JavaUtils.dumpAllThreads(out::println);
- }
- }
-
- private static Throwable getTimeoutException(Failure failure) {
- if (failure == null) {
- return null;
- }
- final Throwable throwable = failure.getException();
- if (throwable.getClass() != TIMEOUT_EXCEPTION.getClass()) {
- return null;
- }
- final String message = throwable.getMessage();
- if (message == null || !message.startsWith(TIMEOUT_EXCEPTION_PREFIX)) {
- return null;
- }
- return throwable;
- }
-
- public static void main(String[] args) {
- final JUnitRunListener listener = new JUnitRunListener();
- listener.out.println("TIMEOUT_EXCEPTION_PREFIX = '" +
TIMEOUT_EXCEPTION_PREFIX + "'");
- TIMEOUT_EXCEPTION.printStackTrace(listener.out);
-
- listener.testFailure(new Failure(null, new TestTimedOutException(999,
TimeUnit.MILLISECONDS)));
- }
-}
diff --git
a/ratis-common/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener
b/ratis-common/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener
new file mode 100644
index 000000000..71636f29a
--- /dev/null
+++
b/ratis-common/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener
@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+org.apache.ratis.JUnit5TestExecutionListener
\ No newline at end of file
