/**
* Copyright (C) 2011 JTalks.org Team
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library 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
* Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jtalks.jcommune.web.controller;
import org.jtalks.common.model.entity.Section;
import org.jtalks.jcommune.model.dto.PageRequest;
import org.jtalks.jcommune.model.entity.*;
import org.jtalks.jcommune.service.*;
import org.jtalks.jcommune.plugin.api.exceptions.NotFoundException;
import org.jtalks.jcommune.service.nontransactional.LocationService;
import org.jtalks.jcommune.plugin.api.web.dto.Breadcrumb;
import org.jtalks.jcommune.plugin.api.web.dto.TopicDto;
import org.jtalks.jcommune.plugin.api.web.util.BreadcrumbBuilder;
import org.jtalks.jcommune.service.dto.EntityToDtoConverter;
import org.jtalks.jcommune.plugin.api.web.dto.json.JsonResponse;
import org.jtalks.jcommune.plugin.api.web.dto.json.JsonResponseStatus;
import org.mockito.Matchers;
import org.mockito.Mock;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.retry.policy.NeverRetryPolicy;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.core.session.SessionRegistry;
import org.springframework.validation.BeanPropertyBindingResult;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.ModelAndView;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import java.util.*;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyLong;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.*;
import static org.mockito.MockitoAnnotations.initMocks;
import static org.springframework.test.web.ModelAndViewAssert.*;
import static org.testng.Assert.*;
/**
* @author Teterin Alexandre
* @author Kirill Afonin
* @author Max Malakhov
* @author Eugeny Batov
*/
public class TopicControllerTest {
public long BRANCH_ID = 1L;
private long TOPIC_ID = 1L;
private String TOPIC_CONTENT = "content here";
private JCUser user;
private Branch branch;
@Mock
private TopicModificationService topicModificationService;
@Mock
private TopicFetchService topicFetchService;
@Mock
private TopicDraftService topicDraftService;
@Mock
private PostService postService;
@Mock
private BranchService branchService;
@Mock
private UserService userService;
@Mock
private BreadcrumbBuilder breadcrumbBuilder;
@Mock
private LocationService locationService;
@Mock
private SessionRegistry registry;
@Mock
private EntityToDtoConverter converter;
private TopicController controller;
@Mock
private BindingResult result;
private RetryTemplate retryTemplate;
@BeforeMethod
public void initEnvironment() {
initMocks(this);
retryTemplate = new RetryTemplate();
retryTemplate.setRetryPolicy(new NeverRetryPolicy());
controller = new TopicController(
topicModificationService,
postService,
branchService,
userService,
breadcrumbBuilder,
locationService,
registry,
topicFetchService,
topicDraftService,
converter,
retryTemplate);
}
@BeforeMethod
public void prepareTestData() {
branch = new Branch("", "description");
branch.setSection(new Section("sectionname"));
branch.setId(BRANCH_ID);
user = new JCUser("username", "email@mail.com", "password");
}
@Test
public void initBinder() {
WebDataBinder binder = mock(WebDataBinder.class);
controller.initBinder(binder);
verify(binder).registerCustomEditor(eq(String.class), any(StringTrimmerEditor.class));
}
@Test
public void delete() throws NotFoundException {
Topic topic = new Topic(null, null);
branch.addTopic(topic);
when(topicFetchService.get(anyLong())).thenReturn(topic);
ModelAndView actualMav = controller.deleteTopic(TOPIC_ID);
assertViewName(actualMav, "redirect:/branches/" + BRANCH_ID);
verify(topicModificationService).deleteTopic(topic);
}
//TODO: this has to be improved - too complicated test!=
@Test
public void showTopicPageShouldShowListOfPostsWithUpdatedInfoAboutLastReadPosts() throws NotFoundException {
String page = "1";
Topic topic = createTopic();
prepareViewTopicMocks(topic, page);
WebRequest request = mock(WebRequest.class);
ModelAndView mav = controller.showTopicPage(request, TOPIC_ID, page);
verify(topicFetchService).checkViewTopicPermission(topic.getBranch().getId());
//
assertViewName(mav, "topic/postList");
assertAndReturnModelAttributeOfType(mav, "postsPage", Page.class);
//
Topic actualTopic = assertAndReturnModelAttributeOfType(mav, "topic", Topic.class);
assertEquals(actualTopic, topic);
assertModelAttributeAvailable(mav, "breadcrumbList");
}
@Test
public void showTopicPageShouldReturnNullIfModifiedSinceOlderThenLastUpdate() throws NotFoundException {
String page = "1";
Topic topic = createTopic();
prepareViewTopicMocks(topic, page);
WebRequest request = mock(WebRequest.class);
doReturn(true).when(request).checkNotModified(anyLong());
ModelAndView mav = controller.showTopicPage(request, TOPIC_ID, page);
assertNull(mav);
}
@Test
public void showTopicPageShouldReturnNotNullDataIfIfModifiedSinceOlderThenLastUpdate() throws NotFoundException {
String page = "1";
Topic topic = createTopic();
prepareViewTopicMocks(topic, page);
WebRequest request = mock(WebRequest.class);
when(request.checkNotModified(topic.getModificationDate().getMillis())).thenReturn(false);
ModelAndView mav = controller.showTopicPage(request, TOPIC_ID, page);
assertNotNull(mav);
}
@Test
public void createTopicShouldPassAndRedirectToNewTopicIfItIsValid() throws Exception {
Branch branch = createBranch();
Topic topic = createTopic();
TopicDto dto = getDto();
BindingResult result = mock(BindingResult.class);
when(branchService.get(BRANCH_ID)).thenReturn(branch);
when(topicModificationService.createTopic(topic, TOPIC_CONTENT)).thenReturn(topic);
ModelAndView mav = controller.createTopic(dto, result, BRANCH_ID);
verify(topicModificationService).createTopic(topic, TOPIC_CONTENT);
//
assertViewName(mav, "redirect:/topics/1");
}
@Test
public void createTopicShouldNotPassAndMustShowTopicErrorIfItIsInvalid() throws NotFoundException {
BindingResult result = mock(BindingResult.class);
when(result.hasErrors()).thenReturn(true);
when(branchService.get(BRANCH_ID)).thenReturn(branch);
List<Breadcrumb> breadcrumbs = new BreadcrumbBuilder().getNewTopicBreadcrumb(branch);
when(breadcrumbBuilder.getNewTopicBreadcrumb(branch)).thenReturn(breadcrumbs);
ModelAndView mav = controller.createTopic(getDto(), result, BRANCH_ID);
verify(branchService).get(BRANCH_ID);
verify(breadcrumbBuilder).getNewTopicBreadcrumb(branch);
List<Breadcrumb> breadcrumbsFromModel = (List) mav.getModel().get("breadcrumbList");
for (int i = 0; i < breadcrumbs.size(); i++) {
assertEquals(breadcrumbs.get(i).getValue(), breadcrumbsFromModel.get(i).getValue());
}
assertEquals(breadcrumbsFromModel.get(1).getValue(), branch.getSection().getName());
assertEquals(breadcrumbsFromModel.get(2).getValue(), branch.getName());
assertViewName(mav, "topic/topicForm");
long branchId = assertAndReturnModelAttributeOfType(mav, "branchId", Long.class);
assertEquals(branchId, BRANCH_ID);
}
@Test
public void testSaveDraft() throws Exception {
TopicDraft savedDraft = createTopicDraft();
when(topicDraftService.saveOrUpdateDraft(savedDraft)).thenReturn(savedDraft);
JsonResponse response = controller.saveDraft(savedDraft, result);
assertEquals(response.getStatus(), JsonResponseStatus.SUCCESS);
assertEquals((long) response.getResult(), savedDraft.getId());
}
@Test
public void saveDraftShouldReturnFailResponseIfValidationErrorsOccurred() throws Exception {
when(result.hasErrors()).thenReturn(true);
JsonResponse response = controller.saveDraft(createTopicDraft(), result);
assertEquals(response.getStatus(), JsonResponseStatus.FAIL);
}
@Test
public void testDeleteDraft() {
controller.deleteDraft();
verify(topicDraftService).deleteDraft();
}
@Test
public void showNewTopicPageShouldReturnTemplateForNewTopic() throws NotFoundException {
when(branchService.get(BRANCH_ID)).thenReturn(branch);
when(breadcrumbBuilder.getNewTopicBreadcrumb(branch)).thenReturn(new ArrayList<Breadcrumb>());
ModelAndView mav = controller.showNewTopicPage(BRANCH_ID);
verify(branchService).get(BRANCH_ID);
verify(breadcrumbBuilder).getNewTopicBreadcrumb(branch);
//
assertViewName(mav, "topic/topicForm");
//
TopicDto topicDto = assertAndReturnModelAttributeOfType(mav, "topicDto", TopicDto.class);
Topic actualTopic = topicDto.getTopic();
Branch actualTopicBranch = actualTopic.getBranch();
assertEquals(actualTopicBranch, branch, "Topic template should be attached to branch where user creates branch.");
assertNotNull(actualTopic.getPoll(), "Topic template should contain poll template.");
//
long branchId = assertAndReturnModelAttributeOfType(mav, "branchId", Long.class);
assertEquals(branchId, BRANCH_ID,
"Topic template should be returned with the same branch id as passed to create new topic.");
assertModelAttributeAvailable(mav, "breadcrumbList");
}
@Test
public void showNewTopicPageShouldShowDraft() throws NotFoundException {
Topic expectedTopic = createTopic();
TopicDraft expectedDraft = new TopicDraft(user, expectedTopic.getTitle(), expectedTopic.getBodyText());
when(topicDraftService.getDraft()).thenReturn(expectedDraft);
ModelAndView mav = controller.showNewTopicPage(BRANCH_ID);
TopicDto topicDto = assertAndReturnModelAttributeOfType(mav, "topicDto", TopicDto.class);
Topic topic = topicDto.getTopic();
assertEquals(topic.getTitle(), expectedDraft.getTitle());
assertEquals(topicDto.getBodyText(), expectedDraft.getContent());
}
@Test
public void editTopicPageShouldOpenEditFormAndNotEnableNotificationsIfUserNotSubcribed() throws NotFoundException {
Topic topic = this.createTopic();
Post post = new Post(user, "content");
topic.addPost(post);
topic.setType(TopicTypeName.DISCUSSION.getName());
//
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
when(breadcrumbBuilder.getForumBreadcrumb(topic)).thenReturn(new ArrayList<Breadcrumb>());
when(userService.getCurrentUser()).thenReturn(user);
ModelAndView mav = controller.editTopicPage(TOPIC_ID);
verify(topicFetchService).get(TOPIC_ID);
verify(breadcrumbBuilder).getForumBreadcrumb(topic);
//
assertViewName(mav, "topic/topicForm");
//
TopicDto dto = assertAndReturnModelAttributeOfType(mav, "topicDto", TopicDto.class);
assertEquals(dto.getTopic().getId(), TOPIC_ID);
//
long branchId = assertAndReturnModelAttributeOfType(mav, "branchId", Long.class);
assertEquals(branchId, BRANCH_ID);
assertModelAttributeAvailable(mav, "breadcrumbList");
}
@Test
public void editTopicPageShouldOpenEditFormAndEnableNotificationsIfUserSubcribed() throws NotFoundException {
Topic topic = this.createTopic();
Set<JCUser> subscribers = new HashSet<>();
subscribers.add(user);
topic.setSubscribers(subscribers);
Post post = new Post(user, "content");
topic.addPost(post);
topic.setType(TopicTypeName.DISCUSSION.getName());
//
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
when(breadcrumbBuilder.getForumBreadcrumb(topic)).thenReturn(new ArrayList<Breadcrumb>());
when(userService.getCurrentUser()).thenReturn(user);
ModelAndView mav = controller.editTopicPage(TOPIC_ID);
verify(topicFetchService).get(TOPIC_ID);
verify(breadcrumbBuilder).getForumBreadcrumb(topic);
//
assertViewName(mav, "topic/topicForm");
//
TopicDto dto = assertAndReturnModelAttributeOfType(mav, "topicDto", TopicDto.class);
assertEquals(dto.getTopic().getId(), TOPIC_ID);
//
long branchId = assertAndReturnModelAttributeOfType(mav, "branchId", Long.class);
assertEquals(branchId, BRANCH_ID);
assertModelAttributeAvailable(mav, "breadcrumbList");
}
@Test(expectedExceptions = AccessDeniedException.class)
public void editTopicPageShouldNotBePossibleForCodeReview() throws NotFoundException {
Topic topic = this.createTopic();
topic.setType(TopicTypeName.CODE_REVIEW.getName());
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
when(breadcrumbBuilder.getForumBreadcrumb(topic)).thenReturn(new ArrayList<Breadcrumb>());
when(userService.getCurrentUser()).thenReturn(user);
controller.editTopicPage(TOPIC_ID);
}
@Test
public void saveValidationPass() throws NotFoundException {
TopicDto dto = getDto();
BindingResult bindingResult = new BeanPropertyBindingResult(dto, "topicDto");
when(topicFetchService.get(TOPIC_ID)).thenReturn(createTopic());
//invoke the object under test
ModelAndView mav = controller.editTopic(dto, bindingResult, TOPIC_ID);
Topic topic = topicFetchService.get(TOPIC_ID);
//check expectations
verify(topicModificationService).updateTopic(topic, dto.getPoll());
//check result
assertViewName(mav, "redirect:/topics/" + TOPIC_ID);
}
@Test
public void saveValidationFail() throws NotFoundException {
TopicDto dto = getDto();
BeanPropertyBindingResult resultWithErrors = mock(BeanPropertyBindingResult.class);
when(topicFetchService.get(TOPIC_ID)).thenReturn(this.createTopic());
when(resultWithErrors.hasErrors()).thenReturn(true);
ModelAndView mav = controller.editTopic(dto, resultWithErrors, TOPIC_ID);
assertViewName(mav, "topic/topicForm");
long branchId = assertAndReturnModelAttributeOfType(mav, "branchId", Long.class);
assertEquals(branchId, BRANCH_ID);
verify(topicModificationService, never()).updateTopic(Matchers.<Topic>any(), Matchers.<Poll>any());
}
@Test
public void moveTopic() throws NotFoundException {
String url = "example.com";
Topic topic = createTopic();
TopicDto topicDto = new TopicDto(topic);
topicDto.setTopicUrl(url);
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
when(converter.convertTopicToDto(topic)).thenReturn(topicDto);
JsonResponse response = controller.moveTopic(TOPIC_ID, BRANCH_ID);
assertEquals(response.getStatus(), JsonResponseStatus.SUCCESS);
assertEquals(response.getResult(), url);
verify(topicModificationService).moveTopic(topic, BRANCH_ID);
}
@Test(expectedExceptions = NotFoundException.class)
public void moveTopicShouldThrowExceptionIfTopicNotFound() throws Exception {
when(topicFetchService.get(anyLong())).thenThrow(new NotFoundException());
controller.moveTopic(1L, 1L);
}
@Test
public void closeTopic() throws NotFoundException {
Topic topic = createTopic();
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
controller.closeTopic(TOPIC_ID);
verify(topicModificationService).closeTopic(topic);
}
@Test
public void reopenTopic() throws NotFoundException {
Topic topic = createTopic();
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
controller.openTopic(TOPIC_ID);
verify(topicModificationService).openTopic(topic);
}
@Test
public void pageContainLinkToMarkAsRead() throws NotFoundException {
String page = "1";
Topic topic = createTopic();
prepareViewTopicMocks(topic, page);
ModelAndView mav = controller.showTopicPage(mock(WebRequest.class), TOPIC_ID, page);
assertModelAttributeAvailable(mav, "markAsReadLink");
}
private Branch createBranch() {
Branch branch = new Branch("branch name", "branch description");
branch.setId(BRANCH_ID);
return branch;
}
private Topic createTopic() {
Branch branch = createBranch();
Topic topic = new Topic(user, "Topic theme");
topic.setId(TOPIC_ID);
topic.setUuid("uuid");
topic.setBranch(branch);
topic.addPost(new Post(user, TOPIC_CONTENT));
return topic;
}
private TopicDraft createTopicDraft() {
TopicDraft topicDraft = new TopicDraft(user, "Topic theme", TOPIC_CONTENT);
topicDraft.setBranchId(BRANCH_ID);
topicDraft.setTopicType(TopicTypeName.DISCUSSION.getName());
return topicDraft;
}
private TopicDto getDto() {
TopicDto dto = new TopicDto();
Topic topic = createTopic();
dto.setBodyText(TOPIC_CONTENT);
Poll poll = new Poll();
List<PollItem> pollItems = Arrays.asList(new PollItem("123"));
poll.addPollOptions(pollItems);
topic.setPoll(poll);
dto.setTopic(topic);
return dto;
}
private void prepareViewTopicMocks(Topic topic, String page) throws NotFoundException {
PageRequest pageable = new PageRequest(page, 15);
Page<Post> postsPage = new PageImpl<>(topic.getPosts(), pageable, 30L);
when(userService.getCurrentUser()).thenReturn(topic.getTopicStarter());
when(topicFetchService.get(TOPIC_ID)).thenReturn(topic);
when(breadcrumbBuilder.getForumBreadcrumb(topic)).thenReturn(new ArrayList<Breadcrumb>());
when(postService.getPosts(topic, page)).thenReturn(postsPage);
}
}