class FormAjaxResponseBuilderTest in Drupal 9

@coversDefaultClass \Drupal\Core\Form\FormAjaxResponseBuilder @group Form

Hierarchy

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

File

core/tests/Drupal/Tests/Core/Form/FormAjaxResponseBuilderTest.php, line 18

Namespace

Drupal\Tests\Core\Form

class FormAjaxResponseBuilderTest extends UnitTestCase {

  /**
   * @var \Drupal\Core\Render\MainContent\MainContentRendererInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $renderer;

  /**
   * @var \Drupal\Core\Routing\RouteMatchInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $routeMatch;

  /**
   * @var \Drupal\Core\Form\FormAjaxResponseBuilder
   */
  protected $formAjaxResponseBuilder;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->renderer = $this
      ->createMock('Drupal\\Core\\Render\\MainContent\\MainContentRendererInterface');
    $this->routeMatch = $this
      ->createMock('Drupal\\Core\\Routing\\RouteMatchInterface');
    $this->formAjaxResponseBuilder = new FormAjaxResponseBuilder($this->renderer, $this->routeMatch);
  }

  /**
   * @covers ::buildResponse
   */
  public function testBuildResponseNoTriggeringElement() {
    $this->renderer
      ->expects($this
      ->never())
      ->method('renderResponse');
    $request = new Request();
    $form = [];
    $form_state = new FormState();
    $commands = [];
    $this
      ->expectException(HttpException::class);
    $this->formAjaxResponseBuilder
      ->buildResponse($request, $form, $form_state, $commands);
  }

  /**
   * @covers ::buildResponse
   */
  public function testBuildResponseNoCallable() {
    $this->renderer
      ->expects($this
      ->never())
      ->method('renderResponse');
    $request = new Request();
    $form = [];
    $form_state = new FormState();
    $triggering_element = [];
    $form_state
      ->setTriggeringElement($triggering_element);
    $commands = [];
    $this
      ->expectException(HttpException::class);
    $this->formAjaxResponseBuilder
      ->buildResponse($request, $form, $form_state, $commands);
  }

  /**
   * @covers ::buildResponse
   */
  public function testBuildResponseRenderArray() {
    $triggering_element = [
      '#ajax' => [
        'callback' => function (array $form, FormStateInterface $form_state) {
          return $form['test'];
        },
      ],
    ];
    $request = new Request();
    $form = [
      'test' => [
        '#type' => 'textfield',
      ],
    ];
    $form_state = new FormState();
    $form_state
      ->setTriggeringElement($triggering_element);
    $commands = [];
    $this->renderer
      ->expects($this
      ->once())
      ->method('renderResponse')
      ->with($form['test'], $request, $this->routeMatch)
      ->willReturn(new AjaxResponse([]));
    $result = $this->formAjaxResponseBuilder
      ->buildResponse($request, $form, $form_state, $commands);
    $this
      ->assertInstanceOf('\\Drupal\\Core\\Ajax\\AjaxResponse', $result);
    $this
      ->assertSame($commands, $result
      ->getCommands());
  }

  /**
   * @covers ::buildResponse
   */
  public function testBuildResponseResponse() {
    $triggering_element = [
      '#ajax' => [
        'callback' => function (array $form, FormStateInterface $form_state) {
          return new AjaxResponse([]);
        },
      ],
    ];
    $request = new Request();
    $form = [];
    $form_state = new FormState();
    $form_state
      ->setTriggeringElement($triggering_element);
    $commands = [];
    $this->renderer
      ->expects($this
      ->never())
      ->method('renderResponse');
    $result = $this->formAjaxResponseBuilder
      ->buildResponse($request, $form, $form_state, $commands);
    $this
      ->assertInstanceOf('\\Drupal\\Core\\Ajax\\AjaxResponse', $result);
    $this
      ->assertSame($commands, $result
      ->getCommands());
  }

  /**
   * @covers ::buildResponse
   */
  public function testBuildResponseWithCommands() {
    $triggering_element = [
      '#ajax' => [
        'callback' => function (array $form, FormStateInterface $form_state) {
          return new AjaxResponse([]);
        },
      ],
    ];
    $request = new Request();
    $form = [
      'test' => [
        '#type' => 'textfield',
      ],
    ];
    $form_state = new FormState();
    $form_state
      ->setTriggeringElement($triggering_element);
    $commands = [
      new AlertCommand('alert!'),
    ];
    $commands_expected = [];
    $commands_expected[] = [
      'command' => 'alert',
      'text' => 'alert!',
    ];
    $this->renderer
      ->expects($this
      ->never())
      ->method('renderResponse');
    $result = $this->formAjaxResponseBuilder
      ->buildResponse($request, $form, $form_state, $commands);
    $this
      ->assertInstanceOf('\\Drupal\\Core\\Ajax\\AjaxResponse', $result);
    $this
      ->assertSame($commands_expected, $result
      ->getCommands());
  }

  /**
   * @covers ::buildResponse
   */
  public function testBuildResponseWithUpdateCommand() {
    $triggering_element = [
      '#ajax' => [
        'callback' => function (array $form, FormStateInterface $form_state) {
          return new AjaxResponse([]);
        },
      ],
    ];
    $request = new Request();
    $form = [
      '#build_id' => 'the_build_id',
      '#build_id_old' => 'a_new_build_id',
      'test' => [
        '#type' => 'textfield',
      ],
    ];
    $form_state = new FormState();
    $form_state
      ->setTriggeringElement($triggering_element);
    $commands = [
      new AlertCommand('alert!'),
    ];
    $commands_expected = [];
    $commands_expected[] = [
      'command' => 'update_build_id',
      'old' => 'a_new_build_id',
      'new' => 'the_build_id',
    ];
    $commands_expected[] = [
      'command' => 'alert',
      'text' => 'alert!',
    ];
    $this->renderer
      ->expects($this
      ->never())
      ->method('renderResponse');
    $result = $this->formAjaxResponseBuilder
      ->buildResponse($request, $form, $form_state, $commands);
    $this
      ->assertInstanceOf('\\Drupal\\Core\\Ajax\\AjaxResponse', $result);
    $this
      ->assertSame($commands_expected, $result
      ->getCommands());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FormAjaxResponseBuilderTest::$formAjaxResponseBuilder	protected	property
FormAjaxResponseBuilderTest::$renderer	protected	property
FormAjaxResponseBuilderTest::$routeMatch	protected	property
FormAjaxResponseBuilderTest::setUp	protected	function	Overrides UnitTestCase::setUp
FormAjaxResponseBuilderTest::testBuildResponseNoCallable	public	function	@covers ::buildResponse
FormAjaxResponseBuilderTest::testBuildResponseNoTriggeringElement	public	function	@covers ::buildResponse
FormAjaxResponseBuilderTest::testBuildResponseRenderArray	public	function	@covers ::buildResponse
FormAjaxResponseBuilderTest::testBuildResponseResponse	public	function	@covers ::buildResponse
FormAjaxResponseBuilderTest::testBuildResponseWithCommands	public	function	@covers ::buildResponse
FormAjaxResponseBuilderTest::testBuildResponseWithUpdateCommand	public	function	@covers ::buildResponse
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::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
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