[DX] [Form] Add helper method to register form extensions during unit testing #21780

pierredup · 2017-02-27T13:24:18Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	N/A
License	MIT
Doc PR	symfony/symfony-docs#7578

Add helper method to register form extensions during unit testing, so it's easier to register custom form type extensions, form types, or type guessers

xabbuh · 2017-02-27T15:53:13Z

src/Symfony/Component/Form/Test/TypeTestCase.php

    protected function setUp()
    {
        parent::setUp();

        $this->dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
        $this->builder = new FormBuilder(null, null, $this->dispatcher, $this->factory);
+        $this->validator = $this->getMockBuilder('Symfony\Component\Validator\Validator\ValidatorInterface')->getMock();


This will break existing applications that use the TypeTestCase class, but do not have the Validator component installed.

Wrapped the extension in a check to make sure ValidatorInterface exists

xabbuh · 2017-02-27T19:58:30Z

src/Symfony/Component/Form/Test/TypeTestCase.php

@@ -34,6 +36,20 @@ protected function setUp()
        $this->builder = new FormBuilder(null, null, $this->dispatcher, $this->factory);
    }

+    protected function getTypedExtensions()


If you want this to be called automatically based on the parent FormIntegrationTestCase class, you will have to rename this method to getTypeExtensions().

Thanks, it was supposed to be getTypeExtensions, I don't know how that d sneaked in there

HeahDude · 2017-03-03T22:15:49Z

Hi @pierredup, thank you for proposing this.

In fact there is already this TypeTestCase form the validator extension that can be extended, it does extend the base TypeTestCase with the change you suggest.

I've opened symfony/symfony-docs#7566 so we don't forget to document it, we may close here though.

pierredup · 2017-03-04T07:50:52Z

@HeahDude I initially did try using that, but I got the error Invalid argument supplied for foreach() in Symfony/Component/Form/Extension/Validator/EventListener/ValidationListener.php:57.

This is because the validate method is not mocked, which means when it is called it just returns null which breaks the listener. So to solve this I can add the mock to the validator TypeTestCase class, but I opted to rather update the base TypeTestCase since most people would probably use that class in their tests and not know about the other class. But I'm happy to make that change instead.

This still leaves the issue that it's not easy to register your own type extensions. You can pass it as the second argument to the PreloadedExtension class, but that is not very intuitive (I'm not sure if most people even know about this).
Having a method to register a type extension the same as the getExtensions method is a lot clearer and easier to use

HeahDude · 2017-03-04T13:19:25Z

src/Symfony/Component/Form/Test/TypeTestCase.php

+
+        if (interface_exists(ValidatorInterface::class)) {
+            $validator = $this->getMockBuilder(ValidatorInterface::class)->getMock();
+            $validator->expects($this->any())->method('validate')->will($this->returnValue(array()));


Then only this line should be added in the proper validator extension base type, we don't need to add the extension overhead to all base tests.

HeahDude · 2017-03-04T13:25:55Z

src/Symfony/Component/Form/Test/FormIntegrationTestCase.php

            ->getFormFactory();
    }

    protected function getExtensions()
    {
        return array();
    }
+
+    protected function getTypeExtensions()


If this line were too be added in favor of:

use Symfony\Component\Form\PreloadedExtension; // ... protected function getExtensions() { return array(new PreloadedExtension( array(new SomeType($this->getDependencyMock())), array(new SomeTypeExtension(new SomeService()), array( new SomeGuesser($this->getDependencyMock2()), new SomeOtherGuesser()), ), )); }

We should also add two other protected functions for types and guessers, and add addTypeGuessers and addTypes call above as well to be consistent.

I would not vote against it, but I would vote for a better doc.

pierredup · 2017-03-06T07:37:30Z

I created a separate PR (#21886) to address the validate method issue, which can go as a bug fix, and updated this PR as a new feature to include extra helper methods to register form extensions for unit testing for DX

xabbuh · 2017-03-06T07:52:52Z

👍

Status: Reviewed

fabpot · 2017-03-06T16:17:07Z

Can you add a note in the CHANGELOG?

fabpot · 2017-03-06T18:22:00Z

Thank you @pierredup.

fabpot · 2017-03-06T18:23:25Z

see 638bdc8

xabbuh · 2017-04-15T12:36:44Z

src/Symfony/Component/Form/Test/FormIntegrationTestCase.php

            ->getFormFactory();
    }

    protected function getExtensions()
    {
        return array();
    }
+
+    protected function getTypedExtensions()


the method should IMO be named getTypeExtensions()

…or unit testing (pierredup) This PR was squashed before being merged into the master branch (closes #7578). Discussion ---------- Add docs to register custom form extensions and types for unit testing Docs for symfony/symfony#21780 to register custom extensions and types Commits ------- 45d6ed8 Add docs to register custom form extensions and types for unit testing

…) (xabbuh) This PR was merged into the 3.3-dev branch. Discussion ---------- [Form] rename getTypedExtensions() to getTypeExtensions() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #21780 (comment) | License | MIT | Doc PR | Commits ------- 099f626 rename getTypedExtensions() to getTypeExtensions()

carsonbot added Status: Needs Review Form Feature labels Feb 27, 2017

pierredup force-pushed the form-type-extensions branch from 279b0ef to 082c642 Compare February 27, 2017 13:26

nicolas-grekas added this to the 3.3 milestone Feb 27, 2017

xabbuh reviewed Feb 27, 2017

View reviewed changes

pierredup force-pushed the form-type-extensions branch from 082c642 to 4986008 Compare February 27, 2017 19:12

xabbuh reviewed Feb 27, 2017

View reviewed changes

Add the FormTypeValidatorExtension to the TypeTestCase factory builder

3481246

pierredup force-pushed the form-type-extensions branch from 4986008 to 3481246 Compare February 27, 2017 20:06

smithandre approved these changes Feb 27, 2017

View reviewed changes

HeahDude mentioned this pull request Mar 3, 2017

[Form] Missing note about validation and form type tests symfony/symfony-docs#7566

Closed

HeahDude suggested changes Mar 4, 2017

View reviewed changes

pierredup added 2 commits March 6, 2017 09:07

Mock validate call in the validator form TypeTestCase

b3b2c22

Fix use statements

1a1d8ad

pierredup changed the title ~~[Form] Add the FormTypeValidatorExtension to the TypeTestCase factory builder~~ [Form] Mar 6, 2017

pierredup changed the title ~~[Form]~~ [Form] Add validate method call to mocked validator in TypeTestCase Mar 6, 2017

Add helper method to register form extensions during unit testing

198a601

pierredup changed the title ~~[Form] Add validate method call to mocked validator in TypeTestCase~~ [Form] Add helper method to register form extensions during unit testing Mar 6, 2017

pierredup changed the title ~~[Form] Add helper method to register form extensions during unit testing~~ [DX] [Form] Add helper method to register form extensions during unit testing Mar 6, 2017

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 6, 2017

pierredup mentioned this pull request Mar 6, 2017

Add docs to register custom form extensions and types for unit testing symfony/symfony-docs#7578

Closed

fabpot closed this in 7638f6e Mar 6, 2017

pierredup deleted the form-type-extensions branch March 7, 2017 18:12

HeahDude mentioned this pull request Mar 10, 2017

Remove Validator\TypeTestCase and add validator logic to base TypeTestCase #21960

Closed

xabbuh reviewed Apr 15, 2017

View reviewed changes

xabbuh mentioned this pull request Apr 15, 2017

[Form] rename getTypedExtensions() to getTypeExtensions() #22445

Merged

ogizanagi mentioned this pull request May 1, 2017

[Form] RepeatedType does not allow invalid_options #22593

Closed

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX] [Form] Add helper method to register form extensions during unit testing #21780

[DX] [Form] Add helper method to register form extensions during unit testing #21780

pierredup commented Feb 27, 2017 •

edited

Loading

xabbuh Feb 27, 2017

pierredup Feb 27, 2017

xabbuh Feb 27, 2017

pierredup Feb 27, 2017

HeahDude commented Mar 3, 2017

pierredup commented Mar 4, 2017

HeahDude Mar 4, 2017

HeahDude Mar 4, 2017 •

edited

Loading

pierredup commented Mar 6, 2017 •

edited

Loading

xabbuh commented Mar 6, 2017

fabpot commented Mar 6, 2017

fabpot commented Mar 6, 2017

fabpot commented Mar 6, 2017

xabbuh Apr 15, 2017

[DX] [Form] Add helper method to register form extensions during unit testing #21780

[DX] [Form] Add helper method to register form extensions during unit testing #21780

Conversation

pierredup commented Feb 27, 2017 • edited Loading

xabbuh Feb 27, 2017

Choose a reason for hiding this comment

pierredup Feb 27, 2017

Choose a reason for hiding this comment

xabbuh Feb 27, 2017

Choose a reason for hiding this comment

pierredup Feb 27, 2017

Choose a reason for hiding this comment

HeahDude commented Mar 3, 2017

pierredup commented Mar 4, 2017

HeahDude Mar 4, 2017

Choose a reason for hiding this comment

HeahDude Mar 4, 2017 • edited Loading

Choose a reason for hiding this comment

pierredup commented Mar 6, 2017 • edited Loading

xabbuh commented Mar 6, 2017

fabpot commented Mar 6, 2017

fabpot commented Mar 6, 2017

fabpot commented Mar 6, 2017

xabbuh Apr 15, 2017

Choose a reason for hiding this comment

pierredup commented Feb 27, 2017 •

edited

Loading

HeahDude Mar 4, 2017 •

edited

Loading

pierredup commented Mar 6, 2017 •

edited

Loading