Add simple Redis SessionRepository implementation

See: #1408
2019-05-01 19:58:07 +02:00
parent 54859070f3
commit 17005c51a7
3 changed files with 884 additions and 0 deletions
--- a/spring-session-data-redis/src/test/java/org/springframework/session/data/redis/SimpleRedisOperationsSessionRepositoryTests.java
+++ b/spring-session-data-redis/src/test/java/org/springframework/session/data/redis/SimpleRedisOperationsSessionRepositoryTests.java
@@ -0,0 +1,343 @@
+/*
+ * Copyright 2014-2019 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
+ *
+ *      https://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.session.data.redis;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
+import java.util.Collections;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+import org.springframework.data.redis.core.HashOperations;
+import org.springframework.data.redis.core.RedisOperations;
+import org.springframework.session.MapSession;
+import org.springframework.session.data.redis.SimpleRedisOperationsSessionRepository.RedisSession;
+import org.springframework.test.util.ReflectionTestUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
+import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+
+/**
+ * Tests for {@link SimpleRedisOperationsSessionRepository}.
+ *
+ * @author Vedran Pavic
+ */
+class SimpleRedisOperationsSessionRepositoryTests {
+
+	private static final String TEST_SESSION_ID = "session-id";
+
+	private static final String TEST_SESSION_KEY = getSessionKey(TEST_SESSION_ID);
+
+	@Mock
+	private RedisOperations<String, Object> sessionRedisOperations;
+
+	@Mock
+	private HashOperations<String, String, Object> sessionHashOperations;
+
+	@Captor
+	private ArgumentCaptor<Map<String, Object>> delta;
+
+	private SimpleRedisOperationsSessionRepository sessionRepository;
+
+	@BeforeEach
+	void setUp() {
+		MockitoAnnotations.initMocks(this);
+		given(this.sessionRedisOperations.<String, Object>opsForHash())
+				.willReturn(this.sessionHashOperations);
+		this.sessionRepository = new SimpleRedisOperationsSessionRepository(
+				this.sessionRedisOperations);
+	}
+
+	@Test
+	void constructor_NullRedisOperations_ShouldThrowException() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> new ReactiveRedisOperationsSessionRepository(null))
+				.withMessageContaining("sessionRedisOperations cannot be null");
+	}
+
+	@Test
+	void setDefaultMaxInactiveInterval_ValidInterval_ShouldSetInterval() {
+		this.sessionRepository.setDefaultMaxInactiveInterval(Duration.ofMinutes(10));
+		assertThat(ReflectionTestUtils.getField(this.sessionRepository,
+				"defaultMaxInactiveInterval")).isEqualTo(Duration.ofMinutes(10));
+	}
+
+	@Test
+	void setDefaultMaxInactiveInterval_NullInterval_ShouldThrowException() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(
+						() -> this.sessionRepository.setDefaultMaxInactiveInterval(null))
+				.withMessage("defaultMaxInactiveInterval must not be null");
+	}
+
+	@Test
+	void setKeyNamespace_ValidNamespace_ShouldSetNamespace() {
+		this.sessionRepository.setKeyNamespace("test:");
+		assertThat(ReflectionTestUtils.getField(this.sessionRepository, "keyNamespace"))
+				.isEqualTo("test:");
+	}
+
+	@Test
+	void setKeyNamespace_NullNamespace_ShouldThrowException() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> this.sessionRepository.setKeyNamespace(null))
+				.withMessage("keyNamespace must not be empty");
+	}
+
+	@Test
+	void setKeyNamespace_EmptyNamespace_ShouldThrowException() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> this.sessionRepository.setKeyNamespace(" "))
+				.withMessage("keyNamespace must not be empty");
+	}
+
+	@Test
+	void setFlushMode_ValidFlushMode_ShouldSetFlushMode() {
+		this.sessionRepository.setFlushMode(RedisFlushMode.IMMEDIATE);
+		assertThat(ReflectionTestUtils.getField(this.sessionRepository, "flushMode"))
+				.isEqualTo(RedisFlushMode.IMMEDIATE);
+	}
+
+	@Test
+	void setFlushMode_NullFlushMode_ShouldThrowException() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> this.sessionRepository.setFlushMode(null))
+				.withMessage("flushMode must not be null");
+	}
+
+	@Test
+	void createSession_DefaultMaxInactiveInterval_ShouldCreateSession() {
+		RedisSession redisSession = this.sessionRepository.createSession();
+		assertThat(redisSession.getMaxInactiveInterval()).isEqualTo(
+				Duration.ofSeconds(MapSession.DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void createSession_CustomMaxInactiveInterval_ShouldCreateSession() {
+		this.sessionRepository.setDefaultMaxInactiveInterval(Duration.ofMinutes(10));
+		RedisSession redisSession = this.sessionRepository.createSession();
+		assertThat(redisSession.getMaxInactiveInterval())
+				.isEqualTo(Duration.ofMinutes(10));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void createSession_ImmediateFlushMode_ShouldCreateSession() {
+		this.sessionRepository.setFlushMode(RedisFlushMode.IMMEDIATE);
+		RedisSession session = this.sessionRepository.createSession();
+		String key = getSessionKey(session.getId());
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionRedisOperations).expireAt(eq(key), eq(getExpiry(session)));
+		verify(this.sessionHashOperations).putAll(eq(key), this.delta.capture());
+		assertThat(this.delta.getValue()).hasSize(3);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void save_NewSession_ShouldSaveSession() {
+		RedisSession session = this.sessionRepository.createSession();
+		this.sessionRepository.save(session);
+		String key = getSessionKey(session.getId());
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionRedisOperations).expireAt(eq(key), eq(getExpiry(session)));
+		verify(this.sessionHashOperations).putAll(eq(key), this.delta.capture());
+		assertThat(this.delta.getValue()).hasSize(3);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void save_NewSessionAndCustomKeyNamespace_ShouldSaveSession() {
+		this.sessionRepository.setKeyNamespace("custom:");
+		RedisSession session = this.sessionRepository.createSession();
+		this.sessionRepository.save(session);
+		String key = "custom:sessions:" + session.getId();
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionRedisOperations).expireAt(eq(key), eq(getExpiry(session)));
+		verify(this.sessionHashOperations).putAll(eq(key), this.delta.capture());
+		assertThat(this.delta.getValue()).hasSize(3);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void save_NewSessionAndChangedSessionId_ShouldSaveSession() {
+		RedisSession session = this.sessionRepository.createSession();
+		session.changeSessionId();
+		this.sessionRepository.save(session);
+		String key = getSessionKey(session.getId());
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionRedisOperations).expireAt(eq(key), eq(getExpiry(session)));
+		verify(this.sessionHashOperations).putAll(eq(key), this.delta.capture());
+		assertThat(this.delta.getValue()).hasSize(3);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void save_SessionExistsAndHasChanges_ShouldSaveSession() {
+		given(this.sessionRedisOperations.hasKey(eq(TEST_SESSION_KEY))).willReturn(true);
+		RedisSession session = createTestSession();
+		session.setLastAccessedTime(Instant.now());
+		session.setAttribute("attribute2", "value2");
+		this.sessionRepository.save(session);
+		verify(this.sessionRedisOperations).hasKey(eq(TEST_SESSION_KEY));
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionRedisOperations).expireAt(eq(TEST_SESSION_KEY),
+				eq(getExpiry(session)));
+		verify(this.sessionHashOperations).putAll(eq(TEST_SESSION_KEY),
+				this.delta.capture());
+		assertThat(this.delta.getValue()).hasSize(2);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void save_SessionExistsAndNoChanges_ShouldSaveSession() {
+		given(this.sessionRedisOperations.hasKey(eq(TEST_SESSION_KEY))).willReturn(true);
+		RedisSession session = createTestSession();
+		this.sessionRepository.save(session);
+		verify(this.sessionRedisOperations).hasKey(eq(TEST_SESSION_KEY));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void save_SessionNotExists_ShouldThrowException() {
+		RedisSession session = createTestSession();
+		assertThatIllegalStateException()
+				.isThrownBy(() -> this.sessionRepository.save(session))
+				.withMessage("Session was invalidated");
+		verify(this.sessionRedisOperations).hasKey(eq(TEST_SESSION_KEY));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	@SuppressWarnings("unchecked")
+	void findById_SessionExists_ShouldReturnSession() {
+		Instant now = Instant.now().truncatedTo(ChronoUnit.MILLIS);
+		given(this.sessionHashOperations.entries(eq(TEST_SESSION_KEY))).willReturn(
+				mapOf(RedisSessionMapper.CREATION_TIME_KEY, Instant.EPOCH.toEpochMilli(),
+						RedisSessionMapper.LAST_ACCESSED_TIME_KEY, now.toEpochMilli(),
+						RedisSessionMapper.MAX_INACTIVE_INTERVAL_KEY,
+						MapSession.DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS,
+						RedisSessionMapper.ATTRIBUTE_PREFIX + "attribute1", "value1"));
+		RedisSession session = this.sessionRepository.findById(TEST_SESSION_ID);
+		assertThat(session.getId()).isEqualTo(TEST_SESSION_ID);
+		assertThat(session.getCreationTime()).isEqualTo(Instant.EPOCH);
+		assertThat(session.getLastAccessedTime()).isEqualTo(now);
+		assertThat(session.getMaxInactiveInterval()).isEqualTo(
+				Duration.ofSeconds(MapSession.DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS));
+		assertThat(session.getAttributeNames())
+				.isEqualTo(Collections.singleton("attribute1"));
+		assertThat(session.<String>getAttribute("attribute1")).isEqualTo("value1");
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionHashOperations).entries(eq(TEST_SESSION_KEY));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	@SuppressWarnings("unchecked")
+	void findById_SessionExistsAndIsExpired_ShouldReturnNull() {
+		given(this.sessionHashOperations.entries(eq(TEST_SESSION_KEY))).willReturn(mapOf(
+				RedisSessionMapper.CREATION_TIME_KEY, Instant.EPOCH.toEpochMilli(),
+				RedisSessionMapper.LAST_ACCESSED_TIME_KEY, Instant.EPOCH.toEpochMilli(),
+				RedisSessionMapper.MAX_INACTIVE_INTERVAL_KEY,
+				MapSession.DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS,
+				RedisSessionMapper.ATTRIBUTE_PREFIX + "attribute1", "value1"));
+		assertThat(this.sessionRepository.findById(TEST_SESSION_ID)).isNull();
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionHashOperations).entries(eq(TEST_SESSION_KEY));
+		verify(this.sessionRedisOperations).delete(eq(TEST_SESSION_KEY));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void findById_SessionNotExists_ShouldReturnNull() {
+		assertThat(this.sessionRepository.findById(TEST_SESSION_ID)).isNull();
+		verify(this.sessionRedisOperations).opsForHash();
+		verify(this.sessionHashOperations).entries(eq(TEST_SESSION_KEY));
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void deleteById__ShouldDeleteSession() {
+		this.sessionRepository.deleteById(TEST_SESSION_ID);
+		verify(this.sessionRedisOperations).delete(TEST_SESSION_KEY);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	@Test
+	void getSessionRedisOperations__ShouldReturnRedisOperations() {
+		assertThat(this.sessionRepository.getSessionRedisOperations())
+				.isEqualTo(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionRedisOperations);
+		verifyNoMoreInteractions(this.sessionHashOperations);
+	}
+
+	private static String getSessionKey(String sessionId) {
+		return "spring:session:sessions:" + sessionId;
+	}
+
+	private static Date getExpiry(RedisSession session) {
+		return Date
+				.from(Instant.ofEpochMilli(session.getLastAccessedTime().toEpochMilli())
+						.plusSeconds(session.getMaxInactiveInterval().getSeconds()));
+	}
+
+	private static Map mapOf(Object... objects) {
+		Map<String, Object> result = new HashMap<>();
+		if (objects != null) {
+			for (int i = 0; i < objects.length; i += 2) {
+				result.put((String) objects[i], objects[i + 1]);
+			}
+		}
+		return result;
+	}
+
+	private RedisSession createTestSession() {
+		MapSession cached = new MapSession(TEST_SESSION_ID);
+		cached.setCreationTime(Instant.EPOCH);
+		cached.setLastAccessedTime(Instant.EPOCH);
+		cached.setAttribute("attribute1", "value1");
+		return this.sessionRepository.new RedisSession(cached);
+	}
+
+}