发布于 2015-08-27 16:46:30 | 133 次阅读 | 评论: 0 | 来源: 网络整理
The Form component consists of 3 core objects: a form type (implementing
FormTypeInterface), the
Form and the
FormView.
The only class that is usually manipulated by programmers is the form type class
which serves as a form blueprint. It is used to generate the Form and the
FormView. You could test it directly by mocking its interactions with the
factory but it would be complex. It is better to pass it to FormFactory like it
is done in a real application. It is simple to bootstrap and you can trust
the Symfony components enough to use them as a testing base.
There is already a class that you can benefit from for simple FormTypes
testing: TypeTestCase. It is used to
test the core types and you can use it to test your types too.
2.3 新版功能: The TypeTestCase has moved to the SymfonyComponentFormTest
namespace in 2.3. Previously, the class was located in
SymfonyComponentFormTestsExtensionCoreType.
注解
Depending on the way you installed your Symfony or Symfony Form component
the tests may not be downloaded. Use the --prefer-source option with
Composer if this is the case.
The simplest TypeTestCase implementation looks like the following:
// src/Acme/TestBundle/Tests/Form/Type/TestedTypeTest.php
namespace AcmeTestBundleTestsFormType;
use AcmeTestBundleFormTypeTestedType;
use AcmeTestBundleModelTestObject;
use SymfonyComponentFormTestTypeTestCase;
class TestedTypeTest extends TypeTestCase
{
public function testSubmitValidData()
{
$formData = array(
'test' => 'test',
'test2' => 'test2',
);
$type = new TestedType();
$form = $this->factory->create($type);
$object = TestObject::fromArray($formData);
// submit the data to the form directly
$form->submit($formData);
$this->assertTrue($form->isSynchronized());
$this->assertEquals($object, $form->getData());
$view = $form->createView();
$children = $view->children;
foreach (array_keys($formData) as $key) {
$this->assertArrayHasKey($key, $children);
}
}
}
So, what does it test? Here comes a detailed explanation.
First you verify if the FormType compiles. This includes basic class
inheritance, the buildForm function and options resolution. This should
be the first test you write:
$type = new TestedType();
$form = $this->factory->create($type);
This test checks that none of your data transformers used by the form
failed. The isSynchronized()
method is only set to false if a data transformer throws an exception:
$form->submit($formData);
$this->assertTrue($form->isSynchronized());
注解
Don’t test the validation: it is applied by a listener that is not active in the test case and it relies on validation configuration. Instead, unit test your custom constraints directly.
Next, verify the submission and mapping of the form. The test below checks if all the fields are correctly specified:
$this->assertEquals($object, $form->getData());
Finally, check the creation of the FormView. You should check if all
widgets you want to display are available in the children property:
$view = $form->createView();
$children = $view->children;
foreach (array_keys($formData) as $key) {
$this->assertArrayHasKey($key, $children);
}
Your form may depend on other types that are defined as services. It might look like this:
// src/Acme/TestBundle/Form/Type/TestedType.php
// ... the buildForm method
$builder->add('acme_test_child_type');
To create your form correctly, you need to make the type available to the
form factory in your test. The easiest way is to register it manually
before creating the parent form using the PreloadedExtension class:
// src/Acme/TestBundle/Tests/Form/Type/TestedTypeTests.php
namespace AcmeTestBundleTestsFormType;
use AcmeTestBundleFormTypeTestedType;
use AcmeTestBundleModelTestObject;
use SymfonyComponentFormTestTypeTestCase;
use SymfonyComponentFormPreloadedExtension;
class TestedTypeTest extends TypeTestCase
{
protected function getExtensions()
{
$childType = new TestChildType();
return array(new PreloadedExtension(array(
$childType->getName() => $childType,
), array()));
}
public function testSubmitValidData()
{
$type = new TestedType();
$form = $this->factory->create($type);
// ... your test
}
}
警告
Make sure the child type you add is well tested. Otherwise you may be getting errors that are not related to the form you are currently testing but to its children.
It often happens that you use some options that are added by
form extensions. One of the
cases may be the ValidatorExtension with its invalid_message option.
The TypeTestCase loads only the core form extension so an “Invalid option”
exception will be raised if you try to use it for testing a class that depends
on other extensions. You need add those extensions to the factory object:
// src/Acme/TestBundle/Tests/Form/Type/TestedTypeTests.php
namespace AcmeTestBundleTestsFormType;
use AcmeTestBundleFormTypeTestedType;
use AcmeTestBundleModelTestObject;
use SymfonyComponentFormTestTypeTestCase;
use SymfonyComponentFormForms;
use SymfonyComponentFormFormBuilder;
use SymfonyComponentFormExtensionValidatorTypeFormTypeValidatorExtension;
use SymfonyComponentValidatorConstraintViolationList;
class TestedTypeTest extends TypeTestCase
{
protected function setUp()
{
parent::setUp();
$validator = $this->getMock('SymfonyComponentValidatorValidatorValidatorInterface');
$validator->method('validate')->will($this->returnValue(new ConstraintViolationList()));
$this->factory = Forms::createFormFactoryBuilder()
->addExtensions($this->getExtensions())
->addTypeExtension(
new FormTypeValidatorExtension(
$validator
)
)
->addTypeGuesser(
$this->getMockBuilder(
'SymfonyComponentFormExtensionValidatorValidatorTypeGuesser'
)
->disableOriginalConstructor()
->getMock()
)
->getFormFactory();
$this->dispatcher = $this->getMock('SymfonyComponentEventDispatcherEventDispatcherInterface');
$this->builder = new FormBuilder(null, null, $this->dispatcher, $this->factory);
}
// ... your tests
}
If you are not familiar yet with PHPUnit’s data providers, this might be a good opportunity to use them:
// src/Acme/TestBundle/Tests/Form/Type/TestedTypeTests.php
namespace AcmeTestBundleTestsFormType;
use AcmeTestBundleFormTypeTestedType;
use AcmeTestBundleModelTestObject;
use SymfonyComponentFormTestTypeTestCase;
class TestedTypeTest extends TypeTestCase
{
/**
* @dataProvider getValidTestData
*/
public function testForm($data)
{
// ... your test
}
public function getValidTestData()
{
return array(
array(
'data' => array(
'test' => 'test',
'test2' => 'test2',
),
),
array(
'data' => array(),
),
array(
'data' => array(
'test' => null,
'test2' => null,
),
),
);
}
}
The code above will run your test three times with 3 different sets of data. This allows for decoupling the test fixtures from the tests and easily testing against multiple sets of data.
You can also pass another argument, such as a boolean if the form has to be synchronized with the given set of data or not etc.