tests/modules/Opportunities/Bug55520Test.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2013 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/export_utils.php';
  39
  40 /**
  41  * Bug #55520
  42  * Export opportunities on windows corrupts unicode characters
  43  *
  44  * @author vromanenko@sugarcrm.com
  45  * @ticked 55520
  46  */
  47 class Bug55520Test extends Sugar_PHPUnit_Framework_TestCase
  48 {
  49     const BOM = "\xEF\xBB\xBF";
  50     const DEFAULT_EXPORT_CHARSET_PREF_NAME = 'default_export_charset';
  51     const UTF8_CHARSET = 'UTF-8';
  52     const NON_UTF8_CHARSET = 'ISO-8859-1';
  53
  54     /**
  55      * @var Opportunity
  56      */
  57     protected $opportunity;
  58
  59     /**
  60      * @var string
  61      */
  62     protected $defaultExportCharset;
  63
  64     /**
  65      * @var User
  66      */
  67     protected $currentUser;
  68
  69     protected function setUp()
  70     {
  71         SugarTestHelper::setUp('beanList');
  72         SugarTestHelper::setUp('beanFiles');
  73         SugarTestHelper::setUp('current_user');
  74         $this->currentUser = $GLOBALS['current_user'];
  75         $this->defaultExportCharset = $this->currentUser->getPreference(self::DEFAULT_EXPORT_CHARSET_PREF_NAME);
  76
  77         $this->opportunity = SugarTestOpportunityUtilities::createOpportunity();
  78     }
  79
  80     /**
  81      * Ensure that exported data starts with BOM
  82      *
  83      * @group 55520
  84      */
  85     public function testExportStringIncludesBOM()
  86     {
  87         $this->currentUser->setPreference(self::DEFAULT_EXPORT_CHARSET_PREF_NAME, self::UTF8_CHARSET);
  88         $export = export('Opportunities', $this->opportunity->id);
  89         $this->assertStringStartsWith(self::BOM, $export);
  90     }
  91
  92     /**
  93      * Ensure that exported data does not start with BOM if the export character set is other than utf-8
  94      *
  95      * @group 55520
  96      */
  97     public function testExportStringNotIncludesBOM()
  98     {
  99         $this->currentUser->setPreference(self::DEFAULT_EXPORT_CHARSET_PREF_NAME, self::NON_UTF8_CHARSET);
 100         $export = export('Opportunities', $this->opportunity->id);
 101         $this->assertStringStartsNotWith(self::BOM, $export);
 102     }
 103
 104     protected function tearDown()
 105     {
 106         $this->currentUser->setPreference(self::DEFAULT_EXPORT_CHARSET_PREF_NAME, $this->defaultExportCharset);
 107         SugarTestHelper::tearDown();
 108         SugarTestOpportunityUtilities::removeAllCreatedOpportunities();
 109     }
 110
 111 }