AbstractCsrfTagTests.java

/*
 * Copyright 2002-2016 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.security.taglibs.csrf;

import org.junit.Before;
import org.junit.Test;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.mock.web.MockPageContext;
import org.springframework.mock.web.MockServletContext;
import org.springframework.security.web.csrf.CsrfToken;
import org.springframework.security.web.csrf.DefaultCsrfToken;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;

import java.io.UnsupportedEncodingException;

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

/**
 * @author Nick Williams
 */
public class AbstractCsrfTagTests {

	public MockTag tag;
	private MockHttpServletRequest request;
	private MockHttpServletResponse response;

	@Before
	public void setUp() {
		MockServletContext servletContext = new MockServletContext();
		this.request = new MockHttpServletRequest(servletContext);
		this.response = new MockHttpServletResponse();
		MockPageContext pageContext = new MockPageContext(servletContext, this.request,
				this.response);
		this.tag = new MockTag();
		this.tag.setPageContext(pageContext);
	}

	@Test
	public void noCsrfDoesNotRender() throws JspException, UnsupportedEncodingException {

		this.tag.handleReturn = "shouldNotBeRendered";

		int returned = this.tag.doEndTag();

		assertThat(returned).as("The returned value is not correct.").isEqualTo(TagSupport.EVAL_PAGE);
		assertThat(this.response.getContentAsString()).withFailMessage("The output value is not correct.").isEqualTo("");
	}

	@Test
	public void hasCsrfRendersReturnedValue() throws JspException,
			UnsupportedEncodingException {

		CsrfToken token = new DefaultCsrfToken("X-Csrf-Token", "_csrf",
				"abc123def456ghi789");
		this.request.setAttribute(CsrfToken.class.getName(), token);

		this.tag.handleReturn = "fooBarBazQux";

		int returned = this.tag.doEndTag();

		assertThat(returned).as("The returned value is not correct.").isEqualTo(TagSupport.EVAL_PAGE);
		assertThat(this.response.getContentAsString()).withFailMessage("The output value is not correct.").isEqualTo("fooBarBazQux");
		assertThat(this.tag.token).as("The token is not correct.").isSameAs(token);
	}

	@Test
	public void hasCsrfRendersDifferentValue() throws JspException,
			UnsupportedEncodingException {

		CsrfToken token = new DefaultCsrfToken("X-Csrf-Token", "_csrf",
				"abc123def456ghi789");
		this.request.setAttribute(CsrfToken.class.getName(), token);

		this.tag.handleReturn = "<input type=\"hidden\" />";

		int returned = this.tag.doEndTag();

		assertThat(returned).as("The returned value is not correct.").isEqualTo(TagSupport.EVAL_PAGE);
		assertThat(this.response.getContentAsString()).withFailMessage("The output value is not correct.").isEqualTo("<input type=\"hidden\" />");
		assertThat(this.tag.token).as("The token is not correct.").isSameAs(token);
	}

	private static class MockTag extends AbstractCsrfTag {

		private CsrfToken token;
		private String handleReturn;

		@Override
		protected String handleToken(CsrfToken token) {
			this.token = token;
			return this.handleReturn;
		}
	}
}