-
-
Notifications
You must be signed in to change notification settings - Fork 85
/
Copy pathMakeFactoryTest.php
451 lines (356 loc) · 14.4 KB
/
MakeFactoryTest.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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
<?php
/*
* This file is part of the zenstruck/foundry package.
*
* (c) Kevin Bond <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Zenstruck\Foundry\Tests\Integration\Maker;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
use Symfony\Component\Console\Tester\CommandTester;
use Zenstruck\Foundry\Maker\Factory\FactoryGenerator;
use Zenstruck\Foundry\Tests\Fixture\Document\GenericDocument;
use Zenstruck\Foundry\Tests\Fixture\Document\WithEmbeddableDocument;
use Zenstruck\Foundry\Tests\Fixture\Entity\Address;
use Zenstruck\Foundry\Tests\Fixture\Entity\Category;
use Zenstruck\Foundry\Tests\Fixture\Entity\Contact;
use Zenstruck\Foundry\Tests\Fixture\Entity\GenericEntity;
use Zenstruck\Foundry\Tests\Fixture\Entity\WithEmbeddableEntity;
use Zenstruck\Foundry\Tests\Fixture\Object1;
use Zenstruck\Foundry\Tests\Fixture\ObjectWithEnum;
/**
* @author Kevin Bond <[email protected]>
* @group maker
*/
final class MakeFactoryTest extends MakerTestCase
{
private const PHPSTAN_PATH = __DIR__.'/../../..'.FactoryGenerator::PHPSTAN_PATH;
private const PSALM_PATH = __DIR__.'/../../..'.FactoryGenerator::PSALM_PATH;
protected function setUp(): void
{
self::assertDirectoryDoesNotExist(self::tempDir());
parent::setUp();
}
protected function tearDown(): void
{
parent::tearDown();
$removeSCAMock = static function(string $file): void {
if (\file_exists($file)) {
\unlink($file);
\rmdir(\dirname($file));
\rmdir(\dirname($file, 2));
}
};
$removeSCAMock(self::PHPSTAN_PATH);
$removeSCAMock(self::PSALM_PATH);
}
/**
* @test
*/
public function can_create_factory(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => Category::class]);
$output = $tester->getDisplay();
$this->assertStringContainsString('Note: pass --test if you want to generate factories in your tests/ directory', $output);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/CategoryFactory.php'));
}
/**
* @test
*/
public function can_create_factory_interactively(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->setInputs([
Contact::class, // which class to create a factory for?
'yes', // should create PostFactory for Contact::$address?
]);
$tester->execute([], ['interactive' => true]);
$output = $tester->getDisplay();
$this->assertStringContainsString(
'A factory for class "Zenstruck\Foundry\Tests\Fixture\Entity\Address" is missing for field Contact::$address. Do you want to create it?',
$output,
);
$this->assertFileExists(self::tempFile('src/Factory/AddressFactory.php'));
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ContactFactory.php'));
}
/**
* @test
*/
public function can_create_factory_in_test_dir(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => Category::class, '--test' => true]);
$this->assertFileExists(self::tempFile('tests/Factory/CategoryFactory.php'));
}
/**
* @test
*/
public function can_create_factory_in_test_dir_with_nested_factory_already_created(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => Contact::class, '--test' => true]);
$tester->execute(['class' => Address::class, '--test' => true]);
$this->assertFileExists(self::tempFile('tests/Factory/ContactFactory.php'));
$this->assertFileExists(self::tempFile('tests/Factory/AddressFactory.php'));
}
/**
* @test
* @dataProvider scaToolProvider
*/
public function can_create_factory_with_static_analysis_annotations(string $scaTool): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$this->emulateSCAToolEnabled($scaTool);
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => Category::class, '--test' => true, '--with-phpdoc' => true]);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('tests/Factory/CategoryFactory.php'));
}
/**
* @return iterable<string, array{0: string}>
*/
public static function scaToolProvider(): iterable
{
yield 'phpstan' => [self::PHPSTAN_PATH];
yield 'psalm' => [self::PSALM_PATH];
}
/**
* @test
*/
public function can_create_factory_for_entity_with_repository(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => GenericEntity::class, '--with-phpdoc' => true]);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/GenericEntityFactory.php'));
}
/**
* @test
*/
public function invalid_entity_throws_exception(): void
{
$tester = $this->makeFactoryCommandTester();
try {
$tester->execute(['class' => 'Invalid']);
} catch (RuntimeCommandException $e) {
$this->assertSame('Class "Invalid" not found.', $e->getMessage());
$this->assertFileDoesNotExist(self::tempFile('src/Factory/InvalidFactory.php'));
return;
}
$this->fail('Exception not thrown.');
}
/**
* @test
*/
public function can_create_factory_for_not_persisted_class(): void
{
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => Object1::class, '--no-persistence' => true, '--all-fields' => true]);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/Object1Factory.php'));
}
/**
* @test
*/
public function can_create_factory_for_not_persisted_class_interactively(): void
{
$tester = $this->makeFactoryCommandTester();
$tester->setInputs(['Foo', Object1::class]); // "Foo" will generate a validation error
$tester->execute(['--no-persistence' => true]);
$output = $tester->getDisplay();
$this->assertStringContainsString('Not persisted fully qualified class name to create a factory for:', $output);
$this->assertStringContainsString('[ERROR] Given class "Foo" does not exist', $output);
$this->assertFileExists(self::tempFile('src/Factory/Object1Factory.php'));
}
/**
* @test
*/
public function can_customize_namespace(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->setInputs([GenericEntity::class]);
$tester->execute(['--namespace' => 'My\\Namespace']);
$expectedFile = self::tempFile('src/My/Namespace/GenericEntityFactory.php');
$this->assertFileExists($expectedFile);
$this->assertStringContainsString('namespace App\\My\\Namespace;', \file_get_contents($expectedFile) ?: '');
}
/**
* @test
*/
public function can_customize_namespace_with_test_flag(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->setInputs([GenericEntity::class]);
$tester->execute(['--namespace' => 'My\\Namespace', '--test' => true]);
$expectedFile = self::tempFile('tests/My/Namespace/GenericEntityFactory.php');
$this->assertFileExists($expectedFile);
$this->assertStringContainsString('namespace App\\Tests\\My\\Namespace;', \file_get_contents($expectedFile) ?: '');
}
/**
* @test
*/
public function can_customize_namespace_with_root_namespace_prefix(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->setInputs([GenericEntity::class]);
$tester->execute(['--namespace' => 'App\\My\\Namespace']);
$expectedFile = self::tempFile('src/My/Namespace/GenericEntityFactory.php');
$this->assertFileExists($expectedFile);
$this->assertStringContainsString('namespace App\\My\\Namespace;', \file_get_contents($expectedFile) ?: '');
}
/**
* @test
*/
public function can_customize_namespace_with_test_flag_with_root_namespace_prefix(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->setInputs([GenericEntity::class]);
$tester->execute(['--namespace' => 'App\\Tests\\My\\Namespace', '--test' => true]);
$expectedFile = self::tempFile('tests/My/Namespace/GenericEntityFactory.php');
$this->assertFileExists($expectedFile);
$this->assertStringContainsString('namespace App\\Tests\\My\\Namespace;', \file_get_contents($expectedFile) ?: '');
}
/**
* @test
* @dataProvider documentProvider
*/
public function can_create_factory_for_odm(string $class, string $file): void
{
if (!\getenv('MONGO_URL')) {
self::markTestSkipped('doctrine/odm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->setInputs([$class]);
$tester->execute([]);
$this->assertFileExists(self::tempFile("src/Factory/{$file}.php"));
}
/**
* @return iterable<string, array{0: string, 1: string}>
*/
public static function documentProvider(): iterable
{
yield 'document' => [GenericDocument::class, 'GenericDocumentFactory'];
yield 'embedded document' => [WithEmbeddableDocument::class, 'WithEmbeddableDocumentFactory'];
}
/**
* @test
*/
public function can_create_all_factories_for_doctrine_objects(): void
{
if (!\getenv('MONGO_URL') && !\getenv('DATABASE_URL')) {
self::markTestSkipped('Some persistence should be activated.');
}
$tester = $this->makeFactoryCommandTester();
$inputs = ['All']; // which factory to generate?
$tester->setInputs($inputs);
$tester->execute([]);
$expectedFactories = [];
if (\getenv('DATABASE_URL')) {
$expectedFactories = ['EmbeddableFactory', 'GenericEntityFactory', 'GlobalEntityFactory', 'WithEmbeddableEntityFactory'];
}
if (\getenv('MONGO_URL')) {
$expectedFactories = [...$expectedFactories, 'GenericDocumentFactory', 'GlobalDocumentFactory', 'WithEmbeddableDocumentFactory'];
}
self::assertGreaterThan(0, \count($expectedFactories));
foreach ($expectedFactories as $expectedFactory) {
$this->assertFileExists(self::tempFile("src/Factory/{$expectedFactory}.php"));
}
}
/**
* @test
*/
public function can_create_factory_with_auto_activated_not_persisted_option(): void
{
if (\getenv('MONGO_URL') || \getenv('DATABASE_URL')) {
self::markTestSkipped('No persistence should be activated.');
}
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => GenericEntity::class]);
$output = $tester->getDisplay();
$this->assertStringContainsString('Note: Doctrine not enabled: auto-activating --no-persistence option.', $output);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/GenericEntityFactory.php'));
}
/**
* @test
*/
public function can_create_factory_with_all_fields(): void
{
if (!\getenv('DATABASE_URL')) {
self::markTestSkipped('doctrine/orm not enabled.');
}
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => GenericEntity::class, '--all-fields' => true]);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/GenericEntityFactory.php'));
}
/**
* @test
* @dataProvider objectsWithEmbeddableProvider
*/
public function can_create_factory_with_embeddable(string $objectClass, string $objectFactoryName): void
{
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => $objectClass, '--all-fields' => true]);
$this->assertFileExists(self::tempFile('src/Factory/EmbeddableFactory.php'));
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile("src/Factory/{$objectFactoryName}.php"));
}
/**
* @return iterable<string, array{0: string, 1: string}>
*/
public static function objectsWithEmbeddableProvider(): iterable
{
if (\getenv('DATABASE_URL')) {
yield 'orm' => [WithEmbeddableEntity::class, 'WithEmbeddableEntityFactory'];
}
if (\getenv('MONGO_URL')) {
yield 'odm' => [WithEmbeddableDocument::class, 'WithEmbeddableDocumentFactory'];
}
}
/**
* @test
*/
public function can_create_factory_with_default_enum(): void
{
$tester = $this->makeFactoryCommandTester();
$tester->execute(['class' => ObjectWithEnum::class, '--no-persistence' => true]);
$this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ObjectWithEnumFactory.php'));
}
private function emulateSCAToolEnabled(string $scaToolFilePath): void
{
\mkdir(\dirname($scaToolFilePath), 0777, true);
\touch($scaToolFilePath);
}
private function makeFactoryCommandTester(): CommandTester
{
return new CommandTester((new Application(self::bootKernel()))->find('make:factory'));
}
}