tests/service/Bug49898Test.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 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
  39 /**
  40  * Bug49898Test.php
  41  *
  42  * This test is for bug 49898.  Basically the plugin code is still dependent on the legacy versions of the SOAP api (soap.php).  As a result,
  43  * the search_by_module call is expecting a username and password combination.  However, the plugin code cannot supply a username and password, but
  44  * only has the session id information.  Therefore, as an alternative, it was proposed to have a workaround where if a username is empty, then the password
  45  * is assumed to be the session id.  This test replicates that check by searching on two modules (Accounts and Contacts) based on an email address
  46  * derived from the Contact.
  47  *
  48  * @author Collin Lee
  49  *
  50  */
  51
  52 require_once 'tests/service/SOAPTestCase.php';
  53
  54 class Bug49898Test extends SOAPTestCase
  55 {
  56     var $contact;
  57     var $account;
  58     var $lead;
  59
  60     /**
  61      * setUp
  62      * Override the setup from SoapTestCase to also create the seed search data for Accounts and Contacts.
  63      */
  64     public function setUp()
  65     {
  66         $this->_soapURL = $GLOBALS['sugar_config']['site_url'].'/soap.php';
  67                 parent::setUp();
  68         $this->_login(); // Logging in just before the SOAP call as this will also commit any pending DB changes
  69         $this->contact = SugarTestContactUtilities::createContact();
  70         $this->contact->contacts_users_id = $GLOBALS['current_user']->id;
  71         $this->contact->save();
  72         $this->account = SugarTestAccountUtilities::createAccount();
  73         $this->account->email1 = $this->contact->email1;
  74         $this->account->save();
  75         $this->lead = SugarTestLeadUtilities::createLead();
  76         $this->lead->email1 = $this->contact->email1;
  77         $this->lead->save();
  78         $GLOBALS['db']->commit(); // Making sure these changes are committed to the database
  79     }
  80
  81     public function testSearchByModuleWithSessionIdHack()
  82     {
  83         //Assert that the plugin fix to use a blank user_name and session id as password works
  84         $modules = array('Contacts', 'Accounts', 'Leads');
  85         $result = $this->_soapClient->call('search_by_module', array('user_name' => '', 'password' => $this->_sessionId, 'search_string' => $this->contact->email1, 'modules' => $modules, 'offset' => 0, 'max_results' => 10));
  86         $this->assertTrue(!empty($result) && count($result['entry_list']) == 3, 'Incorrect number of results returned. HTTP Response: '.$this->_soapClient->response);
  87
  88         //Assert that the traditional method of using user_name and password also works
  89         $result = $this->_soapClient->call('search_by_module', array('user_name' => $GLOBALS['current_user']->user_name, 'password' => $GLOBALS['current_user']->user_hash, 'search_string' => $this->contact->email1, 'modules' => $modules, 'offset' => 0, 'max_results' => 10));
  90         $this->assertTrue(!empty($result) && count($result['entry_list']) == 3, 'Incorrect number of results returned. HTTP Response: '.$this->_soapClient->response);
  91     }
  92
  93
  94 }
  95