Symfony testowanie formularzy

Question

Witam,

mam problem z testowaniem błędów w formularzu, mam taki formularz:

<?php

declare(strict_types=1);

namespace App\Form;

use App\Entity\User;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\PasswordType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class UserType extends AbstractType
{
    /**
     * @param FormBuilderInterface $builder
     * @param array $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('username', TextType::class)
            ->add('plainPassword', PasswordType::class)
            ->add('email', EmailType::class)
        ;
    }

    /**
     * @param OptionsResolver $resolver
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'data_class' => User::class,
        ]);
    }
}

a tak wygląda mój validation.yaml

App\Entity\User:
  constraints:
    - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: username
    - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: email
  properties:
    username:
      - NotBlank: ~
      - Length:
          min: 3
          max: 80
    password:
      - Length:
          min: 8
    plainPassword:
      - NotBlank: ~
      - Length:
          min: 8
    email:
      - Email:
          message: The email "{{ value }}" is not a valid email.
          checkMX: true
      - NotBlank: ~
    createdAt:
      - DateTime: ~

chciałem przetestować formularz z danymi które nie mogą przejść walidacji ale wyrzuca mi błąd: Failed asserting that true is false, próbowałem robić tak jak jest napisane w dokumentacji symfony oraz ze stackoverflow ale nic nie działa :/

<?php

namespace App\Tests\Form;

use App\Entity\User;
use App\Form\UserType;
use Symfony\Component\Form\Extension\Core\CoreExtension;
use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
use Symfony\Component\Form\Form;
use Symfony\Component\Form\Test\TypeTestCase;
use Symfony\Component\Translation\IdentityTranslator;
use Symfony\Component\Validator\ConstraintValidatorFactory;
use Symfony\Component\Validator\Context\ExecutionContextFactory;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Tests\Fixtures\FakeMetadataFactory;
use Symfony\Component\Validator\Validator\RecursiveValidator;


class UserTypeTest extends TypeTestCase
{
    protected function getExtensions()
    {
        $extensions = parent::getExtensions();
        $metadataFactory = new FakeMetadataFactory();
        $metadataFactory->addMetadata(new ClassMetadata(  Form::class));
        $validator = $this->createValidator($metadataFactory);

        $extensions[] = new CoreExtension();
        $extensions[] = new ValidatorExtension($validator);

        return $extensions;
    }

    protected function createValidator(\Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface $metadataFactory, array $objectInitializers = array())
    {
        $translator = new IdentityTranslator();
        $translator->setLocale('en');
        $contextFactory = new ExecutionContextFactory($translator);
        $validatorFactory = new ConstraintValidatorFactory();
        return new RecursiveValidator($contextFactory, $metadataFactory, $validatorFactory, $objectInitializers);
    }

    /**
     * @dataProvider formDataIsValidProvider
     */
    public function testFormIfDataIsValid($formData, $user, $expected)
    {
        $form = $this->factory->create(UserType::class, $user);
        $form->submit($formData);

        $this->assertTrue($form->isSynchronized());
        $this->assertTrue($form->isValid());
        $this->assertEquals($expected, $user);
    }

    /**
     * @dataProvider formDataIsNotValidProvider
     */
    public function testFormIfDataIsNotValid($user, $formData)
    {
        $form = $this->factory->create(UserType::class, $user);
        $form->submit($formData);

        $this->assertFalse($form->isValid());
    }

    public function formDataIsValidProvider()
    {
        $formData = [
            'username' => 'Example',
            'plainPassword' => 'Example',
            'email' => 'Example',
        ];

        $user = new User();

        $expected = new User();
        $expected->setUsername('Example');
        $expected->setPlainPassword('Example');
        $expected->setEmail('Example');

        return [
            [ $formData, $user, $expected ]
        ];
    }

    public function formDataIsNotValidProvider()
    {
        $user = new User();

        $formDataIsBlank = [
            'username' => '',
            'plainPassword' => '',
            'email' => ''
        ];

        $formDataIsNotHaveLength = [
            'username' => '12',
            'plainPassword' => '1234567',
            'email' => 'e@gmail.com'
        ];

        $formDataBadEmail = [
            'username' => 'ExampleUsername',
            'plainPassword' => 'ExamplePassword',
            'email' => 'ExampleEmail'
        ];

        return [
            [ $user, $formDataIsBlank ],
            [ $user, $formDataIsNotHaveLength ],
            [ $user, $formDataBadEmail ]
        ];
    }
}

 

Answer 1

Strasznie przekombinowane IMO. Wyciągnij w teście z kontenera form Factory, stwórz formularz i submituj dane. Interesuje Cię tylko czy walid czy nie. Nie ma potrzeby sprawdzać tego przypisania bo to leży po stronie Symfony.

Jedynym przypadkiem kiedy sprawdzanie czy obiekt dobrze wygląda to użycie FORM_EVENTS.

Comments

czyli cały testFormIfDataIsNotValid do wywalenia i zostawić tylko testFormIfDataIsValid?

---

Generalnie tak, ale nie widzę sensu przekazywania w tym providerze pustego usera. Nie widzę również sensu istnienia tego providera skoro masz tylko jeden przypadek testowy.

---

test robiłem z dokumentacją symfony i tam był pusty user

https://symfony.com/doc/current/form/unit_testing.html#the-basics

---

Ok, co nie zmienia faktu, że i tak nie ma to dużego sensu. Test powinien być jak najmniejszy i przerabiać dużo przypadków. Nie odwrotnie.

---

rozumiem, jakieś jeszcze testy do tego formularza powinienem napisać czy testFormIfDataIsValid wystarczy?

---

Jeśli nie korzystasz z FORM_EVENTS to wystarczy. Zmień nazwę testIsValidationCorrect.

W phpunicie funkcje assert mają również argument message. Warto z niego korzystać.

---

dziękuje za pomoc, mam jeszcze jedno pytanie, czy do takiego serwisu można napisać jakiś wartościowy test?

class Register
{
    /** @var EntityManagerInterface  */
    private $entityManager;

    /** @var UserPasswordEncoderInterface  */
    private $passwordEncoder;

    /**
     * @param EntityManagerInterface $entityManager
     * @param UserPasswordEncoderInterface $encoder
     */
    public function __construct(
        EntityManagerInterface $entityManager,
        UserPasswordEncoderInterface $encoder
    ) {
        $this->entityManager = $entityManager;
        $this->passwordEncoder = $encoder;
    }

    /**
     * @param User $user
     * @return string
     */
    public function registerUser(User $user)
    {
        $user->setPassword(
            $this->passwordEncoder->encodePassword($user, $user->getPlainPassword())
        );

        $this->entityManager->persist($user);
        $this->entityManager->flush();

        return $user->getUsername();
    }
}