1 /*
2 * Copyright (C) 2016, Matthias Sohn <matthias.sohn@sap.com>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.junit;
44
45 import java.text.MessageFormat;
46 import java.util.logging.Level;
47 import java.util.logging.Logger;
48
49 import org.junit.rules.TestRule;
50 import org.junit.runner.Description;
51 import org.junit.runners.model.Statement;
52
53 /**
54 * {@link TestRule} which enables to run the same JUnit test repeatedly. Add
55 * this rule to the test class
56 *
57 * <pre>
58 * public class MyTest {
59 * @Rule
60 * public RepeatRule repeatRule = new RepeatRule();
61 * ...
62 * }
63 * </pre>
64 *
65 * and annotate the test to be repeated with the
66 * {@code @Repeat(n=<repetitions>)} annotation
67 *
68 * <pre>
69 * @Test
70 * @Repeat(n = 100)
71 * public void test() {
72 * ...
73 * }
74 * </pre>
75 *
76 * then this test will be repeated 100 times. If any test execution fails test
77 * repetition will be stopped.
78 */
79 public class RepeatRule implements TestRule {
80
81 private static Logger LOG = Logger
82 .getLogger(RepeatRule.class.getName());
83
84 public static class RepeatedTestException extends RuntimeException {
85 private static final long serialVersionUID = 1L;
86
87 public RepeatedTestException(String message, Throwable cause) {
88 super(message, cause);
89 }
90 }
91
92 private static class RepeatStatement extends Statement {
93
94 private final int repetitions;
95
96 private final Statement statement;
97
98 private RepeatStatement(int repetitions, Statement statement) {
99 this.repetitions = repetitions;
100 this.statement = statement;
101 }
102
103 @Override
104 public void evaluate() throws Throwable {
105 for (int i = 0; i < repetitions; i++) {
106 try {
107 statement.evaluate();
108 } catch (Throwable e) {
109 RepeatedTestException ex = new RepeatedTestException(
110 MessageFormat.format(
111 "Repeated test failed when run for the {0}. time",
112 Integer.valueOf(i + 1)),
113 e);
114 LOG.log(Level.SEVERE, ex.getMessage(), ex);
115 throw ex;
116 }
117 }
118 }
119 }
120
121 @Override
122 public Statement apply(Statement statement, Description description) {
123 Statement result = statement;
124 Repeat repeat = description.getAnnotation(Repeat.class);
125 if (repeat != null) {
126 int n = repeat.n();
127 result = new RepeatStatement(n, statement);
128 }
129 return result;
130 }
131 }