You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by uc...@apache.org on 2015/09/23 11:46:16 UTC
flink git commit: [tests] Add RetryOnFailure annotation
Repository: flink
Updated Branches:
refs/heads/master 7825461ed -> 7d78f3632
[tests] Add RetryOnFailure annotation
Remove TestRetry
This closes #1167
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/7d78f363
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/7d78f363
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/7d78f363
Branch: refs/heads/master
Commit: 7d78f36320e9e4b340ec930f2910ea3bbfe31424
Parents: 7825461
Author: Ufuk Celebi <uc...@apache.org>
Authored: Mon Sep 21 21:23:04 2015 +0200
Committer: Ufuk Celebi <uc...@apache.org>
Committed: Wed Sep 23 11:46:01 2015 +0200
----------------------------------------------------------------------
.../flink/testutils/junit/RetryOnFailure.java | 49 ++++++++
.../testutils/junit/RetryOnFailureTest.java | 78 +++++++++++++
.../apache/flink/testutils/junit/RetryRule.java | 113 +++++++++++++++++++
3 files changed, 240 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/7d78f363/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailure.java
----------------------------------------------------------------------
diff --git a/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailure.java b/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailure.java
new file mode 100644
index 0000000..40e01c1
--- /dev/null
+++ b/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailure.java
@@ -0,0 +1,49 @@
+/*
+ * 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.flink.testutils.junit;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation to use with {@link RetryRule}.
+ *
+ * <p>Add the {@link RetryRule} to your test and annotate tests with {@link RetryOnFailure}.
+ *
+ * <pre>
+ * public class YourTest {
+ *
+ * {@literal@}Rule
+ * public RetryRule retryRule = new RetryRule();
+ *
+ * {@literal@}Test
+ * {@literal@}RetryOnFailure(times=1)
+ * public void yourTest() {
+ * // This will be retried 1 time (total runs 2) before failing the test.
+ * throw new Exception("Failing test");
+ * }
+ * }
+ * </pre>
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ java.lang.annotation.ElementType.METHOD })
+public @interface RetryOnFailure {
+ int times();
+}
http://git-wip-us.apache.org/repos/asf/flink/blob/7d78f363/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailureTest.java
----------------------------------------------------------------------
diff --git a/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailureTest.java b/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailureTest.java
new file mode 100644
index 0000000..efc7ba4
--- /dev/null
+++ b/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryOnFailureTest.java
@@ -0,0 +1,78 @@
+/*
+ * 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.flink.testutils.junit;
+
+import org.junit.AfterClass;
+import org.junit.Rule;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class RetryOnFailureTest {
+
+ @Rule
+ public RetryRule retryRule = new RetryRule();
+
+ private static final int NUMBER_OF_RUNS = 5;
+
+ private static int numberOfFailedRuns;
+
+ private static int numberOfSuccessfulRuns;
+
+ private static boolean firstRun = true;
+
+ @AfterClass
+ public static void verify() throws Exception {
+ assertEquals(NUMBER_OF_RUNS + 1, numberOfFailedRuns);
+ assertEquals(3, numberOfSuccessfulRuns);
+ }
+
+ @Test
+ @RetryOnFailure(times = NUMBER_OF_RUNS)
+ public void testRetryOnFailure() throws Exception {
+ // All but the (expected) last run should be successful
+ if (numberOfFailedRuns < NUMBER_OF_RUNS) {
+ numberOfFailedRuns++;
+ throw new RuntimeException("Expected test exception");
+ }
+ else {
+ numberOfSuccessfulRuns++;
+ }
+ }
+
+ @Test
+ @RetryOnFailure(times = NUMBER_OF_RUNS)
+ public void testRetryOnceOnFailure() throws Exception {
+ if (firstRun) {
+ numberOfFailedRuns++;
+ firstRun = false;
+ throw new RuntimeException("Expected test exception");
+ }
+ else {
+ numberOfSuccessfulRuns++;
+ }
+ }
+
+ @Test
+ @RetryOnFailure(times = NUMBER_OF_RUNS)
+ public void testDontRetryOnSuccess() throws Exception {
+ numberOfSuccessfulRuns++;
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/flink/blob/7d78f363/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryRule.java
----------------------------------------------------------------------
diff --git a/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryRule.java b/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryRule.java
new file mode 100644
index 0000000..4c4d688
--- /dev/null
+++ b/flink-core/src/test/java/org/apache/flink/testutils/junit/RetryRule.java
@@ -0,0 +1,113 @@
+/*
+ * 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.flink.testutils.junit;
+
+import org.junit.Test;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+/**
+ * A rule to retry failed tests for a fixed number of times.
+ *
+ * <p>Add the {@link RetryRule} to your test and annotate tests with {@link RetryOnFailure}.
+ *
+ * <pre>
+ * public class YourTest {
+ *
+ * {@literal@}Rule
+ * public RetryRule retryRule = new RetryRule();
+ *
+ * {@literal@}Test
+ * {@literal@}RetryOnFailure(times=1)
+ * public void yourTest() {
+ * // This will be retried 1 time (total runs 2) before failing the test.
+ * throw new Exception("Failing test");
+ * }
+ * }
+ * </pre>
+ */
+public class RetryRule implements TestRule {
+
+ public final static Logger LOG = LoggerFactory.getLogger(RetryRule.class);
+
+ @Override
+ public Statement apply(Statement statement, Description description) {
+ RetryOnFailure retryOnFailure = description.getAnnotation(RetryOnFailure.class);
+
+ if (retryOnFailure != null) {
+ Test test = description.getAnnotation(Test.class);
+ if (test.expected() != Test.None.class) {
+ throw new IllegalArgumentException("You cannot combine the RetryOnFailure " +
+ "annotation with the Test(expected) annotation.");
+ }
+
+ statement = new RetryOnFailureStatement(retryOnFailure.times(), statement);
+ }
+
+ return statement;
+ }
+
+ /**
+ * Retries a test in case of a failure.
+ */
+ private static class RetryOnFailureStatement extends Statement {
+
+ private final int timesOnFailure;
+
+ private int currentRun;
+
+ private final Statement statement;
+
+ private RetryOnFailureStatement(int timesOnFailure, Statement statement) {
+ checkArgument(timesOnFailure >= 0, "Negatives number of retries on failure");
+ this.timesOnFailure = timesOnFailure;
+ this.statement = statement;
+ }
+
+ /**
+ * Retry a test in case of a failure.
+ *
+ * @throws Throwable
+ */
+ @Override
+ public void evaluate() throws Throwable {
+ for (currentRun = 0; currentRun <= timesOnFailure; currentRun++) {
+ try {
+ statement.evaluate();
+ break; // success
+ }
+ catch (Throwable t) {
+ LOG.debug(String.format("Test run failed (%d/%d).",
+ currentRun, timesOnFailure + 1), t);
+
+ // Throw the failure if retried too often
+ if (currentRun == timesOnFailure) {
+ throw t;
+ }
+ }
+ }
+ }
+ }
+
+}