WIP: Add tests for JsonViewControllerAdvice

See commit f620b9e7.

src/test/java/de/thm/arsnova/controller/JsonViewControllerAdviceTest.java

+/*
+ * This file is part of ARSnova Backend.
+ * Copyright (C) 2012-2019 The ARSnova Team and Contributors
+ *
+ * ARSnova Backend is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * ARSnova Backend is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.thm.arsnova.controller;
+
+import com.fasterxml.jackson.annotation.JsonView;
+import de.thm.arsnova.config.AppConfig;
+import de.thm.arsnova.config.TestAppConfig;
+import de.thm.arsnova.config.TestPersistanceConfig;
+import de.thm.arsnova.config.TestSecurityConfig;
+import de.thm.arsnova.config.WebSocketConfig;
+import de.thm.arsnova.model.Entity;
+import de.thm.arsnova.model.serialization.View;
+import de.thm.arsnova.service.EntityService;
+import de.thm.arsnova.test.context.support.WithMockUser;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.http.MediaType;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * This class tests {@link JsonViewControllerAdvice} which should be applied to
+ * controllers which extend {@link AbstractEntityController}. It tests that the
+ * correct {@link JsonView} is applied for serialization based on the
+ * <code>view</code> query parameter and that unauthorized view requests are
+ * rejected.
+ *
+ * @author Daniel Gerhardt
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@WebAppConfiguration
+@ContextConfiguration(classes = {
+		AppConfig.class,
+		TestAppConfig.class,
+		TestPersistanceConfig.class,
+		TestSecurityConfig.class,
+		WebSocketConfig.class})
+@ActiveProfiles("test")
+public class JsonViewControllerAdviceTest {
+	@Autowired
+	private WebApplicationContext webApplicationContext;
+
+	private MockMvc mockMvc;
+
+	@InjectMocks
+	private DummyEntityController dummyEntityController;
+
+	@MockBean
+	private EntityService<DummyEntity> dummyEntityService;
+
+	@Before
+	public void setup() {
+		mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
+		when(dummyEntityService.get("1")).thenReturn(new DummyEntity());
+	}
+
+	@Test
+	@WithMockUser("TestUser")
+	public void testShouldNotSerializeAdminViewForRegularUser() throws Exception {
+		mockMvc.perform(get("/dummy/1?view=admin").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isForbidden());
+	}
+
+	@Test
+	@WithMockUser("Admin")
+	public void testShouldSerializeAdminViewForAdmin() throws Exception {
+		mockMvc.perform(get("/dummy/1?view=admin").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk());
+	}
+
+	@Test
+	@WithMockUser("Admin")
+	public void testShouldSerializeOwnerViewForAdmin() throws Exception {
+		mockMvc.perform(get("/dummy/1?view=owner").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk());
+	}
+
+	@Test
+	@WithMockUser("Admin")
+	public void testAdminViewShouldContainAdminProperties() throws Exception {
+		mockMvc.perform(get("/dummy/1?view=admin").accept(MediaType.APPLICATION_JSON))
+				.andExpect(jsonPath("$.adminReadableString").exists())
+				.andExpect(jsonPath("$.ownerReadableString").exists())
+				.andExpect(jsonPath("$.publicReadableString").exists());
+	}
+
+	@Test
+	@WithMockUser("Admin")
+	public void testOwnerViewShouldContainOwnerProperties() throws Exception {
+		mockMvc.perform(get("/dummy/1?view=owner").accept(MediaType.APPLICATION_JSON))
+				.andExpect(jsonPath("$.adminReadableString").doesNotExist())
+				.andExpect(jsonPath("$.ownerReadableString").exists())
+				.andExpect(jsonPath("$.publicReadableString").exists());
+	}
+
+	@Test
+	@WithMockUser("Admin")
+	public void testDefaultViewShouldContainPublicProperties() throws Exception {
+		mockMvc.perform(get("/dummy/1").accept(MediaType.APPLICATION_JSON))
+				.andExpect(jsonPath("$.adminReadableString").doesNotExist())
+				.andExpect(jsonPath("$.ownerReadableString").doesNotExist())
+				.andExpect(jsonPath("$.publicReadableString").exists());
+	}
+
+	@RestController
+	@RequestMapping(DummyEntityController.REQUEST_MAPPING)
+	static class DummyEntityController extends AbstractEntityController<DummyEntity> {
+		private static final String REQUEST_MAPPING = "/dummy";
+
+		protected DummyEntityController(final EntityService<DummyEntity> entityService) {
+			super(entityService);
+		}
+
+		@Override
+		protected String getMapping() {
+			return REQUEST_MAPPING;
+		}
+	}
+
+	static class DummyEntity extends Entity {
+		@JsonView(View.Public.class) public String publicReadableString = "public";
+		@JsonView(View.Owner.class) public String ownerReadableString = "owner";
+		@JsonView(View.Admin.class) public String adminReadableString = "admin";
+	}
+}

src/test/resources/arsnova.properties.example

@@ -30,7 +30,7 @@ socketio.port=8090
 # Admin accounts
 # Usernames of the accounts which are allowed to manage global messages of the
 # day. Multiple accounts are separated by commas.
-security.admin-accounts=
+security.admin-accounts=Admin
 
 
 ################################################################################