-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add unit tests with mockito for metric stats (#38)
- Loading branch information
Showing
6 changed files
with
424 additions
and
9 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
107 changes: 107 additions & 0 deletions
107
src/test/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsFactoryTest.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,107 @@ | ||
package io.kokuwa.keycloak.metrics.stats; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; | ||
import static org.junit.jupiter.api.Assertions.assertEquals; | ||
import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
import static org.junit.jupiter.api.Assertions.assertNull; | ||
import static org.mockito.Mockito.mock; | ||
import static org.mockito.Mockito.verify; | ||
import static org.mockito.Mockito.when; | ||
|
||
import java.time.Duration; | ||
|
||
import org.junit.jupiter.api.DisplayName; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.platform.commons.util.ReflectionUtils; | ||
import org.keycloak.models.KeycloakSession; | ||
import org.keycloak.models.KeycloakSessionFactory; | ||
import org.keycloak.models.KeycloakTransactionManager; | ||
import org.keycloak.timer.TimerProvider; | ||
import org.mockito.ArgumentCaptor; | ||
import org.mockito.ArgumentMatchers; | ||
import org.mockito.Mock; | ||
import org.mockito.Spy; | ||
|
||
import io.kokuwa.keycloak.metrics.junit.AbstractMockitoTest; | ||
|
||
/** | ||
* Test for {@link MetricsStatsFactory} with Mockito. | ||
* | ||
* @author Stephan Schnabel | ||
*/ | ||
@DisplayName("metrics: factory") | ||
public class MetricsStatsFactoryTest extends AbstractMockitoTest { | ||
|
||
@Spy | ||
MetricsStatsFactoryImpl factory; | ||
@Mock | ||
KeycloakSessionFactory sessionFactory; | ||
@Mock | ||
KeycloakSession session; | ||
|
||
@DisplayName("disabled") | ||
@Test | ||
void disabled() { | ||
factory.init(null); | ||
factory.postInit(sessionFactory); | ||
assertNull(factory.create(session)); | ||
factory.close(); | ||
} | ||
|
||
@DisplayName("enabled - with default values") | ||
@Test | ||
void enabledDefault() { | ||
when(factory.getenv("KC_METRICS_STATS_ENABLED")).thenReturn("true"); | ||
when(factory.getenv("KC_METRICS_STATS_INTERVAL")).thenReturn(null); | ||
when(factory.getenv("KC_METRICS_STATS_INFO_THRESHOLD")).thenReturn(null); | ||
when(factory.getenv("KC_METRICS_STATS_WARN_THRESHOLD")).thenReturn(null); | ||
assertTask(Duration.ofSeconds(60), Duration.ofSeconds(30), Duration.ofSeconds(45)); | ||
} | ||
|
||
@DisplayName("enabled - with custom interval") | ||
@Test | ||
void enabledCustomInterval() { | ||
when(factory.getenv("KC_METRICS_STATS_ENABLED")).thenReturn("true"); | ||
when(factory.getenv("KC_METRICS_STATS_INTERVAL")).thenReturn("PT300s"); | ||
when(factory.getenv("KC_METRICS_STATS_INFO_THRESHOLD")).thenReturn(null); | ||
when(factory.getenv("KC_METRICS_STATS_WARN_THRESHOLD")).thenReturn(null); | ||
assertTask(Duration.ofSeconds(300), Duration.ofSeconds(150), Duration.ofSeconds(225)); | ||
} | ||
|
||
@DisplayName("enabled - with custom thresholds") | ||
@Test | ||
void enabledCustomThresholds() { | ||
when(factory.getenv("KC_METRICS_STATS_ENABLED")).thenReturn("true"); | ||
when(factory.getenv("KC_METRICS_STATS_INTERVAL")).thenReturn(null); | ||
when(factory.getenv("KC_METRICS_STATS_INFO_THRESHOLD")).thenReturn("PT40s"); | ||
when(factory.getenv("KC_METRICS_STATS_WARN_THRESHOLD")).thenReturn("PT50s"); | ||
assertTask(Duration.ofSeconds(60), Duration.ofSeconds(40), Duration.ofSeconds(50)); | ||
} | ||
|
||
private void assertTask(Duration interval, Duration infoThreshold, Duration warnThreshold) { | ||
|
||
var timerProvider = mock(TimerProvider.class); | ||
when(sessionFactory.create()).thenReturn(session); | ||
when(session.getProvider(TimerProvider.class)).thenReturn(timerProvider); | ||
when(session.getTransactionManager()).thenReturn(mock(KeycloakTransactionManager.class)); | ||
|
||
factory.postInit(sessionFactory); | ||
|
||
var taskCaptor = ArgumentCaptor.forClass(MetricsStatsTask.class); | ||
verify(timerProvider).scheduleTask( | ||
taskCaptor.capture(), | ||
ArgumentMatchers.eq(interval.toMillis()), | ||
ArgumentMatchers.eq("metrics")); | ||
assertNotNull(taskCaptor.getValue(), "task"); | ||
assertField(interval, taskCaptor.getValue(), "interval"); | ||
assertField(infoThreshold, taskCaptor.getValue(), "infoThreshold"); | ||
assertField(warnThreshold, taskCaptor.getValue(), "warnThreshold"); | ||
} | ||
|
||
private void assertField(Duration expected, MetricsStatsTask task, String name) { | ||
assertEquals( | ||
expected, | ||
assertDoesNotThrow(() -> ReflectionUtils.tryToReadFieldValue(MetricsStatsTask.class, name, task).get()), | ||
"field " + name + " invalid"); | ||
} | ||
} |
37 changes: 37 additions & 0 deletions
37
src/test/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsSpiTest.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,37 @@ | ||
package io.kokuwa.keycloak.metrics.stats; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertEquals; | ||
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 java.util.ServiceLoader; | ||
|
||
import org.junit.jupiter.api.DisplayName; | ||
import org.junit.jupiter.api.Test; | ||
|
||
import io.kokuwa.keycloak.metrics.junit.AbstractMockitoTest; | ||
|
||
/** | ||
* Test for {@link MetricsStatsSpi} with Mockito. | ||
* | ||
* @author Stephan Schnabel | ||
*/ | ||
@DisplayName("metrics: spi") | ||
public class MetricsStatsSpiTest extends AbstractMockitoTest { | ||
|
||
@Test | ||
void test() { | ||
|
||
var spi = new MetricsStatsSpi(); | ||
assertEquals("metrics", spi.getName(), "getName()"); | ||
assertFalse(spi.isInternal(), "isInternal()"); | ||
assertNotNull(spi.getProviderClass(), "getProviderClass()"); | ||
assertTrue(spi.getProviderFactoryClass().isInterface(), "getProviderFactoryClass() - should be an interface"); | ||
|
||
var factory = ServiceLoader.load(spi.getProviderFactoryClass()).findFirst().orElse(null); | ||
assertNotNull(factory, "failed to read factory with service loader"); | ||
assertEquals(MetricsStatsFactoryImpl.class, factory.getClass(), "factory.class"); | ||
assertEquals("default", factory.getId(), "factory.id"); | ||
} | ||
} |
Oops, something went wrong.