4 * File for the TestActionSchedule class
8 * CiviCRM is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Affero General Public License
10 * as published by the Free Software Foundation; either version 3 of
11 * the License, or (at your option) any later version.
13 * CiviCRM is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
18 * You should have received a copy of the GNU Affero General Public
19 * License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>.
24 * Include class definitions
26 require_once 'CiviTest/CiviUnitTestCase.php';
30 * Test APIv3 civicrm_action_schedule functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_ActionSchedule
35 class api_v3_ActionScheduleTest
extends CiviUnitTestCase
{
38 protected $_entity = 'action_schedule';
39 protected $_apiversion = 3;
42 * Test setup for every test.
44 public function setUp() {
46 $this->useTransaction(TRUE);
50 * Test simple create action schedule.
52 public function testSimpleActionScheduleCreate() {
53 $oldCount = CRM_Core_DAO
::singleValueQuery('select count(*) from civicrm_action_schedule');
54 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
55 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
56 $scheduledStatus = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
57 $mappingId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionMapping', 'activity_type', 'id', 'entity_value');
58 $activityTypeId = CRM_Core_OptionGroup
::getValue('activity_type', "Meeting", 'name');
59 $title = "simpleActionSchedule" . substr(sha1(rand()), 0, 7);
62 'recipient' => $assigneeID,
64 'entity_value' => $activityTypeId,
65 'entity_status' => $scheduledStatus,
67 'record_activity' => 1,
68 'start_action_date' => 'activity_date_time',
69 'mapping_id' => $mappingId,
71 $actionSchedule = $this->callAPISuccess('action_schedule', 'create', $params);
72 $this->assertTrue(is_numeric($actionSchedule['id']));
73 $this->assertTrue($actionSchedule['id'] > 0);
74 $newCount = CRM_Core_DAO
::singleValueQuery('select count(*) from civicrm_action_schedule');
75 $this->assertEquals($oldCount +
1, $newCount);
79 * Check if required fields are not passed.
81 public function testActionScheduleCreateWithoutRequired() {
83 'subject' => 'this case should fail',
84 'scheduled_date_time' => date('Ymd'),
86 $this->callAPIFailure('activity', 'create', $params);
90 * Test create with scheduled dates.
92 public function testActionScheduleWithScheduledDatesCreate() {
93 $oldCount = CRM_Core_DAO
::singleValueQuery('select count(*) from civicrm_action_schedule');
94 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
95 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
96 $scheduledStatus = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
97 $mappingId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionMapping', 'activity_type', 'id', 'entity_value');
98 $activityTypeId = CRM_Core_OptionGroup
::getValue('activity_type', "Meeting", 'name');
99 $title = "simpleActionSchedule" . substr(sha1(rand()), 0, 7);
102 'recipient' => $assigneeID,
104 'entity_value' => $activityTypeId,
105 'entity_status' => $scheduledStatus,
107 'record_activity' => 1,
108 'mapping_id' => $mappingId,
109 'start_action_offset' => 3,
110 'start_action_unit' => 'day',
111 'start_action_condition' => 'before',
112 'start_action_date' => 'activity_date_time',
114 'repetition_frequency_unit' => 'day',
115 'repetition_frequency_interval' => 3,
116 'end_frequency_unit' => 'hour',
117 'end_frequency_interval' => 0,
118 'end_action' => 'before',
119 'end_date' => 'activity_date_time',
120 'body_html' => 'Test description',
121 'subject' => 'Test subject',
123 $actionSchedule = $this->callAPISuccess('action_schedule', 'create', $params);
124 $this->assertTrue(is_numeric($actionSchedule['id']));
125 $this->assertTrue($actionSchedule['id'] > 0);
126 $this->assertEquals($actionSchedule['values'][$actionSchedule['id']]['start_action_offset'][0], $params['start_action_offset']);
127 $newCount = CRM_Core_DAO
::singleValueQuery('select count(*) from civicrm_action_schedule');
128 $this->assertEquals($oldCount +
1, $newCount);