TopicTest.java

/**
 * 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.model.entity;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import com.google.common.base.Optional;
import org.joda.time.DateTime;
import org.testng.annotations.Test;

import static org.testng.Assert.*;

public class TopicTest {

    @Test
    public void getNeighborPostIfOnlyOnePostInTheTopic() {
        Post singlePost = new Post();
        Topic topicWithSinglePost = new Topic(new JCUser(),
                "title4getNeighborPostIfOnlyOnePostInTheTopic");
        topicWithSinglePost.addPost(singlePost);

        Post post = topicWithSinglePost.getNeighborPost(singlePost);
        // same post (singlePost) should be returned
        assertEquals(post, singlePost);
    }

    @Test
    public void getNeighborPostForMiddlePostInTheTopic() {
        Topic topicLocal = new Topic(new JCUser(),
                "title4getNeighborPostForMiddlePostInTheTopic");
        // add 3 posts to topic
        Post[] posts = postList(3, topicLocal);
        // get neighbor for post in the middle.
        Post post = topicLocal.getNeighborPost(posts[1]);
        // next post (post2) should be returned
        assertEquals(post, posts[2]);
    }

    @Test
    public void getNeighborPostForLastPostInTheTopic() {
        Topic topic = createTopic();
        Post post = topic.getNeighborPost(topic.getPosts().get(1));
        // previous post (post1) should be returned
        assertEquals(post, topic.getPosts().get(0));
    }

    @Test
    public void firstPostShouldReturnFirstPostOfTheTopic() {
        Topic topic = createTopic();
        Post firstPost = topic.getFirstPost();

        assertEquals(firstPost, topic.getPosts().get(0));
    }

    @Test
    public void addPostShouldUpdateModificationDate() throws InterruptedException {
        Topic topic = createTopic();
        DateTime prevDate = topic.getModificationDate();
        Post post = new Post();
        post.setCreationDate(new DateTime().plusHours(1));
        topic.addPost(post);
        assertTrue(topic.getModificationDate().isAfter(prevDate));
    }

    @Test
    public void addPostShouldSetModificationDateToPostCreationDate() throws InterruptedException {
        Topic topic = createTopic();
        DateTime prevDate = topic.getModificationDate();
        Post post = new Post();
        post.setCreationDate(new DateTime().plusDays(1));
        topic.addPost(post);

        assertEquals(topic.getModificationDate(), post.getCreationDate());
        assertFalse(prevDate.equals(topic.getModificationDate()));
    }

    @Test
    public void recalculateModificationDateShouldSetModificationDateAsTheLatestDateAmongAllPosts() {
        Topic topic = createTopic();
        DateTime lastModificationDate = new DateTime();
        
        topic.getFirstPost().setCreationDate(lastModificationDate.minusDays(1));
        topic.getPosts().get(1).setCreationDate(lastModificationDate);
        Post post3 = new Post();
        post3.setCreationDate(lastModificationDate.minusDays(2));
        
        topic.addPost(post3);
        
        topic.recalculateModificationDate();
        
        assertEquals(topic.getModificationDate(), lastModificationDate);
    }

    @Test
    public void hasUpdatesShouldReturnTrueByDefault() {
        Topic topic = createTopic();

        assertTrue(topic.isHasUpdates());
    }

    @Test
    public void hasUpdatesShouldReturnTrueInCaseOfUpdatesExist() {
        Topic topic = createTopic();
        DateTime creationDate = new DateTime();
        topic.getFirstPost().setCreationDate(creationDate);
        topic.getLastPost().setCreationDate(creationDate.plusDays(1));
        topic.setLastReadPostDate(creationDate);

        assertTrue(topic.isHasUpdates());
    }

    @Test
    public void hasUpdatesShouldReturnFalseInCaseOfNoUpdatesExist() {
        Topic topic = createTopic();
        DateTime lastModificationDate = new DateTime();

        topic.getFirstPost().setCreationDate(lastModificationDate.minusDays(1));
        topic.getPosts().get(1).setCreationDate(lastModificationDate);

        topic.setLastReadPostDate(topic.getLastPost().getCreationDate());
        assertFalse(topic.isHasUpdates());
    }

    @Test
    public void getFirstUnreadPostIdShouldReturnTheNextPostAfterLastRead() {
        Topic topic = createTopic();
        DateTime lastModificationDate = new DateTime();

        topic.getFirstPost().setCreationDate(lastModificationDate.minusDays(1));
        topic.getPosts().get(1).setCreationDate(lastModificationDate);

        topic.setLastReadPostDate(topic.getFirstPost().getCreationDate());

        long id = topic.getFirstUnreadPostId();

        assertEquals(topic.getPosts().get(1).getId(), id);
    }

    @Test
    public void getFirstUnreadPostIdShouldReturnFirstPostIdIfAllPostAreRead() {
        Topic topic = createTopic();
        DateTime lastModificationDate = new DateTime();

        topic.getFirstPost().setCreationDate(lastModificationDate.minusDays(1));
        topic.getPosts().get(1).setCreationDate(lastModificationDate);

        long id = topic.getFirstUnreadPostId();

        assertEquals(topic.getPosts().get(0).getId(), id);
    }

    @Test
    public void topicShouldHasNoUpdatesIfLastReadPostIsTheLatestPost() {
        Topic topic = createTopic();
        DateTime lastPostCreationDate = new DateTime();
        topic.getLastPost().setCreationDate(lastPostCreationDate);
        topic.setLastReadPostDate(lastPostCreationDate);
        assertEquals(topic.getLastReadPostDate(), lastPostCreationDate);
        assertFalse(topic.isHasUpdates());
    }

    @Test
    public void removePostShouldRemovePostFromTheTopic() {
        Topic topic = createTopic();
        DateTime lastModification = new DateTime(1900, 11, 11, 11, 11, 11, 11);
        topic.setModificationDate(lastModification);
        Post toRemove = topic.getPosts().get(0);

        topic.removePost(toRemove);

        assertFalse(topic.getPosts().contains(toRemove), "The post isn't removed from the topic");
    }

    @Test
    public void removePostShouldSetModificationDateToLastPostInTheTopic(){
        Post post1 = new Post();
        post1.setCreationDate(new DateTime());
        Post post2 = new Post();
        post2.setCreationDate(new DateTime());
        Topic topic = new Topic(new JCUser(), "title");
        topic.addPost(post1);
        topic.addPost(post2);
        Post post3 = new Post();
        post3.setCreationDate(new DateTime());
        topic.addPost(post3);
        topic.removePost(post3);

        assertEquals(topic.getModificationDate(), post2.getCreationDate());

    }

    @Test
    public void setSubscribersShouldSubscribeUserToTheTopic() {
        Topic topic = createTopic();
        JCUser subscribedUser = new JCUser();
        JCUser notSubscribedUser = new JCUser();
        Set<JCUser> subscribers = new HashSet<>();
        subscribers.add(subscribedUser);
        topic.setSubscribers(subscribers);
        assertTrue(topic.userSubscribed(subscribedUser));
        assertFalse(topic.userSubscribed(notSubscribedUser));
    }

    @Test
    public void addOrOverrideAttributeShouldAddAttributes() {
        Topic topic = createTopic();
        String name = "name";
        String value = "value";

        topic.addOrOverrideAttribute(name, value);

        assertEquals(topic.getAttributes().get(name), value);
    }

    @Test
    public void addOrOverrideAttributeShouldOverrideExistentAttributes() {
        Topic topic = createTopic();
        String name = "name";
        String newValue = "newValue";
        topic.addOrOverrideAttribute(name, "value");

        topic.addOrOverrideAttribute(name, newValue);

        assertEquals(topic.getAttributes().get(name), newValue);
    }

    private Post[] postList(int numberOfPosts, Topic topic) {
        Post[] posts = new Post[numberOfPosts];
        for (int i = 0; i < posts.length; i++) {
            posts[i] = new Post();
            topic.addPost(posts[i]);
        }
        return posts;
    }

    @Test
    public void isCodeReviewShouldReturnTrueIfTopicTypeIsCodeReview() {
        Topic topic = createTopic();
        topic.setType(TopicTypeName.CODE_REVIEW.getName());

        assertTrue(topic.isCodeReview());
    }

    @Test
    public void isCodeReviewShouldReturnFalseIfTopicTypeIsNotCodeReview() {
        Topic topic = createTopic();
        topic.setType(TopicTypeName.DISCUSSION.getName());

        assertFalse(topic.isCodeReview());
    }

    @Test
    public void isCodeReviewShouldReturnFalseIfTopicTypeNotSet() {
        Topic topic = createTopic();
        topic.setType(null);

        assertFalse(topic.isCodeReview());
    }

    @Test
    public void isPlugableShouldReturnFalseForDiscussion() {
        Topic topic = createTopic();
        topic.setType(TopicTypeName.DISCUSSION.getName());

        assertFalse(topic.isPlugable());
    }

    @Test
    public void isPlugableShouldReturnFalseForCodeReview() {
        Topic topic = createTopic();
        topic.setType(TopicTypeName.CODE_REVIEW.getName());

        assertFalse(topic.isPlugable());
    }

    @Test
    public void isPlugableShouldReturnTrueForUnknownTopicType() {
        Topic topic = createTopic();
        topic.setType("Any plugable");

        assertTrue(topic.isPlugable());
    }

    @Test
    public void isPlugableShouldReturnFalseIfTopicTypeNotSet() {
        Topic topic = createTopic();
        topic.setType(null);

        assertFalse(topic.isPlugable());
    }

	@Test
	public void testIsContainsOwnerPostsOnlyReturnsTrueIfOthersDidNotRespond() {
		Topic topic = createTopic();

		assertTrue(topic.getPosts().size() > 0);
		assertTrue(topic.isContainsOwnerPostsOnly());
	}

	@Test
	public void testIsContainsOwnerPostsOnlyReturnsFalseIfOthersHaveResponded() {
		Topic topic = createTopicWithOthersPosts();

		assertTrue(topic.getPosts().size() > 0);
		assertFalse(topic.isContainsOwnerPostsOnly());
	}

	@Test
	public void testIsContainsOwnerPostsOnlyReturnsTrueOnEmptyTopic() {
		Topic topic = createTopicWithOthersPosts();
		topic.setPosts(Collections.<Post>emptyList());

		assertTrue(topic.getPosts().size() == 0);
		assertTrue(topic.isContainsOwnerPostsOnly());
	}

    @Test
    public void getDraftForUserShouldReturnDraftOfSpecifiedUser() {
        Topic topic = new Topic();
        JCUser targetUser = new JCUser();
        PostDraft expected = new PostDraft("blahblah", targetUser);
        topic.addDraft(expected);
        topic.addDraft(new PostDraft("qwerr", new JCUser()));

        PostDraft actual = topic.getDraftForUser(targetUser);

        assertEquals(actual, expected);
    }

    @Test
    public void getDraftForUserShouldReturnNullIfDraftNotFound() {
        Topic topic = new Topic();

        PostDraft draft = topic.getDraftForUser(new JCUser());

        assertNull(draft);
    }

    @Test
    public void getUserPostCountTest() {
        JCUser user = new JCUser();
        Topic topic = new Topic();
        topic.addPost(new Post(user, ""));

        assertEquals(topic.getUserPostCount(user), 1);
    }

    @Test
    public void getUserPostCountShouldReturnZeroIfUserNotPosted() {
        Topic topic = new Topic();

        assertEquals(topic.getUserPostCount(new JCUser()), 0);
    }

    @Test
    public void getUserPostCountShouldReturnZeroIfOnlyOthersPosted() {
        Topic topic = new Topic();
        topic.addPost(new Post(new JCUser(), ""));

        assertEquals(topic.getUserPostCount(new JCUser()), 0);
    }

    @Test
    public void getUserPostCountTestMoreThanOneUserPosted() {
        Topic topic = new Topic();
        topic.addPost(new Post(new JCUser(), ""));
        JCUser user = new JCUser();
        topic.addPost(new Post(user, ""));
        topic.addPost(new Post(user, ""));

        assertEquals(topic.getUserPostCount(user), 2);
    }

    @Test
    public void testGetUnsubscribeLinkForSubscribersOfPostShouldReturnTopicUnsubscribeLink()
    {
        Topic topic = new Topic();
        topic.setId(1);

        assertEquals(topic.getUnsubscribeLinkForSubscribersOf(Post.class), "/topics/1/unsubscribe");
    }

    /**
     * Case for hibernate proxies
     */
    @Test
    public void getUnsubscribeLinkForSubscribersOfPostSubclassShouldReturnTopicUnsubscribeLink()
    {
        class PostSubClass extends Post {
        }
        Topic topic = new Topic();
        topic.setId(1);

        assertEquals(topic.getUnsubscribeLinkForSubscribersOf(PostSubClass.class), "/topics/1/unsubscribe");
    }



    @Test
    public void getUnsubscribeLinkForSubscribersOfTopicShouldReturnTopicUnsubscribeLink()
    {
        Topic topic = new Topic();
        topic.setId(1);

        assertEquals(topic.getUnsubscribeLinkForSubscribersOf(Topic.class), "/topics/1/unsubscribe");
    }


    /**
     * Case for hibernate proxies
     */
    @Test
    public void getUnsubscribeLinkForSubscribersOfTopicSubclassShouldReturnTopicUnsubscribeLink() {
        class TopicSubClass extends Topic {
        }
        Topic topic = new Topic();
        topic.setId(1);

        assertEquals(topic.getUnsubscribeLinkForSubscribersOf(TopicSubClass.class), "/topics/1/unsubscribe");
    }


    @Test
    public void getUnsubscribeLinkForSubscribersOfBranchShouldReturnBranchUnsubscribeLink() {
        Topic topic = new Topic();
        Branch branch = new Branch();
        branch.setId(1);
        topic.setBranch(branch);

        assertEquals(topic.getUnsubscribeLinkForSubscribersOf(Branch.class), "/branches/1/unsubscribe");
    }

    /**
     * Case for hibernate proxies
     */
    @Test
    public void getUnsubscribeLinkForSubscribersOfBranchSubclassShouldReturnBranchUnsubscribeLink() {
        class BranchSubClass extends Branch {
        }
        Topic topic = new Topic();
        Branch branch = new Branch();
        branch.setId(1);
        topic.setBranch(branch);

        assertEquals(topic.getUnsubscribeLinkForSubscribersOf(BranchSubClass.class), "/branches/1/unsubscribe");
    }

    @Test
    public void markAsReadUrlIsEmptyForAnonymousUser() throws Exception {
        Optional<String> markAsReadUrl = createTopic().getMarkAsReadUrl(new AnonymousUser(), "2");
        assertFalse(markAsReadUrl.isPresent(), "URL should be absent for anonymous user");
    }

    @Test
    public void markAsReadUrlPresentsForNonAnonymousUser() throws Exception {
        Optional<String> markAsReadUrl = createTopic().getMarkAsReadUrl(new JCUser(), "2");
        assertTrue(markAsReadUrl.isPresent(), "URL should be present for authorized user");
    }

    @Test
    public void markAsReadUrlContainsTopicIdAndPageNumberInPath() throws Exception {
        Optional<String> markAsReadUrl = createTopic().getMarkAsReadUrl(new JCUser(), "2");
        String url = markAsReadUrl.get();
        assertTrue(url.startsWith("0/page/2/markread"), "URL should contain topicId and page");
    }

    @Test
    public void markAsReadUrlContainsUserIdAsQueryParams() throws Exception {
        Optional<String> markAsReadUrl = createTopic().getMarkAsReadUrl(new JCUser(), "2");
        String url = markAsReadUrl.get();
        assertTrue(url.contains("userId=0"), "URL should have userId param");
    }

    @Test
    public void markAsReadUrlContainsLastModifiedAsQueryParams() throws Exception {
        Topic topic = createTopic();
        DateTime lastModificationPostDate = topic.getLastModificationPostDate();
        Optional<String> markAsReadUrl = topic.getMarkAsReadUrl(new JCUser(), "2");
        String url = markAsReadUrl.get();
        assertTrue(url.endsWith("lastModified=" + lastModificationPostDate.getMillis()), "URL should have lastModified param");
    }


    private Topic createTopic() {
		JCUser topicStarter = new JCUser();

        Post post1 = new Post(topicStarter, "Post N1 for tests");
        post1.setCreationDate(new DateTime());
		Post post2 = new Post(topicStarter, "Post N2 for tests");
		post2.setCreationDate(new DateTime());

        Topic topic = new Topic(topicStarter, "Topic title for testing");
        topic.addPost(post1);
        topic.addPost(post2);

        return topic;
    }

	private Topic createTopicWithOthersPosts() {
		JCUser topicStarter = new JCUser();
		JCUser otherUser = new JCUser();

		Post post1 = new Post(topicStarter, "Post N1 by topic starter");
		post1.setCreationDate(new DateTime());
		Post post2 = new Post(otherUser, "Post N2 by other user");
		post2.setCreationDate(new DateTime());

		Topic topic = new Topic(topicStarter, "Topic title for testing");
		topic.addPost(post1);
		topic.addPost(post2);

		return topic;
	}
}