-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce config param for default test instance lifecycle
WIP Issue: #905
- Loading branch information
Showing
5 changed files
with
227 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
...-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestInstanceLifecycleUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* | ||
| * Copyright 2015-2017 the original author or authors. | ||
| * | ||
| * All rights reserved. This program and the accompanying materials are | ||
| * made available under the terms of the Eclipse Public License v1.0 which | ||
| * accompanies this distribution and is available at | ||
| * | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
|
|
||
| package org.junit.jupiter.engine.descriptor; | ||
|
|
||
| import static java.util.logging.Level.WARNING; | ||
| import static org.junit.jupiter.engine.Constants.DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import org.junit.jupiter.api.TestInstance; | ||
| import org.junit.jupiter.api.TestInstance.Lifecycle; | ||
| import org.junit.platform.commons.util.AnnotationUtils; | ||
| import org.junit.platform.commons.util.Preconditions; | ||
| import org.junit.platform.engine.ConfigurationParameters; | ||
|
|
||
| /** | ||
| * Collection of utilities for retrieving the test instance lifecycle mode. | ||
| * | ||
| * @since 5.0 | ||
| * @see TestInstance | ||
| * @see TestInstance.Lifecycle | ||
| */ | ||
| final class TestInstanceLifecycleUtils { | ||
|
|
||
| private static final Logger LOG = Logger.getLogger(TestInstanceLifecycleUtils.class.getName()); | ||
|
|
||
| ///CLOVER:OFF | ||
| private TestInstanceLifecycleUtils() { | ||
| /* no-op */ | ||
| } | ||
| ///CLOVER:ON | ||
|
|
||
| static TestInstance.Lifecycle getTestInstanceLifecycle(Class<?> testClass, ConfigurationParameters configParams) { | ||
| Preconditions.notNull(testClass, "testClass must not be null"); | ||
| Preconditions.notNull(configParams, "ConfigurationParameters must not be null"); | ||
|
|
||
| // @formatter:off | ||
| return AnnotationUtils.findAnnotation(testClass, TestInstance.class) | ||
| .map(TestInstance::value) | ||
| .orElseGet(() -> getDefaultTestInstanceLifecycle(configParams)); | ||
| // @formatter:on | ||
| } | ||
|
|
||
| // TODO Consider looking up the default test instance lifecycle mode once per test plan execution. | ||
| static TestInstance.Lifecycle getDefaultTestInstanceLifecycle(ConfigurationParameters configParams) { | ||
| Preconditions.notNull(configParams, "ConfigurationParameters must not be null"); | ||
| String propertyName = DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME; | ||
|
|
||
| Optional<String> optional = configParams.get(propertyName); | ||
| String constantName = null; | ||
| if (optional.isPresent()) { | ||
| try { | ||
| constantName = optional.get().trim().toUpperCase(); | ||
| Lifecycle lifecycle = TestInstance.Lifecycle.valueOf(constantName); | ||
| LOG.info(() -> String.format( | ||
| "Using default test instance lifecycle mode '%s' set via the '%s' configuration parameter.", | ||
| lifecycle, propertyName)); | ||
| return lifecycle; | ||
| } | ||
| catch (Exception ex) { | ||
| // local copy necessary for use in lambda expression | ||
| String constant = constantName; | ||
| LOG.log(WARNING, ex, | ||
| () -> String.format( | ||
| "Invalid test instance lifecycle mode '%s' set via the '%s' configuration parameter. " | ||
| + "Falling back to %s lifecycle semantics.", | ||
| constant, propertyName, Lifecycle.PER_METHOD.name())); | ||
| } | ||
| } | ||
|
|
||
| return Lifecycle.PER_METHOD; | ||
| } | ||
|
|
||
| } |
118 changes: 118 additions & 0 deletions
118
...ne/src/test/java/org/junit/jupiter/engine/descriptor/TestInstanceLifecycleUtilsTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| /* | ||
| * Copyright 2015-2017 the original author or authors. | ||
| * | ||
| * All rights reserved. This program and the accompanying materials are | ||
| * made available under the terms of the Eclipse Public License v1.0 which | ||
| * accompanies this distribution and is available at | ||
| * | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
|
|
||
| package org.junit.jupiter.engine.descriptor; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.junit.jupiter.api.Assertions.assertAll; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
| import static org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS; | ||
| import static org.junit.jupiter.api.TestInstance.Lifecycle.PER_METHOD; | ||
| import static org.junit.jupiter.engine.Constants.DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME; | ||
| import static org.junit.jupiter.engine.descriptor.TestInstanceLifecycleUtils.getDefaultTestInstanceLifecycle; | ||
| import static org.junit.jupiter.engine.descriptor.TestInstanceLifecycleUtils.getTestInstanceLifecycle; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.TestInstance; | ||
| import org.junit.jupiter.api.TestInstance.Lifecycle; | ||
| import org.junit.platform.commons.util.PreconditionViolationException; | ||
| import org.junit.platform.engine.ConfigurationParameters; | ||
|
|
||
| /** | ||
| * Unit tests for {@link TestInstanceLifecycleUtils}. | ||
| * | ||
| * <p>NOTE: it doesn't make sense to unit test the JVM system property fallback | ||
| * support in this test class since that feature is a concrete implementation | ||
| * detail of {@code LauncherConfigurationParameters} which necessitates an | ||
| * integration test via the {@code Launcher} API. | ||
| * | ||
| * @since 5.0 | ||
| */ | ||
| class TestInstanceLifecycleUtilsTests { | ||
|
|
||
| private static final String KEY = DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME; | ||
|
|
||
| @Test | ||
| void getDefaultTestInstanceLifecyclePreconditions() { | ||
| PreconditionViolationException exception = assertThrows(PreconditionViolationException.class, | ||
| () -> getDefaultTestInstanceLifecycle(null)); | ||
| assertThat(exception).hasMessage("ConfigurationParameters must not be null"); | ||
| } | ||
|
|
||
| @Test | ||
| void getDefaultTestInstanceLifecycleWithNoConfigParamSet() { | ||
| Lifecycle lifecycle = getDefaultTestInstanceLifecycle(mock(ConfigurationParameters.class)); | ||
| assertThat(lifecycle).isEqualTo(PER_METHOD); | ||
| } | ||
|
|
||
| @Test | ||
| void getDefaultTestInstanceLifecycleWithConfigParamSet() { | ||
| assertAll(// | ||
| () -> assertDefaultConfigParam(null, PER_METHOD), // | ||
| () -> assertDefaultConfigParam("", PER_METHOD), // | ||
| () -> assertDefaultConfigParam("bogus", PER_METHOD), // | ||
| () -> assertDefaultConfigParam(PER_METHOD.name(), PER_METHOD), // | ||
| () -> assertDefaultConfigParam(PER_METHOD.name().toLowerCase(), PER_METHOD), // | ||
| () -> assertDefaultConfigParam(" " + PER_METHOD.name() + " ", PER_METHOD), // | ||
| () -> assertDefaultConfigParam(PER_CLASS.name(), PER_CLASS), // | ||
| () -> assertDefaultConfigParam(PER_CLASS.name().toLowerCase(), PER_CLASS), // | ||
| () -> assertDefaultConfigParam(" " + PER_CLASS.name() + " ", Lifecycle.PER_CLASS) // | ||
| ); | ||
| } | ||
|
|
||
| private void assertDefaultConfigParam(String configValue, Lifecycle expected) { | ||
| ConfigurationParameters configParams = mock(ConfigurationParameters.class); | ||
| when(configParams.get(KEY)).thenReturn(Optional.ofNullable(configValue)); | ||
| Lifecycle lifecycle = getDefaultTestInstanceLifecycle(configParams); | ||
| assertThat(lifecycle).isEqualTo(expected); | ||
| } | ||
|
|
||
| @Test | ||
| void getTestInstanceLifecyclePreconditions() { | ||
| PreconditionViolationException exception = assertThrows(PreconditionViolationException.class, | ||
| () -> getTestInstanceLifecycle(null, mock(ConfigurationParameters.class))); | ||
| assertThat(exception).hasMessage("testClass must not be null"); | ||
|
|
||
| exception = assertThrows(PreconditionViolationException.class, | ||
| () -> getTestInstanceLifecycle(getClass(), null)); | ||
| assertThat(exception).hasMessage("ConfigurationParameters must not be null"); | ||
| } | ||
|
|
||
| @Test | ||
| void getTestInstanceLifecycleWithNoConfigParamSet() { | ||
| Lifecycle lifecycle = getTestInstanceLifecycle(getClass(), mock(ConfigurationParameters.class)); | ||
| assertThat(lifecycle).isEqualTo(PER_METHOD); | ||
| } | ||
|
|
||
| @Test | ||
| void getTestInstanceLifecycleWithConfigParamSet() { | ||
| ConfigurationParameters configParams = mock(ConfigurationParameters.class); | ||
| when(configParams.get(KEY)).thenReturn(Optional.of(PER_CLASS.name().toLowerCase())); | ||
| Lifecycle lifecycle = getTestInstanceLifecycle(getClass(), configParams); | ||
| assertThat(lifecycle).isEqualTo(PER_CLASS); | ||
| } | ||
|
|
||
| @Test | ||
| void getTestInstanceLifecycleWithLocalConfigThatOverridesCustomDefaultSetViaConfigParam() { | ||
| ConfigurationParameters configParams = mock(ConfigurationParameters.class); | ||
| when(configParams.get(KEY)).thenReturn(Optional.of(PER_CLASS.name().toLowerCase())); | ||
| Lifecycle lifecycle = getTestInstanceLifecycle(TestCase.class, configParams); | ||
| assertThat(lifecycle).isEqualTo(PER_METHOD); | ||
| } | ||
|
|
||
| @TestInstance(Lifecycle.PER_METHOD) | ||
| private static class TestCase { | ||
| } | ||
|
|
||
| } |