spring-authorization-server/samples/custom-consent-authorizationserver/src/test/java/sample/CustomConsentAuthorizationServerTests.java

/*
 * Copyright 2020-2022 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 sample;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import com.gargoylesoftware.htmlunit.WebClient;
import com.gargoylesoftware.htmlunit.WebResponse;
import com.gargoylesoftware.htmlunit.html.DomElement;
import com.gargoylesoftware.htmlunit.html.HtmlCheckBoxInput;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.HttpStatus;
import org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationConsentService;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.web.util.UriComponentsBuilder;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;

/**
 * Consent page integration tests for the sample Authorization Server serving a custom Consent page.
 *
 * @author Dmitriy Dubson
 */
@ExtendWith(SpringExtension.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
public class CustomConsentAuthorizationServerTests {

	@Autowired
	private WebClient webClient;

	@MockBean
	private OAuth2AuthorizationConsentService authorizationConsentService;

	private final String redirectUri = "http://127.0.0.1/login/oauth2/code/messaging-client-oidc";

	private final String authorizationRequestUri = UriComponentsBuilder
			.fromPath("/oauth2/authorize")
			.queryParam("response_type", "code")
			.queryParam("client_id", "messaging-client")
			.queryParam("scope", "openid message.read message.write")
			.queryParam("state", "state")
			.queryParam("redirect_uri", this.redirectUri)
			.toUriString();

	@BeforeEach
	public void setUp() {
		this.webClient.getOptions().setThrowExceptionOnFailingStatusCode(false);
		this.webClient.getOptions().setRedirectEnabled(true);
		this.webClient.getCookieManager().clearCookies();
		when(this.authorizationConsentService.findById(any(), any())).thenReturn(null);
	}

	@Test
	@WithMockUser("user1")
	public void whenUserConsentsToAllScopesThenReturnAuthorizationCode() throws IOException {
		final HtmlPage consentPage = this.webClient.getPage(this.authorizationRequestUri);
		assertThat(consentPage.getTitleText()).isEqualTo("Custom consent page - Consent required");

		List<HtmlCheckBoxInput> scopes = new ArrayList<>();
		consentPage.querySelectorAll("input[name='scope']").forEach(scope ->
				scopes.add((HtmlCheckBoxInput) scope));
		for (HtmlCheckBoxInput scope : scopes) {
			scope.click();
		}

		List<String> scopeIds = new ArrayList<>();
		scopes.forEach(scope -> {
			assertThat(scope.isChecked()).isTrue();
			scopeIds.add(scope.getId());
		});
		assertThat(scopeIds).containsExactlyInAnyOrder("message.read", "message.write");

		DomElement submitConsentButton = consentPage.querySelector("button[id='submit-consent']");
		this.webClient.getOptions().setRedirectEnabled(false);

		WebResponse approveConsentResponse = submitConsentButton.click().getWebResponse();
		assertThat(approveConsentResponse.getStatusCode()).isEqualTo(HttpStatus.MOVED_PERMANENTLY.value());
		String location = approveConsentResponse.getResponseHeaderValue("location");
		assertThat(location).startsWith(this.redirectUri);
		assertThat(location).contains("code=");
	}

	@Test
	@WithMockUser("user1")
	public void whenUserCancelsConsentThenReturnAccessDeniedError() throws IOException {
		final HtmlPage consentPage = this.webClient.getPage(this.authorizationRequestUri);
		assertThat(consentPage.getTitleText()).isEqualTo("Custom consent page - Consent required");

		DomElement cancelConsentButton = consentPage.querySelector("button[id='cancel-consent']");
		this.webClient.getOptions().setRedirectEnabled(false);

		WebResponse cancelConsentResponse = cancelConsentButton.click().getWebResponse();
		assertThat(cancelConsentResponse.getStatusCode()).isEqualTo(HttpStatus.MOVED_PERMANENTLY.value());
		String location = cancelConsentResponse.getResponseHeaderValue("location");
		assertThat(location).startsWith(this.redirectUri);
		assertThat(location).contains("error=access_denied");
	}

}