/*
 * Copyright 2002-2023 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.security.test.web.servlet;

import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.security.web.savedrequest.HttpSessionRequestCache;
import org.springframework.security.web.savedrequest.RequestCache;
import org.springframework.security.web.savedrequest.SavedRequest;
import org.springframework.test.web.servlet.ResultMatcher;

import static org.assertj.core.api.Assertions.assertThat;

/**
 * Ensures that the MockMvcResult redirects to the saved RequestCache.getRedirectUrl().
 */
public final class RequestCacheResultMatcher {

	/**
	 * Verifies that the MockMvcResult redirects to the saved
	 * RequestCache.getRedirectUrl().
	 * @return a ResultMatcher that performs the verification.
	 */
	public static ResultMatcher redirectToCachedRequest() {
		return (mvcResult) -> {
			RequestCache requestCache = new HttpSessionRequestCache();
			MockHttpServletResponse response = mvcResult.getResponse();
			SavedRequest savedRequest = requestCache.getRequest(mvcResult.getRequest(), response);
			assertThat(savedRequest).describedAs("savedRequest cannot be null").isNotNull();
			String cachedRedirectUrl = savedRequest.getRedirectUrl();
			assertThat(response.getRedirectedUrl()).isEqualTo(cachedRedirectUrl);
		};
	}

	private RequestCacheResultMatcher() {
	}

}
