Zurmo: /home/apizurmo/zurmo/app/protected/modules/notifications/tests/unit/NotificationSubscriberUtilTest.php Source File

00001 <?php
00002     /*********************************************************************************
00003      * Zurmo is a customer relationship management program developed by
00004      * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
00005      *
00006      * Zurmo is free software; you can redistribute it and/or modify it under
00007      * the terms of the GNU Affero General Public License version 3 as published by the
00008      * Free Software Foundation with the addition of the following permission added
00009      * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
00010      * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
00011      * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
00012      *
00013      * Zurmo is distributed in the hope that it will be useful, but WITHOUT
00014      * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00015      * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
00016      * details.
00017      *
00018      * You should have received a copy of the GNU Affero General Public License along with
00019      * this program; if not, see http://www.gnu.org/licenses or write to the Free
00020      * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00021      * 02110-1301 USA.
00022      *
00023      * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
00024      * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
00025      *
00026      * The interactive user interfaces in original and modified versions
00027      * of this program must display Appropriate Legal Notices, as required under
00028      * Section 5 of the GNU Affero General Public License version 3.
00029      *
00030      * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
00031      * these Appropriate Legal Notices must retain the display of the Zurmo
00032      * logo and Zurmo copyright notice. If the display of the logo is not reasonably
00033      * feasible for technical reasons, the Appropriate Legal Notices must display the words
00034      * "Copyright Zurmo Inc. 2017. All rights reserved".
00035      ********************************************************************************/
00036 
00037     class NotificationSubscriberUtilTest extends ZurmoBaseTest
00038     {
00039         public static function setUpBeforeClass()
00040         {
00041             parent::setUpBeforeClass();
00042             SecurityTestHelper::createSuperAdmin();
00043             $super = User::getByUsername('super');
00044             Yii::app()->user->userModel = $super;
00045             $user                   = UserTestHelper::createBasicUser('Tilly');
00046             TaskTestHelper::createTaskByNameForOwner('My Task', $super);
00047             AccountTestHelper::createAccountByNameForOwner('anAccount', $super);
00048         }
00049 
00050         public function setUp()
00051         {
00052             parent::setUp();
00053             Yii::app()->user->userModel = User::getByUsername('super');
00054         }
00055 
00059         public function testMarkUserHasReadLatest()
00060         {
00061             $super                     = User::getByUsername('super');
00062             $steven                    = UserTestHelper::createBasicUser('steven');
00063 
00064             $task = new Task();
00065             $task->name = 'MyTest';
00066             $nowStamp = DateTimeUtil::convertTimestampToDbFormatDateTime(time());
00067             $this->assertTrue($task->save());
00068 
00069             $task = Task::getById($task->id);
00070             $user = Yii::app()->user->userModel;
00071             $notificationSubscriber = new NotificationSubscriber();
00072             $notificationSubscriber->person = $steven;
00073             $notificationSubscriber->hasReadLatest = false;
00074             $task->notificationSubscribers->add($notificationSubscriber);
00075             $this->assertTrue($task->save());
00076 
00077             $id = $task->id;
00078             $task->forget();
00079             unset($task);
00080 
00081             $task = Task::getById($id);
00082             $this->assertEquals(0, $task->notificationSubscribers->offsetGet(0)->hasReadLatest);
00083             $this->assertEquals(0, $task->notificationSubscribers->offsetGet(1)->hasReadLatest);
00084             //After running for super, nothing will change.
00085             NotificationSubscriberUtil::markUserHasReadLatest($task, $steven);
00086             NotificationSubscriberUtil::markUserHasReadLatest($task, $super);
00087             $id = $task->id;
00088             $task->forget();
00089             unset($task);
00090 
00091             $task = Task::getById($id);
00092             foreach ($task->notificationSubscribers as $position => $subscriber)
00093             {
00094                 $this->assertEquals(1, $subscriber->hasReadLatest);
00095             }
00096         }
00097 
00102         public function testGetSubscriberData()
00103         {
00104             $user  = User::getByUsername('steven');
00105 
00106             $tasks  = Task::getByName('MyTest');
00107             $task   = $tasks[0];
00108 
00109             $content = NotificationSubscriberUtil::getSubscriberData($task);
00110             $this->assertContains('gravatar', $content);
00111             $this->assertContains('users/default/details', $content);
00112         }
00113 
00117         public function testGetSubscribers()
00118         {
00119             $user  = User::getByUsername('steven');
00120 
00121             $tasks  = Task::getByName('MyTest');
00122             $task   = $tasks[0];
00123 
00124             $subscribers = NotificationSubscriberUtil::getModelSubscribers($task);
00125             $found = false;
00126             foreach ($subscribers as $subscriber)
00127             {
00128                 if ($subscriber->id == $user->id)
00129                 {
00130                     $found = true;
00131                 }
00132             }
00133             $this->assertTrue($found);
00134         }
00135 
00139         public function testResolveSubscriptionLink()
00140         {
00141             $tasks  = Task::getByName('MyTest');
00142             $task   = $tasks[0];
00143             $sally  = UserTestHelper::createBasicUser('sally');
00144             $maggi  = UserTestHelper::createBasicUser('maggi');
00145             $task->owner = $sally;
00146             $task->requestedByUser = $maggi;
00147             $task->save();
00148             if (NotificationSubscriberUtil::doNotificationSubscribersContainPerson($task, Yii::app()->user->userModel) === false)
00149             {
00150                 $notificationSubscriber = new NotificationSubscriber();
00151                 $notificationSubscriber->person = Yii::app()->user->userModel;
00152                 $task->notificationSubscribers->add($notificationSubscriber);
00153                 $task->save();
00154             }
00155             $link = NotificationSubscriberUtil::getKanbanSubscriptionLink($task, 0);
00156             $this->assertContains('unsubscribe-model-link', $link);
00157             $modelDerivationPathToItem = RuntimeUtil::getModelDerivationPathToItem('User');
00158             foreach ($task->notificationSubscribers as $notificationSubscriber)
00159             {
00160                 $user = $notificationSubscriber->person->castDown(array($modelDerivationPathToItem));
00161                 if ($user->id == Yii::app()->user->userModel->id)
00162                 {
00163                     $task->notificationSubscribers->remove($notificationSubscriber);
00164                 }
00165             }
00166             $task->save();
00167             $link = NotificationSubscriberUtil::getKanbanSubscriptionLink($task, 0);
00168             $this->assertContains('subscribe-model-link', $link);
00169         }
00170 
00174         public function testResolveDetailSubscriptionLink()
00175         {
00176             $tasks  = Task::getByName('MyTest');
00177             $task   = $tasks[0];
00178             if (NotificationSubscriberUtil::doNotificationSubscribersContainPerson($task, Yii::app()->user->userModel) === false)
00179             {
00180                 $notificationSubscriber = new NotificationSubscriber();
00181                 $notificationSubscriber->person = Yii::app()->user->userModel;
00182                 $task->notificationSubscribers->add($notificationSubscriber);
00183                 $task->save();
00184             }
00185             $link = NotificationSubscriberUtil::getDetailSubscriptionLink($task, 0);
00186             $this->assertContains('detail-unsubscribe-model-link', $link);
00187             $modelDerivationPathToItem = RuntimeUtil::getModelDerivationPathToItem('User');
00188             foreach ($task->notificationSubscribers as $index => $notificationSubscriber)
00189             {
00190                 $user = $notificationSubscriber->person->castDown(array($modelDerivationPathToItem));
00191                 if ($user->id == Yii::app()->user->userModel->id)
00192                 {
00193                     $task->notificationSubscribers->remove($notificationSubscriber);
00194                 }
00195             }
00196             $task->save();
00197             $link = NotificationSubscriberUtil::getDetailSubscriptionLink($task, 0);
00198             $this->assertContains('detail-subscribe-model-link', $link);
00199         }
00200 
00204         public function testAddSubscriberToModel()
00205         {
00206             Yii::app()->user->userModel = User::getByUsername('super');
00207             $user = User::getByUsername('tilly');
00208             $task = new Task();
00209             $task->name = 'MyTest';
00210             $task->owner = $user;
00211             $nowStamp = DateTimeUtil::convertTimestampToDbFormatDateTime(time());
00212             $this->assertTrue($task->save());
00213             $this->assertEquals($user, $task->owner);
00214 
00215             //There would be two here as default subscribers are added
00216             $this->assertEquals(2, count($task->notificationSubscribers));
00217             $user = Yii::app()->user->userModel;
00218             NotificationSubscriberUtil::addSubscriber($user, $task);
00219             $task->save();
00220             $this->assertEquals(2, count($task->notificationSubscribers));
00221         }
00222 
00226         public function testResolveAndRenderTaskCardDetailsSubscribersContent()
00227         {
00228             $hellodear      = UserTestHelper::createBasicUser('hellodear');
00229             $task           = new Task();
00230             $task->name     = 'MyCardTest';
00231             $task->owner    = $hellodear;
00232             $this->assertTrue($task->save());
00233 
00234             $task = Task::getById($task->id);
00235             $user = Yii::app()->user->userModel;
00236             NotificationSubscriberUtil::addSubscriber($hellodear, $task);
00237             $this->assertTrue($task->save());
00238             $content = NotificationSubscriberUtil::resolveAndRenderTaskCardDetailsSubscribersContent($task);
00239             $this->assertContains('gravatar', $content);
00240             $this->assertContains('users/default/details', $content);
00241             $this->assertContains('hellodear', $content);
00242             $this->assertContains('task-owner', $content);
00243         }
00244 
00248         public function testProcessSubscriptionRequest()
00249         {
00250             $modelDerivationPathToItem = RuntimeUtil::getModelDerivationPathToItem('User');
00251 
00252             $mark                   = UserTestHelper::createBasicUser('mark');
00253             $jim                    = UserTestHelper::createBasicUser('jim');
00254 
00255             $task = TaskTestHelper::createTaskByNameForOwner('SubTask', Yii::app()->user->userModel);
00256             $this->assertEquals(1, count($task->notificationSubscribers));
00257             $subscribedUser = $task->notificationSubscribers[0]->person->castDown(array($modelDerivationPathToItem));
00258             $this->assertEquals(Yii::app()->user->userModel->id, $subscribedUser->id);
00259 
00260             $task = NotificationSubscriberUtil::processSubscriptionRequest($task, $mark);
00261             $this->assertEquals(2, count($task->notificationSubscribers));
00262             $subscribedUser1 = $task->notificationSubscribers[0]->person->castDown(array($modelDerivationPathToItem));
00263             $subscribedUser2 = $task->notificationSubscribers[1]->person->castDown(array($modelDerivationPathToItem));
00264             $this->assertTrue(in_array(Yii::app()->user->userModel->id, array($subscribedUser1->id, $subscribedUser2->id)));
00265             $this->assertTrue(in_array($mark->id, array($subscribedUser1->id, $subscribedUser2->id)));
00266 
00267             $task = NotificationSubscriberUtil::processSubscriptionRequest($task, $jim);
00268             $this->assertEquals(3, count($task->notificationSubscribers));
00269             $subscribedUser1 = $task->notificationSubscribers[0]->person->castDown(array($modelDerivationPathToItem));
00270             $subscribedUser2 = $task->notificationSubscribers[1]->person->castDown(array($modelDerivationPathToItem));
00271             $subscribedUser3 = $task->notificationSubscribers[2]->person->castDown(array($modelDerivationPathToItem));
00272             $this->assertTrue(in_array(Yii::app()->user->userModel->id, array($subscribedUser1->id, $subscribedUser2->id, $subscribedUser3->id)));
00273             $this->assertTrue(in_array($mark->id, array($subscribedUser1->id, $subscribedUser2->id, $subscribedUser3->id)));
00274             $this->assertTrue(in_array($jim->id, array($subscribedUser1->id, $subscribedUser2->id, $subscribedUser3->id)));
00275         }
00276 
00281         public function testProcessUnsubscriptionRequest()
00282         {
00283             $modelDerivationPathToItem = RuntimeUtil::getModelDerivationPathToItem('User');
00284 
00285             $maria                   = UserTestHelper::createBasicUser('maria');
00286             $john                    = UserTestHelper::createBasicUser('john');
00287 
00288             $task = TaskTestHelper::createTaskByNameForOwner('SubTask2', Yii::app()->user->userModel);
00289             $task = NotificationSubscriberUtil::processSubscriptionRequest($task, $maria);
00290             $task = NotificationSubscriberUtil::processSubscriptionRequest($task, $john);
00291             // Just check number of subscribed users, checking if their ids are done in testProcessTaskSubscriptionRequest
00292             $this->assertEquals(3, count($task->notificationSubscribers));
00293 
00294             $task = NotificationSubscriberUtil::processUnsubscriptionRequest($task, $maria);
00295             $this->assertEquals(2, count($task->notificationSubscribers));
00296             $subscribedUser1 = $task->notificationSubscribers[0]->person->castDown(array($modelDerivationPathToItem));
00297             $subscribedUser2 = $task->notificationSubscribers[1]->person->castDown(array($modelDerivationPathToItem));
00298             $this->assertTrue(in_array(Yii::app()->user->userModel->id, array($subscribedUser1->id, $subscribedUser2->id)));
00299             $this->assertTrue(in_array($john->id, array($subscribedUser1->id, $subscribedUser2->id)));
00300 
00301             $task = NotificationSubscriberUtil::processUnsubscriptionRequest($task, $john);
00302             $this->assertEquals(1, count($task->notificationSubscribers));
00303             $subscribedUser = $task->notificationSubscribers[0]->person->castDown(array($modelDerivationPathToItem));
00304             $this->assertEquals(Yii::app()->user->userModel->id, $subscribedUser->id);
00305         }
00306     }
00307 ?>