/*
* 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.geode.test.junit.rules;
import static org.assertj.core.api.Assertions.*;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.junit.Rule;
import org.junit.Test;
import org.junit.experimental.categories.Category;
import org.junit.runner.Result;
import org.junit.runner.notification.Failure;
import org.apache.geode.test.junit.categories.UnitTest;
/**
* Unit tests for {@link ExpectedTimeoutRule}.
*/
@Category(UnitTest.class)
public class ExpectedTimeoutRuleTest {
@Test
public void passesUnused() {
Result result = TestRunner.runTest(PassingTestShouldPassWhenUnused.class);
assertThat(result.wasSuccessful()).isTrue();
}
@Test
public void failsWithoutExpectedException() {
Result result = TestRunner.runTest(FailsWithoutExpectedException.class);
assertThat(result.wasSuccessful()).isFalse();
List<Failure> failures = result.getFailures();
assertThat(failures.size()).as("Failures: " + failures).isEqualTo(1);
Failure failure = failures.get(0);
assertThat(failure.getException()).isExactlyInstanceOf(AssertionError.class)
.hasMessage("Expected test to throw an instance of " + TimeoutException.class.getName());
}
@Test
public void failsWithoutExpectedTimeoutException() {
Result result = TestRunner.runTest(FailsWithoutExpectedTimeoutException.class);
assertThat(result.wasSuccessful()).isFalse();
List<Failure> failures = result.getFailures();
assertThat(failures.size()).as("Failures: " + failures).isEqualTo(1);
Failure failure = failures.get(0);
assertThat(failure.getException()).isExactlyInstanceOf(AssertionError.class)
.hasMessage("Expected test to throw (an instance of " + TimeoutException.class.getName()
+ " and exception with message a string containing \""
+ FailsWithoutExpectedTimeoutException.message + "\")");
}
@Test
public void failsWithExpectedTimeoutButWrongError() {
Result result = TestRunner.runTest(FailsWithExpectedTimeoutButWrongError.class);
assertThat(result.wasSuccessful()).isFalse();
List<Failure> failures = result.getFailures();
assertThat(failures.size()).as("Failures: " + failures).isEqualTo(1);
Failure failure = failures.get(0);
String expectedMessage = "\n"
+ "Expected: (an instance of java.util.concurrent.TimeoutException and exception with message a string containing \"this is a message for FailsWithExpectedTimeoutButWrongError\")"
+ "\n" + " "
+ "but: an instance of java.util.concurrent.TimeoutException <java.lang.NullPointerException> is a java.lang.NullPointerException";
assertThat(failure.getException()).isExactlyInstanceOf(AssertionError.class)
.hasMessageContaining(expectedMessage);
}
@Test
public void passesWithExpectedTimeoutAndTimeoutException() {
Result result = TestRunner.runTest(PassesWithExpectedTimeoutAndTimeoutException.class);
assertThat(result.wasSuccessful()).isTrue();
}
@Test
public void failsWhenTimeoutIsEarly() {
Result result = TestRunner.runTest(FailsWhenTimeoutIsEarly.class);
assertThat(result.wasSuccessful()).isFalse();
List<Failure> failures = result.getFailures();
assertThat(failures.size()).as("Failures: " + failures).isEqualTo(1);
Failure failure = failures.get(0);
assertThat(failure.getException()).isExactlyInstanceOf(AssertionError.class)
.hasMessage("Expected test to throw (an instance of " + TimeoutException.class.getName()
+ " and exception with message a string containing \"" + FailsWhenTimeoutIsEarly.message
+ "\")");
}
@Test
public void failsWhenTimeoutIsLate() {
Result result = TestRunner.runTest(FailsWhenTimeoutIsLate.class);
assertThat(result.wasSuccessful()).isFalse();
List<Failure> failures = result.getFailures();
assertThat(failures.size()).as("Failures: " + failures).isEqualTo(1);
Failure failure = failures.get(0);
assertThat(failure.getException()).isExactlyInstanceOf(AssertionError.class)
.hasMessage("Expected test to throw (an instance of " + TimeoutException.class.getName()
+ " and exception with message a string containing \"" + FailsWhenTimeoutIsLate.message
+ "\")");
}
/**
* Base class for all inner class test cases
*/
public static class AbstractExpectedTimeoutRuleTest {
@Rule
public ExpectedTimeoutRule timeout = ExpectedTimeoutRule.none();
}
/**
* Used by test {@link #passesUnused()}
*/
public static class PassingTestShouldPassWhenUnused extends AbstractExpectedTimeoutRuleTest {
@Test
public void doTest() {}
}
/**
* Used by test {@link #failsWithoutExpectedException()}
*/
public static class FailsWithoutExpectedException extends AbstractExpectedTimeoutRuleTest {
@Test
public void doTest() {
timeout.expect(TimeoutException.class);
}
}
/**
* Used by test {@link #failsWithoutExpectedTimeoutException()}
*/
public static class FailsWithoutExpectedTimeoutException extends AbstractExpectedTimeoutRuleTest {
static final String message = "this is a message for FailsWithoutExpectedTimeoutException";
@Test
public void doTest() throws Exception {
timeout.expect(TimeoutException.class);
timeout.expectMessage(message);
timeout.expectMinimumDuration(10);
timeout.expectMaximumDuration(1000);
timeout.expectTimeUnit(TimeUnit.MILLISECONDS);
Thread.sleep(100);
}
}
/**
* Used by test {@link #failsWithExpectedTimeoutButWrongError()}
*/
public static class FailsWithExpectedTimeoutButWrongError
extends AbstractExpectedTimeoutRuleTest {
static final String message = "this is a message for FailsWithExpectedTimeoutButWrongError";
@Test
public void doTest() throws Exception {
timeout.expect(TimeoutException.class);
timeout.expectMessage(message);
timeout.expectMinimumDuration(10);
timeout.expectMaximumDuration(1000);
timeout.expectTimeUnit(TimeUnit.MILLISECONDS);
Thread.sleep(100);
throw new NullPointerException();
}
}
/**
* Used by test {@link #passesWithExpectedTimeoutAndTimeoutException()}
*/
public static class PassesWithExpectedTimeoutAndTimeoutException
extends AbstractExpectedTimeoutRuleTest {
static final String message =
"this is a message for PassesWithExpectedTimeoutAndTimeoutException";
static final Class<TimeoutException> exceptionClass = TimeoutException.class;
@Test
public void doTest() throws Exception {
timeout.expect(exceptionClass);
timeout.expectMessage(message);
timeout.expectMinimumDuration(10);
timeout.expectMaximumDuration(1000);
timeout.expectTimeUnit(TimeUnit.MILLISECONDS);
Thread.sleep(100);
throw new TimeoutException(message);
}
}
/**
* Used by test {@link #failsWhenTimeoutIsEarly()}
*/
public static class FailsWhenTimeoutIsEarly extends AbstractExpectedTimeoutRuleTest {
static final String message = "this is a message for FailsWhenTimeoutIsEarly";
@Test
public void doTest() throws Exception {
timeout.expect(TimeoutException.class);
timeout.expectMessage(message);
timeout.expectMinimumDuration(1000);
timeout.expectMaximumDuration(2000);
timeout.expectTimeUnit(TimeUnit.MILLISECONDS);
Thread.sleep(10);
}
}
/**
* Used by test {@link #failsWhenTimeoutIsLate()}
*/
public static class FailsWhenTimeoutIsLate extends AbstractExpectedTimeoutRuleTest {
static final String message = "this is a message for FailsWhenTimeoutIsLate";
@Test
public void doTest() throws Exception {
timeout.expect(TimeoutException.class);
timeout.expectMessage(message);
timeout.expectMinimumDuration(10);
timeout.expectMaximumDuration(20);
timeout.expectTimeUnit(TimeUnit.MILLISECONDS);
Thread.sleep(100);
}
}
}