Add form tests + document the TypeTestCase + LiveCollection pattern

loevgaard · loevgaard · commit c18a3489f9ef · 2026-05-11T09:33:45.000+02:00
Three new test files covering src/Form:

- tests/Form/Type/PriceTierTypeTest — TypeTestCase-based, 8 tests:
  bind quantity/discount/channel into a PriceTier; empty payload is a
  no-op (the nullable-setter contract); PRE_SET_DATA listener adds
  productVariant only when initial data has a product; data_class and
  validation_groups propagate from AbstractResourceType; block_prefix
  is stable.

- tests/Form/Type/PriceTierCollectionTypeTest — TypeTestCase-based,
  12 tests covering configureOptions() defaults, getParent(),
  getBlockPrefix(), AND the Live Component decoration upstream
  symfony/ux-live-component's own LiveCollectionTypeTest verifies:
  button_add has the live_collection_button_add block prefix and the
  data-action="live#action" + data-live-action-param="addCollectionItem"
  attrs; each entry's button_delete has the
  live_collection_button_delete block prefix. Plus a data-binding
  round-trip test: submitting an array of payloads produces one
  PriceTier per entry. This is the real contract test — without
  asserting on the decorated view, a regression that swaps the parent
  back to plain CollectionType would slip through.

- tests/Form/Extension/ProductTypeExtensionTest — pure unit test
  with a prophesized FormBuilderInterface: extends ProductType,
  adds priceTiers field with PriceTierCollectionType + Valid +
  label=false.

CLAUDE.md gains the convention (under Conventions): form-type tests
extend Symfony\Component\Form\Test\TypeTestCase; for LiveCollectionType
parents, assert button_add/button_delete view decoration.

Suite: 33 -&gt; 59 tests, 57 -&gt; 101 assertions. ECS + PHPStan green.
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -69,5 +69,6 @@ Wiring:
 - Configuration of other bundles lives in `SetonoSyliusTierPricingExtension::prepend()` as inlined PHP arrays passed to `prependExtensionConfig()`. Do not read YAML files from disk inside `prepend()` and forward the parsed result.
 - DI service configuration is **PHP DSL**, not XML. New services go under `config/services/<topic>.php` using `ContainerConfigurator`. Use the FQCN as the service id and alias `*Interface` to it for forward compatibility.
 - **Mocks: always use Prophecy** (`Prophecy\PhpUnit\ProphecyTrait` + `$this->prophesize(...)->reveal()`). Don't mix with PHPUnit's native `createMock()` / `createStub()` — keep doubles consistent across the suite. The `setono/sylius-plugin` toolchain ships `jangregor/phpstan-prophecy` so PHPStan understands `prophesize()` return types.
+- **Form-type tests**: extend `Symfony\Component\Form\Test\TypeTestCase` (see <https://symfony.com/doc/6.4/form/unit_testing.html>). Register the SUT + its child types via `getTypes()` (cleaner than `PreloadedExtension` when types are easily instantiable); for Sylius types that need services, prophesize the deps and pass them to the type's constructor. Use `$this->factory->create(SUT::class, $initialData)` then `submit([...])`, and assert against `isSynchronized()` + `getData()` + child-form presence with `$form->has('fieldName')`. **For form types whose parent is `LiveCollectionType`**, mirror the upstream `symfony/ux-live-component` test (`Symfony\UX\LiveComponent\Tests\Unit\Form\Type\LiveCollectionTypeTest`): call `createView()` and assert that `$view->vars['button_add']->vars['block_prefixes']` contains `live_collection_button_add` (and `button_delete` on each entry contains `live_collection_button_delete`). That's the only test that proves the Live decoration actually ran — `configureOptions()` assertions alone won't catch a regression that flips `getParent()` back to plain `CollectionType`.
 - Before each commit, run `composer fix-style`, `composer analyse`, and `composer phpunit` and fix what they flag. Don't commit on top of pre-existing failures.
 - Prefer **relative paths** in shell commands (`./tests/Application/bin/console ...`, `composer ...`). Absolute paths inside the working directory trigger Claude Code permission prompts. If you `cd` into `tests/Application/`, `cd` back to the project root before subsequent commands rather than chaining absolute paths.
diff --git a/tests/Form/Extension/ProductTypeExtensionTest.php b/tests/Form/Extension/ProductTypeExtensionTest.php
@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusTierPricingPlugin\Tests\Form\Extension;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Setono\SyliusTierPricingPlugin\Form\Extension\ProductTypeExtension;
+use Setono\SyliusTierPricingPlugin\Form\Type\PriceTierCollectionType;
+use Sylius\Bundle\ProductBundle\Form\Type\ProductType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Validator\Constraints\Valid;
+
+final class ProductTypeExtensionTest extends TestCase
+{
+    use ProphecyTrait;
+
+    #[Test]
+    public function it_extends_the_sylius_product_form_type(): void
+    {
+        self::assertSame([ProductType::class], iterator_to_array(
+            (function (): \Generator {
+                yield from ProductTypeExtension::getExtendedTypes();
+            })(),
+        ));
+    }
+
+    #[Test]
+    public function it_adds_the_price_tiers_field_with_a_valid_constraint_and_no_label(): void
+    {
+        $builder = $this->prophesize(FormBuilderInterface::class);
+        $builder
+            ->add(
+                'priceTiers',
+                PriceTierCollectionType::class,
+                Argument::that(static function (array $options): bool {
+                    if (false !== $options['label']) {
+                        return false;
+                    }
+
+                    if (!isset($options['constraints']) || !\is_array($options['constraints'])) {
+                        return false;
+                    }
+
+                    return 1 === count($options['constraints']) && $options['constraints'][0] instanceof Valid;
+                }),
+            )
+            ->shouldBeCalledOnce()
+            ->willReturn($builder->reveal());
+
+        (new ProductTypeExtension())->buildForm($builder->reveal(), []);
+    }
+}
diff --git a/tests/Form/Type/PriceTierCollectionTypeTest.php b/tests/Form/Type/PriceTierCollectionTypeTest.php
@@ -0,0 +1,219 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusTierPricingPlugin\Tests\Form\Type;
+
+use PHPUnit\Framework\Attributes\Test;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Setono\SyliusTierPricingPlugin\Form\Type\PriceTierCollectionType;
+use Setono\SyliusTierPricingPlugin\Form\Type\PriceTierType;
+use Setono\SyliusTierPricingPlugin\Model\PriceTier;
+use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
+use Sylius\Bundle\ProductBundle\Form\Type\ProductVariantChoiceType;
+use Sylius\Component\Core\Model\Channel;
+use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Resource\Doctrine\Persistence\RepositoryInterface;
+use Symfony\Component\Form\FormView;
+use Symfony\Component\Form\Test\TypeTestCase;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\UX\LiveComponent\Form\Type\LiveCollectionType;
+
+final class PriceTierCollectionTypeTest extends TypeTestCase
+{
+    use ProphecyTrait;
+
+    private Channel $channel;
+
+    protected function setUp(): void
+    {
+        $this->channel = $this->channel('WEB');
+
+        parent::setUp();
+    }
+
+    // -----------------------------------------------------------------------
+    // configureOptions() — option defaults
+    // -----------------------------------------------------------------------
+
+    #[Test]
+    public function it_extends_live_collection_type_so_add_and_delete_fire_server_side_via_live_components(): void
+    {
+        self::assertSame(LiveCollectionType::class, (new PriceTierCollectionType())->getParent());
+    }
+
+    #[Test]
+    public function it_uses_price_tier_type_as_the_entry_type_with_a_blank_per_row_label(): void
+    {
+        $options = $this->resolveOptions();
+
+        self::assertSame(PriceTierType::class, $options['entry_type']);
+        self::assertSame(['label' => false], $options['entry_options']);
+    }
+
+    #[Test]
+    public function it_allows_adding_and_deleting_rows(): void
+    {
+        $options = $this->resolveOptions();
+
+        self::assertTrue($options['allow_add']);
+        self::assertTrue($options['allow_delete']);
+    }
+
+    #[Test]
+    public function it_disables_by_reference_so_the_owning_side_of_the_relation_is_updated_on_save(): void
+    {
+        self::assertFalse($this->resolveOptions()['by_reference']);
+    }
+
+    #[Test]
+    public function it_pins_block_name_to_entry_matching_the_sylius_image_collection_convention(): void
+    {
+        self::assertSame('entry', $this->resolveOptions()['block_name']);
+    }
+
+    #[Test]
+    public function it_labels_the_add_button_with_the_plugin_translation_key(): void
+    {
+        self::assertSame(
+            ['label' => 'setono_sylius_tier_pricing.ui.add_price_tier'],
+            $this->resolveOptions()['button_add_options'],
+        );
+    }
+
+    #[Test]
+    public function it_exposes_a_predictable_block_prefix_for_template_overrides(): void
+    {
+        self::assertSame(
+            'setono_sylius_tier_pricing_price_tier_collection',
+            (new PriceTierCollectionType())->getBlockPrefix(),
+        );
+    }
+
+    // -----------------------------------------------------------------------
+    // Live decoration — the contract that makes Add/Delete fire over the wire.
+    // Mirrors symfony/ux-live-component's own LiveCollectionTypeTest.
+    // -----------------------------------------------------------------------
+
+    #[Test]
+    public function the_add_button_view_carries_the_live_collection_button_add_block_prefix(): void
+    {
+        $blockPrefixes = $this->buttonAddView()->vars['block_prefixes'];
+        assert(is_array($blockPrefixes));
+
+        self::assertContains('live_collection_button_add', $blockPrefixes);
+    }
+
+    #[Test]
+    public function the_add_button_view_emits_the_live_action_attributes_for_addCollectionItem(): void
+    {
+        $attr = $this->buttonAddView()->vars['attr'];
+        assert(is_array($attr));
+
+        self::assertSame('live#action', $attr['data-action']);
+        self::assertSame('addCollectionItem', $attr['data-live-action-param']);
+        self::assertSame('price_tiers', $attr['data-live-name-param']);
+    }
+
+    #[Test]
+    public function each_entry_view_carries_a_delete_button_with_the_live_collection_button_delete_block_prefix(): void
+    {
+        $view = $this->factory
+            ->createNamed('price_tiers', PriceTierCollectionType::class, [new PriceTier()])
+            ->createView();
+        self::assertCount(1, $view);
+
+        $buttonDelete = $view[0]->vars['button_delete'];
+        assert($buttonDelete instanceof FormView);
+        $blockPrefixes = $buttonDelete->vars['block_prefixes'];
+        assert(is_array($blockPrefixes));
+
+        self::assertContains('live_collection_button_delete', $blockPrefixes);
+    }
+
+    #[Test]
+    public function the_add_button_label_resolves_to_the_plugin_translation_key(): void
+    {
+        self::assertSame(
+            'setono_sylius_tier_pricing.ui.add_price_tier',
+            $this->buttonAddView()->vars['label'],
+        );
+    }
+
+    // -----------------------------------------------------------------------
+    // Data binding — submit a list of entries, verify each becomes a PriceTier.
+    // -----------------------------------------------------------------------
+
+    #[Test]
+    public function submitting_an_array_of_payloads_produces_one_price_tier_per_entry(): void
+    {
+        $form = $this->factory->createNamed('price_tiers', PriceTierCollectionType::class);
+        $form->submit([
+            ['quantity' => '5', 'discount' => '10', 'channel' => 'WEB'],
+            ['quantity' => '10', 'discount' => '20', 'channel' => ''],
+        ]);
+
+        self::assertTrue($form->isSynchronized());
+
+        /** @var list<PriceTier> $tiers */
+        $tiers = $form->getData();
+        self::assertCount(2, $tiers);
+        self::assertContainsOnlyInstancesOf(PriceTier::class, $tiers);
+        self::assertSame(5, $tiers[0]->getQuantity());
+        self::assertSame($this->channel, $tiers[0]->getChannel());
+        self::assertSame(10, $tiers[1]->getQuantity());
+        self::assertNull($tiers[1]->getChannel());
+    }
+
+    protected function getTypes(): array
+    {
+        return [
+            new PriceTierType(PriceTier::class, ['setono_sylius_tier_pricing']),
+            new ChannelChoiceType($this->channelRepository()),
+            new ProductVariantChoiceType(),
+        ];
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    private function resolveOptions(): array
+    {
+        $resolver = new OptionsResolver();
+        (new PriceTierCollectionType())->configureOptions($resolver);
+
+        /** @var array<string, mixed> $resolved */
+        $resolved = $resolver->resolve();
+
+        return $resolved;
+    }
+
+    private function buttonAddView(): FormView
+    {
+        $view = $this->factory
+            ->createNamed('price_tiers', PriceTierCollectionType::class, [])
+            ->createView();
+        $buttonAdd = $view->vars['button_add'];
+        assert($buttonAdd instanceof FormView);
+
+        return $buttonAdd;
+    }
+
+    /** @return RepositoryInterface<ChannelInterface> */
+    private function channelRepository(): RepositoryInterface
+    {
+        $repository = $this->prophesize(RepositoryInterface::class);
+        $repository->findAll()->willReturn([$this->channel]);
+
+        return $repository->reveal();
+    }
+
+    private function channel(string $code): Channel
+    {
+        $channel = new Channel();
+        $channel->setCode($code);
+        $channel->setName($code);
+
+        return $channel;
+    }
+}
diff --git a/tests/Form/Type/PriceTierTypeTest.php b/tests/Form/Type/PriceTierTypeTest.php
