3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 job functions
31 * @package CiviCRM_APIv3
34 * @copyright CiviCRM LLC (c) 2004-2013
35 * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
38 require_once 'CiviTest/CiviUnitTestCase.php';
39 class api_v3_JobTest
extends CiviUnitTestCase
{
40 protected $_apiversion = 3;
41 public $_eNoticeCompliant = TRUE;
42 public $DBResetRequired = FALSE;
43 public $_entity = 'Job';
44 public $_params = array();
48 $this->_params
= array(
50 'name' => 'API_Test_Job',
51 'description' => 'A long description written by hand in cursive',
52 'run_frequency' => 'Daily',
53 'api_entity' => 'ApiTestEntity',
54 'api_action' => 'apitestaction',
55 'parameters' => 'Semi-formal explanation of runtime job parameters',
61 $this->quickCleanup(array('civicrm_job'));
62 CRM_Utils_Hook
::singleton()->reset();
69 function testCreateWithoutName() {
72 $result = $this->callAPIFailure('job', 'create', $params,
73 'Mandatory key(s) missing from params array: run_frequency, name, api_entity, api_action'
78 * create job with an invalid "run_frequency" value
80 function testCreateWithInvalidFrequency() {
83 'name' => 'API_Test_Job',
84 'description' => 'A long description written by hand in cursive',
85 'run_frequency' => 'Fortnightly',
86 'api_entity' => 'ApiTestEntity',
87 'api_action' => 'apitestaction',
88 'parameters' => 'Semi-formal explanation of runtime job parameters',
91 $result = $this->callAPIFailure('job', 'create', $params);
97 function testCreate() {
98 $result = $this->callAPIAndDocument('job', 'create', $this->_params
, __FUNCTION__
, __FILE__
);
99 $this->assertNotNull($result['values'][0]['id'], 'in line ' . __LINE__
);
101 // mutate $params to match expected return value
102 unset($this->_params
['sequential']);
103 //assertDBState compares expected values in $result to actual values in the DB
104 $this->assertDBState('CRM_Core_DAO_Job', $result['id'], $this->_params
);
108 * check with empty array
110 function testDeleteEmpty() {
112 $result = $this->callAPIFailure('job', 'delete', $params);
116 * check with No array
118 function testDeleteParamsNotArray() {
119 $result = $this->callAPIFailure('job', 'delete', 'string');
123 * check if required fields are not passed
125 function testDeleteWithoutRequired() {
127 'name' => 'API_Test_PP',
128 'title' => 'API Test Payment Processor',
129 'class_name' => 'CRM_Core_Payment_APITest',
132 $result = $this->callAPIFailure('job', 'delete', $params);
133 $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id');
137 * check with incorrect required fields
139 function testDeleteWithIncorrectData() {
142 $result = $this->callAPIFailure('job', 'delete', $params);
148 function testDelete() {
149 $createResult = $this->callAPISuccess('job', 'create', $this->_params
);
150 $params = array('id' => $createResult['id'],);
151 $result = $this->callAPIAndDocument('job', 'delete', $params, __FUNCTION__
, __FILE__
);
152 $this->assertAPIDeleted($this->_entity
, $createResult['id']);
157 public function testCallUpdateGreetingMissingParams() {
158 $result = $this->callAPISuccess($this->_entity, 'update_greeting', array('gt' => 1));
159 $this->assertEquals('Mandatory key(s) missing from params array: ct', $result['error_message']);
162 public function testCallUpdateGreetingIncorrectParams() {
163 $result = $this->callAPISuccess($this->_entity, 'update_greeting', array('gt' => 1, 'ct' => 'djkfhdskjfhds'));
164 $this->assertEquals('ct `djkfhdskjfhds` is not valid.', $result['error_message']);
167 * Note that this test is about tesing the metadata / calling of the function & doesn't test the success of the called function
169 public function testCallUpdateGreetingSuccess() {
170 $result = $this->callAPISuccess($this->_entity
, 'update_greeting', array('gt' => 'postal_greeting', 'ct' => 'Individual'));
173 public function testCallUpdateGreetingCommaSeparatedParamsSuccess() {
174 $gt = 'postal_greeting,email_greeting,addressee';
175 $ct = 'Individual,Household';
176 $result = $this->callAPISuccess($this->_entity
, 'update_greeting', array('gt' => $gt, 'ct' => $ct));
179 public function testCallDisableExpiredRelationships() {
180 $individualID = $this->individualCreate();
181 $orgID = $this->organizationCreate();
182 CRM_Utils_Hook_UnitTests
::singleton()->setHook('civicrm_pre', array($this, 'hookPreRelationship'));
183 $relationshipTypeID = $this->callAPISuccess('relationship_type', 'getvalue', array('return' => 'id', 'name_a_b' => 'Employee of'));
184 $result = $this->callAPISuccess('relationship', 'create', array(
185 'relationship_type_id' => $relationshipTypeID,
186 'contact_id_a' => $individualID,
187 'contact_id_b' => $orgID,
189 'end_date' => 'yesterday',
191 $relationshipID = $result['id'];
192 $this->assertEquals('Hooked', $result['values'][$relationshipID]['description']);
193 $this->callAPISuccess($this->_entity
, 'disable_expired_relationships', array());
194 $result = $this->callAPISuccess('relationship', 'get', array());
195 $this->assertEquals('Go Go you good thing', $result['values'][$relationshipID]['description']);
196 $this->contactDelete($individualID);
197 $this->contactDelete($orgID);
200 function hookPreRelationship($op, $objectName, $id, &$params ) {
201 if($op == 'delete') {
204 if($params['is_active']) {
205 $params['description'] = 'Hooked';
208 $params['description'] = 'Go Go you good thing';