/
TimestampBehaviorTest.php
403 lines (353 loc) · 12.2 KB
/
TimestampBehaviorTest.php
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\ORM\Behavior;
use Cake\Event\Event;
use Cake\I18n\Time;
use Cake\ORM\Behavior\TimestampBehavior;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;
use Cake\TestSuite\TestCase;
/**
* Behavior test case
*/
class TimestampBehaviorTest extends TestCase
{
/**
* autoFixtures
*
* Don't load fixtures for all tests
*
* @var bool
*/
public $autoFixtures = false;
/**
* fixtures
*
* @var array
*/
public $fixtures = [
'core.users'
];
/**
* Sanity check Implemented events
*
* @return void
*/
public function testImplementedEventsDefault()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$expected = [
'Model.beforeSave' => 'handleEvent'
];
$this->assertEquals($expected, $this->Behavior->implementedEvents());
}
/**
* testImplementedEventsCustom
*
* The behavior allows for handling any event - test an example
*
* @return void
*/
public function testImplementedEventsCustom()
{
$table = $this->getMock('Cake\ORM\Table');
$settings = ['events' => ['Something.special' => ['date_specialed' => 'always']]];
$this->Behavior = new TimestampBehavior($table, $settings);
$expected = [
'Something.special' => 'handleEvent'
];
$this->assertEquals($expected, $this->Behavior->implementedEvents());
}
/**
* testCreatedAbsent
*
* @return void
* @triggers Model.beforeSave
*/
public function testCreatedAbsent()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$event = new Event('Model.beforeSave');
$entity = new Entity(['name' => 'Foo']);
$return = $this->Behavior->handleEvent($event, $entity);
$this->assertTrue($return, 'Handle Event is expected to always return true');
$this->assertInstanceOf('Cake\I18n\Time', $entity->created);
$this->assertSame($ts->format('c'), $entity->created->format('c'), 'Created timestamp is not the same');
}
/**
* testCreatedPresent
*
* @return void
* @triggers Model.beforeSave
*/
public function testCreatedPresent()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$event = new Event('Model.beforeSave');
$existingValue = new \DateTime('2011-11-11');
$entity = new Entity(['name' => 'Foo', 'created' => $existingValue]);
$return = $this->Behavior->handleEvent($event, $entity);
$this->assertTrue($return, 'Handle Event is expected to always return true');
$this->assertSame($existingValue, $entity->created, 'Created timestamp is expected to be unchanged');
}
/**
* testCreatedNotNew
*
* @return void
* @triggers Model.beforeSave
*/
public function testCreatedNotNew()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$event = new Event('Model.beforeSave');
$entity = new Entity(['name' => 'Foo']);
$entity->isNew(false);
$return = $this->Behavior->handleEvent($event, $entity);
$this->assertTrue($return, 'Handle Event is expected to always return true');
$this->assertNull($entity->created, 'Created timestamp is expected to be untouched if the entity is not new');
}
/**
* testModifiedAbsent
*
* @return void
* @triggers Model.beforeSave
*/
public function testModifiedAbsent()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$event = new Event('Model.beforeSave');
$entity = new Entity(['name' => 'Foo']);
$entity->isNew(false);
$return = $this->Behavior->handleEvent($event, $entity);
$this->assertTrue($return, 'Handle Event is expected to always return true');
$this->assertInstanceOf('Cake\I18n\Time', $entity->modified);
$this->assertSame($ts->format('c'), $entity->modified->format('c'), 'Modified timestamp is not the same');
}
/**
* testModifiedPresent
*
* @return void
* @triggers Model.beforeSave
*/
public function testModifiedPresent()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$event = new Event('Model.beforeSave');
$existingValue = new \DateTime('2011-11-11');
$entity = new Entity(['name' => 'Foo', 'modified' => $existingValue]);
$entity->clean();
$entity->isNew(false);
$return = $this->Behavior->handleEvent($event, $entity);
$this->assertTrue($return, 'Handle Event is expected to always return true');
$this->assertInstanceOf('Cake\I18n\Time', $entity->modified);
$this->assertSame($ts->format('c'), $entity->modified->format('c'), 'Modified timestamp is expected to be updated');
}
/**
* testInvalidEventConfig
*
* @expectedException \UnexpectedValueException
* @expectedExceptionMessage When should be one of "always", "new" or "existing". The passed value "fat fingers" is invalid
* @return void
* @triggers Model.beforeSave
*/
public function testInvalidEventConfig()
{
$table = $this->getMock('Cake\ORM\Table');
$settings = ['events' => ['Model.beforeSave' => ['created' => 'fat fingers']]];
$this->Behavior = new TimestampBehavior($table, $settings);
$event = new Event('Model.beforeSave');
$entity = new Entity(['name' => 'Foo']);
$this->Behavior->handleEvent($event, $entity);
}
/**
* testGetTimestamp
*
* @return void
*/
public function testGetTimestamp()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$return = $this->Behavior->timestamp();
$this->assertInstanceOf(
'DateTime',
$return,
'Should return a timestamp object'
);
$now = Time::now();
$this->assertEquals($now, $return);
return $this->Behavior;
}
/**
* testGetTimestampPersists
*
* @depends testGetTimestamp
* @return void
*/
public function testGetTimestampPersists($behavior)
{
$this->Behavior = $behavior;
$initialValue = $this->Behavior->timestamp();
$postValue = $this->Behavior->timestamp();
$this->assertSame(
$initialValue,
$postValue,
'The timestamp should be exactly the same object'
);
}
/**
* testGetTimestampRefreshes
*
* @depends testGetTimestamp
* @return void
*/
public function testGetTimestampRefreshes($behavior)
{
$this->Behavior = $behavior;
$initialValue = $this->Behavior->timestamp();
$postValue = $this->Behavior->timestamp(null, true);
$this->assertNotSame(
$initialValue,
$postValue,
'The timestamp should be a different object if refreshTimestamp is truthy'
);
}
/**
* testSetTimestampExplicit
*
* @return void
*/
public function testSetTimestampExplicit()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime();
$this->Behavior->timestamp($ts);
$return = $this->Behavior->timestamp();
$this->assertEquals(
$ts->format('c'),
$return->format('c'),
'Should return the same value as initially set'
);
}
/**
* testTouch
*
* @return void
*/
public function testTouch()
{
$table = $this->getMock('Cake\ORM\Table');
$this->Behavior = new TimestampBehavior($table);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$entity = new Entity(['username' => 'timestamp test']);
$return = $this->Behavior->touch($entity);
$this->assertTrue($return, 'touch is expected to return true if it sets a field value');
$this->assertSame(
$ts->format('Y-m-d H:i:s'),
$entity->modified->format('Y-m-d H:i:s'),
'Modified field is expected to be updated'
);
$this->assertNull($entity->created, 'Created field is NOT expected to change');
}
/**
* testTouchNoop
*
* @return void
*/
public function testTouchNoop()
{
$table = $this->getMock('Cake\ORM\Table');
$config = [
'events' => [
'Model.beforeSave' => [
'created' => 'new',
]
]
];
$this->Behavior = new TimestampBehavior($table, $config);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$entity = new Entity(['username' => 'timestamp test']);
$return = $this->Behavior->touch($entity);
$this->assertFalse($return, 'touch is expected to do nothing and return false');
$this->assertNull($entity->modified, 'Modified field is NOT expected to change');
$this->assertNull($entity->created, 'Created field is NOT expected to change');
}
/**
* testTouchCustomEvent
*
* @return void
*/
public function testTouchCustomEvent()
{
$table = $this->getMock('Cake\ORM\Table');
$settings = ['events' => ['Something.special' => ['date_specialed' => 'always']]];
$this->Behavior = new TimestampBehavior($table, $settings);
$ts = new \DateTime('2000-01-01');
$this->Behavior->timestamp($ts);
$entity = new Entity(['username' => 'timestamp test']);
$return = $this->Behavior->touch($entity, 'Something.special');
$this->assertTrue($return, 'touch is expected to return true if it sets a field value');
$this->assertSame(
$ts->format('Y-m-d H:i:s'),
$entity->date_specialed->format('Y-m-d H:i:s'),
'Modified field is expected to be updated'
);
$this->assertNull($entity->created, 'Created field is NOT expected to change');
}
/**
* Test that calling save, triggers an insert including the created and updated field values
*
* @return void
*/
public function testSaveTriggersInsert()
{
$this->loadFixtures('Users');
$table = TableRegistry::get('users');
$table->addBehavior('Timestamp', [
'events' => [
'Model.beforeSave' => [
'created' => 'new',
'updated' => 'always'
]
]
]);
$entity = new Entity(['username' => 'timestamp test']);
$return = $table->save($entity);
$this->assertSame($entity, $return, 'The returned object is expected to be the same entity object');
$row = $table->find('all')->where(['id' => $entity->id])->first();
$now = Time::now();
$this->assertEquals($now, $row->created);
$this->assertEquals($now, $row->updated);
}
}