Version 1
[yaffs-website] / web / core / tests / Drupal / Tests / Core / Form / FormSubmitterTest.php
diff --git a/web/core/tests/Drupal/Tests/Core/Form/FormSubmitterTest.php b/web/core/tests/Drupal/Tests/Core/Form/FormSubmitterTest.php
new file mode 100644 (file)
index 0000000..15df6f6
--- /dev/null
@@ -0,0 +1,256 @@
+<?php
+
+namespace Drupal\Tests\Core\Form;
+
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Core\Form\FormState;
+use Drupal\Core\Routing\UrlGeneratorInterface;
+use Drupal\Core\Url;
+use Drupal\Core\Utility\UnroutedUrlAssemblerInterface;
+use Drupal\Tests\UnitTestCase;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * @coversDefaultClass \Drupal\Core\Form\FormSubmitter
+ * @group 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() {
+    parent::setUp();
+    $this->urlGenerator = $this->getMock(UrlGeneratorInterface::class);
+    $this->unroutedUrlAssembler = $this->getMock(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->getMock('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')
+      ->will($this->returnValueMap([
+          ['test_route_a', [], ['absolute' => TRUE], FALSE, 'test-route'],
+          ['test_route_b', ['key' => 'value'], ['absolute' => TRUE], FALSE, 'test-route/value'],
+        ])
+      );
+
+    $form_state = $this->getMock('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->getMock('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->getMock('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])
+      ->setMethods(['batchGet', 'drupalInstallationAttempted'])
+      ->getMock();
+  }
+
+}