Introduce dedicated tests for DisabledIfCondition
This commit introduces tests for DisabledIfCondition that verify actual condition evaluation results and exception handling; whereas, the existing tests in DisabledIfTestCase only test the "happy paths" and standard cases. Issue: SPR-14614
This commit is contained in:
@@ -0,0 +1,177 @@
|
||||
/*
|
||||
* Copyright 2002-2016 the original author or authors.
|
||||
*
|
||||
* Licensed 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.springframework.test.context.junit.jupiter;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
import java.util.Optional;
|
||||
|
||||
import org.hamcrest.Matcher;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ConditionEvaluationResult;
|
||||
import org.junit.jupiter.api.extension.ExtensionContext.Store;
|
||||
import org.junit.jupiter.api.extension.TestExtensionContext;
|
||||
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.test.context.TestContextManager;
|
||||
import org.springframework.util.ReflectionUtils;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.containsString;
|
||||
import static org.hamcrest.CoreMatchers.endsWith;
|
||||
import static org.hamcrest.CoreMatchers.equalTo;
|
||||
import static org.hamcrest.CoreMatchers.is;
|
||||
import static org.hamcrest.CoreMatchers.startsWith;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
import static org.junit.jupiter.api.Assertions.assertAll;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.junit.jupiter.api.Assertions.expectThrows;
|
||||
import static org.mockito.Matchers.any;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* Tests for {@link DisabledIfCondition} that verify actual condition evaluation
|
||||
* results and exception handling; whereas, {@link DisabledIfTestCase} only tests
|
||||
* the <em>happy paths</em>.
|
||||
*
|
||||
* @author Sam Brannen
|
||||
* @since 5.0
|
||||
* @see DisabledIfTestCase
|
||||
*/
|
||||
class DisabledIfConditionTestCase {
|
||||
|
||||
private final DisabledIfCondition condition = new DisabledIfCondition();
|
||||
|
||||
|
||||
@Test
|
||||
void missingDisabledIf() {
|
||||
IllegalStateException exception = expectThrows(IllegalStateException.class,
|
||||
() -> condition.evaluate(buildExtensionContext("missingDisabledIf")));
|
||||
|
||||
assertThat(exception.getMessage(), startsWith("@DisabledIf must be present"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void disabledByEmptyExpression() {
|
||||
// @formatter:off
|
||||
assertAll(
|
||||
() -> assertExpressionIsBlank("emptyExpression"),
|
||||
() -> assertExpressionIsBlank("blankExpression")
|
||||
);
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Test
|
||||
void invalidExpressionEvaluationType() {
|
||||
IllegalStateException exception = expectThrows(IllegalStateException.class,
|
||||
() -> condition.evaluate(buildExtensionContext("nonBooleanOrStringExpression")));
|
||||
|
||||
assertThat(exception.getMessage(),
|
||||
is(equalTo("@DisabledIf(\"#{6 * 7}\") must evaluate to a String or a Boolean, not java.lang.Integer")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void disabledWithCustomReason() {
|
||||
assertResult(condition.evaluate(buildExtensionContext("customReason")), true, is(equalTo("Because... 42!")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void disabledWithDefaultReason() {
|
||||
assertResult(condition.evaluate(buildExtensionContext("defaultReason")), true,
|
||||
endsWith("defaultReason() is disabled because @DisabledIf(\"#{1 + 1 eq 2}\") evaluated to true"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void notDisabledWithDefaultReason() {
|
||||
assertResult(condition.evaluate(buildExtensionContext("neverDisabledWithDefaultReason")), false, endsWith(
|
||||
"neverDisabledWithDefaultReason() is enabled because @DisabledIf(\"false\") did not evaluate to true"));
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
private TestExtensionContext buildExtensionContext(String methodName) {
|
||||
Class<?> testClass = SpringTestCase.class;
|
||||
Method method = ReflectionUtils.findMethod(getClass(), methodName);
|
||||
Store store = mock(Store.class);
|
||||
when(store.getOrComputeIfAbsent(any(), any(), any())).thenReturn(new TestContextManager(testClass));
|
||||
|
||||
TestExtensionContext extensionContext = mock(TestExtensionContext.class);
|
||||
when(extensionContext.getTestClass()).thenReturn(Optional.of(testClass));
|
||||
when(extensionContext.getElement()).thenReturn(Optional.of(method));
|
||||
when(extensionContext.getStore(any())).thenReturn(store);
|
||||
return extensionContext;
|
||||
}
|
||||
|
||||
private void assertExpressionIsBlank(String methodName) {
|
||||
IllegalStateException exception = expectThrows(IllegalStateException.class,
|
||||
() -> condition.evaluate(buildExtensionContext(methodName)));
|
||||
|
||||
assertThat(exception.getMessage(), containsString("must not be blank"));
|
||||
}
|
||||
|
||||
private void assertResult(ConditionEvaluationResult result, boolean disabled, Matcher<String> matcher) {
|
||||
assertNotNull(result);
|
||||
|
||||
if (disabled) {
|
||||
assertTrue(result.isDisabled());
|
||||
}
|
||||
else {
|
||||
assertFalse(result.isDisabled());
|
||||
}
|
||||
|
||||
Optional<String> reason = result.getReason();
|
||||
assertTrue(reason.isPresent());
|
||||
assertThat(reason.get(), matcher);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
@DisabledIf("")
|
||||
private void emptyExpression() {
|
||||
}
|
||||
|
||||
@DisabledIf("\t")
|
||||
private void blankExpression() {
|
||||
}
|
||||
|
||||
@DisabledIf("#{6 * 7}")
|
||||
private void nonBooleanOrStringExpression() {
|
||||
}
|
||||
|
||||
@DisabledIf(expression = "#{6 * 7 == 42}", reason = "Because... 42!")
|
||||
private void customReason() {
|
||||
}
|
||||
|
||||
@DisabledIf("#{1 + 1 eq 2}")
|
||||
private void defaultReason() {
|
||||
}
|
||||
|
||||
@DisabledIf("false")
|
||||
private void neverDisabledWithDefaultReason() {
|
||||
}
|
||||
|
||||
|
||||
private static class SpringTestCase {
|
||||
|
||||
@Configuration
|
||||
static class Config {
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -33,6 +33,7 @@ import static org.junit.jupiter.api.Assertions.*;
|
||||
* @author Tadaya Tsuyukubo
|
||||
* @author Sam Brannen
|
||||
* @since 5.0
|
||||
* @see DisabledIfConditionTestCase
|
||||
* @see DisabledIf
|
||||
* @see SpringExtension
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user