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
|
<?php
namespace Civi\Test\Api4\Entity;
use Civi\Api4\Generic\AbstractEntity;
use Civi\Api4\Entity;
use Civi\Test\Api4\Service\TestCreationParameterProvider;
use Civi\Test\Api4\Traits\TableDropperTrait;
use Civi\Test\Api4\UnitTestCase;
/**
* @group headless
*/
class ConformanceTest extends UnitTestCase {
use TableDropperTrait;
use \Civi\Test\Api4\Traits\OptionCleanupTrait {
setUp as setUpOptionCleanup;
}
/**
* @var TestCreationParameterProvider
*/
protected $creationParamProvider;
/**
* Set up baseline for testing
*/
public function setUp() {
$tablesToTruncate = [
'civicrm_custom_group',
'civicrm_custom_field',
'civicrm_group',
'civicrm_event',
'civicrm_participant',
];
$this->dropByPrefix('civicrm_value_myfavorite');
$this->cleanup(['tablesToTruncate' => $tablesToTruncate]);
$this->setUpOptionCleanup();
$this->loadDataSet('ConformanceTest');
$this->creationParamProvider = \Civi::container()->get('test.param_provider');
parent::setUp();
// calculateTaxAmount() for contribution triggers a deprecation notice
\PHPUnit_Framework_Error_Deprecated::$enabled = FALSE;
}
public function getEntities() {
$result = [];
$entities = Entity::get()->setCheckPermissions(FALSE)->execute();
foreach ($entities as $entity) {
if ($entity['name'] != 'Entity') {
$result[] = [$entity['name']];
}
}
return $result;
}
/**
* Fixme: This should use getEntities as a dataProvider but that fails for some reason
*/
public function testConformance() {
$entities = $this->getEntities();
$this->assertNotEmpty($entities);
foreach ($entities as $data) {
$entity = $data[0];
$entityClass = 'Civi\Api4\\' . $entity;
$this->checkActions($entityClass);
$this->checkFields($entityClass, $entity);
$id = $this->checkCreation($entity, $entityClass);
$this->checkGet($entityClass, $id, $entity);
$this->checkUpdateFailsFromCreate($entityClass, $id);
$this->checkWrongParamType($entityClass);
$this->checkDeleteWithNoId($entityClass);
$this->checkDeletion($entityClass, $id);
$this->checkPostDelete($entityClass, $id, $entity);
}
}
/**
* @param string $entityClass
* @param $entity
*/
protected function checkFields($entityClass, $entity) {
$fields = $entityClass::getFields()
->setCheckPermissions(FALSE)
->setIncludeCustom(FALSE)
->execute()
->indexBy('name');
$errMsg = sprintf('%s is missing required ID field', $entity);
$subset = ['data_type' => 'Integer'];
$this->assertArraySubset($subset, $fields['id'], $errMsg);
}
/**
* @param string $entityClass
*/
protected function checkActions($entityClass) {
$actions = $entityClass::getActions()
->setCheckPermissions(FALSE)
->execute()
->indexBy('name');
$this->assertNotEmpty($actions->getArrayCopy());
}
/**
* @param string $entity
* @param AbstractEntity|string $entityClass
*
* @return mixed
*/
protected function checkCreation($entity, $entityClass) {
$requiredParams = $this->creationParamProvider->getRequired($entity);
$createResult = $entityClass::create()
->setValues($requiredParams)
->setCheckPermissions(FALSE)
->execute()
->first();
$this->assertArrayHasKey('id', $createResult, "create missing ID");
$id = $createResult['id'];
$this->assertGreaterThanOrEqual(1, $id, "$entity ID not positive");
return $id;
}
/**
* @param AbstractEntity|string $entityClass
* @param int $id
*/
protected function checkUpdateFailsFromCreate($entityClass, $id) {
$exceptionThrown = '';
try {
$entityClass::create()
->setCheckPermissions(FALSE)
->addValue('id', $id)
->execute();
}
catch (\API_Exception $e) {
$exceptionThrown = $e->getMessage();
}
$this->assertContains('id', $exceptionThrown);
}
/**
* @param AbstractEntity|string $entityClass
* @param int $id
* @param string $entity
*/
protected function checkGet($entityClass, $id, $entity) {
$getResult = $entityClass::get()
->setCheckPermissions(FALSE)
->addWhere('id', '=', $id)
->execute();
$errMsg = sprintf('Failed to fetch a %s after creation', $entity);
$this->assertEquals(1, count($getResult), $errMsg);
}
/**
* @param AbstractEntity|string $entityClass
*/
protected function checkDeleteWithNoId($entityClass) {
$exceptionThrown = '';
try {
$entityClass::delete()
->execute();
}
catch (\API_Exception $e) {
$exceptionThrown = $e->getMessage();
}
$this->assertContains('required', $exceptionThrown);
}
/**
* @param AbstractEntity|string $entityClass
*/
protected function checkWrongParamType($entityClass) {
$exceptionThrown = '';
try {
$entityClass::get()
->setCheckPermissions('nada')
->execute();
}
catch (\API_Exception $e) {
$exceptionThrown = $e->getMessage();
}
$this->assertContains('checkPermissions', $exceptionThrown);
$this->assertContains('type', $exceptionThrown);
}
/**
* @param AbstractEntity|string $entityClass
* @param int $id
*/
protected function checkDeletion($entityClass, $id) {
$deleteResult = $entityClass::delete()
->setCheckPermissions(FALSE)
->addWhere('id', '=', $id)
->execute();
// should get back an array of deleted id
$this->assertEquals([$id], (array) $deleteResult);
}
/**
* @param AbstractEntity|string $entityClass
* @param int $id
* @param string $entity
*/
protected function checkPostDelete($entityClass, $id, $entity) {
$getDeletedResult = $entityClass::get()
->setCheckPermissions(FALSE)
->addWhere('id', '=', $id)
->execute();
$errMsg = sprintf('Entity "%s" was not deleted', $entity);
$this->assertEquals(0, count($getDeletedResult), $errMsg);
}
}
|
