class FormSubmitterTest in Drupal 10

@coversDefaultClass \Drupal\Core\Form\FormSubmitter @group Form

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Form\FormSubmitterTest

File

core/tests/Drupal/Tests/Core/Form/FormSubmitterTest.php, line 19

Namespace

Drupal\Tests\Core\Form

class FormSubmitterTest extends UnitTestCase {

  /**
   * The mocked URL generator.
   *
   * @var \PHPUnit\Framework\MockObject\MockObject|\Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

  /**
   * The mocked unrouted URL assembler.
   *
   * @var \PHPUnit\Framework\MockObject\MockObject|\Drupal\Core\Utility\UnroutedUrlAssemblerInterface
   */
  protected $unroutedUrlAssembler;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->urlGenerator = $this
      ->createMock(UrlGeneratorInterface::class);
    $this->unroutedUrlAssembler = $this
      ->createMock(UnroutedUrlAssemblerInterface::class);
  }

  /**
   * @covers ::doSubmitForm
   */
  public function testHandleFormSubmissionNotSubmitted() {
    $form_submitter = $this
      ->getFormSubmitter();
    $form = [];
    $form_state = new FormState();
    $return = $form_submitter
      ->doSubmitForm($form, $form_state);
    $this
      ->assertFalse($form_state
      ->isExecuted());
    $this
      ->assertNull($return);
  }

  /**
   * @covers ::doSubmitForm
   */
  public function testHandleFormSubmissionNoRedirect() {
    $form_submitter = $this
      ->getFormSubmitter();
    $form = [];
    $form_state = (new FormState())
      ->setSubmitted()
      ->disableRedirect();
    $return = $form_submitter
      ->doSubmitForm($form, $form_state);
    $this
      ->assertTrue($form_state
      ->isExecuted());
    $this
      ->assertNull($return);
  }

  /**
   * @covers ::doSubmitForm
   *
   * @dataProvider providerTestHandleFormSubmissionWithResponses
   */
  public function testHandleFormSubmissionWithResponses($class, $form_state_key) {
    $response = $this
      ->getMockBuilder($class)
      ->disableOriginalConstructor()
      ->getMock();
    $response
      ->expects($this
      ->any())
      ->method('prepare')
      ->will($this
      ->returnValue($response));
    $form_state = (new FormState())
      ->setSubmitted()
      ->setFormState([
      $form_state_key => $response,
    ]);
    $form_submitter = $this
      ->getFormSubmitter();
    $form = [];
    $return = $form_submitter
      ->doSubmitForm($form, $form_state);
    $this
      ->assertInstanceOf('Symfony\\Component\\HttpFoundation\\Response', $return);
  }
  public function providerTestHandleFormSubmissionWithResponses() {
    return [
      [
        'Symfony\\Component\\HttpFoundation\\Response',
        'response',
      ],
      [
        'Symfony\\Component\\HttpFoundation\\RedirectResponse',
        'redirect',
      ],
    ];
  }

  /**
   * Tests the redirectForm() method when the redirect is NULL.
   *
   * @covers ::redirectForm
   */
  public function testRedirectWithNull() {
    $form_submitter = $this
      ->getFormSubmitter();
    $form_state = $this
      ->createMock('Drupal\\Core\\Form\\FormStateInterface');
    $form_state
      ->expects($this
      ->once())
      ->method('getRedirect')
      ->willReturn(NULL);
    $this->urlGenerator
      ->expects($this
      ->once())
      ->method('generateFromRoute')
      ->with('<current>', [], [
      'query' => [],
      'absolute' => TRUE,
    ])
      ->willReturn('http://localhost/test-path');
    $redirect = $form_submitter
      ->redirectForm($form_state);

    // If we have no redirect, we redirect to the current URL.
    $this
      ->assertSame('http://localhost/test-path', $redirect
      ->getTargetUrl());
    $this
      ->assertSame(303, $redirect
      ->getStatusCode());
  }

  /**
   * Tests redirectForm() when a redirect is a Url object.
   *
   * @covers ::redirectForm
   *
   * @dataProvider providerTestRedirectWithUrl
   */
  public function testRedirectWithUrl(Url $redirect_value, $result, $status = 303) {
    $container = new ContainerBuilder();
    $container
      ->set('url_generator', $this->urlGenerator);
    \Drupal::setContainer($container);
    $form_submitter = $this
      ->getFormSubmitter();
    $this->urlGenerator
      ->expects($this
      ->once())
      ->method('generateFromRoute')
      ->willReturnMap([
      [
        'test_route_a',
        [],
        [
          'absolute' => TRUE,
        ],
        FALSE,
        'test-route',
      ],
      [
        'test_route_b',
        [
          'key' => 'value',
        ],
        [
          'absolute' => TRUE,
        ],
        FALSE,
        'test-route/value',
      ],
    ]);
    $form_state = $this
      ->createMock('Drupal\\Core\\Form\\FormStateInterface');
    $form_state
      ->expects($this
      ->once())
      ->method('getRedirect')
      ->willReturn($redirect_value);
    $redirect = $form_submitter
      ->redirectForm($form_state);
    $this
      ->assertSame($result, $redirect
      ->getTargetUrl());
    $this
      ->assertSame($status, $redirect
      ->getStatusCode());
  }

  /**
   * Provides test data for testing the redirectForm() method with a route name.
   *
   * @return array
   *   Returns some test data.
   */
  public function providerTestRedirectWithUrl() {
    return [
      [
        new Url('test_route_a', [], [
          'absolute' => TRUE,
        ]),
        'test-route',
      ],
      [
        new Url('test_route_b', [
          'key' => 'value',
        ], [
          'absolute' => TRUE,
        ]),
        'test-route/value',
      ],
    ];
  }

  /**
   * Tests the redirectForm() method with a response object.
   *
   * @covers ::redirectForm
   */
  public function testRedirectWithResponseObject() {
    $form_submitter = $this
      ->getFormSubmitter();
    $redirect = new RedirectResponse('/example');
    $form_state = $this
      ->createMock('Drupal\\Core\\Form\\FormStateInterface');
    $form_state
      ->expects($this
      ->once())
      ->method('getRedirect')
      ->willReturn($redirect);
    $result_redirect = $form_submitter
      ->redirectForm($form_state);
    $this
      ->assertSame($redirect, $result_redirect);
  }

  /**
   * Tests the redirectForm() method when no redirect is expected.
   *
   * @covers ::redirectForm
   */
  public function testRedirectWithoutResult() {
    $form_submitter = $this
      ->getFormSubmitter();
    $this->urlGenerator
      ->expects($this
      ->never())
      ->method('generateFromRoute');
    $this->unroutedUrlAssembler
      ->expects($this
      ->never())
      ->method('assemble');
    $container = new ContainerBuilder();
    $container
      ->set('url_generator', $this->urlGenerator);
    $container
      ->set('unrouted_url_assembler', $this->unroutedUrlAssembler);
    \Drupal::setContainer($container);
    $form_state = $this
      ->createMock('Drupal\\Core\\Form\\FormStateInterface');
    $form_state
      ->expects($this
      ->once())
      ->method('getRedirect')
      ->willReturn(FALSE);
    $redirect = $form_submitter
      ->redirectForm($form_state);
    $this
      ->assertNull($redirect);
  }

  /**
   * @covers ::executeSubmitHandlers
   */
  public function testExecuteSubmitHandlers() {
    $form_submitter = $this
      ->getFormSubmitter();
    $mock = $this
      ->getMockForAbstractClass('Drupal\\Core\\Form\\FormBase', [], '', TRUE, TRUE, TRUE, [
      'submit_handler',
      'hash_submit',
      'simple_string_submit',
    ]);
    $mock
      ->expects($this
      ->once())
      ->method('submit_handler')
      ->with($this
      ->isType('array'), $this
      ->isInstanceOf('Drupal\\Core\\Form\\FormStateInterface'));
    $mock
      ->expects($this
      ->once())
      ->method('hash_submit')
      ->with($this
      ->isType('array'), $this
      ->isInstanceOf('Drupal\\Core\\Form\\FormStateInterface'));
    $mock
      ->expects($this
      ->once())
      ->method('simple_string_submit')
      ->with($this
      ->isType('array'), $this
      ->isInstanceOf('Drupal\\Core\\Form\\FormStateInterface'));
    $form = [];
    $form_state = new FormState();
    $form_submitter
      ->executeSubmitHandlers($form, $form_state);
    $form['#submit'][] = [
      $mock,
      'hash_submit',
    ];
    $form_submitter
      ->executeSubmitHandlers($form, $form_state);

    // $form_state submit handlers will supersede $form handlers.
    $form_state
      ->setSubmitHandlers([
      [
        $mock,
        'submit_handler',
      ],
    ]);
    $form_submitter
      ->executeSubmitHandlers($form, $form_state);

    // Methods directly on the form object can be specified as a string.
    $form_state = (new FormState())
      ->setFormObject($mock)
      ->setSubmitHandlers([
      '::simple_string_submit',
    ]);
    $form_submitter
      ->executeSubmitHandlers($form, $form_state);
  }

  /**
   * @return \Drupal\Core\Form\FormSubmitterInterface
   */
  protected function getFormSubmitter() {
    $request_stack = new RequestStack();
    $request_stack
      ->push(Request::create('/test-path'));
    return $this
      ->getMockBuilder('Drupal\\Core\\Form\\FormSubmitter')
      ->setConstructorArgs([
      $request_stack,
      $this->urlGenerator,
    ])
      ->onlyMethods([
      'batchGet',
    ])
      ->getMock();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FormSubmitterTest::$unroutedUrlAssembler	protected	property	The mocked unrouted URL assembler.
FormSubmitterTest::$urlGenerator	protected	property	The mocked URL generator.
FormSubmitterTest::getFormSubmitter	protected	function
FormSubmitterTest::providerTestHandleFormSubmissionWithResponses	public	function
FormSubmitterTest::providerTestRedirectWithUrl	public	function	Provides test data for testing the redirectForm() method with a route name.
FormSubmitterTest::setUp	protected	function	Overrides UnitTestCase::setUp
FormSubmitterTest::testExecuteSubmitHandlers	public	function	@covers ::executeSubmitHandlers
FormSubmitterTest::testHandleFormSubmissionNoRedirect	public	function	@covers ::doSubmitForm
FormSubmitterTest::testHandleFormSubmissionNotSubmitted	public	function	@covers ::doSubmitForm
FormSubmitterTest::testHandleFormSubmissionWithResponses	public	function	@covers ::doSubmitForm
FormSubmitterTest::testRedirectWithNull	public	function	Tests the redirectForm() method when the redirect is NULL.
FormSubmitterTest::testRedirectWithoutResult	public	function	Tests the redirectForm() method when no redirect is expected.
FormSubmitterTest::testRedirectWithResponseObject	public	function	Tests the redirectForm() method with a response object.
FormSubmitterTest::testRedirectWithUrl	public	function	Tests redirectForm() when a redirect is a Url object.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass	public static	function