Skip to content

Commit

Permalink
Fixes junit-teamgh-193 (allow explicit ordering of Rules).
Browse files Browse the repository at this point in the history
Add a class RuleChain, which allows ordering of TestRules.

Usage:
  @rule
  public TestRule chain= RuleChain
                         .outerRule(new LoggingRule("outer rule")
                         .around(new LoggingRule("middle rule")
                         .around(new LoggingRule("inner rule");

A test with such a rule chain creates the following log:
  starting outer rule
  starting middle rule
  starting inner rule
  finished inner rule
  finished middle rule
  finished outer rule
  • Loading branch information
stefanbirkner committed Sep 14, 2011
1 parent 96df21c commit e8349c5
Show file tree
Hide file tree
Showing 3 changed files with 161 additions and 0 deletions.
99 changes: 99 additions & 0 deletions src/main/java/org/junit/rules/RuleChain.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/**
*
*/
package org.junit.rules;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.junit.runner.Description;
import org.junit.runners.model.Statement;

/**
* The RuleChain rule allows ordering of TestRules. You create a
* {@code RuleChain} with {@link #outerRule(TestRule)} and subsequent calls of
* {@link #around(TestRule)}:
*
* <pre>
* public static class UseRuleChain {
* &#064;Rule
* public TestRule chain= RuleChain
* .outerRule(new LoggingRule("outer rule")
* .around(new LoggingRule("middle rule")
* .around(new LoggingRule("inner rule");
*
* &#064;Test
* public void example() {
* assertTrue(true);
* }
* }
* </pre>
*
* writes the log
*
* <pre>
* starting outer rule
* starting middle rule
* starting inner rule
* finished inner rule
* finished middle rule
* finished outer rule
* </pre>
*/
public class RuleChain implements TestRule {
private static final RuleChain EMPTY_CHAIN= new RuleChain(
Collections.<TestRule> emptyList());

private List<TestRule> rulesStartingWithInnerMost;

/**
* Returns a {@code RuleChain} without a {@link TestRule}. This method may
* be the starting point of a {@code RuleChain}.
*
* @return a {@code RuleChain} without a {@link TestRule}.
*/
public static RuleChain emptyRuleChain() {
return EMPTY_CHAIN;
}

/**
* Returns a {@code RuleChain} with a single {@link TestRule}. This method
* is the usual starting point of a {@code RuleChain}.
*
* @param outerRule
* the outer rule of the {@code RuleChain}.
* @return a {@code RuleChain} with a single {@link TestRule}.
*/
public static RuleChain outerRule(TestRule outerRule) {
return emptyRuleChain().around(outerRule);
}

private RuleChain(List<TestRule> rules) {
this.rulesStartingWithInnerMost= rules;
}

/**
* Create a new {@code RuleChain}, which encloses the {@code nextRule} with
* the rules of the current {@code RuleChain}.
*
* @param enclosedRule
* the rule to enclose.
* @return a new {@code RuleChain}.
*/
public RuleChain around(TestRule enclosedRule) {
List<TestRule> rulesOfNewChain= new ArrayList<TestRule>();
rulesOfNewChain.add(enclosedRule);
rulesOfNewChain.addAll(rulesStartingWithInnerMost);
return new RuleChain(rulesOfNewChain);
}

/**
* {@inheritDoc}
*/
public Statement apply(Statement base, Description description) {
for (TestRule each : rulesStartingWithInnerMost)
base= each.apply(base, description);
return base;
}
}
2 changes: 2 additions & 0 deletions src/test/java/org/junit/tests/AllTests.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.junit.tests.experimental.rules.ExternalResourceRuleTest;
import org.junit.tests.experimental.rules.MethodRulesTest;
import org.junit.tests.experimental.rules.NameRulesTest;
import org.junit.tests.experimental.rules.RuleChainTest;
import org.junit.tests.experimental.rules.TempFolderRuleTest;
import org.junit.tests.experimental.rules.TestRuleTest;
import org.junit.tests.experimental.rules.TimeoutRuleTest;
Expand Down Expand Up @@ -150,6 +151,7 @@
CategoryTest.class,
CategoriesAndParameterizedTest.class,
ParentRunnerFilteringTest.class,
RuleChainTest.class,
BlockJUnit4ClassRunnerOverrideTest.class
})
public class AllTests {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package org.junit.tests.experimental.rules;

import static java.util.Arrays.asList;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.experimental.results.PrintableResult.testResult;
import static org.junit.rules.RuleChain.outerRule;

import java.util.ArrayList;
import java.util.List;

import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.RuleChain;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;

public class RuleChainTest {
private static final List<String> LOG= new ArrayList<String>();

private static class LoggingRule extends TestWatcher {
private final String label;

public LoggingRule(String label) {
this.label= label;
}

@Override
protected void starting(Description description) {
LOG.add("starting " + label);
}

@Override
protected void finished(Description description) {
LOG.add("finished " + label);
}
}

public static class UseRuleChain {
@Rule
public final RuleChain chain= outerRule(new LoggingRule("outer rule"))
.around(new LoggingRule("middle rule")).around(
new LoggingRule("inner rule"));

@Test
public void example() {
assertTrue(true);
}
}

@Test
public void executeRulesInCorrectOrder() throws Exception {
testResult(UseRuleChain.class);
List<String> expectedLog= asList("starting outer rule",
"starting middle rule", "starting inner rule",
"finished inner rule", "finished middle rule",
"finished outer rule");
assertEquals(expectedLog, LOG);
}
}

0 comments on commit e8349c5

Please sign in to comment.