SpringSessionBackedSessionRegistryTest.java

/*
 * Copyright 2014-2017 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.session.security;

import java.util.Collections;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

import org.springframework.security.core.Authentication;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.context.SecurityContextImpl;
import org.springframework.security.core.session.SessionInformation;
import org.springframework.security.core.userdetails.User;
import org.springframework.session.ExpiringSession;
import org.springframework.session.FindByIndexNameSessionRepository;
import org.springframework.session.MapSession;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.mock;
import static org.mockito.BDDMockito.verify;
import static org.mockito.BDDMockito.when;

/**
 * Tests for {@link SpringSessionBackedSessionRegistry}.
 */
@RunWith(MockitoJUnitRunner.class)
public class SpringSessionBackedSessionRegistryTest {

	private static final String SESSION_ID = "sessionId";

	private static final String SESSION_ID2 = "otherSessionId";

	private static final String USER_NAME = "userName";

	private static final User PRINCIPAL = new User(USER_NAME, "password",
			Collections.<GrantedAuthority>emptyList());

	private static final Date NOW = new Date();

	@Mock
	private FindByIndexNameSessionRepository<ExpiringSession> sessionRepository;

	@InjectMocks
	private SpringSessionBackedSessionRegistry<ExpiringSession> sessionRegistry;

	@Test
	public void sessionInformationForExistingSession() {
		ExpiringSession session = createSession(SESSION_ID, USER_NAME, NOW.getTime());
		when(this.sessionRepository.getSession(SESSION_ID)).thenReturn(session);

		SessionInformation sessionInfo = this.sessionRegistry
				.getSessionInformation(SESSION_ID);

		assertThat(sessionInfo.getSessionId()).isEqualTo(SESSION_ID);
		assertThat(sessionInfo.getLastRequest()).isEqualTo(NOW);
		assertThat(sessionInfo.getPrincipal()).isEqualTo(USER_NAME);
		assertThat(sessionInfo.isExpired()).isFalse();
	}

	@Test
	public void sessionInformationForExpiredSession() {
		ExpiringSession session = createSession(SESSION_ID, USER_NAME, NOW.getTime());
		session.setAttribute(SpringSessionBackedSessionInformation.EXPIRED_ATTR,
				Boolean.TRUE);
		when(this.sessionRepository.getSession(SESSION_ID)).thenReturn(session);

		SessionInformation sessionInfo = this.sessionRegistry
				.getSessionInformation(SESSION_ID);

		assertThat(sessionInfo.getSessionId()).isEqualTo(SESSION_ID);
		assertThat(sessionInfo.getLastRequest()).isEqualTo(NOW);
		assertThat(sessionInfo.getPrincipal()).isEqualTo(USER_NAME);
		assertThat(sessionInfo.isExpired()).isTrue();
	}

	@Test
	public void noSessionInformationForMissingSession() {
		assertThat(this.sessionRegistry.getSessionInformation("nonExistingSessionId"))
				.isNull();
	}

	@Test
	public void getAllSessions() {
		setUpSessions();

		List<SessionInformation> allSessionInfos = this.sessionRegistry
				.getAllSessions(PRINCIPAL, true);

		assertThat(allSessionInfos).extracting("sessionId").containsExactly(SESSION_ID,
				SESSION_ID2);
	}

	@Test
	public void getNonExpiredSessions() {
		setUpSessions();

		List<SessionInformation> nonExpiredSessionInfos = this.sessionRegistry
				.getAllSessions(PRINCIPAL, false);

		assertThat(nonExpiredSessionInfos).extracting("sessionId")
				.containsExactly(SESSION_ID2);
	}

	@Test
	public void expireNow() {
		ExpiringSession session = createSession(SESSION_ID, USER_NAME, NOW.getTime());
		when(this.sessionRepository.getSession(SESSION_ID)).thenReturn(session);

		SessionInformation sessionInfo = this.sessionRegistry
				.getSessionInformation(SESSION_ID);
		assertThat(sessionInfo.isExpired()).isFalse();

		sessionInfo.expireNow();

		assertThat(sessionInfo.isExpired()).isTrue();
		ArgumentCaptor<ExpiringSession> captor = ArgumentCaptor
				.forClass(ExpiringSession.class);
		verify(this.sessionRepository).save(captor.capture());
		assertThat(captor.getValue().<Boolean>getAttribute(
				SpringSessionBackedSessionInformation.EXPIRED_ATTR))
						.isEqualTo(Boolean.TRUE);
	}

	private ExpiringSession createSession(String sessionId, String userName,
			Long lastAccessed) {
		MapSession session = new MapSession(sessionId);
		session.setLastAccessedTime(lastAccessed);
		Authentication authentication = mock(Authentication.class);
		when(authentication.getName()).thenReturn(userName);
		SecurityContextImpl securityContext = new SecurityContextImpl();
		securityContext.setAuthentication(authentication);
		session.setAttribute("SPRING_SECURITY_CONTEXT", securityContext);
		return session;
	}

	private void setUpSessions() {
		ExpiringSession session1 = createSession(SESSION_ID, USER_NAME, NOW.getTime());
		session1.setAttribute(SpringSessionBackedSessionInformation.EXPIRED_ATTR,
				Boolean.TRUE);
		ExpiringSession session2 = createSession(SESSION_ID2, USER_NAME, NOW.getTime());
		Map<String, ExpiringSession> sessions = new LinkedHashMap<>();
		sessions.put(session1.getId(), session1);
		sessions.put(session2.getId(), session2);
		when(this.sessionRepository.findByIndexNameAndIndexValue(
				FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME, USER_NAME))
						.thenReturn(sessions);
	}

}