Convert all existing entity_embed tests from WebTestBase to BrowserTestBase

Ooh, I think I've finally figured out why this doesn't work!

This works with drupalPostAjaxForm():

      '#ajax' => array(
        'callback' => '::updateTypeSettings',
        'wrapper' => 'embed-type-settings-wrapper', // <-- Selector ID provided here.
        'effect' => 'fade',
      ),
...
  public function updateTypeSettings(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();

    // Update options for entity type bundles.
    $response->addCommand(new ReplaceCommand(
      NULL, // <-- Selector not provided here.
      $form['type_settings']
    ));

    return $response;
  }

This does not:

      '#ajax' => array(
        'callback' => '::updateTypeSettings',
         // <-- Selector not provided here.
        'effect' => 'fade',
      ),
...
  public function updateTypeSettings(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();

    // Update options for entity type bundles.
    $response->addCommand(new ReplaceCommand(
      '#embed-type-settings-wrapper', // <-- Selector ID provided here
      $form['type_settings']
    ));

    return $response;
  }

I think I need to file a bug in Drupal 8 in drupalProcessAjaxResponse()

And here's the code in drupalProcessAjaxResponse that shows that they don't support arbitrary selectors in the AjaxResponse:

      switch ($command['command']) {
        case 'insert':
          $wrapperNode = NULL;
          // When a command doesn't specify a selector, use the
          // #ajax['wrapper'] which is always an HTML ID.
          if (!isset($command['selector'])) {
            $wrapperNode = $xpath->query('//*[@id="' . $ajax_settings['wrapper'] . '"]')->item(0);
          }
          // @todo Ajax commands can target any jQuery selector, but these are
          //   hard to fully emulate with XPath. For now, just handle 'head'
          //   and 'body', since these are used by
          //   \Drupal\Core\Ajax\AjaxResponse::ajaxRender().
          elseif (in_array($command['selector'], array('head', 'body'))) {
            $wrapperNode = $xpath->query('//' . $command['selector'])->item(0);
          }
          if ($wrapperNode) {
            ...

It looks like BrowserTestBase should probably be used for complex AJAX testing: https://www.drupal.org/node/2232861. But it appears that it's not actually ready until Drupal 8.1. And lacks JavaScript so cannot actually be used for anything AJAX related: https://www.drupal.org/node/2469713.

An example of a contrib module test converted to BrowserTestBase: https://www.drupal.org/node/2469609

FYI you should just be able to override drupalProcessAjaxResponse() in your base test class that extends WebTestBase to include the patch.

Core patch filed in #2554449: drupalProcessAjaxResponse() should support returning an AJAX InsertCommand with an ID selector

Is this still worth fixing? I worked on adding a test. This is a copy of the replace test, but it can be modified to reproduce the issue. Will post this for now. This was meant for the core issue.

.

Please submit core patches in the core issue.

What is the plan here? Convert to BrowserTestBase?

Convert to BrowserTestBase?

At this point in the Drupal 8 cycle, where nearly all WebTestBase tests in core have been converted to BrowserTestBase, that seems the only sensible path forward. If we convert entity_embed's tests to use BrowserTestBase, it will also be ready for Drupal 9.

Rescoping.

This is a pretty sloppy patch, but it converts all the tests to BrowserTestBase (and, for the parts of EntityEmbedDialogTest which use the defunct drupalPostAjaxForm(), to WebDriverTestBase). This might also bring things back to green in HEAD, which would be damn good progress.

The tests definitely still need refinement and refactoring, but this is a good start.

Given that the test coverage is currently in less-than-ideal state, and is failing in HEAD, I'm ignoring any and all nits (since I'd have lots of them for the tests in HEAD too), and focusing on only the things that truly matter: the surface area covered by tests, and minimizing change.

1. +++ b/tests/src/Functional/EntityEmbedDialogTest.php
   @@ -91,46 +91,6 @@ class EntityEmbedDialogTest extends EntityEmbedTestBase {
   -    $title = $this->node->getTitle() . ' (' . $this->node->id() . ')';
   

   Why can we delete all this? This means we reduce test coverage.

2. +++ b/tests/src/FunctionalJavascript/EntityEmbedDialogTest.php
   @@ -0,0 +1,101 @@
   +  public function testEntityEmbedButtonMarkup() {
   

   Aha, we moved it here, because it needed JS to run those tests, since BrowserTestBase doesn't emulate the AJAXy stuff without executing JS like WebTestBase used to do.

3. Everything else is trivial, a few things raise eyebrows, but nothing major.

This gets the job done; it gets tests to not only work using the non-deprecated test system, but also makes them pass again.

This blocks #2560787: Add tests for entity access.

This also blocks:

• #2576983: Add tests to ensure translated content works as expected
• #2587433: Add tests for embed button config dependencies
• #2587667: Add tests to confirm setting up an Entity Embed button works
• #2466013: Write test for CKEditor integration

Rerolled against #2993391: test failing due to use_description_as_link_text change.