feat: skip readonly properties on entities when generating factories (#…

…798)

Co-authored-by: Nicolas PHILIPPE <[email protected]>

.env

@@ -10,3 +10,4 @@ MONGO_URL="mongodb://127.0.0.1:27018/dbName?compressors=disabled&gssapiServi
 USE_DAMA_DOCTRINE_TEST_BUNDLE="0"
 USE_FOUNDRY_PHPUNIT_EXTENSION="0"
 PHPUNIT_VERSION="9" # allowed values: 9, 10, 11
+APP_ENV=test

composer.json

@@ -22,6 +22,7 @@
         "symfony/deprecation-contracts": "^2.2|^3.0",
         "symfony/framework-bundle": "^6.4|^7.0",
         "symfony/property-access": "^6.4|^7.0",
+        "symfony/property-info": "^6.4|^7.0",
         "symfony/var-exporter": "^6.4.9|~7.0.9|^7.1.2",
         "zenstruck/assert": "^1.4"
     },

src/Maker/Factory/FactoryGenerator.php

@@ -39,6 +39,7 @@ public function __construct(
         private \Traversable $defaultPropertiesGuessers,
         private FactoryClassMap $factoryClassMap,
         private NamespaceGuesser $namespaceGuesser,
+        private bool $forceProperties = false
     ) {
     }
 
@@ -150,6 +151,7 @@ private function createMakeFactoryData(Generator $generator, string $class, Make
             $this->staticAnalysisTool(),
             $persisted ?? false,
             $makeFactoryQuery->addPhpDoc(),
+            $this->forceProperties
         );
     }
 

src/Maker/Factory/MakeFactoryData.php

@@ -15,6 +15,7 @@
 use Doctrine\ORM\EntityRepository;
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
+use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
 use Zenstruck\Foundry\ObjectFactory;
 use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory;
 use Zenstruck\Foundry\Persistence\Proxy;
@@ -29,6 +30,8 @@ final class MakeFactoryData
     public const STATIC_ANALYSIS_TOOL_PHPSTAN = 'phpstan';
     public const STATIC_ANALYSIS_TOOL_PSALM = 'psalm';
 
+    private static ReflectionExtractor|null $propertyInfo = null;
+
     /** @var list<string> */
     private array $uses;
     /** @var array<string, string> */
@@ -43,6 +46,7 @@ public function __construct(
         private string $staticAnalysisTool,
         private bool $persisted,
         bool $withPhpDoc,
+        private bool $forceProperties
     ) {
         $this->uses = [
             $this->getFactoryClass(),
@@ -154,6 +158,22 @@ public function addDefaultProperty(string $propertyName, string $defaultValue):
     public function getDefaultProperties(): array
     {
         $defaultProperties = $this->defaultProperties;
+        $class = $this->object->getName();
+
+        /**
+         * If forceProperties is not set we filter out properties that can not be set because they're either readonly or have no setter.
+         * Useful for properties that auto generate when the entity is created and can not be changed like a createdAt property for example.
+         *
+         * We do this here because we need to get the class of the Entity which only seems to be accessible here.
+         */
+        $defaultProperties = array_filter($defaultProperties, function (string $propertyName) use ($class): bool {
+            if (true === $this->forceProperties) {
+                return true;
+            }
+
+            return self::propertyInfo()->isWritable($class, $propertyName) || self::propertyInfo()->isInitializable($class, $propertyName);
+        }, ARRAY_FILTER_USE_KEY);
+
         \ksort($defaultProperties);
 
         return $defaultProperties;
@@ -189,4 +209,9 @@ public function addEnumDefaultProperty(string $propertyName, string $enumClass):
             "self::faker()->randomElement({$enumShortClassName}::cases()),",
         );
     }
+
+    private static function propertyInfo(): ReflectionExtractor
+    {
+        return self::$propertyInfo ??= new ReflectionExtractor();
+    }
 }

src/ZenstruckFoundryBundle.php

@@ -231,6 +231,9 @@ public function loadExtension(array $config, ContainerConfigurator $configurator
             if (!isset($bundles['DoctrineBundle']) && !isset($bundles['DoctrineMongoDBBundle'])) {
                 $container->removeDefinition('.zenstruck_foundry.maker.factory.doctrine_scalar_fields_default_properties_guesser');
             }
+
+            $container->getDefinition('.zenstruck_foundry.maker.factory.generator')
+                ->setArgument('$forceProperties', $config['instantiator']['always_force_properties'] ?? false);
         } else {
             $configurator->import('../config/command_stubs.php');
         }

tests/Fixture/Maker/expected/does_force_initialization_of_non_settable_with_always_force.php

@@ -0,0 +1,59 @@
+<?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 App\Factory;
+
+use Zenstruck\Foundry\ObjectFactory;
+use Zenstruck\Foundry\Tests\Fixture\ObjectWithNonWriteable;
+
+/**
+ * @extends ObjectFactory<ObjectWithNonWriteable>
+ */
+final class ObjectWithNonWriteableFactory extends ObjectFactory
+{
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#factories-as-services
+     *
+     * @todo inject services if required
+     */
+    public function __construct()
+    {
+    }
+
+    public static function class(): string
+    {
+        return ObjectWithNonWriteable::class;
+    }
+
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#model-factories
+     *
+     * @todo add your default values here
+     */
+    protected function defaults(): array|callable
+    {
+        return [
+            'bar' => self::faker()->sentence(),
+            'baz' => self::faker()->sentence(),
+            'foo' => self::faker()->sentence(),
+        ];
+    }
+
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
+     */
+    protected function initialize(): static
+    {
+        return $this
+            // ->afterInstantiate(function(ObjectWithNonWriteable $objectWithNonWriteable): void {})
+        ;
+    }
+}

tests/Fixture/Maker/expected/does_not_initialize_non_settable.php

@@ -0,0 +1,58 @@
+<?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 App\Factory;
+
+use Zenstruck\Foundry\ObjectFactory;
+use Zenstruck\Foundry\Tests\Fixture\ObjectWithNonWriteable;
+
+/**
+ * @extends ObjectFactory<ObjectWithNonWriteable>
+ */
+final class ObjectWithNonWriteableFactory extends ObjectFactory
+{
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#factories-as-services
+     *
+     * @todo inject services if required
+     */
+    public function __construct()
+    {
+    }
+
+    public static function class(): string
+    {
+        return ObjectWithNonWriteable::class;
+    }
+
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#model-factories
+     *
+     * @todo add your default values here
+     */
+    protected function defaults(): array|callable
+    {
+        return [
+            'baz' => self::faker()->sentence(),
+            'foo' => self::faker()->sentence(),
+        ];
+    }
+
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
+     */
+    protected function initialize(): static
+    {
+        return $this
+            // ->afterInstantiate(function(ObjectWithNonWriteable $objectWithNonWriteable): void {})
+        ;
+    }
+}

tests/Fixture/ObjectWithNonWriteable.php

@@ -0,0 +1,41 @@
+<?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\Fixture;
+
+final class ObjectWithNonWriteable
+{
+    private string $bar;
+    // @phpstan-ignore-next-line We do not want assign a default value to this so the factory sets one
+    private string $baz;
+
+    public function __construct(
+        public readonly string $foo
+    ) {
+        $this->bar = 'bar';
+    }
+
+    public function getBaz(): string
+    {
+        return $this->baz;
+    }
+
+    public function setBaz(string $baz): ObjectWithNonWriteable
+    {
+        $this->baz = $baz;
+        return $this;
+    }
+
+    public function getBar(): string
+    {
+        return $this->bar;
+    }
+}

tests/Fixture/TestKernel.php

@@ -35,6 +35,10 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
     {
         parent::configureContainer($c, $loader);
 
+        if ($this->getEnvironment() !== 'test') {
+            $loader->load(\sprintf('%s/config/%s.yaml', __DIR__, $this->getEnvironment()));
+        }
+
         $c->loadFromExtension('zenstruck_foundry', [
             'orm' => [
                 'reset' => [

tests/Fixture/config/always_force.yaml

@@ -0,0 +1,3 @@
+zenstruck_foundry:
+    instantiator:
+        always_force_properties: true # always "force set" properties

tests/Integration/Maker/MakeFactoryTest.php

@@ -23,6 +23,7 @@
 use Zenstruck\Foundry\Tests\Fixture\Entity\WithEmbeddableEntity;
 use Zenstruck\Foundry\Tests\Fixture\Object1;
 use Zenstruck\Foundry\Tests\Fixture\ObjectWithEnum;
+use Zenstruck\Foundry\Tests\Fixture\ObjectWithNonWriteable;
 
 /**
  * @author Kevin Bond <[email protected]>
@@ -421,14 +422,40 @@ public function can_create_factory_with_default_enum(): void
         $this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ObjectWithEnumFactory.php'));
     }
 
+    /**
+     * @test
+     */
+    public function does_not_initialize_non_settable(): void
+    {
+        $tester = $this->makeFactoryCommandTester();
+
+        $tester->execute(['class' => ObjectWithNonWriteable::class, '--no-persistence' => true]);
+
+        $this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ObjectWithNonWriteableFactory.php'));
+    }
+
+    /**
+     * @test
+     */
+    public function does_force_initialization_of_non_settable_with_always_force(): void
+    {
+        $tester = $this->makeFactoryCommandTester('always_force');
+
+        $tester->execute(['class' => ObjectWithNonWriteable::class, '--no-persistence' => true]);
+
+        $this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ObjectWithNonWriteableFactory.php'));
+    }
+
     private function emulateSCAToolEnabled(string $scaToolFilePath): void
     {
         \mkdir(\dirname($scaToolFilePath), 0777, true);
         \touch($scaToolFilePath);
     }
 
-    private function makeFactoryCommandTester(): CommandTester
+    private function makeFactoryCommandTester(string $appEnv = 'test'): CommandTester
     {
-        return new CommandTester((new Application(self::bootKernel()))->find('make:factory'));
+        return new CommandTester((new Application(self::bootKernel([
+            'environment' => $appEnv,
+        ])))->find('make:factory'));
     }
 }