CipherStreamAPI/src/test/java/com/mattrixwv/cipherstream/controller/monosubstitution/AtbashCipherControllerIntegrationTest.java

package com.mattrixwv.cipherstream.controller.monosubstitution;


import static org.hamcrest.Matchers.*;
import static org.mockito.Mockito.*;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import java.util.List;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.mockito.Mock;
import org.slf4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.util.ReflectionTestUtils;
import org.springframework.test.web.servlet.MockMvc;

import com.fasterxml.jackson.databind.node.ObjectNode;
import com.mattrixwv.cipherstream.aspect.CipherStreamLoggingAspect;
import com.mattrixwv.cipherstream.controller.CipherStreamControllerIntegrationTestBase;
import com.mattrixwv.cipherstream.utils.CipherInfoUtil;
import com.mattrixwv.cipherstream.utils.CipherParameterUtil;


@Tag("integration-test")
@WebMvcTest(controllers = AtbashCipherController.class)
public class AtbashCipherControllerIntegrationTest extends CipherStreamControllerIntegrationTestBase{
	@Autowired
	private MockMvc mockMvc;
	@Autowired
	private AtbashCipherController atbashCipherController;
	//Loggers
	@Mock(name = "com.mattrixwv.cipherstream.controller.monosubstitution.AtbashCipherController")
	protected Logger atbashLogger;
	//Fields
	private static final ObjectNode blankNode = mapper.createObjectNode();
	private static final String url = "/atbash";
	private static final String decodedString = "Message to^encode";
	private static final String encodedString = "Nvhhztv gl^vmxlwv";
	private static final String atbashName = "atbashName";
	private static final String atbashDescription = "atbashDescription";
	private static final List<String> atbashExplanation = List.of("atbashExplanation1", "atbashExplanation2", "atbashExplanation3");
	private static final List<String> atbashFacts = List.of("atbashFact1", "atbashFact2", "atbashFact3");


	@BeforeEach
	public void setup(){
		decodedNode = mapper.createObjectNode();
		decodedNode.put(CipherParameterUtil.PRESERVE_CAPITALS, true);
		decodedNode.put(CipherParameterUtil.PRESERVE_WHITESPACE, true);
		decodedNode.put(CipherParameterUtil.PRESERVE_SYMBOLS, true);
		decodedNode.put(CipherParameterUtil.INPUT_STRING, decodedString);
		decodedNode.put(CipherParameterUtil.OUTPUT_STRING, encodedString);

		encodedNode = mapper.createObjectNode();
		encodedNode.put(CipherParameterUtil.PRESERVE_CAPITALS, true);
		encodedNode.put(CipherParameterUtil.PRESERVE_WHITESPACE, true);
		encodedNode.put(CipherParameterUtil.PRESERVE_SYMBOLS, true);
		encodedNode.put(CipherParameterUtil.INPUT_STRING, encodedString);
		encodedNode.put(CipherParameterUtil.OUTPUT_STRING, decodedString);

		ReflectionTestUtils.setField(atbashCipherController, "atbashName", atbashName);
		ReflectionTestUtils.setField(atbashCipherController, "atbashDescription", atbashDescription);
		ReflectionTestUtils.setField(atbashCipherController, "atbashExplanation", atbashExplanation);
		ReflectionTestUtils.setField(atbashCipherController, "atbashFacts", atbashFacts);
	}


	@Test
	public void testGetCipherInfo() throws Exception{
		mockMvc.perform(get(url)
				.header("X-Request-Id", requestId)
				.header("X-Forwarded-For", ipAddress))
			.andExpect(status().isOk())
			.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_DESCRIPTION).value(atbashDescription))
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_NAME).value(atbashName))
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_EXPLANATION).isArray())
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_EXPLANATION, hasSize(atbashExplanation.size())))
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_EXPLANATION, hasItems(atbashExplanation.get(0), atbashExplanation.get(1), atbashExplanation.get(2))))
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_FACTS).isArray())
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_FACTS, hasSize(atbashFacts.size())))
			.andExpect(jsonPath(CipherInfoUtil.CIPHER_FACTS, hasItems(atbashFacts.get(0), atbashFacts.get(1), atbashFacts.get(2))));

		//Filter
		super.verifyFilter(url);
		//Controller
		verify(atbashLogger, times(1)).info("Getting info for {}", atbashName);
		verifyNoMoreInteractions(atbashLogger);
		verify(mdc, times(1)).put(CipherStreamLoggingAspect.CIPHER_NAME_LOGGING, atbashName);
	}

	@Test
	public void testEncodeAtbash() throws Exception{
		mockMvc.perform(post(url + "/encode")
				.header("X-Request-Id", requestId)
				.header("X-Forwarded-For", ipAddress)
				.contentType(MediaType.APPLICATION_JSON)
				.content(decodedNode.toString()))
			.andExpect(status().isOk())
			.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
			.andExpect(jsonPath(CipherParameterUtil.OUTPUT_STRING).value(encodedString));

		//Filter
		super.verifyFilter(url + "/encode");
		//Controller
		verify(atbashLogger, times(1)).info("Encoding {}", atbashName);
		verifyNoMoreInteractions(atbashLogger);
		verify(mdc, times(1)).put(CipherStreamLoggingAspect.CIPHER_NAME_LOGGING, atbashName);
		//Cipher Aspect
		verifyAspectLogging(decodedNode);
	}

	@Test
	public void testEncodeAtbash_error() throws Exception{
		mockMvc.perform(post(url + "/encode")
				.header("X-Request-Id", requestId)
				.header("X-Forwarded-For", ipAddress)
				.contentType(MediaType.APPLICATION_JSON)
				.content(blankNode.toString()))
			.andExpect(status().isBadRequest())
			.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
			.andExpect(jsonPath("message").value(CipherParameterUtil.PRESERVE_CAPITALS + CipherParameterUtil.PRESENT_MESSAGE));

		//Filter
		super.verifyFilter(url + "/encode");
		//Controller
		verify(atbashLogger, times(1)).info("Encoding {}", atbashName);
		verifyNoMoreInteractions(atbashLogger);
		verify(mdc, times(1)).put(CipherStreamLoggingAspect.CIPHER_NAME_LOGGING, atbashName);
		//Cipher Aspect
		verifyNoInteractions(aspectLogger);
	}

	@Test
	public void testDecodeAtbash() throws Exception{
		mockMvc.perform(post(url + "/decode")
				.header("X-Request-Id", requestId)
				.header("X-Forwarded-For", ipAddress)
				.contentType(MediaType.APPLICATION_JSON)
				.content(encodedNode.toString()))
			.andExpect(status().isOk())
			.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
			.andExpect(jsonPath(CipherParameterUtil.OUTPUT_STRING).value(decodedString));

		//Filter
		super.verifyFilter(url + "/decode");
		//Controller
		verify(atbashLogger, times(1)).info("Decoding {}", atbashName);
		verifyNoMoreInteractions(atbashLogger);
		verify(mdc, times(1)).put(CipherStreamLoggingAspect.CIPHER_NAME_LOGGING, atbashName);
		//Cipher Aspect
		verifyAspectLogging(encodedNode);
	}

	@Test
	public void testDecodeAtbash_error() throws Exception{
		mockMvc.perform(post(url + "/decode")
				.header("X-Request-Id", requestId)
				.header("X-Forwarded-For", ipAddress)
				.contentType(MediaType.APPLICATION_JSON)
				.content(blankNode.toString()))
			.andExpect(status().isBadRequest())
			.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
			.andExpect(jsonPath("message").value(CipherParameterUtil.PRESERVE_CAPITALS + CipherParameterUtil.PRESENT_MESSAGE));

		//Filter
		super.verifyFilter(url + "/decode");
		//Controller
		verify(atbashLogger, times(1)).info("Decoding {}", atbashName);
		verifyNoMoreInteractions(atbashLogger);
		verify(mdc, times(1)).put(CipherStreamLoggingAspect.CIPHER_NAME_LOGGING, atbashName);
		//Cipher Aspect
		verifyNoInteractions(aspectLogger);
	}
}