1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<?php
namespace Civi\Test\Api4;
use Civi\Test\Api4\Traits\TestDataLoaderTrait;
use Civi\Test\HeadlessInterface;
use Civi\Test\TransactionalInterface;
/**
* @group headless
*/
class UnitTestCase extends \PHPUnit_Framework_TestCase implements HeadlessInterface, TransactionalInterface {
use TestDataLoaderTrait;
/**
* @see CiviUnitTestCase
*
* @param string $name
* @param array $data
* @param string $dataName
*/
public function __construct($name = NULL, array $data = [], $dataName = '') {
parent::__construct($name, $data, $dataName);
error_reporting(E_ALL & ~E_NOTICE);
}
public function setUpHeadless() {
return \Civi\Test::headless()->installMe(__DIR__)->apply();
}
/**
* Tears down the fixture, for example, closes a network connection.
*
* This method is called after a test is executed.
*/
public function tearDown() {
parent::tearDown();
}
/**
* Quick clean by emptying tables created for the test.
*
* @param array $params
*/
public function cleanup($params) {
$params += [
'tablesToTruncate' => [],
];
\CRM_Core_DAO::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
foreach ($params['tablesToTruncate'] as $table) {
\Civi::log()->info('truncating: ' . $table);
$sql = "TRUNCATE TABLE $table";
\CRM_Core_DAO::executeQuery($sql);
}
\CRM_Core_DAO::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
}
/**
* Quick record counter
*
* @param string $table_name
* @returns int record count
*/
public function getRowCount($table_name) {
$sql = "SELECT count(id) FROM $table_name";
return (int) \CRM_Core_DAO::singleValueQuery($sql);
}
/**
* Create sample entities (using V3 for now).
*
* @param array $params (type, seq, overrides, count)
* @return array (either single, or array of array if count >1)
*/
public static function createEntity($params) {
$params += [
'count' => 1,
'seq' => 0,
];
$entities = [];
$entity = NULL;
for ($i = 0; $i < $params['count']; $i++) {
$params['seq']++;
$data = self::sample($params);
$api_params = ['sequential' => 1] + $data['sample_params'];
$result = civicrm_api3($data['entity'], 'create', $api_params);
if ($result['is_error']) {
throw new \Exception("creating $data[entity] failed");
}
$entity = $result['values'][0];
if (!($entity['id'] > 0)) {
throw new \Exception("created entity is malformed");
}
$entities[] = $entity;
}
return $params['count'] == 1 ? $entity : $entities;
}
/**
* Helper function for creating sample entities.
*
* Depending on the supplied sequence integer, plucks values from the dummy data.
* Constructs a foreign entity when an ID is required but isn't supplied in the overrides.
*
* Inspired by CiviUnitTestCase::
* @todo - extract this function to own class and share with CiviUnitTestCase?
* @param array $params
* - type: string roughly matching entity type
* - seq: (optional) int sequence number for the values of this type
* - overrides: (optional) array of fill in parameters
*
* @return array
* - entity: string API entity type (usually the type supplied except for contact subtypes)
* - sample_params: array API sample_params properties of sample entity
*/
public static function sample($params) {
$params += [
'seq' => 0,
'overrides' => [],
];
$type = $params['type'];
// sample data - if field is array then chosed based on `seq`
$sample_params = [];
if (in_array($type, ['Individual', 'Organization', 'Household'])) {
$sample_params['contact_type'] = $type;
$entity = 'Contact';
}
else {
$entity = $type;
}
// use the seq to pluck a set of params out
foreach (self::sampleData($type) as $key => $value) {
if (is_array($value)) {
$sample_params[$key] = $value[$params['seq'] % count($value)];
}
else {
$sample_params[$key] = $value;
}
}
if ($type == 'Individual') {
$sample_params['email'] = strtolower(
$sample_params['first_name'] . '_' . $sample_params['last_name'] . '@civicrm.org'
);
$sample_params['prefix_id'] = 3;
$sample_params['suffix_id'] = 3;
}
if (!count($sample_params)) {
throw new \Exception("unknown sample type: $type");
}
$sample_params = $params['overrides'] + $sample_params;
// make foreign enitiies if they haven't been supplied
foreach ($sample_params as $key => $value) {
if (substr($value, 0, 6) === 'dummy.') {
$foreign_entity = self::createEntity([
'type' => substr($value, 6),
'seq' => $params['seq']]);
$sample_params[$key] = $foreign_entity['id'];
}
}
return compact("entity", "sample_params");
}
/**
* Provider of sample data.
*
* @return array
* Array values represent a set of allowable items.
* Strings in the form "dummy.Entity" require creating a foreign entity first.
*/
public static function sampleData($type) {
$data = [
'Individual' => [
// The number of values in each list need to be coprime numbers to not have duplicates
'first_name' => ['Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'],
'middle_name' => ['J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'],
'last_name' => ['Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'],
'contact_type' => 'Individual',
],
'Organization' => [
'organization_name' => [
'Unit Test Organization',
'Acme',
'Roberts and Sons',
'Cryo Space Labs',
'Sharper Pens',
],
],
'Household' => [
'household_name' => ['Unit Test household'],
],
'Event' => [
'title' => 'Annual CiviCRM meet',
'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
'event_type_id' => 1,
'is_public' => 1,
'start_date' => 20081021,
'end_date' => 20081023,
'is_online_registration' => 1,
'registration_start_date' => 20080601,
'registration_end_date' => 20081015,
'max_participants' => 100,
'event_full_text' => 'Sorry! We are already full',
'is_monetary' => 0,
'is_active' => 1,
'is_show_location' => 0,
],
'Participant' => [
'event_id' => 'dummy.Event',
'contact_id' => 'dummy.Individual',
'status_id' => 2,
'role_id' => 1,
'register_date' => 20070219,
'source' => 'Wimbeldon',
'event_level' => 'Payment',
],
'Contribution' => [
'contact_id' => 'dummy.Individual',
'financial_type_id' => 1, // donation, 2 = member, 3 = campaign contribution, 4=event
'total_amount' => 7.3,
],
'Activity' => [
//'activity_type_id' => 1,
'subject' => 'unit testing',
'source_contact_id' => 'dummy.Individual',
],
];
if ($type == 'Contact') {
$type = 'Individual';
}
return $data[$type];
}
}
|
