ConversationTest.php

<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo 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 Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2017. All rights reserved".
     ********************************************************************************/

    class ConversationTest extends ZurmoBaseTest
    {
        public static function setUpBeforeClass()
        {
            parent::setUpBeforeClass();
            SecurityTestHelper::createSuperAdmin();
            $super = User::getByUsername('super');
            Yii::app()->user->userModel = $super;
            AccountTestHelper::createAccountByNameForOwner('anAccount', $super);
        }

        public function setUp()
        {
            parent::setUp();
            Yii::app()->user->userModel = User::getByUsername('super');
        }

        public function testCreateAndGetConversationById()
        {
            $super                     = User::getByUsername('super');
            $fileModel                 = ZurmoTestHelper::createFileModel();
            $accounts                  = Account::getByName('anAccount');
            $steven                    = UserTestHelper::createBasicUser('steven');

            $conversation              = new Conversation();
            $conversation->owner       = $super;
            $conversation->subject     = 'My test subject';
            $conversation->description = 'My test description';
            $conversation->conversationItems->add($accounts[0]);
            $conversation->files->add($fileModel);
            $this->assertTrue($conversation->save());

            $explicitReadWriteModelPermissions = ExplicitReadWriteModelPermissionsUtil::
                                                 makeBySecurableItem($conversation);
            $postData = array();
            $postData['itemIds'] = $steven->getClassId('Item');
            ConversationParticipantsUtil::resolveConversationHasManyParticipantsFromPost(
                                            $conversation, $postData, $explicitReadWriteModelPermissions);
            $this->assertTrue($conversation->save());
            $success = ExplicitReadWriteModelPermissionsUtil::
                        resolveExplicitReadWriteModelPermissions($conversation, $explicitReadWriteModelPermissions);
            $this->assertTrue($success);

            $id = $conversation->id;
            $conversation->forget();
            unset($conversation);

            $conversation = Conversation::getById($id);
            $this->assertEquals('My test subject',                $conversation->subject);
            $this->assertEquals('My test description',            $conversation->description);
            $this->assertEquals($super,                           $conversation->owner);
            $this->assertEquals(1,                                $conversation->conversationItems->count());
            $this->assertEquals($accounts[0]->getClassId('Item'), $conversation->conversationItems->offsetGet(0)->id);
            $this->assertEquals(1,                                $conversation->files->count());
            $this->assertEquals($fileModel,                       $conversation->files->offsetGet(0));
            $this->assertEquals(1,                                $conversation->conversationParticipants->count());
            $this->assertEquals($steven,                          $conversation->conversationParticipants->offsetGet(0)->person);
            $this->assertEquals(1,                                $conversation->ownerHasReadLatest);

            //Clear conversation so permissions take properly.  Needed because we don't have changes between page loads.
            $id = $conversation->id;
            $conversation->forget();
            unset($conversation);

            //At this point there should be one readWritePermitable.  "Steven"
            $conversation = Conversation::getById($id);
            $explicitReadWriteModelPermissions = ExplicitReadWriteModelPermissionsUtil::
                                                 makeBySecurableItem($conversation);
            $readWritePermitables              = $explicitReadWriteModelPermissions->getReadWritePermitables();
            $this->assertEquals(1, count($readWritePermitables));
            $this->assertEquals($steven, $readWritePermitables[$steven->getClassId('Permitable')]);
            $this->assertEquals(1, $conversation->conversationParticipants->count());
            $this->assertEquals($steven, $conversation->conversationParticipants[0]->person);
        }

        public function testAddingComments()
        {
            $conversations = Conversation::getAll();
            $this->assertEquals(1, count($conversations));
            $conversation  = $conversations[0];
            $steven        = User::getByUserName('steven');
            $latestStamp   = $conversation->latestDateTime;

            //latestDateTime should not change when just saving the conversation
            $conversation->conversationParticipants->offsetGet(0)->hasReadLatest = true;
            $conversation->ownerHasReadLatest                                    = true;
            $this->assertTrue($conversation->save());
            $this->assertEquals($latestStamp, $conversation->latestDateTime);
            $this->assertEquals(1, $conversation->ownerHasReadLatest);

            sleep(2); // Sleeps are bad in tests, but I need some time to pass

            //Add comment, this should update the latestDateTime,
            //and also it should reset hasReadLatest on conversation participants
            $comment              = new Comment();
            $comment->description = 'This is my first comment';
            $conversation->comments->add($comment);
            $this->assertTrue($conversation->save());
            $this->assertNotEquals($latestStamp, $conversation->latestDateTime);
            $this->assertEquals(0, $conversation->conversationParticipants->offsetGet(0)->hasReadLatest);
            //super made the comment, so this should remain the same.
            $this->assertEquals(1, $conversation->ownerHasReadLatest);

            //set it to read latest
            $conversation->conversationParticipants->offsetGet(0)->hasReadLatest = true;
            $this->assertTrue($conversation->save());
            $this->assertEquals(1, $conversation->conversationParticipants->offsetGet(0)->hasReadLatest);

            //have steven make the comment. Now the ownerHasReadLatest should set to false, and hasReadLatest should remain true
            Yii::app()->user->userModel = $steven;
            $conversation               = Conversation::getById($conversation->id);
            $comment                    = new Comment();
            $comment->description       = 'This is steven`\s first comment';
            $conversation->comments->add($comment);
            $this->assertTrue($conversation->save());
            $this->assertEquals(1, $conversation->conversationParticipants->offsetGet(0)->hasReadLatest);
            $this->assertEquals(0, $conversation->ownerHasReadLatest);
        }

        public function testResolveConversationParticipantsForExplicitModelPermissions()
        {
            $super                     = User::getByUsername('super');
            $steven                    = User::getByUsername('steven');
            $sally                     = UserTestHelper::createBasicUser('sally');
            $mary                      = UserTestHelper::createBasicUser('mary');

            $conversation              = new Conversation();
            $conversation->owner       = $super;
            $conversation->subject     = 'My test subject2';
            $conversation->description = 'My test description2';
            $this->assertTrue($conversation->save());

            //Set explicitPermissions. Should not add any at this point
            $explicitReadWriteModelPermissions = ExplicitReadWriteModelPermissionsUtil::
                                                 makeBySecurableItem($conversation);
            $readWritePermitables              = $explicitReadWriteModelPermissions->getReadWritePermitables();
            $this->assertEquals(0, count($readWritePermitables));

            //Attempt to resolve against posted conversationParticipants data
            $postData = array();
            $postData['itemIds'] = $super->getClassId('Item');
            ConversationParticipantsUtil::resolveConversationHasManyParticipantsFromPost(
                                            $conversation, $postData, $explicitReadWriteModelPermissions);
            //Should still be 0, because super is the owner, and would not be specially added. (This is just a safety test here)
            $readWritePermitables              = $explicitReadWriteModelPermissions->getReadWritePermitables();
            $this->assertEquals(0, count($readWritePermitables));
            $this->assertEquals(0, $conversation->conversationParticipants->count());

            //Add steven as a conversation participant.
            $postData = array();
            $postData['itemIds'] = $super->getClassId('Item') . ',' . $steven->getClassId('Item'); // Not Coding Standard
            ConversationParticipantsUtil::resolveConversationHasManyParticipantsFromPost($conversation,
                                                                                         $postData,
                                                                                         $explicitReadWriteModelPermissions);
            $this->assertTrue($conversation->save());
            $success = ExplicitReadWriteModelPermissionsUtil::
                        resolveExplicitReadWriteModelPermissions($conversation, $explicitReadWriteModelPermissions);
            $this->assertTrue($success);

            //At this point there should be one readWritePermitable.  "Steven"
            $explicitReadWriteModelPermissions = ExplicitReadWriteModelPermissionsUtil::
                                                 makeBySecurableItem($conversation);
            $readWritePermitables              = $explicitReadWriteModelPermissions->getReadWritePermitables();
            $this->assertEquals(1, count($readWritePermitables));
            $this->assertEquals($steven, $readWritePermitables[$steven->getClassId('Permitable')]);
            $this->assertEquals(1, $conversation->conversationParticipants->count());
            $this->assertEquals($steven, $conversation->conversationParticipants[0]->person);
        }

        public function testGetUnreadConversationCount()
        {
            $super                     = User::getByUsername('super');
            $mary                      = User::getByUsername('mary');
            $count                     = Conversation::getUnreadCountByUser($super);
            $account2                  = AccountTestHelper::createAccountByNameForOwner('anAccount2', $super);

            $conversation              = new Conversation();
            $conversation->owner       = $super;
            $conversation->subject     = 'My test subject2';
            $conversation->description = 'My test description2';
            $conversation->conversationItems->add($account2);
            $this->assertTrue($conversation->save());

            //when super adds a comment, it should remain same count
            $comment                   = new Comment();
            $comment->description      = 'This is my first comment';
            $conversation->comments->add($comment);
            $this->assertTrue($conversation->save());
            $count                     = Conversation::getUnreadCountByUser($super);
            $this->assertEquals(1, $count);

            //Add mary as a participant
            $explicitReadWriteModelPermissions = ExplicitReadWriteModelPermissionsUtil::
                                                 makeBySecurableItem($conversation);
            $postData            = array();
            $postData['itemIds'] = $super->getClassId('Item') . ',' . $mary->getClassId('Item'); // Not Coding Standard
            ConversationParticipantsUtil::resolveConversationHasManyParticipantsFromPost($conversation,
                                                                                         $postData,
                                                                                         $explicitReadWriteModelPermissions);
            $success              = ExplicitReadWriteModelPermissionsUtil::
                                        resolveExplicitReadWriteModelPermissions($conversation,
                                                                                 $explicitReadWriteModelPermissions);
            $this->assertTrue($success);
            $conversation->save();

            //when mary adds a comment, super's count should go up (assumming count was previously 0)
            Yii::app()->user->userModel = $mary;
            $comment                    = new Comment();
            $comment->description       = 'This is mary\'s first comment';
            $conversation->comments->add($comment);
            $this->assertTrue($conversation->save());
            Yii::app()->user->userModel = $super;
            $count                      = Conversation::getUnreadCountByUser($super);
            $this->assertEquals(2, $count);
        }

        public function testDeleteConversation()
        {
            $conversations = Conversation::getAll();
            $this->assertEquals(3, count($conversations));
            $comments = Comment::getAll();
            $this->assertEquals(4, count($comments));

            //check count of conversation_items
            $count   = ZurmoRedBean::getRow('select count(*) count from conversation_item');
            $this->assertEquals(2, $count['count']);

            //remove the account, tests tthat ConversationObserver is correctly removing data from conversation_item
            $accounts                  = Account::getByName('anAccount2');
            $this->assertTrue($accounts[0]->delete());

            $count   = ZurmoRedBean::getRow('select count(*) count from conversation_item');
            $this->assertEquals(1, $count['count']);

            foreach ($conversations as $conversation)
            {
                $conversationId = $conversation->id;
                $conversation->forget();
                $conversation   = Conversation::getById($conversationId);
                $deleted        = $conversation->delete();
                $this->assertTrue($deleted);
            }

            //Count of conversation items should be 0 since the ConversationsObserver should make sure it gets removed correctly.
            $count   = ZurmoRedBean::getRow('select count(*) count from conversation_item');
            $this->assertEquals(0, $count['count']);

            //check that all comments are removed, since they are owned.
            $comments = Comment::getAll();
            $this->assertEquals(0, count($comments));
        }
    }
?>