tests/data/SugarBeanTest.php

   1 <?php
   2
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 require_once('include/SugarObjects/templates/file/File.php');
  40
  41 class SugarBeanTest extends Sugar_PHPUnit_Framework_TestCase
  42 {
  43
  44     public static function setUpBeforeClass()
  45     {
  46         $GLOBALS['current_user'] = SugarTestUserUtilities::createAnonymousUser();
  47         }
  48
  49     public function setUp()
  50     {
  51         SugarTestHelper::setUp('beanFiles');
  52         SugarTestHelper::setUp('beanList');
  53     }
  54
  55     public function tearDown()
  56     {
  57         SugarTestHelper::tearDown();
  58     }
  59
  60         public static function tearDownAfterClass()
  61         {
  62             SugarTestUserUtilities::removeAllCreatedAnonymousUsers();
  63         unset($GLOBALS['current_user']);
  64         }
  65
  66     public function testGetObjectName(){
  67         $bean = new BeanMockTestObjectName();
  68         $this->assertEquals($bean->getObjectName(), 'my_table', "SugarBean->getObjectName() is not returning the table name when object_name is empty.");
  69     }
  70
  71     public function testGetAuditTableName(){
  72         $bean = new BeanMockTestObjectName();
  73         $this->assertEquals($bean->get_audit_table_name(), 'my_table_audit', "SugarBean->get_audit_table_name() is not returning the correct audit table name.");
  74     }
  75
  76     /**
  77      * @ticket 47261
  78      */
  79     public function testGetCustomTableName()
  80     {
  81         $bean = new BeanMockTestObjectName();
  82         $this->assertEquals($bean->get_custom_table_name(), 'my_table_cstm', "SugarBean->get_custom_table_name() is not returning the correct custom table name.");
  83     }
  84
  85     public function testRetrieveQuoting()
  86     {
  87         $bean = new BeanMockTestObjectName();
  88         $bean->db = new MockMysqlDb();
  89         $bean->retrieve("bad'idstring");
  90         $this->assertNotContains("bad'id", $bean->db->lastQuery);
  91         $this->assertContains("bad", $bean->db->lastQuery);
  92         $this->assertContains("idstring", $bean->db->lastQuery);
  93     }
  94
  95     public function testRetrieveStringQuoting()
  96     {
  97         $bean = new BeanMockTestObjectName();
  98         $bean->db = new MockMysqlDb();
  99         $bean->retrieve_by_string_fields(array("test1" => "bad'string", "evil'key" => "data", 'tricky-(select * from config)' => 'test'));
 100         $this->assertNotContains("bad'string", $bean->db->lastQuery);
 101         $this->assertNotContains("evil'key", $bean->db->lastQuery);
 102         $this->assertNotContains("select * from config", $bean->db->lastQuery);
 103     }
 104
 105
 106
 107
 108     /**
 109      * Test to make sure that when a bean is cloned it removes all loaded relationships so they can be recreated on
 110      * the cloned copy if they are called.
 111      *
 112      * @group 51630
 113      * @return void
 114      */
 115     public function testCloneBeanDoesntKeepRelationship()
 116     {
 117         $account = SugarTestAccountUtilities::createAccount();
 118
 119         $account->load_relationship('contacts');
 120
 121         // lets make sure the relationship is loaded
 122         $this->assertTrue(isset($account->contacts));
 123
 124         $clone_account = clone $account;
 125
 126         // lets make sure that the relationship is not on the cloned record
 127         $this->assertFalse(isset($clone_account->contacts));
 128
 129         SugarTestAccountUtilities::removeAllCreatedAccounts();
 130     }
 131
 132     /**
 133      * Test whether a relate field is determined correctly
 134      *
 135      * @param array $field_defs
 136      * @param string $field_name
 137      * @param bool $is_relate
 138      * @dataProvider isRelateFieldProvider
 139      * @covers SugarBean::is_relate_field
 140      */
 141     public function testIsRelateField(array $field_defs, $field_name, $is_relate)
 142     {
 143         $bean = new BeanIsRelateFieldMock();
 144         $bean->field_defs = $field_defs;
 145         $actual = $bean->is_relate_field($field_name);
 146
 147         if ($is_relate)
 148         {
 149             $this->assertTrue($actual);
 150         }
 151         else
 152         {
 153             $this->assertFalse($actual);
 154         }
 155     }
 156
 157     public static function isRelateFieldProvider()
 158     {
 159         return array(
 160             // test for on a non-existing field
 161             array(
 162                 array(), 'dummy', false,
 163             ),
 164             // test for non-specified field type
 165             array(
 166                 array(
 167                     'my_field' => array(),
 168                 ), 'my_field', false,
 169             ),
 170             // test on a non-relate field type
 171             array(
 172                 array(
 173                     'my_field' => array(
 174                         'type' => 'varchar',
 175                     ),
 176                 ), 'my_field', false,
 177             ),
 178             // test on a relate field type but link not specified
 179             array(
 180                 array(
 181                     'my_field' => array(
 182                         'type' => 'relate',
 183                     ),
 184                 ), 'my_field', false,
 185             ),
 186             // test when only link is specified
 187             array(
 188                 array(
 189                     'my_field' => array(
 190                         'link' => 'my_link',
 191                     ),
 192                 ), 'my_field', false,
 193             ),
 194             // test on a relate field type
 195             array(
 196                 array(
 197                     'my_field' => array(
 198                         'type' => 'relate',
 199                         'link' => 'my_link',
 200                     ),
 201                 ), 'my_field', true,
 202             ),
 203         );
 204     }
 205
 206     /**
 207      * Test asserts behavior of haveFiles method
 208      *
 209      * @group 58955
 210      * @dataProvider getHaveFiles
 211      */
 212     public function testHaveFiles($class, $expected)
 213     {
 214         /**
 215          * @var SugarBean $bean
 216          */
 217         $bean = new $class();
 218         $this->assertEquals($expected, $bean->haveFiles(), 'Result is incorrect');
 219     }
 220
 221     /**
 222      * Test asserts behavior of getFiles method
 223      *
 224      * @group 58955
 225      */
 226     public function testGetFiles()
 227     {
 228         $bean = new SugarBean58955Extends();
 229         $this->assertEmpty($bean->getFiles(), 'Incorrect result');
 230
 231         $bean->id = 'test';
 232         $this->assertEquals(array('test'), $bean->getFiles(), 'Incorrect result');
 233
 234         $bean = new SugarBean58955Implements();
 235         $this->assertEmpty($bean->getFiles(), 'Incorrect result');
 236
 237         $bean->id = 'test';
 238         $this->assertEquals(array('test'), $bean->getFiles(), 'Incorrect result');
 239
 240         $bean = new SugarBean58955Image();
 241         $bean->id = 'test';
 242         $this->assertEmpty($bean->getFiles(), 'Incorrect result');
 243
 244         $bean->image = 'test';
 245         $this->assertEquals(array('test'), $bean->getFiles(), 'Incorrect result');
 246     }
 247
 248     /**
 249      * Data provider for testHaveFiles
 250      * @return array
 251      */
 252     public function getHaveFiles()
 253     {
 254         return array(
 255             array('SugarBean58955Extends', true),
 256             array('SugarBean58955Implements', true),
 257             array('SugarBean58955Image', true),
 258             array('SugarBean', false),
 259         );
 260     }
 261
 262     /**
 263      * Test asserts behavior of getFilesFields method
 264      *
 265      * @group 58955
 266      */
 267     public function testGetFilesFields()
 268     {
 269         $bean = new SugarBean58955Extends();
 270         $this->assertEquals(array('id'), $bean->getFilesFields(), 'Incorrect result');
 271
 272         $bean = new SugarBean58955Implements();
 273         $this->assertEquals(array('id'), $bean->getFilesFields(), 'Incorrect result');
 274
 275         $bean = new SugarBean58955Image();
 276         $this->assertEquals(array('image'), $bean->getFilesFields(), 'Incorrect result');
 277     }
 278 }
 279
 280 /**
 281  * Class SugarBean58955Extends
 282  * Mock for testHaveFiles & testGetFiles tests
 283  */
 284 class SugarBean58955Extends extends File
 285 {
 286     /**
 287      * @var string
 288      */
 289     public $module_name = 'SugarBean58955Extends';
 290
 291     public function __construct()
 292     {
 293         $this->field_defs = array();
 294     }
 295 }
 296
 297 /**
 298  * Class SugarBean58955Implements
 299  * Mock for testHaveFiles & testGetFiles tests
 300  */
 301 class SugarBean58955Implements extends SugarBean
 302 {
 303     /**
 304      * @var string
 305      */
 306     public $module_name = 'SugarBean58955Implements';
 307
 308     public function __construct()
 309     {
 310         $this->field_defs = array();
 311     }
 312
 313     public function bean_implements($interface)
 314     {
 315         if ($interface == 'FILE') {
 316             return true;
 317         }
 318         return parent::bean_implements($interface);
 319     }
 320 }
 321
 322 /**
 323  * Class SugarBean58955Image
 324  * Mock for testHaveFiles & testGetFiles tests
 325  */
 326 class SugarBean58955Image extends SugarBean
 327 {
 328     /**
 329      * @var string
 330      */
 331     public $module_name = 'SugarBean58955Image';
 332
 333     public function __construct()
 334     {
 335         $this->field_defs = array(
 336             'image' => array(
 337                 'type' => 'image'
 338             )
 339         );
 340     }
 341 }
 342
 343 // Using Mssql here because mysql needs real connection for quoting
 344 require_once 'include/database/MssqlManager.php';
 345 class MockMysqlDb extends MssqlManager
 346 {
 347     public $database = true;
 348     public $lastQuery;
 349
 350     public function connect(array $configOptions = null, $dieOnError = false)
 351     {
 352         return true;
 353     }
 354
 355     public function query($sql, $dieOnError = false, $msg = '', $suppress = false, $keepResult = false)
 356     {
 357         $this->lastQuery = $sql;
 358         return true;
 359     }
 360
 361     public function fetchByAssoc($result, $encode = true)
 362     {
 363         return false;
 364     }
 365 }
 366
 367 class BeanMockTestObjectName extends SugarBean
 368 {
 369     var $table_name = "my_table";
 370
 371     function BeanMockTestObjectName() {
 372                 parent::SugarBean();
 373         }
 374 }
 375
 376 class BeanIsRelateFieldMock extends SugarBean
 377 {
 378     public function is_relate_field($field_name_name)
 379     {
 380         return parent::is_relate_field($field_name_name);
 381     }
 382 }