tests/include/utils/Bug46122Test.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38 require_once('include/utils/LogicHook.php');
  39 require_once('include/MVC/View/SugarView.php');
  40
  41 class Bug46122Test extends Sugar_PHPUnit_Framework_TestCase
  42 {
  43     var $hasCustomModulesLogicHookFile = false;
  44     var $hasCustomContactLogicHookFile = false;
  45     var $modulesHookFile = 'custom/modules/logic_hooks.php';
  46     var $contactsHookFile = 'custom/modules/Contacts/logic_hooks.php';
  47
  48     public function setUp()
  49     {
  50         //Setup mock logic hook files
  51         if(file_exists($this->modulesHookFile))
  52         {
  53             $this->hasCustomModulesLogicHookFile = true;
  54             copy($this->modulesHookFile, $this->modulesHookFile.'.bak');
  55         } else {
  56             write_array_to_file("test", array(), $this->modulesHookFile);
  57         }
  58
  59         if(file_exists($this->contactsHookFile))
  60         {
  61             $this->hasCustomContactLogicHookFile = true;
  62             copy($this->contactsHookFile, $this->contactsHookFile.'.bak');
  63         } else {
  64             write_array_to_file("test", array(), $this->contactsHookFile);
  65         }
  66
  67         $this->useOutputBuffering = false;
  68         LogicHook::refreshHooks();
  69     }
  70
  71     public function tearDown()
  72     {
  73         //Remove the custom logic hook files
  74         if($this->hasCustomModulesLogicHookFile && file_exists($this->modulesHookFile.'.bak'))
  75         {
  76             copy($this->modulesHookFile.'.bak', $this->modulesHookFile);
  77             unlink($this->modulesHookFile.'.bak');
  78         } else if(file_exists($this->modulesHookFile)) {
  79             unlink($this->modulesHookFile);
  80         }
  81
  82         if($this->hasCustomContactLogicHookFile && file_exists($this->contactsHookFile.'.bak'))
  83         {
  84             copy($this->contactsHookFile.'.bak', $this->contactsHookFile);
  85             unlink($this->contactsHookFile.'.bak');
  86         } else if(file_exists($this->contactsHookFile)) {
  87             unlink($this->contactsHookFile);
  88         }
  89         unset($GLOBALS['logic_hook']);
  90     }
  91
  92     public function testSugarViewProcessLogicHookWithModule()
  93     {
  94         $GLOBALS['logic_hook'] = new LogicHookMock();
  95         $hooks = $GLOBALS['logic_hook']->getHooks('Contacts');
  96         $sugarViewMock = new Bug46122TestSugarViewMock();
  97         $sugarViewMock->module = 'Contacts';
  98         $sugarViewMock->process();
  99         $expectedHookCount = isset($hooks['after_ui_frame']) ? count($hooks['after_ui_frame']) : 0;
 100         $this->assertEquals($expectedHookCount, $GLOBALS['logic_hook']->hookRunCount, 'Assert that two logic hook files were run');
 101     }
 102
 103
 104     public function testSugarViewProcessLogicHookWithoutModule()
 105     {
 106         $GLOBALS['logic_hook'] = new LogicHookMock();
 107         $hooks = $GLOBALS['logic_hook']->getHooks('');
 108         $sugarViewMock = new Bug46122TestSugarViewMock();
 109         $sugarViewMock->module = '';
 110         $sugarViewMock->process();
 111         $expectedHookCount = isset($hooks['after_ui_frame']) ? count($hooks['after_ui_frame']) : 0;
 112         $this->assertEquals($expectedHookCount, $GLOBALS['logic_hook']->hookRunCount, 'Assert that one logic hook file was run');
 113     }
 114 }
 115
 116 class Bug46122TestSugarViewMock extends SugarView
 117 {
 118     var $options = array();
 119     //no-opt methods we override
 120     function _trackView() {}
 121     function renderJavascript() {}
 122     function _buildModuleList() {}
 123     function preDisplay() {}
 124     function displayErrors() {}
 125     function display() {}
 126 }
 127
 128 class LogicHookMock extends LogicHook
 129 {
 130     var $hookRunCount = 0;
 131
 132     function process_hooks($hook_array, $event, $arguments)
 133     {
 134         if(!empty($hook_array[$event])){
 135             if($event == 'after_ui_frame')
 136             {
 137                 $this->hookRunCount++;
 138             }
 139         }
 140     }
 141 }
 142
 143 ?>