/tests/service/SOAPAPI3Test.php
PHP | 352 lines | 251 code | 42 blank | 59 comment | 5 complexity | 221a4f2a178a93a6c5ff96dc7261366e MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, LGPL-2.1, BSD-3-Clause, AGPL-3.0
- <?php
- /*********************************************************************************
- * SugarCRM Community Edition is a customer relationship management program developed by
- * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
- *
- * This program is free software; you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License version 3 as published by the
- * Free Software Foundation with the addition of the following permission added
- * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
- * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
- * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along with
- * this program; if not, see http://www.gnu.org/licenses or write to the Free
- * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301 USA.
- *
- * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
- * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
- *
- * The interactive user interfaces in modified source and object code versions
- * of this program must display Appropriate Legal Notices, as required under
- * Section 5 of the GNU Affero General Public License version 3.
- *
- * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
- * these Appropriate Legal Notices must retain the display of the "Powered by
- * SugarCRM" logo. If the display of the logo is not reasonably feasible for
- * technical reasons, the Appropriate Legal Notices must display the words
- * "Powered by SugarCRM".
- ********************************************************************************/
-
- require_once('include/TimeDate.php');
- require_once('service/v3/SugarWebServiceUtilv3.php');
- require_once('tests/service/APIv3Helper.php');
- require_once 'tests/service/SOAPTestCase.php';
- /**
- * This class is meant to test everything SOAP
- *
- */
- class SOAPAPI3Test extends SOAPTestCase
- {
- public $_contactId = '';
- private static $helperObject;
- /**
- * Create test user
- *
- */
- public function setUp()
- {
- $this->_soapURL = $GLOBALS['sugar_config']['site_url'].'/service/v3/soap.php';
- parent::setUp();
- $GLOBALS['app_strings'] = return_application_language($GLOBALS['current_language']);
- $GLOBALS['app_list_strings'] = return_app_list_strings_language($GLOBALS['current_language']);
- self::$helperObject = new APIv3Helper();
- }
- /**
- * Remove anything that was used during this test
- *
- */
- public function tearDown() {
- parent::tearDown();
- global $soap_version_test_accountId, $soap_version_test_opportunityId, $soap_version_test_contactId;
- unset($soap_version_test_accountId);
- unset($soap_version_test_opportunityId);
- unset($soap_version_test_contactId);
- }
- /**
- * Ensure we can create a session on the server.
- *
- */
- public function testCanLogin(){
- $result = $this->_login();
- $this->assertTrue(!empty($result['id']) && $result['id'] != -1,
- 'SOAP Session not created. Error ('.$this->_soapClient->faultcode.'): '.$this->_soapClient->faultstring.': '.$this->_soapClient->faultdetail);
- }
- public function testSearchByModule()
- {
- $this->_login();
- $seedData = self::$helperObject->populateSeedDataForSearchTest($this->_user->id);
- $searchModules = array('Accounts','Contacts','Opportunities');
- $searchString = "UNIT TEST";
- $offSet = 0;
- $maxResults = 10;
- $results = $this->_soapClient->call('search_by_module',
- array(
- 'session' => $this->_sessionId,
- 'search' => $searchString,
- 'modules' => $searchModules,
- 'offset' => $offSet,
- 'max' => $maxResults,
- 'user' => $this->_user->id)
- );
- $this->assertTrue( self::$helperObject->findBeanIdFromEntryList($results['entry_list'],$seedData[0]['id'],'Accounts') );
- $this->assertFalse( self::$helperObject->findBeanIdFromEntryList($results['entry_list'],$seedData[1]['id'],'Accounts') );
- $this->assertTrue( self::$helperObject->findBeanIdFromEntryList($results['entry_list'],$seedData[2]['id'],'Contacts') );
- $this->assertTrue( self::$helperObject->findBeanIdFromEntryList($results['entry_list'],$seedData[3]['id'],'Opportunities') );
- $this->assertFalse( self::$helperObject->findBeanIdFromEntryList($results['entry_list'],$seedData[4]['id'],'Opportunities') );
- $GLOBALS['db']->query("DELETE FROM accounts WHERE name like 'UNIT TEST%' ");
- $GLOBALS['db']->query("DELETE FROM opportunities WHERE name like 'UNIT TEST%' ");
- $GLOBALS['db']->query("DELETE FROM contacts WHERE first_name like 'UNIT TEST%' ");
- }
- public function testSearchByModuleWithReturnFields()
- {
- $this->_login();
- $seedData = self::$helperObject->populateSeedDataForSearchTest($this->_user->id);
- $returnFields = array('name','id','deleted');
- $searchModules = array('Accounts','Contacts','Opportunities');
- $searchString = "UNIT TEST";
- $offSet = 0;
- $maxResults = 10;
- $results = $this->_soapClient->call('search_by_module',
- array(
- 'session' => $this->_sessionId,
- 'search' => $searchString,
- 'modules' => $searchModules,
- 'offset' => $offSet,
- 'max' => $maxResults,
- 'user' => $this->_user->id,
- 'fields' => $returnFields)
- );
- $this->assertEquals($seedData[0]['fieldValue'], self::$helperObject->findFieldByNameFromEntryList($results['entry_list'],$seedData[0]['id'],'Accounts', $seedData[0]['fieldName']));
- $this->assertFalse(self::$helperObject->findFieldByNameFromEntryList($results['entry_list'],$seedData[1]['id'],'Accounts', $seedData[1]['fieldName']));
- $this->assertEquals($seedData[2]['fieldValue'], self::$helperObject->findFieldByNameFromEntryList($results['entry_list'],$seedData[2]['id'],'Contacts', $seedData[2]['fieldName']));
- $this->assertEquals($seedData[3]['fieldValue'], self::$helperObject->findFieldByNameFromEntryList($results['entry_list'],$seedData[3]['id'],'Opportunities', $seedData[3]['fieldName']));
- $this->assertFalse(self::$helperObject->findFieldByNameFromEntryList($results['entry_list'],$seedData[4]['id'],'Opportunities', $seedData[4]['fieldName']));
- $GLOBALS['db']->query("DELETE FROM accounts WHERE name like 'UNIT TEST%' ");
- $GLOBALS['db']->query("DELETE FROM opportunities WHERE name like 'UNIT TEST%' ");
- $GLOBALS['db']->query("DELETE FROM contacts WHERE first_name like 'UNIT TEST%' ");
- }
- public function testGetVardefsMD5()
- {
- $GLOBALS['reload_vardefs'] = TRUE;
- //Test a regular module
- $result = $this->_getVardefsMD5('Accounts');
- $a = new Account();
- $soapHelper = new SugarWebServiceUtilv3();
- $actualVardef = $soapHelper->get_return_module_fields($a,'Accounts','');
- $actualMD5 = md5(serialize($actualVardef));
- $this->assertEquals($actualMD5, $result[0], "Unable to retrieve vardef md5.");
- //Test a fake module
- $result = $this->_getVardefsMD5('BadModule');
- $this->assertTrue($result['faultstring'] == 'Module Does Not Exist');
- unset($GLOBALS['reload_vardefs']);
- }
- public function testGetUpcomingActivities()
- {
- $this->_login();
- $expected = $this->_createUpcomingActivities(); //Seed the data.
- $results = $this->_soapClient->call('get_upcoming_activities',array('session'=>$this->_sessionId));
- $this->assertEquals($expected[0] ,$results[0]['id'] , 'Unable to get upcoming activities Error ('.$this->_soapClient->faultcode.'): '.$this->_soapClient->faultstring.': '.$this->_soapClient->faultdetail);
- $this->assertEquals($expected[1] ,$results[1]['id'] , 'Unable to get upcoming activities Error ('.$this->_soapClient->faultcode.'): '.$this->_soapClient->faultstring.': '.$this->_soapClient->faultdetail);
- $this->_removeUpcomingActivities();
- }
- /**
- * Get Module Layout functions not exposed to soap service, make sure they are not available.
- *
- */
- public function testGetModuleLayoutMD5()
- {
- $result = $this->_getModuleLayoutMD5();
- $this->assertContains('Client',$result['faultcode']);
- }
- public function testSetEntriesForAccount() {
- $result = $this->_setEntriesForAccount();
- $this->assertTrue(!empty($result['ids']) && $result['ids'][0] != -1,
- 'Can not create new account using testSetEntriesForAccount. Error ('.$this->_soapClient->faultcode.'): '.$this->_soapClient->faultstring.': '.$this->_soapClient->faultdetail);
- } // fn
- /**********************************
- * HELPER PUBLIC FUNCTIONS
- **********************************/
- private function _removeUpcomingActivities()
- {
- $GLOBALS['db']->query("DELETE FROM calls where name = 'UNIT TEST'");
- $GLOBALS['db']->query("DELETE FROM tasks where name = 'UNIT TEST'");
- }
- private function _createUpcomingActivities()
- {
- $GLOBALS['current_user']->setPreference('datef','Y-m-d') ;
- $GLOBALS['current_user']->setPreference('timef','H:i') ;
- $date1 = $GLOBALS['timedate']->to_display_date_time(gmdate("Y-m-d H:i:s", (gmmktime() + (3600 * 24 * 2) ) ),true,true, $GLOBALS['current_user']) ; //Two days from today
- $date2 = $GLOBALS['timedate']->to_display_date_time(gmdate("Y-m-d H:i:s", (gmmktime() + (3600 * 24 * 4) ) ),true,true, $GLOBALS['current_user']) ; //Two days from today
- $callID = uniqid();
- $c = new Call();
- $c->id = $callID;
- $c->new_with_id = TRUE;
- $c->status = 'Not Planned';
- $c->date_start = $date1;
- $c->name = "UNIT TEST";
- $c->assigned_user_id = $this->_user->id;
- $c->save(FALSE);
- $callID = uniqid();
- $c = new Call();
- $c->id = $callID;
- $c->new_with_id = TRUE;
- $c->status = 'Planned';
- $c->date_start = $date1;
- $c->name = "UNIT TEST";
- $c->assigned_user_id = $this->_user->id;
- $c->save(FALSE);
- $taskID = uniqid();
- $t = new Task();
- $t->id = $taskID;
- $t->new_with_id = TRUE;
- $t->status = 'Not Started';
- $t->date_due = $date2;
- $t->name = "UNIT TEST";
- $t->assigned_user_id = $this->_user->id;
- $t->save(FALSE);
- return array($callID, $taskID);
- }
- public function _getVardefsMD5($module)
- {
- $this->_login();
- $result = $this->_soapClient->call('get_module_fields_md5',array('session'=>$this->_sessionId,'module'=> $module ));
- return $result;
- }
- public function _getModuleLayoutMD5()
- {
- $this->_login();
- $result = $this->_soapClient->call('get_module_layout_md5',
- array('session'=>$this->_sessionId,'module_names'=> array('Accounts'),'types' => array('default'),'views' => array('list')));
- return $result;
- }
- public function _setEntryForContact() {
- $this->_login();
- global $timedate;
- $current_date = $timedate->nowDb();
- $time = mt_rand();
- $first_name = 'SugarContactFirst' . $time;
- $last_name = 'SugarContactLast';
- $email1 = 'contact@sugar.com';
- $result = $this->_soapClient->call('set_entry',array('session'=>$this->_sessionId,'module_name'=>'Contacts', 'name_value_list'=>array(array('name'=>'last_name' , 'value'=>"$last_name"), array('name'=>'first_name' , 'value'=>"$first_name"), array('name'=>'do_not_call' , 'value'=>"1"), array('name'=>'birthdate' , 'value'=>"$current_date"), array('name'=>'lead_source' , 'value'=>"Cold Call"), array('name'=>'email1' , 'value'=>"$email1"))));
- SugarTestContactUtilities::setCreatedContact(array($this->_contactId));
- return $result;
- } // fn
- public function _getEntryForContact() {
- global $soap_version_test_contactId;
- $this->_login();
- $result = $this->_soapClient->call('get_entry',array('session'=>$this->_sessionId,'module_name'=>'Contacts','id'=>$soap_version_test_contactId,'select_fields'=>array('last_name', 'first_name', 'do_not_call', 'lead_source'), 'link_name_to_fields_array' => array(array('name' => 'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))));
- $GLOBALS['log']->fatal("_getEntryForContact" . " " . $soap_version_test_contactId);
- return $result;
- }
- public function _setEntriesForAccount() {
- global $soap_version_test_accountId;
- $this->_login();
- global $timedate;
- $current_date = $timedate->nowDb();
- $time = mt_rand();
- $name = 'SugarAccount' . $time;
- $email1 = 'account@'. $time. 'sugar.com';
- $result = $this->_soapClient->call('set_entries',array('session'=>$this->_sessionId,'module_name'=>'Accounts', 'name_value_lists'=>array(array(array('name'=>'name' , 'value'=>"$name"), array('name'=>'email1' , 'value'=>"$email1")))));
- $soap_version_test_accountId = $result['ids'][0];
- $GLOBALS['log']->fatal("_setEntriesForAccount id = " . $soap_version_test_accountId);
- SugarTestAccountUtilities::setCreatedAccount(array($soap_version_test_accountId));
- return $result;
- } // fn
- public function _setEntryForOpportunity() {
- global $soap_version_test_accountId, $soap_version_test_opportunityId;
- $this->_login();
- global $timedate;
- $date_closed = $timedate->getNow()->get("+1 week")->asDb();
- $time = mt_rand();
- $name = 'SugarOpportunity' . $time;
- $account_id = $soap_version_test_accountId;
- $sales_stage = 'Prospecting';
- $probability = 10;
- $amount = 1000;
- $GLOBALS['log']->fatal("_setEntryForOpportunity id = " . $soap_version_test_accountId);
- $result = $this->_soapClient->call('set_entry',array('session'=>$this->_sessionId,'module_name'=>'Opportunities', 'name_value_lists'=>array(array('name'=>'name' , 'value'=>"$name"), array('name'=>'amount' , 'value'=>"$amount"), array('name'=>'probability' , 'value'=>"$probability"), array('name'=>'sales_stage' , 'value'=>"$sales_stage"), array('name'=>'account_id' , 'value'=>"$account_id"))));
- $soap_version_test_opportunityId = $result['id'];
- return $result;
- } // fn
- public function _setRelationshipForOpportunity() {
- global $soap_version_test_contactId, $soap_version_test_opportunityId;
- $this->_login();
- $result = $this->_soapClient->call('set_relationship',array('session'=>$this->_sessionId,'module_name' => 'Opportunities','module_id' => "$soap_version_test_opportunityId", 'link_field_name' => 'contacts','related_ids' =>array("$soap_version_test_contactId"), 'name_value_list' => array(array('name' => 'contact_role', 'value' => 'testrole'))));
- return $result;
- } // fn
- public function _getRelationshipForOpportunity() {
- global $soap_version_test_opportunityId;
- $this->_login();
- $result = $this->_soapClient->call('get_relationships',
- array(
- 'session' => $this->_sessionId,
- 'module_name' => 'Opportunities',
- 'module_id' => "$soap_version_test_opportunityId",
- 'link_field_name' => 'contacts',
- 'related_module_query' => '',
- 'related_fields' => array('id'),
- 'related_module_link_name_to_fields_array' => array(array('name' => 'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address'))))
- );
- return $result;
- } // fn
- public function _searchByModule() {
- $this->_login();
- $result = $this->_soapClient->call('search_by_module',
- array(
- 'session' => $this->_sessionId,
- 'search_string' => 'Sugar',
- 'modules' => array('Accounts', 'Contacts', 'Opportunities'),
- 'offset' => '0',
- 'max_results' => '10')
- );
- return $result;
- } // fn
- }